diff mbox series

[RFC,net-next] dt-bindings: net: xilinx: document xilinx emaclite driver binding

Message ID 1652373596-5994-1-git-send-email-radhey.shyam.pandey@xilinx.com (mailing list archive)
State RFC
Delegated to: Netdev Maintainers
Headers show
Series [RFC,net-next] dt-bindings: net: xilinx: document xilinx emaclite driver binding | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers success CCed 10 of 10 maintainers
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
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

Radhey Shyam Pandey May 12, 2022, 4:39 p.m. UTC 
Add basic description for the xilinx emaclite driver DT bindings.

Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
---
 .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/xlnx,emaclite.yaml

Comments

Krzysztof Kozlowski May 13, 2022, 8:52 a.m. UTC | #1 
On 12/05/2022 18:39, Radhey Shyam Pandey wrote:
> Add basic description for the xilinx emaclite driver DT bindings.
> 
> Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> ---
>  .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/xlnx,emaclite.yaml

Why is this RFC? Do you expect DT maintainers review or not? Maybe there
is no point for us to review something which is not going to be applied?

> 
> diff --git a/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> new file mode 100644
> index 000000000000..a3e2a0e89b24
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> @@ -0,0 +1,60 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/xlnx,emaclite.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx Emaclite Ethernet controller
> +
> +maintainers:
> +  - Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> +  - Harini Katakam <harini.katakam@xilinx.com>
> +

You should include ethernet controller schema.

> +properties:
> +  compatible:
> +    enum:
> +      - xlnx,opb-ethernetlite-1.01.a
> +      - xlnx,opb-ethernetlite-1.01.b
> +      - xlnx,xps-ethernetlite-1.00.a
> +      - xlnx,xps-ethernetlite-2.00.a
> +      - xlnx,xps-ethernetlite-2.01.a
> +      - xlnx,xps-ethernetlite-3.00.a
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  phy-handle: true
> +
> +  local-mac-address: true
> +
> +  xlnx,tx-ping-pong:
> +    type: boolean
> +    description: hardware supports tx ping pong buffer.
> +
> +  xlnx,rx-ping-pong:
> +    type: boolean
> +    description: hardware supports rx ping pong buffer.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - phy-handle
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    axi_ethernetlite_1: ethernet@40e00000 {
> +            compatible = "xlnx,xps-ethernetlite-3.00.a";

4-space indentation for DTS, please.

> +            interrupt-parent = <&axi_intc_1>;
> +            interrupts = <1 0>;
> +            local-mac-address = [00 0a 35 00 00 00];
> +            phy-handle = <&phy0>;
> +            reg = <0x40e00000 0x10000>;
> +            xlnx,rx-ping-pong;
> +            xlnx,tx-ping-pong;
> +    };


Best regards,
Krzysztof
Rob Herring (Arm) May 18, 2022, 12:32 a.m. UTC | #2 
On Thu, May 12, 2022 at 10:09:56PM +0530, Radhey Shyam Pandey wrote:
> Add basic description for the xilinx emaclite driver DT bindings.
> 
> Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> ---
>  .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> new file mode 100644
> index 000000000000..a3e2a0e89b24
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> @@ -0,0 +1,60 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/xlnx,emaclite.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx Emaclite Ethernet controller
> +
> +maintainers:
> +  - Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> +  - Harini Katakam <harini.katakam@xilinx.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - xlnx,opb-ethernetlite-1.01.a
> +      - xlnx,opb-ethernetlite-1.01.b
> +      - xlnx,xps-ethernetlite-1.00.a
> +      - xlnx,xps-ethernetlite-2.00.a
> +      - xlnx,xps-ethernetlite-2.01.a
> +      - xlnx,xps-ethernetlite-3.00.a
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  phy-handle: true
> +
> +  local-mac-address: true
> +
> +  xlnx,tx-ping-pong:
> +    type: boolean
> +    description: hardware supports tx ping pong buffer.
> +
> +  xlnx,rx-ping-pong:
> +    type: boolean
> +    description: hardware supports rx ping pong buffer.

Are these based on IP version or configuration of IP?

Rob
Radhey Shyam Pandey May 18, 2022, 3:47 p.m. UTC | #3 
> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Friday, May 13, 2022 2:23 PM
> To: Radhey Shyam Pandey <radheys@xilinx.com>; davem@davemloft.net;
> edumazet@google.com; kuba@kernel.org; pabeni@redhat.com;
> robh+dt@kernel.org; krzysztof.kozlowski+dt@linaro.org; Harini Katakam
> <harinik@xilinx.com>
> Cc: netdev@vger.kernel.org; devicetree@vger.kernel.org; linux-
> kernel@vger.kernel.org; git <git@xilinx.com>
> Subject: Re: [RFC net-next] dt-bindings: net: xilinx: document xilinx emaclite
> driver binding
> 
> On 12/05/2022 18:39, Radhey Shyam Pandey wrote:
> > Add basic description for the xilinx emaclite driver DT bindings.
> >
> > Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> > ---
> >  .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
> >  1 file changed, 60 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> 
> Why is this RFC? Do you expect DT maintainers review or not? Maybe there is
> no point for us to review something which is not going to be applied?

I intentionally made it RFC so that all aspects are reviewed as this driver didn't
had an existing binding. I will send out next version with below comment 
addressed. Thanks!
> 
> >
> > diff --git a/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > new file mode 100644
> > index 000000000000..a3e2a0e89b24
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > @@ -0,0 +1,60 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/xlnx,emaclite.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx Emaclite Ethernet controller
> > +
> > +maintainers:
> > +  - Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> > +  - Harini Katakam <harini.katakam@xilinx.com>
> > +
> 
> You should include ethernet controller schema.
> 
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - xlnx,opb-ethernetlite-1.01.a
> > +      - xlnx,opb-ethernetlite-1.01.b
> > +      - xlnx,xps-ethernetlite-1.00.a
> > +      - xlnx,xps-ethernetlite-2.00.a
> > +      - xlnx,xps-ethernetlite-2.01.a
> > +      - xlnx,xps-ethernetlite-3.00.a
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  phy-handle: true
> > +
> > +  local-mac-address: true
> > +
> > +  xlnx,tx-ping-pong:
> > +    type: boolean
> > +    description: hardware supports tx ping pong buffer.
> > +
> > +  xlnx,rx-ping-pong:
> > +    type: boolean
> > +    description: hardware supports rx ping pong buffer.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - phy-handle
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    axi_ethernetlite_1: ethernet@40e00000 {
> > +            compatible = "xlnx,xps-ethernetlite-3.00.a";
> 
> 4-space indentation for DTS, please.
> 
> > +            interrupt-parent = <&axi_intc_1>;
> > +            interrupts = <1 0>;
> > +            local-mac-address = [00 0a 35 00 00 00];
> > +            phy-handle = <&phy0>;
> > +            reg = <0x40e00000 0x10000>;
> > +            xlnx,rx-ping-pong;
> > +            xlnx,tx-ping-pong;
> > +    };
> 
> 
> Best regards,
> Krzysztof
Radhey Shyam Pandey May 18, 2022, 3:51 p.m. UTC | #4 
> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Wednesday, May 18, 2022 6:03 AM
> To: Radhey Shyam Pandey <radheys@xilinx.com>
> Cc: davem@davemloft.net; edumazet@google.com; kuba@kernel.org;
> pabeni@redhat.com; krzysztof.kozlowski+dt@linaro.org; Harini Katakam
> <harinik@xilinx.com>; netdev@vger.kernel.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org; git <git@xilinx.com>
> Subject: Re: [RFC net-next] dt-bindings: net: xilinx: document xilinx emaclite
> driver binding
> 
> On Thu, May 12, 2022 at 10:09:56PM +0530, Radhey Shyam Pandey wrote:
> > Add basic description for the xilinx emaclite driver DT bindings.
> >
> > Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> > ---
> >  .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
> >  1 file changed, 60 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > new file mode 100644
> > index 000000000000..a3e2a0e89b24
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
> > @@ -0,0 +1,60 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/xlnx,emaclite.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx Emaclite Ethernet controller
> > +
> > +maintainers:
> > +  - Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
> > +  - Harini Katakam <harini.katakam@xilinx.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - xlnx,opb-ethernetlite-1.01.a
> > +      - xlnx,opb-ethernetlite-1.01.b
> > +      - xlnx,xps-ethernetlite-1.00.a
> > +      - xlnx,xps-ethernetlite-2.00.a
> > +      - xlnx,xps-ethernetlite-2.01.a
> > +      - xlnx,xps-ethernetlite-3.00.a
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  phy-handle: true
> > +
> > +  local-mac-address: true
> > +
> > +  xlnx,tx-ping-pong:
> > +    type: boolean
> > +    description: hardware supports tx ping pong buffer.
> > +
> > +  xlnx,rx-ping-pong:
> > +    type: boolean
> > +    description: hardware supports rx ping pong buffer.
> 
> Are these based on IP version or configuration of IP?

These properties doesn't depend on IP version and are 
related to IP configuration.
 
> 
> Rob
Krzysztof Kozlowski May 19, 2022, 8:06 a.m. UTC | #5 
On 18/05/2022 17:47, Radhey Shyam Pandey wrote:
>> -----Original Message-----
>> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> Sent: Friday, May 13, 2022 2:23 PM
>> To: Radhey Shyam Pandey <radheys@xilinx.com>; davem@davemloft.net;
>> edumazet@google.com; kuba@kernel.org; pabeni@redhat.com;
>> robh+dt@kernel.org; krzysztof.kozlowski+dt@linaro.org; Harini Katakam
>> <harinik@xilinx.com>
>> Cc: netdev@vger.kernel.org; devicetree@vger.kernel.org; linux-
>> kernel@vger.kernel.org; git <git@xilinx.com>
>> Subject: Re: [RFC net-next] dt-bindings: net: xilinx: document xilinx emaclite
>> driver binding
>>
>> On 12/05/2022 18:39, Radhey Shyam Pandey wrote:
>>> Add basic description for the xilinx emaclite driver DT bindings.
>>>
>>> Signed-off-by: Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
>>> ---
>>>  .../bindings/net/xlnx,emaclite.yaml           | 60 +++++++++++++++++++
>>>  1 file changed, 60 insertions(+)
>>>  create mode 100644
>>> Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
>>
>> Why is this RFC? Do you expect DT maintainers review or not? Maybe there is
>> no point for us to review something which is not going to be applied?
> 
> I intentionally made it RFC so that all aspects are reviewed as this driver didn't
> had an existing binding. I will send out next version with below comment 
> addressed. Thanks!

RFC means you develop something which is not ready, not sure how to do
it, you send an initial idea. Sending a regular bindings as RFC, without
explaining what you expect, is a bit confusing.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
new file mode 100644
index 000000000000..a3e2a0e89b24
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/xlnx,emaclite.yaml
@@ -0,0 +1,60 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/xlnx,emaclite.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx Emaclite Ethernet controller
+
+maintainers:
+  - Radhey Shyam Pandey <radhey.shyam.pandey@xilinx.com>
+  - Harini Katakam <harini.katakam@xilinx.com>
+
+properties:
+  compatible:
+    enum:
+      - xlnx,opb-ethernetlite-1.01.a
+      - xlnx,opb-ethernetlite-1.01.b
+      - xlnx,xps-ethernetlite-1.00.a
+      - xlnx,xps-ethernetlite-2.00.a
+      - xlnx,xps-ethernetlite-2.01.a
+      - xlnx,xps-ethernetlite-3.00.a
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  phy-handle: true
+
+  local-mac-address: true
+
+  xlnx,tx-ping-pong:
+    type: boolean
+    description: hardware supports tx ping pong buffer.
+
+  xlnx,rx-ping-pong:
+    type: boolean
+    description: hardware supports rx ping pong buffer.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - phy-handle
+
+additionalProperties: false
+
+examples:
+  - |
+    axi_ethernetlite_1: ethernet@40e00000 {
+            compatible = "xlnx,xps-ethernetlite-3.00.a";
+            interrupt-parent = <&axi_intc_1>;
+            interrupts = <1 0>;
+            local-mac-address = [00 0a 35 00 00 00];
+            phy-handle = <&phy0>;
+            reg = <0x40e00000 0x10000>;
+            xlnx,rx-ping-pong;
+            xlnx,tx-ping-pong;
+    };