Skip to content

Commit 2afef45

Browse files
authored
Merge pull request hathach#2030 from slc-tl/patch-1
Update porting.rst
2 parents a41ab41 + 0900785 commit 2afef45

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/contributing/porting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ Feel free to skip this until you want to verify your demo code is running. To im
6262
OS Abstraction Layer (OSAL)
6363
^^^^^^^^^^^^^^^^^^^^^^^^^^^
6464

65-
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.
65+
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``.
6666

67-
The code is almost entirely agnostic of MCU and lives in ``src/osal``.
67+
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()`.
6868

6969
Device API
7070
^^^^^^^^^^

0 commit comments

Comments
 (0)