git.oblomov.eu Git - linux-2.6/blob - drivers/net/wireless/rt2x00/rt2x00debug.c

   1 /*
   2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
   3         <http://rt2x00.serialmonkey.com>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the
  17         Free Software Foundation, Inc.,
  18         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22         Module: rt2x00lib
  23         Abstract: rt2x00 debugfs specific routines.
  24  */
  25
  26 #include <linux/debugfs.h>
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/poll.h>
  30 #include <linux/uaccess.h>
  31
  32 #include "rt2x00.h"
  33 #include "rt2x00lib.h"
  34 #include "rt2x00dump.h"
  35
  36 #define MAX_LINE_LENGTH 64
  37
  38 struct rt2x00debug_intf {
  39         /*
  40          * Pointer to driver structure where
  41          * this debugfs entry belongs to.
  42          */
  43         struct rt2x00_dev *rt2x00dev;
  44
  45         /*
  46          * Reference to the rt2x00debug structure
  47          * which can be used to communicate with
  48          * the registers.
  49          */
  50         const struct rt2x00debug *debug;
  51
  52         /*
  53          * Debugfs entries for:
  54          * - driver folder
  55          *   - driver file
  56          *   - chipset file
  57          *   - device flags file
  58          *   - register folder
  59          *     - csr offset/value files
  60          *     - eeprom offset/value files
  61          *     - bbp offset/value files
  62          *     - rf offset/value files
  63          *   - queue folder
  64          *     - frame dump file
  65          *     - queue stats file
  66          */
  67         struct dentry *driver_folder;
  68         struct dentry *driver_entry;
  69         struct dentry *chipset_entry;
  70         struct dentry *dev_flags;
  71         struct dentry *register_folder;
  72         struct dentry *csr_off_entry;
  73         struct dentry *csr_val_entry;
  74         struct dentry *eeprom_off_entry;
  75         struct dentry *eeprom_val_entry;
  76         struct dentry *bbp_off_entry;
  77         struct dentry *bbp_val_entry;
  78         struct dentry *rf_off_entry;
  79         struct dentry *rf_val_entry;
  80         struct dentry *queue_folder;
  81         struct dentry *queue_frame_dump_entry;
  82         struct dentry *queue_stats_entry;
  83
  84         /*
  85          * The frame dump file only allows a single reader,
  86          * so we need to store the current state here.
  87          */
  88         unsigned long frame_dump_flags;
  89 #define FRAME_DUMP_FILE_OPEN    1
  90
  91         /*
  92          * We queue each frame before dumping it to the user,
  93          * per read command we will pass a single skb structure
  94          * so we should be prepared to queue multiple sk buffers
  95          * before sending it to userspace.
  96          */
  97         struct sk_buff_head frame_dump_skbqueue;
  98         wait_queue_head_t frame_dump_waitqueue;
  99
 100         /*
 101          * Driver and chipset files will use a data buffer
 102          * that has been created in advance. This will simplify
 103          * the code since we can use the debugfs functions.
 104          */
 105         struct debugfs_blob_wrapper driver_blob;
 106         struct debugfs_blob_wrapper chipset_blob;
 107
 108         /*
 109          * Requested offset for each register type.
 110          */
 111         unsigned int offset_csr;
 112         unsigned int offset_eeprom;
 113         unsigned int offset_bbp;
 114         unsigned int offset_rf;
 115 };
 116
 117 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
 118                             struct sk_buff *skb)
 119 {
 120         struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
 121         struct skb_frame_desc *desc = get_skb_frame_desc(skb);
 122         struct sk_buff *skbcopy;
 123         struct rt2x00dump_hdr *dump_hdr;
 124         struct timeval timestamp;
 125
 126         do_gettimeofday(&timestamp);
 127
 128         if (!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags))
 129                 return;
 130
 131         if (skb_queue_len(&intf->frame_dump_skbqueue) > 20) {
 132                 DEBUG(rt2x00dev, "txrx dump queue length exceeded.\n");
 133                 return;
 134         }
 135
 136         skbcopy = alloc_skb(sizeof(*dump_hdr) + desc->desc_len + desc->data_len,
 137                             GFP_ATOMIC);
 138         if (!skbcopy) {
 139                 DEBUG(rt2x00dev, "Failed to copy skb for dump.\n");
 140                 return;
 141         }
 142
 143         dump_hdr = (struct rt2x00dump_hdr *)skb_put(skbcopy, sizeof(*dump_hdr));
 144         dump_hdr->version = cpu_to_le32(DUMP_HEADER_VERSION);
 145         dump_hdr->header_length = cpu_to_le32(sizeof(*dump_hdr));
 146         dump_hdr->desc_length = cpu_to_le32(desc->desc_len);
 147         dump_hdr->data_length = cpu_to_le32(desc->data_len);
 148         dump_hdr->chip_rt = cpu_to_le16(rt2x00dev->chip.rt);
 149         dump_hdr->chip_rf = cpu_to_le16(rt2x00dev->chip.rf);
 150         dump_hdr->chip_rev = cpu_to_le32(rt2x00dev->chip.rev);
 151         dump_hdr->type = cpu_to_le16(desc->frame_type);
 152         dump_hdr->queue_index = desc->entry->queue->qid;
 153         dump_hdr->entry_index = desc->entry->entry_idx;
 154         dump_hdr->timestamp_sec = cpu_to_le32(timestamp.tv_sec);
 155         dump_hdr->timestamp_usec = cpu_to_le32(timestamp.tv_usec);
 156
 157         memcpy(skb_put(skbcopy, desc->desc_len), desc->desc, desc->desc_len);
 158         memcpy(skb_put(skbcopy, desc->data_len), desc->data, desc->data_len);
 159
 160         skb_queue_tail(&intf->frame_dump_skbqueue, skbcopy);
 161         wake_up_interruptible(&intf->frame_dump_waitqueue);
 162
 163         /*
 164          * Verify that the file has not been closed while we were working.
 165          */
 166         if (!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags))
 167                 skb_queue_purge(&intf->frame_dump_skbqueue);
 168 }
 169
 170 static int rt2x00debug_file_open(struct inode *inode, struct file *file)
 171 {
 172         struct rt2x00debug_intf *intf = inode->i_private;
 173
 174         file->private_data = inode->i_private;
 175
 176         if (!try_module_get(intf->debug->owner))
 177                 return -EBUSY;
 178
 179         return 0;
 180 }
 181
 182 static int rt2x00debug_file_release(struct inode *inode, struct file *file)
 183 {
 184         struct rt2x00debug_intf *intf = file->private_data;
 185
 186         module_put(intf->debug->owner);
 187
 188         return 0;
 189 }
 190
 191 static int rt2x00debug_open_queue_dump(struct inode *inode, struct file *file)
 192 {
 193         struct rt2x00debug_intf *intf = inode->i_private;
 194         int retval;
 195
 196         retval = rt2x00debug_file_open(inode, file);
 197         if (retval)
 198                 return retval;
 199
 200         if (test_and_set_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags)) {
 201                 rt2x00debug_file_release(inode, file);
 202                 return -EBUSY;
 203         }
 204
 205         return 0;
 206 }
 207
 208 static int rt2x00debug_release_queue_dump(struct inode *inode, struct file *file)
 209 {
 210         struct rt2x00debug_intf *intf = inode->i_private;
 211
 212         skb_queue_purge(&intf->frame_dump_skbqueue);
 213
 214         clear_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags);
 215
 216         return rt2x00debug_file_release(inode, file);
 217 }
 218
 219 static ssize_t rt2x00debug_read_queue_dump(struct file *file,
 220                                            char __user *buf,
 221                                            size_t length,
 222                                            loff_t *offset)
 223 {
 224         struct rt2x00debug_intf *intf = file->private_data;
 225         struct sk_buff *skb;
 226         size_t status;
 227         int retval;
 228
 229         if (file->f_flags & O_NONBLOCK)
 230                 return -EAGAIN;
 231
 232         retval =
 233             wait_event_interruptible(intf->frame_dump_waitqueue,
 234                                      (skb =
 235                                      skb_dequeue(&intf->frame_dump_skbqueue)));
 236         if (retval)
 237                 return retval;
 238
 239         status = min((size_t)skb->len, length);
 240         if (copy_to_user(buf, skb->data, status)) {
 241                 status = -EFAULT;
 242                 goto exit;
 243         }
 244
 245         *offset += status;
 246
 247 exit:
 248         kfree_skb(skb);
 249
 250         return status;
 251 }
 252
 253 static unsigned int rt2x00debug_poll_queue_dump(struct file *file,
 254                                                 poll_table *wait)
 255 {
 256         struct rt2x00debug_intf *intf = file->private_data;
 257
 258         poll_wait(file, &intf->frame_dump_waitqueue, wait);
 259
 260         if (!skb_queue_empty(&intf->frame_dump_skbqueue))
 261                 return POLLOUT | POLLWRNORM;
 262
 263         return 0;
 264 }
 265
 266 static const struct file_operations rt2x00debug_fop_queue_dump = {
 267         .owner          = THIS_MODULE,
 268         .read           = rt2x00debug_read_queue_dump,
 269         .poll           = rt2x00debug_poll_queue_dump,
 270         .open           = rt2x00debug_open_queue_dump,
 271         .release        = rt2x00debug_release_queue_dump,
 272 };
 273
 274 static ssize_t rt2x00debug_read_queue_stats(struct file *file,
 275                                             char __user *buf,
 276                                             size_t length,
 277                                             loff_t *offset)
 278 {
 279         struct rt2x00debug_intf *intf = file->private_data;
 280         struct data_queue *queue;
 281         unsigned int lines = 1 + intf->rt2x00dev->data_queues;
 282         size_t size;
 283         char *data;
 284         char *temp;
 285
 286         if (*offset)
 287                 return 0;
 288
 289         data = kzalloc(lines * MAX_LINE_LENGTH, GFP_KERNEL);
 290         if (!data)
 291                 return -ENOMEM;
 292
 293         temp = data +
 294             sprintf(data, "qid\tcount\tlimit\tlength\tindex\tdone\tcrypto\n");
 295
 296         queue_for_each(intf->rt2x00dev, queue) {
 297                 spin_lock(&queue->lock);
 298
 299                 temp += sprintf(temp, "%d\t%d\t%d\t%d\t%d\t%d\t%d\n", queue->qid,
 300                                 queue->count, queue->limit, queue->length,
 301                                 queue->index[Q_INDEX],
 302                                 queue->index[Q_INDEX_DONE],
 303                                 queue->index[Q_INDEX_CRYPTO]);
 304
 305                 spin_unlock(&queue->lock);
 306         }
 307
 308         size = strlen(data);
 309         size = min(size, length);
 310
 311         if (copy_to_user(buf, data, size)) {
 312                 kfree(data);
 313                 return -EFAULT;
 314         }
 315
 316         kfree(data);
 317
 318         *offset += size;
 319         return size;
 320 }
 321
 322 static const struct file_operations rt2x00debug_fop_queue_stats = {
 323         .owner          = THIS_MODULE,
 324         .read           = rt2x00debug_read_queue_stats,
 325         .open           = rt2x00debug_file_open,
 326         .release        = rt2x00debug_file_release,
 327 };
 328
 329 #define RT2X00DEBUGFS_OPS_READ(__name, __format, __type)        \
 330 static ssize_t rt2x00debug_read_##__name(struct file *file,     \
 331                                          char __user *buf,      \
 332                                          size_t length,         \
 333                                          loff_t *offset)        \
 334 {                                                               \
 335         struct rt2x00debug_intf *intf = file->private_data;     \
 336         const struct rt2x00debug *debug = intf->debug;          \
 337         char line[16];                                          \
 338         size_t size;                                            \
 339         __type value;                                           \
 340                                                                 \
 341         if (*offset)                                            \
 342                 return 0;                                       \
 343                                                                 \
 344         if (intf->offset_##__name >= debug->__name.word_count)  \
 345                 return -EINVAL;                                 \
 346                                                                 \
 347         debug->__name.read(intf->rt2x00dev,                     \
 348                            intf->offset_##__name, &value);      \
 349                                                                 \
 350         size = sprintf(line, __format, value);                  \
 351                                                                 \
 352         if (copy_to_user(buf, line, size))                      \
 353                 return -EFAULT;                                 \
 354                                                                 \
 355         *offset += size;                                        \
 356         return size;                                            \
 357 }
 358
 359 #define RT2X00DEBUGFS_OPS_WRITE(__name, __type)                 \
 360 static ssize_t rt2x00debug_write_##__name(struct file *file,    \
 361                                           const char __user *buf,\
 362                                           size_t length,        \
 363                                           loff_t *offset)       \
 364 {                                                               \
 365         struct rt2x00debug_intf *intf = file->private_data;     \
 366         const struct rt2x00debug *debug = intf->debug;          \
 367         char line[16];                                          \
 368         size_t size;                                            \
 369         __type value;                                           \
 370                                                                 \
 371         if (*offset)                                            \
 372                 return 0;                                       \
 373                                                                 \
 374         if (!capable(CAP_NET_ADMIN))                            \
 375                 return -EPERM;                                  \
 376                                                                 \
 377         if (intf->offset_##__name >= debug->__name.word_count)  \
 378                 return -EINVAL;                                 \
 379                                                                 \
 380         if (copy_from_user(line, buf, length))                  \
 381                 return -EFAULT;                                 \
 382                                                                 \
 383         size = strlen(line);                                    \
 384         value = simple_strtoul(line, NULL, 0);                  \
 385                                                                 \
 386         debug->__name.write(intf->rt2x00dev,                    \
 387                             intf->offset_##__name, value);      \
 388                                                                 \
 389         *offset += size;                                        \
 390         return size;                                            \
 391 }
 392
 393 #define RT2X00DEBUGFS_OPS(__name, __format, __type)             \
 394 RT2X00DEBUGFS_OPS_READ(__name, __format, __type);               \
 395 RT2X00DEBUGFS_OPS_WRITE(__name, __type);                        \
 396                                                                 \
 397 static const struct file_operations rt2x00debug_fop_##__name = {\
 398         .owner          = THIS_MODULE,                          \
 399         .read           = rt2x00debug_read_##__name,            \
 400         .write          = rt2x00debug_write_##__name,           \
 401         .open           = rt2x00debug_file_open,                \
 402         .release        = rt2x00debug_file_release,             \
 403 };
 404
 405 RT2X00DEBUGFS_OPS(csr, "0x%.8x\n", u32);
 406 RT2X00DEBUGFS_OPS(eeprom, "0x%.4x\n", u16);
 407 RT2X00DEBUGFS_OPS(bbp, "0x%.2x\n", u8);
 408 RT2X00DEBUGFS_OPS(rf, "0x%.8x\n", u32);
 409
 410 static ssize_t rt2x00debug_read_dev_flags(struct file *file,
 411                                           char __user *buf,
 412                                           size_t length,
 413                                           loff_t *offset)
 414 {
 415         struct rt2x00debug_intf *intf = file->private_data;
 416         char line[16];
 417         size_t size;
 418
 419         if (*offset)
 420                 return 0;
 421
 422         size = sprintf(line, "0x%.8x\n", (unsigned int)intf->rt2x00dev->flags);
 423
 424         if (copy_to_user(buf, line, size))
 425                 return -EFAULT;
 426
 427         *offset += size;
 428         return size;
 429 }
 430
 431 static const struct file_operations rt2x00debug_fop_dev_flags = {
 432         .owner          = THIS_MODULE,
 433         .read           = rt2x00debug_read_dev_flags,
 434         .open           = rt2x00debug_file_open,
 435         .release        = rt2x00debug_file_release,
 436 };
 437
 438 static struct dentry *rt2x00debug_create_file_driver(const char *name,
 439                                                      struct rt2x00debug_intf
 440                                                      *intf,
 441                                                      struct debugfs_blob_wrapper
 442                                                      *blob)
 443 {
 444         char *data;
 445
 446         data = kzalloc(3 * MAX_LINE_LENGTH, GFP_KERNEL);
 447         if (!data)
 448                 return NULL;
 449
 450         blob->data = data;
 451         data += sprintf(data, "driver: %s\n", intf->rt2x00dev->ops->name);
 452         data += sprintf(data, "version: %s\n", DRV_VERSION);
 453         data += sprintf(data, "compiled: %s %s\n", __DATE__, __TIME__);
 454         blob->size = strlen(blob->data);
 455
 456         return debugfs_create_blob(name, S_IRUGO, intf->driver_folder, blob);
 457 }
 458
 459 static struct dentry *rt2x00debug_create_file_chipset(const char *name,
 460                                                       struct rt2x00debug_intf
 461                                                       *intf,
 462                                                       struct
 463                                                       debugfs_blob_wrapper
 464                                                       *blob)
 465 {
 466         const struct rt2x00debug *debug = intf->debug;
 467         char *data;
 468
 469         data = kzalloc(8 * MAX_LINE_LENGTH, GFP_KERNEL);
 470         if (!data)
 471                 return NULL;
 472
 473         blob->data = data;
 474         data += sprintf(data, "rt chip: %04x\n", intf->rt2x00dev->chip.rt);
 475         data += sprintf(data, "rf chip: %04x\n", intf->rt2x00dev->chip.rf);
 476         data += sprintf(data, "revision:%08x\n", intf->rt2x00dev->chip.rev);
 477         data += sprintf(data, "\n");
 478         data += sprintf(data, "csr length: %d\n", debug->csr.word_count);
 479         data += sprintf(data, "eeprom length: %d\n", debug->eeprom.word_count);
 480         data += sprintf(data, "bbp length: %d\n", debug->bbp.word_count);
 481         data += sprintf(data, "rf length: %d\n", debug->rf.word_count);
 482         blob->size = strlen(blob->data);
 483
 484         return debugfs_create_blob(name, S_IRUGO, intf->driver_folder, blob);
 485 }
 486
 487 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
 488 {
 489         const struct rt2x00debug *debug = rt2x00dev->ops->debugfs;
 490         struct rt2x00debug_intf *intf;
 491
 492         intf = kzalloc(sizeof(struct rt2x00debug_intf), GFP_KERNEL);
 493         if (!intf) {
 494                 ERROR(rt2x00dev, "Failed to allocate debug handler.\n");
 495                 return;
 496         }
 497
 498         intf->debug = debug;
 499         intf->rt2x00dev = rt2x00dev;
 500         rt2x00dev->debugfs_intf = intf;
 501
 502         intf->driver_folder =
 503             debugfs_create_dir(intf->rt2x00dev->ops->name,
 504                                rt2x00dev->hw->wiphy->debugfsdir);
 505         if (IS_ERR(intf->driver_folder))
 506                 goto exit;
 507
 508         intf->driver_entry =
 509             rt2x00debug_create_file_driver("driver", intf, &intf->driver_blob);
 510         if (IS_ERR(intf->driver_entry))
 511                 goto exit;
 512
 513         intf->chipset_entry =
 514             rt2x00debug_create_file_chipset("chipset",
 515                                             intf, &intf->chipset_blob);
 516         if (IS_ERR(intf->chipset_entry))
 517                 goto exit;
 518
 519         intf->dev_flags = debugfs_create_file("dev_flags", S_IRUGO,
 520                                               intf->driver_folder, intf,
 521                                               &rt2x00debug_fop_dev_flags);
 522         if (IS_ERR(intf->dev_flags))
 523                 goto exit;
 524
 525         intf->register_folder =
 526             debugfs_create_dir("register", intf->driver_folder);
 527         if (IS_ERR(intf->register_folder))
 528                 goto exit;
 529
 530 #define RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(__intf, __name)     \
 531 ({                                                              \
 532         (__intf)->__name##_off_entry =                          \
 533             debugfs_create_u32(__stringify(__name) "_offset",   \
 534                                S_IRUGO | S_IWUSR,               \
 535                                (__intf)->register_folder,       \
 536                                &(__intf)->offset_##__name);     \
 537         if (IS_ERR((__intf)->__name##_off_entry))               \
 538                 goto exit;                                      \
 539                                                                 \
 540         (__intf)->__name##_val_entry =                          \
 541             debugfs_create_file(__stringify(__name) "_value",   \
 542                                 S_IRUGO | S_IWUSR,              \
 543                                 (__intf)->register_folder,      \
 544                                 (__intf), &rt2x00debug_fop_##__name);\
 545         if (IS_ERR((__intf)->__name##_val_entry))               \
 546                 goto exit;                                      \
 547 })
 548
 549         RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, csr);
 550         RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, eeprom);
 551         RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, bbp);
 552         RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, rf);
 553
 554 #undef RT2X00DEBUGFS_CREATE_REGISTER_ENTRY
 555
 556         intf->queue_folder =
 557             debugfs_create_dir("queue", intf->driver_folder);
 558         if (IS_ERR(intf->queue_folder))
 559                 goto exit;
 560
 561         intf->queue_frame_dump_entry =
 562             debugfs_create_file("dump", S_IRUGO, intf->queue_folder,
 563                                 intf, &rt2x00debug_fop_queue_dump);
 564         if (IS_ERR(intf->queue_frame_dump_entry))
 565                 goto exit;
 566
 567         skb_queue_head_init(&intf->frame_dump_skbqueue);
 568         init_waitqueue_head(&intf->frame_dump_waitqueue);
 569
 570         intf->queue_stats_entry =
 571             debugfs_create_file("queue", S_IRUGO, intf->queue_folder,
 572                                 intf, &rt2x00debug_fop_queue_stats);
 573
 574         return;
 575
 576 exit:
 577         rt2x00debug_deregister(rt2x00dev);
 578         ERROR(rt2x00dev, "Failed to register debug handler.\n");
 579
 580         return;
 581 }
 582
 583 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
 584 {
 585         struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
 586
 587         if (unlikely(!intf))
 588                 return;
 589
 590         skb_queue_purge(&intf->frame_dump_skbqueue);
 591
 592         debugfs_remove(intf->queue_stats_entry);
 593         debugfs_remove(intf->queue_frame_dump_entry);
 594         debugfs_remove(intf->queue_folder);
 595         debugfs_remove(intf->rf_val_entry);
 596         debugfs_remove(intf->rf_off_entry);
 597         debugfs_remove(intf->bbp_val_entry);
 598         debugfs_remove(intf->bbp_off_entry);
 599         debugfs_remove(intf->eeprom_val_entry);
 600         debugfs_remove(intf->eeprom_off_entry);
 601         debugfs_remove(intf->csr_val_entry);
 602         debugfs_remove(intf->csr_off_entry);
 603         debugfs_remove(intf->register_folder);
 604         debugfs_remove(intf->dev_flags);
 605         debugfs_remove(intf->chipset_entry);
 606         debugfs_remove(intf->driver_entry);
 607         debugfs_remove(intf->driver_folder);
 608         kfree(intf->chipset_blob.data);
 609         kfree(intf->driver_blob.data);
 610         kfree(intf);
 611
 612         rt2x00dev->debugfs_intf = NULL;
 613 }