Skip to contentSkip to conversation

net: phylink: update documentation on create and destroy

PATCH Applied Russell King 2 participants 2 messages Nov 19, 2019 – Nov 20, 2019

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: phylink: update documentation on create and destroy

Update the documentation on phylink's create and destroy functions to explicitly state that the rtnl lock must not be held while calling these.

---
 drivers/net/phy/phylink.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/net/phy/phylink.c +4 -0
index 8b5e1086523c..342521ed7e7a 100644
@@ -580,6 +580,8 @@ static int phylink_register_sfp(struct phylink *pl,
  * Create a new phylink instance, and parse the link parameters found in @np.
  * This will parse in-band modes, fixed-link or SFP configuration.
  *
+ * Note: the rtnl lock must not be held when calling this function.
+ *
  * Returns a pointer to a &struct phylink, or an error-pointer value. Users
  * must use IS_ERR() to check for errors from this function.
  */
@@ -659,6 +661,8 @@ EXPORT_SYMBOL_GPL(phylink_create);
  *
  * Destroy a phylink instance. Any PHY that has been attached must have been
  * cleaned up via phylink_disconnect_phy() prior to calling this function.
+ *
+ * Note: the rtnl lock must not be held when calling this function.
  */
 void phylink_destroy(struct phylink *pl)
 {
Signature · 1 line
2.20.1