diff mbox series

[V3,2/2] ASoC: dt-bindings: max98363: add soundwire amplifier

Message ID 20230323175256.2606939-2-ryan.lee.analog@gmail.com
State Superseded
Headers show
Series None | expand

Commit Message

“Ryan March 23, 2023, 5:52 p.m. UTC
From: Ryan Lee <ryans.lee@analog.com>

This patch adds dt-bindings information for Analog Devices MAX98363
SoundWire Amplifier.

Signed-off-by: Ryan Lee <ryans.lee@analog.com>
---
Changes from v1:
  Fixed a syntax error for the 'dt_binding_check' build.
  Removed unnecessary properties.
  Added description about SoundWire device ID of MAX98363
Changes from v2:
  Removed the legacy from i2c/i2s driver and added SoundWire device ID info.
  Added missing information about DAI.

 .../bindings/sound/adi,max98363.yaml          | 62 +++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/adi,max98363.yaml

Comments

Lee, RyanS March 30, 2023, 10:26 p.m. UTC | #1
> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Friday, March 24, 2023 4:37 AM
> To: “Ryan <ryan.lee.analog@gmail.com>; lgirdwood@gmail.com;
> broonie@kernel.org; perex@perex.cz; tiwai@suse.com;
> rf@opensource.cirrus.com; ckeepax@opensource.cirrus.com; pierre-
> louis.bossart@linux.intel.com; herve.codina@bootlin.com;
> wangweidong.a@awinic.com; james.schulman@cirrus.com;
> ajye_huang@compal.corp-partner.google.com; shumingf@realtek.com;
> povik+lin@cutebit.org; flatmax@flatmax.com; linux-kernel@vger.kernel.org;
> alsa-devel@alsa-project.org; robh+dt@kernel.org;
> devicetree@vger.kernel.org; Lee, RyanS <RyanS.Lee@analog.com>
> Subject: Re: [PATCH V3 2/2] ASoC: dt-bindings: max98363: add soundwire
> amplifier
> 
> [External]
> 
> On 23/03/2023 18:52, “Ryan wrote:
> > From: Ryan Lee <ryans.lee@analog.com>
> >
> > This patch adds dt-bindings information for Analog Devices MAX98363
> > SoundWire Amplifier.
> 
> No improvements here. So reminding:
> 
> Do not use "This commit/patch", but imperative mood. See:
> https://urldefense.com/v3/__https://elixir.bootlin.com/linux/v5.17.1/sourc
> e/Documentation/process/submitting-
> patches.rst*L95__;Iw!!A3Ni8CS0y2Y!45rMxtn89otlen5mjEOGMXoPQwnsl3p9
> qtuTJR99QgKZDNdFOo-ufIWE2OeebHfJynGjhmC4y2fFPWtYaTwRKjXhfkE$
> 

Thanks for the comment. I shall fix this and the rest.

> >
> > Signed-off-by: Ryan Lee <ryans.lee@analog.com>
> > ---
> > Changes from v1:
> >   Fixed a syntax error for the 'dt_binding_check' build.
> >   Removed unnecessary properties.
> >   Added description about SoundWire device ID of MAX98363 Changes from
> > v2:
> >   Removed the legacy from i2c/i2s driver and added SoundWire device ID
> info.
> >   Added missing information about DAI.
> >
> >  .../bindings/sound/adi,max98363.yaml          | 62 +++++++++++++++++++
> >  1 file changed, 62 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/sound/adi,max98363.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> > b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> > new file mode 100644
> > index 000000000000..92352a23e1cb
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
> > @@ -0,0 +1,62 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> >
> +https://urldefense.com/v3/__http://devicetree.org/schemas/sound/adi,m
> >
> +ax98363.yaml*__;Iw!!A3Ni8CS0y2Y!45rMxtn89otlen5mjEOGMXoPQwnsl3p
> 9qtuTJ
> > +R99QgKZDNdFOo-ufIWE2OeebHfJynGjhmC4y2fFPWtYaTwRYaJNMro$
> > +$schema:
> > +https://urldefense.com/v3/__http://devicetree.org/meta-
> schemas/core.y
> >
> +aml*__;Iw!!A3Ni8CS0y2Y!45rMxtn89otlen5mjEOGMXoPQwnsl3p9qtuTJR99
> QgKZDN
> > +dFOo-ufIWE2OeebHfJynGjhmC4y2fFPWtYaTwRTMn3208$
> > +
> > +title: Analog Devices MAX98363 SoundWire Amplifier
> > +
> > +maintainers:
> > +  - Ryan Lee <ryans.lee@analog.com>
> > +
> > +description:
> > +  The MAX98363 is a SoundWire input Class D mono amplifier that
> > +  supports MIPI SoundWire v1.2-compatible digital interface for
> > +  audio and control data.
> > +  SoundWire peripheral device ID of MAX98363 is 0x3X019F836300
> 
> lowercase hex
> 
> > +  where X is the peripheral device unique ID decoded from pin.
> > +  It supports up to 10 peripheral devices(0x0 to 0x9).
> > +
> > +allOf:
> > +  - $ref: dai-common.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    const: sdw3019F836300
> 
> lowercase hex (also in example)
> 
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  '#sound-dai-cells':
> > +    const: 0
> > +
> > +  sound-name-prefix: true
> 
> Drop this.
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - "#sound-dai-cells"
> > +
> > +additionalProperties: false
> 
> Instead:
> unevaluatedProperties: false
> 
> Best regards,
> Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/adi,max98363.yaml b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
new file mode 100644
index 000000000000..92352a23e1cb
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/adi,max98363.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/adi,max98363.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices MAX98363 SoundWire Amplifier
+
+maintainers:
+  - Ryan Lee <ryans.lee@analog.com>
+
+description:
+  The MAX98363 is a SoundWire input Class D mono amplifier that
+  supports MIPI SoundWire v1.2-compatible digital interface for
+  audio and control data.
+  SoundWire peripheral device ID of MAX98363 is 0x3X019F836300
+  where X is the peripheral device unique ID decoded from pin.
+  It supports up to 10 peripheral devices(0x0 to 0x9).
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    const: sdw3019F836300
+
+  reg:
+    maxItems: 1
+
+  '#sound-dai-cells':
+    const: 0
+
+  sound-name-prefix: true
+
+required:
+  - compatible
+  - reg
+  - "#sound-dai-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    soundwire-controller@3250000 {
+        #address-cells = <2>;
+        #size-cells = <0>;
+        reg = <0x3250000 0x2000>;
+
+        speaker@0,0 {
+            compatible = "sdw3019F836300";
+            reg = <0 0>;
+            #sound-dai-cells = <0>;
+            sound-name-prefix = "Speaker Left";
+        };
+
+        speaker@0,1 {
+            compatible = "sdw3019F836300";
+            reg = <0 1>;
+            #sound-dai-cells = <0>;
+            sound-name-prefix = "Speaker Right";
+        };
+    };