summaryrefslogtreecommitdiff
path: root/docs/reference/class/index.rst
blob: 2f8e577d0437cc29682f8644529dec08c90c5b4a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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