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/StdDescriptors.c
  50  *    - LUFA/Drivers/USB/HighLevel/USBInterrupt.c
  51  *    - LUFA/Drivers/USB/HighLevel/USBTask.c
  52  *    - LUFA/Drivers/USB/Class/ConfigDescriptor.c
  53  *    - LUFA/Drivers/USB/Class/HIDParser.c
  54  *
  55  *  \section Module Description
  56  *  Functions, macros, variables, enums and types related to the management of USB communications.
  57  */
  58
  59 #ifndef __USB_H__
  60 #define __USB_H__
  61
  62         /* Preprocessor Checks: */
  63                 #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY))
  64                         #error USB_HOST_ONLY is not available for the currently selected USB AVR model.
  65                 #endif
  66
  67                 #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) ||  \
  68                        defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) ||  \
  69                            defined(__AVR_AT90USB162__)  || defined(__AVR_AT90USB82__)  ||  \
  70                            defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) ||  \
  71                            defined(__AVR_ATmega32U6__)))
  72                         #error The currently selected AVR model is not supported under the USB component of the LUFA library.
  73                 #endif
  74
  75         /* Includes: */
  76                 #include "HighLevel/USBMode.h"
  77                 #include "HighLevel/USBTask.h"
  78                 #include "HighLevel/USBInterrupt.h"
  79                 #include "HighLevel/Events.h"
  80                 #include "HighLevel/StdDescriptors.h"
  81
  82                 #include "LowLevel/LowLevel.h"
  83
  84                 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
  85                         #include "LowLevel/Host.h"
  86                         #include "LowLevel/HostChapter9.h"
  87                         #include "LowLevel/Pipe.h"
  88                 #endif
  89
  90                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
  91                         #include "LowLevel/Device.h"
  92                         #include "LowLevel/DevChapter9.h"
  93                         #include "LowLevel/Endpoint.h"
  94                 #endif
  95
  96                 #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
  97                         #include "LowLevel/OTG.h"
  98                 #endif
  99
 100                 #include "Class/ConfigDescriptor.h"
 101                 #include "Class/HIDParser.h"
 102
 103 #endif
 104