aboutsummaryrefslogtreecommitdiff
path: root/quantum/template/avr/config.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/template/avr/config.h')
-rw-r--r--quantum/template/avr/config.h190
1 files changed, 190 insertions, 0 deletions
diff --git a/quantum/template/avr/config.h b/quantum/template/avr/config.h
new file mode 100644
index 000000000..6d0b3c4d5
--- /dev/null
+++ b/quantum/template/avr/config.h
@@ -0,0 +1,190 @@
1/*
2Copyright 2017 REPLACE_WITH_YOUR_NAME
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along 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 0x0000
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, 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
57/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
58#define DEBOUNCING_DELAY 5
59
60/* define if matrix has ghost (lacks anti-ghosting diodes) */
61//#define MATRIX_HAS_GHOST
62
63/* number of backlight levels */
64
65/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
66#define LOCKING_SUPPORT_ENABLE
67/* Locking resynchronize hack */
68#define LOCKING_RESYNC_ENABLE
69
70/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
71 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
72 */
73// #define GRAVE_ESC_CTRL_OVERRIDE
74
75/*
76 * Force NKRO
77 *
78 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
79 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
80 * makefile for this to work.)
81 *
82 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
83 * until the next keyboard reset.
84 *
85 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
86 * fully operational during normal computer usage.
87 *
88 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
89 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
90 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
91 * power-up.
92 *
93 */
94//#define FORCE_NKRO
95
96/*
97 * Magic Key Options
98 *
99 * Magic keys are hotkey commands that allow control over firmware functions of
100 * the keyboard. They are best used in combination with the HID Listen program,
101 * found here: https://www.pjrc.com/teensy/hid_listen.html
102 *
103 * The options below allow the magic key functionality to be changed. This is
104 * useful if your keyboard/keypad is missing keys and you want magic key support.
105 *
106 */
107
108/* key combination for magic key command */
109#define IS_COMMAND() ( \
110 keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
111)
112
113/* control how magic key switches layers */
114//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
115//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
116//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
117
118/* override magic key keymap */
119//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
120//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
121//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
122//#define MAGIC_KEY_HELP1 H
123//#define MAGIC_KEY_HELP2 SLASH
124//#define MAGIC_KEY_DEBUG D
125//#define MAGIC_KEY_DEBUG_MATRIX X
126//#define MAGIC_KEY_DEBUG_KBD K
127//#define MAGIC_KEY_DEBUG_MOUSE M
128//#define MAGIC_KEY_VERSION V
129//#define MAGIC_KEY_STATUS S
130//#define MAGIC_KEY_CONSOLE C
131//#define MAGIC_KEY_LAYER0_ALT1 ESC
132//#define MAGIC_KEY_LAYER0_ALT2 GRAVE
133//#define MAGIC_KEY_LAYER0 0
134//#define MAGIC_KEY_LAYER1 1
135//#define MAGIC_KEY_LAYER2 2
136//#define MAGIC_KEY_LAYER3 3
137//#define MAGIC_KEY_LAYER4 4
138//#define MAGIC_KEY_LAYER5 5
139//#define MAGIC_KEY_LAYER6 6
140//#define MAGIC_KEY_LAYER7 7
141//#define MAGIC_KEY_LAYER8 8
142//#define MAGIC_KEY_LAYER9 9
143//#define MAGIC_KEY_BOOTLOADER PAUSE
144//#define MAGIC_KEY_LOCK CAPS
145//#define MAGIC_KEY_EEPROM E
146//#define MAGIC_KEY_NKRO N
147//#define MAGIC_KEY_SLEEP_LED Z
148
149/*
150 * Feature disable options
151 * These options are also useful to firmware size reduction.
152 */
153
154/* disable debug print */
155//#define NO_DEBUG
156
157/* disable print */
158//#define NO_PRINT
159
160/* disable action features */
161//#define NO_ACTION_LAYER
162//#define NO_ACTION_TAPPING
163//#define NO_ACTION_ONESHOT
164//#define NO_ACTION_MACRO
165//#define NO_ACTION_FUNCTION
166
167/*
168 * MIDI options
169 */
170
171/* Prevent use of disabled MIDI features in the keymap */
172//#define MIDI_ENABLE_STRICT 1
173
174/* enable basic MIDI features:
175 - MIDI notes can be sent when in Music mode is on
176*/
177//#define MIDI_BASIC
178
179/* enable advanced MIDI features:
180 - MIDI notes can be added to the keymap
181 - Octave shift and transpose
182 - Virtual sustain, portamento, and modulation wheel
183 - etc.
184*/
185//#define MIDI_ADVANCED
186
187/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
188//#define MIDI_TONE_KEYCODE_OCTAVES 1
189
190#endif