[Keyboard] Add GPAD8-2R (gpad8_2r) Macro Pad (#19914)

Co-authored-by: jack <0x6a73@protonmail.com>

8 files changed, 298 insertions, 0 deletions

diff --git a/keyboards/gkeyboard/gpad8_2r/config.h b/keyboards/gkeyboard/gpad8_2r/config.h
new file mode 100644
index 0000000000..e3a0340f19
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/config.h
@@ -0,0 +1,65 @@
+// Copyright 2023 gkeyboard (@gkeyboard)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define DYNAMIC_KEYMAP_LAYER_COUNT 8
+
+#define RGB_DI_PIN GP19
+#define RGB_MATRIX_LED_COUNT 16
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_MATRIX_KEYPRESSES
+#define RGB_DISABLE_WHEN_USB_SUSPENDED
+// RGB Matrix Animation modes. Explicitly enabled
+// For full list of effects, see:
+// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+#define ENABLE_RGB_MATRIX_ALPHAS_MODS
+#define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+#define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+#define ENABLE_RGB_MATRIX_BREATHING
+#define ENABLE_RGB_MATRIX_BAND_SAT
+#define ENABLE_RGB_MATRIX_BAND_VAL
+#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+#define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+#define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+#define ENABLE_RGB_MATRIX_CYCLE_ALL
+#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+#define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+#define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+#define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+#define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+#define ENABLE_RGB_MATRIX_DUAL_BEACON
+#define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+#define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+#define ENABLE_RGB_MATRIX_RAINDROPS
+#define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+#define ENABLE_RGB_MATRIX_HUE_BREATHING
+#define ENABLE_RGB_MATRIX_HUE_PENDULUM
+#define ENABLE_RGB_MATRIX_HUE_WAVE
+#define ENABLE_RGB_MATRIX_PIXEL_RAIN
+#define ENABLE_RGB_MATRIX_PIXEL_FLOW
+#define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
+// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+#define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+#define ENABLE_RGB_MATRIX_DIGITAL_RAIN
+// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+#define ENABLE_RGB_MATRIX_SPLASH
+#define ENABLE_RGB_MATRIX_MULTISPLASH
+#define ENABLE_RGB_MATRIX_SOLID_SPLASH
+#define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
+
+/* 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
diff --git a/keyboards/gkeyboard/gpad8_2r/info.json b/keyboards/gkeyboard/gpad8_2r/info.json
new file mode 100644
index 0000000000..fcc900a35f
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/info.json
@@ -0,0 +1,80 @@
+{
+    "manufacturer": "gkeyboard",
+    "keyboard_name": "GPAD8-2R",
+    "url": "https://github.com/gkeyboard/GPAD8-2R",
+    "maintainer": "gkeyboard",
+    "bootloader": "rp2040",
+    "processor": "RP2040",
+    "board": "GENERIC_RP_RP2040",
+    "usb": {
+        "vid": "0x474B",
+        "pid": "0x4202",
+        "device_version": "1.0.0"
+    },
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgb_matrix": true
+    },
+    "matrix_pins": {
+        "cols": ["GP12", "GP11", "GP10", "GP9"],
+        "rows": ["GP4", "GP5", "GP6"]
+    },
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "enabled": true,
+        "rotary": [
+            {
+                "pin_a": "GP29",
+                "pin_b": "GP28",
+                "resolution": 4
+            },
+            {
+                "pin_a": "GP2",
+                "pin_b": "GP3",
+                "resolution": 4
+            }
+        ]
+    },
+    "rgb_matrix": {
+        "driver": "WS2812",
+        "layout": [
+            { "flags": 4, "matrix": [1, 0], "x": 28, "y": 12 },
+            { "flags": 4, "matrix": [1, 1], "x": 84, "y": 12 },
+            { "flags": 4, "matrix": [1, 2], "x": 140, "y": 12 },
+            { "flags": 4, "matrix": [1, 3], "x": 196, "y": 12 },
+            { "flags": 4, "matrix": [2, 0], "x": 28, "y": 28 },
+            { "flags": 4, "matrix": [2, 1], "x": 84, "y": 28 },
+            { "flags": 4, "matrix": [2, 2], "x": 140, "y": 28 },
+            { "flags": 4, "matrix": [2, 3], "x": 196, "y": 28 },
+            { "flags": 2, "x": 28, "y": 44 },
+            { "flags": 2, "x": 84, "y": 44 },
+            { "flags": 2, "x": 140, "y": 44 },
+            { "flags": 2, "x": 196, "y": 44 },
+            { "flags": 2, "x": 28, "y": 60 },
+            { "flags": 2, "x": 84, "y": 60 },
+            { "flags": 2, "x": 140, "y": 60 },
+            { "flags": 2, "x": 196, "y": 60 }
+        ]
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                { "matrix": [0, 0], "x": 0.0, "y": 0.0 },
+                { "matrix": [0, 3], "x": 3.0, "y": 0.0 },
+                { "matrix": [1, 0], "x": 0.0, "y": 1.25 },
+                { "matrix": [1, 1], "x": 1.0, "y": 1.25 },
+                { "matrix": [1, 2], "x": 2.0, "y": 1.25 },
+                { "matrix": [1, 3], "x": 3.0, "y": 1.25 },
+                { "matrix": [2, 0], "x": 0.0, "y": 2.25 },
+                { "matrix": [2, 1], "x": 1.0, "y": 2.25 },
+                { "matrix": [2, 2], "x": 2.0, "y": 2.25 },
+                { "matrix": [2, 3], "x": 3.0, "y": 2.25 }
+            ]
+        }
+    }
+}
diff --git a/keyboards/gkeyboard/gpad8_2r/keymaps/default/keymap.c b/keyboards/gkeyboard/gpad8_2r/keymaps/default/keymap.c
new file mode 100644
index 0000000000..41b505336d
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/keymaps/default/keymap.c
@@ -0,0 +1,49 @@
+/* Copyright 2023 gkeyboard
+ *
+ * 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_MUTE,                RGB_TOG,
+        KC_A,   KC_B,   KC_C,   KC_D,
+        KC_E,   KC_F,   KC_G,   KC_H
+    ),
+    [1] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [2] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [3] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU),      ENCODER_CCW_CW(RGB_MOD, RGB_RMOD) },
+    [1] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [2] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [3] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }
+};
+#endif
diff --git a/keyboards/gkeyboard/gpad8_2r/keymaps/default/rules.mk b/keyboards/gkeyboard/gpad8_2r/keymaps/default/rules.mk
new file mode 100644
index 0000000000..ee32568148
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/gkeyboard/gpad8_2r/keymaps/via/keymap.c b/keyboards/gkeyboard/gpad8_2r/keymaps/via/keymap.c
new file mode 100644
index 0000000000..589a1b1539
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/keymaps/via/keymap.c
@@ -0,0 +1,73 @@
+/* Copyright 2023 gkeyboard
+ *
+ * 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_MUTE,                RGB_TOG,
+        KC_A,   KC_B,   KC_C,   KC_D,
+        KC_E,   KC_F,   KC_G,   KC_H
+    ),
+    [1] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [2] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [3] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [4] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [5] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [6] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    ),
+    [7] = LAYOUT(
+        KC_TRNS,                            KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
+        KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU),      ENCODER_CCW_CW(RGB_MOD, RGB_RMOD) },
+    [1] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [2] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [3] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [4] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [5] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [6] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    [7] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS),      ENCODER_CCW_CW(KC_TRNS, KC_TRNS) }
+};
+#endif
diff --git a/keyboards/gkeyboard/gpad8_2r/keymaps/via/rules.mk b/keyboards/gkeyboard/gpad8_2r/keymaps/via/rules.mk
new file mode 100644
index 0000000000..f1adcab005
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/gkeyboard/gpad8_2r/readme.md b/keyboards/gkeyboard/gpad8_2r/readme.md
new file mode 100644
index 0000000000..fd16251714
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/readme.md
@@ -0,0 +1,27 @@
+# GPAD8-2R
+
+![GPAD8-2R](https://i.imgur.com/jAaO7gYh.png)
+
+8 Keys Custom Macro Pad, 2 Encoders, with USB Type-C, RGB underglow, RGB Per Key Lighting. 
+
+* Keyboard Maintainer: [gkeyboard](https://github.com/gkeyboard)
+* Hardware Supported: GPAD8-2R PCB
+* Hardware Availability: http://www.mltelectronic.com
+
+Make example for this keyboard (after setting up your build environment):
+
+    make gkeyboard/gpad8_2r:default
+
+Flashing example for this keyboard:
+
+    make gkeyboard/gpad8_2r: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
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
diff --git a/keyboards/gkeyboard/gpad8_2r/rules.mk b/keyboards/gkeyboard/gpad8_2r/rules.mk
new file mode 100644
index 0000000000..997fce7e65
--- /dev/null
+++ b/keyboards/gkeyboard/gpad8_2r/rules.mk
@@ -0,0 +1 @@
+WS2812_DRIVER = vendor