2 * The USB Monitor, inspired by Dave Harding's USBMon.
4 * This is a binary format reader.
6 * Copyright (C) 2006 Paolo Abeni (paolo.abeni@email.it)
7 * Copyright (C) 2006,2007 Pete Zaitcev (zaitcev@redhat.com)
10 #include <linux/kernel.h>
11 #include <linux/types.h>
13 #include <linux/cdev.h>
14 #include <linux/usb.h>
15 #include <linux/poll.h>
16 #include <linux/compat.h>
19 #include <asm/uaccess.h>
24 * Defined by USB 2.0 clause 9.3, table 9.2.
29 #define MON_IOC_MAGIC 0x92
31 #define MON_IOCQ_URB_LEN _IO(MON_IOC_MAGIC, 1)
32 /* #2 used to be MON_IOCX_URB, removed before it got into Linus tree */
33 #define MON_IOCG_STATS _IOR(MON_IOC_MAGIC, 3, struct mon_bin_stats)
34 #define MON_IOCT_RING_SIZE _IO(MON_IOC_MAGIC, 4)
35 #define MON_IOCQ_RING_SIZE _IO(MON_IOC_MAGIC, 5)
36 #define MON_IOCX_GET _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get)
37 #define MON_IOCX_MFETCH _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch)
38 #define MON_IOCH_MFLUSH _IO(MON_IOC_MAGIC, 8)
40 #define MON_IOCX_GET32 _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get32)
41 #define MON_IOCX_MFETCH32 _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch32)
45 * Some architectures have enormous basic pages (16KB for ia64, 64KB for ppc).
46 * But it's all right. Just use a simple way to make sure the chunk is never
47 * smaller than a page.
49 * N.B. An application does not know our chunk size.
51 * Woops, get_zeroed_page() returns a single page. I guess we're stuck with
52 * page-sized chunks for the time being.
54 #define CHUNK_SIZE PAGE_SIZE
55 #define CHUNK_ALIGN(x) (((x)+CHUNK_SIZE-1) & ~(CHUNK_SIZE-1))
58 * The magic limit was calculated so that it allows the monitoring
59 * application to pick data once in two ticks. This way, another application,
60 * which presumably drives the bus, gets to hog CPU, yet we collect our data.
61 * If HZ is 100, a 480 mbit/s bus drives 614 KB every jiffy. USB has an
62 * enormous overhead built into the bus protocol, so we need about 1000 KB.
64 * This is still too much for most cases, where we just snoop a few
65 * descriptor fetches for enumeration. So, the default is a "reasonable"
66 * amount for systems with HZ=250 and incomplete bus saturation.
68 * XXX What about multi-megabyte URBs which take minutes to transfer?
70 #define BUFF_MAX CHUNK_ALIGN(1200*1024)
71 #define BUFF_DFL CHUNK_ALIGN(300*1024)
72 #define BUFF_MIN CHUNK_ALIGN(8*1024)
75 * The per-event API header (2 per URB).
77 * This structure is seen in userland as defined by the documentation.
80 u64 id
; /* URB ID - from submission to callback */
81 unsigned char type
; /* Same as in text API; extensible. */
82 unsigned char xfer_type
; /* ISO, Intr, Control, Bulk */
83 unsigned char epnum
; /* Endpoint number and transfer direction */
84 unsigned char devnum
; /* Device address */
85 unsigned short busnum
; /* Bus number */
88 s64 ts_sec
; /* gettimeofday */
89 s32 ts_usec
; /* gettimeofday */
91 unsigned int len_urb
; /* Length of data (submitted or actual) */
92 unsigned int len_cap
; /* Delivered length */
93 unsigned char setup
[SETUP_LEN
]; /* Only for Control S-type */
96 /* per file statistic */
97 struct mon_bin_stats
{
103 struct mon_bin_hdr __user
*hdr
; /* Only 48 bytes, not 64. */
105 size_t alloc
; /* Length of data (can be zero) */
108 struct mon_bin_mfetch
{
109 u32 __user
*offvec
; /* Vector of events fetched */
110 u32 nfetch
; /* Number of events to fetch (out: fetched) */
111 u32 nflush
; /* Number of events to flush */
115 struct mon_bin_get32
{
121 struct mon_bin_mfetch32
{
128 /* Having these two values same prevents wrapping of the mon_bin_hdr */
132 /* max number of USB bus supported */
133 #define MON_BIN_MAX_MINOR 128
136 * The buffer: map of used pages.
140 unsigned char *ptr
; /* XXX just use page_to_virt everywhere? */
144 * This gets associated with an open file struct.
146 struct mon_reader_bin
{
147 /* The buffer: one per open. */
148 spinlock_t b_lock
; /* Protect b_cnt, b_in */
149 unsigned int b_size
; /* Current size of the buffer - bytes */
150 unsigned int b_cnt
; /* Bytes used */
151 unsigned int b_in
, b_out
; /* Offsets into buffer - bytes */
152 unsigned int b_read
; /* Amount of read data in curr. pkt. */
153 struct mon_pgmap
*b_vec
; /* The map array */
154 wait_queue_head_t b_wait
; /* Wait for data here */
156 struct mutex fetch_lock
; /* Protect b_read, b_out */
159 /* A list of these is needed for "bus 0". Some time later. */
163 unsigned int cnt_lost
;
166 static inline struct mon_bin_hdr
*MON_OFF2HDR(const struct mon_reader_bin
*rp
,
169 return (struct mon_bin_hdr
*)
170 (rp
->b_vec
[offset
/ CHUNK_SIZE
].ptr
+ offset
% CHUNK_SIZE
);
173 #define MON_RING_EMPTY(rp) ((rp)->b_cnt == 0)
175 static struct class *mon_bin_class
;
176 static dev_t mon_bin_dev0
;
177 static struct cdev mon_bin_cdev
;
179 static void mon_buff_area_fill(const struct mon_reader_bin
*rp
,
180 unsigned int offset
, unsigned int size
);
181 static int mon_bin_wait_event(struct file
*file
, struct mon_reader_bin
*rp
);
182 static int mon_alloc_buff(struct mon_pgmap
*map
, int npages
);
183 static void mon_free_buff(struct mon_pgmap
*map
, int npages
);
186 * This is a "chunked memcpy". It does not manipulate any counters.
187 * But it returns the new offset for repeated application.
189 unsigned int mon_copy_to_buff(const struct mon_reader_bin
*this,
190 unsigned int off
, const unsigned char *from
, unsigned int length
)
192 unsigned int step_len
;
194 unsigned int in_page
;
198 * Determine step_len.
201 in_page
= CHUNK_SIZE
- (off
& (CHUNK_SIZE
-1));
202 if (in_page
< step_len
)
206 * Copy data and advance pointers.
208 buf
= this->b_vec
[off
/ CHUNK_SIZE
].ptr
+ off
% CHUNK_SIZE
;
209 memcpy(buf
, from
, step_len
);
210 if ((off
+= step_len
) >= this->b_size
) off
= 0;
218 * This is a little worse than the above because it's "chunked copy_to_user".
219 * The return value is an error code, not an offset.
221 static int copy_from_buf(const struct mon_reader_bin
*this, unsigned int off
,
222 char __user
*to
, int length
)
224 unsigned int step_len
;
226 unsigned int in_page
;
230 * Determine step_len.
233 in_page
= CHUNK_SIZE
- (off
& (CHUNK_SIZE
-1));
234 if (in_page
< step_len
)
238 * Copy data and advance pointers.
240 buf
= this->b_vec
[off
/ CHUNK_SIZE
].ptr
+ off
% CHUNK_SIZE
;
241 if (copy_to_user(to
, buf
, step_len
))
243 if ((off
+= step_len
) >= this->b_size
) off
= 0;
251 * Allocate an (aligned) area in the buffer.
252 * This is called under b_lock.
253 * Returns ~0 on failure.
255 static unsigned int mon_buff_area_alloc(struct mon_reader_bin
*rp
,
260 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
261 if (rp
->b_cnt
+ size
> rp
->b_size
)
265 if ((rp
->b_in
+= size
) >= rp
->b_size
)
266 rp
->b_in
-= rp
->b_size
;
271 * This is the same thing as mon_buff_area_alloc, only it does not allow
272 * buffers to wrap. This is needed by applications which pass references
273 * into mmap-ed buffers up their stacks (libpcap can do that).
275 * Currently, we always have the header stuck with the data, although
276 * it is not strictly speaking necessary.
278 * When a buffer would wrap, we place a filler packet to mark the space.
280 static unsigned int mon_buff_area_alloc_contiguous(struct mon_reader_bin
*rp
,
284 unsigned int fill_size
;
286 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
287 if (rp
->b_cnt
+ size
> rp
->b_size
)
289 if (rp
->b_in
+ size
> rp
->b_size
) {
291 * This would wrap. Find if we still have space after
292 * skipping to the end of the buffer. If we do, place
293 * a filler packet and allocate a new packet.
295 fill_size
= rp
->b_size
- rp
->b_in
;
296 if (rp
->b_cnt
+ size
+ fill_size
> rp
->b_size
)
298 mon_buff_area_fill(rp
, rp
->b_in
, fill_size
);
302 rp
->b_cnt
+= size
+ fill_size
;
303 } else if (rp
->b_in
+ size
== rp
->b_size
) {
316 * Return a few (kilo-)bytes to the head of the buffer.
317 * This is used if a DMA fetch fails.
319 static void mon_buff_area_shrink(struct mon_reader_bin
*rp
, unsigned int size
)
322 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
325 rp
->b_in
+= rp
->b_size
;
330 * This has to be called under both b_lock and fetch_lock, because
331 * it accesses both b_cnt and b_out.
333 static void mon_buff_area_free(struct mon_reader_bin
*rp
, unsigned int size
)
336 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
338 if ((rp
->b_out
+= size
) >= rp
->b_size
)
339 rp
->b_out
-= rp
->b_size
;
342 static void mon_buff_area_fill(const struct mon_reader_bin
*rp
,
343 unsigned int offset
, unsigned int size
)
345 struct mon_bin_hdr
*ep
;
347 ep
= MON_OFF2HDR(rp
, offset
);
348 memset(ep
, 0, PKT_SIZE
);
350 ep
->len_cap
= size
- PKT_SIZE
;
353 static inline char mon_bin_get_setup(unsigned char *setupb
,
354 const struct urb
*urb
, char ev_type
)
357 if (!usb_endpoint_xfer_control(&urb
->ep
->desc
) || ev_type
!= 'S')
360 if (urb
->dev
->bus
->uses_dma
&&
361 (urb
->transfer_flags
& URB_NO_SETUP_DMA_MAP
)) {
362 return mon_dmapeek(setupb
, urb
->setup_dma
, SETUP_LEN
);
364 if (urb
->setup_packet
== NULL
)
367 memcpy(setupb
, urb
->setup_packet
, SETUP_LEN
);
371 static char mon_bin_get_data(const struct mon_reader_bin
*rp
,
372 unsigned int offset
, struct urb
*urb
, unsigned int length
)
375 if (urb
->dev
->bus
->uses_dma
&&
376 (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)) {
377 mon_dmapeek_vec(rp
, offset
, urb
->transfer_dma
, length
);
381 if (urb
->transfer_buffer
== NULL
)
384 mon_copy_to_buff(rp
, offset
, urb
->transfer_buffer
, length
);
388 static void mon_bin_event(struct mon_reader_bin
*rp
, struct urb
*urb
,
393 unsigned int urb_length
;
396 struct mon_bin_hdr
*ep
;
399 do_gettimeofday(&ts
);
401 spin_lock_irqsave(&rp
->b_lock
, flags
);
404 * Find the maximum allowable length, then allocate space.
406 urb_length
= (ev_type
== 'S') ?
407 urb
->transfer_buffer_length
: urb
->actual_length
;
410 if (length
>= rp
->b_size
/5)
411 length
= rp
->b_size
/5;
413 if (usb_urb_dir_in(urb
)) {
414 if (ev_type
== 'S') {
419 if (ev_type
== 'C') {
426 offset
= mon_buff_area_alloc_contiguous(rp
, length
+ PKT_SIZE
);
428 offset
= mon_buff_area_alloc(rp
, length
+ PKT_SIZE
);
431 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
435 ep
= MON_OFF2HDR(rp
, offset
);
436 if ((offset
+= PKT_SIZE
) >= rp
->b_size
) offset
= 0;
439 * Fill the allocated area.
441 memset(ep
, 0, PKT_SIZE
);
443 switch (usb_endpoint_type(&urb
->ep
->desc
)) {
444 case USB_ENDPOINT_XFER_CONTROL
:
445 ep
->xfer_type
= PIPE_CONTROL
;
447 case USB_ENDPOINT_XFER_BULK
:
448 ep
->xfer_type
= PIPE_BULK
;
450 case USB_ENDPOINT_XFER_INT
:
451 ep
->xfer_type
= PIPE_INTERRUPT
;
454 ep
->xfer_type
= PIPE_ISOCHRONOUS
;
457 ep
->epnum
= urb
->ep
->desc
.bEndpointAddress
;
458 ep
->devnum
= urb
->dev
->devnum
;
459 ep
->busnum
= urb
->dev
->bus
->busnum
;
460 ep
->id
= (unsigned long) urb
;
461 ep
->ts_sec
= ts
.tv_sec
;
462 ep
->ts_usec
= ts
.tv_usec
;
463 ep
->status
= urb
->status
;
464 ep
->len_urb
= urb_length
;
465 ep
->len_cap
= length
;
467 ep
->flag_setup
= mon_bin_get_setup(ep
->setup
, urb
, ev_type
);
469 ep
->flag_data
= mon_bin_get_data(rp
, offset
, urb
, length
);
470 if (ep
->flag_data
!= 0) { /* Yes, it's 0x00, not '0' */
472 mon_buff_area_shrink(rp
, length
);
475 ep
->flag_data
= data_tag
;
478 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
480 wake_up(&rp
->b_wait
);
483 static void mon_bin_submit(void *data
, struct urb
*urb
)
485 struct mon_reader_bin
*rp
= data
;
486 mon_bin_event(rp
, urb
, 'S');
489 static void mon_bin_complete(void *data
, struct urb
*urb
)
491 struct mon_reader_bin
*rp
= data
;
492 mon_bin_event(rp
, urb
, 'C');
495 static void mon_bin_error(void *data
, struct urb
*urb
, int error
)
497 struct mon_reader_bin
*rp
= data
;
500 struct mon_bin_hdr
*ep
;
502 spin_lock_irqsave(&rp
->b_lock
, flags
);
504 offset
= mon_buff_area_alloc(rp
, PKT_SIZE
);
506 /* Not incrementing cnt_lost. Just because. */
507 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
511 ep
= MON_OFF2HDR(rp
, offset
);
513 memset(ep
, 0, PKT_SIZE
);
515 switch (usb_endpoint_type(&urb
->ep
->desc
)) {
516 case USB_ENDPOINT_XFER_CONTROL
:
517 ep
->xfer_type
= PIPE_CONTROL
;
519 case USB_ENDPOINT_XFER_BULK
:
520 ep
->xfer_type
= PIPE_BULK
;
522 case USB_ENDPOINT_XFER_INT
:
523 ep
->xfer_type
= PIPE_INTERRUPT
;
526 ep
->xfer_type
= PIPE_ISOCHRONOUS
;
529 ep
->epnum
= urb
->ep
->desc
.bEndpointAddress
;
530 ep
->devnum
= urb
->dev
->devnum
;
531 ep
->busnum
= urb
->dev
->bus
->busnum
;
532 ep
->id
= (unsigned long) urb
;
535 ep
->flag_setup
= '-';
538 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
540 wake_up(&rp
->b_wait
);
543 static int mon_bin_open(struct inode
*inode
, struct file
*file
)
545 struct mon_bus
*mbus
;
546 struct mon_reader_bin
*rp
;
550 mutex_lock(&mon_lock
);
551 if ((mbus
= mon_bus_lookup(iminor(inode
))) == NULL
) {
552 mutex_unlock(&mon_lock
);
555 if (mbus
!= &mon_bus0
&& mbus
->u_bus
== NULL
) {
556 printk(KERN_ERR TAG
": consistency error on open\n");
557 mutex_unlock(&mon_lock
);
561 rp
= kzalloc(sizeof(struct mon_reader_bin
), GFP_KERNEL
);
566 spin_lock_init(&rp
->b_lock
);
567 init_waitqueue_head(&rp
->b_wait
);
568 mutex_init(&rp
->fetch_lock
);
570 rp
->b_size
= BUFF_DFL
;
572 size
= sizeof(struct mon_pgmap
) * (rp
->b_size
/CHUNK_SIZE
);
573 if ((rp
->b_vec
= kzalloc(size
, GFP_KERNEL
)) == NULL
) {
578 if ((rc
= mon_alloc_buff(rp
->b_vec
, rp
->b_size
/CHUNK_SIZE
)) < 0)
583 rp
->r
.rnf_submit
= mon_bin_submit
;
584 rp
->r
.rnf_error
= mon_bin_error
;
585 rp
->r
.rnf_complete
= mon_bin_complete
;
587 mon_reader_add(mbus
, &rp
->r
);
589 file
->private_data
= rp
;
590 mutex_unlock(&mon_lock
);
598 mutex_unlock(&mon_lock
);
603 * Extract an event from buffer and copy it to user space.
604 * Wait if there is no event ready.
605 * Returns zero or error.
607 static int mon_bin_get_event(struct file
*file
, struct mon_reader_bin
*rp
,
608 struct mon_bin_hdr __user
*hdr
, void __user
*data
, unsigned int nbytes
)
611 struct mon_bin_hdr
*ep
;
616 mutex_lock(&rp
->fetch_lock
);
618 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
619 mutex_unlock(&rp
->fetch_lock
);
623 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
625 if (copy_to_user(hdr
, ep
, sizeof(struct mon_bin_hdr
))) {
626 mutex_unlock(&rp
->fetch_lock
);
630 step_len
= min(ep
->len_cap
, nbytes
);
631 if ((offset
= rp
->b_out
+ PKT_SIZE
) >= rp
->b_size
) offset
= 0;
633 if (copy_from_buf(rp
, offset
, data
, step_len
)) {
634 mutex_unlock(&rp
->fetch_lock
);
638 spin_lock_irqsave(&rp
->b_lock
, flags
);
639 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
640 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
643 mutex_unlock(&rp
->fetch_lock
);
647 static int mon_bin_release(struct inode
*inode
, struct file
*file
)
649 struct mon_reader_bin
*rp
= file
->private_data
;
650 struct mon_bus
* mbus
= rp
->r
.m_bus
;
652 mutex_lock(&mon_lock
);
654 if (mbus
->nreaders
<= 0) {
655 printk(KERN_ERR TAG
": consistency error on close\n");
656 mutex_unlock(&mon_lock
);
659 mon_reader_del(mbus
, &rp
->r
);
661 mon_free_buff(rp
->b_vec
, rp
->b_size
/CHUNK_SIZE
);
665 mutex_unlock(&mon_lock
);
669 static ssize_t
mon_bin_read(struct file
*file
, char __user
*buf
,
670 size_t nbytes
, loff_t
*ppos
)
672 struct mon_reader_bin
*rp
= file
->private_data
;
674 struct mon_bin_hdr
*ep
;
681 mutex_lock(&rp
->fetch_lock
);
683 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
684 mutex_unlock(&rp
->fetch_lock
);
688 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
690 if (rp
->b_read
< sizeof(struct mon_bin_hdr
)) {
691 step_len
= min(nbytes
, sizeof(struct mon_bin_hdr
) - rp
->b_read
);
692 ptr
= ((char *)ep
) + rp
->b_read
;
693 if (step_len
&& copy_to_user(buf
, ptr
, step_len
)) {
694 mutex_unlock(&rp
->fetch_lock
);
699 rp
->b_read
+= step_len
;
703 if (rp
->b_read
>= sizeof(struct mon_bin_hdr
)) {
704 step_len
= min(nbytes
, (size_t)ep
->len_cap
);
705 offset
= rp
->b_out
+ PKT_SIZE
;
706 offset
+= rp
->b_read
- sizeof(struct mon_bin_hdr
);
707 if (offset
>= rp
->b_size
)
708 offset
-= rp
->b_size
;
709 if (copy_from_buf(rp
, offset
, buf
, step_len
)) {
710 mutex_unlock(&rp
->fetch_lock
);
715 rp
->b_read
+= step_len
;
720 * Check if whole packet was read, and if so, jump to the next one.
722 if (rp
->b_read
>= sizeof(struct mon_bin_hdr
) + ep
->len_cap
) {
723 spin_lock_irqsave(&rp
->b_lock
, flags
);
724 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
725 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
729 mutex_unlock(&rp
->fetch_lock
);
734 * Remove at most nevents from chunked buffer.
735 * Returns the number of removed events.
737 static int mon_bin_flush(struct mon_reader_bin
*rp
, unsigned nevents
)
740 struct mon_bin_hdr
*ep
;
743 mutex_lock(&rp
->fetch_lock
);
744 spin_lock_irqsave(&rp
->b_lock
, flags
);
745 for (i
= 0; i
< nevents
; ++i
) {
746 if (MON_RING_EMPTY(rp
))
749 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
750 mon_buff_area_free(rp
, PKT_SIZE
+ ep
->len_cap
);
752 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
754 mutex_unlock(&rp
->fetch_lock
);
759 * Fetch at most max event offsets into the buffer and put them into vec.
760 * The events are usually freed later with mon_bin_flush.
761 * Return the effective number of events fetched.
763 static int mon_bin_fetch(struct file
*file
, struct mon_reader_bin
*rp
,
764 u32 __user
*vec
, unsigned int max
)
766 unsigned int cur_out
;
767 unsigned int bytes
, avail
;
769 unsigned int nevents
;
770 struct mon_bin_hdr
*ep
;
774 mutex_lock(&rp
->fetch_lock
);
776 if ((rc
= mon_bin_wait_event(file
, rp
)) < 0) {
777 mutex_unlock(&rp
->fetch_lock
);
781 spin_lock_irqsave(&rp
->b_lock
, flags
);
783 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
788 while (bytes
< avail
) {
792 ep
= MON_OFF2HDR(rp
, cur_out
);
793 if (put_user(cur_out
, &vec
[nevents
])) {
794 mutex_unlock(&rp
->fetch_lock
);
799 size
= ep
->len_cap
+ PKT_SIZE
;
800 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
801 if ((cur_out
+= size
) >= rp
->b_size
)
802 cur_out
-= rp
->b_size
;
806 mutex_unlock(&rp
->fetch_lock
);
811 * Count events. This is almost the same as the above mon_bin_fetch,
812 * only we do not store offsets into user vector, and we have no limit.
814 static int mon_bin_queued(struct mon_reader_bin
*rp
)
816 unsigned int cur_out
;
817 unsigned int bytes
, avail
;
819 unsigned int nevents
;
820 struct mon_bin_hdr
*ep
;
823 mutex_lock(&rp
->fetch_lock
);
825 spin_lock_irqsave(&rp
->b_lock
, flags
);
827 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
832 while (bytes
< avail
) {
833 ep
= MON_OFF2HDR(rp
, cur_out
);
836 size
= ep
->len_cap
+ PKT_SIZE
;
837 size
= (size
+ PKT_ALIGN
-1) & ~(PKT_ALIGN
-1);
838 if ((cur_out
+= size
) >= rp
->b_size
)
839 cur_out
-= rp
->b_size
;
843 mutex_unlock(&rp
->fetch_lock
);
849 static int mon_bin_ioctl(struct inode
*inode
, struct file
*file
,
850 unsigned int cmd
, unsigned long arg
)
852 struct mon_reader_bin
*rp
= file
->private_data
;
853 // struct mon_bus* mbus = rp->r.m_bus;
855 struct mon_bin_hdr
*ep
;
860 case MON_IOCQ_URB_LEN
:
862 * N.B. This only returns the size of data, without the header.
864 spin_lock_irqsave(&rp
->b_lock
, flags
);
865 if (!MON_RING_EMPTY(rp
)) {
866 ep
= MON_OFF2HDR(rp
, rp
->b_out
);
869 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
872 case MON_IOCQ_RING_SIZE
:
876 case MON_IOCT_RING_SIZE
:
878 * Changing the buffer size will flush it's contents; the new
879 * buffer is allocated before releasing the old one to be sure
880 * the device will stay functional also in case of memory
885 struct mon_pgmap
*vec
;
887 if (arg
< BUFF_MIN
|| arg
> BUFF_MAX
)
890 size
= CHUNK_ALIGN(arg
);
891 if ((vec
= kzalloc(sizeof(struct mon_pgmap
) * (size
/CHUNK_SIZE
),
892 GFP_KERNEL
)) == NULL
) {
897 ret
= mon_alloc_buff(vec
, size
/CHUNK_SIZE
);
903 mutex_lock(&rp
->fetch_lock
);
904 spin_lock_irqsave(&rp
->b_lock
, flags
);
905 mon_free_buff(rp
->b_vec
, size
/CHUNK_SIZE
);
909 rp
->b_read
= rp
->b_in
= rp
->b_out
= rp
->b_cnt
= 0;
911 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
912 mutex_unlock(&rp
->fetch_lock
);
916 case MON_IOCH_MFLUSH
:
917 ret
= mon_bin_flush(rp
, arg
);
922 struct mon_bin_get getb
;
924 if (copy_from_user(&getb
, (void __user
*)arg
,
925 sizeof(struct mon_bin_get
)))
928 if (getb
.alloc
> 0x10000000) /* Want to cast to u32 */
930 ret
= mon_bin_get_event(file
, rp
,
931 getb
.hdr
, getb
.data
, (unsigned int)getb
.alloc
);
936 case MON_IOCX_GET32
: {
937 struct mon_bin_get32 getb
;
939 if (copy_from_user(&getb
, (void __user
*)arg
,
940 sizeof(struct mon_bin_get32
)))
943 ret
= mon_bin_get_event(file
, rp
,
944 compat_ptr(getb
.hdr32
), compat_ptr(getb
.data32
),
950 case MON_IOCX_MFETCH
:
952 struct mon_bin_mfetch mfetch
;
953 struct mon_bin_mfetch __user
*uptr
;
955 uptr
= (struct mon_bin_mfetch __user
*)arg
;
957 if (copy_from_user(&mfetch
, uptr
, sizeof(mfetch
)))
961 ret
= mon_bin_flush(rp
, mfetch
.nflush
);
964 if (put_user(ret
, &uptr
->nflush
))
967 ret
= mon_bin_fetch(file
, rp
, mfetch
.offvec
, mfetch
.nfetch
);
970 if (put_user(ret
, &uptr
->nfetch
))
977 case MON_IOCX_MFETCH32
:
979 struct mon_bin_mfetch32 mfetch
;
980 struct mon_bin_mfetch32 __user
*uptr
;
982 uptr
= (struct mon_bin_mfetch32 __user
*) compat_ptr(arg
);
984 if (copy_from_user(&mfetch
, uptr
, sizeof(mfetch
)))
987 if (mfetch
.nflush32
) {
988 ret
= mon_bin_flush(rp
, mfetch
.nflush32
);
991 if (put_user(ret
, &uptr
->nflush32
))
994 ret
= mon_bin_fetch(file
, rp
, compat_ptr(mfetch
.offvec32
),
998 if (put_user(ret
, &uptr
->nfetch32
))
1005 case MON_IOCG_STATS
: {
1006 struct mon_bin_stats __user
*sp
;
1007 unsigned int nevents
;
1008 unsigned int ndropped
;
1010 spin_lock_irqsave(&rp
->b_lock
, flags
);
1011 ndropped
= rp
->cnt_lost
;
1013 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1014 nevents
= mon_bin_queued(rp
);
1016 sp
= (struct mon_bin_stats __user
*)arg
;
1017 if (put_user(rp
->cnt_lost
, &sp
->dropped
))
1019 if (put_user(nevents
, &sp
->queued
))
1033 mon_bin_poll(struct file
*file
, struct poll_table_struct
*wait
)
1035 struct mon_reader_bin
*rp
= file
->private_data
;
1036 unsigned int mask
= 0;
1037 unsigned long flags
;
1039 if (file
->f_mode
& FMODE_READ
)
1040 poll_wait(file
, &rp
->b_wait
, wait
);
1042 spin_lock_irqsave(&rp
->b_lock
, flags
);
1043 if (!MON_RING_EMPTY(rp
))
1044 mask
|= POLLIN
| POLLRDNORM
; /* readable */
1045 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1050 * open and close: just keep track of how many times the device is
1051 * mapped, to use the proper memory allocation function.
1053 static void mon_bin_vma_open(struct vm_area_struct
*vma
)
1055 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1059 static void mon_bin_vma_close(struct vm_area_struct
*vma
)
1061 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1066 * Map ring pages to user space.
1068 struct page
*mon_bin_vma_nopage(struct vm_area_struct
*vma
,
1069 unsigned long address
, int *type
)
1071 struct mon_reader_bin
*rp
= vma
->vm_private_data
;
1072 unsigned long offset
, chunk_idx
;
1073 struct page
*pageptr
;
1075 offset
= (address
- vma
->vm_start
) + (vma
->vm_pgoff
<< PAGE_SHIFT
);
1076 if (offset
>= rp
->b_size
)
1077 return NOPAGE_SIGBUS
;
1078 chunk_idx
= offset
/ CHUNK_SIZE
;
1079 pageptr
= rp
->b_vec
[chunk_idx
].pg
;
1082 *type
= VM_FAULT_MINOR
;
1086 struct vm_operations_struct mon_bin_vm_ops
= {
1087 .open
= mon_bin_vma_open
,
1088 .close
= mon_bin_vma_close
,
1089 .nopage
= mon_bin_vma_nopage
,
1092 int mon_bin_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
1094 /* don't do anything here: "nopage" will set up page table entries */
1095 vma
->vm_ops
= &mon_bin_vm_ops
;
1096 vma
->vm_flags
|= VM_RESERVED
;
1097 vma
->vm_private_data
= filp
->private_data
;
1098 mon_bin_vma_open(vma
);
1102 struct file_operations mon_fops_binary
= {
1103 .owner
= THIS_MODULE
,
1104 .open
= mon_bin_open
,
1105 .llseek
= no_llseek
,
1106 .read
= mon_bin_read
,
1107 /* .write = mon_text_write, */
1108 .poll
= mon_bin_poll
,
1109 .ioctl
= mon_bin_ioctl
,
1110 .release
= mon_bin_release
,
1113 static int mon_bin_wait_event(struct file
*file
, struct mon_reader_bin
*rp
)
1115 DECLARE_WAITQUEUE(waita
, current
);
1116 unsigned long flags
;
1118 add_wait_queue(&rp
->b_wait
, &waita
);
1119 set_current_state(TASK_INTERRUPTIBLE
);
1121 spin_lock_irqsave(&rp
->b_lock
, flags
);
1122 while (MON_RING_EMPTY(rp
)) {
1123 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1125 if (file
->f_flags
& O_NONBLOCK
) {
1126 set_current_state(TASK_RUNNING
);
1127 remove_wait_queue(&rp
->b_wait
, &waita
);
1128 return -EWOULDBLOCK
; /* Same as EAGAIN in Linux */
1131 if (signal_pending(current
)) {
1132 remove_wait_queue(&rp
->b_wait
, &waita
);
1135 set_current_state(TASK_INTERRUPTIBLE
);
1137 spin_lock_irqsave(&rp
->b_lock
, flags
);
1139 spin_unlock_irqrestore(&rp
->b_lock
, flags
);
1141 set_current_state(TASK_RUNNING
);
1142 remove_wait_queue(&rp
->b_wait
, &waita
);
1146 static int mon_alloc_buff(struct mon_pgmap
*map
, int npages
)
1149 unsigned long vaddr
;
1151 for (n
= 0; n
< npages
; n
++) {
1152 vaddr
= get_zeroed_page(GFP_KERNEL
);
1155 free_page((unsigned long) map
[n
].ptr
);
1158 map
[n
].ptr
= (unsigned char *) vaddr
;
1159 map
[n
].pg
= virt_to_page(vaddr
);
1164 static void mon_free_buff(struct mon_pgmap
*map
, int npages
)
1168 for (n
= 0; n
< npages
; n
++)
1169 free_page((unsigned long) map
[n
].ptr
);
1172 int mon_bin_add(struct mon_bus
*mbus
, const struct usb_bus
*ubus
)
1175 unsigned minor
= ubus
? ubus
->busnum
: 0;
1177 if (minor
>= MON_BIN_MAX_MINOR
)
1180 dev
= device_create(mon_bin_class
, ubus
? ubus
->controller
: NULL
,
1181 MKDEV(MAJOR(mon_bin_dev0
), minor
), "usbmon%d", minor
);
1185 mbus
->classdev
= dev
;
1189 void mon_bin_del(struct mon_bus
*mbus
)
1191 device_destroy(mon_bin_class
, mbus
->classdev
->devt
);
1194 int __init
mon_bin_init(void)
1198 mon_bin_class
= class_create(THIS_MODULE
, "usbmon");
1199 if (IS_ERR(mon_bin_class
)) {
1200 rc
= PTR_ERR(mon_bin_class
);
1204 rc
= alloc_chrdev_region(&mon_bin_dev0
, 0, MON_BIN_MAX_MINOR
, "usbmon");
1208 cdev_init(&mon_bin_cdev
, &mon_fops_binary
);
1209 mon_bin_cdev
.owner
= THIS_MODULE
;
1211 rc
= cdev_add(&mon_bin_cdev
, mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1218 unregister_chrdev_region(mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1220 class_destroy(mon_bin_class
);
1225 void mon_bin_exit(void)
1227 cdev_del(&mon_bin_cdev
);
1228 unregister_chrdev_region(mon_bin_dev0
, MON_BIN_MAX_MINOR
);
1229 class_destroy(mon_bin_class
);