Commit 78c21fca authored by Oleksij Rempel's avatar Oleksij Rempel Committed by Jakub Kicinski

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

Update the comment to follow kernel-doc format.
Signed-off-by: default avatarOleksij Rempel <o.rempel@pengutronix.de>
Reviewed-by: default avatarFlorian Fainelli <florian.fainelli@broadcom.com>
Reviewed-by: default avatarVladimir Oltean <vladimir.oltean@nxp.com>
Link: https://lore.kernel.org/r/20231026051051.2316937-3-o.rempel@pengutronix.deSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 3b454b63
...@@ -3617,12 +3617,20 @@ bool ksz_is_port_mac_global_usable(struct dsa_switch *ds, int port) ...@@ -3617,12 +3617,20 @@ bool ksz_is_port_mac_global_usable(struct dsa_switch *ds, int port)
return true; return true;
} }
/* Program the switch's MAC address register with the MAC address of the /**
* requesting user port. This single address is used by the switch for multiple * ksz_switch_macaddr_get - Program the switch's MAC address register.
* features, like HSR self-address filtering and WoL. Other user ports are * @ds: DSA switch instance.
* allowed to share ownership of this address as long as their MAC address is * @port: Port number.
* the same. The user ports' MAC addresses must not change while they have * @extack: Netlink extended acknowledgment.
* ownership of the switch MAC address. *
* This function programs the switch's MAC address register with the MAC address
* of the requesting user port. This single address is used by the switch for
* multiple features like HSR self-address filtering and WoL. Other user ports
* can share ownership of this address as long as their MAC address is the same.
* The MAC addresses of user ports must not change while they have ownership of
* the switch MAC address.
*
* Return: 0 on success, or other error codes on failure.
*/ */
int ksz_switch_macaddr_get(struct dsa_switch *ds, int port, int ksz_switch_macaddr_get(struct dsa_switch *ds, int port,
struct netlink_ext_ack *extack) struct netlink_ext_ack *extack)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment