[deliverable/linux.git] / Documentation / devicetree / bindings / sound / adi,axi-i2s.txt

ADI AXI-I2S controller

Required properties:
 - compatible : Must be "adi,axi-i2s-1.00.a"
 - reg : Must contain I2S core's registers location and length
 - clocks : Pairs of phandle and specifier referencing the controller's clocks.
   The controller expects two clocks, the clock used for the AXI interface and
   the clock used as the sampling rate reference clock sample.
 - clock-names : "axi" for the clock to the AXI interface, "ref" for the sample
   rate reference clock.
 - dmas: Pairs of phandle and specifier for the DMA channels that are used by
   the core. The core expects two dma channels, one for transmit and one for
   receive.
 - dma-names : "tx" for the transmit channel, "rx" for the receive channel.

For more details on the 'dma', 'dma-names', 'clock' and 'clock-names' properties
please check:
	* resource-names.txt
	* clock/clock-bindings.txt
	* dma/dma.txt

Example:

	i2s: i2s@0x77600000 {
		compatible = "adi,axi-i2s-1.00.a";
		reg = <0x77600000 0x1000>;
		clocks = <&clk 15>, <&audio_clock>;
		clock-names = "axi", "ref";
		dmas = <&ps7_dma 0>, <&ps7_dma 1>;
		dma-names = "tx", "rx";
	};
Commit	Line	Data
00e6cb2a LPC	1	ADI AXI-I2S controller
	2
	3	Required properties:
	4	- compatible : Must be "adi,axi-i2s-1.00.a"
	5	- reg : Must contain I2S core's registers location and length
	6	- clocks : Pairs of phandle and specifier referencing the controller's clocks.
	7	The controller expects two clocks, the clock used for the AXI interface and
	8	the clock used as the sampling rate reference clock sample.
	9	- clock-names : "axi" for the clock to the AXI interface, "ref" for the sample
	10	rate reference clock.
	11	- dmas: Pairs of phandle and specifier for the DMA channels that are used by
	12	the core. The core expects two dma channels, one for transmit and one for
	13	receive.
	14	- dma-names : "tx" for the transmit channel, "rx" for the receive channel.
	15
	16	For more details on the 'dma', 'dma-names', 'clock' and 'clock-names' properties
	17	please check:
	18	* resource-names.txt
	19	* clock/clock-bindings.txt
	20	* dma/dma.txt
	21
	22	Example:
	23
	24	i2s: i2s@0x77600000 {
	25	compatible = "adi,axi-i2s-1.00.a";
	26	reg = <0x77600000 0x1000>;
	27	clocks = <&clk 15>, <&audio_clock>;
	28	clock-names = "axi", "ref";
	29	dmas = <&ps7_dma 0>, <&ps7_dma 1>;
	30	dma-names = "tx", "rx";
	31	};