[PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

[PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

[Ryan.Wanner]

From: Ryan Wanner <Ryan.Wanner@microchip.com>

Convert Atmel PDMIC devicetree binding to json-schema.
Change file naming to match json-schema naming.

Signed-off-by: Ryan Wanner <Ryan.Wanner@microchip.com>
---
 .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
 .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------
 2 files changed, 104 insertions(+), 55 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt

diff --git a/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
new file mode 100644
index 000000000000..cb34c0fc4fc8
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/atmel,sama5d2-pdmic.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel PDMIC driver under ALSA SoC architecture
+
+maintainers:
+  - Claudiu Beznea <claudiu.beznea@microchip.com>
+
+description:
+  Atmel Pulse Density Modulation Interface Controller
+  (PDMIC) peripheral is a mono PDM decoder module
+  that decodes an incoming PDM sample stream.
+
+properties:
+  compatible:
+    items:
+      - const: atmel,sama5d2-pdmic
+
+  reg:
+    description: Should contain PDMIC registers location and length.
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    description:
+      Must contain an entry for each required entry in clock-names.
+      Please refer to clock-bindings.txt.
+
+    items:
+      - description: peripheral clock.
+      - description: generated clock.
+
+  clock-names:
+    items:
+      - const: pclk
+      - const: gclk
+
+  dmas:
+    maxItems: 1
+
+  dma-names:
+    const: rx
+
+  atmel,mic-min-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The minimal frequency that the microphone supports.
+
+  atmel,mic-max-freq:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      The maximal frequency that the microphone supports.
+
+  atmel,model:
+    description: The user-visible name of this sound card.
+    $ref: /schemas/types.yaml#/definitions/string
+    default: PDMIC
+
+  atmel,mic-offset:
+    $ref: /schemas/types.yaml#/definitions/int32
+    description: The offset that should be added.
+    default: 0
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+  - clock-names
+  - clocks
+  - atmel,mic-min-freq
+  - atmel,mic-max-freq
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/dma/at91.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    pdmic: sound@f8018000 {
+              compatible = "atmel,sama5d2-pdmic";
+              reg = <0xf8018000 0x124>;
+              interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
+              dmas = <&dma0
+                      (AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
+                      | AT91_XDMAC_DT_PERID(50))>;
+              dma-names = "rx";
+              clocks = <&pdmic_clk>, <&pdmic_gclk>;
+              clock-names = "pclk", "gclk";
+              pinctrl-names = "default";
+              pinctrl-0 = <&pinctrl_pdmic_default>;
+              atmel,model = "PDMIC@sama5d2_xplained";
+              atmel,mic-min-freq = <1000000>;
+              atmel,mic-max-freq = <3246000>;
+              atmel,mic-offset = <0x0>;
+    };
diff --git a/Documentation/devicetree/bindings/sound/atmel-pdmic.txt b/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
deleted file mode 100644
index e0875f17c229..000000000000
--- a/Documentation/devicetree/bindings/sound/atmel-pdmic.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-* Atmel PDMIC driver under ALSA SoC architecture
-
-Required properties:
-- compatible
-	Should be "atmel,sama5d2-pdmic".
-- reg
-	Should contain PDMIC registers location and length.
-- interrupts
-	Should contain the IRQ line for the PDMIC.
-- dmas
-	One DMA specifiers as described in atmel-dma.txt and dma.txt files.
-- dma-names
-	Must be "rx".
-- clock-names
-	Required elements:
-	- "pclk"	peripheral clock
-	- "gclk"	generated clock
-- clocks
-	Must contain an entry for each required entry in clock-names.
-	Please refer to clock-bindings.txt.
-- atmel,mic-min-freq
-	The minimal frequency that the micphone supports.
-- atmel,mic-max-freq
-	The maximal frequency that the micphone supports.
-
-Optional properties:
-- pinctrl-names, pinctrl-0
-	Please refer to pinctrl-bindings.txt.
-- atmel,model
-	The user-visible name of this sound card.
-	The default value is "PDMIC".
-- atmel,mic-offset
-	The offset that should be added.
-	The range is from -32768 to 32767.
-	The default value is 0.
-
-Example:
-	pdmic@f8018000 {
-				compatible = "atmel,sama5d2-pdmic";
-				reg = <0xf8018000 0x124>;
-				interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
-				dmas = <&dma0
-					(AT91_XDMAC_DT_MEM_IF(0) | AT91_XDMAC_DT_PER_IF(1)
-					| AT91_XDMAC_DT_PERID(50))>;
-				dma-names = "rx";
-				clocks = <&pdmic_clk>, <&pdmic_gclk>;
-				clock-names = "pclk", "gclk";
-
-				pinctrl-names = "default";
-				pinctrl-0 = <&pinctrl_pdmic_default>;
-				atmel,model = "PDMIC @ sama5d2_xplained";
-				atmel,mic-min-freq = <1000000>;
-				atmel,mic-max-freq = <3246000>;
-				atmel,mic-offset = <0x0>;
-	};
-- 
2.34.1

Re: [PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 892 bytes --]

On Tue, Jul 05, 2022 at 09:21:42AM -0700, Ryan.Wanner@microchip.com wrote:
> From: Ryan Wanner <Ryan.Wanner@microchip.com>
> 
> Convert Atmel PDMIC devicetree binding to json-schema.
> Change file naming to match json-schema naming.

As documented in submitting-patches.rst please send patches to the 
maintainers for the code you would like to change.  The normal kernel
workflow is that people apply patches from their inboxes, if they aren't
copied they are likely to not see the patch at all and it is much more
difficult to apply patches.

Please submit patches using subject lines reflecting the style for the
subsystem, this makes it easier for people to identify relevant patches.
Look at what existing commits in the area you're changing are doing and
make sure your subject lines visually resemble what they're doing.
There's no need to resubmit to fix this alone.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

[Krzysztof Kozlowski]

On 05/07/2022 18:21, Ryan.Wanner@microchip.com wrote:
> From: Ryan Wanner <Ryan.Wanner@microchip.com>
> 
> Convert Atmel PDMIC devicetree binding to json-schema.
> Change file naming to match json-schema naming.
> 
> Signed-off-by: Ryan Wanner <Ryan.Wanner@microchip.com>
> ---
>  .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
>  .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------

You need to send the patches to proper folks with proper subject prefix.
Use get_maintainers.pl for the first and `git log --oneline --` for the
second.

>  2 files changed, 104 insertions(+), 55 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
>  delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
> new file mode 100644
> index 000000000000..cb34c0fc4fc8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
> @@ -0,0 +1,104 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/atmel,sama5d2-pdmic.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel PDMIC driver under ALSA SoC architecture

"driver" and ALSA are Linux specific, so this could be corrected during
conversion to name the hardware.

> +
> +maintainers:
> +  - Claudiu Beznea <claudiu.beznea@microchip.com>
> +
> +description:
> +  Atmel Pulse Density Modulation Interface Controller
> +  (PDMIC) peripheral is a mono PDM decoder module
> +  that decodes an incoming PDM sample stream.
> +
> +properties:
> +  compatible:
> +    items:

One item, so no need for items.

> +      - const: atmel,sama5d2-pdmic
> +
> +  reg:
> +    description: Should contain PDMIC registers location and length.

Skip description, it's obvious.

> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    description:
> +      Must contain an entry for each required entry in clock-names.
> +      Please refer to clock-bindings.txt.

Skip description.

> +
> +    items:
> +      - description: peripheral clock.
> +      - description: generated clock.

Skip trailing dots, since you do not start with capital letter.

> +
> +  clock-names:
> +    items:
> +      - const: pclk
> +      - const: gclk
> +
> +  dmas:
> +    maxItems: 1
> +
> +  dma-names:
> +    const: rx
> +
> +  atmel,mic-min-freq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      The minimal frequency that the microphone supports.
> +
> +  atmel,mic-max-freq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      The maximal frequency that the microphone supports.
> +
> +  atmel,model:
> +    description: The user-visible name of this sound card.
> +    $ref: /schemas/types.yaml#/definitions/string
> +    default: PDMIC
> +
> +  atmel,mic-offset:
> +    $ref: /schemas/types.yaml#/definitions/int32
> +    description: The offset that should be added.
> +    default: 0
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - dmas
> +  - dma-names
> +  - clock-names
> +  - clocks
> +  - atmel,mic-min-freq
> +  - atmel,mic-max-freq
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/dma/at91.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    pdmic: sound@f8018000 {
> +              compatible = "atmel,sama5d2-pdmic";

Use four space for DTS indentation.

> +              reg = <0xf8018000 0x124>;
> +              interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
> +              dmas = <&dma0

Best regards,
Krzysztof

Re: [PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

[Nicolas Ferre]

Krzysztof, Mark,

On 05/07/2022 at 19:56, Krzysztof Kozlowski wrote:
> On 05/07/2022 18:21, Ryan.Wanner@microchip.com wrote:
>> From: Ryan Wanner <Ryan.Wanner@microchip.com>
>>
>> Convert Atmel PDMIC devicetree binding to json-schema.
>> Change file naming to match json-schema naming.
>>
>> Signed-off-by: Ryan Wanner <Ryan.Wanner@microchip.com>
>> ---
>>   .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
>>   .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------
> 
> You need to send the patches to proper folks with proper subject prefix.
> Use get_maintainers.pl for the first and `git log --oneline --` for the
> second.

Just to let you know that Codrin who was in charge of audio is not with 
Microchip anymore. We'll change the MAINTAINERS file soon so that it's 
clearer for everyone.
Anyway, we'll make sure to add Mark and Liam to the list.

Best regards,
   Nicolas

>>   2 files changed, 104 insertions(+), 55 deletions(-)
>>   create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
>>   delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt

[..]


-- 
Nicolas Ferre