Struct UsbProxy 

pub struct UsbProxy { /* private fields */ }

Implementations

impl UsbProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.usb/Usb.

pub fn take_event_stream(&self) -> UsbEventStream

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

Panics

Panics if the event stream was already taken.

pub fn connect_to_endpoint( &self, ep_addr: u8, ep: ServerEnd<EndpointMarker>, ) -> QueryResponseFut<UsbConnectToEndpointResult, DefaultFuchsiaResourceDialect>

Connects a channel to the specified USB endpoint (ep_addr).

Endpoint 0 (the default control pipe) cannot be connected via this method; use [ControlTransfer] instead.

Closing the [Usb] channel does not automatically close open [Endpoint] channels, which remain bound to the underlying host controller until explicitly closed by the client or disconnected when the physical USB device is unplugged.

• error:
  • ZX_ERR_INVALID_ARGS if ep_addr refers to endpoint 0 or an endpoint number > 15.
  • ZX_ERR_NOT_FOUND if the device or endpoint address does not exist.
  • ZX_ERR_ALREADY_BOUND if the endpoint is already bound to an active channel.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.

pub fn get_device_speed( &self, ) -> QueryResponseFut<UsbSpeed, DefaultFuchsiaResourceDialect>

Returns the negotiated bus speed of the USB device.

pub fn get_device_id( &self, ) -> QueryResponseFut<u32, DefaultFuchsiaResourceDialect>

Returns the internal device ID assigned by the USB host controller / bus driver.

pub fn get_device_descriptor( &self, ) -> QueryResponseFut<UsbDeviceDescriptor, DefaultFuchsiaResourceDialect>

Returns the USB device descriptor.

pub fn get_configuration_descriptor( &self, config: u8, ) -> QueryResponseFut<UsbGetConfigurationDescriptorResult, DefaultFuchsiaResourceDialect>

Returns the full raw configuration descriptor hierarchy (in standard USB wire format) for the configuration with bConfigurationValue == config.

• error:
  • ZX_ERR_INVALID_ARGS if config does not match any configuration descriptor on the device.

pub fn get_configuration( &self, ) -> QueryResponseFut<u8, DefaultFuchsiaResourceDialect>

Returns the bConfigurationValue of the currently active USB configuration.

pub fn set_configuration( &self, configuration: u8, ) -> QueryResponseFut<UsbSetConfigurationResult, DefaultFuchsiaResourceDialect>

Selects the active USB configuration (SET_CONFIGURATION) and updates the host controller state.

Replies after the SET_CONFIGURATION control transfer and controller state update complete.

• error:
  • ZX_ERR_INVALID_ARGS if configuration does not match any configuration on the device.
  • ZX_ERR_TIMED_OUT if the control transfer times out.
  • ZX_ERR_IO_REFUSED if the device stalls the request.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.
  • ZX_ERR_NOT_SUPPORTED if invoked on an interface-scoped connection that prohibits device-wide configuration changes.

pub fn set_interface( &self, interface_number: u8, alt_setting: u8, ) -> QueryResponseFut<UsbSetInterfaceResult, DefaultFuchsiaResourceDialect>

Selects an alternate setting for the specified USB interface (SET_INTERFACE) and updates the host controller state.

Replies after the SET_INTERFACE control transfer and controller state update complete.

• error:
  • ZX_ERR_INVALID_ARGS if interface_number or alt_setting is invalid.
  • ZX_ERR_TIMED_OUT if the control transfer times out.
  • ZX_ERR_IO_REFUSED if the device stalls the request.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.

pub fn control_transfer( &self, setup: &UsbSetup, timeout_ns: i64, write_data: &[u8], ) -> QueryResponseFut<UsbControlTransferResult, DefaultFuchsiaResourceDialect>

Performs a synchronous USB control transfer (IN or OUT) over endpoint 0.

Replies after the control transaction completes on the bus (and any associated host controller state updates for standard SET_CONFIGURATION or SET_INTERFACE requests finish).

While this method can be used to read descriptors, prefer [GetDeviceDescriptor] and [GetConfigurationDescriptor] when reading descriptors.

If timeout_ns is 0 or negative, a default 5-second timeout is used (per USB 2.0 Section 9.2.6.4).

• error:
  • ZX_ERR_INVALID_ARGS if the setup packet length or write_data size is invalid.
  • ZX_ERR_TIMED_OUT if the control transfer does not complete within the timeout.
  • ZX_ERR_IO_REFUSED if the device returns a STALL handshake.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.
  • ZX_ERR_NOT_SUPPORTED if the server does not support raw control transfers.

pub fn enable_endpoint( &self, ep_desc: &UsbEndpointDescriptor, ss_com_desc: &UsbSsEpCompDescriptor, enable: bool, ) -> QueryResponseFut<UsbEnableEndpointResult, DefaultFuchsiaResourceDialect>

Enables or disables a USB endpoint on the host controller, configuring it as specified by the provided descriptors.

Replies after the host controller has updated its endpoint context and transfer ring state.

• error:
  • ZX_ERR_INVALID_ARGS if the endpoint descriptor is invalid.
  • ZX_ERR_NO_RESOURCES if the host controller lacks bandwidth or resources.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.
  • ZX_ERR_NOT_SUPPORTED if the server does not support direct endpoint configuration.

pub fn reset_endpoint( &self, ep_address: u8, ) -> QueryResponseFut<UsbResetEndpointResult, DefaultFuchsiaResourceDialect>

Resets an endpoint on the host controller that is in a halted or error state, returning the host controller’s endpoint ring and data toggle to a normal running state.

Note: To clear a halt condition on a non-control endpoint, clients should also issue a standard CLEAR_FEATURE(ENDPOINT_HALT) control request to the device to reset the device’s data toggle to DATA0.

• error:
  • ZX_ERR_INVALID_ARGS if the endpoint is not halted or the address is invalid.
  • ZX_ERR_IO_NOT_PRESENT if the device has been disconnected.

Trait Implementations

impl Clone for UsbProxy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsbProxy

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

Formats the value using the given formatter.

impl Proxy for UsbProxy

type Protocol = UsbMarker

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.

impl UsbProxyInterface for UsbProxy

type ConnectToEndpointResponseFut = QueryResponseFut<Result<(), i32>>

type GetDeviceSpeedResponseFut = QueryResponseFut<UsbSpeed>

type GetDeviceIdResponseFut = QueryResponseFut<u32>

type GetDeviceDescriptorResponseFut = QueryResponseFut<UsbDeviceDescriptor>

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

type GetConfigurationResponseFut = QueryResponseFut<u8>

type SetConfigurationResponseFut = QueryResponseFut<Result<(), i32>>

type SetInterfaceResponseFut = QueryResponseFut<Result<(), i32>>

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

type EnableEndpointResponseFut = QueryResponseFut<Result<(), i32>>

type ResetEndpointResponseFut = QueryResponseFut<Result<(), i32>>

fn connect_to_endpoint( &self, ep_addr: u8, ep: ServerEnd<EndpointMarker>, ) -> Self::ConnectToEndpointResponseFut

fn get_device_speed(&self) -> Self::GetDeviceSpeedResponseFut

fn get_device_id(&self) -> Self::GetDeviceIdResponseFut

fn get_device_descriptor(&self) -> Self::GetDeviceDescriptorResponseFut

fn get_configuration_descriptor( &self, config: u8, ) -> Self::GetConfigurationDescriptorResponseFut

fn get_configuration(&self) -> Self::GetConfigurationResponseFut

fn set_configuration( &self, configuration: u8, ) -> Self::SetConfigurationResponseFut

fn set_interface( &self, interface_number: u8, alt_setting: u8, ) -> Self::SetInterfaceResponseFut

fn control_transfer( &self, setup: &UsbSetup, timeout_ns: i64, write_data: &[u8], ) -> Self::ControlTransferResponseFut

fn enable_endpoint( &self, ep_desc: &UsbEndpointDescriptor, ss_com_desc: &UsbSsEpCompDescriptor, enable: bool, ) -> Self::EnableEndpointResponseFut

fn reset_endpoint(&self, ep_address: u8) -> Self::ResetEndpointResponseFut