Merge pull request #3423 from armusin/threadx_osal

ThreadX OSAL header

Author: hathach

.github/workflows/claude-code-review.yml

@@ -1,27 +1,15 @@
 name: Claude Code Review
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, synchronize, ready_for_review, reopened]
-    # Optional: Only run on specific file changes
-    # paths:
-    #   - "src/**/*.ts"
-    #   - "src/**/*.tsx"
-    #   - "src/**/*.js"
-    #   - "src/**/*.jsx"
 
 jobs:
   claude-review:
-    # Optional: Filter by PR author
-    # if: |
-    #   github.event.pull_request.user.login == 'external-contributor' ||
-    #   github.event.pull_request.user.login == 'new-developer' ||
-    #   github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
-
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      pull-requests: read
+      pull-requests: write
       issues: read
       id-token: write
 

AGENTS.md

@@ -114,21 +114,72 @@ Use `-DBOARD=...` with any supported board under `hw/bsp/espressif/boards/`. NEV
     - `cd examples/device/cdc_msc_freertos`
     - `idf.py -DBOARD=espressif_s3_devkitc monitor`
 
-## J-Link GDB Server + RTT Logging
+## GDB Debugging
+
+Look up the board's `JLINK_DEVICE` and `OPENOCD_OPTION` from `hw/bsp/*/boards/*/board.cmake` (or `board.mk`).
+
+### JLinkGDBServer
+
+**Terminal 1 – start the GDB server:**
+```bash
+JLinkGDBServer -device stm32h743xi -if SWD -speed 4000 \
+  -port 2331 -swoport 2332 -telnetport 2333 -nogui
+```
+
+**Terminal 2 – connect GDB:**
+```bash
+arm-none-eabi-gdb /tmp/build/firmware.elf
+(gdb) target remote :2331
+(gdb) monitor reset halt
+(gdb) load
+(gdb) continue
+```
+
+To break on entry instead of running immediately:
+```bash
+(gdb) monitor reset halt
+(gdb) load
+(gdb) break main
+(gdb) continue
+```
+
+### OpenOCD
+
+**Terminal 1 – start the GDB server:**
+```bash
+openocd -f interface/stlink.cfg -f target/stm32h7x.cfg
+# or with J-Link probe:
+openocd -f interface/jlink.cfg -f target/stm32h7x.cfg
+```
+
+For boards that define `OPENOCD_OPTION` in `board.cmake`, use those options directly:
+```bash
+openocd $(cat hw/bsp/FAMILY/boards/BOARD/board.cmake | grep OPENOCD_OPTION | ...)
+```
+
+**Terminal 2 – connect GDB (OpenOCD default port is 3333):**
+```bash
+arm-none-eabi-gdb /tmp/build/firmware.elf
+(gdb) target remote :3333
+(gdb) monitor reset halt
+(gdb) load
+(gdb) continue
+```
+
+### RTT Logging with JLinkGDBServer
 
 - Build with RTT logging enabled (example):
   `cd examples/device/cdc_msc && make BOARD=stm32h743eval LOG=2 LOGGER=rtt all`
 - Flash with J-Link:
   `cd examples/device/cdc_msc && make BOARD=stm32h743eval LOG=2 LOGGER=rtt flash-jlink`
-- Launch GDB server (keep this running in terminal 1):
+- Launch GDB server with RTT port (keep this running in terminal 1):
   `JLinkGDBServer -device stm32h743xi -if SWD -speed 4000 -port 2331 -swoport 2332 -telnetport 2333 -RTTTelnetPort 19021 -nogui`
 - Read RTT output (terminal 2):
   `JLinkRTTClient`
 - Capture RTT to file (optional):
   `JLinkRTTClient | tee rtt.log`
 - For non-interactive capture:
   `timeout 20s JLinkRTTClient > rtt.log`
-- Use the board-specific `JLINK_DEVICE` from `hw/bsp/*/boards/*/board.mk` if you are not using `stm32h743eval`.
 
 ## Unit Testing
 

docs/faq.rst

@@ -15,7 +15,7 @@ Yes, TinyUSB is released under the MIT license, allowing commercial use with min
 
 **Q: Does TinyUSB require an RTOS?**
 
-No, TinyUSB works in bare metal environments. It also supports FreeRTOS, RT-Thread, and Mynewt.
+No, TinyUSB works in bare metal environments. It also supports FreeRTOS, RT-Thread, ThreadX, and Mynewt.
 
 **Q: How much memory does TinyUSB use?**
 

examples/device/board_test/src/main.c

@@ -39,11 +39,35 @@ enum {
 
 #define HELLO_STR   "Hello from TinyUSB\r\n"
 
-int main(void) {
-  board_init();
-  board_led_write(true);
+// board test example does not use both device and host stack
+#if CFG_TUSB_OS != OPT_OS_NONE
+uint32_t tusb_time_millis_api(void) {
+  return osal_time_millis();
+}
+
+void tusb_time_delay_ms_api(uint32_t ms) {
+  osal_task_delay(ms);
+}
+#endif
+
+//--------------------------------------------------------------------+
+//
+//--------------------------------------------------------------------+
+
+// Task parameter type: ULONG for ThreadX, void* for FreeRTOS and noos
+#if CFG_TUSB_OS == OPT_OS_THREADX
+  #define RTOS_PARAM ULONG
+#elif CFG_TUSB_OS == OPT_OS_FREERTOS
+  #define RTOS_PARAM void*
+  static void freertos_init(void);
+#else
+  #define RTOS_PARAM void*
+#endif
 
+static void board_test_loop(RTOS_PARAM param) {
+  (void) param;
   uint32_t start_ms = 0;
+  (void) start_ms;
   bool led_state = false;
 
   while (1) {
@@ -58,26 +82,94 @@ int main(void) {
     }
 
     // Blink and print every interval ms
-    if (!(tusb_time_millis_api() - start_ms < interval_ms)) {
-      start_ms = tusb_time_millis_api();
-
-      if (ch < 0) {
-        // skip if echoing
-        printf(HELLO_STR);
+    #if CFG_TUSB_OS == OPT_OS_FREERTOS
+    vTaskDelay(interval_ms / portTICK_PERIOD_MS);
+    #elif CFG_TUSB_OS == OPT_OS_THREADX
+    tx_thread_sleep(_osal_ms2tick(interval_ms));
+    #else
+    if (tusb_time_millis_api() - start_ms < interval_ms) {
+      continue; // not enough time
+    }
+    #endif
+    start_ms = tusb_time_millis_api();
 
-        #ifndef LOGGER_UART
-        board_uart_write(HELLO_STR, sizeof(HELLO_STR)-1);
-        #endif
-      }
+    if (ch < 0) {
+      // skip if echoing
+      printf(HELLO_STR);
 
-      board_led_write(led_state);
-      led_state = !led_state; // toggle
+      #ifndef LOGGER_UART
+      board_uart_write(HELLO_STR, sizeof(HELLO_STR)-1);
+      #endif
     }
+
+    board_led_write(led_state);
+    led_state = !led_state; // toggle
   }
 }
 
+int main(void) {
+  board_init();
+  board_led_write(true);
+
+#if CFG_TUSB_OS == OPT_OS_FREERTOS
+  freertos_init();
+#elif CFG_TUSB_OS == OPT_OS_THREADX
+  tx_kernel_enter();
+#else
+  board_test_loop(NULL);
+#endif
+
+  return 0;
+}
+
 #ifdef ESP_PLATFORM
 void app_main(void) {
   main();
 }
 #endif
+
+//--------------------------------------------------------------------+
+// FreeRTOS
+//--------------------------------------------------------------------+
+#if CFG_TUSB_OS == OPT_OS_FREERTOS
+
+#ifdef ESP_PLATFORM
+#define MAIN_STACK_SIZE   4096
+#else
+#define MAIN_STACK_SIZE   512
+#endif
+
+#if configSUPPORT_STATIC_ALLOCATION
+static StackType_t  _main_stack[MAIN_STACK_SIZE];
+static StaticTask_t _main_taskdef;
+#endif
+
+static void freertos_init(void) {
+  #if configSUPPORT_STATIC_ALLOCATION
+  xTaskCreateStatic(board_test_loop, "main", MAIN_STACK_SIZE, NULL, 1, _main_stack, &_main_taskdef);
+  #else
+  xTaskCreate(board_test_loop, "main", MAIN_STACK_SIZE, NULL, 1, NULL);
+  #endif
+
+  #ifndef ESP_PLATFORM
+  vTaskStartScheduler();
+  #endif
+}
+
+//--------------------------------------------------------------------+
+// ThreadX
+//--------------------------------------------------------------------+
+#elif CFG_TUSB_OS == OPT_OS_THREADX
+
+#define MAIN_TASK_STACK_SIZE  1024
+static TX_THREAD _main_thread;
+static ULONG _main_thread_stack[MAIN_TASK_STACK_SIZE / sizeof(ULONG)];
+
+void tx_application_define(void *first_unused_memory) {
+  (void) first_unused_memory;
+  static CHAR main_thread_name[] = "main";
+  tx_thread_create(&_main_thread, main_thread_name, board_test_loop, 0,
+                   _main_thread_stack, MAIN_TASK_STACK_SIZE,
+                   1, 1, TX_NO_TIME_SLICE, TX_AUTO_START);
+}
+#endif