protocol/lufa/LUFA-120730/LUFA/CodeTemplates/DriverStubs/Joystick.h

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