Re: [PATCH net-next v4 05/15] net: dsa: vsc73xx: add structure descriptions

Vladimir Oltean
2024-02-15T00:18:25Z

On Tue, Feb 13, 2024 at 11:03:18PM +0100, Pawel Dembicki wrote:
> diff --git a/drivers/net/dsa/vitesse-vsc73xx.h b/drivers/net/dsa/vitesse-vsc73xx.h
> index fee1378508b5..99c5c24ffde0 100644
> --- a/drivers/net/dsa/vitesse-vsc73xx.h
> +++ b/drivers/net/dsa/vitesse-vsc73xx.h
> @@ -15,7 +15,15 @@
> #define VSC73XX_MAX_NUM_PORTS 8
>
> /**
> - * struct vsc73xx - VSC73xx state container
> + * struct vsc73xx - VSC73xx state container: main data structure
> + * @dev: The device pointer
> + * @reset: The descriptor for the GPIO line tied to the reset pin
> + * @ds: Pointer to the DSA core structure
> + * @gc: Main structure of the GPIO controller
> + * @chipid: Storage for the Chip ID value read from the CHIPID register of the switch
> + * @addr: MAC address used in flow control frames
> + * @ops: Structure with hardware-dependent operations
> + * @priv: Pointer to the configuration interface structure
> */
> struct vsc73xx {
> struct device *dev;
> @@ -28,6 +36,11 @@ struct vsc73xx {
> void *priv;
> };
>
> +/**
> + * struct vsc73xx_ops - VSC73xx methods container: pointers to hardware-dependent functions

The netdev coding style still sticks to the "80 characters per line" rule.
I can't find other deviations from this rule in the driver.

Maybe you can cut down on the boilerplate a little bit. Like:

/**
* struct vsc73xx_ops - VSC73xx methods container
* @read: Method for register reading over the hardware-dependent interface
* @write: Method for register writing over the hardware-dependent interface

> + * @read: Pointer to the read function from the hardware-dependent interface
> + * @write: Pointer to the write function from the hardware-dependent interface
> + */
> struct vsc73xx_ops {
> int (*read)(struct vsc73xx *vsc, u8 block, u8 subblock, u8 reg,
> u32 *val);
> --
> 2.34.1
>