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:
68 * - csr offset/value files
69 * - eeprom offset/value files
70 * - bbp offset/value files
71 * - rf 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
*register_folder
;
82 struct dentry
*csr_off_entry
;
83 struct dentry
*csr_val_entry
;
84 struct dentry
*eeprom_off_entry
;
85 struct dentry
*eeprom_val_entry
;
86 struct dentry
*bbp_off_entry
;
87 struct dentry
*bbp_val_entry
;
88 struct dentry
*rf_off_entry
;
89 struct dentry
*rf_val_entry
;
90 struct dentry
*queue_folder
;
91 struct dentry
*queue_frame_dump_entry
;
92 struct dentry
*queue_stats_entry
;
93 struct dentry
*crypto_stats_entry
;
96 * The frame dump file only allows a single reader,
97 * so we need to store the current state here.
99 unsigned long frame_dump_flags
;
100 #define FRAME_DUMP_FILE_OPEN 1
103 * We queue each frame before dumping it to the user,
104 * per read command we will pass a single skb structure
105 * so we should be prepared to queue multiple sk buffers
106 * before sending it to userspace.
108 struct sk_buff_head frame_dump_skbqueue
;
109 wait_queue_head_t frame_dump_waitqueue
;
112 * HW crypto statistics.
113 * All statistics are stored separately per cipher type.
115 struct rt2x00debug_crypto crypto_stats
[CIPHER_MAX
];
118 * Driver and chipset files will use a data buffer
119 * that has been created in advance. This will simplify
120 * the code since we can use the debugfs functions.
122 struct debugfs_blob_wrapper driver_blob
;
123 struct debugfs_blob_wrapper chipset_blob
;
126 * Requested offset for each register type.
128 unsigned int offset_csr
;
129 unsigned int offset_eeprom
;
130 unsigned int offset_bbp
;
131 unsigned int offset_rf
;
134 void rt2x00debug_update_crypto(struct rt2x00_dev
*rt2x00dev
,
135 struct rxdone_entry_desc
*rxdesc
)
137 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
138 enum cipher cipher
= rxdesc
->cipher
;
139 enum rx_crypto status
= rxdesc
->cipher_status
;
141 if (cipher
== CIPHER_TKIP_NO_MIC
)
142 cipher
= CIPHER_TKIP
;
143 if (cipher
== CIPHER_NONE
|| cipher
>= CIPHER_MAX
)
146 /* Remove CIPHER_NONE index */
149 intf
->crypto_stats
[cipher
].success
+= (status
== RX_CRYPTO_SUCCESS
);
150 intf
->crypto_stats
[cipher
].icv_error
+= (status
== RX_CRYPTO_FAIL_ICV
);
151 intf
->crypto_stats
[cipher
].mic_error
+= (status
== RX_CRYPTO_FAIL_MIC
);
152 intf
->crypto_stats
[cipher
].key_error
+= (status
== RX_CRYPTO_FAIL_KEY
);
155 void rt2x00debug_dump_frame(struct rt2x00_dev
*rt2x00dev
,
156 enum rt2x00_dump_type type
, struct sk_buff
*skb
)
158 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
159 struct skb_frame_desc
*desc
= get_skb_frame_desc(skb
);
160 struct sk_buff
*skbcopy
;
161 struct rt2x00dump_hdr
*dump_hdr
;
162 struct timeval timestamp
;
164 do_gettimeofday(×tamp
);
166 if (!test_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
))
169 if (skb_queue_len(&intf
->frame_dump_skbqueue
) > 20) {
170 DEBUG(rt2x00dev
, "txrx dump queue length exceeded.\n");
174 skbcopy
= alloc_skb(sizeof(*dump_hdr
) + desc
->desc_len
+ skb
->len
,
177 DEBUG(rt2x00dev
, "Failed to copy skb for dump.\n");
181 dump_hdr
= (struct rt2x00dump_hdr
*)skb_put(skbcopy
, sizeof(*dump_hdr
));
182 dump_hdr
->version
= cpu_to_le32(DUMP_HEADER_VERSION
);
183 dump_hdr
->header_length
= cpu_to_le32(sizeof(*dump_hdr
));
184 dump_hdr
->desc_length
= cpu_to_le32(desc
->desc_len
);
185 dump_hdr
->data_length
= cpu_to_le32(skb
->len
);
186 dump_hdr
->chip_rt
= cpu_to_le16(rt2x00dev
->chip
.rt
);
187 dump_hdr
->chip_rf
= cpu_to_le16(rt2x00dev
->chip
.rf
);
188 dump_hdr
->chip_rev
= cpu_to_le16(rt2x00dev
->chip
.rev
);
189 dump_hdr
->type
= cpu_to_le16(type
);
190 dump_hdr
->queue_index
= desc
->entry
->queue
->qid
;
191 dump_hdr
->entry_index
= desc
->entry
->entry_idx
;
192 dump_hdr
->timestamp_sec
= cpu_to_le32(timestamp
.tv_sec
);
193 dump_hdr
->timestamp_usec
= cpu_to_le32(timestamp
.tv_usec
);
195 memcpy(skb_put(skbcopy
, desc
->desc_len
), desc
->desc
, desc
->desc_len
);
196 memcpy(skb_put(skbcopy
, skb
->len
), skb
->data
, skb
->len
);
198 skb_queue_tail(&intf
->frame_dump_skbqueue
, skbcopy
);
199 wake_up_interruptible(&intf
->frame_dump_waitqueue
);
202 * Verify that the file has not been closed while we were working.
204 if (!test_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
))
205 skb_queue_purge(&intf
->frame_dump_skbqueue
);
208 static int rt2x00debug_file_open(struct inode
*inode
, struct file
*file
)
210 struct rt2x00debug_intf
*intf
= inode
->i_private
;
212 file
->private_data
= inode
->i_private
;
214 if (!try_module_get(intf
->debug
->owner
))
220 static int rt2x00debug_file_release(struct inode
*inode
, struct file
*file
)
222 struct rt2x00debug_intf
*intf
= file
->private_data
;
224 module_put(intf
->debug
->owner
);
229 static int rt2x00debug_open_queue_dump(struct inode
*inode
, struct file
*file
)
231 struct rt2x00debug_intf
*intf
= inode
->i_private
;
234 retval
= rt2x00debug_file_open(inode
, file
);
238 if (test_and_set_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
)) {
239 rt2x00debug_file_release(inode
, file
);
246 static int rt2x00debug_release_queue_dump(struct inode
*inode
, struct file
*file
)
248 struct rt2x00debug_intf
*intf
= inode
->i_private
;
250 skb_queue_purge(&intf
->frame_dump_skbqueue
);
252 clear_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
);
254 return rt2x00debug_file_release(inode
, file
);
257 static ssize_t
rt2x00debug_read_queue_dump(struct file
*file
,
262 struct rt2x00debug_intf
*intf
= file
->private_data
;
267 if (file
->f_flags
& O_NONBLOCK
)
271 wait_event_interruptible(intf
->frame_dump_waitqueue
,
273 skb_dequeue(&intf
->frame_dump_skbqueue
)));
277 status
= min((size_t)skb
->len
, length
);
278 if (copy_to_user(buf
, skb
->data
, status
)) {
291 static unsigned int rt2x00debug_poll_queue_dump(struct file
*file
,
294 struct rt2x00debug_intf
*intf
= file
->private_data
;
296 poll_wait(file
, &intf
->frame_dump_waitqueue
, wait
);
298 if (!skb_queue_empty(&intf
->frame_dump_skbqueue
))
299 return POLLOUT
| POLLWRNORM
;
304 static const struct file_operations rt2x00debug_fop_queue_dump
= {
305 .owner
= THIS_MODULE
,
306 .read
= rt2x00debug_read_queue_dump
,
307 .poll
= rt2x00debug_poll_queue_dump
,
308 .open
= rt2x00debug_open_queue_dump
,
309 .release
= rt2x00debug_release_queue_dump
,
312 static ssize_t
rt2x00debug_read_queue_stats(struct file
*file
,
317 struct rt2x00debug_intf
*intf
= file
->private_data
;
318 struct data_queue
*queue
;
319 unsigned long irqflags
;
320 unsigned int lines
= 1 + intf
->rt2x00dev
->data_queues
;
328 data
= kzalloc(lines
* MAX_LINE_LENGTH
, GFP_KERNEL
);
333 sprintf(data
, "qid\tcount\tlimit\tlength\tindex\tdone\tcrypto\n");
335 queue_for_each(intf
->rt2x00dev
, queue
) {
336 spin_lock_irqsave(&queue
->lock
, irqflags
);
338 temp
+= sprintf(temp
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\n", queue
->qid
,
339 queue
->count
, queue
->limit
, queue
->length
,
340 queue
->index
[Q_INDEX
],
341 queue
->index
[Q_INDEX_DONE
],
342 queue
->index
[Q_INDEX_CRYPTO
]);
344 spin_unlock_irqrestore(&queue
->lock
, irqflags
);
348 size
= min(size
, length
);
350 if (copy_to_user(buf
, data
, size
)) {
361 static const struct file_operations rt2x00debug_fop_queue_stats
= {
362 .owner
= THIS_MODULE
,
363 .read
= rt2x00debug_read_queue_stats
,
364 .open
= rt2x00debug_file_open
,
365 .release
= rt2x00debug_file_release
,
368 #ifdef CONFIG_RT2X00_LIB_CRYPTO
369 static ssize_t
rt2x00debug_read_crypto_stats(struct file
*file
,
374 struct rt2x00debug_intf
*intf
= file
->private_data
;
375 char *name
[] = { "WEP64", "WEP128", "TKIP", "AES" };
384 data
= kzalloc((1 + CIPHER_MAX
) * MAX_LINE_LENGTH
, GFP_KERNEL
);
389 temp
+= sprintf(data
, "cipher\tsuccess\ticv err\tmic err\tkey err\n");
391 for (i
= 0; i
< CIPHER_MAX
; i
++) {
392 temp
+= sprintf(temp
, "%s\t%lu\t%lu\t%lu\t%lu\n", name
[i
],
393 intf
->crypto_stats
[i
].success
,
394 intf
->crypto_stats
[i
].icv_error
,
395 intf
->crypto_stats
[i
].mic_error
,
396 intf
->crypto_stats
[i
].key_error
);
400 size
= min(size
, length
);
402 if (copy_to_user(buf
, data
, size
)) {
413 static const struct file_operations rt2x00debug_fop_crypto_stats
= {
414 .owner
= THIS_MODULE
,
415 .read
= rt2x00debug_read_crypto_stats
,
416 .open
= rt2x00debug_file_open
,
417 .release
= rt2x00debug_file_release
,
421 #define RT2X00DEBUGFS_OPS_READ(__name, __format, __type) \
422 static ssize_t rt2x00debug_read_##__name(struct file *file, \
427 struct rt2x00debug_intf *intf = file->private_data; \
428 const struct rt2x00debug *debug = intf->debug; \
431 unsigned int index = intf->offset_##__name; \
437 if (index >= debug->__name.word_count) \
440 index += (debug->__name.word_base / \
441 debug->__name.word_size); \
443 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
444 index *= debug->__name.word_size; \
446 debug->__name.read(intf->rt2x00dev, index, &value); \
448 size = sprintf(line, __format, value); \
450 if (copy_to_user(buf, line, size)) \
457 #define RT2X00DEBUGFS_OPS_WRITE(__name, __type) \
458 static ssize_t rt2x00debug_write_##__name(struct file *file, \
459 const char __user *buf,\
463 struct rt2x00debug_intf *intf = file->private_data; \
464 const struct rt2x00debug *debug = intf->debug; \
467 unsigned int index = intf->offset_##__name; \
473 if (index >= debug->__name.word_count) \
476 if (copy_from_user(line, buf, length)) \
479 size = strlen(line); \
480 value = simple_strtoul(line, NULL, 0); \
482 index += (debug->__name.word_base / \
483 debug->__name.word_size); \
485 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
486 index *= debug->__name.word_size; \
488 debug->__name.write(intf->rt2x00dev, index, value); \
494 #define RT2X00DEBUGFS_OPS(__name, __format, __type) \
495 RT2X00DEBUGFS_OPS_READ(__name, __format, __type); \
496 RT2X00DEBUGFS_OPS_WRITE(__name, __type); \
498 static const struct file_operations rt2x00debug_fop_##__name = {\
499 .owner = THIS_MODULE, \
500 .read = rt2x00debug_read_##__name, \
501 .write = rt2x00debug_write_##__name, \
502 .open = rt2x00debug_file_open, \
503 .release = rt2x00debug_file_release, \
506 RT2X00DEBUGFS_OPS(csr
, "0x%.8x\n", u32
);
507 RT2X00DEBUGFS_OPS(eeprom
, "0x%.4x\n", u16
);
508 RT2X00DEBUGFS_OPS(bbp
, "0x%.2x\n", u8
);
509 RT2X00DEBUGFS_OPS(rf
, "0x%.8x\n", u32
);
511 static ssize_t
rt2x00debug_read_dev_flags(struct file
*file
,
516 struct rt2x00debug_intf
*intf
= file
->private_data
;
523 size
= sprintf(line
, "0x%.8x\n", (unsigned int)intf
->rt2x00dev
->flags
);
525 if (copy_to_user(buf
, line
, size
))
532 static const struct file_operations rt2x00debug_fop_dev_flags
= {
533 .owner
= THIS_MODULE
,
534 .read
= rt2x00debug_read_dev_flags
,
535 .open
= rt2x00debug_file_open
,
536 .release
= rt2x00debug_file_release
,
539 static struct dentry
*rt2x00debug_create_file_driver(const char *name
,
540 struct rt2x00debug_intf
542 struct debugfs_blob_wrapper
547 data
= kzalloc(3 * MAX_LINE_LENGTH
, GFP_KERNEL
);
552 data
+= sprintf(data
, "driver:\t%s\n", intf
->rt2x00dev
->ops
->name
);
553 data
+= sprintf(data
, "version:\t%s\n", DRV_VERSION
);
554 data
+= sprintf(data
, "compiled:\t%s %s\n", __DATE__
, __TIME__
);
555 blob
->size
= strlen(blob
->data
);
557 return debugfs_create_blob(name
, S_IRUSR
, intf
->driver_folder
, blob
);
560 static struct dentry
*rt2x00debug_create_file_chipset(const char *name
,
561 struct rt2x00debug_intf
567 const struct rt2x00debug
*debug
= intf
->debug
;
570 data
= kzalloc(8 * MAX_LINE_LENGTH
, GFP_KERNEL
);
575 data
+= sprintf(data
, "rt chip:\t%04x\n", intf
->rt2x00dev
->chip
.rt
);
576 data
+= sprintf(data
, "rf chip:\t%04x\n", intf
->rt2x00dev
->chip
.rf
);
577 data
+= sprintf(data
, "revision:\t%04x\n", intf
->rt2x00dev
->chip
.rev
);
578 data
+= sprintf(data
, "\n");
579 data
+= sprintf(data
, "register\tbase\twords\twordsize\n");
580 data
+= sprintf(data
, "csr\t%d\t%d\t%d\n",
581 debug
->csr
.word_base
,
582 debug
->csr
.word_count
,
583 debug
->csr
.word_size
);
584 data
+= sprintf(data
, "eeprom\t%d\t%d\t%d\n",
585 debug
->eeprom
.word_base
,
586 debug
->eeprom
.word_count
,
587 debug
->eeprom
.word_size
);
588 data
+= sprintf(data
, "bbp\t%d\t%d\t%d\n",
589 debug
->bbp
.word_base
,
590 debug
->bbp
.word_count
,
591 debug
->bbp
.word_size
);
592 data
+= sprintf(data
, "rf\t%d\t%d\t%d\n",
594 debug
->rf
.word_count
,
595 debug
->rf
.word_size
);
596 blob
->size
= strlen(blob
->data
);
598 return debugfs_create_blob(name
, S_IRUSR
, intf
->driver_folder
, blob
);
601 void rt2x00debug_register(struct rt2x00_dev
*rt2x00dev
)
603 const struct rt2x00debug
*debug
= rt2x00dev
->ops
->debugfs
;
604 struct rt2x00debug_intf
*intf
;
606 intf
= kzalloc(sizeof(struct rt2x00debug_intf
), GFP_KERNEL
);
608 ERROR(rt2x00dev
, "Failed to allocate debug handler.\n");
613 intf
->rt2x00dev
= rt2x00dev
;
614 rt2x00dev
->debugfs_intf
= intf
;
616 intf
->driver_folder
=
617 debugfs_create_dir(intf
->rt2x00dev
->ops
->name
,
618 rt2x00dev
->hw
->wiphy
->debugfsdir
);
619 if (IS_ERR(intf
->driver_folder
) || !intf
->driver_folder
)
623 rt2x00debug_create_file_driver("driver", intf
, &intf
->driver_blob
);
624 if (IS_ERR(intf
->driver_entry
) || !intf
->driver_entry
)
627 intf
->chipset_entry
=
628 rt2x00debug_create_file_chipset("chipset",
629 intf
, &intf
->chipset_blob
);
630 if (IS_ERR(intf
->chipset_entry
) || !intf
->chipset_entry
)
633 intf
->dev_flags
= debugfs_create_file("dev_flags", S_IRUSR
,
634 intf
->driver_folder
, intf
,
635 &rt2x00debug_fop_dev_flags
);
636 if (IS_ERR(intf
->dev_flags
) || !intf
->dev_flags
)
639 intf
->register_folder
=
640 debugfs_create_dir("register", intf
->driver_folder
);
641 if (IS_ERR(intf
->register_folder
) || !intf
->register_folder
)
644 #define RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(__intf, __name) \
646 (__intf)->__name##_off_entry = \
647 debugfs_create_u32(__stringify(__name) "_offset", \
649 (__intf)->register_folder, \
650 &(__intf)->offset_##__name); \
651 if (IS_ERR((__intf)->__name##_off_entry) \
652 || !(__intf)->__name##_off_entry) \
655 (__intf)->__name##_val_entry = \
656 debugfs_create_file(__stringify(__name) "_value", \
658 (__intf)->register_folder, \
659 (__intf), &rt2x00debug_fop_##__name);\
660 if (IS_ERR((__intf)->__name##_val_entry) \
661 || !(__intf)->__name##_val_entry) \
665 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, csr
);
666 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, eeprom
);
667 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, bbp
);
668 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, rf
);
670 #undef RT2X00DEBUGFS_CREATE_REGISTER_ENTRY
673 debugfs_create_dir("queue", intf
->driver_folder
);
674 if (IS_ERR(intf
->queue_folder
) || !intf
->queue_folder
)
677 intf
->queue_frame_dump_entry
=
678 debugfs_create_file("dump", S_IRUSR
, intf
->queue_folder
,
679 intf
, &rt2x00debug_fop_queue_dump
);
680 if (IS_ERR(intf
->queue_frame_dump_entry
)
681 || !intf
->queue_frame_dump_entry
)
684 skb_queue_head_init(&intf
->frame_dump_skbqueue
);
685 init_waitqueue_head(&intf
->frame_dump_waitqueue
);
687 intf
->queue_stats_entry
=
688 debugfs_create_file("queue", S_IRUSR
, intf
->queue_folder
,
689 intf
, &rt2x00debug_fop_queue_stats
);
691 #ifdef CONFIG_RT2X00_LIB_CRYPTO
692 if (test_bit(CONFIG_SUPPORT_HW_CRYPTO
, &rt2x00dev
->flags
))
693 intf
->crypto_stats_entry
=
694 debugfs_create_file("crypto", S_IRUGO
, intf
->queue_folder
,
695 intf
, &rt2x00debug_fop_crypto_stats
);
701 rt2x00debug_deregister(rt2x00dev
);
702 ERROR(rt2x00dev
, "Failed to register debug handler.\n");
707 void rt2x00debug_deregister(struct rt2x00_dev
*rt2x00dev
)
709 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
714 skb_queue_purge(&intf
->frame_dump_skbqueue
);
716 #ifdef CONFIG_RT2X00_LIB_CRYPTO
717 debugfs_remove(intf
->crypto_stats_entry
);
719 debugfs_remove(intf
->queue_stats_entry
);
720 debugfs_remove(intf
->queue_frame_dump_entry
);
721 debugfs_remove(intf
->queue_folder
);
722 debugfs_remove(intf
->rf_val_entry
);
723 debugfs_remove(intf
->rf_off_entry
);
724 debugfs_remove(intf
->bbp_val_entry
);
725 debugfs_remove(intf
->bbp_off_entry
);
726 debugfs_remove(intf
->eeprom_val_entry
);
727 debugfs_remove(intf
->eeprom_off_entry
);
728 debugfs_remove(intf
->csr_val_entry
);
729 debugfs_remove(intf
->csr_off_entry
);
730 debugfs_remove(intf
->register_folder
);
731 debugfs_remove(intf
->dev_flags
);
732 debugfs_remove(intf
->chipset_entry
);
733 debugfs_remove(intf
->driver_entry
);
734 debugfs_remove(intf
->driver_folder
);
735 kfree(intf
->chipset_blob
.data
);
736 kfree(intf
->driver_blob
.data
);
739 rt2x00dev
->debugfs_intf
= NULL
;