[alsa-devel] [RFC 1/2] ASoC: micfil: Add bindings for MICFIL DAI

[Rob Herring]

On Mon, Dec 10, 2018 at 09:21:14AM +0000, Cosmin Samoila wrote:
> Document the bindings for MICFIL DAI.
> 
> Signed-off-by: Cosmin-Gabriel Samoila <cosmin.samoila at nxp.com>
> ---
>  .../devicetree/bindings/sound/fsl,micfil.txt       | 38 ++++++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/fsl,micfil.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/fsl,micfil.txt b/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> new file mode 100644
> index 0000000..2aa4526
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/fsl,micfil.txt
> @@ -0,0 +1,38 @@
> +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"
> +
> +  - 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.
> +
> +  - dma-names		: One "rx" dma must be configured.

You don't need -names when there is only one.

> +
> +Example:
> +micfil: micfil at 30080000 {
> +	compatible = "fsl,imx8mm-micfil";
> +	reg = <0x0 0x30080000 0x0 0x10000>;
> +	interrupts = <GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>,
> +		     <GIC_SPI 45 IRQ_TYPE_LEVEL_HIGH>,
> +		     <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>;
> +	dma-names = "rx";
> +	status = "disabled";

Don't show status in examples.

> +};
> -- 
> 2.7.4
>