Keychron q3 (#16912)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Cesar Rojas <cesar.fieoner@gmail.com>
Co-authored-by: lokher <lokher@gmail.com>
Co-authored-by: Adam Karim <adam@akarsoft.com>
Co-authored-by: bootstrapper <ido.samuelson@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

76 files changed, 3870 insertions, 0 deletions

diff --git a/keyboards/keychron/q3/ansi/ansi.c b/keyboards/keychron/q3/ansi/ansi.c
new file mode 100644
index 0000000000..46ebe44144
--- /dev/null
+++ b/keyboards/keychron/q3/ansi/ansi.c
@@ -0,0 +1,154 @@
+/* Copyright 2022 @ 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 "ansi.h"
+
+#ifdef RGB_MATRIX_ENABLE
+
+const ckled2001_led PROGMEM g_ckled2001_leds[DRIVER_LED_TOTAL] = {
+/* Refer to IS31 manual for these locations
+ *   driver
+ *   |  R location
+ *   |  |       G location
+ *   |  |       |       B location
+ *   |  |       |       | */
+    {0, I_1,    G_1,    H_1},
+    {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, 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, I_10,   G_10,   H_10},
+    {0, I_11,   G_11,   H_11},
+    {0, I_12,   G_12,   H_12},
+    {0, I_13,   G_13,   H_13},
+    {0, I_15,   G_15,   H_15},
+    {0, I_16,   G_16,   H_16},
+    {1, I_15,   G_15,   H_15},
+
+    {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, 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, C_11,   A_11,   B_11},
+    {0, C_12,   A_12,   B_12},
+    {0, C_13,   A_13,   B_13},
+    {0, C_14,   A_14,   B_14},
+    {0, C_15,   A_15,   B_15},
+    {0, C_16,   A_16,   B_16},
+    {1, I_16,   G_16,   H_16},
+
+    {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, F_6,    D_6,    E_6},
+    {0, F_7,    D_7,    E_7},
+    {0, F_8,    D_8,    E_8},
+    {0, F_9,    D_9,    E_9},
+    {0, F_10,   D_10,   E_10},
+    {0, F_11,   D_11,   E_11},
+    {0, F_12,   D_12,   E_12},
+    {0, F_13,   D_13,   E_13},
+    {0, F_14,   D_14,   E_14},
+    {0, F_15,   D_15,   E_15},
+    {0, F_16,   D_16,   E_16},
+    {1, I_13,   G_13,   H_13},
+
+    {1, I_1,    G_1,    H_1},
+    {1, I_2,    G_2,    H_2},
+    {1, I_3,    G_3,    H_3},
+    {1, I_4,    G_4,    H_4},
+    {1, I_5,    G_5,    H_5},
+    {1, I_6,    G_6,    H_6},
+    {1, I_7,    G_7,    H_7},
+    {1, I_8,    G_8,    H_8},
+    {1, I_9,    G_9,    H_9},
+    {1, I_10,   G_10,   H_10},
+    {1, I_11,   G_11,   H_11},
+    {1, I_12,   G_12,   H_12},
+    {1, I_14,   G_14,   H_14},
+
+    {1, C_1,    A_1,    B_1},
+    {1, C_3,    A_3,    B_3},
+    {1, C_4,    A_4,    B_4},
+    {1, C_5,    A_5,    B_5},
+    {1, C_6,    A_6,    B_6},
+    {1, C_7,    A_7,    B_7},
+    {1, C_8,    A_8,    B_8},
+    {1, C_9,    A_9,    B_9},
+    {1, C_10,   A_10,   B_10},
+    {1, C_11,   A_11,   B_11},
+    {1, C_12,   A_12,   B_12},
+    {1, C_14,   A_14,   B_14},
+    {1, C_16,   A_16,   B_16},
+
+    {1, F_1,    D_1,    E_1},
+    {1, F_2,    D_2,    E_2},
+    {1, F_3,    D_3,    E_3},
+    {1, F_7,    D_7,    E_7},
+    {1, F_11,   D_11,   E_11},
+    {1, F_12,   D_12,   E_12},
+    {1, F_13,   D_13,   E_13},
+    {1, F_14,   D_14,   E_14},
+    {1, F_15,   D_15,   E_15},
+    {1, F_16,   D_16,   E_16},
+    {1, C_15,   A_15,   B_15},
+};
+
+#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 },
+        { 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 },
+        { 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48 },
+        { 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 49, 62, 15, 32 },
+        { 63, __, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, __, 74, 86, 75 },
+        { 76, 77, 78, __, __, __, 79, __, __, __, 80, 81, 82, 83, 84, 85 },
+    },
+    {
+        // LED Index to Physical Position
+        {0,0},           {26,0},  {39,0},  {52,0},  {65,0},  {85,0},  {98,0},   {111,0},  {124,0},  {143,0},  {156,0},  {169,0},  {182,0},  {198,0},  {211,0},  {224,0},
+        {0,15}, {13,15}, {26,15}, {39,15}, {52,15}, {65,15}, {78,15}, {91,15},  {104,15}, {117,15}, {130,15}, {143,15}, {156,15}, {176,15}, {198,15}, {211,15}, {224,15},
+        {3,28}, {20,28}, {33,28}, {46,28}, {59,28}, {72,28}, {85,28}, {98,28},  {111,28}, {124,28}, {137,28}, {150,28}, {163,28}, {179,28}, {198,28}, {211,28}, {224,28},
+        {5,40}, {23,40}, {36,40}, {49,40}, {62,40}, {75,40}, {88,40}, {101,40}, {114,40}, {127,40}, {140,40}, {153,40},           {174,40},
+        {8,52},          {29,52}, {42,52}, {55,52}, {68,52}, {81,52}, {94,52},  {107,52}, {120,52}, {133,52}, {146,52},           {171,52},           {211,52},
+        {2,64}, {18,64}, {34,64},                            {83,64},                               {131,64}, {148,64}, {164,64}, {180,64}, {198,64}, {211,64}, {224,64},
+    },
+    {
+        // RGB LED Index to Flag
+        1,    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+        1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1, 1, 1,
+        1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1, 1,
+        8, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,
+        1,    4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,    1,
+        1, 1, 1,          4,          1, 1, 1, 1, 1, 1, 1,
+    }
+};
+
+#endif // RGB_MATRIX_ENABLE
diff --git a/keyboards/keychron/q3/ansi/ansi.h b/keyboards/keychron/q3/ansi/ansi.h
new file mode 100644
index 0000000000..de5b0aedb1
--- /dev/null
+++ b/keyboards/keychron/q3/ansi/ansi.h
@@ -0,0 +1,19 @@
+/* Copyright 2022 @ 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
+
+#include "quantum.h"
diff --git a/keyboards/keychron/q3/ansi/config.h b/keyboards/keychron/q3/ansi/config.h
new file mode 100644
index 0000000000..8535f02cc2
--- /dev/null
+++ b/keyboards/keychron/q3/ansi/config.h
@@ -0,0 +1,36 @@
+/* Copyright 2022 @ 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, A3, A4, A5, A6, A7, B0, B1, A8, A9, A10, H3 }
+
+/* We uses a pin with a stronger pull resistor than the internal MCU pins */
+// #define MATRIX_UNSELECT_DRIVE_HIGH
+
+/* RGB Matrix Configuration */
+#define DRIVER_1_LED_TOTAL 48
+#define DRIVER_2_LED_TOTAL 39
+#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+
+#define CKLED2001_CURRENT_TUNE \
+    { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
+
+/* Enable CapsLcok LED */
+#define CAPS_LOCK_LED_INDEX 50
+
diff --git a/keyboards/keychron/q3/ansi/info.json b/keyboards/keychron/q3/ansi/info.json
new file mode 100644
index 0000000000..83be45fc23
--- /dev/null
+++ b/keyboards/keychron/q3/ansi/info.json
@@ -0,0 +1,109 @@
+{
+    "keyboard_name": "Keychron Q3",
+    "manufacturer": "Keychron",
+    "url": "https://github.com/Keychron",
+    "maintainer": "lalalademaxiya1",
+    "usb": {
+        "vid": "0x3434",
+        "pid": "0x0120",
+        "device_version": "1.0.0"
+    },
+    "layouts": {
+        "LAYOUT_ansi_87": {
+            "layout": [
+                {"matrix":[0, 0], "x":0, "y":0},
+                {"matrix":[0, 1], "x":2, "y":0},
+                {"matrix":[0, 2], "x":3, "y":0},
+                {"matrix":[0, 3], "x":4, "y":0},
+                {"matrix":[0, 4], "x":5, "y":0},
+                {"matrix":[0, 5], "x":6.5, "y":0},
+                {"matrix":[0, 6], "x":7.5, "y":0},
+                {"matrix":[0, 7], "x":8.5, "y":0},
+                {"matrix":[0, 8], "x":9.5, "y":0},
+                {"matrix":[0, 9], "x":11, "y":0},
+                {"matrix":[0,10], "x":12, "y":0},
+                {"matrix":[0,11], "x":13, "y":0},
+                {"matrix":[0,12], "x":14, "y":0},
+                {"matrix":[0,14], "x":15.25, "y":0},
+                {"matrix":[0,15], "x":16.25, "y":0},
+                {"matrix":[3,14], "x":17.25, "y":0},
+
+                {"matrix":[1, 0], "x":0, "y":1.25},
+                {"matrix":[1, 1], "x":1, "y":1.25},
+                {"matrix":[1, 2], "x":2, "y":1.25},
+                {"matrix":[1, 3], "x":3, "y":1.25},
+                {"matrix":[1, 4], "x":4, "y":1.25},
+                {"matrix":[1, 5], "x":5, "y":1.25},
+                {"matrix":[1, 6], "x":6, "y":1.25},
+                {"matrix":[1, 7], "x":7, "y":1.25},
+                {"matrix":[1, 8], "x":8, "y":1.25},
+                {"matrix":[1, 9], "x":9, "y":1.25},
+                {"matrix":[1,10], "x":10, "y":1.25},
+                {"matrix":[1,11], "x":11, "y":1.25},
+                {"matrix":[1,12], "x":12, "y":1.25},
+                {"matrix":[1,13], "x":13, "y":1.25, "w":2},
+                {"matrix":[1,14], "x":15.25, "y":1.25},
+                {"matrix":[1,15], "x":16.25, "y":1.25},
+                {"matrix":[3,15], "x":17.25, "y":1.25},
+
+                {"matrix":[2, 0], "x":0, "y":2.25, "w":1.5},
+                {"matrix":[2, 1], "x":1.5, "y":2.25},
+                {"matrix":[2, 2], "x":2.5, "y":2.25},
+                {"matrix":[2, 3], "x":3.5, "y":2.25},
+                {"matrix":[2, 4], "x":4.5, "y":2.25},
+                {"matrix":[2, 5], "x":5.5, "y":2.25},
+                {"matrix":[2, 6], "x":6.5, "y":2.25},
+                {"matrix":[2, 7], "x":7.5, "y":2.25},
+                {"matrix":[2, 8], "x":8.5, "y":2.25},
+                {"matrix":[2, 9], "x":9.5, "y":2.25},
+                {"matrix":[2,10], "x":10.5, "y":2.25},
+                {"matrix":[2,11], "x":11.5, "y":2.25},
+                {"matrix":[2,12], "x":12.5, "y":2.25},
+                {"matrix":[2,13], "x":13.5, "y":2.25, "w":1.5},
+                {"matrix":[2,14], "x":15.25, "y":2.25},
+                {"matrix":[2,15], "x":16.25, "y":2.25},
+                {"matrix":[3,12], "x":17.25, "y":2.25},
+
+                {"matrix":[3, 0], "x":0, "y":3.25, "w":1.75},
+                {"matrix":[3, 1], "x":1.75, "y":3.25},
+                {"matrix":[3, 2], "x":2.75, "y":3.25},
+                {"matrix":[3, 3], "x":3.75, "y":3.25},
+                {"matrix":[3, 4], "x":4.75, "y":3.25},
+                {"matrix":[3, 5], "x":5.75, "y":3.25},
+                {"matrix":[3, 6], "x":6.75, "y":3.25},
+                {"matrix":[3, 7], "x":7.75, "y":3.25},
+                {"matrix":[3, 8], "x":8.75, "y":3.25},
+                {"matrix":[3, 9], "x":9.75, "y":3.25},
+                {"matrix":[3,10], "x":10.75, "y":3.25},
+                {"matrix":[3,11], "x":11.75, "y":3.25},
+                {"matrix":[3,13], "x":12.75, "y":3.25, "w":2.25},
+
+                {"matrix":[4, 0], "x":0, "y":4.25, "w":2.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},
+                {"matrix":[4, 5], "x":5.25, "y":4.25},
+                {"matrix":[4, 6], "x":6.25, "y":4.25},
+                {"matrix":[4, 7], "x":7.25, "y":4.25},
+                {"matrix":[4, 8], "x":8.25, "y":4.25},
+                {"matrix":[4, 9], "x":9.25, "y":4.25},
+                {"matrix":[4,10], "x":10.25, "y":4.25},
+                {"matrix":[4,11], "x":11.25, "y":4.25},
+                {"matrix":[4,13], "x":12.25, "y":4.25, "w":2.75},
+                {"matrix":[4,15], "x":16.25, "y":4.25},
+
+                {"matrix":[5, 0], "x":0, "y":5.25, "w":1.25},
+                {"matrix":[5, 1], "x":1.25, "y":5.25, "w":1.25},
+                {"matrix":[5, 2], "x":2.5, "y":5.25, "w":1.25},
+                {"matrix":[5, 6], "x":3.75, "y":5.25, "w":6.25},
+                {"matrix":[5,10], "x":10, "y":5.25, "w":1.25},
+                {"matrix":[5,11], "x":11.25, "y":5.25, "w":1.25},
+                {"matrix":[5,12], "x":12.5, "y":5.25, "w":1.25},
+                {"matrix":[5,13], "x":13.75, "y":5.25, "w":1.25},
+                {"matrix":[5,14], "x":15.25, "y":5.25},
+                {"matrix":[5,15], "x":16.25, "y":5.25},
+                {"matrix":[4,14], "x":17.25, "y":5.25}
+            ]
+        }
+    }
+}
diff --git a/keyboards/keychron/q3/ansi/keymaps/default/keymap.c b/keyboards/keychron/q3/ansi/keymaps/default/keymap.c
new file mode 100644
index 0000000000..a2cad2d8c9
--- /dev/null
+++ b/keyboards/keychron/q3/ansi/keymaps/default/keymap.c
@@ -0,0 +1,58 @@
+/* Copyright 2022 @ 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
+
+enum layers{
+    MAC_BASE,
+    MAC_FN,
+    WIN_BASE,
+    WIN_FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [MAC_BASE] = LAYOUT_ansi_87(
+        KC_ESC,             KC_BRID,  KC_BRIU,  KC_NO,    KC_NO,    RGB_VAD,  RGB_VAI,  KC_MPRV,  KC_MPLY,  KC_MNXT,  KC_MUTE,  KC_VOLD,    KC_VOLU,  KC_NO,    KC_NO,    RGB_MOD,
+        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_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_BSLS,  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,