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>
40 /* The root directory. */
41 static struct dentry
*rootdir
;
43 struct b43_debugfs_fops
{
44 ssize_t (*read
)(struct b43_wldev
*dev
, char *buf
, size_t bufsize
);
45 int (*write
)(struct b43_wldev
*dev
, const char *buf
, size_t count
);
46 struct file_operations fops
;
47 /* Offset of struct b43_dfs_file in struct b43_dfsentry */
48 size_t file_struct_offset
;
49 /* Take wl->irq_lock before calling read/write? */
54 struct b43_dfs_file
* fops_to_dfs_file(struct b43_wldev
*dev
,
55 const struct b43_debugfs_fops
*dfops
)
60 p
+= dfops
->file_struct_offset
;
66 #define fappend(fmt, x...) \
68 if (bufsize - count) \
69 count += snprintf(buf + count, \
73 printk(KERN_ERR "b43: fappend overflow\n"); \
77 /* wl->irq_lock is locked */
78 static ssize_t
tsf_read_file(struct b43_wldev
*dev
,
79 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 static int tsf_write_file(struct b43_wldev
*dev
,
94 const char *buf
, size_t count
)
98 if (sscanf(buf
, "%llu", (unsigned long long *)(&tsf
)) != 1)
100 b43_tsf_write(dev
, tsf
);
105 /* wl->irq_lock is locked */
106 static ssize_t
ucode_regs_read_file(struct b43_wldev
*dev
,
107 char *buf
, size_t bufsize
)
112 for (i
= 0; i
< 64; i
++) {
113 fappend("r%d = 0x%04x\n", i
,
114 b43_shm_read16(dev
, B43_SHM_SCRATCH
, i
));
120 /* wl->irq_lock is locked */
121 static ssize_t
shm_read_file(struct b43_wldev
*dev
,
122 char *buf
, size_t bufsize
)
127 __le16
*le16buf
= (__le16
*)buf
;
129 for (i
= 0; i
< 0x1000; i
++) {
130 if (bufsize
< sizeof(tmp
))
132 tmp
= b43_shm_read16(dev
, B43_SHM_SHARED
, 2 * i
);
133 le16buf
[i
] = cpu_to_le16(tmp
);
134 count
+= sizeof(tmp
);
135 bufsize
-= sizeof(tmp
);
141 static ssize_t
txstat_read_file(struct b43_wldev
*dev
,
142 char *buf
, size_t bufsize
)
144 struct b43_txstatus_log
*log
= &dev
->dfsentry
->txstatlog
;
148 struct b43_txstatus
*stat
;
150 spin_lock_irqsave(&log
->lock
, flags
);
152 fappend("Nothing transmitted, yet\n");
155 fappend("b43 TX status reports:\n\n"
156 "index | cookie | seq | phy_stat | frame_count | "
157 "rts_count | supp_reason | pm_indicated | "
158 "intermediate | for_ampdu | acked\n" "---\n");
162 if (i
== B43_NR_LOGGED_TXSTATUS
)
164 stat
= &(log
->log
[i
]);
167 "0x%04X | 0x%04X | 0x%02X | "
172 stat
->cookie
, stat
->seq
, stat
->phy_stat
,
173 stat
->frame_count
, stat
->rts_count
,
174 stat
->supp_reason
, stat
->pm_indicated
,
175 stat
->intermediate
, stat
->for_ampdu
,
184 spin_unlock_irqrestore(&log
->lock
, flags
);
189 static ssize_t
txpower_g_read_file(struct b43_wldev
*dev
,
190 char *buf
, size_t bufsize
)
194 if (dev
->phy
.type
!= B43_PHYTYPE_G
) {
195 fappend("Device is not a G-PHY\n");
198 fappend("Control: %s\n", dev
->phy
.manual_txpower_control
?
199 "MANUAL" : "AUTOMATIC");
200 fappend("Baseband attenuation: %u\n", dev
->phy
.bbatt
.att
);
201 fappend("Radio attenuation: %u\n", dev
->phy
.rfatt
.att
);
202 fappend("TX Mixer Gain: %s\n",
203 (dev
->phy
.tx_control
& B43_TXCTL_TXMIX
) ? "ON" : "OFF");
204 fappend("PA Gain 2dB: %s\n",
205 (dev
->phy
.tx_control
& B43_TXCTL_PA2DB
) ? "ON" : "OFF");
206 fappend("PA Gain 3dB: %s\n",
207 (dev
->phy
.tx_control
& B43_TXCTL_PA3DB
) ? "ON" : "OFF");
209 fappend("You can write to this file:\n");
210 fappend("Writing \"auto\" enables automatic txpower control.\n");
212 ("Writing the attenuation values as \"bbatt rfatt txmix pa2db pa3db\" "
213 "enables manual txpower control.\n");
214 fappend("Example: 5 4 0 0 1\n");
215 fappend("Enables manual control with Baseband attenuation 5, "
216 "Radio attenuation 4, No TX Mixer Gain, "
217 "No PA Gain 2dB, With PA Gain 3dB.\n");
222 static int txpower_g_write_file(struct b43_wldev
*dev
,
223 const char *buf
, size_t count
)
225 if (dev
->phy
.type
!= B43_PHYTYPE_G
)
227 if ((count
>= 4) && (memcmp(buf
, "auto", 4) == 0)) {
228 /* Automatic control */
229 dev
->phy
.manual_txpower_control
= 0;
230 b43_phy_xmitpower(dev
);
232 int bbatt
= 0, rfatt
= 0, txmix
= 0, pa2db
= 0, pa3db
= 0;
234 if (sscanf(buf
, "%d %d %d %d %d", &bbatt
, &rfatt
,
235 &txmix
, &pa2db
, &pa3db
) != 5)
237 b43_put_attenuation_into_ranges(dev
, &bbatt
, &rfatt
);
238 dev
->phy
.manual_txpower_control
= 1;
239 dev
->phy
.bbatt
.att
= bbatt
;
240 dev
->phy
.rfatt
.att
= rfatt
;
241 dev
->phy
.tx_control
= 0;
243 dev
->phy
.tx_control
|= B43_TXCTL_TXMIX
;
245 dev
->phy
.tx_control
|= B43_TXCTL_PA2DB
;
247 dev
->phy
.tx_control
|= B43_TXCTL_PA3DB
;
250 b43_set_txpower_g(dev
, &dev
->phy
.bbatt
,
251 &dev
->phy
.rfatt
, dev
->phy
.tx_control
);
252 b43_radio_unlock(dev
);
259 /* wl->irq_lock is locked */
260 static int restart_write_file(struct b43_wldev
*dev
,
261 const char *buf
, size_t count
)
265 if (count
> 0 && buf
[0] == '1') {
266 b43_controller_restart(dev
, "manually restarted");
273 static ssize_t
append_lo_table(ssize_t count
, char *buf
, const size_t bufsize
,
274 struct b43_loctl table
[B43_NR_BB
][B43_NR_RF
])
277 struct b43_loctl
*ctl
;
279 for (i
= 0; i
< B43_NR_BB
; i
++) {
280 for (j
= 0; j
< B43_NR_RF
; j
++) {
281 ctl
= &(table
[i
][j
]);
282 fappend("(bbatt %2u, rfatt %2u) -> "
283 "(I %+3d, Q %+3d, Used: %d, Calibrated: %d)\n",
284 i
, j
, ctl
->i
, ctl
->q
,
286 b43_loctl_is_calibrated(ctl
));
293 static ssize_t
loctls_read_file(struct b43_wldev
*dev
,
294 char *buf
, size_t bufsize
)
297 struct b43_txpower_lo_control
*lo
;
300 if (dev
->phy
.type
!= B43_PHYTYPE_G
) {
301 fappend("Device is not a G-PHY\n");
305 lo
= dev
->phy
.lo_control
;
306 fappend("-- Local Oscillator calibration data --\n\n");
307 fappend("Measured: %d, Rebuild: %d, HW-power-control: %d\n",
310 dev
->phy
.hardware_power_control
);
311 fappend("TX Bias: 0x%02X, TX Magn: 0x%02X\n",
312 lo
->tx_bias
, lo
->tx_magn
);
313 fappend("Power Vector: 0x%08X%08X\n",
314 (unsigned int)((lo
->power_vector
& 0xFFFFFFFF00000000ULL
) >> 32),
315 (unsigned int)(lo
->power_vector
& 0x00000000FFFFFFFFULL
));
316 fappend("\nControl table WITH PADMIX:\n");
317 count
= append_lo_table(count
, buf
, bufsize
, lo
->with_padmix
);
318 fappend("\nControl table WITHOUT PADMIX:\n");
319 count
= append_lo_table(count
, buf
, bufsize
, lo
->no_padmix
);
320 fappend("\nUsed RF attenuation values: Value(WithPadmix flag)\n");
321 for (i
= 0; i
< lo
->rfatt_list
.len
; i
++) {
323 lo
->rfatt_list
.list
[i
].att
,
324 lo
->rfatt_list
.list
[i
].with_padmix
);
327 fappend("\nUsed Baseband attenuation values:\n");
328 for (i
= 0; i
< lo
->bbatt_list
.len
; i
++) {
330 lo
->bbatt_list
.list
[i
].att
);
335 return err
? err
: count
;
340 static int b43_debugfs_open(struct inode
*inode
, struct file
*file
)
342 file
->private_data
= inode
->i_private
;
346 static ssize_t
b43_debugfs_read(struct file
*file
, char __user
*userbuf
,
347 size_t count
, loff_t
*ppos
)
349 struct b43_wldev
*dev
;
350 struct b43_debugfs_fops
*dfops
;
351 struct b43_dfs_file
*dfile
;
352 ssize_t
uninitialized_var(ret
);
354 const size_t bufsize
= 1024 * 128;
355 const size_t buforder
= get_order(bufsize
);
360 dev
= file
->private_data
;
364 mutex_lock(&dev
->wl
->mutex
);
365 if (b43_status(dev
) < B43_STAT_INITIALIZED
) {
370 dfops
= container_of(file
->f_op
, struct b43_debugfs_fops
, fops
);
375 dfile
= fops_to_dfs_file(dev
, dfops
);
377 if (!dfile
->buffer
) {
378 buf
= (char *)__get_free_pages(GFP_KERNEL
, buforder
);
383 /* Sparse warns about the following memset, because it has a big
384 * size value. That warning is bogus, so I will ignore it. --mb */
385 memset(buf
, 0, bufsize
);
386 if (dfops
->take_irqlock
) {
387 spin_lock_irq(&dev
->wl
->irq_lock
);
388 ret
= dfops
->read(dev
, buf
, bufsize
);
389 spin_unlock_irq(&dev
->wl
->irq_lock
);
391 ret
= dfops
->read(dev
, buf
, bufsize
);
393 free_pages((unsigned long)buf
, buforder
);
397 dfile
->data_len
= ret
;
401 ret
= simple_read_from_buffer(userbuf
, count
, ppos
,
404 if (*ppos
>= dfile
->data_len
) {
405 free_pages((unsigned long)dfile
->buffer
, buforder
);
406 dfile
->buffer
= NULL
;
410 mutex_unlock(&dev
->wl
->mutex
);
412 return err
? err
: ret
;
415 static ssize_t
b43_debugfs_write(struct file
*file
,
416 const char __user
*userbuf
,
417 size_t count
, loff_t
*ppos
)
419 struct b43_wldev
*dev
;
420 struct b43_debugfs_fops
*dfops
;
426 if (count
> PAGE_SIZE
)
428 dev
= file
->private_data
;
432 mutex_lock(&dev
->wl
->mutex
);
433 if (b43_status(dev
) < B43_STAT_INITIALIZED
) {
438 dfops
= container_of(file
->f_op
, struct b43_debugfs_fops
, fops
);
444 buf
= (char *)get_zeroed_page(GFP_KERNEL
);
449 if (copy_from_user(buf
, userbuf
, count
)) {
453 if (dfops
->take_irqlock
) {
454 spin_lock_irq(&dev
->wl
->irq_lock
);
455 err
= dfops
->write(dev
, buf
, count
);
456 spin_unlock_irq(&dev
->wl
->irq_lock
);
458 err
= dfops
->write(dev
, buf
, count
);
463 free_page((unsigned long)buf
);
465 mutex_unlock(&dev
->wl
->mutex
);
467 return err
? err
: count
;
471 #define B43_DEBUGFS_FOPS(name, _read, _write, _take_irqlock) \
472 static struct b43_debugfs_fops fops_##name = { \
476 .open = b43_debugfs_open, \
477 .read = b43_debugfs_read, \
478 .write = b43_debugfs_write, \
480 .file_struct_offset = offsetof(struct b43_dfsentry, \
482 .take_irqlock = _take_irqlock, \
485 B43_DEBUGFS_FOPS(tsf
, tsf_read_file
, tsf_write_file
, 1);
486 B43_DEBUGFS_FOPS(ucode_regs
, ucode_regs_read_file
, NULL
, 1);
487 B43_DEBUGFS_FOPS(shm
, shm_read_file
, NULL
, 1);
488 B43_DEBUGFS_FOPS(txstat
, txstat_read_file
, NULL
, 0);
489 B43_DEBUGFS_FOPS(txpower_g
, txpower_g_read_file
, txpower_g_write_file
, 0);
490 B43_DEBUGFS_FOPS(restart
, NULL
, restart_write_file
, 1);
491 B43_DEBUGFS_FOPS(loctls
, loctls_read_file
, NULL
, 0);
494 int b43_debug(struct b43_wldev
*dev
, enum b43_dyndbg feature
)
496 return !!(dev
->dfsentry
&& dev
->dfsentry
->dyn_debug
[feature
]);
499 static void b43_remove_dynamic_debug(struct b43_wldev
*dev
)
501 struct b43_dfsentry
*e
= dev
->dfsentry
;
504 for (i
= 0; i
< __B43_NR_DYNDBG
; i
++)
505 debugfs_remove(e
->dyn_debug_dentries
[i
]);
508 static void b43_add_dynamic_debug(struct b43_wldev
*dev
)
510 struct b43_dfsentry
*e
= dev
->dfsentry
;
513 #define add_dyn_dbg(name, id, initstate) do { \
514 e->dyn_debug[id] = (initstate); \
515 d = debugfs_create_bool(name, 0600, e->subdir, \
516 &(e->dyn_debug[id])); \
518 e->dyn_debug_dentries[id] = d; \
521 add_dyn_dbg("debug_xmitpower", B43_DBG_XMITPOWER
, 0);
522 add_dyn_dbg("debug_dmaoverflow", B43_DBG_DMAOVERFLOW
, 0);
523 add_dyn_dbg("debug_dmaverbose", B43_DBG_DMAVERBOSE
, 0);
524 add_dyn_dbg("debug_pwork_fast", B43_DBG_PWORK_FAST
, 0);
525 add_dyn_dbg("debug_pwork_stop", B43_DBG_PWORK_STOP
, 0);
530 void b43_debugfs_add_device(struct b43_wldev
*dev
)
532 struct b43_dfsentry
*e
;
533 struct b43_txstatus_log
*log
;
537 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
539 b43err(dev
->wl
, "debugfs: add device OOM\n");
544 log
->log
= kcalloc(B43_NR_LOGGED_TXSTATUS
,
545 sizeof(struct b43_txstatus
), GFP_KERNEL
);
547 b43err(dev
->wl
, "debugfs: add device txstatus OOM\n");
552 spin_lock_init(&log
->lock
);
556 snprintf(devdir
, sizeof(devdir
), "%s", wiphy_name(dev
->wl
->hw
->wiphy
));
557 e
->subdir
= debugfs_create_dir(devdir
, rootdir
);
558 if (!e
->subdir
|| IS_ERR(e
->subdir
)) {
559 if (e
->subdir
== ERR_PTR(-ENODEV
)) {
560 b43dbg(dev
->wl
, "DebugFS (CONFIG_DEBUG_FS) not "
561 "enabled in kernel config\n");
563 b43err(dev
->wl
, "debugfs: cannot create %s directory\n",
566 dev
->dfsentry
= NULL
;
572 #define ADD_FILE(name, mode) \
575 d = debugfs_create_file(__stringify(name), \
576 mode, e->subdir, dev, \
577 &fops_##name.fops); \
578 e->file_##name.dentry = NULL; \
580 e->file_##name.dentry = d; \
585 ADD_FILE(ucode_regs
, 0400);
587 ADD_FILE(txstat
, 0400);
588 ADD_FILE(txpower_g
, 0600);
589 ADD_FILE(restart
, 0200);
590 ADD_FILE(loctls
, 0400);
594 b43_add_dynamic_debug(dev
);
597 void b43_debugfs_remove_device(struct b43_wldev
*dev
)
599 struct b43_dfsentry
*e
;
606 b43_remove_dynamic_debug(dev
);
608 debugfs_remove(e
->file_tsf
.dentry
);
609 debugfs_remove(e
->file_ucode_regs
.dentry
);
610 debugfs_remove(e
->file_shm
.dentry
);
611 debugfs_remove(e
->file_txstat
.dentry
);
612 debugfs_remove(e
->file_txpower_g
.dentry
);
613 debugfs_remove(e
->file_restart
.dentry
);
614 debugfs_remove(e
->file_loctls
.dentry
);
616 debugfs_remove(e
->subdir
);
617 kfree(e
->txstatlog
.log
);
621 /* Called with IRQs disabled. */
622 void b43_debugfs_log_txstat(struct b43_wldev
*dev
,
623 const struct b43_txstatus
*status
)
625 struct b43_dfsentry
*e
= dev
->dfsentry
;
626 struct b43_txstatus_log
*log
;
627 struct b43_txstatus
*cur
;
633 spin_lock(&log
->lock
); /* IRQs are already disabled. */
635 if (i
== B43_NR_LOGGED_TXSTATUS
)
638 cur
= &(log
->log
[i
]);
639 memcpy(cur
, status
, sizeof(*cur
));
640 spin_unlock(&log
->lock
);
643 void b43_debugfs_init(void)
645 rootdir
= debugfs_create_dir(KBUILD_MODNAME
, NULL
);
650 void b43_debugfs_exit(void)
652 debugfs_remove(rootdir
);