Adding Keyboard: GMMK Pro (#12030)

* GMMK Pro QMK Firmware Code

* info.json added

* updated info.json for the unused keys

* redoing info.json

* readme for pro

* gmmk initial readme

* pipeline fix, issue with compiling gmmk.h

* gmmk pro code formatting changes

* removed rules.mk

* noci file

* Updates

* updated matrix function to match keymap

* updating the keymap layout, renaming matrix, updating layout name to LAYOUT

* fauxpark changes added

* PID VID updates

* removed chconfig and made rules.mk comments cleaner

Co-authored-by: Drashna Jael're <drashna@live.com>

keyboards/gmmk/pro/config.h

@@ -0,0 +1,46 @@
+/* Copyright 2021 Glorious, LLC <salman@pcgamingrace.com>
+ *
+ * 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 DEVICE_VER      0x0001
+#define VENDOR_ID       0x320F
+#define PRODUCT_ID      0x5044
+#define MANUFACTURER    Glorious
+#define PRODUCT         GMMK Pro
+
+/* key matrix size */
+#define MATRIX_ROWS 11
+#define MATRIX_COLS 8
+
+#define MATRIX_ROW_PINS  { B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10 }
+#define MATRIX_COL_PINS  { A0, A1, A2, A3, A4, A8, A9, A10 }
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+
+#define TAP_CODE_DELAY 10
+#define ENCODERS_PAD_A { C15 }
+#define ENCODERS_PAD_B { C14 }
+
+/* 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

keyboards/gmmk/pro/info.json

@@ -0,0 +1,110 @@
+{
+    "keyboard_name": "GMMK Pro",
+    "url": "https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black-reservation",
+    "maintainer": "GloriousThrall",
+    "width": 16.5,
+    "height": 6.75,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"x":0, "y":0},
+
+                {"x":1.25, "y":0},
+                {"x":2.25, "y":0},
+                {"x":3.25, "y":0},
+                {"x":4.25, "y":0},
+
+                {"x":5.5, "y":0},
+                {"x":6.5, "y":0},
+                {"x":7.5, "y":0},
+                {"x":8.5, "y":0},
+
+                {"x":9.75, "y":0},
+                {"x":10.75, "y":0},
+                {"x":11.75, "y":0},
+                {"x":12.75, "y":0},
+
+                {"x":14, "y":0},
+
+                {"x":0, "y":1.5},
+                {"x":1, "y":1.5},
+                {"x":2, "y":1.5},
+                {"x":3, "y":1.5},
+                {"x":4, "y":1.5},
+                {"x":5, "y":1.5},
+                {"x":6, "y":1.5},
+                {"x":7, "y":1.5},
+                {"x":8, "y":1.5},
+                {"x":9, "y":1.5},
+                {"x":10, "y":1.5},
+                {"x":11, "y":1.5},
+                {"x":12, "y":1.5},
+                {"x":13, "y":1.5, "w":2},
+
+                {"x":15.5, "y":1.5},
+
+                {"x":0, "y":2.5, "w":1.5},
+                {"x":1.5, "y":2.5},
+                {"x":2.5, "y":2.5},
+                {"x":3.5, "y":2.5},
+                {"x":4.5, "y":2.5},
+                {"x":5.5, "y":2.5},
+                {"x":6.5, "y":2.5},
+                {"x":7.5, "y":2.5},
+                {"x":8.5, "y":2.5},
+                {"x":9.5, "y":2.5},
+                {"x":10.5, "y":2.5},
+                {"x":11.5, "y":2.5},
+                {"x":12.5, "y":2.5},
+                {"x":13.5, "y":2.5, "w":1.5},
+
+                {"x":15.5, "y":2.5},
+
+                {"x":0, "y":3.5, "w":1.75},
+                {"x":1.75, "y":3.5},
+                {"x":2.75, "y":3.5},
+                {"x":3.75, "y":3.5},
+                {"x":4.75, "y":3.5},
+                {"x":5.75, "y":3.5},
+                {"x":6.75, "y":3.5},
+                {"x":7.75, "y":3.5},
+                {"x":8.75, "y":3.5},
+                {"x":9.75, "y":3.5},
+                {"x":10.75, "y":3.5},
+                {"x":11.75, "y":3.5},
+                {"x":12.75, "y":3.5, "w":2.25},
+
+                {"x":15.5, "y":3.5},
+
+                {"x":0, "y":4.5, "w":2.25},
+                {"x":2.25, "y":4.5},
+                {"x":3.25, "y":4.5},
+                {"x":4.25, "y":4.5},
+                {"x":5.25, "y":4.5},
+                {"x":6.25, "y":4.5},
+                {"x":7.25, "y":4.5},
+                {"x":8.25, "y":4.5},
+                {"x":9.25, "y":4.5},
+                {"x":10.25, "y":4.5},
+                {"x":11.25, "y":4.5},
+                {"x":12.25, "y":4.5, "w":1.75},
+
+                {"x":14.25, "y":4.75},
+
+                {"x":15.5, "y":4.5},
+
+                {"x":0, "y":5.5, "w":1.25},
+                {"x":1.25, "y":5.5, "w":1.25},
+                {"x":2.5, "y":5.5, "w":1.25},
+                {"x":3.75, "y":5.5, "w":6.25},
+                {"x":10, "y":5.5},
+                {"x":11, "y":5.5},
+                {"x":12, "y":5.5},
+
+                {"x":13.25, "y":5.75},
+                {"x":14.25, "y":5.75},
+                {"x":15.25, "y":5.75}
+            ]
+        }
+    }
+}

keyboards/gmmk/pro/keymaps/default/keymap.c

@@ -0,0 +1,47 @@
+/* Copyright 2021 Glorious, LLC <salman@pcgamingrace.com>
+
+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] = {
+
+//      ESC      F1       F2       F3       F4       F5       F6       F7       F8       F9       F10      F11      F12	     Prt           Rotary(Mute)
+//      ~        1        2        3        4        5        6        7        8        9        0         -       (=)	     BackSpc           Del
+//      Tab      Q        W        E        R        T        Y        U        I        O        P        [        ]        \                 PgUp
+//      Caps     A        S        D        F        G        H        J        K        L        ;        "                 Enter             PgDn
+//      Sh_L              Z        X        C        V        B        N        M        ,        .        ?                 Sh_R     Up       End
+//      Ct_L     Win_L    Alt_L                               SPACE                               Alt_R    FN       Ct_R     Left     Down     Right
+
+
+    [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_PSCR,          KC_MUTE,
+        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_DEL,
+        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_PGUP,
+        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_PGDN,
+        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_END,
+        KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+    )
+
+};
+
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (clockwise) {
+      tap_code(KC_VOLU);
+    } else {
+      tap_code(KC_VOLD);
+    }
+}

keyboards/gmmk/pro/pro.c

@@ -0,0 +1,16 @@
+/* Copyright 2021 Glorious, LLC <salman@pcgamingrace.com>
+ *
+ * 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 "pro.h"

keyboards/gmmk/pro/pro.h

@@ -0,0 +1,50 @@
+/* Copyright 2021 Glorious, LLC <salman@pcgamingrace.com>
+
+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 ___ KC_NO
+
+//  ESC  F1   F2   F3   F4   F5   F6   F7   F8   F9   F10  F11  F12  Prt    Rotary(Mute)
+//  ~    1    2    3    4    5    6    7    8    9    0    -    (=)  BSpc     Del
+//  Tab  Q    W    E    R    T    Y    U    I    O    P    [    ]    \        PgUp
+//  Caps A    S    D    F    G    H    J    K    L    ;    "        Enter     PgDn
+//  Sh_L Z    X    C    V    B    N    M    ,    .    ?       Sh_R       Up   End
+//  Ct_L    Win_L   Alt_L      SPACE          Alt_R   FN   Ct_R     Left Down Right
+
+#define LAYOUT( \
+    k13, k26, k36, k31, k33, k07, k63, k71, k76, ka6, ka7, ka3, ka5, k97,     k01, \
+    k16, k17, k27, k37, k47, k46, k56, k57, k67, k77, k87, k86, k66, ka1,     k65, \
+    k11, k10, k20, k30, k40, k41, k51, k50, k60, k70, k80, k81, k61, ka2,     k15, \
+    k21, k12, k22, k32, k42, k43, k53, k52, k62, k72, k82, k83,     ka4,      k25, \
+    k00, k14, k24, k34, k44, k45, k55, k54, k64, k74, k85,    k91,       k35, k75, \
+    k06,    k90,    k93,       k94,          k92,     k95, k04,     k03, k73, k05  \
+) \
+{ \
+    { k00, k01, ___, k03, k04, k05, k06, k07}, \
+    { k10, k11, k12, k13, k14, k15, k16, k17}, \
+    { k20, k21, k22, ___, k24, k25, k26, k27}, \
+    { k30, k31, k32, k33, k34, k35, k36, k37}, \
+    { k40, k41, k42, k43, k44, k45, k46, k47}, \
+    { k50, k51, k52, k53, k54, k55, k56, k57}, \
+    { k60, k61, k62, k63, k64, k65, k66, k67}, \
+    { k70, k71, k72, k73, k74, k75, k76, k77}, \
+    { k80, k81, k82, k83, ___, k85, k86, k87}, \
+    { k90, k91, k92, k93, k94, k95, ___, k97}, \
+    { ___, ka1, ka2, ka3, ka4, ka5, ka6, ka7}  \
+}

keyboards/gmmk/pro/readme.md

@@ -0,0 +1,13 @@
+# GMMK PRO
+
+A tenkeyless 75%  keyboard made and sold by Glorious LLC. Equipped with the STM32 ARM Cortex-M4 microcontroller, with support for rotary encoders and three additional layouts. [More info at Glorious](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black-reservation)
+
+* Keyboard Maintainer: [GloriousThrall](https://github.com/GloriousThrall)  
+* Hardware Supported: GMMK Pro
+* Hardware Availability: [GloriousPCGaming.com](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black-reservation)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make gmmk/pro:default
+
+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/gmmk/pro/rules.mk

@@ -0,0 +1,20 @@
+# MCU name
+MCU = STM32F303
+
+# 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 = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+ENCODER_ENABLE = yes