142 lines
7.6 KiB
Plaintext
142 lines
7.6 KiB
Plaintext
/**
|
||
@page CustomHID_Standalone USB Device Custom HID application
|
||
|
||
@verbatim
|
||
******************************************************************************
|
||
* @file USB_Device/CustomHID_Standalone/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of the USB Custom HID application.
|
||
******************************************************************************
|
||
* @attention
|
||
*
|
||
* Copyright (c) 2016 STMicroelectronics.
|
||
* All rights reserved.
|
||
*
|
||
* This software is licensed under terms that can be found in the LICENSE file
|
||
* in the root directory of this software component.
|
||
* If no LICENSE file comes with this software, it is provided AS-IS.
|
||
*
|
||
******************************************************************************
|
||
@endverbatim
|
||
|
||
@par Application Description
|
||
|
||
Use of the USB device application based on the Custom HID Class.
|
||
|
||
This is a typical application on how to use the STM32F7xx USB OTG Device peripheral, where the STM32 MCU is
|
||
enumerated as a HID compliant device using the native PC Host HID driver to which the STM32F769I-EVAL
|
||
board is connected.
|
||
|
||
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 216 MHz. The Full Speed (FS) USB module uses
|
||
internally a 48-MHz clock which is coming from a specific output of two PLLs: main PLL or PLL SAI.
|
||
In the High Speed (HS) mode the USB clock (60 MHz) is driven by the ULPI.
|
||
|
||
The 48 MHz clock for the USB FS can be derived from one of the two following sources:
|
||
– PLL clock (clocked by the HSE): If the USB uses the PLL as clock source, the PLL VCO clock must be programmed
|
||
to output 432 MHz frequency (USBCLK = PLLVCO/PLLQ).
|
||
– PLLSAI clock (clocked by the HSE): If the USB uses the PLLSAI as clock source, the PLLSAI VCO clock must be programmed
|
||
to output 384 MHz frequency (USBCLK = PLLSAIVCO/PLLSAIP).
|
||
|
||
To test the application, user must proceed as follows:
|
||
- Start the "USB HID Demonstrator" PC applet, available for download from www.st.com,
|
||
and connect STM32 USB to PC
|
||
- The device should be detected and shown in the USB HID target box
|
||
- Press Graphic View button
|
||
- Select "use SET_FEATURE" or "use SET_REPORT" in order to use SET_REPORT request to send HID Report
|
||
for LED control
|
||
- Use the potentiometer of the STM32F769I-EVAL board to transfer the result of the converted voltage
|
||
(via the ADC) the to the PC host (these values are sent to the PC using the endpoint1 IN)
|
||
- Make sure that following report ID are configured: LED1 ID (0x1), LED2 ID(0x2), LED3 ID(0x3),
|
||
LED4 ID(0x4), BUTTON1_ID(0x5) and Potentiometer_ID(0x7).
|
||
- Select LEDs to switch on/off on the STM32F769I-EVAL board: a SET_REPORT request will be sent
|
||
|
||
@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 Device library, please refer to UM1734
|
||
"STM32Cube USB Device 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
|
||
|
||
@par Keywords
|
||
|
||
Connectivity, USB_Device, USB, HID, Full Speed, High Speed, Joystick, Mouse, OTG
|
||
|
||
@Note If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
|
||
then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
|
||
The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).
|
||
|
||
@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
|
||
It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
|
||
In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
|
||
Even though the user must manage the cache coherence for read accesses.
|
||
Please refer to the AN4838 “Managing memory protection unit (MPU) in STM32 MCUs”
|
||
Please refer to the AN4839 “Level 1 cache on STM32F7 Series”
|
||
|
||
@par Directory contents
|
||
|
||
- USB_Device/CustomHID_Standalone/Src/main.c Main program
|
||
- USB_Device/CustomHID_Standalone/Src/system_stm32f7xx.c STM32F7xx system clock configuration file
|
||
- USB_Device/CustomHID_Standalone/Src/stm32f7xx_it.c Interrupt handlers
|
||
- USB_Device/CustomHID_Standalone/Src/stm32f7xx_hal_msp.c HAL MSP module
|
||
- USB_Device/CustomHID_Standalone/Src/usbd_conf.c General low level driver configuration
|
||
- USB_Device/CustomHID_Standalone/Src/usbd_desc.c USB device descriptor
|
||
- USB_Device/CustomHID_Standalone/Inc/main.h Main program header file
|
||
- USB_Device/CustomHID_Standalone/Inc/stm32f7xx_it.h Interrupt handlers header file
|
||
- USB_Device/CustomHID_Standalone/Inc/stm32f7xx_hal_conf.h HAL configuration file
|
||
- USB_Device/CustomHID_Standalone/Inc/usbd_conf.h USB device driver Configuration file
|
||
- USB_Device/CustomHID_Standalone/Inc/usbd_desc.h USB device descriptor header file
|
||
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This application runs on STM32F767xx/STM32F769xx/STM32F777xx/STM32F779xx devices.
|
||
|
||
- This application has been tested with STMicroelectronics STM32F769I-EVAL
|
||
evaluation boards and can be easily tailored to any other supported device
|
||
and development board.
|
||
|
||
- STM32F769I-EVAL Set-up
|
||
- Connect the STM32F769I-EVAL board to the PC through 'USB micro A-Male
|
||
to A-Male' cable to the connector:
|
||
- CN8 : to use USB High Speed (HS)
|
||
- CN13: to use USB Full Speed (FS)
|
||
- CN14: 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 "USB OTG2 HS & FS" in STM32F769I_EVAL Evaluation Board
|
||
User Manual.
|
||
@note Make sure that :
|
||
- jumper JP14 must be removed when using USB OTG FS
|
||
- Use the Potentiometer (RV1) of the Eval board connected to PF.10.
|
||
|
||
|
||
@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:
|
||
- STM32F769I_EVAL_USBH-HS: to configure the project for STM32F7xx devices using USB OTG HS peripheral
|
||
- STM32F769I_EVAL_USBH-FS: to configure the project for STM32F7xx devices using USB OTG FS peripheral
|
||
- STM32F769I_EVAL_USBH-HS-IN-FS: to configure the project for STM32F7xx devices and use USB OTG HS
|
||
peripheral In FS (using embedded PHY).
|
||
- Run the application
|
||
|
||
|
||
*/
|
||
|