diff mbox series

[v2,5/5] dt-bindings: net: ftgmac100: convert to yaml version from txt

Message ID 20230509143504.30382-6-fr0st61te@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series Refactoring for GMA command | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next, async
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: 8 this patch: 8
netdev/cc_maintainers warning 2 maintainers not CCed: ratbert@faraday-tech.com conor+dt@kernel.org
netdev/build_clang success Errors and warnings before: 8 this patch: 8
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: 8 this patch: 8
netdev/checkpatch warning WARNING: DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause) WARNING: Missing commit description - Add an appropriate one 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

Ivan Mikhaylov May 9, 2023, 2:35 p.m. UTC 
Signed-off-by: Ivan Mikhaylov <fr0st61te@gmail.com>
---
 .../bindings/net/faraday,ftgmac100.yaml       | 110 ++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml

Comments

Krzysztof Kozlowski May 10, 2023, 2:50 p.m. UTC | #1 
On 09/05/2023 16:35, Ivan Mikhaylov wrote:
> Signed-off-by: Ivan Mikhaylov <fr0st61te@gmail.com>

Need some commit msg.


> ---
>  .../bindings/net/faraday,ftgmac100.yaml       | 110 ++++++++++++++++++

Missing actual conversion (removal).

>  1 file changed, 110 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> new file mode 100644
> index 000000000000..98cd142f74bb
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> @@ -0,0 +1,110 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual-license, unless you copied some chunks of old binding... but was
there old binding?

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/faraday,ftgmac100.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Faraday Technology FTGMAC100 gigabit ethernet controller
> +
> +allOf:
> +  - $ref: "ethernet-controller.yaml#"

Drop quotes.


> +
> +maintainers:
> +  - Po-Yu Chuang <ratbert@faraday-tech.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: faraday,ftgmac100
> +      - items:
> +          - enum:
> +              - aspeed,ast2400-mac
> +              - aspeed,ast2500-mac
> +              - aspeed,ast2600-mac
> +          - const: faraday,ftgmac100
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    description: |
> +      In accordance with the generic clock bindings.

Drop this part. Obvious.

>  Must describe the MAC
> +      IP clock, and optionally an RMII RCLK gate for the AST2500/AST2600. The
> +      required MAC clock must be the first cell.

The cells depend on clock provider. Do you mean something else?

> +    minItems: 1
> +    maxItems: 2
> +
> +  clock-names:
> +    items:
> +      - enum:
> +          - MACCLK
> +          - RCLK

This does not allow two clocks... List all the items and add minItems: 1.


> +
> +  phy-mode:
> +    enum:
> +      - rgmii
> +      - rmii
> +
> +  phy-handle: true
> +
> +  use-ncsi:
> +    description: |

Do not need '|' unless you need to preserve formatting.

I will stop review, because it depends whether this is true conversion
or new binding.

Best regards,
Krzysztof
Ivan Mikhaylov May 11, 2023, 12:15 a.m. UTC | #2 
On Wed, 2023-05-10 at 16:50 +0200, Krzysztof Kozlowski wrote:
> On 09/05/2023 16:35, Ivan Mikhaylov wrote:
> > Signed-off-by: Ivan Mikhaylov <fr0st61te@gmail.com>
> 
> Need some commit msg.
> 
> 
> > ---
> >  .../bindings/net/faraday,ftgmac100.yaml       | 110
> > ++++++++++++++++++
> 
> Missing actual conversion (removal).
> 
> >  1 file changed, 110 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> > 
> > diff --git
> > a/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> > b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> > new file mode 100644
> > index 000000000000..98cd142f74bb
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
> > @@ -0,0 +1,110 @@
> > +# SPDX-License-Identifier: GPL-2.0
> 
> Dual-license, unless you copied some chunks of old binding... but was
> there old binding?

Krzysztof, I copied a lot from old one ftgmac100.txt.

> 
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/faraday,ftgmac100.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Faraday Technology FTGMAC100 gigabit ethernet controller
> > +
> > +allOf:
> > +  - $ref: "ethernet-controller.yaml#"
> 
> Drop quotes.
> 
> 
> > +
> > +maintainers:
> > +  - Po-Yu Chuang <ratbert@faraday-tech.com>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - const: faraday,ftgmac100
> > +      - items:
> > +          - enum:
> > +              - aspeed,ast2400-mac
> > +              - aspeed,ast2500-mac
> > +              - aspeed,ast2600-mac
> > +          - const: faraday,ftgmac100
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    description: |
> > +      In accordance with the generic clock bindings.
> 
> Drop this part. Obvious.
> 
> >  Must describe the MAC
> > +      IP clock, and optionally an RMII RCLK gate for the
> > AST2500/AST2600. The
> > +      required MAC clock must be the first cell.
> 
> The cells depend on clock provider. Do you mean something else?

It's exactly from ftgmac100.txt, this section without any changes, I
didn't add anything new in the sentence.

> 
> > +    minItems: 1
> > +    maxItems: 2
> > +
> > +  clock-names:
> > +    items:
> > +      - enum:
> > +          - MACCLK
> > +          - RCLK
> 
> This does not allow two clocks... List all the items and add
> minItems: 1.
> 
> 
> > +
> > +  phy-mode:
> > +    enum:
> > +      - rgmii
> > +      - rmii
> > +
> > +  phy-handle: true
> > +
> > +  use-ncsi:
> > +    description: |
> 
> Do not need '|' unless you need to preserve formatting.
> 
> I will stop review, because it depends whether this is true
> conversion
> or new binding.
> 

I've tried to convert it from ftgmac100.txt, everything is same in it
except mac-address-increment option with explanation for which purpose
it there, need I divide conversion from that option or is it fine in
one?

Thanks.
Krzysztof Kozlowski May 11, 2023, 8:39 a.m. UTC | #3 
On 11/05/2023 02:15, Ivan Mikhaylov wrote:
>>> +  phy-mode:
>>> +    enum:
>>> +      - rgmii
>>> +      - rmii
>>> +
>>> +  phy-handle: true
>>> +
>>> +  use-ncsi:
>>> +    description: |
>>
>> Do not need '|' unless you need to preserve formatting.
>>
>> I will stop review, because it depends whether this is true
>> conversion
>> or new binding.
>>
> 
> I've tried to convert it from ftgmac100.txt, everything is same in it
> except mac-address-increment option with explanation for which purpose
> it there, need I divide conversion from that option or is it fine in
> one?

As I wrote at beginning, I don't see conversion here, so difficult to judge.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
new file mode 100644
index 000000000000..98cd142f74bb
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/faraday,ftgmac100.yaml
@@ -0,0 +1,110 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/faraday,ftgmac100.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Faraday Technology FTGMAC100 gigabit ethernet controller
+
+allOf:
+  - $ref: "ethernet-controller.yaml#"
+
+maintainers:
+  - Po-Yu Chuang <ratbert@faraday-tech.com>
+
+properties:
+  compatible:
+    oneOf:
+      - const: faraday,ftgmac100
+      - items:
+          - enum:
+              - aspeed,ast2400-mac
+              - aspeed,ast2500-mac
+              - aspeed,ast2600-mac
+          - const: faraday,ftgmac100
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    description: |
+      In accordance with the generic clock bindings. Must describe the MAC
+      IP clock, and optionally an RMII RCLK gate for the AST2500/AST2600. The
+      required MAC clock must be the first cell.
+    minItems: 1
+    maxItems: 2
+
+  clock-names:
+    items:
+      - enum:
+          - MACCLK
+          - RCLK
+
+  phy-mode:
+    enum:
+      - rgmii
+      - rmii
+
+  phy-handle: true
+
+  use-ncsi:
+    description: |
+      Use the NC-SI stack instead of an MDIO PHY. Currently assumes
+      rmii (100bT) but kept as a separate property in case NC-SI grows support
+      for a gigabit link.
+    type: boolean
+
+  no-hw-checksum:
+    description: |
+      Used to disable HW checksum support. Here for backward
+      compatibility as the driver now should have correct defaults based on
+      the SoC.
+    type: boolean
+
+  mac-address-increment:
+    description: |
+      Increment the MAC address taken by GMA command via  NC-SI. Specifies
+      a signed number to be added to the host MAC address as obtained by
+      the OEM GMA command. If not specified, 1 is used by default for
+      Broadcom and Intel network cards, 0 otherwise.
+
+  mdio:
+    $ref: /schemas/net/mdio.yaml#
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    mac0: ethernet@1e660000 {
+        compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";
+        reg = <0x1e660000 0x180>;
+        interrupts = <2>;
+        use-ncsi;
+    };
+
+    mac1: ethernet@1e680000 {
+        compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";
+        reg = <0x1e680000 0x180>;
+        interrupts = <2>;
+
+        phy-handle = <&phy>;
+        phy-mode = "rgmii";
+
+        mdio {
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            phy: ethernet-phy@1 {
+                compatible = "ethernet-phy-ieee802.3-c22";
+                reg = <1>;
+            };
+        };
+    };