xref: /freebsd/sys/contrib/device-tree/Bindings/leds/backlight/kinetic,ktz8866.yaml (revision 2f9966ff63d65bd474478888c9088eeae3f9c669) 
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  reg:
25    maxItems: 1
26
27  vddpos-supply:
28    description: positive boost supply regulator.
29
30  vddneg-supply:
31    description: negative boost supply regulator.
32
33  enable-gpios:
34    description: GPIO to use to enable/disable the backlight (HWEN pin).
35    maxItems: 1
36
37  current-num-sinks:
38    description: number of the LED current sinks' channels.
39    $ref: /schemas/types.yaml#/definitions/uint32
40    enum: [1, 2, 3, 4, 5, 6]
41
42  kinetic,current-ramp-delay-ms:
43    description: |
44      LED current ramping delay time in milliseconds, note that the
45      case 1 will be mapped to 1μs.
46    enum: [1, 2, 4, 8, 16, 32, 64, 128, 192, 256, 320, 384, 448, 512, 576, 640]
47
48  kinetic,led-enable-ramp-delay-ms:
49    description: |
50      LED on/off ramping delay time in milliseconds, note that the case 0 will be
51      mapped to 512μs because ktz8866 can't ramp faster than it.
52    enum: [0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384]
53
54  kinetic,enable-lcd-bias:
55    description: Set if we want to output bias power supply for LCD.
56    type: boolean
57
58required:
59  - compatible
60  - reg
61  - vddpos-supply
62  - vddneg-supply
63  - enable-gpios
64
65unevaluatedProperties: false
66
67examples:
68  - |
69    #include <dt-bindings/gpio/gpio.h>
70
71    i2c {
72        #address-cells = <1>;
73        #size-cells = <0>;
74
75        backlight@11 {
76            compatible = "kinetic,ktz8866";
77            reg = <0x11>;
78            vddpos-supply = <&bl_vddpos_5p5>;
79            vddneg-supply = <&bl_vddneg_5p5>;
80            enable-gpios = <&tlmm 139 GPIO_ACTIVE_HIGH>;
81            current-num-sinks = <5>;
82            kinetic,current-ramp-delay-ms = <128>;
83            kinetic,led-enable-ramp-delay-ms = <1>;
84            kinetic,enable-lcd-bias;
85        };
86    };
87