Skip to content

Commit 1d43aec

Browse files
committed
applications: nrf_desktop: doc: usb_state: generalize dwc2 udc support
Refactor the documentation of the USB State module from the nRF Desktop application to generalize the support for the DWC2 USB Device Controller driver. Signed-off-by: Kamil Piszczek <[email protected]>
1 parent 8fe0761 commit 1d43aec

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

applications/nrf_desktop/doc/usb_state.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To select the USB stack, enable one of the following Kconfig choice options:
3737
The USB legacy stack is used by default.
3838
* :ref:`CONFIG_DESKTOP_USB_STACK_NEXT <config_desktop_app_options>`
3939
The option enables USB next stack (:kconfig:option:`CONFIG_USB_DEVICE_STACK_NEXT`).
40-
This is the only USB stack that supports USB High-Speed and the nRF54H20 devices.
40+
This is the only USB stack that supports SoCs with USB High-Speed (such as the nRF54H20 SoC).
4141

4242
.. note::
4343
The USB next stack integration is :ref:`experimental <software_maturity>`.
@@ -85,7 +85,7 @@ The module informs that the HID report was sent using :c:struct:`hid_report_sent
8585
In the case of :ref:`nrf_desktop_hid_mouse_report_handling`, enabling the USB SOF synchronization also synchronizes motion sensor sampling with the USB SOF instead of USB polls (motion sensor sampling is synchronized to :c:struct:`hid_report_sent_event`).
8686
This synchronization ensures that the sensor is sampled more evenly.
8787

88-
The :ref:`CONFIG_DESKTOP_USB_HID_REPORT_SENT_ON_SOF <config_desktop_app_options>` Kconfig option is enabled by default on the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`) to mitigate a negative impact of jitter related to USB polls.
88+
The :ref:`CONFIG_DESKTOP_USB_HID_REPORT_SENT_ON_SOF <config_desktop_app_options>` Kconfig option is enabled by default on devices (such as the nRF54H20 SoC) that use an UDC driver with High-Speed support (:kconfig:option:`CONFIG_UDC_DRIVER_HAS_HIGH_SPEED_SUPPORT`) to mitigate a negative impact of jitter related to USB polls.
8989
The negative impact of the jitter is more visible for USB High-Speed.
9090

9191
.. _nrf_desktop_usb_state_hid_class_instance:
@@ -236,15 +236,12 @@ The |usb_state| is a transport for :ref:`nrf_desktop_config_channel` when the ch
236236
The module also handles a HID keyboard LED output report received through USB from the connected host.
237237
The module sends the report using :c:struct:`hid_report_event`, that is handled either by :ref:`nrf_desktop_hid_state` (for peripheral) or by the :ref:`nrf_desktop_hid_forward` (for dongle).
238238

239-
nRF54H20 support
240-
================
239+
DWC2 USB device controller support
240+
==================================
241241

242-
Due to the characteristics of the nRF54H20 USB Device Controller (UDC), following change has been made in the USB state module to support the nRF54H20 devices:
243-
244-
* The module disables the USB stack when the USB cable is disconnected and enables the stack when the cable is connected.
245-
246-
This change is applicable to the nRF54H20 devices only.
247-
It is necessary to ensure proper USB stack operation on the nRF54H20 devices.
242+
Due to the characteristics of the DWC2 USB Device Controller (UDC), the USB state module disables the USB stack when the USB cable is disconnected and enables the stack when the cable is connected.
243+
These actions are necessary to ensure proper USB stack operation.
244+
This change is applicable to the devices that use the DWC2 USB driver (such as the nRF54H20 SoC).
248245

249246
The :kconfig:option:`CONFIG_UDC_DWC2_USBHS_VBUS_READY_TIMEOUT` Kconfig option is set to a non-zero value to prevent the :c:func:`usbd_enable` function from blocking the application forever when the USB cable is not connected.
250247
Instead, the function returns an error on timeout.

0 commit comments

Comments
 (0)