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, see <http://www.gnu.org/licenses/>.
21 Abstract: rt2x00 debugfs specific routines.
24 #include <linux/debugfs.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/poll.h>
28 #include <linux/sched.h>
29 #include <linux/slab.h>
30 #include <linux/uaccess.h>
33 #include "rt2x00lib.h"
34 #include "rt2x00dump.h"
36 #define MAX_LINE_LENGTH 64
38 struct rt2x00debug_crypto {
39 unsigned long success;
40 unsigned long icv_error;
41 unsigned long mic_error;
42 unsigned long key_error;
45 struct rt2x00debug_intf {
47 * Pointer to driver structure where
48 * this debugfs entry belongs to.
50 struct rt2x00_dev *rt2x00dev;
53 * Reference to the rt2x00debug structure
54 * which can be used to communicate with
57 const struct rt2x00debug *debug;
60 * Debugfs entries for:
64 * - device state flags file
65 * - device capability flags file
67 * - csr offset/value files
68 * - eeprom offset/value files
69 * - bbp offset/value files
70 * - rf offset/value files
71 * - rfcsr offset/value files
77 struct dentry *driver_folder;
78 struct dentry *driver_entry;
79 struct dentry *chipset_entry;
80 struct dentry *dev_flags;
81 struct dentry *cap_flags;
82 struct dentry *register_folder;
83 struct dentry *csr_off_entry;
84 struct dentry *csr_val_entry;
85 struct dentry *eeprom_off_entry;
86 struct dentry *eeprom_val_entry;
87 struct dentry *bbp_off_entry;
88 struct dentry *bbp_val_entry;
89 struct dentry *rf_off_entry;
90 struct dentry *rf_val_entry;
91 struct dentry *rfcsr_off_entry;
92 struct dentry *rfcsr_val_entry;
93 struct dentry *queue_folder;
94 struct dentry *queue_frame_dump_entry;
95 struct dentry *queue_stats_entry;
96 struct dentry *crypto_stats_entry;
99 * The frame dump file only allows a single reader,
100 * so we need to store the current state here.
102 unsigned long frame_dump_flags;
103 #define FRAME_DUMP_FILE_OPEN 1
106 * We queue each frame before dumping it to the user,
107 * per read command we will pass a single skb structure
108 * so we should be prepared to queue multiple sk buffers
109 * before sending it to userspace.
111 struct sk_buff_head frame_dump_skbqueue;
112 wait_queue_head_t frame_dump_waitqueue;
115 * HW crypto statistics.
116 * All statistics are stored separately per cipher type.
118 struct rt2x00debug_crypto crypto_stats[CIPHER_MAX];
121 * Driver and chipset files will use a data buffer
122 * that has been created in advance. This will simplify
123 * the code since we can use the debugfs functions.
125 struct debugfs_blob_wrapper driver_blob;
126 struct debugfs_blob_wrapper chipset_blob;
129 * Requested offset for each register type.
131 unsigned int offset_csr;
132 unsigned int offset_eeprom;
133 unsigned int offset_bbp;
134 unsigned int offset_rf;
135 unsigned int offset_rfcsr;
138 void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
139 struct rxdone_entry_desc *rxdesc)
141 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
142 enum cipher cipher = rxdesc->cipher;
143 enum rx_crypto status = rxdesc->cipher_status;
145 if (cipher == CIPHER_TKIP_NO_MIC)
146 cipher = CIPHER_TKIP;
147 if (cipher == CIPHER_NONE || cipher >= CIPHER_MAX)
150 /* Remove CIPHER_NONE index */
153 intf->crypto_stats[cipher].success += (status == RX_CRYPTO_SUCCESS);
154 intf->crypto_stats[cipher].icv_error += (status == RX_CRYPTO_FAIL_ICV);
155 intf->crypto_stats[cipher].mic_error += (status == RX_CRYPTO_FAIL_MIC);
156 intf->crypto_stats[cipher].key_error += (status == RX_CRYPTO_FAIL_KEY);
159 void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
160 enum rt2x00_dump_type type, struct sk_buff *skb)
162 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
163 struct skb_frame_desc *skbdesc = get_skb_frame_desc(skb);
164 struct sk_buff *skbcopy;
165 struct rt2x00dump_hdr *dump_hdr;
166 struct timeval timestamp;
169 if (likely(!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags)))
172 do_gettimeofday(×tamp);
174 if (skb_queue_len(&intf->frame_dump_skbqueue) > 20) {
175 rt2x00_dbg(rt2x00dev, "txrx dump queue length exceeded\n");
180 if (skbdesc->flags & SKBDESC_DESC_IN_SKB)
181 data_len -= skbdesc->desc_len;
183 skbcopy = alloc_skb(sizeof(*dump_hdr) + skbdesc->desc_len + data_len,
186 rt2x00_dbg(rt2x00dev, "Failed to copy skb for dump\n");
190 dump_hdr = (struct rt2x00dump_hdr *)skb_put(skbcopy, sizeof(*dump_hdr));
191 dump_hdr->version = cpu_to_le32(DUMP_HEADER_VERSION);
192 dump_hdr->header_length = cpu_to_le32(sizeof(*dump_hdr));
193 dump_hdr->desc_length = cpu_to_le32(skbdesc->desc_len);
194 dump_hdr->data_length = cpu_to_le32(data_len);
195 dump_hdr->chip_rt = cpu_to_le16(rt2x00dev->chip.rt);
196 dump_hdr->chip_rf = cpu_to_le16(rt2x00dev->chip.rf);
197 dump_hdr->chip_rev = cpu_to_le16(rt2x00dev->chip.rev);
198 dump_hdr->type = cpu_to_le16(type);
199 dump_hdr->queue_index = skbdesc->entry->queue->qid;
200 dump_hdr->entry_index = skbdesc->entry->entry_idx;
201 dump_hdr->timestamp_sec = cpu_to_le32(timestamp.tv_sec);
202 dump_hdr->timestamp_usec = cpu_to_le32(timestamp.tv_usec);
204 if (!(skbdesc->flags & SKBDESC_DESC_IN_SKB))
205 memcpy(skb_put(skbcopy, skbdesc->desc_len), skbdesc->desc,
207 memcpy(skb_put(skbcopy, skb->len), skb->data, skb->len);
209 skb_queue_tail(&intf->frame_dump_skbqueue, skbcopy);
210 wake_up_interruptible(&intf->frame_dump_waitqueue);
213 * Verify that the file has not been closed while we were working.
215 if (!test_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags))
216 skb_queue_purge(&intf->frame_dump_skbqueue);
218 EXPORT_SYMBOL_GPL(rt2x00debug_dump_frame);
220 static int rt2x00debug_file_open(struct inode *inode, struct file *file)
222 struct rt2x00debug_intf *intf = inode->i_private;
224 file->private_data = inode->i_private;
226 if (!try_module_get(intf->debug->owner))
232 static int rt2x00debug_file_release(struct inode *inode, struct file *file)
234 struct rt2x00debug_intf *intf = file->private_data;
236 module_put(intf->debug->owner);
241 static int rt2x00debug_open_queue_dump(struct inode *inode, struct file *file)
243 struct rt2x00debug_intf *intf = inode->i_private;
246 retval = rt2x00debug_file_open(inode, file);
250 if (test_and_set_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags)) {
251 rt2x00debug_file_release(inode, file);
258 static int rt2x00debug_release_queue_dump(struct inode *inode, struct file *file)
260 struct rt2x00debug_intf *intf = inode->i_private;
262 skb_queue_purge(&intf->frame_dump_skbqueue);
264 clear_bit(FRAME_DUMP_FILE_OPEN, &intf->frame_dump_flags);
266 return rt2x00debug_file_release(inode, file);
269 static ssize_t rt2x00debug_read_queue_dump(struct file *file,
274 struct rt2x00debug_intf *intf = file->private_data;
279 if (file->f_flags & O_NONBLOCK)
283 wait_event_interruptible(intf->frame_dump_waitqueue,
285 skb_dequeue(&intf->frame_dump_skbqueue)));
289 status = min_t(size_t, skb->len, length);
290 if (copy_to_user(buf, skb->data, status)) {
303 static unsigned int rt2x00debug_poll_queue_dump(struct file *file,
306 struct rt2x00debug_intf *intf = file->private_data;
308 poll_wait(file, &intf->frame_dump_waitqueue, wait);
310 if (!skb_queue_empty(&intf->frame_dump_skbqueue))
311 return POLLOUT | POLLWRNORM;
316 static const struct file_operations rt2x00debug_fop_queue_dump = {
317 .owner = THIS_MODULE,
318 .read = rt2x00debug_read_queue_dump,
319 .poll = rt2x00debug_poll_queue_dump,
320 .open = rt2x00debug_open_queue_dump,
321 .release = rt2x00debug_release_queue_dump,
322 .llseek = default_llseek,
325 static ssize_t rt2x00debug_read_queue_stats(struct file *file,
330 struct rt2x00debug_intf *intf = file->private_data;
331 struct data_queue *queue;
332 unsigned long irqflags;
333 unsigned int lines = 1 + intf->rt2x00dev->data_queues;
341 data = kcalloc(lines, MAX_LINE_LENGTH, GFP_KERNEL);
346 sprintf(data, "qid\tflags\t\tcount\tlimit\tlength\tindex\tdma done\tdone\n");
348 queue_for_each(intf->rt2x00dev, queue) {
349 spin_lock_irqsave(&queue->index_lock, irqflags);
351 temp += sprintf(temp, "%d\t0x%.8x\t%d\t%d\t%d\t%d\t%d\t\t%d\n",
352 queue->qid, (unsigned int)queue->flags,
353 queue->count, queue->limit, queue->length,
354 queue->index[Q_INDEX],
355 queue->index[Q_INDEX_DMA_DONE],
356 queue->index[Q_INDEX_DONE]);
358 spin_unlock_irqrestore(&queue->index_lock, irqflags);
362 size = min(size, length);
364 if (copy_to_user(buf, data, size)) {
375 static const struct file_operations rt2x00debug_fop_queue_stats = {
376 .owner = THIS_MODULE,
377 .read = rt2x00debug_read_queue_stats,
378 .open = rt2x00debug_file_open,
379 .release = rt2x00debug_file_release,
380 .llseek = default_llseek,
383 #ifdef CONFIG_RT2X00_LIB_CRYPTO
384 static ssize_t rt2x00debug_read_crypto_stats(struct file *file,
389 struct rt2x00debug_intf *intf = file->private_data;
390 static const char * const name[] = { "WEP64", "WEP128", "TKIP", "AES" };
399 data = kzalloc((1 + CIPHER_MAX) * MAX_LINE_LENGTH, GFP_KERNEL);
404 temp += sprintf(data, "cipher\tsuccess\ticv err\tmic err\tkey err\n");
406 for (i = 0; i < CIPHER_MAX; i++) {
407 temp += sprintf(temp, "%s\t%lu\t%lu\t%lu\t%lu\n", name[i],
408 intf->crypto_stats[i].success,
409 intf->crypto_stats[i].icv_error,
410 intf->crypto_stats[i].mic_error,
411 intf->crypto_stats[i].key_error);
415 size = min(size, length);
417 if (copy_to_user(buf, data, size)) {
428 static const struct file_operations rt2x00debug_fop_crypto_stats = {
429 .owner = THIS_MODULE,
430 .read = rt2x00debug_read_crypto_stats,
431 .open = rt2x00debug_file_open,
432 .release = rt2x00debug_file_release,
433 .llseek = default_llseek,
437 #define RT2X00DEBUGFS_OPS_READ(__name, __format, __type) \
438 static ssize_t rt2x00debug_read_##__name(struct file *file, \
443 struct rt2x00debug_intf *intf = file->private_data; \
444 const struct rt2x00debug *debug = intf->debug; \
447 unsigned int index = intf->offset_##__name; \
453 if (index >= debug->__name.word_count) \
456 index += (debug->__name.word_base / \
457 debug->__name.word_size); \
459 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
460 index *= debug->__name.word_size; \
462 debug->__name.read(intf->rt2x00dev, index, &value); \
464 size = sprintf(line, __format, value); \
466 if (copy_to_user(buf, line, size)) \
473 #define RT2X00DEBUGFS_OPS_WRITE(__name, __type) \
474 static ssize_t rt2x00debug_write_##__name(struct file *file, \
475 const char __user *buf,\
479 struct rt2x00debug_intf *intf = file->private_data; \
480 const struct rt2x00debug *debug = intf->debug; \
483 unsigned int index = intf->offset_##__name; \
489 if (index >= debug->__name.word_count) \
492 if (length > sizeof(line)) \
495 if (copy_from_user(line, buf, length)) \
499 size = strlen(line); \
500 value = simple_strtoul(line, NULL, 0); \
502 index += (debug->__name.word_base / \
503 debug->__name.word_size); \
505 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
506 index *= debug->__name.word_size; \
508 debug->__name.write(intf->rt2x00dev, index, value); \
514 #define RT2X00DEBUGFS_OPS(__name, __format, __type) \
515 RT2X00DEBUGFS_OPS_READ(__name, __format, __type); \
516 RT2X00DEBUGFS_OPS_WRITE(__name, __type); \
518 static const struct file_operations rt2x00debug_fop_##__name = {\
519 .owner = THIS_MODULE, \
520 .read = rt2x00debug_read_##__name, \
521 .write = rt2x00debug_write_##__name, \
522 .open = rt2x00debug_file_open, \
523 .release = rt2x00debug_file_release, \
524 .llseek = generic_file_llseek, \
527 RT2X00DEBUGFS_OPS(csr, "0x%.8x\n", u32);
528 RT2X00DEBUGFS_OPS(eeprom, "0x%.4x\n", u16);
529 RT2X00DEBUGFS_OPS(bbp, "0x%.2x\n", u8);
530 RT2X00DEBUGFS_OPS(rf, "0x%.8x\n", u32);
531 RT2X00DEBUGFS_OPS(rfcsr, "0x%.2x\n", u8);
533 static ssize_t rt2x00debug_read_dev_flags(struct file *file,
538 struct rt2x00debug_intf *intf = file->private_data;
545 size = sprintf(line, "0x%.8x\n", (unsigned int)intf->rt2x00dev->flags);
547 if (copy_to_user(buf, line, size))
554 static const struct file_operations rt2x00debug_fop_dev_flags = {
555 .owner = THIS_MODULE,
556 .read = rt2x00debug_read_dev_flags,
557 .open = rt2x00debug_file_open,
558 .release = rt2x00debug_file_release,
559 .llseek = default_llseek,
562 static ssize_t rt2x00debug_read_cap_flags(struct file *file,
567 struct rt2x00debug_intf *intf = file->private_data;
574 size = sprintf(line, "0x%.8x\n", (unsigned int)intf->rt2x00dev->cap_flags);
576 if (copy_to_user(buf, line, size))
583 static const struct file_operations rt2x00debug_fop_cap_flags = {
584 .owner = THIS_MODULE,
585 .read = rt2x00debug_read_cap_flags,
586 .open = rt2x00debug_file_open,
587 .release = rt2x00debug_file_release,
588 .llseek = default_llseek,
591 static struct dentry *rt2x00debug_create_file_driver(const char *name,
592 struct rt2x00debug_intf
594 struct debugfs_blob_wrapper
599 data = kzalloc(3 * MAX_LINE_LENGTH, GFP_KERNEL);
604 data += sprintf(data, "driver:\t%s\n", intf->rt2x00dev->ops->name);
605 data += sprintf(data, "version:\t%s\n", DRV_VERSION);
606 blob->size = strlen(blob->data);
608 return debugfs_create_blob(name, S_IRUSR, intf->driver_folder, blob);
611 static struct dentry *rt2x00debug_create_file_chipset(const char *name,
612 struct rt2x00debug_intf
618 const struct rt2x00debug *debug = intf->debug;
621 data = kzalloc(9 * MAX_LINE_LENGTH, GFP_KERNEL);
626 data += sprintf(data, "rt chip:\t%04x\n", intf->rt2x00dev->chip.rt);
627 data += sprintf(data, "rf chip:\t%04x\n", intf->rt2x00dev->chip.rf);
628 data += sprintf(data, "revision:\t%04x\n", intf->rt2x00dev->chip.rev);
629 data += sprintf(data, "\n");
630 data += sprintf(data, "register\tbase\twords\twordsize\n");
631 #define RT2X00DEBUGFS_SPRINTF_REGISTER(__name) \
633 if (debug->__name.read) \
634 data += sprintf(data, __stringify(__name) \
636 debug->__name.word_base, \
637 debug->__name.word_count, \
638 debug->__name.word_size); \
640 RT2X00DEBUGFS_SPRINTF_REGISTER(csr);
641 RT2X00DEBUGFS_SPRINTF_REGISTER(eeprom);
642 RT2X00DEBUGFS_SPRINTF_REGISTER(bbp);
643 RT2X00DEBUGFS_SPRINTF_REGISTER(rf);
644 RT2X00DEBUGFS_SPRINTF_REGISTER(rfcsr);
645 #undef RT2X00DEBUGFS_SPRINTF_REGISTER
647 blob->size = strlen(blob->data);
649 return debugfs_create_blob(name, S_IRUSR, intf->driver_folder, blob);
652 void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
654 const struct rt2x00debug *debug = rt2x00dev->ops->debugfs;
655 struct rt2x00debug_intf *intf;
657 intf = kzalloc(sizeof(struct rt2x00debug_intf), GFP_KERNEL);
659 rt2x00_err(rt2x00dev, "Failed to allocate debug handler\n");
664 intf->rt2x00dev = rt2x00dev;
665 rt2x00dev->debugfs_intf = intf;
667 intf->driver_folder =
668 debugfs_create_dir(intf->rt2x00dev->ops->name,
669 rt2x00dev->hw->wiphy->debugfsdir);
670 if (IS_ERR(intf->driver_folder) || !intf->driver_folder)
674 rt2x00debug_create_file_driver("driver", intf, &intf->driver_blob);
675 if (IS_ERR(intf->driver_entry) || !intf->driver_entry)
678 intf->chipset_entry =
679 rt2x00debug_create_file_chipset("chipset",
680 intf, &intf->chipset_blob);
681 if (IS_ERR(intf->chipset_entry) || !intf->chipset_entry)
684 intf->dev_flags = debugfs_create_file("dev_flags", S_IRUSR,
685 intf->driver_folder, intf,
686 &rt2x00debug_fop_dev_flags);
687 if (IS_ERR(intf->dev_flags) || !intf->dev_flags)
690 intf->cap_flags = debugfs_create_file("cap_flags", S_IRUSR,
691 intf->driver_folder, intf,
692 &rt2x00debug_fop_cap_flags);
693 if (IS_ERR(intf->cap_flags) || !intf->cap_flags)
696 intf->register_folder =
697 debugfs_create_dir("register", intf->driver_folder);
698 if (IS_ERR(intf->register_folder) || !intf->register_folder)
701 #define RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(__intf, __name) \
703 if (debug->__name.read) { \
704 (__intf)->__name##_off_entry = \
705 debugfs_create_u32(__stringify(__name) "_offset", \
707 (__intf)->register_folder, \
708 &(__intf)->offset_##__name); \
709 if (IS_ERR((__intf)->__name##_off_entry) \
710 || !(__intf)->__name##_off_entry) \
713 (__intf)->__name##_val_entry = \
714 debugfs_create_file(__stringify(__name) "_value", \
716 (__intf)->register_folder, \
717 (__intf), &rt2x00debug_fop_##__name); \
718 if (IS_ERR((__intf)->__name##_val_entry) \
719 || !(__intf)->__name##_val_entry) \
724 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, csr);
725 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, eeprom);
726 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, bbp);
727 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, rf);
728 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf, rfcsr);
730 #undef RT2X00DEBUGFS_CREATE_REGISTER_ENTRY
733 debugfs_create_dir("queue", intf->driver_folder);
734 if (IS_ERR(intf->queue_folder) || !intf->queue_folder)
737 intf->queue_frame_dump_entry =
738 debugfs_create_file("dump", S_IRUSR, intf->queue_folder,
739 intf, &rt2x00debug_fop_queue_dump);
740 if (IS_ERR(intf->queue_frame_dump_entry)
741 || !intf->queue_frame_dump_entry)
744 skb_queue_head_init(&intf->frame_dump_skbqueue);
745 init_waitqueue_head(&intf->frame_dump_waitqueue);
747 intf->queue_stats_entry =
748 debugfs_create_file("queue", S_IRUSR, intf->queue_folder,
749 intf, &rt2x00debug_fop_queue_stats);
751 #ifdef CONFIG_RT2X00_LIB_CRYPTO
752 if (rt2x00_has_cap_hw_crypto(rt2x00dev))
753 intf->crypto_stats_entry =
754 debugfs_create_file("crypto", S_IRUGO, intf->queue_folder,
755 intf, &rt2x00debug_fop_crypto_stats);
761 rt2x00debug_deregister(rt2x00dev);
762 rt2x00_err(rt2x00dev, "Failed to register debug handler\n");
765 void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
767 struct rt2x00debug_intf *intf = rt2x00dev->debugfs_intf;
772 skb_queue_purge(&intf->frame_dump_skbqueue);
774 #ifdef CONFIG_RT2X00_LIB_CRYPTO
775 debugfs_remove(intf->crypto_stats_entry);
777 debugfs_remove(intf->queue_stats_entry);
778 debugfs_remove(intf->queue_frame_dump_entry);
779 debugfs_remove(intf->queue_folder);
780 debugfs_remove(intf->rfcsr_val_entry);
781 debugfs_remove(intf->rfcsr_off_entry);
782 debugfs_remove(intf->rf_val_entry);
783 debugfs_remove(intf->rf_off_entry);
784 debugfs_remove(intf->bbp_val_entry);
785 debugfs_remove(intf->bbp_off_entry);
786 debugfs_remove(intf->eeprom_val_entry);
787 debugfs_remove(intf->eeprom_off_entry);
788 debugfs_remove(intf->csr_val_entry);
789 debugfs_remove(intf->csr_off_entry);
790 debugfs_remove(intf->register_folder);
791 debugfs_remove(intf->dev_flags);
792 debugfs_remove(intf->cap_flags);
793 debugfs_remove(intf->chipset_entry);
794 debugfs_remove(intf->driver_entry);
795 debugfs_remove(intf->driver_folder);
796 kfree(intf->chipset_blob.data);
797 kfree(intf->driver_blob.data);
800 rt2x00dev->debugfs_intf = NULL;