* Master include file for the library USB functionality. This file should be included in all user projects making\r
* use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel\r
* directories.\r
- *\r
- * Class specific utility files in USB/Class/ must still be included manually, as they are not normally part of\r
- * the USB library unless desired by the library user.\r
*/\r
\r
/** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h\r
*\r
- * Functions, macros, variables, enums and types related to the management of USB communications.\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/LowLevel/DevChapter9.c\r
+ * - LUFA/Drivers/USB/LowLevel/Endpoint.c\r
+ * - LUFA/Drivers/USB/LowLevel/Host.c\r
+ * - LUFA/Drivers/USB/LowLevel/HostChapter9.c\r
+ * - LUFA/Drivers/USB/LowLevel/LowLevel.c\r
+ * - LUFA/Drivers/USB/LowLevel/Pipe.c\r
+ * - LUFA/Drivers/USB/HighLevel/Events.c\r
+ * - LUFA/Drivers/USB/HighLevel/USBInterrupt.c\r
+ * - LUFA/Drivers/USB/HighLevel/USBTask.c\r
+ * - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c\r
+ *\r
+ * \section Module Description\r
+ * Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. 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
\r
+/** \ingroup Group_USB\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
+ * \warning The Host mode Class Drivers are currently incomplete and are included for preview purposes only. The Host\r
+ * mode class drivers should not be used in any user project until they have been completed in a later revision.\r
+ */\r
+ \r
#ifndef __USB_H__\r
#define __USB_H__\r
\r
- /* Preprocessor Checks: */\r
- #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY))\r
- #error USB_HOST_ONLY is not available for the currently selected USB AVR model.\r
- #endif\r
- \r
+ /* Preprocessor Checks: */ \r
#if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \\r
defined(__AVR_AT90USB162__) || defined(__AVR_AT90USB82__) || \\r
+ defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || \\r
+ defined(__AVR_ATmega8U2__) || \\r
defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || \\r
defined(__AVR_ATmega32U6__)))\r
#error The currently selected AVR model is not supported under the USB component of the LUFA library.\r
#include "LowLevel/OTG.h"\r
#endif\r
\r
- #include "Class/ConfigDescriptor.h"\r
- #include "Class/HIDParser.h"\r
+ #include "HighLevel/ConfigDescriptor.h"\r
\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff