Struct usb_device::bus::UsbBusAllocator

pub struct UsbBusAllocator<B: UsbBus> { /* private fields */ }

Helper type used for UsbBus resource allocation and initialization.

Implementations

impl<B: UsbBus> UsbBusAllocator<B>

pub fn new(bus: B) -> UsbBusAllocator<B>

Creates a new UsbBusAllocator that wraps the provided UsbBus. Usually only called by USB driver implementations.

pub fn interface(&self) -> InterfaceNumber

Allocates a new interface number.

pub fn string(&self) -> StringIndex

Allocates a new string index.

pub fn alloc<D: EndpointDirection>( &self, ep_addr: Option<EndpointAddress>, ep_type: EndpointType, max_packet_size: u16, interval: u8 ) -> Result<Endpoint<'_, B, D>>

Allocates an endpoint with the specified direction and address.

This directly delegates to UsbBus::alloc_ep, so see that method for details. In most cases classes should call the endpoint type specific methods instead.

pub fn control<D: EndpointDirection>( &self, max_packet_size: u16 ) -> Endpoint<'_, B, D>

Allocates a control endpoint.

This crate implements the control state machine only for endpoint 0. If classes want to support control requests in other endpoints, the state machine must be implemented manually. This should rarely be needed by classes.

Arguments

• max_packet_size - Maximum packet size in bytes. Must be one of 8, 16, 32 or 64.

Panics

Panics if endpoint allocation fails, because running out of endpoints or memory is not feasibly recoverable.

pub fn isochronous<D: EndpointDirection>( &self, synchronization: IsochronousSynchronizationType, usage: IsochronousUsageType, payload_size: u16, interval: u8 ) -> Endpoint<'_, B, D>

Allocates an isochronous endpoint.

Arguments

• synchronization - Type of synchronization used by the endpoint
• usage - Whether the endpoint is data, explicit feedback, or data+implicit feedback
• payload_size - Payload size in bytes.
• interval - Interval for polling, expressed in frames/microframes.

See USB 2.0 section 9.6.6.

Panics

Panics if endpoint allocation fails, because running out of endpoints or memory is not feasibly recoverable.

pub fn bulk<D: EndpointDirection>( &self, max_packet_size: u16 ) -> Endpoint<'_, B, D>

Allocates a bulk endpoint.

Arguments

• max_packet_size - Maximum packet size in bytes. Must be one of 8, 16, 32 or 64.

Panics

Panics if endpoint allocation fails, because running out of endpoints or memory is not feasibly recoverable.

pub fn interrupt<D: EndpointDirection>( &self, max_packet_size: u16, interval: u8 ) -> Endpoint<'_, B, D>

Allocates an interrupt endpoint.

• max_packet_size - Maximum packet size in bytes. Cannot exceed 64 bytes.
• interval - Polling interval.

Panics

Panics if endpoint allocation fails, because running out of endpoints or memory is not feasibly recoverable.