Struct DeviceProxy

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.platform.device/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 get_mmio_by_id( &self, index: u32, ) -> QueryResponseFut<DeviceGetMmioByIdResult, DefaultFuchsiaResourceDialect>

Returns a memory mapped IO (MMIO) resource for the given |index|.

• error ZX_ERR_OUT_OF_RANGE if |index| is equal or greater than the number of mmios.
• error ZX_ERR_INTERNAL if the retrieved mmio is not valid.
• error ZX_ERR_NOT_FOUND if the retrieved mmio’s base address is NULL.

pub fn get_mmio_by_name( &self, name: &str, ) -> QueryResponseFut<DeviceGetMmioByNameResult, DefaultFuchsiaResourceDialect>

Returns a memory mapped IO (MMIO) resource for the given |name|.

• error ZX_ERR_INVALID_ARGS if |name| is an empty string.
• error ZX_ERR_OUT_OF_RANGE if |name| is not found.
• error ZX_ERR_INTERNAL if the retrieved mmio is not valid.
• error ZX_ERR_NOT_FOUND if the retrieved’s mmio base address is NULL.

pub fn get_interrupt_by_id( &self, index: u32, flags: u32, ) -> QueryResponseFut<DeviceGetInterruptByIdResult, DefaultFuchsiaResourceDialect>

Returns an interrupt handle for the given |index|. |flags| is forwarded as the |options| parameter to zx_interrupt_create.

• error ZX_ERR_OUT_OF_RANGE if |index| is equal or greater than the number of interrupts.
• error ZX_ERR_INTERNAL if the retrieved interrupt is not valid.

pub fn get_interrupt_by_name( &self, name: &str, flags: u32, ) -> QueryResponseFut<DeviceGetInterruptByNameResult, DefaultFuchsiaResourceDialect>

Returns an interrupt handle for the given |name|. |flags| is forwarded as the |options| parameter to zx_interrupt_create.

• error ZX_ERR_INVALID_ARGS if |name| is an empty string.
• error ZX_ERR_OUT_OF_RANGE if |name| is not found.
• error ZX_ERR_INTERNAL if the retrieved interrupt is not valid.

pub fn get_bti_by_id( &self, index: u32, ) -> QueryResponseFut<DeviceGetBtiByIdResult, DefaultFuchsiaResourceDialect>

Returns a bus transaction initiator (bti) handle for the given |index|.

• error ZX_ERR_OUT_OF_RANGE if |index| is equal or greater than the number of btis.
• error ZX_ERR_INTERNAL if the retrieved bti is not valid.

pub fn get_bti_by_name( &self, name: &str, ) -> QueryResponseFut<DeviceGetBtiByNameResult, DefaultFuchsiaResourceDialect>

Returns a bus transaction initiator (bti) handle for the given |name|.

• error ZX_ERR_INVALID_ARGS if |name| is an empty string.
• error ZX_ERR_OUT_OF_RANGE if |name| is not found.
• error ZX_ERR_INTERNAL if the retrieved bti is not valid.

pub fn get_smc_by_id( &self, index: u32, ) -> QueryResponseFut<DeviceGetSmcByIdResult, DefaultFuchsiaResourceDialect>

Returns a secure monitor call (smc) handle for the given |index|.

• error ZX_ERR_OUT_OF_RANGE if |index| is equal or greater than the number of smcs.
• error ZX_ERR_INTERNAL if the retrieved smc is not valid.

pub fn get_smc_by_name( &self, name: &str, ) -> QueryResponseFut<DeviceGetSmcByNameResult, DefaultFuchsiaResourceDialect>

Returns a secure monitor call (smc) handle for the given |name|.

• error ZX_ERR_INVALID_ARGS if |name| is an empty string.
• error ZX_ERR_OUT_OF_RANGE if |name| is not found.
• error ZX_ERR_INTERNAL if the retrieved smc is not valid.

pub fn get_power_configuration( &self, ) -> QueryResponseFut<DeviceGetPowerConfigurationResult, DefaultFuchsiaResourceDialect>

Returns power configuration for the device the driver has bound to.

pub fn get_node_device_info( &self, ) -> QueryResponseFut<DeviceGetNodeDeviceInfoResult, DefaultFuchsiaResourceDialect>

Returns information about the device corresponding to the node that the driver has bound to.

pub fn get_board_info( &self, ) -> QueryResponseFut<DeviceGetBoardInfoResult, DefaultFuchsiaResourceDialect>

Return information about the board the device is attached to.

pub fn get_metadata( &self, id: &str, ) -> QueryResponseFut<DeviceGetMetadataResult, DefaultFuchsiaResourceDialect>

Returns the metadata associated with the device and |id|. Returns ZX_ERR_NOT_FOUND if the metadata does not exist.

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 GetMmioByIdResponseFut = QueryResponseFut<Result<Mmio, i32>>

type GetMmioByNameResponseFut = QueryResponseFut<Result<Mmio, i32>>

type GetInterruptByIdResponseFut = QueryResponseFut<Result<Interrupt, i32>>

type GetInterruptByNameResponseFut = QueryResponseFut<Result<Interrupt, i32>>

type GetBtiByIdResponseFut = QueryResponseFut<Result<Bti, i32>>

type GetBtiByNameResponseFut = QueryResponseFut<Result<Bti, i32>>

type GetSmcByIdResponseFut = QueryResponseFut<Result<Resource, i32>>

type GetSmcByNameResponseFut = QueryResponseFut<Result<Resource, i32>>

type GetPowerConfigurationResponseFut = QueryResponseFut<Result<Vec<PowerElementConfiguration>, i32>>

type GetNodeDeviceInfoResponseFut = QueryResponseFut<Result<NodeDeviceInfo, i32>>

type GetBoardInfoResponseFut = QueryResponseFut<Result<BoardInfo, i32>>

type GetMetadataResponseFut = QueryResponseFut<Result<Vec<u8>, i32>>

fn get_mmio_by_id(&self, index: u32) -> Self::GetMmioByIdResponseFut

fn get_mmio_by_name(&self, name: &str) -> Self::GetMmioByNameResponseFut

fn get_interrupt_by_id( &self, index: u32, flags: u32, ) -> Self::GetInterruptByIdResponseFut

fn get_interrupt_by_name( &self, name: &str, flags: u32, ) -> Self::GetInterruptByNameResponseFut

fn get_bti_by_id(&self, index: u32) -> Self::GetBtiByIdResponseFut

fn get_bti_by_name(&self, name: &str) -> Self::GetBtiByNameResponseFut

fn get_smc_by_id(&self, index: u32) -> Self::GetSmcByIdResponseFut

fn get_smc_by_name(&self, name: &str) -> Self::GetSmcByNameResponseFut

fn get_power_configuration(&self) -> Self::GetPowerConfigurationResponseFut

fn get_node_device_info(&self) -> Self::GetNodeDeviceInfoResponseFut

fn get_board_info(&self) -> Self::GetBoardInfoResponseFut

fn get_metadata(&self, id: &str) -> Self::GetMetadataResponseFut

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<'_, Handle>>

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