Scan/matrix/matrix_template.h

   1 /* Copyright (C) 2011,2014 by Jacob Alexander
   2  *
   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:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  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
  19  * THE SOFTWARE.
  20  */
  21
  22 #ifndef __MATRIX_H
  23 #define __MATRIX_H
  24
  25 // ----- Includes -----
  26
  27 // Compiler Includes
  28 #include <stdint.h>
  29
  30
  31
  32 // ----- Scan Mode Setting (See matrix_scan.h for more details) -----
  33 #define scanMode scanDual
  34
  35
  36
  37 // ----- Key Settings -----
  38
  39 // -- Example for scanCol --
  40 /*
  41 #define KEYBOARD_KEYS 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
  44 */
  45
  46
  47 // -- Example for scanRow --
  48 /*
  49 #define KEYBOARD_KEYS 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
  52 */
  53
  54
  55 // -- Example for scanRow_powrCol, scanCol_powrRow, and scanDual --
  56 /*
  57 #define KEYBOARD_KEYS 69 // # of keys
  58 #define MAX_ROW_SIZE   8 // # of keys in the largest row
  59 #define MAX_COL_SIZE   9 // # of keys in the largest column
  60 */
  61
  62
  63
  64 // ----- Matrix Configuration -----
  65 static const uint8_t matrix_pinout[][MAX_ROW_SIZE + 1] = {
  66
  67
  68
  69 // Just layout the matrix by rows and columns
  70 // Usually you'll want to set the scanMode above to scanDual or scanCol_powrRow/scanRow_powrCol
  71 // The mode allows for optimization in the kind of scanning algorithms that are done
  72 //
  73 // The key numbers are used to translate into the keymap table (array) (and always start from 1, not 0).
  74 // 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
  75 // See the keymap.h file for the various preconfigured arrays.
  76
  77 // Scan Mode | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | ...
  78 // -------------------------------------------------------
  79 //     Row 1 | Key 1   Key 7   Key32    ...
  80 //     Row 2 | Key 3   Key92    ...
  81 //     Row 3 | Key23    ...
  82 //     Row 4 |  ...
  83 //     Row 5 |
  84 //      ...  |
  85
  86
  87 // -- scanCol Example --
  88 /*
  89   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2, pinF6, pinF7, pinB2, pinD0, pinB0, pinB6, pinB1, pinB3 },
  90   { pinNULL,  1,     2,     3,     4,     5,     6,     7,     8,     9,     10,    11,    12,    13,    14,    15,    16    },
  91 */
  92
  93
  94 // -- scanRow Example --
  95 /*
  96   { scanMode, pinNULL },
  97   { pinF0,    1       },
  98   { pinF4,    2       },
  99   { pinB7,    3       },
 100   { pinD3,    4       },
 101   { pinF5,    5       },
 102   { pinF1,    6       },
 103   { pinD1,    7       },
 104   { pinD2,    8       },
 105   { pinF6,    9       },
 106   { pinF7,    10      },
 107   { pinB2,    11      },
 108   { pinD0,    12      },
 109   { pinB0,    13      },
 110   { pinB6,    14      },
 111   { pinB1,    15      },
 112   { pinB3,    16      },
 113 */
 114
 115
 116 // -- scanRow_powrCol Example and scanCol_powrRow Example --
 117 // 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
 118 /*
 119   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
 120   { pinF6,    1,     2,     3,     4,     5,     6,     7,     8     },
 121   { pinF7,    9,     10,    11,    12,    13,    14,    15,    16    },
 122   { pinB2,    17,    20,    30,    40,    50,    60,    59,    38    },
 123   { pinD0,    18,    21,    31,    41,    51,    61,    67,    39    },
 124   { pinB0,    19,    22,    32,    42,    52,    62,    68,    47    },
 125   { pinB6,    27,    23,    33,    43,    53,    63,    69,    48    },
 126   { pinB1,    28,    24,    34,    44,    54,    64,    0,     49    }, // 0 signifies no key at that location
 127   { pinB3,    29,    25,    35,    45,    55,    65,    0,     57    },
 128   { pinA0,    37,    26,    36,    46,    56,    66,    0,     58    },
 129 */
 130
 131
 132 // -- scanDual Example --
 133 // The example is the same as the previous one, but uses both columns and rows to power and detect, needed for non-NKRO matrices.
 134 /*
 135   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
 136   { pinF6,    1,     2,     3,     4,     5,     6,     7,     8     },
 137   { pinF7,    9,     10,    11,    12,    13,    14,    15,    16    },
 138   { pinB2,    17,    20,    30,    40,    50,    60,    59,    38    },
 139   { pinD0,    18,    21,    31,    41,    51,    61,    67,    39    },
 140   { pinB0,    19,    22,    32,    42,    52,    62,    68,    47    },
 141   { pinB6,    27,    23,    33,    43,    53,    63,    69,    48    },
 142   { pinB1,    28,    24,    34,    44,    54,    64,    0,     49    }, // 0 signifies no key at that location
 143   { pinB3,    29,    25,    35,    45,    55,    65,    0,     57    },
 144   { pinA0,    37,    26,    36,    46,    56,    66,    0,     58    },
 145 */
 146
 147
 148 };
 149
 150
 151
 152 #endif // __MATRIX_H
 153