keyboards/ep/96/config.h

   1 /*
   2 Copyright 2018 Elliot Powell
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #pragma once
  19
  20 #include "config_common.h"
  21
  22 /* USB Device descriptor parameter */
  23 #define VENDOR_ID       0xFEED
  24 #define PRODUCT_ID      0x9696
  25 #define DEVICE_VER      0x0001
  26 #define MANUFACTURER    Elliot Powell
  27 #define PRODUCT         ep96
  28 #define DESCRIPTION     A simple 96 key keyboard
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 6
  32 #define MATRIX_COLS 19
  33
  34 /*
  35  * Keyboard Matrix Assignments
  36  *
  37  * Change this to how you wired your keyboard
  38  * COLS: AVR pins used for columns, left to right
  39  * ROWS: AVR pins used for rows, top to bottom
  40  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  41  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  42  *
  43 */
  44 #define MATRIX_ROW_PINS { B0, B1, B3, B2, B7, C6 }
  45 #define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, B5, B6, C7, F7, F6, F5, F4, F1, F0, E6 }
  46 #define UNUSED_PINS
  47
  48 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
  49 #define DIODE_DIRECTION COL2ROW
  50
  51 // #endif
  52
  53 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  54 #define DEBOUNCING_DELAY 5
  55
  56 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  57 //#define MATRIX_HAS_GHOST
  58
  59
  60 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  61 #define LOCKING_SUPPORT_ENABLE
  62 /* Locking resynchronize hack */
  63 #define LOCKING_RESYNC_ENABLE
  64
  65 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  66  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  67  */
  68 // #define GRAVE_ESC_CTRL_OVERRIDE
  69
  70 /*
  71  * Force NKRO
  72  *
  73  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  74  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  75  * makefile for this to work.)
  76  *
  77  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  78  * until the next keyboard reset.
  79  *
  80  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  81  * fully operational during normal computer usage.
  82  *
  83  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  84  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  85  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  86  * power-up.
  87  *
  88  */
  89 //#define FORCE_NKRO
  90
  91 /*
  92  * Magic Key Options
  93  *
  94  * Magic keys are hotkey commands that allow control over firmware functions of
  95  * the keyboard. They are best used in combination with the HID Listen program,
  96  * found here: https://www.pjrc.com/teensy/hid_listen.html
  97  *
  98  * The options below allow the magic key functionality to be changed. This is
  99  * useful if your keyboard/keypad is missing keys and you want magic key support.
 100  *
 101  */
 102
 103 /* key combination for magic key command */
 104 #define IS_COMMAND() ( \
 105     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 106 )
 107
 108 /* control how magic key switches layers */
 109 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 110 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 111 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 112
 113 /* override magic key keymap */
 114 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 115 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 116 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 117 //#define MAGIC_KEY_HELP1          H
 118 //#define MAGIC_KEY_HELP2          SLASH
 119 //#define MAGIC_KEY_DEBUG          D
 120 //#define MAGIC_KEY_DEBUG_MATRIX   X
 121 //#define MAGIC_KEY_DEBUG_KBD      K
 122 //#define MAGIC_KEY_DEBUG_MOUSE    M
 123 //#define MAGIC_KEY_VERSION        V
 124 //#define MAGIC_KEY_STATUS         S
 125 //#define MAGIC_KEY_CONSOLE        C
 126 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 127 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 128 //#define MAGIC_KEY_LAYER0         0
 129 //#define MAGIC_KEY_LAYER1         1
 130 //#define MAGIC_KEY_LAYER2         2
 131 //#define MAGIC_KEY_LAYER3         3
 132 //#define MAGIC_KEY_LAYER4         4
 133 //#define MAGIC_KEY_LAYER5         5
 134 //#define MAGIC_KEY_LAYER6         6
 135 //#define MAGIC_KEY_LAYER7         7
 136 //#define MAGIC_KEY_LAYER8         8
 137 //#define MAGIC_KEY_LAYER9         9
 138 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 139 //#define MAGIC_KEY_LOCK           CAPS
 140 //#define MAGIC_KEY_EEPROM         E
 141 //#define MAGIC_KEY_NKRO           N
 142 //#define MAGIC_KEY_SLEEP_LED      Z
 143
 144 /*
 145  * Feature disable options
 146  *  These options are also useful to firmware size reduction.
 147  */
 148
 149 /* disable debug print */
 150 //#define NO_DEBUG
 151
 152 /* disable print */
 153 //#define NO_PRINT
 154
 155 /* disable action features */
 156 //#define NO_ACTION_LAYER
 157 //#define NO_ACTION_TAPPING
 158 //#define NO_ACTION_ONESHOT
 159 //#define NO_ACTION_MACRO
 160 //#define NO_ACTION_FUNCTION
 161
 162 /*
 163  * MIDI options
 164  */
 165
 166 /* Prevent use of disabled MIDI features in the keymap */
 167 //#define MIDI_ENABLE_STRICT 1
 168
 169 /* enable basic MIDI features:
 170    - MIDI notes can be sent when in Music mode is on
 171 */
 172 //#define MIDI_BASIC
 173
 174 /* enable advanced MIDI features:
 175    - MIDI notes can be added to the keymap
 176    - Octave shift and transpose
 177    - Virtual sustain, portamento, and modulation wheel
 178    - etc.
 179 */
 180 //#define MIDI_ADVANCED
 181
 182 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 183 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 184
 185 /*
 186  * HD44780 LCD Display Configuration
 187  */
 188 /*
 189 #define LCD_LINES           2     //< number of visible lines of the display
 190 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 191
 192 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 193
 194 #if LCD_IO_MODE
 195 #define LCD_PORT         PORTB        //< port for the LCD lines
 196 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 197 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 198 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 199 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 200 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 201 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 202 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 203 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 204 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 205 #define LCD_RS_PIN       3            //< pin  for RS line
 206 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 207 #define LCD_RW_PIN       2            //< pin  for RW line
 208 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 209 #define LCD_E_PIN        1            //< pin  for Enable line
 210 #endif
 211 */
 212