[PATCH net-next v2 08/10] net: pcs: xpcs: Add fwnode-based descriptor creation method

[Serge Semin]

Hi Simon

On Wed, Jun 05, 2024 at 06:49:20PM +0100, Simon Horman wrote:
> On Sun, Jun 02, 2024 at 05:36:22PM +0300, Serge Semin wrote:
> > It's now possible to have the DW XPCS device defined as a standard
> > platform device for instance in the platform DT-file. Although that
> > functionality is useless unless there is a way to have the device found by
> > the client drivers (STMMAC/DW *MAC, NXP SJA1105 Eth Switch, etc). Provide
> > such ability by means of the xpcs_create_fwnode() method. It needs to be
> > called with the device DW XPCS fwnode instance passed. That node will be
> > then used to find the MDIO-device instance in order to create the DW XPCS
> > descriptor.
> > 
> > Note the method semantics and name is similar to what has been recently
> > introduced in the Lynx PCS driver.
> > 
> > Signed-off-by: Serge Semin <fancer.lancer at gmail.com>
> 
> Hi Serge,
> 
> Some minor nits from my side flagged by kernel-doc -none -Wall
> 
> ...
> 
> > diff --git a/drivers/net/pcs/pcs-xpcs.c b/drivers/net/pcs/pcs-xpcs.c
> 
> ...
> 
> > @@ -1505,6 +1507,16 @@ static struct dw_xpcs *xpcs_create(struct mdio_device *mdiodev,
> >  	return ERR_PTR(ret);
> >  }
> >  
> > +/**
> > + * xpcs_create_mdiodev() - create a DW xPCS instance with the MDIO @addr
> > + * @bus: pointer to the MDIO-bus descriptor for the device to be looked at
> > + * @addr: device MDIO-bus ID
> > + * @requested PHY interface
> 
> An entry for @interface should go here.

Right.

> 
> > + *
> > + * If successful, returns a pointer to the DW XPCS handle. Otherwise returns
> > + * -ENODEV if device couldn't be found on the bus, other negative errno related
> > + * to the data allocation and MDIO-bus communications.
> 
> Please consider including this information as a Return: section of the
> Kernel doc. Likewise for xpcs_create_fwnode().

Sure.

> 
> > + */
> >  struct dw_xpcs *xpcs_create_mdiodev(struct mii_bus *bus, int addr,
> >  				    phy_interface_t interface)
> >  {
> > @@ -1529,6 +1541,44 @@ struct dw_xpcs *xpcs_create_mdiodev(struct mii_bus *bus, int addr,
> >  }
> >  EXPORT_SYMBOL_GPL(xpcs_create_mdiodev);
> >  
> > +/**
> > + * xpcs_create_fwnode() - Create a DW xPCS instance from @fwnode
> > + * @node: fwnode handle poining to the DW XPCS device
> 
> s/@node/@fwnode/

Holy mother, so many typos in the kdoc part. I should have been more
attentive. I'll fix all of them in v2. Thanks.

* Special thanks for mentioning the scripts/kernel-doc I'll be using
it from now on.

-Serge(y)

> 
> > + * @interface: requested PHY interface
> > + *
> > + * If successful, returns a pointer to the DW XPCS handle. Otherwise returns
> > + * -ENODEV if the fwnode is marked unavailable or device couldn't be found on
> > + * the bus, -EPROBE_DEFER if the respective MDIO-device instance couldn't be
> > + * found, other negative errno related to the data allocations and MDIO-bus
> > + * communications.
> > + */
> > +struct dw_xpcs *xpcs_create_fwnode(struct fwnode_handle *fwnode,
> > +				   phy_interface_t interface)
> 
> ...