/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- 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
+ 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
* - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the management of USB communications.\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
+ * The USB stack requires the sole control over the USB controller in the microcontroller only; i.e. it does not\r
+ * require any additional AVR timers, etc. to operate. This ensures that the USB stack requires as few resources\r
+ * 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
/** \ingroup Group_USB\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.\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="100px">USB Class</th> \r
+ * <th width="90px">Device Mode</th> \r
+ * <th width="90px">Host Mode</th> \r
+ * </tr>\r
+ * <tr>\r
+ * <td>Audio</td>\r
+ * <td bgcolor="#00EE00">Yes</td>\r
+ * <td bgcolor="#EE0000">No</td>\r
+ * </tr>\r
+ * <tr>\r
+ * <td>CDC</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
#ifndef __USB_H__\r
#define __USB_H__\r
\r
+ /* Includes: */\r
+ #include "HighLevel/USBMode.h"\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_ATmega16U4__) || defined(__AVR_ATmega32U4__) || \\r
- defined(__AVR_ATmega32U6__)))\r
+ #if (!defined(USB_SERIES_2_AVR) && !defined(USB_SERIES_4_AVR) && \\r
+ !defined(USB_SERIES_6_AVR) && !defined(USB_SERIES_7_AVR))\r
#error The currently selected AVR model is not supported under the USB component of the LUFA library.\r
#endif\r
\r
/* Includes: */\r
- #include "HighLevel/USBMode.h"\r
#include "HighLevel/USBTask.h"\r
#include "HighLevel/USBInterrupt.h"\r
#include "HighLevel/Events.h"\r
projects / pub / USBasp.git / blobdiff