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/uaccess.h>
34 #include "rt2x00lib.h"
35 #include "rt2x00dump.h"
37 #define MAX_LINE_LENGTH 64
39 struct rt2x00debug_crypto
{
40 unsigned long success
;
41 unsigned long icv_error
;
42 unsigned long mic_error
;
43 unsigned long key_error
;
46 struct rt2x00debug_intf
{
48 * Pointer to driver structure where
49 * this debugfs entry belongs to.
51 struct rt2x00_dev
*rt2x00dev
;
54 * Reference to the rt2x00debug structure
55 * which can be used to communicate with
58 const struct rt2x00debug
*debug
;
61 * Debugfs entries for:
67 * - csr offset/value files
68 * - eeprom offset/value files
69 * - bbp offset/value files
70 * - rf offset/value files
76 struct dentry
*driver_folder
;
77 struct dentry
*driver_entry
;
78 struct dentry
*chipset_entry
;
79 struct dentry
*dev_flags
;
80 struct dentry
*register_folder
;
81 struct dentry
*csr_off_entry
;
82 struct dentry
*csr_val_entry
;
83 struct dentry
*eeprom_off_entry
;
84 struct dentry
*eeprom_val_entry
;
85 struct dentry
*bbp_off_entry
;
86 struct dentry
*bbp_val_entry
;
87 struct dentry
*rf_off_entry
;
88 struct dentry
*rf_val_entry
;
89 struct dentry
*queue_folder
;
90 struct dentry
*queue_frame_dump_entry
;
91 struct dentry
*queue_stats_entry
;
92 struct dentry
*crypto_stats_entry
;
95 * The frame dump file only allows a single reader,
96 * so we need to store the current state here.
98 unsigned long frame_dump_flags
;
99 #define FRAME_DUMP_FILE_OPEN 1
102 * We queue each frame before dumping it to the user,
103 * per read command we will pass a single skb structure
104 * so we should be prepared to queue multiple sk buffers
105 * before sending it to userspace.
107 struct sk_buff_head frame_dump_skbqueue
;
108 wait_queue_head_t frame_dump_waitqueue
;
111 * HW crypto statistics.
112 * All statistics are stored seperately per cipher type.
114 struct rt2x00debug_crypto crypto_stats
[CIPHER_MAX
];
117 * Driver and chipset files will use a data buffer
118 * that has been created in advance. This will simplify
119 * the code since we can use the debugfs functions.
121 struct debugfs_blob_wrapper driver_blob
;
122 struct debugfs_blob_wrapper chipset_blob
;
125 * Requested offset for each register type.
127 unsigned int offset_csr
;
128 unsigned int offset_eeprom
;
129 unsigned int offset_bbp
;
130 unsigned int offset_rf
;
133 void rt2x00debug_update_crypto(struct rt2x00_dev
*rt2x00dev
,
134 struct rxdone_entry_desc
*rxdesc
)
136 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
137 enum cipher cipher
= rxdesc
->cipher
;
138 enum rx_crypto status
= rxdesc
->cipher_status
;
140 if (cipher
== CIPHER_TKIP_NO_MIC
)
141 cipher
= CIPHER_TKIP
;
142 if (cipher
== CIPHER_NONE
|| cipher
>= CIPHER_MAX
)
145 /* Remove CIPHER_NONE index */
148 intf
->crypto_stats
[cipher
].success
+= (status
== RX_CRYPTO_SUCCESS
);
149 intf
->crypto_stats
[cipher
].icv_error
+= (status
== RX_CRYPTO_FAIL_ICV
);
150 intf
->crypto_stats
[cipher
].mic_error
+= (status
== RX_CRYPTO_FAIL_MIC
);
151 intf
->crypto_stats
[cipher
].key_error
+= (status
== RX_CRYPTO_FAIL_KEY
);
154 void rt2x00debug_dump_frame(struct rt2x00_dev
*rt2x00dev
,
155 enum rt2x00_dump_type type
, struct sk_buff
*skb
)
157 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
158 struct skb_frame_desc
*desc
= get_skb_frame_desc(skb
);
159 struct sk_buff
*skbcopy
;
160 struct rt2x00dump_hdr
*dump_hdr
;
161 struct timeval timestamp
;
163 do_gettimeofday(×tamp
);
165 if (!test_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
))
168 if (skb_queue_len(&intf
->frame_dump_skbqueue
) > 20) {
169 DEBUG(rt2x00dev
, "txrx dump queue length exceeded.\n");
173 skbcopy
= alloc_skb(sizeof(*dump_hdr
) + desc
->desc_len
+ skb
->len
,
176 DEBUG(rt2x00dev
, "Failed to copy skb for dump.\n");
180 dump_hdr
= (struct rt2x00dump_hdr
*)skb_put(skbcopy
, sizeof(*dump_hdr
));
181 dump_hdr
->version
= cpu_to_le32(DUMP_HEADER_VERSION
);
182 dump_hdr
->header_length
= cpu_to_le32(sizeof(*dump_hdr
));
183 dump_hdr
->desc_length
= cpu_to_le32(desc
->desc_len
);
184 dump_hdr
->data_length
= cpu_to_le32(skb
->len
);
185 dump_hdr
->chip_rt
= cpu_to_le16(rt2x00dev
->chip
.rt
);
186 dump_hdr
->chip_rf
= cpu_to_le16(rt2x00dev
->chip
.rf
);
187 dump_hdr
->chip_rev
= cpu_to_le16(rt2x00dev
->chip
.rev
);
188 dump_hdr
->type
= cpu_to_le16(type
);
189 dump_hdr
->queue_index
= desc
->entry
->queue
->qid
;
190 dump_hdr
->entry_index
= desc
->entry
->entry_idx
;
191 dump_hdr
->timestamp_sec
= cpu_to_le32(timestamp
.tv_sec
);
192 dump_hdr
->timestamp_usec
= cpu_to_le32(timestamp
.tv_usec
);
194 memcpy(skb_put(skbcopy
, desc
->desc_len
), desc
->desc
, desc
->desc_len
);
195 memcpy(skb_put(skbcopy
, skb
->len
), skb
->data
, skb
->len
);
197 skb_queue_tail(&intf
->frame_dump_skbqueue
, skbcopy
);
198 wake_up_interruptible(&intf
->frame_dump_waitqueue
);
201 * Verify that the file has not been closed while we were working.
203 if (!test_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
))
204 skb_queue_purge(&intf
->frame_dump_skbqueue
);
207 static int rt2x00debug_file_open(struct inode
*inode
, struct file
*file
)
209 struct rt2x00debug_intf
*intf
= inode
->i_private
;
211 file
->private_data
= inode
->i_private
;
213 if (!try_module_get(intf
->debug
->owner
))
219 static int rt2x00debug_file_release(struct inode
*inode
, struct file
*file
)
221 struct rt2x00debug_intf
*intf
= file
->private_data
;
223 module_put(intf
->debug
->owner
);
228 static int rt2x00debug_open_queue_dump(struct inode
*inode
, struct file
*file
)
230 struct rt2x00debug_intf
*intf
= inode
->i_private
;
233 retval
= rt2x00debug_file_open(inode
, file
);
237 if (test_and_set_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
)) {
238 rt2x00debug_file_release(inode
, file
);
245 static int rt2x00debug_release_queue_dump(struct inode
*inode
, struct file
*file
)
247 struct rt2x00debug_intf
*intf
= inode
->i_private
;
249 skb_queue_purge(&intf
->frame_dump_skbqueue
);
251 clear_bit(FRAME_DUMP_FILE_OPEN
, &intf
->frame_dump_flags
);
253 return rt2x00debug_file_release(inode
, file
);
256 static ssize_t
rt2x00debug_read_queue_dump(struct file
*file
,
261 struct rt2x00debug_intf
*intf
= file
->private_data
;
266 if (file
->f_flags
& O_NONBLOCK
)
270 wait_event_interruptible(intf
->frame_dump_waitqueue
,
272 skb_dequeue(&intf
->frame_dump_skbqueue
)));
276 status
= min((size_t)skb
->len
, length
);
277 if (copy_to_user(buf
, skb
->data
, status
)) {
290 static unsigned int rt2x00debug_poll_queue_dump(struct file
*file
,
293 struct rt2x00debug_intf
*intf
= file
->private_data
;
295 poll_wait(file
, &intf
->frame_dump_waitqueue
, wait
);
297 if (!skb_queue_empty(&intf
->frame_dump_skbqueue
))
298 return POLLOUT
| POLLWRNORM
;
303 static const struct file_operations rt2x00debug_fop_queue_dump
= {
304 .owner
= THIS_MODULE
,
305 .read
= rt2x00debug_read_queue_dump
,
306 .poll
= rt2x00debug_poll_queue_dump
,
307 .open
= rt2x00debug_open_queue_dump
,
308 .release
= rt2x00debug_release_queue_dump
,
311 static ssize_t
rt2x00debug_read_queue_stats(struct file
*file
,
316 struct rt2x00debug_intf
*intf
= file
->private_data
;
317 struct data_queue
*queue
;
318 unsigned long irqflags
;
319 unsigned int lines
= 1 + intf
->rt2x00dev
->data_queues
;
327 data
= kzalloc(lines
* MAX_LINE_LENGTH
, GFP_KERNEL
);
332 sprintf(data
, "qid\tcount\tlimit\tlength\tindex\tdone\tcrypto\n");
334 queue_for_each(intf
->rt2x00dev
, queue
) {
335 spin_lock_irqsave(&queue
->lock
, irqflags
);
337 temp
+= sprintf(temp
, "%d\t%d\t%d\t%d\t%d\t%d\t%d\n", queue
->qid
,
338 queue
->count
, queue
->limit
, queue
->length
,
339 queue
->index
[Q_INDEX
],
340 queue
->index
[Q_INDEX_DONE
],
341 queue
->index
[Q_INDEX_CRYPTO
]);
343 spin_unlock_irqrestore(&queue
->lock
, irqflags
);
347 size
= min(size
, length
);
349 if (copy_to_user(buf
, data
, size
)) {
360 static const struct file_operations rt2x00debug_fop_queue_stats
= {
361 .owner
= THIS_MODULE
,
362 .read
= rt2x00debug_read_queue_stats
,
363 .open
= rt2x00debug_file_open
,
364 .release
= rt2x00debug_file_release
,
367 #ifdef CONFIG_RT2X00_LIB_CRYPTO
368 static ssize_t
rt2x00debug_read_crypto_stats(struct file
*file
,
373 struct rt2x00debug_intf
*intf
= file
->private_data
;
374 char *name
[] = { "WEP64", "WEP128", "TKIP", "AES" };
383 data
= kzalloc((1 + CIPHER_MAX
) * MAX_LINE_LENGTH
, GFP_KERNEL
);
388 temp
+= sprintf(data
, "cipher\tsuccess\ticv err\tmic err\tkey err\n");
390 for (i
= 0; i
< CIPHER_MAX
; i
++) {
391 temp
+= sprintf(temp
, "%s\t%lu\t%lu\t%lu\t%lu\n", name
[i
],
392 intf
->crypto_stats
[i
].success
,
393 intf
->crypto_stats
[i
].icv_error
,
394 intf
->crypto_stats
[i
].mic_error
,
395 intf
->crypto_stats
[i
].key_error
);
399 size
= min(size
, length
);
401 if (copy_to_user(buf
, data
, size
)) {
412 static const struct file_operations rt2x00debug_fop_crypto_stats
= {
413 .owner
= THIS_MODULE
,
414 .read
= rt2x00debug_read_crypto_stats
,
415 .open
= rt2x00debug_file_open
,
416 .release
= rt2x00debug_file_release
,
420 #define RT2X00DEBUGFS_OPS_READ(__name, __format, __type) \
421 static ssize_t rt2x00debug_read_##__name(struct file *file, \
426 struct rt2x00debug_intf *intf = file->private_data; \
427 const struct rt2x00debug *debug = intf->debug; \
430 unsigned int index = intf->offset_##__name; \
436 if (index >= debug->__name.word_count) \
439 index += (debug->__name.word_base / \
440 debug->__name.word_size); \
442 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
443 index *= debug->__name.word_size; \
445 debug->__name.read(intf->rt2x00dev, index, &value); \
447 size = sprintf(line, __format, value); \
449 if (copy_to_user(buf, line, size)) \
456 #define RT2X00DEBUGFS_OPS_WRITE(__name, __type) \
457 static ssize_t rt2x00debug_write_##__name(struct file *file, \
458 const char __user *buf,\
462 struct rt2x00debug_intf *intf = file->private_data; \
463 const struct rt2x00debug *debug = intf->debug; \
466 unsigned int index = intf->offset_##__name; \
472 if (index >= debug->__name.word_count) \
475 if (copy_from_user(line, buf, length)) \
478 size = strlen(line); \
479 value = simple_strtoul(line, NULL, 0); \
481 index += (debug->__name.word_base / \
482 debug->__name.word_size); \
484 if (debug->__name.flags & RT2X00DEBUGFS_OFFSET) \
485 index *= debug->__name.word_size; \
487 debug->__name.write(intf->rt2x00dev, index, value); \
493 #define RT2X00DEBUGFS_OPS(__name, __format, __type) \
494 RT2X00DEBUGFS_OPS_READ(__name, __format, __type); \
495 RT2X00DEBUGFS_OPS_WRITE(__name, __type); \
497 static const struct file_operations rt2x00debug_fop_##__name = {\
498 .owner = THIS_MODULE, \
499 .read = rt2x00debug_read_##__name, \
500 .write = rt2x00debug_write_##__name, \
501 .open = rt2x00debug_file_open, \
502 .release = rt2x00debug_file_release, \
505 RT2X00DEBUGFS_OPS(csr
, "0x%.8x\n", u32
);
506 RT2X00DEBUGFS_OPS(eeprom
, "0x%.4x\n", u16
);
507 RT2X00DEBUGFS_OPS(bbp
, "0x%.2x\n", u8
);
508 RT2X00DEBUGFS_OPS(rf
, "0x%.8x\n", u32
);
510 static ssize_t
rt2x00debug_read_dev_flags(struct file
*file
,
515 struct rt2x00debug_intf
*intf
= file
->private_data
;
522 size
= sprintf(line
, "0x%.8x\n", (unsigned int)intf
->rt2x00dev
->flags
);
524 if (copy_to_user(buf
, line
, size
))
531 static const struct file_operations rt2x00debug_fop_dev_flags
= {
532 .owner
= THIS_MODULE
,
533 .read
= rt2x00debug_read_dev_flags
,
534 .open
= rt2x00debug_file_open
,
535 .release
= rt2x00debug_file_release
,
538 static struct dentry
*rt2x00debug_create_file_driver(const char *name
,
539 struct rt2x00debug_intf
541 struct debugfs_blob_wrapper
546 data
= kzalloc(3 * MAX_LINE_LENGTH
, GFP_KERNEL
);
551 data
+= sprintf(data
, "driver:\t%s\n", intf
->rt2x00dev
->ops
->name
);
552 data
+= sprintf(data
, "version:\t%s\n", DRV_VERSION
);
553 data
+= sprintf(data
, "compiled:\t%s %s\n", __DATE__
, __TIME__
);
554 blob
->size
= strlen(blob
->data
);
556 return debugfs_create_blob(name
, S_IRUSR
, intf
->driver_folder
, blob
);
559 static struct dentry
*rt2x00debug_create_file_chipset(const char *name
,
560 struct rt2x00debug_intf
566 const struct rt2x00debug
*debug
= intf
->debug
;
569 data
= kzalloc(8 * MAX_LINE_LENGTH
, GFP_KERNEL
);
574 data
+= sprintf(data
, "rt chip:\t%04x\n", intf
->rt2x00dev
->chip
.rt
);
575 data
+= sprintf(data
, "rf chip:\t%04x\n", intf
->rt2x00dev
->chip
.rf
);
576 data
+= sprintf(data
, "revision:\t%04x\n", intf
->rt2x00dev
->chip
.rev
);
577 data
+= sprintf(data
, "\n");
578 data
+= sprintf(data
, "register\tbase\twords\twordsize\n");
579 data
+= sprintf(data
, "csr\t%d\t%d\t%d\n",
580 debug
->csr
.word_base
,
581 debug
->csr
.word_count
,
582 debug
->csr
.word_size
);
583 data
+= sprintf(data
, "eeprom\t%d\t%d\t%d\n",
584 debug
->eeprom
.word_base
,
585 debug
->eeprom
.word_count
,
586 debug
->eeprom
.word_size
);
587 data
+= sprintf(data
, "bbp\t%d\t%d\t%d\n",
588 debug
->bbp
.word_base
,
589 debug
->bbp
.word_count
,
590 debug
->bbp
.word_size
);
591 data
+= sprintf(data
, "rf\t%d\t%d\t%d\n",
593 debug
->rf
.word_count
,
594 debug
->rf
.word_size
);
595 blob
->size
= strlen(blob
->data
);
597 return debugfs_create_blob(name
, S_IRUSR
, intf
->driver_folder
, blob
);
600 void rt2x00debug_register(struct rt2x00_dev
*rt2x00dev
)
602 const struct rt2x00debug
*debug
= rt2x00dev
->ops
->debugfs
;
603 struct rt2x00debug_intf
*intf
;
605 intf
= kzalloc(sizeof(struct rt2x00debug_intf
), GFP_KERNEL
);
607 ERROR(rt2x00dev
, "Failed to allocate debug handler.\n");
612 intf
->rt2x00dev
= rt2x00dev
;
613 rt2x00dev
->debugfs_intf
= intf
;
615 intf
->driver_folder
=
616 debugfs_create_dir(intf
->rt2x00dev
->ops
->name
,
617 rt2x00dev
->hw
->wiphy
->debugfsdir
);
618 if (IS_ERR(intf
->driver_folder
) || !intf
->driver_folder
)
622 rt2x00debug_create_file_driver("driver", intf
, &intf
->driver_blob
);
623 if (IS_ERR(intf
->driver_entry
) || !intf
->driver_entry
)
626 intf
->chipset_entry
=
627 rt2x00debug_create_file_chipset("chipset",
628 intf
, &intf
->chipset_blob
);
629 if (IS_ERR(intf
->chipset_entry
) || !intf
->chipset_entry
)
632 intf
->dev_flags
= debugfs_create_file("dev_flags", S_IRUSR
,
633 intf
->driver_folder
, intf
,
634 &rt2x00debug_fop_dev_flags
);
635 if (IS_ERR(intf
->dev_flags
) || !intf
->dev_flags
)
638 intf
->register_folder
=
639 debugfs_create_dir("register", intf
->driver_folder
);
640 if (IS_ERR(intf
->register_folder
) || !intf
->register_folder
)
643 #define RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(__intf, __name) \
645 (__intf)->__name##_off_entry = \
646 debugfs_create_u32(__stringify(__name) "_offset", \
648 (__intf)->register_folder, \
649 &(__intf)->offset_##__name); \
650 if (IS_ERR((__intf)->__name##_off_entry) \
651 || !(__intf)->__name##_off_entry) \
654 (__intf)->__name##_val_entry = \
655 debugfs_create_file(__stringify(__name) "_value", \
657 (__intf)->register_folder, \
658 (__intf), &rt2x00debug_fop_##__name);\
659 if (IS_ERR((__intf)->__name##_val_entry) \
660 || !(__intf)->__name##_val_entry) \
664 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, csr
);
665 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, eeprom
);
666 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, bbp
);
667 RT2X00DEBUGFS_CREATE_REGISTER_ENTRY(intf
, rf
);
669 #undef RT2X00DEBUGFS_CREATE_REGISTER_ENTRY
672 debugfs_create_dir("queue", intf
->driver_folder
);
673 if (IS_ERR(intf
->queue_folder
) || !intf
->queue_folder
)
676 intf
->queue_frame_dump_entry
=
677 debugfs_create_file("dump", S_IRUSR
, intf
->queue_folder
,
678 intf
, &rt2x00debug_fop_queue_dump
);
679 if (IS_ERR(intf
->queue_frame_dump_entry
)
680 || !intf
->queue_frame_dump_entry
)
683 skb_queue_head_init(&intf
->frame_dump_skbqueue
);
684 init_waitqueue_head(&intf
->frame_dump_waitqueue
);
686 intf
->queue_stats_entry
=
687 debugfs_create_file("queue", S_IRUSR
, intf
->queue_folder
,
688 intf
, &rt2x00debug_fop_queue_stats
);
690 #ifdef CONFIG_RT2X00_LIB_CRYPTO
691 if (test_bit(CONFIG_SUPPORT_HW_CRYPTO
, &rt2x00dev
->flags
))
692 intf
->crypto_stats_entry
=
693 debugfs_create_file("crypto", S_IRUGO
, intf
->queue_folder
,
694 intf
, &rt2x00debug_fop_crypto_stats
);
700 rt2x00debug_deregister(rt2x00dev
);
701 ERROR(rt2x00dev
, "Failed to register debug handler.\n");
706 void rt2x00debug_deregister(struct rt2x00_dev
*rt2x00dev
)
708 struct rt2x00debug_intf
*intf
= rt2x00dev
->debugfs_intf
;
713 skb_queue_purge(&intf
->frame_dump_skbqueue
);
715 #ifdef CONFIG_RT2X00_LIB_CRYPTO
716 debugfs_remove(intf
->crypto_stats_entry
);
718 debugfs_remove(intf
->queue_stats_entry
);
719 debugfs_remove(intf
->queue_frame_dump_entry
);
720 debugfs_remove(intf
->queue_folder
);
721 debugfs_remove(intf
->rf_val_entry
);
722 debugfs_remove(intf
->rf_off_entry
);
723 debugfs_remove(intf
->bbp_val_entry
);
724 debugfs_remove(intf
->bbp_off_entry
);
725 debugfs_remove(intf
->eeprom_val_entry
);
726 debugfs_remove(intf
->eeprom_off_entry
);
727 debugfs_remove(intf
->csr_val_entry
);
728 debugfs_remove(intf
->csr_off_entry
);
729 debugfs_remove(intf
->register_folder
);
730 debugfs_remove(intf
->dev_flags
);
731 debugfs_remove(intf
->chipset_entry
);
732 debugfs_remove(intf
->driver_entry
);
733 debugfs_remove(intf
->driver_folder
);
734 kfree(intf
->chipset_blob
.data
);
735 kfree(intf
->driver_blob
.data
);
738 rt2x00dev
->debugfs_intf
= NULL
;