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

  - 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
	10	- compatible : Compatible list, must contain "fsl,imx35-esai".
	11
	12	- reg : Offset and length of the register set for the device.
	13
	14	- interrupts : Contains the spdif interrupt.
	15
	16	- dmas : Generic dma devicetree binding as described in
	17	Documentation/devicetree/bindings/dma/dma.txt.
	18
	19	- dma-names : Two dmas have to be defined, "tx" and "rx".
	20
	21	- clocks: Contains an entry for each entry in clock-names.
	22
	23	- clock-names : Includes the following entries:
	24	"core" The core clock used to access registers
	25	"extal" The esai baud clock for esai controller used to derive
	26	HCK, SCK and FS.
	27	"fsys" The system clock derived from ahb clock used to derive
	28	HCK, SCK and FS.
	29
	30	- fsl,fifo-depth: The number of elements in the transmit and receive FIFOs.
	31	This number is the maximum allowed value for TFCR[TFWM] or RFCR[RFWM].
	32
	33	- fsl,esai-synchronous: This is a boolean property. If present, indicating
	34	that ESAI would work in the synchronous mode, which means all the settings
	35	for Receiving would be duplicated from Transmition related registers.
	36
eaba603f XL	37	- big-endian : If this property is absent, the native endian mode will
	38	be in use as default, or the big endian mode will be in use for all the
	39	device registers.
	40
43d24e76 NC	41	Example:
	42
	43	esai: esai@02024000 {
	44	compatible = "fsl,imx35-esai";
	45	reg = <0x02024000 0x4000>;
	46	interrupts = <0 51 0x04>;
	47	clocks = <&clks 208>, <&clks 118>, <&clks 208>;
	48	clock-names = "core", "extal", "fsys";
	49	dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
	50	dma-names = "rx", "tx";
	51	fsl,fifo-depth = <128>;
	52	fsl,esai-synchronous;
eaba603f	53	big-endian;
43d24e76 NC	54	status = "disabled";
43d24e76 NC	55	};