keyboards/scythe/config.h

   1 /* Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp>
   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      0x3941
  24 #define DEVICE_VER      0x0001
  25 #define MANUFACTURER    Kagizaraya
  26 #define PRODUCT         Scythe
  27 #define DESCRIPTION     Yet another 60% split keyboard
  28
  29 /* key matrix size */
  30 #define MATRIX_ROWS 10
  31 #define MATRIX_COLS 7
  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 { F7, F6, F5, F4, D5 }
  44 #define MATRIX_COL_PINS { D6, D7, B4, B5, B6, C6, C7 }
  45 #define UNUSED_PINS
  46
  47 #define SOFT_SERIAL_PIN D0
  48
  49 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
  50 #define DIODE_DIRECTION COL2ROW
  51
  52 #define BACKLIGHT_PIN B7
  53 // #define BACKLIGHT_BREATHING
  54 #define BACKLIGHT_LEVELS 3
  55
  56 #define RGBLIGHT_SPLIT 1
  57 #define RGB_DI_PIN F0
  58 #ifdef RGB_DI_PIN
  59 #define RGBLIGHT_ANIMATIONS
  60 #define RGBLED_NUM 9
  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 /* key combination for magic key command */
 118 /*
 119 #define IS_COMMAND() ( \
 120     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 121 )
 122 */
 123
 124 /* control how magic key switches layers */
 125 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 126 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 127 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 128
 129 /* override magic key keymap */
 130 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 131 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 132 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 133 //#define MAGIC_KEY_HELP1          H
 134 //#define MAGIC_KEY_HELP2          SLASH
 135 //#define MAGIC_KEY_DEBUG          D
 136 //#define MAGIC_KEY_DEBUG_MATRIX   X
 137 //#define MAGIC_KEY_DEBUG_KBD      K
 138 //#define MAGIC_KEY_DEBUG_MOUSE    M
 139 //#define MAGIC_KEY_VERSION        V
 140 //#define MAGIC_KEY_STATUS         S
 141 //#define MAGIC_KEY_CONSOLE        C
 142 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 143 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 144 //#define MAGIC_KEY_LAYER0         0
 145 //#define MAGIC_KEY_LAYER1         1
 146 //#define MAGIC_KEY_LAYER2         2
 147 //#define MAGIC_KEY_LAYER3         3
 148 //#define MAGIC_KEY_LAYER4         4
 149 //#define MAGIC_KEY_LAYER5         5
 150 //#define MAGIC_KEY_LAYER6         6
 151 //#define MAGIC_KEY_LAYER7         7
 152 //#define MAGIC_KEY_LAYER8         8
 153 //#define MAGIC_KEY_LAYER9         9
 154 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 155 //#define MAGIC_KEY_LOCK           CAPS
 156 //#define MAGIC_KEY_EEPROM         E
 157 //#define MAGIC_KEY_NKRO           N
 158 //#define MAGIC_KEY_SLEEP_LED      Z
 159
 160 /*
 161  * Feature disable options
 162  *  These options are also useful to firmware size reduction.
 163  */
 164
 165 /* disable debug print */
 166 //#define NO_DEBUG
 167
 168 /* disable print */
 169 //#define NO_PRINT
 170
 171 /* disable action features */
 172 //#define NO_ACTION_LAYER
 173 //#define NO_ACTION_TAPPING
 174 //#define NO_ACTION_ONESHOT
 175 //#define NO_ACTION_MACRO
 176 //#define NO_ACTION_FUNCTION
 177
 178 /*
 179  * MIDI options
 180  */
 181
 182 /* Prevent use of disabled MIDI features in the keymap */
 183 //#define MIDI_ENABLE_STRICT 1
 184
 185 /* enable basic MIDI features:
 186    - MIDI notes can be sent when in Music mode is on
 187 */
 188 //#define MIDI_BASIC
 189
 190 /* enable advanced MIDI features:
 191    - MIDI notes can be added to the keymap
 192    - Octave shift and transpose
 193    - Virtual sustain, portamento, and modulation wheel
 194    - etc.
 195 */
 196 //#define MIDI_ADVANCED
 197
 198 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 199 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 200
 201 /*
 202  * HD44780 LCD Display Configuration
 203  */
 204 /*
 205 #define LCD_LINES           2     //< number of visible lines of the display
 206 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 207
 208 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 209
 210 #if LCD_IO_MODE
 211 #define LCD_PORT         PORTB        //< port for the LCD lines
 212 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 213 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 214 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 215 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 216 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 217 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 218 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 219 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 220 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 221 #define LCD_RS_PIN       3            //< pin  for RS line
 222 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 223 #define LCD_RW_PIN       2            //< pin  for RW line
 224 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 225 #define LCD_E_PIN        1            //< pin  for Enable line
 226 #endif
 227 */
 228
 229 /* Bootmagic Lite key configuration */
 230 // #define BOOTMAGIC_LITE_ROW 0
 231 // #define BOOTMAGIC_LITE_COLUMN 0
 232
 233 /* Serial settings */
 234 #define USE_SERIAL
 235 //#define EE_HANDS
 236 #define I2C_MASTER_LEFT
 237 //#define I2C_MASTER_RIGHT
 238
 239 #define TAPPING_TERM    120