Struct usb_device::endpoint::Endpoint

pub struct Endpoint<'a, B: UsbBus, D: EndpointDirection> { /* private fields */ }

Handle for a USB endpoint. The endpoint direction is constrained by the D type argument, which must be either In or Out.

Implementations

impl<B: UsbBus, D: EndpointDirection> Endpoint<'_, B, D>

pub fn address(&self) -> EndpointAddress

Gets the endpoint address including direction bit.

pub fn ep_type(&self) -> EndpointType

Gets the endpoint transfer type.

pub fn max_packet_size(&self) -> u16

Gets the maximum packet size for the endpoint.

pub fn interval(&self) -> u8

Gets the poll interval for interrupt endpoints.

pub fn stall(&self)

Sets the STALL condition for the endpoint.

pub fn unstall(&self)

Clears the STALL condition of the endpoint.

impl<B: UsbBus> Endpoint<'_, B, In>

pub fn write(&self, data: &[u8]) -> Result<usize>

Writes a single packet of data to the specified endpoint and returns number of bytes actually written.

The only reason for a short write is if the caller passes a slice larger than the amount of memory allocated earlier, and this is generally an error in the class implementation.

Errors

Note: USB bus implementation errors are directly passed through, so be prepared to handle other errors as well.

• InvalidEndpoint - The ep_addr does not point to a valid endpoint that was previously allocated with UsbBus::alloc_ep.
• WouldBlock - A previously written packet is still pending to be sent.

impl<B: UsbBus> Endpoint<'_, B, Out>

pub fn read(&self, data: &mut [u8]) -> Result<usize>

Reads a single packet of data from the specified endpoint and returns the actual length of the packet.

This should also clear any NAK flags and prepare the endpoint to receive the next packet.

Errors

Note: USB bus implementation errors are directly passed through, so be prepared to handle other errors as well.

• InvalidEndpoint - The ep_addr does not point to a valid endpoint that was previously allocated with UsbBus::alloc_ep.
• WouldBlock - There is no packet to be read. Note that this is different from a received zero-length packet, which is valid in USB. A zero-length packet will return Ok(0).
• BufferOverflow - The received packet is too long to fix in buf. This is generally an error in the class implementation.