Skip to contentSkip to conversation

leds: add driver for SPI driven WorldSemi WS2812B RGB LEDs

PATCH Superseded Chuanhong Guo 2 participants 11 messages Dec 2, 2022 – Dec 3, 2022

Subsystems (3)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover leds: add driver for SPI driven WorldSemi WS2812B RGB LEDs

This patch adds support for driving a chain of WS2812B LED chips using SPI bus.

WorldSemi WS2812B is a individually addressable LED chip that can be chained together and controlled individually using a single wire. The chip recognize a long pulse as a bit of 1 and a short pulse as a bit of 0. Host sends a continuous stream of 24-bits color values, each LED chip takes the first 3 byte it receives as its color value and passes the leftover bytes to the next LED on the chain.

This driver simulates this protocol using SPI bus by sending a long pulse as 3'b110 and a short pulse as 3'b100. The SPI frequency needs to be 2.105MHz~2.85MHz for the timing to be correct and the controller needs to transfer all the bytes continuously.

Changes since v1:
various dt binding fixes
add support for default-brightness

Chuanhong Guo (3):
dt-bindings: vendor-prefixes: add an entry for WorldSemi
dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi
leds: add driver for SPI driven WorldSemi WS2812B RGB LEDs

 .../bindings/leds/worldsemi,ws2812b.yaml      | 138 ++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
 drivers/leds/rgb/Kconfig                      |  11 +
 drivers/leds/rgb/Makefile                     |   1 +
 drivers/leds/rgb/leds-ws2812b.c               | 235 ++++++++++++++++++
 5 files changed, 387 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml
 create mode 100644 drivers/leds/rgb/leds-ws2812b.c
Signature · 1 line
2.38.1
#1 lore raw

PATCH v2 1/3 dt-bindings: vendor-prefixes: add an entry for WorldSemi

Add vendor prefix for WorldSemi that makes WS2812B individually-addressable RGB LEDs.

--
Change since v1:
reword commit message

 Documentation/devicetree/bindings/vendor-prefixes.yaml | 2 ++
 1 file changed, 2 insertions(+)
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index 10c178d97b02..32274d894664 100644
@@ -1462,6 +1462,8 @@ patternProperties:
     description: Wondermedia Technologies, Inc.
   "^wobo,.*":
     description: Wobo
+  "^worldsemi,.*":
+    description: WorldSemi Co., Limited
   "^wanchanglong,.*":
     description: Wanchanglong Electronics Technology(SHENZHEN)Co.,Ltd.
   "^x-powers,.*":
Signature · 1 line
2.38.1
#3 lore raw

PATCH v2 2/3 dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

In reply to Chuanhong Guo

This patch adds dt binding schema for WorldSemi WS2812B driven using SPI bus.

---
Changes since v1:
remove linux driver reference from description remove some obvious descriptions
fix unit address regex in multi-led property drop various minItems
add maxItems = 1 to reg
fix node names and property orders in binding example drop -spi from compatible string
add default-brightness

 .../bindings/leds/worldsemi,ws2812b.yaml      | 138 ++++++++++++++++++
 1 file changed, 138 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +138 -0
new file mode 100644
index 000000000000..f91908d0acef
@@ -0,0 +1,138 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/worldsemi,ws2812b.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: WS2812B LEDs driven using SPI
+
+maintainers:
+  - Chuanhong Guo <[email protected]>
+
+description: |
+  WorldSemi WS2812B is a individually addressable LED chip that can be chained
+  together and controlled individually using a single wire.
+  This binding describes a chain of WS2812B LEDs connected to the SPI MOSI pin.
+  Typical setups includes connecting the data pin of the LED chain to MOSI as
+  the only device or using CS and MOSI with a tri-state voltage-level shifter
+  for the data pin.
+  The SPI frequency needs to be 2.105MHz~2.85MHz for the timing to be correct
+  and the controller needs to send all the bytes continuously.
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+properties:
+  compatible:
+    const: worldsemi,ws2812b
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    minimum: 2105000
+    maximum: 2850000
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^multi-led@[0-9a-f]+$":
+    type: object
+    $ref: leds-class-multicolor.yaml#
+    unevaluatedProperties: false
+
+    properties:
+      color-index:
+        description: |
+          A 3-item array specifying color of each components in this LED. It
+          should be one of the LED_COLOR_ID_* prefixed definitions from the
+          header include/dt-bindings/leds/common.h. Defaults to
+          <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>
+          if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array
+        maxItems: 3
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {
+            compatible = "worldsemi,ws2812b";
+            reg = <0>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+            spi-max-frequency = <2850000>;
+            multi-led@0 {
+                reg = <0>;
+                color-index = <LED_COLOR_ID_RED LED_COLOR_ID_GREEN LED_COLOR_ID_BLUE>;
+                default-brightness = <30>;
+                default-intensity = <10 50 90>;
+                color = <LED_COLOR_ID_RGB>;
+                function = LED_FUNCTION_STATUS;
+                function-enumerator = <0>;
+            };
+            multi-led@1 {
+                reg = <1>;
+                color = <LED_COLOR_ID_RGB>;
+                function = LED_FUNCTION_STATUS;
+                function-enumerator = <1>;
+            };
+            multi-led@2 {
+                reg = <2>;
+                color = <LED_COLOR_ID_RGB>;
+                function = LED_FUNCTION_STATUS;
+                function-enumerator = <2>;
+            };
+            multi-led@3 {
+                reg = <3>;
+                color = <LED_COLOR_ID_RGB>;
+                function = LED_FUNCTION_STATUS;
+                function-enumerator = <3>;
+            };
+        };
+    };
+
+...
Signature · 1 line
2.38.1
#4 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Quoted 2 lines · Chuanhong Guo

This patch adds dt binding schema for WorldSemi WS2812B driven using SPI bus.

Do not use "This commit/patch".
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95

Quoted 86 lines

---
Changes since v1:
remove linux driver reference from description remove some obvious descriptions
fix unit address regex in multi-led property drop various minItems
add maxItems = 1 to reg
fix node names and property orders in binding example drop -spi from compatible string
add default-brightness

 .../bindings/leds/worldsemi,ws2812b.yaml      | 138 ++++++++++++++++++
 1 file changed, 138 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +63 -0
new file mode 100644
index 000000000000..f91908d0acef
@@ -0,0 +1,138 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/worldsemi,ws2812b.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: WS2812B LEDs driven using SPI
+
+maintainers:
+  - Chuanhong Guo <[email protected]>
+
+description: |
+  WorldSemi WS2812B is a individually addressable LED chip that can be chained
+  together and controlled individually using a single wire.
+  This binding describes a chain of WS2812B LEDs connected to the SPI MOSI pin.
+  Typical setups includes connecting the data pin of the LED chain to MOSI as
+  the only device or using CS and MOSI with a tri-state voltage-level shifter
+  for the data pin.
+  The SPI frequency needs to be 2.105MHz~2.85MHz for the timing to be correct
+  and the controller needs to send all the bytes continuously.
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+properties:
+  compatible:
+    const: worldsemi,ws2812b
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    minimum: 2105000
+    maximum: 2850000
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^multi-led@[0-9a-f]+$":
+    type: object
+    $ref: leds-class-multicolor.yaml#
+    unevaluatedProperties: false
+
+    properties:
+      color-index:
+        description: |
+          A 3-item array specifying color of each components in this LED. It
+          should be one of the LED_COLOR_ID_* prefixed definitions from the
+          header include/dt-bindings/leds/common.h. Defaults to
+          <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>
+          if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array
+        maxItems: 3
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 73

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array

I am still not convinced these two properties are correct. Why this LED is special and defines default brightness and intensity and other LEDs do not? You explained you are doing it for user-space which is usually not a valid reason for changes specific to one binding. Either all bindings should support it or none.

Quoted 19 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

so rather not the first one ("leds").

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 109

Quoted 7 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +7 -0
+            compatible = "worldsemi,ws2812b";
+            reg = <0>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+            spi-max-frequency = <2850000>;
+            multi-led@0 {
+                reg = <0>;

Best regards,
Krzysztof

#5 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Hi!

Quoted 7 lines · Krzysztof Kozlowski
Quoted 2 lines · Chuanhong Guo

This patch adds dt binding schema for WorldSemi WS2812B driven using SPI bus.

Do not use "This commit/patch".
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95

OK.

Quoted 15 lines

[...]

Quoted 14 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +14 -0
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
Quoted 8 lines

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 73

Quoted 2 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +2 -0
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array

I am still not convinced these two properties are correct. Why this LED is special and defines default brightness and intensity and other LEDs do not? You explained you are doing it for user-space which is usually not a valid reason for changes specific to one binding. Either all bindings should support it or none.

There's already a default-state for simple LEDs without brightness control so I think it makes sense to add default-brightness for LEDs with brightness control and default-intensity for colored LEDs. The default-state seems to be implemented in various LED drivers, so I implemented these two properties in my LED driver. There's nothing device-specific about these two properties.

Quoted 36 lines
Quoted 20 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

Quoted 1 line

so rather not the first one ("leds").

As you can see, this node describes a chain of LEDs, not a single LED, so the plural form is more appropriate than the singular form.

Quoted 4 lines

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

This also isn't appropriate. WS2812B is a single LED package of 3 diodes and a microcontroller. If we treat every package as a LED, the SPI MOSI is connected directly to the LED packages themselves with no controller in between. If we treat the microcontroller as a led-controller, every LED contains its own controller, instead of one controller controlling all LEDs, and the parent node still shouldn't be called a led-controller.

Here's a picture of the WS2812B LED package:
https://cdn-shop.adafruit.com/970x728/1655-00.jpg
and a chain of them:
https://cdn-shop.adafruit.com/970x728/1463-00.jpg

--
Regards,
Chuanhong Guo

#6 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Quoted 23 lines · Chuanhong Guo
Quoted 14 lines
Quoted 14 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +14 -0
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
Quoted 8 lines

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 73

Quoted 2 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +2 -0
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array

I am still not convinced these two properties are correct. Why this LED is special and defines default brightness and intensity and other LEDs do not? You explained you are doing it for user-space which is usually not a valid reason for changes specific to one binding. Either all bindings should support it or none.

Quoted 6 lines

There's already a default-state for simple LEDs without brightness control so I think it makes sense to add default-brightness for LEDs with brightness control and default-intensity for colored LEDs. The default-state seems to be implemented in various LED drivers, so I implemented these two properties in my LED driver. There's nothing device-specific about these two properties.

default-state has a bit different purpose - to prevent any glitches/changes when probing driver. Other values should not be controller by default, at least not for this specific LED. If you want to change common LED bindings and LED maintainers agree, sure, that's different case.

Your device does not require these default brightness/intensity properties... or at least you did not provide rationale why your device (not driver... you keep referring to driver for some reason) needs them.

Quoted 56 lines
Quoted 36 lines
Quoted 20 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

Quoted 1 line

so rather not the first one ("leds").

As you can see, this node describes a chain of LEDs, not a single LED, so the plural form is more appropriate than the singular form.

Quoted 4 lines

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

This also isn't appropriate. WS2812B is a single LED package of 3 diodes and a microcontroller. If we treat every package as a LED, the SPI MOSI is connected directly to the LED packages themselves with no controller in between. If we treat the microcontroller as a led-controller, every LED contains its own controller, instead of one controller controlling all LEDs, and the parent node still shouldn't be called a led-controller.

Quoted 4 lines

Here's a picture of the WS2812B LED package:
https://cdn-shop.adafruit.com/970x728/1655-00.jpg
and a chain of them:
https://cdn-shop.adafruit.com/970x728/1463-00.jpg

Then your bindings and DTS do not represent the hardware.

Best regards,
Krzysztof

#7 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Hi!

Quoted 32 lines · Krzysztof Kozlowski
Quoted 23 lines · Chuanhong Guo
Quoted 14 lines
Quoted 14 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +14 -0
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
Quoted 8 lines

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 73

Quoted 2 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +2 -0
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array

I am still not convinced these two properties are correct. Why this LED is special and defines default brightness and intensity and other LEDs do not? You explained you are doing it for user-space which is usually not a valid reason for changes specific to one binding. Either all bindings should support it or none.

Quoted 6 lines

There's already a default-state for simple LEDs without brightness control so I think it makes sense to add default-brightness for LEDs with brightness control and default-intensity for colored LEDs. The default-state seems to be implemented in various LED drivers, so I implemented these two properties in my LED driver. There's nothing device-specific about these two properties.

Quoted 2 lines

default-state has a bit different purpose - to prevent any glitches/changes when probing driver.

OK. I didn't know that property is used in this way. I can live without them. I'll drop it in the next version.

Quoted 57 lines
Quoted 57 lines
Quoted 37 lines
Quoted 21 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

Quoted 1 line

so rather not the first one ("leds").

As you can see, this node describes a chain of LEDs, not a single LED, so the plural form is more appropriate than the singular form.

Quoted 4 lines

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

This also isn't appropriate. WS2812B is a single LED package of 3 diodes and a microcontroller. If we treat every package as a LED, the SPI MOSI is connected directly to the LED packages themselves with no controller in between. If we treat the microcontroller as a led-controller, every LED contains its own controller, instead of one controller controlling all LEDs, and the parent node still shouldn't be called a led-controller.

Quoted 6 lines
Quoted 4 lines

Here's a picture of the WS2812B LED package:
https://cdn-shop.adafruit.com/970x728/1655-00.jpg
and a chain of them:
https://cdn-shop.adafruit.com/970x728/1463-00.jpg

Then your bindings and DTS do not represent the hardware.

How should this hardware be represented, then?

The connection can be:

SPI-MOSI---LED1---LED2---LED3---...---LEDN

or

SPI-MOSI---Tri-state signal gate---LED1---LED2---LED3---...---LEDN SPI-CS-----|

Signature · 2 lines
Regards,
Chuanhong Guo
#8 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Quoted 108 lines · Chuanhong Guo

Hi!

Quoted 32 lines · Krzysztof Kozlowski
Quoted 23 lines · Chuanhong Guo
Quoted 14 lines
Quoted 14 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +14 -0
+
+      default-brightness:
+        description:
+          The default brightness that should be applied to the LED by the operating
+          system on start-up. The brightness should not exceed the brightness the
+          LED can provide.
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 255
+        default: 0
+
+      default-intensity:
+        description: |
+          An array of 3 integer specifying the default intensity of each color
Quoted 8 lines

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 73

Quoted 2 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +2 -0
+          components in this LED. <255 255 255> if unspecified.
+        $ref: /schemas/types.yaml#/definitions/uint32-array

I am still not convinced these two properties are correct. Why this LED is special and defines default brightness and intensity and other LEDs do not? You explained you are doing it for user-space which is usually not a valid reason for changes specific to one binding. Either all bindings should support it or none.

Quoted 6 lines

There's already a default-state for simple LEDs without brightness control so I think it makes sense to add default-brightness for LEDs with brightness control and default-intensity for colored LEDs. The default-state seems to be implemented in various LED drivers, so I implemented these two properties in my LED driver. There's nothing device-specific about these two properties.

Quoted 2 lines

default-state has a bit different purpose - to prevent any glitches/changes when probing driver.

OK. I didn't know that property is used in this way. I can live without them. I'll drop it in the next version.

Quoted 57 lines
Quoted 57 lines
Quoted 37 lines
Quoted 21 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

Quoted 1 line

so rather not the first one ("leds").

As you can see, this node describes a chain of LEDs, not a single LED, so the plural form is more appropriate than the singular form.

Quoted 4 lines

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

This also isn't appropriate. WS2812B is a single LED package of 3 diodes and a microcontroller. If we treat every package as a LED, the SPI MOSI is connected directly to the LED packages themselves with no controller in between. If we treat the microcontroller as a led-controller, every LED contains its own controller, instead of one controller controlling all LEDs, and the parent node still shouldn't be called a led-controller.

Quoted 6 lines
Quoted 4 lines

Here's a picture of the WS2812B LED package:
https://cdn-shop.adafruit.com/970x728/1655-00.jpg
and a chain of them:
https://cdn-shop.adafruit.com/970x728/1463-00.jpg

Then your bindings and DTS do not represent the hardware.

How should this hardware be represented, then?

Quoted 8 lines

The connection can be:

SPI-MOSI---LED1---LED2---LED3---...---LEDN

or

SPI-MOSI---Tri-state signal gate---LED1---LED2---LED3---...---LEDN SPI-CS-----|

I would look at it this as either of:
1. serially linked separate LED controllers (so multiple device nodes)

2. one LED controller handling the entire LED system of many sub-controllers.

For the (2) I proposed the name led-controller. If you think this is not (2), then looks like (1) and you should have many devices... which probably is not doable on itself. And how to call this entire set of separate LED controllers? Heh, can be also some controller, like led-controller.

Best regards,
Krzysztof

#9 lore raw

Re: [PATCH v2 2/3] dt-bindings: leds: add dt schema for worldsemi,ws2812b-spi

Quoted 76 lines · Krzysztof Kozlowski
Quoted 64 lines
Quoted 55 lines
Quoted 55 lines
Quoted 35 lines
Quoted 19 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +19 -0
+        maxItems: 3
+        items:
+          minimum: 0
+          maximum: 255
+
+      reg:
+        description: |
+          Which LED this node represents. The reg of the first LED on the chain
+          is 0.
+        maxItems: 1
+
+    required:
+      - reg
+      - color
+      - function
+
+required:
+  - compatible
+

Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml line 102

Quoted 10 lines
Documentation/devicetree/bindings/leds/worldsemi,ws2812b.yaml new file +10 -0
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/leds/common.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        leds@0 {

git grep leds@ -- Documentation/devicetree/ | wc -l 1
git grep led@ -- Documentation/devicetree/ | wc -l 165

Quoted 1 line

so rather not the first one ("leds").

As you can see, this node describes a chain of LEDs, not a single LED, so the plural form is more appropriate than the singular form.

Quoted 4 lines

There is also:
git grep led-controller@ -- Documentation/devicetree/ | wc -l 30

This also isn't appropriate. WS2812B is a single LED package of 3 diodes and a microcontroller. If we treat every package as a LED, the SPI MOSI is connected directly to the LED packages themselves with no controller in between. If we treat the microcontroller as a led-controller, every LED contains its own controller, instead of one controller controlling all LEDs, and the parent node still shouldn't be called a led-controller.

Quoted 6 lines
Quoted 4 lines

Here's a picture of the WS2812B LED package:
https://cdn-shop.adafruit.com/970x728/1655-00.jpg
and a chain of them:
https://cdn-shop.adafruit.com/970x728/1463-00.jpg

Then your bindings and DTS do not represent the hardware.

How should this hardware be represented, then?

Quoted 8 lines

The connection can be:

SPI-MOSI---LED1---LED2---LED3---...---LEDN

or

SPI-MOSI---Tri-state signal gate---LED1---LED2---LED3---...---LEDN SPI-CS-----|

I would look at it this as either of:
1. serially linked separate LED controllers (so multiple device nodes)

Quoted 8 lines

2. one LED controller handling the entire LED system of many sub-controllers.

For the (2) I proposed the name led-controller. If you think this is not (2), then looks like (1) and you should have many devices... which probably is not doable on itself. And how to call this entire set of separate LED controllers? Heh, can be also some controller, like led-controller.

OK. I'll name it led-controller in the next version.

Signature · 2 lines
Regards,
Chuanhong Guo
#10 lore raw

PATCH v2 3/3 leds: add driver for SPI driven WorldSemi WS2812B RGB LEDs

In reply to Chuanhong Guo

This patch adds support for driving a chain of WS2812B LED chips using SPI bus.

WorldSemi WS2812B is a individually addressable LED chip that can be chained together and controlled individually using a single wire. The chip recognize a long pulse as a bit of 1 and a short pulse as a bit of 0. Host sends a continuous stream of 24-bits color values, each LED chip takes the first 3 byte it receives as its color value and passes the leftover bytes to the next LED on the chain.

This driver simulates this protocol using SPI bus by sending a long pulse as 3'b110 and a short pulse as 3'b100. The SPI frequency needs to be 2.105MHz~2.85MHz for the timing to be correct and the controller needs to transfer all the bytes continuously.

---
Changes since v1:
rename the driver to drop -spi suffix
add support for default-brightness
use fwnode apis for properties

 drivers/leds/rgb/Kconfig        |  11 ++
 drivers/leds/rgb/Makefile       |   1 +
 drivers/leds/rgb/leds-ws2812b.c | 235 ++++++++++++++++++++++++++++++++
 3 files changed, 247 insertions(+)
 create mode 100644 drivers/leds/rgb/leds-ws2812b.c
drivers/leds/rgb/Kconfig +11 -0
index 204cf470beae..5c2081852f01 100644
@@ -26,4 +26,15 @@ config LEDS_QCOM_LPG
 
 	  If compiled as a module, the module will be named leds-qcom-lpg.
 
+config LEDS_WS2812B
+	tristate "SPI driven WS2812B RGB LED support"
+	depends on OF
+	depends on SPI
+	help
+	  This option enables support for driving daisy-chained WS2812B RGB
+	  LED chips using SPI bus. This driver simulates the single-wire
+	  protocol by sending bits over the SPI MOSI pin. For this to work,
+	  the SPI frequency should be 2.105MHz~2.85MHz and the controller
+	  needs to transfer all the bytes continuously.
+
 endif # LEDS_CLASS_MULTICOLOR
drivers/leds/rgb/Makefile +1 -0
index 0675bc0f6e18..a6f855eaeb14 100644
@@ -2,3 +2,4 @@
 
 obj-$(CONFIG_LEDS_PWM_MULTICOLOR)	+= leds-pwm-multicolor.o
 obj-$(CONFIG_LEDS_QCOM_LPG)		+= leds-qcom-lpg.o
+obj-$(CONFIG_LEDS_WS2812B)		+= leds-ws2812b.o
drivers/leds/rgb/leds-ws2812b.c new file +235 -0

235 lines not on this page · raw message

Signature · 1 line
2.38.1