CMSIS-Driver_STM32  
CMSIS Drivers for STMicroelectronics STM32 Series devices
 
Loading...
Searching...
No Matches
USB Host

Revision History

  • Version 2.2
    • Added support for USB DRD controller
    • Updated high-speed support
    • Updated detection and signaling of ARM_USBH_EVENT_RESET event
  • Version 2.1
    • Added support for USB HS in FS mode (when using the internal PHY)
  • Version 2.0
    • Initial release

Requirements

This driver requires the STM32 device specific HAL and STM32CubeMX (CubeMX) initialization code generator. The driver instance is mapped to hardware as shown in the table below:

CMSIS Driver Instance STM32 Hardware Resource
Driver_USBH0 USB_OTG_FS or USB_FS or USB_DRD_FS
Driver_USBH1 USB_OTG_HS

Deviations

This driver has the following deviations from the CMSIS-Driver specification:

Conceptual deviations:

  • CubeMX generated initialization code (function MX_USB_...HCD_Init) already configures the peripheral. Power, clocks, pins, and interrupts are enabled after execution of initialization that executes in main.c.
  • Role (Host to Device) cannot be changed at run-time.

Functional deviations:

  • Initialize:
    • depends on the code generated by CubeMX.
    • does not initialize the pins.
  • Uninitialize:
    • does not de-initialize the pins.
  • PowerControl:
    • depends on the code generated by CubeMX.
    • low-power mode is not supported by HAL.
  • PortSuspend/PortResume/PipeReset/PipeDelete/PipeTransferAbort:
    • not supported by HAL.
  • PortGetState:
    • over-current status is not supported by HAL.
  • SignalPortEvent:
    • over-current signaling is not supported by HAL.

CubeMX Configuration

This driver requires the following configuration in CubeMX:

  • clock: USB peripheral clock at 48 MHz.
  • peripheral:
    • for USB or USB_OTG_FS configured as Host_Only or Mode = Host_Only.
    • for USB_OTG_HS in high-speed mode: configured as External Phy = Host_Only if ULPI Phy is populated , and Parameter Settings configured as desired.
    • for USB_OTG_HS in full-speed mode: configured as Internal FS Phy = Host_Only if ULPI Phy is not populated , and Parameter Settings configured as desired.
  • pins:
    • for USB or USB_OTG_FS in full-speed mode: USB_OTG_FS_DM, USB_OTG_FS_DP pins and pin for VBUS control (usually GPIO or via Multi Function eXpander (MFX))
    • for USB_OTG_HS in high-speed mode: USB_OTG_HS_ULPI_CK, USB_OTG_HS_ULPI_D0, USB_OTG_HS_ULPI_D1 , USB_OTG_HS_ULPI_D2, USB_OTG_HS_ULPI_D3, USB_OTG_HS_ULPI_D4, USB_OTG_HS_ULPI_D5, USB_OTG_HS_ULPI_D6 , USB_OTG_HS_ULPI_D7, USB_OTG_HS_ULPI_DIR, USB_OTG_HS_ULPI_NXT and USB_OTG_HS_ULPI_STP pins.
    • for USB_OTG_HS in full-speed mode: USB_OTG_HS_VBUS, USB_OTG_HS_DM and USB_OTG_HS_DP pins.
  • interrupts:
    • for USB or USB_FS or USB_OTG_FS enabled USB or USB FS global interrupt or USB On The Go FS global interrupt and IRQ handlers that Call HAL handlers.
    • for USB_OTG_HS enabled USB On The Go HS global interrupt and IRQ handlers that Call HAL handlers.

Example

Pinout & Configuration tab

  1. In the Pinout view window click on a pin and select it's functionality:
    Pin Functionality
    PA11 USB_OTG_FS_DM
    PA12 USB_OTG_FS_DP
    PA5 USB_OTG_HS_ULPI_CK
    PA3 USB_OTG_HS_ULPI_D0
    PB0 USB_OTG_HS_ULPI_D1
    PB1 USB_OTG_HS_ULPI_D2
    PB10 USB_OTG_HS_ULPI_D3
    PB11 USB_OTG_HS_ULPI_D4
    PB12 USB_OTG_HS_ULPI_D5
    PB13 USB_OTG_HS_ULPI_D6
    PB5 USB_OTG_HS_ULPI_D7
    PI11 USB_OTG_HS_ULPI_DIR
    PH4 USB_OTG_HS_ULPI_NXT
    PC0 USB_OTG_HS_ULPI_STP

  2. Under Categories: Connectivity select USB_OTG_FS:

    Mode:

    • Mode: Host_Only
    • Activate_VBUS: Disable
    • Activate_SOF: unchecked

    Configuration:

    • Parameter Settings: as desired
    • GPIO Settings:
      Pin Name Signal on Pin Pin Context.. GPIO output.. GPIO mode GPIO Pull-up/Pull.. Maximum out.. Fast Mode User Label
      PA11 USB_OTG_FS_DM n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PA12 USB_OTG_FS_DP n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .

  3. Under Categories: Connectivity select USB_OTG_HS:

    Mode:

    • External Phy: Host_Only
    • Internal FS Phy: Disable
    • Activate_SOF: unchecked
    • Activate_VBUS: Disable

    Configuration:

    • Parameter Settings: as desired
    • GPIO Settings:
      Pin Name Signal on Pin Pin Context.. GPIO output.. GPIO mode GPIO Pull-up/Pull.. Maximum out.. Fast Mode User Label
      PA5 USB_OTG_HS_ULPI_CK n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PA3 USB_OTG_HS_ULPI_D0 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB0 USB_OTG_HS_ULPI_D1 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB1 USB_OTG_HS_ULPI_D2 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB10 USB_OTG_HS_ULPI_D3 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB11 USB_OTG_HS_ULPI_D4 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB12 USB_OTG_HS_ULPI_D5 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB13 USB_OTG_HS_ULPI_D6 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PB5 USB_OTG_HS_ULPI_D7 n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PI11 USB_OTG_HS_ULPI_DIR n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PH4 USB_OTG_HS_ULPI_NXT n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .
      PC0 USB_OTG_HS_ULPI_STP n/a n/a Alternate Function Push Pull No pull-up and no.. High n/a .

  4. Under Categories: System Core select NVIC:

    Configuration:

    • NVIC:
      NVIC Interrupt Table Enabled Preemption Priority Sub Priority
      USB On The Go HS global interrupt checked 0 0
      USB On The Go FS global interrupt checked 0 0

    • Code generation:
      Enabled interrupt table Select for.. Generate Enable in.. Generate IRQ h.. Call HAL handler
      USB On The Go HS global interrupt unchecked checked checked checked
      USB On The Go FS global interrupt unchecked checked checked checked

Clock Configuration tab

  1. Configure To USB (MHz): 48

Project Manager tab

  1. Under Advanced Settings:

    Generated Function Calls:

    Generate Code Function Name Peripheral Inst.. Do not generate .. Visibility (Static)
    checked MX_USB_OTG_FS_HCD_Init USB_OTG_FS unchecked checked
    checked MX_USB_OTG_HS_HCD_Init USB_OTG_HS unchecked checked

Source Code

If VBUS pin is not under control of USB Controller but is controlled with GPIO or Multi Function eXpander (MFX) then it is necessary to provide hardware-specific function USBH_HW_VbusOnOff for VBUS pin control.

Example:

// \fn int32_t USBH_HW_VbusOnOff (HCD_HandleTypeDef *ptr_hhcd, bool vbus)
// \brief Hardware-specific control of VBUS line.
// \param[in] ptr_hhcd Pointer to hhcd
// \param[in] vbus
// - \b false VBUS off
// - \b true VBUS on
// \return 0 on success, -1 on error.
int32_t USBH_HW_VbusOnOff (HCD_HandleTypeDef *ptr_hhcd, bool vbus) {
if (ptr_hhcd == &hhcd_USB_OTG_FS) {
if (vbus) { // VBUS power on
BSP_IO_WritePin(0U, IO_PIN_7, IO_PIN_SET);
} else { // VBUS power off
BSP_IO_WritePin(0U, IO_PIN_7, IO_PIN_RESET);
}
}
return 0;
}