Enum DeviceRequest

pub enum DeviceRequest {
    GetMmioById {
        index: u32,
        responder: DeviceGetMmioByIdResponder,
    },
    GetMmioByName {
        name: String,
        responder: DeviceGetMmioByNameResponder,
    },
    GetInterruptById {
        index: u32,
        flags: u32,
        responder: DeviceGetInterruptByIdResponder,
    },
    GetInterruptByName {
        name: String,
        flags: u32,
        responder: DeviceGetInterruptByNameResponder,
    },
    GetBtiById {
        index: u32,
        responder: DeviceGetBtiByIdResponder,
    },
    GetBtiByName {
        name: String,
        responder: DeviceGetBtiByNameResponder,
    },
    GetSmcById {
        index: u32,
        responder: DeviceGetSmcByIdResponder,
    },
    GetSmcByName {
        name: String,
        responder: DeviceGetSmcByNameResponder,
    },
    GetPowerConfiguration {
        responder: DeviceGetPowerConfigurationResponder,
    },
    GetNodeDeviceInfo {
        responder: DeviceGetNodeDeviceInfoResponder,
    },
    GetBoardInfo {
        responder: DeviceGetBoardInfoResponder,
    },
    GetMetadata {
        id: String,
        responder: DeviceGetMetadataResponder,
    },
    #[non_exhaustive]
    _UnknownMethod {
        ordinal: u64,
        control_handle: DeviceControlHandle,
        method_type: MethodType,
    },
}

Variants

GetMmioById

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.

Fields

index: u32

responder: DeviceGetMmioByIdResponder

GetMmioByName

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.

Fields

name: String

responder: DeviceGetMmioByNameResponder

GetInterruptById

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.

Fields

index: u32

flags: u32

responder: DeviceGetInterruptByIdResponder

GetInterruptByName

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.

Fields

name: String

flags: u32

responder: DeviceGetInterruptByNameResponder

GetBtiById

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.

Fields

index: u32

responder: DeviceGetBtiByIdResponder

GetBtiByName

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.

Fields

name: String

responder: DeviceGetBtiByNameResponder

GetSmcById

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.

Fields

index: u32

responder: DeviceGetSmcByIdResponder

GetSmcByName

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.

Fields

name: String

responder: DeviceGetSmcByNameResponder

GetPowerConfiguration

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

Fields

responder: DeviceGetPowerConfigurationResponder

GetNodeDeviceInfo

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

Fields

responder: DeviceGetNodeDeviceInfoResponder

GetBoardInfo

Return information about the board the device is attached to.

Fields

responder: DeviceGetBoardInfoResponder

GetMetadata

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

Fields

id: String

responder: DeviceGetMetadataResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: DeviceControlHandle

method_type: MethodType

Implementations

impl DeviceRequest

pub fn into_get_mmio_by_id(self) -> Option<(u32, DeviceGetMmioByIdResponder)>

pub fn into_get_mmio_by_name( self, ) -> Option<(String, DeviceGetMmioByNameResponder)>

pub fn into_get_interrupt_by_id( self, ) -> Option<(u32, u32, DeviceGetInterruptByIdResponder)>

pub fn into_get_interrupt_by_name( self, ) -> Option<(String, u32, DeviceGetInterruptByNameResponder)>

pub fn into_get_bti_by_id(self) -> Option<(u32, DeviceGetBtiByIdResponder)>

pub fn into_get_bti_by_name( self, ) -> Option<(String, DeviceGetBtiByNameResponder)>

pub fn into_get_smc_by_id(self) -> Option<(u32, DeviceGetSmcByIdResponder)>

pub fn into_get_smc_by_name( self, ) -> Option<(String, DeviceGetSmcByNameResponder)>

pub fn into_get_power_configuration( self, ) -> Option<DeviceGetPowerConfigurationResponder>

pub fn into_get_node_device_info( self, ) -> Option<DeviceGetNodeDeviceInfoResponder>

pub fn into_get_board_info(self) -> Option<DeviceGetBoardInfoResponder>

pub fn into_get_metadata(self) -> Option<(String, DeviceGetMetadataResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for DeviceRequest

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

Formats the value using the given formatter.