diff mbox series

[2/6] ASoC: add DT bindings for Microchip PDMC

Message ID 20220304181756.1894561-3-codrin.ciubotariu@microchip.com (mailing list archive)
State Superseded
Headers show
Series Add driver for SAMA7G5's PDMC | expand

Commit Message

Codrin Ciubotariu March 4, 2022, 6:17 p.m. UTC 
This patch adds DT bindings for the new Microchip PDMC embedded in
sama7g5 SoCs.

Signed-off-by: Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
---
 .../devicetree/bindings/sound/mchp,pdmc.yaml  | 99 +++++++++++++++++++
 include/dt-bindings/sound/mchp,pdmc.h         | 13 +++
 2 files changed, 112 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/mchp,pdmc.yaml
 create mode 100644 include/dt-bindings/sound/mchp,pdmc.h

Comments

Krzysztof Kozlowski March 5, 2022, 10:03 p.m. UTC | #1 
On 04/03/2022 19:17, Codrin Ciubotariu wrote:
> This patch adds DT bindings for the new Microchip PDMC embedded in
> sama7g5 SoCs.

Do not use "this patch" but simple imperative mode. See submitting patches.

> 
> Signed-off-by: Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
> ---
>  .../devicetree/bindings/sound/mchp,pdmc.yaml  | 99 +++++++++++++++++++
>  include/dt-bindings/sound/mchp,pdmc.h         | 13 +++
>  2 files changed, 112 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/mchp,pdmc.yaml
>  create mode 100644 include/dt-bindings/sound/mchp,pdmc.h
> 
> diff --git a/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml b/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml
> new file mode 100644
> index 000000000000..bdf5c52c29d9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml

mchp is not a proper Microchip vendor prefix. You wanted "microchip"
probably.

> @@ -0,0 +1,99 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/mchp,pdmc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Microchip PDMC Device Tree Bindings

s/PDMC/Pulse Density Microphone Controller/
s/Device Tree Bindings//
(title is about hardware)

> +
> +maintainers:
> +  - Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
> +
> +description:
> +  The Microchip Pulse Density Microphone Controller (PDMC) interfaces up to 4 digital microphones
> +  having Pulse Density Modulated (PDM) outputs.
> +
> +properties:
> +  "#sound-dai-cells":
> +    const: 0
> +
> +  compatible:
> +    const: microchip,sama7g5-pdmc

Compatible goes first (and also keep such order in "required").

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: Peripheral Bus Clock
> +      - description: Generic Clock
> +
> +  clock-names:
> +    items:
> +      - const: pclk
> +      - const: gclk
> +
> +  dmas:
> +    description: RX DMA Channel
> +    maxItems: 1
> +
> +  dma-names:
> +    const: rx
> +
> +  microchip,mic-pos:
> +    description: |
> +      Position of PDM microphones on the DS line and the sampling edge (rising or falling) of the
> +      CLK line. A microphone is represented as a pair of DS line and the sampling edge. The first
> +      microhpone is mapped to channel 0, the second to channel 1, etc.

Lang typo (microphone).

> +    $ref: /schemas/types.yaml#/definitions/uint32-matrix
> +    items:
> +      items:
> +        - description: value for DS line
> +        - description: value for sampling edge
> +      anyOf:
> +        - enum:
> +            - [0, 0]
> +            - [0, 1]
> +            - [1, 0]
> +            - [1, 1]
> +    minItems: 1
> +    maxItems: 4
> +    uniqueItems: true
> +
> +required:
> +  - "#sound-dai-cells"
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +  - dmas
> +  - dma-names
> +  - microchip,mic-pos
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/at91.h>
> +    #include <dt-bindings/dma/at91.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/sound/mchp,pdmc.h>
> +
> +    pdmc: pdmc@e1608000 {

Generic node name, so microphone? microphone-controller? sound? audio-codec?

> +        #sound-dai-cells = <0>;
> +        compatible = "microchip,sama7g5-pdmc";

Compatible goes first, then reg.

> +        reg = <0xe1608000 0x4000>;
> +        interrupts = <GIC_SPI 68 IRQ_TYPE_LEVEL_HIGH>;
> +        dmas = <&dma0 AT91_XDMAC_DT_PERID(37)>;
> +        dma-names = "rx";
> +        clocks = <&pmc PMC_TYPE_PERIPHERAL 68>, <&pmc PMC_TYPE_GCK 68>;
> +        clock-names = "pclk", "gclk";
> +        microchip,mic-pos = <MCHP_PDMC_DS0 MCHP_PDMC_CLK_POSITIVE>,
> +                            <MCHP_PDMC_DS0 MCHP_PDMC_CLK_NEGATIVE>,
> +                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_POSITIVE>,
> +                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_NEGATIVE>;
> +    };
> diff --git a/include/dt-bindings/sound/mchp,pdmc.h b/include/dt-bindings/sound/mchp,pdmc.h
> new file mode 100644
> index 000000000000..543c424a5a6f
> --- /dev/null
> +++ b/include/dt-bindings/sound/mchp,pdmc.h

Proper vendor prefix.

> @@ -0,0 +1,13 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +#ifndef __DT_BINDINGS_MCHP_PDMC_H__
> +#define __DT_BINDINGS_MCHP_PDMC_H__
> +
> +/* PDM microphone's pin placement */
> +#define MCHP_PDMC_DS0 0
> +#define MCHP_PDMC_DS1 1
> +
> +/* PDM microphone clock edge sampling */
> +#define MCHP_PDMC_CLK_POSITIVE 0
> +#define MCHP_PDMC_CLK_NEGATIVE 1
> +
> +#endif /* __DT_BINDINGS_MCHP_PDMC_H__ */


Best regards,
Krzysztof
Codrin Ciubotariu March 7, 2022, 10:09 a.m. UTC | #2 
On 06.03.2022 00:03, Krzysztof Kozlowski wrote:
> 
> On 04/03/2022 19:17, Codrin Ciubotariu wrote:
>> This patch adds DT bindings for the new Microchip PDMC embedded in
>> sama7g5 SoCs.

...snip...
> 
> Best regards,
> Krzysztof

Hi Krzysztof,

I just sent v2 will with (I hope) all you comments addressed. Thank you 
for your reviews!

Best regards,
Codrin
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml b/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml
new file mode 100644
index 000000000000..bdf5c52c29d9
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/mchp,pdmc.yaml
@@ -0,0 +1,99 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/mchp,pdmc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip PDMC Device Tree Bindings
+
+maintainers:
+  - Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
+
+description:
+  The Microchip Pulse Density Microphone Controller (PDMC) interfaces up to 4 digital microphones
+  having Pulse Density Modulated (PDM) outputs.
+
+properties:
+  "#sound-dai-cells":
+    const: 0
+
+  compatible:
+    const: microchip,sama7g5-pdmc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: Peripheral Bus Clock
+      - description: Generic Clock
+
+  clock-names:
+    items:
+      - const: pclk
+      - const: gclk
+
+  dmas:
+    description: RX DMA Channel
+    maxItems: 1
+
+  dma-names:
+    const: rx
+
+  microchip,mic-pos:
+    description: |
+      Position of PDM microphones on the DS line and the sampling edge (rising or falling) of the
+      CLK line. A microphone is represented as a pair of DS line and the sampling edge. The first
+      microhpone is mapped to channel 0, the second to channel 1, etc.
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    items:
+      items:
+        - description: value for DS line
+        - description: value for sampling edge
+      anyOf:
+        - enum:
+            - [0, 0]
+            - [0, 1]
+            - [1, 0]
+            - [1, 1]
+    minItems: 1
+    maxItems: 4
+    uniqueItems: true
+
+required:
+  - "#sound-dai-cells"
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+  - dmas
+  - dma-names
+  - microchip,mic-pos
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/at91.h>
+    #include <dt-bindings/dma/at91.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/sound/mchp,pdmc.h>
+
+    pdmc: pdmc@e1608000 {
+        #sound-dai-cells = <0>;
+        compatible = "microchip,sama7g5-pdmc";
+        reg = <0xe1608000 0x4000>;
+        interrupts = <GIC_SPI 68 IRQ_TYPE_LEVEL_HIGH>;
+        dmas = <&dma0 AT91_XDMAC_DT_PERID(37)>;
+        dma-names = "rx";
+        clocks = <&pmc PMC_TYPE_PERIPHERAL 68>, <&pmc PMC_TYPE_GCK 68>;
+        clock-names = "pclk", "gclk";
+        microchip,mic-pos = <MCHP_PDMC_DS0 MCHP_PDMC_CLK_POSITIVE>,
+                            <MCHP_PDMC_DS0 MCHP_PDMC_CLK_NEGATIVE>,
+                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_POSITIVE>,
+                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_NEGATIVE>;
+    };
diff --git a/include/dt-bindings/sound/mchp,pdmc.h b/include/dt-bindings/sound/mchp,pdmc.h
new file mode 100644
index 000000000000..543c424a5a6f
--- /dev/null
+++ b/include/dt-bindings/sound/mchp,pdmc.h
@@ -0,0 +1,13 @@ 
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef __DT_BINDINGS_MCHP_PDMC_H__
+#define __DT_BINDINGS_MCHP_PDMC_H__
+
+/* PDM microphone's pin placement */
+#define MCHP_PDMC_DS0 0
+#define MCHP_PDMC_DS1 1
+
+/* PDM microphone clock edge sampling */
+#define MCHP_PDMC_CLK_POSITIVE 0
+#define MCHP_PDMC_CLK_NEGATIVE 1
+
+#endif /* __DT_BINDINGS_MCHP_PDMC_H__ */