From 55538b2e1e743ec1a209e61880d52bb5d2156669 Mon Sep 17 00:00:00 2001
From: Ryan <fauxpark@gmail.com>
Date: Thu, 13 Jun 2024 22:19:45 +1000
Subject: [PATCH] APA102: API rework (#23355)

---
 docs/drivers/apa102.md              | 51 +++++++++++++++++++++++------
 drivers/led/apa102.c                | 25 ++++++++++----
 drivers/led/apa102.h                | 15 ++-------
 quantum/rgblight/rgblight_drivers.c |  8 +++++
 4 files changed, 70 insertions(+), 29 deletions(-)

diff --git a/docs/drivers/apa102.md b/docs/drivers/apa102.md
index 88868a73b5..197b18869e 100644
--- a/docs/drivers/apa102.md
+++ b/docs/drivers/apa102.md
@@ -26,20 +26,51 @@ Add the following to your `config.h`:
 
 ## API {#api}
 
-### `void apa102_setleds(rgb_led_t *start_led, uint16_t num_leds)`
+### `void apa102_init(void)` {#api-apa102-init}
 
-Send RGB data to the APA102 LED chain.
-
-#### Arguments {#api-apa102-setleds-arguments}
-
- - `rgb_led_t *start_led`  
-   A pointer to the LED array.
- - `uint16_t num_leds`  
-   The length of the LED array.
+Initialize the LED driver. This function should be called first.
 
 ---
 
-### `void apa102_set_brightness(uint8_t brightness)`
+### `void apa102_set_color(uint16_t index, uint8_t red, uint8_t green, uint8_t blue)` {#api-apa102-set-color}
+
+Set the color of a single LED. This function does not immediately update the LEDs; call `apa102_flush()` after you are finished.
+
+#### Arguments {#api-apa102-set-color-arguments}
+
+ - `uint16_t index`  
+   The LED index in the APA102 chain.
+ - `uint8_t red`  
+   The red value to set.
+ - `uint8_t green`  
+   The green value to set.
+ - `uint8_t blue`  
+   The blue value to set.
+
+---
+
+### `void apa102_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-apa102-set-color-all}
+
+Set the color of all LEDs.
+
+#### Arguments {#api-apa102-set-color-all-arguments}
+
+ - `uint8_t red`  
+   The red value to set.
+ - `uint8_t green`  
+   The green value to set.
+ - `uint8_t blue`  
+   The blue value to set.
+
+---
+
+### `void apa102_flush(void)` {#api-apa102-flush}
+
+Flush the PWM values to the LED chain.
+
+---
+
+### `void apa102_set_brightness(uint8_t brightness)` {#api-apa102-set-brightness}
 
 Set the global brightness.
 
diff --git a/drivers/led/apa102.c b/drivers/led/apa102.c
index b171b07b12..0cf0ecb401 100644
--- a/drivers/led/apa102.c
+++ b/drivers/led/apa102.c
@@ -53,7 +53,8 @@
         io_wait;                                          \
     } while (0)
 
-uint8_t apa102_led_brightness = APA102_DEFAULT_BRIGHTNESS;
+rgb_led_t apa102_leds[APA102_LED_COUNT];
+uint8_t   apa102_led_brightness = APA102_DEFAULT_BRIGHTNESS;
 
 static void apa102_send_byte(uint8_t byte) {
     APA102_SEND_BIT(byte, 7);
@@ -121,14 +122,24 @@ void apa102_init(void) {
     gpio_set_pin_output(APA102_CI_PIN);
 }
 
-void apa102_setleds(rgb_led_t *start_led, uint16_t num_leds) {
-    rgb_led_t *end = start_led + num_leds;
+void apa102_set_color(uint16_t index, uint8_t red, uint8_t green, uint8_t blue) {
+    apa102_leds[index].r = red;
+    apa102_leds[index].g = green;
+    apa102_leds[index].b = blue;
+}
 
-    apa102_start_frame();
-    for (rgb_led_t *led = start_led; led < end; led++) {
-        apa102_send_frame(led->r, led->g, led->b, apa102_led_brightness);
+void apa102_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint16_t i = 0; i < APA102_LED_COUNT; i++) {
+        apa102_set_color(i, red, green, blue);
     }
-    apa102_end_frame(num_leds);
+}
+
+void apa102_flush(void) {
+    apa102_start_frame();
+    for (uint8_t i = 0; i < APA102_LED_COUNT; i++) {
+        apa102_send_frame(apa102_leds[i].r, apa102_leds[i].g, apa102_leds[i].b, apa102_led_brightness);
+    }
+    apa102_end_frame(APA102_LED_COUNT);
 }
 
 void apa102_set_brightness(uint8_t brightness) {
diff --git a/drivers/led/apa102.h b/drivers/led/apa102.h
index 5e2f78658b..42f1344f0c 100644
--- a/drivers/led/apa102.h
+++ b/drivers/led/apa102.h
@@ -32,17 +32,8 @@
 #define APA102_MAX_BRIGHTNESS 31
 
 void apa102_init(void);
-
-/* User Interface
- *
- * Input:
- *         start_led:          An array of GRB data describing the LED colors
- *         num_leds:           The number of LEDs to write
- *
- * The functions will perform the following actions:
- *         - Set the data-out pin as output
- *         - Send out the LED data
- */
-void apa102_setleds(rgb_led_t *start_led, uint16_t num_leds);
+void apa102_set_color(uint16_t index, uint8_t red, uint8_t green, uint8_t blue);
+void apa102_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
+void apa102_flush(void);
 
 void apa102_set_brightness(uint8_t brightness);
diff --git a/quantum/rgblight/rgblight_drivers.c b/quantum/rgblight/rgblight_drivers.c
index 8902b8f842..76e9031aec 100644
--- a/quantum/rgblight/rgblight_drivers.c
+++ b/quantum/rgblight/rgblight_drivers.c
@@ -14,6 +14,14 @@ const rgblight_driver_t rgblight_driver = {
 #elif defined(RGBLIGHT_APA102)
 #    include "apa102.h"
 
+// Temporary shim
+static void apa102_setleds(rgb_led_t *ledarray, uint16_t number_of_leds) {
+    for (uint16_t i = 0; i < number_of_leds; i++) {
+        apa102_set_color(i, ledarray[i].r, ledarray[i].g, ledarray[i].b);
+    }
+    apa102_flush();
+}
+
 const rgblight_driver_t rgblight_driver = {
     .init    = apa102_init,
     .setleds = apa102_setleds,