Re: [PATCH v2 2/7] QE: Add ucc hdlc document to bindings
From: Rob Herring <robh@kernel.org>
Date: 2016-02-23 20:21:57
Also in:
linux-devicetree, lkml
On Thu, Feb 18, 2016 at 09:06:07AM +0800, Zhao Qiang wrote:
Add ucc hdlc document to Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt
Not a very useful description.
quoted hunk ↗ jump to hunk
Signed-off-by: Zhao Qiang <qiang.zhao@nxp.com> --- Changes for v2 - use ucc-hdlc instead of ucc_hdlc - add more information to properties. .../bindings/powerpc/fsl/cpm_qe/network.txt | 93 ++++++++++++++++++++++ 1 file changed, 93 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..936158c 100644 --- a/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt +++ b/Documentation/devicetree/bindings/powerpc/fsl/cpm_qe/network.txt@@ -41,3 +41,96 @@ Example: fsl,mdio-pin = <12>; fsl,mdc-pin = <13>; }; + +* HDLC + +Currently defined compatibles: +- fsl,ucc-hdlc + +Properties for fsl,ucc-hdlc: +- rx-clock-name +- tx-clock-name + Usage: required + Value type: <string> + Definition : should be "brg1"-"brg16" for internal clock source, + should be "clk1"-"clk28" for external clock source. + +- fsl,rx-sync-clock + Usage: required + Value type: <string> + Definition : should be "none" when using internal clock source, + should be "rsync_pin" when using external clock source.
Why not a boolean property here?
+ +- fsl,tx-sync-clock + Usage: required + Value type: <string> + Definition : should be "none" when using internal clock source, + should be "tsync_pin" when using external clock source.
And here.
+ +- fsl,tx-timeslot +- fsl,rx-timeslot
Perhaps append "-mask"
+ Usage: required + Value type: <u32> + Definition : time slot for TDM operation. Indicates which time slots + used for transmitting and receiving. + +- fsl,tdm-framer-type + Usage: required + Value type: <string> + Definition : "e1" or "t1"
Boolean?
+ +- fsl,tdm-mode + Usage: required + Value type: <string> + Definition : "normal" or "internal-loopback"
Boolean?
+
+- fsl,tdm-id
+ Usage: required
+ Value type: <u32>
+ Definition : number of TDM ID
+
+- fsl,siram-entry-id
+ Usage: required
+ Value type: <u32>
+ Definition : should be 0,2,4...64. the number of TDM entry.
+
+- fsl,tdm-interface
+ Usage: optional
+ Value type: <empty>
+ Definition : Specify that hdlc is based on tdm-interface
+
+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;
+ };+fsl,siram-entry-id : SI RAM entry ID for the TDM +fsl,tdm-interface : hdlc is based on tdm-interface
Should be deleted?
+
+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