xref: /linux/Documentation/devicetree/bindings/leds/backlight/kinetic,ktz8866.yaml (revision c156d4af4354091c38a1cbef62c0b1574e8c4394) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/leds/backlight/kinetic,ktz8866.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Kinetic Technologies KTZ8866 backlight
8
9maintainers:
10  - Jianhua Lu <lujianhua000@gmail.com>
11
12description: |
13  The Kinetic Technologies KTZ8866 is a high efficiency 6-channels-current-sinks
14  led backlight with dual lcd bias power.
15  https://www.kinet-ic.com/ktz8866/
16
17allOf:
18  - $ref: common.yaml#
19
20properties:
21  compatible:
22    const: kinetic,ktz8866
23
24  vddpos-supply:
25    description: positive boost supply regulator.
26
27  vddneg-supply:
28    description: negative boost supply regulator.
29
30  enable-gpios:
31    description: GPIO to use to enable/disable the backlight (HWEN pin).
32    maxItems: 1
33
34  current-num-sinks:
35    description: number of the LED current sinks' channels.
36    $ref: /schemas/types.yaml#/definitions/uint32
37    enum: [1, 2, 3, 4, 5, 6]
38
39  kinetic,current-ramp-delay-ms:
40    description: |
41      LED current ramping delay time in milliseconds, note that the
42      case 1 will be mapped to 1μs.
43    enum: [1, 2, 4, 8, 16, 32, 64, 128, 192, 256, 320, 384, 448, 512, 576, 640]
44
45  kinetic,led-enable-ramp-delay-ms:
46    description: |
47      LED on/off ramping delay time in milliseconds, note that the case 0 will be
48      mapped to 512μs because ktz8866 can't ramp faster than it.
49    enum: [0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384]
50
51  kinetic,enable-lcd-bias:
52    description: Set if we want to output bias power supply for LCD.
53    type: boolean
54
55required:
56  - compatible
57  - vddpos-supply
58  - vddneg-supply
59  - enable-gpios
60
61unevaluatedProperties: false
62
63examples:
64  - |
65    #include <dt-bindings/gpio/gpio.h>
66
67    backlight {
68        compatible = "kinetic,ktz8866";
69
70        vddpos-supply = <&bl_vddpos_5p5>;
71        vddneg-supply = <&bl_vddneg_5p5>;
72        enable-gpios = <&tlmm 139 GPIO_ACTIVE_HIGH>;
73        current-num-sinks = <5>;
74        kinetic,current-ramp-delay-ms = <128>;
75        kinetic,led-enable-ramp-delay-ms = <1>;
76        kinetic,enable-lcd-bias;
77    };
78