Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a8605ea2 authored by Alexander Usyskin's avatar Alexander Usyskin Committed by Greg Kroah-Hartman
Browse files

mei: fix KDoc documentation formatting 



Fix Kdoc documentation formatting warnings
genertaed by ./scripts/kernel-doc

Signed-off-by: default avatarAlexander Usyskin <alexander.usyskin@intel.com>
Signed-off-by: default avatarTomas Winkler <tomas.winkler@intel.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 764c065a

drivers/misc/mei/amthif.c

+13 −17
Original line number Diff line number Diff line
@@ -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 @@ int mei_amthif_read(struct mei_device *dev, struct file *file, 
 * @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
Original line number Diff line number Diff line
@@ -27,13 +27,14 @@ 
#include "client.h"



/**

 * mei_me_cl_by_uuid - locate index of me client

 * mei_me_cl_by_uuid - locate me client by uuid

 *

 * @dev: mei device

 * @uuid: me client uuid

 *

 * Locking: called under "dev->device_lock" lock

 *

 * returns me client or NULL if not found

 * Return: me client or NULL if not found

 */

struct mei_me_client *mei_me_cl_by_uuid(const struct mei_device *dev,

					const uuid_le *uuid)
@@ -48,16 +49,15 @@ struct mei_me_client *mei_me_cl_by_uuid(const struct mei_device *dev, 
}



/**

 * mei_me_cl_by_id return index to me_clients for client_id

 * mei_me_cl_by_id - locate me client by client id

 *

 * @dev: the device structure

 * @client_id: me client id

 *

 * Locking: called under "dev->device_lock" lock

 *

 * returns me client or NULL if not found

 * Return: me client or NULL if not found

 */



struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id)

{
@@ -69,6 +69,17 @@ struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id) 
	return NULL;

}



/**

 * mei_me_cl_by_uuid_id - locate me client by client id and uuid

 *

 * @dev: the device structure

 * @uuid: me client uuid

 * @client_id: me client id

 *

 * Locking: called under "dev->device_lock" lock

 *

 * Return: me client or NULL if not found

 */

struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,

					   const uuid_le *uuid, u8 client_id)

{
@@ -109,7 +120,7 @@ void mei_me_cl_remove(struct mei_device *dev, const uuid_le *uuid, u8 client_id) 
 * @cl1: host client 1

 * @cl2: host client 2

 *

 * returns true  - if the clients has same host and me ids

 * Return: true  - if the clients has same host and me ids

 *         false - otherwise

 */

static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
@@ -184,10 +195,10 @@ void mei_io_cb_free(struct mei_cl_cb *cb) 
/**

 * mei_io_cb_init - allocate and initialize io callback

 *

 * @cl - mei client

 * @cl: mei client

 * @fp: pointer to file structure

 *

 * returns mei_cl_cb pointer or NULL;

 * Return: mei_cl_cb pointer or NULL;

 */

struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp)

{
@@ -211,7 +222,7 @@ struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp) 
 * @cb: io callback structure

 * @length: size of the buffer

 *

 * returns 0 on success

 * Return: 0 on success

 *         -EINVAL if cb is NULL

 *         -ENOMEM if allocation failed

 */
@@ -235,7 +246,7 @@ int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length) 
 * @cb: io callback structure

 * @length: size of the buffer

 *

 * returns 0 on success

 * Return: 0 on success

 *         -EINVAL if cb is NULL

 *         -ENOMEM if allocation failed

 */
@@ -305,7 +316,7 @@ void mei_cl_init(struct mei_cl *cl, struct mei_device *dev) 
 * mei_cl_allocate - allocates cl  structure and sets it up.

 *

 * @dev: mei device

 * returns  The allocated file or NULL on failure

 * Return:  The allocated file or NULL on failure

 */

struct mei_cl *mei_cl_allocate(struct mei_device *dev)

{
@@ -325,7 +336,7 @@ struct mei_cl *mei_cl_allocate(struct mei_device *dev) 
 *

 * @cl: host client

 *

 * returns cb on success, NULL on error

 * Return: cb on success, NULL on error

 */

struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl)

{
@@ -343,7 +354,7 @@ struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl) 
 * @cl - host client

 * @id - fixed host id or -1 for generic one

 *

 * returns 0 on success

 * Return: 0 on success

 *	-EINVAL on incorrect values

 *	-ENONET if client not found

 */
@@ -455,10 +466,10 @@ void mei_host_client_init(struct work_struct *work) 
}



/**

 * mei_hbuf_acquire: try to acquire host buffer

 * mei_hbuf_acquire - try to acquire host buffer

 *

 * @dev: the device structure

 * returns true if host buffer was acquired

 * Return: true if host buffer was acquired

 */

bool mei_hbuf_acquire(struct mei_device *dev)

{
@@ -485,7 +496,7 @@ bool mei_hbuf_acquire(struct mei_device *dev) 
 *

 * Locking: called under "dev->device_lock" lock

 *

 * returns 0 on success, <0 on failure.

 * Return: 0 on success, <0 on failure.

 */

int mei_cl_disconnect(struct mei_cl *cl)

{
@@ -566,7 +577,7 @@ int mei_cl_disconnect(struct mei_cl *cl) 
 *

 * @cl: private data of the file object

 *

 * returns true if other client is connected, false - otherwise.

 * Return: true if other client is connected, false - otherwise.

 */

bool mei_cl_is_other_connecting(struct mei_cl *cl)

{
@@ -593,10 +604,11 @@ bool mei_cl_is_other_connecting(struct mei_cl *cl) 
 * mei_cl_connect - connect host client to the me one

 *

 * @cl: host client

 * @file: pointer to file structure

 *

 * Locking: called under "dev->device_lock" lock

 *

 * returns 0 on success, <0 on failure.

 * Return: 0 on success, <0 on failure.

 */

int mei_cl_connect(struct mei_cl *cl, struct file *file)

{
@@ -671,7 +683,7 @@ int mei_cl_connect(struct mei_cl *cl, struct file *file) 
 *

 * @cl: private data of the file object

 *

 * returns 1 if mei_flow_ctrl_creds >0, 0 - otherwise.

 * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.

 *	-ENOENT if mei_cl is not present

 *	-EINVAL if single_recv_buf == 0

 */
@@ -707,7 +719,7 @@ int mei_cl_flow_ctrl_creds(struct mei_cl *cl) 
 *

 * @cl: private data of the file object

 *

 * @returns

 * Return:

 *	0 on success

 *	-ENOENT when me client is not found

 *	-EINVAL when ctrl credits are <= 0
@@ -745,7 +757,7 @@ int mei_cl_flow_ctrl_reduce(struct mei_cl *cl) 
 *

 * @cl: host client

 *

 * returns 0 on success, <0 on failure.

 * Return: 0 on success, <0 on failure.

 */

int mei_cl_read_start(struct mei_cl *cl, size_t length)

{
@@ -823,7 +835,7 @@ int mei_cl_read_start(struct mei_cl *cl, size_t length) 
 * @cb: callback block.

 * @cmpl_list: complete list.

 *

 * returns 0, OK; otherwise error.

 * Return: 0, OK; otherwise error.

 */

int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,

		     struct mei_cl_cb *cmpl_list)
@@ -900,12 +912,12 @@ int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, 


/**

 * mei_cl_write - submit a write cb to mei device

	assumes device_lock is locked

 *	assumes device_lock is locked

 *

 * @cl: host client

 * @cl: write callback with filled data

 * @cb: write callback with filled data

 *

 * returns number of bytes sent on success, <0 on failure.

 * Return: number of bytes sent on success, <0 on failure.

 */

int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)

{
@@ -1042,7 +1054,7 @@ void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb) 
/**

 * mei_cl_all_disconnect - disconnect forcefully all connected clients

 *

 * @dev - mei device

 * @dev: mei device

 */



void mei_cl_all_disconnect(struct mei_device *dev)
@@ -1060,7 +1072,7 @@ void mei_cl_all_disconnect(struct mei_device *dev) 
/**

 * mei_cl_all_wakeup  - wake up all readers and writers they can be interrupted

 *

 * @dev  - mei device

 * @dev: mei device

 */

void mei_cl_all_wakeup(struct mei_device *dev)

{
@@ -1080,8 +1092,8 @@ void mei_cl_all_wakeup(struct mei_device *dev) 


/**

 * mei_cl_all_write_clear - clear all pending writes



 * @dev - mei device

 *

 * @dev: mei device

 */

void mei_cl_all_write_clear(struct mei_device *dev)

{

drivers/misc/mei/debugfs.c

+5 −2
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ const char *mei_hbm_state_str(enum mei_hbm_state state) 
 *

 * @status: client connect response status

 *

 * returns corresponding error code

 * Return: corresponding error code

 */

static int mei_cl_conn_status_to_errno(enum mei_cl_connect_status status)

{
@@ -196,7 +196,7 @@ int mei_hbm_cl_write(struct mei_device *dev, 
 * @cl: client

 * @cmd: hbm client message

 *

 * returns true if addresses are the same

 * Return: true if addresses are the same

 */

static inline

bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd)
@@ -211,7 +211,7 @@ bool mei_hbm_cl_addr_equal(struct mei_cl *cl, struct mei_hbm_cl_cmd *cmd) 
 * @dev: the device structure

 * @buf: a buffer with hbm cl command

 *

 * returns the recipient client or NULL if not found

 * Return: the recipient client or NULL if not found

 */

static inline

struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf)
@@ -231,7 +231,7 @@ struct mei_cl *mei_hbm_cl_find_by_cmd(struct mei_device *dev, void *buf) 
 *

 * @dev: the device structure

 *

 * returns 0 on success and < 0 on failure

 * Return: 0 on success and < 0 on failure

 */

int mei_hbm_start_wait(struct mei_device *dev)

{
@@ -259,7 +259,7 @@ int mei_hbm_start_wait(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns 0 on success and < 0 on failure

 * Return: 0 on success and < 0 on failure

 */

int mei_hbm_start_req(struct mei_device *dev)

{
@@ -297,7 +297,7 @@ int mei_hbm_start_req(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns 0 on success and < 0 on failure

 * Return: 0 on success and < 0 on failure

 */

static int mei_hbm_enum_clients_req(struct mei_device *dev)

{
@@ -330,7 +330,7 @@ static int mei_hbm_enum_clients_req(struct mei_device *dev) 
 * @dev: the device structure

 * @res: hbm property response

 *

 * returns 0 on success and -ENOMEM on allocation failure

 * Return: 0 on success and -ENOMEM on allocation failure

 */



static int mei_hbm_me_cl_add(struct mei_device *dev,
@@ -355,7 +355,7 @@ static int mei_hbm_me_cl_add(struct mei_device *dev, 
 *

 * @dev: the device structure

 *

 * returns 0 on success and < 0 on failure

 * Return: 0 on success and < 0 on failure

 */



static int mei_hbm_prop_req(struct mei_device *dev)
@@ -405,7 +405,7 @@ static int mei_hbm_prop_req(struct mei_device *dev) 
 * @dev: the device structure

 * @pg_cmd: the pg command code

 *

 * returns -EIO on write failure

 * Return: -EIO on write failure

 *         -EOPNOTSUPP if the operation is not supported by the protocol

 */

int mei_hbm_pg(struct mei_device *dev, u8 pg_cmd)
@@ -434,10 +434,9 @@ EXPORT_SYMBOL_GPL(mei_hbm_pg); 
/**

 * mei_hbm_stop_req - send stop request message

 *

 * @dev - mei device

 * @cl: client info

 * @dev: mei device

 *

 * This function returns -EIO on write failure

 * Return: -EIO on write failure

 */

static int mei_hbm_stop_req(struct mei_device *dev)

{
@@ -461,7 +460,7 @@ static int mei_hbm_stop_req(struct mei_device *dev) 
 * @dev: the device structure

 * @cl: client info

 *

 * This function returns -EIO on write failure

 * Return: -EIO on write failure

 */

int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl)

{
@@ -477,7 +476,7 @@ int mei_hbm_cl_flow_control_req(struct mei_device *dev, struct mei_cl *cl) 
 * @dev: the device structure

 * @flow: flow control.

 *

 * return 0 on success, < 0 otherwise

 * Return: 0 on success, < 0 otherwise

 */

static int mei_hbm_add_single_flow_creds(struct mei_device *dev,

				  struct hbm_flow_control *flow)
@@ -533,7 +532,7 @@ static void mei_hbm_cl_flow_control_res(struct mei_device *dev, 
 * @dev: the device structure

 * @cl: a client to disconnect from

 *

 * This function returns -EIO on write failure

 * Return: -EIO on write failure

 */

int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)

{
@@ -548,7 +547,7 @@ int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl) 
 * @dev: the device structure

 * @cl: a client to disconnect from

 *

 * This function returns -EIO on write failure

 * Return: -EIO on write failure

 */

int mei_hbm_cl_disconnect_rsp(struct mei_device *dev, struct mei_cl *cl)

{
@@ -584,7 +583,7 @@ static void mei_hbm_cl_disconnect_res(struct mei_cl *cl, 
 * @dev: the device structure

 * @cl: a client to connect to

 *

 * returns -EIO on write failure

 * Return: -EIO on write failure

 */

int mei_hbm_cl_connect_req(struct mei_device *dev, struct mei_cl *cl)

{
@@ -677,7 +676,7 @@ static void mei_hbm_cl_res(struct mei_device *dev, 
 * @dev: the device structure.

 * @disconnect_req: disconnect request bus message from the me

 *

 * returns -ENOMEM on allocation failure

 * Return: -ENOMEM on allocation failure

 */

static int mei_hbm_fw_disconnect_req(struct mei_device *dev,

		struct hbm_client_connect_request *disconnect_req)
@@ -702,7 +701,7 @@ static int mei_hbm_fw_disconnect_req(struct mei_device *dev, 
}



/**

 * mei_hbm_config_features: check what hbm features and commands

 * mei_hbm_config_features - check what hbm features and commands

 *        are supported by the fw

 *

 * @dev: the device structure
@@ -724,7 +723,7 @@ static void mei_hbm_config_features(struct mei_device *dev) 
 *     support the hbm version of the device

 *

 * @dev: the device structure

 * returns true if driver can support hbm version of the device

 * Return: true if driver can support hbm version of the device

 */

bool mei_hbm_version_is_supported(struct mei_device *dev)

{
@@ -738,9 +737,9 @@ bool mei_hbm_version_is_supported(struct mei_device *dev) 
 * handle the read bus message cmd processing.

 *

 * @dev: the device structure

 * @mei_hdr: header of bus message

 * @hdr: header of bus message

 *

 * returns 0 on success and < 0 on failure

 * Return: 0 on success and < 0 on failure

 */

int mei_hbm_dispatch(struct mei_device *dev, struct mei_msg_hdr *hdr)

{

drivers/misc/mei/hw-me.c

+24 −24
Original line number Diff line number Diff line
@@ -28,10 +28,10 @@ 
/**

 * mei_me_reg_read - Reads 32bit data from the mei device

 *

 * @dev: the device structure

 * @hw: the me hardware structure

 * @offset: offset from which to read the data

 *

 * returns register value (u32)

 * Return: register value (u32)

 */

static inline u32 mei_me_reg_read(const struct mei_me_hw *hw,

			       unsigned long offset)
@@ -43,7 +43,7 @@ static inline u32 mei_me_reg_read(const struct mei_me_hw *hw, 
/**

 * mei_me_reg_write - Writes 32bit data to the mei device

 *

 * @dev: the device structure

 * @hw: the me hardware structure

 * @offset: offset from which to write the data

 * @value: register value to write (u32)

 */
@@ -59,7 +59,7 @@ static inline void mei_me_reg_write(const struct mei_me_hw *hw, 
 *

 * @dev: the device structure

 *

 * returns ME_CB_RW register value (u32)

 * Return: ME_CB_RW register value (u32)

 */

static u32 mei_me_mecbrw_read(const struct mei_device *dev)

{
@@ -68,9 +68,9 @@ static u32 mei_me_mecbrw_read(const struct mei_device *dev) 
/**

 * mei_me_mecsr_read - Reads 32bit data from the ME CSR

 *

 * @dev: the device structure

 * @hw: the me hardware structure

 *

 * returns ME_CSR_HA register value (u32)

 * Return: ME_CSR_HA register value (u32)

 */

static inline u32 mei_me_mecsr_read(const struct mei_me_hw *hw)

{
@@ -80,9 +80,9 @@ static inline u32 mei_me_mecsr_read(const struct mei_me_hw *hw) 
/**

 * mei_hcsr_read - Reads 32bit data from the host CSR

 *

 * @dev: the device structure

 * @hw: the me hardware structure

 *

 * returns H_CSR register value (u32)

 * Return: H_CSR register value (u32)

 */

static inline u32 mei_hcsr_read(const struct mei_me_hw *hw)

{
@@ -93,7 +93,7 @@ static inline u32 mei_hcsr_read(const struct mei_me_hw *hw) 
 * mei_hcsr_set - writes H_CSR register to the mei device,

 * and ignores the H_IS bit for it is write-one-to-zero.

 *

 * @dev: the device structure

 * @hw: the me hardware structure

 */

static inline void mei_hcsr_set(struct mei_me_hw *hw, u32 hcsr)

{
@@ -274,8 +274,8 @@ static void mei_me_host_set_ready(struct mei_device *dev) 
/**

 * mei_me_host_is_ready - check whether the host has turned ready

 *

 * @dev - mei device

 * returns bool

 * @dev: mei device

 * Return: bool

 */

static bool mei_me_host_is_ready(struct mei_device *dev)

{
@@ -288,8 +288,8 @@ static bool mei_me_host_is_ready(struct mei_device *dev) 
/**

 * mei_me_hw_is_ready - check whether the me(hw) has turned ready

 *

 * @dev - mei device

 * returns bool

 * @dev: mei device

 * Return: bool

 */

static bool mei_me_hw_is_ready(struct mei_device *dev)

{
@@ -333,7 +333,7 @@ static int mei_me_hw_start(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns number of filled slots

 * Return: number of filled slots

 */

static unsigned char mei_hbuf_filled_slots(struct mei_device *dev)

{
@@ -353,7 +353,7 @@ static unsigned char mei_hbuf_filled_slots(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns true if empty, false - otherwise.

 * Return: true if empty, false - otherwise.

 */

static bool mei_me_hbuf_is_empty(struct mei_device *dev)

{
@@ -365,7 +365,7 @@ static bool mei_me_hbuf_is_empty(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns -EOVERFLOW if overflow, otherwise empty slots count

 * Return: -EOVERFLOW if overflow, otherwise empty slots count

 */

static int mei_me_hbuf_empty_slots(struct mei_device *dev)

{
@@ -394,7 +394,7 @@ static size_t mei_me_hbuf_max_len(const struct mei_device *dev) 
 * @header: mei HECI header of message

 * @buf: message payload will be written

 *

 * This function returns -EIO if write has failed

 * Return: -EIO if write has failed

 */

static int mei_me_write_message(struct mei_device *dev,

			struct mei_msg_hdr *header,
@@ -444,7 +444,7 @@ static int mei_me_write_message(struct mei_device *dev, 
 *

 * @dev: the device structure

 *

 * returns -EOVERFLOW if overflow, otherwise filled slots count

 * Return: -EOVERFLOW if overflow, otherwise filled slots count

 */

static int mei_me_count_full_read_slots(struct mei_device *dev)

{
@@ -529,7 +529,7 @@ static void mei_me_pg_exit(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns 0 on success an error code otherwise

 * Return: 0 on success an error code otherwise

 */

int mei_me_pg_set_sync(struct mei_device *dev)

{
@@ -566,7 +566,7 @@ int mei_me_pg_set_sync(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns 0 on success an error code otherwise

 * Return: 0 on success an error code otherwise

 */

int mei_me_pg_unset_sync(struct mei_device *dev)

{
@@ -603,7 +603,7 @@ int mei_me_pg_unset_sync(struct mei_device *dev) 
 *

 * @dev: the device structure

 *

 * returns: true is pg supported, false otherwise

 * Return: true is pg supported, false otherwise

 */

static bool mei_me_pg_is_enabled(struct mei_device *dev)

{
@@ -635,7 +635,7 @@ static bool mei_me_pg_is_enabled(struct mei_device *dev) 
 * @irq: The irq number

 * @dev_id: pointer to the device structure

 *

 * returns irqreturn_t

 * Return: irqreturn_t

 */



irqreturn_t mei_me_irq_quick_handler(int irq, void *dev_id)
@@ -660,7 +660,7 @@ irqreturn_t mei_me_irq_quick_handler(int irq, void *dev_id) 
 * @irq: The irq number

 * @dev_id: pointer to the device structure

 *

 * returns irqreturn_t

 * Return: irqreturn_t

 *

 */

irqreturn_t mei_me_irq_thread_handler(int irq, void *dev_id)
@@ -841,7 +841,7 @@ const struct mei_cfg mei_me_lpt_cfg = { 
 * @pdev: The pci device structure

 * @cfg: per device generation config

 *

 * returns The mei_device_device pointer on success, NULL on failure.

 * Return: The mei_device_device pointer on success, NULL on failure.

 */

struct mei_device *mei_me_dev_init(struct pci_dev *pdev,

				   const struct mei_cfg *cfg)