Subject: [PATCH v2 2/3] dt: ASoC: zx-i2s: Document for the ZTE zx296718 I2S controller

From: [email-masked] (Shawn Guo)
Date: Tue, 7 Feb 2017 16:30:37 +0800

On Tue, Feb 07, 2017 at 11:02:50AM +0800, Baoyou Xie wrote:
> This patch documents the devicetree for the ZTE's zx296718
> I2S audio controller.
> 
> Signed-off-by: Baoyou Xie <[email-masked]>
> ---
>  Documentation/devicetree/bindings/sound/zte,zx-i2s.txt | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/sound/zte,zx-i2s.txt b/Documentation/devicetree/bindings/sound/zte,zx-i2s.txt
> index 7e5aa6f..c405561 100644
> --- a/Documentation/devicetree/bindings/sound/zte,zx-i2s.txt
> +++ b/Documentation/devicetree/bindings/sound/zte,zx-i2s.txt
> @@ -1,10 +1,12 @@
>  ZTE ZX296702 I2S controller
>  
>  Required properties:
> - - compatible : Must be "zte,zx296702-i2s"
> + - compatible : Should include one of the following strings:
> +	"zte,zx296702-i2s","zte,zx296718-i2s".
>   - reg : Must contain I2S core's registers location and length
>   - clocks : Pairs of phandle and specifier referencing the controller's clocks.
> - - clock-names: "tx" for the clock to the I2S interface.
> + - clock-names: "tx" for the wclk, "pclk" for the pclk to the I2S interface.
> +	must contain pclk for zx296718 SoC.

The 'pclk' is really required for zx296702-i2s as well.  The driver may
happen to work on zx296702 only because 'pclk' is already enabled by
someone else before I2S driver starts working.

Shawn

>   - dmas: Pairs of phandle and specifier for the DMA channel that is used by
>     the core. The core expects two dma channels for transmit.
>   - dma-names : Must be "tx" and "rx"
> -- 
> 2.7.4
>