diff options
| author | Ha Thach <[email protected]> | 2025-11-17 23:34:04 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-11-17 23:34:04 +0700 |
| commit | 66c84528f67c0eedc23d25221500d820e702d93f (patch) | |
| tree | f09f88b100d1e65b56d76a3715ce9d6aeada8f87 /docs | |
| parent | 20c36442246279d884a6b61066fda6778c1c06ee (diff) | |
| parent | 117350222301bc0c9f70104e8a1c4080c34810f2 (diff) | |
Merge pull request #3345 from hathach/update-iso-alloc
make dcd_edpt_iso_alloc/activate as default API for ISO endpoint
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/porting.rst | 10 |
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()`` """"""""""""""""""" |