mei: docmentation cleanup
Subsystems (2)
cover mei: docmentation cleanup
Overall documentation formating fix and other collateral fixes.
Alexander Usyskin (4):
mei: trivial: fix errors in prints in comments
mei: drop me_client_presentation_num
mei: fix KDoc documentation formatting
mei: fix kernel-doc warnings
drivers/misc/mei/amthif.c | 35 +++---- drivers/misc/mei/client.c | 78 +++++++++------ drivers/misc/mei/debugfs.c | 11 +- drivers/misc/mei/hbm.c | 47 +++++---- drivers/misc/mei/hw-me.c | 89 +++++++++++------ drivers/misc/mei/hw-me.h | 6 ++ drivers/misc/mei/hw-txe.c | 116 ++++++++++++++-------- drivers/misc/mei/hw-txe.h | 1 + drivers/misc/mei/hw.h | 48 ++++----- drivers/misc/mei/init.c | 12 +-- drivers/misc/mei/interrupt.c | 28 +++--- drivers/misc/mei/main.c | 21 ++-- drivers/misc/mei/mei_dev.h | 232 +++++++++++++++++++++++++++++-------------- drivers/misc/mei/nfc.c | 8 +- drivers/misc/mei/pci-me.c | 10 +- drivers/misc/mei/pci-txe.c | 2 +- drivers/misc/mei/wd.c | 15 ++- 17 files changed, 469 insertions(+), 290 deletions(-)
Signature · 1 line
1.9.3
PATCH 1/4 mei: trivial: fix errors in prints in comments
From: Alexander Usyskin <[email protected]>
Fix misspellings and wrong print texts
--- drivers/misc/mei/client.c | 2 +- drivers/misc/mei/debugfs.c | 2 +- drivers/misc/mei/hw-txe.c | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-)
drivers/misc/mei/client.c +1 -1
@@ -926,7 +926,7 @@ int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking) buf = &cb->request_buffer; -cl_dbg (dev, cl,"mei_cl_write %d\n" , buf->size); +cl_dbg (dev, cl,"size=%d\n" , buf->size); rets =pm_runtime_get (dev->dev);if (rets <0 && rets != -EINPROGRESS ) {
drivers/misc/mei/debugfs.c +1 -1
@@ -105,7 +105,7 @@ static ssize_t mei_dbgfs_read_active(struct file *fp, char __user *ubuf,mutex_lock (&dev->device_lock); -/* if the driver is not enabled the list won't b consitent */ +/* if the driver is not enabled the list won't be consistent */ if (dev->dev_state !=MEI_DEV_ENABLED ) goto out;
drivers/misc/mei/hw-txe.c +2 -2
@@ -841,7 +841,7 @@ static int mei_txe_hw_reset(struct mei_device *dev, bool intr_enable) }/* -* Set rediness RDY_CLR bit +* Set readiness RDY_CLR bit */ mei_txe_readiness_clear (dev);
@@ -867,7 +867,7 @@ static int mei_txe_hw_start(struct mei_device *dev) ret =mei_txe_readiness_wait (dev);if (ret <0 ) { -dev_err (dev->dev,"wating for readiness failed\n" ); +dev_err (dev->dev,"waiting for readiness failed\n" );return ret; }
Signature · 1 line
1.9.3
PATCH 2/4 mei: drop me_client_presentation_num
In reply to Tomas WinklerFrom: Alexander Usyskin <[email protected]>
me_client_presentation_num field is not used for any particular purpose now, so it can be safely dropped.
--- drivers/misc/mei/hbm.c | 2 -- drivers/misc/mei/mei_dev.h | 1 - 2 files changed, 3 deletions(-)
drivers/misc/mei/hbm.c +0 -2
@@ -126,7 +126,6 @@ static void mei_me_cl_remove_all(struct mei_device *dev)*/ void mei_hbm_reset (struct mei_device *dev) { - dev->me_client_presentation_num =0 ; dev->me_client_index =0 ;mei_me_cl_remove_all (dev);
@@ -883,7 +882,6 @@ int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)mei_hbm_me_cl_add (dev, props_res); dev->me_client_index++; - dev->me_client_presentation_num++;/* request property for the next client */ if (mei_hbm_prop_req (dev))
drivers/misc/mei/mei_dev.h +0 -1
@@ -470,7 +470,6 @@ struct mei_device {struct list_head me_clients;DECLARE_BITMAP (me_clients_map,MEI_CLIENTS_MAX );DECLARE_BITMAP (host_clients_map,MEI_CLIENTS_MAX ); -unsigned long me_client_presentation_num;unsigned long me_client_index;struct mei_cl wd_cl;
Signature · 1 line
1.9.3
PATCH 3/4 mei: fix KDoc documentation formatting
In reply to Tomas WinklerFrom: Alexander Usyskin <[email protected]>
Fix Kdoc documentation formatting warnings
genertaed by ./scripts/kernel-doc
--- drivers/misc/mei/amthif.c | 30 +++++++-------- drivers/misc/mei/client.c | 70 ++++++++++++++++++++--------------- drivers/misc/mei/debugfs.c | 7 +++- drivers/misc/mei/hbm.c | 43 +++++++++++----------- drivers/misc/mei/hw-me.c | 48 ++++++++++++------------ drivers/misc/mei/hw-txe.c | 57 +++++++++++++++------------- drivers/misc/mei/hw.h | 46 +++++++++++------------ drivers/misc/mei/init.c | 10 ++--- drivers/misc/mei/interrupt.c | 24 ++++++------ drivers/misc/mei/main.c | 21 +++++------ drivers/misc/mei/mei_dev.h | 88 ++++++++++++++++++++++---------------------- drivers/misc/mei/nfc.c | 3 +- drivers/misc/mei/pci-me.c | 4 +- drivers/misc/mei/pci-txe.c | 2 +- drivers/misc/mei/wd.c | 15 ++++---- 15 files changed, 243 insertions(+), 225 deletions(-)
drivers/misc/mei/amthif.c +13 -17
@@ -122,7 +122,7 @@ int mei_amthif_host_init(struct mei_device *dev)* @dev: the device structure * @file: pointer to file object * -* returns returned a list entry on success, NULL on failure. +* Return: returned a list entry on success, NULL on failure. */ struct mei_cl_cb *mei_amthif_find_read_list_entry (struct mei_device *dev,struct file *file)
@@ -140,15 +140,14 @@ struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev,* mei_amthif_read - read data from AMTHIF client * * @dev: the device structure -* @if_num: minor number * @file: pointer to file object -* @*ubuf: pointer to user data in user space +* @ubuf: pointer to user data in user space * @length: data length to read * @offset: data read offset * * Locking: called under "dev->device_lock" lock * -* returns +* Return: * returned data length on success, * zero if no data to read, * negative on failure.
@@ -256,7 +255,7 @@ out:* @dev: the device structure * @cb: mei call back struct * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. * */ static int mei_amthif_send_cmd (struct mei_device *dev,struct mei_cl_cb *cb)
@@ -326,7 +325,7 @@ static int mei_amthif_send_cmd(struct mei_device *dev, struct mei_cl_cb *cb)* @dev: the device structure * @cb: mei call back struct * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. * */ int mei_amthif_write (struct mei_device *dev,struct mei_cl_cb *cb)
@@ -356,8 +355,6 @@ int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *cb)* mei_amthif_run_next_cmd * * @dev: the device structure -* -* returns 0 on success, <0 on failure. */ void mei_amthif_run_next_cmd (struct mei_device *dev) {
@@ -420,12 +417,11 @@ unsigned int mei_amthif_poll(struct mei_device *dev,/** * mei_amthif_irq_write - write iamthif command in irq thread context. * -* @dev: the device structure. -* @cb_pos: callback block. * @cl: private data of the file object. +* @cb: callback block. * @cmpl_list: complete list. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ int mei_amthif_irq_write (struct mei_cl *cl,struct mei_cl_cb *cb,struct mei_cl_cb *cmpl_list)
@@ -507,7 +503,7 @@ int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,* @mei_hdr: header of amthif message * @complete_list: An instance of our list structure * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ int mei_amthif_irq_read_msg(struct mei_device *dev, struct mei_msg_hdr *mei_hdr,
@@ -560,7 +556,7 @@ int mei_amthif_irq_read_msg(struct mei_device *dev,* @dev: the device structure. * @slots: free slots. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ int mei_amthif_irq_read (struct mei_device *dev,s32 *slots) {
@@ -590,7 +586,7 @@ int mei_amthif_irq_read(struct mei_device *dev, s32 *slots)* mei_amthif_complete - complete amthif callback. * * @dev: the device structure. -* @cb_pos: callback block. +* @cb: callback block. */ void mei_amthif_complete (struct mei_device *dev,struct mei_cl_cb *cb) {
@@ -624,7 +620,7 @@ void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb)* mei_clear_list is called to clear resources associated with file * when application calls close function or Ctrl-C was pressed * -* returns true if callback removed from the list, false otherwise +* Return: true if callback removed from the list, false otherwise */ static bool mei_clear_list (struct mei_device *dev,const struct file *file,struct list_head *mei_cb_list)
@@ -664,7 +660,7 @@ static bool mei_clear_list(struct mei_device *dev,* mei_clear_lists is called to clear resources associated with file * when application calls close function or Ctrl-C was pressed * -* returns true if callback removed from the list, false otherwise +* Return: true if callback removed from the list, false otherwise */ static bool mei_clear_lists (struct mei_device *dev,struct file *file) {
@@ -705,7 +701,7 @@ static bool mei_clear_lists(struct mei_device *dev, struct file *file)* @dev: device structure * @file: pointer to file structure * -* returns 0 on success, <0 on error +* Return: 0 on success, <0 on error */ int mei_amthif_release (struct mei_device *dev,struct file *file) {
drivers/misc/mei/client.c +41 -29
224 lines not on this page · raw message
drivers/misc/mei/debugfs.c +5 -2
@@ -161,7 +161,8 @@ static const struct file_operations mei_dbgfs_fops_devstate = {/** * mei_dbgfs_deregister - Remove the debugfs files and directories -* @mei - pointer to mei device private data +* +* @dev: the mei device structure */ void mei_dbgfs_deregister (struct mei_device *dev) {
@@ -172,8 +173,10 @@ void mei_dbgfs_deregister(struct mei_device *dev) }/** -* Add the debugfs files +* mei_dbgfs_register - Add the debugfs files * +* @dev: the mei device structure +* @name: the mei device name */ int mei_dbgfs_register (struct mei_device *dev,const char *name) {
drivers/misc/mei/hbm.c +21 -22
159 lines not on this page · raw message
drivers/misc/mei/hw-me.c +24 -24
166 lines not on this page · raw message
drivers/misc/mei/hw-txe.c +32 -25
201 lines not on this page · raw message
drivers/misc/mei/hw.h +23 -23
77 lines not on this page · raw message
drivers/misc/mei/init.c +5 -5
@@ -56,11 +56,11 @@ const char *mei_pg_state_str(enum mei_pg_state state)/** -* mei_cancel_work. Cancel mei background jobs +* mei_cancel_work - Cancel mei background jobs * * @dev: the device structure * -* returns 0 on success or < 0 if the reset hasn't succeeded +* Return: 0 on success or < 0 if the reset hasn't succeeded */ void mei_cancel_work (struct mei_device *dev) {
@@ -175,7 +175,7 @@ EXPORT_SYMBOL_GPL(mei_reset);* * @dev: the device structure * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ int mei_start (struct mei_device *dev) {
@@ -244,7 +244,7 @@ EXPORT_SYMBOL_GPL(mei_start);* * @dev: the device structure * -* returns 0 on success or -ENODEV if the restart hasn't succeeded +* Return: 0 on success or -ENODEV if the restart hasn't succeeded */ int mei_restart (struct mei_device *dev) {
@@ -325,7 +325,7 @@ EXPORT_SYMBOL_GPL(mei_stop);* * @dev: the device structure * -* returns true of there is no pending write +* Return: true of there is no pending write */ bool mei_write_is_idle (struct mei_device *dev) {
drivers/misc/mei/interrupt.c +12 -12
@@ -33,8 +33,8 @@* mei_irq_compl_handler - dispatch complete handlers * for the completed callbacks * -* @dev - mei device -* @compl_list - list of completed cbs +* @dev: mei device +* @compl_list: list of completed cbs */ void mei_irq_compl_handler (struct mei_device *dev,struct mei_cl_cb *compl_list) {
@@ -62,7 +62,7 @@ EXPORT_SYMBOL_GPL(mei_irq_compl_handler);* @cl: host client * @mei_hdr: header of mei client message * -* returns true if matches, false otherwise +* Return: true if matches, false otherwise */ static inline int mei_cl_hbm_equal (struct mei_cl *cl,struct mei_msg_hdr *mei_hdr)
@@ -72,12 +72,12 @@ static inline int mei_cl_hbm_equal(struct mei_cl *cl, }/** * mei_cl_is_reading - checks if the client -is the one to read this message +* is the one to read this message * * @cl: mei client * @mei_hdr: header of mei message * -* returns true on match and false otherwise +* Return: true on match and false otherwise */ static bool mei_cl_is_reading (struct mei_cl *cl,struct mei_msg_hdr *mei_hdr) {
@@ -93,7 +93,7 @@ static bool mei_cl_is_reading(struct mei_cl *cl, struct mei_msg_hdr *mei_hdr)* @mei_hdr: header of mei client message * @complete_list: An instance of our list structure * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ static int mei_cl_irq_read_msg(struct mei_device *dev, struct mei_msg_hdr *mei_hdr,
@@ -165,7 +165,7 @@ static int mei_cl_irq_read_msg(struct mei_device *dev,* @cb: callback block. * @cmpl_list: complete list. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ static int mei_cl_irq_disconnect_rsp (struct mei_cl *cl,struct mei_cl_cb *cb,struct mei_cl_cb *cmpl_list)
@@ -201,7 +201,7 @@ static int mei_cl_irq_disconnect_rsp(struct mei_cl *cl, struct mei_cl_cb *cb,* @cb: callback block. * @cmpl_list: complete list. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ static int mei_cl_irq_disconnect (struct mei_cl *cl,struct mei_cl_cb *cb,struct mei_cl_cb *cmpl_list)
@@ -241,7 +241,7 @@ static int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,* @cb: callback block. * @cmpl_list: complete list. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ static int mei_cl_irq_read (struct mei_cl *cl,struct mei_cl_cb *cb,struct mei_cl_cb *cmpl_list)
@@ -278,7 +278,7 @@ static int mei_cl_irq_read(struct mei_cl *cl, struct mei_cl_cb *cb,* @cb: callback block. * @cmpl_list: complete list. * -* returns 0, OK; otherwise, error. +* Return: 0, OK; otherwise, error. */ static int mei_cl_irq_connect (struct mei_cl *cl,struct mei_cl_cb *cb,struct mei_cl_cb *cmpl_list)
@@ -321,7 +321,7 @@ static int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,* @cmpl_list: An instance of our list structure * @slots: slots to read. * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ int mei_irq_read_handler (struct mei_device *dev,struct mei_cl_cb *cmpl_list,s32 *slots)
@@ -424,7 +424,7 @@ EXPORT_SYMBOL_GPL(mei_irq_read_handler);* @dev: the device structure * @cmpl_list: An instance of our list structure * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ int mei_irq_write_handler (struct mei_device *dev,struct mei_cl_cb *cmpl_list) {
drivers/misc/mei/main.c +10 -11
@@ -44,7 +44,7 @@* @inode: pointer to inode structure * @file: pointer to file structure * -* returns 0 on success, <0 on error +* Return: 0 on success, <0 on error */ static int mei_open (struct inode *inode,struct file *file) {
@@ -96,7 +96,7 @@ err_unlock:* @inode: pointer to inode structure * @file: pointer to file structure * -* returns 0 on success, <0 on error +* Return: 0 on success, <0 on error */ static int mei_release (struct inode *inode,struct file *file) {
@@ -157,7 +157,7 @@ out:* @length: buffer length * @offset: data offset in buffer * -* returns >=0 data length on success , <0 on error +* Return: >=0 data length on success , <0 on error */ static ssize_t mei_read (struct file *file,char __user *ubuf,size_t length,loff_t *offset)
@@ -297,7 +297,7 @@ out:* @length: buffer length * @offset: data offset in buffer * -* returns >=0 data length on success , <0 on error +* Return: >=0 data length on success , <0 on error */ static ssize_t mei_write (struct file *file,const char __user *ubuf,size_t length,loff_t *offset)
@@ -414,13 +414,12 @@ out:/** * mei_ioctl_connect_client - the connect to fw client IOCTL function * -* @dev: the device structure -* @data: IOCTL connect data, input and output parameters * @file: private data of the file object +* @data: IOCTL connect data, input and output parameters * * Locking: called under "dev->device_lock" lock * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ static int mei_ioctl_connect_client (struct file *file,struct mei_connect_client_data *data)
@@ -509,7 +508,7 @@ end:* @cmd: ioctl command * @data: pointer to mei message structure * -* returns 0 on success , <0 on error +* Return: 0 on success , <0 on error */ static long mei_ioctl (struct file *file,unsigned int cmd,unsigned long data) {
@@ -573,7 +572,7 @@ out:* @cmd: ioctl command * @data: pointer to mei message structure * -* returns 0 on success , <0 on error +* Return: 0 on success , <0 on error */ #ifdef CONFIG_COMPAT static long mei_compat_ioctl(struct file *file,
@@ -590,7 +589,7 @@ static long mei_compat_ioctl(struct file *file,* @file: pointer to file structure * @wait: pointer to poll_table structure * -* returns poll mask +* Return: poll mask */ static unsigned int mei_poll (struct file *file,poll_table *wait) {
@@ -660,7 +659,7 @@ static DEFINE_IDR(mei_idr);* * @dev: device pointer * -* returns allocated minor, or -ENOSPC if no free minor left +* Return: allocated minor, or -ENOSPC if no free minor left */ static int mei_minor_get (struct mei_device *dev) {
drivers/misc/mei/mei_dev.h +45 -43
157 lines not on this page · raw message
drivers/misc/mei/nfc.c +2 -1
@@ -88,7 +88,8 @@ struct mei_nfc_hci_hdr {#define MEI_NFC_HEADER_SIZE 10 -/** mei_nfc_dev - NFC mei device +/** +* struct mei_nfc_dev - NFC mei device * * @cl: NFC host client * @cl_info: NFC info host client
drivers/misc/mei/pci-me.c +2 -2
@@ -103,7 +103,7 @@ static inline void mei_me_unset_pm_domain(struct mei_device *dev) {}* @pdev: PCI device structure * @cfg: per generation config * -* returns true if ME Interface is valid, false otherwise +* Return: true if ME Interface is valid, false otherwise */ static bool mei_me_quirk_probe (struct pci_dev *pdev,const struct mei_cfg *cfg)
@@ -122,7 +122,7 @@ static bool mei_me_quirk_probe(struct pci_dev *pdev,* @pdev: PCI device structure * @ent: entry in kcs_pci_tbl * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ static int mei_me_probe (struct pci_dev *pdev,const struct pci_device_id *ent) {
drivers/misc/mei/pci-txe.c +1 -1
@@ -67,7 +67,7 @@ static void mei_txe_pci_iounmap(struct pci_dev *pdev, struct mei_txe_hw *hw)* @pdev: PCI device structure * @ent: entry in mei_txe_pci_tbl * -* returns 0 on success, <0 on failure. +* Return: 0 on success, <0 on failure. */ static int mei_txe_probe (struct pci_dev *pdev,const struct pci_device_id *ent) {
drivers/misc/mei/wd.c +7 -8
@@ -51,7 +51,7 @@ static void mei_wd_set_start_timeout(struct mei_device *dev, u16 timeout)* * @dev: the device structure * -* returns -ENOTTY if wd client cannot be found +* Return: -ENOTTY if wd client cannot be found * -EIO if write has failed * 0 on success */
@@ -105,7 +105,7 @@ int mei_wd_host_init(struct mei_device *dev)* * @dev: the device structure * -* returns 0 if success, +* Return: 0 if success, * -EIO when message send fails * -EINVAL when invalid message is to be sent * -ENODEV on flow control failure
@@ -150,9 +150,8 @@ int mei_wd_send(struct mei_device *dev)* mei_wd_stop - sends watchdog stop message to fw. * * @dev: the device structure -* @preserve: indicate if to keep the timeout value * -* returns 0 if success +* Return: 0 if success * on error: * -EIO when message send fails * -EINVAL when invalid message is to be sent
@@ -207,7 +206,7 @@ err:* * @wd_dev - watchdog device struct * -* returns 0 if success, negative errno code for failure +* Return: 0 if success, negative errno code for failure */ static int mei_wd_ops_start (struct watchdog_device *wd_dev) {
@@ -244,7 +243,7 @@ end_unlock:* * @wd_dev - watchdog device struct * -* returns 0 if success, negative errno code for failure +* Return: 0 if success, negative errno code for failure */ static int mei_wd_ops_stop (struct watchdog_device *wd_dev) {
@@ -266,7 +265,7 @@ static int mei_wd_ops_stop(struct watchdog_device *wd_dev)* * @wd_dev - watchdog device struct * -* returns 0 if success, negative errno code for failure +* Return: 0 if success, negative errno code for failure */ static int mei_wd_ops_ping (struct watchdog_device *wd_dev) {
@@ -314,7 +313,7 @@ end:* @wd_dev - watchdog device struct * @timeout - timeout value to set * -* returns 0 if success, negative errno code for failure +* Return: 0 if success, negative errno code for failure */ static int mei_wd_ops_set_timeout (struct watchdog_device *wd_dev,unsigned int timeout)
Signature · 1 line
1.9.3
PATCH 4/4 mei: fix kernel-doc warnings
In reply to Tomas WinklerFrom: Alexander Usyskin <[email protected]>
Add missed parameters descriptions and return values descriptions
--- drivers/misc/mei/amthif.c | 5 +- drivers/misc/mei/client.c | 6 ++ drivers/misc/mei/debugfs.c | 2 + drivers/misc/mei/hbm.c | 2 + drivers/misc/mei/hw-me.c | 41 ++++++++++-- drivers/misc/mei/hw-me.h | 6 ++ drivers/misc/mei/hw-txe.c | 63 ++++++++++++------ drivers/misc/mei/hw-txe.h | 1 + drivers/misc/mei/hw.h | 2 + drivers/misc/mei/init.c | 4 +- drivers/misc/mei/interrupt.c | 4 +- drivers/misc/mei/mei_dev.h | 151 +++++++++++++++++++++++++++++++++---------- drivers/misc/mei/nfc.c | 5 ++ drivers/misc/mei/pci-me.c | 6 +- 14 files changed, 231 insertions(+), 67 deletions(-)
drivers/misc/mei/amthif.c +3 -2
@@ -64,6 +64,7 @@ void mei_amthif_reset_params(struct mei_device *dev)* * @dev: the device structure * +* Return: 0 on success, <0 on failure. */ int mei_amthif_host_init (struct mei_device *dev) {
@@ -352,7 +353,7 @@ int mei_amthif_write(struct mei_device *dev, struct mei_cl_cb *cb)return mei_amthif_send_cmd (dev, cb); }/** -* mei_amthif_run_next_cmd +* mei_amthif_run_next_cmd - send next amt command from queue * * @dev: the device structure */
@@ -496,7 +497,7 @@ int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, }/** -* mei_amthif_irq_read_message - read routine after ISR to +* mei_amthif_irq_read_msg - read routine after ISR to * handle the read amthif message * * @dev: the device structure
drivers/misc/mei/client.c +6 -0
@@ -271,6 +271,8 @@ int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length)* mei_cl_flush_queues - flushes queue lists belonging to cl. * * @cl: host client +* +* Return: 0 on success, -EINVAL if cl or cl->dev is NULL. */ int mei_cl_flush_queues (struct mei_cl *cl) {
@@ -402,6 +404,8 @@ int mei_cl_link(struct mei_cl *cl, int id)* mei_cl_unlink - remove me_cl from the list * * @cl: host client +* +* Return: always 0 */ int mei_cl_unlink (struct mei_cl *cl) {
@@ -756,6 +760,7 @@ int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)* mei_cl_read_start - the start read client message function. * * @cl: host client +* @length: number of bytes to read * * Return: 0 on success, <0 on failure. */
@@ -916,6 +921,7 @@ int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,* * @cl: host client * @cb: write callback with filled data +* @blocking: block until completed * * Return: number of bytes sent on success, <0 on failure. */
drivers/misc/mei/debugfs.c +2 -0
@@ -177,6 +177,8 @@ void mei_dbgfs_deregister(struct mei_device *dev)* * @dev: the mei device structure * @name: the mei device name +* +* Return: 0 on success, <0 on failure. */ int mei_dbgfs_register (struct mei_device *dev,const char *name) {
drivers/misc/mei/hbm.c +2 -0
@@ -176,6 +176,8 @@ void mei_hbm_cl_hdr(struct mei_cl *cl, u8 hbm_cmd, void *buf, size_t len)* @cl: client * @hbm_cmd: host bus message command * @len: buffer length +* +* Return: 0 on success, <0 on failure. */ static inline int mei_hbm_cl_write(struct mei_device *dev,
drivers/misc/mei/hw-me.c +34 -7
114 lines not on this page · raw message
drivers/misc/mei/hw-me.h +6 -0
@@ -47,7 +47,13 @@ struct mei_cfg {#define MEI_ME_RPM_TIMEOUT 500/* ms */ /** +* struct mei_me_hw - me hw specific data +* * @cfg: per device generation config and ops +* @mem_addr: io memory address +* @host_hw_state: cached host state +* @me_hw_state: cached me (fw) state +* @pg_state: power gating state */ struct mei_me_hw {const struct mei_cfg *cfg;
drivers/misc/mei/hw-txe.c +45 -18
222 lines not on this page · raw message
drivers/misc/mei/hw-txe.h +1 -0
@@ -40,6 +40,7 @@* @mem_addr: SeC and BRIDGE bars * @aliveness: aliveness (power gating) state of the hardware * @readiness: readiness state of the hardware +* @slots: number of empty slots * @wait_aliveness_resp: aliveness wait queue * @intr_cause: translated interrupt cause */
drivers/misc/mei/hw.h +2 -0
@@ -109,6 +109,8 @@ enum mei_stop_reason_types {* @MEI_HBMS_NOT_ALLOWED : operation not allowed * @MEI_HBMS_ALREADY_STARTED : system is already started * @MEI_HBMS_NOT_STARTED : system not started +* +* @MEI_HBMS_MAX : sentinel */ enum mei_hbm_status {MEI_HBMS_SUCCESS =0 ,
drivers/misc/mei/init.c +2 -2
@@ -59,8 +59,6 @@ const char *mei_pg_state_str(enum mei_pg_state state)* mei_cancel_work - Cancel mei background jobs * * @dev: the device structure -* -* Return: 0 on success or < 0 if the reset hasn't succeeded */ void mei_cancel_work (struct mei_device *dev) {
@@ -75,6 +73,8 @@ EXPORT_SYMBOL_GPL(mei_cancel_work);* mei_reset - resets host and fw. * * @dev: the device structure +* +* Return: 0 on success or < 0 if the reset hasn't succeeded */ int mei_reset (struct mei_device *dev) {
drivers/misc/mei/interrupt.c +2 -2
@@ -87,7 +87,7 @@ static bool mei_cl_is_reading(struct mei_cl *cl, struct mei_msg_hdr *mei_hdr) }/** -* mei_irq_read_client_message - process client message +* mei_cl_irq_read_msg - process client message * * @dev: the device structure * @mei_hdr: header of mei client message
@@ -234,7 +234,7 @@ static int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,/** -* mei_cl_irq_close - processes client read related operation from the +* mei_cl_irq_read - processes client read related operation from the * interrupt thread context - request for flow control credits * * @cl: client
drivers/misc/mei/mei_dev.h +118 -33
234 lines not on this page · raw message
drivers/misc/mei/nfc.c +5 -0
@@ -94,9 +94,14 @@ struct mei_nfc_hci_hdr {* @cl: NFC host client * @cl_info: NFC info host client * @init_work: perform connection to the info client +* @send_wq: send completion wait queue * @fw_ivn: NFC Interface Version Number * @vendor_id: NFC manufacturer ID * @radio_type: NFC radio type +* @bus_name: bus name +* +* @req_id: message counter +* @recv_req_id: reception message counter */ struct mei_nfc_dev {struct mei_cl *cl;
drivers/misc/mei/pci-me.c +3 -3
@@ -98,7 +98,7 @@ static inline void mei_me_unset_pm_domain(struct mei_device *dev) {}#endif /* CONFIG_PM_RUNTIME */ /** -* mei_quirk_probe - probe for devices that doesn't valid ME interface +* mei_me_quirk_probe - probe for devices that doesn't valid ME interface * * @pdev: PCI device structure * @cfg: per generation config
@@ -117,7 +117,7 @@ static bool mei_me_quirk_probe(struct pci_dev *pdev, }/** -* mei_probe - Device Initialization Routine +* mei_me_probe - Device Initialization Routine * * @pdev: PCI device structure * @ent: entry in kcs_pci_tbl
@@ -249,7 +249,7 @@ end: }/** -* mei_remove - Device Removal Routine +* mei_me_remove - Device Removal Routine * * @pdev: PCI device structure *
Signature · 1 line
1.9.3
Greg KH
maintainerQuoted 3 lines · Tomas Winkler
Overall documentation formating fix and other collateral fixes.
Didn't apply :(