Struct UsbFunctionProxy 

pub struct UsbFunctionProxy { /* private fields */ }

Implementations

impl UsbFunctionProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.usb.function/UsbFunction.

pub fn take_event_stream(&self) -> UsbFunctionEventStream

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<UsbFunctionConnectToEndpointResult, DefaultFuchsiaResourceDialect>

Connects to endpoint. Returns

• ZX_ERR_NOT_FOUND: if endpoint address does not exist.
• ZX_ERR_ALREADY_BOUND: if the endpoint is already bound.

pub fn configure( &self, configuration: &[u8], iface: ClientEnd<UsbFunctionInterfaceMarker>, ) -> QueryResponseFut<UsbFunctionConfigureResult, DefaultFuchsiaResourceDialect>

Configures the function with the given descriptors.

configuration is a vector of USB descriptors to configure the function with. The descriptors are concatenated together following the USB specification to form the configuration. iface provides the control-plane callbacks for the function.

The function is unregistered from the USB function manager when iface is closed.

Any resource address and numbers referenced in configuration must have been allocated by a previous call to AllocResources.

Returns ZX_ERR_INVALID_ARGS if the configuration is invalid.

pub fn deconfigure( &self, ) -> QueryResponseFut<UsbFunctionDeconfigureResult, DefaultFuchsiaResourceDialect>

Deconfigures the function.

This is the opposite of Configure. The server drops its connection to the function upon receiving the call, if it’s bound.

Returns after the function channel has been unbound from the server.

Trivially succeeds if no function interface is bound.

Returns ZX_ERR_UNAVAILABLE if a deconfiguration is already in progress.

pub fn alloc_resources( &self, interface_count: u8, endpoints: Vec<EndpointResource>, strings: &[String], ) -> QueryResponseFut<UsbFunctionAllocResourcesResult, DefaultFuchsiaResourceDialect>

Allocates resources for the function.

This function is used to allocate resources for the function.

interface_count informs how many interfaces to create. interface_nums returns the allocate interface numbers referencing the requested interfaces.

endpoints is a vector of endpoints to allocate. The direction and endpoint server end are provided. endpoint_addrs returns a vector of the same size containing the allocated endpoint addresses. On success the endpoint server ends are connected to a server. Closed otherwise.

strings is a vector of strings to allocate. string_indices returns a vector of the same size containing the allocated string indices.

Returns the interface ids, endpoint ids, and string ids that were allocated. On error, no resources are allocated. Returns:

• ZX_ERR_NO_RESOURCES if any resource namespace numbers are exhausted.

The allocated resource numbers and addresses remain allocated for the lifetime of the connection to UsbFunction.

pub fn endpoint_set_stall( &self, endpoint_address: u8, ) -> QueryResponseFut<UsbFunctionEndpointSetStallResult, DefaultFuchsiaResourceDialect>

Sets stall state in an endpoint.

Returns

• ZX_ERR_IO_NOT_PRESENT: If device is not running, disconnected, or inactive.
• ZX_ERR_NOT_FOUND: If endpoint address does not exist.

pub fn endpoint_clear_stall( &self, endpoint_address: u8, ) -> QueryResponseFut<UsbFunctionEndpointClearStallResult, DefaultFuchsiaResourceDialect>

Clears stall state in an endpoint.

Returns

• ZX_ERR_IO_NOT_PRESENT: If device is not running, disconnected, or inactive.
• ZX_ERR_NOT_FOUND: If endpoint address does not exist.

pub fn configure_endpoint( &self, endpoint_address: u8, endpoint_configuration: &EndpointConfiguration, ) -> QueryResponseFut<UsbFunctionConfigureEndpointResult, DefaultFuchsiaResourceDialect>

Configure and enable an endpoint with the given configuration.

See usb20 9.6.6.

Returns

• ZX_ERR_IO_NOT_PRESENT: If device is not running, disconnected, or inactive.
• ZX_ERR_NOT_FOUND: If endpoint address does not exist.
• ZX_ERR_INVALID_ARGS: If the configuration is invalid.

pub fn disable_endpoint( &self, endpoint_address: u8, ) -> QueryResponseFut<UsbFunctionDisableEndpointResult, DefaultFuchsiaResourceDialect>

Disable an endpoint.

Returns

• ZX_ERR_IO_NOT_PRESENT: If device is not running, disconnected, or inactive.
• ZX_ERR_NOT_FOUND: If endpoint address does not exist.

Trait Implementations

impl Clone for UsbFunctionProxy

fn clone(&self) -> UsbFunctionProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsbFunctionProxy

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

Formats the value using the given formatter.

impl Proxy for UsbFunctionProxy

type Protocol = UsbFunctionMarker

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 UsbFunctionProxyInterface for UsbFunctionProxy

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

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

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

type AllocResourcesResponseFut = QueryResponseFut<Result<(Vec<u8>, Vec<u8>, Vec<u8>), i32>>

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

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

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

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

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

fn configure( &self, configuration: &[u8], iface: ClientEnd<UsbFunctionInterfaceMarker>, ) -> Self::ConfigureResponseFut

fn deconfigure(&self) -> Self::DeconfigureResponseFut

fn alloc_resources( &self, interface_count: u8, endpoints: Vec<EndpointResource>, strings: &[String], ) -> Self::AllocResourcesResponseFut

fn endpoint_set_stall( &self, endpoint_address: u8, ) -> Self::EndpointSetStallResponseFut

fn endpoint_clear_stall( &self, endpoint_address: u8, ) -> Self::EndpointClearStallResponseFut

fn configure_endpoint( &self, endpoint_address: u8, endpoint_configuration: &EndpointConfiguration, ) -> Self::ConfigureEndpointResponseFut

fn disable_endpoint( &self, endpoint_address: u8, ) -> Self::DisableEndpointResponseFut