Browse Source

fix(underglow): Add newly required color-mapping prop.

xmkb
Peter Johanson 3 years ago committed by Pete Johanson
parent
commit
bf2fc68070
  1. 1
      app/boards/arm/bdn9/bdn9_rev2.dts
  2. 3
      app/boards/arm/nice60/nice60.dts
  3. 4
      app/boards/shields/chalice/boards/nice_nano.overlay
  4. 4
      app/boards/shields/chalice/boards/nice_nano_v2.overlay
  5. 4
      app/boards/shields/corne/boards/nice_nano.overlay
  6. 4
      app/boards/shields/elephant42/boards/nice_nano_v2.overlay
  7. 4
      app/boards/shields/helix/boards/nice_nano.overlay
  8. 3
      app/boards/shields/jorne/boards/nice_nano.overlay
  9. 3
      app/boards/shields/kyria/boards/nice_nano.overlay
  10. 32
      app/boards/shields/kyria/boards/nice_nano_v2.overlay
  11. 3
      app/boards/shields/kyria/boards/nrfmicro_11.overlay
  12. 3
      app/boards/shields/kyria/boards/nrfmicro_11_flipped.overlay
  13. 3
      app/boards/shields/kyria/boards/nrfmicro_13.overlay
  14. 3
      app/boards/shields/lily58/boards/nice_nano.overlay
  15. 4
      app/boards/shields/microdox/boards/nice_nano.overlay
  16. 4
      app/boards/shields/murphpad/boards/nice_nano.overlay
  17. 3
      app/boards/shields/nibble/boards/nice_nano.overlay
  18. 4
      app/boards/shields/redox/boards/nice_nano.overlay
  19. 3
      app/boards/shields/reviung41/boards/nice_nano.overlay
  20. 3
      app/boards/shields/romac_plus/boards/nice_nano.overlay
  21. 3
      app/boards/shields/tg4x/boards/nice_nano.overlay
  22. 3
      app/boards/shields/tidbit/boards/nice_nano.overlay
  23. 17
      docs/docs/features/underglow.md

1
app/boards/arm/bdn9/bdn9_rev2.dts

@ -6,6 +6,7 @@
/dts-v1/; /dts-v1/;
#include <st/f0/stm32f072Xb.dtsi> #include <st/f0/stm32f072Xb.dtsi>
#include <dt-bindings/led/led.h>
/ { / {
model = "Keeb.io BDN9 rev2"; model = "Keeb.io BDN9 rev2";

3
app/boards/arm/nice60/nice60.dts

@ -6,6 +6,8 @@
/dts-v1/; /dts-v1/;
#include <nordic/nrf52840_qiaa.dtsi> #include <nordic/nrf52840_qiaa.dtsi>
#include <dt-bindings/led/led.h>
#include <dt-bindings/zmk/matrix_transform.h> #include <dt-bindings/zmk/matrix_transform.h>
/ { / {
@ -124,6 +126,7 @@ RC(4,0) RC(4,1) RC(4,2) RC(4,5) R
chain-length = <12>; /* LED strip length */ chain-length = <12>; /* LED strip length */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/chalice/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,8 @@
chain-length = <14>; /* arbitrary; change at will */ chain-length = <14>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/chalice/boards/nice_nano_v2.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,8 @@
chain-length = <14>; /* arbitrary; change at will */ chain-length = <14>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/corne/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
/* Cannot be used together with i2c0. */ /* Cannot be used together with i2c0. */
@ -19,6 +21,8 @@
chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */ chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/elephant42/boards/nice_nano_v2.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
/* Cannot be used together with i2c0. */ /* Cannot be used together with i2c0. */
@ -18,6 +20,8 @@
chain-length = <27>; /* There are per-key RGB and the LAST 6 are underglow */ chain-length = <27>; /* There are per-key RGB and the LAST 6 are underglow */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/helix/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,8 @@
chain-length = <32>; /* number of LEDs */ chain-length = <32>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/jorne/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
/* Cannot be used together with i2c0. */ /* Cannot be used together with i2c0. */
@ -19,6 +21,7 @@
chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */ chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/kyria/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <10>; /* arbitrary; change at will */ chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

32
app/boards/shields/kyria/boards/nice_nano_v2.overlay

@ -0,0 +1,32 @@
#include <dt-bindings/led/led.h>
&spi1 {
compatible = "nordic,nrf-spim";
status = "okay";
mosi-pin = <6>;
// Unused pins, needed for SPI definition, but not used by the ws2812 driver itself.
sck-pin = <5>;
miso-pin = <7>;
led_strip: ws2812@0 {
compatible = "worldsemi,ws2812-spi";
label = "WS2812";
/* SPI */
reg = <0>; /* ignored, but necessary for SPI bindings */
spi-max-frequency = <4000000>;
/* WS2812 */
chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>;
spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
};
};
/ {
chosen {
zmk,underglow = &led_strip;
};
};

3
app/boards/shields/kyria/boards/nrfmicro_11.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <10>; /* arbitrary; change at will */ chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/kyria/boards/nrfmicro_11_flipped.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <10>; /* arbitrary; change at will */ chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/kyria/boards/nrfmicro_13.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <10>; /* arbitrary; change at will */ chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/lily58/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,7 @@
chain-length = <5>; /* number of LEDs */ chain-length = <5>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/microdox/boards/nice_nano.overlay

@ -3,6 +3,9 @@
* *
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
/* Cannot be used together with i2c0. */ /* Cannot be used together with i2c0. */
@ -24,6 +27,7 @@
chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */ chain-length = <6>; /* There are per-key RGB, but the first 6 are underglow */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/murphpad/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,8 @@
chain-length = <8>; /* number of LEDs */ chain-length = <8>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/nibble/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,7 @@
chain-length = <10>; /* number of LEDs */ chain-length = <10>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

4
app/boards/shields/redox/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,8 @@
chain-length = <5>; /* number of LEDs */ chain-length = <5>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/reviung41/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <11>; /* arbitrary; change at will */ chain-length = <11>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/romac_plus/boards/nice_nano.overlay

@ -1,3 +1,5 @@
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -18,6 +20,7 @@
chain-length = <10>; /* arbitrary; change at will */ chain-length = <10>; /* arbitrary; change at will */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/tg4x/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,7 @@
chain-length = <7>; /* number of LEDs */ chain-length = <7>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

3
app/boards/shields/tidbit/boards/nice_nano.overlay

@ -4,6 +4,8 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -24,6 +26,7 @@
chain-length = <8>; /* number of LEDs */ chain-length = <8>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
}; };
}; };

17
docs/docs/features/underglow.md

@ -67,6 +67,8 @@ To identify which pin number you need to put in the config you need do to a bit
Here's an example on a definition that uses P0.06: Here's an example on a definition that uses P0.06:
``` ```
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
compatible = "nordic,nrf-spim"; compatible = "nordic,nrf-spim";
status = "okay"; status = "okay";
@ -87,6 +89,9 @@ Here's an example on a definition that uses P0.06:
chain-length = <10>; /* number of LEDs */ chain-length = <10>; /* number of LEDs */
spi-one-frame = <0x70>; spi-one-frame = <0x70>;
spi-zero-frame = <0x40>; spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN
LED_COLOR_ID_RED
LED_COLOR_ID_BLUE>;
}; };
}; };
``` ```
@ -98,6 +103,13 @@ Ignoring these restrictions may result in poor wireless performance. You can fin
::: :::
:::note
Standard WS2812 LEDs use a wire protocol where the bits for the colors green, red, and blue values are sent in that order.
If your board/shield uses LEDs that require the data sent in a different order, the `color-mapping` property ordering should be changed to match.
:::
### Other boards ### Other boards
For other boards, you must select an SPI definition that has the `MOSI` pin as your data pin going to your LED strip. For other boards, you must select an SPI definition that has the `MOSI` pin as your data pin going to your LED strip.
@ -105,6 +117,8 @@ For other boards, you must select an SPI definition that has the `MOSI` pin as y
Here's another example for a non-nRF52 board on `spi1`: Here's another example for a non-nRF52 board on `spi1`:
``` ```
#include <dt-bindings/led/led.h>
&spi1 { &spi1 {
led_strip: ws2812@0 { led_strip: ws2812@0 {
@ -119,6 +133,9 @@ Here's another example for a non-nRF52 board on `spi1`:
chain-length = <10>; /* number of LEDs */ chain-length = <10>; /* number of LEDs */
spi-one-frame = <0x70>; /* make sure to configure this properly for your SOC */ spi-one-frame = <0x70>; /* make sure to configure this properly for your SOC */
spi-zero-frame = <0x40>; /* make sure to configure this properly for your SOC */ spi-zero-frame = <0x40>; /* make sure to configure this properly for your SOC */
color-mapping = <LED_COLOR_ID_GREEN
LED_COLOR_ID_RED
LED_COLOR_ID_BLUE>;
}; };
}; };
``` ```

Loading…
Cancel
Save