net: ethernet: Add DT bindings for the Gemini ethernet
authorLinus Walleij <linus.walleij@linaro.org>
Fri, 12 Jan 2018 21:34:23 +0000 (22:34 +0100)
committerDavid S. Miller <davem@davemloft.net>
Mon, 15 Jan 2018 19:38:55 +0000 (14:38 -0500)
This adds the device tree bindings for the Gemini ethernet
controller. It is pretty straight-forward, using standard
bindings and modelling the two child ports as child devices
under the parent ethernet controller device.

Cc: devicetree@vger.kernel.org
Cc: Tobias Waldvogel <tobias.waldvogel@gmail.com>
Cc: Michał Mirosław <mirq-linux@rere.qmqm.pl>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/devicetree/bindings/net/cortina,gemini-ethernet.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/net/cortina,gemini-ethernet.txt b/Documentation/devicetree/bindings/net/cortina,gemini-ethernet.txt
new file mode 100644 (file)
index 0000000..6c55998
--- /dev/null
@@ -0,0 +1,92 @@
+Cortina Systems Gemini Ethernet Controller
+==========================================
+
+This ethernet controller is found in the Gemini SoC family:
+StorLink SL3512 and SL3516, also known as Cortina Systems
+CS3512 and CS3516.
+
+Required properties:
+- compatible: must be "cortina,gemini-ethernet"
+- reg: must contain the global registers and the V-bit and A-bit
+  memory areas, in total three register sets.
+- syscon: a phandle to the system controller
+- #address-cells: must be specified, must be <1>
+- #size-cells: must be specified, must be <1>
+- ranges: should be state like this giving a 1:1 address translation
+  for the subnodes
+
+The subnodes represents the two ethernet ports in this device.
+They are not independent of each other since they share resources
+in the parent node, and are thus children.
+
+Required subnodes:
+- port0: contains the resources for ethernet port 0
+- port1: contains the resources for ethernet port 1
+
+Required subnode properties:
+- compatible: must be "cortina,gemini-ethernet-port"
+- reg: must contain two register areas: the DMA/TOE memory and
+  the GMAC memory area of the port
+- interrupts: should contain the interrupt line of the port.
+  this is nominally a level interrupt active high.
+- resets: this must provide an SoC-integrated reset line for
+  the port.
+- clocks: this should contain a handle to the PCLK clock for
+  clocking the silicon in this port
+- clock-names: must be "PCLK"
+
+Optional subnode properties:
+- phy-mode: see ethernet.txt
+- phy-handle: see ethernet.txt
+
+Example:
+
+mdio-bus {
+       (...)
+       phy0: ethernet-phy@1 {
+               reg = <1>;
+               device_type = "ethernet-phy";
+       };
+       phy1: ethernet-phy@3 {
+               reg = <3>;
+               device_type = "ethernet-phy";
+       };
+};
+
+
+ethernet@60000000 {
+       compatible = "cortina,gemini-ethernet";
+       reg = <0x60000000 0x4000>, /* Global registers, queue */
+             <0x60004000 0x2000>, /* V-bit */
+             <0x60006000 0x2000>; /* A-bit */
+       syscon = <&syscon>;
+       #address-cells = <1>;
+       #size-cells = <1>;
+       ranges;
+
+       gmac0: ethernet-port@0 {
+               compatible = "cortina,gemini-ethernet-port";
+               reg = <0x60008000 0x2000>, /* Port 0 DMA/TOE */
+                     <0x6000a000 0x2000>; /* Port 0 GMAC */
+               interrupt-parent = <&intcon>;
+               interrupts = <1 IRQ_TYPE_LEVEL_HIGH>;
+               resets = <&syscon GEMINI_RESET_GMAC0>;
+               clocks = <&syscon GEMINI_CLK_GATE_GMAC0>;
+               clock-names = "PCLK";
+               phy-mode = "rgmii";
+               phy-handle = <&phy0>;
+       };
+
+       gmac1: ethernet-port@1 {
+               compatible = "cortina,gemini-ethernet-port";
+               reg = <0x6000c000 0x2000>, /* Port 1 DMA/TOE */
+                     <0x6000e000 0x2000>; /* Port 1 GMAC */
+               interrupt-parent = <&intcon>;
+               interrupts = <2 IRQ_TYPE_LEVEL_HIGH>;
+               resets = <&syscon GEMINI_RESET_GMAC1>;
+               clocks = <&syscon GEMINI_CLK_GATE_GMAC1>;
+               clock-names = "PCLK";
+               phy-mode = "rgmii";
+               phy-handle = <&phy1>;
+       };
+};