Commit 1abfb265 authored by Jiri Pirko's avatar Jiri Pirko Committed by David S. Miller
Browse files

net: devlink: fix unlocked vs locked functions descriptions 



To be unified with the rest of the code, the unlocked version (devl_*)
of function should have the same description in documentation as the
locked one. Add the missing documentation. Also, add "Context"
annotation for the locked versions where it is missing.

Signed-off-by: default avatarJiri Pirko <jiri@nvidia.com>
Acked-by: default avatarJakub Kicinski <kuba@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 3e35d198

net/core/devlink.c

+22 −0
Original line number Diff line number Diff line
@@ -9673,6 +9673,19 @@ static void devlink_port_type_warn_cancel(struct devlink_port *devlink_port) 
	cancel_delayed_work_sync(&devlink_port->type_warn_dw);

}



/**

 * devl_port_register() - Register devlink port

 *

 * @devlink: devlink

 * @devlink_port: devlink port

 * @port_index: driver-specific numerical identifier of the port

 *

 * Register devlink port with provided port index. User can use

 * any indexing, even hw-related one. devlink_port structure

 * is convenient to be embedded inside user driver private structure.

 * Note that the caller should take care of zeroing the devlink_port

 * structure.

 */

int devl_port_register(struct devlink *devlink,

		       struct devlink_port *devlink_port,

		       unsigned int port_index)
@@ -9711,6 +9724,8 @@ EXPORT_SYMBOL_GPL(devl_port_register); 
 *	is convenient to be embedded inside user driver private structure.

 *	Note that the caller should take care of zeroing the devlink_port

 *	structure.

 *

 *	Context: Takes and release devlink->lock <mutex>.

 */

int devlink_port_register(struct devlink *devlink,

			  struct devlink_port *devlink_port,
@@ -9725,6 +9740,11 @@ int devlink_port_register(struct devlink *devlink, 
}

EXPORT_SYMBOL_GPL(devlink_port_register);



/**

 * devl_port_unregister() - Unregister devlink port

 *

 * @devlink_port: devlink port

 */

void devl_port_unregister(struct devlink_port *devlink_port)

{

	lockdep_assert_held(&devlink_port->devlink->lock);
@@ -9742,6 +9762,8 @@ EXPORT_SYMBOL_GPL(devl_port_unregister); 
 *	devlink_port_unregister - Unregister devlink port

 *

 *	@devlink_port: devlink port

 *

 *	Context: Takes and release devlink->lock <mutex>.

 */

void devlink_port_unregister(struct devlink_port *devlink_port)

{