Skip to content

Commit 5ab1539

Browse files
jfischer-nojfischer-no
committed
usb: mark new stack as unstable and set it as the default
Document that the legacy stack is now deprecated. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
1 parent ea37188 commit 5ab1539

File tree

24 files changed

+44
-56
lines changed

24 files changed

+44
-56
lines changed

‎doc/connectivity/usb/device/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_api:
22

3-
USB device support APIs
4-
#######################
3+
USB device support APIs (deprecated)
4+
####################################
55

66
.. toctree::
77
:maxdepth: 1

‎doc/connectivity/usb/device/api/usb_dc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_dc_api:
22

3-
USB device controller driver API
4-
################################
3+
USB device controller driver API (deprecated)
4+
#############################################
55

66
The USB device controller driver API is described in
77
:zephyr_file:`include/zephyr/drivers/usb/usb_dc.h` and sometimes referred to

‎doc/connectivity/usb/device/api/usb_device.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_device_stack_api:
22

3-
USB device stack API
4-
####################
3+
USB device stack API (deprecated)
4+
#################################
55

66
API reference
77
*************

‎doc/connectivity/usb/device/api/usb_device_bos.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_bos_api:
22

3-
Binary Device Object Store (BOS) support API
4-
############################################
3+
Binary Device Object Store (BOS) support API (deprecated)
4+
#########################################################
55

66
API reference
77
*************

‎doc/connectivity/usb/device/api/usb_device_hid.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_hid_device:
22

3-
USB HID Class API
4-
#################
3+
USB HID Class API (deprecated)
4+
##############################
55

66
USB device specific part for HID support defined in
77
:zephyr_file:`include/zephyr/usb/class/usb_hid.h`.

‎doc/connectivity/usb/device/usb_device.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_device_stack:
22

3-
USB device support
4-
##################
3+
USB device support (deprecated)
4+
###############################
55

66
.. contents::
77
:local:
@@ -26,10 +26,9 @@ over time. It provides the following functionalities:
2626
:zephyr_file:`include/zephyr/usb/usb_device.h`
2727

2828
.. note::
29-
It is planned to deprecate all APIs listed in :ref:`usb_api` and the
30-
functions that depend on them between Zephyr v4.1.0 and v4.2.0, and remove
31-
them in v4.4.0. The new USB device support, represented by the APIs in
32-
:ref:`usb_device_next_api`, will become the default in Zephyr v4.2.0.
29+
All APIs listed in :ref:`usb_api` and the functions that depend on them are
30+
deprecated and will be remove in v4.4.0. Please use the new USB device
31+
support represented by the APIs in :ref:`usb_device_next_api`.
3332

3433
Supported USB classes
3534
*********************

‎doc/connectivity/usb/device_next/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_device_next_api:
22

3-
New USB device support APIs
4-
###########################
3+
USB device support APIs
4+
#######################
55

66
.. toctree::
77
:maxdepth: 1

‎doc/connectivity/usb/device_next/api/udc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The USB device controller driver API is described in
77
:zephyr_file:`include/zephyr/drivers/usb/udc.h` and referred to
88
as the ``UDC driver`` API.
99

10-
UDC driver API is experimental and is subject to change without notice.
10+
UDC driver API is unstable and is subject to change without notice.
1111
It is a replacement for :ref:`usb_dc_api`. If you wish to port an existing
1212
driver to UDC driver API, or add a new driver, please use
1313
:zephyr_file:`drivers/usb/udc/udc_skeleton.c` as a starting point.

‎doc/connectivity/usb/device_next/api/usbd.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _usbd_api:
22

3-
USB device stack (next) API
4-
###########################
3+
USB device stack API
4+
####################
55

6-
New USB device stack API is experimental and is subject to change without notice.
6+
USB device stack API is unstable and is subject to change without notice.
77

88
API reference
99
*************

‎doc/connectivity/usb/device_next/usb_device.rst

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _usb_device_stack_next:
22

3-
New USB device support
4-
######################
3+
USB device support
4+
##################
55

66
Overview
77
********
@@ -10,19 +10,16 @@ USB device support consists of the USB device controller (UDC) drivers
1010
, :ref:`udc_api`, and USB device stack, :ref:`usbd_api`.
1111
The :ref:`udc_api` provides a generic and vendor independent interface to USB
1212
device controllers, and although, there a is clear separation between these
13-
layers, the purpose of :ref:`udc_api` is to serve new Zephyr's USB device stack
13+
layers, the purpose of :ref:`udc_api` is to serve Zephyr's USB device stack
1414
exclusively.
1515

16-
The new device stack supports multiple device controllers, meaning that if a
16+
The device stack supports multiple device controllers, meaning that if a
1717
SoC has multiple controllers, they can be used simultaneously. Full and
1818
high-speed device controllers are supported. It also provides support for
1919
registering multiple function or class instances to a configuration at runtime,
2020
or changing the configuration later. It has built-in support for several USB
2121
classes and provides an API to implement custom USB functions.
2222

23-
The new USB device support is considered experimental and will replace
24-
:ref:`usb_device_stack`.
25-
2623
Samples
2724
=======
2825

@@ -32,13 +29,6 @@ Samples
3229

3330
* :zephyr:code-sample:`uac2-implicit-feedback`
3431

35-
Samples ported to new USB device support
36-
----------------------------------------
37-
38-
To build a sample that supports both the old and new USB device stack, set the
39-
configuration ``-DCONF_FILE=usbd_next_prj.conf`` either directly or via
40-
``west``.
41-
4232
* :zephyr:code-sample:`bluetooth_hci_usb`
4333

4434
* :zephyr:code-sample:`usb-cdc-acm`
@@ -49,7 +39,7 @@ configuration ``-DCONF_FILE=usbd_next_prj.conf`` either directly or via
4939

5040
* :zephyr:code-sample:`usb-hid-mouse`
5141

52-
* :zephyr:code-sample:`zperf` To build the sample for the new device support,
42+
* :zephyr:code-sample:`zperf` To build the sample for the device support,
5343
set the configuration overlay file
5444
``-DDEXTRA_CONF_FILE=overlay-usbd_next_ecm.conf`` and devicetree overlay file
5545
``-DDTC_OVERLAY_FILE="usbd_next_ecm.overlay`` either directly or via ``west``.

0 commit comments

Comments
 (0)