[jackhill/qmk/firmware.git] / keyboards / kbd6x / config.h

/*
Copyright 2018 MechMerlin

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0x0000
#define DEVICE_VER      0x0001
#define MANUFACTURER    You
#define PRODUCT         kbd6x
#define DESCRIPTION     A custom keyboard

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 14

/*
 * Keyboard Matrix Assignments
 *
 * Change this to how you wired your keyboard
 * COLS: AVR pins used for columns, left to right
 * ROWS: AVR pins used for rows, top to bottom
 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
 *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
 *
*/
#define MATRIX_ROW_PINS { B3, B2, B1, B0, D4 }
#define MATRIX_COL_PINS { F6, F5, F4, F1, E6, D0, D1, D2, D3, D5, D6, D7, B4, B5 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
#define DIODE_DIRECTION COL2ROW

#define BACKLIGHT_PIN B7
#define BACKLIGHT_BREATHING
#define BACKLIGHT_LEVELS 3

#define RGB_DI_PIN F0
#ifdef RGB_DI_PIN
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 14
#define RGBLIGHT_HUE_STEP 12
#define RGBLIGHT_SAT_STEP 12
#define RGBLIGHT_VAL_STEP 12
#endif


/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCING_DELAY 5

/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST

/* number of backlight levels */

/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
#define LOCKING_SUPPORT_ENABLE
/* Locking resynchronize hack */
#define LOCKING_RESYNC_ENABLE

/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 */
// #define GRAVE_ESC_CTRL_OVERRIDE

/*
 * Force NKRO
 *
 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 * makefile for this to work.)
 *
 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 * until the next keyboard reset.
 *
 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 * fully operational during normal computer usage.
 *
 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 * power-up.
 *
 */
//#define FORCE_NKRO

/*
 * Magic Key Options
 *
 * Magic keys are hotkey commands that allow control over firmware functions of
 * the keyboard. They are best used in combination with the HID Listen program,
 * found here: https://www.pjrc.com/teensy/hid_listen.html
 *
 * The options below allow the magic key functionality to be changed. This is
 * useful if your keyboard/keypad is missing keys and you want magic key support.
 *
 */

/* key combination for magic key command */
#define IS_COMMAND() ( \
    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
)

/* control how magic key switches layers */
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false

/* override magic key keymap */
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
//#define MAGIC_KEY_HELP1          H
//#define MAGIC_KEY_HELP2          SLASH
//#define MAGIC_KEY_DEBUG          D
//#define MAGIC_KEY_DEBUG_MATRIX   X
//#define MAGIC_KEY_DEBUG_KBD      K
//#define MAGIC_KEY_DEBUG_MOUSE    M
//#define MAGIC_KEY_VERSION        V
//#define MAGIC_KEY_STATUS         S
//#define MAGIC_KEY_CONSOLE        C
//#define MAGIC_KEY_LAYER0_ALT1    ESC
//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
//#define MAGIC_KEY_LAYER0         0
//#define MAGIC_KEY_LAYER1         1
//#define MAGIC_KEY_LAYER2         2
//#define MAGIC_KEY_LAYER3         3
//#define MAGIC_KEY_LAYER4         4
//#define MAGIC_KEY_LAYER5         5
//#define MAGIC_KEY_LAYER6         6
//#define MAGIC_KEY_LAYER7         7
//#define MAGIC_KEY_LAYER8         8
//#define MAGIC_KEY_LAYER9         9
//#define MAGIC_KEY_BOOTLOADER     PAUSE
//#define MAGIC_KEY_LOCK           CAPS
//#define MAGIC_KEY_EEPROM         E
//#define MAGIC_KEY_NKRO           N
//#define MAGIC_KEY_SLEEP_LED      Z

/*
 * Feature disable options
 *  These options are also useful to firmware size reduction.
 */

/* disable debug print */
//#define NO_DEBUG

/* disable print */
//#define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

/*
 * MIDI options
 */

/* Prevent use of disabled MIDI features in the keymap */
//#define MIDI_ENABLE_STRICT 1

/* enable basic MIDI features:
   - MIDI notes can be sent when in Music mode is on
*/
//#define MIDI_BASIC

/* enable advanced MIDI features:
   - MIDI notes can be added to the keymap
   - Octave shift and transpose
   - Virtual sustain, portamento, and modulation wheel
   - etc.
*/
//#define MIDI_ADVANCED

/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
//#define MIDI_TONE_KEYCODE_OCTAVES 1

/*
 * HD44780 LCD Display Configuration
 */
/*
#define LCD_LINES           2     //< number of visible lines of the display
#define LCD_DISP_LENGTH    16     //< visibles characters per line of the display

#define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode

#if LCD_IO_MODE
#define LCD_PORT         PORTB        //< port for the LCD lines
#define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
#define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
#define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
#define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
#define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
#define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
#define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
#define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
#define LCD_RS_PORT      LCD_PORT     //< port for RS line
#define LCD_RS_PIN       3            //< pin  for RS line
#define LCD_RW_PORT      LCD_PORT     //< port for RW line
#define LCD_RW_PIN       2            //< pin  for RW line
#define LCD_E_PORT       LCD_PORT     //< port for Enable line
#define LCD_E_PIN        1            //< pin  for Enable line
#endif
*/
Commit	Line	Data
0c4e0a20 M	1	/*
	2	Copyright 2018 MechMerlin
	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	#pragma once
	19
	20	#include "config_common.h"
	21
	22	/* USB Device descriptor parameter */
	23	#define VENDOR_ID 0xFEED
	24	#define PRODUCT_ID 0x0000
	25	#define DEVICE_VER 0x0001
	26	#define MANUFACTURER You
	27	#define PRODUCT kbd6x
	28	#define DESCRIPTION A custom keyboard
	29
	30	/* key matrix size */
	31	#define MATRIX_ROWS 5
	32	#define MATRIX_COLS 14
	33
	34	/*
	35	* Keyboard Matrix Assignments
	36	*
	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)
	42	*
	43	*/
	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 }
	46	#define UNUSED_PINS
	47
	48	/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
	49	#define DIODE_DIRECTION COL2ROW
	50
	51	#define BACKLIGHT_PIN B7
	52	#define BACKLIGHT_BREATHING
	53	#define BACKLIGHT_LEVELS 3
	54
	55	#define RGB_DI_PIN F0
	56	#ifdef RGB_DI_PIN
	57	#define RGBLIGHT_ANIMATIONS
	58	#define RGBLED_NUM 14
	59	#define RGBLIGHT_HUE_STEP 12
	60	#define RGBLIGHT_SAT_STEP 12
	61	#define RGBLIGHT_VAL_STEP 12
	62	#endif
	63
	64
65	/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
66	#define DEBOUNCING_DELAY 5
67
68	/* define if matrix has ghost (lacks anti-ghosting diodes) */
69	//#define MATRIX_HAS_GHOST
70
71	/* number of backlight levels */
72
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
77
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).
80	*/
81	// #define GRAVE_ESC_CTRL_OVERRIDE
82
83	/*
84	* Force NKRO
85	*
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.)
89	*
90	* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
91	* until the next keyboard reset.
92	*
93	* NKRO may prevent your keystrokes from being detected in the BIOS, but it is
94	* fully operational during normal computer usage.
95	*
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
99	* power-up.
100	*
101	*/
102	//#define FORCE_NKRO
103
104	/*
105	* Magic Key Options
106	*
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
110	*
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.
113	*
114	*/
115
116	/* key combination for magic key command */
117	#define IS_COMMAND() ( \
118	keyboard_report->mods == (MOD_BIT(KC_LSHIFT) \| MOD_BIT(KC_RSHIFT)) \
119	)
120
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
125
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
156
157	/*
158	* Feature disable options
159	* These options are also useful to firmware size reduction.
160	*/
161
162	/* disable debug print */
163	//#define NO_DEBUG
164
165	/* disable print */
166	//#define NO_PRINT
167
168	/* disable action features */
169	//#define NO_ACTION_LAYER
170	//#define NO_ACTION_TAPPING
171	//#define NO_ACTION_ONESHOT
cce19d26 DJ	172	#define NO_ACTION_MACRO
cce19d26 DJ	173	#define NO_ACTION_FUNCTION
0c4e0a20 M	174
	175	/*
	176	* MIDI options
	177	*/
	178
	179	/* Prevent use of disabled MIDI features in the keymap */
	180	//#define MIDI_ENABLE_STRICT 1
	181
	182	/* enable basic MIDI features:
	183	- MIDI notes can be sent when in Music mode is on
	184	*/
	185	//#define MIDI_BASIC
	186
	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
	191	- etc.
	192	*/
	193	//#define MIDI_ADVANCED
	194
	195	/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
	196	//#define MIDI_TONE_KEYCODE_OCTAVES 1
	197
	198	/*
	199	* HD44780 LCD Display Configuration
	200	*/
	201	/*
	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
	204
	205	#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
	206
	207	#if LCD_IO_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
	223	#endif
	224	*/