Devicetree
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Jan Carlo Roleda <jancarlo.roleda@analog.com>
Cc: Lee Jones <lee@kernel.org>, Pavel Machek <pavel@kernel.org>,
	 Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	 Conor Dooley <conor+dt@kernel.org>,
	linux-kernel@vger.kernel.org, linux-leds@vger.kernel.org,
	 devicetree@vger.kernel.org
Subject: Re: [PATCH v2 3/3] dt-bindings: leds: Document LTC3208 Multidisplay LED Driver
Date: Thu, 26 Mar 2026 10:13:01 +0100	[thread overview]
Message-ID: <20260326-nimble-sociable-sawfly-515a36@quoll> (raw)
In-Reply-To: <20260326-upstream-ltc3208-v2-3-3dbc992b6098@analog.com>

On Thu, Mar 26, 2026 at 06:30:12AM +0800, Jan Carlo Roleda wrote:
> Add Documentation for LTC3208 Multidisplay LED Driver.

Please organize the patch documenting the compatible (DT bindings)
before the patch using that compatible.
See also: https://elixir.bootlin.com/linux/v6.14-rc6/source/Documentation/devicetree/bindings/submitting-patches.rst#L46

> 
> Signed-off-by: Jan Carlo Roleda <jancarlo.roleda@analog.com>
> ---
>  .../devicetree/bindings/leds/adi,ltc3208.yaml      | 158 +++++++++++++++++++++
>  MAINTAINERS                                        |   1 +
>  2 files changed, 159 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/leds/adi,ltc3208.yaml b/Documentation/devicetree/bindings/leds/adi,ltc3208.yaml
> new file mode 100644
> index 000000000000..c139937936bc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/adi,ltc3208.yaml
> @@ -0,0 +1,158 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (c) 2026 Analog Devices, Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/adi,ltc3208.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LTC3208 Multidisplay LED Controller from Linear Technologies (Now Analog Devices).

Drop full stop

> +
> +maintainers:
> +  - Jan Carlo Roleda <jancarlo.roleda@analog.com>
> +
> +description:
> +  The LTC3208 is a multidisplay LED controller that can support up to 1A to all
> +  connected LEDs.
> +
> +  The datasheet for this device can be found in
> +  https://www.analog.com/en/products/ltc3208.html
> +
> +properties:
> +  compatible:
> +    const: adi,ltc3208
> +
> +  reg:
> +    maxItems: 1
> +
> +  '#address-cells':

Use consistent quotes, either ' or "

> +    const: 1
> +
> +  '#size-cells':
> +    const: 0
> +
> +  adi,disable-camhl-pin:
> +    type: boolean
> +    description:
> +      Configures whether the external CAMHL pin is disabled.
> +      if disabled then the output pins associated with CAM will always select

s/if/If/.

> +      the CAM register's high half-byte brightness.
> +
> +  adi,cfg-enrgbs-pin:
> +    type: boolean
> +    description:
> +      Configures which channel the ENRGBS pin toggles when it receives a signal.
> +      ENRGBS pin controls the SUB channel's output pins if this is set,
> +      or RGB channel's output pins if this is unset.
> +
> +  adi,disable-rgb-aux4-dropout:
> +    type: boolean
> +    description:
> +      Configures the RGB and AUX4 dropout signals to be disabled.
> +
> +  adi,aux1-channel:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description:
> +      LED Channel that the AUX1 output pin mirrors its brightness level from.
> +    enum: [aux, main, sub, cam]
> +    default: aux
> +
> +  adi,aux2-channel:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description:
> +      LED Channel that the AUX2 output pin mirrors its brightness level from.
> +    enum: [aux, main, sub, cam]
> +    default: aux
> +
> +  adi,aux3-channel:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description:
> +      LED Channel that the AUX3 output pin mirrors its brightness level from.
> +    enum: [aux, main, sub, cam]
> +    default: aux
> +
> +  adi,aux4-channel:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description:
> +      LED Channel that the AUX4 output pin mirrors its brightness level from.
> +    enum: [aux, main, sub, cam]
> +    default: aux
> +
> +patternProperties:
> +  "^led@[0-7]$":
> +    type: object
> +    $ref: /schemas/leds/common.yaml#
> +    unevaluatedProperties: false
> +    properties:
> +      reg:
> +        description:
> +          LED Channel Number. each channel maps to a specific channel group used
> +          to configure the brightness level of the output pins corresponding to
> +          the channel.
> +        enum:
> +          - 0 # Main Channel (8-bit brightness)
> +          - 1 # Sub Channel (8-bit brightness)
> +          - 2 # AUX Channel (4-bit brightness)
> +          - 3 # Camera Channel, Low-side byte (4-bit brightness)
> +          - 4 # Camera Channel, High-side byte (4-bit brightness)
> +          - 5 # Red Channel (4-bit brightness)
> +          - 6 # Blue Channel (4-bit brightness)
> +          - 7 # Green Channel (4-bit brightness)
> +    required:
> +      - reg
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>

Where do you use it?

> +    #include <dt-bindings/leds/common.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      led-controller@1b {
> +        compatible = "adi,ltc3208";
> +        reg = <0x1b>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        adi,disable-camhl-pin;
> +        adi,cfg-enrgbs-pin;
> +        adi,disable-rgb-aux4-dropout;
> +
> +        led@0 {
> +          reg = <0>;

Please list other applicable properties. Otherwise listing all these
children is pointless - feels deducible from the compatible.

> +        };
> +
> +        led@1 {
> +          reg = <1>;
> +        };

Best regards,
Krzysztof


  reply	other threads:[~2026-03-26  9:13 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-25 22:30 [PATCH v2 0/3] Add support for LTC3208 multi-display driver Jan Carlo Roleda
2026-03-25 22:30 ` [PATCH v2 1/3] Add Maintainers to LTC3208 LED Driver Jan Carlo Roleda
2026-03-26  9:14   ` Krzysztof Kozlowski
2026-04-01  0:14     ` Roleda, Jan carlo
2026-03-25 22:30 ` [PATCH v2 2/3] leds: ltc3208: add driver Jan Carlo Roleda
2026-03-25 22:30 ` [PATCH v2 3/3] dt-bindings: leds: Document LTC3208 Multidisplay LED Driver Jan Carlo Roleda
2026-03-26  9:13   ` Krzysztof Kozlowski [this message]
2026-04-01  0:11     ` Roleda, Jan carlo

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=20260326-nimble-sociable-sawfly-515a36@quoll \
    --to=krzk@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jancarlo.roleda@analog.com \
    --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=robh@kernel.org \
    /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