diff options
author | Andrew Jackson <Andrew.Jackson@arm.com> | 2014-12-30 05:55:47 -0500 |
---|---|---|
committer | Mark Brown <broonie@kernel.org> | 2014-12-30 11:52:28 -0500 |
commit | d8b58e0b5322f91eb6fcffc337a74083a24c7149 (patch) | |
tree | 0d18a8b24f1d4b1ae3e1dadba9113d8cada94eb8 /Documentation/devicetree/bindings/sound | |
parent | 758c2debcbf1a4ba6a787d276ca0fb3333105b06 (diff) |
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>
Diffstat (limited to 'Documentation/devicetree/bindings/sound')
-rw-r--r-- | Documentation/devicetree/bindings/sound/designware-i2s.txt | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/sound/designware-i2s.txt b/Documentation/devicetree/bindings/sound/designware-i2s.txt new file mode 100644 index 000000000000..7bb54247f8e8 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/designware-i2s.txt | |||
@@ -0,0 +1,31 @@ | |||
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 | }; | ||