quantum/template/avr/config.h

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