summaryrefslogtreecommitdiff
path: root/peripherals/pio/pio_keypad.h
blob: 166f0668001b975db32a9f8677b7d5832a3f72bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/* ----------------------------------------------------------------------------
 *         ATMEL Microcontroller Software Support 
 * ----------------------------------------------------------------------------
 * Copyright (c) 2008, Atmel Corporation
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ----------------------------------------------------------------------------
 */

#ifndef PIO_KEYPAD_H
#define PIO_KEYPAD_H

//------------------------------------------------------------------------------
//         Headers
//------------------------------------------------------------------------------

#include <board.h>

//------------------------------------------------------------------------------
//         Global Definitions
//------------------------------------------------------------------------------




//------------------------------------------------------------------------------
//         Global Macros
//------------------------------------------------------------------------------
//enable keypad press interrupt
#define PIO_KeyPadEnableKPIt(pPIO)	((pPIO)->KIER = 1<<0)

//enable keypad release interrupt
#define PIO_KeyPadEnableKRIt(pPIO)	((pPIO)->KIER = 1<<1)

//disable keypad press interrupt
#define PIO_KeyPadDisableKPIt(pPIO)	((pPIO)->KIDR = 1<<0)

//disable keypad release interrupt
#define PIO_KeyPadDisableKRIt(pPIO)	((pPIO)->KIDR = 1<<1)

//enable keypad controller interrupt
#define PIO_KeyPadEnableIt(pPIO, mode)	{switch(mode):\
						case 1:PIO_KeyPadEnableKPIt(pPIO);break;\
						case 2:PIO_KeyPadEnableKRIt(pPIO);break;\
						case 3:PIO_KeyPadEnableKPIt(pPIO);\
						       PIO_KeyPadEnableKRIt(pPIO);break;\
						default:break;\
					}

//disable keypad controller interrupt
#define PIO_KeyPadDisableIt(pPIO, mode) {switch(mode):\
						case 1:PIO_KeyPadDisableKPIt(pPIO);break;\
						case 2:PIO_KeyPadDisableKRIt(pPIO);break;\
						case 3:PIO_KeyPadDisableKPIt(pPIO);\
						       PIO_KeyPadDisableKRIt(pPIO);break;\
						default:break;\
					}

//get keypad controller interrupt mask
#define PIO_KeyPadGetItMask(pPIO)	((pPIO)->PIO_KIMR)


//------------------------------------------------------------------------------
/// Calculates the size of an array of Pin instances. The array must be defined
/// locally (i.e. not a pointer), otherwise the computation will not be correct.
/// \param pPins  Local array of Pin instances.
/// \return Number of elements in array.
//------------------------------------------------------------------------------
#define PIO_LISTSIZE(pPins)    (sizeof(pPins) / sizeof(Pin))

//------------------------------------------------------------------------------
//         Global Types
//------------------------------------------------------------------------------
typedef enum {
	FALSE,
	TRUE
} bool;

typedef struct _KeyPadConfig {
	bool enable;//keypad controller enable or disable
	unsigned char col:3;//config column size
	unsigned char row:3;//config row size
        unsigned int debouncing;//config debouncing
} KeyPadConfig;


typedef struct _KeyColRow {
      unsigned char row:3;
      unsigned char col:3;
} KeyColRow;

 
typedef struct _KeyDownEvent {
      bool press;//at least 1 pressed key detected, or 0
      unsigned char keyPressNum;//simultaneously pressed key number
      KeyColRow preKeyMatrix[4];//pressed key matrix
} KeyDownEvent;

 

typedef struct _KeyUpEvent {
      bool release;//at least 1 released key  detected, or 0
      unsigned char keyRelNum;//simultaneously released key number
      KeyColRow relKeyMatrix[4];//released key matrix
} KeyUpEvent;

      

typedef struct _KeyEvent {
      KeyDownEvent kdEvent;
      KeyUpEvent   kuEvent;
} KeyEvent;

//------------------------------------------------------------------------------
//         Global Access Macros 
//------------------------------------------------------------------------------


//------------------------------------------------------------------------------
//         Global Functions
//------------------------------------------------------------------------------

void PIO_KeyPadConfig(AT91S_PIO *pPIO, KeyPadConfig *config);

void PIO_GetKeyStatus(AT91S_PIO *pPIO, KeyEvent *event);

void PIO_KeypadEnableIt(AT91S_PIO *pio, unsigned int mode);

void PIO_KeypadDisableIt(AT91S_PIO *pio, unsigned int mode);


#endif //#ifndef PIO_KEYPAD_H

personal git repositories of Harald Welte. Your mileage may vary