Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

net: dsa: microchip: Refactor comment for ksz_switch_macaddr_get() function

Update the comment to follow kernel-doc format.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
Reviewed-by: Florian Fainelli <florian.fainelli@broadcom.com>
Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Link: https://lore.kernel.org/r/20231026051051.2316937-3-o.rempel@pengutronix.de
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Oleksij Rempel and committed by
Jakub Kicinski
78c21fca 3b454b63

+14 -6
+14 -6
drivers/net/dsa/microchip/ksz_common.c
··· 3617 3617 return true; 3618 3618 } 3619 3619 3620 - /* Program the switch's MAC address register with the MAC address of the 3621 - * requesting user port. This single address is used by the switch for multiple 3622 - * features, like HSR self-address filtering and WoL. Other user ports are 3623 - * allowed to share ownership of this address as long as their MAC address is 3624 - * the same. The user ports' MAC addresses must not change while they have 3625 - * ownership of the switch MAC address. 3620 + /** 3621 + * ksz_switch_macaddr_get - Program the switch's MAC address register. 3622 + * @ds: DSA switch instance. 3623 + * @port: Port number. 3624 + * @extack: Netlink extended acknowledgment. 3625 + * 3626 + * This function programs the switch's MAC address register with the MAC address 3627 + * of the requesting user port. This single address is used by the switch for 3628 + * multiple features like HSR self-address filtering and WoL. Other user ports 3629 + * can share ownership of this address as long as their MAC address is the same. 3630 + * The MAC addresses of user ports must not change while they have ownership of 3631 + * the switch MAC address. 3632 + * 3633 + * Return: 0 on success, or other error codes on failure. 3626 3634 */ 3627 3635 int ksz_switch_macaddr_get(struct dsa_switch *ds, int port, 3628 3636 struct netlink_ext_ack *extack)