]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/5x5/config.h
Keyboard: add 5x5 board support (#3694)
[qmk_firmware.git] / keyboards / 5x5 / config.h
1
2
3 #pragma once
4
5 #include "config_common.h"
6
7 /* USB Device descriptor parameter */
8 #define VENDOR_ID       0xFEED
9 #define PRODUCT_ID      0x0A0C
10 #define DEVICE_VER      0x05B5
11 #define MANUFACTURER    di0ib
12 #define PRODUCT         The 5x5 Keyboard
13 #define DESCRIPTION     A 25 or 50 or 75 key keyboard
14
15 /* key matrix size */
16 #define MATRIX_ROWS 5
17 #define MATRIX_COLS 15
18
19 /*
20  * Keyboard Matrix Assignments
21  *
22  * Change this to how you wired your keyboard
23  * COLS: AVR pins used for columns, left to right
24  * ROWS: AVR pins used for rows, top to bottom
25  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
26  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
27  *
28 */
29 #define MATRIX_ROW_PINS { B2, D1, D0, D4, C6 }
30 #define MATRIX_COL_PINS { D7, E6, B4, B5, B6, B7, D6, F7, F6, F5, F4, F1, F0, B3, B1 }
31 #define UNUSED_PINS
32
33 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
34 #define DIODE_DIRECTION COL2ROW
35
36 // #define BACKLIGHT_PIN B7
37 // #define BACKLIGHT_BREATHING
38 // #define BACKLIGHT_LEVELS 3
39
40 // #define RGB_DI_PIN E2
41 // #ifdef RGB_DI_PIN
42 // #define RGBLIGHT_ANIMATIONS
43 // #define RGBLED_NUM 16
44 // #define RGBLIGHT_HUE_STEP 8
45 // #define RGBLIGHT_SAT_STEP 8
46 // #define RGBLIGHT_VAL_STEP 8
47 // #endif
48
49 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
50 #define DEBOUNCING_DELAY 5
51
52 /* define if matrix has ghost (lacks anti-ghosting diodes) */
53 //#define MATRIX_HAS_GHOST
54
55 /* number of backlight levels */
56
57 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
58 #define LOCKING_SUPPORT_ENABLE
59 /* Locking resynchronize hack */
60 #define LOCKING_RESYNC_ENABLE
61
62 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
63  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
64  */
65 // #define GRAVE_ESC_CTRL_OVERRIDE
66
67 /*
68  * Force NKRO
69  *
70  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
71  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
72  * makefile for this to work.)
73  *
74  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
75  * until the next keyboard reset.
76  *
77  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
78  * fully operational during normal computer usage.
79  *
80  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
81  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
82  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
83  * power-up.
84  *
85  */
86 //#define FORCE_NKRO
87
88 /*
89  * Magic Key Options
90  *
91  * Magic keys are hotkey commands that allow control over firmware functions of
92  * the keyboard. They are best used in combination with the HID Listen program,
93  * found here: https://www.pjrc.com/teensy/hid_listen.html
94  *
95  * The options below allow the magic key functionality to be changed. This is
96  * useful if your keyboard/keypad is missing keys and you want magic key support.
97  *
98  */
99
100 /* key combination for magic key command */
101 #define IS_COMMAND() ( \
102     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
103 )
104
105 /* control how magic key switches layers */
106 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
107 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
108 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
109
110 /* override magic key keymap */
111 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
112 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
113 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
114 //#define MAGIC_KEY_HELP1          H
115 //#define MAGIC_KEY_HELP2          SLASH
116 //#define MAGIC_KEY_DEBUG          D
117 //#define MAGIC_KEY_DEBUG_MATRIX   X
118 //#define MAGIC_KEY_DEBUG_KBD      K
119 //#define MAGIC_KEY_DEBUG_MOUSE    M
120 //#define MAGIC_KEY_VERSION        V
121 //#define MAGIC_KEY_STATUS         S
122 //#define MAGIC_KEY_CONSOLE        C
123 //#define MAGIC_KEY_LAYER0_ALT1    ESC
124 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
125 //#define MAGIC_KEY_LAYER0         0
126 //#define MAGIC_KEY_LAYER1         1
127 //#define MAGIC_KEY_LAYER2         2
128 //#define MAGIC_KEY_LAYER3         3
129 //#define MAGIC_KEY_LAYER4         4
130 //#define MAGIC_KEY_LAYER5         5
131 //#define MAGIC_KEY_LAYER6         6
132 //#define MAGIC_KEY_LAYER7         7
133 //#define MAGIC_KEY_LAYER8         8
134 //#define MAGIC_KEY_LAYER9         9
135 //#define MAGIC_KEY_BOOTLOADER     PAUSE
136 //#define MAGIC_KEY_LOCK           CAPS
137 //#define MAGIC_KEY_EEPROM         E
138 //#define MAGIC_KEY_NKRO           N
139 //#define MAGIC_KEY_SLEEP_LED      Z
140
141 /*
142  * Feature disable options
143  *  These options are also useful to firmware size reduction.
144  */
145
146 /* disable debug print */
147 //#define NO_DEBUG
148
149 /* disable print */
150 //#define NO_PRINT
151
152 /* disable action features */
153 //#define NO_ACTION_LAYER
154 //#define NO_ACTION_TAPPING
155 //#define NO_ACTION_ONESHOT
156 //#define NO_ACTION_MACRO
157 //#define NO_ACTION_FUNCTION
158
159 /*
160  * MIDI options
161  */
162
163 /* Prevent use of disabled MIDI features in the keymap */
164 //#define MIDI_ENABLE_STRICT 1
165
166 /* enable basic MIDI features:
167    - MIDI notes can be sent when in Music mode is on
168 */
169 //#define MIDI_BASIC
170
171 /* enable advanced MIDI features:
172    - MIDI notes can be added to the keymap
173    - Octave shift and transpose
174    - Virtual sustain, portamento, and modulation wheel
175    - etc.
176 */
177 //#define MIDI_ADVANCED
178
179 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
180 //#define MIDI_TONE_KEYCODE_OCTAVES 1
181
182 /*
183  * HD44780 LCD Display Configuration
184  */
185 /*
186 #define LCD_LINES           2     //< number of visible lines of the display
187 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
188
189 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
190
191 #if LCD_IO_MODE
192 #define LCD_PORT         PORTB        //< port for the LCD lines
193 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
194 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
195 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
196 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
197 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
198 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
199 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
200 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
201 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
202 #define LCD_RS_PIN       3            //< pin  for RS line
203 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
204 #define LCD_RW_PIN       2            //< pin  for RW line
205 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
206 #define LCD_E_PIN        1            //< pin  for Enable line
207 #endif
208 */