[Keyboard] Add rev_0131 for Keychron Q0 (#19547)

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

11 files changed, 427 insertions, 0 deletions

diff --git a/keyboards/keychron/q0/rev_0131/config.h b/keyboards/keychron/q0/rev_0131/config.h
new file mode 100644
index 0000000000..4ed6f0e4e7
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/config.h
@@ -0,0 +1,45 @@
+/* Copyright 2023 @ Keychron (https://www.keychron.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
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { B5, B4, B3, A15, A14, A13 }
+#define MATRIX_COL_PINS { C14, C15, A0, A1, A2 }
+
+/* RGB Matrix Driver Configuration */
+#define DRIVER_COUNT 1
+#define DRIVER_ADDR_1 0b1110111
+
+/* RGB Matrix Configuration */
+#define DRIVER_1_LED_TOTAL 26
+#define RGB_MATRIX_LED_COUNT DRIVER_1_LED_TOTAL
+
+/* Scan phase of led driver set as MSKPHASE_9CHANNEL(defined as 0x03 in CKLED2001.h) */
+#define PHASE_CHANNEL MSKPHASE_9CHANNEL
+
+/* Enable num-lock LED */
+#define NUM_LOCK_LED_INDEX 5
+
+/* Encoder Configuration */
+#define ENCODERS_PAD_A { A3 }
+#define ENCODERS_PAD_B { A4 }
+#define ENCODER_RESOLUTION 4
+#define ENCODER_DEFAULT_POS 0x3
+
+/* Specify (0,1) which programmed as "Fn" key on this keyboard as bootmagic key */
+#define BOOTMAGIC_LITE_ROW 0
+#define BOOTMAGIC_LITE_COLUMN 1
diff --git a/keyboards/keychron/q0/rev_0131/info.json b/keyboards/keychron/q0/rev_0131/info.json
new file mode 100644
index 0000000000..9fbbe7d206
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/info.json
@@ -0,0 +1,51 @@
+{
+    "keyboard_name": "Keychron Q0 Plus",
+    "manufacturer": "Keychron",
+    "url": "https://github.com/Keychron",
+    "maintainer": "lalalademaxiya1",
+    "usb": {
+        "vid": "0x3434",
+        "pid": "0x0131",
+        "device_version": "1.0.0"
+    },
+    "processor": "STM32L432",
+    "bootloader": "stm32-dfu",
+    "layouts": {
+        "LAYOUT_numpad_6x5": {
+            "layout": [
+                {"matrix":[0,0], "x":0, "y":0},
+                {"matrix":[0,1], "x":1.25, "y":0},
+                {"matrix":[0,2], "x":2.25, "y":0},
+                {"matrix":[0,3], "x":3.25, "y":0},
+                {"matrix":[0,4], "x":4.25, "y":0},
+
+                {"matrix":[1,0], "x":0, "y":1.25},
+                {"matrix":[1,1], "x":1.25, "y":1.25},
+                {"matrix":[1,2], "x":2.25, "y":1.25},
+                {"matrix":[1,3], "x":3.25, "y":1.25},
+                {"matrix":[1,4], "x":4.25, "y":1.25},
+
+                {"matrix":[2,0], "x":0, "y":2.25},
+                {"matrix":[2,1], "x":1.25, "y":2.25},
+                {"matrix":[2,2], "x":2.25, "y":2.25},
+                {"matrix":[2,3], "x":3.25, "y":2.25},
+                {"matrix":[2,4], "x":4.25, "y":2.25, "h":2},
+
+                {"matrix":[3,0], "x":0, "y":3.25},
+                {"matrix":[3,1], "x":1.25, "y":3.25},
+                {"matrix":[3,2], "x":2.25, "y":3.25},
+                {"matrix":[3,3], "x":3.25, "y":3.25},
+
+                {"matrix":[4,0], "x":0, "y":4.25},
+                {"matrix":[4,1], "x":1.25, "y":4.25},
+                {"matrix":[4,2], "x":2.25, "y":4.25},
+                {"matrix":[4,3], "x":3.25, "y":4.25},
+                {"matrix":[4,4], "x":4.25, "y":4.25, "h":2},
+
+                {"matrix":[5,0], "x":0, "y":5.25},
+                {"matrix":[5,1], "x":1.25, "y":5.25, "w":2},
+                {"matrix":[5,3], "x":3.25, "y":5.25}
+            ]
+        }
+    }
+}
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/default/keymap.c b/keyboards/keychron/q0/rev_0131/keymaps/default/keymap.c
new file mode 100644
index 0000000000..f92d6b8362
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/default/keymap.c
@@ -0,0 +1,49 @@
+/* Copyright 2023 @ Keychron (https://www.keychron.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
+
+// clang-format off
+
+enum layers {
+    BASE,
+    FUNC
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [BASE] = LAYOUT_numpad_6x5(
+        KC_MUTE, MO(FUNC), KC_ESC,  KC_BSPC,  KC_TAB,
+        _______, KC_NUM,   KC_PSLS, KC_PAST,  KC_PMNS,
+        _______, KC_P7,    KC_P8,   KC_P9,    KC_PPLS,
+        _______, KC_P4,    KC_P5,   KC_P6,
+        _______, KC_P1,    KC_P2,   KC_P3,    KC_PENT,
+        _______, KC_P0,             KC_PDOT),
+
+    [FUNC] = LAYOUT_numpad_6x5(
+        RGB_TOG, _______,  KC_MUTE, KC_VOLD,  KC_VOLU,
+        _______, RGB_MOD,  RGB_VAI, RGB_HUI,  KC_DEL,
+        _______, RGB_RMOD, RGB_VAD, RGB_HUD,  _______,
+        _______, RGB_SAI,  RGB_SPI, KC_MPRV,
+        _______, RGB_SAD,  RGB_SPD, KC_MPLY,  _______,
+        _______, RGB_TOG,           KC_MNXT),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [FUNC] = { ENCODER_CCW_CW(RGB_VAD, RGB_VAI) },
+};
+#endif // ENCODER_MAP_ENABLE
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/default/rules.mk b/keyboards/keychron/q0/rev_0131/keymaps/default/rules.mk
new file mode 100644
index 0000000000..ee32568148
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/keychron/keymap.c b/keyboards/keychron/q0/rev_0131/keymaps/keychron/keymap.c
new file mode 100644
index 0000000000..5d73b5733f
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/keychron/keymap.c
@@ -0,0 +1,83 @@
+/* Copyright 2023 @ Keychron (https://www.keychron.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
+#include "keychron_common.h"
+
+// clang-format off
+
+enum layers {
+    BASE,
+    FUNC,
+    L2,
+    L3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [BASE] = LAYOUT_numpad_6x5(
+        KC_MUTE,   MO(FUNC), KC_ESC,  KC_BSPC,  KC_TAB,
+        MACRO01,   KC_NUM,   KC_PSLS, KC_PAST,  KC_PMNS,
+        MACRO02,   KC_P7,    KC_P8,   KC_P9,    KC_PPLS,
+        MACRO03,   KC_P4,    KC_P5,   KC_P6,
+        MACRO04,   KC_P1,    KC_P2,   KC_P3,    KC_PENT,
+        MACRO05,   KC_P0,             KC_PDOT),
+
+    [FUNC] = LAYOUT_numpad_6x5(
+        RGB_TOG,   _______,  KC_MUTE, KC_VOLD,  KC_VOLU,
+        MACRO01,   RGB_MOD,  RGB_VAI, RGB_HUI,  KC_DEL,
+        MACRO02,   RGB_RMOD, RGB_VAD, RGB_HUD,  _______,
+        MACRO03,   RGB_SAI,  RGB_SPI, KC_MPRV,
+        MACRO04,   RGB_SAD,  RGB_SPD, KC_MPLY,  _______,
+        MACRO05,   RGB_TOG,           KC_MNXT),
+
+    [L2] = LAYOUT_numpad_6x5(
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,           _______),
+
+    [L3] = LAYOUT_numpad_6x5(
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,           _______)
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [FUNC] = { ENCODER_CCW_CW(RGB_VAD, RGB_VAI) },
+    [L2] = { ENCODER_CCW_CW(_______, _______) },
+    [L3] = { ENCODER_CCW_CW(_______, _______) }
+};
+#endif // ENCODER_MAP_ENABLE
+
+// clang-format on
+
+void housekeeping_task_user(void) {
+    housekeeping_task_keychron();
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (!process_record_keychron(keycode, record)) {
+        return false;
+    }
+    return true;
+}
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/keychron/rules.mk b/keyboards/keychron/q0/rev_0131/keymaps/keychron/rules.mk
new file mode 100644
index 0000000000..9cf1a9b56c
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/keychron/rules.mk
@@ -0,0 +1,5 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
+
+VPATH += keyboards/keychron/common
+SRC += keychron_common.c
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/via/keymap.c b/keyboards/keychron/q0/rev_0131/keymaps/via/keymap.c
new file mode 100644
index 0000000000..58070ecd27
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/via/keymap.c
@@ -0,0 +1,69 @@
+/* Copyright 2023 @ Keychron (https://www.keychron.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
+
+ // clang-format off
+
+enum layers {
+    BASE,
+    FUNC,
+    L2,
+    L3
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [BASE] = LAYOUT_numpad_6x5(
+        KC_MUTE,   MO(FUNC), KC_ESC,  KC_BSPC,  KC_TAB,
+        MACRO01,   KC_NUM,   KC_PSLS, KC_PAST,  KC_PMNS,
+        MACRO02,   KC_P7,    KC_P8,   KC_P9,    KC_PPLS,
+        MACRO03,   KC_P4,    KC_P5,   KC_P6,
+        MACRO04,   KC_P1,    KC_P2,   KC_P3,    KC_PENT,
+        MACRO05,   KC_P0,             KC_PDOT),
+
+    [FUNC] = LAYOUT_numpad_6x5(
+        RGB_TOG,   _______,  KC_MUTE, KC_VOLD,  KC_VOLU,
+        MACRO01,   RGB_MOD,  RGB_VAI, RGB_HUI,  KC_DEL,
+        MACRO02,   RGB_RMOD, RGB_VAD, RGB_HUD,  _______,
+        MACRO03,   RGB_SAI,  RGB_SPI, KC_MPRV,
+        MACRO04,   RGB_SAD,  RGB_SPD, KC_MPLY,  _______,
+        MACRO05,   RGB_TOG,           KC_MNXT),
+
+    [L2] = LAYOUT_numpad_6x5(
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,  _______, _______,
+        _______, _______,  _______, _______,  _______,
+        _______, _______,           _______),
+
+    [L3] = LAYOUT_numpad_6x5(
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,  _______, _______,
+        _______, _______,  _______, _______,   _______,
+        _______, _______,           _______)
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [BASE]      = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [FUNC]       = { ENCODER_CCW_CW(RGB_VAD, RGB_VAI) },
+    [L2] = { ENCODER_CCW_CW(_______, _______) },
+    [L3] = { ENCODER_CCW_CW(_______, _______) }
+};
+#endif // ENCODER_MAP_ENABLE
diff --git a/keyboards/keychron/q0/rev_0131/keymaps/via/rules.mk b/keyboards/keychron/q0/rev_0131/keymaps/via/rules.mk
new file mode 100644
index 0000000000..f1adcab005
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
diff --git a/keyboards/keychron/q0/rev_0131/readme.md b/keyboards/keychron/q0/rev_0131/readme.md
new file mode 100644
index 0000000000..df07c40e49
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/readme.md
@@ -0,0 +1,6 @@
+# The enhanced version with encoder of the Keychron Q0
+
+- The name of this keyboard is "Q0 Plus"
+- Enable EC11 rotary encoder
+- Turn clockwise to increase volume and turn anti-clockwise to decrease volume
+- Press the knob button to mute
diff --git a/keyboards/keychron/q0/rev_0131/rev_0131.c b/keyboards/keychron/q0/rev_0131/rev_0131.c
new file mode 100644
index 0000000000..c67a460557
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/rev_0131.c
@@ -0,0 +1,95 @@
+/* Copyright 2023 @ Keychron (https://www.keychron.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 "quantum.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+// clang-format off
+
+const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to CKLED manual for these locations
+ *   driver
+ *   |  R location
+ *   |  |       G location
+ *   |  |       |       B location
+ *   |  |       |       | */
+    {0, I_2,    G_2,    H_2},
+    {0, I_3,    G_3,    H_3},
+    {0, I_4,    G_4,    H_4},
+    {0, I_5,    G_5,    H_5},
+
+    {0, C_1,    A_1,    B_1},
+    {0, C_2,    A_2,    B_2},
+    {0, C_3,    A_3,    B_3},
+    {0, C_4,    A_4,    B_4},
+    {0, C_5,    A_5,    B_5},
+
+    {0, F_1,    D_1,    E_1},
+    {0, F_2,    D_2,    E_2},
+    {0, F_3,    D_3,    E_3},
+    {0, F_4,    D_4,    E_4},
+    {0, F_5,    D_5,    E_5},
+
+    {0, I_6,    G_6,    H_6},
+    {0, I_7,    G_7,    H_7},
+    {0, I_8,    G_8,    H_8},
+    {0, I_9,    G_9,    H_9},
+
+    {0, C_6,    A_6,    B_6},
+    {0, C_7,    A_7,    B_7},
+    {0, C_8,    A_8,    B_8},
+    {0, C_9,    A_9,    B_9},
+    {0, C_10,   A_10,   B_10},
+
+    {0, F_6,    D_6,    E_6},
+    {0, F_7,    D_7,    E_7},
+    {0, F_9,    D_9,    E_9},
+};
+
+#define __ NO_LED
+
+led_config_t g_led_config = {
+    {
+        // Key Matrix to LED Index
+        { __,  0,  1,  2,  3 },
+        {  4,  5,  6,  7,  8 },
+        {  9, 10, 11, 12, 13 },
+        { 14, 15, 16, 17, __ },
+        { 18, 19, 20, 21, 22 },
+        { 23, 24, __, 25, __ },
+    },
+    {
+        // LED Index to Physical Position
+                {56,0},  {112,0},  {168,0},  {224,0},
+        {0,15}, {56,15}, {112,15}, {168,15}, {224,15},
+        {0,27}, {56,27}, {112,27}, {168,27}, {224,34},
+        {0,40}, {56,40}, {112,40}, {168,40},
+        {0,52}, {56,52}, {112,52}, {168,52}, {224,58},
+        {0,64}, {84,64},           {168,64},
+    },
+    {
+        // LED Index to Flag
+           1, 1, 1, 1,
+        4, 8, 4, 4, 4,
+        4, 4, 4, 4, 4,
+        4, 4, 4, 4,
+        4, 4, 4, 4, 4,
+        4,    4, 1,
+    }
+};
+
+#endif // RGB_MATRIX_ENABLE
diff --git a/keyboards/keychron/q0/rev_0131/rules.mk b/keyboards/keychron/q0/rev_0131/rules.mk
new file mode 100644
index 0000000000..d5f04c34d2
--- /dev/null
+++ b/keyboards/keychron/q0/rev_0131/rules.mk
@@ -0,0 +1,21 @@
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+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
+NKRO_ENABLE = yes           # Enable USB N-key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+ENCODER_ENABLE = yes        # Enable encoder
+DIP_SWITCH_ENABLE = no
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = CKLED2001
+EEPROM_DRIVER = wear_leveling
+WEAR_LEVELING_DRIVER = embedded_flash
+
+# Enter lower-power sleep mode when on the ChibiOS idle thread
+OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE