alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/usb_host_docs' into 'master'

Browse Source 
Add USB Host Library API docs

See merge request espressif/esp-idf!15013
This commit is contained in:
Darian
2021-09-02 14:05:08 +00:00
parent db33e957b8 963836f491
commit c8aab00fdb
17 changed files with 199 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en/api-reference/peripherals/index.rst
View File

@@ -34,5 +34,6 @@ Peripherals API
TWAI <twai>
UART <uart>
:SOC_USB_OTG_SUPPORTED: USB Device <usb_device>
:SOC_USB_OTG_SUPPORTED: USB Host <usb_host>
Code examples for this API section are provided in the :example:`peripherals` directory of ESP-IDF examples.

26
docs/en/api-reference/peripherals/usb_host.rst Normal file
View File

@@ -0,0 +1,26 @@
USB Host
========
.. warning::
The USB Host Library API is a beta version thus is subject to change.
The following document lists the API and types of the USB Host Library (that is currently under development).
API Reference
-------------
The API of the USB Host Library is separated into the following header files. However, it is sufficient for applications to only ``#include "usb/usb_host.h"`` and all of USB Host Library headers will also be included.
- :component_file:`usb/include/usb/usb_host.h` contains the functions and types of the USB Host Library
- :component_file:`usb/include/usb/usb_helpers.h` contains various helper functions that are related to the USB protocol such as descriptor parsing.
- :component_file:`usb/include/usb/usb_types_stack.h` contains types that are are used across multiple layers of the USB Host stack.
- :component_file:`usb/include/usb/usb_types_ch9.h` contains types and macros related to Chapter 9 of the USB2.0 specification (i.e., descriptors and standard requests).
.. include-build-file:: inc/usb_host.inc
.. include-build-file:: inc/usb_helpers.inc
.. include-build-file:: inc/usb_types_stack.inc
.. include-build-file:: inc/usb_types_ch9.inc