diff mbox series

[RESEND,v6,1/2] dt-bindings: leds: convert ktd2692 bindings to yaml

Message ID 20220504150457.5626-2-markuss.broks@gmail.com
State Superseded
Headers show
Series Make AUX gpio pin optional for ktd2692 | expand

Commit Message

Markuss Broks May 4, 2022, 3:04 p.m. UTC
This patch converts the leds-ktd2692.txt bindings to modern yaml
style device-tree bindings.

Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

Signed-off-by: Markuss Broks <markuss.broks@gmail.com>
---
 .../bindings/leds/kinetic,ktd2692.yaml        | 87 +++++++++++++++++++
 .../devicetree/bindings/leds/leds-ktd2692.txt | 50 -----------
 2 files changed, 87 insertions(+), 50 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
 delete mode 100644 Documentation/devicetree/bindings/leds/leds-ktd2692.txt

Comments

Andy Shevchenko May 4, 2022, 3:26 p.m. UTC | #1
On Wed, May 4, 2022 at 5:06 PM Markuss Broks <markuss.broks@gmail.com> wrote:
>
> This patch converts the leds-ktd2692.txt bindings to modern yaml
> style device-tree bindings.

> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
>
> Signed-off-by: Markuss Broks <markuss.broks@gmail.com>

There must be no blank lines in the tag block.

> ---
>  .../bindings/leds/kinetic,ktd2692.yaml        | 87 +++++++++++++++++++
>  .../devicetree/bindings/leds/leds-ktd2692.txt | 50 -----------
>  2 files changed, 87 insertions(+), 50 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
>  delete mode 100644 Documentation/devicetree/bindings/leds/leds-ktd2692.txt
>
> diff --git a/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml b/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
> new file mode 100644
> index 000000000000..bac95a51afa1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
> @@ -0,0 +1,87 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/kinetic,ktd2692.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: KTD2692 Flash LED Driver from Kinetic Technologies
> +
> +maintainers:
> +  - Markuss Broks <markuss.broks@gmail.com>
> +
> +description: |
> +  KTD2692 is the ideal power solution for high-power flash LEDs.
> +  It uses ExpressWire single-wire programming for maximum flexibility.
> +
> +  The ExpressWire interface through CTRL pin can control LED on/off and
> +  enable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
> +  Flash timeout, LVP(low voltage protection).
> +
> +  Also, When the AUX pin is pulled high while CTRL pin is high,
> +  LED current will be ramped up to the flash-mode current level.
> +
> +properties:
> +  compatible:
> +    const: kinetic,ktd2692
> +
> +  ctrl-gpios:
> +    maxItems: 1
> +    description: Specifier of the GPIO connected to CTRL pin.
> +
> +  aux-gpios:
> +    maxItems: 1
> +    description: Specifier of the GPIO connected to CTRL pin.
> +
> +  vin-supply:
> +    description: LED supply (2.7V to 5.5V).
> +
> +  led:
> +    type: object
> +    $ref: common.yaml#
> +    description: Properties for the LED.
> +    properties:
> +      function: true
> +      color: true
> +      flash-max-timeout-us:
> +        description: Flash LED maximum timeout.
> +
> +      led-max-microamp:
> +        maximum: 300000
> +        description: Minimum Threshold for Timer protection
> +          is defined internally (Maximum 300mA).
> +
> +      flash-max-microamp:
> +        maximum: 300000
> +        description: Flash LED maximum current
> +          Formula - I(uA) = 15000000 / Rset.
> +
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - ctrl-gpios
> +  - led
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/leds/common.h>
> +
> +    ktd2692 {
> +      compatible = "kinetic,ktd2692";
> +      ctrl-gpios = <&gpc0 1 0>;
> +      aux-gpios = <&gpc0 2 0>;
> +      vin-supply = <&vbat>;
> +
> +      led {
> +        function = LED_FUNCTION_FLASH;
> +        color = <LED_COLOR_ID_WHITE>;
> +        flash-max-timeout-us = <250000>;
> +        flash-max-microamp = <150000>;
> +        led-max-microamp = <25000>;
> +      };
> +    };
> +
> +...
> diff --git a/Documentation/devicetree/bindings/leds/leds-ktd2692.txt b/Documentation/devicetree/bindings/leds/leds-ktd2692.txt
> deleted file mode 100644
> index 853737452580..000000000000
> --- a/Documentation/devicetree/bindings/leds/leds-ktd2692.txt
> +++ /dev/null
> @@ -1,50 +0,0 @@
> -* Kinetic Technologies - KTD2692 Flash LED Driver
> -
> -KTD2692 is the ideal power solution for high-power flash LEDs.
> -It uses ExpressWire single-wire programming for maximum flexibility.
> -
> -The ExpressWire interface through CTRL pin can control LED on/off and
> -enable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
> -Flash timeout, LVP(low voltage protection).
> -
> -Also, When the AUX pin is pulled high while CTRL pin is high,
> -LED current will be ramped up to the flash-mode current level.
> -
> -Required properties:
> -- compatible : Should be "kinetic,ktd2692".
> -- ctrl-gpios : Specifier of the GPIO connected to CTRL pin.
> -- aux-gpios : Specifier of the GPIO connected to AUX pin.
> -
> -Optional properties:
> -- vin-supply : "vin" LED supply (2.7V to 5.5V).
> -  See Documentation/devicetree/bindings/regulator/regulator.txt
> -
> -A discrete LED element connected to the device must be represented by a child
> -node - See Documentation/devicetree/bindings/leds/common.txt
> -
> -Required properties for flash LED child nodes:
> -  See Documentation/devicetree/bindings/leds/common.txt
> -- led-max-microamp : Minimum Threshold for Timer protection
> -  is defined internally (Maximum 300mA).
> -- flash-max-microamp : Flash LED maximum current
> -  Formula : I(mA) = 15000 / Rset.
> -- flash-max-timeout-us : Flash LED maximum timeout.
> -
> -Optional properties for flash LED child nodes:
> -- label : See Documentation/devicetree/bindings/leds/common.txt
> -
> -Example:
> -
> -ktd2692 {
> -       compatible = "kinetic,ktd2692";
> -       ctrl-gpios = <&gpc0 1 0>;
> -       aux-gpios = <&gpc0 2 0>;
> -       vin-supply = <&vbat>;
> -
> -       flash-led {
> -               label = "ktd2692-flash";
> -               led-max-microamp = <300000>;
> -               flash-max-microamp = <1500000>;
> -               flash-max-timeout-us = <1835000>;
> -       };
> -};
> --
> 2.35.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml b/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
new file mode 100644
index 000000000000..bac95a51afa1
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/kinetic,ktd2692.yaml
@@ -0,0 +1,87 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/kinetic,ktd2692.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: KTD2692 Flash LED Driver from Kinetic Technologies
+
+maintainers:
+  - Markuss Broks <markuss.broks@gmail.com>
+
+description: |
+  KTD2692 is the ideal power solution for high-power flash LEDs.
+  It uses ExpressWire single-wire programming for maximum flexibility.
+
+  The ExpressWire interface through CTRL pin can control LED on/off and
+  enable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
+  Flash timeout, LVP(low voltage protection).
+
+  Also, When the AUX pin is pulled high while CTRL pin is high,
+  LED current will be ramped up to the flash-mode current level.
+
+properties:
+  compatible:
+    const: kinetic,ktd2692
+
+  ctrl-gpios:
+    maxItems: 1
+    description: Specifier of the GPIO connected to CTRL pin.
+
+  aux-gpios:
+    maxItems: 1
+    description: Specifier of the GPIO connected to CTRL pin.
+
+  vin-supply:
+    description: LED supply (2.7V to 5.5V).
+
+  led:
+    type: object
+    $ref: common.yaml#
+    description: Properties for the LED.
+    properties:
+      function: true
+      color: true
+      flash-max-timeout-us:
+        description: Flash LED maximum timeout.
+
+      led-max-microamp:
+        maximum: 300000
+        description: Minimum Threshold for Timer protection
+          is defined internally (Maximum 300mA).
+
+      flash-max-microamp:
+        maximum: 300000
+        description: Flash LED maximum current
+          Formula - I(uA) = 15000000 / Rset.
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - ctrl-gpios
+  - led
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/leds/common.h>
+
+    ktd2692 {
+      compatible = "kinetic,ktd2692";
+      ctrl-gpios = <&gpc0 1 0>;
+      aux-gpios = <&gpc0 2 0>;
+      vin-supply = <&vbat>;
+
+      led {
+        function = LED_FUNCTION_FLASH;
+        color = <LED_COLOR_ID_WHITE>;
+        flash-max-timeout-us = <250000>;
+        flash-max-microamp = <150000>;
+        led-max-microamp = <25000>;
+      };
+    };
+
+...
diff --git a/Documentation/devicetree/bindings/leds/leds-ktd2692.txt b/Documentation/devicetree/bindings/leds/leds-ktd2692.txt
deleted file mode 100644
index 853737452580..000000000000
--- a/Documentation/devicetree/bindings/leds/leds-ktd2692.txt
+++ /dev/null
@@ -1,50 +0,0 @@ 
-* Kinetic Technologies - KTD2692 Flash LED Driver
-
-KTD2692 is the ideal power solution for high-power flash LEDs.
-It uses ExpressWire single-wire programming for maximum flexibility.
-
-The ExpressWire interface through CTRL pin can control LED on/off and
-enable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
-Flash timeout, LVP(low voltage protection).
-
-Also, When the AUX pin is pulled high while CTRL pin is high,
-LED current will be ramped up to the flash-mode current level.
-
-Required properties:
-- compatible : Should be "kinetic,ktd2692".
-- ctrl-gpios : Specifier of the GPIO connected to CTRL pin.
-- aux-gpios : Specifier of the GPIO connected to AUX pin.
-
-Optional properties:
-- vin-supply : "vin" LED supply (2.7V to 5.5V).
-  See Documentation/devicetree/bindings/regulator/regulator.txt
-
-A discrete LED element connected to the device must be represented by a child
-node - See Documentation/devicetree/bindings/leds/common.txt
-
-Required properties for flash LED child nodes:
-  See Documentation/devicetree/bindings/leds/common.txt
-- led-max-microamp : Minimum Threshold for Timer protection
-  is defined internally (Maximum 300mA).
-- flash-max-microamp : Flash LED maximum current
-  Formula : I(mA) = 15000 / Rset.
-- flash-max-timeout-us : Flash LED maximum timeout.
-
-Optional properties for flash LED child nodes:
-- label : See Documentation/devicetree/bindings/leds/common.txt
-
-Example:
-
-ktd2692 {
-	compatible = "kinetic,ktd2692";
-	ctrl-gpios = <&gpc0 1 0>;
-	aux-gpios = <&gpc0 2 0>;
-	vin-supply = <&vbat>;
-
-	flash-led {
-		label = "ktd2692-flash";
-		led-max-microamp = <300000>;
-		flash-max-microamp = <1500000>;
-		flash-max-timeout-us = <1835000>;
-	};
-};