Re: [PATCH v2 4/4] mfd: rt4831: Adds DT binding document for Richtek RT4831 MFD core

[Rob Herring <robh@kernel.org>]

On Fri, Dec 04, 2020 at 12:06:35AM +0800, cy_huang wrote:
> From: ChiYuan Huang <cy_huang@richtek.com>
> 
> Adds DT binding document for Richtek RT4831 MFD core.
> 
> This patch depends on
> 
> "backlight: rt4831: Adds DT binding document for Richtek RT4831 backlight".
> "regulator: rt4831: Adds DT binding document for Richtek RT4831 DSV regulator".

You generally don't need to state dependencies on other patches in the 
series. You need to state dependencies that are either pending in a 
maintainers tree or patches not yet applied. IOW, anything not in Linus' 
tree. And that information goes below the '---'.

> 
> Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> ---
> Changes since v2
> - Add "patch depends on" in commit description.
> - Adds regulator-allow-bypass flag in DSVLCM.
> ---
>  .../devicetree/bindings/mfd/richtek,rt4831.yaml    | 90 ++++++++++++++++++++++
>  include/dt-bindings/leds/rt4831-backlight.h        | 23 ++++++

This goes in the backlight binding patch.

>  2 files changed, 113 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/richtek,rt4831.yaml
>  create mode 100644 include/dt-bindings/leds/rt4831-backlight.h
> 
> diff --git a/Documentation/devicetree/bindings/mfd/richtek,rt4831.yaml b/Documentation/devicetree/bindings/mfd/richtek,rt4831.yaml
> new file mode 100644
> index 00000000..c6ca953
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/richtek,rt4831.yaml
> @@ -0,0 +1,90 @@
> +# SPDX-License-Identifier: GPL-2.0

For new bindings:

(GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/richtek,rt4831.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Richtek RT4831 DSV and Backlight Integrated IC
> +
> +maintainers:
> +  - ChiYuan Huang <cy_huang@richtek.com>
> +
> +description: |
> +  RT4831 is a multifunctional device that can provide power to the LCD display
> +  and LCD backlight.
> +
> +  For Display Bias Voltage DSVP and DSVN, the output range is about 4V to 6.5V.
> +  It's sufficient to meet the current LCD power requirement.
> +
> +  For the LCD backlight, it can provide four channel WLED driving capability.
> +  Each channel driving current is up to 30mA
> +
> +  Datasheet is available at
> +  https://www.richtek.com/assets/product_file/RT4831A/DS4831A-05.pdf
> +
> +properties:
> +  compatible:
> +    const: richtek,rt4831
> +
> +  reg:
> +    description: I2C device address.
> +    maxItems: 1
> +
> +  enable-gpios:
> +    description: |
> +      GPIO to enable/disable the chip. It is optional.
> +      Some usage directly tied this pin to follow VIO 1.8V power on sequence.
> +    maxItems: 1
> +
> +  regulators:
> +    $ref: ../regulator/richtek,rt4831-regulator.yaml
> +
> +  backlight:
> +    $ref: ../leds/backlight/richtek,rt4831-backlight.yaml
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/leds/rt4831-backlight.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      rt4831@11 {
> +        compatible = "richtek,rt4831";
> +        reg = <0x11>;
> +
> +        regulators {
> +          DSVLCM {
> +            regulator-min-microvolt = <4000000>;
> +            regulator-max-microvolt = <7150000>;
> +            regulator-allow-bypass;
> +          };
> +          DSVP {
> +            regulator-name = "rt4831-dsvp";
> +            regulator-min-microvolt = <4000000>;
> +            regulator-max-microvolt = <6500000>;
> +            regulator-boot-on;
> +          };
> +          DSVN {
> +            regulator-name = "rt4831-dsvn";
> +            regulator-min-microvolt = <4000000>;
> +            regulator-max-microvolt = <6500000>;
> +            regulator-boot-on;
> +          };
> +        };
> +
> +        backlight {
> +          compatible = "richtek,rt4831-backlight";
> +          default-brightness = <1024>;
> +          max-brightness = <2048>;
> +          richtek,bled-ovp-sel = /bits/ 8 <RT4831_BLOVPLVL_21V>;
> +          richtek,channel-use = /bits/ 8 <RT4831_BLED_ALLCHEN>;
> +        };
> +      };
> +    };
> diff --git a/include/dt-bindings/leds/rt4831-backlight.h b/include/dt-bindings/leds/rt4831-backlight.h
> new file mode 100644
> index 00000000..7084906
> --- /dev/null
> +++ b/include/dt-bindings/leds/rt4831-backlight.h
> @@ -0,0 +1,23 @@
> +/*
> + * This header provides constants for rt4831 backlight bindings.
> + *
> + * This file is licensed under the terms of the GNU General Public
> + * License version 2.  This program is licensed "as is" without any
> + * warranty of any kind, whether express or implied.

Use SPDX tag. Also, probably should be dual licensed too if you want to 
use your DTs with non-GPL OS.

> + */
> +
> +#ifndef _DT_BINDINGS_RT4831_BACKLIGHT_H
> +#define _DT_BINDINGS_RT4831_BACKLIGHT_H
> +
> +#define RT4831_BLOVPLVL_17V	0
> +#define RT4831_BLOVPLVL_21V	1
> +#define RT4831_BLOVPLVL_25V	2
> +#define RT4831_BLOVPLVL_29V	3
> +
> +#define RT4831_BLED_CH1EN	(1 << 0)
> +#define RT4831_BLED_CH2EN	(1 << 1)
> +#define RT4831_BLED_CH3EN	(1 << 2)
> +#define RT4831_BLED_CH4EN	(1 << 3)
> +#define RT4831_BLED_ALLCHEN	((1 << 4) - 1)
> +
> +#endif /* _DT_BINDINGS_RT4831_BACKLIGHT_H */
> -- 
> 2.7.4
>