LUFA/Common/BoardTypes.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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 pre-made board hardware defines.
  33  *
  34  *  \copydetails Group_BoardTypes
  35  *
  36  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  37  *        functionality.
  38  */
  39
  40 /** \ingroup Group_Common
  41  *  \defgroup Group_BoardTypes Board Types
  42  *  \brief Supported pre-made board hardware defines.
  43  *
  44  *  Board macros for indicating the chosen physical board hardware to the library. These macros should be used when
  45  *  defining the \c BOARD token to the chosen hardware via the \c -D switch in the project makefile. If a custom
  46  *  board is used, the \ref BOARD_NONE or \ref BOARD_USER values should be selected.
  47  *
  48  *  @{
  49  */
  50
  51 #ifndef __LUFA_BOARDTYPES_H__
  52 #define __LUFA_BOARDTYPES_H__
  53
  54         /* Preprocessor Checks: */
  55                 #if !defined(__INCLUDE_FROM_COMMON_H)
  56                         #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
  57                 #endif
  58
  59         /* Public Interface - May be used in end-application: */
  60                 /* Macros: */
  61                         /** Selects the user-defined board drivers, which should be placed in the user project's folder
  62                          *  under a directory named \c /Board/. Each board driver should be named identically to the LUFA
  63                          *  master board driver (i.e., driver in the \c LUFA/Drivers/Board directory) so that the library
  64                          *  can correctly identify it.
  65                          */
  66                         #define BOARD_USER                 0
  67
  68                         /** Disables board drivers when operation will not be adversely affected (e.g. LEDs) - use of board drivers
  69                          *  such as the Joystick driver, where the removal would adversely affect the code's operation is still disallowed. */
  70                         #define BOARD_NONE                 1
  71
  72                         /** Selects the USBKEY specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  73                         #define BOARD_USBKEY               2
  74
  75                         /** Selects the STK525 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  76                         #define BOARD_STK525               3
  77
  78                         /** Selects the STK526 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  79                         #define BOARD_STK526               4
  80
  81                         /** Selects the RZUSBSTICK specific board drivers, including the driver for the boards LEDs. */
  82                         #define BOARD_RZUSBSTICK           5
  83
  84                         /** Selects the ATAVRUSBRF01 specific board drivers, including the driver for the board LEDs. */
  85                         #define BOARD_ATAVRUSBRF01         6
  86
  87                         /** Selects the BUMBLEB specific board drivers, using the officially recommended peripheral layout. */
  88                         #define BOARD_BUMBLEB              7
  89
  90                         /** Selects the XPLAIN (Revision 2 or newer) specific board drivers, including LED and Dataflash drivers. */
  91                         #define BOARD_XPLAIN               8
  92
  93                         /** Selects the XPLAIN (Revision 1) specific board drivers, including LED and Dataflash drivers. */
  94                         #define BOARD_XPLAIN_REV1          9
  95
  96                         /** Selects the EVK527 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  97                         #define BOARD_EVK527               10
  98
  99                         /** Selects the Teensy version 1.x specific board drivers, including the driver for the board LEDs. */
 100                         #define BOARD_TEENSY               11
 101
 102                         /** Selects the USBTINY MKII specific board drivers, including the Button and LEDs drivers. */
 103                         #define BOARD_USBTINYMKII          12
 104
 105                         /** Selects the Benito specific board drivers, including the Button and LEDs drivers. */
 106                         #define BOARD_BENITO               13
 107
 108                         /** Selects the JM-DB-U2 specific board drivers, including the Button and LEDs drivers. */
 109                         #define BOARD_JMDBU2               14
 110
 111                         /** Selects the Olimex AVR-USB-162 specific board drivers, including the Button and LEDs drivers. */
 112                         #define BOARD_OLIMEX162            15
 113
 114                         /** Selects the UDIP specific board drivers, including the Button and LEDs drivers. */
 115                         #define BOARD_UDIP                 16
 116
 117                         /** Selects the BUI specific board drivers, including the driver for the board LEDs. */
 118                         #define BOARD_BUI                  17
 119
 120                         /** Selects the Arduino Uno specific board drivers, including the driver for the board LEDs. */
 121                         #define BOARD_UNO                  18
 122
 123                         /** Selects the Busware CUL V3 specific board drivers, including the Button and LEDs drivers. */
 124                         #define BOARD_CULV3                19
 125
 126                         /** Selects the Blackcat USB JTAG specific board drivers, including the driver for the board LEDs. */
 127                         #define BOARD_BLACKCAT             20
 128
 129                         /** Selects the Maximus specific board drivers, including the driver for the board LEDs. */
 130                         #define BOARD_MAXIMUS              21
 131
 132                         /** Selects the Minimus specific board drivers, including the Button and LEDs drivers. */
 133                         #define BOARD_MINIMUS              22
 134
 135                         /** Selects the Adafruit U4 specific board drivers, including the Button driver. */
 136                         #define BOARD_ADAFRUITU4           23
 137
 138                         /** Selects the Microsin AVR-USB162 specific board drivers, including the Button and LEDs drivers. */
 139                         #define BOARD_MICROSIN162          24
 140
 141                         /** Selects the Kernel Concepts USBFOO specific board drivers, including the Button and LEDs drivers. */
 142                         #define BOARD_USBFOO               25
 143
 144                         /** Selects the Sparkfun ATMEGA8U2 specific board drivers, including the driver for the board LEDs. */
 145                         #define BOARD_SPARKFUN8U2          26
 146
 147                         /** Selects the Atmel EVK1101 specific board drivers, including the Button, Joystick and LED drivers. */
 148                         #define BOARD_EVK1101              27
 149
 150                         /** Selects the Busware TUL specific board drivers, including the Button and LED drivers. */
 151                         #define BOARD_TUL                  28
 152
 153                         /** Selects the Atmel EVK1100 specific board drivers, including the Button, Joystick and LED drivers. */
 154                         #define BOARD_EVK1100              29
 155
 156                         /** Selects the Atmel EVK1104 specific board drivers, including the Button and LED drivers. */
 157                         #define BOARD_EVK1104              30
 158
 159                         /** Selects the Atmel XMEGA A3BU Xplained specific board drivers, including Dataflash, Button and LED drivers. */
 160                         #define BOARD_A3BU_XPLAINED        31
 161
 162                         /** Selects the Teensy version 2.x specific board drivers, including the driver for the board LEDs. */
 163                         #define BOARD_TEENSY2              32
 164
 165                         /** Selects the USB2AX version 1 and 2 specific board drivers, including the Button and LEDs drivers. */
 166                         #define BOARD_USB2AX               33
 167
 168                         /** Selects the USB2AX version 3 specific board drivers, including the Button and LEDs drivers. */
 169                         #define BOARD_USB2AX_V3            34
 170
 171                         /** Selects the Micropendous 32U2 specific board drivers, including the Button and LED drivers. */
 172                         #define BOARD_MICROPENDOUS_32U2    35
 173
 174                         /** Selects the Micropendous A specific board drivers, including the driver for the board Button. */
 175                         #define BOARD_MICROPENDOUS_A       36
 176
 177                         /** Selects the Micropendous 1 specific board drivers, including the driver for the board Button. */
 178                         #define BOARD_MICROPENDOUS_1       37
 179
 180                         /** Selects the Micropendous 2 specific board drivers, including the driver for the board Button. */
 181                         #define BOARD_MICROPENDOUS_2       38
 182
 183                         /** Selects the Micropendous 3 specific board drivers, including the driver for the board Button. */
 184                         #define BOARD_MICROPENDOUS_3       39
 185
 186                         /** Selects the Micropendous 4 specific board drivers, including the driver for the board Button. */
 187                         #define BOARD_MICROPENDOUS_4       40
 188
 189                         /** Selects the Micropendous DIP specific board drivers, including the driver for the board Button. */
 190                         #define BOARD_MICROPENDOUS_DIP     41
 191
 192                         /** Selects the Micropendous (Arduino-like) revision 1 specific board drivers, including the Button and LED drivers. */
 193                         #define BOARD_MICROPENDOUS_REV1    42
 194
 195                         /** Selects the Micropendous (Arduino-like) revision 2 specific board drivers, including the Button and LED drivers. */
 196                         #define BOARD_MICROPENDOUS_REV2    43
 197
 198                         /** Selects the XMEGA B1 Xplained specific board drivers, including the Button and LED drivers. */
 199                         #define BOARD_B1_XPLAINED          44
 200
 201                         /** Selects the Bitwizard Multio specific board drivers, including the driver for the board LEDs. */
 202                         #define BOARD_MULTIO               45
 203
 204                         /** Selects the Bitwizard Big-Multio specific board drivers, including the driver for the board LEDs. */
 205                         #define BOARD_BIGMULTIO            46
 206
 207                         /** Selects the DorkbotPDX Duce specific board drivers, including the driver for the board LEDs. */
 208                         #define BOARD_DUCE                 47
 209
 210                         /** Selects the Olimex AVR-USB-32U4 specific board drivers, including the Button and LED drivers. */
 211                         #define BOARD_OLIMEX32U4           48
 212
 213                         /** Selects the Olimex AVR-USB-T32U4 specific board drivers, including the Button and LED drivers. */
 214                         #define BOARD_OLIMEXT32U4          49
 215
 216                         /** Selects the Olimex AVR-ISP-MK2 specific board drivers, including the Button and LED drivers. */
 217                         #define BOARD_OLIMEXISPMK2         50
 218
 219                         /** Selects the Arduino Leonardo specific board drivers, including the driver for the board LEDs. */
 220                         #define BOARD_LEONARDO             51
 221
 222                         /** Selects the UC3-A3 Xplained specific board drivers, including the Button and LED drivers. */
 223                         #define BOARD_UC3A3_XPLAINED       52
 224
 225                         /** Selects the USB2AX version 3.1 specific board drivers, including the Button and LEDs drivers. */
 226                         #define BOARD_USB2AX_V31           53
 227
 228                         /** Selects the Stange-ISP specific board drivers, including the Button and LEDs drivers. */
 229                         #define BOARD_STANGE_ISP           54
 230
 231                         /** Selects the XMEGA C3 XPLAINED specific board drivers, including the Button and LEDs drivers. */
 232                         #define BOARD_C3_XPLAINED          55
 233
 234                         /** Selects the U2S specific board drivers, including the Button and LEDs drivers. */
 235                         #define BOARD_U2S                  56
 236
 237                         /** Selects the Arduino YUN specific board drivers, including the driver for the board LEDs. */
 238                         #define BOARD_YUN                  57
 239
 240                         /** Selects the Arduino Micro specific board drivers, including the driver for the board LEDs. */
 241                         #define BOARD_MICRO                58
 242
 243                         /** Selects the Atmel Xplained-MINI specific board drivers, including the driver for the board LEDs. */
 244                         #define BOARD_XPLAINED_MINI        59
 245
 246                         #if !defined(__DOXYGEN__)
 247                                 #define BOARD_                 BOARD_NONE
 248
 249                                 #if !defined(BOARD)
 250                                         #define BOARD              BOARD_NONE
 251                                 #endif
 252                         #endif
 253
 254 #endif
 255
 256 /** @} */
 257