Commit b335c19b authored by Johann Fischer's avatar Johann Fischer Committed by Anas Nashif
Browse files

doc: move USB documentation to connectivity 



Mostly moved and reorganised content to the Connectivity chapter,
separated API references. Fill in some gaps in the USB device
documentation.

Signed-off-by: default avatarJohann Fischer <johann.fischer@nordicsemi.no>
parent 09a9a7ed

MAINTAINERS.yml

+1 −1
Original line number Diff line number Diff line
@@ -2619,7 +2619,7 @@ USB: 
    - subsys/usb/

    - tests/subsys/usb/

    - tests/drivers/udc/

    - doc/services/usb/

    - doc/connectivity/usb/

  labels:

    - "area: USB"

doc/connectivity/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -9,4 +9,5 @@ Connectivity 
   bluetooth/index.rst

   networking/index.rst

   lora_lorawan/index.rst

   usb/index.rst

   usb_c/index.rst

doc/connectivity/usb/api/hid.rst

0 → 100644
+25 −0
Original line number Diff line number Diff line 
.. _usb_hid_common:



Human Interface Devices (HID)

#############################



Common USB HID part that can be used outside of USB support, defined in

header file :zephyr_file:`include/zephyr/usb/class/hid.h`.



HID types reference

*******************



.. doxygengroup:: usb_hid_definitions



HID items reference

*******************



.. doxygengroup:: usb_hid_items



HID Mouse and Keyboard report descriptors

*****************************************



The pre-defined Mouse and Keyboard report descriptors can be used by

a HID device implementation or simply as examples.



.. doxygengroup:: usb_hid_mk_report_desc

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

0 → 100644
+11 −0
Original line number Diff line number Diff line 
.. _usb_api:



USB device support APIs

#######################



.. toctree::

   :maxdepth: 1



   usb_dc.rst

   usb_device.rst

   usb_device_hid.rst

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

0 → 100644
+16 −0
Original line number Diff line number Diff line 
.. _usb_dc_api:



USB device controller driver API

################################



The USB device controller driver API is described in

:zephyr_file:`include/zephyr/drivers/usb/usb_dc.h` and sometimes referred to

as the ``usb_dc`` API.



This API has some limitations by design, it does not follow :ref:`device_model_api`

and is being replaced by a new UDC driver API.



API reference

*************



.. doxygengroup:: _usb_device_controller_api

CRA Git | Maintained and supported by SUSTech CRA and CCSE