doc: usb: Move generated api to the right place

Move USB API to the right place.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2018-10-03 12:48:17 +03:00 committed by Anas Nashif
commit add69d60e3
3 changed files with 31 additions and 12 deletions

View file

@ -28,3 +28,4 @@ The Zephyr APIs are used the same way on all SoCs and boards.
misc_api
logger_api
shell_api
usb_api

21
doc/api/usb_api.rst Normal file
View file

@ -0,0 +1,21 @@
.. _usb_api:
USB subsystem API
#################
.. contents::
:depth: 2
:local:
:backlinks: top
USB Device Controller API
*************************
.. doxygengroup:: _usb_device_controller_api
:project: Zephyr
USB Device Core Layer API
*************************
.. doxygengroup:: _usb_device_core_api
:project: Zephyr

View file

@ -31,13 +31,6 @@ to deal directly with the hardware. All device controller drivers should
implement the APIs described in file usb_dc.h. This allows the integration of
new USB device controllers to be done without changing the upper layers.
.. _usb_device_controller_api:
USB Device Controller API
=========================
.. doxygengroup:: _usb_device_controller_api
:project: Zephyr
USB device core layer
*********************
@ -55,11 +48,6 @@ functionalities:
* Uses the APIs provided by the device controller drivers to interact with
the USB device controller.
USB Device Core Layer API
=========================
.. doxygengroup:: _usb_device_core_api
:project: Zephyr
USB device class drivers
************************
@ -326,4 +314,13 @@ USB transaction(s), depending endpoint max packet size. The class driver does
not have to implement endpoint callback and should set this callback to the
generic usb_transfer_ep_callback.
Further reading
***************
More information on the stack and its usage can be found in the following
subsections:
.. toctree::
:maxdepth: 2
../../api/usb_api.rst