Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 3.51 KB

README.md

File metadata and controls

90 lines (57 loc) · 3.51 KB
Raw

Ux_Host_HID_Standalone application description

This application provides an example of Azure RTOS USBX stack usage . It shows how to develop bare metal USB Host Human Interface "HID" able to enumerate and communicates with a mouse or a keyboard.

The application's main calls the MX_USBX_Host_Init() function in order to Initialize USBX and USBX_Host_Process in the while loop.

As stated earlier, the present application runs in standalone mode without ThreadX, for this reason, the standalone variant of USBX is enabled by adding the following flag in ux_user.h:

  • #define UX_STANDALONE

The application is designed to behave as an USB HID Host, the code provides required requests to properly enumerate HID devices , HID Class APIs to decode HID reports received from a mouse or a keyboard and display data on uart HyperTerminal.

Expected success behavior

When a HID device is plugged to NUCLEO-L4R5ZI board, a Message will be displayed on the uart HyperTerminal showing the Vendor ID and Product ID of the attached device. After enumeration phase, a message will indicate that the device is ready for use. The host must be able to properly decode HID reports sent by the corresponding device and display those information on the HyperTerminal.

The received HID reports are used by host to identify: in case of a mouse

  • (x,y) mouse position
  • Wheel position
  • Pressed mouse buttons

in case of a keyboard

  • Pressed key

Error behaviors

Errors are detected such as (Unsupported device, Enumeration Fail) and the corresponding message is displayed on the HyperTerminal.

Assumptions if any

User is familiar with USB 2.0 "Universal Serial BUS" Specification and HID class Specification.

Known limitations

None.

Keywords

Standalone, USBXHost, USB_OTG, Full Speed, HID, Mouse, Keyboard,

Hardware and Software environment

  • This application runs on STM32L4R5xx devices.

  • This application has been tested with STMicroelectronics NUCLEO-L4R5ZI boards Revision MB1312 A-01 and can be easily tailored to any other supported device and development board.

  • NUCLEO-L4R5ZI Set-up

    • Plug the USB HID device into the NUCLEO-L4R5ZI board through 'USB micro A-Male to A-Female' cable to the connector:
      • CN13 : to use USB Full Speed OTG IP.
    • Connect ST-Link cable to the PC USB port to display data on the HyperTerminal.

    A virtual COM port will then appear in the HyperTerminal:

    • Hyperterminal configuration
      • Data Length = 8 Bits
      • One Stop Bit
      • No parity
      • BaudRate = 115200 baud
      • Flow control: None

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 application

Notes

The user has to check the list of the COM ports in Device Manager to find out the number of the COM ports that have been assigned (by OS) to the Stlink VCP.

Note

The user has to check the list of the COM ports in Device Manager to find out the number of the COM ports that have been assigned (by OS) to the Stlink VCP.

The application uses the bypass HSE clock (STlink MCO Output) which is HSI/2 (Default configuration).

MCO from ST-LINK: MCO output of ST-LINK is used as input clock. This frequency cannot be changed, it is fixed at 8 MHz and connected to the PF0/PH0-OSC_IN of STM32 microcontroller.

The configuration must be:

  • SB147 OFF
  • SB109 and SB148 ON
  • SB12 and SB13 OFF