Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt-bindings: doc: net: keystone-netcp: document cpts

The Keystone 2 66AK2HK/E/L 1G Ethernet Switch Subsystems contains The
Common Platform Time Sync (CPTS) module which is in general compatible with
CPTS module found on "legacy" TI AM3/4/5 SoCs. So, the basic support for
Keystone 2 CPTS is available by default, but not documented.
The Keystone 2 CPTS module supports also some additional features like time
sync reference (RFTCLK) clock selection through CPTS_RFTCLK_SEL register
(offset: x08) in CPTS module, which is modelled as multiplexer clock.

This patch adds missed binding documentation for Keystone 2 66AK2HK/E/L
CPTS module.

Signed-off-by: Grygorii Strashko <grygorii.strashko@ti.com>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Grygorii Strashko and committed by
David S. Miller
12775af5 8d94a873

+44
+44
Documentation/devicetree/bindings/net/keystone-netcp.txt
··· 104 104 - 10Gb mac<->mac forced mode : 11 105 105 ----phy-handle: phandle to PHY device 106 106 107 + - cpts: sub-node time synchronization (CPTS) submodule configuration 108 + -- clocks: CPTS reference clock. Should point on cpts-refclk-mux clock. 109 + -- clock-names: should be "cpts" 110 + -- cpts-refclk-mux: multiplexer clock definition sub-node for CPTS reference (RFTCLK) clock 111 + --- #clock-cells: should be 0 112 + --- clocks: list of CPTS reference (RFTCLK) clock's parents as defined in Data manual 113 + --- ti,mux-tbl: array of multiplexer indexes as defined in Data manual 114 + --- assigned-clocks: should point on cpts-refclk-mux clock 115 + --- assigned-clock-parents: should point on required RFTCLK clock parent to be selected 116 + -- cpts_clock_mult: (optional) Numerator to convert input clock ticks 117 + into nanoseconds 118 + -- cpts_clock_shift: (optional) Denominator to convert input clock ticks into 119 + nanoseconds. 120 + Mult and shift will be calculated basing on CPTS 121 + rftclk frequency if both cpts_clock_shift and 122 + cpts_clock_mult properties are not provided. 123 + 107 124 Optional properties: 108 125 - enable-ale: NetCP driver keeps the address learning feature in the ethernet 109 126 switch module disabled. This attribute is to enable the address ··· 185 168 tx-queue = <648>; 186 169 tx-channel = <8>; 187 170 171 + cpts { 172 + clocks = <&cpts_refclk_mux>; 173 + clock-names = "cpts"; 174 + 175 + cpts_refclk_mux: cpts-refclk-mux { 176 + #clock-cells = <0>; 177 + clocks = <&chipclk12>, <&chipclk13>, 178 + <&timi0>, <&timi1>, 179 + <&tsipclka>, <&tsrefclk>, 180 + <&tsipclkb>; 181 + ti,mux-tbl = <0x0>, <0x1>, <0x2>, 182 + <0x3>, <0x4>, <0x8>, <0xC>; 183 + assigned-clocks = <&cpts_refclk_mux>; 184 + assigned-clock-parents = <&chipclk12>; 185 + }; 186 + }; 187 + 188 188 interfaces { 189 189 gbe0: interface-0 { 190 190 slave-port = <0>; ··· 252 218 netcp-gbe = <&gbe1>; 253 219 }; 254 220 }; 221 + }; 222 + 223 + CPTS board configuration - select external CPTS RFTCLK: 224 + 225 + &tsrefclk{ 226 + clock-frequency = <500000000>; 227 + }; 228 + 229 + &cpts_refclk_mux { 230 + assigned-clock-parents = <&tsrefclk>; 255 231 };