mei: Fix comments in drivers/misc/mei
Correct typos and fix stray comments.
Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Acked-by: Winkler, Tomas <tomas.winkler@intel.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
diff --git a/drivers/misc/mei/amthif.c b/drivers/misc/mei/amthif.c
index c86d7e3..1fbfd63 100644
--- a/drivers/misc/mei/amthif.c
+++ b/drivers/misc/mei/amthif.c
@@ -60,7 +60,7 @@
}
/**
- * mei_amthif_host_init_ - mei initialization amthif client.
+ * mei_amthif_host_init - mei initialization amthif client.
*
* @dev: the device structure
*
@@ -433,7 +433,7 @@
/**
- * mei_amthif_irq_process_completed - processes completed iamthif operation.
+ * mei_amthif_irq_write_completed - processes completed iamthif operation.
*
* @dev: the device structure.
* @slots: free slots.
@@ -703,7 +703,7 @@
/**
* mei_amthif_release - the release function
*
-* @inode: pointer to inode structure
+* @dev: device structure
* @file: pointer to file structure
*
* returns 0 on success, <0 on error
diff --git a/drivers/misc/mei/client.c b/drivers/misc/mei/client.c
index 1569afe..4eba513 100644
--- a/drivers/misc/mei/client.c
+++ b/drivers/misc/mei/client.c
@@ -109,7 +109,7 @@
* mei_io_cb_init - allocate and initialize io callback
*
* @cl - mei client
- * @file: pointer to file structure
+ * @fp: pointer to file structure
*
* returns mei_cl_cb pointer or NULL;
*/
@@ -132,8 +132,8 @@
/**
* mei_io_cb_alloc_req_buf - allocate request buffer
*
- * @cb - io callback structure
- * @size: size of the buffer
+ * @cb: io callback structure
+ * @length: size of the buffer
*
* returns 0 on success
* -EINVAL if cb is NULL
@@ -154,10 +154,10 @@
return 0;
}
/**
- * mei_io_cb_alloc_req_buf - allocate respose buffer
+ * mei_io_cb_alloc_resp_buf - allocate respose buffer
*
- * @cb - io callback structure
- * @size: size of the buffer
+ * @cb: io callback structure
+ * @length: size of the buffer
*
* returns 0 on success
* -EINVAL if cb is NULL
@@ -183,7 +183,6 @@
/**
* mei_cl_flush_queues - flushes queue lists belonging to cl.
*
- * @dev: the device structure
* @cl: host client
*/
int mei_cl_flush_queues(struct mei_cl *cl)
@@ -243,7 +242,8 @@
/**
* mei_cl_find_read_cb - find this cl's callback in the read list
*
- * @dev: device structure
+ * @cl: host client
+ *
* returns cb on success, NULL on error
*/
struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl)
@@ -262,6 +262,7 @@
*
* @cl - host client
* @id - fixed host id or -1 for genereting one
+ *
* returns 0 on success
* -EINVAL on incorrect values
* -ENONET if client not found
@@ -301,7 +302,7 @@
/**
* mei_cl_unlink - remove me_cl from the list
*
- * @dev: the device structure
+ * @cl: host client
*/
int mei_cl_unlink(struct mei_cl *cl)
{
@@ -534,7 +535,6 @@
/**
* mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
*
- * @dev: the device structure
* @cl: private data of the file object
*
* returns 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
@@ -575,8 +575,8 @@
/**
* mei_cl_flow_ctrl_reduce - reduces flow_control.
*
- * @dev: the device structure
* @cl: private data of the file object
+ *
* @returns
* 0 on success
* -ENOENT when me client is not found
@@ -614,7 +614,7 @@
}
/**
- * mei_cl_start_read - the start read client message function.
+ * mei_cl_read_start - the start read client message function.
*
* @cl: host client
*
diff --git a/drivers/misc/mei/hbm.c b/drivers/misc/mei/hbm.c
index fb9e63b..4465d3f 100644
--- a/drivers/misc/mei/hbm.c
+++ b/drivers/misc/mei/hbm.c
@@ -62,6 +62,7 @@
/**
* mei_hbm_cl_hdr - construct client hbm header
+ *
* @cl: - client
* @hbm_cmd: host bus message command
* @buf: buffer for cl header
@@ -184,7 +185,7 @@
}
/**
- * mei_hbm_prop_requsest - request property for a single client
+ * mei_hbm_prop_req - request property for a single client
*
* @dev: the device structure
*
@@ -283,9 +284,9 @@
}
/**
- * add_single_flow_creds - adds single buffer credentials.
+ * mei_hbm_add_single_flow_creds - adds single buffer credentials.
*
- * @file: private data ot the file object.
+ * @dev: the device structure
* @flow: flow control.
*/
static void mei_hbm_add_single_flow_creds(struct mei_device *dev,
@@ -477,7 +478,7 @@
/**
- * mei_client_disconnect_request - disconnect request initiated by me
+ * mei_hbm_fw_disconnect_req - disconnect request initiated by me
* host sends disoconnect response
*
* @dev: the device structure.
diff --git a/drivers/misc/mei/hw-me.c b/drivers/misc/mei/hw-me.c
index 45ea718..c31f7a47 100644
--- a/drivers/misc/mei/hw-me.c
+++ b/drivers/misc/mei/hw-me.c
@@ -103,7 +103,7 @@
/**
- * me_hw_config - configure hw dependent settings
+ * mei_me_hw_config - configure hw dependent settings
*
* @dev: mei device
*/
@@ -155,7 +155,7 @@
* mei_me_hw_reset - resets fw via mei csr register.
*
* @dev: the device structure
- * @interrupts_enabled: if interrupt should be enabled after reset.
+ * @intr_enable: if interrupt should be enabled after reset.
*/
static void mei_me_hw_reset(struct mei_device *dev, bool intr_enable)
{
@@ -243,7 +243,7 @@
}
/**
- * mei_hbuf_is_empty - checks if host buffer is empty.
+ * mei_me_hbuf_is_empty - checks if host buffer is empty.
*
* @dev: the device structure
*
@@ -543,7 +543,7 @@
};
/**
- * init_mei_device - allocates and initializes the mei device structure
+ * mei_me_dev_init - allocates and initializes the mei device structure
*
* @pdev: The pci device structure
*
diff --git a/drivers/misc/mei/interrupt.c b/drivers/misc/mei/interrupt.c
index 3535b26..8a649d7 100644
--- a/drivers/misc/mei/interrupt.c
+++ b/drivers/misc/mei/interrupt.c
@@ -30,7 +30,7 @@
/**
- * mei_complete_handler - processes completed operation.
+ * mei_irq_complete_handler - processes completed operation.
*
* @cl: private data of the file object.
* @cb_pos: callback block.
@@ -177,7 +177,7 @@
/**
- * _mei_hb_read - processes read related operation.
+ * _mei_irq_thread_read - processes read related operation.
*
* @dev: the device structure.
* @slots: free slots.
@@ -310,7 +310,7 @@
}
/**
- * mei_irq_thread_read_handler - bottom half read routine after ISR to
+ * mei_irq_read_handler - bottom half read routine after ISR to
* handle the read processing.
*
* @dev: the device structure
diff --git a/drivers/misc/mei/pci-me.c b/drivers/misc/mei/pci-me.c
index b40ec06..df17506 100644
--- a/drivers/misc/mei/pci-me.c
+++ b/drivers/misc/mei/pci-me.c
@@ -92,6 +92,7 @@
/**
* mei_quirk_probe - probe for devices that doesn't valid ME interface
+ *
* @pdev: PCI device structure
* @ent: entry into pci_device_table
*
diff --git a/drivers/misc/mei/wd.c b/drivers/misc/mei/wd.c
index 2413247..3effd5f 100644
--- a/drivers/misc/mei/wd.c
+++ b/drivers/misc/mei/wd.c
@@ -58,6 +58,7 @@
* mei_wd_host_init - connect to the watchdog client
*
* @dev: the device structure
+ *
* returns -ENENT if wd client cannot be found
* -EIO if write has failed
* 0 on success