+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this\r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in\r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief Master include file for the library USB functionality.\r
- *\r
- * Master include file for the library USB functionality.\r
- *\r
- * This file should be included in all user projects making use of the USB portions of the library, instead of\r
- * the individual USB driver submodule headers.\r
- */\r
-\r
-/** \defgroup Group_USB USB Core - LUFA/Drivers/USB/USB.h\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/USB/Core/ConfigDescriptors.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/DeviceStandardReq.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/Events.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/HostStandardReq.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/USBTask.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/Device_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/Endpoint_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/EndpointStream_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/Host_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/Pipe_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/PipeStream_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/USBController_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Core/<i>ARCH</i>/USBInterrupt_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- * - LUFA/Drivers/USB/Class/Common/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- *\r
- * \section Sec_ModDescription Module Description\r
- * Driver and framework for the USB controller of the selected architecture and microcontroller model. This module\r
- * consists of many submodules, and is designed to provide an easy way to configure and control USB host, device\r
- * or OTG mode USB applications.\r
- *\r
- * The USB stack requires the sole control over the USB controller in the microcontroller only; i.e. it does not\r
- * require any additional timers or other peripherals to operate. This ensures that the USB stack requires as few\r
- * resources as possible.\r
- *\r
- * The USB stack can be used in Device Mode for connections to USB Hosts (see \ref Group_Device), in Host mode for\r
- * hosting of other USB devices (see \ref Group_Host), or as a dual role device which can either act as a USB host\r
- * or device depending on what peripheral is connected (see \ref Group_OTG). Both modes also require a common set\r
- * of USB management functions found \ref Group_USBManagement.\r
- */\r
-\r
-/** \defgroup Group_USBClassDrivers USB Class Drivers\r
- *\r
- * Drivers for both host and device mode of the standard USB classes, for rapid application development.\r
- * Class drivers give a framework which sits on top of the low level library API, allowing for standard\r
- * USB classes to be implemented in a project with minimal user code. These drivers can be used in\r
- * conjunction with the library low level APIs to implement interfaces both via the class drivers and via\r
- * the standard library APIs.\r
- *\r
- * Multiple device mode class drivers can be used within a project, including multiple instances of the\r
- * same class driver. In this way, USB Hosts and Devices can be made quickly using the internal class drivers\r
- * so that more time and effort can be put into the end application instead of the USB protocol.\r
- *\r
- * The available class drivers and their modes are listed below.\r
- *\r
- * <table>\r
- * <tr>\r
- * <th width="200px">USB Class</th>\r
- * <th width="90px">Device Mode</th>\r
- * <th width="90px">Host Mode</th>\r
- * </tr>\r
- * <tr>\r
- * <td>Android Open Accessory</td>\r
- * <td bgcolor="#EE0000">No</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>Audio 1.0</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>CDC-ACM</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>HID</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>MIDI</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>Mass Storage</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>Printer</td>\r
- * <td bgcolor="#EE0000">No</td>\r
-* <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>RNDIS</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * <tr>\r
- * <td>Still Image</td>\r
- * <td bgcolor="#EE0000">No</td>\r
- * <td bgcolor="#00EE00">Yes</td>\r
- * </tr>\r
- * </table>\r
- *\r
- *\r
- * \section Sec_UsingClassDrivers Using the Class Drivers\r
- * To make the Class drivers easy to integrate into a user application, they all implement a standardized\r
- * design with similarly named/used function, enums, defines and types. The two different modes are implemented\r
- * slightly differently, and thus will be explained separately. For information on a specific class driver, read\r
- * the class driver's module documentation.\r
- *\r
- * \subsection Sec_ClassDriverDevice Device Mode Class Drivers\r
- * Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly,\r
- * the module configuration and state structure must be added to the project source. These structures are named in a\r
- * similar manner between classes, that of <tt>USB_ClassInfo_<i>{Class Name}</i>_Device_t</tt>, and are used to hold the\r
- * complete state and configuration for each class instance. Multiple class instances is where the power of the class\r
- * drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's \c USB_ClassInfo_*\r
- * structure.\r
- *\r
- * Inside the ClassInfo structure lies two sections, a \c Config section, and a \c State section. The \c Config\r
- * section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>\r
- * before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters\r
- * for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.\r
- *\r
- * The following is an example of a properly initialized instance of the Audio Class Driver structure:\r
- *\r
- * \code\r
- * USB_ClassInfo_Audio_Device_t My_Audio_Interface =\r
- * {\r
- * .Config =\r
- * {\r
- * .StreamingInterfaceNumber = 1,\r
- * .DataINEndpoint =\r
- * {\r
- * .Address = (ENDPOINT_DIR_IN | 1),\r
- * .Size = 64,\r
- * .Banks = 1,\r
- * },\r
- * },\r
- * };\r
- * \endcode\r
- *\r
- * \note The class driver's configuration parameters should match those used in the device's descriptors that are\r
- * sent to the host.\r
- *\r
- * To initialize the Class driver instance, the driver's <tt><i>{Class Name}</i>_Device_ConfigureEndpoints()</tt> function\r
- * should be called in response to the \ref EVENT_USB_Device_ConfigurationChanged() event. This function will return a\r
- * boolean true value if the driver successfully initialized the instance. Like all the class driver functions, this function\r
- * takes in the address of the specific instance you wish to initialize - in this manner, multiple separate instances of\r
- * the same class type can be initialized like this:\r
- *\r
- * \code\r
- * void EVENT_USB_Device_ConfigurationChanged(void)\r
- * {\r
- * LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
- * \r
- * if (!(Audio_Device_ConfigureEndpoints(&My_Audio_Interface)))\r
- * LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
- * }\r
- * \endcode\r
- *\r
- * Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's\r
- * <tt><i>{Class Name}</i>_Device_USBTask()</tt> function in the main program loop. The exact implementation of this\r
- * function varies between class drivers, and can be used for any internal class driver purpose to maintain each\r
- * instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each\r
- * separate instance, just like the main USB maintenance routine \ref USB_USBTask():\r
- *\r
- * \code\r
- * int main(void)\r
- * {\r
- * SetupHardware();\r
- * \r
- * LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
- * \r
- * for (;;)\r
- * {\r
- * if (USB_DeviceState != DEVICE_STATE_Configured)\r
- * Create_And_Process_Samples();\r
- * \r
- * Audio_Device_USBTask(&My_Audio_Interface);\r
- * USB_USBTask();\r
- * }\r
- * }\r
- * \endcode\r
- *\r
- * The final standardized Device Class Driver function is the Control Request handler function\r
- * <tt><i>{Class Name}</i>_Device_ProcessControlRequest()</tt>, which should be called when the\r
- * \ref EVENT_USB_Device_ControlRequest() event fires. This function should also be called for\r
- * each class driver instance, using the address of the instance to operate on as the function's\r
- * parameter. The request handler will abort if it is determined that the current request is not\r
- * targeted at the given class driver instance, thus these methods can safely be called\r
- * one-after-another in the event handler with no form of error checking:\r
- *\r
- * \code\r
- * void EVENT_USB_Device_ControlRequest(void)\r
- * {\r
- * Audio_Device_ProcessControlRequest(&My_Audio_Interface);\r
- * }\r
- * \endcode\r
- *\r
- * Each class driver may also define a set of callback functions (which are prefixed by \c CALLBACK_*\r
- * in the function's name) which <b>must</b> also be added to the user application - refer to each\r
- * individual class driver's documentation for mandatory callbacks. In addition, each class driver may\r
- * also define a set of events (identifiable by their prefix of \c EVENT_* in the function's name), which\r
- * the user application <b>may</b> choose to implement, or ignore if not needed.\r
- *\r
- * The individual Device Mode Class Driver documentation contains more information on the non-standardized,\r
- * class-specific functions which the user application can then use on the driver instances, such as data\r
- * read and write routines. See each driver's individual documentation for more information on the\r
- * class-specific functions.\r
- *\r
- * \subsection Sec_ClassDriverHost Host Mode Class Drivers\r
- * Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly,\r
- * the module configuration and state structure must be added to the project source. These structures are named in a\r
- * similar manner between classes, that of <tt>USB_ClassInfo_<b>{Class Name}</b>_Host_t</tt>, and are used to hold the\r
- * complete state and configuration for each class instance. Multiple class instances is where the power of the class\r
- * drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's \c USB_ClassInfo_*\r
- * structure.\r
- *\r
- * Inside the \c USB_ClassInfo_* structure lies two sections, a \c Config section, and a \c State section. The \c Config\r
- * section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>\r
- * before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters\r
- * for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.\r
- *\r
- * The following is an example of a properly initialized instance of the MIDI Host Class Driver structure:\r
- *\r
- * \code\r
- * USB_ClassInfo_MIDI_Host_t My_MIDI_Interface =\r
- * {\r
- * .Config =\r
- * {\r
- * .DataINPipe =\r
- * {\r
- * .Address = (PIPE_DIR_IN | 1),\r
- * .Size = 64,\r
- * .Banks = 1,\r
- * },\r
- * .DataOUTPipe =\r
- * {\r
- * .Address = (PIPE_DIR_OUT | 2),\r
- * .Size = 64,\r
- * .Banks = 1,\r
- * },\r
- * },\r
- * };\r
- * \endcode\r
- *\r
- * To initialize the Class driver instance, the driver's <tt><b>{Class Name}</b>_Host_ConfigurePipes()</tt> function\r
- * should be called in response to the \c EVENT_USB_Host_DeviceEnumerationComplete() event firing. This function will\r
- * will return an error code from the class driver's <tt><b>{Class Name}</b>_EnumerationFailure_ErrorCodes_t</tt> enum\r
- * to indicate if the driver successfully initialized the instance and bound it to an interface in the attached device.\r
- * Like all the class driver functions, this function takes in the address of the specific instance you wish to initialize -\r
- * in this manner, multiple separate instances of the same class type can be initialized. A fragment of a Class Driver\r
- * based Host mode application may look like the following:\r
- *\r
- * \code\r
- * void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
- * {\r
- * LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
- * \r
- * uint16_t ConfigDescriptorSize;\r
- * uint8_t ConfigDescriptorData[512];\r
- * \r
- * if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,\r
- * sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)\r
- * {\r
- * LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
- * return;\r
- * }\r
- * \r
- * if (MIDI_Host_ConfigurePipes(&Keyboard_MIDI_Interface,\r
- * ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError)\r
- * {\r
- * LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
- * return;\r
- * }\r
- * \r
- * if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)\r
- * {\r
- * LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
- * return;\r
- * }\r
- * \r
- * LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
- * }\r
- * \endcode\r
- *\r
- * Note that the function also requires the device's configuration descriptor so that it can determine which interface\r
- * in the device to bind to - this can be retrieved as shown in the above fragment using the\r
- * \ref USB_Host_GetDeviceConfigDescriptor() function. If the device does not implement the interface the class driver\r
- * is looking for, if all the matching interfaces are already bound to class driver instances or if an error occurs while\r
- * binding to a device interface (for example, a device endpoint bank larger that the maximum supported bank size is used)\r
- * the configuration will fail.\r
- *\r
- * To complete the device enumeration after binding the host mode Class Drivers to the attached device, a call to\r
- * \c USB_Host_SetDeviceConfiguration() must be made. If the device configuration is not set within the \r
- * \c EVENT_USB_Host_DeviceEnumerationComplete() event, the host still will assume the device enumeration has failed.\r
- *\r
- * Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's\r
- * <tt><b>{Class Name}</b>_Host_USBTask()</tt> function in the main program loop. The exact implementation of this\r
- * function varies between class drivers, and can be used for any internal class driver purpose to maintain each\r
- * instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each\r
- * separate instance, just like the main USB maintenance routine \ref USB_USBTask():\r
- *\r
- * \code\r
- * int main(void)\r
- * {\r
- * SetupHardware();\r
- * \r
- * LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
- * \r
- * for (;;)\r
- * {\r
- * if (USB_HostState != HOST_STATE_Configured)\r
- * Create_And_Process_Samples();\r
- * \r
- * MIDI_Host_USBTask(&My_Audio_Interface);\r
- * USB_USBTask();\r
- * }\r
- * }\r
- * \endcode\r
- *\r
- * Each class driver may also define a set of callback functions (which are prefixed by \c CALLBACK_*\r
- * in the function's name) which <b>must</b> also be added to the user application - refer to each\r
- * individual class driver's documentation for mandatory callbacks. In addition, each class driver may\r
- * also define a set of events (identifiable by their prefix of \c EVENT_* in the function's name), which\r
- * the user application <b>may</b> choose to implement, or ignore if not needed.\r
- *\r
- * The individual Host Mode Class Driver documentation contains more information on the non-standardized,\r
- * class-specific functions which the user application can then use on the driver instances, such as data\r
- * read and write routines. See each driver's individual documentation for more information on the\r
- * class-specific functions.\r
- */\r
-\r
-#ifndef __USB_H__\r
-#define __USB_H__\r
-\r
- /* Macros: */\r
- #define __INCLUDE_FROM_USB_DRIVER\r
-\r
- /* Includes: */\r
- #include "../../Common/Common.h"\r
- #include "Core/USBMode.h"\r
-\r
- /* Includes: */\r
- #include "Core/USBTask.h"\r
- #include "Core/Events.h"\r
- #include "Core/StdDescriptors.h"\r
- #include "Core/ConfigDescriptors.h"\r
- #include "Core/USBController.h"\r
- #include "Core/USBInterrupt.h"\r
-\r
- #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
- #include "Core/Host.h"\r
- #include "Core/Pipe.h"\r
- #include "Core/HostStandardReq.h"\r
- #include "Core/PipeStream.h"\r
- #endif\r
-\r
- #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
- #include "Core/Device.h"\r
- #include "Core/Endpoint.h"\r
- #include "Core/DeviceStandardReq.h"\r
- #include "Core/EndpointStream.h"\r
- #endif\r
-\r
- #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
- #include "Core/OTG.h"\r
- #endif\r
-\r
- #include "Class/AndroidAccessoryClass.h"\r
- #include "Class/AudioClass.h"\r
- #include "Class/CDCClass.h"\r
- #include "Class/HIDClass.h"\r
- #include "Class/MassStorageClass.h"\r
- #include "Class/MIDIClass.h"\r
- #include "Class/PrinterClass.h"\r
- #include "Class/RNDISClass.h"\r
- #include "Class/StillImageClass.h"\r
-\r
-#endif\r
-\r
projects / qmk_firmware.git / blobdiff