diff mbox

[v3,1/4] drm: arm: Add DT bindings documentation for HDLCD driver.

Message ID 1449058982-18595-2-git-send-email-Liviu.Dudau@arm.com (mailing list archive)
State New, archived
Headers show

Commit Message

Liviu Dudau Dec. 2, 2015, 12:22 p.m. UTC
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: Kumar Gala <galak@codeaurora.org>

Signed-off-by: Liviu Dudau <Liviu.Dudau@arm.com>
---
 .../devicetree/bindings/display/arm,hdlcd.txt      | 79 ++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/arm,hdlcd.txt

Comments

Rob Herring (Arm) Dec. 2, 2015, 2:25 p.m. UTC | #1
On Wed, Dec 02, 2015 at 12:22:59PM +0000, Liviu Dudau wrote:
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Pawel Moll <pawel.moll@arm.com>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
> Cc: Kumar Gala <galak@codeaurora.org>
> 
> Signed-off-by: Liviu Dudau <Liviu.Dudau@arm.com>

I still think you should have a more specific compatible string, but 
here's some rope:

Acked-by: Rob Herring <robh@kernel.org>

> ---
>  .../devicetree/bindings/display/arm,hdlcd.txt      | 79 ++++++++++++++++++++++
>  1 file changed, 79 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/display/arm,hdlcd.txt
> 
> diff --git a/Documentation/devicetree/bindings/display/arm,hdlcd.txt b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
> new file mode 100644
> index 0000000..78bc242
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
> @@ -0,0 +1,79 @@
> +ARM HDLCD
> +
> +This is a display controller found on several development platforms produced
> +by ARM Ltd and in more modern of its' Fast Models. The HDLCD is an RGB
> +streamer that reads the data from a framebuffer and sends it to a single
> +digital encoder (DVI or HDMI).
> +
> +Required properties:
> +  - compatible: "arm,hdlcd"
> +  - reg: Physical base address and length of the controller's registers.
> +  - interrupts: One interrupt used by the display controller to notify the
> +    interrupt controller when any of the interrupt sources programmed in
> +    the interrupt mask register have activated.
> +  - clocks: A list of phandle + clock-specifier pairs, one for each
> +    entry in 'clock-names'.
> +  - clock-names: A list of clock names. For HDLCD it should contain:
> +      - "pxlclk" for the clock feeding the output PLL of the controller.
> +
> +Required sub-nodes:
> +  - port: The HDLCD connection to an encoder chip. The connection is modeled
> +    using the OF graph bindings specified in
> +    Documentation/devicetree/bindings/graph.txt.
> +
> +Optional properties:
> +  - memory-region: phandle to a node describing memory (see
> +    Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt) to be
> +    used for the framebuffer; if not present, the framebuffer may be located
> +    anywhere in memory.
> +
> +
> +Example:
> +
> +/ {
> +	...
> +
> +	hdlcd@2b000000 {
> +		compatible = "arm,hdlcd";
> +		reg = <0 0x2b000000 0 0x1000>;
> +		interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>;
> +		clocks = <&oscclk5>;
> +		clock-names = "pxlclk";
> +		port {
> +			hdlcd_output: endpoint@0 {
> +				remote-endpoint = <&hdmi_enc_input>;
> +			};
> +		};
> +	};
> +
> +	/* HDMI encoder on I2C bus */
> +	i2c@7ffa0000 {
> +		....
> +		hdmi-transmitter@70 {
> +			compatible = ".....";
> +			reg = <0x70>;
> +			port@0 {
> +				hdmi_enc_input: endpoint {
> +					remote-endpoint = <&hdlcd_output>;
> +				};
> +
> +				hdmi_enc_output: endpoint {
> +					remote-endpoint = <&hdmi_1_port>;
> +				};
> +			};
> +		};
> +
> +	};
> +
> +	hdmi1: connector@1 {
> +		compatible = "hdmi-connector";
> +		type = "a";
> +		port {
> +			hdmi_1_port: endpoint {
> +				remote-endpoint = <&hdmi_enc_output>;
> +			};
> +		};
> +	};
> +
> +	...
> +};
> -- 
> 2.6.2
>
Liviu Dudau Dec. 2, 2015, 2:51 p.m. UTC | #2
On Wed, Dec 02, 2015 at 08:25:15AM -0600, Rob Herring wrote:
> On Wed, Dec 02, 2015 at 12:22:59PM +0000, Liviu Dudau wrote:
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Pawel Moll <pawel.moll@arm.com>
> > Cc: Mark Rutland <mark.rutland@arm.com>
> > Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
> > Cc: Kumar Gala <galak@codeaurora.org>
> > 
> > Signed-off-by: Liviu Dudau <Liviu.Dudau@arm.com>
> 
> I still think you should have a more specific compatible string, but 
> here's some rope:

:) Now I need to find some soap and a small wooden box.

> 
> Acked-by: Rob Herring <robh@kernel.org>

Thanks!
Liviu

> 
> > ---
> >  .../devicetree/bindings/display/arm,hdlcd.txt      | 79 ++++++++++++++++++++++
> >  1 file changed, 79 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/display/arm,hdlcd.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/display/arm,hdlcd.txt b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
> > new file mode 100644
> > index 0000000..78bc242
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
> > @@ -0,0 +1,79 @@
> > +ARM HDLCD
> > +
> > +This is a display controller found on several development platforms produced
> > +by ARM Ltd and in more modern of its' Fast Models. The HDLCD is an RGB
> > +streamer that reads the data from a framebuffer and sends it to a single
> > +digital encoder (DVI or HDMI).
> > +
> > +Required properties:
> > +  - compatible: "arm,hdlcd"
> > +  - reg: Physical base address and length of the controller's registers.
> > +  - interrupts: One interrupt used by the display controller to notify the
> > +    interrupt controller when any of the interrupt sources programmed in
> > +    the interrupt mask register have activated.
> > +  - clocks: A list of phandle + clock-specifier pairs, one for each
> > +    entry in 'clock-names'.
> > +  - clock-names: A list of clock names. For HDLCD it should contain:
> > +      - "pxlclk" for the clock feeding the output PLL of the controller.
> > +
> > +Required sub-nodes:
> > +  - port: The HDLCD connection to an encoder chip. The connection is modeled
> > +    using the OF graph bindings specified in
> > +    Documentation/devicetree/bindings/graph.txt.
> > +
> > +Optional properties:
> > +  - memory-region: phandle to a node describing memory (see
> > +    Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt) to be
> > +    used for the framebuffer; if not present, the framebuffer may be located
> > +    anywhere in memory.
> > +
> > +
> > +Example:
> > +
> > +/ {
> > +	...
> > +
> > +	hdlcd@2b000000 {
> > +		compatible = "arm,hdlcd";
> > +		reg = <0 0x2b000000 0 0x1000>;
> > +		interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>;
> > +		clocks = <&oscclk5>;
> > +		clock-names = "pxlclk";
> > +		port {
> > +			hdlcd_output: endpoint@0 {
> > +				remote-endpoint = <&hdmi_enc_input>;
> > +			};
> > +		};
> > +	};
> > +
> > +	/* HDMI encoder on I2C bus */
> > +	i2c@7ffa0000 {
> > +		....
> > +		hdmi-transmitter@70 {
> > +			compatible = ".....";
> > +			reg = <0x70>;
> > +			port@0 {
> > +				hdmi_enc_input: endpoint {
> > +					remote-endpoint = <&hdlcd_output>;
> > +				};
> > +
> > +				hdmi_enc_output: endpoint {
> > +					remote-endpoint = <&hdmi_1_port>;
> > +				};
> > +			};
> > +		};
> > +
> > +	};
> > +
> > +	hdmi1: connector@1 {
> > +		compatible = "hdmi-connector";
> > +		type = "a";
> > +		port {
> > +			hdmi_1_port: endpoint {
> > +				remote-endpoint = <&hdmi_enc_output>;
> > +			};
> > +		};
> > +	};
> > +
> > +	...
> > +};
> > -- 
> > 2.6.2
> > 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/display/arm,hdlcd.txt b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
new file mode 100644
index 0000000..78bc242
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/arm,hdlcd.txt
@@ -0,0 +1,79 @@ 
+ARM HDLCD
+
+This is a display controller found on several development platforms produced
+by ARM Ltd and in more modern of its' Fast Models. The HDLCD is an RGB
+streamer that reads the data from a framebuffer and sends it to a single
+digital encoder (DVI or HDMI).
+
+Required properties:
+  - compatible: "arm,hdlcd"
+  - reg: Physical base address and length of the controller's registers.
+  - interrupts: One interrupt used by the display controller to notify the
+    interrupt controller when any of the interrupt sources programmed in
+    the interrupt mask register have activated.
+  - clocks: A list of phandle + clock-specifier pairs, one for each
+    entry in 'clock-names'.
+  - clock-names: A list of clock names. For HDLCD it should contain:
+      - "pxlclk" for the clock feeding the output PLL of the controller.
+
+Required sub-nodes:
+  - port: The HDLCD connection to an encoder chip. The connection is modeled
+    using the OF graph bindings specified in
+    Documentation/devicetree/bindings/graph.txt.
+
+Optional properties:
+  - memory-region: phandle to a node describing memory (see
+    Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt) to be
+    used for the framebuffer; if not present, the framebuffer may be located
+    anywhere in memory.
+
+
+Example:
+
+/ {
+	...
+
+	hdlcd@2b000000 {
+		compatible = "arm,hdlcd";
+		reg = <0 0x2b000000 0 0x1000>;
+		interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>;
+		clocks = <&oscclk5>;
+		clock-names = "pxlclk";
+		port {
+			hdlcd_output: endpoint@0 {
+				remote-endpoint = <&hdmi_enc_input>;
+			};
+		};
+	};
+
+	/* HDMI encoder on I2C bus */
+	i2c@7ffa0000 {
+		....
+		hdmi-transmitter@70 {
+			compatible = ".....";
+			reg = <0x70>;
+			port@0 {
+				hdmi_enc_input: endpoint {
+					remote-endpoint = <&hdlcd_output>;
+				};
+
+				hdmi_enc_output: endpoint {
+					remote-endpoint = <&hdmi_1_port>;
+				};
+			};
+		};
+
+	};
+
+	hdmi1: connector@1 {
+		compatible = "hdmi-connector";
+		type = "a";
+		port {
+			hdmi_1_port: endpoint {
+				remote-endpoint = <&hdmi_enc_output>;
+			};
+		};
+	};
+
+	...
+};