summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorHa Thach <[email protected]>2023-04-28 11:36:14 +0700
committerGitHub <[email protected]>2023-04-28 11:36:14 +0700
commit2afef458be5ddea97d286f5dd8d3925c4846ee6e (patch)
treefa1c69c6377cb668f4f86937555741e9c30bd161 /docs/contributing
parenta41ab41b8b49e35fd0182472bd61909015f706cf (diff)
parent090078542fd8b9a11d72163b11b99e7d25f63072 (diff)
Merge pull request #2030 from slc-tl/patch-1
Update porting.rst
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/porting.rst4
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
^^^^^^^^^^