summaryrefslogtreecommitdiff
path: root/docs/porting.rst
diff options
context:
space:
mode:
authorHiFiPhile <[email protected]>2025-11-19 22:05:07 +0100
committerHiFiPhile <[email protected]>2025-11-19 22:05:07 +0100
commit85adf694e659bde41b34e2f585cb2db552279064 (patch)
tree6445badf0b427556fd47fb3d7b682bb8b439039e /docs/porting.rst
parent2f0a35f21af4c09154d6b4b5b118325af8990e51 (diff)
parent790c7a0d7a6099e88a0bf6bbc341504c8bdaa974 (diff)
Merge remote-tracking branch 'tinyusb/master' into copilot/fix-dcd-edpt-xfer-issue
Signed-off-by: HiFiPhile <[email protected]>
Diffstat (limited to 'docs/porting.rst')
-rw-r--r--docs/porting.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/porting.rst b/docs/porting.rst
index c3076354c..9b60ec5a2 100644
--- a/docs/porting.rst
+++ b/docs/porting.rst
@@ -173,12 +173,22 @@ Also make sure to enable endpoint specific interrupts.
``dcd_edpt_close()``
""""""""""""""""""""
+.. warning::
+ This function is deprecated, ISO transfer should implement dcd_edpt_iso_alloc() and dcd_edpt_iso_activate() instead.
+
Close an endpoint. his function is used for implementing alternate settings.
After calling this, the device should not respond to any packets directed towards this endpoint. When called, this function must abort any transfers in progress through this endpoint, before returning.
Implementation is optional. Must be called from the USB task. Interrupts could be disabled or enabled during the call.
+``dcd_edpt_iso_alloc() / dcd_edpt_iso_activate()``
+""""""""""""""""""""""""""""""""""""""""""""""""""
+
+dcd_edpt_iso_alloc() is used to allocate largest buffer (for all alternative interfaces) for ISO endpoints when device is enumerated. This allows DCD to allocate necessary resources for ISO endpoints in the future.
+
+dcd_edpt_iso_activate() is used to activate or deactivate ISO endpoint when alternate setting is set with active max packet size.
+
``dcd_edpt_xfer()``
"""""""""""""""""""