[deliverable/linux.git] / Documentation / devicetree / bindings / sound / fsl,esai.txt

Freescale Enhanced Serial Audio Interface (ESAI) Controller

The Enhanced Serial Audio Interface (ESAI) provides a full-duplex serial port
for serial communication with a variety of serial devices, including industry
standard codecs, Sony/Phillips Digital Interface (S/PDIF) transceivers, and
other DSPs. It has up to six transmitters and four receivers.

Required properties:

  - compatible		: Compatible list, must contain "fsl,imx35-esai" or
			  "fsl,vf610-esai"

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

  - interrupts		: Contains the spdif interrupt.

  - 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".

  - clocks		: Contains an entry for each entry in clock-names.

  - clock-names		: Includes the following entries:
	"core"		  The core clock used to access registers
	"extal"		  The esai baud clock for esai controller used to
			  derive HCK, SCK and FS.
	"fsys"		  The system clock derived from ahb clock used to
			  derive HCK, SCK and FS.

  - fsl,fifo-depth	: The number of elements in the transmit and receive
			  FIFOs. This number is the maximum allowed value for
			  TFCR[TFWM] or RFCR[RFWM].

  - fsl,esai-synchronous: This is a boolean property. If present, indicating
			  that ESAI would work in the synchronous mode, which
			  means all the settings for Receiving would be
			  duplicated from Transmition related registers.

  - big-endian		: If this property is absent, the native endian mode
			  will be in use as default, or the big endian mode
			  will be in use for all the device registers.

Example:

esai: esai@02024000 {
	compatible = "fsl,imx35-esai";
	reg = <0x02024000 0x4000>;
	interrupts = <0 51 0x04>;
	clocks = <&clks 208>, <&clks 118>, <&clks 208>;
	clock-names = "core", "extal", "fsys";
	dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
	dma-names = "rx", "tx";
	fsl,fifo-depth = <128>;
	fsl,esai-synchronous;
	big-endian;
	status = "disabled";
};
Commit	Line	Data
43d24e76 NC	1	Freescale Enhanced Serial Audio Interface (ESAI) Controller
	2
	3	The Enhanced Serial Audio Interface (ESAI) provides a full-duplex serial port
	4	for serial communication with a variety of serial devices, including industry
	5	standard codecs, Sony/Phillips Digital Interface (S/PDIF) transceivers, and
	6	other DSPs. It has up to six transmitters and four receivers.
	7
	8	Required properties:
	9
73a2cd91 NC	10	- compatible : Compatible list, must contain "fsl,imx35-esai" or
73a2cd91 NC	11	"fsl,vf610-esai"
43d24e76	12
73a2cd91	13	- reg : Offset and length of the register set for the device.
43d24e76	14
73a2cd91	15	- interrupts : Contains the spdif interrupt.
43d24e76	16
73a2cd91 NC	17	- dmas : Generic dma devicetree binding as described in
73a2cd91 NC	18	Documentation/devicetree/bindings/dma/dma.txt.
43d24e76	19
73a2cd91	20	- dma-names : Two dmas have to be defined, "tx" and "rx".
43d24e76	21
73a2cd91	22	- clocks : Contains an entry for each entry in clock-names.
43d24e76	23
73a2cd91 NC	24	- clock-names : Includes the following entries:
	25	"core" The core clock used to access registers
	26	"extal" The esai baud clock for esai controller used to
	27	derive HCK, SCK and FS.
	28	"fsys" The system clock derived from ahb clock used to
	29	derive HCK, SCK and FS.
43d24e76	30
73a2cd91 NC	31	- fsl,fifo-depth : The number of elements in the transmit and receive
	32	FIFOs. This number is the maximum allowed value for
	33	TFCR[TFWM] or RFCR[RFWM].
43d24e76 NC	34
43d24e76 NC	35	- fsl,esai-synchronous: This is a boolean property. If present, indicating
73a2cd91 NC	36	that ESAI would work in the synchronous mode, which
	37	means all the settings for Receiving would be
	38	duplicated from Transmition related registers.
43d24e76	39
73a2cd91 NC	40	- big-endian : If this property is absent, the native endian mode
	41	will be in use as default, or the big endian mode
	42	will be in use for all the device registers.
eaba603f	43
43d24e76 NC	44	Example:
	45
	46	esai: esai@02024000 {
	47	compatible = "fsl,imx35-esai";
	48	reg = <0x02024000 0x4000>;
	49	interrupts = <0 51 0x04>;
	50	clocks = <&clks 208>, <&clks 118>, <&clks 208>;
	51	clock-names = "core", "extal", "fsys";
	52	dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
	53	dma-names = "rx", "tx";
	54	fsl,fifo-depth = <128>;
	55	fsl,esai-synchronous;
eaba603f	56	big-endian;
43d24e76 NC	57	status = "disabled";
43d24e76 NC	58	};