Commit | Line | Data |
---|---|---|
599e8d80 DV |
1 | /* |
2 | * Ultra Wide Band | |
3 | * Debug support | |
4 | * | |
5 | * Copyright (C) 2005-2006 Intel Corporation | |
6 | * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com> | |
e43ace89 | 7 | * Copyright (C) 2008 Cambridge Silicon Radio Ltd. |
599e8d80 DV |
8 | * |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License version | |
11 | * 2 as published by the Free Software Foundation. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program; if not, write to the Free Software | |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
21 | * 02110-1301, USA. | |
22 | * | |
23 | * | |
24 | * FIXME: doc | |
25 | */ | |
26 | ||
27 | #include <linux/spinlock.h> | |
28 | #include <linux/module.h> | |
29 | #include <linux/slab.h> | |
30 | #include <linux/notifier.h> | |
31 | #include <linux/device.h> | |
32 | #include <linux/debugfs.h> | |
33 | #include <linux/uaccess.h> | |
34 | #include <linux/seq_file.h> | |
35 | ||
36 | #include <linux/uwb/debug-cmd.h> | |
599e8d80 DV |
37 | |
38 | #include "uwb-internal.h" | |
39 | ||
599e8d80 DV |
40 | /* |
41 | * Debug interface | |
42 | * | |
43 | * Per radio controller debugfs files (in uwb/uwbN/): | |
44 | * | |
45 | * command: Flexible command interface (see <linux/uwb/debug-cmd.h>). | |
46 | * | |
47 | * reservations: information on reservations. | |
48 | * | |
49 | * accept: Set to true (Y or 1) to accept reservation requests from | |
50 | * peers. | |
51 | * | |
52 | * drp_avail: DRP availability information. | |
53 | */ | |
54 | ||
55 | struct uwb_dbg { | |
56 | struct uwb_pal pal; | |
57 | ||
621a5f7a | 58 | bool accept; |
599e8d80 DV |
59 | struct list_head rsvs; |
60 | ||
61 | struct dentry *root_d; | |
62 | struct dentry *command_f; | |
63 | struct dentry *reservations_f; | |
64 | struct dentry *accept_f; | |
65 | struct dentry *drp_avail_f; | |
5b37717a | 66 | spinlock_t list_lock; |
599e8d80 DV |
67 | }; |
68 | ||
69 | static struct dentry *root_dir; | |
70 | ||
71 | static void uwb_dbg_rsv_cb(struct uwb_rsv *rsv) | |
72 | { | |
5b37717a | 73 | struct uwb_dbg *dbg = rsv->pal_priv; |
599e8d80 | 74 | |
5b37717a | 75 | uwb_rsv_dump("debug", rsv); |
cae1c114 DV |
76 | |
77 | if (rsv->state == UWB_RSV_STATE_NONE) { | |
5b37717a | 78 | spin_lock(&dbg->list_lock); |
cae1c114 | 79 | list_del(&rsv->pal_node); |
5b37717a | 80 | spin_unlock(&dbg->list_lock); |
cae1c114 DV |
81 | uwb_rsv_destroy(rsv); |
82 | } | |
599e8d80 DV |
83 | } |
84 | ||
85 | static int cmd_rsv_establish(struct uwb_rc *rc, | |
86 | struct uwb_dbg_cmd_rsv_establish *cmd) | |
87 | { | |
88 | struct uwb_mac_addr macaddr; | |
89 | struct uwb_rsv *rsv; | |
90 | struct uwb_dev *target; | |
91 | int ret; | |
92 | ||
93 | memcpy(&macaddr, cmd->target, sizeof(macaddr)); | |
94 | target = uwb_dev_get_by_macaddr(rc, &macaddr); | |
95 | if (target == NULL) | |
96 | return -ENODEV; | |
97 | ||
e4b49580 | 98 | rsv = uwb_rsv_create(rc, uwb_dbg_rsv_cb, rc->dbg); |
599e8d80 DV |
99 | if (rsv == NULL) { |
100 | uwb_dev_put(target); | |
101 | return -ENOMEM; | |
102 | } | |
103 | ||
5b37717a SP |
104 | rsv->target.type = UWB_RSV_TARGET_DEV; |
105 | rsv->target.dev = target; | |
106 | rsv->type = cmd->type; | |
107 | rsv->max_mas = cmd->max_mas; | |
108 | rsv->min_mas = cmd->min_mas; | |
109 | rsv->max_interval = cmd->max_interval; | |
599e8d80 DV |
110 | |
111 | ret = uwb_rsv_establish(rsv); | |
112 | if (ret) | |
113 | uwb_rsv_destroy(rsv); | |
5b37717a SP |
114 | else { |
115 | spin_lock(&(rc->dbg)->list_lock); | |
599e8d80 | 116 | list_add_tail(&rsv->pal_node, &rc->dbg->rsvs); |
5b37717a SP |
117 | spin_unlock(&(rc->dbg)->list_lock); |
118 | } | |
599e8d80 DV |
119 | return ret; |
120 | } | |
121 | ||
122 | static int cmd_rsv_terminate(struct uwb_rc *rc, | |
123 | struct uwb_dbg_cmd_rsv_terminate *cmd) | |
124 | { | |
125 | struct uwb_rsv *rsv, *found = NULL; | |
126 | int i = 0; | |
127 | ||
5b37717a SP |
128 | spin_lock(&(rc->dbg)->list_lock); |
129 | ||
599e8d80 DV |
130 | list_for_each_entry(rsv, &rc->dbg->rsvs, pal_node) { |
131 | if (i == cmd->index) { | |
132 | found = rsv; | |
5b37717a | 133 | uwb_rsv_get(found); |
599e8d80 DV |
134 | break; |
135 | } | |
cae1c114 | 136 | i++; |
599e8d80 | 137 | } |
5b37717a SP |
138 | |
139 | spin_unlock(&(rc->dbg)->list_lock); | |
140 | ||
599e8d80 DV |
141 | if (!found) |
142 | return -EINVAL; | |
143 | ||
599e8d80 | 144 | uwb_rsv_terminate(found); |
5b37717a | 145 | uwb_rsv_put(found); |
599e8d80 DV |
146 | |
147 | return 0; | |
148 | } | |
149 | ||
6d5a681d SP |
150 | static int cmd_ie_add(struct uwb_rc *rc, struct uwb_dbg_cmd_ie *ie_to_add) |
151 | { | |
152 | return uwb_rc_ie_add(rc, | |
153 | (const struct uwb_ie_hdr *) ie_to_add->data, | |
154 | ie_to_add->len); | |
155 | } | |
156 | ||
157 | static int cmd_ie_rm(struct uwb_rc *rc, struct uwb_dbg_cmd_ie *ie_to_rm) | |
158 | { | |
159 | return uwb_rc_ie_rm(rc, ie_to_rm->data[0]); | |
160 | } | |
161 | ||
599e8d80 DV |
162 | static ssize_t command_write(struct file *file, const char __user *buf, |
163 | size_t len, loff_t *off) | |
164 | { | |
165 | struct uwb_rc *rc = file->private_data; | |
166 | struct uwb_dbg_cmd cmd; | |
6fae35f9 | 167 | int ret = 0; |
5b37717a | 168 | |
599e8d80 DV |
169 | if (len != sizeof(struct uwb_dbg_cmd)) |
170 | return -EINVAL; | |
171 | ||
172 | if (copy_from_user(&cmd, buf, len) != 0) | |
173 | return -EFAULT; | |
174 | ||
175 | switch (cmd.type) { | |
176 | case UWB_DBG_CMD_RSV_ESTABLISH: | |
177 | ret = cmd_rsv_establish(rc, &cmd.rsv_establish); | |
178 | break; | |
179 | case UWB_DBG_CMD_RSV_TERMINATE: | |
180 | ret = cmd_rsv_terminate(rc, &cmd.rsv_terminate); | |
181 | break; | |
6d5a681d SP |
182 | case UWB_DBG_CMD_IE_ADD: |
183 | ret = cmd_ie_add(rc, &cmd.ie_add); | |
184 | break; | |
185 | case UWB_DBG_CMD_IE_RM: | |
186 | ret = cmd_ie_rm(rc, &cmd.ie_rm); | |
187 | break; | |
6fae35f9 DV |
188 | case UWB_DBG_CMD_RADIO_START: |
189 | ret = uwb_radio_start(&rc->dbg->pal); | |
190 | break; | |
191 | case UWB_DBG_CMD_RADIO_STOP: | |
192 | uwb_radio_stop(&rc->dbg->pal); | |
193 | break; | |
599e8d80 DV |
194 | default: |
195 | return -EINVAL; | |
196 | } | |
197 | ||
198 | return ret < 0 ? ret : len; | |
199 | } | |
200 | ||
828c0950 | 201 | static const struct file_operations command_fops = { |
234e3405 | 202 | .open = simple_open, |
599e8d80 DV |
203 | .write = command_write, |
204 | .read = NULL, | |
205 | .llseek = no_llseek, | |
206 | .owner = THIS_MODULE, | |
207 | }; | |
208 | ||
209 | static int reservations_print(struct seq_file *s, void *p) | |
210 | { | |
211 | struct uwb_rc *rc = s->private; | |
212 | struct uwb_rsv *rsv; | |
213 | ||
214 | mutex_lock(&rc->rsvs_mutex); | |
215 | ||
216 | list_for_each_entry(rsv, &rc->reservations, rc_node) { | |
217 | struct uwb_dev_addr devaddr; | |
218 | char owner[UWB_ADDR_STRSIZE], target[UWB_ADDR_STRSIZE]; | |
219 | bool is_owner; | |
599e8d80 DV |
220 | |
221 | uwb_dev_addr_print(owner, sizeof(owner), &rsv->owner->dev_addr); | |
222 | if (rsv->target.type == UWB_RSV_TARGET_DEV) { | |
223 | devaddr = rsv->target.dev->dev_addr; | |
224 | is_owner = &rc->uwb_dev == rsv->owner; | |
225 | } else { | |
226 | devaddr = rsv->target.devaddr; | |
227 | is_owner = true; | |
228 | } | |
229 | uwb_dev_addr_print(target, sizeof(target), &devaddr); | |
230 | ||
231 | seq_printf(s, "%c %s -> %s: %s\n", | |
232 | is_owner ? 'O' : 'T', | |
233 | owner, target, uwb_rsv_state_str(rsv->state)); | |
234 | seq_printf(s, " stream: %d type: %s\n", | |
235 | rsv->stream, uwb_rsv_type_str(rsv->type)); | |
125918db | 236 | seq_printf(s, " %*pb\n", UWB_NUM_MAS, rsv->mas.bm); |
599e8d80 DV |
237 | } |
238 | ||
239 | mutex_unlock(&rc->rsvs_mutex); | |
240 | ||
241 | return 0; | |
242 | } | |
243 | ||
244 | static int reservations_open(struct inode *inode, struct file *file) | |
245 | { | |
246 | return single_open(file, reservations_print, inode->i_private); | |
247 | } | |
248 | ||
828c0950 | 249 | static const struct file_operations reservations_fops = { |
599e8d80 DV |
250 | .open = reservations_open, |
251 | .read = seq_read, | |
252 | .llseek = seq_lseek, | |
253 | .release = single_release, | |
254 | .owner = THIS_MODULE, | |
255 | }; | |
256 | ||
257 | static int drp_avail_print(struct seq_file *s, void *p) | |
258 | { | |
259 | struct uwb_rc *rc = s->private; | |
125918db TH |
260 | |
261 | seq_printf(s, "global: %*pb\n", UWB_NUM_MAS, rc->drp_avail.global); | |
262 | seq_printf(s, "local: %*pb\n", UWB_NUM_MAS, rc->drp_avail.local); | |
263 | seq_printf(s, "pending: %*pb\n", UWB_NUM_MAS, rc->drp_avail.pending); | |
599e8d80 DV |
264 | |
265 | return 0; | |
266 | } | |
267 | ||
268 | static int drp_avail_open(struct inode *inode, struct file *file) | |
269 | { | |
270 | return single_open(file, drp_avail_print, inode->i_private); | |
271 | } | |
272 | ||
828c0950 | 273 | static const struct file_operations drp_avail_fops = { |
599e8d80 DV |
274 | .open = drp_avail_open, |
275 | .read = seq_read, | |
276 | .llseek = seq_lseek, | |
277 | .release = single_release, | |
278 | .owner = THIS_MODULE, | |
279 | }; | |
280 | ||
6fae35f9 DV |
281 | static void uwb_dbg_channel_changed(struct uwb_pal *pal, int channel) |
282 | { | |
6fae35f9 DV |
283 | struct device *dev = &pal->rc->uwb_dev.dev; |
284 | ||
285 | if (channel > 0) | |
286 | dev_info(dev, "debug: channel %d started\n", channel); | |
287 | else | |
288 | dev_info(dev, "debug: channel stopped\n"); | |
289 | } | |
290 | ||
e17be2b2 | 291 | static void uwb_dbg_new_rsv(struct uwb_pal *pal, struct uwb_rsv *rsv) |
599e8d80 | 292 | { |
e17be2b2 | 293 | struct uwb_dbg *dbg = container_of(pal, struct uwb_dbg, pal); |
599e8d80 | 294 | |
e17be2b2 | 295 | if (dbg->accept) { |
5b37717a | 296 | spin_lock(&dbg->list_lock); |
e17be2b2 | 297 | list_add_tail(&rsv->pal_node, &dbg->rsvs); |
5b37717a | 298 | spin_unlock(&dbg->list_lock); |
e17be2b2 | 299 | uwb_rsv_accept(rsv, uwb_dbg_rsv_cb, dbg); |
cae1c114 | 300 | } |
599e8d80 DV |
301 | } |
302 | ||
303 | /** | |
304 | * uwb_dbg_add_rc - add a debug interface for a radio controller | |
305 | * @rc: the radio controller | |
306 | */ | |
307 | void uwb_dbg_add_rc(struct uwb_rc *rc) | |
308 | { | |
309 | rc->dbg = kzalloc(sizeof(struct uwb_dbg), GFP_KERNEL); | |
310 | if (rc->dbg == NULL) | |
311 | return; | |
312 | ||
313 | INIT_LIST_HEAD(&rc->dbg->rsvs); | |
5b37717a | 314 | spin_lock_init(&(rc->dbg)->list_lock); |
599e8d80 DV |
315 | |
316 | uwb_pal_init(&rc->dbg->pal); | |
6fae35f9 DV |
317 | rc->dbg->pal.rc = rc; |
318 | rc->dbg->pal.channel_changed = uwb_dbg_channel_changed; | |
599e8d80 | 319 | rc->dbg->pal.new_rsv = uwb_dbg_new_rsv; |
6fae35f9 DV |
320 | uwb_pal_register(&rc->dbg->pal); |
321 | ||
599e8d80 DV |
322 | if (root_dir) { |
323 | rc->dbg->root_d = debugfs_create_dir(dev_name(&rc->uwb_dev.dev), | |
324 | root_dir); | |
325 | rc->dbg->command_f = debugfs_create_file("command", 0200, | |
326 | rc->dbg->root_d, rc, | |
327 | &command_fops); | |
328 | rc->dbg->reservations_f = debugfs_create_file("reservations", 0444, | |
329 | rc->dbg->root_d, rc, | |
330 | &reservations_fops); | |
331 | rc->dbg->accept_f = debugfs_create_bool("accept", 0644, | |
332 | rc->dbg->root_d, | |
333 | &rc->dbg->accept); | |
334 | rc->dbg->drp_avail_f = debugfs_create_file("drp_avail", 0444, | |
335 | rc->dbg->root_d, rc, | |
336 | &drp_avail_fops); | |
337 | } | |
338 | } | |
339 | ||
340 | /** | |
6d5a681d | 341 | * uwb_dbg_del_rc - remove a radio controller's debug interface |
599e8d80 DV |
342 | * @rc: the radio controller |
343 | */ | |
344 | void uwb_dbg_del_rc(struct uwb_rc *rc) | |
345 | { | |
346 | struct uwb_rsv *rsv, *t; | |
347 | ||
348 | if (rc->dbg == NULL) | |
349 | return; | |
350 | ||
351 | list_for_each_entry_safe(rsv, t, &rc->dbg->rsvs, pal_node) { | |
cae1c114 | 352 | uwb_rsv_terminate(rsv); |
599e8d80 DV |
353 | } |
354 | ||
6fae35f9 | 355 | uwb_pal_unregister(&rc->dbg->pal); |
599e8d80 DV |
356 | |
357 | if (root_dir) { | |
358 | debugfs_remove(rc->dbg->drp_avail_f); | |
359 | debugfs_remove(rc->dbg->accept_f); | |
360 | debugfs_remove(rc->dbg->reservations_f); | |
361 | debugfs_remove(rc->dbg->command_f); | |
362 | debugfs_remove(rc->dbg->root_d); | |
363 | } | |
364 | } | |
365 | ||
366 | /** | |
367 | * uwb_dbg_exit - initialize the debug interface sub-module | |
368 | */ | |
369 | void uwb_dbg_init(void) | |
370 | { | |
371 | root_dir = debugfs_create_dir("uwb", NULL); | |
372 | } | |
373 | ||
374 | /** | |
375 | * uwb_dbg_exit - clean-up the debug interface sub-module | |
376 | */ | |
377 | void uwb_dbg_exit(void) | |
378 | { | |
379 | debugfs_remove(root_dir); | |
380 | } | |
dcc7461e DV |
381 | |
382 | /** | |
383 | * uwb_dbg_create_pal_dir - create a debugfs directory for a PAL | |
384 | * @pal: The PAL. | |
385 | */ | |
386 | struct dentry *uwb_dbg_create_pal_dir(struct uwb_pal *pal) | |
387 | { | |
388 | struct uwb_rc *rc = pal->rc; | |
389 | ||
390 | if (root_dir && rc->dbg && rc->dbg->root_d && pal->name) | |
391 | return debugfs_create_dir(pal->name, rc->dbg->root_d); | |
392 | return NULL; | |
393 | } |