Add documentation to describe StarFive dwmac driver(GMAC).
Signed-off-by: Yanhong Wang <yanhong.wang@starfivetech.com>
---
.../devicetree/bindings/net/snps,dwmac.yaml | 1 +
.../bindings/net/starfive,jh7110-dwmac.yaml | 113 ++++++++++++++++++
MAINTAINERS | 5 +
3 files changed, 119 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml
diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
index baf2c5b9e92d..8b07bc9c8b00 100644
--- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml
+++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
@@ -91,6 +91,7 @@ properties:
- snps,dwmac-5.20
- snps,dwxgmac
- snps,dwxgmac-2.10
+ - starfive,jh7110-dwmac
reg:
minItems: 1
diff --git a/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml
new file mode 100644
index 000000000000..eb0767da834a
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml
@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2022 StarFive Technology Co., Ltd.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/starfive,jh7110-dwmac.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: StarFive JH7110 DWMAC glue layer
+
+maintainers:
+ - Yanhong Wang <yanhong.wang@starfivetech.com>
+
+select:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - starfive,jh7110-dwmac
+ required:
+ - compatible
+
+properties:
+ compatible:
+ items:
+ - enum:
+ - starfive,jh7110-dwmac
+ - const: snps,dwmac-5.20
+
+ clocks:
+ items:
+ - description: GMAC main clock
+ - description: GMAC AHB clock
+ - description: PTP clock
+ - description: TX clock
+ - description: GTXC clock
+ - description: GTX clock
+
+ clock-names:
+ items:
+ - const: stmmaceth
+ - const: pclk
+ - const: ptp_ref
+ - const: tx
+ - const: gtxc
+ - const: gtx
+
+ resets:
+ items:
+ - description: MAC Reset signal.
+ - description: AHB Reset signal.
+
+ reset-names:
+ items:
+ - const: stmmaceth
+ - const: ahb
+
+allOf:
+ - $ref: snps,dwmac.yaml#
+
+unevaluatedProperties: true
+
+required:
+ - compatible
+ - clocks
+ - clock-names
+ - resets
+ - reset-names
+
+examples:
+ - |
+ ethernet@16030000 {
+ compatible = "starfive,jh7110-dwmac", "snps,dwmac-5.20";
+ reg = <0x16030000 0x10000>;
+ clocks = <&clk 3>, <&clk 2>, <&clk 109>,
+ <&clk 5>, <&clk 111>, <&clk 108>;
+ clock-names = "stmmaceth", "pclk", "ptp_ref",
+ "tx", "gtxc", "gtx";
+ resets = <&rst 1>, <&rst 2>;
+ reset-names = "stmmaceth", "ahb";
+ interrupts = <7>, <6>, <5>;
+ interrupt-names = "macirq", "eth_wake_irq", "eth_lpi";
+ phy-mode = "rgmii-id";
+ snps,multicast-filter-bins = <64>;
+ snps,perfect-filter-entries = <8>;
+ rx-fifo-depth = <2048>;
+ tx-fifo-depth = <2048>;
+ snps,fixed-burst;
+ snps,no-pbl-x8;
+ snps,tso;
+ snps,force_thresh_dma_mode;
+ snps,axi-config = <&stmmac_axi_setup>;
+ snps,en-tx-lpi-clockgating;
+ snps,txpbl = <16>;
+ snps,rxpbl = <16>;
+ phy-handle = <&phy0>;
+
+ mdio {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ compatible = "snps,dwmac-mdio";
+
+ phy0: ethernet-phy@0 {
+ reg = <0>;
+ };
+ };
+
+ stmmac_axi_setup: stmmac-axi-config {
+ snps,lpi_en;
+ snps,wr_osr_lmt = <4>;
+ snps,rd_osr_lmt = <4>;
+ snps,blen = <256 128 64 32 0 0 0>;
+ };
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index a70c1d0f303e..56be59bb09f7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -19606,6 +19606,11 @@ F: Documentation/devicetree/bindings/clock/starfive*
F: drivers/clk/starfive/
F: include/dt-bindings/clock/starfive*
+STARFIVE DWMAC GLUE LAYER
+M: Yanhong Wang <yanhong.wang@starfivetech.com>
+S: Maintained
+F: Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml
+
STARFIVE PINCTRL DRIVER
M: Emil Renner Berthing <kernel@esmil.dk>
M: Jianlong Huang <jianlong.huang@starfivetech.com>
--
2.17.1On 18/01/2023 07:16, Yanhong Wang wrote: > Add documentation to describe StarFive dwmac driver(GMAC). > > Signed-off-by: Yanhong Wang <yanhong.wang@starfivetech.com> Subject is poor. You miss device prefix and it's not correct sentence. "Add support for XYZ" or better: "Add XYZ" > --- > .../devicetree/bindings/net/snps,dwmac.yaml | 1 + > .../bindings/net/starfive,jh7110-dwmac.yaml | 113 ++++++++++++++++++ > MAINTAINERS | 5 + > 3 files changed, 119 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml > > diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml > index baf2c5b9e92d..8b07bc9c8b00 100644 > --- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml > +++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml > @@ -91,6 +91,7 @@ properties: > - snps,dwmac-5.20 > - snps,dwxgmac > - snps,dwxgmac-2.10 > + - starfive,jh7110-dwmac > > reg: > minItems: 1 > diff --git a/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml > new file mode 100644 > index 000000000000..eb0767da834a > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml > @@ -0,0 +1,113 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +# Copyright (C) 2022 StarFive Technology Co., Ltd. > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/net/starfive,jh7110-dwmac.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: StarFive JH7110 DWMAC glue layer > + > +maintainers: > + - Yanhong Wang <yanhong.wang@starfivetech.com> > + > +select: > + properties: > + compatible: > + contains: > + enum: > + - starfive,jh7110-dwmac > + required: > + - compatible > + > +properties: > + compatible: > + items: > + - enum: > + - starfive,jh7110-dwmac > + - const: snps,dwmac-5.20 > + > + clocks: > + items: > + - description: GMAC main clock > + - description: GMAC AHB clock > + - description: PTP clock > + - description: TX clock > + - description: GTXC clock > + - description: GTX clock > + > + clock-names: > + items: > + - const: stmmaceth > + - const: pclk > + - const: ptp_ref > + - const: tx > + - const: gtxc > + - const: gtx > + > + resets: > + items: > + - description: MAC Reset signal. Drop trailing dot > + - description: AHB Reset signal. Ditto > + > + reset-names: > + items: > + - const: stmmaceth > + - const: ahb You have two resets. Why do you change them to three for all variants? It's not explained in commit 2/7, so this is confusing. > + > +allOf: > + - $ref: snps,dwmac.yaml# > + > +unevaluatedProperties: true > + > +required: > + - compatible > + - clocks > + - clock-names > + - resets > + - reset-names > + Best regards, Krzysztof
On 2023/1/18 23:49, Krzysztof Kozlowski wrote: > On 18/01/2023 07:16, Yanhong Wang wrote: >> Add documentation to describe StarFive dwmac driver(GMAC). >> >> Signed-off-by: Yanhong Wang <yanhong.wang@starfivetech.com> > > > Subject is poor. You miss device prefix and it's not correct sentence. > > "Add support for XYZ" > or better: > "Add XYZ" > Thanks. I will change to "Add support for JH7110" in the next version. > >> --- >> .../devicetree/bindings/net/snps,dwmac.yaml | 1 + >> .../bindings/net/starfive,jh7110-dwmac.yaml | 113 ++++++++++++++++++ >> MAINTAINERS | 5 + >> 3 files changed, 119 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml >> >> diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml >> index baf2c5b9e92d..8b07bc9c8b00 100644 >> --- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml >> +++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml >> @@ -91,6 +91,7 @@ properties: >> - snps,dwmac-5.20 >> - snps,dwxgmac >> - snps,dwxgmac-2.10 >> + - starfive,jh7110-dwmac >> >> reg: >> minItems: 1 >> diff --git a/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml >> new file mode 100644 >> index 000000000000..eb0767da834a >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml >> @@ -0,0 +1,113 @@ >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) >> +# Copyright (C) 2022 StarFive Technology Co., Ltd. >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/net/starfive,jh7110-dwmac.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: StarFive JH7110 DWMAC glue layer >> + >> +maintainers: >> + - Yanhong Wang <yanhong.wang@starfivetech.com> >> + >> +select: >> + properties: >> + compatible: >> + contains: >> + enum: >> + - starfive,jh7110-dwmac >> + required: >> + - compatible >> + >> +properties: >> + compatible: >> + items: >> + - enum: >> + - starfive,jh7110-dwmac >> + - const: snps,dwmac-5.20 >> + >> + clocks: >> + items: >> + - description: GMAC main clock >> + - description: GMAC AHB clock >> + - description: PTP clock >> + - description: TX clock >> + - description: GTXC clock >> + - description: GTX clock >> + >> + clock-names: >> + items: >> + - const: stmmaceth >> + - const: pclk >> + - const: ptp_ref >> + - const: tx >> + - const: gtxc >> + - const: gtx >> + >> + resets: >> + items: >> + - description: MAC Reset signal. > > Drop trailing dot > I will fix. >> + - description: AHB Reset signal. > > Ditto > I will fix. >> + >> + reset-names: >> + items: >> + - const: stmmaceth >> + - const: ahb > > You have two resets. Why do you change them to three for all variants? > It's not explained in commit 2/7, so this is confusing. > Refer to the definition of clocks, define the value of maxItems slightly larger (3), and reserve a little expandable space without affecting other definitions. If you need to configure 3 resets in the future, you only need to define it in individual schemas, and you don't need to adjust this item anymore. I will adjust maxItems to 2 in the next version. >> + >> +allOf: >> + - $ref: snps,dwmac.yaml# >> + >> +unevaluatedProperties: true >> + >> +required: >> + - compatible >> + - clocks >> + - clock-names >> + - resets >> + - reset-names >> + > > > Best regards, > Krzysztof >
© 2016 - 2025 Red Hat, Inc.