Re: [PATCH 2/2] drm: Add DT bindings documentation for OpenCores VGA/LCD controller

[Rob Herring]

On Thu, Jun 09, 2016 at 03:33:19PM +0200, Andrea Merello wrote:
> Signed-off-by: Andrea Merello <andrea.merello@xxxxxxxxx>
> Cc: Stefan Kristiansson <stefan.kristiansson@xxxxxxxxxxxxx>
> Cc: Tomi Valkeinen <tomi.valkeinen@xxxxxx>
> Cc: Francesco Diotalevi <francesco.diotalevi@xxxxxx>
> Cc: Claudio Lorini <claudio.lorini@xxxxxx>
> ---
>  .../bindings/display/opencores,ocdrm.txt           | 27 ++++++++++++++++++++++
>  1 file changed, 27 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/display/opencores,ocdrm.txt
> 
> diff --git a/Documentation/devicetree/bindings/display/opencores,ocdrm.txt b/Documentation/devicetree/bindings/display/opencores,ocdrm.txt
> new file mode 100644
> index 0000000..8d36de5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/opencores,ocdrm.txt
> @@ -0,0 +1,27 @@
> +OpenCores VGA/LCD controller
> +
> +Required properties:
> +- compatible: "opencores,ocdrm"

Name this based on what the h/w block is called, not a Linux subsystem.

Is there any sort of versioning for OpenCore IP that you can include in 
the name?

> +- reg: Physical base address and length of the controller's registers.
> +- clocks: Must contain an entry for the pixelclock generator.
> +  See ../clocks/clock-bindings.txt for details.
> +
> +Required sub-nodes:
> +- port: the connection to a DRM bridge.  The connection is modelled

Don't include Linux driver details (DRM) in bindings.

> +  using the OF graph bindings specified in
> +  Documentation/devicetree/bindings/graph.txt.
> +
> +Example:
> +
> +ocdrm@43c10000 {
> +	compatible = "opencores,ocfb-drm";

Doesn't match the above and even worse naming.

> +	reg = <0x43c10000 0x10000>;
> +	clocks = <&pix_clock>;
> +	ports {
> +		port@0 {

Single port doesn't need a unit address.

> +			rgb_out: endpoint {
> +				remote-endpoint = <&bridge_in>;
> +			};
> +		};
> +	};
> +};
> -- 
> 1.9.1
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html