diff mbox

[1/4] dt-bindings: Add A10 I2S controller binding documentation

Message ID 20160601175430.11625-2-maxime.ripard@free-electrons.com (mailing list archive)
State New, archived
Headers show

Commit Message

Maxime Ripard June 1, 2016, 5:54 p.m. UTC
Introduce the device tree binding for the I2S controller found in the
Allwinner A10 and later SoCs.

Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
---
 .../devicetree/bindings/sound/sun4i-i2s.txt        | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/sun4i-i2s.txt

Comments

Mark Brown June 2, 2016, 10:09 a.m. UTC | #1
On Wed, Jun 01, 2016 at 07:54:27PM +0200, Maxime Ripard wrote:
> Introduce the device tree binding for the I2S controller found in the
> Allwinner A10 and later SoCs.

Please use subject lines matching the style for the subsystem.  This
makes it easier for people to identify relevant patches.
Rob Herring (Arm) June 6, 2016, 1:08 p.m. UTC | #2
On Wed, Jun 01, 2016 at 07:54:27PM +0200, Maxime Ripard wrote:
> Introduce the device tree binding for the I2S controller found in the
> Allwinner A10 and later SoCs.
> 
> Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
> ---
>  .../devicetree/bindings/sound/sun4i-i2s.txt        | 33 ++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/sun4i-i2s.txt b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> new file mode 100644
> index 000000000000..365ca4eede5f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> @@ -0,0 +1,33 @@
> +* Allwinner A10 I2S controller
> +
> +The I2S bus (Inter-IC sound bus) is a serial link for digital
> +audio data transfer between devices in the system.
> +
> +Required properties:
> +
> +- compatible: should be one of the followings
> +   - "allwinner,sun4i-a10-i2s"
> +- reg: physical base address of the controller and length of memory mapped
> +  region.
> +- interrupts: should contain the I2S interrupt.
> +- dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
> +	Documentation/devicetree/bindings/dma/dma.txt
> +- dma-names: should include "tx" and "rx".
> +- clocks: a list of phandle + clock-specifer pairs, one for each entry in clock-names.
> +- clock-names: should contain followings:
> +   - "apb" : clock for the I2S bus interface
> +   - "mod" : module clock for the I2S controller
> +
> +Example:
> +
> +i2s0: i2s@01c22400 {
> +	#sound-dai-cells = <0>;

This is missing from the property list.

> +	compatible = "allwinner,sun4i-a10-i2s";
> +	reg = <0x01c22400 0x400>;
> +	interrupts = <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
> +	clocks = <&apb0_gates 3>, <&i2s0_clk>;
> +	clock-names = "apb", "mod";
> +	dmas = <&dma SUN4I_DMA_NORMAL 3>,
> +	       <&dma SUN4I_DMA_NORMAL 3>;
> +	dma-names = "rx", "tx";
> +};
> -- 
> 2.8.3
>
Maxime Ripard June 9, 2016, 5:15 p.m. UTC | #3
Hi Rob,

On Mon, Jun 06, 2016 at 08:08:18AM -0500, Rob Herring wrote:
> On Wed, Jun 01, 2016 at 07:54:27PM +0200, Maxime Ripard wrote:
> > Introduce the device tree binding for the I2S controller found in the
> > Allwinner A10 and later SoCs.
> > 
> > Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
> > ---
> >  .../devicetree/bindings/sound/sun4i-i2s.txt        | 33 ++++++++++++++++++++++
> >  1 file changed, 33 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/sound/sun4i-i2s.txt b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> > new file mode 100644
> > index 000000000000..365ca4eede5f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
> > @@ -0,0 +1,33 @@
> > +* Allwinner A10 I2S controller
> > +
> > +The I2S bus (Inter-IC sound bus) is a serial link for digital
> > +audio data transfer between devices in the system.
> > +
> > +Required properties:
> > +
> > +- compatible: should be one of the followings
> > +   - "allwinner,sun4i-a10-i2s"
> > +- reg: physical base address of the controller and length of memory mapped
> > +  region.
> > +- interrupts: should contain the I2S interrupt.
> > +- dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
> > +	Documentation/devicetree/bindings/dma/dma.txt
> > +- dma-names: should include "tx" and "rx".
> > +- clocks: a list of phandle + clock-specifer pairs, one for each entry in clock-names.
> > +- clock-names: should contain followings:
> > +   - "apb" : clock for the I2S bus interface
> > +   - "mod" : module clock for the I2S controller
> > +
> > +Example:
> > +
> > +i2s0: i2s@01c22400 {
> > +	#sound-dai-cells = <0>;
> 
> This is missing from the property list.

Indeed, I'll add it.

Thanks!
Maxime
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/sun4i-i2s.txt b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
new file mode 100644
index 000000000000..365ca4eede5f
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
@@ -0,0 +1,33 @@ 
+* Allwinner A10 I2S controller
+
+The I2S bus (Inter-IC sound bus) is a serial link for digital
+audio data transfer between devices in the system.
+
+Required properties:
+
+- compatible: should be one of the followings
+   - "allwinner,sun4i-a10-i2s"
+- reg: physical base address of the controller and length of memory mapped
+  region.
+- interrupts: should contain the I2S interrupt.
+- dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
+	Documentation/devicetree/bindings/dma/dma.txt
+- dma-names: should include "tx" and "rx".
+- clocks: a list of phandle + clock-specifer pairs, one for each entry in clock-names.
+- clock-names: should contain followings:
+   - "apb" : clock for the I2S bus interface
+   - "mod" : module clock for the I2S controller
+
+Example:
+
+i2s0: i2s@01c22400 {
+	#sound-dai-cells = <0>;
+	compatible = "allwinner,sun4i-a10-i2s";
+	reg = <0x01c22400 0x400>;
+	interrupts = <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
+	clocks = <&apb0_gates 3>, <&i2s0_clk>;
+	clock-names = "apb", "mod";
+	dmas = <&dma SUN4I_DMA_NORMAL 3>,
+	       <&dma SUN4I_DMA_NORMAL 3>;
+	dma-names = "rx", "tx";
+};