Skip to content

Commit 78c21fc

Browse files
oleremkuba-moo
authored andcommitted
net: dsa: microchip: Refactor comment for ksz_switch_macaddr_get() function
Update the comment to follow kernel-doc format. Signed-off-by: Oleksij Rempel <[email protected]> Reviewed-by: Florian Fainelli <[email protected]> Reviewed-by: Vladimir Oltean <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jakub Kicinski <[email protected]>
1 parent 3b454b6 commit 78c21fc

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

drivers/net/dsa/microchip/ksz_common.c

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3617,12 +3617,20 @@ bool ksz_is_port_mac_global_usable(struct dsa_switch *ds, int port)
36173617
return true;
36183618
}
36193619

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.
36263634
*/
36273635
int ksz_switch_macaddr_get(struct dsa_switch *ds, int port,
36283636
struct netlink_ext_ack *extack)

0 commit comments

Comments
 (0)