Commit 9afe1839 authored by Lee Jones's avatar Lee Jones Committed by Greg Kroah-Hartman

misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups

Includes; missing descriptions for function args, the promotion
of obvious kerneldoc headers and the mis-formatting of existing
argument descriptions.

Fixes the following W=1 kernel build warnings:

 drivers/misc/mic/scif/scif_nm.c:19: warning: Function parameter or member 'node' not described in 'scif_invalidate_ep'
 drivers/misc/mic/scif/scif_nm.c:173: warning: Function parameter or member 'node_id' not described in 'scif_disconnect_node'
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-23-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 5ab3f590
......@@ -14,6 +14,8 @@
/**
* scif_invalidate_ep() - Set state for all connected endpoints
* to disconnected and wake up all send/recv waitqueues
*
* @node: Node to invalidate
*/
static void scif_invalidate_ep(int node)
{
......@@ -99,11 +101,10 @@ void scif_send_acks(struct scif_dev *dev)
}
}
/*
* scif_cleanup_scifdev
*
/**
* scif_cleanup_scifdev - Uninitialize SCIF data structures for remote
* SCIF device.
* @dev: Remote SCIF device.
* Uninitialize SCIF data structures for remote SCIF device.
*/
void scif_cleanup_scifdev(struct scif_dev *dev)
{
......@@ -136,8 +137,8 @@ void scif_cleanup_scifdev(struct scif_dev *dev)
scif_cleanup_qp(dev);
}
/*
* scif_remove_node:
/**
* scif_remove_node
*
* @node: Node to remove
*/
......@@ -162,9 +163,9 @@ static int scif_send_rmnode_msg(int node, int remove_node)
}
/**
* scif_node_disconnect:
* scif_node_disconnect
*
* @node_id[in]: source node id.
* @node_id: source node id [in]
* @mgmt_initiated: Disconnection initiated from the mgmt node
*
* Disconnect a node from the scif network.
......
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