Struct lpc55s6x_hal::drivers::usbd::UsbBus

pub struct UsbBus<P> { /* fields omitted */ }

Implements the usb_device::bus::UsbBus trait.

From that documentation:

The UsbBus is shared by reference between the global UsbDevice as well as UsbClasses, and therefore any required mutability must be implemented using interior mutability. Most operations that may mutate the bus object itself take place before enable is called. After the bus is enabled, in practice most access won't mutate the object itself but only endpoint-specific registers and buffers, the access to which is mostly arbitrated by endpoint handles.

Methods

impl<PIN: Usb0VbusPin + Sync> UsbBus<PIN>

pub fn new(
    usbfsd: EnabledUsbfsDevice,
    _usb0_vbus_pin: PIN
) -> UsbBusAllocator<Self>

Constructs a new USB peripheral driver.

Trait Implementations

impl<PINS: Send + Sync> UsbBus for UsbBus<PINS>

const QUIRK_SET_ADDRESS_BEFORE_STATUS: bool

Indicates that set_device_address must be called before accepting the corresponding control transfer, not after.

fn alloc_ep(
    &mut self,
    ep_dir: UsbDirection,
    ep_addr: Option<EndpointAddress>,
    ep_type: EndpointType,
    max_packet_size: u16,
    _interval: u8
) -> Result<EndpointAddress>

Allocates an endpoint and specified endpoint parameters. This method is called by the device and class implementations to allocate endpoints, and can only be called before enable is called.

fn enable(&mut self)

Enables and initializes the USB peripheral. Soon after enabling the device will be reset, so there is no need to perform a USB reset in this method.

fn reset(&self)

Performs a USB reset. This method should reset the platform-specific peripheral as well as ensure that all endpoints previously allocate with alloc_ep are initialized as specified.

fn set_device_address(&self, addr: u8)

Sets the device USB address to addr.

fn poll(&self) -> PollResult

Gets information about events and incoming data. Usually called in a loop or from an interrupt handler. See the [PollResult] struct for more information.

fn read(&self, ep_addr: EndpointAddress, buf: &mut [u8]) -> Result<usize>

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

fn write(&self, ep_addr: EndpointAddress, buf: &[u8]) -> Result<usize>

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

fn set_stalled(&self, ep_addr: EndpointAddress, stalled: bool)

Sets or clears the STALL condition for an endpoint. If the endpoint is an OUT endpoint, it should be prepared to receive data again.

fn is_stalled(&self, ep_addr: EndpointAddress) -> bool

Gets whether the STALL condition is set for an endpoint.

fn suspend(&self)

Causes the USB peripheral to enter USB suspend mode, lowering power consumption and preparing to detect a USB wakeup event. This will be called after poll returns [PollResult::Suspend]. The device will continue be polled, and it shall return a value other than Suspend from poll when it no longer detects the suspend condition.

fn resume(&self)

Resumes from suspend mode. This may only be called after the peripheral has been previously suspended.

fn force_reset(&self) -> Result<(), UsbError>

Simulates a disconnect from the USB bus, causing the host to reset and re-enumerate the device.