diff mbox series

dt-bindings: sound:atmel-at91sam9g20ek: convert bindings to json-schema

Message ID 20240214-at91sam9g20ek-wm8731-yaml-v1-1-33333e17383b@microchip.com
State New
Headers show
Series dt-bindings: sound:atmel-at91sam9g20ek: convert bindings to json-schema | expand

Commit Message

Balakrishnan Sambath Feb. 14, 2024, 6:40 a.m. UTC
Convert atmel-at91sam9g20ek-wm8731-audio DT binding to yaml
based json-schema.Change file name to match json-scheme naming.

Signed-off-by: Balakrishnan Sambath <balakrishnan.s@microchip.com>
---
 .../bindings/sound/atmel,at91sam9g20ek-wm8731.yaml | 60 ++++++++++++++++++++++
 .../sound/atmel-at91sam9g20ek-wm8731-audio.txt     | 26 ----------
 2 files changed, 60 insertions(+), 26 deletions(-)


---
base-commit: 0dd3ee31125508cd67f7e7172247f05b7fd1753a
change-id: 20240214-at91sam9g20ek-wm8731-yaml-404ddddbb91a

Best regards,

Comments

Balakrishnan Sambath Feb. 23, 2024, 9:27 a.m. UTC | #1
Hi Rob,

On 14/02/24 7:28 pm, Rob Herring wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On Wed, Feb 14, 2024 at 12:10:06PM +0530, Balakrishnan Sambath wrote:
>> Convert atmel-at91sam9g20ek-wm8731-audio DT binding to yaml
>> based json-schema.Change file name to match json-scheme naming.
>>
>> Signed-off-by: Balakrishnan Sambath <balakrishnan.s@microchip.com>
>> ---
>>   .../bindings/sound/atmel,at91sam9g20ek-wm8731.yaml | 60 ++++++++++++++++++++++
>>   .../sound/atmel-at91sam9g20ek-wm8731-audio.txt     | 26 ----------
>>   2 files changed, 60 insertions(+), 26 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml b/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml
>> new file mode 100644
>> index 000000000000..f6330707fe1b
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml
>> @@ -0,0 +1,60 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/sound/atmel,at91sam9g20ek-wm8731.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Atmel at91sam9g20ek wm8731 audio complex
>> +
>> +maintainers:
>> +  - Balakrishnan Sambath <balakrishnan.s@microchip.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: atmel,at91sam9g20ek-wm8731-audio
>> +
>> +  atmel,model:
>> +    $ref: /schemas/types.yaml#/definitions/string
>> +    description: The user-visible name of this sound complex.
> 
> blank line between DT properties
> 
sure, thanks for pointing it out. I'll fix this in v2
>> +  atmel,audio-routing:
>> +    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
>> +    description: A list of the connections between audio components.
>> +    minItems: 2
> 
> No max?
> 

Here, there's no explicit constraint on the maximum number of items, so 
I only enforced minItems. Please let me know if I'm doing something wrong.

>> +    items:
>> +      enum:
>> +        # Board Connectors
>> +        - "Ext Spk"
>> +        - "Int MIC"
>> +
>> +        # CODEC Pins
>> +        - LHPOUT
>> +        - MICIN
>> +  atmel,ssc-controller:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description: The phandle of the SSC controller
>> +  atmel,audio-codec:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description: The phandle of WM8731 audio codec
>> +
>> +required:
>> +  - compatible
>> +  - atmel,model
>> +  - atmel,audio-routing
>> +  - atmel,ssc-controller
>> +  - atmel,audio-codec
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    sound {
>> +        compatible = "atmel,at91sam9g20ek-wm8731-audio";
>> +        pinctrl-names = "default";
>> +        pinctrl-0 = <&pinctrl_pck0_as_mck>;
>> +        atmel,model = "wm8731 @ AT91SAMG20EK";
>> +        atmel,audio-routing =
>> +            "Ext Spk", "LHPOUT",
>> +            "Int MIC", "MICIN";
>> +        atmel,ssc-controller = <&ssc0>;
>> +        atmel,audio-codec = <&wm8731>;
>> +    };
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml b/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml
new file mode 100644
index 000000000000..f6330707fe1b
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/atmel,at91sam9g20ek-wm8731.yaml
@@ -0,0 +1,60 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/atmel,at91sam9g20ek-wm8731.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel at91sam9g20ek wm8731 audio complex
+
+maintainers:
+  - Balakrishnan Sambath <balakrishnan.s@microchip.com>
+
+properties:
+  compatible:
+    const: atmel,at91sam9g20ek-wm8731-audio
+
+  atmel,model:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: The user-visible name of this sound complex.
+  atmel,audio-routing:
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+    description: A list of the connections between audio components.
+    minItems: 2
+    items:
+      enum:
+        # Board Connectors
+        - "Ext Spk"
+        - "Int MIC"
+
+        # CODEC Pins
+        - LHPOUT
+        - MICIN
+  atmel,ssc-controller:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: The phandle of the SSC controller
+  atmel,audio-codec:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: The phandle of WM8731 audio codec
+
+required:
+  - compatible
+  - atmel,model
+  - atmel,audio-routing
+  - atmel,ssc-controller
+  - atmel,audio-codec
+
+additionalProperties: false
+
+examples:
+  - |
+    sound {
+        compatible = "atmel,at91sam9g20ek-wm8731-audio";
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_pck0_as_mck>;
+        atmel,model = "wm8731 @ AT91SAMG20EK";
+        atmel,audio-routing =
+            "Ext Spk", "LHPOUT",
+            "Int MIC", "MICIN";
+        atmel,ssc-controller = <&ssc0>;
+        atmel,audio-codec = <&wm8731>;
+    };
diff --git a/Documentation/devicetree/bindings/sound/atmel-at91sam9g20ek-wm8731-audio.txt b/Documentation/devicetree/bindings/sound/atmel-at91sam9g20ek-wm8731-audio.txt
deleted file mode 100644
index 9c5a9947b64d..000000000000
--- a/Documentation/devicetree/bindings/sound/atmel-at91sam9g20ek-wm8731-audio.txt
+++ /dev/null
@@ -1,26 +0,0 @@ 
-* Atmel at91sam9g20ek wm8731 audio complex
-
-Required properties:
-  - compatible: "atmel,at91sam9g20ek-wm8731-audio"
-  - atmel,model: The user-visible name of this sound complex.
-  - atmel,audio-routing: A list of the connections between audio components.
-  - atmel,ssc-controller: The phandle of the SSC controller
-  - atmel,audio-codec: The phandle of the WM8731 audio codec
-Optional properties:
-  - pinctrl-names, pinctrl-0: Please refer to pinctrl-bindings.txt
-
-Example:
-sound {
-	compatible = "atmel,at91sam9g20ek-wm8731-audio";
-	pinctrl-names = "default";
-	pinctrl-0 = <&pinctrl_pck0_as_mck>;
-
-	atmel,model = "wm8731 @ AT91SAMG20EK";
-
-	atmel,audio-routing =
-		"Ext Spk", "LHPOUT",
-		"Int MIC", "MICIN";
-
-	atmel,ssc-controller = <&ssc0>;
-	atmel,audio-codec = <&wm8731>;
-};