Commit for the 111009 release.

[pub/lufa.git] / LUFA / Drivers / Board / Joystick.h

diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index f2298e9..0d91576 100644 (file)
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -29,10 +29,10 @@
 */
 
 /** \file
- *  \brief Master include file for the board digital joystick driver.
+ *  \brief Digital joystick board hardware driver.
  *
  *  This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
- *  5-way joystick.
+ *  digital joystick.
  *
  *  User code should include this file, which will in turn include the correct joystick driver header file for the
  *  currently selected board.
@@ -44,7 +44,8 @@
  */
 
 /** \ingroup Group_BoardDrivers
- *  @defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
+ *  \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
+ *  \brief Digital joystick board hardware driver.
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
@@ -54,7 +55,7 @@
  *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
  *  located on many boards.
  *
- *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
+ *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
@@ -64,7 +65,7 @@
  *  application.
  *
  *  \code
- *      // Initialise the board Joystick driver before first use
+ *      // Initialize the board Joystick driver before first use
  *      Joystick_Init();
  *
  *      printf("Waiting for joystick movement...\r\n");
@@ -93,35 +94,34 @@
 #define __JOYSTICK_H__
 
        /* Macros: */
-       #if !defined(__DOXYGEN__)
                #define __INCLUDE_FROM_JOYSTICK_H
-               #define INCLUDE_FROM_JOYSTICK_H
-       #endif
 
        /* Includes: */
-       #include "../../Common/Common.h"
+               #include "../../Common/Common.h"
 
-       #if (BOARD == BOARD_NONE)
-               #error The Board Joystick driver cannot be used if the makefile BOARD option is not set.
-       #elif (BOARD == BOARD_USBKEY)
-               #include "USBKEY/Joystick.h"
-       #elif (BOARD == BOARD_STK525)
-               #include "STK525/Joystick.h"
-       #elif (BOARD == BOARD_STK526)
-               #include "STK526/Joystick.h"
-       #elif (BOARD == BOARD_BUMBLEB)
-               #include "BUMBLEB/Joystick.h"
-       #elif (BOARD == BOARD_EVK527)
-               #include "EVK527/Joystick.h"
-       #elif (BOARD == BOARD_USER)
-               #include "Board/Joystick.h"
-       #else
-               #error The selected board does not contain a joystick.
-       #endif
+               #if (BOARD == BOARD_NONE)
+                       #error The Board Joystick driver cannot be used if the makefile BOARD option is not set.
+               #elif (BOARD == BOARD_USBKEY)
+                       #include "AVR8/USBKEY/Joystick.h"
+               #elif (BOARD == BOARD_STK525)
+                       #include "AVR8/STK525/Joystick.h"
+               #elif (BOARD == BOARD_STK526)
+                       #include "AVR8/STK526/Joystick.h"
+               #elif (BOARD == BOARD_BUMBLEB)
+                       #include "AVR8/BUMBLEB/Joystick.h"
+               #elif (BOARD == BOARD_EVK527)
+                       #include "AVR8/EVK527/Joystick.h"
+               #elif (BOARD == BOARD_EVK1101)
+                       #include "UC3/EVK1101/Joystick.h"
+               #elif (BOARD == BOARD_EVK1100)
+                       #include "UC3/EVK1100/Joystick.h"
+               #else
+                       #include "Board/Joystick.h"
+               #endif
 
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)
-               /** Initialises the joystick driver so that the joystick position can be read. This sets the appropriate
+               /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
                 *  I/O pins to inputs with their pull-ups enabled.
                 */
                static inline void Joystick_Init(void);
@@ -132,7 +132,7 @@
                 *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
                 *          for direction masks.
                 */
-               static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
+               static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
        #endif
 
 #endif