Struct DeviceProxy 

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.spmi/Device.

pub fn take_event_stream(&self) -> DeviceEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn register_read( &self, address: u16, size_bytes: u32, ) -> QueryResponseFut<DeviceRegisterReadResult, DefaultFuchsiaResourceDialect>

Issue register read commands to the SPMI device. The implementation may choose which SPMI variation (e.g. extended, long) to use. When successful, it returns size_bytes in data read contiguously starting from address in the device.

pub fn register_write( &self, address: u16, data: &[u8], ) -> QueryResponseFut<DeviceRegisterWriteResult, DefaultFuchsiaResourceDialect>

Issue register write commands to the SPMI device. The implementation may choose which SPMI variation (e.g. extended, long) to use. When this command is successful, data will be written contiguously starting from address in the device.

pub fn get_properties( &self, ) -> QueryResponseFut<DeviceGetPropertiesResponse, DefaultFuchsiaResourceDialect>

Get the properties of the SPMI device.

pub fn watch_controller_write_commands( &self, address: u8, size: u16, setup_wake_lease: Option<EventPair>, ) -> QueryResponseFut<DeviceWatchControllerWriteCommandsResult, DefaultFuchsiaResourceDialect>

Hanging-get method to receive controller write commands from the device. address and size specify the register range to monitor for commands. Multiple overlapping calls to this method are not allowed. Returns INVALID_ARGS if address or size are invalid, or BAD_STATE if another call is pending for this register range. Returns CANCELED if CancelWatchControllerWriteCommands() was called for this register range.

If this method is meant to keep the system awake (prevents suspension) while watch is setup, use the passed-in setup_wake_lease LeaseToken. Then, when the watch is triggered this method will return a second wake_lease LeaseToken to prevent suspension.

These keep alive wake lease tokens are provided by the Power Framework’s System Activity Governor. A driver supporting keep alive must be able to get wake_lease from System Activity Governor.

When wake_lease is closed, then the created wake lease keeping the system from suspending at the time of watch triggering is dropped. Hence, to guarantee that the system is not suspended by the Power Framework a client must either keep this wake_lease for as long as the system needs to stay awake, or a client must get its own wake lease from the Power Framework before it drops wake_lease to prevent suspension.

pub fn cancel_watch_controller_write_commands( &self, address: u8, size: u16, ) -> QueryResponseFut<DeviceCancelWatchControllerWriteCommandsResult, DefaultFuchsiaResourceDialect>

Cancels an pending call to WatchControllerWriteCommands. address and size must exactly match a previous call to WatchControllerWriteCommands(), otherwise NOT_FOUND is returned.

Trait Implementations

impl Clone for DeviceProxy

fn clone(&self) -> DeviceProxy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceProxyInterface for DeviceProxy

type RegisterReadResponseFut = QueryResponseFut<Result<Vec<u8>, DriverError>>

type RegisterWriteResponseFut = QueryResponseFut<Result<(), DriverError>>

type GetPropertiesResponseFut = QueryResponseFut<DeviceGetPropertiesResponse>

type WatchControllerWriteCommandsResponseFut = QueryResponseFut<Result<(Vec<Register8>, Option<EventPair>), DriverError>>

type CancelWatchControllerWriteCommandsResponseFut = QueryResponseFut<Result<(), DriverError>>

fn register_read( &self, address: u16, size_bytes: u32, ) -> Self::RegisterReadResponseFut

fn register_write( &self, address: u16, data: &[u8], ) -> Self::RegisterWriteResponseFut

fn get_properties(&self) -> Self::GetPropertiesResponseFut

fn watch_controller_write_commands( &self, address: u8, size: u16, setup_wake_lease: Option<EventPair>, ) -> Self::WatchControllerWriteCommandsResponseFut

fn cancel_watch_controller_write_commands( &self, address: u8, size: u16, ) -> Self::CancelWatchControllerWriteCommandsResponseFut

impl Proxy for DeviceProxy

type Protocol = DeviceMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, NullableHandle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.