diff mbox series

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

Message ID 1602864634-23489-2-git-send-email-hsin-hsiung.wang@mediatek.com
State Superseded
Headers show
Series Add SPMI support for Mediatek MT6873/8192 SoC IC | expand

Commit Message

Hsin-Hsiung Wang Oct. 16, 2020, 4:10 p.m. UTC 
This adds documentation for the SPMI controller found on Mediatek SoCs.

Signed-off-by: Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>

---
 .../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

-- 
2.18.0

Comments

Rob Herring (Arm) Oct. 19, 2020, 7:52 p.m. UTC | #1 
On Sat, 17 Oct 2020 00:10:33 +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@mediatek.com>

> ---

>  .../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

> 



My bot found errors running 'make dt_binding_check' on your patch:

Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.example.dts:19:18: fatal error: dt-bindings/clock/mt8192-clk.h: No such file or directory
   19 |         #include <dt-bindings/clock/mt8192-clk.h>
      |                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[1]: *** [scripts/Makefile.lib:342: Documentation/devicetree/bindings/spmi/mtk,spmi-mtk-pmif.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1366: dt_binding_check] Error 2


See https://patchwork.ozlabs.org/patch/1383441

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Rob Herring (Arm) Oct. 19, 2020, 7:54 p.m. UTC | #2 
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@mediatek.com>
> ---

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@mediatek.com>
> +
> +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
Hsin-Hsiung Wang Oct. 20, 2020, 4:04 a.m. UTC | #3 
Hi,

On Mon, 2020-10-19 at 14:54 -0500, Rob Herring wrote:
> 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@mediatek.com>

> > ---

> 

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

> 

Sorry, I don't add the necessary patchset[1] into the commit message.
I will update it in the next patch.

[1]
https://patchwork.kernel.org/project/linux-mediatek/list/?series=342593

> >  .../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@mediatek.com>

> > +

> > +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.

> 

Thanks, I will update it in the next patch.
> > +

> > +properties:

> > +  compatible:

> > +    const: mediatek,mt6873-spmi

> > +

> > +  reg:

> > +    minItems: 2

> > +    maxItems: 2

> > +

> > +  reg-names:

> > +    items:

> > +      - const: "pmif"

> > +      - const: "spmimst"

> 

> Don't need quotes

> 

Thanks, I will update it in the next patch.
> > +

> > +  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

> 

Thanks, I will update it in the next patch.
> > +

> > +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
diff mbox series

Patch

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@mediatek.com>
+
+description: |+
+  On MediaTek SoCs the PMIC is connected via SPMI and the controller allows
+  for multiple SoCs to control a single SPMI master.
+
+properties:
+  compatible:
+    const: mediatek,mt6873-spmi
+
+  reg:
+    minItems: 2
+    maxItems: 2
+
+  reg-names:
+    items:
+      - const: "pmif"
+      - const: "spmimst"
+
+  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
+
+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>;
+    };
+...