fidl_fuchsia_power_manager_debug/
fidl_fuchsia_power_manager_debug.rs

1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::client::QueryResponseFut;
8use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
9use fidl::endpoints::{ControlHandle as _, Responder as _};
10pub use fidl_fuchsia_power_manager_debug_common::*;
11use futures::future::{self, MaybeDone, TryFutureExt};
12use zx_status;
13
14#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
15pub struct DebugMarker;
16
17impl fidl::endpoints::ProtocolMarker for DebugMarker {
18    type Proxy = DebugProxy;
19    type RequestStream = DebugRequestStream;
20    #[cfg(target_os = "fuchsia")]
21    type SynchronousProxy = DebugSynchronousProxy;
22
23    const DEBUG_NAME: &'static str = "fuchsia.power.manager.debug.Debug";
24}
25impl fidl::endpoints::DiscoverableProtocolMarker for DebugMarker {}
26pub type DebugMessageResult = Result<(), MessageError>;
27
28pub trait DebugProxyInterface: Send + Sync {
29    type MessageResponseFut: std::future::Future<Output = Result<DebugMessageResult, fidl::Error>>
30        + Send;
31    fn r#message(
32        &self,
33        node_name: &str,
34        command: &str,
35        args: &[String],
36    ) -> Self::MessageResponseFut;
37}
38#[derive(Debug)]
39#[cfg(target_os = "fuchsia")]
40pub struct DebugSynchronousProxy {
41    client: fidl::client::sync::Client,
42}
43
44#[cfg(target_os = "fuchsia")]
45impl fidl::endpoints::SynchronousProxy for DebugSynchronousProxy {
46    type Proxy = DebugProxy;
47    type Protocol = DebugMarker;
48
49    fn from_channel(inner: fidl::Channel) -> Self {
50        Self::new(inner)
51    }
52
53    fn into_channel(self) -> fidl::Channel {
54        self.client.into_channel()
55    }
56
57    fn as_channel(&self) -> &fidl::Channel {
58        self.client.as_channel()
59    }
60}
61
62#[cfg(target_os = "fuchsia")]
63impl DebugSynchronousProxy {
64    pub fn new(channel: fidl::Channel) -> Self {
65        let protocol_name = <DebugMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
66        Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
67    }
68
69    pub fn into_channel(self) -> fidl::Channel {
70        self.client.into_channel()
71    }
72
73    /// Waits until an event arrives and returns it. It is safe for other
74    /// threads to make concurrent requests while waiting for an event.
75    pub fn wait_for_event(
76        &self,
77        deadline: zx::MonotonicInstant,
78    ) -> Result<DebugEvent, fidl::Error> {
79        DebugEvent::decode(self.client.wait_for_event(deadline)?)
80    }
81
82    /// Sends a debug message to the specified Power Manager node.
83    ///
84    /// + `node_name` is the name of the Power Manager node to message. A list
85    ///   of node names for a given device can be found in the device-specific
86    ///   node config file [here](/src/power/power-manager/node_config/).
87    /// + `command` is the node-specific command to be sent to the specified
88    ///   node. The supported commands for a given node can be found by
89    ///   inspecting that node's source.
90    /// + `args` is a vector of arguments to be sent that may be required by the
91    ///   node to execute the command.
92    ///
93    /// For example, to override the SOC temperature to 40C on Astro (according
94    /// to the current [node
95    /// configuration](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/node_config/astro_node_config.json;l=58;drc=2cd2c555e5d2f0371e36bdca70ed4ba92635cb86)
96    /// and `TemperatureHandler` [implementation](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/src/temperature_handler.rs;drc=f6e405ca555f5e5ab575d421e84b721684ba41fa):
97    ///
98    ///     ```
99    ///     Message(
100    ///         "temperature_soc_pll",
101    ///         "set_temperature",
102    ///         [ "40" ]
103    ///     )
104    ///     ```
105    pub fn r#message(
106        &self,
107        mut node_name: &str,
108        mut command: &str,
109        mut args: &[String],
110        ___deadline: zx::MonotonicInstant,
111    ) -> Result<DebugMessageResult, fidl::Error> {
112        let _response = self.client.send_query::<DebugMessageRequest, fidl::encoding::ResultType<
113            fidl::encoding::EmptyStruct,
114            MessageError,
115        >>(
116            (node_name, command, args),
117            0x3a1d992128e015da,
118            fidl::encoding::DynamicFlags::empty(),
119            ___deadline,
120        )?;
121        Ok(_response.map(|x| x))
122    }
123}
124
125#[cfg(target_os = "fuchsia")]
126impl From<DebugSynchronousProxy> for zx::Handle {
127    fn from(value: DebugSynchronousProxy) -> Self {
128        value.into_channel().into()
129    }
130}
131
132#[cfg(target_os = "fuchsia")]
133impl From<fidl::Channel> for DebugSynchronousProxy {
134    fn from(value: fidl::Channel) -> Self {
135        Self::new(value)
136    }
137}
138
139#[derive(Debug, Clone)]
140pub struct DebugProxy {
141    client: fidl::client::Client<fidl::encoding::DefaultFuchsiaResourceDialect>,
142}
143
144impl fidl::endpoints::Proxy for DebugProxy {
145    type Protocol = DebugMarker;
146
147    fn from_channel(inner: ::fidl::AsyncChannel) -> Self {
148        Self::new(inner)
149    }
150
151    fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
152        self.client.into_channel().map_err(|client| Self { client })
153    }
154
155    fn as_channel(&self) -> &::fidl::AsyncChannel {
156        self.client.as_channel()
157    }
158}
159
160impl DebugProxy {
161    /// Create a new Proxy for fuchsia.power.manager.debug/Debug.
162    pub fn new(channel: ::fidl::AsyncChannel) -> Self {
163        let protocol_name = <DebugMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
164        Self { client: fidl::client::Client::new(channel, protocol_name) }
165    }
166
167    /// Get a Stream of events from the remote end of the protocol.
168    ///
169    /// # Panics
170    ///
171    /// Panics if the event stream was already taken.
172    pub fn take_event_stream(&self) -> DebugEventStream {
173        DebugEventStream { event_receiver: self.client.take_event_receiver() }
174    }
175
176    /// Sends a debug message to the specified Power Manager node.
177    ///
178    /// + `node_name` is the name of the Power Manager node to message. A list
179    ///   of node names for a given device can be found in the device-specific
180    ///   node config file [here](/src/power/power-manager/node_config/).
181    /// + `command` is the node-specific command to be sent to the specified
182    ///   node. The supported commands for a given node can be found by
183    ///   inspecting that node's source.
184    /// + `args` is a vector of arguments to be sent that may be required by the
185    ///   node to execute the command.
186    ///
187    /// For example, to override the SOC temperature to 40C on Astro (according
188    /// to the current [node
189    /// configuration](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/node_config/astro_node_config.json;l=58;drc=2cd2c555e5d2f0371e36bdca70ed4ba92635cb86)
190    /// and `TemperatureHandler` [implementation](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/src/temperature_handler.rs;drc=f6e405ca555f5e5ab575d421e84b721684ba41fa):
191    ///
192    ///     ```
193    ///     Message(
194    ///         "temperature_soc_pll",
195    ///         "set_temperature",
196    ///         [ "40" ]
197    ///     )
198    ///     ```
199    pub fn r#message(
200        &self,
201        mut node_name: &str,
202        mut command: &str,
203        mut args: &[String],
204    ) -> fidl::client::QueryResponseFut<
205        DebugMessageResult,
206        fidl::encoding::DefaultFuchsiaResourceDialect,
207    > {
208        DebugProxyInterface::r#message(self, node_name, command, args)
209    }
210}
211
212impl DebugProxyInterface for DebugProxy {
213    type MessageResponseFut = fidl::client::QueryResponseFut<
214        DebugMessageResult,
215        fidl::encoding::DefaultFuchsiaResourceDialect,
216    >;
217    fn r#message(
218        &self,
219        mut node_name: &str,
220        mut command: &str,
221        mut args: &[String],
222    ) -> Self::MessageResponseFut {
223        fn _decode(
224            mut _buf: Result<<fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc, fidl::Error>,
225        ) -> Result<DebugMessageResult, fidl::Error> {
226            let _response = fidl::client::decode_transaction_body::<
227                fidl::encoding::ResultType<fidl::encoding::EmptyStruct, MessageError>,
228                fidl::encoding::DefaultFuchsiaResourceDialect,
229                0x3a1d992128e015da,
230            >(_buf?)?;
231            Ok(_response.map(|x| x))
232        }
233        self.client.send_query_and_decode::<DebugMessageRequest, DebugMessageResult>(
234            (node_name, command, args),
235            0x3a1d992128e015da,
236            fidl::encoding::DynamicFlags::empty(),
237            _decode,
238        )
239    }
240}
241
242pub struct DebugEventStream {
243    event_receiver: fidl::client::EventReceiver<fidl::encoding::DefaultFuchsiaResourceDialect>,
244}
245
246impl std::marker::Unpin for DebugEventStream {}
247
248impl futures::stream::FusedStream for DebugEventStream {
249    fn is_terminated(&self) -> bool {
250        self.event_receiver.is_terminated()
251    }
252}
253
254impl futures::Stream for DebugEventStream {
255    type Item = Result<DebugEvent, fidl::Error>;
256
257    fn poll_next(
258        mut self: std::pin::Pin<&mut Self>,
259        cx: &mut std::task::Context<'_>,
260    ) -> std::task::Poll<Option<Self::Item>> {
261        match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
262            &mut self.event_receiver,
263            cx
264        )?) {
265            Some(buf) => std::task::Poll::Ready(Some(DebugEvent::decode(buf))),
266            None => std::task::Poll::Ready(None),
267        }
268    }
269}
270
271#[derive(Debug)]
272pub enum DebugEvent {}
273
274impl DebugEvent {
275    /// Decodes a message buffer as a [`DebugEvent`].
276    fn decode(
277        mut buf: <fidl::encoding::DefaultFuchsiaResourceDialect as fidl::encoding::ResourceDialect>::MessageBufEtc,
278    ) -> Result<DebugEvent, fidl::Error> {
279        let (bytes, _handles) = buf.split_mut();
280        let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
281        debug_assert_eq!(tx_header.tx_id, 0);
282        match tx_header.ordinal {
283            _ => Err(fidl::Error::UnknownOrdinal {
284                ordinal: tx_header.ordinal,
285                protocol_name: <DebugMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
286            }),
287        }
288    }
289}
290
291/// A Stream of incoming requests for fuchsia.power.manager.debug/Debug.
292pub struct DebugRequestStream {
293    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
294    is_terminated: bool,
295}
296
297impl std::marker::Unpin for DebugRequestStream {}
298
299impl futures::stream::FusedStream for DebugRequestStream {
300    fn is_terminated(&self) -> bool {
301        self.is_terminated
302    }
303}
304
305impl fidl::endpoints::RequestStream for DebugRequestStream {
306    type Protocol = DebugMarker;
307    type ControlHandle = DebugControlHandle;
308
309    fn from_channel(channel: ::fidl::AsyncChannel) -> Self {
310        Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
311    }
312
313    fn control_handle(&self) -> Self::ControlHandle {
314        DebugControlHandle { inner: self.inner.clone() }
315    }
316
317    fn into_inner(
318        self,
319    ) -> (::std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>, bool)
320    {
321        (self.inner, self.is_terminated)
322    }
323
324    fn from_inner(
325        inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
326        is_terminated: bool,
327    ) -> Self {
328        Self { inner, is_terminated }
329    }
330}
331
332impl futures::Stream for DebugRequestStream {
333    type Item = Result<DebugRequest, fidl::Error>;
334
335    fn poll_next(
336        mut self: std::pin::Pin<&mut Self>,
337        cx: &mut std::task::Context<'_>,
338    ) -> std::task::Poll<Option<Self::Item>> {
339        let this = &mut *self;
340        if this.inner.check_shutdown(cx) {
341            this.is_terminated = true;
342            return std::task::Poll::Ready(None);
343        }
344        if this.is_terminated {
345            panic!("polled DebugRequestStream after completion");
346        }
347        fidl::encoding::with_tls_decode_buf::<_, fidl::encoding::DefaultFuchsiaResourceDialect>(
348            |bytes, handles| {
349                match this.inner.channel().read_etc(cx, bytes, handles) {
350                    std::task::Poll::Ready(Ok(())) => {}
351                    std::task::Poll::Pending => return std::task::Poll::Pending,
352                    std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
353                        this.is_terminated = true;
354                        return std::task::Poll::Ready(None);
355                    }
356                    std::task::Poll::Ready(Err(e)) => {
357                        return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(
358                            e.into(),
359                        ))))
360                    }
361                }
362
363                // A message has been received from the channel
364                let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
365
366                std::task::Poll::Ready(Some(match header.ordinal {
367                    0x3a1d992128e015da => {
368                        header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
369                        let mut req = fidl::new_empty!(
370                            DebugMessageRequest,
371                            fidl::encoding::DefaultFuchsiaResourceDialect
372                        );
373                        fidl::encoding::Decoder::<fidl::encoding::DefaultFuchsiaResourceDialect>::decode_into::<DebugMessageRequest>(&header, _body_bytes, handles, &mut req)?;
374                        let control_handle = DebugControlHandle { inner: this.inner.clone() };
375                        Ok(DebugRequest::Message {
376                            node_name: req.node_name,
377                            command: req.command,
378                            args: req.args,
379
380                            responder: DebugMessageResponder {
381                                control_handle: std::mem::ManuallyDrop::new(control_handle),
382                                tx_id: header.tx_id,
383                            },
384                        })
385                    }
386                    _ => Err(fidl::Error::UnknownOrdinal {
387                        ordinal: header.ordinal,
388                        protocol_name: <DebugMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
389                    }),
390                }))
391            },
392        )
393    }
394}
395
396/// Exposes a debug control interface to the Power Manager.
397#[derive(Debug)]
398pub enum DebugRequest {
399    /// Sends a debug message to the specified Power Manager node.
400    ///
401    /// + `node_name` is the name of the Power Manager node to message. A list
402    ///   of node names for a given device can be found in the device-specific
403    ///   node config file [here](/src/power/power-manager/node_config/).
404    /// + `command` is the node-specific command to be sent to the specified
405    ///   node. The supported commands for a given node can be found by
406    ///   inspecting that node's source.
407    /// + `args` is a vector of arguments to be sent that may be required by the
408    ///   node to execute the command.
409    ///
410    /// For example, to override the SOC temperature to 40C on Astro (according
411    /// to the current [node
412    /// configuration](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/node_config/astro_node_config.json;l=58;drc=2cd2c555e5d2f0371e36bdca70ed4ba92635cb86)
413    /// and `TemperatureHandler` [implementation](https://cs.opensource.google/fuchsia/fuchsia/+/main:src/power/power-manager/src/temperature_handler.rs;drc=f6e405ca555f5e5ab575d421e84b721684ba41fa):
414    ///
415    ///     ```
416    ///     Message(
417    ///         "temperature_soc_pll",
418    ///         "set_temperature",
419    ///         [ "40" ]
420    ///     )
421    ///     ```
422    Message {
423        node_name: String,
424        command: String,
425        args: Vec<String>,
426        responder: DebugMessageResponder,
427    },
428}
429
430impl DebugRequest {
431    #[allow(irrefutable_let_patterns)]
432    pub fn into_message(self) -> Option<(String, String, Vec<String>, DebugMessageResponder)> {
433        if let DebugRequest::Message { node_name, command, args, responder } = self {
434            Some((node_name, command, args, responder))
435        } else {
436            None
437        }
438    }
439
440    /// Name of the method defined in FIDL
441    pub fn method_name(&self) -> &'static str {
442        match *self {
443            DebugRequest::Message { .. } => "message",
444        }
445    }
446}
447
448#[derive(Debug, Clone)]
449pub struct DebugControlHandle {
450    inner: std::sync::Arc<fidl::ServeInner<fidl::encoding::DefaultFuchsiaResourceDialect>>,
451}
452
453impl fidl::endpoints::ControlHandle for DebugControlHandle {
454    fn shutdown(&self) {
455        self.inner.shutdown()
456    }
457    fn shutdown_with_epitaph(&self, status: zx_status::Status) {
458        self.inner.shutdown_with_epitaph(status)
459    }
460
461    fn is_closed(&self) -> bool {
462        self.inner.channel().is_closed()
463    }
464    fn on_closed(&self) -> fidl::OnSignalsRef<'_> {
465        self.inner.channel().on_closed()
466    }
467
468    #[cfg(target_os = "fuchsia")]
469    fn signal_peer(
470        &self,
471        clear_mask: zx::Signals,
472        set_mask: zx::Signals,
473    ) -> Result<(), zx_status::Status> {
474        use fidl::Peered;
475        self.inner.channel().signal_peer(clear_mask, set_mask)
476    }
477}
478
479impl DebugControlHandle {}
480
481#[must_use = "FIDL methods require a response to be sent"]
482#[derive(Debug)]
483pub struct DebugMessageResponder {
484    control_handle: std::mem::ManuallyDrop<DebugControlHandle>,
485    tx_id: u32,
486}
487
488/// Set the the channel to be shutdown (see [`DebugControlHandle::shutdown`])
489/// if the responder is dropped without sending a response, so that the client
490/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
491impl std::ops::Drop for DebugMessageResponder {
492    fn drop(&mut self) {
493        self.control_handle.shutdown();
494        // Safety: drops once, never accessed again
495        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
496    }
497}
498
499impl fidl::endpoints::Responder for DebugMessageResponder {
500    type ControlHandle = DebugControlHandle;
501
502    fn control_handle(&self) -> &DebugControlHandle {
503        &self.control_handle
504    }
505
506    fn drop_without_shutdown(mut self) {
507        // Safety: drops once, never accessed again due to mem::forget
508        unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
509        // Prevent Drop from running (which would shut down the channel)
510        std::mem::forget(self);
511    }
512}
513
514impl DebugMessageResponder {
515    /// Sends a response to the FIDL transaction.
516    ///
517    /// Sets the channel to shutdown if an error occurs.
518    pub fn send(self, mut result: Result<(), MessageError>) -> Result<(), fidl::Error> {
519        let _result = self.send_raw(result);
520        if _result.is_err() {
521            self.control_handle.shutdown();
522        }
523        self.drop_without_shutdown();
524        _result
525    }
526
527    /// Similar to "send" but does not shutdown the channel if an error occurs.
528    pub fn send_no_shutdown_on_err(
529        self,
530        mut result: Result<(), MessageError>,
531    ) -> Result<(), fidl::Error> {
532        let _result = self.send_raw(result);
533        self.drop_without_shutdown();
534        _result
535    }
536
537    fn send_raw(&self, mut result: Result<(), MessageError>) -> Result<(), fidl::Error> {
538        self.control_handle.inner.send::<fidl::encoding::ResultType<
539            fidl::encoding::EmptyStruct,
540            MessageError,
541        >>(
542            result,
543            self.tx_id,
544            0x3a1d992128e015da,
545            fidl::encoding::DynamicFlags::empty(),
546        )
547    }
548}
549
550mod internal {
551    use super::*;
552}
fidl_fuchsia_power_manager_debug/fidl_fuchsia_power_manager_debug.rs

fidl_fuchsia_power_manager_debug/
fidl_fuchsia_power_manager_debug.rs
