Re: [PATCH v4 1/2] dt-bindings: spmi: document binding for the Mediatek SPMI controller

From: Rob Herring
Date: Mon Oct 19 2020 - 15:54:59 EST


On Sat, Oct 17, 2020 at 12:10:33AM +0800, Hsin-Hsiung Wang wrote:
> This adds documentation for the SPMI controller found on Mediatek SoCs.
>
> Signed-off-by: Hsin-Hsiung Wang <hsin-hsiung.wang@xxxxxxxxxxxx>
> ---

If you have a dependency such as the include, please note it here.

> .../bindings/spmi/mtk,spmi-mtk-pmif.yaml | 70 +++++++++++++++++++
> 1 file changed, 70 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.yaml
>
> diff --git a/Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.yaml b/Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.yaml
> new file mode 100644
> index 000000000000..9945200a35b3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.yaml
> @@ -0,0 +1,70 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spmi/mtk,spmi-mtk-pmif.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Mediatek SPMI Controller Device Tree Bindings
> +
> +maintainers:
> + - Hsin-Hsiung Wang <hsin-hsiung.wang@xxxxxxxxxxxx>
> +
> +description: |+
> + On MediaTek SoCs the PMIC is connected via SPMI and the controller allows
> + for multiple SoCs to control a single SPMI master.

Need a $ref to spmi.yaml.

> +
> +properties:
> + compatible:
> + const: mediatek,mt6873-spmi
> +
> + reg:
> + minItems: 2
> + maxItems: 2
> +
> + reg-names:
> + items:
> + - const: "pmif"
> + - const: "spmimst"

Don't need quotes

> +
> + clocks:
> + minItems: 3
> + maxItems: 3
> +
> + clock-names:
> + items:
> + - const: "pmif_sys_ck"
> + - const: "pmif_tmr_ck"
> + - const: "spmimst_clk_mux"
> +
> + assigned-clocks:
> + maxItems: 1
> +
> + assigned-clock-parents:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - clocks
> + - clock-names

unevaluatedProperties: false

> +
> +examples:
> + - |
> + #include <dt-bindings/clock/mt8192-clk.h>
> +
> + spmi: spmi@10027000 {
> + compatible = "mediatek,mt6873-spmi";
> + reg = <0 0x10027000 0 0x000e00>,
> + <0 0x10029000 0 0x000100>;
> + reg-names = "pmif", "spmimst";
> + clocks = <&infracfg CLK_INFRA_PMIC_AP>,
> + <&infracfg CLK_INFRA_PMIC_TMR>,
> + <&topckgen CLK_TOP_SPMI_MST_SEL>;
> + clock-names = "pmif_sys_ck",
> + "pmif_tmr_ck",
> + "spmimst_clk_mux";
> + assigned-clocks = <&topckgen CLK_TOP_PWRAP_ULPOSC_SEL>;
> + assigned-clock-parents = <&topckgen CLK_TOP_OSC_D10>;
> + };
> +...
> --
> 2.18.0