Add ifndef to WS2812 timing constraints (#14678)

* Add ifndef to WS2812 timing constraints

Due to the way that the PrimeKB Meridian PCB was designed, this change
is needed in order to properly adjust the LEDs.

Testing:
* Compiled primekb/meridian:default successfully
* Compiled random board (walletburner/neuron:default) successfully

* Fix linting errors

Missed some spacing

* More linting fixes

Spacing on the comments... really?

* Rename WS2812 timing parameters for clarity; add comments

* Add docs update for the WS2812 timing macros

* Fix typo on comment

* Add ifndef for WS2812_RES

* Update double backticks and table with parameters

* Move timing adjustments documentation to ws2812_drivers

* Move timings adjustment discussion to bitbang section

* Update T0H and T1H definitions in subtractions

* format

Co-authored-by: Gondolindrim <alvaro.volpato@usp.br>
Co-authored-by: zvecr <git@zvecr.com>

2 files changed, 46 insertions, 12 deletions

diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md
index 101798f211..03dc4f2fd1 100644
--- a/docs/ws2812_driver.md
+++ b/docs/ws2812_driver.md
@@ -62,6 +62,23 @@ Configure the hardware via your config.h:
 #define WS2812_TIMEOUT 100 // default: 100
 ```
 
+##### Adjusting bit timings (ChibiOS only)
+
+The WS2812 LED communication topology depends on a serialized timed window, lasting typically 1250ns in total, where a bit is interpreted as either 0 or 1 depending on for how much time the `RGB_DI` pin voltage is kept high and how much time it is kept low. The WS2812 datasheet specifies quantities defined as `T0H`, `T0L`, `T1H`, `T1L` (respectively, typically 350ns, 900ns, 900ns and 350ns); a bit is interpreted as zero if the voltage on the control pin is held high for `T0H` and then `T0L`, and the bit is interpreted as one if the voltage is held high for `T1H` and then low for `T1L`. Additionally, there is also a RESET time parameter whereby an LED color is reset if the voltage control pin is kept low for more than that parameter; in WS2812 that amount is 6000 nanoseconds.
+
+The WS2812 "bit-banged" ChibiOS driver does just that, in a simple way. It defines these values and governs the `RGB_DI` pin according to these times. There are, however, other LED parts that work in a communication topology similar to this but with different timing parameters; such is the case, for instance, of the SK6812. In order to better support such LEDs whilst keeping the WS2812 driver applicable, QMK allows you to tune these parameters through the definition macros:
+
+| Macro               |Default                                     |
+|---------------------|--------------------------------------------|
+|`WS2812_TIMING       |`1250`                                      |
+|`WS2812_T0H`         |`350`                                       |
+|`WS2812_T0L`         |`WS2812_TIMING - WS2812_T0H`                |
+|`WS2812_T1H`         |`900`                                       |
+|`WS2812_T1L`         |`WS2812_TIMING - WS2812_T1L`                |
+|`WS2812_RES`         |`6000`                                      |
+
+It must be noted, however, that this tuning is only available for the ARM family of microprocessors (since it's ChibiOS-dependent) and not available for PWM and SPI drivers -- so if you intend to use this be aware it will only work with the "bit-banged" driver which is knowingly slower and can possibly throttle the microcontroller if too many LEDs are used.
+
 ### SPI
 Targeting STM32 boards where WS2812 support is offloaded to an SPI hardware device. The advantage is that the use of DMA offloads processing of the WS2812 protocol from the MCU. `RGB_DI_PIN` for this driver is the configured SPI MOSI pin. Due to the nature of repurposing SPI to drive the LEDs, the other SPI pins, MISO and SCK, **must** remain unused. To configure it, add this to your rules.mk:
 
diff --git a/platforms/chibios/drivers/ws2812.c b/platforms/chibios/drivers/ws2812.c
index b46c46ae57..8c882c8eeb 100644
--- a/platforms/chibios/drivers/ws2812.c
+++ b/platforms/chibios/drivers/ws2812.c
@@ -40,18 +40,35 @@
         }                                           \
     } while (0)
 
-// These are the timing constraints taken mostly from the WS2812 datasheets
-// These are chosen to be conservative and avoid problems rather than for maximum throughput
+/* The WS2812 datasheets define T1H 900ns, T0H 350ns, T1L 350ns, T0L 900ns. Hence, by default, these are chosen to be conservative and avoid problems rather than for maximum throughput; in the code, this is done by default using a WS2812_TIMING parameter that accounts for the whole window (1250ns) and defining T1H and T0H; T1L and T0L are obtained by subtracting their low counterparts from the window.
+However, there are certain "WS2812"-like LEDs, like the SK6812s, which work in a similar communication topology but use different timings for the window and the T1L, T1H, T0L and T0H. This means that, albeit the same driver being applicable, the timings must be adapted. The following defines are done such that the adjustment of these timings can be done in the keyboard's config.h; if nothing is said, the defines default to the WS2812 ones.
+*/
 
-#define T1H 900           // Width of a 1 bit in ns
-#define T1L (1250 - T1H)  // Width of a 1 bit in ns
+#ifndef WS2812_TIMING
+#    define WS2812_TIMING 1250
+#endif
 
-#define T0H 350           // Width of a 0 bit in ns
-#define T0L (1250 - T0H)  // Width of a 0 bit in ns
+#ifndef WS2812_T1H
+#    define WS2812_T1H 900  // Width of a 1 bit in ns
+#endif
+
+#ifndef WS2812_T1L
+#    define WS2812_T1L (WS2812_TIMING - WS2812_T1H)  // Width of a 1 bit in ns
+#endif
+
+#ifndef WS2812_T0H
+#    define WS2812_T0H 350  // Width of a 0 bit in ns
+#endif
+
+#ifndef WS2812_T0L
+#    define WS2812_T0L (WS2812_TIMING - WS2812_T0H)  // Width of a 0 bit in ns
+#endif
 
 // The reset gap can be 6000 ns, but depending on the LED strip it may have to be increased
 // to values like 600000 ns. If it is too small, the pixels will show nothing most of the time.
-#define RES (1000 * WS2812_TRST_US)  // Width of the low gap between bits to cause a frame to latch
+#ifndef WS2812_RES
+#    define WS2812_RES (1000 * WS2812_TRST_US)  // Width of the low gap between bits to cause a frame to latch
+#endif
 
 void sendByte(uint8_t byte) {
     // WS2812 protocol wants most significant bits first
@@ -61,15 +78,15 @@ void sendByte(uint8_t byte) {
         if (is_one) {
             // 1
             writePinHigh(RGB_DI_PIN);
-            wait_ns(T1H);
+            wait_ns(WS2812_T1H);
             writePinLow(RGB_DI_PIN);
-            wait_ns(T1L);
+            wait_ns(WS2812_T1L);
         } else {
             // 0
             writePinHigh(RGB_DI_PIN);
-            wait_ns(T0H);
+            wait_ns(WS2812_T0H);
             writePinLow(RGB_DI_PIN);
-            wait_ns(T0L);
+            wait_ns(WS2812_T0L);
         }
     }
 }
@@ -108,7 +125,7 @@ void ws2812_setleds(LED_TYPE *ledarray, uint16_t leds) {
 #endif
     }
 
-    wait_ns(RES);
+    wait_ns(WS2812_RES);
 
     chSysUnlock();
 }