Re: [PATCH net-next v6 01/11] dt-bindings: net: ti: Adds DUAL-EMAC mode support on PRU-ICSS2 for AM57xx, AM43xx and AM33xx SOCs

[Parvathi Pudi <parvathi@couthit.com>]

Hi,

> On Wed, Apr 23, 2025 at 11:36:57AM +0530, Parvathi Pudi wrote:
>> Documentation update for the newly added "pruss2_eth" device tree
>> node and its dependencies along with compatibility for PRU-ICSS
>> Industrial Ethernet Peripheral (IEP), PRU-ICSS Enhanced Capture
>> (eCAP) peripheral and using YAML binding document for AM57xx SoCs.
>> 
>> Co-developed-by: Basharath Hussain Khaja <basharath@couthit.com>
>> Signed-off-by: Basharath Hussain Khaja <basharath@couthit.com>
>> Signed-off-by: Parvathi Pudi <parvathi@couthit.com>
>> ---
>>  .../devicetree/bindings/net/ti,icss-iep.yaml  |  10 +-
>>  .../bindings/net/ti,icssm-prueth.yaml         | 233 ++++++++++++++++++
>>  .../bindings/net/ti,pruss-ecap.yaml           |  32 +++
>>  .../devicetree/bindings/soc/ti/ti,pruss.yaml  |   9 +
>>  4 files changed, 281 insertions(+), 3 deletions(-)
>>  create mode 100644 Documentation/devicetree/bindings/net/ti,icssm-prueth.yaml
>>  create mode 100644 Documentation/devicetree/bindings/net/ti,pruss-ecap.yaml
>> 
>> diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> index e36e3a622904..ea2659d90a52 100644
>> --- a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> +++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> @@ -8,6 +8,8 @@ title: Texas Instruments ICSS Industrial Ethernet Peripheral
>> (IEP) module
>>  
>>  maintainers:
>>    - Md Danish Anwar <danishanwar@ti.com>
>> +  - Parvathi Pudi <parvathi@couthit.com>
>> +  - Basharath Hussain Khaja <basharath@couthit.com>
>>  
>>  properties:
>>    compatible:
>> @@ -17,9 +19,11 @@ properties:
>>                - ti,am642-icss-iep
>>                - ti,j721e-icss-iep
>>            - const: ti,am654-icss-iep
>> -
>> -      - const: ti,am654-icss-iep
>> -
>> +      - enum:
>> +          - ti,am654-icss-iep
>> +          - ti,am5728-icss-iep
>> +          - ti,am4376-icss-iep
>> +          - ti,am3356-icss-iep
>>  
>>    reg:
>>      maxItems: 1
>> diff --git a/Documentation/devicetree/bindings/net/ti,icssm-prueth.yaml
>> b/Documentation/devicetree/bindings/net/ti,icssm-prueth.yaml
>> new file mode 100644
>> index 000000000000..d42aea70eb76
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/ti,icssm-prueth.yaml
>> @@ -0,0 +1,233 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/net/ti,icssm-prueth.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Texas Instruments ICSSM PRUSS Ethernet
>> +
>> +maintainers:
>> +  - Roger Quadros <rogerq@ti.com>
>> +  - Andrew F. Davis <afd@ti.com>
>> +  - Parvathi Pudi <parvathi@couthit.com>
>> +  - Basharath Hussain Khaja <basharath@couthit.com>
>> +
>> +description:
>> +  Ethernet based on the Programmable Real-Time Unit and Industrial
>> +  Communication Subsystem.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,am57-prueth     # for AM57x SoC family
>> +      - ti,am4376-prueth   # for AM43x SoC family
>> +      - ti,am3359-prueth   # for AM33x SoC family
>> +
>> +  sram:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description:
>> +      phandle to OCMC SRAM node
>> +
>> +  ti,mii-rt:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description:
>> +      phandle to MII_RT module's syscon regmap
> 
> regmap is a Linuxism. Say what functionality you need from this block.
> 

Sure, we will update the documentation in the next version.

>> +
>> +  ti,iep:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description:
>> +      phandle to IEP (Industrial Ethernet Peripheral) for ICSS
>> +
>> +  ti,ecap:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description:
>> +      phandle to Enhanced Capture (eCAP) event for ICSS
>> +
>> +  interrupts:
>> +    items:
>> +      - description: High priority Rx Interrupt specifier.
>> +      - description: Low priority Rx Interrupt specifier.
>> +
>> +  interrupt-names:
>> +    items:
>> +      - const: rx_hp
>> +      - const: rx_lp
>> +
>> +  ethernet-ports:
>> +    type: object
>> +    additionalProperties: false
>> +
>> +    properties:
>> +      '#address-cells':
>> +        const: 1
>> +      '#size-cells':
>> +        const: 0
>> +
>> +    patternProperties:
>> +      ^ethernet-port@[0-1]$:
>> +        type: object
>> +        description: ICSSM PRUETH external ports
>> +        $ref: ethernet-controller.yaml#
>> +        unevaluatedProperties: false
>> +
>> +        properties:
>> +          reg:
>> +            items:
>> +              - enum: [0, 1]
>> +            description: ICSSM PRUETH port number
>> +
>> +          interrupts:
>> +            maxItems: 3
>> +
>> +          interrupt-names:
>> +            items:
>> +              - const: rx
>> +              - const: emac_ptp_tx
>> +              - const: hsr_ptp_tx
>> +
>> +        required:
>> +          - reg
>> +
>> +    anyOf:
>> +      - required:
>> +          - ethernet-port@0
>> +      - required:
>> +          - ethernet-port@1
>> +
>> +required:
>> +  - compatible
>> +  - sram
>> +  - ti,mii-rt
>> +  - ti,iep
>> +  - ti,ecap
>> +  - ethernet-ports
>> +  - interrupts
>> +  - interrupt-names
>> +
>> +allOf:
>> +  - $ref: /schemas/remoteproc/ti,pru-consumer.yaml#
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    /* Dual-MAC Ethernet application node on PRU-ICSS2 */
>> +    pruss2_eth: pruss2-eth {
> 
> Drop unused labels.
> 

"pruss2_eth" label is the primary node of the PRU-ICSS2 and
PRUETH driver is referring to this label. A name followed by a
label is required. Do we need to rename "pruss2-eth" to any
other? if we try to remove the name, we expected to see a
syntax error.

>> +      compatible = "ti,am57-prueth";
>> +      ti,prus = <&pru2_0>, <&pru2_1>;
>> +      sram = <&ocmcram1>;
>> +      ti,mii-rt = <&pruss2_mii_rt>;
>> +      ti,iep = <&pruss2_iep>;
>> +      ti,ecap = <&pruss2_ecap>;
>> +      interrupts = <20 2 2>, <21 3 3>;
>> +      interrupt-names = "rx_hp", "rx_lp";
>> +      interrupt-parent = <&pruss2_intc>;
>> +
>> +      ethernet-ports {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +        pruss2_emac0: ethernet-port@0 {
>> +          reg = <0>;
>> +          phy-handle = <&pruss2_eth0_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <20 2 2>, <26 6 6>, <23 6 6>;
>> +          interrupt-names = "rx", "emac_ptp_tx", "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +
>> +        pruss2_emac1: ethernet-port@1 {
>> +          reg = <1>;
>> +          phy-handle = <&pruss2_eth1_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <21 3 3>, <27 9 7>, <24 9 7>;
>> +          interrupt-names = "rx", "emac_ptp_tx", "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +      };
>> +    };
>> +  - |
>> +    /* Dual-MAC Ethernet application node on PRU-ICSS1 */
>> +    pruss1_eth: pruss1-eth {
>> +      compatible = "ti,am4376-prueth";
>> +      ti,prus = <&pru1_0>, <&pru1_1>;
>> +      sram = <&ocmcram>;
>> +      ti,mii-rt = <&pruss1_mii_rt>;
>> +      ti,iep = <&pruss1_iep>;
>> +      ti,ecap = <&pruss1_ecap>;
>> +      interrupts = <20 2 2>, <21 3 3>;
>> +      interrupt-names = "rx_hp", "rx_lp";
>> +      interrupt-parent = <&pruss1_intc>;
>> +
>> +      pinctrl-0 = <&pruss1_eth_default>;
>> +      pinctrl-names = "default";
>> +
>> +      ethernet-ports {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +        pruss1_emac0: ethernet-port@0 {
>> +          reg = <0>;
>> +          phy-handle = <&pruss1_eth0_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <20 2 2>, <26 6 6>, <23 6 6>;
>> +          interrupt-names = "rx", "emac_ptp_tx",
>> +                                          "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +
>> +        pruss1_emac1: ethernet-port@1 {
>> +          reg = <1>;
>> +          phy-handle = <&pruss1_eth1_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <21 3 3>, <27 9 7>, <24 9 7>;
>> +          interrupt-names = "rx", "emac_ptp_tx",
>> +                                          "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +      };
>> +    };
>> +  - |
>> +    /* Dual-MAC Ethernet application node on PRU-ICSS */
>> +    pruss_eth: pruss-eth {
> 
> Really need 3 examples?
> 

We included these examples to differentiate between three series
of devices (AM335x, AM437x and AM57xx) with same architecture
for PRU-ICSS but differences in number of instances, local
interrupt controller mapping, size, offset differences and etc. 

>> +      compatible = "ti,am3359-prueth";
>> +      ti,prus = <&pru0>, <&pru1>;
>> +      sram = <&ocmcram>;
>> +      ti,mii-rt = <&pruss_mii_rt>;
>> +      ti,iep = <&pruss_iep>;
>> +      ti,ecap = <&pruss_ecap>;
>> +      interrupts = <20 2 2>, <21 3 3>;
>> +      interrupt-names = "rx_hp", "rx_lp";
>> +      interrupt-parent = <&pruss_intc>;
>> +
>> +      pinctrl-0 = <&pruss_eth_default>;
>> +      pinctrl-names = "default";
>> +
>> +      ethernet-ports {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +        pruss_emac0: ethernet-port@0 {
>> +          reg = <0>;
>> +          phy-handle = <&pruss_eth0_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <20 2 2>, <26 6 6>, <23 6 6>;
>> +          interrupt-names = "rx", "emac_ptp_tx",
>> +                                          "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +
>> +        pruss_emac1: ethernet-port@1 {
>> +          reg = <1>;
>> +          phy-handle = <&pruss_eth1_phy>;
>> +          phy-mode = "mii";
>> +          interrupts = <21 3 3>, <27 9 7>, <24 9 7>;
>> +          interrupt-names = "rx", "emac_ptp_tx",
>> +                                          "hsr_ptp_tx";
>> +          /* Filled in by bootloader */
>> +          local-mac-address = [00 00 00 00 00 00];
>> +        };
>> +      };
>> +    };
>> diff --git a/Documentation/devicetree/bindings/net/ti,pruss-ecap.yaml
>> b/Documentation/devicetree/bindings/net/ti,pruss-ecap.yaml
>> new file mode 100644
>> index 000000000000..42f217099b2e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/ti,pruss-ecap.yaml
>> @@ -0,0 +1,32 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/net/ti,pruss-ecap.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Texas Instruments PRU-ICSS Enhanced Capture (eCAP) event module
>> +
>> +maintainers:
>> +  - Murali Karicheri <m-karicheri2@ti.com>
>> +  - Parvathi Pudi <parvathi@couthit.com>
>> +  - Basharath Hussain Khaja <basharath@couthit.com>
>> +
>> +properties:
>> +  compatible:
>> +    const: ti,pruss-ecap
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    pruss2_ecap: ecap@30000 {
>> +        compatible = "ti,pruss-ecap";
>> +        reg = <0x30000 0x60>;
>> +    };
>> diff --git a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> index 927b3200e29e..594f54264a8c 100644
>> --- a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> +++ b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> @@ -251,6 +251,15 @@ patternProperties:
>>  
>>      type: object
>>  
>> +  ecap@[a-f0-9]+$:
>> +    description:
>> +      PRU-ICSS has a Enhanced Capture (eCAP) event module which can generate
>> +      and capture periodic timer based events which will be used for features
>> +      like RX Pacing to rise interrupt when the timer event has occurred.
>> +      Each PRU-ICSS instance has one eCAP modeule irrespective of SOCs.
>> +
>> +    type: object
> 
> This should either have a ref to ti,pruss-ecap.yaml or should just move
> reg and compatible here since it is only 2 properties.
> 

We will address this in the next version.

Thanks and Regards,
Parvathi.