Joystick.h 3.87 KB
Newer Older
1 2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4 5 6 7 8 9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12 13 14 15 16 17 18
  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 
19 20 21 22 23 24 25 26 27 28 29 30 31 32
  software without specific, written prior permission.

  The author disclaim 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
 *
33
 *  Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board
34 35 36 37 38 39 40 41 42
 *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
 *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
 */

/** \ingroup Group_Joystick
 *  @defgroup Group_Joystick_BUMBLEB BUMBLEB
 *
43
 *  Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board
44 45 46 47 48
 *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
 *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
 *
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
 *  @{
 */

#ifndef __JOYSTICK_BUMBLEB_H__
#define __JOYSTICK_BUMBLEB_H__

	/* Includes: */
		#include <avr/io.h>

		#include "../../../Common/Common.h"

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
66
		#if !defined(__INCLUDE_FROM_JOYSTICK_H)
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
			#error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
		#endif

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
			#define JOY_MASK                 ((1 << 0) | (1 << 1) | (1 << 2) | (1 << 3) | (1 << 4))
	#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** Mask for the joystick being pushed in the left direction. */
			#define JOY_LEFT                  (1 << 2)

			/** Mask for the joystick being pushed in the upward direction. */
			#define JOY_UP                    (1 << 3)

			/** Mask for the joystick being pushed in the right direction. */
			#define JOY_RIGHT                 (1 << 0)

			/** Mask for the joystick being pushed in the downward direction. */
			#define JOY_DOWN                  (1 << 1)

			/** Mask for the joystick being pushed inward. */
			#define JOY_PRESS                 (1 << 4)
			
		/* Inline Functions: */
		#if !defined(__DOXYGEN__)
			static inline void Joystick_Init(void)
			{
				DDRD  &= ~JOY_MASK;
				PORTD |= JOY_MASK;
99
			}
100
			
101 102
			static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
			static inline uint8_t Joystick_GetStatus(void)
103 104 105 106 107 108 109 110 111 112 113 114 115
			{
				return (uint8_t)(~PIND & JOY_MASK);
			}
		#endif

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */