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