1 /* Copyright (C) 2011,2014 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
22 #ifndef __MATRIX_SCAN_H
23 #define __MATRIX_SCAN_H
25 // ----- Includes -----
34 // ----- Defines -----
36 // ----- Quick Map (don't change) -----
95 // ----- Scan Mode (usually dual-scan) -----
96 // Ordered by increasing memory/CPU usage
97 #define scanRow 0 // Needed for powered switches (Hall-Effect)
98 #define scanCol 1 // Opposite of scanRow
99 #define scanRow_powrCol 2 // NKRO supported matrix (simple detection)
100 #define scanCol_powrRow 3 // Opposite of scanRow_powrCol
101 #define scanDual 4 // Typical ~2KRO matrix
103 #define powrRow 5 // Matrix setup for powering a row, initially the row would be set low
104 #define powrCol 6 // Like powrRow but for columns
107 // ----- Direction -----
108 #define columnSet 0 // PIN_SET_COL for PIN_SET
109 #define rowSet 1 // PIN_SET_ROW for PIN_SET
113 // ----- Variables -----
117 // ----- Functions -----
119 void matrix_pinSetup( uint8_t *matrix, uint8_t scanType );
120 void matrix_scan( uint8_t *matrix, uint8_t *detectArray );
122 #endif // __MATRIX_SCAN_H