projects/linux·blob master · refs

384 lines · 9.6 KiB

1// SPDX-License-Identifier: GPL-2.0-only
2// Copyright(c) 2017-2019 Intel Corporation.
3
4#include <linux/cleanup.h>
5#include <linux/device.h>
6#include <linux/debugfs.h>
7#include <linux/firmware.h>
8#include <linux/pm_runtime.h>
9#include <linux/slab.h>
10#include <linux/soundwire/sdw.h>
11#include <linux/soundwire/sdw_registers.h>
12#include <linux/string_choices.h>
13#include "bus.h"
14
15static struct dentry *sdw_debugfs_root;
16
17void sdw_bus_debugfs_init(struct sdw_bus *bus)
18{
19 char name[16];
20
21 if (!sdw_debugfs_root)
22 return;
23
24 /* create the debugfs master-N */
25 snprintf(name, sizeof(name), "master-%d-%d", bus->controller_id, bus->link_id);
26 bus->debugfs = debugfs_create_dir(name, sdw_debugfs_root);
27}
28
29void sdw_bus_debugfs_exit(struct sdw_bus *bus)
30{
31 debugfs_remove_recursive(bus->debugfs);
32}
33
34#define RD_BUF (3 * PAGE_SIZE)
35
36static ssize_t sdw_sprintf(struct sdw_slave *slave,
37 char *buf, size_t pos, unsigned int reg)
38{
39 int value;
40
41 value = sdw_read_no_pm(slave, reg);
42
43 if (value < 0)
44 return scnprintf(buf + pos, RD_BUF - pos, "%3x\tXX\n", reg);
45 else
46 return scnprintf(buf + pos, RD_BUF - pos,
47 "%3x\t%2x\n", reg, value);
48}
49
50static int sdw_slave_reg_show(struct seq_file *s_file, void *data)
51{
52 struct sdw_slave *slave = s_file->private;
53 ssize_t ret;
54 int i, j;
55
56 char *buf __free(kfree) = kzalloc(RD_BUF, GFP_KERNEL);
57 if (!buf)
58 return -ENOMEM;
59
60 ret = pm_runtime_get_sync(&slave->dev);
61 if (ret < 0 && ret != -EACCES) {
62 pm_runtime_put_noidle(&slave->dev);
63 return ret;
64 }
65
66 ret = scnprintf(buf, RD_BUF, "Register Value\n");
67
68 /* DP0 non-banked registers */
69 ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP0\n");
70 for (i = SDW_DP0_INT; i <= SDW_DP0_PREPARECTRL; i++)
71 ret += sdw_sprintf(slave, buf, ret, i);
72
73 /* DP0 Bank 0 registers */
74 ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
75 ret += sdw_sprintf(slave, buf, ret, SDW_DP0_CHANNELEN);
76 for (i = SDW_DP0_SAMPLECTRL1; i <= SDW_DP0_LANECTRL; i++)
77 ret += sdw_sprintf(slave, buf, ret, i);
78
79 /* DP0 Bank 1 registers */
80 ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
81 ret += sdw_sprintf(slave, buf, ret,
82 SDW_DP0_CHANNELEN + SDW_BANK1_OFFSET);
83 for (i = SDW_DP0_SAMPLECTRL1 + SDW_BANK1_OFFSET;
84 i <= SDW_DP0_LANECTRL + SDW_BANK1_OFFSET; i++)
85 ret += sdw_sprintf(slave, buf, ret, i);
86
87 /* SCP registers */
88 ret += scnprintf(buf + ret, RD_BUF - ret, "\nSCP\n");
89 for (i = SDW_SCP_INT1; i <= SDW_SCP_BUS_CLOCK_BASE; i++)
90 ret += sdw_sprintf(slave, buf, ret, i);
91 for (i = SDW_SCP_DEVID_0; i <= SDW_SCP_DEVID_5; i++)
92 ret += sdw_sprintf(slave, buf, ret, i);
93 for (i = SDW_SCP_SDCA_INT1; i <= SDW_SCP_SDCA_INTMASK4; i++)
94 ret += sdw_sprintf(slave, buf, ret, i);
95 for (i = SDW_SCP_FRAMECTRL_B0; i <= SDW_SCP_BUSCLOCK_SCALE_B0; i++)
96 ret += sdw_sprintf(slave, buf, ret, i);
97 for (i = SDW_SCP_FRAMECTRL_B1; i <= SDW_SCP_BUSCLOCK_SCALE_B1; i++)
98 ret += sdw_sprintf(slave, buf, ret, i);
99 for (i = SDW_SCP_PHY_OUT_CTRL_0; i <= SDW_SCP_PHY_OUT_CTRL_7; i++)
100 ret += sdw_sprintf(slave, buf, ret, i);
101
102
103 /*
104 * SCP Bank 0/1 registers are read-only and cannot be
105 * retrieved from the Slave. The Master typically keeps track
106 * of the current frame size so the information can be found
107 * in other places
108 */
109
110 /* DP1..14 registers */
111 for (i = 1; SDW_VALID_PORT_RANGE(i); i++) {
112
113 /* DPi registers */
114 ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP%d\n", i);
115 for (j = SDW_DPN_INT(i); j <= SDW_DPN_PREPARECTRL(i); j++)
116 ret += sdw_sprintf(slave, buf, ret, j);
117
118 /* DPi Bank0 registers */
119 ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
120 for (j = SDW_DPN_CHANNELEN_B0(i);
121 j <= SDW_DPN_LANECTRL_B0(i); j++)
122 ret += sdw_sprintf(slave, buf, ret, j);
123
124 /* DPi Bank1 registers */
125 ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
126 for (j = SDW_DPN_CHANNELEN_B1(i);
127 j <= SDW_DPN_LANECTRL_B1(i); j++)
128 ret += sdw_sprintf(slave, buf, ret, j);
129 }
130
131 seq_printf(s_file, "%s", buf);
132
133 pm_runtime_mark_last_busy(&slave->dev);
134 pm_runtime_put(&slave->dev);
135
136 return 0;
137}
138DEFINE_SHOW_ATTRIBUTE(sdw_slave_reg);
139
140#define MAX_CMD_BYTES (1024 * 1024)
141
142static int cmd;
143static int cmd_type;
144static u32 start_addr;
145static size_t num_bytes;
146static u8 read_buffer[MAX_CMD_BYTES];
147static char *firmware_file;
148
149static int set_command(void *data, u64 value)
150{
151 struct sdw_slave *slave = data;
152
153 if (value > 1)
154 return -EINVAL;
155
156 /* Userspace changed the hardware state behind the kernel's back */
157 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
158
159 dev_dbg(&slave->dev, "command: %s\n", str_read_write(value));
160 cmd = value;
161
162 return 0;
163}
164DEFINE_DEBUGFS_ATTRIBUTE(set_command_fops, NULL,
165 set_command, "%llu\n");
166
167static int set_command_type(void *data, u64 value)
168{
169 struct sdw_slave *slave = data;
170
171 if (value > 1)
172 return -EINVAL;
173
174 /* Userspace changed the hardware state behind the kernel's back */
175 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
176
177 dev_dbg(&slave->dev, "command type: %s\n", value ? "BRA" : "Column0");
178
179 cmd_type = (int)value;
180
181 return 0;
182}
183DEFINE_DEBUGFS_ATTRIBUTE(set_command_type_fops, NULL,
184 set_command_type, "%llu\n");
185
186static int set_start_address(void *data, u64 value)
187{
188 struct sdw_slave *slave = data;
189
190 /* Userspace changed the hardware state behind the kernel's back */
191 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
192
193 dev_dbg(&slave->dev, "start address %#llx\n", value);
194
195 start_addr = value;
196
197 return 0;
198}
199DEFINE_DEBUGFS_ATTRIBUTE(set_start_address_fops, NULL,
200 set_start_address, "%llu\n");
201
202static int set_num_bytes(void *data, u64 value)
203{
204 struct sdw_slave *slave = data;
205
206 if (value == 0 || value > MAX_CMD_BYTES)
207 return -EINVAL;
208
209 /* Userspace changed the hardware state behind the kernel's back */
210 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
211
212 dev_dbg(&slave->dev, "number of bytes %lld\n", value);
213
214 num_bytes = value;
215
216 return 0;
217}
218DEFINE_DEBUGFS_ATTRIBUTE(set_num_bytes_fops, NULL,
219 set_num_bytes, "%llu\n");
220
221static int do_bpt_sequence(struct sdw_slave *slave, bool write, u8 *buffer)
222{
223 struct sdw_bpt_msg msg = {0};
224 struct sdw_bpt_section *sec;
225
226 sec = kzalloc_objs(*sec, 1);
227 if (!sec)
228 return -ENOMEM;
229 msg.sections = 1;
230
231 sec[0].addr = start_addr;
232 sec[0].len = num_bytes;
233
234 msg.sec = sec;
235 msg.dev_num = slave->dev_num;
236 if (write)
237 msg.flags = SDW_MSG_FLAG_WRITE;
238 else
239 msg.flags = SDW_MSG_FLAG_READ;
240 sec[0].buf = buffer;
241
242 return sdw_bpt_send_sync(slave->bus, slave, &msg);
243}
244
245static int cmd_go(void *data, u64 value)
246{
247 const struct firmware *fw = NULL;
248 struct sdw_slave *slave = data;
249 ktime_t start_t;
250 ktime_t finish_t;
251 int ret;
252
253 if (value != 1)
254 return -EINVAL;
255
256 /* one last check */
257 if (start_addr > SDW_REG_MAX ||
258 num_bytes == 0 || num_bytes > MAX_CMD_BYTES)
259 return -EINVAL;
260
261 ret = pm_runtime_get_sync(&slave->dev);
262 if (ret < 0 && ret != -EACCES) {
263 pm_runtime_put_noidle(&slave->dev);
264 return ret;
265 }
266
267 if (cmd == 0) {
268 ret = request_firmware(&fw, firmware_file, &slave->dev);
269 if (ret < 0) {
270 dev_err(&slave->dev, "firmware %s not found\n", firmware_file);
271 goto out;
272 }
273 if (fw->size < num_bytes) {
274 dev_err(&slave->dev,
275 "firmware %s: firmware size %zd, desired %zd\n",
276 firmware_file, fw->size, num_bytes);
277 goto out;
278 }
279 }
280
281 /* Userspace changed the hardware state behind the kernel's back */
282 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
283
284 dev_dbg(&slave->dev, "starting command\n");
285 start_t = ktime_get();
286
287 if (cmd == 0) {
288 if (cmd_type)
289 ret = do_bpt_sequence(slave, true, (u8 *)fw->data);
290 else
291 ret = sdw_nwrite_no_pm(slave, start_addr, num_bytes, fw->data);
292 } else {
293 memset(read_buffer, 0, sizeof(read_buffer));
294
295 if (cmd_type)
296 ret = do_bpt_sequence(slave, false, read_buffer);
297 else
298 ret = sdw_nread_no_pm(slave, start_addr, num_bytes, read_buffer);
299 }
300
301 finish_t = ktime_get();
302
303 dev_dbg(&slave->dev, "command completed, num_byte %zu status %d, time %lld ms\n",
304 num_bytes, ret, div_u64(finish_t - start_t, NSEC_PER_MSEC));
305
306out:
307 if (fw)
308 release_firmware(fw);
309
310 pm_runtime_mark_last_busy(&slave->dev);
311 pm_runtime_put(&slave->dev);
312
313 return ret;
314}
315DEFINE_DEBUGFS_ATTRIBUTE(cmd_go_fops, NULL,
316 cmd_go, "%llu\n");
317
318#define MAX_LINE_LEN 128
319
320static int read_buffer_show(struct seq_file *s_file, void *data)
321{
322 char buf[MAX_LINE_LEN];
323 int i;
324
325 if (num_bytes == 0 || num_bytes > MAX_CMD_BYTES)
326 return -EINVAL;
327
328 for (i = 0; i < num_bytes; i++) {
329 scnprintf(buf, MAX_LINE_LEN, "address %#x val 0x%02x\n",
330 start_addr + i, read_buffer[i]);
331 seq_printf(s_file, "%s", buf);
332 }
333
334 return 0;
335}
336DEFINE_SHOW_ATTRIBUTE(read_buffer);
337
338void sdw_slave_debugfs_init(struct sdw_slave *slave)
339{
340 struct dentry *master;
341 struct dentry *d;
342 char name[32];
343
344 master = slave->bus->debugfs;
345
346 /* create the debugfs slave-name */
347 snprintf(name, sizeof(name), "%s", dev_name(&slave->dev));
348 d = debugfs_create_dir(name, master);
349
350 debugfs_create_file("registers", 0400, d, slave, &sdw_slave_reg_fops);
351
352 /* interface to send arbitrary commands */
353 debugfs_create_file("command", 0200, d, slave, &set_command_fops);
354 debugfs_create_file("command_type", 0200, d, slave, &set_command_type_fops);
355 debugfs_create_file("start_address", 0200, d, slave, &set_start_address_fops);
356 debugfs_create_file("num_bytes", 0200, d, slave, &set_num_bytes_fops);
357 debugfs_create_file("go", 0200, d, slave, &cmd_go_fops);
358
359 debugfs_create_file("read_buffer", 0400, d, slave, &read_buffer_fops);
360 if (firmware_file)
361 debugfs_create_str("firmware_file", 0200, d, &firmware_file);
362
363 slave->debugfs = d;
364}
365
366void sdw_slave_debugfs_exit(struct sdw_slave *slave)
367{
368 debugfs_remove_recursive(slave->debugfs);
369}
370
371void sdw_debugfs_init(void)
372{
373 if (!firmware_file)
374 firmware_file = kstrdup("", GFP_KERNEL);
375
376 sdw_debugfs_root = debugfs_create_dir("soundwire", NULL);
377}
378
379void sdw_debugfs_exit(void)
380{
381 debugfs_remove_recursive(sdw_debugfs_root);
382 kfree(firmware_file);
383 firmware_file = NULL;
384}