xref: /freebsd/sys/contrib/device-tree/Bindings/sound/designware-i2s.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel VadotDesignWare I2S controller
2*c66ec88fSEmmanuel Vadot
3*c66ec88fSEmmanuel VadotRequired properties:
4*c66ec88fSEmmanuel Vadot - compatible : Must be "snps,designware-i2s"
5*c66ec88fSEmmanuel Vadot - reg : Must contain the I2S core's registers location and length
6*c66ec88fSEmmanuel Vadot - clocks : Pairs of phandle and specifier referencing the controller's
7*c66ec88fSEmmanuel Vadot   clocks. The controller expects one clock: the clock used as the sampling
8*c66ec88fSEmmanuel Vadot   rate reference clock sample.
9*c66ec88fSEmmanuel Vadot - clock-names : "i2sclk" for the sample rate reference clock.
10*c66ec88fSEmmanuel Vadot - dmas: Pairs of phandle and specifier for the DMA channels that are used by
11*c66ec88fSEmmanuel Vadot   the core. The core expects one or two dma channels: one for transmit and
12*c66ec88fSEmmanuel Vadot   one for receive.
13*c66ec88fSEmmanuel Vadot - dma-names : "tx" for the transmit channel, "rx" for the receive channel.
14*c66ec88fSEmmanuel Vadot
15*c66ec88fSEmmanuel VadotOptional properties:
16*c66ec88fSEmmanuel Vadot - interrupts: The interrupt line number for the I2S controller. Add this
17*c66ec88fSEmmanuel Vadot   parameter if the I2S controller that you are using does not support DMA.
18*c66ec88fSEmmanuel Vadot
19*c66ec88fSEmmanuel VadotFor more details on the 'dma', 'dma-names', 'clock' and 'clock-names'
20*c66ec88fSEmmanuel Vadotproperties please check:
21*c66ec88fSEmmanuel Vadot	* resource-names.txt
22*c66ec88fSEmmanuel Vadot	* clock/clock-bindings.txt
23*c66ec88fSEmmanuel Vadot	* dma/dma.txt
24*c66ec88fSEmmanuel Vadot
25*c66ec88fSEmmanuel VadotExample:
26*c66ec88fSEmmanuel Vadot
27*c66ec88fSEmmanuel Vadot	soc_i2s: i2s@7ff90000 {
28*c66ec88fSEmmanuel Vadot		compatible = "snps,designware-i2s";
29*c66ec88fSEmmanuel Vadot		reg = <0x0 0x7ff90000 0x0 0x1000>;
30*c66ec88fSEmmanuel Vadot		clocks = <&scpi_i2sclk 0>;
31*c66ec88fSEmmanuel Vadot		clock-names = "i2sclk";
32*c66ec88fSEmmanuel Vadot		#sound-dai-cells = <0>;
33*c66ec88fSEmmanuel Vadot		dmas = <&dma0 5>;
34*c66ec88fSEmmanuel Vadot		dma-names = "tx";
35*c66ec88fSEmmanuel Vadot	};
36