Re: [PATCH] dt-bindings: mfd: sprd,sc2731: convert to YAML

[Rob Herring <robh@kernel.org>]

On Thu, Aug 15, 2024 at 12:26:29PM +0200, Stanislav Jakubek wrote:
> Convert the Spreadtrum SC27xx PMIC bindings to DT schema. Adjust the
> filename to match the compatible of the only in-tree user, SC2731.
> Change #interrupt-cells value to 1, as according to [1] that is the
> correct value.
> 
> [1] https://lore.kernel.org/lkml/b6a32917d1e231277d240a4084bebb6ad91247e3.1550060544.git.baolin.wang@linaro.org/
> 
> Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> ---
> Depends on:
>   - eFuse YAML conversion: https://lore.kernel.org/lkml/9fba73ce66f1f3b7b2a8f46e7c21f60cff5a85f0.1721199034.git.stano.jakubek@gmail.com/
>   - RTC YAML conversion: https://lore.kernel.org/lkml/ZrBzmQI0IAL7LI3e@standask-GA-A55M-S2HP/

These either have to be sent as 1 series for 1 maintainer to apply (Lee) 
or you'll have to wait a cycle for the dependencies.

> 
>  .../devicetree/bindings/mfd/sprd,sc2731.yaml  | 124 ++++++++++++++++++
>  .../bindings/mfd/sprd,sc27xx-pmic.txt         |  40 ------
>  2 files changed, 124 insertions(+), 40 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/mfd/sprd,sc2731.yaml
>  delete mode 100644 Documentation/devicetree/bindings/mfd/sprd,sc27xx-pmic.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/sprd,sc2731.yaml b/Documentation/devicetree/bindings/mfd/sprd,sc2731.yaml
> new file mode 100644
> index 000000000000..59df02e1e53b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/sprd,sc2731.yaml
> @@ -0,0 +1,124 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/sprd,sc2731.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Spreadtrum SC27xx PMIC
> +
> +maintainers:
> +  - Orson Zhai <orsonzhai@gmail.com>
> +  - Baolin Wang <baolin.wang7@gmail.com>
> +  - Chunyan Zhang <zhang.lyra@gmail.com>
> +
> +description: |
> +  Spreadtrum PMICs belonging to the SC27xx series integrate all mobile handset
> +  power management, audio codec, battery management and user interface support
> +  functions in a single chip. They have 6 major functional blocks:
> +    - DCDCs to support CPU, memory
> +    - LDOs to support both internal and external requirements
> +    - Battery management system, such as charger, fuel gauge
> +    - Audio codec
> +    - User interface functions, such as indicator, flash LED and so on
> +    - IC level interface, such as power on/off control, RTC, typec and so on
> +
> +properties:
> +  $nodename:
> +    pattern: '^pmic@[0-9a-f]+$'
> +
> +  compatible:
> +    enum:
> +      - sprd,sc2720
> +      - sprd,sc2721
> +      - sprd,sc2723
> +      - sprd,sc2730
> +      - sprd,sc2731
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  interrupt-controller: true
> +  spi-max-frequency: true
> +
> +  '#address-cells':
> +    const: 1
> +
> +  '#interrupt-cells':
> +    const: 1
> +
> +  '#size-cells':
> +    const: 0
> +
> +  regulators:
> +    type: object
> +    $ref: /schemas/regulator/sprd,sc2731-regulator.yaml#
> +
> +patternProperties:
> +  "^adc@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/iio/adc/sprd,sc2720-adc.yaml#
> +
> +  "^charger@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/power/supply/sc2731-charger.yaml#
> +
> +  "^efuse@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/nvmem/sprd,sc2731-efuse.yaml#
> +
> +  "^fuel-gauge@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/power/supply/sc27xx-fg.yaml#
> +
> +  "^gpio@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/gpio/sprd,gpio-eic.yaml#
> +
> +  "^led-controller@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/leds/sprd,sc2731-bltc.yaml#
> +
> +  "^rtc@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/rtc/sprd,sc2731-rtc.yaml#
> +
> +  "^vibrator@[0-9a-f]+$":
> +    type: object
> +    $ref: /schemas/input/sprd,sc27xx-vibrator.yaml#
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-controller
> +  - spi-max-frequency
> +  - '#address-cells'
> +  - '#interrupt-cells'
> +  - '#size-cells'
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      pmic@0 {
> +        compatible = "sprd,sc2731";
> +        reg = <0>;
> +        interrupts = <GIC_SPI 31 IRQ_TYPE_LEVEL_HIGH>;
> +        interrupt-controller;
> +        spi-max-frequency = <26000000>;
> +        #address-cells = <1>;
> +        #interrupt-cells = <1>;
> +        #size-cells = <0>;

The preference is one complete example here and drop any partial 
examples of the child nodes in the child node schemas.

> +      };
> +    };
> +...
> diff --git a/Documentation/devicetree/bindings/mfd/sprd,sc27xx-pmic.txt b/Documentation/devicetree/bindings/mfd/sprd,sc27xx-pmic.txt
> deleted file mode 100644
> index 21b9a897fca5..000000000000
> --- a/Documentation/devicetree/bindings/mfd/sprd,sc27xx-pmic.txt
> +++ /dev/null
> @@ -1,40 +0,0 @@
> -Spreadtrum SC27xx Power Management Integrated Circuit (PMIC)
> -
> -The Spreadtrum SC27xx series PMICs contain SC2720, SC2721, SC2723, SC2730
> -and SC2731. The Spreadtrum PMIC belonging to SC27xx series integrates all
> -mobile handset power management, audio codec, battery management and user
> -interface support function in a single chip. It has 6 major functional
> -blocks:
> -- DCDCs to support CPU, memory.
> -- LDOs to support both internal and external requirement.
> -- Battery management system, such as charger, fuel gauge.
> -- Audio codec.
> -- User interface function, such as indicator, flash LED and so on.
> -- IC level interface, such as power on/off control, RTC and typec and so on.
> -
> -Required properties:
> -- compatible: Should be one of the following:
> -	"sprd,sc2720"
> -	"sprd,sc2721"
> -	"sprd,sc2723"
> -	"sprd,sc2730"
> -	"sprd,sc2731"
> -- reg: The address of the device chip select, should be 0.
> -- spi-max-frequency: Typically set to 26000000.
> -- interrupts: The interrupt line the device is connected to.
> -- interrupt-controller: Marks the device node as an interrupt controller.
> -- #interrupt-cells: The number of cells to describe an PMIC IRQ, must be 2.
> -- #address-cells: Child device offset number of cells, must be 1.
> -- #size-cells: Child device size number of cells, must be 0.
> -
> -Example:
> -pmic@0 {
> -	compatible = "sprd,sc2731";
> -	reg = <0>;
> -	spi-max-frequency = <26000000>;
> -	interrupts = <GIC_SPI 31 IRQ_TYPE_LEVEL_HIGH>;
> -	interrupt-controller;
> -	#interrupt-cells = <2>;
> -	#address-cells = <1>;
> -	#size-cells = <0>;
> -};
> -- 
> 2.34.1
>