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 0xFEED
24 #define PRODUCT_ID 0x0000
25 #define DEVICE_VER 0x0001
26 #define MANUFACTURER You
28 #define DESCRIPTION A custom keyboard
32 #define MATRIX_COLS 14
35 * Keyboard Matrix Assignments
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)
44 #define MATRIX_ROW_PINS { B3, B2, B1, B0, D4 }
45 #define MATRIX_COL_PINS { F6, F5, F4, F1, E6, D0, D1, D2, D3, D5, D6, D7, B4, B5 }
48 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
49 #define DIODE_DIRECTION COL2ROW
51 #define BACKLIGHT_PIN B7
52 #define BACKLIGHT_BREATHING
53 #define BACKLIGHT_LEVELS 3
57 #define RGBLIGHT_ANIMATIONS
59 #define RGBLIGHT_HUE_STEP 12
60 #define RGBLIGHT_SAT_STEP 12
61 #define RGBLIGHT_VAL_STEP 12
65 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
66 #define DEBOUNCING_DELAY 5
68 /* define if matrix has ghost (lacks anti-ghosting diodes) */
69 //#define MATRIX_HAS_GHOST
71 /* number of backlight levels */
73 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
74 #define LOCKING_SUPPORT_ENABLE
75 /* Locking resynchronize hack */
76 #define LOCKING_RESYNC_ENABLE
78 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
79 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
81 // #define GRAVE_ESC_CTRL_OVERRIDE
86 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
87 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
88 * makefile for this to work.)
90 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
91 * until the next keyboard reset.
93 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
94 * fully operational during normal computer usage.
96 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
97 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
98 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
107 * Magic keys are hotkey commands that allow control over firmware functions of
108 * the keyboard. They are best used in combination with the HID Listen program,
109 * found here: https://www.pjrc.com/teensy/hid_listen.html
111 * The options below allow the magic key functionality to be changed. This is
112 * useful if your keyboard/keypad is missing keys and you want magic key support.
116 /* key combination for magic key command */
117 #define IS_COMMAND() ( \
118 keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
121 /* control how magic key switches layers */
122 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
123 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
124 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
126 /* override magic key keymap */
127 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
128 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
129 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
130 //#define MAGIC_KEY_HELP1 H
131 //#define MAGIC_KEY_HELP2 SLASH
132 //#define MAGIC_KEY_DEBUG D
133 //#define MAGIC_KEY_DEBUG_MATRIX X
134 //#define MAGIC_KEY_DEBUG_KBD K
135 //#define MAGIC_KEY_DEBUG_MOUSE M
136 //#define MAGIC_KEY_VERSION V
137 //#define MAGIC_KEY_STATUS S
138 //#define MAGIC_KEY_CONSOLE C
139 //#define MAGIC_KEY_LAYER0_ALT1 ESC
140 //#define MAGIC_KEY_LAYER0_ALT2 GRAVE
141 //#define MAGIC_KEY_LAYER0 0
142 //#define MAGIC_KEY_LAYER1 1
143 //#define MAGIC_KEY_LAYER2 2
144 //#define MAGIC_KEY_LAYER3 3
145 //#define MAGIC_KEY_LAYER4 4
146 //#define MAGIC_KEY_LAYER5 5
147 //#define MAGIC_KEY_LAYER6 6
148 //#define MAGIC_KEY_LAYER7 7
149 //#define MAGIC_KEY_LAYER8 8
150 //#define MAGIC_KEY_LAYER9 9
151 //#define MAGIC_KEY_BOOTLOADER PAUSE
152 //#define MAGIC_KEY_LOCK CAPS
153 //#define MAGIC_KEY_EEPROM E
154 //#define MAGIC_KEY_NKRO N
155 //#define MAGIC_KEY_SLEEP_LED Z
158 * Feature disable options
159 * These options are also useful to firmware size reduction.
162 /* disable debug print */
168 /* disable action features */
169 //#define NO_ACTION_LAYER
170 //#define NO_ACTION_TAPPING
171 //#define NO_ACTION_ONESHOT
172 #define NO_ACTION_MACRO
173 #define NO_ACTION_FUNCTION
179 /* Prevent use of disabled MIDI features in the keymap */
180 //#define MIDI_ENABLE_STRICT 1
182 /* enable basic MIDI features:
183 - MIDI notes can be sent when in Music mode is on
187 /* enable advanced MIDI features:
188 - MIDI notes can be added to the keymap
189 - Octave shift and transpose
190 - Virtual sustain, portamento, and modulation wheel
193 //#define MIDI_ADVANCED
195 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
196 //#define MIDI_TONE_KEYCODE_OCTAVES 1
199 * HD44780 LCD Display Configuration
202 #define LCD_LINES 2 //< number of visible lines of the display
203 #define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
205 #define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
208 #define LCD_PORT PORTB //< port for the LCD lines
209 #define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
210 #define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
211 #define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
212 #define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
213 #define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
214 #define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
215 #define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
216 #define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
217 #define LCD_RS_PORT LCD_PORT //< port for RS line
218 #define LCD_RS_PIN 3 //< pin for RS line
219 #define LCD_RW_PORT LCD_PORT //< port for RW line
220 #define LCD_RW_PIN 2 //< pin for RW line
221 #define LCD_E_PORT LCD_PORT //< port for Enable line
222 #define LCD_E_PIN 1 //< pin for Enable line