diff mbox series

[3/5] dt-bindings: mediatek: mt8192: add audio afe document

Message ID 1601624142-18991-4-git-send-email-jiaxin.yu@mediatek.com
State New
Headers show
Series ASoC: Mediatek: Add support for MT8192 SoC | expand

Commit Message

Jiaxin Yu (俞家鑫) Oct. 2, 2020, 7:35 a.m. UTC 
This patch adds mt8192 audio afe document.

Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>

---
 .../bindings/sound/mt8192-afe-pcm.yaml        | 98 +++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml

-- 
2.18.0

Comments

Rob Herring Oct. 5, 2020, 1:55 p.m. UTC | #1 
On Fri, 02 Oct 2020 15:35:40 +0800, Jiaxin Yu wrote:
> This patch adds mt8192 audio afe document.
> 
> Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> ---
>  .../bindings/sound/mt8192-afe-pcm.yaml        | 98 +++++++++++++++++++
>  1 file changed, 98 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
> 


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

Documentation/devicetree/bindings/sound/mt8192-afe-pcm.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/sound/mt8192-afe-pcm.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/1375582

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 Oct. 5, 2020, 1:57 p.m. UTC | #2 
On Fri, Oct 02, 2020 at 03:35:40PM +0800, Jiaxin Yu wrote:
> This patch adds mt8192 audio afe document.
> 
> Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>
> ---
>  .../bindings/sound/mt8192-afe-pcm.yaml        | 98 +++++++++++++++++++
>  1 file changed, 98 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
> new file mode 100644
> index 0000000000000..43852315f1867
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
> @@ -0,0 +1,98 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings:

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

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/mt8192-afe-pcm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Mediatek AFE PCM controller for mt8192
> +
> +maintainers:
> +   - Jiaxin Yu <jiaxin.yu@mediatek.com>
> +   - Shane Chien <shane.chien@mediatek.com>
> +
> +properties:
> +  compatible:
> +    contains:

So any other string in addition is okay?

> +      const: mediatek,mt8192-audio
> +
> +  interrupts:
> +    maxItems: 1
> +    description: AFE interrupt line

Drop description.

> +
> +  resets:
> +    maxItems: 1
> +
> +  reset-names:
> +    const: audiosys
> +
> +  apmixedsys:
> +    maxItems: 1

This is an array?

> +    description: The mediatek apmixedsys controller
> +
> +  infracfg:
> +    maxItems: 1
> +    description: The mediatek infracfg controller
> +
> +  topckgen:
> +    maxItems: 1
> +    description: The mediatek topckgen controller

These all need a type reference and and vendor prefix.

> +
> +  power-domains:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: AFE clock
> +      - description: ADDA DAC clock
> +      - description: ADDA DAC pre-distortion clock
> +      - description: audio infra sys clock
> +      - description: audio infra 26M clock
> +
> +  clock-names:
> +    items:
> +      - const: aud_afe_clk
> +      - const: aud_dac_clk
> +      - const: aud_dac_predis_clk
> +      - const: aud_infra_clk
> +      - const: aud_infra_26m_clk
> +
> +required:
> +  - compatible
> +  - interrupts
> +  - resets
> +  - reset-names
> +  - power-domains
> +  - clocks
> +  - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/mt8192-clk.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/power/mt8192-power.h>
> +
> +    afe: mt8192-afe-pcm {
> +        compatible = "mediatek,mt8192-audio";
> +        interrupts = <GIC_SPI 202 IRQ_TYPE_LEVEL_HIGH>;
> +        resets = <&watchdog MT8192_TOPRGU_AUDIO_SW_RST>;
> +        reset-names = "audiosys";
> +        apmixedsys = <&apmixedsys>;
> +        infracfg = <&infracfg>;
> +        topckgen = <&topckgen>;
> +        power-domains = <&scpsys MT8192_POWER_DOMAIN_AUDIO>;
> +        clocks = <&audsys CLK_AUD_AFE>,
> +                 <&audsys CLK_AUD_DAC>,
> +                 <&audsys CLK_AUD_DAC_PREDIS>,
> +                 <&infracfg CLK_INFRA_AUDIO>,
> +                 <&infracfg CLK_INFRA_AUDIO_26M_B>;
> +        clock-names = "aud_afe_clk",
> +                      "aud_dac_clk",
> +                      "aud_dac_predis_clk",
> +                      "aud_infra_clk",
> +                      "aud_infra_26m_clk";
> +    };
> +
> +...
> -- 
> 2.18.0
Jiaxin Yu (俞家鑫) Oct. 12, 2020, 5:47 a.m. UTC | #3 
On Mon, 2020-10-05 at 08:55 -0500, Rob Herring wrote:
> On Fri, 02 Oct 2020 15:35:40 +0800, Jiaxin Yu wrote:

> > This patch adds mt8192 audio afe document.

> > 

> > Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>

> > ---

> >  .../bindings/sound/mt8192-afe-pcm.yaml        | 98 +++++++++++++++++++

> >  1 file changed, 98 insertions(+)

> >  create mode 100644 Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml

> > 

> 

> 

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

> 

> Documentation/devicetree/bindings/sound/mt8192-afe-pcm.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/sound/mt8192-afe-pcm.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/1375582

> 

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

> 

Sorry, I should add a dependency description.
"dt-bindings/clock/mt8192-clk.h" is included in
https://patchwork.kernel.org/cover/11752231 series of patches, but they
has not been accepted.
Jiaxin Yu (俞家鑫) Oct. 12, 2020, 5:56 a.m. UTC | #4 
On Mon, 2020-10-05 at 08:57 -0500, Rob Herring wrote:
> On Fri, Oct 02, 2020 at 03:35:40PM +0800, Jiaxin Yu wrote:

> > This patch adds mt8192 audio afe document.

> > 

> > Signed-off-by: Jiaxin Yu <jiaxin.yu@mediatek.com>

> > ---

> >  .../bindings/sound/mt8192-afe-pcm.yaml        | 98 +++++++++++++++++++

> >  1 file changed, 98 insertions(+)

> >  create mode 100644 Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml

> > 

> > diff --git a/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml

> > new file mode 100644

> > index 0000000000000..43852315f1867

> > --- /dev/null

> > +++ b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml

> > @@ -0,0 +1,98 @@

> > +# SPDX-License-Identifier: GPL-2.0

> 

> Dual license new bindings:

> 

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

> 

Ok, got it.

> > +%YAML 1.2

> > +---

> > +$id: http://devicetree.org/schemas/sound/mt8192-afe-pcm.yaml#

> > +$schema: http://devicetree.org/meta-schemas/core.yaml#

> > +

> > +title: Mediatek AFE PCM controller for mt8192

> > +

> > +maintainers:

> > +   - Jiaxin Yu <jiaxin.yu@mediatek.com>

> > +   - Shane Chien <shane.chien@mediatek.com>

> > +

> > +properties:

> > +  compatible:

> > +    contains:

> 

> So any other string in addition is okay?

> 

No, there will be no other string. So do I need to remove "contains"?

> > +      const: mediatek,mt8192-audio

> > +

> > +  interrupts:

> > +    maxItems: 1

> > +    description: AFE interrupt line

> 

> Drop description.

> 

Ok.

> > +

> > +  resets:

> > +    maxItems: 1

> > +

> > +  reset-names:

> > +    const: audiosys

> > +

> > +  apmixedsys:

> > +    maxItems: 1

> 

> This is an array?

> 

No, it is just a phandle to the mediatek apmixedsys controller.

> > +    description: The mediatek apmixedsys controller

> > +

> > +  infracfg:

> > +    maxItems: 1

> > +    description: The mediatek infracfg controller

> > +

> > +  topckgen:

> > +    maxItems: 1

> > +    description: The mediatek topckgen controller

> 

> These all need a type reference and and vendor prefix.

> 

Should I change it to the following?

mediatek,topckgen:
  $ref: "/schemas/types.yaml#/definitions/phandle"
  maxItems: 1
  description: The phandle of the mediatek topckgen controller

> > +

> > +  power-domains:

> > +    maxItems: 1

> > +

> > +  clocks:

> > +    items:

> > +      - description: AFE clock

> > +      - description: ADDA DAC clock

> > +      - description: ADDA DAC pre-distortion clock

> > +      - description: audio infra sys clock

> > +      - description: audio infra 26M clock

> > +

> > +  clock-names:

> > +    items:

> > +      - const: aud_afe_clk

> > +      - const: aud_dac_clk

> > +      - const: aud_dac_predis_clk

> > +      - const: aud_infra_clk

> > +      - const: aud_infra_26m_clk

> > +

> > +required:

> > +  - compatible

> > +  - interrupts

> > +  - resets

> > +  - reset-names

> > +  - power-domains

> > +  - clocks

> > +  - clock-names

> > +

> > +additionalProperties: false

> > +

> > +examples:

> > +  - |

> > +    #include <dt-bindings/clock/mt8192-clk.h>

> > +    #include <dt-bindings/interrupt-controller/irq.h>

> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>

> > +    #include <dt-bindings/power/mt8192-power.h>

> > +

> > +    afe: mt8192-afe-pcm {

> > +        compatible = "mediatek,mt8192-audio";

> > +        interrupts = <GIC_SPI 202 IRQ_TYPE_LEVEL_HIGH>;

> > +        resets = <&watchdog MT8192_TOPRGU_AUDIO_SW_RST>;

> > +        reset-names = "audiosys";

> > +        apmixedsys = <&apmixedsys>;

> > +        infracfg = <&infracfg>;

> > +        topckgen = <&topckgen>;

> > +        power-domains = <&scpsys MT8192_POWER_DOMAIN_AUDIO>;

> > +        clocks = <&audsys CLK_AUD_AFE>,

> > +                 <&audsys CLK_AUD_DAC>,

> > +                 <&audsys CLK_AUD_DAC_PREDIS>,

> > +                 <&infracfg CLK_INFRA_AUDIO>,

> > +                 <&infracfg CLK_INFRA_AUDIO_26M_B>;

> > +        clock-names = "aud_afe_clk",

> > +                      "aud_dac_clk",

> > +                      "aud_dac_predis_clk",

> > +                      "aud_infra_clk",

> > +                      "aud_infra_26m_clk";

> > +    };

> > +

> > +...

> > -- 

> > 2.18.0
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
new file mode 100644
index 0000000000000..43852315f1867
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/mt8192-afe-pcm.yaml
@@ -0,0 +1,98 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/mt8192-afe-pcm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek AFE PCM controller for mt8192
+
+maintainers:
+   - Jiaxin Yu <jiaxin.yu@mediatek.com>
+   - Shane Chien <shane.chien@mediatek.com>
+
+properties:
+  compatible:
+    contains:
+      const: mediatek,mt8192-audio
+
+  interrupts:
+    maxItems: 1
+    description: AFE interrupt line
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    const: audiosys
+
+  apmixedsys:
+    maxItems: 1
+    description: The mediatek apmixedsys controller
+
+  infracfg:
+    maxItems: 1
+    description: The mediatek infracfg controller
+
+  topckgen:
+    maxItems: 1
+    description: The mediatek topckgen controller
+
+  power-domains:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: AFE clock
+      - description: ADDA DAC clock
+      - description: ADDA DAC pre-distortion clock
+      - description: audio infra sys clock
+      - description: audio infra 26M clock
+
+  clock-names:
+    items:
+      - const: aud_afe_clk
+      - const: aud_dac_clk
+      - const: aud_dac_predis_clk
+      - const: aud_infra_clk
+      - const: aud_infra_26m_clk
+
+required:
+  - compatible
+  - interrupts
+  - resets
+  - reset-names
+  - power-domains
+  - clocks
+  - clock-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/mt8192-clk.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/power/mt8192-power.h>
+
+    afe: mt8192-afe-pcm {
+        compatible = "mediatek,mt8192-audio";
+        interrupts = <GIC_SPI 202 IRQ_TYPE_LEVEL_HIGH>;
+        resets = <&watchdog MT8192_TOPRGU_AUDIO_SW_RST>;
+        reset-names = "audiosys";
+        apmixedsys = <&apmixedsys>;
+        infracfg = <&infracfg>;
+        topckgen = <&topckgen>;
+        power-domains = <&scpsys MT8192_POWER_DOMAIN_AUDIO>;
+        clocks = <&audsys CLK_AUD_AFE>,
+                 <&audsys CLK_AUD_DAC>,
+                 <&audsys CLK_AUD_DAC_PREDIS>,
+                 <&infracfg CLK_INFRA_AUDIO>,
+                 <&infracfg CLK_INFRA_AUDIO_26M_B>;
+        clock-names = "aud_afe_clk",
+                      "aud_dac_clk",
+                      "aud_dac_predis_clk",
+                      "aud_infra_clk",
+                      "aud_infra_26m_clk";
+    };
+
+...