keyboards/miniaxe/config.h

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