mirror of
https://github.com/STMicroelectronics/STM32CubeF3.git
synced 2025-04-28 13:48:53 +08:00
/** @page HID_Standalone USB Device Human Interface (HID) example @verbatim ****************************************************************************** * @file USB_Device/HID_Standalone/readme.txt * @author MCD Application Team * @brief Description of the USB HID example. ****************************************************************************** * @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 Example Description Use of the USB device application based on the Human Interface (HID). This is a typical example on how to use the USB peripheral in Device mode with HID class V1.11 following the "Device Class Definition for Human Interface Devices (HID) Version 1.11 Jun 27, 2001". The example is built around the USB device library and emulate the Mouse directions using Joystick buttons mounted on the STM32303C-EVAL board. This example supports the remote wakeup feature (the ability to bring the USB suspended bus back to the active condition), and the Key button is used as the remote wakeup source. By default, in Windows OS, the USB mouse Power Management feature is turned off. This setting is different from classic PS/2 computer functionality. To enable the Wake up from standby option, user has to manually turn on the Power Management feature for the USB mouse. To enable the wake from standby option for the USB mouse, the following steps have to be followed: - Start "Device Manager", - Select "Mice and other pointing devices", - Select the "HID-compliant mouse" device (make sure that PID &VID are equal to 0x5710 & 0x0483 respectively) - Right click and select "Properties", - Select "Power Management" tab, - Finally click to select "Allow this device to wake the computer" check box. 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. It is possible to remappe the USB interrupts (USB_LP and USB_WKUP) on interrupt lines 75 and 76. User can select USB line Interrupt through macro defined in main.h. (USE_USB_INTERRUPT_DEFAULT and USE_USB_INTERRUPT_REMAPPED) @note The application needs to ensure that the SysTick time base is set to 1 millisecond to have correct HAL configuration. @note To reduce the example footprint, the toolchain dynamic allocation is replaced by a static allocation by returning the address of a pre-defined static buffer with the HID class structure size. @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 built-in USB peripheral of the STM32F3x does not provide a specific interrupt for USB cable plug/unplug detection. The correct way to detect the USB cable plug/unplug is to detect the availability of the VBUS line using a normal GPIO pin (external interrupt line). @par Directory contents - USB_Device/HID_Standalone/Src/main.c Main program - USB_Device/HID_Standalone/Src/system_stm32f3xx.c STM32f3xx system clock configuration file - USB_Device/HID_Standalone/Src/stm32f3xx_it.c Interrupt handlers - USB_Device/HID_Standalone/Src/usbd_conf.c General low level driver configuration - USB_Device/HID_Standalone/Src/usbd_desc.c USB device HID descriptor - USB_Device/HID_Standalone/Inc/main.h Main program header file - USB_Device/HID_Standalone/Inc/stm32f3xx_it.h Interrupt handlers header file - USB_Device/HID_Standalone/Inc/stm32f3xx_hal_conf.h HAL configuration file - USB_Device/HID_Standalone/Inc/usbd_conf.h USB device driver Configuration file - USB_Device/HID_Standalone/Inc/usbd_desc.h USB device MSC descriptor header file @par Hardware and Software environment - This example runs on STM32F303xx devices. - This example has been tested with STMicroelectronics STM32303C-EVAL evaluation boards and can be easily tailored to any other supported device and development board. - STM32303C-EVAL Set-up - Connect the STM32303C-EVAL board to the PC through 'USB Type A-Male to A-Male' @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 */