diff options
| author | HiFiPhile <[email protected]> | 2026-08-01 19:22:52 +0200 |
|---|---|---|
| committer | HiFiPhile <[email protected]> | 2026-08-01 19:22:52 +0200 |
| commit | cd9bbed39f5851d5e4dc64271f18b8db777acb53 (patch) | |
| tree | 83866c4127a6d808ba9eb6d543fe5d3787cd3af2 /docs/reference/class/index.rst | |
| parent | f3021b337fcea154b898489c417d428c92f88e92 (diff) | |
doc: add class docscodex/class-reference-docs
Signed-off-by: HiFiPhile <[email protected]>
Diffstat (limited to 'docs/reference/class/index.rst')
| -rw-r--r-- | docs/reference/class/index.rst | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/reference/class/index.rst b/docs/reference/class/index.rst new file mode 100644 index 000000000..2f8e577d0 --- /dev/null +++ b/docs/reference/class/index.rst @@ -0,0 +1,96 @@ +************* +Class Drivers +************* + +Class drivers implement USB protocols such as CDC serial, HID, mass storage, +and MIDI. Enable only the classes your product uses: device APIs start with +``tud_`` and host APIs start with ``tuh_``. + +Start with :doc:`device` or :doc:`host`, then use the class page for its +configuration, data flow, callbacks, and examples. The API lists below focus +on the calls normally needed by an application; the public headers remain the +complete API reference. + +Support matrix +============== + +.. list-table:: + :header-rows: 1 + :widths: 24 18 18 40 + + * - Class + - Device + - Host + - Guide + * - Audio 1.0/2.0 + - Yes + - No + - :doc:`audio` + * - Bluetooth HCI + - Yes + - No + - :doc:`bluetooth` + * - CDC serial + - Yes + - Yes + - :doc:`cdc` + * - DFU 1.1 + - Yes + - No + - :doc:`dfu` + * - HID 1.11 + - Yes + - Yes + - :doc:`hid` + * - MIDI 1.0/2.0 + - Yes + - Yes + - :doc:`midi` + * - Mass Storage (BOT) + - Yes + - Yes + - :doc:`msc` + * - Media Transfer (MTP) + - Yes + - No + - :doc:`mtp` + * - Network (ECM/RNDIS/NCM) + - Yes + - No + - :doc:`network` + * - Printer + - Yes + - No + - :doc:`printer` + * - Test and Measurement (USBTMC) + - Yes + - No + - :doc:`usbtmc` + * - Vendor-specific + - Yes + - Custom driver + - :doc:`vendor` + * - Video 1.5 + - Yes + - No + - :doc:`video` + +.. toctree:: + :maxdepth: 1 + :hidden: + + device + host + audio + bluetooth + cdc + dfu + hid + midi + msc + mtp + network + printer + usbtmc + vendor + video |