Struct stm32_hal2::usb::UsbBus

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

USB peripheral driver for STM32 microcontrollers.

Implementations

impl<USB> UsbBus<USB> where
    USB: UsbPeripheral, 

pub fn new(peripheral: USB) -> UsbBusAllocator<UsbBus<USB>>

Constructs a new USB peripheral driver.

pub fn free(self) -> USB

pub fn force_reenumeration<F>(&self, disconnect: F) where
    F: FnOnce(), 

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

Mostly used for development. By calling this at the start of your program ensures that the host re-enumerates your device after a new program has been flashed.

disconnect parameter is used to provide a custom disconnect function. This function will be called with USB peripheral powered down and interrupts disabled. It should perform disconnect in a platform-specific way.

Trait Implementations

impl<USB> UsbBus for UsbBus<USB> where
    USB: UsbPeripheral, 

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

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.

pub 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.

pub 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.

pub fn set_device_address(&self, addr: u8)

Sets the device USB address to addr.

pub 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.

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

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

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

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

pub 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.

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

Gets whether the STALL condition is set for an endpoint.

pub 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.

pub fn resume(&self)

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

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

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

pub const QUIRK_SET_ADDRESS_BEFORE_STATUS: bool

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