Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / Board / AVR8 / BUMBLEB / Joystick.h @ 978b99e5

History | View | Annotate | Download (3.65 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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 Board specific joystick driver header for the Fletchtronics BUMBLEB.
33
 *  \copydetails Group_Joystick_BUMBLEB
34
 *
35
 *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
36
 *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
37
 */
38

    
39
/** \ingroup Group_Joystick
40
 *  \defgroup Group_Joystick_BUMBLEB BUMBLEB
41
 *  \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
42
 *
43
 *  Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
44
 *  third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
45
 *  layout for buttons, LEDs and a Joystick.
46
 *
47
 *  @{
48
 */
49

    
50
#ifndef __JOYSTICK_BUMBLEB_H__
51
#define __JOYSTICK_BUMBLEB_H__
52

    
53
        /* Includes: */
54
                #include "../../../../Common/Common.h"
55

    
56
        /* Enable C linkage for C++ Compilers: */
57
                #if defined(__cplusplus)
58
                        extern "C" {
59
                #endif
60

    
61
        /* Preprocessor Checks: */
62
                #if !defined(__INCLUDE_FROM_JOYSTICK_H)
63
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
64
                #endif
65

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

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

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

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

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

    
86
                        /** Mask for the joystick being pushed inward. */
87
                        #define JOY_PRESS                 (1 << 4)
88

    
89
                /* Inline Functions: */
90
                #if !defined(__DOXYGEN__)
91
                        static inline void Joystick_Init(void)
92
                        {
93
                                DDRD  &= ~JOY_MASK;
94
                                PORTD |= JOY_MASK;
95
                        }
96

    
97
                        static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
98
                        static inline uint8_t Joystick_GetStatus(void)
99
                        {
100
                                return (uint8_t)(~PIND & JOY_MASK);
101
                        }
102
                #endif
103

    
104
        /* Disable C linkage for C++ Compilers: */
105
                #if defined(__cplusplus)
106
                        }
107
                #endif
108

    
109
#endif
110

    
111
/** @} */
112