linux-leds.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: Harrison Carter <hcarter@thegoodpenguin.co.uk>
Cc: Lee Jones <lee@kernel.org>, Pavel Machek <pavel@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Sakari Ailus <sakari.ailus@linux.intel.com>,
	linux-leds@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] dt-bindings: leds: as3645: Convert to DT schema
Date: Wed, 10 Sep 2025 10:05:27 -0500	[thread overview]
Message-ID: <20250910150527.GA54174-robh@kernel.org> (raw)
In-Reply-To: <20250909-ams-txt-to-dt-schema-v1-1-8a30c25c8295@thegoodpenguin.co.uk>

On Tue, Sep 09, 2025 at 09:50:04AM +0100, Harrison Carter wrote:
> Convert the ams,as3645a.txt to DT Schema format.
> 
> maintainer: set to what I found in MAINTAINERS
> 
> Signed-off-by: Harrison Carter <hcarter@thegoodpenguin.co.uk>
> ---
>  .../devicetree/bindings/leds/ams,as3645a.txt       |  85 --------------
>  .../devicetree/bindings/leds/ams,as3645a.yaml      | 130 +++++++++++++++++++++
>  2 files changed, 130 insertions(+), 85 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/leds/ams,as3645a.txt b/Documentation/devicetree/bindings/leds/ams,as3645a.txt
> deleted file mode 100644
> index 4af2987b25e92394ebd46456e30002d3ae3a6101..0000000000000000000000000000000000000000
> --- a/Documentation/devicetree/bindings/leds/ams,as3645a.txt
> +++ /dev/null
> @@ -1,85 +0,0 @@
> -Analog devices AS3645A device tree bindings
> -
> -The AS3645A flash LED controller can drive two LEDs, one high current
> -flash LED and one indicator LED. The high current flash LED can be
> -used in torch mode as well.
> -
> -Ranges below noted as [a, b] are closed ranges between a and b, i.e. a
> -and b are included in the range.
> -
> -Please also see common.txt in the same directory.
> -
> -
> -Required properties
> -===================
> -
> -compatible	: Must be "ams,as3645a".
> -reg		: The I2C address of the device. Typically 0x30.
> -#address-cells	: 1
> -#size-cells	: 0
> -
> -
> -Required properties of the flash child node (0)
> -===============================================
> -
> -reg: 0
> -flash-timeout-us: Flash timeout in microseconds. The value must be in
> -		  the range [100000, 850000] and divisible by 50000.
> -flash-max-microamp: Maximum flash current in microamperes. Has to be
> -		    in the range between [200000, 500000] and
> -		    divisible by 20000.
> -led-max-microamp: Maximum torch (assist) current in microamperes. The
> -		  value must be in the range between [20000, 160000] and
> -		  divisible by 20000.
> -ams,input-max-microamp: Maximum flash controller input current. The
> -			value must be in the range [1250000, 2000000]
> -			and divisible by 50000.
> -
> -
> -Optional properties of the flash child node
> -===========================================
> -
> -function	:  See Documentation/devicetree/bindings/leds/common.txt.
> -color		:  See Documentation/devicetree/bindings/leds/common.txt.
> -label		:  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
> -
> -
> -Required properties of the indicator child node (1)
> -===================================================
> -
> -reg: 1
> -led-max-microamp: Maximum indicator current. The allowed values are
> -		  2500, 5000, 7500 and 10000.
> -
> -Optional properties of the indicator child node
> -===============================================
> -
> -function	:  See Documentation/devicetree/bindings/leds/common.txt.
> -color		:  See Documentation/devicetree/bindings/leds/common.txt.
> -label		:  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
> -
> -
> -Example
> -=======
> -
> -#include <dt-bindings/leds/common.h>
> -
> -	as3645a@30 {
> -		#address-cells = <1>;
> -		#size-cells = <0>;
> -		reg = <0x30>;
> -		compatible = "ams,as3645a";
> -		led@0 {
> -			reg = <0x0>;
> -			flash-timeout-us = <150000>;
> -			flash-max-microamp = <320000>;
> -			led-max-microamp = <60000>;
> -			ams,input-max-microamp = <1750000>;
> -			function = LED_FUNCTION_FLASH;
> -		};
> -		led@1 {
> -			reg = <0x1>;
> -			led-max-microamp = <10000>;
> -			function = LED_FUNCTION_INDICATOR;
> -		};
> -	};
> diff --git a/Documentation/devicetree/bindings/leds/ams,as3645a.yaml b/Documentation/devicetree/bindings/leds/ams,as3645a.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..f956c20cc8fb379f370ad785a3d75f27d0cfa032
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/ams,as3645a.yaml
> @@ -0,0 +1,130 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/ams,as3645a.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AS3645A LED Controller
> +
> +maintainers:
> +  - Sakari Ailus <sakari.ailus@iki.fi>
> +
> +description: |

Don't need '|'.

> +  The AS3645A flash LED controller can drive two LEDs, one high current
> +  flash LED and one indicator LED. The high current flash LED can be
> +  used in torch mode as well.
> +
> +properties:
> +  compatible:
> +    const: ams,as3645a
> +
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0
> +
> +  reg:
> +    maxItems: 1
> +
> +  led@0:
> +    type: object
> +    $ref: common.yaml#
> +    unevaluatedProperties: false
> +
> +    properties:
> +      reg:
> +        const: 0
> +
> +      flash-timeout-us:
> +        minimum: 100000
> +        maximum: 850000

	   multipleOf: 50000

> +        description: |
> +          Flash timeout in microseconds. Must be divisible by 50000

Drop description. 

> +
> +      flash-max-microamp:
> +        minimum: 200000
> +        maximum: 500000
> +        description: |
> +          Maximum flash current in microamperes. Must be divisible by 20000
> +
> +      led-max-microamp:
> +        minimum: 20000
> +        maximum: 160000
> +        description: |
> +          Maximum torch (assist) current in microamperes Must be divisible by 20000

Same on these 2.

> +
> +      ams,input-max-microamp:
> +        minimum: 1250000
> +        maximum: 2000000
> +        description: |

Don't need '|'.

> +          Maximum flash controller input current. Must be divisible by 50000
> +
> +    required:
> +      - reg
> +      - flash-timeout-us
> +      - flash-max-microamp
> +      - led-max-microamp
> +      - ams,input-max-microamp
> +
> +  led@1:
> +    type: object
> +    $ref: common.yaml#
> +    unevaluatedProperties: false
> +
> +    properties:
> +      reg:
> +        const: 1
> +
> +      led-max-microamp:
> +        enum:
> +          - 2500
> +          - 5000
> +          - 7500
> +          - 10000
> +        description: |
> +          Maximum indicator current. The allowed values are 2500, 5000, 7500 and 10000.

No need to repeat constraints in free-form text. Drop the description 
here, but I would add description under the nodes to say they are for 
flash and indicator.

> +
> +    required:
> +      - reg
> +      - led-max-microamp
> +
> +required:
> +  - compatible
> +  - reg
> +  - "#size-cells"
> +  - "#address-cells"
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/leds/common.h>
> +
> +    i2c{
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        as3645a@30 {

led-controller@30

> +            compatible = "ams,as3645a";
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +            reg = <0x30>;
> +
> +            led@0 {
> +                reg = <0>;
> +                flash-timeout-us = <150000>;
> +                flash-max-microamp = <320000>;
> +                led-max-microamp = <60000>;
> +                ams,input-max-microamp = <1750000>;
> +                function = LED_FUNCTION_FLASH;
> +            };
> +
> +            led@1 {
> +                reg = <1>;
> +                led-max-microamp = <10000>;
> +                function = LED_FUNCTION_INDICATOR;
> +            };
> +        };
> +    };
> +...
> 
> ---
> base-commit: c17b750b3ad9f45f2b6f7e6f7f4679844244f0b9
> change-id: 20250906-ams-txt-to-dt-schema-a821e0e03c46
> 
> Best regards,
> -- 
> Harrison Carter <hcarter@thegoodpenguin.co.uk>
> 

  reply	other threads:[~2025-09-10 15:05 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-09  8:50 [PATCH] dt-bindings: leds: as3645: Convert to DT schema Harrison Carter
2025-09-10 15:05 ` Rob Herring [this message]
2025-09-10 17:07   ` Harrison Carter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250910150527.GA54174-robh@kernel.org \
    --to=robh@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=hcarter@thegoodpenguin.co.uk \
    --cc=krzk+dt@kernel.org \
    --cc=lee@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=pavel@kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).