net: axienet: document axistream-connected attribute

The axienet driver requires the use of an axistream-connected attribute,
but this isn't documented in the devicetree bindings. Document how this
attribute is supposed to be used, including the upcoming change to make
the usage of this attribute optional.

Signed-off-by: Robert Hancock <hancock@sedsystems.ca>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/Documentation/devicetree/bindings/net/xilinx_axienet.txt b/Documentation/devicetree/bindings/net/xilinx_axienet.txt
index a8be67b425fd7db3185e5f9ac3efc1151ac956c8..7360617cdedb54deb56f31aacc3ab65e07ada886 100644 (file)
--- a/Documentation/devicetree/bindings/net/xilinx_axienet.txt
+++ b/Documentation/devicetree/bindings/net/xilinx_axienet.txt
@@ -17,9 +17,15 @@ For more details about mdio please refer phy.txt file in the same directory.
 Required properties:
 - compatible   : Must be one of "xlnx,axi-ethernet-1.00.a",
                  "xlnx,axi-ethernet-1.01.a", "xlnx,axi-ethernet-2.01.a"
-- reg          : Address and length of the IO space.
+- reg          : Address and length of the IO space, as well as the address
+                  and length of the AXI DMA controller IO space, unless
+                  axistream-connected is specified, in which case the reg
+                  attribute of the node referenced by it is used.
 - interrupts   : Should be a list of 2 or 3 interrupts: TX DMA, RX DMA,
-                 and optionally Ethernet core.
+                 and optionally Ethernet core. If axistream-connected is
+                 specified, the TX/RX DMA interrupts should be on that node
+                 instead, and only the Ethernet core interrupt is optionally
+                 specified here.
 - phy-handle   : Should point to the external phy device.
                  See ethernet.txt file in the same directory.
 - xlnx,rxmem   : Set to allocated memory buffer for Rx/Tx in the hardware
@@ -37,6 +43,11 @@ Optional properties:
                  auto-detected from the CPU clock (but only on platforms where
                  this is possible). New device trees should specify this - the
                  auto detection is only for backward compatibility.
+- axistream-connected: Reference to another node which contains the resources
+                      for the AXI DMA controller used by this device.
+                      If this is specified, the DMA-related resources from that
+                      device (DMA registers and DMA TX/RX interrupts) rather
+                      than this one will be used.
  - mdio                : Child node for MDIO bus. Must be defined if PHY access is
                  required through the core's MDIO interface (i.e. always,
                  unless the PHY is accessed through a different bus).
@@ -46,10 +57,10 @@ Example:
                compatible = "xlnx,axi-ethernet-1.00.a";
                device_type = "network";
                interrupt-parent = <&microblaze_0_axi_intc>;
-               interrupts = <2 0>;
+               interrupts = <2 0 1>;
                clocks = <&axi_clk>;
                phy-mode = "mii";
-               reg = <0x40c00000 0x40000>;
+               reg = <0x40c00000 0x40000 0x50c00000 0x40000>;
                xlnx,rxcsum = <0x2>;
                xlnx,rxmem = <0x800>;
                xlnx,txcsum = <0x2>;