Commit 96944aaf authored by Pawel Dembicki's avatar Pawel Dembicki Committed by Jakub Kicinski
Browse files

net: dsa: vsc73xx: add structure descriptions 



This commit adds updates to the documentation describing the structures
used in vsc73xx. This will help prevent kdoc-related issues in the future.

Reviewed-by: default avatarLinus Walleij <linus.walleij@linaro.org>
Reviewed-by: default avatarFlorian Fainelli <florian.fainelli@broadcom.com>
Reviewed-by: default avatarVladimir Oltean <olteanv@gmail.com>
Signed-off-by: default avatarPawel Dembicki <paweldembicki@gmail.com>
Link: https://lore.kernel.org/r/20240417205048.3542839-6-paweldembicki@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 6cc5280a

drivers/net/dsa/vitesse-vsc73xx.h

+15 −1
Original line number Diff line number Diff line
@@ -15,7 +15,16 @@ 
#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 +37,11 @@ struct vsc73xx { 
	void				*priv;

};



/**

 * 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

 */

struct vsc73xx_ops {

	int (*read)(struct vsc73xx *vsc, u8 block, u8 subblock, u8 reg,

		    u32 *val);