diff mbox series

ASoC: dt-bindings: ssm2602: convert to dt schema

Message ID 20240511214739.242950-1-shenxiaxi26@gmail.com
State Superseded
Headers show
Series ASoC: dt-bindings: ssm2602: convert to dt schema | expand

Checks

Context Check Description
robh/checkpatch warning total: 1 errors, 2 warnings, 50 lines checked
robh/patch-applied success
robh/dt-meta-schema fail build log

Commit Message

Xiaxi Shen May 11, 2024, 9:47 p.m. UTC
Convert adi,ssm2602 binding to DT schema

The original adi,ssm2602.txt contains bindings for 3 devices
SSM2602, SSM2603 and SSM2604. Since they share something
in common. So I created one single yaml and name it 260x instead.
Let me know if you think it should be done in another way.

It passed dt_binding_check and dtbs_check.

Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
---
 .../devicetree/bindings/sound/adi,ssm2602.txt | 19 -------
 .../bindings/sound/adi,ssm260x.yaml           | 50 +++++++++++++++++++
 2 files changed, 50 insertions(+), 19 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/adi,ssm2602.txt
 create mode 100644 Documentation/devicetree/bindings/sound/adi,ssm260x.yaml

Comments

Rob Herring May 11, 2024, 11:26 p.m. UTC | #1
On Sat, 11 May 2024 14:47:39 -0700, Xiaxi Shen wrote:
> Convert adi,ssm2602 binding to DT schema
> 
> The original adi,ssm2602.txt contains bindings for 3 devices
> SSM2602, SSM2603 and SSM2604. Since they share something
> in common. So I created one single yaml and name it 260x instead.
> Let me know if you think it should be done in another way.
> 
> It passed dt_binding_check and dtbs_check.
> 
> Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
> ---
>  .../devicetree/bindings/sound/adi,ssm2602.txt | 19 -------
>  .../bindings/sound/adi,ssm260x.yaml           | 50 +++++++++++++++++++
>  2 files changed, 50 insertions(+), 19 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/adi,ssm2602.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/adi,ssm260x.yaml
> 

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

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/adi,ssm260x.yaml: $id: Cannot determine base path from $id, relative path/filename doesn't match actual path or filename
 	 $id: http://devicetree.org/schemas/sound/adi,ssm2602.yaml
 	file: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/adi,ssm260x.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240511214739.242950-1-shenxiaxi26@gmail.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

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 after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/adi,ssm2602.txt b/Documentation/devicetree/bindings/sound/adi,ssm2602.txt
deleted file mode 100644
index 3b3302fe399b..000000000000
--- a/Documentation/devicetree/bindings/sound/adi,ssm2602.txt
+++ /dev/null
@@ -1,19 +0,0 @@ 
-Analog Devices SSM2602, SSM2603 and SSM2604 I2S audio CODEC devices
-
-SSM2602 support both I2C and SPI as the configuration interface,
-the selection is made by the MODE strap-in pin.
-SSM2603 and SSM2604 only support I2C as the configuration interface.
-
-Required properties:
-
-  - compatible : One of "adi,ssm2602", "adi,ssm2603" or "adi,ssm2604"
-
-  - reg : the I2C address of the device for I2C, the chip select
-          number for SPI.
-
- Example:
-
-	ssm2602: ssm2602@1a {
-		compatible = "adi,ssm2602";
-		reg = <0x1a>;
-	};
diff --git a/Documentation/devicetree/bindings/sound/adi,ssm260x.yaml b/Documentation/devicetree/bindings/sound/adi,ssm260x.yaml
new file mode 100644
index 000000000000..f465f9168a0a
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/adi,ssm260x.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/adi,ssm2602.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices SSM2602, SSM2603 and SSM2604 I2S audio CODEC devices
+
+description:
+  SSM2602 support both I2C and SPI as the configuration interface,
+  
+  the selection is made by the MODE strap-in pin.
+
+  SSM2603 and SSM2604 only support I2C as the configuration interface.
+
+maintainers:
+  - Liam Girdwood <lgirdwood@gmail.com>
+  - Mark Brown <broonie@kernel.org>
+  - Rob Herring <robh@kernel.org>
+  - Krzysztof Kozlowski <krzk+dt@kernel.org>
+  - Conor Dooley <conor+dt@kernel.org>
+
+properties:
+  compatible:
+    description: One of "adi,ssm2602", "adi,ssm2603" or "adi,ssm2604"
+    enum:
+      - adi,ssm2602
+      - adi,ssm2603
+      - adi,ssm2604
+
+  reg:
+    description: the I2C address of the device for I2C, the chip select number for SPI.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+   i2c {
+     #address-cells = <1>;
+     #size-cells = <0>;
+     ssm2602@1a {
+       compatible = "adi,ssm2602";
+       reg = <0x1a>;
+     };
+   };