aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwanleg <32079073+wanleg@users.noreply.github.com>2018-08-19 13:18:19 -0700
committerDrashna Jaelre <drashna@live.com>2018-08-19 13:18:19 -0700
commitd87ef88de0303309a317283a292c52e7e89d6449 (patch)
treeb8e05f6ef53236e2d791010f57affd8d2ec068da
parent8bc771a84247b59ab924cc241f455beec6384362 (diff)
downloadqmk_firmware-d87ef88de0303309a317283a292c52e7e89d6449.tar.gz
qmk_firmware-d87ef88de0303309a317283a292c52e7e89d6449.zip
Keyboard: add 5x5 board support (#3694)
* 5x5 board support * 5x5 work * 5x5board config * add 5x5 board support
-rw-r--r--keyboards/5x5/5x5.c29
-rw-r--r--keyboards/5x5/5x5.h57
-rw-r--r--keyboards/5x5/config.h208
-rw-r--r--keyboards/5x5/info.json0
-rw-r--r--keyboards/5x5/keymaps/default/config.h5
-rw-r--r--keyboards/5x5/keymaps/default/keymap.c139
-rw-r--r--keyboards/5x5/readme.md23
-rw-r--r--keyboards/5x5/rules.mk74
8 files changed, 535 insertions, 0 deletions
diff --git a/keyboards/5x5/5x5.c b/keyboards/5x5/5x5.c
new file mode 100644
index 000000000..20e524609
--- /dev/null
+++ b/keyboards/5x5/5x5.c
@@ -0,0 +1,29 @@
1
2#include "5x5.h"
3
4void matrix_init_kb(void) {
5 // put your keyboard start-up code here
6 // runs once when the firmware starts up
7
8 matrix_init_user();
9}
10
11void matrix_scan_kb(void) {
12 // put your looping keyboard code here
13 // runs every cycle (a lot)
14
15 matrix_scan_user();
16}
17
18bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
19 // put your per-action keyboard code here
20 // runs for every action, just before processing by the firmware
21
22 return process_record_user(keycode, record);
23}
24
25void led_set_kb(uint8_t usb_led) {
26 // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
27
28 led_set_user(usb_led);
29}
diff --git a/keyboards/5x5/5x5.h b/keyboards/5x5/5x5.h
new file mode 100644
index 000000000..cbfc28a90
--- /dev/null
+++ b/keyboards/5x5/5x5.h
@@ -0,0 +1,57 @@
1
2#ifndef FIVEX5_H
3#define FIVEX5_H
4
5#include "quantum.h"
6#define ___ KC_NO
7
8// This a shortcut to help you visually see your layout.
9// The first section contains all of the arguments
10// The second converts the arguments into a two-dimensional array
11
12#define LAYOUT_ortho_5x5( \
13 K00, K01, K02, K03, K04, \
14 K10, K11, K12, K13, K14, \
15 K20, K21, K22, K23, K24, \
16 K30, K31, K32, K33, K34, \
17 K40, K41, K42, K43, K44 \
18) \
19{ \
20 { K00, K01, K02, K03, K04, ___, ___, ___, ___, ___, ___, ___, ___, ___, ___}, \
21 { K10, K11, K12, K13, K14, ___, ___, ___, ___, ___, ___, ___, ___, ___, ___}, \
22 { K20, K21, K22, K23, K24, ___, ___, ___, ___, ___, ___, ___, ___, ___, ___}, \
23 { K30, K31, K32, K33, K34, ___, ___, ___, ___, ___, ___, ___, ___, ___, ___}, \
24 { K40, K41, K42, K43, K44, ___, ___, ___, ___, ___, ___, ___, ___, ___, ___} \
25}
26
27#define LAYOUT_ortho_5x10( \
28 K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, \
29 K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, \
30 K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, \
31 K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, \
32 K40, K41, K42, K43, K44, K45, K46, K47, K48, K49 \
33) \
34{ \
35 { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, ___, ___, ___, ___, ___}, \
36 { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, ___, ___, ___, ___, ___}, \
37 { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, ___, ___, ___, ___, ___}, \
38 { K30, K31, K32, K33, K34, K35, K35, K37, K38, K39, ___, ___, ___, ___, ___}, \
39 { K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, ___, ___, ___, ___, ___} \
40}
41
42#define LAYOUT_ortho_5x15( \
43 K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0a, K0b, K0c, K0d, K0e, \
44 K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1a, K1b, K1c, K1d, K1e, \
45 K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2a, K2b, K2c, K2d, K2e, \
46 K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3a, K3b, K3c, K3d, K3e, \
47 K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, K4a, K4b, K4c, K4d, K4e \
48) \
49{ \
50 { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0a, K0b, K0c, K0d, K0e}, \
51 { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1a, K1b, K1c, K1d, K1e}, \
52 { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2a, K2b, K2c, K2d, K2e}, \
53 { K30, K31, K32, K33, K34, K35, K35, K37, K38, K39, K3a, K3b, K3c, K3d, K3e}, \
54 { K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, K4a, K4b, K4c, K4d, K4e} \
55}
56
57#endif
diff --git a/keyboards/5x5/config.h b/keyboards/5x5/config.h
new file mode 100644
index 000000000..bc609934e
--- /dev/null
+++ b/keyboards/5x5/config.h
@@ -0,0 +1,208 @@
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*/
diff --git a/keyboards/5x5/info.json b/keyboards/5x5/info.json
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/keyboards/5x5/info.json
diff --git a/keyboards/5x5/keymaps/default/config.h b/keyboards/5x5/keymaps/default/config.h
new file mode 100644
index 000000000..d533d806c
--- /dev/null
+++ b/keyboards/5x5/keymaps/default/config.h
@@ -0,0 +1,5 @@
1
2
3#pragma once
4
5// place overrides here
diff --git a/keyboards/5x5/keymaps/default/keymap.c b/keyboards/5x5/keymaps/default/keymap.c
new file mode 100644
index 000000000..a2c525d08
--- /dev/null
+++ b/keyboards/5x5/keymaps/default/keymap.c
@@ -0,0 +1,139 @@
1
2#include QMK_KEYBOARD_H
3
4#define PAD 0
5#define _QW 1
6#define NUM 2
7#define DIR 3
8
9// Readability keycodes
10#define _______ KC_TRNS
11
12const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
13
14/* Single 5x5 board only
15 * .--------------------------------------------.
16 * | QWERTY | / | * | - | |
17 * |--------+--------+--------+--------+--------|
18 * | 7 | 8 | 9 | + | |
19 * |--------+--------+--------+--------+--------|
20 * | 4 | 5 | 6 | + | |
21 * |--------+--------+--------+--------+--------|
22 * | 1 | 2 | 3 | ENTER | |
23 * |--------+--------+--------+--------+--------|
24 * | 0 | 0 | . | ENTER | |
25 * '--------------------------------------------'
26 */
27
28 [PAD] = LAYOUT_ortho_5x5(
29 DF(_QW), KC_PSLS, KC_PAST, KC_PMNS, _______,
30 KC_KP_7, KC_KP_8, KC_KP_9, KC_PPLS, _______,
31 KC_KP_4, KC_KP_5, KC_KP_6, KC_PPLS, _______,
32 KC_KP_1, KC_KP_2, KC_KP_3, KC_PENT, _______,
33 KC_KP_0, KC_KP_0, KC_KP_DOT, KC_PENT, _______
34 ),
35
36/* QWERTY
37 * .--------------------------------------------------------------------------------------------------------------------------------------.
38 * | | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | | | | |
39 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
40 * | ESC | Q | W | E | R | T | Y | U | I | O | P | BACKSP | 7 | 8 | 9 |
41 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
42 * | TAB | A | S | D | F | G | H | J | K | L | ; | ' | 4 | 5 | 6 |
43 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
44 * | SHIFT | Z | X | C | V | B | N | M | , | . | / | ENT/SFT| 1 | 2 | 3 |
45 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
46 * | LCTRL | LGUI | ALT | ALT | NUM | SHIFT | SPACE | DIR | RGUI | RALT | DEL | CTRL | 0 | 0 | . |
47 * '--------------------------------------------------------------------------------------------------------------------------------------'
48 */
49
50 [_QW] = LAYOUT_ortho_5x15(
51 _______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______, _______, _______, _______,
52 KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_KP_7, KC_KP_8, KC_KP_9,
53 KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_KP_4, KC_KP_5, KC_KP_6,
54 KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, SFT_T(KC_ENT), KC_KP_1, KC_KP_2, KC_KP_3,
55 KC_LCTL, KC_LGUI, KC_LALT, KC_LALT, MO(NUM), KC_LSFT, KC_SPC, MO(DIR), KC_RGUI, KC_RALT, KC_DEL, KC_RCTL, KC_KP_0, KC_KP_0, KC_KP_DOT
56 ),
57
58/* NUMBERS
59 * .--------------------------------------------------------------------------------------------------------------------------------------.
60 * | | | | | | | | | | | | | | | |
61 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
62 * | | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | NUMLOCK| / | * | - |
63 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
64 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | | | | + |
65 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
66 * | | F11 | F12 | | | | ENTER | SHIFT | RGUI | ./ALT | BKSC | | | | ENTER |
67 * | | | | | | | | | | |CTRLhold| | | | |
68 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
69 * | | | | | | | ENTER | SHIFT | | | | | | | |
70 * '--------------------------------------------------------------------------------------------------------------------------------------'
71 */
72
73 [NUM] = LAYOUT_ortho_5x15(
74 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
75 _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
76 KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______, _______, _______, KC_PPLS,
77 _______, KC_F11, KC_F12, KC_TRNS, KC_TRNS, KC_TRNS, KC_ENT, KC_RSFT, KC_RGUI, ALT_T(KC_DOT), CTL_T(KC_BSPC), _______, _______, _______, KC_PENT,
78 _______, _______, _______, _______, _______, _______, KC_ENT, KC_RSFT, _______, _______, _______, _______, _______, _______, _______
79 ),
80
81/* DIRECTIONS
82 * .--------------------------------------------------------------------------------------------------------------------------------------.
83 * | | | | | | | | | | | | | | | |
84 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
85 * | RESET | TAB | up | | INS | CTRL | SHIFT | PgUp | Home | - | = | DEL | | | |
86 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
87 * | CAPSLK | left | down | right | PrScr | SHIFT | CTRL | PgDn | End | [ | ] | \ | | | |
88 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
89 * | | P-Brk | | | | | | | RGUI | ALT | | | | | |
90 * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------|
91 * | KEYPAD | | | | | | | | | | | | | | |
92 * '--------------------------------------------------------------------------------------------------------------------------------------'
93 */
94
95 [DIR] = LAYOUT_ortho_5x15(
96 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
97 RESET, KC_TAB, KC_UP, _______, KC_INS, KC_LCTL, KC_LSFT, KC_PGUP, KC_HOME, KC_MINS, KC_EQL, KC_DEL, _______, _______, _______,
98 KC_CAPS, KC_LEFT, KC_DOWN, KC_RGHT, KC_PSCR, KC_LSFT, KC_LCTL, KC_PGDN, KC_END, KC_LBRC, KC_RBRC, KC_BSLS, _______, _______, _______,
99 _______, KC_PAUS, _______, _______, _______, _______, _______, _______, KC_RGUI, KC_RALT, _______, _______, _______, _______, _______,
100 DF(PAD), _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
101 ),
102
103};
104
105const uint16_t PROGMEM fn_actions[] = {
106
107};
108
109const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
110{
111 // MACRODOWN only works in this function
112 switch(id) {
113 case 0:
114 if (record->event.pressed) {
115 register_code(KC_RSFT);
116 } else {
117 unregister_code(KC_RSFT);
118 }
119 break;
120 }
121 return MACRO_NONE;
122};
123
124
125void matrix_init_user(void) {
126
127}
128
129void matrix_scan_user(void) {
130
131}
132
133bool process_record_user(uint16_t keycode, keyrecord_t *record) {
134 return true;
135}
136
137void led_set_user(uint8_t usb_led) {
138
139}
diff --git a/keyboards/5x5/readme.md b/keyboards/5x5/readme.md
new file mode 100644
index 000000000..e25535968
--- /dev/null
+++ b/keyboards/5x5/readme.md
@@ -0,0 +1,23 @@
1# 5x5
2
3![5x5](https://3.bp.blogspot.com/-bKOfUyMtdrE/WqGA_03kGZI/AAAAAAACPtY/DsHDTQS0IlMD3ie8HHlf1ATRUAwpZdcSgCLcBGAs/s1600/c.jpg)
4===
5
6**Modular Keypad/Keyboard**
7The basic unit is a 5x5 matrix with 25 keys. Up to 3 of these can be connected to each other side by side.
85x5, 5x10, and 5x15 matrices are possible.
9There are pads for header pins on each side that complete the circuits from board to board. These can be permanently connected with solder bridges or temporarily with pin headers and shunt jumpers.
10**_All configurations are powered by a SINGLE Arduino Micro or clone (NOT a Pro Micro)._**
11
12* [The original TMK firmware](https://github.com/di0ib/tmk_keyboard/tree/master/keyboard/5x5)
13
14Keyboard Maintainer: QMK Community
15Hardware Supported: 5x5 PCB
16Hardware Availability: [5x5 project on 40% Keyboards](http://www.40percent.club/2018/04/5x5.html)
17
18Make example for this keyboard (after setting up your build environment):
19
20 make 5x5:default
21
22See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
23First pass at adding support for the 4x4 keyboard. Compiles but completely untested. Intended to kick-start development.
diff --git a/keyboards/5x5/rules.mk b/keyboards/5x5/rules.mk
new file mode 100644
index 000000000..b04e4a527
--- /dev/null
+++ b/keyboards/5x5/rules.mk
@@ -0,0 +1,74 @@
1# MCU name
2#MCU = at90usb1286
3MCU = atmega32u4
4
5# Processor frequency.
6# This will define a symbol, F_CPU, in all source code files equal to the
7# processor frequency in Hz. You can then use this symbol in your source code to
8# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
9# automatically to create a 32-bit value in your source code.
10#
11# This will be an integer division of F_USB below, as it is sourced by
12# F_USB after it has run through any CPU prescalers. Note that this value
13# does not *change* the processor frequency - it should merely be updated to
14# reflect the processor speed set externally so that the code can use accurate
15# software delays.
16F_CPU = 16000000
17
18#
19# LUFA specific
20#
21# Target architecture (see library "Board Types" documentation).
22ARCH = AVR8
23
24# Input clock frequency.
25# This will define a symbol, F_USB, in all source code files equal to the
26# input clock frequency (before any prescaling is performed) in Hz. This value may
27# differ from F_CPU if prescaling is used on the latter, and is required as the
28# raw input clock is fed directly to the PLL sections of the AVR for high speed
29# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
30# at the end, this will be done automatically to create a 32-bit value in your
31# source code.
32#
33# If no clock division is performed on the input clock inside the AVR (via the
34# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
35F_USB = $(F_CPU)
36
37# Interrupt driven control endpoint task(+60)
38OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
39
40# Boot Section Size in *bytes*
41# Teensy halfKay 512
42# Teensy++ halfKay 1024
43# Atmel DFU loader 4096
44# LUFA bootloader 4096
45# USBaspLoader 2048
46OPT_DEFS += -DBOOTLOADER_SIZE=4096
47
48# Bootloader
49# This definition is optional, and if your keyboard supports multiple bootloaders of
50# different sizes, comment this out, and the correct address will be loaded
51# automatically (+60). See bootloader.mk for all options.
52BOOTLOADER = caterina
53
54# Build Options
55# change yes to no to disable
56#
57BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
58MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
59EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
60CONSOLE_ENABLE = yes # Console for debug(+400)
61COMMAND_ENABLE = yes # Commands for debug and configuration
62# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
63SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
64# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
65NKRO_ENABLE = no # USB Nkey Rollover
66BACKLIGHT_ENABLE = no # Enable keyboard RGB underglow
67MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
68UNICODE_ENABLE = no # Unicode
69BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
70AUDIO_ENABLE = no # Audio output on port C6
71FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
72HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400)
73
74LAYOUT = ortho_5x5 ortho_5x10 ortho_5x15