Struct EndpointProxy 

pub struct EndpointProxy { /* private fields */ }

Implementations

impl EndpointProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.usb.endpoint/Endpoint.

pub fn take_event_stream(&self) -> EndpointEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_info( &self, ) -> QueryResponseFut<EndpointGetInfoResult, DefaultFuchsiaResourceDialect>

Gets endpoint information

pub fn register_vmos( &self, vmo_ids: &[VmoInfo], ) -> QueryResponseFut<Vec<VmoHandle>, DefaultFuchsiaResourceDialect>

Registers and pins VMOs to the vmo_ids. Returns

• vmo: Handles to successfully registered vmo_ids. VMO IDs that are already are registered to will fail.

pub fn unregister_vmos( &self, vmo_ids: &[u64], ) -> QueryResponseFut<(Vec<u64>, Vec<i32>), DefaultFuchsiaResourceDialect>

Unregisters the VMOs corresponding to the vmo_ids. Returns

• failed_vmo_ids: vmo_ids that failed to unregister.
• errors: Error values that correspond 1:1 to failed_vmo_ids above.

pub fn queue_requests(&self, req: Vec<Request>) -> Result<(), Error>

Submit Requests to queue. Processed starting with the 0th Request. Submitting a vector of Requests allows for pre-buffering.

Clients are responsible for cache management and ensuring cache coherency. The explanation to follow concerns VMOs that have been previously registered via RegisterVmos. The following rules must be followed:

1. After writing to VMO-backed buffers, the caller must call zx_cache_flush with ZX_CACHE_FLUSH_DATA before invoking QueueRequests, causing the hardware to DMA-process the buffer. This avoids both stale buffer data being DMA-read, and a concurrent race between the hardware and CPU to update the same addresses.

2. Before reading from VMO-backed buffers, the caller must call zx_cache_flush with ZX_CACHE_FLUSH_DATA | ZX_CACHE_FLUSH_INVALIDATE after the buffer contents have been DMA-written by the hardware. This implies a non-dirty cache (see #1 above) and ensures any subsequent CPU-reads fetch the previously DMA-written data from RAM.

Failing to adhere to these rules will result in the exchange of corrupted and/or stale data. If the VMO is not virtually mapped (uncommon), zx_vmo_op_range should be used in lieu of zx_cache_flush. If the usb::FidlRequest types are in use, they contain helpers for these operations.

Requests may be pre-buffered. In other words, requests may be queued for data that is not present/ready in the buffer yet. The USB Endpoint Server consuming requests does not care if the data in the buffer is ready or not and will always process requests on schedule. It is the responsibility of the USB Endpoint Client that submits requests to ensure that data is ready on schedule (taking into consideration cache management above).

• Definition of “on schedule” varies for different endpoints and controllers. In general, this will be communicated by the lead_time parameter returned by GetInfo.

pub fn cancel_all( &self, ) -> QueryResponseFut<EndpointCancelAllResult, DefaultFuchsiaResourceDialect>

Cancels all requests. Returns

• ZX_ERR_IO_NOT_PRESENT: If device is not running, disconnected, or inactive.
• ZX_ERR_IO: If cancel failed due to an unsuccessful request.

Trait Implementations

impl Clone for EndpointProxy

fn clone(&self) -> EndpointProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointProxy

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

Formats the value using the given formatter.

impl EndpointProxyInterface for EndpointProxy

type GetInfoResponseFut = QueryResponseFut<Result<EndpointInfo, i32>>

type RegisterVmosResponseFut = QueryResponseFut<Vec<VmoHandle>>

type UnregisterVmosResponseFut = QueryResponseFut<(Vec<u64>, Vec<i32>)>

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

fn get_info(&self) -> Self::GetInfoResponseFut

fn register_vmos(&self, vmo_ids: &[VmoInfo]) -> Self::RegisterVmosResponseFut

fn unregister_vmos(&self, vmo_ids: &[u64]) -> Self::UnregisterVmosResponseFut

fn queue_requests(&self, req: Vec<Request>) -> Result<(), Error>

fn cancel_all(&self) -> Self::CancelAllResponseFut

impl Proxy for EndpointProxy

type Protocol = EndpointMarker

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.