Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ASoC: dwc: Add documentation for I2S DT

Add documentation for Designware I2S hardware block. The block requires
one clock (for audio sampling) and DMA channels for receive and transmit.

Signed-off-by: Andrew Jackson <Andrew.Jackson@arm.com>
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Andrew Jackson and committed by
Mark Brown
d8b58e0b 758c2deb

+31
+31
Documentation/devicetree/bindings/sound/designware-i2s.txt
··· 1 + DesignWare I2S controller 2 + 3 + Required properties: 4 + - compatible : Must be "snps,designware-i2s" 5 + - reg : Must contain the I2S core's registers location and length 6 + - clocks : Pairs of phandle and specifier referencing the controller's 7 + clocks. The controller expects one clock: the clock used as the sampling 8 + rate reference clock sample. 9 + - clock-names : "i2sclk" for the sample rate reference clock. 10 + - dmas: Pairs of phandle and specifier for the DMA channels that are used by 11 + the core. The core expects one or two dma channels: one for transmit and 12 + one for receive. 13 + - dma-names : "tx" for the transmit channel, "rx" for the receive channel. 14 + 15 + For more details on the 'dma', 'dma-names', 'clock' and 'clock-names' 16 + properties please check: 17 + * resource-names.txt 18 + * clock/clock-bindings.txt 19 + * dma/dma.txt 20 + 21 + Example: 22 + 23 + soc_i2s: i2s@7ff90000 { 24 + compatible = "snps,designware-i2s"; 25 + reg = <0x0 0x7ff90000 0x0 0x1000>; 26 + clocks = <&scpi_i2sclk 0>; 27 + clock-names = "i2sclk"; 28 + #sound-dai-cells = <0>; 29 + dmas = <&dma0 5>; 30 + dma-names = "tx"; 31 + };