keyboards/xd84/config.h

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