[deliverable/linux.git] / Documentation / devicetree / bindings / sound / imx-audio-spdif.txt

Freescale i.MX audio complex with S/PDIF transceiver

Required properties:

  - compatible		: "fsl,imx-audio-spdif"

  - model		: The user-visible name of this sound complex

  - spdif-controller	: The phandle of the i.MX S/PDIF controller


Optional properties:

  - spdif-out		: This is a boolean property. If present, the
			  transmitting function of S/PDIF will be enabled,
			  indicating there's a physical S/PDIF out connector
			  or jack on the board or it's connecting to some
			  other IP block, such as an HDMI encoder or
			  display-controller.

  - spdif-in		: This is a boolean property. If present, the receiving
			  function of S/PDIF will be enabled, indicating there
			  is a physical S/PDIF in connector/jack on the board.

* Note: At least one of these two properties should be set in the DT binding.


Example:

sound-spdif {
	compatible = "fsl,imx-audio-spdif";
	model = "imx-spdif";
	spdif-controller = <&spdif>;
	spdif-out;
	spdif-in;
};
Commit	Line	Data
2a956ec0 NC	1	Freescale i.MX audio complex with S/PDIF transceiver
	2
	3	Required properties:
	4
6219b082	5	- compatible : "fsl,imx-audio-spdif"
2a956ec0	6
6219b082	7	- model : The user-visible name of this sound complex
2a956ec0	8
6219b082	9	- spdif-controller : The phandle of the i.MX S/PDIF controller
2a956ec0 NC	10
	11
	12	Optional properties:
	13
6219b082 NC	14	- spdif-out : This is a boolean property. If present, the
	15	transmitting function of S/PDIF will be enabled,
	16	indicating there's a physical S/PDIF out connector
	17	or jack on the board or it's connecting to some
	18	other IP block, such as an HDMI encoder or
	19	display-controller.
2a956ec0	20
6219b082 NC	21	- spdif-in : This is a boolean property. If present, the receiving
	22	function of S/PDIF will be enabled, indicating there
	23	is a physical S/PDIF in connector/jack on the board.
2a956ec0 NC	24
	25	* Note: At least one of these two properties should be set in the DT binding.
	26
	27
	28	Example:
	29
	30	sound-spdif {
	31	compatible = "fsl,imx-audio-spdif";
	32	model = "imx-spdif";
	33	spdif-controller = <&spdif>;
	34	spdif-out;
	35	spdif-in;
	36	};