summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorslc-tl <[email protected]>2023-04-14 17:07:33 -0600
committerGitHub <[email protected]>2023-04-14 17:07:33 -0600
commit8c780a9564a05ea0f0e3bf0d929fd5dbe6c4806a (patch)
treebc1164b633393d9dd07da48bdd27fa1363699128 /docs/contributing
parent723e21ad6a97d17c406f83b5ff6ae6571c611e86 (diff)
Update porting.rst
Adds more in depth documentation of how tud_task does not need to be polled in implementations that use an RTOS / scheduler.
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/porting.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/contributing/porting.rst b/docs/contributing/porting.rst
index 710af51c3..9ec392661 100644
--- a/docs/contributing/porting.rst
+++ b/docs/contributing/porting.rst
@@ -69,7 +69,7 @@ The code is almost entirely agnostic of MCU and lives in ``src/osal``.
Device API
^^^^^^^^^^
-After the USB device is setup, the USB device code works by processing events on the main thread (by calling ``tud_task``\ ). These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
+After the USB device is setup, the USB device code works by processing events on the main thread (by calling ``tud_task``\ ). In RTOS configurations, tud_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 in your modified ``tusb_config.h``. For example `#define CFG_TUSB_OS OPT_OS_FREERTOS` enables the FreeRTOS scheduler to schedule other threads than that which calls `tud_task`. These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
All of the code for the low-level device API is in ``src/portable/<vendor>/<chip family>/dcd_<chip family>.c``.