mei: add ABI documentation for fw_status exported through sysfs
Subsystems (2)
PATCH v2 1/3 mei: add ABI documentation for fw_status exported through sysfs
---
V2: rephrase the description
Documentation/ABI/testing/sysfs-class-mei | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
Documentation/ABI/testing/sysfs-class-mei +15 -0
@@ -14,3 +14,18 @@ Description: The /sys/class/mei/meiN directory is created for each probed mei device +What: /sys/class/mei/meiN/fw_status +Date: Nov 2014 +KernelVersion: 3.19 +Contact: Tomas Winkler <[email protected]> +Description: Display fw status registers content + + The ME FW writes its status information into fw status + registers for BIOS and OS to monitor fw health. + + The register contains running state, power management + state, error codes, and others. The way the registers + are decoded depends on PCH or SoC generation. + Also number of registers varies between 1 and 6 + depending on generation. +
Signature · 1 line
1.9.3
PATCH v2 2/3 mei: bus: use ssize_t as the return type for send and receive
Mei bus receive and send function may return either number of transmitted bytes or errno. It is better to use ssize_t type for that purpose that mixing size_t with int.
---
V2: rebase
drivers/misc/mei/bus.c | 30 ++++++++++++++---------------- drivers/misc/mei/mei_dev.h | 6 +++--- include/linux/mei_cl_bus.h | 4 ++-- 3 files changed, 19 insertions(+), 21 deletions(-)
drivers/misc/mei/bus.c +14 -16
@@ -224,13 +224,13 @@ void mei_cl_driver_unregister(struct mei_cl_driver *driver) }EXPORT_SYMBOL_GPL (mei_cl_driver_unregister); -static int ___mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length, +static ssize_t ___mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length,bool blocking) {struct mei_device *dev;struct mei_me_client *me_cl;struct mei_cl_cb *cb; -int rets; +ssize_t rets;if (WARN_ON (!cl || !cl->dev))return -ENODEV ;
@@ -271,12 +271,12 @@ static int ___mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length,return rets; } -int __mei_cl_recv (struct mei_cl *cl,u8 *buf,size_t length) +ssize_t __mei_cl_recv (struct mei_cl *cl,u8 *buf,size_t length) {struct mei_device *dev;struct mei_cl_cb *cb;size_t r_length; -int err; +ssize_t rets;if (WARN_ON (!cl || !cl->dev))return -ENODEV ;
@@ -286,11 +286,9 @@ int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length)mutex_lock (&dev->device_lock);if (!cl->read_cb) { - err =mei_cl_read_start (cl, length); -if (err <0 ) { -mutex_unlock (&dev->device_lock); -return err; - } + rets =mei_cl_read_start (cl, length); +if (rets <0 ) + goto out; } if (cl->reading_state != MEI_READ_COMPLETE &&
@@ -313,13 +311,13 @@ int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length) cb = cl->read_cb;if (cl->reading_state !=MEI_READ_COMPLETE ) { - r_length =0 ; + rets =0 ; goto out; } r_length =min_t (size_t, length, cb->buf_idx); -memcpy (buf, cb->response_buffer.data, r_length); + rets = r_length;mei_io_cb_free (cb); cl->reading_state =MEI_IDLE ;
@@ -328,20 +326,20 @@ int __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length) out:mutex_unlock (&dev->device_lock); -return r_length; +return rets; } -inline int __mei_cl_async_send (struct mei_cl *cl,u8 *buf,size_t length) +inline ssize_t __mei_cl_async_send (struct mei_cl *cl,u8 *buf,size_t length) {return ___mei_cl_send (cl, buf, length,0 ); } -inline int __mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length) +inline ssize_t __mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length) {return ___mei_cl_send (cl, buf, length,1 ); } -int mei_cl_send (struct mei_cl_device *device,u8 *buf,size_t length) +ssize_t mei_cl_send (struct mei_cl_device *device,u8 *buf,size_t length) {struct mei_cl *cl = device->cl;
@@ -355,7 +353,7 @@ int mei_cl_send(struct mei_cl_device *device, u8 *buf, size_t length) }EXPORT_SYMBOL_GPL (mei_cl_send); -int mei_cl_recv (struct mei_cl_device *device,u8 *buf,size_t length) +ssize_t mei_cl_recv (struct mei_cl_device *device,u8 *buf,size_t length) {struct mei_cl *cl = device->cl;
drivers/misc/mei/mei_dev.h +3 -3
@@ -345,9 +345,9 @@ struct mei_cl_device *mei_cl_add_device(struct mei_device *dev, struct mei_cl_ops *ops);void mei_cl_remove_device (struct mei_cl_device *device); -int __mei_cl_async_send (struct mei_cl *cl,u8 *buf,size_t length); -int __mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length); -int __mei_cl_recv (struct mei_cl *cl,u8 *buf,size_t length); +ssize_t __mei_cl_async_send (struct mei_cl *cl,u8 *buf,size_t length); +ssize_t __mei_cl_send (struct mei_cl *cl,u8 *buf,size_t length); +ssize_t __mei_cl_recv (struct mei_cl *cl,u8 *buf,size_t length);void mei_cl_bus_rx_event (struct mei_cl *cl);void mei_cl_bus_remove_devices (struct mei_device *dev);int mei_cl_bus_init (void );
include/linux/mei_cl_bus.h +2 -2
@@ -25,8 +25,8 @@ int __mei_cl_driver_register(struct mei_cl_driver *driver,void mei_cl_driver_unregister (struct mei_cl_driver *driver); -int mei_cl_send (struct mei_cl_device *device,u8 *buf,size_t length); -int mei_cl_recv (struct mei_cl_device *device,u8 *buf,size_t length); +ssize_t mei_cl_send (struct mei_cl_device *device,u8 *buf,size_t length); +ssize_t mei_cl_recv (struct mei_cl_device *device,u8 *buf,size_t length);typedef void (*mei_cl_event_cb_t )(struct mei_cl_device *device,u32 events,void *context);
Signature · 1 line
1.9.3
PATCH v2 3/3 mei: add reference counting for me clients
In reply to Tomas WinklerTo support dynamic addition and removal of
me clients we add reference counter.
Update kdoc with locking requirements.
---
V2: add locking requirements to kdoc
drivers/misc/mei/amthif.c | 14 +++-- drivers/misc/mei/bus.c | 35 ++++++----- drivers/misc/mei/client.c | 152 ++++++++++++++++++++++++++++++++++++++------- drivers/misc/mei/client.h | 17 +++-- drivers/misc/mei/debugfs.c | 32 ++++++---- drivers/misc/mei/hbm.c | 34 +++++----- drivers/misc/mei/main.c | 22 +++---- drivers/misc/mei/mei_dev.h | 2 + drivers/misc/mei/nfc.c | 2 + drivers/misc/mei/wd.c | 1 + 10 files changed, 219 insertions(+), 92 deletions(-)
drivers/misc/mei/amthif.c +8 -6
@@ -97,23 +97,25 @@ int mei_amthif_host_init(struct mei_device *dev)/* allocate storage for ME message buffer */ msg_buf =kcalloc (dev->iamthif_mtu,sizeof (unsigned char ),GFP_KERNEL ); -if (!msg_buf) -return -ENOMEM ; +if (!msg_buf) { + ret = -ENOMEM ; + goto out; + } dev->iamthif_msg_buf = msg_buf; ret =mei_cl_link (cl,MEI_IAMTHIF_HOST_CLIENT_ID ); -if (ret <0 ) { -dev_err (dev->dev, -"amthif: failed link client %d\n" , ret); -return ret; +dev_err (dev->dev,"amthif: failed cl_link %d\n" , ret); + goto out; } ret =mei_cl_connect (cl,NULL ); dev->iamthif_state =MEI_IAMTHIF_IDLE ; +out: +mei_me_cl_put (me_cl);return ret; }
drivers/misc/mei/bus.c +21 -14
@@ -237,33 +237,40 @@ static ssize_t ___mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length, dev = cl->dev; -if (cl->state !=MEI_FILE_CONNECTED ) -return -ENODEV ; +mutex_lock (&dev->device_lock); +if (cl->state !=MEI_FILE_CONNECTED ) { + rets = -ENODEV ; + goto out; + }/* Check if we have an ME client device */ me_cl =mei_me_cl_by_uuid_id (dev, &cl->cl_uuid, cl->me_client_id); -if (!me_cl) -return -ENOTTY ; +if (!me_cl) { + rets = -ENOTTY ; + goto out; + } -if (length > me_cl->props.max_msg_length) -return -EFBIG ; +if (length > me_cl->props.max_msg_length) { + rets = -EFBIG ; + goto out; + } cb =mei_io_cb_init (cl,NULL ); -if (!cb) -return -ENOMEM ; +if (!cb) { + rets = -ENOMEM ; + goto out; + } rets =mei_io_cb_alloc_req_buf (cb, length); -if (rets <0 ) { -mei_io_cb_free (cb); -return rets; - } +if (rets <0 ) + goto out;memcpy (cb->request_buffer.data, buf, length); -mutex_lock (&dev->device_lock); - rets =mei_cl_write (cl, cb, blocking); +out: +mei_me_cl_put (me_cl);mutex_unlock (&dev->device_lock);if (rets <0 )mei_io_cb_free (cb);
drivers/misc/mei/client.c +129 -23
245 lines not on this page · raw message
drivers/misc/mei/client.h +12 -5
@@ -24,15 +24,22 @@#include "mei_dev.h" +/* +* reference counting base function +*/ +void mei_me_cl_init (struct mei_me_client *me_cl); +void mei_me_cl_put (struct mei_me_client *me_cl); +struct mei_me_client *mei_me_cl_get (struct mei_me_client *me_cl); +struct mei_me_client *mei_me_cl_by_uuid (const struct mei_device *dev, -const uuid_le *cuuid); +const uuid_le *uuid);struct mei_me_client *mei_me_cl_by_id (struct mei_device *dev,u8 client_id); -struct mei_me_client *mei_me_cl_by_uuid_id (struct mei_device *dev,const uuid_le *uuid,u8 client_id); - -void mei_me_cl_remove (struct mei_device *dev, -const uuid_le *uuid,u8 client_id); +void mei_me_cl_rm_by_uuid (struct mei_device *dev,const uuid_le *uuid); +void mei_me_cl_rm_by_uuid_id (struct mei_device *dev, +const uuid_le *uuid,u8 id); +void mei_me_cl_rm_all (struct mei_device *dev);/* * MEI IO Functions
drivers/misc/mei/debugfs.c +20 -12
@@ -21,20 +21,22 @@#include <linux/mei.h> #include "mei_dev.h" +#include "client.h" #include "hw.h" static ssize_t mei_dbgfs_read_meclients (struct file *fp,char __user *ubuf,size_t cnt,loff_t *ppos) {struct mei_device *dev = fp->private_data; -struct mei_me_client *me_cl; +struct mei_me_client *me_cl, *n;size_t bufsz =1 ;char *buf;int i =0 ;int pos =0 ;int ret; -#define HDR " |id|fix| UUID |con|msg len|sb|\n" +#define HDR \ +" |id|fix| UUID |con|msg len|sb|refc|\n"mutex_lock (&dev->device_lock);
@@ -54,16 +56,22 @@ static ssize_t mei_dbgfs_read_meclients(struct file *fp, char __user *ubuf,if (dev->dev_state !=MEI_DEV_ENABLED ) goto out; -list_for_each_entry (me_cl, &dev->me_clients, list) { - - pos +=scnprintf (buf + pos, bufsz - pos, -"%2d|%2d|%3d|%pUl|%3d|%7d|%2d|\n" , - i++, me_cl->client_id, - me_cl->props.fixed_address, - &me_cl->props.protocol_name, - me_cl->props.max_number_of_connections, - me_cl->props.max_msg_length, - me_cl->props.single_recv_buf); +list_for_each_entry_safe (me_cl, n, &dev->me_clients, list) { + + me_cl =mei_me_cl_get (me_cl); +if (me_cl) { + pos +=scnprintf (buf + pos, bufsz - pos, +"%2d|%2d|%3d|%pUl|%3d|%7d|%2d|%4d|\n" , + i++, me_cl->client_id, + me_cl->props.fixed_address, + &me_cl->props.protocol_name, + me_cl->props.max_number_of_connections, + me_cl->props.max_msg_length, + me_cl->props.single_recv_buf, +atomic_read (&me_cl->refcnt.refcount)); + } + +mei_me_cl_put (me_cl); } out:mutex_unlock (&dev->device_lock);
drivers/misc/mei/hbm.c +15 -19
@@ -105,21 +105,6 @@ void mei_hbm_idle(struct mei_device *dev) }/** -* mei_me_cl_remove_all - remove all me clients -* -* @dev: the device structure -*/ -static void mei_me_cl_remove_all (struct mei_device *dev) -{ -struct mei_me_client *me_cl, *next; - -list_for_each_entry_safe (me_cl, next, &dev->me_clients, list) { -list_del (&me_cl->list); -kfree (me_cl); - } -} - -/** * mei_hbm_reset - reset hbm counters and book keeping data structurs * * @dev: the device structure
@@ -128,7 +113,7 @@ void mei_hbm_reset(struct mei_device *dev) { dev->me_client_index =0 ; -mei_me_cl_remove_all (dev); +mei_me_cl_rm_all (dev);mei_hbm_idle (dev); }
@@ -339,11 +324,16 @@ static int mei_hbm_me_cl_add(struct mei_device *dev, struct hbm_props_response *res) {struct mei_me_client *me_cl; +const uuid_le *uuid = &res->client_properties.protocol_name; + +mei_me_cl_rm_by_uuid (dev, uuid); me_cl =kzalloc (sizeof (struct mei_me_client ),GFP_KERNEL );if (!me_cl)return -ENOMEM ; +mei_me_cl_init (me_cl); + me_cl->props = res->client_properties; me_cl->client_id = res->me_addr; me_cl->mei_flow_ctrl_creds =0 ;
@@ -484,6 +474,7 @@ static int mei_hbm_add_single_flow_creds(struct mei_device *dev, struct hbm_flow_control *flow) {struct mei_me_client *me_cl; +int rets; me_cl =mei_me_cl_by_id (dev, flow->me_addr);if (!me_cl) {
@@ -492,14 +483,19 @@ static int mei_hbm_add_single_flow_creds(struct mei_device *dev,return -ENOENT ; } -if (WARN_ON (me_cl->props.single_recv_buf ==0 )) -return -EINVAL ; +if (WARN_ON (me_cl->props.single_recv_buf ==0 )) { + rets = -EINVAL ; + goto out; + } me_cl->mei_flow_ctrl_creds++;dev_dbg (dev->dev,"recv flow ctrl msg ME %d (single) creds = %d.\n" , flow->me_addr, me_cl->mei_flow_ctrl_creds); -return 0 ; + rets =0 ; +out: +mei_me_cl_put (me_cl); +return rets; }/**
drivers/misc/mei/main.c +9 -13
@@ -303,7 +303,7 @@ static ssize_t mei_write(struct file *file, const char __user *ubuf, size_t length, loff_t *offset) { struct mei_cl *cl = file->private_data; -struct mei_me_client *me_cl; +struct mei_me_client *me_cl =NULL ;struct mei_cl_cb *write_cb =NULL ;struct mei_device *dev;unsigned long timeout =0 ;
@@ -399,12 +399,14 @@ static ssize_t mei_write(struct file *file, const char __user *ubuf, "amthif write failed with status = %d\n", rets); goto out; } +mei_me_cl_put (me_cl);mutex_unlock (&dev->device_lock);return length; } rets =mei_cl_write (cl, write_cb, false); out: +mei_me_cl_put (me_cl);mutex_unlock (&dev->device_lock);if (rets <0 )mei_io_cb_free (write_cb);
@@ -433,24 +435,19 @@ static int mei_ioctl_connect_client(struct file *file, cl = file->private_data; dev = cl->dev; -if (dev->dev_state !=MEI_DEV_ENABLED ) { - rets = -ENODEV ; - goto end; - } +if (dev->dev_state !=MEI_DEV_ENABLED ) +return -ENODEV ;if (cl->state !=MEI_FILE_INITIALIZING && - cl->state !=MEI_FILE_DISCONNECTED ) { - rets = -EBUSY ; - goto end; - } + cl->state !=MEI_FILE_DISCONNECTED ) +return -EBUSY ;/* find ME client we're trying to connect to */ me_cl =mei_me_cl_by_uuid (dev, &data->in_client_uuid);if (!me_cl || me_cl->props.fixed_address) {dev_dbg (dev->dev,"Cannot connect to FW Client UUID = %pUl\n" , &data->in_client_uuid); - rets = -ENOTTY ; - goto end; +return -ENOTTY ; } cl->me_client_id = me_cl->client_id;
@@ -487,17 +484,16 @@ static int mei_ioctl_connect_client(struct file *file, goto end; } -/* prepare the output buffer */ client = &data->out_client_properties; client->max_msg_length = me_cl->props.max_msg_length; client->protocol_version = me_cl->props.protocol_version;dev_dbg (dev->dev,"Can connect?\n" ); - rets =mei_cl_connect (cl, file); end: +mei_me_cl_put (me_cl);return rets; }
drivers/misc/mei/mei_dev.h +2 -0
@@ -172,12 +172,14 @@ struct mei_fw_status {* struct mei_me_client - representation of me (fw) client * * @list: link in me client list +* @refcnt: struct reference count * @props: client properties * @client_id: me client id * @mei_flow_ctrl_creds: flow control credits */ struct mei_me_client {struct list_head list; +struct kref refcnt;struct mei_client_properties props;u8 client_id;u8 mei_flow_ctrl_creds;
drivers/misc/mei/nfc.c +2 -0
@@ -521,6 +521,7 @@ int mei_nfc_host_init(struct mei_device *dev) cl_info->me_client_id = me_cl->client_id; cl_info->cl_uuid = me_cl->props.protocol_name; +mei_me_cl_put (me_cl); ret =mei_cl_link (cl_info,MEI_HOST_CLIENT_ID_ANY );if (ret)
@@ -539,6 +540,7 @@ int mei_nfc_host_init(struct mei_device *dev) cl->me_client_id = me_cl->client_id; cl->cl_uuid = me_cl->props.protocol_name; +mei_me_cl_put (me_cl); ret =mei_cl_link (cl,MEI_HOST_CLIENT_ID_ANY );if (ret)
drivers/misc/mei/wd.c +1 -0
@@ -76,6 +76,7 @@ int mei_wd_host_init(struct mei_device *dev) cl->me_client_id = me_cl->client_id; cl->cl_uuid = me_cl->props.protocol_name; +mei_me_cl_put (me_cl); ret =mei_cl_link (cl,MEI_WD_HOST_CLIENT_ID );
Signature · 1 line
1.9.3
Greg KH
maintainerRe: [char-misc-next 3/3 V2] mei: add reference counting for me clients
Quoted 6 lines · Tomas Winkler
To support dynamic addition and removal of
me clients we add reference counter.Update kdoc with locking requirements.
Signed-off-by Tomas Winkler <[email protected]>
This patch adds build warnings, I can't take it:
drivers/misc/mei/bus.c: In function ‘___mei_cl_send’:drivers/misc/mei/bus.c:276:3: warning: ‘cb’ may be used uninitialized in this function [-Wmaybe-uninitialized]
mei_io_cb_free(cb);
^drivers/misc/mei/bus.c:273:2: warning: ‘me_cl’ may be used uninitialized in this function [-Wmaybe-uninitialized]
mei_me_cl_put(me_cl);
^
Please be more careful.
RE: [char-misc-next 3/3 V2] mei: add reference counting for me clients
Quoted 8 lines
Quoted 2 lines
Signed-off-by Tomas Winkler <[email protected]>This patch adds build warnings, I can't take it:
drivers/misc/mei/bus.c: In function ‘___mei_cl_send’:drivers/misc/mei/bus.c:276:3: warning: ‘cb’ may be used uninitialized in this function [-Wmaybe-uninitialized]
Quoted 6 lines
mei_io_cb_free(cb); ^
drivers/misc/mei/bus.c:273:2: warning: ‘me_cl’ may be used uninitialized in this function [-Wmaybe-uninitialized]
mei_me_cl_put(me_cl);
^
CONFIG_CC_OPTIMIZE_FOR_SIZE is pushing -Wno-maybe-uninitialized so this didn't pop up. Resending
Thanks
Tomas
���{.n�+�������+%�����ݶ��w��{.n�+����{��G�����{ay�ʇڙ�,j��f���h��������z_�(�階�ݢj"���m������G������?����&���~��iO��z��v�^�m����������?�I�
Quoted 9 lines
Signed-off-by Tomas Winkler <[email protected]>---
V2: rephrase the descriptionDocumentation/ABI/testing/sysfs-class-mei | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
Greg you've included 'mei: export fw status registers through sysfs' to 3.19-rc1 pull request but left this documentation patch out.
Thanks
Tomas
[email protected]
maintainerQuoted 11 lines · Tomas
Quoted 9 lines
Signed-off-by Tomas Winkler <[email protected]>---
V2: rephrase the descriptionDocumentation/ABI/testing/sysfs-class-mei | 15 +++++++++++++++ 1 file changed, 15 insertions(+)Greg you've included 'mei: export fw status registers through sysfs' to 3.19-rc1 pull request but left this documentation patch out.
I don't remember what happened there, can you resend and I will queue it up for after 3.19-rc1?
thanks,
greg k-h
Quoted 20 lines
-----Original Message-----
From: [email protected] [mailto:[email protected]]
Sent: Friday, December 19, 2014 00:15
To: Winkler, Tomas
Cc: [email protected]; [email protected]
Subject: Re: [char-misc-next 1/3 V2] mei: add ABI documentation forfw_statusexported through sysfsQuoted 9 lines · Tomas
Quoted 9 lines
Signed-off-by Tomas Winkler <[email protected]>---
V2: rephrase the descriptionDocumentation/ABI/testing/sysfs-class-mei | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
Quoted 6 lines
Quoted 1 line
Greg you've included 'mei: export fw status registers through sysfs' to 3.19-rc1
pull request
Quoted 1 line
but left this documentation patch out.
I don't remember what happened there, can you resend and I will queue it up for after 3.19-rc1?
Thanks
Done