124 lines
6.2 KiB
Plaintext
124 lines
6.2 KiB
Plaintext
/**
|
||
@page HID_RTOS USB Host Humain Interface (HID) RTOS example
|
||
|
||
@verbatim
|
||
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
|
||
* @file USB_Host/HID_RTOS/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of the USB Host HID RTOS example.
|
||
******************************************************************************
|
||
* @attention
|
||
*
|
||
* <h2><center>© Copyright (c) 2016 STMicroelectronics.
|
||
* All rights reserved.</center></h2>
|
||
*
|
||
* 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 Example Description
|
||
|
||
Use of the USB host application based on the HID class.
|
||
|
||
This is a typical example on how to use the STM32F105x/107x USB OTG Host peripheral to interact with an USB
|
||
HID Device such as a Mouse or a Keyboard.
|
||
|
||
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 72 MHz. The Full Speed (FS) USB module uses
|
||
internally a 48-MHz clock, which is generated from an integrated PLL.
|
||
|
||
When the application is started, the connected HID device (Mouse/Keyboard) is detected in HID mode and
|
||
gets initialized. The STM32 MCU behaves as a HID Host, it enumerates the device and extracts VID, PID,
|
||
manufacturer name, Serial number and product name information and displays it on the LCD screen.
|
||
This example is based on interacting with a HID device (Mouse/Keyboard). It creates a normal
|
||
priority thread, that executes a HID routine.
|
||
|
||
A menu is displayed and the user can select any operation from the menu using the Joystick buttons:
|
||
- "Start HID" operation starts the appropriate HID application to the attached HID Device.
|
||
- "Start Mouse / Re-Initialize" operation starts Mouse HID example. Moving the mouse will move
|
||
the pointer in the display rectangle and if a button is pressed, the corresponding rectangle will be
|
||
highlighted in Blue.
|
||
- "Start Keyboard / Clear" operation starts Keyboard HID example. Taped Keyboard characters are
|
||
displayed on the LCD screen.
|
||
- "Re-Enumerate" operation performs a new Enumeration of the device.
|
||
|
||
@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.
|
||
|
||
@note In case of using an "AZERTY keyboard", user should add "AZERTY_KEYBOARD" define in the project Preprocessor.
|
||
|
||
For more details about the STM32Cube USB Host library, please refer to UM1720
|
||
"STM32Cube USB Host library".
|
||
|
||
|
||
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.
|
||
|
||
Since this is an RTOS based example, built around FreeRTOS and CMSIS-OS wrapping layer common APIs,
|
||
the RTOS is enabled by setting, #define USBH_USE_OS 1
|
||
|
||
@note The FreeRTOS heap size configTOTAL_HEAP_SIZE defined in FreeRTOSConfig.h is set accordingly to the
|
||
OS resources memory requirements of the application with +10% margin and rounded to the upper Kbyte boundary.
|
||
|
||
For more details about FreeRTOS implementation on STM32Cube, please refer to UM1722 "Developing Applications
|
||
on STM32Cube with RTOS".
|
||
|
||
@par Directory contents
|
||
|
||
- USB_Host/HID_RTOS/Src/main.c Main program
|
||
- USB_Host/HID_RTOS/Src/system_stm32f1xx.c STM32F1xx system clock configuration file
|
||
- USB_Host/HID_RTOS/Src/stm32f1xx_it.c Interrupt handlers
|
||
- USB_Host/HID_RTOS/Src/menu.c HID State Machine
|
||
- USB_Host/HID_RTOS/Src/usbh_conf.c General low level driver configuration
|
||
- USB_Host/HID_RTOS/Src/mouse.c HID mouse functions file
|
||
- USB_Host/HID_RTOS/Src/keybaord.c HID keyboard functions file
|
||
- USB_Host/HID_RTOS/Inc/main.h Main program header file
|
||
- USB_Host/HID_RTOS/Inc/stm32f1xx_it.h Interrupt handlers header file
|
||
- USB_Host/HID_RTOS/Inc/lcd_log_conf.h LCD log configuration file
|
||
- USB_Host/HID_RTOS/Inc/stm32f1xx_hal_conf.h HAL configuration file
|
||
- USB_Host/HID_RTOS/Inc/usbh_conf.h USB Host driver Configuration file
|
||
- USB_Host/HID_RTOS/Inc/FreeRTOSConfig.h FreeRTOS Module Configuration file
|
||
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This example runs on STM32F107xx/STM32F105xx devices.
|
||
|
||
- This example has been tested with STMicroelectronics STM3210C-EVAL RevC
|
||
evaluation boards and can be easily tailored to any other supported device
|
||
and development board.
|
||
|
||
- STM3210C-EVAL RevC Set-up
|
||
- Plug a USB device mouse or keyboard into the STM3210C-EVAL board
|
||
through 'USB micro A-Male to A-Female' cable
|
||
|
||
|
||
@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
|
||
- Run the example
|
||
|
||
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
|
||
*/
|