1 /* Copyright (C) 2014-2015 by Jacob Alexander
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 // ----- Includes -----
26 // KLL Generated Defines
31 // ----- Defines -----
33 #if ( DebounceDivThreshold_define < 0xFF + 1 )
34 #define DebounceCounter uint8_t
35 #elif ( DebounceDivThreshold_define < 0xFFFF + 1 )
36 #define DebounceCounter uint16_t
37 #elif ( DebounceDivThreshold_define < 0xFFFFFFFF + 1 )
38 #define DebounceCounter uint32_t
40 #error "Debounce threshold is too high... 32 bit max. Check .kll defines."
43 #if ( MinDebounceTime_define > 0xFF )
44 #error "MinDebounceTime is a maximum of 255 ms"
45 #elif ( MinDebounceTime_define < 0x00 )
46 #error "MinDebounceTime is a minimum 0 ms"
53 // Freescale MK20s have GPIO ports A...E
62 // Each port has a possible 32 pins
107 // Sense/Strobe configuration
108 typedef enum Config {
109 Config_Pullup, // Internal pull-up
110 Config_Pulldown, // Internal pull-down
111 Config_Opendrain, // External pull resistor
115 typedef enum KeyPosition {
119 KeyState_Release = 3,
125 // ----- Structs -----
127 // Struct container for defining Rows (Sense) and Columns (Strobes)
128 typedef struct GPIO_Pin {
134 typedef struct KeyState {
135 DebounceCounter activeCount;
136 DebounceCounter inactiveCount;
137 KeyPosition prevState;
138 KeyPosition curState;
139 uint8_t prevDecisionTime;
140 } __attribute__((packed)) KeyState;
142 // Ghost Element, after ghost detection/cancelation
143 typedef struct KeyGhost {
146 KeyPosition saved; // state before ghosting
147 } __attribute__((packed)) KeyGhost;
150 inline uint8_t keyOn(/*KeyPosition*/uint8_t st)
151 { return (st == KeyState_Press || st == KeyState_Hold) ? 1 : 0; }
154 // ----- Functions -----
157 void Matrix_scan( uint16_t scanNum );