Documentation: broadcom-bcmgenet: add better clocks documentation
authorFlorian Fainelli <f.fainelli@gmail.com>
Fri, 14 Feb 2014 23:21:42 +0000 (15:21 -0800)
committerDavid S. Miller <davem@davemloft.net>
Mon, 17 Feb 2014 05:27:44 +0000 (00:27 -0500)
Document the required "clocks" phandles and their corresponding
"clock-names" properties for the two clocks used by the GENET hardware
block ("enet" and "enet-wol").

CC: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/devicetree/bindings/net/broadcom-bcmgenet.txt

index afd31f9..88c3d04 100644 (file)
@@ -14,8 +14,11 @@ Required properties:
 - size-cells: should be 1
 
 Optional properties:
-- clocks: When provided, must be two cells, first one is the main GENET clock
-  and the second cell is the Genet Wake-on-LAN clock.
+- clocks: When provided, must be two phandles to the functional clocks nodes
+  of the GENET block. The first phandle is the main GENET clock used during
+  normal operation, while the second phandle is the Wake-on-LAN clock.
+- clock-names: When provided, names of the functional clock phandles, first
+  name should be "enet" and second should be "enet-wol".
 
 - phy-handle: A phandle to a phy node defining the PHY address (as the reg
   property, a single integer), used to describe configurations where a PHY