GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / leds / nxp,pca953x.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/leds/nxp,pca953x.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: NXP PCA9532 LED Dimmer
8
9 maintainers:
10   - Riku Voipio <riku.voipio@iki.fi>
11
12 description: |
13   The PCA9532 family is SMBus I/O expander optimized for dimming LEDs.
14   The PWM support 256 steps.
15
16   For more product information please see the link below:
17     https://www.nxp.com/docs/en/data-sheet/PCA9532.pdf
18
19 properties:
20   compatible:
21     enum:
22       - nxp,pca9530
23       - nxp,pca9531
24       - nxp,pca9532
25       - nxp,pca9533
26
27   reg:
28     maxItems: 1
29
30   gpio-controller: true
31
32   gpio-line-names:
33     minItems: 1
34     maxItems: 16
35
36   '#gpio-cells':
37     const: 2
38
39 patternProperties:
40   "^led-[0-9a-z]+$":
41     type: object
42     $ref: common.yaml#
43     unevaluatedProperties: false
44
45     properties:
46       type:
47         description: |
48           Output configuration, see include/dt-bindings/leds/leds-pca9532.h
49         $ref: /schemas/types.yaml#/definitions/uint32
50         default: 0
51         minimum: 0
52         maximum: 4
53
54 required:
55   - compatible
56   - reg
57
58 additionalProperties: false
59
60 examples:
61   - |
62     #include <dt-bindings/leds/leds-pca9532.h>
63
64     i2c {
65         #address-cells = <1>;
66         #size-cells = <0>;
67
68         led-controller@62 {
69             compatible = "nxp,pca9533";
70             reg = <0x62>;
71
72             led-1 {
73                 label = "pca:red:power";
74                 type = <PCA9532_TYPE_LED>;
75             };
76
77             led-2 {
78                 label = "pca:green:power";
79                 type = <PCA9532_TYPE_LED>;
80             };
81
82             led-3 {
83                 type = <PCA9532_TYPE_LED>;
84                 default-state = "on";
85             };
86
87             led-4 {
88                 type = <PCA9532_TYPE_LED>;
89                 default-state = "keep";
90             };
91         };
92     };
93
94 ...