# \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- Subsystems: ETHERNET PHY LIBRARY, LYNX PCS MODULE, MEDIATEK ETHERNET PCS DRIVER, NETWORKING DRIVERS, SYNOPSYS DESIGNWARE ETHERNET XPCS DRIVER, THE REST
- Maintainers: Andrew Lunn, Heiner Kallweit, Ioana Ciornei, Alexander Couzens, Daniel Golle, Andrew Lunn, "David S. Miller", Eric Dumazet, Jakub Kicinski, Paolo Abeni, Linus Torvalds
- List: netdev
- 5 messages, 3 authors
- Page: https://ratatoskr.run/netdev/2024/01/2467331/t

## \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- From: Breno Leitao \<leitao@debian.org\>
- Date: 2024-01-22 18:46:13 
- Message: https://ratatoskr.run/netdev/2024/01/2467331.md

```text
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 <leitao@debian.org>
---
 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

```

## Re: \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- From: Daniel Golle \<daniel@makrotopia.org\>
- Date: 2024-01-22 19:32:03 
- Message: https://ratatoskr.run/netdev/2024/01/2467385.md

```text
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 <leitao@debian.org>
> ---
>  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
> 
```

## Re: \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- From: Andrew Lunn \<andrew@lunn.ch\>
- Date: 2024-01-22 19:33:55 
- Message: https://ratatoskr.run/netdev/2024/01/2467386.md

```text
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 <leitao@debian.org>
> ---
>  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
```

## Re: \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- From: Breno Leitao \<leitao@debian.org\>
- Date: 2024-01-22 19:42:21 
- Message: https://ratatoskr.run/netdev/2024/01/2467397.md

```text
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 <leitao@debian.org>
> > ---
> >  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");

```

## Re: \[PATCH net-next 03/22\] net: fill in MODULE\_DESCRIPTION()s for PCS Layer

- From: Breno Leitao \<leitao@debian.org\>
- Date: 2024-01-22 19:42:55 
- Message: https://ratatoskr.run/netdev/2024/01/2467406.md

```text
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 <leitao@debian.org>
> > ---
> >  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!
```
