lkml.org 
[lkml]   [2022]   [May]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH 11/14] dt-bindings: leds: mt6370: Add Mediatek mt6370 indicator documentation
From
On 31/05/2022 12:42, ChiaEn Wu wrote:
> From: ChiYuan Huang <cy_huang@richtek.com>
>
> Add Mediatek mt6370 indicator documentation.
>
> Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> ---
> .../leds/mediatek,mt6370-indicator.yaml | 57 +++++++++++++++++++
> 1 file changed, 57 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/leds/mediatek,mt6370-indicator.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/mediatek,mt6370-indicator.yaml b/Documentation/devicetree/bindings/leds/mediatek,mt6370-indicator.yaml
> new file mode 100644
> index 000000000000..823be3add097
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/mediatek,mt6370-indicator.yaml
> @@ -0,0 +1,57 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/mediatek,mt6370-indicator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LED driver for MT6370 PMIC from MediaTek Integrated.
> +
> +maintainers:
> + - Alice Chen <alice_chen@richtek.com>
> +
> +description: |
> + This module is part of the MT6370 MFD device.
> + see Documentation/devicetree/bindings/mfd/mediatek,mt6370.yaml
> + Add MT6370 LED driver include 4-channel RGB LED support Register/PWM/Breath Mode
> +
> +properties:
> + compatible:
> + const: mediatek,mt6370-indicator
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> +patternProperties:
> + "^(multi-)?led@[0-3]$":
> + description: |
> + Properties for a single LED.

Not useful description. Just skip it, I think schema allows it.

> + $ref: common.yaml#
> + type: object
> +
> + properties:
> + reg:
> + description: |
> + Index of the LED.

The same, regs are usually not described.

> + enum:
> + - 0 # LED output ISINK1
> + - 1 # LED output ISINK2
> + - 2 # LED output ISINK3
> + - 3 # LED output ISINK4
> +
> + mediatek,soft-start:
> + description: |
> + soft start step control, support /0.5ms/1ms/1.5ms/2ms.

Why here you start sentence lower-case?

> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1, 2, 3]

This has to be in logical values, so in ms, not in some register values.
Use proper unit suffix and enumerate the actual values.

> +
> + unevaluatedProperties: false
> +
> +required:
> + - compatible
> + - "#address-cells"
> + - "#size-cells"
> +
> +additionalProperties: false


Best regards,
Krzysztof

\
 
 \ /
  Last update: 2022-05-31 22:40    [W:0.117 / U:0.172 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site