[Keyboard] Add MIO keyboard (#11852)

Co-authored-by: Ryan <fauxpark@gmail.com>

10 files changed, 327 insertions, 0 deletions

diff --git a/keyboards/mio/config.h b/keyboards/mio/config.h
new file mode 100644
index 0000000000..7eab9ea590
--- /dev/null
+++ b/keyboards/mio/config.h
@@ -0,0 +1,67 @@
+/*
+Copyright 2021 recompile keys
+
+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    0x524B // recompile keys
+#define PRODUCT_ID   0x4D41 // MIO
+#define DEVICE_VER   0x0001
+#define MANUFACTURER recompile keys
+#define PRODUCT      MIO
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 8
+
+/*
+ * 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 { F1, F0, F4, F7, F6, F5 }
+#define MATRIX_COL_PINS { C7, C6, B6, B5, B4, D7, D6, D4}
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define RGB_DI_PIN B3
+#ifdef RGB_DI_PIN
+#    define RGBLED_NUM 8
+#    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 */
+#    define RGBLIGHT_ANIMATIONS
+#endif
+
+/* 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/mio/info.json b/keyboards/mio/info.json
new file mode 100644
index 0000000000..d5afdbf79b
--- /dev/null
+++ b/keyboards/mio/info.json
@@ -0,0 +1,54 @@
+{
+  "keyboard_name": "MIO",
+  "url": "https://keys.recompile.net/projects/mio/",
+  "maintainer": "recompile keys",
+  "width": 8.25,
+  "height": 7.5,
+  "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.25, "y": 0 },
+        {"label": "F6", "x": 7.25, "y": 0 },
+        {"label": "~", "x": 0, "y": 1.25 },
+        {"label": "!", "x": 1, "y": 1.25 },
+        {"label": "@", "x": 2, "y": 1.25 },
+        {"label": "#", "x": 3, "y": 1.25 },
+        {"label": "$", "x": 4, "y": 1.25 },
+        {"label": "%", "x": 5, "y": 1.25 },
+        {"label": "^", "x": 6, "y": 1.25 },
+        {"label": "&", "x": 7, "y": 1.25 },
+        {"label": "Tab", "x": 0, "y": 2.25, "w": 1.5 },
+        {"label": "Q", "x": 1.5, "y": 2.25 },
+        {"label": "W", "x": 2.5, "y": 2.25 },
+        {"label": "E", "x": 3.5, "y": 2.25 },
+        {"label": "R", "x": 4.5, "y": 2.25 },
+        {"label": "T", "x": 5.5, "y": 2.25 },
+        {"label": "Y", "x": 6.5, "y": 2.25 },
+        {"label": "Caps Lock", "x": 0, "y": 3.25, "w": 1.75 },
+        {"label": "A", "x": 1.75, "y": 3.25 },
+        {"label": "S", "x": 2.75, "y": 3.25 },
+        {"label": "D", "x": 3.75, "y": 3.25 },
+        {"label": "F", "x": 4.75, "y": 3.25 },
+        {"label": "G", "x": 5.75, "y": 3.25 },
+        {"label": "H", "x": 6.75, "y": 3.25 },
+        {"label": "Shift", "x": 0, "y": 4.25, "w": 2.25 },
+        {"label": "Z", "x": 2.25, "y": 4.25 },
+        {"label": "X", "x": 3.25, "y": 4.25 },
+        {"label": "C", "x": 4.25, "y": 4.25 },
+        {"label": "V", "x": 5.25, "y": 4.25 },
+        {"label": "B", "x": 6.25, "y": 4.25 },
+        {"label": "N", "x": 7.25, "y": 4.25 },
+        {"label": "Ctrl", "x": 0, "y": 5.25, "w": 1.5 },
+        {"label": "Alt", "x": 2.5, "y": 5.25, "w": 1.5 },
+        {"x": 4, "y": 5.25, "w": 1.5 },
+        {"x": 5.5, "y": 5.25, "w": 2.75 },
+        {"x": 7, "y": 6.5, "w": 1.25 }
+      ]
+    }
+  }
+}
diff --git a/keyboards/mio/keymaps/default/keymap.c b/keyboards/mio/keymaps/default/keymap.c
new file mode 100644
index 0000000000..39223f537a
--- /dev/null
+++ b/keyboards/mio/keymaps/default/keymap.c
@@ -0,0 +1,42 @@
+/* Copyright 2021 recompile keys
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* Base */
+    [_BASE] = LAYOUT(
+        KC_ESC,           KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,
+        KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,
+        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,
+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,
+        MO(_FN), KC_LCTL, KC_LALT,                   KC_SPC,  KC_ENT
+    ),
+    [_FN] = LAYOUT(
+        RESET,             _______, _______, _______, _______, _______, _______,
+        RGB_TOG, RGB_MOD,  RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______,
+        _______, RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______,
+        _______, _______,  _______, _______, _______, _______, _______,
+        _______, _______,  _______, _______, _______, _______, _______,
+        _______, _______, _______,                    _______, _______
+    )
+};
diff --git a/keyboards/mio/keymaps/default/readme.md b/keyboards/mio/keymaps/default/readme.md
new file mode 100644
index 0000000000..688c514730
--- /dev/null
+++ b/keyboards/mio/keymaps/default/readme.md
@@ -0,0 +1,5 @@
+![MIO Layout Image](https://i.imgur.com/vihNDjn.png)
+
+# Default MIO Layout
+
+This layout is the default keymap for MIO.
diff --git a/keyboards/mio/keymaps/via/keymap.c b/keyboards/mio/keymaps/via/keymap.c
new file mode 100644
index 0000000000..b521df9971
--- /dev/null
+++ b/keyboards/mio/keymaps/via/keymap.c
@@ -0,0 +1,51 @@
+/* Copyright 2021 recompile keys
+ *
+ * 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_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,
+        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,
+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,
+        MO(1),   KC_LCTL, KC_LALT,                   KC_SPC,  KC_ENT
+    ),
+    [1] = LAYOUT(
+        RESET,             _______, _______, _______, _______, _______, _______,
+        RGB_TOG, RGB_MOD,  RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______,
+        _______, RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______,
+        _______, _______,  _______, _______, _______, _______, _______,
+        _______, _______,  _______, _______, _______, _______, _______,
+        _______, _______,  _______,                   _______, _______
+    ),
+    [2] = LAYOUT(
+        _______,          _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______,                   _______, _______
+    ),
+    [3] = LAYOUT(
+        _______,          _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______,
+        _______, _______, _______,                   _______, _______
+    )
+};
diff --git a/keyboards/mio/keymaps/via/rules.mk b/keyboards/mio/keymaps/via/rules.mk
new file mode 100644
index 0000000000..36b7ba9cbc
--- /dev/null
+++ b/keyboards/mio/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+LTO_ENABLE = yes
diff --git a/keyboards/mio/mio.c b/keyboards/mio/mio.c
new file mode 100644
index 0000000000..154a89d26f
--- /dev/null
+++ b/keyboards/mio/mio.c
@@ -0,0 +1,17 @@
+/* Copyright 2021 recompile keys
+ *
+ * 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 "mio.h"
diff --git a/keyboards/mio/mio.h b/keyboards/mio/mio.h
new file mode 100644
index 0000000000..da6dc3229c
--- /dev/null
+++ b/keyboards/mio/mio.h
@@ -0,0 +1,44 @@
+/* Copyright 2021 recompile keys
+ *
+ * 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"
+
+/* This is 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( \
+    K000,           K002,   K003,   K004,   K005,   K006,   K007, \
+    K100,   K101,   K102,   K103,   K104,   K105,   K106,   K107, \
+    K200,   K201,   K202,   K203,   K204,   K205,   K206, \
+    K300,   K301,   K302,   K303,   K304,   K305,   K306, \
+    K400,   K401,   K402,   K403,   K404,   K405,   K406, \
+    K500,   K501,   K502,                   K505,   K506  \
+) \
+{ \
+    { K000,   KC_NO,  K002,   K003,   K004,   K005,   K006,   K007  }, \
+    { K100,   K101,   K102,   K103,   K104,   K105,   K106,   K107  }, \
+    { K200,   K201,   K202,   K203,   K204,   K205,   K206,   KC_NO }, \
+    { K300,   K301,   K302,   K303,   K304,   K305,   K306,   KC_NO }, \
+    { K400,   K401,   K402,   K403,   K404,   K405,   K406,   KC_NO }, \
+    { K500,   K501,   K502,   KC_NO,  KC_NO,  K505,   K506,   KC_NO }, \
+}
diff --git a/keyboards/mio/readme.md b/keyboards/mio/readme.md
new file mode 100644
index 0000000000..6ae4fd049f
--- /dev/null
+++ b/keyboards/mio/readme.md
@@ -0,0 +1,23 @@
+# MIO
+
+![MIO](https://keys.recompile.net/images/mio-01@600w.jpg)
+
+High-end custom gaming keyboard.
+
+* Keyboard Maintainer: [Naoto Takai](https://github.com/takai)
+* Hardware Supported: Original MIO PCB
+* Hardware Availability:  https://keys.recompile.net/projects/mio/
+
+Make example for this keyboard (after setting up your build environment):
+
+    make mio:default
+
+Flashing example for this keyboard:
+
+    make mio: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).
+
+## Bootloader Mode
+
+In order to flash the firmware, you need to put the keyboard into bootloader mode. To enable the bootloader mode, press the reset button (SW1) on the underside of the PCB.
diff --git a/keyboards/mio/rules.mk b/keyboards/mio/rules.mk
new file mode 100644
index 0000000000..38ce53e309
--- /dev/null
+++ b/keyboards/mio/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+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
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output