Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
From:   Puranjay Mohan <p-mohan@ti.com>
To:     <linux-kernel@vger.kernel.org>
CC:     <davem@davemloft.net>, <edumazet@google.com>,
        <krzysztof.kozlowski+dt@linaro.org>, <netdev@vger.kernel.org>,
        <devicetree@vger.kernel.org>, <nm@ti.com>, <ssantosh@kernel.org>,
        <s-anna@ti.com>, <p-mohan@ti.com>,
        <linux-arm-kernel@lists.infradead.org>, <rogerq@kernel.org>,
        <grygorii.strashko@ti.com>, <vigneshr@ti.com>, <kishon@ti.com>,
        <robh+dt@kernel.org>, <afd@ti.com>, <andrew@lunn.ch>
Subject: [PATCH v2 1/2] dt-bindings: net: Add ICSSG Ethernet Driver bindings
Date:   Tue, 31 May 2022 15:21:07 +0530
Message-ID: <20220531095108.21757-2-p-mohan@ti.com>
In-Reply-To: <20220531095108.21757-1-p-mohan@ti.com>
References: <20220531095108.21757-1-p-mohan@ti.com>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

Add a YAML binding document for the ICSSG Programmable real time unit
based Ethernet driver. This driver uses the PRU and PRUSS consumer APIs
to interface the PRUs and load/run the firmware for supporting ethernet
functionality.

Signed-off-by: Puranjay Mohan <p-mohan@ti.com>
---
v1: https://lore.kernel.org/all/20220506052433.28087-2-p-mohan@ti.com/ 
v1 -> v2:
* Addressed Rob's Comments
* It includes indentation, formatting, and other minor changes.
---
 .../bindings/net/ti,icssg-prueth.yaml         | 181 ++++++++++++++++++
 1 file changed, 181 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml

diff --git a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
new file mode 100644
index 000000000000..40af968e9178
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
@@ -0,0 +1,181 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/ti,icssg-prueth.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: |+
+  Texas Instruments ICSSG PRUSS Ethernet
+
+maintainers:
+  - Puranjay Mohan <p-mohan@ti.com>
+
+description:
+  Ethernet based on the Programmable Real-Time
+  Unit and Industrial Communication Subsystem.
+
+allOf:
+  - $ref: /schemas/remoteproc/ti,pru-consumer.yaml#
+
+properties:
+  compatible:
+    enum:
+      - ti,am654-icssg-prueth  # for AM65x SoC family
+
+  pinctrl-0:
+    maxItems: 1
+
+  pinctrl-names:
+    items:
+      - const: default
+
+  sram:
+    description:
+      phandle to MSMC SRAM node
+
+  dmas:
+    maxItems: 10
+    description:
+      list of phandles and specifiers to UDMA.
+
+  dma-names:
+    items:
+      - const: tx0-0
+      - const: tx0-1
+      - const: tx0-2
+      - const: tx0-3
+      - const: tx1-0
+      - const: tx1-1
+      - const: tx1-2
+      - const: tx1-3
+      - const: rx0
+      - const: rx1
+
+  ethernet-ports:
+    type: object
+    properties:
+      '#address-cells':
+        const: 1
+      '#size-cells':
+        const: 0
+
+    patternProperties:
+      ^port@[0-1]$:
+        type: object
+        description: ICSSG PRUETH external ports
+
+        $ref: ethernet-controller.yaml#
+
+        unevaluatedProperties: false
+        additionalProperties: true
+        properties:
+          reg:
+            items:
+              - enum: [0, 1]
+            description: ICSSG PRUETH port number
+
+          ti,syscon-rgmii-delay:
+            $ref: /schemas/types.yaml#/definitions/phandle-array
+            description:
+              phandle to system controller node and register offset
+              to ICSSG control register for RGMII transmit delay
+
+        required:
+          - reg
+
+  ti,mii-g-rt:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: |
+      phandle to MII_G_RT module's syscon regmap.
+
+  ti,mii-rt:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: |
+      phandle to MII_RT module's syscon regmap
+
+  interrupts:
+    minItems: 2
+    maxItems: 2
+    description: |
+      Interrupt specifiers to TX timestamp IRQ.
+
+  interrupt-names:
+    items:
+      - const: tx_ts0
+      - const: tx_ts1
+
+required:
+  - compatible
+  - sram
+  - ti,mii-g-rt
+  - dmas
+  - dma-names
+  - ethernet-ports
+  - interrupts
+  - interrupt-names
+
+unevaluatedProperties: false
+
+examples:
+  - |
+
+    /* Example k3-am654 base board SR2.0, dual-emac */
+    pruss2_eth: pruss2_eth {
+            compatible = "ti,am654-icssg-prueth";
+            pinctrl-names = "default";
+            pinctrl-0 = <&icssg2_rgmii_pins_default>;
+            sram = <&msmc_ram>;
+
+            ti,prus = <&pru2_0>, <&rtu2_0>, <&tx_pru2_0>, <&pru2_1>, <&rtu2_1>, <&tx_pru2_1>;
+            firmware-name = "ti-pruss/am65x-pru0-prueth-fw.elf",
+                            "ti-pruss/am65x-rtu0-prueth-fw.elf",
+                            "ti-pruss/am65x-txpru0-prueth-fw.elf",
+                            "ti-pruss/am65x-pru1-prueth-fw.elf",
+                            "ti-pruss/am65x-rtu1-prueth-fw.elf",
+                            "ti-pruss/am65x-txpru1-prueth-fw.elf";
+            ti,pruss-gp-mux-sel = <2>,      /* MII mode */
+                                  <2>,
+                                  <2>,
+                                  <2>,      /* MII mode */
+                                  <2>,
+                                  <2>;
+            ti,mii-g-rt = <&icssg2_mii_g_rt>;
+            dmas = <&main_udmap 0xc300>, /* egress slice 0 */
+                   <&main_udmap 0xc301>, /* egress slice 0 */
+                   <&main_udmap 0xc302>, /* egress slice 0 */
+                   <&main_udmap 0xc303>, /* egress slice 0 */
+                   <&main_udmap 0xc304>, /* egress slice 1 */
+                   <&main_udmap 0xc305>, /* egress slice 1 */
+                   <&main_udmap 0xc306>, /* egress slice 1 */
+                   <&main_udmap 0xc307>, /* egress slice 1 */
+                   <&main_udmap 0x4300>, /* ingress slice 0 */
+                   <&main_udmap 0x4301>; /* ingress slice 1 */
+            dma-names = "tx0-0", "tx0-1", "tx0-2", "tx0-3",
+                        "tx1-0", "tx1-1", "tx1-2", "tx1-3",
+                        "rx0", "rx1";
+            interrupts = <24 0 2>, <25 1 3>;
+            interrupt-names = "tx_ts0", "tx_ts1";
+            ethernet-ports {
+                    #address-cells = <1>;
+                    #size-cells = <0>;
+                    pruss2_emac0: port@0 {
+                            reg = <0>;
+                            phy-handle = <&pruss2_eth0_phy>;
+                            phy-mode = "rgmii-rxid";
+                            interrupts-extended = <&icssg2_intc 24>;
+                            ti,syscon-rgmii-delay = <&scm_conf 0x4120>;
+                            /* Filled in by bootloader */
+                            local-mac-address = [00 00 00 00 00 00];
+                    };
+
+                    pruss2_emac1: port@1 {
+                            reg = <1>;
+                            phy-handle = <&pruss2_eth1_phy>;
+                            phy-mode = "rgmii-rxid";
+                            interrupts-extended = <&icssg2_intc 25>;
+                            ti,syscon-rgmii-delay = <&scm_conf 0x4124>;
+                            /* Filled in by bootloader */
+                            local-mac-address = [00 00 00 00 00 00];
+                    };
+            };
+    };
-- 
2.17.1