[deliverable/linux.git] / Documentation / devicetree / bindings / sound / fsl-sai.txt

Freescale Synchronous Audio Interface (SAI).

The SAI is based on I2S module that used communicating with audio codecs,
which provides a synchronous audio interface that supports fullduplex
serial interfaces with frame synchronization such as I2S, AC97, TDM, and
codec/DSP interfaces.

Required properties:

  - compatible		: Compatible list, contains "fsl,vf610-sai" or
			  "fsl,imx6sx-sai".

  - reg			: Offset and length of the register set for the device.

  - clocks		: Must contain an entry for each entry in clock-names.

  - clock-names		: Must include the "bus" for register access and
			  "mclk1", "mclk2", "mclk3" for bit clock and frame
			  clock providing.
  - dmas		: Generic dma devicetree binding as described in
			  Documentation/devicetree/bindings/dma/dma.txt.

  - dma-names		: Two dmas have to be defined, "tx" and "rx".

  - pinctrl-names	: Must contain a "default" entry.

  - pinctrl-NNN		: One property must exist for each entry in
			  pinctrl-names. See ../pinctrl/pinctrl-bindings.txt
			  for details of the property values.

  - big-endian		: Boolean property, required if all the FTM_PWM
			  registers are big-endian rather than little-endian.

  - lsb-first		: Configures whether the LSB or the MSB is transmitted
			  first for the fifo data. If this property is absent,
			  the MSB is transmitted first as default, or the LSB
			  is transmitted first.

  - fsl,sai-synchronous-rx: This is a boolean property. If present, indicating
			  that SAI will work in the synchronous mode (sync Tx
			  with Rx) which means both the transimitter and the
			  receiver will send and receive data by following
			  receiver's bit clocks and frame sync clocks.

  - fsl,sai-asynchronous: This is a boolean property. If present, indicating
			  that SAI will work in the asynchronous mode, which
			  means both transimitter and receiver will send and
			  receive data by following their own bit clocks and
			  frame sync clocks separately.

Note:
- If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the
  default synchronous mode (sync Rx with Tx) will be used, which means both
  transimitter and receiver will send and receive data by following clocks
  of transimitter.
- fsl,sai-asynchronous and fsl,sai-synchronous-rx are exclusive.

Example:
sai2: sai@40031000 {
	      compatible = "fsl,vf610-sai";
	      reg = <0x40031000 0x1000>;
	      pinctrl-names = "default";
	      pinctrl-0 = <&pinctrl_sai2_1>;
	      clocks = <&clks VF610_CLK_PLATFORM_BUS>,
		     <&clks VF610_CLK_SAI2>,
		     <&clks 0>, <&clks 0>;
	      clock-names = "bus", "mclk1", "mclk2", "mclk3";
	      dma-names = "tx", "rx";
	      dmas = <&edma0 0 VF610_EDMA_MUXID0_SAI2_TX>,
		   <&edma0 0 VF610_EDMA_MUXID0_SAI2_RX>;
	      big-endian;
	      lsb-first;
};
Commit	Line	Data
b6344859 XL	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
b6344859	8	Required properties:
0b9938b2 NC	9
	10	- compatible : Compatible list, contains "fsl,vf610-sai" or
	11	"fsl,imx6sx-sai".
	12
	13	- reg : Offset and length of the register set for the device.
	14
	15	- clocks : Must contain an entry for each entry in clock-names.
	16
	17	- clock-names : Must include the "bus" for register access and
	18	"mclk1", "mclk2", "mclk3" for bit clock and frame
	19	clock providing.
	20	- dmas : Generic dma devicetree binding as described in
	21	Documentation/devicetree/bindings/dma/dma.txt.
	22
	23	- dma-names : Two dmas have to be defined, "tx" and "rx".
	24
	25	- pinctrl-names : Must contain a "default" entry.
	26
	27	- pinctrl-NNN : One property must exist for each entry in
	28	pinctrl-names. See ../pinctrl/pinctrl-bindings.txt
	29	for details of the property values.
	30
	31	- big-endian : Boolean property, required if all the FTM_PWM
	32	registers are big-endian rather than little-endian.
	33
	34	- lsb-first : Configures whether the LSB or the MSB is transmitted
	35	first for the fifo data. If this property is absent,
	36	the MSB is transmitted first as default, or the LSB
	37	is transmitted first.
	38
	39	- fsl,sai-synchronous-rx: This is a boolean property. If present, indicating
	40	that SAI will work in the synchronous mode (sync Tx
	41	with Rx) which means both the transimitter and the
	42	receiver will send and receive data by following
	43	receiver's bit clocks and frame sync clocks.
	44
	45	- fsl,sai-asynchronous: This is a boolean property. If present, indicating
	46	that SAI will work in the asynchronous mode, which
	47	means both transimitter and receiver will send and
	48	receive data by following their own bit clocks and
	49	frame sync clocks separately.
08fdf65e NC	50
	51	Note:
	52	- If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the
	53	default synchronous mode (sync Rx with Tx) will be used, which means both
	54	transimitter and receiver will send and receive data by following clocks
	55	of transimitter.
ce7344a4	56	- fsl,sai-asynchronous and fsl,sai-synchronous-rx are exclusive.
b6344859 XL	57
	58	Example:
	59	sai2: sai@40031000 {
	60	compatible = "fsl,vf610-sai";
	61	reg = <0x40031000 0x1000>;
	62	pinctrl-names = "default";
	63	pinctrl-0 = <&pinctrl_sai2_1>;
ca3e35c7 NC	64	clocks = <&clks VF610_CLK_PLATFORM_BUS>,
	65	<&clks VF610_CLK_SAI2>,
	66	<&clks 0>, <&clks 0>;
	67	clock-names = "bus", "mclk1", "mclk2", "mclk3";
b6344859 XL	68	dma-names = "tx", "rx";
	69	dmas = <&edma0 0 VF610_EDMA_MUXID0_SAI2_TX>,
	70	<&edma0 0 VF610_EDMA_MUXID0_SAI2_RX>;
014fd22e	71	big-endian;
eadb0019	72	lsb-first;
b6344859	73	};