xref: /freebsd/sys/contrib/device-tree/Bindings/leds/backlight/kinetic,ktz8866.yaml (revision cb7aa33ac6cd46a5434798e50363136e64f3ae98) 
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    enum: [1, 2, 3, 4, 5, 6]
37
38  kinetic,current-ramp-delay-ms:
39    description: |
40      LED current ramping delay time in milliseconds, note that the
41      case 1 will be mapped to 1μs.
42    enum: [1, 2, 4, 8, 16, 32, 64, 128, 192, 256, 320, 384, 448, 512, 576, 640]
43
44  kinetic,led-enable-ramp-delay-ms:
45    description: |
46      LED on/off ramping delay time in milliseconds, note that the case 0 will be
47      mapped to 512μs because ktz8866 can't ramp faster than it.
48    enum: [0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384]
49
50  kinetic,enable-lcd-bias:
51    description: Set if we want to output bias power supply for LCD.
52    type: boolean
53
54required:
55  - compatible
56  - vddpos-supply
57  - vddneg-supply
58  - enable-gpios
59
60unevaluatedProperties: false
61
62examples:
63  - |
64    #include <dt-bindings/gpio/gpio.h>
65
66    backlight {
67        compatible = "kinetic,ktz8866";
68
69        vddpos-supply = <&bl_vddpos_5p5>;
70        vddneg-supply = <&bl_vddneg_5p5>;
71        enable-gpios = <&tlmm 139 GPIO_ACTIVE_HIGH>;
72        current-num-sinks = <5>;
73        kinetic,current-ramp-delay-ms = <128>;
74        kinetic,led-enable-ramp-delay-ms = <1>;
75        kinetic,enable-lcd-bias;
76    };
77