Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2012-2022, Intel Corporation. All rights reserved
4 * Intel Management Engine Interface (Intel MEI) Linux driver
5 */
6
7#include <linux/slab.h>
8#include <linux/kernel.h>
9#include <linux/device.h>
10#include <linux/debugfs.h>
11#include <linux/seq_file.h>
12
13#include <linux/mei.h>
14
15#include "mei_dev.h"
16#include "client.h"
17#include "hw.h"
18
19static int mei_dbgfs_meclients_show(struct seq_file *m, void *unused)
20{
21 struct mei_device *dev = m->private;
22 struct mei_me_client *me_cl;
23 int i = 0;
24
25 if (!dev)
26 return -ENODEV;
27
28 down_read(&dev->me_clients_rwsem);
29
30 seq_puts(m, " |id|fix| UUID |con|msg len|sb|refc|vt|\n");
31
32 /* if the driver is not enabled the list won't be consistent */
33 if (dev->dev_state != MEI_DEV_ENABLED)
34 goto out;
35
36 list_for_each_entry(me_cl, &dev->me_clients, list) {
37 if (!mei_me_cl_get(me_cl))
38 continue;
39
40 seq_printf(m, "%2d|%2d|%3d|%pUl|%3d|%7d|%2d|%4d|%2d|\n",
41 i++, me_cl->client_id,
42 me_cl->props.fixed_address,
43 &me_cl->props.protocol_name,
44 me_cl->props.max_number_of_connections,
45 me_cl->props.max_msg_length,
46 me_cl->props.single_recv_buf,
47 kref_read(&me_cl->refcnt),
48 me_cl->props.vt_supported);
49 mei_me_cl_put(me_cl);
50 }
51
52out:
53 up_read(&dev->me_clients_rwsem);
54 return 0;
55}
56DEFINE_SHOW_ATTRIBUTE(mei_dbgfs_meclients);
57
58static int mei_dbgfs_active_show(struct seq_file *m, void *unused)
59{
60 struct mei_device *dev = m->private;
61 struct mei_cl *cl;
62 int i = 0;
63
64 if (!dev)
65 return -ENODEV;
66
67 mutex_lock(&dev->device_lock);
68
69 seq_puts(m, " |me|host|state|rd|wr|wrq\n");
70
71 /* if the driver is not enabled the list won't be consistent */
72 if (dev->dev_state != MEI_DEV_ENABLED)
73 goto out;
74
75 list_for_each_entry(cl, &dev->file_list, link) {
76
77 seq_printf(m, "%3d|%2d|%4d|%5d|%2d|%2d|%3u\n",
78 i, mei_cl_me_id(cl), cl->host_client_id, cl->state,
79 !list_empty(&cl->rd_completed), cl->writing_state,
80 cl->tx_cb_queued);
81 i++;
82 }
83out:
84 mutex_unlock(&dev->device_lock);
85 return 0;
86}
87DEFINE_SHOW_ATTRIBUTE(mei_dbgfs_active);
88
89static const char *mei_dev_pxp_mode_str(enum mei_dev_pxp_mode state)
90{
91#define MEI_PXP_MODE(state) case MEI_DEV_PXP_##state: return #state
92 switch (state) {
93 MEI_PXP_MODE(DEFAULT);
94 MEI_PXP_MODE(INIT);
95 MEI_PXP_MODE(SETUP);
96 MEI_PXP_MODE(READY);
97 default:
98 return "unknown";
99 }
100#undef MEI_PXP_MODE
101}
102
103static int mei_dbgfs_devstate_show(struct seq_file *m, void *unused)
104{
105 struct mei_device *dev = m->private;
106
107 seq_printf(m, "dev: %s\n", mei_dev_state_str(dev->dev_state));
108 seq_printf(m, "hbm: %s\n", mei_hbm_state_str(dev->hbm_state));
109
110 if (dev->hbm_state >= MEI_HBM_ENUM_CLIENTS &&
111 dev->hbm_state <= MEI_HBM_STARTED) {
112 seq_puts(m, "hbm features:\n");
113 seq_printf(m, "\tPG: %01d\n", dev->hbm_f_pg_supported);
114 seq_printf(m, "\tDC: %01d\n", dev->hbm_f_dc_supported);
115 seq_printf(m, "\tIE: %01d\n", dev->hbm_f_ie_supported);
116 seq_printf(m, "\tDOT: %01d\n", dev->hbm_f_dot_supported);
117 seq_printf(m, "\tEV: %01d\n", dev->hbm_f_ev_supported);
118 seq_printf(m, "\tFA: %01d\n", dev->hbm_f_fa_supported);
119 seq_printf(m, "\tOS: %01d\n", dev->hbm_f_os_supported);
120 seq_printf(m, "\tDR: %01d\n", dev->hbm_f_dr_supported);
121 seq_printf(m, "\tVT: %01d\n", dev->hbm_f_vt_supported);
122 seq_printf(m, "\tCAP: %01d\n", dev->hbm_f_cap_supported);
123 seq_printf(m, "\tCD: %01d\n", dev->hbm_f_cd_supported);
124 }
125
126 seq_printf(m, "pg: %s, %s\n",
127 mei_pg_is_enabled(dev) ? "ENABLED" : "DISABLED",
128 mei_pg_state_str(mei_pg_state(dev)));
129
130 seq_printf(m, "pxp: %s\n", mei_dev_pxp_mode_str(dev->pxp_mode));
131
132 return 0;
133}
134DEFINE_SHOW_ATTRIBUTE(mei_dbgfs_devstate);
135
136static ssize_t mei_dbgfs_write_allow_fa(struct file *file,
137 const char __user *user_buf,
138 size_t count, loff_t *ppos)
139{
140 struct mei_device *dev;
141 int ret;
142
143 dev = container_of(file->private_data,
144 struct mei_device, allow_fixed_address);
145
146 ret = debugfs_write_file_bool(file, user_buf, count, ppos);
147 if (ret < 0)
148 return ret;
149 dev->override_fixed_address = true;
150 return ret;
151}
152
153static const struct file_operations mei_dbgfs_allow_fa_fops = {
154 .open = simple_open,
155 .read = debugfs_read_file_bool,
156 .write = mei_dbgfs_write_allow_fa,
157 .llseek = generic_file_llseek,
158};
159
160/**
161 * mei_dbgfs_deregister - Remove the debugfs files and directories
162 *
163 * @dev: the mei device structure
164 */
165void mei_dbgfs_deregister(struct mei_device *dev)
166{
167 if (!dev->dbgfs_dir)
168 return;
169 debugfs_remove_recursive(dev->dbgfs_dir);
170 dev->dbgfs_dir = NULL;
171}
172
173/**
174 * mei_dbgfs_register - Add the debugfs files
175 *
176 * @dev: the mei device structure
177 * @name: the mei device name
178 */
179void mei_dbgfs_register(struct mei_device *dev, const char *name)
180{
181 struct dentry *dir;
182
183 dir = debugfs_create_dir(name, NULL);
184 dev->dbgfs_dir = dir;
185
186 debugfs_create_file("meclients", S_IRUSR, dir, dev,
187 &mei_dbgfs_meclients_fops);
188 debugfs_create_file("active", S_IRUSR, dir, dev,
189 &mei_dbgfs_active_fops);
190 debugfs_create_file("devstate", S_IRUSR, dir, dev,
191 &mei_dbgfs_devstate_fops);
192 debugfs_create_file("allow_fixed_address", S_IRUSR | S_IWUSR, dir,
193 &dev->allow_fixed_address,
194 &mei_dbgfs_allow_fa_fops);
195}
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
21#include <linux/mei.h>
22
23#include "mei_dev.h"
24#include "client.h"
25#include "hw.h"
26
27static 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 \
39" |id|fix| UUID |con|msg len|sb|refc|\n"
40
41 down_read(&dev->me_clients_rwsem);
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 up_read(&dev->me_clients_rwsem);
49 return -ENOMEM;
50 }
51
52 pos += scnprintf(buf + pos, bufsz - pos, HDR);
53#undef HDR
54
55 /* if the driver is not enabled the list won't be consistent */
56 if (dev->dev_state != MEI_DEV_ENABLED)
57 goto out;
58
59 list_for_each_entry(me_cl, &dev->me_clients, list) {
60
61 if (mei_me_cl_get(me_cl)) {
62 pos += scnprintf(buf + pos, bufsz - pos,
63 "%2d|%2d|%3d|%pUl|%3d|%7d|%2d|%4d|\n",
64 i++, me_cl->client_id,
65 me_cl->props.fixed_address,
66 &me_cl->props.protocol_name,
67 me_cl->props.max_number_of_connections,
68 me_cl->props.max_msg_length,
69 me_cl->props.single_recv_buf,
70 atomic_read(&me_cl->refcnt.refcount));
71
72 mei_me_cl_put(me_cl);
73 }
74 }
75
76out:
77 up_read(&dev->me_clients_rwsem);
78 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
79 kfree(buf);
80 return ret;
81}
82
83static const struct file_operations mei_dbgfs_fops_meclients = {
84 .open = simple_open,
85 .read = mei_dbgfs_read_meclients,
86 .llseek = generic_file_llseek,
87};
88
89static ssize_t mei_dbgfs_read_active(struct file *fp, char __user *ubuf,
90 size_t cnt, loff_t *ppos)
91{
92 struct mei_device *dev = fp->private_data;
93 struct mei_cl *cl;
94 size_t bufsz = 1;
95 char *buf;
96 int i = 0;
97 int pos = 0;
98 int ret;
99
100#define HDR " |me|host|state|rd|wr|\n"
101
102 if (!dev)
103 return -ENODEV;
104
105 mutex_lock(&dev->device_lock);
106
107 /*
108 * if the driver is not enabled the list won't be consistent,
109 * we output empty table
110 */
111 if (dev->dev_state == MEI_DEV_ENABLED)
112 list_for_each_entry(cl, &dev->file_list, link)
113 bufsz++;
114
115 bufsz *= sizeof(HDR) + 1;
116
117 buf = kzalloc(bufsz, GFP_KERNEL);
118 if (!buf) {
119 mutex_unlock(&dev->device_lock);
120 return -ENOMEM;
121 }
122
123 pos += scnprintf(buf + pos, bufsz - pos, HDR);
124#undef HDR
125
126 /* if the driver is not enabled the list won't be consistent */
127 if (dev->dev_state != MEI_DEV_ENABLED)
128 goto out;
129
130 list_for_each_entry(cl, &dev->file_list, link) {
131
132 pos += scnprintf(buf + pos, bufsz - pos,
133 "%3d|%2d|%4d|%5d|%2d|%2d|\n",
134 i, mei_cl_me_id(cl), cl->host_client_id, cl->state,
135 !list_empty(&cl->rd_completed), cl->writing_state);
136 i++;
137 }
138out:
139 mutex_unlock(&dev->device_lock);
140 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
141 kfree(buf);
142 return ret;
143}
144
145static const struct file_operations mei_dbgfs_fops_active = {
146 .open = simple_open,
147 .read = mei_dbgfs_read_active,
148 .llseek = generic_file_llseek,
149};
150
151static ssize_t mei_dbgfs_read_devstate(struct file *fp, char __user *ubuf,
152 size_t cnt, loff_t *ppos)
153{
154 struct mei_device *dev = fp->private_data;
155 const size_t bufsz = 1024;
156 char *buf = kzalloc(bufsz, GFP_KERNEL);
157 int pos = 0;
158 int ret;
159
160 if (!buf)
161 return -ENOMEM;
162
163 pos += scnprintf(buf + pos, bufsz - pos, "dev: %s\n",
164 mei_dev_state_str(dev->dev_state));
165 pos += scnprintf(buf + pos, bufsz - pos, "hbm: %s\n",
166 mei_hbm_state_str(dev->hbm_state));
167
168 if (dev->hbm_state >= MEI_HBM_ENUM_CLIENTS &&
169 dev->hbm_state <= MEI_HBM_STARTED) {
170 pos += scnprintf(buf + pos, bufsz - pos, "hbm features:\n");
171 pos += scnprintf(buf + pos, bufsz - pos, "\tPG: %01d\n",
172 dev->hbm_f_pg_supported);
173 pos += scnprintf(buf + pos, bufsz - pos, "\tDC: %01d\n",
174 dev->hbm_f_dc_supported);
175 pos += scnprintf(buf + pos, bufsz - pos, "\tIE: %01d\n",
176 dev->hbm_f_ie_supported);
177 pos += scnprintf(buf + pos, bufsz - pos, "\tDOT: %01d\n",
178 dev->hbm_f_dot_supported);
179 pos += scnprintf(buf + pos, bufsz - pos, "\tEV: %01d\n",
180 dev->hbm_f_ev_supported);
181 pos += scnprintf(buf + pos, bufsz - pos, "\tFA: %01d\n",
182 dev->hbm_f_fa_supported);
183 }
184
185 pos += scnprintf(buf + pos, bufsz - pos, "pg: %s, %s\n",
186 mei_pg_is_enabled(dev) ? "ENABLED" : "DISABLED",
187 mei_pg_state_str(mei_pg_state(dev)));
188 ret = simple_read_from_buffer(ubuf, cnt, ppos, buf, pos);
189 kfree(buf);
190 return ret;
191}
192static const struct file_operations mei_dbgfs_fops_devstate = {
193 .open = simple_open,
194 .read = mei_dbgfs_read_devstate,
195 .llseek = generic_file_llseek,
196};
197
198static ssize_t mei_dbgfs_write_allow_fa(struct file *file,
199 const char __user *user_buf,
200 size_t count, loff_t *ppos)
201{
202 struct mei_device *dev;
203 int ret;
204
205 dev = container_of(file->private_data,
206 struct mei_device, allow_fixed_address);
207
208 ret = debugfs_write_file_bool(file, user_buf, count, ppos);
209 if (ret < 0)
210 return ret;
211 dev->override_fixed_address = true;
212 return ret;
213}
214
215static const struct file_operations mei_dbgfs_fops_allow_fa = {
216 .open = simple_open,
217 .read = debugfs_read_file_bool,
218 .write = mei_dbgfs_write_allow_fa,
219 .llseek = generic_file_llseek,
220};
221
222/**
223 * mei_dbgfs_deregister - Remove the debugfs files and directories
224 *
225 * @dev: the mei device structure
226 */
227void mei_dbgfs_deregister(struct mei_device *dev)
228{
229 if (!dev->dbgfs_dir)
230 return;
231 debugfs_remove_recursive(dev->dbgfs_dir);
232 dev->dbgfs_dir = NULL;
233}
234
235/**
236 * mei_dbgfs_register - Add the debugfs files
237 *
238 * @dev: the mei device structure
239 * @name: the mei device name
240 *
241 * Return: 0 on success, <0 on failure.
242 */
243int mei_dbgfs_register(struct mei_device *dev, const char *name)
244{
245 struct dentry *dir, *f;
246
247 dir = debugfs_create_dir(name, NULL);
248 if (!dir)
249 return -ENOMEM;
250
251 dev->dbgfs_dir = dir;
252
253 f = debugfs_create_file("meclients", S_IRUSR, dir,
254 dev, &mei_dbgfs_fops_meclients);
255 if (!f) {
256 dev_err(dev->dev, "meclients: registration failed\n");
257 goto err;
258 }
259 f = debugfs_create_file("active", S_IRUSR, dir,
260 dev, &mei_dbgfs_fops_active);
261 if (!f) {
262 dev_err(dev->dev, "active: registration failed\n");
263 goto err;
264 }
265 f = debugfs_create_file("devstate", S_IRUSR, dir,
266 dev, &mei_dbgfs_fops_devstate);
267 if (!f) {
268 dev_err(dev->dev, "devstate: registration failed\n");
269 goto err;
270 }
271 f = debugfs_create_file("allow_fixed_address", S_IRUSR | S_IWUSR, dir,
272 &dev->allow_fixed_address,
273 &mei_dbgfs_fops_allow_fa);
274 if (!f) {
275 dev_err(dev->dev, "allow_fixed_address: registration failed\n");
276 goto err;
277 }
278 return 0;
279err:
280 mei_dbgfs_deregister(dev);
281 return -ENODEV;
282}
283