diff mbox series

[1/3] ASoC: dt-bindings: maxim,max9867: convert txt bindings to yaml

Message ID 20230302-max9867-v1-1-aa9f7f25db5e@skidata.com
State New
Headers show
Series Add "mclk" support for maxim,max9867 | expand

Commit Message

Richard Leitner March 2, 2023, 11:55 a.m. UTC 
From: Richard Leitner <richard.leitner@skidata.com>

Convert from max9867.txt to maxim,max9867.yaml and add missing
'#sound-dai-cells' property.

Signed-off-by: Richard Leitner <richard.leitner@skidata.com>
---
 .../devicetree/bindings/sound/max9867.txt          | 17 --------
 .../devicetree/bindings/sound/maxim,max9867.yaml   | 51 ++++++++++++++++++++++
 2 files changed, 51 insertions(+), 17 deletions(-)

Comments

Richard Leitner March 2, 2023, 1:48 p.m. UTC | #1 
On Thu, Mar 02, 2023 at 02:31:14PM +0100, Krzysztof Kozlowski wrote:
> On 02/03/2023 12:55, richard.leitner@linux.dev wrote:
> > From: Richard Leitner <richard.leitner@skidata.com>
> > 
> > Convert from max9867.txt to maxim,max9867.yaml and add missing
> > '#sound-dai-cells' property.
> 
> Thank you for your patch. There is something to discuss/improve.
> 
> Except wrong ID (and missing test):
> 
> > +
> > +examples:
> > +  - |
> > +    &i2c {
> > +            max9867: max9867@18 {
> 
> Generic node names, so "codec" and drop the unused label.

Thanks for the review and feedback. I'll fix that in v2.

> 
> Use 4 spaces for example indentation.

Ok. checkpatch.pl didn't complain about that so I thought this was
fine. Are there any other scripts/tools to check for correct formatting
of bindings?

> 
> > +                    compatible = "maxim,max9867";
> > +                    #sound-dai-cells = <0>;
> > +                    reg = <0x18>;
> 
> Best regards,
> Krzysztof
> 

Thanks & regards;rl
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/max9867.txt b/Documentation/devicetree/bindings/sound/max9867.txt
deleted file mode 100644
index b8bd914ee697..000000000000
--- a/Documentation/devicetree/bindings/sound/max9867.txt
+++ /dev/null
@@ -1,17 +0,0 @@ 
-max9867 codec
-
-This device supports I2C mode only.
-
-Required properties:
-
-- compatible : "maxim,max9867"
-- reg : The chip select number on the I2C bus
-
-Example:
-
-&i2c {
-	max9867: max9867@18 {
-		compatible = "maxim,max9867";
-		reg = <0x18>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/sound/maxim,max9867.yaml b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
new file mode 100644
index 000000000000..cefa43c3d34e
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/max9867.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim Integrated MAX9867 CODEC
+
+description: |
+  This device supports I2C only.
+  Pins on the device (for linking into audio routes):
+      * LOUT
+      * ROUT
+      * LINL
+      * LINR
+      * MICL
+      * MICR
+      * DMICL
+      * DMICR
+
+maintainers:
+  - Ladislav Michl <ladis@linux-mips.org>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    enum:
+      - maxim,max9867
+
+  '#sound-dai-cells':
+    const: 0
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    &i2c {
+            max9867: max9867@18 {
+                    compatible = "maxim,max9867";
+                    #sound-dai-cells = <0>;
+                    reg = <0x18>;
+            };
+    };
+...