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 15
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 { B0, B3, C7, B6, C6 }
45 #define MATRIX_COL_PINS { F6, F5, F4, F1, E6, D5, D3, D2, D1, D0, D4, 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 8
60 #define RGBLIGHT_SAT_STEP 8
61 #define RGBLIGHT_VAL_STEP 8
64 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
65 #define DEBOUNCING_DELAY 5
67 /* define if matrix has ghost (lacks anti-ghosting diodes) */
68 //#define MATRIX_HAS_GHOST
70 /* number of backlight levels */
72 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
73 #define LOCKING_SUPPORT_ENABLE
74 /* Locking resynchronize hack */
75 #define LOCKING_RESYNC_ENABLE
77 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
78 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
80 // #define GRAVE_ESC_CTRL_OVERRIDE
85 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
86 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
87 * makefile for this to work.)
89 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
90 * until the next keyboard reset.
92 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
93 * fully operational during normal computer usage.
95 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
96 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
97 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
106 * Magic keys are hotkey commands that allow control over firmware functions of
107 * the keyboard. They are best used in combination with the HID Listen program,
108 * found here: https://www.pjrc.com/teensy/hid_listen.html
110 * The options below allow the magic key functionality to be changed. This is
111 * useful if your keyboard/keypad is missing keys and you want magic key support.
115 /* key combination for magic key command */
116 #define IS_COMMAND() ( \
117 keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
120 /* control how magic key switches layers */
121 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
122 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
123 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
125 /* override magic key keymap */
126 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
127 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
128 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
129 //#define MAGIC_KEY_HELP1 H
130 //#define MAGIC_KEY_HELP2 SLASH
131 //#define MAGIC_KEY_DEBUG D
132 //#define MAGIC_KEY_DEBUG_MATRIX X
133 //#define MAGIC_KEY_DEBUG_KBD K
134 //#define MAGIC_KEY_DEBUG_MOUSE M
135 //#define MAGIC_KEY_VERSION V
136 //#define MAGIC_KEY_STATUS S
137 //#define MAGIC_KEY_CONSOLE C
138 //#define MAGIC_KEY_LAYER0_ALT1 ESC
139 //#define MAGIC_KEY_LAYER0_ALT2 GRAVE
140 //#define MAGIC_KEY_LAYER0 0
141 //#define MAGIC_KEY_LAYER1 1
142 //#define MAGIC_KEY_LAYER2 2
143 //#define MAGIC_KEY_LAYER3 3
144 //#define MAGIC_KEY_LAYER4 4
145 //#define MAGIC_KEY_LAYER5 5
146 //#define MAGIC_KEY_LAYER6 6
147 //#define MAGIC_KEY_LAYER7 7
148 //#define MAGIC_KEY_LAYER8 8
149 //#define MAGIC_KEY_LAYER9 9
150 //#define MAGIC_KEY_BOOTLOADER PAUSE
151 //#define MAGIC_KEY_LOCK CAPS
152 //#define MAGIC_KEY_EEPROM E
153 //#define MAGIC_KEY_NKRO N
154 //#define MAGIC_KEY_SLEEP_LED Z
157 * Feature disable options
158 * These options are also useful to firmware size reduction.
161 /* disable debug print */
167 /* disable action features */
168 //#define NO_ACTION_LAYER
169 //#define NO_ACTION_TAPPING
170 //#define NO_ACTION_ONESHOT
171 //#define NO_ACTION_MACRO
172 //#define NO_ACTION_FUNCTION
178 /* Prevent use of disabled MIDI features in the keymap */
179 //#define MIDI_ENABLE_STRICT 1
181 /* enable basic MIDI features:
182 - MIDI notes can be sent when in Music mode is on
186 /* enable advanced MIDI features:
187 - MIDI notes can be added to the keymap
188 - Octave shift and transpose
189 - Virtual sustain, portamento, and modulation wheel
192 //#define MIDI_ADVANCED
194 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
195 //#define MIDI_TONE_KEYCODE_OCTAVES 1
198 * HD44780 LCD Display Configuration
201 #define LCD_LINES 2 //< number of visible lines of the display
202 #define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
204 #define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
207 #define LCD_PORT PORTB //< port for the LCD lines
208 #define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
209 #define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
210 #define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
211 #define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
212 #define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
213 #define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
214 #define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
215 #define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
216 #define LCD_RS_PORT LCD_PORT //< port for RS line
217 #define LCD_RS_PIN 3 //< pin for RS line
218 #define LCD_RW_PORT LCD_PORT //< port for RW line
219 #define LCD_RW_PIN 2 //< pin for RW line
220 #define LCD_E_PORT LCD_PORT //< port for Enable line
221 #define LCD_E_PIN 1 //< pin for Enable line
225 /* Bootmagic Lite key configuration */
226 // #define BOOTMAGIC_LITE_ROW 0
227 // #define BOOTMAGIC_LITE_COLUMN 0