diff mbox series

[v3,1/5] dt-bindings: net: Add ICSS IEP

Message ID 20230809114906.21866-2-danishanwar@ti.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series Introduce IEP driver and packet timestamping support | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 9 this patch: 9
netdev/cc_maintainers success CCed 10 of 10 maintainers
netdev/build_clang success Errors and warnings before: 9 this patch: 9
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 9 this patch: 9
netdev/checkpatch warning WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

MD Danish Anwar Aug. 9, 2023, 11:49 a.m. UTC
Add DT binding documentation for ICSS IEP module.

Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
---
 .../devicetree/bindings/net/ti,icss-iep.yaml  | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/ti,icss-iep.yaml

Comments

Conor Dooley Aug. 9, 2023, 9:37 p.m. UTC | #1
Hey,

On Wed, Aug 09, 2023 at 05:19:02PM +0530, MD Danish Anwar wrote:
> Add DT binding documentation for ICSS IEP module.
> 
> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
> ---
>  .../devicetree/bindings/net/ti,icss-iep.yaml  | 37 +++++++++++++++++++
>  1 file changed, 37 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> new file mode 100644
> index 000000000000..adae240cfd53
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> @@ -0,0 +1,37 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/ti,icss-iep.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments ICSS Industrial Ethernet Peripheral (IEP) module

Does the module here refer to the hw component or to the linux kernel
module?

> +
> +maintainers:
> +  - Md Danish Anwar <danishanwar@ti.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ti,am654-icss-iep   # for all TI K3 SoCs

*sigh* Please at least give me a chance to reply to the conversation on
the previous versions of the series before sending more, that's the
second time with this series :/
Right now this looks worse to me than what we started with given the
comment is even broader. I have not changed my mind re: what I said on
the previous version.

Thanks,
Conor.

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +    description: phandle to the IEP source clock
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    icssg0_iep0: iep@2e000 {
> +        compatible = "ti,am654-icss-iep";
> +        reg = <0x2e000 0x1000>;
> +        clocks = <&icssg0_iepclk_mux>;
> +    };
> -- 
> 2.34.1
>
Anwar, Md Danish Aug. 10, 2023, 9:53 a.m. UTC | #2
Hi Conor,

On 10/08/23 3:07 am, Conor Dooley wrote:
> Hey,
> 
> On Wed, Aug 09, 2023 at 05:19:02PM +0530, MD Danish Anwar wrote:
>> Add DT binding documentation for ICSS IEP module.
>>
>> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
>> ---
>>  .../devicetree/bindings/net/ti,icss-iep.yaml  | 37 +++++++++++++++++++
>>  1 file changed, 37 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> new file mode 100644
>> index 000000000000..adae240cfd53
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>> @@ -0,0 +1,37 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/net/ti,icss-iep.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Texas Instruments ICSS Industrial Ethernet Peripheral (IEP) module
> 
> Does the module here refer to the hw component or to the linux kernel
> module?
> 

The module here refers to the hardware component.

>> +
>> +maintainers:
>> +  - Md Danish Anwar <danishanwar@ti.com>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,am654-icss-iep   # for all TI K3 SoCs
> 
> *sigh* Please at least give me a chance to reply to the conversation on
> the previous versions of the series before sending more, that's the
> second time with this series :/

My bad, I should have waited for your response. I will hold on posting next
version until your response is received.

> Right now this looks worse to me than what we started with given the
> comment is even broader. I have not changed my mind re: what I said on
> the previous version.
> 

OK, so in the previous version [1] your reply was to have specific compatibles
as bindings with "ti-am654-icss-iep" as a fall back. I will go with this only.

Does the below looks good to you? Here "ti,am642-icss-iep" and
"ti,j721e-icss-iep" are different compatibles for different SoCs where as
"ti,am654-icss-iep" is the fall back. Compatible "ti,am654-icss-iep" will go in
the driver.

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - ti,am642-icss-iep
              - ti,j721e-icss-iep
          - const: ti,am654-icss-iep

      - items:
          - const: ti,am654-icss-iep

examples:
  - |

    /* AM65x */
    icssg0_iep0: iep@2e000 {
        compatible = "ti,am654-icss-iep";
        reg = <0x2e000 0x1000>;
        clocks = <&icssg0_iepclk_mux>;
    };

    /* J721E */
    icssg0_iep0: iep@2f000 {
        compatible = "ti,j721e-icss-iep","ti,am654-icss-iep";
        reg = <0x2e000 0x1000>;
        clocks = <&icssg0_iepclk_mux>;
    };


    /* AM64x */
    icssg0_iep0: iep@2b000 {
        compatible = "ti,am642-icss-iep", "ti,am654-icss-iep";
        reg = <0x2e000 0x1000>;
        clocks = <&icssg0_iepclk_mux>;
    };


Please let me know if the compatible property and the example looks OK to you.
Also please let me know if some other change is required. I will send next
revision after your confirmation.

> Thanks,
> Conor.
> 
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    maxItems: 1
>> +    description: phandle to the IEP source clock
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    icssg0_iep0: iep@2e000 {
>> +        compatible = "ti,am654-icss-iep";
>> +        reg = <0x2e000 0x1000>;
>> +        clocks = <&icssg0_iepclk_mux>;
>> +    };
>> -- 
>> 2.34.1
>>

[1] https://lore.kernel.org/all/20230808-nutmeg-mashing-543b41e56aa1@spud/
Conor Dooley Aug. 10, 2023, 12:52 p.m. UTC | #3
On Thu, Aug 10, 2023 at 03:23:11PM +0530, Md Danish Anwar wrote:
> On 10/08/23 3:07 am, Conor Dooley wrote:
> > On Wed, Aug 09, 2023 at 05:19:02PM +0530, MD Danish Anwar wrote:
> >> Add DT binding documentation for ICSS IEP module.
> >>
> >> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
> >> ---
> >>  .../devicetree/bindings/net/ti,icss-iep.yaml  | 37 +++++++++++++++++++
> >>  1 file changed, 37 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> >>
> >> diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> >> new file mode 100644
> >> index 000000000000..adae240cfd53
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
> >> @@ -0,0 +1,37 @@
> >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> >> +%YAML 1.2
> >> +---
> >> +$id: http://devicetree.org/schemas/net/ti,icss-iep.yaml#
> >> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >> +
> >> +title: Texas Instruments ICSS Industrial Ethernet Peripheral (IEP) module
> > 
> > Does the module here refer to the hw component or to the linux kernel
> > module?
> > 
> 
> The module here refers to the hardware component.

Sweet, thanks.

> >> +
> >> +maintainers:
> >> +  - Md Danish Anwar <danishanwar@ti.com>
> >> +
> >> +properties:
> >> +  compatible:
> >> +    enum:
> >> +      - ti,am654-icss-iep   # for all TI K3 SoCs
> > 
> > *sigh* Please at least give me a chance to reply to the conversation on
> > the previous versions of the series before sending more, that's the
> > second time with this series :/
> 
> My bad, I should have waited for your response. I will hold on posting next
> version until your response is received.
> 
> > Right now this looks worse to me than what we started with given the
> > comment is even broader. I have not changed my mind re: what I said on
> > the previous version.
> > 
> 
> OK, so in the previous version [1] your reply was to have specific compatibles
> as bindings with "ti-am654-icss-iep" as a fall back. I will go with this only.
> 
> Does the below looks good to you? Here "ti,am642-icss-iep" and
> "ti,j721e-icss-iep" are different compatibles for different SoCs where as
> "ti,am654-icss-iep" is the fall back. Compatible "ti,am654-icss-iep" will go in
> the driver.
> 
> properties:
>   compatible:
>     oneOf:
>       - items:
>           - enum:
>               - ti,am642-icss-iep
>               - ti,j721e-icss-iep
>           - const: ti,am654-icss-iep
> 
>       - items:
>           - const: ti,am654-icss-iep

This one doesn't need to be an items list, since there is only one item.
It should be able to just be const:. I much prefer this approach.

Thanks,
Conor.
Anwar, Md Danish Aug. 10, 2023, 12:57 p.m. UTC | #4
On 10/08/23 6:22 pm, Conor Dooley wrote:
> On Thu, Aug 10, 2023 at 03:23:11PM +0530, Md Danish Anwar wrote:
>> On 10/08/23 3:07 am, Conor Dooley wrote:
>>> On Wed, Aug 09, 2023 at 05:19:02PM +0530, MD Danish Anwar wrote:
>>>> Add DT binding documentation for ICSS IEP module.
>>>>
>>>> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
>>>> ---
>>>>  .../devicetree/bindings/net/ti,icss-iep.yaml  | 37 +++++++++++++++++++
>>>>  1 file changed, 37 insertions(+)
>>>>  create mode 100644 Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>>>> new file mode 100644
>>>> index 000000000000..adae240cfd53
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
>>>> @@ -0,0 +1,37 @@
>>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/net/ti,icss-iep.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: Texas Instruments ICSS Industrial Ethernet Peripheral (IEP) module
>>>
>>> Does the module here refer to the hw component or to the linux kernel
>>> module?
>>>
>>
>> The module here refers to the hardware component.
> 
> Sweet, thanks.
> 
>>>> +
>>>> +maintainers:
>>>> +  - Md Danish Anwar <danishanwar@ti.com>
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    enum:
>>>> +      - ti,am654-icss-iep   # for all TI K3 SoCs
>>>
>>> *sigh* Please at least give me a chance to reply to the conversation on
>>> the previous versions of the series before sending more, that's the
>>> second time with this series :/
>>
>> My bad, I should have waited for your response. I will hold on posting next
>> version until your response is received.
>>
>>> Right now this looks worse to me than what we started with given the
>>> comment is even broader. I have not changed my mind re: what I said on
>>> the previous version.
>>>
>>
>> OK, so in the previous version [1] your reply was to have specific compatibles
>> as bindings with "ti-am654-icss-iep" as a fall back. I will go with this only.
>>
>> Does the below looks good to you? Here "ti,am642-icss-iep" and
>> "ti,j721e-icss-iep" are different compatibles for different SoCs where as
>> "ti,am654-icss-iep" is the fall back. Compatible "ti,am654-icss-iep" will go in
>> the driver.
>>
>> properties:
>>   compatible:
>>     oneOf:
>>       - items:
>>           - enum:
>>               - ti,am642-icss-iep
>>               - ti,j721e-icss-iep
>>           - const: ti,am654-icss-iep
>>
>>       - items:
>>           - const: ti,am654-icss-iep
> 
> This one doesn't need to be an items list, since there is only one item.
> It should be able to just be const:. I much prefer this approach.
> 
> Thanks,
> Conor.

Sure Conor, I will remove items from the last one and make it just const like
below. Please let me know if this is ok.

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - ti,am642-icss-iep
              - ti,j721e-icss-iep
          - const: ti,am654-icss-iep

      - const: ti,am654-icss-iep
Conor Dooley Aug. 10, 2023, 1:05 p.m. UTC | #5
On Thu, Aug 10, 2023 at 06:27:22PM +0530, Md Danish Anwar wrote:
> 
> Sure Conor, I will remove items from the last one and make it just const like
> below. Please let me know if this is ok.

Yeah, that looks okay to me, thanks.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/ti,icss-iep.yaml b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
new file mode 100644
index 000000000000..adae240cfd53
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/ti,icss-iep.yaml
@@ -0,0 +1,37 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/ti,icss-iep.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments ICSS Industrial Ethernet Peripheral (IEP) module
+
+maintainers:
+  - Md Danish Anwar <danishanwar@ti.com>
+
+properties:
+  compatible:
+    enum:
+      - ti,am654-icss-iep   # for all TI K3 SoCs
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+    description: phandle to the IEP source clock
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    icssg0_iep0: iep@2e000 {
+        compatible = "ti,am654-icss-iep";
+        reg = <0x2e000 0x1000>;
+        clocks = <&icssg0_iepclk_mux>;
+    };