Skip to content

Commit c828f5d

Browse files
jfischer-nonashif
authored andcommitted
doc: usb: add VID/PID documentation for the new USB device stack
The content is almost identical to that of the legacy stack because we either ported or rewrote all the samples. Signed-off-by: Johann Fischer <[email protected]>
1 parent 96944d9 commit c828f5d

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.. _usbd_vid_pid:
2+
3+
USB Vendor and Product identifiers
4+
**********************************
5+
6+
The USB Vendor ID for the Zephyr project is ``0x2FE3``. Zephyr USB Vendor ID must
7+
not be used when a vendor integrates Zephyr USB device support into its own
8+
product.
9+
10+
Each USB :zephyr:code-sample-category:`sample<usb>` has its own unique Product ID.
11+
The USB maintainer, if one is assigned, or otherwise the Zephyr Technical
12+
Steering Committee, may allocate other USB Product IDs based on well-motivated
13+
and documented requests.
14+
15+
The following Product IDs are currently used:
16+
17+
+----------------------------------------------------+--------+
18+
| Sample | PID |
19+
+====================================================+========+
20+
| :zephyr:code-sample:`usb-cdc-acm` | 0x0001 |
21+
+----------------------------------------------------+--------+
22+
| Reserved (previously: usb-cdc-acm-composite) | 0x0002 |
23+
+----------------------------------------------------+--------+
24+
| Reserved (previously: usb-hid-cdc) | 0x0003 |
25+
+----------------------------------------------------+--------+
26+
| :zephyr:code-sample:`usb-cdc-acm-console` | 0x0004 |
27+
+----------------------------------------------------+--------+
28+
| :zephyr:code-sample:`usb-dfu` (Run-Time) | 0x0005 |
29+
+----------------------------------------------------+--------+
30+
| Reserved (previously: usb-hid) | 0x0006 |
31+
+----------------------------------------------------+--------+
32+
| :zephyr:code-sample:`usb-hid-mouse` | 0x0007 |
33+
+----------------------------------------------------+--------+
34+
| :zephyr:code-sample:`usb-mass` | 0x0008 |
35+
+----------------------------------------------------+--------+
36+
| :zephyr:code-sample:`testusb-app` | 0x0009 |
37+
+----------------------------------------------------+--------+
38+
| :zephyr:code-sample:`webusb` | 0x000A |
39+
+----------------------------------------------------+--------+
40+
| :zephyr:code-sample:`bluetooth_hci_usb` | 0x000B |
41+
+----------------------------------------------------+--------+
42+
| Reserved (previously: bluetooth_hci_usb_h4) | 0x000C |
43+
+----------------------------------------------------+--------+
44+
| Reserved (previously: wpan-usb) | 0x000D |
45+
+----------------------------------------------------+--------+
46+
| :zephyr:code-sample:`uac2-explicit-feedback` | 0x000E |
47+
+----------------------------------------------------+--------+
48+
| :zephyr:code-sample:`uac2-implicit-feedback` | 0x000F |
49+
+----------------------------------------------------+--------+
50+
| :zephyr:code-sample:`uvc` | 0x0011 |
51+
+----------------------------------------------------+--------+
52+
| :zephyr:code-sample:`usb-dfu` (DFU Mode) | 0xFFFF |
53+
+----------------------------------------------------+--------+

doc/connectivity/usb/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ USB
1717
:maxdepth: 1
1818

1919
device_next/usb_device.rst
20+
device_next/vid_pid.rst
2021
device_next/api/index.rst
2122
host/api/index.rst
2223
host/usbip.rst

0 commit comments

Comments
 (0)