Skip to content

Latest commit

 

History

History
146 lines (110 loc) · 8.34 KB

README.md

File metadata and controls

146 lines (110 loc) · 8.34 KB
Raw

Ux_Device_HID_CDC_ACM application description

This application provides an example of Azure RTOS USBX stack usage on STM32L4R9I-Discovery board, it shows how to develop a composite USB Device communication Class "HID" and "CDC_ACM" based application.

The application is designed to emulate an USB HID mouse device and USB-to-UART bridge following the Virtual COM Port (VCP) implementations, the code provides all required device descriptors framework and associated to both Classes descriptor report to build a composite compliant USB HID_CDC_ACM device. At the beginning ThreadX call the entry function tx_application_define(), at this stage, all USBx resources are initialized, the CDC_ACM and HID Class driver is registered and the application creates 4 threads with the same priorities :

  • app_ux_device_thread_entry (Prio : 10; PreemptionPrio : 10) used to initialize USB OTG HAL PCD driver and start the device.

  • usbx_cdc_acm_read_thread_entry (Prio : 20; PreemptionPrio : 20) used to Read the received data from Virtual COM Port.

  • usbx_cdc_acm_write_thread_entry (Prio : 20; PreemptionPrio : 20) used to send the received data over UART .

  • usbx_hid_thread_entry (Prio : 20; PreemptionPrio : 20) used to send HID reports to move automatically the PC host machine cursor. During enumeration phase, four communication pipes "endpoints" are declared in the CDC class and HID implementations :

  • 1 x Bulk IN endpoint for receiving data from STM32 device to PC host: When data are received over UART they are saved in the buffer "UserTxBufferFS". Periodically, in a usbx_cdc_acm_write_thread_entry the state of the buffer "UserTxBufferFS" is checked. If there are available data, they are transmitted in response to IN token otherwise it is NAKed.

  • 1 x Bulk OUT endpoint for transmitting data from PC host to STM32 device: When data are received through this endpoint they are saved in the buffer "UserRxBufferFS" then they are transmitted over UART using DMA mode and in meanwhile the OUT endpoint is NAKed. Once the transmission is over, the OUT endpoint is prepared to receive next packet in HAL_UART_RxCpltCallback().

  • 1 x Interrupt IN endpoint for setting and getting serial-port parameters: When control setup is received, the corresponding request is executed in USBD_CDC_ACM_ParameterChange.

In CDC_ACM application, two requests are implemented:

- Set line: Set the bit rate, number of Stop bits, parity, and number of data bits
- Get line: Get the bit rate, number of Stop bits, parity, and number of data bits
The other requests (send break, control line state) are not implemented.

  • 1 x Interrupt IN endpoint for setting the HID position: When the User Button is pressed the application calls the GetPointerData() API to update the mouse position (x, y) and send the report buffer through the ux_device_class_hid_event_set() API. Note

  • Receiving data over UART is handled by interrupt while transmitting is handled by DMA allowing hence the application to receive data at the same time it is transmitting another data (full- duplex feature). The support of the VCP interface is managed through the ST Virtual COM Port driver available for download from www.st.com.

  • The user has to check the list of HID and the COM ports in Device Manager to find out the HID device and the COM port number that have been assigned (by OS) to the VCP interface.

Expected success behavior

When plugged to PC host, the STM32L4R9I-Discovery must be properly enumerated a composite device as an HID ,USB Serial device and an STlink Com port. During the enumeration phase, the device must provide host with the requested descriptors (Device descriptor, configuration descriptor, string descriptors). Those descriptors are used by host driver to identify the device capabilities. Once STM32L4R9I-Discovery USB device successfully completed the enumeration phase. Connect USB cable to Host , Open two hyperterminals (USB com port and UART com port) to send/receive data to/from host to/from device. When USER_Button is pressed, the device sneds a HID report. Each report sent should move the PC host machine mouse cursor by one step.

Error behaviors

Host PC shows that USB device does not operate as designed (Enumeration failed, for example PC Cursor doesn't move or Com port enumeration failed).

Assumptions if any

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

Known limitations

None.

Notes

ThreadX usage hints

  • ThreadX uses the Systick as time base, thus it is mandatory that the HAL uses a separate time base through the TIM IPs.

  • ThreadX is configured with 100 ticks/sec by default, this should be taken into account when using delays or timeouts at application. It is always possible to reconfigure it in the "tx_user.h", the "TX_TIMER_TICKS_PER_SECOND" define,but this should be reflected in "tx_initialize_low_level.S" file too.

  • ThreadX is disabling all interrupts during kernel start-up to avoid any unexpected behavior, therefore all system related calls (HAL, BSP) should be done either at the beginning of the application or inside the thread entry functions.

  • ThreadX offers the "tx_application_define()" function, that is automatically called by the tx_kernel_enter() API. It is highly recommended to use it to create all applications ThreadX related resources (threads, semaphores, memory pools...) but it should not in any way contain a system API call (HAL or BSP).

  • Using dynamic memory allocation requires to apply some changes to the linker file. ThreadX needs to pass a pointer to the first free memory location in RAM to the tx_application_define() function, using the "first_unused_memory" argument. This require changes in the linker files to expose this memory location.

    • For EWARM add the following section into the .icf file:
    place in RAM_region    { last section FREE_MEM };
    • For MDK-ARM:
    either define the RW_IRAM1 region in the ".sct" file
or modify the line below in "tx_initialize_low_level.S to match the memory region being used
    LDR r1, =|Image$$RW_IRAM1$$ZI$$Limit|
    • For STM32CubeIDE add the following section into the .ld file:
    ._threadx_heap :
  {
     . = ALIGN(8);
     __RAM_segment_used_end__ = .;
     . = . + 64K;
     . = ALIGN(8);
   } >RAM_D1 AT> RAM_D1

    The simplest way to provide memory for ThreadX is to define a new section, see ._threadx_heap above.
In the example above the ThreadX heap size is set to 64KBytes.
The ._threadx_heap must be located between the .bss and the ._user_heap_stack sections in the linker script.
Caution: Make sure that ThreadX does not need more than the provided heap memory (64KBytes in this example).
Read more in STM32CubeIDE User Guide, chapter: "Linker script".
    • The "tx_initialize_low_level.S" should be also modified to enable the "USE_DYNAMIC_MEMORY_ALLOCATION" flag.

USBX usage hints

Keywords

RTOS, ThreadX, USBX, USBXDevice, USB_OTG, High Speed, CDC, HID, VCP, USART, DMA, Mouse.

Hardware and Software environment

  • This example runs on STM32L4R9xx devices

  • This example has been tested with STMicroelectronics STM32L4R9I-Discovery boards Revision MB1311 C-01 and can be easily tailored to any other supported device and development board.

  • STM32L4R9I-Discovery Set-up

  • Connect the STM32L4R9I-Discovery board CN1 to the PC through "MICRO-USB" to "Standard A" cable.

  • For VCP the configuration is dynamic for example it can be :

    • BaudRate = 115200 baud
    • Word Length = 8 Bits
    • Stop Bit = 1
    • Parity = None
    • Flow control = None

  • The USART2 interface available on PA2 and PA3 of the microcontroller are connected to ST-LINK MCU. By default the USART2 communication between the target MCU and ST-LINK MCU is enabled.

It's configuration is as following: - BaudRate = 115200 baud - Word Length = 8 Bits - Stop Bit = 1 - Parity = None - Flow control = None

Note

  • When we configure the VCP baudrate under 9600 the USART2 baudrate shall be set to 9600.

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