[PATCH v7 3/6] dt-bindings: media: Document Synopsys Designware HDMI RX

[Jose Abreu]

Document the bindings for the Synopsys Designware HDMI RX.

Signed-off-by: Jose Abreu <joabreu@xxxxxxxxxxxx>
Cc: Carlos Palminha <palminha@xxxxxxxxxxxx>
Cc: Rob Herring <robh+dt@xxxxxxxxxx>
Cc: Mark Rutland <mark.rutland@xxxxxxx>
Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
Cc: Hans Verkuil <hans.verkuil@xxxxxxxxx>
Cc: Sylwester Nawrocki <snawrocki@xxxxxxxxxx>
Cc: devicetree@xxxxxxxxxxxxxxx

Changes from v6:
	- Document which properties are required/optional (Sylwester)
	- Drop compatible string for SoC (Sylwester)
	- Reword edid-phandle property (Sylwester)
	- Typo fixes (Sylwester)
Changes from v4:
	- Use "cfg" instead of "cfg-clk" (Rob)
	- Change node names (Rob)
Changes from v3:
	- Document the new DT bindings suggested by Sylwester
Changes from v2:
	- Document edid-phandle property
---
 .../devicetree/bindings/media/snps,dw-hdmi-rx.txt  | 74 ++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/snps,dw-hdmi-rx.txt

diff --git a/Documentation/devicetree/bindings/media/snps,dw-hdmi-rx.txt b/Documentation/devicetree/bindings/media/snps,dw-hdmi-rx.txt
new file mode 100644
index 0000000..6c49aae
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/snps,dw-hdmi-rx.txt
@@ -0,0 +1,74 @@
+Synopsys DesignWare HDMI RX Decoder
+===================================
+
+This document defines device tree properties for the Synopsys DesignWare HDMI
+RX Decoder (DWC HDMI RX). It doesn't constitute a device tree binding
+specification by itself but is meant to be referenced by platform-specific
+device tree bindings.
+
+The properties bellow belong to the Synopsys DesignWare HDMI RX Decoder node.
+
+- compatible: Required property. Shall be "snps,dw-hdmi-rx".
+
+- reg: Required property. Memory mapped base address and length of the DWC
+HDMI RX registers.
+
+- interrupts: Required property. Reference to the DWC HDMI RX interrupt and
+HDMI 5V sense interrupt.
+
+- clocks: Required property. Phandle to the config clock block.
+
+- clock-names: Required property. Shall be "cfg".
+
+- edid-phandle: Optional proerty. phandle to the EDID handler block; if this
+property is not specified it is assumed that EDID is handled by device
+described by parent node of the HDMI RX node. You should not specify this
+property if your HDMI RX controller does not have CEC.
+
+- #address-cells: Required property. Shall be 1.
+
+- #size-cells: Required property. Shall be 0.
+
+You also have to create a subnode for the PHY device. PHY node properties are
+as follows.
+
+- compatible: Required property. Shall be "snps,dw-hdmi-phy-e405".
+
+- reg: Required property. Shall be JTAG address of the PHY.
+
+- clocks: Required property. Phandle for cfg clock.
+
+- clock-names: Required property. Shall be "cfg".
+
+A sample binding is now provided. The compatible string is for a SoC which has
+has a Synopsys DesignWare HDMI RX decoder inside.
+
+Example:
+
+dw_hdmi_soc: dw-hdmi-soc@0 {
+	compatible = "...";
+	#address-cells = <1>;
+	#size-cells = <1>;
+	ranges;
+
+	hdmi-rx@0 {
+		compatible = "snps,dw-hdmi-rx";
+		reg = <0x0 0x10000>;
+		interrupts = <1 2>;
+		edid-phandle = <&dw_hdmi_soc>;
+
+		clocks = <&dw_hdmi_refclk>;
+		clock-names = "cfg";
+
+		#address-cells = <1>;
+		#size-cells = <0>;
+
+		hdmi-phy@fc {
+			compatible = "snps,dw-hdmi-phy-e405";
+			reg = <0xfc>;
+
+			clocks = <&dw_hdmi_refclk>;
+			clock-names = "cfg";
+		};
+	};
+};
-- 
1.9.1