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 buffer must not be longer than the max_packet_size specified when allocating the endpoint.

Errors

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

• WouldBlock - The transmission buffer of the USB peripheral is full and the packet cannot be sent now. A peripheral may or may not support concurrent transmission of packets.
• BufferOverflow - The data is longer than the max_packet_size specified when allocating the endpoint. This is generally an error in the class implementation.

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. The buffer should be large enough to fit at least as many bytes as the max_packet_size specified when allocating the endpoint.

Errors

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

• WouldBlock - There is no packet to be read. Note that this is different from a received zero-length packet, which is valid and significant in USB. A zero-length packet will return Ok(0).
• BufferOverflow - The received packet is too long to fit in data. This is generally an error in the class implementation.