]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/template/config.h
Merge pull request #1 from J3RN/vim-navigation
[qmk_firmware.git] / 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 COLS (int []){ F1, F0, B0 }
46 #define ROWS (int []){ D0, D5 }
47
48 /* COL2ROW or ROW2COL */
49 #define DIODE_DIRECTION COL2ROW
50
51 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
52 #define DEBOUNCE    5
53
54 /* define if matrix has ghost (lacks anti-ghosting diodes) */
55 //#define MATRIX_HAS_GHOST
56
57 /* number of backlight levels */
58 #define BACKLIGHT_LEVELS 3
59
60 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
61 #define LOCKING_SUPPORT_ENABLE
62 /* Locking resynchronize hack */
63 #define LOCKING_RESYNC_ENABLE
64
65 /* 
66  * Force NKRO
67  *
68  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved 
69  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
70  * makefile for this to work.)
71  *
72  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
73  * until the next keyboard reset.
74  *
75  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is 
76  * fully operational during normal computer usage.
77  *
78  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
79  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
80  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
81  * power-up.
82  *
83  */
84 //#define FORCE_NKRO
85
86 /*
87  * Magic Key Options
88  *
89  * Magic keys are hotkey commands that allow control over firmware functions of
90  * the keyboard. They are best used in combination with the HID Listen program,
91  * found here: https://www.pjrc.com/teensy/hid_listen.html
92  *
93  * The options below allow the magic key functionality to be changed. This is 
94  * useful if your keyboard/keypad is missing keys and you want magic key support.
95  *
96  */
97
98 /* key combination for magic key command */
99 #define IS_COMMAND() ( \
100     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
101 )
102
103 /* control how magic key switches layers */
104 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
105 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
106 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
107
108 /* override magic key keymap */
109 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
110 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
111 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
112 //#define MAGIC_KEY_HELP1          H
113 //#define MAGIC_KEY_HELP2          SLASH
114 //#define MAGIC_KEY_DEBUG          D
115 //#define MAGIC_KEY_DEBUG_MATRIX   X
116 //#define MAGIC_KEY_DEBUG_KBD      K
117 //#define MAGIC_KEY_DEBUG_MOUSE    M
118 //#define MAGIC_KEY_VERSION        V
119 //#define MAGIC_KEY_STATUS         S
120 //#define MAGIC_KEY_CONSOLE        C
121 //#define MAGIC_KEY_LAYER0_ALT1    ESC
122 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
123 //#define MAGIC_KEY_LAYER0         0
124 //#define MAGIC_KEY_LAYER1         1
125 //#define MAGIC_KEY_LAYER2         2
126 //#define MAGIC_KEY_LAYER3         3
127 //#define MAGIC_KEY_LAYER4         4
128 //#define MAGIC_KEY_LAYER5         5
129 //#define MAGIC_KEY_LAYER6         6
130 //#define MAGIC_KEY_LAYER7         7
131 //#define MAGIC_KEY_LAYER8         8
132 //#define MAGIC_KEY_LAYER9         9
133 //#define MAGIC_KEY_BOOTLOADER     PAUSE
134 //#define MAGIC_KEY_LOCK           CAPS
135 //#define MAGIC_KEY_EEPROM         E
136 //#define MAGIC_KEY_NKRO           N
137 //#define MAGIC_KEY_SLEEP_LED      Z
138
139 /*
140  * Feature disable options
141  *  These options are also useful to firmware size reduction.
142  */
143
144 /* disable debug print */
145 //#define NO_DEBUG
146
147 /* disable print */
148 //#define NO_PRINT
149
150 /* disable action features */
151 //#define NO_ACTION_LAYER
152 //#define NO_ACTION_TAPPING
153 //#define NO_ACTION_ONESHOT
154 //#define NO_ACTION_MACRO
155 //#define NO_ACTION_FUNCTION
156
157 #endif