LUFA/DriverStubs/Joystick.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 /*
  32    This is a stub driver header file, for implementing custom board
  33    layout hardware with compatible LUFA board specific drivers. If
  34    the library is configured to use the BOARD_USER board mode, this
  35    driver file should be completed and copied into the "/Board/" folder
  36    inside the application's folder.
  37
  38    This stub is for the board-specific component of the LUFA Joystick
  39    driver, a small surface mount four-way (plus button) digital joystick
  40    on most USB AVR boards.
  41 */
  42
  43 #ifndef __JOYSTICK_USER_H__
  44 #define __JOYSTICK_USER_H__
  45
  46         /* Includes: */
  47                 #include <avr/io.h>
  48
  49                 // TODO: Add any required includes here
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Preprocessor Checks: */
  57                 #if !defined(INCLUDE_FROM_JOYSTICK_H)
  58                         #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
  59                 #endif
  60
  61         /* Public Interface - May be used in end-application: */
  62                 /* Macros: */
  63                         /** Mask for the joystick being pushed in the left direction. */
  64                         #define JOY_LEFT                  // TODO: Add mask to indicate joystick left position here
  65
  66                         /** Mask for the joystick being pushed in the right direction. */
  67                         #define JOY_RIGHT                 // TODO: Add mask to indicate joystick right position here
  68
  69                         /** Mask for the joystick being pushed in the upward direction. */
  70                         #define JOY_UP                    // TODO: Add mask to indicate joystick up position here
  71
  72                         /** Mask for the joystick being pushed in the downward direction. */
  73                         #define JOY_DOWN                  // TODO: Add mask to indicate joystick down position here
  74
  75                         /** Mask for the joystick being pushed inward. */
  76                         #define JOY_PRESS                 // TODO: Add mask to indicate joystick pressed position here
  77
  78                 /* Inline Functions: */
  79                 #if !defined(__DOXYGEN__)
  80                         static inline void Joystick_Init(void)
  81                         {
  82                                 // TODO: Initialize joystick port pins as inputs with pull-ups
  83                         }
  84
  85                         static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  86                         static inline uint8_t Joystick_GetStatus(void)
  87                         {
  88                                 // TODO: Return current joystick position data which can be obtained by masking against the JOY_* macros
  89                         }
  90                 #endif
  91
  92         /* Disable C linkage for C++ Compilers: */
  93                 #if defined(__cplusplus)
  94                         }
  95                 #endif
  96
  97 #endif