quantum/template/config.h

   1 /*
   2 Copyright 2012 Jun Wako <wakojun@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 #ifndef CONFIG_H
  19 #define CONFIG_H
  20
  21 #include "config_common.h"
  22
  23 /* USB Device descriptor parameter */
  24 #define VENDOR_ID       0xFEED
  25 #define PRODUCT_ID      0x6060
  26 #define DEVICE_VER      0x0001
  27 #define MANUFACTURER    You
  28 #define PRODUCT         %KEYBOARD%
  29 #define DESCRIPTION     A custom keyboard
  30
  31 /* key matrix size */
  32 #define MATRIX_ROWS 2
  33 #define MATRIX_COLS 3
  34
  35 /*
  36  * Keyboard Matrix Assignments
  37  *
  38  * Change this to how you wired your keyboard
  39  * COLS: AVR pins used for columns, left to right
  40  * ROWS: AVR pins used for rows, top to bottom
  41  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  42  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  43  *
  44 */
  45 #define MATRIX_ROW_PINS { D0, D5 }
  46 #define MATRIX_COL_PINS { F1, F0, B0 }
  47 #define UNUSED_PINS
  48
  49 /* COL2ROW or ROW2COL */
  50 #define DIODE_DIRECTION COL2ROW
  51
  52 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  53 #define DEBOUNCING_DELAY 5
  54
  55 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  56 //#define MATRIX_HAS_GHOST
  57
  58 /* number of backlight levels */
  59 #define BACKLIGHT_LEVELS 3
  60
  61 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  62 #define LOCKING_SUPPORT_ENABLE
  63 /* Locking resynchronize hack */
  64 #define LOCKING_RESYNC_ENABLE
  65
  66 /*
  67  * Force NKRO
  68  *
  69  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  70  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  71  * makefile for this to work.)
  72  *
  73  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  74  * until the next keyboard reset.
  75  *
  76  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  77  * fully operational during normal computer usage.
  78  *
  79  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  80  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  81  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  82  * power-up.
  83  *
  84  */
  85 //#define FORCE_NKRO
  86
  87 /*
  88  * Magic Key Options
  89  *
  90  * Magic keys are hotkey commands that allow control over firmware functions of
  91  * the keyboard. They are best used in combination with the HID Listen program,
  92  * found here: https://www.pjrc.com/teensy/hid_listen.html
  93  *
  94  * The options below allow the magic key functionality to be changed. This is
  95  * useful if your keyboard/keypad is missing keys and you want magic key support.
  96  *
  97  */
  98
  99 /* key combination for magic key command */
 100 #define IS_COMMAND() ( \
 101     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 102 )
 103
 104 /* control how magic key switches layers */
 105 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 106 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 107 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 108
 109 /* override magic key keymap */
 110 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 111 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 112 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 113 //#define MAGIC_KEY_HELP1          H
 114 //#define MAGIC_KEY_HELP2          SLASH
 115 //#define MAGIC_KEY_DEBUG          D
 116 //#define MAGIC_KEY_DEBUG_MATRIX   X
 117 //#define MAGIC_KEY_DEBUG_KBD      K
 118 //#define MAGIC_KEY_DEBUG_MOUSE    M
 119 //#define MAGIC_KEY_VERSION        V
 120 //#define MAGIC_KEY_STATUS         S
 121 //#define MAGIC_KEY_CONSOLE        C
 122 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 123 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 124 //#define MAGIC_KEY_LAYER0         0
 125 //#define MAGIC_KEY_LAYER1         1
 126 //#define MAGIC_KEY_LAYER2         2
 127 //#define MAGIC_KEY_LAYER3         3
 128 //#define MAGIC_KEY_LAYER4         4
 129 //#define MAGIC_KEY_LAYER5         5
 130 //#define MAGIC_KEY_LAYER6         6
 131 //#define MAGIC_KEY_LAYER7         7
 132 //#define MAGIC_KEY_LAYER8         8
 133 //#define MAGIC_KEY_LAYER9         9
 134 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 135 //#define MAGIC_KEY_LOCK           CAPS
 136 //#define MAGIC_KEY_EEPROM         E
 137 //#define MAGIC_KEY_NKRO           N
 138 //#define MAGIC_KEY_SLEEP_LED      Z
 139
 140 /*
 141  * Feature disable options
 142  *  These options are also useful to firmware size reduction.
 143  */
 144
 145 /* disable debug print */
 146 //#define NO_DEBUG
 147
 148 /* disable print */
 149 //#define NO_PRINT
 150
 151 /* disable action features */
 152 //#define NO_ACTION_LAYER
 153 //#define NO_ACTION_TAPPING
 154 //#define NO_ACTION_ONESHOT
 155 //#define NO_ACTION_MACRO
 156 //#define NO_ACTION_FUNCTION
 157
 158 #endif