ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.

Browse source
This commit is contained in:
Dean Camera 2010-12-26 14:55:26 +00:00
parent 2073b96d82
commit a8b66f318d
109 changed files with 357 additions and 318 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LUFA/Drivers/USB/Class/Audio.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for Device
* USB mode only. User applications can use this class driver instead of implementing the Audio class manually via
* the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/CDC.h
View file

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial
* Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
* CDC class manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Common/Audio.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassAudio
* @defgroup Group_USBClassAudioCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Audio 1.0 Class.
*

2
LUFA/Drivers/USB/Class/Common/CDC.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassCDC
* @defgroup Group_USBClassCDCCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* CDC Class.
*

2
LUFA/Drivers/USB/Class/Common/HID.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassHID
* @defgroup Group_USBClassHIDCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* HID Class.
*

2
LUFA/Drivers/USB/Class/Common/MIDI.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMIDI
* @defgroup Group_USBClassMIDICommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* MIDI Class.
*

2
LUFA/Drivers/USB/Class/Common/MassStorage.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassMS
* @defgroup Group_USBClassMSCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Mass Storage Class.
*

2
LUFA/Drivers/USB/Class/Common/Printer.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassPrinter
* @defgroup Group_USBClassPrinterCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Printer Class.
*

2
LUFA/Drivers/USB/Class/Common/RNDIS.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassRNDIS
* @defgroup Group_USBClassRNDISCommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* RNDIS Class.
*

2
LUFA/Drivers/USB/Class/Common/StillImage.h
View file

@ -40,7 +40,7 @@
/** \ingroup Group_USBClassSI
* @defgroup Group_USBClassSICommon Common Class Definitions
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
* Still Image Class.
*

2
LUFA/Drivers/USB/Class/Device/Audio.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/Audio.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/CDC.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the CDC USB Class driver.
*
* \note There are several major drawbacks to the CDC-ACM standard USB class, however

2
LUFA/Drivers/USB/Class/Device/HID.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the HID USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/MIDI.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/MassStorage.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Device/RNDIS.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/HID.h
View file

@ -46,7 +46,7 @@
* - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
* and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
* via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Host/CDC.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the CDC USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/HID.h
View file

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the HID USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/HIDParser.h
View file

@ -43,7 +43,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
*
* The processed HID report is presented back to the user application as a flat structure containing each report

2
LUFA/Drivers/USB/Class/Host/MIDI.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/MassStorage.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/Printer.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/Printer.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Printer USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/Host/RNDIS.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet
* USB Class driver.
*

2
LUFA/Drivers/USB/Class/Host/StillImage.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
*
* @{

2
LUFA/Drivers/USB/Class/MIDI.h
View file

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device
* and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manually
* via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/MassStorage.h
View file

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Mass Storage Class Driver module. This module contains an internal implementation of the USB Mass Storage Class, for both
* Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class
* manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/Printer.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/Printer.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Printer Class Driver module. This module contains an internal implementation of the USB Printer Class, for the base
* USB Printer transport layer for USB Host mode only. Note that printers are free to implement whatever printer language
* they choose on top of this (e.g. Postscript), and so this driver exposes low level data transport functions only rather

2
LUFA/Drivers/USB/Class/RNDIS.h
View file

@ -45,7 +45,7 @@
* - LUFA/Drivers/USB/Class/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
* - LUFA/Drivers/USB/Class/Host/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking
* Class, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
* RNDIS class manually via the low-level LUFA APIs.

2
LUFA/Drivers/USB/Class/StillImage.h
View file

@ -44,7 +44,7 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/USB/Class/Host/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Still Image Class Driver module. This module contains an internal implementation of the USB Still Image Class,
* for USB Host mode only. User applications can use this class driver instead of implementing the Still Image class
* manually via the low-level LUFA APIs.

6
LUFA/Drivers/USB/USB.h
View file

@ -55,7 +55,7 @@
* - LUFA/Drivers/USB/HighLevel/PipeStream.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
* - LUFA/Drivers/USB/HighLevel/USBTask.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
*
* \section Module Description
* \section Sec_ModDescription Module Description
* Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module
* consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
* or OTG mode USB applications.
@ -139,7 +139,7 @@
* slightly differently, and thus will be explained separately. For information on a specific class driver, read
* the class driver's module documentation.
*
* \subsection SSec_ClassDriverDevice Device Mode Class Drivers
* \subsection Sec_ClassDriverDevice Device Mode Class Drivers
* Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
* the module configuration and state structure must be added to the project source. These structures are named in a
* similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Device_t</i>, and are used to hold the
@ -238,7 +238,7 @@
* read and write routines. See each driver's individual documentation for more information on the
* class-specific functions.
*
* \subsection SSec_ClassDriverHost Host Mode Class Drivers
* \subsection Sec_ClassDriverHost Host Mode Class Drivers
* Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
* the module configuration and state structure must be added to the project source. These structures are named in a
* similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Host_t</i>, and are used to hold the