2 Copyright 2018 MechMerlin
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.
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.
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/>.
20 #include "config_common.h"
22 /* USB Device descriptor parameter */
23 #define VENDOR_ID 0x444B // Duck ("DK")
24 #define PRODUCT_ID 0x4A46 // Jetfire ("JF")
25 #define DEVICE_VER 0x0001
26 #define MANUFACTURER Duck
27 #define PRODUCT Jetfire
28 #define DESCRIPTION A custom keyboard
32 #define MATRIX_COLS 20
34 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
35 #define DIODE_DIRECTION COL2ROW
37 #define BACKLIGHT_LEVELS 1
41 #define RGBLIGHT_ANIMATIONS
43 // #define RGBLIGHT_HUE_STEP 8
44 // #define RGBLIGHT_SAT_STEP 8
45 // #define RGBLIGHT_VAL_STEP 8
48 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
49 #define DEBOUNCING_DELAY 5
51 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
52 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
54 // #define GRAVE_ESC_CTRL_OVERRIDE
59 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
60 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
61 * makefile for this to work.)
63 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
64 * until the next keyboard reset.
66 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
67 * fully operational during normal computer usage.
69 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
70 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
71 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
80 * Magic keys are hotkey commands that allow control over firmware functions of
81 * the keyboard. They are best used in combination with the HID Listen program,
82 * found here: https://www.pjrc.com/teensy/hid_listen.html
84 * The options below allow the magic key functionality to be changed. This is
85 * useful if your keyboard/keypad is missing keys and you want magic key support.
89 /* control how magic key switches layers */
90 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
91 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
92 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
94 /* override magic key keymap */
95 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
96 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
97 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
98 //#define MAGIC_KEY_HELP1 H
99 //#define MAGIC_KEY_HELP2 SLASH
100 //#define MAGIC_KEY_DEBUG D
101 //#define MAGIC_KEY_DEBUG_MATRIX X
102 //#define MAGIC_KEY_DEBUG_KBD K
103 //#define MAGIC_KEY_DEBUG_MOUSE M
104 //#define MAGIC_KEY_VERSION V
105 //#define MAGIC_KEY_STATUS S
106 //#define MAGIC_KEY_CONSOLE C
107 //#define MAGIC_KEY_LAYER0_ALT1 ESC
108 //#define MAGIC_KEY_LAYER0_ALT2 GRAVE
109 //#define MAGIC_KEY_LAYER0 0
110 //#define MAGIC_KEY_LAYER1 1
111 //#define MAGIC_KEY_LAYER2 2
112 //#define MAGIC_KEY_LAYER3 3
113 //#define MAGIC_KEY_LAYER4 4
114 //#define MAGIC_KEY_LAYER5 5
115 //#define MAGIC_KEY_LAYER6 6
116 //#define MAGIC_KEY_LAYER7 7
117 //#define MAGIC_KEY_LAYER8 8
118 //#define MAGIC_KEY_LAYER9 9
119 //#define MAGIC_KEY_BOOTLOADER PAUSE
120 //#define MAGIC_KEY_LOCK CAPS
121 //#define MAGIC_KEY_EEPROM E
122 //#define MAGIC_KEY_NKRO N
123 //#define MAGIC_KEY_SLEEP_LED Z
126 * Feature disable options
127 * These options are also useful to firmware size reduction.
130 /* disable debug print */
136 /* disable action features */
137 //#define NO_ACTION_LAYER
138 //#define NO_ACTION_TAPPING
139 //#define NO_ACTION_ONESHOT
140 //#define NO_ACTION_MACRO
141 //#define NO_ACTION_FUNCTION
147 /* Prevent use of disabled MIDI features in the keymap */
148 //#define MIDI_ENABLE_STRICT 1
150 /* enable basic MIDI features:
151 - MIDI notes can be sent when in Music mode is on
155 /* enable advanced MIDI features:
156 - MIDI notes can be added to the keymap
157 - Octave shift and transpose
158 - Virtual sustain, portamento, and modulation wheel
161 //#define MIDI_ADVANCED
163 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
164 //#define MIDI_TONE_KEYCODE_OCTAVES 1
167 * HD44780 LCD Display Configuration
170 #define LCD_LINES 2 //< number of visible lines of the display
171 #define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
173 #define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
176 #define LCD_PORT PORTB //< port for the LCD lines
177 #define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
178 #define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
179 #define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
180 #define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
181 #define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
182 #define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
183 #define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
184 #define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
185 #define LCD_RS_PORT LCD_PORT //< port for RS line
186 #define LCD_RS_PIN 3 //< pin for RS line
187 #define LCD_RW_PORT LCD_PORT //< port for RW line
188 #define LCD_RW_PIN 2 //< pin for RW line
189 #define LCD_E_PORT LCD_PORT //< port for Enable line
190 #define LCD_E_PIN 1 //< pin for Enable line