[Keyboard] Monstargear XO87 Solderable support (#11716)

* Support for XO87 solderable version

* cleanup

* Remove abandoned code

* replaced KEYMAP with LAYOUT and moved LAYOUT macro to solderable.h.  deleted unneeded files.

* Update keyboards/monstargear/xo87/solderable/keymaps/via/keymap.c

* update info.json with missing keys

* Apply suggestions from code review

* Apply suggestions from code review

correct layout macro

keyboards/monstargear/xo87/solderable/config.h

@@ -0,0 +1,57 @@
+/* Copyright 2021 datafx
+ *
+ * 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"
+
+#define brightnessMax 8
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x4D47 // MG for Monstargear
+#define PRODUCT_ID      0x5344 // SD for Soldered
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Monstargear
+#define PRODUCT         XO87 Soldered
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 16
+
+#define BACKLIGHT_PIN F0
+
+#define MATRIX_ROW_PINS { E6,E7,E3,B0,B1,A2}
+#define MATRIX_COL_PINS { C5,C3,C1,E1,D6,D2,B7,B3,F6,F7,F3,A5,A1,E2,C7,A6 }
+
+#define KEYLED_ROWS 6
+#define KEYLED_COLS 16
+#define KEYLED_ROW_PINS { E5,B4,B5,F0,C6,D5 }
+#define KEYLED_COL_PINS { C4,C2,C0,E0,D4,E4,B6,B2,F4,A0,F2,A4,F1,A7,D3,A3 }
+#define LED_DRIVER_LED_COUNT 93
+
+#define UNUSED_PINS
+#define DIODE_DIRECTION ROW2COL
+#define RGB_DI_PIN D7
+#define DRIVER_LED_TOTAL 21
+#define DRIVER_COUNT 2
+#define RGBLED_NUM 21
+#define RGBLIGHT_ANIMATIONS
+
+#define DEBOUNCE 5
+#define LOCKING_SUPPORT_ENABLE
+#define LOCKING_RESYNC_ENABLE
+
+#define BACKLIGHT_LEVELS 3

keyboards/monstargear/xo87/solderable/keymaps/default/keymap.c

@@ -0,0 +1,36 @@
+/* Copyright 2021 datafx
+ *
+ * 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_all(
+		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_PSCR, KC_SLCK, KC_PAUS,
+		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_INS, KC_HOME, KC_PGUP,
+		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_DEL, KC_END, KC_PGDN,
+		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_BSPC,
+		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_BSLS, KC_UP, KC_RCTL,
+		KC_LCTL, KC_LGUI, KC_LALT, _______, KC_SPC, _______, KC_RALT, KC_RGUI, MO(1), KC_LEFT, KC_DOWN, KC_RGHT),
+
+	[1] = LAYOUT_all(
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, BL_INC, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, BL_TOGG, BL_DEC, BL_STEP),
+};

keyboards/monstargear/xo87/solderable/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for the XO87 Solderable PCB

keyboards/monstargear/xo87/solderable/keymaps/via/config.h

@@ -0,0 +1,18 @@
+/* Copyright 2021 datafx
+ *
+ * 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 VIA_QMK_RGBLIGHT_ENABLE

keyboards/monstargear/xo87/solderable/keymaps/via/keymap.c

@@ -0,0 +1,53 @@
+/* Copyright 2021 datafx
+ *
+ * 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_all(
+		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_PSCR, KC_SLCK, KC_PAUS,
+		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_INS, KC_HOME, KC_PGUP,
+		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_DEL, KC_END, KC_PGDN,
+		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_BSPC,
+		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_BSLS, KC_UP, KC_RCTL,
+		KC_LCTL, KC_LGUI, KC_LALT, _______, KC_SPC, _______, KC_RALT, KC_RGUI, MO(1), KC_LEFT, KC_DOWN, KC_RGHT),
+
+	[1] = LAYOUT_all(
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, BL_INC, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, BL_TOGG, BL_DEC, BL_STEP),
+
+	[2] = LAYOUT_all(
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+	[3] = LAYOUT_all(
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+		_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+
+};

keyboards/monstargear/xo87/solderable/keymaps/via/readme.md

@@ -0,0 +1 @@
+# The default VIA keymap for the XO87 Solderable PCB

keyboards/monstargear/xo87/solderable/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/monstargear/xo87/solderable/readme.md

@@ -0,0 +1,23 @@
+# XO87 Solderable PCB
+
+![XO87](https://cdn.imweb.me/thumbnail/20201120/c90a5bdb75264.png) 
+
+A TKL custom keyboard made by Monstar Gear.
+
+* Keyboard Maintainer: The QMK Community
+* Hardware Supported: XO87 Solderable version
+* Hardware Availability: [Monstargear](https://monstargears.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make monstargear/xo87/solderable:default
+
+Flashing example for this keyboard:
+
+    make monstargear/xo87/solderable:default:flash
+    
+The LED matrix is not yet working with this board.  A temporary workaround to allow the caps/scroll/num lock LEDs to work has been added to allow this firmware to be functional without the led matrix.
+
+Please be aware that Monstar Gear has not yet switched to this firmware and any PCB that is running the pre-installed firmware will need to use ISP to flash their board for the first time.
+
+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).

keyboards/monstargear/xo87/solderable/rules.mk

@@ -0,0 +1,23 @@
+# MCU name
+MCU = at90usb646
+
+# Bootloader selection
+BOOTLOADER = lufa-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 = yes        # 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 = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+BACKLIGHT_DRIVER = custom

keyboards/monstargear/xo87/solderable/solderable.c

@@ -0,0 +1,76 @@
+/* Copyright 2021 datafx
+ *
+ * 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 "solderable.h"
+#include "quantum.h"
+
+#define noLed {255,255}
+
+#define ledSollSP (80+3)
+#define ledNumSP (80+7)
+#define ledCapSP (80+8)
+
+void backlight_init_ports(void) {
+    setPinOutput(Lseg0);
+    setPinOutput(Lseg1);
+    setPinOutput(Lseg2);
+    setPinOutput(Lseg3);
+    setPinOutput(Lseg4);
+    setPinOutput(Lseg5);
+    setPinOutput(Lcom0);
+    setPinOutput(Lcom1);
+    setPinOutput(Lcom2);
+    setPinOutput(Lcom3);
+    setPinOutput(Lcom4);
+    setPinOutput(Lcom5);
+    setPinOutput(Lcom6);
+    setPinOutput(Lcom7);
+    setPinOutput(Lcom8);
+    setPinOutput(Lcom9);
+    setPinOutput(Lcom10);
+    setPinOutput(Lcom11);
+    setPinOutput(Lcom12);
+    setPinOutput(Lcom13);
+    setPinOutput(Lcom14);
+    setPinOutput(Lcom15);
+}
+
+void backlight_set(uint8_t level) {
+}
+
+void backlight_task(void) {
+    // This is a temporary workaround to get the status LEDs working until we can figure out the LED matrix
+    led_t host_leds = host_keyboard_led_state();
+    if (host_leds.scroll_lock) {
+    writePinHigh(Lcom3);
+    writePinHigh(Lseg5);
+    } else {
+    writePinLow(Lcom3);
+    }
+    if (host_leds.num_lock) {
+    writePinHigh(Lcom7);
+    writePinHigh(Lseg5);
+    } else {
+    writePinLow(Lcom7);
+    }
+    if (host_leds.caps_lock) {
+    writePinHigh(Lcom8);
+    writePinHigh(Lseg5);
+    } else {
+    writePinLow(Lcom8);
+    }
+}
+

keyboards/monstargear/xo87/solderable/solderable.h

@@ -0,0 +1,102 @@
+/* Copyright 2021 datafx
+ *
+ * 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/>.
+ */
+
+#define LAYOUT_all( \
+	K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, K015, \
+	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, \
+	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, K215, \
+	K300, K301, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311, K312, K313,             \
+	K400, K401, K402, K403, K404, K405, K406, K407, K408, K409, K410, K411, K412, K413, K414, K415, \
+	K500, K501, K502,             K505, K506,             K509, K510, K511, K512, K513, K514, K515  \
+) { \
+	{ K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011,  K012,  K013,  K014,  K015 }, \
+	{ K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111,  K112,  K113,  K114,  K115 }, \
+	{ K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211,  K212,  K213,  K214,  K215 }, \
+	{ K300,  K301,  K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310,  K311,  K312,  K313,  KC_NO, KC_NO }, \
+	{ K400,  K401,  K402,  K403,  K404,  K405,  K406,  K407,  K408,  K409,  K410,  K411,  K412,  K413,  K414,  K415 }, \
+	{ K500,  K501,  K502,  KC_NO, KC_NO, K505,  K506,  KC_NO, KC_NO, K509,  K510,  K511,  K512,  K513,  K514,  K515 }  \
+}
+
+#define u8 uint8_t
+#define u16 uint16_t
+
+#pragma once
+
+#include "quantum.h"
+
+#define KEYLED_ROWS 6
+#define KEYLED_COLS 16
+
+#define XaxisMax 18
+#define YaxisMax 6
+
+#define RhythmLedColumMax 18
+
+typedef struct{
+	u8 onf;
+	u8 hightLevel;
+	u8 ColumHeight[RhythmLedColumMax];
+}
+
+RhythmLed_;
+
+typedef struct{
+	u8 r,g,b;
+}
+
+rgb_;
+#define colorAGSize 10
+#define colorBGSize RGBLED_NUM-10
+
+typedef struct{
+	rgb_ colorAG[colorAGSize];
+    rgb_ colorBG[RGBLED_NUM-10];
+}
+
+backLedRgbG_;
+
+#define Lseg0 E5
+#define Lseg1 B4
+#define Lseg2 B5
+#define Lseg3 F0
+#define Lseg4 C6
+#define Lseg5 D5
+
+#define Lcom0 C4
+#define Lcom1 C2
+#define Lcom2 C0
+#define Lcom3 E0
+#define Lcom4 D4
+#define Lcom5 E4
+#define Lcom6 B6
+#define Lcom7 B2
+#define Lcom8 F4
+#define Lcom9 A0
+#define Lcom10 F2
+#define Lcom11 A4
+#define Lcom12 F1
+#define Lcom13 A7
+#define Lcom14 D3
+#define Lcom15 A3
+
+extern void keyLedDriver(void);
+extern void KeyLedCom(void);
+u8 getKeyLedIndexForXY(u8 x,u8 y);
+
+extern void ledCapsSet(bool onf);
+extern void ledNumSet(bool onf);
+extern void ledSollSet(bool onf);
+void reflashLedState(void);