[Keyboard] Add Kyria rev. 2 (#16178)

10 files changed, 382 insertions, 0 deletions

diff --git a/keyboards/splitkb/kyria/rev2/config.h b/keyboards/splitkb/kyria/rev2/config.h
new file mode 100644
index 0000000000..8ff3813964
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/config.h
@@ -0,0 +1,107 @@
+/*
+Copyright 2022 Thomas Baart <thomas@splitkb.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
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID    0x8D1D
+#define PRODUCT_ID   0x9D9D
+#define DEVICE_VER   0x0002
+#define MANUFACTURER splitkb
+#define PRODUCT      Kyria rev2
+
+/* key matrix size */
+/* Rows are doubled up */
+#define MATRIX_ROWS  8
+#define MATRIX_COLS  8
+
+// wiring
+#define MATRIX_ROW_PINS \
+    { F6, F7, B1, B3 }
+#define MATRIX_COL_PINS \
+    { B2, B6, B5, B4, E6, D7, C6, D4 }
+#define MATRIX_ROW_PINS_RIGHT \
+    { D4, C6, D7, E6 }
+#define MATRIX_COL_PINS_RIGHT \
+    { B4, B5, B6, B2, B3, B1, F7, F6 }
+#define UNUSED_PINS
+
+#define ENCODERS_PAD_A \
+    { F4 }
+#define ENCODERS_PAD_B \
+    { F5 }
+#define ENCODERS_PAD_A_RIGHT \
+    { F5 }
+#define ENCODERS_PAD_B_RIGHT \
+    { F4 }
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+// Side detection
+// col 4 row 3 on right-hand-side
+#define SPLIT_HAND_MATRIX_GRID E6, B3 // row first because the board is col2row
+#define SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT
+#define MATRIX_MASKED // actual mask is defined by `matrix_mask` in `rev2.c`
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE        5
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+
+#if defined(CONVERT_TO_PROTON_C)
+#    define SERIAL_USART_FULL_DUPLEX      // Enable full duplex operation mode.
+#    define SERIAL_USART_PIN_SWAP         // Swap TX and RX pins if keyboard is master halve.
+#    define SERIAL_USART_DRIVER      SD1  // USART driver of TX pin. default: SD1
+#    define SERIAL_USART_TX_PAL_MODE 7    // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
+#    define SERIAL_USART_TX_PIN      D3
+#    define SERIAL_USART_RX_PIN      D2
+
+#    define RGB_DI_PIN               PAL_LINE(GPIOA, 3)
+#    define WS2812_PWM_DRIVER        PWMD2                  // default: PWMD2
+#    define WS2812_PWM_CHANNEL       4                      // default: 2
+#    define WS2812_PWM_PAL_MODE      1                      // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2
+#    define WS2812_DMA_STREAM        STM32_DMA1_STREAM2     // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
+#    define WS2812_DMA_CHANNEL       2                      // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
+#    define WS2812_DMAMUX_ID         STM32_DMAMUX1_TIM2_UP  // DMAMUX configuration for TIMx_UP -- only required if your MCU has a DMAMUX peripheral, see the respective reference manual for the appropriate values for your MCU.
+#else
+#    define RGB_DI_PIN D3
+#    define SOFT_SERIAL_PIN D2
+#endif
+
+#define RGBLED_SPLIT \
+    { 10, 10 }
+#define RGBLED_NUM 20
+
+#ifdef OLED_ENABLE
+#    define OLED_DISPLAY_128X64
+#    define SPLIT_OLED_ENABLE
+#endif
+
+/* RGB matrix support */
+#ifdef RGB_MATRIX_ENABLE
+#    define SPLIT_TRANSPORT_MIRROR
+#    define DRIVER_LED_TOTAL RGBLED_NUM // Number of LEDs
+#    define RGB_MATRIX_SPLIT { 10, 10 }
+#    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 170
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED
+#endif
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/chconf.h b/keyboards/splitkb/kyria/rev2/proton_c/chconf.h
new file mode 100644
index 0000000000..7ca1d3d243
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/chconf.h
@@ -0,0 +1,22 @@
+/* Copyright 2020 QMK
+ *
+ * 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 CH_CFG_ST_RESOLUTION 16
+#define CH_CFG_ST_FREQUENCY  10000
+
+#include_next "chconf.h"
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/halconf.h b/keyboards/splitkb/kyria/rev2/proton_c/halconf.h
new file mode 100644
index 0000000000..99f2e11b9a
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/halconf.h
@@ -0,0 +1,22 @@
+/* Copyright 2020 QMK
+ *
+ *  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 3 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 <https://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#define HAL_USE_I2C    TRUE
+#define HAL_USE_PWM    TRUE
+#define HAL_USE_SERIAL TRUE
+
+#include_next <halconf.h>
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/mcuconf.h b/keyboards/splitkb/kyria/rev2/proton_c/mcuconf.h
new file mode 100644
index 0000000000..58348af390
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/mcuconf.h
@@ -0,0 +1,29 @@
+/* Copyright 2020 QMK
+ *
+ *  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 3 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 <https://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef STM32_PWM_USE_TIM2
+#define STM32_PWM_USE_TIM2 TRUE
+#undef STM32_PWM_USE_TIM3
+#define STM32_PWM_USE_TIM3 FALSE
+
+#undef STM32_SERIAL_USE_USART1
+#define STM32_SERIAL_USE_USART1 TRUE
+
+#undef STM32_ST_USE_TIMER
+#define STM32_ST_USE_TIMER 3
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/proton_c.c b/keyboards/splitkb/kyria/rev2/proton_c/proton_c.c
new file mode 100644
index 0000000000..9c74b45f77
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/proton_c.c
@@ -0,0 +1,17 @@
+/* Copyright 2022 Thomas Baart <thomas@splitkb.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 "proton_c.h"
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/proton_c.h b/keyboards/splitkb/kyria/rev2/proton_c/proton_c.h
new file mode 100644
index 0000000000..143b9e39dd
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/proton_c.h
@@ -0,0 +1,19 @@
+/* Copyright 2022 Thomas Baart <thomas@splitkb.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 "rev2.h"
diff --git a/keyboards/splitkb/kyria/rev2/proton_c/rules.mk b/keyboards/splitkb/kyria/rev2/proton_c/rules.mk
new file mode 100644
index 0000000000..1a5f9a7cb3
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/proton_c/rules.mk
@@ -0,0 +1,12 @@
+# MCU name
+MCU = STM32F303
+BOARD = QMK_PROTON_C
+
+# Bootloader selection
+BOOTLOADER = stm32-dfu
+
+WS2812_DRIVER = pwm
+SERIAL_DRIVER = usart
+AUDIO_ENABLE = no
+LTO_ENABLE = no
+CONVERT_TO_PROTON_C = yes
diff --git a/keyboards/splitkb/kyria/rev2/rev2.c b/keyboards/splitkb/kyria/rev2/rev2.c
new file mode 100644
index 0000000000..0a181cdf12
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/rev2.c
@@ -0,0 +1,76 @@
+/* Copyright 2022 Thomas Baart <thomas@splitkb.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 "rev2.h"
+
+// Mask out handedness diode to prevent it
+// from keeping the keyboard awake
+// - just mirroring `KC_NO` in the `LAYOUT`
+//   macro to keep it simple
+const matrix_row_t matrix_mask[] = {
+    0b11111100,
+    0b11111100,
+    0b11111111,
+    0b00101111,
+    0b11111100,
+    0b11111100,
+    0b11111111,
+    0b00101111,
+};
+
+#ifdef SWAP_HANDS_ENABLE
+// clang-format off
+__attribute__ ((weak)) const keypos_t PROGMEM hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {
+    {{0, 4}, {1, 4}, {2, 4}, {3, 4}, {4, 4}, {5, 4}, {6, 4}, {7, 4}},
+    {{0, 5}, {1, 5}, {2, 5}, {3, 5}, {4, 5}, {5, 5}, {6, 5}, {7, 5}},
+    {{0, 6}, {1, 6}, {2, 6}, {3, 6}, {4, 6}, {5, 6}, {6, 6}, {7, 6}},
+    {{0, 7}, {1, 7}, {2, 7}, {3, 7}, {4, 7}, {5, 7}, {6, 7}, {7, 7}},
+    {{0, 0}, {1, 0}, {2, 0}, {3, 0}, {4, 0}, {5, 0}, {6, 0}, {7, 0}},
+    {{0, 1}, {1, 1}, {2, 1}, {3, 1}, {4, 1}, {5, 1}, {6, 1}, {7, 1}},
+    {{0, 2}, {1, 2}, {2, 2}, {3, 2}, {4, 2}, {5, 2}, {6, 2}, {7, 2}},
+    {{0, 3}, {1, 3}, {2, 3}, {3, 3}, {4, 3}, {5, 3}, {6, 3}, {7, 3}}
+};
+// clang-format on
+#endif
+
+#ifdef RGB_MATRIX_ENABLE
+/* Map physical under glow LEDs for RGB matrix support
+ *  09, 02, xx, xx, 01, xx,                   xx, 11, xx, xx, 12, 19,
+ *  xx, xx, xx, xx, xx, 00,                   10, xx, xx, xx, xx, xx,
+ *  08, 03, 04, xx, xx, xx, 07, xx,   xx, 17, xx, xx, xx, 14, 13, 18,
+ *                  xx, 05, 06, xx,   xx, xx, xx, 16, 15, xx
+ */
+led_config_t g_led_config = { {
+    // Key Matrix to LED Index
+    { NO_LED, NO_LED, NO_LED, 1,      NO_LED, NO_LED, 2,      9     },
+    { NO_LED, NO_LED, 0,      NO_LED, NO_LED, NO_LED, NO_LED, NO_LED },
+    { NO_LED, 7,      NO_LED, NO_LED, NO_LED, 4,      3,      8      },
+    { NO_LED, NO_LED, 6,      5,      NO_LED, NO_LED, NO_LED, NO_LED },
+    { NO_LED, NO_LED, NO_LED, 11,     NO_LED, NO_LED, 12,     19     },
+    { NO_LED, NO_LED, 10,     NO_LED, NO_LED, NO_LED, NO_LED, NO_LED },
+    { NO_LED, 17,     NO_LED, NO_LED, NO_LED, 14,     13,     18     },
+    { NO_LED, NO_LED, 16,     15,     NO_LED, NO_LED, NO_LED, NO_LED },
+}, {
+    // LED Index to Physical Position
+    {77,24}, {63,8}, {21,8}, {21,40}, {35,40}, {63,56}, {77,56}, {91,40}, {7,40}, {7,8},
+    {147,24}, {161,8}, {203,8}, {203,40}, {189,40}, {161,56}, {147,56}, {133,40}, {217,40}, {217,8}
+}, {
+    // LED Index to Flag
+    LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL,
+    LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL,
+    LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL,
+    LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL, LED_FLAG_ALL
+} };
+#endif
diff --git a/keyboards/splitkb/kyria/rev2/rev2.h b/keyboards/splitkb/kyria/rev2/rev2.h
new file mode 100644
index 0000000000..ed4169b0ed
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/rev2.h
@@ -0,0 +1,70 @@
+/* Copyright 2022 Thomas Baart <thomas@splitkb.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 "kyria.h"
+#ifdef KEYBOARD_splitkb_kyria_rev2_proton_c
+#    include "proton_c.h"
+#endif
+
+/* This a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+    L00, L01, L02, L03, L04, L05,                     R06, R07, R08, R09, R10, R11, \
+    L12, L13, L14, L15, L16, L17,                     R18, R19, R20, R21, R22, R23, \
+    L24, L25, L26, L27, L28, L29, L30, L31, R32, R33, R34, R35, R36, R37, R38, R39, \
+                   L40, L41, L42, L43, L44, R45, R46, R47, R48, R49 \
+) \
+{ \
+    { KC_NO, KC_NO, L05,   L04,   L03,   L02,   L01,   L00   }, \
+    { KC_NO, KC_NO, L17,   L16,   L15,   L14,   L13,   L12   }, \
+    { L31,   L30,   L29,   L28,   L27,   L26,   L25,   L24   }, \
+    { L44,   L43,   L42,   L41,   KC_NO, L40,   KC_NO, KC_NO }, \
+    { KC_NO, KC_NO, R06,   R07,   R08,   R09,   R10,   R11   }, \
+    { KC_NO, KC_NO, R18,   R19,   R20,   R21,   R22,   R23   }, \
+    { R32,   R33,   R34,   R35,   R36,   R37,   R38,   R39   }, \
+    { R45,   R46,   R47,   R48,   KC_NO, R49,   KC_NO, KC_NO }, \
+}
+
+#define LAYOUT_stack(                               \
+    L00, L01, L02, L03, L04, L05,                   \
+    L12, L13, L14, L15, L16, L17,                   \
+    L24, L25, L26, L27, L28, L29, L30, L31,         \
+                   L40, L41, L42, L43, L44,         \
+                                                    \
+                  R06, R07, R08, R09, R10, R11,     \
+                  R18, R19, R20, R21, R22, R23,     \
+        R32, R33, R34, R35, R36, R37, R38, R39,     \
+        R45, R46, R47, R48, R49                     \
+)                                               \
+{                                               \
+    { KC_NO, KC_NO, L05,   L04,   L03,   L02,   L01,   L00   }, \
+    { KC_NO, KC_NO, L17,   L16,   L15,   L14,   L13,   L12   }, \
+    { L31,   L30,   L29,   L28,   L27,   L26,   L25,   L24   }, \
+    { L44,   L43,   L42,   L41,   KC_NO, L40,   KC_NO, KC_NO }, \
+    { KC_NO, KC_NO, R06,   R07,   R08,   R09,   R10,   R11   }, \
+    { KC_NO, KC_NO, R18,   R19,   R20,   R21,   R22,   R23   }, \
+    { R32,   R33,   R34,   R35,   R36,   R37,   R38,   R39   }, \
+    { R45,   R46,   R47,   R48,   KC_NO, R49,   KC_NO, KC_NO }, \
+}
+
+#define LAYOUT_split_3x6_5 LAYOUT
diff --git a/keyboards/splitkb/kyria/rev2/rules.mk b/keyboards/splitkb/kyria/rev2/rules.mk
new file mode 100644
index 0000000000..355c12024f
--- /dev/null
+++ b/keyboards/splitkb/kyria/rev2/rules.mk
@@ -0,0 +1,8 @@
+OLED_ENABLE = yes
+OLED_DRIVER = SSD1306   # Enables the use of OLED displays
+ENCODER_ENABLE = yes       # Enables the use of one or more encoders
+RGBLIGHT_ENABLE = yes      # Enable keyboard RGB underglow
+RGB_MATRIX_ENABLE = no     # Enable keyboard RGB matrix (do not use together with RGBLIGHT_ENABLE)
+RGB_MATRIX_DRIVER = WS2812 # RGB matrix driver support
+
+RGB_MATRIX_SUPPORTED = yes