LUFA/Common/BoardTypes.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *
  33  *  This file contains constants which can be passed to the compiler (via setting the macro BOARD) in the
  34  *  user project makefile using the -D option to configure the library board-specific drivers.
  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  *
  43  *  Macros for indicating the chosen physical board hardware to the library. These macros should be used when
  44  *  defining the BOARD token to the chosen hardware via the -D switch in the project makefile.
  45  *
  46  *  @{
  47  */
  48
  49 #ifndef __BOARDTYPES_H__
  50 #define __BOARDTYPES_H__
  51
  52         /* Preprocessor Checks: */
  53                 #if !defined(__COMMON_H__)
  54                         #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
  55                 #endif
  56
  57         /* Public Interface - May be used in end-application: */
  58                 /* Macros: */
  59                         /** Selects the USBKEY specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  60                         #define BOARD_USBKEY        0
  61
  62                         /** Selects the STK525 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  63                         #define BOARD_STK525        1
  64
  65                         /** Selects the STK526 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  66                         #define BOARD_STK526        2
  67
  68                         /** Selects the RZUSBSTICK specific board drivers, including the driver for the boards LEDs. */
  69                         #define BOARD_RZUSBSTICK    3
  70
  71                         /** Selects the ATAVRUSBRF01 specific board drivers, including the driver for the board LEDs. */
  72                         #define BOARD_ATAVRUSBRF01  4
  73
  74                         /** Selects the user-defined board drivers, which should be placed in the user project's folder
  75                          *  under a directory named /Board/. Each board driver should be named identically to the LUFA
  76                          *  master board driver (i.e., driver in the LUFA/Drivers/Board director) so that the library
  77                          *  can correctly identify it.
  78                          */
  79                         #define BOARD_USER          5
  80
  81                         /** Selects the BUMBLEB specific board drivers, using the officially recommended peripheral layout. */
  82                         #define BOARD_BUMBLEB       6
  83
  84                         /** Selects the XPLAIN (Revision 2 or newer) specific board drivers, including LED and Dataflash driver. */
  85                         #define BOARD_XPLAIN        7
  86
  87                         /** Selects the XPLAIN (Revision 1) specific board drivers, including LED and Dataflash driver. */
  88                         #define BOARD_XPLAIN_REV1   8
  89
  90                         /** Selects the EVK527 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */
  91                         #define BOARD_EVK527        9
  92
  93 #endif
  94
  95 /** @} */