LUFA/Drivers/USB/USB.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Master include file for the library USB functionality. This file should be included in all user projects making
  34  *  use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel
  35  *  directories.
  36  */
  37
  38 /** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h
  39  *
  40  *  \section Sec_Dependencies Module Source Dependencies
  41  *  The following files must be built with any user project that uses this module:
  42  *    - LUFA/Drivers/USB/LowLevel/DevChapter9.c
  43  *    - LUFA/Drivers/USB/LowLevel/Endpoint.c
  44  *    - LUFA/Drivers/USB/LowLevel/Host.c
  45  *    - LUFA/Drivers/USB/LowLevel/HostChapter9.c
  46  *    - LUFA/Drivers/USB/LowLevel/LowLevel.c
  47  *    - LUFA/Drivers/USB/LowLevel/Pipe.c
  48  *    - LUFA/Drivers/USB/HighLevel/Events.c
  49  *    - LUFA/Drivers/USB/HighLevel/USBInterrupt.c
  50  *    - LUFA/Drivers/USB/HighLevel/USBTask.c
  51  *    - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
  52  *
  53  *  \section Module Description
  54  *  Functions, macros, variables, enums and types related to the management of USB communications.
  55  */
  56
  57 /** \ingroup Group_USB
  58  *  @defgroup Group_USBClassDrivers USB Class Drivers
  59  *
  60  *  Drivers for both host and device mode of the standard USB classes, for rapid application development.
  61  *  Class drivers give a framework which sits on top of the low level library API, allowing for standard
  62  *  USB classes to be implemented in a project with minimal user code. These drivers can be used in
  63  *  conjunction with the library low level APIs to implement interfaces both via the class drivers and via
  64  *  the standard library APIs.
  65  *
  66  *  Multiple device mode class drivers can be used within a project, including multiple instances of the
  67  *  same class driver.
  68  */
  69
  70 /** \ingroup Group_USBClassDrivers
  71  *  @defgroup Group_USBDeviceClassDrivers Device Class Drivers
  72  *
  73  *  Device mode drivers for the standard USB classes. These drivers all implement one of the standard USB
  74  *  classes, allowing for the class to be easily implemented in a user project.
  75  */
  76
  77 /** \ingroup Group_USBClassDrivers
  78  *  @defgroup Group_USBHostClassDrivers Host Class Drivers
  79  *
  80  *  Host mode drivers for the standard USB classes. These drivers all implement one of the standard USB
  81  *  classes, allowing for the class to be easily implemented in a user project.
  82  */
  83
  84 #ifndef __USB_H__
  85 #define __USB_H__
  86
  87         /* Preprocessor Checks: */
  88                 #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY))
  89                         #error USB_HOST_ONLY is not available for the currently selected USB AVR model.
  90                 #endif
  91
  92                 #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) ||  \
  93                        defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) ||  \
  94                            defined(__AVR_AT90USB162__)  || defined(__AVR_AT90USB82__)  ||  \
  95                            defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) ||  \
  96                            defined(__AVR_ATmega32U6__)))
  97                         #error The currently selected AVR model is not supported under the USB component of the LUFA library.
  98                 #endif
  99
 100         /* Includes: */
 101                 #include "HighLevel/USBMode.h"
 102                 #include "HighLevel/USBTask.h"
 103                 #include "HighLevel/USBInterrupt.h"
 104                 #include "HighLevel/Events.h"
 105                 #include "HighLevel/StdDescriptors.h"
 106
 107                 #include "LowLevel/LowLevel.h"
 108
 109                 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
 110                         #include "LowLevel/Host.h"
 111                         #include "LowLevel/HostChapter9.h"
 112                         #include "LowLevel/Pipe.h"
 113                 #endif
 114
 115                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
 116                         #include "LowLevel/Device.h"
 117                         #include "LowLevel/DevChapter9.h"
 118                         #include "LowLevel/Endpoint.h"
 119                 #endif
 120
 121                 #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 122                         #include "LowLevel/OTG.h"
 123                 #endif
 124
 125                 #include "HighLevel/ConfigDescriptor.h"
 126
 127 #endif
 128