[PATCH v2 15/30] misc: mic: cosm: cosm_main: Document 'force' function argument

From: Lee Jones
Date: Wed Jul 01 2020 - 04:33:04 EST


Fixes the following W=1 kernel build warning:

drivers/misc/mic/cosm/cosm_main.c:31: warning: Function parameter or member 'force' not described in 'cosm_hw_reset'

Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
---
drivers/misc/mic/cosm/cosm_main.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/misc/mic/cosm/cosm_main.c b/drivers/misc/mic/cosm/cosm_main.c
index f9133c4f61050..ebb0eac43754a 100644
--- a/drivers/misc/mic/cosm/cosm_main.c
+++ b/drivers/misc/mic/cosm/cosm_main.c
@@ -26,6 +26,7 @@ static atomic_t g_num_dev;
/**
* cosm_hw_reset - Issue a HW reset for the MIC device
* @cdev: pointer to cosm_device instance
+ * @force: force a MIC to reset even if it is already reset and ready
*/
static void cosm_hw_reset(struct cosm_device *cdev, bool force)
{
--
2.25.1