[Keyboard] move @vuhopkep 's keebs into /hnahkb (#16102)

8 files changed, 584 insertions, 0 deletions

diff --git a/keyboards/hnahkb/vn66/config.h b/keyboards/hnahkb/vn66/config.h
new file mode 100644
index 0000000000..d809541841
--- /dev/null
+++ b/keyboards/hnahkb/vn66/config.h
@@ -0,0 +1,148 @@
+/*
+Copyright 2019 HnahKB
+
+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   0xCA2C
+#define DEVICE_VER   0x0001
+#define MANUFACTURER HnahKB
+#define PRODUCT      VN66
+
+/* 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 { B1, B2, B3, D2, F7 }
+#define MATRIX_COL_PINS { F6, F5, F4, F1, F0, C6, C7, B5, B4, D7, D6, D4, D5, D3 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define LED_CAPS_LOCK_PIN E6
+#define LED_PIN_ON_STATE 0
+
+#define BACKLIGHT_PIN B6
+#define BACKLIGHT_LEVELS 4
+#define BACKLIGHT_BREATHING
+
+#define ENCODERS_PAD_A { B0 }
+#define ENCODERS_PAD_B { B7 }
+#define ENCODER_RESOLUTION 2
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+#    define RGBLED_NUM 20
+#    define RGBLIGHT_HUE_STEP 8
+#    define RGBLIGHT_SAT_STEP 8
+#    define RGBLIGHT_VAL_STEP 8
+//#    define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+#    define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== all animations enable ==*/
+#    define RGBLIGHT_ANIMATIONS
+/*== or choose animations ==*/
+//#    define RGBLIGHT_EFFECT_BREATHING
+//#    define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//#    define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//#    define RGBLIGHT_EFFECT_SNAKE
+//#    define RGBLIGHT_EFFECT_KNIGHT
+//#    define RGBLIGHT_EFFECT_CHRISTMAS
+//#    define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//#    define RGBLIGHT_EFFECT_RGB_TEST
+//#    define RGBLIGHT_EFFECT_ALTERNATING
+/*== customize breathing effect ==*/
+/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//#    define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+/*==== use exp() and sin() ====*/
+//#    define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//#    define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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 useful 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
+
+/*
+ * 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
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+//#define BOOTMAGIC_LITE_ROW 0
+//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/hnahkb/vn66/info.json b/keyboards/hnahkb/vn66/info.json
new file mode 100644
index 0000000000..a1063ce993
--- /dev/null
+++ b/keyboards/hnahkb/vn66/info.json
@@ -0,0 +1,246 @@
+{
+    "keyboard_name": "vn66",
+    "url": "fb.com/groups/VietNamMechKey/",
+    "maintainer": "qmk",
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [
+                {"x": 0, "y": 0},
+                {"x": 1, "y": 0},
+                {"x": 2, "y": 0},
+                {"x": 3, "y": 0},
+                {"x": 4, "y": 0},
+                {"x": 5, "y": 0},
+                {"x": 6, "y": 0},
+                {"x": 7, "y": 0},
+                {"x": 8, "y": 0},
+                {"x": 9, "y": 0},
+                {"x": 10, "y": 0},
+                {"x": 11, "y": 0},
+                {"x": 12, "y": 0},
+                {"x": 13, "y": 0},
+                {"x": 14, "y": 0},
+
+                {"x": 15.25, "y": 0},
+
+                {"x": 0, "y": 1, "w": 1.5},
+                {"x": 1.5, "y": 1},
+                {"x": 2.5, "y": 1},
+                {"x": 3.5, "y": 1},
+                {"x": 4.5, "y": 1},
+                {"x": 5.5, "y": 1},
+                {"x": 6.5, "y": 1},
+                {"x": 7.5, "y": 1},
+                {"x": 8.5, "y": 1},
+                {"x": 9.5, "y": 1},
+                {"x": 10.5, "y": 1},
+                {"x": 11.5, "y": 1},
+                {"x": 12.5, "y": 1},
+                {"x": 13.5, "y": 1, "w": 1.5},
+
+                {"x": 15.25, "y": 1},
+
+                {"x": 0, "y": 2, "w": 1.75},
+                {"x": 1.75, "y": 2},
+                {"x": 2.75, "y": 2},
+                {"x": 3.75, "y": 2},
+                {"x": 4.75, "y": 2},
+                {"x": 5.75, "y": 2},
+                {"x": 6.75, "y": 2},
+                {"x": 7.75, "y": 2},
+                {"x": 8.75, "y": 2},
+                {"x": 9.75, "y": 2},
+                {"x": 10.75, "y": 2},
+                {"x": 11.75, "y": 2},
+                {"x": 12.75, "y": 2},
+                {"x": 13.75, "y": 2, "w": 1.25},
+
+                {"x": 0, "y": 3, "w": 1.25},
+                {"x": 1.25, "y": 3},
+                {"x": 2.25, "y": 3},
+                {"x": 3.25, "y": 3},
+                {"x": 4.25, "y": 3},
+                {"x": 5.25, "y": 3},
+                {"x": 6.25, "y": 3},
+                {"x": 7.25, "y": 3},
+                {"x": 8.25, "y": 3},
+                {"x": 9.25, "y": 3},
+                {"x": 10.25, "y": 3},
+                {"x": 11.25, "y": 3},
+                {"x": 12.25, "y": 3, "w": 1.75},
+
+                {"x": 14.25, "y": 3.25},
+
+                {"x": 0, "y": 4, "w": 1.25},
+                {"x": 1.25, "y": 4},
+                {"x": 2.25, "y": 4, "w": 1.25},
+                {"x": 3.5, "y": 4, "w": 6},
+                {"x": 9.5, "y": 4, "w": 1.25},
+                {"x": 10.75, "y": 4},
+                {"x": 11.75, "y": 4, "w": 1.25},
+
+                {"x": 13.25, "y": 4.25},
+                {"x": 14.25, "y": 4.25},
+                {"x": 15.25, "y": 4.25}
+            ]
+        },
+        "LAYOUT_66_ansi": {
+            "layout": [
+                {"x": 0, "y": 0},
+                {"x": 1, "y": 0},
+                {"x": 2, "y": 0},
+                {"x": 3, "y": 0},
+                {"x": 4, "y": 0},
+                {"x": 5, "y": 0},
+                {"x": 6, "y": 0},
+                {"x": 7, "y": 0},
+                {"x": 8, "y": 0},
+                {"x": 9, "y": 0},
+                {"x": 10, "y": 0},
+                {"x": 11, "y": 0},
+                {"x": 12, "y": 0},
+                {"x": 13, "y": 0, "w": 2},
+
+                {"x": 15.25, "y": 0},
+
+                {"x": 0, "y": 1, "w": 1.5},
+                {"x": 1.5, "y": 1},
+                {"x": 2.5, "y": 1},
+                {"x": 3.5, "y": 1},
+                {"x": 4.5, "y": 1},
+                {"x": 5.5, "y": 1},
+                {"x": 6.5, "y": 1},
+                {"x": 7.5, "y": 1},
+                {"x": 8.5, "y": 1},
+                {"x": 9.5, "y": 1},
+                {"x": 10.5, "y": 1},
+                {"x": 11.5, "y": 1},
+                {"x": 12.5, "y": 1},
+                {"x": 13.5, "y": 1, "w": 1.5},
+
+                {"x": 15.25, "y": 1},
+
+                {"x": 0, "y": 2, "w": 1.75},
+                {"x": 1.75, "y": 2},
+                {"x": 2.75, "y": 2},
+                {"x": 3.75, "y": 2},
+                {"x": 4.75, "y": 2},
+                {"x": 5.75, "y": 2},
+                {"x": 6.75, "y": 2},
+                {"x": 7.75, "y": 2},
+                {"x": 8.75, "y": 2},
+                {"x": 9.75, "y": 2},
+                {"x": 10.75, "y": 2},
+                {"x": 11.75, "y": 2},
+                {"x": 12.75, "y": 2, "w": 2.25},
+
+                {"x": 0, "y": 3, "w": 2.25},
+                {"x": 2.25, "y": 3},
+                {"x": 3.25, "y": 3},
+                {"x": 4.25, "y": 3},
+                {"x": 5.25, "y": 3},
+                {"x": 6.25, "y": 3},
+                {"x": 7.25, "y": 3},
+                {"x": 8.25, "y": 3},
+                {"x": 9.25, "y": 3},
+                {"x": 10.25, "y": 3},
+                {"x": 11.25, "y": 3},
+                {"x": 12.25, "y": 3, "w": 1.75},
+
+                {"x": 14.25, "y": 3.25},
+
+                {"x": 0, "y": 4, "w": 1.25},
+                {"x": 1.25, "y": 4},
+                {"x": 2.25, "y": 4, "w": 1.25},
+                {"x": 3.5, "y": 4, "w": 6},
+                {"x": 9.5, "y": 4, "w": 1.25},
+                {"x": 10.75, "y": 4},
+                {"x": 11.75, "y": 4, "w": 1.25},
+
+                {"x": 13.25, "y": 4.25},
+                {"x": 14.25, "y": 4.25},
+                {"x": 15.25, "y": 4.25}
+            ]
+        },
+        "LAYOUT_66_iso": {
+            "layout": [
+                {"x": 0, "y": 0},
+                {"x": 1, "y": 0},
+                {"x": 2, "y": 0},
+                {"x": 3, "y": 0},
+                {"x": 4, "y": 0},
+                {"x": 5, "y": 0},
+                {"x": 6, "y": 0},
+                {"x": 7, "y": 0},
+                {"x": 8, "y": 0},
+                {"x": 9, "y": 0},
+                {"x": 10, "y": 0},
+                {"x": 11, "y": 0},
+                {"x": 12, "y": 0},
+                {"x": 13, "y": 0, "w": 2},
+
+                {"x": 15.25, "y": 0},
+
+                {"x": 0, "y": 1, "w": 1.5},
+                {"x": 1.5, "y": 1},
+                {"x": 2.5, "y": 1},
+                {"x": 3.5, "y": 1},
+                {"x": 4.5, "y": 1},
+                {"x": 5.5, "y": 1},
+                {"x": 6.5, "y": 1},
+                {"x": 7.5, "y": 1},
+                {"x": 8.5, "y": 1},
+                {"x": 9.5, "y": 1},
+                {"x": 10.5, "y": 1},
+                {"x": 11.5, "y": 1},
+                {"x": 12.5, "y": 1},
+
+                {"x": 15.25, "y": 1},
+
+                {"x": 0, "y": 2, "w": 1.75},
+                {"x": 1.75, "y": 2},
+                {"x": 2.75, "y": 2},
+                {"x": 3.75, "y": 2},
+                {"x": 4.75, "y": 2},
+                {"x": 5.75, "y": 2},
+                {"x": 6.75, "y": 2},
+                {"x": 7.75, "y": 2},
+                {"x": 8.75, "y": 2},
+                {"x": 9.75, "y": 2},
+                {"x": 10.75, "y": 2},
+                {"x": 11.75, "y": 2},
+                {"x": 12.75, "y": 2},
+
+                {"x": 13.75, "y": 1, "w": 1.25, "h": 2},
+
+                {"x": 0, "y": 3, "w": 1.25},
+                {"x": 1.25, "y": 3},
+                {"x": 2.25, "y": 3},
+                {"x": 3.25, "y": 3},
+                {"x": 4.25, "y": 3},
+                {"x": 5.25, "y": 3},
+                {"x": 6.25, "y": 3},
+                {"x": 7.25, "y": 3},
+                {"x": 8.25, "y": 3},
+                {"x": 9.25, "y": 3},
+                {"x": 10.25, "y": 3},
+                {"x": 11.25, "y": 3},
+                {"x": 12.25, "y": 3, "w": 1.75},
+
+                {"x": 14.25, "y": 3.25},
+
+                {"x": 0, "y": 4, "w": 1.25},
+                {"x": 1.25, "y": 4},
+                {"x": 2.25, "y": 4, "w": 1.25},
+                {"x": 3.5, "y": 4, "w": 6},
+                {"x": 9.5, "y": 4, "w": 1.25},
+                {"x": 10.75, "y": 4},
+                {"x": 11.75, "y": 4, "w": 1.25},
+
+                {"x": 13.25, "y": 4.25},
+                {"x": 14.25, "y": 4.25},
+                {"x": 15.25, "y": 4.25}
+            ]
+        }
+    }
+}
diff --git a/keyboards/hnahkb/vn66/keymaps/default/keymap.c b/keyboards/hnahkb/vn66/keymaps/default/keymap.c
new file mode 100644
index 0000000000..6b5bb083d3
--- /dev/null
+++ b/keyboards/hnahkb/vn66/keymaps/default/keymap.c
@@ -0,0 +1,58 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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
+
+enum layer_names {
+    _QWERTY,
+    _LOWER
+};
+
+#define LOWER MO(_LOWER)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_QWERTY] = LAYOUT_all( /* Base */
+        KC_GESC, 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_DEL, KC_INS,
+        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_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_NUHS, KC_ENT,
+        KC_LSFT, KC_NUBS, 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_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, LOWER,   KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [_LOWER] = LAYOUT_all( /* Base */
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, BL_STEP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, RGB_TOG, RGB_MOD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______, _______, _______
+  )
+};
+
+bool encoder_update_user(uint8_t index, bool clockwise) {
+    if (clockwise == 0) {
+#ifdef MOUSEKEY_ENABLE
+        tap_code(KC_MS_WH_DOWN);
+#else
+        tap_code(KC_VOLD);
+#endif
+    } else {
+#ifdef MOUSEKEY_ENABLE
+        tap_code(KC_MS_WH_UP);
+#else
+        tap_code(KC_VOLU);
+#endif
+    }
+    return true;
+}
diff --git a/keyboards/hnahkb/vn66/keymaps/default/readme.md b/keyboards/hnahkb/vn66/keymaps/default/readme.md
new file mode 100644
index 0000000000..f6119fbc87
--- /dev/null
+++ b/keyboards/hnahkb/vn66/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for vn66
diff --git a/keyboards/hnahkb/vn66/readme.md b/keyboards/hnahkb/vn66/readme.md
new file mode 100644
index 0000000000..f917da5ea5
--- /dev/null
+++ b/keyboards/hnahkb/vn66/readme.md
@@ -0,0 +1,19 @@
+# VN66
+
+![vn66](https://i.imgur.com/Eo28suIl.jpg)
+
+A compact 60% keyboard for VNMK
+
+* Keyboard Maintainer: VNMK Community
+* Hardware Supported: VN66 PCB rev.2
+* Hardware Availability: https://geekhack.org/index.php?topic=101754.0
+
+Make example for this keyboard (after setting up your build environment):
+
+    make hnahkb/vn66:default
+
+Flashing example for this keyboard:
+
+    make hnahkb/vn66:default:flash
+
+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/hnahkb/vn66/rules.mk b/keyboards/hnahkb/vn66/rules.mk
new file mode 100644
index 0000000000..f1c1ec985e
--- /dev/null
+++ b/keyboards/hnahkb/vn66/rules.mk
@@ -0,0 +1,21 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = yes        # Console for debug
+COMMAND_ENABLE = yes        # Commands for debug and configuration
+NKRO_ENABLE = no            # Enable N-Key Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+ENCODER_ENABLE = yes
+
+LAYOUTS = 66_ansi 66_iso
diff --git a/keyboards/hnahkb/vn66/vn66.c b/keyboards/hnahkb/vn66/vn66.c
new file mode 100644
index 0000000000..5631359040
--- /dev/null
+++ b/keyboards/hnahkb/vn66/vn66.c
@@ -0,0 +1,17 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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 "vn66.h"
diff --git a/keyboards/hnahkb/vn66/vn66.h b/keyboards/hnahkb/vn66/vn66.h
new file mode 100644
index 0000000000..c8a356fdba
--- /dev/null
+++ b/keyboards/hnahkb/vn66/vn66.h
@@ -0,0 +1,74 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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 XXX KC_NO
+
+/* This a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT_all( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k4D, k4C, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k4B, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B,      k3C, k3D, \
+    k40, k41, k42,                k44,                k45, k46, k47, k48, k49, k4A \
+) { \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D }, \
+    { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D }, \
+    { k40, k41, k42, XXX, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, k4D } \
+}
+
+#define LAYOUT_66_ansi( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k4C, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k4B, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B,      k2D, \
+    k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C,      k3D, \
+    k40, k41, k42,                k44,                k45, k46, k47, k48, k49, k4A \
+) { \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, XXX, k2D }, \
+    { k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D }, \
+    { k40, k41, k42, XXX, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, XXX } \
+}
+
+#define LAYOUT_66_iso( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k4C, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C,      k4B, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B,      k3C, k3D, \
+    k40, k41, k42,                k44,                k45, k46, k47, k48, k49, k4A \
+) { \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, XXX }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D }, \
+    { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D }, \
+    { k40, k41, k42, XXX, k44, k45, k46, k47, k48, k49, k4A, k4B, k4C, XXX } \
+}
+
+#define LAYOUT_ansi LAYOUT_66_ansi
+#define LAYOUT_iso LAYOUT_66_iso