drivers/misc/mei/debugfs.c

   1 /*
   2  *
   3  * Intel Management Engine Interface (Intel MEI) Linux driver
   4  * Copyright (c) 2012-2013, Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  */
  16 #include <linux/slab.h>
  17 #include <linux/kernel.h>
  18 #include <linux/device.h>
  19 #include <linux/debugfs.h>
  20 #include <linux/pci.h>
  21
  22 #include <linux/mei.h>
  23
  24 #include "mei_dev.h"
  25 #include "hw.h"
  26
  27 static ssize_t mei_dbgfs_read_meclients(struct file *fp, char __user *ubuf,
  28                                         size_t cnt, loff_t *ppos)
  29 {
  30         struct mei_device *dev = fp->private_data;
  31         struct mei_me_client *me_cl;
  32         size_t bufsz = 1;
  33         char *buf;
  34         int i = 0;
  35         int pos = 0;
  36         int ret;
  37
  38 #define HDR "  |id|addr|         UUID                       |con|msg len|sb|\n"
  39
  40         mutex_lock(&dev->device_lock);
  41
  42         list_for_each_entry(me_cl, &dev->me_clients, list)
  43                 bufsz++;
  44
  45         bufsz *= sizeof(HDR) + 1;
  46         buf = kzalloc(bufsz, GFP_KERNEL);
  47         if (!buf) {
  48                 mutex_unlock(&dev->device_lock);
  49                 return -ENOMEM;
  50         }
  51
  52         pos += scnprintf(buf + pos, bufsz - pos, HDR);
  53
  54         /*  if the driver is not enabled the list won't be consistent */
  55         if (dev->dev_state != MEI_DEV_ENABLED)
  56                 goto out;
  57
  58         list_for_each_entry(me_cl, &dev->me_clients, list) {
  59
  60                 /* skip me clients that cannot be connected */
  61                 if (me_cl->props.max_number_of_connections == 0)
  62                         continue;
  63
  64                 pos += scnprintf(buf + pos, bufsz - pos,
  65                         "%2d|%2d|%4d|%pUl|%3d|%7d|%2d|\n",
  66                         i++, me_cl->client_id,
  67                         me_cl->props.fixed_address,
  68                         &me_cl->props.protocol_name,
  69                         me_cl->props.max_number_of_connections,
  70                         me_cl->props.max_msg_length,
  71                         me_cl->props.single_recv_buf);
  72         }
  73 out:
  74         mutex_unlock(&dev->device_lock);
  75         ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
  76         kfree(buf);
  77         return ret;
  78 }
  79
  80 static const struct file_operations mei_dbgfs_fops_meclients = {
  81         .open = simple_open,
  82         .read = mei_dbgfs_read_meclients,
  83         .llseek = generic_file_llseek,
  84 };
  85
  86 static ssize_t mei_dbgfs_read_active(struct file *fp, char __user *ubuf,
  87                                         size_t cnt, loff_t *ppos)
  88 {
  89         struct mei_device *dev = fp->private_data;
  90         struct mei_cl *cl;
  91         const size_t bufsz = 1024;
  92         char *buf;
  93         int i = 0;
  94         int pos = 0;
  95         int ret;
  96
  97         if (!dev)
  98                 return -ENODEV;
  99
 100         buf = kzalloc(bufsz, GFP_KERNEL);
 101         if  (!buf)
 102                 return -ENOMEM;
 103
 104         pos += scnprintf(buf + pos, bufsz - pos,
 105                         "  |me|host|state|rd|wr|\n");
 106
 107         mutex_lock(&dev->device_lock);
 108
 109         /*  if the driver is not enabled the list won't b consitent */
 110         if (dev->dev_state != MEI_DEV_ENABLED)
 111                 goto out;
 112
 113         list_for_each_entry(cl, &dev->file_list, link) {
 114
 115                 pos += scnprintf(buf + pos, bufsz - pos,
 116                         "%2d|%2d|%4d|%5d|%2d|%2d|\n",
 117                         i, cl->me_client_id, cl->host_client_id, cl->state,
 118                         cl->reading_state, cl->writing_state);
 119                 i++;
 120         }
 121 out:
 122         mutex_unlock(&dev->device_lock);
 123         ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
 124         kfree(buf);
 125         return ret;
 126 }
 127
 128 static const struct file_operations mei_dbgfs_fops_active = {
 129         .open = simple_open,
 130         .read = mei_dbgfs_read_active,
 131         .llseek = generic_file_llseek,
 132 };
 133
 134 static ssize_t mei_dbgfs_read_devstate(struct file *fp, char __user *ubuf,
 135                                         size_t cnt, loff_t *ppos)
 136 {
 137         struct mei_device *dev = fp->private_data;
 138         const size_t bufsz = 1024;
 139         char *buf = kzalloc(bufsz, GFP_KERNEL);
 140         int pos = 0;
 141         int ret;
 142
 143         if  (!buf)
 144                 return -ENOMEM;
 145
 146         pos += scnprintf(buf + pos, bufsz - pos, "dev: %s\n",
 147                         mei_dev_state_str(dev->dev_state));
 148         pos += scnprintf(buf + pos, bufsz - pos, "hbm: %s\n",
 149                         mei_hbm_state_str(dev->hbm_state));
 150         pos += scnprintf(buf + pos, bufsz - pos, "pg:  %s, %s\n",
 151                         mei_pg_is_enabled(dev) ? "ENABLED" : "DISABLED",
 152                         mei_pg_state_str(mei_pg_state(dev)));
 153         ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
 154         kfree(buf);
 155         return ret;
 156 }
 157 static const struct file_operations mei_dbgfs_fops_devstate = {
 158         .open = simple_open,
 159         .read = mei_dbgfs_read_devstate,
 160         .llseek = generic_file_llseek,
 161 };
 162
 163 /**
 164  * mei_dbgfs_deregister - Remove the debugfs files and directories
 165  * @mei - pointer to mei device private data
 166  */
 167 void mei_dbgfs_deregister(struct mei_device *dev)
 168 {
 169         if (!dev->dbgfs_dir)
 170                 return;
 171         debugfs_remove_recursive(dev->dbgfs_dir);
 172         dev->dbgfs_dir = NULL;
 173 }
 174
 175 /**
 176  * Add the debugfs files
 177  *
 178  */
 179 int mei_dbgfs_register(struct mei_device *dev, const char *name)
 180 {
 181         struct dentry *dir, *f;
 182
 183         dir = debugfs_create_dir(name, NULL);
 184         if (!dir)
 185                 return -ENOMEM;
 186
 187         f = debugfs_create_file("meclients", S_IRUSR, dir,
 188                                 dev, &mei_dbgfs_fops_meclients);
 189         if (!f) {
 190                 dev_err(dev->dev, "meclients: registration failed\n");
 191                 goto err;
 192         }
 193         f = debugfs_create_file("active", S_IRUSR, dir,
 194                                 dev, &mei_dbgfs_fops_active);
 195         if (!f) {
 196                 dev_err(dev->dev, "meclients: registration failed\n");
 197                 goto err;
 198         }
 199         f = debugfs_create_file("devstate", S_IRUSR, dir,
 200                                 dev, &mei_dbgfs_fops_devstate);
 201         if (!f) {
 202                 dev_err(dev->dev, "devstate: registration failed\n");
 203                 goto err;
 204         }
 205         dev->dbgfs_dir = dir;
 206         return 0;
 207 err:
 208         mei_dbgfs_deregister(dev);
 209         return -ENODEV;
 210 }
 211