[Keyboard] Add support for KBDfans Odin V2 (#18910)

10 files changed, 356 insertions, 0 deletions

diff --git a/keyboards/kbdfans/odin/v2/config.h b/keyboards/kbdfans/odin/v2/config.h
new file mode 100644
index 0000000000..11350c611e
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/config.h
@@ -0,0 +1,51 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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/>.
+ */
+
+#include "config_common.h"
+
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 20
+
+#define MATRIX_ROW_PINS { A10, A9, A8, B14, B13, A2 }
+#define MATRIX_COL_PINS { A3, A4, A5, A6, A7, B0, B1, B2, B12, A15, B3, B4, B5, B6, B7, B8, C13, C14, C15, A0}
+
+#define DIODE_DIRECTION COL2ROW
+
+#define DEBOUNCE 5
+
+#define LED_NUM_LOCK_PIN B9
+#define LED_CAPS_LOCK_PIN B10
+#define LED_PIN_ON_STATE 0
+
+#define RGB_DI_PIN B15
+
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 4
+    #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+    #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+    #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+    #define RGBLIGHT_EFFECT_CHRISTMAS
+    #define RGBLIGHT_EFFECT_SNAKE
+    #define RGBLIGHT_EFFECT_BREATHING
+
+    #define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL
+
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 180
+    #define RGBLIGHT_SLEEP
+#endif
diff --git a/keyboards/kbdfans/odin/v2/info.json b/keyboards/kbdfans/odin/v2/info.json
new file mode 100644
index 0000000000..2a2c71fa2e
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/info.json
@@ -0,0 +1,117 @@
+{
+    "keyboard_name": "Odin V2",
+    "manufacturer": "KBDFans",
+    "url": "",
+    "maintainer": "lexbrugman",
+    "usb": {
+        "vid": "0x4B42",
+        "pid": "0x0101",
+        "device_version": "0.0.1"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                { "label": "Esc", "x": 0, "y": 0 },
+                { "label": "F1", "x": 2, "y": 0 },
+                { "label": "F2", "x": 3, "y": 0 },
+                { "label": "F3", "x": 4, "y": 0 },
+                { "label": "F4", "x": 5, "y": 0 },
+                { "label": "F5", "x": 6.5, "y": 0 },
+                { "label": "F6", "x": 7.5, "y": 0 },
+                { "label": "F7", "x": 8.5, "y": 0 },
+                { "label": "F8", "x": 9.5, "y": 0 },
+                { "label": "F9", "x": 11, "y": 0 },
+                { "label": "F10", "x": 12, "y": 0 },
+                { "label": "F11", "x": 13, "y": 0 },
+                { "label": "F12", "x": 14, "y": 0 },
+                { "label": "Scroll Lock", "x": 15.25, "y": 0 },
+                { "x": 16.5, "y": 0 },
+                { "x": 17.5, "y": 0 },
+                { "x": 18.5, "y": 0 },
+                { "x": 19.5, "y": 0 },
+                { "label": "~", "x": 0, "y": 1.5 },
+                { "label": "!", "x": 1, "y": 1.5 },
+                { "label": "@", "x": 2, "y": 1.5 },
+                { "label": "#", "x": 3, "y": 1.5 },
+                { "label": "$", "x": 4, "y": 1.5 },
+                { "label": "%", "x": 5, "y": 1.5 },
+                { "label": "^", "x": 6, "y": 1.5 },
+                { "label": "&", "x": 7, "y": 1.5 },
+                { "label": "*", "x": 8, "y": 1.5 },
+                { "label": "(", "x": 9, "y": 1.5 },
+                { "label": ")", "x": 10, "y": 1.5 },
+                { "label": "_", "x": 11, "y": 1.5 },
+                { "label": "+", "x": 12, "y": 1.5 },
+                { "label": "Backspace", "w": 2, "x": 13, "y": 1.5 },
+                { "label": "Insert", "x": 15.25, "y": 1.5 },
+                { "label": "Num Lock", "x": 16.5, "y": 1.5 },
+                { "label": "/", "x": 17.5, "y": 1.5 },
+                { "label": "*", "x": 18.5, "y": 1.5 },
+                { "label": "-", "x": 19.5, "y": 1.5 },
+                { "label": "Tab", "w": 1.5, "x": 0, "y": 2.5 },
+                { "label": "Q", "x": 1.5, "y": 2.5 },
+                { "label": "W", "x": 2.5, "y": 2.5 },
+                { "label": "E", "x": 3.5, "y": 2.5 },
+                { "label": "R", "x": 4.5, "y": 2.5 },
+                { "label": "T", "x": 5.5, "y": 2.5 },
+                { "label": "Y", "x": 6.5, "y": 2.5 },
+                { "label": "U", "x": 7.5, "y": 2.5 },
+                { "label": "I", "x": 8.5, "y": 2.5 },
+                { "label": "O", "x": 9.5, "y": 2.5 },
+                { "label": "P", "x": 10.5, "y": 2.5 },
+                { "label": "{", "x": 11.5, "y": 2.5 },
+                { "label": "}", "x": 12.5, "y": 2.5 },
+                { "label": "|", "w": 1.5, "x": 13.5, "y": 2.5 },
+                { "label": "Delete", "x": 15.25, "y": 2.5 },
+                { "label": "7", "x": 16.5, "y": 2.5 },
+                { "label": "8", "x": 17.5, "y": 2.5 },
+                { "label": "9", "x": 18.5, "y": 2.5 },
+                { "h": 2, "label": "+", "x": 19.5, "y": 2.5 },
+                { "label": "Caps Lock", "w": 1.75, "x": 0, "y": 3.5 },
+                { "label": "A", "x": 1.75, "y": 3.5 },
+                { "label": "S", "x": 2.75, "y": 3.5 },
+                { "label": "D", "x": 3.75, "y": 3.5 },
+                { "label": "F", "x": 4.75, "y": 3.5 },
+                { "label": "G", "x": 5.75, "y": 3.5 },
+                { "label": "H", "x": 6.75, "y": 3.5 },
+                { "label": "J", "x": 7.75, "y": 3.5 },
+                { "label": "K", "x": 8.75, "y": 3.5 },
+                { "label": "L", "x": 9.75, "y": 3.5 },
+                { "label": ":", "x": 10.75, "y": 3.5 },
+                { "label": "\"", "x": 11.75, "y": 3.5 },
+                { "label": "Enter", "w": 2.25, "x": 12.75, "y": 3.5 },
+                { "label": "4", "x": 16.5, "y": 3.5 },
+                { "label": "5", "x": 17.5, "y": 3.5 },
+                { "label": "6", "x": 18.5, "y": 3.5 },
+                { "label": "Shift", "w": 2.25, "x": 0, "y": 4.5 },
+                { "label": "Z", "x": 2.25, "y": 4.5 },
+                { "label": "X", "x": 3.25, "y": 4.5 },
+                { "label": "C", "x": 4.25, "y": 4.5 },
+                { "label": "V", "x": 5.25, "y": 4.5 },
+                { "label": "B", "x": 6.25, "y": 4.5 },
+                { "label": "N", "x": 7.25, "y": 4.5 },
+                { "label": "M", "x": 8.25, "y": 4.5 },
+                { "label": "<", "x": 9.25, "y": 4.5 },
+                { "label": ">", "x": 10.25, "y": 4.5 },
+                { "label": "?", "x": 11.25, "y": 4.5 },
+                { "label": "Shift", "w": 2.75, "x": 12.25, "y": 4.5 },
+                { "label": "\u2191", "x": 15.25, "y": 4.75 },
+                { "label": "1", "x": 16.5, "y": 4.5 },
+                { "label": "2", "x": 17.5, "y": 4.5 },
+                { "label": "3", "x": 18.5, "y": 4.5 },
+                { "h": 2, "label": "Enter", "x": 19.5, "y": 4.5 },
+                { "label": "Ctrl", "w": 1.25, "x": 0, "y": 5.5 },
+                { "label": "Win", "w": 1.25, "x": 1.25, "y": 5.5 },
+                { "label": "Alt", "w": 1.25, "x": 2.5, "y": 5.5 },
+                { "w": 7, "x": 3.75, "y": 5.5 },
+                { "label": "Alt", "w": 1.5, "x": 10.75, "y": 5.5 },
+                { "label": "Win", "w": 1.5, "x": 12.25, "y": 5.5 },
+                { "label": "\u2190", "x": 14.25, "y": 5.75 },
+                { "label": "\u2193", "x": 15.25, "y": 5.75 },
+                { "label": "\u2192", "x": 16.25, "y": 5.75 },
+                { "label": "0", "x": 17.5, "y": 5.5 },
+                { "label": ".", "x": 18.5, "y": 5.5 }
+            ]
+        }
+    }
+}
diff --git a/keyboards/kbdfans/odin/v2/keymaps/default/keymap.c b/keyboards/kbdfans/odin/v2/keymaps/default/keymap.c
new file mode 100644
index 0000000000..0ea803cd38
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/keymaps/default/keymap.c
@@ -0,0 +1,37 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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/>.
+ */
+ 
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_SCRL, KC_HOME, KC_END, KC_PGUP, KC_PGDN,
+        KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_P7, KC_P8, KC_P9, KC_PPLS,
+        KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6,
+        KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3, KC_PENT,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT
+    ),
+
+    [1] = LAYOUT(
+        KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_SCRL, KC_HOME, KC_END, KC_PGUP, KC_PGDN,
+        KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_P7, KC_P8, KC_P9, KC_PPLS,
+        KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6,
+        KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3, KC_PENT,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT
+    ),
+};
diff --git a/keyboards/kbdfans/odin/v2/keymaps/via/config.h b/keyboards/kbdfans/odin/v2/keymaps/via/config.h
new file mode 100644
index 0000000000..56a86dc997
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/keymaps/via/config.h
@@ -0,0 +1,18 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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
+#define DYNAMIC_KEYMAP_LAYER_COUNT 2
diff --git a/keyboards/kbdfans/odin/v2/keymaps/via/keymap.c b/keyboards/kbdfans/odin/v2/keymaps/via/keymap.c
new file mode 100644
index 0000000000..ce12d6fedb
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/keymaps/via/keymap.c
@@ -0,0 +1,37 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_SCRL, KC_HOME, KC_END, KC_PGUP, KC_PGDN,
+        KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_P7, KC_P8, KC_P9, KC_PPLS,
+        KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6,
+        KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3, KC_PENT,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT
+    ),
+
+    [1] = LAYOUT(
+        KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_SCRL, KC_HOME, KC_END, KC_PGUP, KC_PGDN,
+        KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_NUM, KC_PSLS, KC_PAST, KC_PMNS,
+        KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_P7, KC_P8, KC_P9, KC_PPLS,
+        KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6,
+        KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3, KC_PENT,
+        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT
+    ),
+};
diff --git a/keyboards/kbdfans/odin/v2/keymaps/via/rules.mk b/keyboards/kbdfans/odin/v2/keymaps/via/rules.mk
new file mode 100644
index 0000000000..1e5b99807c
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/keymaps/via/rules.mk
@@ -0,0 +1 @@
+VIA_ENABLE = yes
diff --git a/keyboards/kbdfans/odin/v2/readme.md b/keyboards/kbdfans/odin/v2/readme.md
new file mode 100644
index 0000000000..52ac9ad699
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/readme.md
@@ -0,0 +1,21 @@
+# ODIN V2
+
+A customizable HOTSWAP keyboard.
+
+* Keyboard Maintainer: [lexbrugman](https://github.com/lexbrugman)
+* Hardware Supported: KBDFANS
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make kbdfans/odin/v2:default
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix
+* **Physical reset button**:press and hold the button on the back of the PCB, then plugin to PC
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/kbdfans/odin/v2/rules.mk b/keyboards/kbdfans/odin/v2/rules.mk
new file mode 100644
index 0000000000..8728fe0a37
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/rules.mk
@@ -0,0 +1,21 @@
+# MCU name
+MCU = STM32F072
+
+# Bootloader selection
+BOOTLOADER = stm32-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = yes           # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+
+# Enter lower-power sleep mode when on the ChibiOS idle thread
+OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE
diff --git a/keyboards/kbdfans/odin/v2/v2.c b/keyboards/kbdfans/odin/v2/v2.c
new file mode 100644
index 0000000000..42cbbc301a
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/v2.c
@@ -0,0 +1,17 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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/>.
+ */
+
+#include "v2.h"
diff --git a/keyboards/kbdfans/odin/v2/v2.h b/keyboards/kbdfans/odin/v2/v2.h
new file mode 100644
index 0000000000..9e183e4498
--- /dev/null
+++ b/keyboards/kbdfans/odin/v2/v2.h
@@ -0,0 +1,36 @@
+/* Copyright 2022 lexbrugman
+ *
+ * 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 "quantum.h"
+
+#define LAYOUT( \
+    k00,      k02, k03, k04, k05,      k07, k08, k09, k0A, k0B, k0C, k0D, k0E, k0F, k0G, k0H, k0I, k0J, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D,      k1F, k1G, k1H, k1I, k1J, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D,      k2F, k2G, k2H, k2I, k2J, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B,      k3D,           k3G, k3H, k3I,      \
+    k40,      k42, k43, k44, k45, k46, k47, k48, k49, k4A, k4B,      k4D,      k4F, k4G, k4H, k4I, k4J, \
+    k50, k51, k52,                k56,                     k5B,      k5D, k5E, k5F, k5G, k5H, k5I       \
+) \
+{ \
+    {k00, KC_NO, k02, k03,   k04,   k05,   KC_NO, k07,   k08,   k09,   k0A,   k0B, k0C,   k0D, k0E,   k0F,   k0G, k0H, k0I, k0J  }, \
+    {k10, k11,   k12, k13,   k14,   k15,   k16,   k17,   k18,   k19,   k1A,   k1B, k1C,   k1D, KC_NO, k1F,   k1G, k1H, k1I, k1J  }, \
+    {k20, k21,   k22, k23,   k24,   k25,   k26,   k27,   k28,   k29,   k2A,   k2B, k2C,   k2D, KC_NO, k2F,   k2G, k2H, k2I, k2J  }, \
+    {k30, k31,   k32, k33,   k34,   k35,   k36,   k37,   k38,   k39,   k3A,   k3B, KC_NO, k3D, KC_NO, KC_NO, k3G, k3H, k3I, KC_NO}, \
+    {k40, KC_NO, k42, k43,   k44,   k45,   k46,   k47,   k48,   k49,   k4A,   k4B, KC_NO, k4D, KC_NO, k4F,   k4G, k4H, k4I, k4J  }, \
+    {k50, k51,   k52, KC_NO, KC_NO, KC_NO, k56,   KC_NO, KC_NO, KC_NO, KC_NO, k5B, KC_NO, k5D, k5E,   k5F,   k5G, k5H, k5I, KC_NO}  \
+}