keyboards/xd87/config.h

   1 /*
   2 Copyright 2018 Alexander Fougner <fougner89 at gmail.com>
   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      0x0000
  25 #define DEVICE_VER      0x0001
  26 #define MANUFACTURER    KP Republic
  27 #define PRODUCT         XD87 TKL
  28 #define DESCRIPTION     KP Republic XD87
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 6
  32 #define MATRIX_COLS 17
  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
  45 #define MATRIX_ROW_PINS { D1, B0, B1, C7, D3, D5 }
  46
  47 #define MATRIX_COL_PINS { E6, F0, F1, F4, F5, F6, F7, B5, B6, C6, D4, D6, D7, B4, B2, B3, D2 }
  48 #define UNUSED_PINS
  49
  50 /* COL2ROW, ROW2COL*/
  51 #define DIODE_DIRECTION COL2ROW
  52
  53 #define BACKLIGHT_PIN D0
  54 // #define BACKLIGHT_BREATHING
  55 #define BACKLIGHT_LEVELS 3
  56
  57 // #define RGB_DI_PIN E2
  58 // #ifdef RGB_DI_PIN
  59 // #define RGBLIGHT_ANIMATIONS
  60 // #define RGBLED_NUM 16
  61 // #define RGBLIGHT_HUE_STEP 8
  62 // #define RGBLIGHT_SAT_STEP 8
  63 // #define RGBLIGHT_VAL_STEP 8
  64 // #endif
  65
  66 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  67 #define DEBOUNCE 5
  68
  69 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  70 //#define MATRIX_HAS_GHOST
  71
  72 /* number of backlight levels */
  73
  74 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  75 #define LOCKING_SUPPORT_ENABLE
  76 /* Locking resynchronize hack */
  77 #define LOCKING_RESYNC_ENABLE
  78
  79 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  80  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  81  */
  82 // #define GRAVE_ESC_CTRL_OVERRIDE
  83
  84 /*
  85  * Force NKRO
  86  *
  87  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  88  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  89  * makefile for this to work.)
  90  *
  91  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  92  * until the next keyboard reset.
  93  *
  94  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  95  * fully operational during normal computer usage.
  96  *
  97  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  98  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  99  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 100  * power-up.
 101  *
 102  */
 103 //#define FORCE_NKRO
 104
 105 /*
 106  * Magic Key Options
 107  *
 108  * Magic keys are hotkey commands that allow control over firmware functions of
 109  * the keyboard. They are best used in combination with the HID Listen program,
 110  * found here: https://www.pjrc.com/teensy/hid_listen.html
 111  *
 112  * The options below allow the magic key functionality to be changed. This is
 113  * useful if your keyboard/keypad is missing keys and you want magic key support.
 114  *
 115  */
 116
 117 /* control how magic key switches layers */
 118 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 119 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 120 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 121
 122 /* override magic key keymap */
 123 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 124 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 125 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 126 //#define MAGIC_KEY_HELP1          H
 127 //#define MAGIC_KEY_HELP2          SLASH
 128 //#define MAGIC_KEY_DEBUG          D
 129 //#define MAGIC_KEY_DEBUG_MATRIX   X
 130 //#define MAGIC_KEY_DEBUG_KBD      K
 131 //#define MAGIC_KEY_DEBUG_MOUSE    M
 132 //#define MAGIC_KEY_VERSION        V
 133 //#define MAGIC_KEY_STATUS         S
 134 //#define MAGIC_KEY_CONSOLE        C
 135 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 136 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 137 //#define MAGIC_KEY_LAYER0         0
 138 //#define MAGIC_KEY_LAYER1         1
 139 //#define MAGIC_KEY_LAYER2         2
 140 //#define MAGIC_KEY_LAYER3         3
 141 //#define MAGIC_KEY_LAYER4         4
 142 //#define MAGIC_KEY_LAYER5         5
 143 //#define MAGIC_KEY_LAYER6         6
 144 //#define MAGIC_KEY_LAYER7         7
 145 //#define MAGIC_KEY_LAYER8         8
 146 //#define MAGIC_KEY_LAYER9         9
 147 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 148 //#define MAGIC_KEY_LOCK           CAPS
 149 //#define MAGIC_KEY_EEPROM         E
 150 //#define MAGIC_KEY_NKRO           N
 151 //#define MAGIC_KEY_SLEEP_LED      Z
 152
 153 /*
 154  * Feature disable options
 155  *  These options are also useful to firmware size reduction.
 156  */
 157
 158 /* disable debug print */
 159 //#define NO_DEBUG
 160
 161 /* disable print */
 162 //#define NO_PRINT
 163
 164 /* disable action features */
 165 //#define NO_ACTION_LAYER
 166 //#define NO_ACTION_TAPPING
 167 //#define NO_ACTION_ONESHOT
 168 //#define NO_ACTION_MACRO
 169 //#define NO_ACTION_FUNCTION
 170
 171 /*
 172  * MIDI options
 173  */
 174
 175 /* Prevent use of disabled MIDI features in the keymap */
 176 //#define MIDI_ENABLE_STRICT 1
 177
 178 /* enable basic MIDI features:
 179    - MIDI notes can be sent when in Music mode is on
 180 */
 181 //#define MIDI_BASIC
 182
 183 /* enable advanced MIDI features:
 184    - MIDI notes can be added to the keymap
 185    - Octave shift and transpose
 186    - Virtual sustain, portamento, and modulation wheel
 187    - etc.
 188 */
 189 //#define MIDI_ADVANCED
 190
 191 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 192 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 193
 194 /*
 195  * HD44780 LCD Display Configuration
 196  */
 197 /*
 198 #define LCD_LINES           2     //< number of visible lines of the display
 199 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 200
 201 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 202
 203 #if LCD_IO_MODE
 204 #define LCD_PORT         PORTB        //< port for the LCD lines
 205 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 206 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 207 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 208 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 209 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 210 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 211 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 212 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 213 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 214 #define LCD_RS_PIN       3            //< pin  for RS line
 215 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 216 #define LCD_RW_PIN       2            //< pin  for RW line
 217 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 218 #define LCD_E_PIN        1            //< pin  for Enable line
 219 #endif
 220 */