3 Broadcom B43 wireless driver
5 debugfs driver debugging code
7 Copyright (c) 2005-2007 Michael Buesch <mb@bu3sch.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 51 Franklin Steet, Fifth Floor,
22 Boston, MA 02110-1301, USA.
27 #include <linux/debugfs.h>
28 #include <linux/slab.h>
29 #include <linux/netdevice.h>
30 #include <linux/pci.h>
31 #include <linux/mutex.h>
41 /* The root directory. */
42 struct dentry *rootdir;
44 struct b43_debugfs_fops {
45 ssize_t (*read)(struct b43_wldev *dev, char *buf, size_t bufsize);
46 int (*write)(struct b43_wldev *dev, const char *buf, size_t count);
47 struct file_operations fops;
48 /* Offset of struct b43_dfs_file in struct b43_dfsentry */
49 size_t file_struct_offset;
50 /* Take wl->irq_lock before calling read/write? */
55 struct b43_dfs_file * fops_to_dfs_file(struct b43_wldev *dev,
56 const struct b43_debugfs_fops *dfops)
61 p += dfops->file_struct_offset;
67 #define fappend(fmt, x...) \
69 if (bufsize - count) \
70 count += snprintf(buf + count, \
74 printk(KERN_ERR "b43: fappend overflow\n"); \
78 /* wl->irq_lock is locked */
79 ssize_t tsf_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
84 b43_tsf_read(dev, &tsf);
85 fappend("0x%08x%08x\n",
86 (unsigned int)((tsf & 0xFFFFFFFF00000000ULL) >> 32),
87 (unsigned int)(tsf & 0xFFFFFFFFULL));
92 /* wl->irq_lock is locked */
93 int tsf_write_file(struct b43_wldev *dev, const char *buf, size_t count)
97 if (sscanf(buf, "%llu", (unsigned long long *)(&tsf)) != 1)
99 b43_tsf_write(dev, tsf);
104 /* wl->irq_lock is locked */
105 ssize_t ucode_regs_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
110 for (i = 0; i < 64; i++) {
111 fappend("r%d = 0x%04x\n", i,
112 b43_shm_read16(dev, B43_SHM_SCRATCH, i));
118 /* wl->irq_lock is locked */
119 ssize_t shm_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
124 __le16 *le16buf = (__le16 *)buf;
126 for (i = 0; i < 0x1000; i++) {
129 tmp = b43_shm_read16(dev, B43_SHM_SHARED, 2 * i);
130 le16buf[i] = cpu_to_le16(tmp);
131 count += sizeof(tmp);
132 bufsize -= sizeof(tmp);
138 ssize_t txstat_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
140 struct b43_txstatus_log *log = &dev->dfsentry->txstatlog;
144 struct b43_txstatus *stat;
146 spin_lock_irqsave(&log->lock, flags);
148 fappend("Nothing transmitted, yet\n");
151 fappend("b43 TX status reports:\n\n"
152 "index | cookie | seq | phy_stat | frame_count | "
153 "rts_count | supp_reason | pm_indicated | "
154 "intermediate | for_ampdu | acked\n" "---\n");
158 if (i == B43_NR_LOGGED_TXSTATUS)
160 stat = &(log->log[i]);
163 "0x%04X | 0x%04X | 0x%02X | "
168 stat->cookie, stat->seq, stat->phy_stat,
169 stat->frame_count, stat->rts_count,
170 stat->supp_reason, stat->pm_indicated,
171 stat->intermediate, stat->for_ampdu,
180 spin_unlock_irqrestore(&log->lock, flags);
185 ssize_t txpower_g_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
189 if (dev->phy.type != B43_PHYTYPE_G) {
190 fappend("Device is not a G-PHY\n");
193 fappend("Control: %s\n", dev->phy.manual_txpower_control ?
194 "MANUAL" : "AUTOMATIC");
195 fappend("Baseband attenuation: %u\n", dev->phy.bbatt.att);
196 fappend("Radio attenuation: %u\n", dev->phy.rfatt.att);
197 fappend("TX Mixer Gain: %s\n",
198 (dev->phy.tx_control & B43_TXCTL_TXMIX) ? "ON" : "OFF");
199 fappend("PA Gain 2dB: %s\n",
200 (dev->phy.tx_control & B43_TXCTL_PA2DB) ? "ON" : "OFF");
201 fappend("PA Gain 3dB: %s\n",
202 (dev->phy.tx_control & B43_TXCTL_PA3DB) ? "ON" : "OFF");
204 fappend("You can write to this file:\n");
205 fappend("Writing \"auto\" enables automatic txpower control.\n");
207 ("Writing the attenuation values as \"bbatt rfatt txmix pa2db pa3db\" "
208 "enables manual txpower control.\n");
209 fappend("Example: 5 4 0 0 1\n");
210 fappend("Enables manual control with Baseband attenuation 5, "
211 "Radio attenuation 4, No TX Mixer Gain, "
212 "No PA Gain 2dB, With PA Gain 3dB.\n");
217 int txpower_g_write_file(struct b43_wldev *dev, const char *buf, size_t count)
219 unsigned long phy_flags;
221 if (dev->phy.type != B43_PHYTYPE_G)
223 if ((count >= 4) && (memcmp(buf, "auto", 4) == 0)) {
224 /* Automatic control */
225 dev->phy.manual_txpower_control = 0;
226 b43_phy_xmitpower(dev);
228 int bbatt = 0, rfatt = 0, txmix = 0, pa2db = 0, pa3db = 0;
230 if (sscanf(buf, "%d %d %d %d %d", &bbatt, &rfatt,
231 &txmix, &pa2db, &pa3db) != 5)
233 b43_put_attenuation_into_ranges(dev, &bbatt, &rfatt);
234 dev->phy.manual_txpower_control = 1;
235 dev->phy.bbatt.att = bbatt;
236 dev->phy.rfatt.att = rfatt;
237 dev->phy.tx_control = 0;
239 dev->phy.tx_control |= B43_TXCTL_TXMIX;
241 dev->phy.tx_control |= B43_TXCTL_PA2DB;
243 dev->phy.tx_control |= B43_TXCTL_PA3DB;
244 b43_phy_lock(dev, phy_flags);
246 b43_set_txpower_g(dev, &dev->phy.bbatt,
247 &dev->phy.rfatt, dev->phy.tx_control);
248 b43_radio_unlock(dev);
249 b43_phy_unlock(dev, phy_flags);
255 /* wl->irq_lock is locked */
256 int restart_write_file(struct b43_wldev *dev, const char *buf, size_t count)
260 if (count > 0 && buf[0] == '1') {
261 b43_controller_restart(dev, "manually restarted");
268 static ssize_t append_lo_table(ssize_t count, char *buf, const size_t bufsize,
269 struct b43_loctl table[B43_NR_BB][B43_NR_RF])
272 struct b43_loctl *ctl;
274 for (i = 0; i < B43_NR_BB; i++) {
275 for (j = 0; j < B43_NR_RF; j++) {
276 ctl = &(table[i][j]);
277 fappend("(bbatt %2u, rfatt %2u) -> "
278 "(I %+3d, Q %+3d, Used: %d, Calibrated: %d)\n",
279 i, j, ctl->i, ctl->q,
281 b43_loctl_is_calibrated(ctl));
288 ssize_t loctls_read_file(struct b43_wldev *dev, char *buf, size_t bufsize)
291 struct b43_txpower_lo_control *lo;
294 if (dev->phy.type != B43_PHYTYPE_G) {
295 fappend("Device is not a G-PHY\n");
299 lo = dev->phy.lo_control;
300 fappend("-- Local Oscillator calibration data --\n\n");
301 fappend("Measured: %d, Rebuild: %d, HW-power-control: %d\n",
304 dev->phy.hardware_power_control);
305 fappend("TX Bias: 0x%02X, TX Magn: 0x%02X\n",
306 lo->tx_bias, lo->tx_magn);
307 fappend("Power Vector: 0x%08X%08X\n",
308 (unsigned int)((lo->power_vector & 0xFFFFFFFF00000000ULL) >> 32),
309 (unsigned int)(lo->power_vector & 0x00000000FFFFFFFFULL));
310 fappend("\nControl table WITH PADMIX:\n");
311 count = append_lo_table(count, buf, bufsize, lo->with_padmix);
312 fappend("\nControl table WITHOUT PADMIX:\n");
313 count = append_lo_table(count, buf, bufsize, lo->no_padmix);
314 fappend("\nUsed RF attenuation values: Value(WithPadmix flag)\n");
315 for (i = 0; i < lo->rfatt_list.len; i++) {
317 lo->rfatt_list.list[i].att,
318 lo->rfatt_list.list[i].with_padmix);
321 fappend("\nUsed Baseband attenuation values:\n");
322 for (i = 0; i < lo->bbatt_list.len; i++) {
324 lo->bbatt_list.list[i].att);
329 return err ? err : count;
334 static int b43_debugfs_open(struct inode *inode, struct file *file)
336 file->private_data = inode->i_private;
340 static ssize_t b43_debugfs_read(struct file *file, char __user *userbuf,
341 size_t count, loff_t *ppos)
343 struct b43_wldev *dev;
344 struct b43_debugfs_fops *dfops;
345 struct b43_dfs_file *dfile;
348 const size_t bufsize = 1024 * 128;
349 const size_t buforder = get_order(bufsize);
354 dev = file->private_data;
358 mutex_lock(&dev->wl->mutex);
359 if (b43_status(dev) < B43_STAT_INITIALIZED) {
364 dfops = container_of(file->f_op, struct b43_debugfs_fops, fops);
369 dfile = fops_to_dfs_file(dev, dfops);
371 if (!dfile->buffer) {
372 buf = (char *)__get_free_pages(GFP_KERNEL, buforder);
377 memset(buf, 0, bufsize);
378 if (dfops->take_irqlock) {
379 spin_lock_irq(&dev->wl->irq_lock);
380 ret = dfops->read(dev, buf, bufsize);
381 spin_unlock_irq(&dev->wl->irq_lock);
383 ret = dfops->read(dev, buf, bufsize);
385 free_pages((unsigned long)buf, buforder);
389 dfile->data_len = ret;
393 ret = simple_read_from_buffer(userbuf, count, ppos,
396 if (*ppos >= dfile->data_len) {
397 free_pages((unsigned long)dfile->buffer, buforder);
398 dfile->buffer = NULL;
402 mutex_unlock(&dev->wl->mutex);
404 return err ? err : ret;
407 static ssize_t b43_debugfs_write(struct file *file,
408 const char __user *userbuf,
409 size_t count, loff_t *ppos)
411 struct b43_wldev *dev;
412 struct b43_debugfs_fops *dfops;
418 if (count > PAGE_SIZE)
420 dev = file->private_data;
424 mutex_lock(&dev->wl->mutex);
425 if (b43_status(dev) < B43_STAT_INITIALIZED) {
430 dfops = container_of(file->f_op, struct b43_debugfs_fops, fops);
436 buf = (char *)get_zeroed_page(GFP_KERNEL);
441 if (copy_from_user(buf, userbuf, count)) {
445 if (dfops->take_irqlock) {
446 spin_lock_irq(&dev->wl->irq_lock);
447 err = dfops->write(dev, buf, count);
448 spin_unlock_irq(&dev->wl->irq_lock);
450 err = dfops->write(dev, buf, count);
455 free_page((unsigned long)buf);
457 mutex_unlock(&dev->wl->mutex);
459 return err ? err : count;
463 #define B43_DEBUGFS_FOPS(name, _read, _write, _take_irqlock) \
464 static struct b43_debugfs_fops fops_##name = { \
468 .open = b43_debugfs_open, \
469 .read = b43_debugfs_read, \
470 .write = b43_debugfs_write, \
472 .file_struct_offset = offsetof(struct b43_dfsentry, \
474 .take_irqlock = _take_irqlock, \
477 B43_DEBUGFS_FOPS(tsf, tsf_read_file, tsf_write_file, 1);
478 B43_DEBUGFS_FOPS(ucode_regs, ucode_regs_read_file, NULL, 1);
479 B43_DEBUGFS_FOPS(shm, shm_read_file, NULL, 1);
480 B43_DEBUGFS_FOPS(txstat, txstat_read_file, NULL, 0);
481 B43_DEBUGFS_FOPS(txpower_g, txpower_g_read_file, txpower_g_write_file, 0);
482 B43_DEBUGFS_FOPS(restart, NULL, restart_write_file, 1);
483 B43_DEBUGFS_FOPS(loctls, loctls_read_file, NULL, 0);
486 int b43_debug(struct b43_wldev *dev, enum b43_dyndbg feature)
488 return !!(dev->dfsentry && dev->dfsentry->dyn_debug[feature]);
491 static void b43_remove_dynamic_debug(struct b43_wldev *dev)
493 struct b43_dfsentry *e = dev->dfsentry;
496 for (i = 0; i < __B43_NR_DYNDBG; i++)
497 debugfs_remove(e->dyn_debug_dentries[i]);
500 static void b43_add_dynamic_debug(struct b43_wldev *dev)
502 struct b43_dfsentry *e = dev->dfsentry;
505 #define add_dyn_dbg(name, id, initstate) do { \
506 e->dyn_debug[id] = (initstate); \
507 d = debugfs_create_bool(name, 0600, e->subdir, \
508 &(e->dyn_debug[id])); \
510 e->dyn_debug_dentries[id] = d; \
513 add_dyn_dbg("debug_xmitpower", B43_DBG_XMITPOWER, 0);
514 add_dyn_dbg("debug_dmaoverflow", B43_DBG_DMAOVERFLOW, 0);
515 add_dyn_dbg("debug_dmaverbose", B43_DBG_DMAVERBOSE, 0);
516 add_dyn_dbg("debug_pwork_fast", B43_DBG_PWORK_FAST, 0);
517 add_dyn_dbg("debug_pwork_stop", B43_DBG_PWORK_STOP, 0);
522 void b43_debugfs_add_device(struct b43_wldev *dev)
524 struct b43_dfsentry *e;
525 struct b43_txstatus_log *log;
529 e = kzalloc(sizeof(*e), GFP_KERNEL);
531 b43err(dev->wl, "debugfs: add device OOM\n");
536 log->log = kcalloc(B43_NR_LOGGED_TXSTATUS,
537 sizeof(struct b43_txstatus), GFP_KERNEL);
539 b43err(dev->wl, "debugfs: add device txstatus OOM\n");
544 spin_lock_init(&log->lock);
548 snprintf(devdir, sizeof(devdir), "%s", wiphy_name(dev->wl->hw->wiphy));
549 e->subdir = debugfs_create_dir(devdir, rootdir);
550 if (!e->subdir || IS_ERR(e->subdir)) {
551 if (e->subdir == ERR_PTR(-ENODEV)) {
552 b43dbg(dev->wl, "DebugFS (CONFIG_DEBUG_FS) not "
553 "enabled in kernel config\n");
555 b43err(dev->wl, "debugfs: cannot create %s directory\n",
558 dev->dfsentry = NULL;
564 #define ADD_FILE(name, mode) \
567 d = debugfs_create_file(__stringify(name), \
568 mode, e->subdir, dev, \
569 &fops_##name.fops); \
570 e->file_##name.dentry = NULL; \
572 e->file_##name.dentry = d; \
577 ADD_FILE(ucode_regs, 0400);
579 ADD_FILE(txstat, 0400);
580 ADD_FILE(txpower_g, 0600);
581 ADD_FILE(restart, 0200);
582 ADD_FILE(loctls, 0400);
586 b43_add_dynamic_debug(dev);
589 void b43_debugfs_remove_device(struct b43_wldev *dev)
591 struct b43_dfsentry *e;
598 b43_remove_dynamic_debug(dev);
600 debugfs_remove(e->file_tsf.dentry);
601 debugfs_remove(e->file_ucode_regs.dentry);
602 debugfs_remove(e->file_shm.dentry);
603 debugfs_remove(e->file_txstat.dentry);
604 debugfs_remove(e->file_txpower_g.dentry);
605 debugfs_remove(e->file_restart.dentry);
606 debugfs_remove(e->file_loctls.dentry);
608 debugfs_remove(e->subdir);
609 kfree(e->txstatlog.log);
613 void b43_debugfs_log_txstat(struct b43_wldev *dev,
614 const struct b43_txstatus *status)
616 struct b43_dfsentry *e = dev->dfsentry;
617 struct b43_txstatus_log *log;
618 struct b43_txstatus *cur;
624 B43_WARN_ON(!irqs_disabled());
625 spin_lock(&log->lock);
627 if (i == B43_NR_LOGGED_TXSTATUS)
630 cur = &(log->log[i]);
631 memcpy(cur, status, sizeof(*cur));
632 spin_unlock(&log->lock);
635 void b43_debugfs_init(void)
637 rootdir = debugfs_create_dir(KBUILD_MODNAME, NULL);
642 void b43_debugfs_exit(void)
644 debugfs_remove(rootdir);