diff mbox series

ASoC: dt-bindings: fsl,micfil: Convert format to json-schema

Message ID 1655980125-24141-1-git-send-email-shengjiu.wang@nxp.com (mailing list archive)
State New, archived
Headers show
Series ASoC: dt-bindings: fsl,micfil: Convert format to json-schema | expand

Commit Message

Shengjiu Wang June 23, 2022, 10:28 a.m. UTC 
Convert the NXP MICFIL binding to DT schema format using json-schema.

Signed-off-by: Shengjiu Wang <shengjiu.wang@nxp.com>
---
 .../devicetree/bindings/sound/fsl,micfil.txt  | 33 ---------
 .../devicetree/bindings/sound/fsl,micfil.yaml | 73 +++++++++++++++++++
 2 files changed, 73 insertions(+), 33 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/fsl,micfil.txt
 create mode 100644 Documentation/devicetree/bindings/sound/fsl,micfil.yaml

Comments

Krzysztof Kozlowski June 24, 2022, 4:01 p.m. UTC | #1 
On 23/06/2022 12:28, Shengjiu Wang wrote:
> Convert the NXP MICFIL binding to DT schema format using json-schema.
> 
> Signed-off-by: Shengjiu Wang <shengjiu.wang@nxp.com>
> ---
>  .../devicetree/bindings/sound/fsl,micfil.txt  | 33 ---------
>  .../devicetree/bindings/sound/fsl,micfil.yaml | 73 +++++++++++++++++++
>  2 files changed, 73 insertions(+), 33 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/fsl,micfil.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.txt b/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> deleted file mode 100644
> index 1ea05d4996c7..000000000000
> --- a/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> +++ /dev/null
> @@ -1,33 +0,0 @@
> -NXP MICFIL Digital Audio Interface (MICFIL).
> -
> -The MICFIL digital interface provides a 16-bit audio signal from a PDM
> -microphone bitstream in a configurable output sampling rate.
> -
> -Required properties:
> -
> -  - compatible		: Compatible list, contains "fsl,imx8mm-micfil"
> -			  or "fsl,imx8mp-micfil"
> -
> -  - reg			: Offset and length of the register set for the device.
> -
> -  - interrupts		: Contains the micfil interrupts.
> -
> -  - clocks		: Must contain an entry for each entry in clock-names.
> -
> -  - clock-names		: Must include the "ipg_clk" for register access and
> -			  "ipg_clk_app" for internal micfil clock.
> -
> -  - dmas		: Generic dma devicetree binding as described in
> -			  Documentation/devicetree/bindings/dma/dma.txt.
> -
> -Example:
> -micfil: micfil@30080000 {
> -	compatible = "fsl,imx8mm-micfil";
> -	reg = <0x0 0x30080000 0x0 0x10000>;
> -	interrupts = <GIC_SPI 109 IRQ_TYPE_LEVEL_HIGH>,
> -		     <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>;
> -	clocks = <&clk IMX8MM_CLK_PDM_IPG>,
> -		 <&clk IMX8MM_CLK_PDM_ROOT>;
> -	clock-names = "ipg_clk", "ipg_clk_app";
> -	dmas = <&sdma2 24 26 0x80000000>;
> -};
> diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.yaml b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> new file mode 100644
> index 000000000000..74c77f4cf7a4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/fsl,micfil.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP MICFIL Digital Audio Interface (MICFIL)
> +
> +maintainers:
> +  - Shengjiu Wang <shengjiu.wang@nxp.com>
> +
> +description: |
> +  The MICFIL digital interface provides a 16-bit or 24-bit audio signal
> +  from a PDM microphone bitstream in a configurable output sampling rate.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,imx8mm-micfil
> +      - fsl,imx8mp-micfil
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 4

You should describe the interrupts/items. Similarly to clocks.

Best regards,
Krzysztof
Shengjiu Wang June 27, 2022, 2 a.m. UTC | #2 
On Sat, Jun 25, 2022 at 12:01 AM Krzysztof Kozlowski <
krzysztof.kozlowski@linaro.org> wrote:

> On 23/06/2022 12:28, Shengjiu Wang wrote:
> > Convert the NXP MICFIL binding to DT schema format using json-schema.
> >
> > Signed-off-by: Shengjiu Wang <shengjiu.wang@nxp.com>
> > ---
> >  .../devicetree/bindings/sound/fsl,micfil.txt  | 33 ---------
> >  .../devicetree/bindings/sound/fsl,micfil.yaml | 73 +++++++++++++++++++
> >  2 files changed, 73 insertions(+), 33 deletions(-)
> >  delete mode 100644
> Documentation/devicetree/bindings/sound/fsl,micfil.txt
> >  create mode 100644
> Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> b/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> > deleted file mode 100644
> > index 1ea05d4996c7..000000000000
> > --- a/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> > +++ /dev/null
> > @@ -1,33 +0,0 @@
> > -NXP MICFIL Digital Audio Interface (MICFIL).
> > -
> > -The MICFIL digital interface provides a 16-bit audio signal from a PDM
> > -microphone bitstream in a configurable output sampling rate.
> > -
> > -Required properties:
> > -
> > -  - compatible               : Compatible list, contains
> "fsl,imx8mm-micfil"
> > -                       or "fsl,imx8mp-micfil"
> > -
> > -  - reg                      : Offset and length of the register set
> for the device.
> > -
> > -  - interrupts               : Contains the micfil interrupts.
> > -
> > -  - clocks           : Must contain an entry for each entry in
> clock-names.
> > -
> > -  - clock-names              : Must include the "ipg_clk" for register
> access and
> > -                       "ipg_clk_app" for internal micfil clock.
> > -
> > -  - dmas             : Generic dma devicetree binding as described in
> > -                       Documentation/devicetree/bindings/dma/dma.txt.
> > -
> > -Example:
> > -micfil: micfil@30080000 {
> > -     compatible = "fsl,imx8mm-micfil";
> > -     reg = <0x0 0x30080000 0x0 0x10000>;
> > -     interrupts = <GIC_SPI 109 IRQ_TYPE_LEVEL_HIGH>,
> > -                  <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>;
> > -     clocks = <&clk IMX8MM_CLK_PDM_IPG>,
> > -              <&clk IMX8MM_CLK_PDM_ROOT>;
> > -     clock-names = "ipg_clk", "ipg_clk_app";
> > -     dmas = <&sdma2 24 26 0x80000000>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> > new file mode 100644
> > index 000000000000..74c77f4cf7a4
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
> > @@ -0,0 +1,73 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/sound/fsl,micfil.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: NXP MICFIL Digital Audio Interface (MICFIL)
> > +
> > +maintainers:
> > +  - Shengjiu Wang <shengjiu.wang@nxp.com>
> > +
> > +description: |
> > +  The MICFIL digital interface provides a 16-bit or 24-bit audio signal
> > +  from a PDM microphone bitstream in a configurable output sampling
> rate.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - fsl,imx8mm-micfil
> > +      - fsl,imx8mp-micfil
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 4
>
> You should describe the interrupts/items. Similarly to clocks.
>
>
> Ok, let me update it.

Best regards
Wang shengjiu
Mark Brown June 29, 2022, 2:05 p.m. UTC | #3 
On Thu, 23 Jun 2022 18:28:45 +0800, Shengjiu Wang wrote:
> Convert the NXP MICFIL binding to DT schema format using json-schema.
> 
> 

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoC: dt-bindings: fsl,micfil: Convert format to json-schema
      commit: 02d91fe47100a29a79fcb8798e45c22591ca852d

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.txt b/Documentation/devicetree/bindings/sound/fsl,micfil.txt
deleted file mode 100644
index 1ea05d4996c7..000000000000
--- a/Documentation/devicetree/bindings/sound/fsl,micfil.txt
+++ /dev/null
@@ -1,33 +0,0 @@ 
-NXP MICFIL Digital Audio Interface (MICFIL).
-
-The MICFIL digital interface provides a 16-bit audio signal from a PDM
-microphone bitstream in a configurable output sampling rate.
-
-Required properties:
-
-  - compatible		: Compatible list, contains "fsl,imx8mm-micfil"
-			  or "fsl,imx8mp-micfil"
-
-  - reg			: Offset and length of the register set for the device.
-
-  - interrupts		: Contains the micfil interrupts.
-
-  - clocks		: Must contain an entry for each entry in clock-names.
-
-  - clock-names		: Must include the "ipg_clk" for register access and
-			  "ipg_clk_app" for internal micfil clock.
-
-  - dmas		: Generic dma devicetree binding as described in
-			  Documentation/devicetree/bindings/dma/dma.txt.
-
-Example:
-micfil: micfil@30080000 {
-	compatible = "fsl,imx8mm-micfil";
-	reg = <0x0 0x30080000 0x0 0x10000>;
-	interrupts = <GIC_SPI 109 IRQ_TYPE_LEVEL_HIGH>,
-		     <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>;
-	clocks = <&clk IMX8MM_CLK_PDM_IPG>,
-		 <&clk IMX8MM_CLK_PDM_ROOT>;
-	clock-names = "ipg_clk", "ipg_clk_app";
-	dmas = <&sdma2 24 26 0x80000000>;
-};
diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.yaml b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
new file mode 100644
index 000000000000..74c77f4cf7a4
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/fsl,micfil.yaml
@@ -0,0 +1,73 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/fsl,micfil.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP MICFIL Digital Audio Interface (MICFIL)
+
+maintainers:
+  - Shengjiu Wang <shengjiu.wang@nxp.com>
+
+description: |
+  The MICFIL digital interface provides a 16-bit or 24-bit audio signal
+  from a PDM microphone bitstream in a configurable output sampling rate.
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx8mm-micfil
+      - fsl,imx8mp-micfil
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 4
+
+  dmas:
+    items:
+      - description: DMA controller phandle and request line for RX
+
+  dma-names:
+    items:
+      - const: rx
+
+  clocks:
+    items:
+      - description: The ipg clock for register access
+      - description: internal micfil clock
+
+  clock-names:
+    items:
+      - const: ipg_clk
+      - const: ipg_clk_app
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+  - clocks
+  - clock-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/imx8mm-clock.h>
+    micfil: audio-controller@30080000 {
+        compatible = "fsl,imx8mm-micfil";
+        reg = <0x30080000 0x10000>;
+        interrupts = <GIC_SPI 109 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 110 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>,
+                     <GIC_SPI 45 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clk IMX8MM_CLK_PDM_IPG>,
+                 <&clk IMX8MM_CLK_PDM_ROOT>;
+        clock-names = "ipg_clk", "ipg_clk_app";
+        dmas = <&sdma2 24 25 0>;
+        dma-names = "rx";
+    };