protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/USBKEY/Joystick.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2012.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *  \brief Board specific joystick driver header for the Atmel USBKEY.\r
  33  *  \copydetails Group_Joystick_USBKEY\r
  34  *\r
  35  *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
  36  *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
  37  */\r
  38 \r
  39 /** \ingroup Group_Joystick\r
  40  *  \defgroup Group_Joystick_USBKEY USBKEY\r
  41  *  \brief Board specific joystick driver header for the Atmel USBKEY.\r
  42  *\r
  43  *  Board specific joystick driver header for the Atmel USBKEY.\r
  44  *\r
  45  *  <table>\r
  46  *    <tr><th>Left Port Pin</th><th>Up Port Pin</th><th>Right Port Pin</th><th>Down Port Pin</th><th>Press Port Pin</th></tr>\r
  47  *    <tr><td>PORTB.6</td><td>PORTB.7</td><td>PORTE.4</td><td>PORTE.5</td><td>PORTB.5</td></tr>\r
  48  *  </table>\r
  49  *\r
  50  *  @{\r
  51  */\r
  52 \r
  53 #ifndef __JOYSTICK_USBKEY_H__\r
  54 #define __JOYSTICK_USBKEY_H__\r
  55 \r
  56         /* Includes: */\r
  57                 #include "../../../../Common/Common.h"\r
  58 \r
  59         /* Enable C linkage for C++ Compilers: */\r
  60                 #if defined(__cplusplus)\r
  61                         extern "C" {\r
  62                 #endif\r
  63 \r
  64         /* Preprocessor Checks: */\r
  65                 #if !defined(__INCLUDE_FROM_JOYSTICK_H)\r
  66                         #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.\r
  67                 #endif\r
  68 \r
  69         /* Private Interface - For use in library only: */\r
  70         #if !defined(__DOXYGEN__)\r
  71                 /* Macros: */\r
  72                         #define JOY_BMASK                 ((1 << 5) | (1 << 6) | (1 << 7))\r
  73                         #define JOY_EMASK                 ((1 << 4) | (1 << 5))\r
  74 \r
  75                         #define JOY_PORTE_MASK_SHIFT      1\r
  76         #endif\r
  77 \r
  78         /* Public Interface - May be used in end-application: */\r
  79                 /* Macros: */\r
  80                         /** Mask for the joystick being pushed in the left direction. */\r
  81                         #define JOY_LEFT                  (1 << 6)\r
  82 \r
  83                         /** Mask for the joystick being pushed in the right direction. */\r
  84                         #define JOY_RIGHT                ((1 << 4) >> JOY_PORTE_MASK_SHIFT)\r
  85 \r
  86                         /** Mask for the joystick being pushed in the upward direction. */\r
  87                         #define JOY_UP                    (1 << 7)\r
  88 \r
  89                         /** Mask for the joystick being pushed in the downward direction. */\r
  90                         #define JOY_DOWN                 ((1 << 5) >> JOY_PORTE_MASK_SHIFT)\r
  91 \r
  92                         /** Mask for the joystick being pushed inward. */\r
  93                         #define JOY_PRESS                 (1 << 5)\r
  94 \r
  95                 /* Inline Functions: */\r
  96                 #if !defined(__DOXYGEN__)\r
  97                         static inline void Joystick_Init(void)\r
  98                         {\r
  99                                 DDRB  &= ~JOY_BMASK;\r
 100                                 DDRE  &= ~JOY_EMASK;\r
 101 \r
 102                                 PORTB |=  JOY_BMASK;\r
 103                                 PORTE |=  JOY_EMASK;\r
 104                         }\r
 105 \r
 106                         static inline void Joystick_Disable(void)\r
 107                         {\r
 108                                 DDRB  &= ~JOY_BMASK;\r
 109                                 DDRE  &= ~JOY_EMASK;\r
 110 \r
 111                                 PORTB &= ~JOY_BMASK;\r
 112                                 PORTE &= ~JOY_EMASK;\r
 113                         }\r
 114 \r
 115                         static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
 116                         static inline uint8_t Joystick_GetStatus(void)\r
 117                         {\r
 118                                 return (((uint8_t)~PINB & JOY_BMASK) | (((uint8_t)~PINE & JOY_EMASK) >> JOY_PORTE_MASK_SHIFT));\r
 119                         }\r
 120                 #endif\r
 121 \r
 122         /* Disable C linkage for C++ Compilers: */\r
 123                 #if defined(__cplusplus)\r
 124                         }\r
 125                 #endif\r
 126 \r
 127 #endif\r
 128 \r
 129 /** @} */\r
 130 \r