Merge branch 'merge' of git://git.kernel.org/pub/scm/linux/kernel/git/paulus/powerpc
[linux-2.6] / drivers / net / wireless / b43 / debugfs.c
1 /*
2
3   Broadcom B43 wireless driver
4
5   debugfs driver debugging code
6
7   Copyright (c) 2005-2007 Michael Buesch <mb@bu3sch.de>
8
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.
13
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.
18
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.
23
24 */
25
26 #include <linux/fs.h>
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>
32
33 #include "b43.h"
34 #include "main.h"
35 #include "debugfs.h"
36 #include "dma.h"
37 #include "xmit.h"
38
39
40 /* The root directory. */
41 static struct dentry *rootdir;
42
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? */
50         bool take_irqlock;
51 };
52
53 static inline
54 struct b43_dfs_file * fops_to_dfs_file(struct b43_wldev *dev,
55                                        const struct b43_debugfs_fops *dfops)
56 {
57         void *p;
58
59         p = dev->dfsentry;
60         p += dfops->file_struct_offset;
61
62         return p;
63 }
64
65
66 #define fappend(fmt, x...)      \
67         do {                                                    \
68                 if (bufsize - count)                            \
69                         count += snprintf(buf + count,          \
70                                           bufsize - count,      \
71                                           fmt , ##x);           \
72                 else                                            \
73                         printk(KERN_ERR "b43: fappend overflow\n"); \
74         } while (0)
75
76
77 /* wl->irq_lock is locked */
78 static ssize_t tsf_read_file(struct b43_wldev *dev,
79                              char *buf, size_t bufsize)
80 {
81         ssize_t count = 0;
82         u64 tsf;
83
84         b43_tsf_read(dev, &tsf);
85         fappend("0x%08x%08x\n",
86                 (unsigned int)((tsf & 0xFFFFFFFF00000000ULL) >> 32),
87                 (unsigned int)(tsf & 0xFFFFFFFFULL));
88
89         return count;
90 }
91
92 /* wl->irq_lock is locked */
93 static int tsf_write_file(struct b43_wldev *dev,
94                           const char *buf, size_t count)
95 {
96         u64 tsf;
97
98         if (sscanf(buf, "%llu", (unsigned long long *)(&tsf)) != 1)
99                 return -EINVAL;
100         b43_tsf_write(dev, tsf);
101
102         return 0;
103 }
104
105 /* wl->irq_lock is locked */
106 static ssize_t ucode_regs_read_file(struct b43_wldev *dev,
107                                     char *buf, size_t bufsize)
108 {
109         ssize_t count = 0;
110         int i;
111
112         for (i = 0; i < 64; i++) {
113                 fappend("r%d = 0x%04x\n", i,
114                         b43_shm_read16(dev, B43_SHM_SCRATCH, i));
115         }
116
117         return count;
118 }
119
120 /* wl->irq_lock is locked */
121 static ssize_t shm_read_file(struct b43_wldev *dev,
122                              char *buf, size_t bufsize)
123 {
124         ssize_t count = 0;
125         int i;
126         u16 tmp;
127         __le16 *le16buf = (__le16 *)buf;
128
129         for (i = 0; i < 0x1000; i++) {
130                 if (bufsize < sizeof(tmp))
131                         break;
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);
136         }
137
138         return count;
139 }
140
141 static ssize_t txstat_read_file(struct b43_wldev *dev,
142                                 char *buf, size_t bufsize)
143 {
144         struct b43_txstatus_log *log = &dev->dfsentry->txstatlog;
145         ssize_t count = 0;
146         unsigned long flags;
147         int i, idx;
148         struct b43_txstatus *stat;
149
150         spin_lock_irqsave(&log->lock, flags);
151         if (log->end < 0) {
152                 fappend("Nothing transmitted, yet\n");
153                 goto out_unlock;
154         }
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");
159         i = log->end + 1;
160         idx = 0;
161         while (1) {
162                 if (i == B43_NR_LOGGED_TXSTATUS)
163                         i = 0;
164                 stat = &(log->log[i]);
165                 if (stat->cookie) {
166                         fappend("%03d | "
167                                 "0x%04X | 0x%04X | 0x%02X | "
168                                 "0x%X | 0x%X | "
169                                 "%u | %u | "
170                                 "%u | %u | %u\n",
171                                 idx,
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,
176                                 stat->acked);
177                         idx++;
178                 }
179                 if (i == log->end)
180                         break;
181                 i++;
182         }
183 out_unlock:
184         spin_unlock_irqrestore(&log->lock, flags);
185
186         return count;
187 }
188
189 static ssize_t txpower_g_read_file(struct b43_wldev *dev,
190                                    char *buf, size_t bufsize)
191 {
192         ssize_t count = 0;
193
194         if (dev->phy.type != B43_PHYTYPE_G) {
195                 fappend("Device is not a G-PHY\n");
196                 goto out;
197         }
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");
208         fappend("\n\n");
209         fappend("You can write to this file:\n");
210         fappend("Writing \"auto\" enables automatic txpower control.\n");
211         fappend
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");
218 out:
219         return count;
220 }
221
222 static int txpower_g_write_file(struct b43_wldev *dev,
223                                 const char *buf, size_t count)
224 {
225         if (dev->phy.type != B43_PHYTYPE_G)
226                 return -ENODEV;
227         if ((count >= 4) && (memcmp(buf, "auto", 4) == 0)) {
228                 /* Automatic control */
229                 dev->phy.manual_txpower_control = 0;
230                 b43_phy_xmitpower(dev);
231         } else {
232                 int bbatt = 0, rfatt = 0, txmix = 0, pa2db = 0, pa3db = 0;
233                 /* Manual control */
234                 if (sscanf(buf, "%d %d %d %d %d", &bbatt, &rfatt,
235                            &txmix, &pa2db, &pa3db) != 5)
236                         return -EINVAL;
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;
242                 if (txmix)
243                         dev->phy.tx_control |= B43_TXCTL_TXMIX;
244                 if (pa2db)
245                         dev->phy.tx_control |= B43_TXCTL_PA2DB;
246                 if (pa3db)
247                         dev->phy.tx_control |= B43_TXCTL_PA3DB;
248                 b43_phy_lock(dev);
249                 b43_radio_lock(dev);
250                 b43_set_txpower_g(dev, &dev->phy.bbatt,
251                                   &dev->phy.rfatt, dev->phy.tx_control);
252                 b43_radio_unlock(dev);
253                 b43_phy_unlock(dev);
254         }
255
256         return 0;
257 }
258
259 /* wl->irq_lock is locked */
260 static int restart_write_file(struct b43_wldev *dev,
261                               const char *buf, size_t count)
262 {
263         int err = 0;
264
265         if (count > 0 && buf[0] == '1') {
266                 b43_controller_restart(dev, "manually restarted");
267         } else
268                 err = -EINVAL;
269
270         return err;
271 }
272
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])
275 {
276         unsigned int i, j;
277         struct b43_loctl *ctl;
278
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,
285                                 ctl->used,
286                                 b43_loctl_is_calibrated(ctl));
287                 }
288         }
289
290         return count;
291 }
292
293 static ssize_t loctls_read_file(struct b43_wldev *dev,
294                                 char *buf, size_t bufsize)
295 {
296         ssize_t count = 0;
297         struct b43_txpower_lo_control *lo;
298         int i, err = 0;
299
300         if (dev->phy.type != B43_PHYTYPE_G) {
301                 fappend("Device is not a G-PHY\n");
302                 err = -ENODEV;
303                 goto out;
304         }
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",
308                 lo->lo_measured,
309                 lo->rebuild,
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++) {
322                 fappend("%u(%d), ",
323                         lo->rfatt_list.list[i].att,
324                         lo->rfatt_list.list[i].with_padmix);
325         }
326         fappend("\n");
327         fappend("\nUsed Baseband attenuation values:\n");
328         for (i = 0; i < lo->bbatt_list.len; i++) {
329                 fappend("%u, ",
330                         lo->bbatt_list.list[i].att);
331         }
332         fappend("\n");
333
334 out:
335         return err ? err : count;
336 }
337
338 #undef fappend
339
340 static int b43_debugfs_open(struct inode *inode, struct file *file)
341 {
342         file->private_data = inode->i_private;
343         return 0;
344 }
345
346 static ssize_t b43_debugfs_read(struct file *file, char __user *userbuf,
347                                 size_t count, loff_t *ppos)
348 {
349         struct b43_wldev *dev;
350         struct b43_debugfs_fops *dfops;
351         struct b43_dfs_file *dfile;
352         ssize_t uninitialized_var(ret);
353         char *buf;
354         const size_t bufsize = 1024 * 128;
355         const size_t buforder = get_order(bufsize);
356         int err = 0;
357
358         if (!count)
359                 return 0;
360         dev = file->private_data;
361         if (!dev)
362                 return -ENODEV;
363
364         mutex_lock(&dev->wl->mutex);
365         if (b43_status(dev) < B43_STAT_INITIALIZED) {
366                 err = -ENODEV;
367                 goto out_unlock;
368         }
369
370         dfops = container_of(file->f_op, struct b43_debugfs_fops, fops);
371         if (!dfops->read) {
372                 err = -ENOSYS;
373                 goto out_unlock;
374         }
375         dfile = fops_to_dfs_file(dev, dfops);
376
377         if (!dfile->buffer) {
378                 buf = (char *)__get_free_pages(GFP_KERNEL, buforder);
379                 if (!buf) {
380                         err = -ENOMEM;
381                         goto out_unlock;
382                 }
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);
390                 } else
391                         ret = dfops->read(dev, buf, bufsize);
392                 if (ret <= 0) {
393                         free_pages((unsigned long)buf, buforder);
394                         err = ret;
395                         goto out_unlock;
396                 }
397                 dfile->data_len = ret;
398                 dfile->buffer = buf;
399         }
400
401         ret = simple_read_from_buffer(userbuf, count, ppos,
402                                       dfile->buffer,
403                                       dfile->data_len);
404         if (*ppos >= dfile->data_len) {
405                 free_pages((unsigned long)dfile->buffer, buforder);
406                 dfile->buffer = NULL;
407                 dfile->data_len = 0;
408         }
409 out_unlock:
410         mutex_unlock(&dev->wl->mutex);
411
412         return err ? err : ret;
413 }
414
415 static ssize_t b43_debugfs_write(struct file *file,
416                                  const char __user *userbuf,
417                                  size_t count, loff_t *ppos)
418 {
419         struct b43_wldev *dev;
420         struct b43_debugfs_fops *dfops;
421         char *buf;
422         int err = 0;
423
424         if (!count)
425                 return 0;
426         if (count > PAGE_SIZE)
427                 return -E2BIG;
428         dev = file->private_data;
429         if (!dev)
430                 return -ENODEV;
431
432         mutex_lock(&dev->wl->mutex);
433         if (b43_status(dev) < B43_STAT_INITIALIZED) {
434                 err = -ENODEV;
435                 goto out_unlock;
436         }
437
438         dfops = container_of(file->f_op, struct b43_debugfs_fops, fops);
439         if (!dfops->write) {
440                 err = -ENOSYS;
441                 goto out_unlock;
442         }
443
444         buf = (char *)get_zeroed_page(GFP_KERNEL);
445         if (!buf) {
446                 err = -ENOMEM;
447                 goto out_unlock;
448         }
449         if (copy_from_user(buf, userbuf, count)) {
450                 err = -EFAULT;
451                 goto out_freepage;
452         }
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);
457         } else
458                 err = dfops->write(dev, buf, count);
459         if (err)
460                 goto out_freepage;
461
462 out_freepage:
463         free_page((unsigned long)buf);
464 out_unlock:
465         mutex_unlock(&dev->wl->mutex);
466
467         return err ? err : count;
468 }
469
470
471 #define B43_DEBUGFS_FOPS(name, _read, _write, _take_irqlock)    \
472         static struct b43_debugfs_fops fops_##name = {          \
473                 .read   = _read,                                \
474                 .write  = _write,                               \
475                 .fops   = {                                     \
476                         .open   = b43_debugfs_open,             \
477                         .read   = b43_debugfs_read,             \
478                         .write  = b43_debugfs_write,            \
479                 },                                              \
480                 .file_struct_offset = offsetof(struct b43_dfsentry, \
481                                                file_##name),    \
482                 .take_irqlock   = _take_irqlock,                \
483         }
484
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);
492
493
494 int b43_debug(struct b43_wldev *dev, enum b43_dyndbg feature)
495 {
496         return !!(dev->dfsentry && dev->dfsentry->dyn_debug[feature]);
497 }
498
499 static void b43_remove_dynamic_debug(struct b43_wldev *dev)
500 {
501         struct b43_dfsentry *e = dev->dfsentry;
502         int i;
503
504         for (i = 0; i < __B43_NR_DYNDBG; i++)
505                 debugfs_remove(e->dyn_debug_dentries[i]);
506 }
507
508 static void b43_add_dynamic_debug(struct b43_wldev *dev)
509 {
510         struct b43_dfsentry *e = dev->dfsentry;
511         struct dentry *d;
512
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]));   \
517         if (!IS_ERR(d))                                 \
518                 e->dyn_debug_dentries[id] = d;          \
519                                 } while (0)
520
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);
526
527 #undef add_dyn_dbg
528 }
529
530 void b43_debugfs_add_device(struct b43_wldev *dev)
531 {
532         struct b43_dfsentry *e;
533         struct b43_txstatus_log *log;
534         char devdir[16];
535
536         B43_WARN_ON(!dev);
537         e = kzalloc(sizeof(*e), GFP_KERNEL);
538         if (!e) {
539                 b43err(dev->wl, "debugfs: add device OOM\n");
540                 return;
541         }
542         e->dev = dev;
543         log = &e->txstatlog;
544         log->log = kcalloc(B43_NR_LOGGED_TXSTATUS,
545                            sizeof(struct b43_txstatus), GFP_KERNEL);
546         if (!log->log) {
547                 b43err(dev->wl, "debugfs: add device txstatus OOM\n");
548                 kfree(e);
549                 return;
550         }
551         log->end = -1;
552         spin_lock_init(&log->lock);
553
554         dev->dfsentry = e;
555
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");
562                 } else {
563                         b43err(dev->wl, "debugfs: cannot create %s directory\n",
564                                devdir);
565                 }
566                 dev->dfsentry = NULL;
567                 kfree(log->log);
568                 kfree(e);
569                 return;
570         }
571
572 #define ADD_FILE(name, mode)    \
573         do {                                                    \
574                 struct dentry *d;                               \
575                 d = debugfs_create_file(__stringify(name),      \
576                                         mode, e->subdir, dev,   \
577                                         &fops_##name.fops);     \
578                 e->file_##name.dentry = NULL;                   \
579                 if (!IS_ERR(d))                                 \
580                         e->file_##name.dentry = d;              \
581         } while (0)
582
583
584         ADD_FILE(tsf, 0600);
585         ADD_FILE(ucode_regs, 0400);
586         ADD_FILE(shm, 0400);
587         ADD_FILE(txstat, 0400);
588         ADD_FILE(txpower_g, 0600);
589         ADD_FILE(restart, 0200);
590         ADD_FILE(loctls, 0400);
591
592 #undef ADD_FILE
593
594         b43_add_dynamic_debug(dev);
595 }
596
597 void b43_debugfs_remove_device(struct b43_wldev *dev)
598 {
599         struct b43_dfsentry *e;
600
601         if (!dev)
602                 return;
603         e = dev->dfsentry;
604         if (!e)
605                 return;
606         b43_remove_dynamic_debug(dev);
607
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);
615
616         debugfs_remove(e->subdir);
617         kfree(e->txstatlog.log);
618         kfree(e);
619 }
620
621 /* Called with IRQs disabled. */
622 void b43_debugfs_log_txstat(struct b43_wldev *dev,
623                             const struct b43_txstatus *status)
624 {
625         struct b43_dfsentry *e = dev->dfsentry;
626         struct b43_txstatus_log *log;
627         struct b43_txstatus *cur;
628         int i;
629
630         if (!e)
631                 return;
632         log = &e->txstatlog;
633         spin_lock(&log->lock); /* IRQs are already disabled. */
634         i = log->end + 1;
635         if (i == B43_NR_LOGGED_TXSTATUS)
636                 i = 0;
637         log->end = i;
638         cur = &(log->log[i]);
639         memcpy(cur, status, sizeof(*cur));
640         spin_unlock(&log->lock);
641 }
642
643 void b43_debugfs_init(void)
644 {
645         rootdir = debugfs_create_dir(KBUILD_MODNAME, NULL);
646         if (IS_ERR(rootdir))
647                 rootdir = NULL;
648 }
649
650 void b43_debugfs_exit(void)
651 {
652         debugfs_remove(rootdir);
653 }