1 /* Copyright (C) 2011 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
25 // ----- Includes -----
32 // ----- Scan Mode Setting (See matrix_scan.h for more details) -----
33 #define scanMode scanDual
37 // ----- Key Settings -----
39 // -- Example for scanCol --
41 #define KEYBOARD_SIZE 16 // # of keys
42 #define MAX_ROW_SIZE 16 // # of keys in the largest row
43 #define MAX_COL_SIZE 1 // # of keys in the largest column
47 // -- Example for scanRow --
49 #define KEYBOARD_SIZE 16 // # of keys
50 #define MAX_ROW_SIZE 1 // # of keys in the largest row
51 #define MAX_COL_SIZE 16 // # of keys in the largest column
55 // -- Example for scanRow_powrCol, scanCol_powrRow, and scanDual --
56 #define KEYBOARD_SIZE 69 // # of keys
57 #define MAX_ROW_SIZE 8 // # of keys in the largest row
58 #define MAX_COL_SIZE 9 // # of keys in the largest column
62 // ----- Matrix Configuration -----
63 static const uint8_t matrix_pinout[][MAX_ROW_SIZE + 1] = {
67 // Just layout the matrix by rows and columns
68 // Usually you'll want to set the scanMode above to scanDual or scanCol_powrRow/scanRow_powrCol
69 // The mode allows for optimization in the kind of scanning algorithms that are done
71 // The key numbers are used to translate into the keymap table (array) (and always start from 1, not 0).
72 // Thus if a row doesn't use all the key positions, you can denote it as 0, which will be ignored/skipped on each scan
73 // See the keymap.h file for the various preconfigured arrays.
75 // Scan Mode | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | ...
76 // -------------------------------------------------------
77 // Row 1 | Key 1 Key 7 Key32 ...
78 // Row 2 | Key 3 Key92 ...
85 // -- scanCol Example --
87 { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2, pinF6, pinF7, pinB2, pinD0, pinB0, pinB6, pinB1, pinB3 },
88 { pinNULL, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 },
92 // -- scanRow Example --
94 { scanMode, pinNULL },
114 // -- scanRow_powrCol Example and scanCol_powrRow Example --
115 // The example is the same, as the difference is whether the row or col is powered, and the other is used to detect the signal
116 { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
117 { pinF6, 1, 2, 3, 4, 5, 6, 7, 8 },
118 { pinF7, 9, 10, 11, 12, 13, 14, 15, 16 },
119 { pinB2, 17, 20, 30, 40, 50, 60, 59, 38 },
120 { pinD0, 18, 21, 31, 41, 51, 61, 67, 39 },
121 { pinB0, 19, 22, 32, 42, 52, 62, 68, 47 },
122 { pinB6, 27, 23, 33, 43, 53, 63, 69, 48 },
123 { pinB1, 28, 24, 34, 44, 54, 64, 0, 49 }, // 0 signifies no key at that location
124 { pinB3, 29, 25, 35, 45, 55, 65, 0, 57 },
125 { pinA0, 37, 26, 36, 46, 56, 66, 0, 58 },
128 // -- scanDual Example --
129 // The example is the same as the previous one, but uses both columns and rows to power and detect, needed for non-NKRO matrices.
131 { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
132 { pinF6, 1, 2, 3, 4, 5, 6, 7, 8 },
133 { pinF7, 9, 10, 11, 12, 13, 14, 15, 16 },
134 { pinB2, 17, 20, 30, 40, 50, 60, 59, 38 },
135 { pinD0, 18, 21, 31, 41, 51, 61, 67, 39 },
136 { pinB0, 19, 22, 32, 42, 52, 62, 68, 47 },
137 { pinB6, 27, 23, 33, 43, 53, 63, 69, 48 },
138 { pinB1, 28, 24, 34, 44, 54, 64, 0, 49 }, // 0 signifies no key at that location
139 { pinB3, 29, 25, 35, 45, 55, 65, 0, 57 },
140 { pinA0, 37, 26, 36, 46, 56, 66, 0, 58 },