Add file-level brief documentation.
Remove accidentally duplicated model-specific peripheral driver files.
This commit is contained in:
parent
ec19436d54
commit
0557676013
111 changed files with 1039 additions and 453 deletions
|
|
@ -29,10 +29,14 @@
|
|||
*/
|
||||
|
||||
/** \file
|
||||
* \brief Configuration descriptor parser API.
|
||||
*
|
||||
* Configuration descriptor parser API. This section of the library gives a friendly API which can be used in
|
||||
* host applications to easily parse an attached device's configuration descriptor so that endpoint, interface
|
||||
* and other descriptor data can be extracted and used as needed.
|
||||
* This section of the library gives a friendly API which can be used in host applications to easily
|
||||
* parse an attached device's configuration descriptor so that endpoint, interface and other descriptor
|
||||
* data can be extracted and used as needed.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_Descriptors
|
||||
|
|
|
|||
|
|
@ -28,6 +28,25 @@
|
|||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB controller events manager.
|
||||
*
|
||||
* This file contains macros and functions relating to the management of library events, which are small
|
||||
* pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from
|
||||
* multiple places in the user or library code, which may or may not be inside an ISR, thus each handler
|
||||
* should be written to be as small and fast as possible to prevent possible problems.
|
||||
*
|
||||
* Events can be hooked by the user application by declaring a handler function with the same name and parameters
|
||||
* listed here. If an event with no user-associated handler is fired within the library, it by default maps to an
|
||||
* internal empty stub function.
|
||||
*
|
||||
* Each event must only have one associated event handler, but can be raised by multiple sources by calling the
|
||||
* event handler function (with any required event parameters).
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_USB
|
||||
* @defgroup Group_Events USB Events
|
||||
*
|
||||
|
|
|
|||
|
|
@ -28,6 +28,15 @@
|
|||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB standard descriptor definitions.
|
||||
*
|
||||
* This file contains structures and macros for the easy creation of standard USB descriptors in USB device projects.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_USB
|
||||
* @defgroup Group_Descriptors USB Descriptors
|
||||
*
|
||||
|
|
|
|||
|
|
@ -28,11 +28,20 @@
|
|||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB control endpoint request definitions.
|
||||
*
|
||||
* This file contains structures and macros for the easy creation and parsing of standard USB control requests.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_USB
|
||||
* @defgroup Group_StdRequest Standard USB Requests
|
||||
*
|
||||
* This module contains definitions for the various control request parameters, so that the request
|
||||
* details (such as data direction, request recipient, etc.) can be extracted via masking.
|
||||
* details (such as data direction, request recipient, etc.) can be extracted via masking.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,6 +27,16 @@
|
|||
arising out of or in connection with the use or performance of
|
||||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB endpoint/pipe stream callback management.
|
||||
*
|
||||
* This file contains definitions for the creation of optional callback routines which can be passed to the
|
||||
* endpoint and/or pipe stream APIs, to abort the transfer currently in progress when a condition is met.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_USB
|
||||
* @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks
|
||||
|
|
|
|||
|
|
@ -28,6 +28,16 @@
|
|||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB controller interrupt service routine management.
|
||||
*
|
||||
* This file contains definitions required for the correct handling of low level USB service routine interrupts
|
||||
* from the USB controller.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
#ifndef __USBINTERRUPT_H__
|
||||
#define __USBINTERRUPT_H__
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,17 @@
|
|||
this software.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
* \brief USB mode and capability macros.
|
||||
*
|
||||
* This file defines macros indicating the type of USB controller the library is being compiled for, and its
|
||||
* capabilities. These macros may then be referenced in the user application to selectively enable or disable
|
||||
* code sections depending on if they are defined or not.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
/** \ingroup Group_USB
|
||||
* @defgroup Group_USBMode USB Mode Tokens
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,7 +27,17 @@
|
|||
arising out of or in connection with the use or performance of
|
||||
this software.
|
||||
*/
|
||||
|
||||
|
||||
/** \file
|
||||
* \brief Main USB service task management.
|
||||
*
|
||||
* This file contains the function definitions required for the main USB service task, which must be called
|
||||
* from the user application to ensure that the USB connection to or from a connected USB device is maintained.
|
||||
*
|
||||
* \note This file should not be included directly. It is automatically included as needed by the USB driver
|
||||
* dispatch header located in LUFA/Drivers/USB/USB.h.
|
||||
*/
|
||||
|
||||
#ifndef __USBTASK_H__
|
||||
#define __USBTASK_H__
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue