X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/8f6b4ddf764c3a54e42d00a7502c82c5c3e71b1c..03ee87b35abdb8b92e8b55ec040fa943f9a6786c:/LUFA/Drivers/USB/USB.h diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h index 75fff2fcd..8d4f2a449 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, provided that the above copyright notice appear in all - copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that the copyright notice and this + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -33,34 +33,115 @@ * Master include file for the library USB functionality. This file should be included in all user projects making * use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel * directories. - * - * Class specific utility files in USB/Class/ must still be included manually, as they are not normally part of - * the USB library unless desired by the library user. */ /** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h * - * Functions, macros, variables, enums and types related to the management of USB communications. + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - LUFA/Drivers/USB/LowLevel/DevChapter9.c + * - LUFA/Drivers/USB/LowLevel/Endpoint.c + * - LUFA/Drivers/USB/LowLevel/Host.c + * - LUFA/Drivers/USB/LowLevel/HostChapter9.c + * - LUFA/Drivers/USB/LowLevel/LowLevel.c + * - LUFA/Drivers/USB/LowLevel/Pipe.c + * - LUFA/Drivers/USB/HighLevel/Events.c + * - LUFA/Drivers/USB/HighLevel/USBInterrupt.c + * - LUFA/Drivers/USB/HighLevel/USBTask.c + * - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c + * + * \section 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. + * + * The USB stack requires the sole control over the USB controller in the microcontroller only; i.e. it does not + * require any additional AVR timers, etc. to operate. This ensures that the USB stack requires as few resources + * as possible. + * + * The USB stack can be used in Device Mode for connections to USB Hosts (see \ref Group_Device), in Host mode for + * hosting of other USB devices (see \ref Group_Host), or as a dual role device which can either act as a USB host + * or device depending on what peripheral is connected (see \ref Group_OTG). Both modes also require a common set + * of USB management functions found \ref Group_USBManagement. */ +/** \ingroup Group_USB + * @defgroup Group_USBClassDrivers USB Class Drivers + * + * Drivers for both host and device mode of the standard USB classes, for rapid application development. + * Class drivers give a framework which sits on top of the low level library API, allowing for standard + * USB classes to be implemented in a project with minimal user code. These drivers can be used in + * conjunction with the library low level APIs to implement interfaces both via the class drivers and via + * the standard library APIs. + * + * Multiple device mode class drivers can be used within a project, including multiple instances of the + * same class driver. In this way, USB Hosts and Devices can be made quickly using the internal class drivers + * so that more time and effort can be put into the end application instead of the USB protocol. + * + * The available class drivers and their modes are listed below. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * +* + * + * + * + * + * + * + * + * + * + * + * + *
USB ClassDevice ModeHost Mode
AudioYesNo
CDCYesYes
HIDYesYes
MIDIYesYes
Mass StorageYesYes
PrinterNoYes
RNDISYesYes
Still ImageNoYes
+ */ + #ifndef __USB_H__ #define __USB_H__ - /* Preprocessor Checks: */ - #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY)) - #error USB_HOST_ONLY is not available for the currently selected USB AVR model. - #endif - - #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \ - defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \ - defined(__AVR_AT90USB162__) || defined(__AVR_AT90USB82__) || \ - defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || \ - defined(__AVR_ATmega32U6__))) + /* Includes: */ + #include "HighLevel/USBMode.h" + + /* Preprocessor Checks: */ + #if (!defined(USB_SERIES_2_AVR) && !defined(USB_SERIES_4_AVR) && \ + !defined(USB_SERIES_6_AVR) && !defined(USB_SERIES_7_AVR)) #error The currently selected AVR model is not supported under the USB component of the LUFA library. #endif /* Includes: */ - #include "Highlevel/USBMode.h" #include "HighLevel/USBTask.h" #include "HighLevel/USBInterrupt.h" #include "HighLevel/Events.h" @@ -84,8 +165,7 @@ #include "LowLevel/OTG.h" #endif - #include "Class/ConfigDescriptor.h" - #include "Class/HIDParser.h" + #include "HighLevel/ConfigDescriptor.h" #endif