Added new Board Hardware Information board driver.
[pub/lufa.git] / LUFA / Drivers / Board / AVR8 / USB2AX / Board.h
diff --git a/LUFA/Drivers/Board/AVR8/USB2AX/Board.h b/LUFA/Drivers/Board/AVR8/USB2AX/Board.h
new file mode 100644 (file)
index 0000000..26a61fb
--- /dev/null
@@ -0,0 +1,105 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2013.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaims all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Board specific LED driver header for the Xevelabs USB2AX.
+ *  \copydetails Group_BoardInfo_USB2AX
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the Board driver
+ *        dispatch header located in LUFA/Drivers/Board/Board.h.
+ */
+
+/** \ingroup Group_BoardInfo
+ *  \defgroup Group_BoardInfo_USB2AX_V31 USB2AX_V31
+ *  \brief Board specific information header for the Xevelabs USB2AX revision 3.1.
+ *
+ *  See \ref Group_BoardInfo_USB2AX for more details.
+ */
+
+/** \ingroup Group_BoardInfo
+ *  \defgroup Group_BoardInfo_USB2AX_V3 USB2AX_V3
+ *  \briefBoard specific information header for the Xevelabs USB2AX revision 3.
+ *
+ *  See \ref Group_BoardInfo_USB2AX for more details.
+ */
+
+/** \ingroup Group_BoardInfo
+ *  \defgroup Group_BoardInfo_USB2AX USB2AX
+ *  \brief Board specific information header for the Xevelabs USB2AX.
+ *
+ *  Board specific information header for the Xevelabs USB2AX (http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX).
+ *
+ *  @{
+ */
+
+#ifndef __BOARD_USB2AX_H__
+#define __BOARD_USB2AX_H__
+
+       /* Includes: */
+               #include "../../../../Common/Common.h"
+               #include "../../Buttons.h"
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_BOARD_H)
+                       #error Do not include this file directly. Include LUFA/Drivers/Board/Board.h instead.
+               #endif
+
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       #if (BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3) || \
+                           defined(__DOXYGEN__)
+                               #include "../../Buttons.h"
+
+                               /** Indicates the board has a hardware Buttons mounted. */
+                               #define BOARD_HAS_BUTTONS
+                       #endif
+
+                       #if ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3) || \
+                            (BOARD == BOARD_USB2AX_V31) || defined(__DOXYGEN__))
+                               #include "../../LEDs.h"
+
+                               /** Indicates the board has a hardware LEDs mounted. */
+                               #define BOARD_HAS_LEDS
+                       #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+
+#endif
+
+/** @} */
+