Skip to content

Commit 53c9919

Browse files
committed
samples: usb: update USB samples root documentation
Add note about legacy samples and update USB samples root documentation. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
1 parent b2f4e24 commit 53c9919

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

samples/subsys/usb/legacy/legacy.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. zephyr:code-sample-category:: usb_legacy
2+
:name: Legacy USB device support
3+
4+
These samples demonstrate the use of legacy USB device support in Zephyr RTOS.
5+
6+
.. note::
7+
These samples use a legacy :ref:`usb_device_stack` that is in the
8+
deprecation process.
9+
10+
.. zephyr:code-sample-listing::
11+
:categories: usb_legacy
12+
:live-search:

samples/subsys/usb/usb.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
.. zephyr:code-sample-category:: usb
2-
:name: USB device support
3-
:show-listing:
4-
:glob: **/*
2+
:name: USB
53

6-
Samples that demonstrate :ref:`usb_device_stack`.
4+
These samples demonstrate the use of USB support in Zephyr RTOS.
5+
6+
Most of the USB support samples can be found under :zephyr_file:`samples/subsys/usb`
7+
in the Zephyr project tree. However, there are a few functions whose samples
8+
are located in different directories. These are:
9+
10+
* Bluetooth HCI USB transport layer implementation is covered by
11+
:zephyr:code-sample:`bluetooth_hci_usb`
12+
* USB CDC ECM and USB CDC NCM implementations are covered by the networking
13+
samples :zephyr:code-sample:`zperf` or :zephyr:code-sample:`sockets-http-server`
14+
15+
.. zephyr:code-sample-listing::
16+
:categories: usb
17+
:live-search:

0 commit comments

Comments
 (0)