2024-01-22 19:12:58

by Breno Leitao

Subject: [PATCH net-next 03/22] net: fill in MODULE_DESCRIPTION()s for PCS Layer

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the LynxI PCS MediaTek's SoC.

Signed-off-by: Breno Leitao <[email protected]>
---
drivers/net/pcs/pcs-lynx.c | 1 +
drivers/net/pcs/pcs-mtk-lynxi.c | 1 +
drivers/net/pcs/pcs-xpcs.c | 1 +
3 files changed, 3 insertions(+)

diff --git a/drivers/net/pcs/pcs-lynx.c b/drivers/net/pcs/pcs-lynx.c
index dc3962b2aa6b..d51d09beaab3 100644
--- a/drivers/net/pcs/pcs-lynx.c
+++ b/drivers/net/pcs/pcs-lynx.c
@@ -398,4 +398,5 @@ void lynx_pcs_destroy(struct phylink_pcs *pcs)
}
EXPORT_SYMBOL(lynx_pcs_destroy);

+MODULE_DESCRIPTION("MediaTek SGMII library for Lynx PCS");
MODULE_LICENSE("Dual BSD/GPL");
diff --git a/drivers/net/pcs/pcs-mtk-lynxi.c b/drivers/net/pcs/pcs-mtk-lynxi.c
index 8501dd365279..4f63abe638c4 100644
--- a/drivers/net/pcs/pcs-mtk-lynxi.c
+++ b/drivers/net/pcs/pcs-mtk-lynxi.c
@@ -303,4 +303,5 @@ void mtk_pcs_lynxi_destroy(struct phylink_pcs *pcs)
}
EXPORT_SYMBOL(mtk_pcs_lynxi_destroy);

+MODULE_DESCRIPTION("MediaTek SGMII library for LynxI");
MODULE_LICENSE("GPL");
diff --git a/drivers/net/pcs/pcs-xpcs.c b/drivers/net/pcs/pcs-xpcs.c
index 31f0beba638a..9c020dd3c766 100644
--- a/drivers/net/pcs/pcs-xpcs.c
+++ b/drivers/net/pcs/pcs-xpcs.c
@@ -1456,4 +1456,5 @@ struct dw_xpcs *xpcs_create_mdiodev(struct mii_bus *bus, int addr,
}
EXPORT_SYMBOL_GPL(xpcs_create_mdiodev);

+MODULE_DESCRIPTION("Synopsys DesignWare XPCS helpers");
MODULE_LICENSE("GPL v2");
--
2.39.3

2024-01-22 19:32:15

by Daniel Golle

Subject: Re: [PATCH net-next 03/22] net: fill in MODULE_DESCRIPTION()s for PCS Layer

Hi Breno,

On Mon, Jan 22, 2024 at 10:45:24AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the LynxI PCS MediaTek's SoC.
>
> Signed-off-by: Breno Leitao <[email protected]>
> ---
> drivers/net/pcs/pcs-lynx.c | 1 +
> drivers/net/pcs/pcs-mtk-lynxi.c | 1 +
> drivers/net/pcs/pcs-xpcs.c | 1 +
> 3 files changed, 3 insertions(+)
>
> diff --git a/drivers/net/pcs/pcs-lynx.c b/drivers/net/pcs/pcs-lynx.c
> index dc3962b2aa6b..d51d09beaab3 100644
> --- a/drivers/net/pcs/pcs-lynx.c
> +++ b/drivers/net/pcs/pcs-lynx.c
> @@ -398,4 +398,5 @@ void lynx_pcs_destroy(struct phylink_pcs *pcs)
> }
> EXPORT_SYMBOL(lynx_pcs_destroy);
>
> +MODULE_DESCRIPTION("MediaTek SGMII library for Lynx PCS");

Nah, pcs-lynx.c is used by various SoC vendors **other than MediaTek**
such as Freescale and STMicroelectronics.

Users of the pcs-lynx.c driver are
ethernet/stmicro/stmmac/dwmac-socfpga.c
ethernet/altera/altera_tse_main.c
ethernet/freescale/dpaa2/dpaa2-mac.c
ethernet/freescale/enetc/enetc_pf.c
ethernet/freescale/fman/fman_memac.c
dsa/ocelot/felix_vsc9959.c
dsa/ocelot/seville_vsc9953.c


> MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/net/pcs/pcs-mtk-lynxi.c b/drivers/net/pcs/pcs-mtk-lynxi.c
> index 8501dd365279..4f63abe638c4 100644
> --- a/drivers/net/pcs/pcs-mtk-lynxi.c
> +++ b/drivers/net/pcs/pcs-mtk-lynxi.c
> @@ -303,4 +303,5 @@ void mtk_pcs_lynxi_destroy(struct phylink_pcs *pcs)
> }
> EXPORT_SYMBOL(mtk_pcs_lynxi_destroy);
>
> +MODULE_DESCRIPTION("MediaTek SGMII library for LynxI");

Ack on this one.

> MODULE_LICENSE("GPL");
> diff --git a/drivers/net/pcs/pcs-xpcs.c b/drivers/net/pcs/pcs-xpcs.c
> index 31f0beba638a..9c020dd3c766 100644
> --- a/drivers/net/pcs/pcs-xpcs.c
> +++ b/drivers/net/pcs/pcs-xpcs.c
> @@ -1456,4 +1456,5 @@ struct dw_xpcs *xpcs_create_mdiodev(struct mii_bus *bus, int addr,
> }
> EXPORT_SYMBOL_GPL(xpcs_create_mdiodev);
>
> +MODULE_DESCRIPTION("Synopsys DesignWare XPCS helpers");
> MODULE_LICENSE("GPL v2");
> --
> 2.39.3
>

2024-01-22 19:45:41

by Breno Leitao

Subject: Re: [PATCH net-next 03/22] net: fill in MODULE_DESCRIPTION()s for PCS Layer

On Mon, Jan 22, 2024 at 08:33:31PM +0100, Andrew Lunn wrote:
> On Mon, Jan 22, 2024 at 10:45:24AM -0800, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to the LynxI PCS MediaTek's SoC.
>
> That patch now does more than that.
>
> > Signed-off-by: Breno Leitao <[email protected]>
> > ---
> > drivers/net/pcs/pcs-lynx.c | 1 +
> > drivers/net/pcs/pcs-mtk-lynxi.c | 1 +
> > drivers/net/pcs/pcs-xpcs.c | 1 +
> > 3 files changed, 3 insertions(+)
> >
> > diff --git a/drivers/net/pcs/pcs-lynx.c b/drivers/net/pcs/pcs-lynx.c
> > index dc3962b2aa6b..d51d09beaab3 100644
> > --- a/drivers/net/pcs/pcs-lynx.c
> > +++ b/drivers/net/pcs/pcs-lynx.c
> > @@ -398,4 +398,5 @@ void lynx_pcs_destroy(struct phylink_pcs *pcs)
> > }
> > EXPORT_SYMBOL(lynx_pcs_destroy);
> >
> > +MODULE_DESCRIPTION("MediaTek SGMII library for Lynx PCS");
>
> pcs-lynx is for NXP hardware, not MediaTek.

Thanks. I will update!

2024-01-22 20:06:45

by Andrew Lunn

Subject: Re: [PATCH net-next 03/22] net: fill in MODULE_DESCRIPTION()s for PCS Layer

On Mon, Jan 22, 2024 at 10:45:24AM -0800, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the LynxI PCS MediaTek's SoC.

That patch now does more than that.

> Signed-off-by: Breno Leitao <[email protected]>
> ---
> drivers/net/pcs/pcs-lynx.c | 1 +
> drivers/net/pcs/pcs-mtk-lynxi.c | 1 +
> drivers/net/pcs/pcs-xpcs.c | 1 +
> 3 files changed, 3 insertions(+)
>
> diff --git a/drivers/net/pcs/pcs-lynx.c b/drivers/net/pcs/pcs-lynx.c
> index dc3962b2aa6b..d51d09beaab3 100644
> --- a/drivers/net/pcs/pcs-lynx.c
> +++ b/drivers/net/pcs/pcs-lynx.c
> @@ -398,4 +398,5 @@ void lynx_pcs_destroy(struct phylink_pcs *pcs)
> }
> EXPORT_SYMBOL(lynx_pcs_destroy);
>
> +MODULE_DESCRIPTION("MediaTek SGMII library for Lynx PCS");

pcs-lynx is for NXP hardware, not MediaTek.

Andrew

---
pw-bot: cr

2024-01-22 20:13:05

by Breno Leitao

Subject: Re: [PATCH net-next 03/22] net: fill in MODULE_DESCRIPTION()s for PCS Layer

On Mon, Jan 22, 2024 at 07:31:18PM +0000, Daniel Golle wrote:
> Hi Breno,
>
> On Mon, Jan 22, 2024 at 10:45:24AM -0800, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to the LynxI PCS MediaTek's SoC.
> >
> > Signed-off-by: Breno Leitao <[email protected]>
> > ---
> > drivers/net/pcs/pcs-lynx.c | 1 +
> > drivers/net/pcs/pcs-mtk-lynxi.c | 1 +
> > drivers/net/pcs/pcs-xpcs.c | 1 +
> > 3 files changed, 3 insertions(+)
> >
> > diff --git a/drivers/net/pcs/pcs-lynx.c b/drivers/net/pcs/pcs-lynx.c
> > index dc3962b2aa6b..d51d09beaab3 100644
> > --- a/drivers/net/pcs/pcs-lynx.c
> > +++ b/drivers/net/pcs/pcs-lynx.c
> > @@ -398,4 +398,5 @@ void lynx_pcs_destroy(struct phylink_pcs *pcs)
> > }
> > EXPORT_SYMBOL(lynx_pcs_destroy);
> >
> > +MODULE_DESCRIPTION("MediaTek SGMII library for Lynx PCS");
>
> Nah, pcs-lynx.c is used by various SoC vendors **other than MediaTek**
> such as Freescale and STMicroelectronics.
>
> Users of the pcs-lynx.c driver are
> ethernet/stmicro/stmmac/dwmac-socfpga.c
> ethernet/altera/altera_tse_main.c
> ethernet/freescale/dpaa2/dpaa2-mac.c
> ethernet/freescale/enetc/enetc_pf.c
> ethernet/freescale/fman/fman_memac.c
> dsa/ocelot/felix_vsc9959.c
> dsa/ocelot/seville_vsc9953.c

Thanks. What about something as?

MODULE_DESCRIPTION("Lynx PCS MDIO helpers");