LUFA/Common/BoardTypes.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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  *  \brief Supported board hardware defines.
  33  *
  34  *  This file contains constants which can be passed to the compiler (via setting the macro BOARD) in the
  35  *  user project makefile using the -D option to configure the library board-specific drivers.
  36  *
  37  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  38  *        functionality.
  39  */
  40
  41 /** \ingroup Group_Common
  42  *  @defgroup Group_BoardTypes Board Types
  43  *
  44  *  Macros for indicating the chosen physical board hardware to the library. These macros should be used when
  45  *  defining the BOARD token to the chosen hardware via the -D switch in the project makefile.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef __BOARDTYPES_H__
  51 #define __BOARDTYPES_H__
  52
  53         /* Preprocessor Checks: */
  54                 #if !defined(__COMMON_H__)
  55                         #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
  56                 #endif
  57
  58         /* Public Interface - May be used in end-application: */
  59                 /* Macros: */
  60                         /** Selects the USBKEY specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  61                         #define BOARD_USBKEY        0
  62
  63                         /** Selects the STK525 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  64                         #define BOARD_STK525        1
  65
  66                         /** Selects the STK526 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  67                         #define BOARD_STK526        2
  68
  69                         /** Selects the RZUSBSTICK specific board drivers, including the driver for the boards LEDs. */
  70                         #define BOARD_RZUSBSTICK    3
  71
  72                         /** Selects the ATAVRUSBRF01 specific board drivers, including the driver for the board LEDs. */
  73                         #define BOARD_ATAVRUSBRF01  4
  74
  75                         /** Selects the user-defined board drivers, which should be placed in the user project's folder
  76                          *  under a directory named \c /Board/. Each board driver should be named identically to the LUFA
  77                          *  master board driver (i.e., driver in the \c LUFA/Drivers/Board directory) so that the library
  78                          *  can correctly identify it.
  79                          */
  80                         #define BOARD_USER          5
  81
  82                         /** Selects the BUMBLEB specific board drivers, using the officially recommended peripheral layout. */
  83                         #define BOARD_BUMBLEB       6
  84
  85                         /** Selects the XPLAIN (Revision 2 or newer) specific board drivers, including LED and Dataflash driver. */
  86                         #define BOARD_XPLAIN        7
  87
  88                         /** Selects the XPLAIN (Revision 1) specific board drivers, including LED and Dataflash driver. */
  89                         #define BOARD_XPLAIN_REV1   8
  90
  91                         /** Selects the EVK527 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  92                         #define BOARD_EVK527        9
  93
  94                         /** Disables board drivers when operation will not be adversely affected (e.g. LEDs) - use of board drivers
  95                          *  such as the Joystick driver, where the removal would adversely affect the code's operation is still disallowed. */
  96                         #define BOARD_NONE          10
  97
  98                         /** Selects the Teensy (all versions) specific board drivers, including the driver for the board LEDs. */
  99                         #define BOARD_TEENSY        11
 100
 101                         /** Selects the USBTINY MKII specific board drivers, including the Button and LEDs drivers. */
 102                         #define BOARD_USBTINYMKII   12
 103
 104                         /** Selects the Benito specific board drivers, including the Button and LEDs drivers. */
 105                         #define BOARD_BENITO        13
 106
 107                         /** Selects the JM-DB-U2 specific board drivers, including the Button and LEDs drivers. */
 108                         #define BOARD_JMDBU2        14
 109
 110                         /** Selects the Olimex AVR-USB-162 specific board drivers, including the Button and LEDs drivers. */
 111                         #define BOARD_OLIMEX162     15
 112
 113                         /** Selects the UDIP specific board drivers, including the Button and LEDs drivers. */
 114                         #define BOARD_UDIP          16
 115
 116                         /** Selects the BUI specific board drivers, including the driver for the board LEDs. */
 117                         #define BOARD_BUI           17
 118
 119                         /** Selects the Arduino Uno specific board drivers, including the driver for the board LEDs. */
 120                         #define BOARD_UNO           18
 121
 122                         /** Selects the CUL V3 specific board drivers, including the Button and LEDs drivers. */
 123                         #define BOARD_CULV3         19
 124
 125                         /** Selects the Blackcat USB JTAG specific board drivers, including the driver for the board LEDs. */
 126                         #define BOARD_BLACKCAT      20
 127
 128                         /** Selects the Maximus specific board drivers, including the driver for the board LEDs. */
 129                         #define BOARD_MAXIMUS       21
 130
 131                         /** Selects the Minimus specific board drivers, including the Button and LEDs drivers. */
 132                         #define BOARD_MINIMUS       22
 133
 134                         /** Selects the Adafruit U4 specific board drivers, including the Button driver. */
 135                         #define BOARD_ADAFRUITU4    23
 136
 137                         /** Selects the Microsin AVR-USB162 specific board drivers, including the Button and LEDs drivers. */
 138                         #define BOARD_MICROSIN162   24
 139
 140                         /** Selects the Kernel Concepts USBFOO specific board drivers, including the Button and LEDs drivers. */
 141                         #define BOARD_USBFOO        25
 142
 143                         #if !defined(__DOXYGEN__)
 144                                 #define BOARD_          BOARD_NONE
 145
 146                                 #if !defined(BOARD)
 147                                         #define BOARD       BOARD_NONE
 148                                 #endif
 149                         #endif
 150
 151 #endif
 152
 153 /** @} */
 154