Struct stm32_hal2::usb_otg::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,
    ep_memory: &'static mut [u32]
) -> UsbBusAllocator<UsbBus<USB>>

Constructs a new USB peripheral driver.

pub fn free(self) -> USB

pub fn force_reset(&self, delay: &mut impl DelayMs<u32>) -> Result<(), UsbError>

pub fn ulpi_read(&self, addr: u8) -> Result<u8, UlpiError>

Reads from a ULPI register in an external ULPI PHY.

Interrupts are disabled for the duration of the function call.

Panics: if phy_type is not PhyType::ExternalHighSpeed.

Example

fn read_usb_vid_pid<USB: UsbPeripheral>(bus: &UsbBus<USB>) -> (u16, u16) {
    let mut vid: u16 = bus.ulpi_read(0x00) as u16;
    vid |= (bus.ulpi_read(0x01) as u16) << 8;
    let mut pid: u16 = bus.ulpi_read(0x02) as u16;
    pid |= (bus.ulpi_read(0x03) as u16) << 8;
    (vid, pid)
}

pub fn ulpi_write(&self, addr: u8, data: u8) -> Result<(), UlpiError>

Writes to a ULPI register in an external ULPI PHY.

Interrupts are disabled for the duration of the function call.

Panics: if phy_type is not PhyType::ExternalHighSpeed.

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

const QUIRK_SET_ADDRESS_BEFORE_STATUS: bool = true

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

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

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