Re: [PATCH 2/6] QE: Add ucc hdlc document to bindings

[Rob Herring <robh@kernel.org>]

On Fri, Jan 08, 2016 at 10:18:10AM +0800, Zhao Qiang wrote:
> Add ucc hdlc document to
> Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt
> 
> Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com>
> ---
>  .../bindings/powerpc/fsl/cpm_qe/network.txt        | 35 ++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt b/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt
> index 29b28b8..017cbf7 100644
> --- a/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt
> +++ b/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt
> @@ -41,3 +41,38 @@ Example:
>  		fsl,mdio-pin = <12>;
>  		fsl,mdc-pin = <13>;
>  	};
> +
> +* HDLC
> +
> +Currently defined compatibles:
> +- fsl,ucc_hdlc

Don't use _.

> +
> +Properties for fsl,ucc_hdlc:
> +rx-clock-name : which clock QE use for RX
> +tx-clock-name : which clock QE use for TX
> +fsl,rx-sync-clock : which pin QE use for RX sync
> +fsl,tx-sync-clock : which pin QE use for TX sync
> +fsl,tx-timeslot : tx timeslot
> +fsl,rx-timeslot : rx timeslot
> +fsl,tdm-framer-type : tdm framer type
> +fsl,tdm-mode : tdm mode, normal or internal-loopback
> +fsl,tdm-id : tdm ID
> +fsl,siram-entry-id : SI RAM entry ID for the TDM
> +fsl,tdm-interface : hdlc based on tdm-interface

It is not clear what any of these properties do. For example, what are 
allowed/valid values. Provide enough information to validate the 
example.

Rob

> +
> +Example:
> +
> +	ucc@2000 {
> +		compatible = "fsl,ucc_hdlc";
> +		rx-clock-name = "clk8";
> +		tx-clock-name = "clk9";
> +		fsl,rx-sync-clock = "rsync_pin";
> +		fsl,tx-sync-clock = "tsync_pin";
> +		fsl,tx-timeslot = <0xfffffffe>;
> +		fsl,rx-timeslot = <0xfffffffe>;
> +		fsl,tdm-framer-type = "e1";
> +		fsl,tdm-mode = "normal";
> +		fsl,tdm-id = <0>;
> +		fsl,siram-entry-id = <0>;
> +		fsl,tdm-interface;
> +	};
> -- 
> 2.1.0.27.g96db324
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html