diff mbox series

[v4,16/18] dt-bindings: mediatek: mt8186: add mt8186-mt6366-da7219-max98357 document

Message ID 20220428093355.16172-17-jiaxin.yu@mediatek.com (mailing list archive)
State Superseded
Headers show
Series ASoC: mediatek: Add support for MT8186 SoC | expand

Commit Message

Jiaxin Yu April 28, 2022, 9:33 a.m. UTC 
Add document for mt8186 board with mt6366, da7219 and max98357.

Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
---
 .../sound/mt8186-mt6366-da7219-max98357.yaml  | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml

Comments

Rob Herring (Arm) April 28, 2022, 12:17 p.m. UTC | #1 
On Thu, 28 Apr 2022 17:33:53 +0800, Jiaxin Yu wrote:
> Add document for mt8186 board with mt6366, da7219 and max98357.
> 
> Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> ---
>  .../sound/mt8186-mt6366-da7219-max98357.yaml  | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml:30:9: [warning] wrong indentation: expected 6 but found 8 (indentation)
./Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml:40:9: [warning] wrong indentation: expected 6 but found 8 (indentation)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

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

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

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

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring (Arm) April 28, 2022, 2:31 p.m. UTC | #2 
On Thu, Apr 28, 2022 at 05:33:53PM +0800, Jiaxin Yu wrote:
> Add document for mt8186 board with mt6366, da7219 and max98357.
> 
> Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> ---
>  .../sound/mt8186-mt6366-da7219-max98357.yaml  | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
> new file mode 100644
> index 000000000000..55e8649f2aea
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
> @@ -0,0 +1,71 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/mt8186-mt6366-da7219-max98357.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Mediatek MT8186 with MT6366, DA7219 and MAX98357 ASoC sound card driver
> +
> +maintainers:
> +  - Jiaxin Yu <jiaxin.yu@mediatek.com>
> +
> +description:
> +  This binding describes the MT8186 sound card.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - mediatek,mt8186_mt6366_da7219_max98357_sound

s/_/-/

> +
> +  mediatek,platform:
> +    $ref: "/schemas/types.yaml#/definitions/phandle"
> +    description: The phandle of MT8186 ASoC platform.
> +
> +  headset-codec:
> +    type: object

       additionalProperties: false

> +    properties:
> +      sound-dai:
> +        $ref: /schemas/types.yaml#/definitions/phandle

sound-dai already has a type, so drop and define how many entries.

> +    required:
> +        - sound-dai
> +
> +  playback-codecs:
> +    type: object

       additionalProperties: false

> +    properties:
> +      sound-dai:
> +        minItems: 2
> +        maxItems: 3

If more than 1 entry, then you need to define what each one is and the 
order. Just like reg, interrupts, clocks, etc.

> +        $ref: /schemas/types.yaml#/definitions/phandle-array

Drop

> +    required:
> +        - sound-dai
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - mediatek,platform
> +  - headset-codec
> +  - playback-codecs
> +
> +examples:
> +  - |
> +
> +    sound: mt8186-sound {
> +        compatible = "mediatek,mt8186_mt6366_da7219_max98357_sound";
> +        mediatek,platform = <&afe>;
> +        pinctrl-names = "aud_clk_mosi_off",
> +                        "aud_clk_mosi_on";
> +        pinctrl-0 = <&aud_clk_mosi_off>;
> +        pinctrl-1 = <&aud_clk_mosi_on>;
> +
> +        headset-codec {
> +            sound-dai = <&da7219>;
> +        };
> +
> +        playback-codecs {
> +            sound-dai = <&anx_bridge_dp>,
> +                        <&max98357a>;
> +        };
> +    };
> +
> +...
> -- 
> 2.25.1
>
Jiaxin Yu April 29, 2022, 9:40 a.m. UTC | #3 
On Thu, 2022-04-28 at 09:31 -0500, Rob Herring wrote:
> On Thu, Apr 28, 2022 at 05:33:53PM +0800, Jiaxin Yu wrote:
> > Add document for mt8186 board with mt6366, da7219 and max98357.
> > 
> > Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> > ---
> >  .../sound/mt8186-mt6366-da7219-max98357.yaml  | 71
> > +++++++++++++++++++
> >  1 file changed, 71 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/sound/mt8186-
> > mt6366-da7219-max98357.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/sound/mt8186-mt6366-
> > da7219-max98357.yaml
> > b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-
> > max98357.yaml
> > new file mode 100644
> > index 000000000000..55e8649f2aea
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-
> > max98357.yaml
> > @@ -0,0 +1,71 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: 
> > http://devicetree.org/schemas/sound/mt8186-mt6366-da7219-max98357.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Mediatek MT8186 with MT6366, DA7219 and MAX98357 ASoC sound
> > card driver
> > +
> > +maintainers:
> > +  - Jiaxin Yu <jiaxin.yu@mediatek.com>
> > +
> > +description:
> > +  This binding describes the MT8186 sound card.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mediatek,mt8186_mt6366_da7219_max98357_sound
> 
> s/_/-/
> 
Got it.
> > +
> > +  mediatek,platform:
> > +    $ref: "/schemas/types.yaml#/definitions/phandle"
> > +    description: The phandle of MT8186 ASoC platform.
> > +
> > +  headset-codec:
> > +    type: object
> 
>        additionalProperties: false
Ditto.
> 
> > +    properties:
> > +      sound-dai:
> > +        $ref: /schemas/types.yaml#/definitions/phandle
> 
> sound-dai already has a type, so drop and define how many entries.
> 
Ditto.
> > +    required:
> > +        - sound-dai
> > +

The indentation of this line is incorrect. I will fix it.

> > +  playback-codecs:
> > +    type: object
> 
>        additionalProperties: false
> 
Got it.
> > +    properties:
> > +      sound-dai:
> > +        minItems: 2
> > +        maxItems: 3
> 
> If more than 1 entry, then you need to define what each one is and
> the 
> order. Just like reg, interrupts, clocks, etc.
> 
Hi Rob,

Should I correct them as below?

---
properties:
  sound-dai:
    minItems: 2
    maxItems: 3
    items:
      - items:
          - description: xxx
          - description: yyy
          - description: zzz

> > +        $ref: /schemas/types.yaml#/definitions/phandle-array
> 
> Drop
> 
Got it.
> > +    required:
> > +        - sound-dai
> > +
> > +additionalProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - mediatek,platform
> > +  - headset-codec
> > +  - playback-codecs
> > +
> > +examples:
> > +  - |
> > +
> > +    sound: mt8186-sound {
> > +        compatible =
> > "mediatek,mt8186_mt6366_da7219_max98357_sound";
> > +        mediatek,platform = <&afe>;
> > +        pinctrl-names = "aud_clk_mosi_off",
> > +                        "aud_clk_mosi_on";
> > +        pinctrl-0 = <&aud_clk_mosi_off>;
> > +        pinctrl-1 = <&aud_clk_mosi_on>;
> > +
> > +        headset-codec {
> > +            sound-dai = <&da7219>;
> > +        };
> > +
> > +        playback-codecs {
> > +            sound-dai = <&anx_bridge_dp>,
> > +                        <&max98357a>;
> > +        };
> > +    };
> > +
> > +...
> > -- 
> > 2.25.1
> >
Rob Herring (Arm) April 29, 2022, 8:16 p.m. UTC | #4 
On Fri, Apr 29, 2022 at 05:40:02PM +0800, Jiaxin Yu wrote:
> On Thu, 2022-04-28 at 09:31 -0500, Rob Herring wrote:
> > On Thu, Apr 28, 2022 at 05:33:53PM +0800, Jiaxin Yu wrote:
> > > Add document for mt8186 board with mt6366, da7219 and max98357.
> > > 
> > > Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> > > ---
> > >  .../sound/mt8186-mt6366-da7219-max98357.yaml  | 71
> > > +++++++++++++++++++
> > >  1 file changed, 71 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/sound/mt8186-
> > > mt6366-da7219-max98357.yaml
> > > 
> > > diff --git a/Documentation/devicetree/bindings/sound/mt8186-mt6366-
> > > da7219-max98357.yaml
> > > b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-
> > > max98357.yaml
> > > new file mode 100644
> > > index 000000000000..55e8649f2aea
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-
> > > max98357.yaml
> > > @@ -0,0 +1,71 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: 
> > > http://devicetree.org/schemas/sound/mt8186-mt6366-da7219-max98357.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Mediatek MT8186 with MT6366, DA7219 and MAX98357 ASoC sound
> > > card driver
> > > +
> > > +maintainers:
> > > +  - Jiaxin Yu <jiaxin.yu@mediatek.com>
> > > +
> > > +description:
> > > +  This binding describes the MT8186 sound card.
> > > +
> > > +properties:
> > > +  compatible:
> > > +    enum:
> > > +      - mediatek,mt8186_mt6366_da7219_max98357_sound
> > 
> > s/_/-/
> > 
> Got it.
> > > +
> > > +  mediatek,platform:
> > > +    $ref: "/schemas/types.yaml#/definitions/phandle"
> > > +    description: The phandle of MT8186 ASoC platform.
> > > +
> > > +  headset-codec:
> > > +    type: object
> > 
> >        additionalProperties: false
> Ditto.
> > 
> > > +    properties:
> > > +      sound-dai:
> > > +        $ref: /schemas/types.yaml#/definitions/phandle
> > 
> > sound-dai already has a type, so drop and define how many entries.
> > 
> Ditto.

No need to reply in agreement. Just trim the email instead.

> > > +    properties:
> > > +      sound-dai:
> > > +        minItems: 2
> > > +        maxItems: 3
> > 
> > If more than 1 entry, then you need to define what each one is and
> > the 
> > order. Just like reg, interrupts, clocks, etc.
> > 
> Hi Rob,
> 
> Should I correct them as below?
> 
> ---
> properties:
>   sound-dai:
>     minItems: 2
>     maxItems: 3
>     items:
>       - items:
>           - description: xxx
>           - description: yyy
>           - description: zzz

Drop the outer 'items'. As-is, you are saying you have 1 entry with 3 
cells (1 phandle + 2 arg cells).

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
new file mode 100644
index 000000000000..55e8649f2aea
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/mt8186-mt6366-da7219-max98357.yaml
@@ -0,0 +1,71 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/mt8186-mt6366-da7219-max98357.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek MT8186 with MT6366, DA7219 and MAX98357 ASoC sound card driver
+
+maintainers:
+  - Jiaxin Yu <jiaxin.yu@mediatek.com>
+
+description:
+  This binding describes the MT8186 sound card.
+
+properties:
+  compatible:
+    enum:
+      - mediatek,mt8186_mt6366_da7219_max98357_sound
+
+  mediatek,platform:
+    $ref: "/schemas/types.yaml#/definitions/phandle"
+    description: The phandle of MT8186 ASoC platform.
+
+  headset-codec:
+    type: object
+    properties:
+      sound-dai:
+        $ref: /schemas/types.yaml#/definitions/phandle
+    required:
+        - sound-dai
+
+  playback-codecs:
+    type: object
+    properties:
+      sound-dai:
+        minItems: 2
+        maxItems: 3
+        $ref: /schemas/types.yaml#/definitions/phandle-array
+    required:
+        - sound-dai
+
+additionalProperties: false
+
+required:
+  - compatible
+  - mediatek,platform
+  - headset-codec
+  - playback-codecs
+
+examples:
+  - |
+
+    sound: mt8186-sound {
+        compatible = "mediatek,mt8186_mt6366_da7219_max98357_sound";
+        mediatek,platform = <&afe>;
+        pinctrl-names = "aud_clk_mosi_off",
+                        "aud_clk_mosi_on";
+        pinctrl-0 = <&aud_clk_mosi_off>;
+        pinctrl-1 = <&aud_clk_mosi_on>;
+
+        headset-codec {
+            sound-dai = <&da7219>;
+        };
+
+        playback-codecs {
+            sound-dai = <&anx_bridge_dp>,
+                        <&max98357a>;
+        };
+    };
+
+...