GMMK Pro RGB Support (#13147)

* Enable SPI1 for GMMK pro

* Setup initial boilerplate for new LED driver

* RGB matrix minimally functional

* Map full LED matrix

* Return keymap to default

* Fix printscreen LED mapping

* Reduce max brightness

* Default values for AW20216

* Add documentation for AW20216

* Disable console and warnings

* Run cformat

* Update drivers/awinic/aw20216.h

Co-authored-by: Drashna Jaelre <drashna@live.com>

* make aw struct match issi struct

Co-authored-by: Drashna Jaelre <drashna@live.com>

* add led location defines

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Use led pin definitions in keyboard.c

* Add driver indices to led map

* Fix elif typo

* Run cformat

* Update docs

* Fix typo in docs

* Document global brightness limits

Co-authored-by: Drashna Jaelre <drashna@live.com>

common_features.mk

@@ -244,7 +244,7 @@ endif
 endif
 
 RGB_MATRIX_ENABLE ?= no
-VALID_RGB_MATRIX_TYPES := IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
+VALID_RGB_MATRIX_TYPES := AW20216 IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
 
 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
@@ -261,6 +261,13 @@ endif
     CIE1931_CURVE := yes
     RGB_KEYCODES_ENABLE := yes
 
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), AW20216)
+        OPT_DEFS += -DAW20216 -DSTM32_SPI -DHAL_USE_SPI=TRUE
+        COMMON_VPATH += $(DRIVER_PATH)/awinic
+        SRC += aw20216.c
+        QUANTUM_LIB_SRC += spi_master.c
+    endif
+
     ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3731)
         OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
         COMMON_VPATH += $(DRIVER_PATH)/issi

docs/feature_rgb_matrix.md

@@ -227,6 +227,74 @@ Configure the hardware via your `config.h`:
 #define DRIVER_LED_TOTAL 70
 ```
 
+---
+### AW20216 :id=aw20216
+There is basic support for addressable RGB matrix lighting with the SPI AW20216 RGB controller. To enable it, add this to your `rules.mk`:
+
+```makefile
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = AW20216
+```
+
+You can use up to 2 AW20216 IC's. Do not specify `DRIVER_<N>_xxx` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `DRIVER_1_CS` | (Required) MCU pin connected to first RGB driver chip select line  | B13 |
+| `DRIVER_2_CS` | (Optional) MCU pin connected to second RGB driver chip select line  | |
+| `DRIVER_1_EN` | (Required) MCU pin connected to first RGB driver hardware enable line  | C13 |
+| `DRIVER_2_EN` | (Optional) MCU pin connected to second RGB driver hardware enable line  | |
+| `DRIVER_1_LED_TOTAL` | (Required) How many RGB lights are connected to first RGB driver  | |
+| `DRIVER_2_LED_TOTAL` | (Optional) How many RGB lights are connected to second RGB driver  | |
+| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
+| `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | |
+| `AW_SCALING_MAX` | (Optional) LED current scaling value (0-255, higher values mean LED is brighter at full PWM) | 150 |
+| `AW_GLOBAL_CURRENT_MAX` | (Optional) Driver global current limit (0-255, higher values means the driver may consume more power) | 150 |
+
+Here is an example using 2 drivers.
+
+```c
+#define DRIVER_1_CS B13
+#define DRIVER_2_CS B14
+// Hardware enable lines may be connected to the same pin
+#define DRIVER_1_EN C13
+#define DRIVER_2_EN C13
+
+#define DRIVER_COUNT 2
+#define DRIVER_1_LED_TOTAL 66
+#define DRIVER_2_LED_TOTAL 32
+#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+```
+
+!> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
+
+Define these arrays listing all the LEDs in your `<keyboard>.c`:
+
+```c
+const aw_led g_aw_leds[DRIVER_LED_TOTAL] = {
+/* Each AW20216 channel is controlled by a register at some offset between 0x00
+ * and 0xD7 inclusive.
+ * See drivers/awinic/aw20216.h for the mapping between register offsets and
+ * driver pin locations.
+ *    driver
+ *    |  R location
+ *    |  |        G location
+ *    |  |        |        B location
+ *    |  |        |        | */
+    { 0, CS1_SW1, CS2_SW1, CS3_SW1 },
+    { 0, CS4_SW1, CS5_SW1, CS6_SW1 },
+    { 0, CS7_SW1, CS8_SW1, CS9_SW1 },
+    { 0, CS10_SW1, CS11_SW1, CS12_SW1 },
+    { 0, CS13_SW1, CS14_SW1, CS15_SW1 },
+    ...
+    { 1, CS1_SW1, CS2_SW1, CS3_SW1 },
+    { 1, CS13_SW1, CS14_SW1, CS15_SW1 },
+    { 1, CS16_SW1, CS17_SW1, CS18_SW1 },
+    { 1, CS4_SW2, CS5_SW2, CS6_SW2 },
+    ...
+};
+```
+
 ---
 
 From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:

drivers/awinic/aw20216.c

@@ -0,0 +1,166 @@
+/* Copyright 2021 Jasper Chan
+ *
+ * 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 "aw20216.h"
+#include "spi_master.h"
+
+/* The AW20216 appears to be somewhat similar to the IS31FL743, although quite
+ * a few things are different, such as the command byte format and page ordering.
+ * The LED addresses start from 0x00 instead of 0x01.
+ */
+#define AWINIC_ID 0b1010 << 4
+
+#define AW_PAGE_FUNCTION 0x00 << 1    // PG0, Function registers
+#define AW_PAGE_PWM 0x01 << 1         // PG1, LED PWM control
+#define AW_PAGE_SCALING 0x02 << 1     // PG2, LED current scaling control
+#define AW_PAGE_PATCHOICE 0x03 << 1   // PG3, Pattern choice?
+#define AW_PAGE_PWMSCALING 0x04 << 1  // PG4, LED PWM + Scaling control?
+
+#define AW_WRITE 0
+#define AW_READ 1
+
+#define AW_REG_CONFIGURATION 0x00  // PG0
+#define AW_REG_GLOBALCURRENT 0x01  // PG0
+
+// Default value of AW_REG_CONFIGURATION
+// D7:D4 = 1011, SWSEL (SW1~SW12 active)
+// D3 = 0?, reserved (apparently this should be 1 but it doesn't seem to matter)
+// D2:D1 = 00, OSDE (open/short detection enable)
+// D0 = 0, CHIPEN (write 1 to enable LEDs when hardware enable pulled high)
+#define AW_CONFIG_DEFAULT 0b10110000
+#define AW_CHIPEN 1
+
+#ifndef AW_SCALING_MAX
+#    define AW_SCALING_MAX 150
+#endif
+
+#ifndef AW_GLOBAL_CURRENT_MAX
+#    define AW_GLOBAL_CURRENT_MAX 150
+#endif
+
+#ifndef DRIVER_1_CS
+#    define DRIVER_1_CS B13
+#endif
+
+#ifndef DRIVER_1_EN
+#    define DRIVER_1_EN C13
+#endif
+
+uint8_t g_spi_transfer_buffer[20] = {0};
+aw_led  g_pwm_buffer[DRIVER_LED_TOTAL];
+bool    g_pwm_buffer_update_required[DRIVER_LED_TOTAL];
+
+bool AW20216_write_register(pin_t slave_pin, uint8_t page, uint8_t reg, uint8_t data) {
+    // Do we need to call spi_stop() if this fails?
+    if (!spi_start(slave_pin, false, 0, 16)) {
+        return false;
+    }
+
+    g_spi_transfer_buffer[0] = (AWINIC_ID | page | AW_WRITE);
+    g_spi_transfer_buffer[1] = reg;
+    g_spi_transfer_buffer[2] = data;
+
+    if (spi_transmit(g_spi_transfer_buffer, 3) != SPI_STATUS_SUCCESS) {
+        spi_stop();
+        return false;
+    }
+    spi_stop();
+    return true;
+}
+
+bool AW20216_init_scaling(void) {
+    // Set constant current to the max, control brightness with PWM
+    aw_led led;
+    for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
+        led = g_aw_leds[i];
+        if (led.driver == 0) {
+            AW20216_write_register(DRIVER_1_CS, AW_PAGE_SCALING, led.r, AW_SCALING_MAX);
+            AW20216_write_register(DRIVER_1_CS, AW_PAGE_SCALING, led.g, AW_SCALING_MAX);
+            AW20216_write_register(DRIVER_1_CS, AW_PAGE_SCALING, led.b, AW_SCALING_MAX);
+        }
+#ifdef DRIVER_2_CS
+        else if (led.driver == 1) {
+            AW20216_write_register(DRIVER_2_CS, AW_PAGE_SCALING, led.r, AW_SCALING_MAX);
+            AW20216_write_register(DRIVER_2_CS, AW_PAGE_SCALING, led.g, AW_SCALING_MAX);
+            AW20216_write_register(DRIVER_2_CS, AW_PAGE_SCALING, led.b, AW_SCALING_MAX);
+        }
+#endif
+    }
+    return true;
+}
+
+bool AW20216_soft_enable(void) {
+    AW20216_write_register(DRIVER_1_CS, AW_PAGE_FUNCTION, AW_REG_CONFIGURATION, AW_CONFIG_DEFAULT | AW_CHIPEN);
+#ifdef DRIVER_2_CS
+    AW20216_write_register(DRIVER_2_CS, AW_PAGE_FUNCTION, AW_REG_CONFIGURATION, AW_CONFIG_DEFAULT | AW_CHIPEN);
+#endif
+    return true;
+}
+
+void AW20216_update_pwm(int index, uint8_t red, uint8_t green, uint8_t blue) {
+    aw_led led = g_aw_leds[index];
+    if (led.driver == 0) {
+        AW20216_write_register(DRIVER_1_CS, AW_PAGE_PWM, led.r, red);
+        AW20216_write_register(DRIVER_1_CS, AW_PAGE_PWM, led.g, green);
+        AW20216_write_register(DRIVER_1_CS, AW_PAGE_PWM, led.b, blue);
+    }
+#ifdef DRIVER_2_CS
+    else if (led.driver == 1) {
+        AW20216_write_register(DRIVER_2_CS, AW_PAGE_PWM, led.r, red);
+        AW20216_write_register(DRIVER_2_CS, AW_PAGE_PWM, led.g, green);
+        AW20216_write_register(DRIVER_2_CS, AW_PAGE_PWM, led.b, blue);
+    }
+#endif
+    return;
+}
+
+void AW20216_init(void) {
+    // All LEDs should start with all scaling and PWM registers as off
+    setPinOutput(DRIVER_1_EN);
+    writePinHigh(DRIVER_1_EN);
+    AW20216_write_register(DRIVER_1_CS, AW_PAGE_FUNCTION, AW_REG_GLOBALCURRENT, AW_GLOBAL_CURRENT_MAX);
+#ifdef DRIVER_2_EN
+    setPinOutput(DRIVER_2_EN);
+    writePinHigh(DRIVER_2_EN);
+    AW20216_write_register(DRIVER_2_CS, AW_PAGE_FUNCTION, AW_REG_GLOBALCURRENT, AW_GLOBAL_CURRENT_MAX);
+#endif
+    AW20216_init_scaling();
+    AW20216_soft_enable();
+    return;
+}
+
+void AW20216_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
+    g_pwm_buffer[index].r               = red;
+    g_pwm_buffer[index].g               = green;
+    g_pwm_buffer[index].b               = blue;
+    g_pwm_buffer_update_required[index] = true;
+    return;
+}
+void AW20216_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
+        AW20216_set_color(i, red, green, blue);
+    }
+    return;
+}
+void AW20216_update_pwm_buffers(void) {
+    for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
+        if (g_pwm_buffer_update_required[i]) {
+            AW20216_update_pwm(i, g_pwm_buffer[i].r, g_pwm_buffer[i].g, g_pwm_buffer[i].b);
+            g_pwm_buffer_update_required[i] = false;
+        }
+    }
+    return;
+}

drivers/awinic/aw20216.h

@@ -0,0 +1,251 @@
+/* Copyright 2021 Jasper Chan (Gigahawk)
+ *
+ * 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 <stdint.h>
+#include <stdbool.h>
+
+typedef struct aw_led {
+    uint8_t driver : 2;
+    uint8_t r;
+    uint8_t g;
+    uint8_t b;
+} aw_led;
+
+extern const aw_led g_aw_leds[DRIVER_LED_TOTAL];
+
+void AW20216_init(void);
+void AW20216_set_color(int index, uint8_t red, uint8_t green, uint8_t blue);
+void AW20216_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
+void AW20216_update_pwm_buffers(void);
+
+#define CS1_SW1 0x00
+#define CS2_SW1 0x01
+#define CS3_SW1 0x02
+#define CS4_SW1 0x03
+#define CS5_SW1 0x04
+#define CS6_SW1 0x05
+#define CS7_SW1 0x06
+#define CS8_SW1 0x07
+#define CS9_SW1 0x08
+#define CS10_SW1 0x09
+#define CS11_SW1 0x0A
+#define CS12_SW1 0x0B
+#define CS13_SW1 0x0C
+#define CS14_SW1 0x0D
+#define CS15_SW1 0x0E
+#define CS16_SW1 0x0F
+#define CS17_SW1 0x10
+#define CS18_SW1 0x11
+#define CS1_SW2 0x12
+#define CS2_SW2 0x13
+#define CS3_SW2 0x14
+#define CS4_SW2 0x15
+#define CS5_SW2 0x16
+#define CS6_SW2 0x17
+#define CS7_SW2 0x18
+#define CS8_SW2 0x19
+#define CS9_SW2 0x1A
+#define CS10_SW2 0x1B
+#define CS11_SW2 0x1C
+#define CS12_SW2 0x1D
+#define CS13_SW2 0x1E
+#define CS14_SW2 0x1F
+#define CS15_SW2 0x20
+#define CS16_SW2 0x21
+#define CS17_SW2 0x22
+#define CS18_SW2 0x23
+#define CS1_SW3 0x24
+#define CS2_SW3 0x25
+#define CS3_SW3 0x26
+#define CS4_SW3 0x27
+#define CS5_SW3 0x28
+#define CS6_SW3 0x29
+#define CS7_SW3 0x2A
+#define CS8_SW3 0x2B
+#define CS9_SW3 0x2C
+#define CS10_SW3 0x2D
+#define CS11_SW3 0x2E
+#define CS12_SW3 0x2F
+#define CS13_SW3 0x30
+#define CS14_SW3 0x31
+#define CS15_SW3 0x32
+#define CS16_SW3 0x33
+#define CS17_SW3 0x34
+#define CS18_SW3 0x35
+#define CS1_SW4 0x36
+#define CS2_SW4 0x37
+#define CS3_SW4 0x38
+#define CS4_SW4 0x39
+#define CS5_SW4 0x3A
+#define CS6_SW4 0x3B
+#define CS7_SW4 0x3C
+#define CS8_SW4 0x3D
+#define CS9_SW4 0x3E
+#define CS10_SW4 0x3F
+#define CS11_SW4 0x40
+#define CS12_SW4 0x41
+#define CS13_SW4 0x42
+#define CS14_SW4 0x43
+#define CS15_SW4 0x44
+#define CS16_SW4 0x45
+#define CS17_SW4 0x46
+#define CS18_SW4 0x47
+#define CS1_SW5 0x48
+#define CS2_SW5 0x49
+#define CS3_SW5 0x4A
+#define CS4_SW5 0x4B
+#define CS5_SW5 0x4C
+#define CS6_SW5 0x4D
+#define CS7_SW5 0x4E
+#define CS8_SW5 0x4F
+#define CS9_SW5 0x50
+#define CS10_SW5 0x51
+#define CS11_SW5 0x52
+#define CS12_SW5 0x53
+#define CS13_SW5 0x54
+#define CS14_SW5 0x55
+#define CS15_SW5 0x56
+#define CS16_SW5 0x57
+#define CS17_SW5 0x58
+#define CS18_SW5 0x59
+#define CS1_SW6 0x5A
+#define CS2_SW6 0x5B
+#define CS3_SW6 0x5C
+#define CS4_SW6 0x5D
+#define CS5_SW6 0x5E
+#define CS6_SW6 0x5F
+#define CS7_SW6 0x60
+#define CS8_SW6 0x61
+#define CS9_SW6 0x62
+#define CS10_SW6 0x63
+#define CS11_SW6 0x64
+#define CS12_SW6 0x65
+#define CS13_SW6 0x66
+#define CS14_SW6 0x67
+#define CS15_SW6 0x68
+#define CS16_SW6 0x69
+#define CS17_SW6 0x6A
+#define CS18_SW6 0x6B
+#define CS1_SW7 0x6C
+#define CS2_SW7 0x6D
+#define CS3_SW7 0x6E
+#define CS4_SW7 0x6F
+#define CS5_SW7 0x70
+#define CS6_SW7 0x71
+#define CS7_SW7 0x72
+#define CS8_SW7 0x73
+#define CS9_SW7 0x74
+#define CS10_SW7 0x75
+#define CS11_SW7 0x76
+#define CS12_SW7 0x77
+#define CS13_SW7 0x78
+#define CS14_SW7 0x79
+#define CS15_SW7 0x7A
+#define CS16_SW7 0x7B
+#define CS17_SW7 0x7C
+#define CS18_SW7 0x7D
+#define CS1_SW8 0x7E
+#define CS2_SW8 0x7F
+#define CS3_SW8 0x80
+#define CS4_SW8 0x81
+#define CS5_SW8 0x82
+#define CS6_SW8 0x83
+#define CS7_SW8 0x84
+#define CS8_SW8 0x85
+#define CS9_SW8 0x86
+#define CS10_SW8 0x87
+#define CS11_SW8 0x88
+#define CS12_SW8 0x89
+#define CS13_SW8 0x8A
+#define CS14_SW8 0x8B
+#define CS15_SW8 0x8C
+#define CS16_SW8 0x8D
+#define CS17_SW8 0x8E
+#define CS18_SW8 0x8F
+#define CS1_SW9 0x90
+#define CS2_SW9 0x91
+#define CS3_SW9 0x92
+#define CS4_SW9 0x93
+#define CS5_SW9 0x94
+#define CS6_SW9 0x95
+#define CS7_SW9 0x96
+#define CS8_SW9 0x97
+#define CS9_SW9 0x98
+#define CS10_SW9 0x99
+#define CS11_SW9 0x9A
+#define CS12_SW9 0x9B
+#define CS13_SW9 0x9C
+#define CS14_SW9 0x9D
+#define CS15_SW9 0x9E
+#define CS16_SW9 0x9F
+#define CS17_SW9 0xA0
+#define CS18_SW9 0xA1
+#define CS1_SW10 0xA2
+#define CS2_SW10 0xA3
+#define CS3_SW10 0xA4
+#define CS4_SW10 0xA5
+#define CS5_SW10 0xA6
+#define CS6_SW10 0xA7
+#define CS7_SW10 0xA8
+#define CS8_SW10 0xA9
+#define CS9_SW10 0xAA
+#define CS10_SW10 0xAB
+#define CS11_SW10 0xAC
+#define CS12_SW10 0xAD
+#define CS13_SW10 0xAE
+#define CS14_SW10 0xAF
+#define CS15_SW10 0xB0
+#define CS16_SW10 0xB1
+#define CS17_SW10 0xB2
+#define CS18_SW10 0xB3
+#define CS1_SW11 0xB4
+#define CS2_SW11 0xB5
+#define CS3_SW11 0xB6
+#define CS4_SW11 0xB7
+#define CS5_SW11 0xB8
+#define CS6_SW11 0xB9
+#define CS7_SW11 0xBA
+#define CS8_SW11 0xBB
+#define CS9_SW11 0xBC
+#define CS10_SW11 0xBD
+#define CS11_SW11 0xBE
+#define CS12_SW11 0xBF
+#define CS13_SW11 0xC0
+#define CS14_SW11 0xC1
+#define CS15_SW11 0xC2
+#define CS16_SW11 0xC3
+#define CS17_SW11 0xC4
+#define CS18_SW11 0xC5
+#define CS1_SW12 0xC6
+#define CS2_SW12 0xC7
+#define CS3_SW12 0xC8
+#define CS4_SW12 0xC9
+#define CS5_SW12 0xCA
+#define CS6_SW12 0xCB
+#define CS7_SW12 0xCC
+#define CS8_SW12 0xCD
+#define CS9_SW12 0xCE
+#define CS10_SW12 0xCF
+#define CS11_SW12 0xD0
+#define CS12_SW12 0xD1
+#define CS13_SW12 0xD2
+#define CS14_SW12 0xD3
+#define CS15_SW12 0xD4
+#define CS16_SW12 0xD5
+#define CS17_SW12 0xD6
+#define CS18_SW12 0xD7

keyboards/gmmk/pro/config.h

@@ -46,3 +46,20 @@
 #define LOCKING_SUPPORT_ENABLE
 /* Locking resynchronize hack */
 #define LOCKING_RESYNC_ENABLE
+
+/* SPI Config for LED Driver */
+#define SPI_DRIVER SPID1
+#define SPI_SCK_PIN A5
+#define SPI_MOSI_PIN A6
+#define SPI_MISO_PIN A7
+
+#define DRIVER_1_CS B13
+#define DRIVER_2_CS B14
+#define DRIVER_1_EN C13
+#define DRIVER_2_EN C13
+
+#define DRIVER_COUNT 2
+#define DRIVER_1_LED_TOTAL 66
+#define DRIVER_2_LED_TOTAL 32
+#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+

keyboards/gmmk/pro/halconf.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#define HAL_USE_SPI TRUE
+#define SPI_USE_WAIT TRUE
+#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
+
+#include_next <halconf.h>

keyboards/gmmk/pro/mcuconf.h

@@ -0,0 +1,6 @@
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef STM32_SPI_USE_SPI1
+#define STM32_SPI_USE_SPI1 TRUE

keyboards/gmmk/pro/pro.c

@@ -14,3 +14,225 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 #include "pro.h"
+
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { {
+    { 4,      NO_LED, NO_LED, 97,     65,     79, 5,      28 },
+    { 8,      2,      9,      0,      10,     75, 1,      7  },
+    { 14,     3,      15,     NO_LED, 16,     86, 6,      13 },
+    { 20,     18,     21,     23,     22,     94, 12,     19 },
+    { 25,     30,     26,     31,     27,     32, 29,     24 },
+    { 41,     36,     42,     37,     43,     38, 35,     40 },
+    { 46,     89,     47,     34,     48,     72, 78,     45 },
+    { 52,     39,     53,     101,    54,     82, 44,     51 },
+    { 58,     63,     59,     64,     NO_LED, 60, 62,     57 },
+    { 11,     90,     55,     17,     33,     49, NO_LED, 69 },
+    { NO_LED, 85,     93,     61,     100,    66, 50,     56 }
+}, {
+    { 0, 0 }, // 0, ESC, k13
+    { 0, 15 }, // 1, ~, k16
+    { 4, 26 }, // 2, Tab, k11
+    { 5, 38 }, // 3, Caps, k21
+    { 9, 49 }, // 4, Sh_L, k00
+    { 2, 61 }, // 5, Ct_L, k06
+    { 18, 0 }, // 6, F1, k26
+    { 14, 15 }, // 7, 1, k17
+    { 22, 26 }, // 8, Q, k10
+    { 25, 38 }, // 9, A, k12
+    { 33, 49 }, // 10, Z, k14
+    { 20, 61 }, // 11, Win_L, k90
+    { 33, 0 }, // 12, F2, k36
+    { 29, 15 }, // 13, 2, k27
+    { 36, 26 }, // 14, W, k20
+    { 40, 38 }, // 15, S, k22
+    { 47, 49 }, // 16, X, k24
+    { 38, 61 }, // 17, Alt_L, k93
+    { 47, 0 }, // 18, F3, k31
+    { 43, 15 }, // 19, 3, k37
+    { 51, 26 }, // 20, E, k30
+    { 54, 38 }, // 21, D, k32
+    { 61, 49 }, // 22, C, k34
+    { 61, 0 }, // 23, F4, k33
+    { 58, 15 }, // 24, 4, k47
+    { 65, 26 }, // 25, R, k40
+    { 69, 38 }, // 26, F, k42
+    { 76, 49 }, // 27, V, k44
+    { 79, 0 }, // 28, F5, k07
+    { 72, 15 }, // 29, 5, k46
+    { 79, 26 }, // 30, T, k41
+    { 83, 38 }, // 31, G, k43
+    { 90, 49 }, // 32, B, k45
+    { 92, 61 }, // 33, SPACE, k94
+    { 94, 0 }, // 34, F6, k63
+    { 87, 15 }, // 35, 6, k56
+    { 94, 26 }, // 36, Y, k51
+    { 98, 38 }, // 37, H, k53
+    { 105, 49 }, // 38, N, k55
+    { 108, 0 }, // 39, F7, k71
+    { 101, 15 }, // 40, 7, k57
+    { 108, 26 }, // 41, U, k50
+    { 112, 38 }, // 42, J, k52
+    { 119, 49 }, // 43, M, k54
+    { 123, 0 }, // 44, F8, k76
+    { 116, 15 }, // 45, 8, k67
+    { 123, 26 }, // 46, I, k60
+    { 126, 38 }, // 47, K, k62
+    { 134, 49 }, // 48, ,, k64
+    { 145, 61 }, // 49, Alt_R, k95
+    { 141, 0 }, // 50, F9, ka6
+    { 130, 15 }, // 51, 9, k77
+    { 137, 26 }, // 52, O, k70
+    { 141, 38 }, // 53, L, k72
+    { 148, 49 }, // 54, ., k74
+    { 159, 61 }, // 55, FN, k92
+    { 155, 0 }, // 56, F10, ka7
+    { 145, 15 }, // 57, 0, k87
+    { 152, 26 }, // 58, P, k80
+    { 155, 38 }, // 59, ;, k82
+    { 163, 49 }, // 60, ?, k85
+    { 170, 0 }, // 61, F11, ka3
+    { 159, 15 }, // 62, -, k86
+    { 166, 26 }, // 63, [, k81
+    { 170, 38 }, // 64, ", k83
+    { 173, 61 }, // 65, Ct_R, k04
+    { 184, 0 }, // 66, F12, ka5
+    { 0, 8 }, // 67, LED, l01
+    { 224, 8 }, // 68, LED, l11
+    { 202, 0 }, // 69, Prt, k97
+    { 0, 15 }, // 70, LED, l02
+    { 224, 15 }, // 71, LED, l12
+    { 224, 15 }, // 72, Del, k65
+    { 0, 21 }, // 73, LED, l03
+    { 224, 21 }, // 74, LED, l13
+    { 224, 26 }, // 75, PgUp, k15
+    { 0, 28 }, // 76, LED, l04
+    { 224, 28 }, // 77, LED, l14
+    { 173, 15 }, // 78, =, k66
+    { 220, 64 }, // 79, Right, k05
+    { 0, 35 }, // 80, LED, l05
+    { 224, 35 }, // 81, LED, l15
+    { 224, 49 }, // 82, End, k75
+    { 0, 42 }, // 83, LED, l06
+    { 224, 42 }, // 84, LED, l16
+    { 195, 15 }, // 85, BSpc, ka1
+    { 224, 38 }, // 86, PgDn, k25
+    { 0, 48 }, // 87, LED, l07
+    { 224, 48 }, // 88, LED, l17
+    { 181, 26 }, // 89, ], k61
+    { 182, 49 }, // 90, Sh_R, k91
+    { 0, 55 }, // 91, LED, l08
+    { 224, 55 }, // 92, LED, l18
+    { 199, 26 }, // 93, \, ka2
+    { 206, 52 }, // 94, Up, k35
+    { 191, 64 }, // 95, Left, k03
+    { 193, 38 }, // 96, Enter, ka4
+    { 206, 64 } // 97, Down, k73
+}, {
+    4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
+    4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 2, 2, 4, 2, 2, 4, 2, 2,
+    4, 2, 2, 4, 4, 2, 2, 4, 2, 2, 4, 4, 2, 2, 4, 4, 2, 2, 4, 4, 4, 4, 4
+} };
+
+const aw_led g_aw_leds[DRIVER_LED_TOTAL] = {
+    { 0, CS1_SW1, CS2_SW1, CS3_SW1 },  //  0, ESC, k13
+    { 0, CS4_SW1, CS5_SW1, CS6_SW1 },  //  1, ~, k16
+    { 0, CS7_SW1, CS8_SW1, CS9_SW1 },  //  2, Tab, k11
+    { 0, CS10_SW1, CS11_SW1, CS12_SW1 },  //  3, Caps, k21
+    { 0, CS13_SW1, CS14_SW1, CS15_SW1 },  //  4, Sh_L, k00
+    { 0, CS16_SW1, CS17_SW1, CS18_SW1 },  //  5, Ct_L, k06
+    { 0, CS1_SW2, CS2_SW2, CS3_SW2 },  //  6, F1, k26
+    { 0, CS4_SW2, CS5_SW2, CS6_SW2 },  //  7, 1, k17
+    { 0, CS7_SW2, CS8_SW2, CS9_SW2 },  //  8, Q, k10
+    { 0, CS10_SW2, CS11_SW2, CS12_SW2 },  //  9, A, k12
+    { 0, CS13_SW2, CS14_SW2, CS15_SW2 },  //  10, Z, k14
+    { 0, CS16_SW2, CS17_SW2, CS18_SW2 },  //  11, Win_L, k90
+    { 0, CS1_SW3, CS2_SW3, CS3_SW3 },  //  12, F2, k36
+    { 0, CS4_SW3, CS5_SW3, CS6_SW3 },  //  13, 2, k27
+    { 0, CS7_SW3, CS8_SW3, CS9_SW3 },  //  14, W, k20
+    { 0, CS10_SW3, CS11_SW3, CS12_SW3 },  //  15, S, k22
+    { 0, CS13_SW3, CS14_SW3, CS15_SW3 },  //  16, X, k24
+    { 0, CS16_SW3, CS17_SW3, CS18_SW3 },  //  17, Alt_L, k93
+    { 0, CS1_SW4, CS2_SW4, CS3_SW4 },  //  18, F3, k31
+    { 0, CS4_SW4, CS5_SW4, CS6_SW4 },  //  19, 3, k37
+    { 0, CS7_SW4, CS8_SW4, CS9_SW4 },  //  20, E, k30
+    { 0, CS10_SW4, CS11_SW4, CS12_SW4 },  //  21, D, k32
+    { 0, CS13_SW4, CS14_SW4, CS15_SW4 },  //  22, C, k34
+    { 0, CS1_SW5, CS2_SW5, CS3_SW5 },  //  23, F4, k33
+    { 0, CS4_SW5, CS5_SW5, CS6_SW5 },  //  24, 4, k47
+    { 0, CS7_SW5, CS8_SW5, CS9_SW5 },  //  25, R, k40
+    { 0, CS10_SW5, CS11_SW5, CS12_SW5 },  //  26, F, k42
+    { 0, CS13_SW5, CS14_SW5, CS15_SW5 },  //  27, V, k44
+    { 0, CS1_SW6, CS2_SW6, CS3_SW6 },  //  28, F5, k07
+    { 0, CS4_SW6, CS5_SW6, CS6_SW6 },  //  29, 5, k46
+    { 0, CS7_SW6, CS8_SW6, CS9_SW6 },  //  30, T, k41
+    { 0, CS10_SW6, CS11_SW6, CS12_SW6 },  //  31, G, k43
+    { 0, CS13_SW6, CS14_SW6, CS15_SW6 },  //  32, B, k45
+    { 0, CS16_SW6, CS17_SW6, CS18_SW6 },  //  33, SPACE, k94
+    { 0, CS1_SW7, CS2_SW7, CS3_SW7 },  //  34, F6, k63
+    { 0, CS4_SW7, CS5_SW7, CS6_SW7 },  //  35, 6, k56
+    { 0, CS7_SW7, CS8_SW7, CS9_SW7 },  //  36, Y, k51
+    { 0, CS10_SW7, CS11_SW7, CS12_SW7 },  //  37, H, k53
+    { 0, CS13_SW7, CS14_SW7, CS15_SW7 },  //  38, N, k55
+    { 0, CS1_SW8, CS2_SW8, CS3_SW8 },  //  39, F7, k71
+    { 0, CS4_SW8, CS5_SW8, CS6_SW8 },  //  40, 7, k57
+    { 0, CS7_SW8, CS8_SW8, CS9_SW8 },  //  41, U, k50
+    { 0, CS10_SW8, CS11_SW8, CS12_SW8 },  //  42, J, k52
+    { 0, CS13_SW8, CS14_SW8, CS15_SW8 },  //  43, M, k54
+    { 0, CS1_SW9, CS2_SW9, CS3_SW9 },  //  44, F8, k76
+    { 0, CS4_SW9, CS5_SW9, CS6_SW9 },  //  45, 8, k67
+    { 0, CS7_SW9, CS8_SW9, CS9_SW9 },  //  46, I, k60
+    { 0, CS10_SW9, CS11_SW9, CS12_SW9 },  //  47, K, k62
+    { 0, CS13_SW9, CS14_SW9, CS15_SW9 },  //  48, ,, k64
+    { 0, CS16_SW9, CS17_SW9, CS18_SW9 },  //  49, Alt_R, k95
+    { 0, CS1_SW10, CS2_SW10, CS3_SW10 },  //  50, F9, ka6
+    { 0, CS4_SW10, CS5_SW10, CS6_SW10 },  //  51, 9, k77
+    { 0, CS7_SW10, CS8_SW10, CS9_SW10 },  //  52, O, k70
+    { 0, CS10_SW10, CS11_SW10, CS12_SW10 },  //  53, L, k72
+    { 0, CS13_SW10, CS14_SW10, CS15_SW10 },  //  54, ., k74
+    { 0, CS16_SW10, CS17_SW10, CS18_SW10 },  //  55, FN, k92
+    { 0, CS1_SW11, CS2_SW11, CS3_SW11 },  //  56, F10, ka7
+    { 0, CS4_SW11, CS5_SW11, CS6_SW11 },  //  57, 0, k87
+    { 0, CS7_SW11, CS8_SW11, CS9_SW11 },  //  58, P, k80
+    { 0, CS10_SW11, CS11_SW11, CS12_SW11 },  //  59, ;, k82
+    { 0, CS13_SW11, CS14_SW11, CS15_SW11 },  //  60, ?, k85
+    { 0, CS1_SW12, CS2_SW12, CS3_SW12 },  //  61, F11, ka3
+    { 0, CS4_SW12, CS5_SW12, CS6_SW12 },  //  62, -, k86
+    { 0, CS7_SW12, CS8_SW12, CS9_SW12 },  //  63, [, k81
+    { 0, CS10_SW12, CS11_SW12, CS12_SW12 },  //  64, ", k83
+    { 0, CS16_SW12, CS17_SW12, CS18_SW12 },  //  65, Ct_R, k04
+
+    { 1, CS1_SW1, CS2_SW1, CS3_SW1 },  //  66, F12, ka5
+    { 1, CS13_SW1, CS14_SW1, CS15_SW1 },  //  67, LED, l01
+    { 1, CS16_SW1, CS17_SW1, CS18_SW1 },  //  68, LED, l11
+    { 1, CS4_SW2, CS5_SW2, CS6_SW2 },  //  69, Prt, k97
+    { 1, CS13_SW2, CS14_SW2, CS15_SW2 },  //  70, LED, l02
+    { 1, CS16_SW2, CS17_SW2, CS18_SW2 },  //  71, LED, l12
+    { 1, CS4_SW3, CS5_SW3, CS6_SW3 },  //  72, Del, k65
+    { 1, CS13_SW3, CS14_SW3, CS15_SW3 },  //  73, LED, l03
+    { 1, CS16_SW3, CS17_SW3, CS18_SW3 },  //  74, LED, l13
+    { 1, CS4_SW4, CS5_SW4, CS6_SW4 },  //  75, PgUp, k15
+    { 1, CS13_SW4, CS14_SW4, CS15_SW4 },  //  76, LED, l04
+    { 1, CS16_SW4, CS17_SW4, CS18_SW4 },  //  77, LED, l14
+    { 1, CS1_SW5, CS2_SW5, CS3_SW5 },  //  78, =, k66
+    { 1, CS10_SW5, CS11_SW5, CS12_SW5 },  //  79, Right, k05
+    { 1, CS13_SW5, CS14_SW5, CS15_SW5 },  //  80, LED, l05
+    { 1, CS16_SW5, CS17_SW5, CS18_SW5 },  //  81, LED, l15
+    { 1, CS4_SW6, CS5_SW6, CS6_SW6 },  //  82, End, k75
+    { 1, CS13_SW6, CS14_SW6, CS15_SW6 },  //  83, LED, l06
+    { 1, CS16_SW6, CS17_SW6, CS18_SW6 },  //  84, LED, l16
+    { 1, CS1_SW7, CS2_SW7, CS3_SW7 },  //  85, BSpc, ka1
+    { 1, CS4_SW7, CS5_SW7, CS6_SW7 },  //  86, PgDn, k25
+    { 1, CS13_SW7, CS14_SW7, CS15_SW7 },  //  87, LED, l07
+    { 1, CS16_SW7, CS17_SW7, CS18_SW7 },  //  88, LED, l17
+    { 1, CS1_SW8, CS2_SW8, CS3_SW8 },  //  89, ], k61
+    { 1, CS4_SW8, CS5_SW8, CS6_SW8 },  //  90, Sh_R, k91
+    { 1, CS13_SW8, CS14_SW8, CS15_SW8 },  //  91, LED, l08
+    { 1, CS16_SW8, CS17_SW8, CS18_SW8 },  //  92, LED, l18
+    { 1, CS1_SW9, CS2_SW9, CS3_SW9 },  //  93, \, ka2
+    { 1, CS4_SW9, CS5_SW9, CS6_SW9 },  //  94, Up, k35
+    { 1, CS4_SW10, CS5_SW10, CS6_SW10 },  //  95, Left, k03
+    { 1, CS1_SW11, CS2_SW11, CS3_SW11 },  //  96, Enter, ka4
+    { 1, CS4_SW11, CS5_SW11, CS6_SW11 },  //  97, Down, k73
+};
+#endif

keyboards/gmmk/pro/rules.mk

@@ -21,3 +21,5 @@ RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 BLUETOOTH_ENABLE = no       # Enable Bluetooth
 AUDIO_ENABLE = no           # Audio output
 ENCODER_ENABLE = yes
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = AW20216

quantum/rgb_matrix.h

@@ -33,6 +33,8 @@
 #    include "is31fl3737.h"
 #elif defined(IS31FL3741)
 #    include "is31fl3741.h"
+#elif defined(AW20216)
+#    include "aw20216.h"
 #elif defined(WS2812)
 #    include "ws2812.h"
 #endif

quantum/rgb_matrix_drivers.c

@@ -171,6 +171,22 @@ const rgb_matrix_driver_t rgb_matrix_driver = {
 };
 #    endif
 
+#elif defined(AW20216)
+#    include "spi_master.h"
+static void init(void) {
+    spi_init();
+    AW20216_init();
+}
+
+static void flush(void) { AW20216_update_pwm_buffers(); }
+
+const rgb_matrix_driver_t rgb_matrix_driver = {
+    .init          = init,
+    .flush         = flush,
+    .set_color     = AW20216_set_color,
+    .set_color_all = AW20216_set_color_all,
+};
+
 #elif defined(WS2812)
 #    if defined(RGBLIGHT_ENABLE) && !defined(RGBLIGHT_CUSTOM_DRIVER)
 #        pragma message "Cannot use RGBLIGHT and RGB Matrix using WS2812 at the same time."