[mirror_ubuntu-bionic-kernel.git] / Documentation / devicetree / bindings / sound / sun4i-i2s.txt

* 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"
   - "allwinner,sun6i-a31-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
- #sound-dai-cells : Must be equal to 0

Required properties for the following compatibles:
	- "allwinner,sun6i-a31-i2s"
- resets: phandle to the reset line for this codec

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";
};
Commit	Line	Data
38c81719 MR	1	* Allwinner A10 I2S controller
	2
	3	The I2S bus (Inter-IC sound bus) is a serial link for digital
	4	audio data transfer between devices in the system.
	5
	6	Required properties:
	7
	8	- compatible: should be one of the followings
	9	- "allwinner,sun4i-a10-i2s"
f55d404f	10	- "allwinner,sun6i-a31-i2s"
38c81719 MR	11	- reg: physical base address of the controller and length of memory mapped
	12	region.
	13	- interrupts: should contain the I2S interrupt.
	14	- dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
	15	Documentation/devicetree/bindings/dma/dma.txt
	16	- dma-names: should include "tx" and "rx".
	17	- clocks: a list of phandle + clock-specifer pairs, one for each entry in clock-names.
	18	- clock-names: should contain followings:
	19	- "apb" : clock for the I2S bus interface
	20	- "mod" : module clock for the I2S controller
	21	- #sound-dai-cells : Must be equal to 0
	22
f55d404f MJ	23	Required properties for the following compatibles:
	24	- "allwinner,sun6i-a31-i2s"
	25	- resets: phandle to the reset line for this codec
	26
38c81719 MR	27	Example:
	28
	29	i2s0: i2s@01c22400 {
	30	#sound-dai-cells = <0>;
	31	compatible = "allwinner,sun4i-a10-i2s";
	32	reg = <0x01c22400 0x400>;
	33	interrupts = <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
	34	clocks = <&apb0_gates 3>, <&i2s0_clk>;
	35	clock-names = "apb", "mod";
	36	dmas = <&dma SUN4I_DMA_NORMAL 3>,
	37	<&dma SUN4I_DMA_NORMAL 3>;
	38	dma-names = "rx", "tx";
	39	};