diff options
| author | HiFiPhile <[email protected]> | 2024-02-01 11:12:20 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-02-01 11:12:20 +0100 |
| commit | d692d7783408dc5ac1f3d21b40b06eff6d722910 (patch) | |
| tree | 2e9ec39d15071c5ce37a437aac729245da6ef57e /docs/contributing | |
| parent | 4c510c12b1d0a0bfb0726c0100ff22cd892aa1e8 (diff) | |
| parent | f505cc2add915c2e68c5d26a2804757c6b904bfe (diff) | |
Merge branch 'master' into src/portable/synopsys/dwc2/fix_sof_int_handling
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/porting.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/contributing/porting.rst b/docs/contributing/porting.rst index 710af51c3..f81d98782 100644 --- a/docs/contributing/porting.rst +++ b/docs/contributing/porting.rst @@ -62,9 +62,9 @@ Feel free to skip this until you want to verify your demo code is running. To im OS Abstraction Layer (OSAL) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The OS Abstraction Layer is responsible for providing basic data structures for TinyUSB that may allow for concurrency when used with an RTOS. Without an RTOS it simply handles concurrency issues between the main code and interrupts. +The OS Abstraction Layer is responsible for providing basic data structures for TinyUSB that may allow for concurrency when used with an RTOS. Without an RTOS it simply handles concurrency issues between the main code and interrupts. The code is almost entirely agnostic of MCU and lives in ``src/osal``. -The code is almost entirely agnostic of MCU and lives in ``src/osal``. +In RTOS configurations, tud_task()/tuh_task() blocks behind a synchronization structure when the event queue is empty, so that the scheduler may give the CPU to a different task. To take advantage of the library's capability to yield the CPU when there are no actionable USB device events, ensure that the `CFG_TUSB_OS` symbol is defined, e.g `OPT_OS_FREERTOS` enables the FreeRTOS scheduler to schedule other threads than that which calls `tud_task()/tuh_task()`. Device API ^^^^^^^^^^ |