Struct UsbBus

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

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.

pub fn suspend_low_power_mode(&self) -> bool

Enter suspend low-power mode

This should be used when in suspend mode if low-power mode needs to be entered during suspend (bus-powered device). Application should call this when it is ready to decrease power consumption to meet power consumption requirements of the USB suspend condition (e.g. disable system clocks or reduce their frequency). When wake up event is received low power mode will be automatically disabled.

Will not enter low-power mode if not in suspend state. Returns true if entered.

pub fn remote_wakeup(&self, resume: bool)

Set/clear remote wakeup bit

Allows to modify CNTR.RESUME bit from device to perform remote wake up from suspend (e.g. on keyboard/mouse input). To perform remote wake up: when a condition is met during suspend mode, use this method with true to set the RESUME bit. Then, after waiting between 1-15 ms (see reference manual) call it again with false to clear the bit.

This method will not set the bit if device is not suspended because performing remote wake up in other mode is invalid and host will most likely disable such a device.

Trait Implementations

impl<USB> UsbBus for UsbBus<USB>

where USB: UsbPeripheral,

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.

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)

Called when the host resets the device. This will be soon called after poll returns PollResult::Reset. This method should reset the state of all endpoints and peripheral flags back to a state suitable for enumeration, as well as ensure that all endpoints previously allocated 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 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.

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.

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.

const QUIRK_SET_ADDRESS_BEFORE_STATUS: bool = false

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