2 Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
3 <http://rt2x00.serialmonkey.com>
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.
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.
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.
23 Abstract: rt2x00 debugfs specific routines.
26 #include <linux/debugfs.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/poll.h>
30 #include <linux/sched.h>
31 #include <linux/slab.h>
32 #include <linux/uaccess.h>
35 #include "rt2x00lib.h"
36 #include "rt2x00dump.h"
38 #define MAX_LINE_LENGTH 64
40 struct rt2x00debug_crypto {
41 unsigned long success;
42 unsigned long icv_error;
43 unsigned long mic_error;
44 unsigned long key_error;
47 struct rt2x00debug_intf {
49 * Pointer to driver structure where
50 * this debugfs entry belongs to.
52 struct rt2x00_dev *rt2x00dev;
55 * Reference to the rt2x00debug structure
56 * which can be used to communicate with
59 const struct rt2x00debug *debug;
62 * Debugfs entries for:
66 * - device state flags file
67 * - device capability flags file
69 * - csr offset/value files
70 * - eeprom offset/value files
71 * - bbp offset/value files
72 * - rf offset/value files
78 struct dentry *driver_folder;
79 struct dentry *driver_entry;
80 struct dentry *chipset_entry;
81 struct dentry *dev_flags;
82 struct dentry *cap_flags;
83 struct dentry *register_folder;
84 struct dentry *csr_off_entry;
85 struct dentry *csr_val_entry;
86 struct dentry *eeprom_off_entry;
87 struct dentry *eeprom_val_entry;
88 struct dentry *bbp_off_entry;
89 struct dentry *bbp_val_entry;
90 struct dentry *rf_off_entry;
91 struct dentry *rf_val_entry;
92 struct dentry *queue_folder;
93 struct dentry *queue_frame_dump_entry;
94 struct dentry *queue_stats_entry;
95 struct dentry *crypto_stats_entry;
98 * The frame dump file only allows a single reader,
99 * so we need to store the current state here.
101 unsigned long frame_dump_flags;
102 #define FRAME_DUMP_FILE_OPEN 1
105 * We queue each frame before dumping it to the user,
106 * per read command we will pass a single skb structure
107 * so we should be prepared to queue multiple sk buffers
108 * before sending it to userspace.
110 struct sk_buff_head frame_dump_skbqueue;
111 wait_queue_head_t frame_dump_waitqueue;
114 * HW crypto statistics.
115 * All statistics are stored separately per cipher type.
117 struct rt2x00debug_crypto crypto_stats[CIPHER_MAX];
120 * Driver and chipset files will use a data buffer
121 * that has been created in advance. This will simplify
122 * the code since we can use the debugfs functions.
124 struct debugfs_blob_wrapper driver_blob;
125 struct debugfs_blob_wrapper chipset_blob;
128 * Requested offset for each register type.
130 unsigned int offset_csr;
131 unsigned int offset_eeprom;
132 unsigned int offset_bbp;
133 unsigned int offset_rf;
136 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
137 struct rxdone_entry_desc *rxdesc)
139 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
140 enum cipher cipher = rxdesc->cipher;
141 enum rx_crypto status = rxdesc->cipher_status;
143 if (cipher == CIPHER_TKIP_NO_MIC)
144 cipher = CIPHER_TKIP;
145 if (cipher == CIPHER_NONE || cipher >= CIPHER_MAX)
148 /* Remove CIPHER_NONE index */
151 intf->crypto_stats[cipher].success += (status == RX_CRYPTO_SUCCESS);
152 intf->crypto_stats[cipher].icv_error += (status == RX_CRYPTO_FAIL_ICV);
153 intf->crypto_stats[cipher].mic_error += (status == RX_CRYPTO_FAIL_MIC);
154 intf->crypto_stats[cipher].key_error += (status == RX_CRYPTO_FAIL_KEY);
157 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
158 enum rt2x00_dump_type type, struct sk_buff *skb)
160 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
161 struct skb_frame_desc *skbdesc = get_skb_frame_desc(skb);
162 struct sk_buff *skbcopy;
163 struct rt2x00dump_hdr *dump_hdr;
164 struct timeval timestamp;
167 if (likely(!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags)))
170 do_gettimeofday(×tamp);
172 if (skb_queue_len(&intf->frame_dump_skbqueue) > 20) {
173 DEBUG(rt2x00dev, "txrx dump queue length exceeded.\n");
178 if (skbdesc->flags & SKBDESC_DESC_IN_SKB)
179 data_len -= skbdesc->desc_len;
181 skbcopy = alloc_skb(sizeof(*dump_hdr) + skbdesc->desc_len + data_len,
184 DEBUG(rt2x00dev, "Failed to copy skb for dump.\n");
188 dump_hdr = (struct rt2x00dump_hdr *)skb_put(skbcopy, sizeof(*dump_hdr));
189 dump_hdr->version = cpu_to_le32(DUMP_HEADER_VERSION);
190 dump_hdr->header_length = cpu_to_le32(sizeof(*dump_hdr));
191 dump_hdr->desc_length = cpu_to_le32(skbdesc->desc_len);
192 dump_hdr->data_length = cpu_to_le32(data_len);
193 dump_hdr->chip_rt = cpu_to_le16(rt2x00dev->chip.rt);
194 dump_hdr->chip_rf = cpu_to_le16(rt2x00dev->chip.rf);
195 dump_hdr->chip_rev = cpu_to_le16(rt2x00dev->chip.rev);
196 dump_hdr->type = cpu_to_le16(type);
197 dump_hdr->queue_index = skbdesc->entry->queue->qid;
198 dump_hdr->entry_index = skbdesc->entry->entry_idx;
199 dump_hdr->timestamp_sec = cpu_to_le32(timestamp.tv_sec);
200 dump_hdr->timestamp_usec = cpu_to_le32(timestamp.tv_usec);
202 if (!(skbdesc->flags & SKBDESC_DESC_IN_SKB))
203 memcpy(skb_put(skbcopy, skbdesc->desc_len), skbdesc->desc,
205 memcpy(skb_put(skbcopy, skb->len), skb->data, skb->len);
207 skb_queue_tail(&intf->frame_dump_skbqueue, skbcopy);
208 wake_up_interruptible(&intf->frame_dump_waitqueue);
211 * Verify that the file has not been closed while we were working.
213 if (!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags))
214 skb_queue_purge(&intf->frame_dump_skbqueue);
216 EXPORT_SYMBOL_GPL(rt2x00debug_dump_frame);
218 static int rt2x00debug_file_open(struct inode *inode, struct file *file)
220 struct rt2x00debug_intf *intf = inode->i_private;
222 file->private_data = inode->i_private;
224 if (!try_module_get(intf->debug->owner))
230 static int rt2x00debug_file_release(struct inode *inode, struct file *file)
232 struct rt2x00debug_intf *intf = file->private_data;
234 module_put(intf->debug->owner);
239 static int rt2x00debug_open_queue_dump(struct inode *inode, struct file *file)
241 struct rt2x00debug_intf *intf = inode->i_private;
244 retval = rt2x00debug_file_open(inode, file);
248 if (test_and_set_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags)) {
249 rt2x00debug_file_release(inode, file);
256 static int rt2x00debug_release_queue_dump(struct inode *inode, struct file *file)
258 struct rt2x00debug_intf *intf = inode->i_private;
260 skb_queue_purge(&intf->frame_dump_skbqueue);
262 clear_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags);
264 return rt2x00debug_file_release(inode, file);
267 static ssize_t rt2x00debug_read_queue_dump(struct file *file,
272 struct rt2x00debug_intf *intf = file->private_data;
277 if (file->f_flags & O_NONBLOCK)
281 wait_event_interruptible(intf->frame_dump_waitqueue,
283 skb_dequeue(&intf->frame_dump_skbqueue)));
287 status = min((size_t)skb->len, length);
288 if (copy_to_user(buf, skb->data, status)) {
301 static unsigned int rt2x00debug_poll_queue_dump(struct file *file,
304 struct rt2x00debug_intf *intf = file->private_data;
306 poll_wait(file, &intf->frame_dump_waitqueue, wait);
308 if (!skb_queue_empty(&intf->frame_dump_skbqueue))
309 return POLLOUT | POLLWRNORM;
314 static const struct file_operations rt2x00debug_fop_queue_dump = {
315 .owner = THIS_MODULE,
316 .read = rt2x00debug_read_queue_dump,
317 .poll = rt2x00debug_poll_queue_dump,
318 .open = rt2x00debug_open_queue_dump,
319 .release = rt2x00debug_release_queue_dump,
320 .llseek = default_llseek,
323 static ssize_t rt2x00debug_read_queue_stats(struct file *file,
328 struct rt2x00debug_intf *intf = file->private_data;
329 struct data_queue *queue;
330 unsigned long irqflags;
331 unsigned int lines = 1 + intf->rt2x00dev->data_queues;
339 data = kcalloc(lines, MAX_LINE_LENGTH, GFP_KERNEL);
344 sprintf(data, "qid\tflags\t\tcount\tlimit\tlength\tindex\tdma done\tdone\n");
346 queue_for_each(intf->rt2x00dev, queue) {
347 spin_lock_irqsave(&queue->index_lock, irqflags);
349 temp += sprintf(temp, "%d\t0x%.8x\t%d\t%d\t%d\t%d\t%d\t\t%d\n",
350 queue->qid, (unsigned int)queue->flags,
351 queue->count, queue->limit, queue->length,
352 queue->index[Q_INDEX],
353 queue->index[Q_INDEX_DMA_DONE],
354 queue->index[Q_INDEX_DONE]);
356 spin_unlock_irqrestore(&queue->index_lock, irqflags);
360 size = min(size, length);
362 if (copy_to_user(buf, data, size)) {
373 static const struct file_operations rt2x00debug_fop_queue_stats = {
374 .owner = THIS_MODULE,
375 .read = rt2x00debug_read_queue_stats,
376 .open = rt2x00debug_file_open,
377 .release = rt2x00debug_file_release,
378 .llseek = default_llseek,
381 #ifdef CONFIG_RT2X00_LIB_CRYPTO
382 static ssize_t rt2x00debug_read_crypto_stats(struct file *file,
387 struct rt2x00debug_intf *intf = file->private_data;
388 static const char * const name[] = { "WEP64", "WEP128", "TKIP", "AES" };
397 data = kzalloc((1 + CIPHER_MAX) * MAX_LINE_LENGTH, GFP_KERNEL);
402 temp += sprintf(data, "cipher\tsuccess\ticv err\tmic err\tkey err\n");
404 for (i = 0; i < CIPHER_MAX; i++) {
405 temp += sprintf(temp, "%s\t%lu\t%lu\t%lu\t%lu\n", name[i],
406 intf->crypto_stats[i].success,
407 intf->crypto_stats[i].icv_error,
408 intf->crypto_stats[i].mic_error,
409 intf->crypto_stats[i].key_error);
413 size = min(size, length);
415 if (copy_to_user(buf, data, size)) {
426 static const struct file_operations rt2x00debug_fop_crypto_stats = {
427 .owner = THIS_MODULE,
428 .read = rt2x00debug_read_crypto_stats,
429 .open = rt2x00debug_file_open,
430 .release = rt2x00debug_file_release,
431 .llseek = default_llseek,
435 #define RT2X00DEBUGFS_OPS_READ(__name, __format, __type) \
436 static ssize_t rt2x00debug_read_##__name(struct file *file, \
441 struct rt2x00debug_intf *intf = file->private_data; \
442 const struct rt2x00debug *debug = intf->debug; \
445 unsigned int index = intf->offset_##__name; \
451 if (index >= debug->__name.word_count) \
454 index += (debug->__name.word_base / \
455 debug->__name.word_size); \
457 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
458 index *= debug->__name.word_size; \
460 debug->__name.read(intf->rt2x00dev, index, &value); \
462 size = sprintf(line, __format, value); \
464 if (copy_to_user(buf, line, size)) \
471 #define RT2X00DEBUGFS_OPS_WRITE(__name, __type) \
472 static ssize_t rt2x00debug_write_##__name(struct file *file, \
473 const char __user *buf,\
477 struct rt2x00debug_intf *intf = file->private_data; \
478 const struct rt2x00debug *debug = intf->debug; \
481 unsigned int index = intf->offset_##__name; \
487 if (index >= debug->__name.word_count) \
490 if (length > sizeof(line)) \
493 if (copy_from_user(line, buf, length)) \
496 size = strlen(line); \
497 value = simple_strtoul(line, NULL, 0); \
499 index += (debug->__name.word_base / \
500 debug->__name.word_size); \
502 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
503 index *= debug->__name.word_size; \
505 debug->__name.write(intf->rt2x00dev, index, value); \
511 #define RT2X00DEBUGFS_OPS(__name, __format, __type) \
512 RT2X00DEBUGFS_OPS_READ(__name, __format, __type); \
513 RT2X00DEBUGFS_OPS_WRITE(__name, __type); \
515 static const struct file_operations rt2x00debug_fop_##__name = {\
516 .owner = THIS_MODULE, \
517 .read = rt2x00debug_read_##__name, \
518 .write = rt2x00debug_write_##__name, \
519 .open = rt2x00debug_file_open, \
520 .release = rt2x00debug_file_release, \
521 .llseek = generic_file_llseek, \
524 RT2X00DEBUGFS_OPS(csr, "0x%.8x\n", u32);
525 RT2X00DEBUGFS_OPS(eeprom, "0x%.4x\n", u16);
526 RT2X00DEBUGFS_OPS(bbp, "0x%.2x\n", u8);
527 RT2X00DEBUGFS_OPS(rf, "0x%.8x\n", u32);
529 static ssize_t rt2x00debug_read_dev_flags(struct file *file,
534 struct rt2x00debug_intf *intf = file->private_data;
541 size = sprintf(line, "0x%.8x\n", (unsigned int)intf->rt2x00dev->flags);
543 if (copy_to_user(buf, line, size))
550 static const struct file_operations rt2x00debug_fop_dev_flags = {
551 .owner = THIS_MODULE,
552 .read = rt2x00debug_read_dev_flags,
553 .open = rt2x00debug_file_open,
554 .release = rt2x00debug_file_release,
555 .llseek = default_llseek,
558 static ssize_t rt2x00debug_read_cap_flags(struct file *file,
563 struct rt2x00debug_intf *intf = file->private_data;
570 size = sprintf(line, "0x%.8x\n", (unsigned int)intf->rt2x00dev->cap_flags);
572 if (copy_to_user(buf, line, size))
579 static const struct file_operations rt2x00debug_fop_cap_flags = {
580 .owner = THIS_MODULE,
581 .read = rt2x00debug_read_cap_flags,
582 .open = rt2x00debug_file_open,
583 .release = rt2x00debug_file_release,
584 .llseek = default_llseek,
587 static struct dentry *rt2x00debug_create_file_driver(const char *name,
588 struct rt2x00debug_intf
590 struct debugfs_blob_wrapper
595 data = kzalloc(3 * MAX_LINE_LENGTH, GFP_KERNEL);
600 data += sprintf(data, "driver:\t%s\n", intf->rt2x00dev->ops->name);
601 data += sprintf(data, "version:\t%s\n", DRV_VERSION);
602 blob->size = strlen(blob->data);
604 return debugfs_create_blob(name, S_IRUSR, intf->driver_folder, blob);
607 static struct dentry *rt2x00debug_create_file_chipset(const char *name,
608 struct rt2x00debug_intf
614 const struct rt2x00debug *debug = intf->debug;
617 data = kzalloc(8 * MAX_LINE_LENGTH, GFP_KERNEL);
622 data += sprintf(data, "rt chip:\t%04x\n", intf->rt2x00dev->chip.rt);
623 data += sprintf(data, "rf chip:\t%04x\n", intf->rt2x00dev->chip.rf);
624 data += sprintf(data, "revision:\t%04x\n", intf->rt2x00dev->chip.rev);
625 data += sprintf(data, "\n");
626 data += sprintf(data, "register\tbase\twords\twordsize\n");
627 data += sprintf(data, "csr\t%d\t%d\t%d\n",
628 debug->csr.word_base,
629 debug->csr.word_count,
630 debug->csr.word_size);
631 data += sprintf(data, "eeprom\t%d\t%d\t%d\n",
632 debug->eeprom.word_base,
633 debug->eeprom.word_count,
634 debug->eeprom.word_size);
635 data += sprintf(data, "bbp\t%d\t%d\t%d\n",
636 debug->bbp.word_base,
637 debug->bbp.word_count,
638 debug->bbp.word_size);
639 data += sprintf(data, "rf\t%d\t%d\t%d\n",
641 debug->rf.word_count,
642 debug->rf.word_size);
643 blob->size = strlen(blob->data);
645 return debugfs_create_blob(name, S_IRUSR, intf->driver_folder, blob);
648 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
650 const struct rt2x00debug *debug = rt2x00dev->ops->debugfs;
651 struct rt2x00debug_intf *intf;
653 intf = kzalloc(sizeof(struct rt2x00debug_intf), GFP_KERNEL);
655 ERROR(rt2x00dev, "Failed to allocate debug handler.\n");
660 intf->rt2x00dev = rt2x00dev;
661 rt2x00dev->debugfs_intf = intf;
663 intf->driver_folder =
664 debugfs_create_dir(intf->rt2x00dev->ops->name,
665 rt2x00dev->hw->wiphy->debugfsdir);
666 if (IS_ERR(intf->driver_folder) || !intf->driver_folder)
670 rt2x00debug_create_file_driver("driver", intf, &intf->driver_blob);
671 if (IS_ERR(intf->driver_entry) || !intf->driver_entry)
674 intf->chipset_entry =
675 rt2x00debug_create_file_chipset("chipset",
676 intf, &intf->chipset_blob);
677 if (IS_ERR(intf->chipset_entry) || !intf->chipset_entry)
680 intf->dev_flags = debugfs_create_file("dev_flags", S_IRUSR,
681 intf->driver_folder, intf,
682 &rt2x00debug_fop_dev_flags);
683 if (IS_ERR(intf->dev_flags) || !intf->dev_flags)
686 intf->cap_flags = debugfs_create_file("cap_flags", S_IRUSR,
687 intf->driver_folder, intf,
688 &rt2x00debug_fop_cap_flags);
689 if (IS_ERR(intf->cap_flags) || !intf->cap_flags)
692 intf->register_folder =
693 debugfs_create_dir("register", intf->driver_folder);
694 if (IS_ERR(intf->register_folder) || !intf->register_folder)
697 #define RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(__intf, __name) \
699 (__intf)->__name##_off_entry = \
700 debugfs_create_u32(__stringify(__name) "_offset", \
702 (__intf)->register_folder, \
703 &(__intf)->offset_##__name); \
704 if (IS_ERR((__intf)->__name##_off_entry) \
705 || !(__intf)->__name##_off_entry) \
708 (__intf)->__name##_val_entry = \
709 debugfs_create_file(__stringify(__name) "_value", \
711 (__intf)->register_folder, \
712 (__intf), &rt2x00debug_fop_##__name);\
713 if (IS_ERR((__intf)->__name##_val_entry) \
714 || !(__intf)->__name##_val_entry) \
718 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, csr);
719 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, eeprom);
720 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, bbp);
721 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, rf);
723 #undef RT2X00DEBUGFS_CREATE_REGISTER_ENTRY
726 debugfs_create_dir("queue", intf->driver_folder);
727 if (IS_ERR(intf->queue_folder) || !intf->queue_folder)
730 intf->queue_frame_dump_entry =
731 debugfs_create_file("dump", S_IRUSR, intf->queue_folder,
732 intf, &rt2x00debug_fop_queue_dump);
733 if (IS_ERR(intf->queue_frame_dump_entry)
734 || !intf->queue_frame_dump_entry)
737 skb_queue_head_init(&intf->frame_dump_skbqueue);
738 init_waitqueue_head(&intf->frame_dump_waitqueue);
740 intf->queue_stats_entry =
741 debugfs_create_file("queue", S_IRUSR, intf->queue_folder,
742 intf, &rt2x00debug_fop_queue_stats);
744 #ifdef CONFIG_RT2X00_LIB_CRYPTO
745 if (test_bit(CAPABILITY_HW_CRYPTO, &rt2x00dev->cap_flags))
746 intf->crypto_stats_entry =
747 debugfs_create_file("crypto", S_IRUGO, intf->queue_folder,
748 intf, &rt2x00debug_fop_crypto_stats);
754 rt2x00debug_deregister(rt2x00dev);
755 ERROR(rt2x00dev, "Failed to register debug handler.\n");
758 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
760 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
765 skb_queue_purge(&intf->frame_dump_skbqueue);
767 #ifdef CONFIG_RT2X00_LIB_CRYPTO
768 debugfs_remove(intf->crypto_stats_entry);
770 debugfs_remove(intf->queue_stats_entry);
771 debugfs_remove(intf->queue_frame_dump_entry);
772 debugfs_remove(intf->queue_folder);
773 debugfs_remove(intf->rf_val_entry);
774 debugfs_remove(intf->rf_off_entry);
775 debugfs_remove(intf->bbp_val_entry);
776 debugfs_remove(intf->bbp_off_entry);
777 debugfs_remove(intf->eeprom_val_entry);
778 debugfs_remove(intf->eeprom_off_entry);
779 debugfs_remove(intf->csr_val_entry);
780 debugfs_remove(intf->csr_off_entry);
781 debugfs_remove(intf->register_folder);
782 debugfs_remove(intf->dev_flags);
783 debugfs_remove(intf->cap_flags);
784 debugfs_remove(intf->chipset_entry);
785 debugfs_remove(intf->driver_entry);
786 debugfs_remove(intf->driver_folder);
787 kfree(intf->chipset_blob.data);
788 kfree(intf->driver_blob.data);
791 rt2x00dev->debugfs_intf = NULL;