xref: /linux/drivers/hid/hid-wiimote-debug.c (revision 5b193d6a8973655f19de87a7873ce31dee2d5fe6)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Debug support for HID Nintendo Wii / Wii U peripherals
4  * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
5  */
6 
7 /*
8  */
9 
10  #include <linux/cleanup.h>
11  #include <linux/debugfs.h>
12  #include <linux/module.h>
13  #include <linux/seq_file.h>
14  #include <linux/spinlock.h>
15  #include <linux/uaccess.h>
16  #include "hid-wiimote.h"
17 
18 struct wiimote_debug {
19 	struct wiimote_data *wdata;
20 	struct dentry *eeprom;
21 	struct dentry *drm;
22 };
23 
24 static ssize_t wiidebug_eeprom_read(struct file *f, char __user *u, size_t s,
25 								loff_t *off)
26 {
27 	struct wiimote_debug *dbg = f->private_data;
28 	struct wiimote_data *wdata = dbg->wdata;
29 	ssize_t ret;
30 	char buf[16];
31 	__u16 size = 0;
32 
33 	if (s == 0)
34 		return -EINVAL;
35 	if (*off > 0xffffff)
36 		return 0;
37 	if (s > 16)
38 		s = 16;
39 
40 	ret = wiimote_cmd_acquire(wdata);
41 	if (ret)
42 		return ret;
43 
44 	scoped_guard(spinlock_irqsave, &wdata->state.lock) {
45 		wdata->state.cmd_read_size = s;
46 		wdata->state.cmd_read_buf = buf;
47 		wiimote_cmd_set(wdata, WIIPROTO_REQ_RMEM, *off & 0xffff);
48 		wiiproto_req_reeprom(wdata, *off, s);
49 	}
50 
51 	ret = wiimote_cmd_wait(wdata);
52 	if (!ret)
53 		size = wdata->state.cmd_read_size;
54 
55 	scoped_guard(spinlock_irqsave, &wdata->state.lock)
56 		wdata->state.cmd_read_buf = NULL;
57 
58 	wiimote_cmd_release(wdata);
59 
60 	if (ret)
61 		return ret;
62 	else if (size == 0)
63 		return -EIO;
64 
65 	if (copy_to_user(u, buf, size))
66 		return -EFAULT;
67 
68 	*off += size;
69 	ret = size;
70 
71 	return ret;
72 }
73 
74 static const struct file_operations wiidebug_eeprom_fops = {
75 	.owner = THIS_MODULE,
76 	.open = simple_open,
77 	.read = wiidebug_eeprom_read,
78 	.llseek = generic_file_llseek,
79 };
80 
81 static const char *wiidebug_drmmap[] = {
82 	[WIIPROTO_REQ_NULL] = "NULL",
83 	[WIIPROTO_REQ_DRM_K] = "K",
84 	[WIIPROTO_REQ_DRM_KA] = "KA",
85 	[WIIPROTO_REQ_DRM_KE] = "KE",
86 	[WIIPROTO_REQ_DRM_KAI] = "KAI",
87 	[WIIPROTO_REQ_DRM_KEE] = "KEE",
88 	[WIIPROTO_REQ_DRM_KAE] = "KAE",
89 	[WIIPROTO_REQ_DRM_KIE] = "KIE",
90 	[WIIPROTO_REQ_DRM_KAIE] = "KAIE",
91 	[WIIPROTO_REQ_DRM_E] = "E",
92 	[WIIPROTO_REQ_DRM_SKAI1] = "SKAI1",
93 	[WIIPROTO_REQ_DRM_SKAI2] = "SKAI2",
94 	[WIIPROTO_REQ_MAX] = NULL
95 };
96 
97 static int wiidebug_drm_show(struct seq_file *f, void *p)
98 {
99 	struct wiimote_debug *dbg = f->private;
100 	const char *str = NULL;
101 	__u8 drm;
102 
103 	scoped_guard(spinlock_irqsave, &dbg->wdata->state.lock)
104 		drm = dbg->wdata->state.drm;
105 
106 	if (drm < WIIPROTO_REQ_MAX)
107 		str = wiidebug_drmmap[drm];
108 	if (!str)
109 		str = "unknown";
110 
111 	seq_printf(f, "%s\n", str);
112 
113 	return 0;
114 }
115 
116 static int wiidebug_drm_open(struct inode *i, struct file *f)
117 {
118 	return single_open(f, wiidebug_drm_show, i->i_private);
119 }
120 
121 static ssize_t wiidebug_drm_write(struct file *f, const char __user *u,
122 							size_t s, loff_t *off)
123 {
124 	struct seq_file *sf = f->private_data;
125 	struct wiimote_debug *dbg = sf->private;
126 	char buf[16];
127 	ssize_t len;
128 	int i;
129 
130 	if (s == 0)
131 		return -EINVAL;
132 
133 	len = min((size_t) 15, s);
134 	if (copy_from_user(buf, u, len))
135 		return -EFAULT;
136 
137 	buf[len] = 0;
138 
139 	for (i = 0; i < WIIPROTO_REQ_MAX; ++i) {
140 		if (!wiidebug_drmmap[i])
141 			continue;
142 		if (!strcasecmp(buf, wiidebug_drmmap[i]))
143 			break;
144 	}
145 
146 	if (i == WIIPROTO_REQ_MAX)
147 		i = simple_strtoul(buf, NULL, 16);
148 
149 	scoped_guard(spinlock_irqsave, &dbg->wdata->state.lock) {
150 		dbg->wdata->state.flags &= ~WIIPROTO_FLAG_DRM_LOCKED;
151 		wiiproto_req_drm(dbg->wdata, (__u8) i);
152 		if (i != WIIPROTO_REQ_NULL)
153 			dbg->wdata->state.flags |= WIIPROTO_FLAG_DRM_LOCKED;
154 	}
155 
156 	return len;
157 }
158 
159 static const struct file_operations wiidebug_drm_fops = {
160 	.owner = THIS_MODULE,
161 	.open = wiidebug_drm_open,
162 	.read = seq_read,
163 	.llseek = seq_lseek,
164 	.write = wiidebug_drm_write,
165 	.release = single_release,
166 };
167 
168 int wiidebug_init(struct wiimote_data *wdata)
169 {
170 	struct wiimote_debug *dbg;
171 
172 	dbg = kzalloc_obj(*dbg);
173 	if (!dbg)
174 		return -ENOMEM;
175 
176 	dbg->wdata = wdata;
177 
178 	dbg->eeprom = debugfs_create_file("eeprom", S_IRUSR,
179 		dbg->wdata->hdev->debug_dir, dbg, &wiidebug_eeprom_fops);
180 
181 	dbg->drm = debugfs_create_file("drm", S_IRUSR,
182 			dbg->wdata->hdev->debug_dir, dbg, &wiidebug_drm_fops);
183 
184 	debugfs_create_u8("player_id", S_IRUSR,
185 		   dbg->wdata->hdev->debug_dir, &wdata->player_id);
186 
187 	scoped_guard(spinlock_irqsave, &wdata->state.lock)
188 		wdata->debug = dbg;
189 
190 	return 0;
191 }
192 
193 void wiidebug_deinit(struct wiimote_data *wdata)
194 {
195 	struct wiimote_debug *dbg = wdata->debug;
196 
197 	if (!dbg)
198 		return;
199 
200 	scoped_guard(spinlock_irqsave, &wdata->state.lock)
201 		wdata->debug = NULL;
202 
203 	debugfs_remove(dbg->drm);
204 	debugfs_remove(dbg->eeprom);
205 	debugfs_lookup_and_remove("player_id", dbg->wdata->hdev->debug_dir);
206 	kfree(dbg);
207 }
208