mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-05-10 19:29:12 +08:00
150 lines
8.5 KiB
Plaintext
150 lines
8.5 KiB
Plaintext
/**
|
||
@page DynamicSwitch_Standalone USB Host Dynamic Switch application
|
||
|
||
@verbatim
|
||
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
|
||
* @file USB_Host/DynamicSwitch_Standalone/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of the USB Host Dynamic Switch application.
|
||
******************************************************************************
|
||
*
|
||
* Copyright (c) 2017 STMicroelectronics. All rights reserved.
|
||
*
|
||
* This software component is licensed by ST under Ultimate Liberty license
|
||
* SLA0044, the "License"; You may not use this file except in compliance with
|
||
* the License. You may obtain a copy of the License at:
|
||
* www.st.com/SLA0044
|
||
*
|
||
******************************************************************************
|
||
@endverbatim
|
||
|
||
@par Application Description
|
||
|
||
This application is a part of the USB Host Library package using STM32Cube firmware. It describes how to use
|
||
dynamically switch, on the same port, between available USB host applications on the STM32F4xx devices.
|
||
|
||
The USBH_RegisterClass() API is provided by the USB Host Library to load the class driver. In this
|
||
application MSC, HID and AUDIO classes are loaded and the user can start his application depending on the
|
||
connected device.
|
||
|
||
At the beginning of the main program the HAL_Init() function is called to reset all the peripherals,
|
||
initialize the Flash interface and the systick. The user is provided with the SystemClock_Config()
|
||
function to configure the system clock (SYSCLK) to run at 168 MHz. The Full Speed (FS) USB module uses
|
||
internally a 48-MHz clock, which is generated from an integrated PLL. In the High Speed (HS) mode the
|
||
USB clock (60 MHz) is driven by the ULPI.
|
||
|
||
It's worth noting that the system clock (SYSCLK) can be configured, depending on the used USB Core:
|
||
- SYSCLK is set to 168 MHz: for FS Core (FS or HS-IN-FS), because used embedded PHY
|
||
requires 48 MHz clock, achieved only when system clock
|
||
is set to 168 MHz.
|
||
- SYSCLK is set to 180 MHz: for only HS Core, since no embedded PHY is used.
|
||
|
||
When the application is started, the connected USB device is detected in the appropriate mode
|
||
(MSC/HID/AUDIO) and gets initialized. The STM32 MCU behaves as a (MSC/HID/AUDIO) Host, it enumerates the
|
||
device and extracts VID, PID, manufacturer name, Serial no and product name information and displays it
|
||
on the LCD screen.
|
||
|
||
A menu is displayed depending on the connected device and the user can select any operation from the
|
||
menu using the Joystick buttons.
|
||
|
||
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
|
||
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
|
||
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
|
||
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
|
||
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
|
||
|
||
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
|
||
to have correct HAL operation.
|
||
|
||
For more details about the STM32Cube USB Host library, please refer to UM1720
|
||
"STM32Cube USB Host library".
|
||
|
||
|
||
@par USB Library Configuration
|
||
|
||
To select the appropriate USB Core to work with, user must add the following macro defines within the
|
||
compiler preprocessor (already done in the preconfigured projects provided with this application):
|
||
- "USE_USB_HS" when using USB High Speed (HS) Core
|
||
- "USE_USB_FS" when using USB Full Speed (FS) Core
|
||
- "USE_USB_HS" and "USE_USB_HS_IN_FS" when using USB High Speed (HS) Core in FS mode
|
||
|
||
It is possible to fine tune needed USB Host features by modifying defines values in USBH configuration
|
||
file <20>usbh_conf.h<> available under the project includes directory, in a way to fit the application
|
||
requirements, such as:
|
||
- Level of debug: USBH_DEBUG_LEVEL
|
||
0: No debug messages
|
||
1: Only User messages are shown
|
||
2: User and Error messages are shown
|
||
3: All messages and internal debug messages are shown
|
||
By default debug messages are displayed on the debugger IO terminal; to redirect the Library
|
||
messages on the LCD screen, lcd_log.c driver need to be added to the application sources.
|
||
|
||
- Number of supported classes: USBH_MAX_NUM_SUPPORTED_CLASS
|
||
|
||
@par Keywords
|
||
|
||
Connectivity, USB_Host, MSC, HID, AUDIO, Full-Speed, High-Speed, LCD, SD Card, Mass Storage, FatFS
|
||
|
||
@par Directory contents
|
||
|
||
- USB_Host/DynamicSwitch_Standalone/Src/main.c Main program
|
||
- USB_Host/DynamicSwitch_Standalone/Src/usbh_diskio_dma.c FatFS usbh diskio driver implementation
|
||
- USB_Host/DynamicSwitch_Standalone/Src/sd_diskio.c FatFS sd diskio driver implementation
|
||
- USB_Host/DynamicSwitch_Standalone/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
|
||
- USB_Host/DynamicSwitch_Standalone/Src/stm32f4xx_it.c Interrupt handlers
|
||
- USB_Host/DynamicSwitch_Standalone/Src/menu.c Main Menu State Machine
|
||
- USB_Host/DynamicSwitch_Standalone/Src/usbh_conf.c General low level driver configuration
|
||
- USB_Host/DynamicSwitch_Standalone/Src/usbh_diskio.c USB diskio interface for FatFs
|
||
- USB_Host/DynamicSwitch_Standalone/Src/msc_explorer.c Explore the USB flash disk content
|
||
- USB_Host/DynamicSwitch_Standalone/Src/file_operations.c Write/read file on the disk
|
||
- USB_Host/DynamicSwitch_Standalone/Src/msc_menu.c MSC State Machine
|
||
- USB_Host/DynamicSwitch_Standalone/Src/hid_menu.c HID State Machine
|
||
- USB_Host/DynamicSwitch_Standalone/Src/audio_menu.c AUDIO State Machine
|
||
- USB_Host/DynamicSwitch_Standalone/Src/audio_explorer.c Explore the uSD content
|
||
- USB_Host/DynamicSwitch_Standalone/Src/audio.c Audio Out (playback) interface API
|
||
- USB_Host/DynamicSwitch_Standalone/Src/mouse.c HID mouse functions
|
||
- USB_Host/DynamicSwitch_Standalone/Src/keyboard.c HID keyboard functions
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/main.h Main program header file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/usbh_diskio_dma.h FatFS usbh diskio driver header file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/sd_diskio.h FatFS sd diskio driver header file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/stm32f4xx_it.h Interrupt handlers header file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/lcd_log_conf.h LCD log configuration file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/stm32f4xx_hal_conf.h HAL configuration file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/usbh_conf.h USB Host driver Configuration file
|
||
- USB_Host/DynamicSwitch_Standalone/Inc/ffconf.h FAT file system module configuration file
|
||
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This application runs on STM32F429xx/STM32F439xx devices.
|
||
|
||
- This application has been tested with STMicroelectronics STM324x9I-EVAL RevB
|
||
evaluation boards and can be easily tailored to any other supported device
|
||
and development board.
|
||
|
||
- STM324x9I-EVAL RevB Set-up
|
||
- Insert a microSD card containing .Wav audio file into the STM324x9I-EVAL uSD slot (CN17)
|
||
- Plug the USB device into the STM324x9I-EVAL board through 'USB micro A-Male
|
||
to A-Female' cable to the connector:
|
||
- CN9 : to use USB High Speed (HS) with embedded PHY(U7)
|
||
- CN14: to use USB Full Speed (FS)
|
||
Please ensure that jumper JP16 is not fitted.
|
||
- CN15: to use USB HS-IN-FS.
|
||
Note that some FS signals are shared with the HS ULPI bus, so some PCB rework is needed.
|
||
For more details, refer to section 2.8 USB OTG2 HS & FS in UM1667
|
||
|
||
|
||
@par How to use it ?
|
||
|
||
In order to make the program work, you must do the following :
|
||
- Open your preferred toolchain
|
||
- Rebuild all files and load your image into target memory
|
||
- In the workspace toolbar select the project configuration:
|
||
- STM324x9I-EVAL_USBH-HS: to configure the project for STM32F4xx devices using USB OTG HS peripheral
|
||
- STM324x9I-EVAL_USBH-FS: to configure the project for STM32F4xx devices using USB OTG FS peripheral
|
||
- STM324x9I-EVAL_USBH-HS-IN-FS: to configure the project for STM32F4xx devices and use USB OTG HS
|
||
peripheral In FS (using embedded PHY).
|
||
- Run the application
|
||
|
||
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
|
||
*/ |