usb_host.rst 1.2 KB

1234567891011121314151617181920212223242526
  1. USB Host
  2. ========
  3. .. warning::
  4. The USB Host Library API is a beta version thus is subject to change.
  5. The following document lists the API and types of the USB Host Library (that is currently under development).
  6. API Reference
  7. -------------
  8. 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.
  9. - :component_file:`usb/include/usb/usb_host.h` contains the functions and types of the USB Host Library
  10. - :component_file:`usb/include/usb/usb_helpers.h` contains various helper functions that are related to the USB protocol such as descriptor parsing.
  11. - :component_file:`usb/include/usb/usb_types_stack.h` contains types that are are used across multiple layers of the USB Host stack.
  12. - :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).
  13. .. include-build-file:: inc/usb_host.inc
  14. .. include-build-file:: inc/usb_helpers.inc
  15. .. include-build-file:: inc/usb_types_stack.inc
  16. .. include-build-file:: inc/usb_types_ch9.inc