by Krzysztof Kozlowski

[permalink] [raw]

Subject: Re: [PATCH v4 4/7] dt-bindings: net: Add support StarFive dwmac

On 18/01/2023 07:16, Yanhong Wang wrote:
> Add documentation to describe StarFive dwmac driver(GMAC).
>
> Signed-off-by: Yanhong Wang <[email protected]>

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 <[email protected]>
> +
> +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

2023-01-18 23:24:30

On Tue, 21 Feb 2023 at 03:27, yanhong wang
<[email protected]> wrote:
>
> add [email protected] to loop.
>
> On 2023/2/16 18:53, Emil Renner Berthing wrote:
> > On Wed, 18 Jan 2023 at 07:20, Yanhong Wang
> > <[email protected]> wrote:
> >>
> >> This adds StarFive dwmac driver support on the StarFive JH7110 SoCs.
> >>
> >> Signed-off-by: Yanhong Wang <[email protected]>
> >> Co-developed-by: Emil Renner Berthing <[email protected]>
> >> Signed-off-by: Emil Renner Berthing <[email protected]>
> >> ---
> >> MAINTAINERS | 1 +
> >> drivers/net/ethernet/stmicro/stmmac/Kconfig | 12 ++
> >> drivers/net/ethernet/stmicro/stmmac/Makefile | 1 +
> >> .../stmicro/stmmac/dwmac-starfive-plat.c | 118 ++++++++++++++++++
> >> 4 files changed, 132 insertions(+)
> >> create mode 100644 drivers/net/ethernet/stmicro/stmmac/dwmac-starfive-plat.c
> >>
> >> diff --git a/MAINTAINERS b/MAINTAINERS
> >> index 56be59bb09f7..5b50b52d3dbb 100644
> >> --- a/MAINTAINERS
> >> +++ b/MAINTAINERS
> >> @@ -19609,6 +19609,7 @@ F: include/dt-bindings/clock/starfive*
> >> STARFIVE DWMAC GLUE LAYER
> >> M: Yanhong Wang <[email protected]>
> >> S: Maintained
> >> +F: Documentation/devicetree/bindings/net/dwmac-starfive-plat.c
> >> F: Documentation/devicetree/bindings/net/starfive,jh7110-dwmac.yaml
> >>
> >> STARFIVE PINCTRL DRIVER
> >> diff --git a/drivers/net/ethernet/stmicro/stmmac/Kconfig b/drivers/net/ethernet/stmicro/stmmac/Kconfig
> >> index 31ff35174034..f9a4ad4abd54 100644
> >> --- a/drivers/net/ethernet/stmicro/stmmac/Kconfig
> >> +++ b/drivers/net/ethernet/stmicro/stmmac/Kconfig
> >> @@ -235,6 +235,18 @@ config DWMAC_INTEL_PLAT
> >> the stmmac device driver. This driver is used for the Intel Keem Bay
> >> SoC.
> >>
> >> +config DWMAC_STARFIVE_PLAT
> >> + tristate "StarFive dwmac support"
> >> + depends on OF && COMMON_CLK
> >> + depends on STMMAC_ETH
> >> + default SOC_STARFIVE
> >> + help
> >> + Support for ethernet controllers on StarFive RISC-V SoCs
> >> +
> >> + This selects the StarFive platform specific glue layer support for
> >> + the stmmac device driver. This driver is used for StarFive JH7110
> >> + ethernet controller.
> >> +
> >> config DWMAC_VISCONTI
> >> tristate "Toshiba Visconti DWMAC support"
> >> default ARCH_VISCONTI
> >> diff --git a/drivers/net/ethernet/stmicro/stmmac/Makefile b/drivers/net/ethernet/stmicro/stmmac/Makefile
> >> index d4e12e9ace4f..a63ab0ab5071 100644
> >> --- a/drivers/net/ethernet/stmicro/stmmac/Makefile
> >> +++ b/drivers/net/ethernet/stmicro/stmmac/Makefile
> >> @@ -31,6 +31,7 @@ obj-$(CONFIG_DWMAC_DWC_QOS_ETH) += dwmac-dwc-qos-eth.o
> >> obj-$(CONFIG_DWMAC_INTEL_PLAT) += dwmac-intel-plat.o
> >> obj-$(CONFIG_DWMAC_GENERIC) += dwmac-generic.o
> >> obj-$(CONFIG_DWMAC_IMX8) += dwmac-imx.o
> >> +obj-$(CONFIG_DWMAC_STARFIVE_PLAT) += dwmac-starfive-plat.o
> >
> > Hi Yanhong,
> >
> > For the next version could you please drop the _PLAT from the config
> > symbol and -plat from filename. I know the intel wrapper does the
> > same, but it's the only one, so lets do like the majority of other
> > wrappers and not add more different ways of doing things.
> >
>
> Thanks. I will fix.
>
> >> obj-$(CONFIG_DWMAC_VISCONTI) += dwmac-visconti.o
> >> stmmac-platform-objs:= stmmac_platform.o
> >> dwmac-altr-socfpga-objs := altr_tse_pcs.o dwmac-socfpga.o
> >> diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac-starfive-plat.c b/drivers/net/ethernet/stmicro/stmmac/dwmac-starfive-plat.c
> >> new file mode 100644
> >> index 000000000000..e441d920933a
> >> --- /dev/null
> >> +++ b/drivers/net/ethernet/stmicro/stmmac/dwmac-starfive-plat.c
> >> @@ -0,0 +1,118 @@
> >> +// SPDX-License-Identifier: GPL-2.0+
> >> +/*
> >> + * StarFive DWMAC platform driver
> >> + *
> >> + * Copyright(C) 2022 StarFive Technology Co., Ltd.
> >> + *
> >> + */
> >> +
> >> +#include <linux/of_device.h>
> >> +
> >> +#include "stmmac_platform.h"
> >> +
> >> +struct starfive_dwmac {
> >> + struct device *dev;
> >> + struct clk *clk_tx;
> >> + struct clk *clk_gtx;
> >> + struct clk *clk_gtxc;
> >> +};
> >
> > I like this name. For the next version could you also
> > s/starfive_eth_plat_/starfive_dwmac_/ on the function/struct names
> > below for consistency.
> >
>
> I will fix.
>
> >> +
> >> +static void starfive_eth_plat_fix_mac_speed(void *priv, unsigned int speed)
> >> +{
> >> + struct starfive_dwmac *dwmac = priv;
> >> + unsigned long rate;
> >> + int err;
> >> +
> >> + rate = clk_get_rate(dwmac->clk_gtx);
> >> +
> >> + switch (speed) {
> >> + case SPEED_1000:
> >> + rate = 125000000;
> >> + break;
> >> + case SPEED_100:
> >> + rate = 25000000;
> >> + break;
> >> + case SPEED_10:
> >> + rate = 2500000;
> >> + break;
> >> + default:
> >> + dev_err(dwmac->dev, "invalid speed %u\n", speed);
> >> + break;
> >> + }
> >> +
> >> + err = clk_set_rate(dwmac->clk_gtx, rate);
> >> + if (err)
> >> + dev_err(dwmac->dev, "failed to set tx rate %lu\n", rate);
> >> +}
> >> +
> >> +static int starfive_eth_plat_probe(struct platform_device *pdev)
> >> +{
> >> + struct plat_stmmacenet_data *plat_dat;
> >> + struct stmmac_resources stmmac_res;
> >> + struct starfive_dwmac *dwmac;
> >> + int err;
> >> +
> >> + err = stmmac_get_platform_resources(pdev, &stmmac_res);
> >> + if (err)
> >> + return err;
> >> +
> >> + plat_dat = stmmac_probe_config_dt(pdev, stmmac_res.mac);
> >> + if (IS_ERR(plat_dat)) {
> >> + dev_err(&pdev->dev, "dt configuration failed\n");
> >> + return PTR_ERR(plat_dat);
> >> + }
> >> +
> >> + dwmac = devm_kzalloc(&pdev->dev, sizeof(*dwmac), GFP_KERNEL);
> >> + if (!dwmac)
> >> + return -ENOMEM;
> >> +
> >> + dwmac->clk_tx = devm_clk_get_enabled(&pdev->dev, "tx");
> >> + if (IS_ERR(dwmac->clk_tx))
> >> + return dev_err_probe(&pdev->dev, PTR_ERR(dwmac->clk_tx),
> >> + "error getting tx clock\n");
> >> +
> >> + dwmac->clk_gtx = devm_clk_get_enabled(&pdev->dev, "gtx");
> >> + if (IS_ERR(dwmac->clk_gtx))
> >> + return dev_err_probe(&pdev->dev, PTR_ERR(dwmac->clk_gtx),
> >> + "error getting gtx clock\n");
> >> +
> >> + dwmac->clk_gtxc = devm_clk_get_enabled(&pdev->dev, "gtxc");
> >> + if (IS_ERR(dwmac->clk_gtxc))
> >> + return dev_err_probe(&pdev->dev, PTR_ERR(dwmac->clk_gtxc),
> >> + "error getting gtxc clock\n");
> >> +
> >> + dwmac->dev = &pdev->dev;
> >> + plat_dat->fix_mac_speed = starfive_eth_plat_fix_mac_speed;
> >> + plat_dat->init = NULL;
> >> + plat_dat->bsp_priv = dwmac;
> >> + plat_dat->dma_cfg->dche = true;
> >> +
> >> + err = stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
> >> + if (err) {
> >> + stmmac_remove_config_dt(pdev, plat_dat);
> >> + return err;
> >> + }
> >> +
> >> + return 0;
> >> +}
> >> +
> >> +static const struct of_device_id starfive_eth_plat_match[] = {
> >> + { .compatible = "starfive,jh7110-dwmac" },
> >> + { }
> >> +};

I noticed you're missing a
MODULE_DEVICE_TABLE(of, starfive_dwmac_match);
here, so udev will load the module automatically.

While you're at it I also like the idiom of using { /* sentinel */ }
for the last entry here.

> >> +static struct platform_driver starfive_eth_plat_driver = {
> >> + .probe = starfive_eth_plat_probe,
> >> + .remove = stmmac_pltfr_remove,
> >> + .driver = {
> >> + .name = "starfive-eth-plat",
> >> + .pm = &stmmac_pltfr_pm_ops,
> >> + .of_match_table = starfive_eth_plat_match,
> >> + },
> >> +};
> >> +
> >> +module_platform_driver(starfive_eth_plat_driver);
> >> +
> >> +MODULE_LICENSE("GPL");
> >> +MODULE_DESCRIPTION("StarFive DWMAC platform driver");
> >> +MODULE_AUTHOR("Yanhong Wang <[email protected]>");
> >> --
> >> 2.17.1
> >>
> >>
> >> _______________________________________________
> >> linux-riscv mailing list
> >> [email protected]
> >> http://lists.infradead.org/mailman/listinfo/linux-riscv