Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
controller/Scan/MatrixARM/matrix_scan.h
Jacob Alexander a9c5898ba5 Adding configurable DebounceDivThreshold
Can be specified from any .kll file

DebounceDivThreshold = 0xFFFFFFFF
Sets to max debounce, default is 0xFFFF.
The 0xFFFFFFFF is about a 2x longer debounce
The max requires more ram (as it uses 32 bit variables instead of 16).

Added support for submodule capabilities files.
2015-02-28 22:13:17 -08:00

146 lines
3.1 KiB
C

/* Copyright (C) 2014-2015 by Jacob Alexander
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef __MATRIX_SCAN_H
#define __MATRIX_SCAN_H
// ----- Includes -----
// KLL Generated Defines
#include <kll_defs.h>
// ----- Defines -----
#if ( DebounceDivThreshold_define < 0xFF + 1 )
#define DebounceCounter uint8_t
#elif ( DebounceDivThreshold_define < 0xFFFF + 1 )
#define DebounceCounter uint16_t
#elif ( DebounceDivThreshold_define < 0xFFFFFFFF + 1 )
#define DebounceCounter uint32_t
#else
#error "Debounce threshold is too high... 32 bit max. Check .kll defines."
#endif
// ----- Enums -----
// Freescale MK20s have GPIO ports A...E
typedef enum Port {
Port_A = 0,
Port_B = 1,
Port_C = 2,
Port_D = 3,
Port_E = 4,
} Port;
// Each port has a possible 32 pins
typedef enum Pin {
Pin_0 = 0,
Pin_1 = 1,
Pin_2 = 2,
Pin_3 = 3,
Pin_4 = 4,
Pin_5 = 5,
Pin_6 = 6,
Pin_7 = 7,
Pin_8 = 8,
Pin_9 = 9,
Pin_10 = 10,
Pin_11 = 11,
Pin_12 = 12,
Pin_13 = 13,
Pin_14 = 14,
Pin_15 = 15,
Pin_16 = 16,
Pin_17 = 17,
Pin_18 = 18,
Pin_19 = 19,
Pin_20 = 20,
Pin_21 = 21,
Pin_22 = 22,
Pin_23 = 23,
Pin_24 = 24,
Pin_25 = 25,
Pin_26 = 26,
Pin_27 = 27,
Pin_28 = 28,
Pin_29 = 29,
Pin_30 = 30,
Pin_31 = 31,
} Pin;
// Type of pin
typedef enum Type {
Type_StrobeOn,
Type_StrobeOff,
Type_StrobeSetup,
Type_Sense,
Type_SenseSetup,
} Type;
// Sense/Strobe configuration
typedef enum Config {
Config_Pullup, // Internal pull-up
Config_Pulldown, // Internal pull-down
Config_Opendrain, // External pull resistor
} Config;
// Keypress States
typedef enum KeyPosition {
KeyState_Off = 0,
KeyState_Press = 1,
KeyState_Hold = 2,
KeyState_Release = 3,
KeyState_Invalid,
} KeyPosition;
// ----- Structs -----
// Struct container for defining Rows (Sense) and Columns (Strobes)
typedef struct GPIO_Pin {
Port port;
Pin pin;
} GPIO_Pin;
// Debounce Element
typedef struct KeyState {
KeyPosition prevState;
KeyPosition curState;
DebounceCounter activeCount;
DebounceCounter inactiveCount;
} KeyState;
// ----- Functions -----
void Matrix_setup();
void Matrix_scan( uint16_t scanNum );
#endif // __MATRIX_SCAN_H