xref: /linux/Documentation/devicetree/bindings/leds/lacie,ns2-leds.yaml (revision 67f8bc848ee31831336bd478e57d2f993551902e)
1*e36f8825SNinad Naik# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2*e36f8825SNinad Naik%YAML 1.2
3*e36f8825SNinad Naik---
4*e36f8825SNinad Naik$id: http://devicetree.org/schemas/leds/lacie,ns2-leds.yaml#
5*e36f8825SNinad Naik$schema: http://devicetree.org/meta-schemas/core.yaml#
6*e36f8825SNinad Naik
7*e36f8825SNinad Naiktitle: Dual-GPIO LEDs found on Network Space v2 (and parents)
8*e36f8825SNinad Naik
9*e36f8825SNinad Naikmaintainers:
10*e36f8825SNinad Naik  - Simon Guinot <simon.guinot@sequanux.org>
11*e36f8825SNinad Naik
12*e36f8825SNinad Naikdescription:
13*e36f8825SNinad Naik  The Network Space v2 dual-GPIO LED is wired to a CPLD. Three different LED
14*e36f8825SNinad Naik  modes are available, off, on and SATA activity blinking. The LED modes are
15*e36f8825SNinad Naik  controlled through two GPIOs (command and slow), each combination of values
16*e36f8825SNinad Naik  for the command/slow GPIOs corresponds to a LED mode.
17*e36f8825SNinad Naik
18*e36f8825SNinad Naikproperties:
19*e36f8825SNinad Naik  compatible:
20*e36f8825SNinad Naik    const: lacie,ns2-leds
21*e36f8825SNinad Naik
22*e36f8825SNinad NaikadditionalProperties:
23*e36f8825SNinad Naik  type: object
24*e36f8825SNinad Naik  $ref: common.yaml#
25*e36f8825SNinad Naik  unevaluatedProperties: false
26*e36f8825SNinad Naik
27*e36f8825SNinad Naik  description: Each child node represents a single LED
28*e36f8825SNinad Naik
29*e36f8825SNinad Naik  properties:
30*e36f8825SNinad Naik    cmd-gpio:
31*e36f8825SNinad Naik      maxItems: 1
32*e36f8825SNinad Naik      description: GPIO connected to the command LED output
33*e36f8825SNinad Naik
34*e36f8825SNinad Naik    slow-gpio:
35*e36f8825SNinad Naik      maxItems: 1
36*e36f8825SNinad Naik      description: GPIO connected to the slow LED output
37*e36f8825SNinad Naik
38*e36f8825SNinad Naik    num-modes:
39*e36f8825SNinad Naik      $ref: /schemas/types.yaml#/definitions/uint32
40*e36f8825SNinad Naik      description:
41*e36f8825SNinad Naik        Number of entries in modes-map.
42*e36f8825SNinad Naik
43*e36f8825SNinad Naik    modes-map:
44*e36f8825SNinad Naik      $ref: /schemas/types.yaml#/definitions/uint32-matrix
45*e36f8825SNinad Naik      description:
46*e36f8825SNinad Naik        A mapping between LED modes (off, on or SATA activity blinking) and
47*e36f8825SNinad Naik        the corresponding cmd-gpio/slow-gpio values. All the GPIO values
48*e36f8825SNinad Naik        combinations should be given in order to avoid having an unknown
49*e36f8825SNinad Naik        mode at driver probe time.
50*e36f8825SNinad Naik
51*e36f8825SNinad Naik      items:
52*e36f8825SNinad Naik        items:
53*e36f8825SNinad Naik          - description: LED mode
54*e36f8825SNinad Naik            enum: [0, 1, 2]
55*e36f8825SNinad Naik          - description: Command GPIO level
56*e36f8825SNinad Naik            enum: [0, 1]
57*e36f8825SNinad Naik          - description: Slow GPIO level
58*e36f8825SNinad Naik            enum: [0, 1]
59*e36f8825SNinad Naik
60*e36f8825SNinad Naik  required:
61*e36f8825SNinad Naik    - cmd-gpio
62*e36f8825SNinad Naik    - slow-gpio
63*e36f8825SNinad Naik    - modes-map
64*e36f8825SNinad Naik
65*e36f8825SNinad Naikrequired:
66*e36f8825SNinad Naik  - compatible
67*e36f8825SNinad Naik
68*e36f8825SNinad Naikexamples:
69*e36f8825SNinad Naik  - |
70*e36f8825SNinad Naik    #include <dt-bindings/leds/leds-ns2.h>
71*e36f8825SNinad Naik
72*e36f8825SNinad Naik    led-controller {
73*e36f8825SNinad Naik        compatible = "lacie,ns2-leds";
74*e36f8825SNinad Naik
75*e36f8825SNinad Naik        led-0 {
76*e36f8825SNinad Naik            label = "ns2:blue:sata";
77*e36f8825SNinad Naik            slow-gpio = <&gpio0 29 0>;
78*e36f8825SNinad Naik            cmd-gpio = <&gpio0 30 0>;
79*e36f8825SNinad Naik            modes-map = <NS_V2_LED_OFF  0 1
80*e36f8825SNinad Naik                         NS_V2_LED_ON   1 0
81*e36f8825SNinad Naik                         NS_V2_LED_ON   0 0
82*e36f8825SNinad Naik                         NS_V2_LED_SATA 1 1>;
83*e36f8825SNinad Naik        };
84*e36f8825SNinad Naik    };
85*e36f8825SNinad Naik...
86