forked from mfulz_github/qmk_firmware
Add human readable license information and add some missing module documentation briefs.
This commit is contained in:
Dean Camera
parent
43658f336e
commit
376160e2c0
File diff suppressed because one or more lines are too long
|
|
@ -9,14 +9,35 @@
|
|||
*
|
||||
* The LUFA library is currently released under the MIT license, included below.
|
||||
*
|
||||
* \section Sec_LicenseForHumans License Sumary for Human Beings
|
||||
* Everyone is free to use LUFA without payment - even in commercial applications
|
||||
* where the product source code is not publically disclosed. However, use of the
|
||||
* library must be in accordance with the library license conditions.
|
||||
*
|
||||
* If you wish to use LUFA without payment, you <b>must</b> include a copy of the
|
||||
* full license text below with your product or project - on your website, and in
|
||||
* an accompanying manual or other materials for the product. As long as the entire
|
||||
* license text is made available and obvious to the users of your product, you
|
||||
* are free to incorporate the LUFA library into your product without special
|
||||
* additional licensing.
|
||||
*
|
||||
* \section Sec_CommercialLicenses Commercial Licensing
|
||||
* In some instances the small requirement for public disclosure of LUFA within a
|
||||
* product is unwanted; in these instances a commecial license is offered up as an
|
||||
* alternative to the standard LUFA license.
|
||||
*
|
||||
* Commercial entities can opt out of the public disclosure clause in this license
|
||||
* for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
|
||||
* allows for the free use of the LUFA library, bootloaders and (where the sole copyright
|
||||
* is attributed to Dean Camera) demos without public disclosure within an organization, in
|
||||
* addition to three free hours of consultation with the library author, and priority support.
|
||||
* for a one-time US$1500 payment. This provides a non-exclusive modified MIT
|
||||
* licensed which allows for the free use of the LUFA library, bootloaders and
|
||||
* (where the sole copyright is attributed to Dean Camera) demos without public
|
||||
* disclosure within an organization, in addition to three free hours of consultation
|
||||
* with the library author, and priority support.
|
||||
*
|
||||
* Please visit the Commercial License link on \ref Page_Resources for more information on
|
||||
* ordering a commercial license for your company.
|
||||
*
|
||||
* \section Sec_LicenseText LUFA License Text
|
||||
*
|
||||
* \verbinclude License.txt
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassAOA Android Open Accessory Class Driver
|
||||
* \brief USB class driver for the Google Android Open Accessory class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassAudio Audio 1.0 Class Driver
|
||||
* \brief USB class driver for the USB-IF Audio 1.0 class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver
|
||||
* \brief USB class driver for the USB-IF CDC-ACM (Virtual Serial) class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassHID HID Class Driver
|
||||
* \brief USB class driver for the USB-IF Human Interface Device (HID) class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassMIDI MIDI Class Driver
|
||||
* \brief USB class driver for the USB-IF MIDI class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassMS Mass Storage Class Driver
|
||||
* \brief USB class driver for the USB-IF Bulk-Only Transport Mass Storage class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassPrinter Printer Class Driver
|
||||
* \brief USB class driver for the USB-IF Printer class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver
|
||||
* \brief USB class driver for the Microsoft Remote Network Driver Interface Specification (RNDIS) class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
|
||||
/** \ingroup Group_USBClassDrivers
|
||||
* \defgroup Group_USBClassSI Still Image Class Driver
|
||||
* \brief USB class driver for the USB-IF Still Image (PIMA-compliant) class standard.
|
||||
*
|
||||
* \section Sec_Dependencies Module Source Dependencies
|
||||
* The following files must be built with any user project that uses this module:
|
||||
|
|
|
|||
|
|
@ -47,8 +47,8 @@
|
|||
* @{
|
||||
*/
|
||||
|
||||
#ifndef __CONFIGDESCRIPTOR_H__
|
||||
#define __CONFIGDESCRIPTOR_H__
|
||||
#ifndef __CONFIGDESCRIPTORS_H__
|
||||
#define __CONFIGDESCRIPTORS_H__
|
||||
|
||||
/* Includes: */
|
||||
#include "../../../Common/Common.h"
|
||||
|
|
@ -119,16 +119,16 @@
|
|||
{
|
||||
HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor. */
|
||||
HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration
|
||||
* descriptor.
|
||||
*/
|
||||
* descriptor.
|
||||
*/
|
||||
HOST_GETCONFIG_PipeError = 2, /**< An error occurred in the pipe while sending the request. */
|
||||
HOST_GETCONFIG_SetupStalled = 3, /**< The attached device stalled the request to retrieve the configuration
|
||||
* descriptor.
|
||||
*/
|
||||
* descriptor.
|
||||
*/
|
||||
HOST_GETCONFIG_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */
|
||||
HOST_GETCONFIG_BuffOverflow = 5, /**< The device's configuration descriptor is too large to fit into the allocated
|
||||
* buffer.
|
||||
*/
|
||||
* buffer.
|
||||
*/
|
||||
HOST_GETCONFIG_InvalidData = 6, /**< The device returned invalid configuration descriptor data. */
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue