Merge tag 'drm-intel-next-2021-01-04' of git://anongit.freedesktop.org/drm/drm-intel...
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / leds / leds-el15203000.txt
1 Crane Merchandising System - EL15203000 LED driver
2 --------------------------------------------------
3
4 This LED Board (aka RED LEDs board) is widely used in
5 coffee vending machines produced by Crane Merchandising Systems.
6 The board manages 3 LEDs and supports predefined blinking patterns
7 for specific leds.
8
9 Vending area LED encoded with symbol 'V' (hex code 0x56).
10 Doesn't have any hardware blinking pattern.
11
12 Screen light tube LED which surrounds vending machine screen and
13 encoded with symbol 'S' (hex code 0x53). Supports blinking breathing pattern.
14
15 Water Pipe LED encoded with symbol 'P' (hex code 0x50) and
16 actually consists of 5 LEDs that exposed by protocol like one LED.
17 Supports next patterns:
18 - cascade pattern
19 - inversed cascade pattern
20 - bounce pattern
21 - inversed bounce pattern
22
23 Required properties:
24 - compatible : "crane,el15203000"
25 - #address-cells : must be 1
26 - #size-cells : must be 0
27
28 Property rules described in Documentation/devicetree/bindings/spi/spi-bus.txt
29 apply. In particular, "reg" and "spi-max-frequency" properties must be given.
30
31 Optional LED sub-node properties:
32 - function:
33         see Documentation/devicetree/bindings/leds/common.txt
34 - color:
35         see Documentation/devicetree/bindings/leds/common.txt
36
37 Example
38 -------
39
40 #include <dt-bindings/leds/common.h>
41
42 led-controller@0 {
43         compatible = "crane,el15203000";
44         reg = <0>;
45         spi-max-frequency = <50000>;
46         #address-cells = <1>;
47         #size-cells = <0>;
48
49         /* water pipe */
50         led@50 {
51                 reg = <0x50>;
52                 function = "pipe";
53                 color = <LED_COLOR_ID_RED>;
54         };
55
56         /* screen frame */
57         led@53 {
58                 reg = <0x53>;
59                 function = "screen";
60                 color = <LED_COLOR_ID_RED>;
61         };
62
63         /* vending area */
64         led@56 {
65                 reg = <0x56>;
66                 function = "vend";
67                 color = <LED_COLOR_ID_RED>;
68         };
69 };