]> git.karo-electronics.de Git - karo-tx-linux.git/blob - Documentation/devicetree/bindings/sound/fsl-sai.txt
Merge remote-tracking branches 'asoc/topic/omap' and 'asoc/topic/rcar' into asoc...
[karo-tx-linux.git] / Documentation / devicetree / bindings / sound / fsl-sai.txt
1 Freescale Synchronous Audio Interface (SAI).
2
3 The SAI is based on I2S module that used communicating with audio codecs,
4 which provides a synchronous audio interface that supports fullduplex
5 serial interfaces with frame synchronization such as I2S, AC97, TDM, and
6 codec/DSP interfaces.
7
8
9 Required properties:
10 - compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai".
11 - reg: Offset and length of the register set for the device.
12 - clocks: Must contain an entry for each entry in clock-names.
13 - clock-names : Must include the "bus" for register access and "mclk1" "mclk2"
14   "mclk3" for bit clock and frame clock providing.
15 - dmas : Generic dma devicetree binding as described in
16   Documentation/devicetree/bindings/dma/dma.txt.
17 - dma-names : Two dmas have to be defined, "tx" and "rx".
18 - pinctrl-names: Must contain a "default" entry.
19 - pinctrl-NNN: One property must exist for each entry in pinctrl-names.
20   See ../pinctrl/pinctrl-bindings.txt for details of the property values.
21 - big-endian-regs: If this property is absent, the little endian mode will
22   be in use as default, or the big endian mode will be in use for all the
23   device registers.
24 - big-endian-data: If this property is absent, the little endian mode will
25   be in use as default, or the big endian mode will be in use for all the
26   fifo data.
27
28 Example:
29 sai2: sai@40031000 {
30               compatible = "fsl,vf610-sai";
31               reg = <0x40031000 0x1000>;
32               pinctrl-names = "default";
33               pinctrl-0 = <&pinctrl_sai2_1>;
34               clocks = <&clks VF610_CLK_PLATFORM_BUS>,
35                      <&clks VF610_CLK_SAI2>,
36                      <&clks 0>, <&clks 0>;
37               clock-names = "bus", "mclk1", "mclk2", "mclk3";
38               dma-names = "tx", "rx";
39               dmas = <&edma0 0 VF610_EDMA_MUXID0_SAI2_TX>,
40                    <&edma0 0 VF610_EDMA_MUXID0_SAI2_RX>;
41               big-endian-regs;
42               big-endian-data;
43 };