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>
18 #include <linux/smp_lock.h>
20 #include <asm/uaccess.h>
25 * Defined by USB 2.0 clause 9.3, table 9.2.
30 #define MON_IOC_MAGIC 0x92
32 #define MON_IOCQ_URB_LEN _IO(MON_IOC_MAGIC, 1)
33 /* #2 used to be MON_IOCX_URB, removed before it got into Linus tree */
34 #define MON_IOCG_STATS _IOR(MON_IOC_MAGIC, 3, struct mon_bin_stats)
35 #define MON_IOCT_RING_SIZE _IO(MON_IOC_MAGIC, 4)
36 #define MON_IOCQ_RING_SIZE _IO(MON_IOC_MAGIC, 5)
37 #define MON_IOCX_GET _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get)
38 #define MON_IOCX_MFETCH _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch)
39 #define MON_IOCH_MFLUSH _IO(MON_IOC_MAGIC, 8)
40 /* #9 was MON_IOCT_SETAPI */
41 #define MON_IOCX_GETX _IOW(MON_IOC_MAGIC, 10, struct mon_bin_get)
44 #define MON_IOCX_GET32 _IOW(MON_IOC_MAGIC, 6, struct mon_bin_get32)
45 #define MON_IOCX_MFETCH32 _IOWR(MON_IOC_MAGIC, 7, struct mon_bin_mfetch32)
46 #define MON_IOCX_GETX32 _IOW(MON_IOC_MAGIC, 10, struct mon_bin_get32)
50 * Some architectures have enormous basic pages (16KB for ia64, 64KB for ppc).
51 * But it's all right. Just use a simple way to make sure the chunk is never
52 * smaller than a page.
54 * N.B. An application does not know our chunk size.
56 * Woops, get_zeroed_page() returns a single page. I guess we're stuck with
57 * page-sized chunks for the time being.
59 #define CHUNK_SIZE PAGE_SIZE
60 #define CHUNK_ALIGN(x) (((x)+CHUNK_SIZE-1) & ~(CHUNK_SIZE-1))
63 * The magic limit was calculated so that it allows the monitoring
64 * application to pick data once in two ticks. This way, another application,
65 * which presumably drives the bus, gets to hog CPU, yet we collect our data.
66 * If HZ is 100, a 480 mbit/s bus drives 614 KB every jiffy. USB has an
67 * enormous overhead built into the bus protocol, so we need about 1000 KB.
69 * This is still too much for most cases, where we just snoop a few
70 * descriptor fetches for enumeration. So, the default is a "reasonable"
71 * amount for systems with HZ=250 and incomplete bus saturation.
73 * XXX What about multi-megabyte URBs which take minutes to transfer?
75 #define BUFF_MAX CHUNK_ALIGN(1200*1024)
76 #define BUFF_DFL CHUNK_ALIGN(300*1024)
77 #define BUFF_MIN CHUNK_ALIGN(8*1024)
80 * The per-event API header (2 per URB).
82 * This structure is seen in userland as defined by the documentation.
85 u64 id; /* URB ID - from submission to callback */
86 unsigned char type; /* Same as in text API; extensible. */
87 unsigned char xfer_type; /* ISO, Intr, Control, Bulk */
88 unsigned char epnum; /* Endpoint number and transfer direction */
89 unsigned char devnum; /* Device address */
90 unsigned short busnum; /* Bus number */
93 s64 ts_sec; /* gettimeofday */
94 s32 ts_usec; /* gettimeofday */
96 unsigned int len_urb; /* Length of data (submitted or actual) */
97 unsigned int len_cap; /* Delivered length */
99 unsigned char setup[SETUP_LEN]; /* Only for Control S-type */
107 unsigned int xfer_flags;
108 unsigned int ndesc; /* Actual number of ISO descriptors */
112 * ISO vector, packed into the head of data stream.
113 * This has to take 16 bytes to make sure that the end of buffer
114 * wrap is not happening in the middle of a descriptor.
116 struct mon_bin_isodesc {
118 unsigned int iso_off;
119 unsigned int iso_len;
123 /* per file statistic */
124 struct mon_bin_stats {
130 struct mon_bin_hdr __user *hdr; /* Can be 48 bytes or 64. */
132 size_t alloc; /* Length of data (can be zero) */
135 struct mon_bin_mfetch {
136 u32 __user *offvec; /* Vector of events fetched */
137 u32 nfetch; /* Number of events to fetch (out: fetched) */
138 u32 nflush; /* Number of events to flush */
142 struct mon_bin_get32 {
148 struct mon_bin_mfetch32 {
155 /* Having these two values same prevents wrapping of the mon_bin_hdr */
159 #define PKT_SZ_API0 48 /* API 0 (2.6.20) size */
160 #define PKT_SZ_API1 64 /* API 1 size: extra fields */
162 #define ISODESC_MAX 128 /* Same number as usbfs allows, 2048 bytes. */
164 /* max number of USB bus supported */
165 #define MON_BIN_MAX_MINOR 128
168 * The buffer: map of used pages.
172 unsigned char *ptr; /* XXX just use page_to_virt everywhere? */
176 * This gets associated with an open file struct.
178 struct mon_reader_bin {
179 /* The buffer: one per open. */
180 spinlock_t b_lock; /* Protect b_cnt, b_in */
181 unsigned int b_size; /* Current size of the buffer - bytes */
182 unsigned int b_cnt; /* Bytes used */
183 unsigned int b_in, b_out; /* Offsets into buffer - bytes */
184 unsigned int b_read; /* Amount of read data in curr. pkt. */
185 struct mon_pgmap *b_vec; /* The map array */
186 wait_queue_head_t b_wait; /* Wait for data here */
188 struct mutex fetch_lock; /* Protect b_read, b_out */
191 /* A list of these is needed for "bus 0". Some time later. */
195 unsigned int cnt_lost;
198 static inline struct mon_bin_hdr *MON_OFF2HDR(const struct mon_reader_bin *rp,
201 return (struct mon_bin_hdr *)
202 (rp->b_vec[offset / CHUNK_SIZE].ptr + offset % CHUNK_SIZE);
205 #define MON_RING_EMPTY(rp) ((rp)->b_cnt == 0)
207 static unsigned char xfer_to_pipe[4] = {
208 PIPE_CONTROL, PIPE_ISOCHRONOUS, PIPE_BULK, PIPE_INTERRUPT
211 static struct class *mon_bin_class;
212 static dev_t mon_bin_dev0;
213 static struct cdev mon_bin_cdev;
215 static void mon_buff_area_fill(const struct mon_reader_bin *rp,
216 unsigned int offset, unsigned int size);
217 static int mon_bin_wait_event(struct file *file, struct mon_reader_bin *rp);
218 static int mon_alloc_buff(struct mon_pgmap *map, int npages);
219 static void mon_free_buff(struct mon_pgmap *map, int npages);
222 * This is a "chunked memcpy". It does not manipulate any counters.
224 static void mon_copy_to_buff(const struct mon_reader_bin *this,
225 unsigned int off, const unsigned char *from, unsigned int length)
227 unsigned int step_len;
229 unsigned int in_page;
233 * Determine step_len.
236 in_page = CHUNK_SIZE - (off & (CHUNK_SIZE-1));
237 if (in_page < step_len)
241 * Copy data and advance pointers.
243 buf = this->b_vec[off / CHUNK_SIZE].ptr + off % CHUNK_SIZE;
244 memcpy(buf, from, step_len);
245 if ((off += step_len) >= this->b_size) off = 0;
252 * This is a little worse than the above because it's "chunked copy_to_user".
253 * The return value is an error code, not an offset.
255 static int copy_from_buf(const struct mon_reader_bin *this, unsigned int off,
256 char __user *to, int length)
258 unsigned int step_len;
260 unsigned int in_page;
264 * Determine step_len.
267 in_page = CHUNK_SIZE - (off & (CHUNK_SIZE-1));
268 if (in_page < step_len)
272 * Copy data and advance pointers.
274 buf = this->b_vec[off / CHUNK_SIZE].ptr + off % CHUNK_SIZE;
275 if (copy_to_user(to, buf, step_len))
277 if ((off += step_len) >= this->b_size) off = 0;
285 * Allocate an (aligned) area in the buffer.
286 * This is called under b_lock.
287 * Returns ~0 on failure.
289 static unsigned int mon_buff_area_alloc(struct mon_reader_bin *rp,
294 size = (size + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
295 if (rp->b_cnt + size > rp->b_size)
299 if ((rp->b_in += size) >= rp->b_size)
300 rp->b_in -= rp->b_size;
305 * This is the same thing as mon_buff_area_alloc, only it does not allow
306 * buffers to wrap. This is needed by applications which pass references
307 * into mmap-ed buffers up their stacks (libpcap can do that).
309 * Currently, we always have the header stuck with the data, although
310 * it is not strictly speaking necessary.
312 * When a buffer would wrap, we place a filler packet to mark the space.
314 static unsigned int mon_buff_area_alloc_contiguous(struct mon_reader_bin *rp,
318 unsigned int fill_size;
320 size = (size + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
321 if (rp->b_cnt + size > rp->b_size)
323 if (rp->b_in + size > rp->b_size) {
325 * This would wrap. Find if we still have space after
326 * skipping to the end of the buffer. If we do, place
327 * a filler packet and allocate a new packet.
329 fill_size = rp->b_size - rp->b_in;
330 if (rp->b_cnt + size + fill_size > rp->b_size)
332 mon_buff_area_fill(rp, rp->b_in, fill_size);
336 rp->b_cnt += size + fill_size;
337 } else if (rp->b_in + size == rp->b_size) {
350 * Return a few (kilo-)bytes to the head of the buffer.
351 * This is used if a data fetch fails.
353 static void mon_buff_area_shrink(struct mon_reader_bin *rp, unsigned int size)
356 /* size &= ~(PKT_ALIGN-1); -- we're called with aligned size */
359 rp->b_in += rp->b_size;
364 * This has to be called under both b_lock and fetch_lock, because
365 * it accesses both b_cnt and b_out.
367 static void mon_buff_area_free(struct mon_reader_bin *rp, unsigned int size)
370 size = (size + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
372 if ((rp->b_out += size) >= rp->b_size)
373 rp->b_out -= rp->b_size;
376 static void mon_buff_area_fill(const struct mon_reader_bin *rp,
377 unsigned int offset, unsigned int size)
379 struct mon_bin_hdr *ep;
381 ep = MON_OFF2HDR(rp, offset);
382 memset(ep, 0, PKT_SIZE);
384 ep->len_cap = size - PKT_SIZE;
387 static inline char mon_bin_get_setup(unsigned char *setupb,
388 const struct urb *urb, char ev_type)
391 if (urb->setup_packet == NULL)
393 memcpy(setupb, urb->setup_packet, SETUP_LEN);
397 static char mon_bin_get_data(const struct mon_reader_bin *rp,
398 unsigned int offset, struct urb *urb, unsigned int length)
401 if (urb->transfer_buffer == NULL)
403 mon_copy_to_buff(rp, offset, urb->transfer_buffer, length);
407 static void mon_bin_get_isodesc(const struct mon_reader_bin *rp,
408 unsigned int offset, struct urb *urb, char ev_type, unsigned int ndesc)
410 struct mon_bin_isodesc *dp;
411 struct usb_iso_packet_descriptor *fp;
413 fp = urb->iso_frame_desc;
414 while (ndesc-- != 0) {
415 dp = (struct mon_bin_isodesc *)
416 (rp->b_vec[offset / CHUNK_SIZE].ptr + offset % CHUNK_SIZE);
417 dp->iso_status = fp->status;
418 dp->iso_off = fp->offset;
419 dp->iso_len = (ev_type == 'S') ? fp->length : fp->actual_length;
421 if ((offset += sizeof(struct mon_bin_isodesc)) >= rp->b_size)
427 static void mon_bin_event(struct mon_reader_bin *rp, struct urb *urb,
428 char ev_type, int status)
430 const struct usb_endpoint_descriptor *epd = &urb->ep->desc;
433 unsigned int urb_length;
437 unsigned int ndesc, lendesc;
439 struct mon_bin_hdr *ep;
442 do_gettimeofday(&ts);
444 spin_lock_irqsave(&rp->b_lock, flags);
447 * Find the maximum allowable length, then allocate space.
449 if (usb_endpoint_xfer_isoc(epd)) {
450 if (urb->number_of_packets < 0) {
452 } else if (urb->number_of_packets >= ISODESC_MAX) {
455 ndesc = urb->number_of_packets;
460 lendesc = ndesc*sizeof(struct mon_bin_isodesc);
462 urb_length = (ev_type == 'S') ?
463 urb->transfer_buffer_length : urb->actual_length;
466 if (length >= rp->b_size/5)
467 length = rp->b_size/5;
469 if (usb_urb_dir_in(urb)) {
470 if (ev_type == 'S') {
474 /* Cannot rely on endpoint number in case of control ep.0 */
477 if (ev_type == 'C') {
484 if (rp->mmap_active) {
485 offset = mon_buff_area_alloc_contiguous(rp,
486 length + PKT_SIZE + lendesc);
488 offset = mon_buff_area_alloc(rp, length + PKT_SIZE + lendesc);
492 spin_unlock_irqrestore(&rp->b_lock, flags);
496 ep = MON_OFF2HDR(rp, offset);
497 if ((offset += PKT_SIZE) >= rp->b_size) offset = 0;
500 * Fill the allocated area.
502 memset(ep, 0, PKT_SIZE);
504 ep->xfer_type = xfer_to_pipe[usb_endpoint_type(epd)];
505 ep->epnum = dir | usb_endpoint_num(epd);
506 ep->devnum = urb->dev->devnum;
507 ep->busnum = urb->dev->bus->busnum;
508 ep->id = (unsigned long) urb;
509 ep->ts_sec = ts.tv_sec;
510 ep->ts_usec = ts.tv_usec;
512 ep->len_urb = urb_length;
513 ep->len_cap = length + lendesc;
514 ep->xfer_flags = urb->transfer_flags;
516 if (usb_endpoint_xfer_int(epd)) {
517 ep->interval = urb->interval;
518 } else if (usb_endpoint_xfer_isoc(epd)) {
519 ep->interval = urb->interval;
520 ep->start_frame = urb->start_frame;
521 ep->s.iso.error_count = urb->error_count;
522 ep->s.iso.numdesc = urb->number_of_packets;
525 if (usb_endpoint_xfer_control(epd) && ev_type == 'S') {
526 ep->flag_setup = mon_bin_get_setup(ep->s.setup, urb, ev_type);
528 ep->flag_setup = '-';
533 mon_bin_get_isodesc(rp, offset, urb, ev_type, ndesc);
534 if ((offset += lendesc) >= rp->b_size)
535 offset -= rp->b_size;
539 ep->flag_data = mon_bin_get_data(rp, offset, urb, length);
540 if (ep->flag_data != 0) { /* Yes, it's 0x00, not '0' */
541 delta = (ep->len_cap + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
542 ep->len_cap -= length;
543 delta -= (ep->len_cap + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
544 mon_buff_area_shrink(rp, delta);
547 ep->flag_data = data_tag;
550 spin_unlock_irqrestore(&rp->b_lock, flags);
552 wake_up(&rp->b_wait);
555 static void mon_bin_submit(void *data, struct urb *urb)
557 struct mon_reader_bin *rp = data;
558 mon_bin_event(rp, urb, 'S', -EINPROGRESS);
561 static void mon_bin_complete(void *data, struct urb *urb, int status)
563 struct mon_reader_bin *rp = data;
564 mon_bin_event(rp, urb, 'C', status);
567 static void mon_bin_error(void *data, struct urb *urb, int error)
569 struct mon_reader_bin *rp = data;
572 struct mon_bin_hdr *ep;
574 spin_lock_irqsave(&rp->b_lock, flags);
576 offset = mon_buff_area_alloc(rp, PKT_SIZE);
578 /* Not incrementing cnt_lost. Just because. */
579 spin_unlock_irqrestore(&rp->b_lock, flags);
583 ep = MON_OFF2HDR(rp, offset);
585 memset(ep, 0, PKT_SIZE);
587 ep->xfer_type = xfer_to_pipe[usb_endpoint_type(&urb->ep->desc)];
588 ep->epnum = usb_urb_dir_in(urb) ? USB_DIR_IN : 0;
589 ep->epnum |= usb_endpoint_num(&urb->ep->desc);
590 ep->devnum = urb->dev->devnum;
591 ep->busnum = urb->dev->bus->busnum;
592 ep->id = (unsigned long) urb;
595 ep->flag_setup = '-';
598 spin_unlock_irqrestore(&rp->b_lock, flags);
600 wake_up(&rp->b_wait);
603 static int mon_bin_open(struct inode *inode, struct file *file)
605 struct mon_bus *mbus;
606 struct mon_reader_bin *rp;
611 mutex_lock(&mon_lock);
612 if ((mbus = mon_bus_lookup(iminor(inode))) == NULL) {
613 mutex_unlock(&mon_lock);
617 if (mbus != &mon_bus0 && mbus->u_bus == NULL) {
618 printk(KERN_ERR TAG ": consistency error on open\n");
619 mutex_unlock(&mon_lock);
624 rp = kzalloc(sizeof(struct mon_reader_bin), GFP_KERNEL);
629 spin_lock_init(&rp->b_lock);
630 init_waitqueue_head(&rp->b_wait);
631 mutex_init(&rp->fetch_lock);
632 rp->b_size = BUFF_DFL;
634 size = sizeof(struct mon_pgmap) * (rp->b_size/CHUNK_SIZE);
635 if ((rp->b_vec = kzalloc(size, GFP_KERNEL)) == NULL) {
640 if ((rc = mon_alloc_buff(rp->b_vec, rp->b_size/CHUNK_SIZE)) < 0)
645 rp->r.rnf_submit = mon_bin_submit;
646 rp->r.rnf_error = mon_bin_error;
647 rp->r.rnf_complete = mon_bin_complete;
649 mon_reader_add(mbus, &rp->r);
651 file->private_data = rp;
652 mutex_unlock(&mon_lock);
661 mutex_unlock(&mon_lock);
667 * Extract an event from buffer and copy it to user space.
668 * Wait if there is no event ready.
669 * Returns zero or error.
671 static int mon_bin_get_event(struct file *file, struct mon_reader_bin *rp,
672 struct mon_bin_hdr __user *hdr, unsigned int hdrbytes,
673 void __user *data, unsigned int nbytes)
676 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 (copy_to_user(hdr, ep, hdrbytes)) {
691 mutex_unlock(&rp->fetch_lock);
695 step_len = min(ep->len_cap, nbytes);
696 if ((offset = rp->b_out + PKT_SIZE) >= rp->b_size) offset = 0;
698 if (copy_from_buf(rp, offset, data, step_len)) {
699 mutex_unlock(&rp->fetch_lock);
703 spin_lock_irqsave(&rp->b_lock, flags);
704 mon_buff_area_free(rp, PKT_SIZE + ep->len_cap);
705 spin_unlock_irqrestore(&rp->b_lock, flags);
708 mutex_unlock(&rp->fetch_lock);
712 static int mon_bin_release(struct inode *inode, struct file *file)
714 struct mon_reader_bin *rp = file->private_data;
715 struct mon_bus* mbus = rp->r.m_bus;
717 mutex_lock(&mon_lock);
719 if (mbus->nreaders <= 0) {
720 printk(KERN_ERR TAG ": consistency error on close\n");
721 mutex_unlock(&mon_lock);
724 mon_reader_del(mbus, &rp->r);
726 mon_free_buff(rp->b_vec, rp->b_size/CHUNK_SIZE);
730 mutex_unlock(&mon_lock);
734 static ssize_t mon_bin_read(struct file *file, char __user *buf,
735 size_t nbytes, loff_t *ppos)
737 struct mon_reader_bin *rp = file->private_data;
738 unsigned int hdrbytes = PKT_SZ_API0;
740 struct mon_bin_hdr *ep;
747 mutex_lock(&rp->fetch_lock);
749 if ((rc = mon_bin_wait_event(file, rp)) < 0) {
750 mutex_unlock(&rp->fetch_lock);
754 ep = MON_OFF2HDR(rp, rp->b_out);
756 if (rp->b_read < hdrbytes) {
757 step_len = min(nbytes, (size_t)(hdrbytes - rp->b_read));
758 ptr = ((char *)ep) + rp->b_read;
759 if (step_len && copy_to_user(buf, ptr, step_len)) {
760 mutex_unlock(&rp->fetch_lock);
765 rp->b_read += step_len;
769 if (rp->b_read >= hdrbytes) {
770 step_len = ep->len_cap;
771 step_len -= rp->b_read - hdrbytes;
772 if (step_len > nbytes)
774 offset = rp->b_out + PKT_SIZE;
775 offset += rp->b_read - hdrbytes;
776 if (offset >= rp->b_size)
777 offset -= rp->b_size;
778 if (copy_from_buf(rp, offset, buf, step_len)) {
779 mutex_unlock(&rp->fetch_lock);
784 rp->b_read += step_len;
789 * Check if whole packet was read, and if so, jump to the next one.
791 if (rp->b_read >= hdrbytes + ep->len_cap) {
792 spin_lock_irqsave(&rp->b_lock, flags);
793 mon_buff_area_free(rp, PKT_SIZE + ep->len_cap);
794 spin_unlock_irqrestore(&rp->b_lock, flags);
798 mutex_unlock(&rp->fetch_lock);
803 * Remove at most nevents from chunked buffer.
804 * Returns the number of removed events.
806 static int mon_bin_flush(struct mon_reader_bin *rp, unsigned nevents)
809 struct mon_bin_hdr *ep;
812 mutex_lock(&rp->fetch_lock);
813 spin_lock_irqsave(&rp->b_lock, flags);
814 for (i = 0; i < nevents; ++i) {
815 if (MON_RING_EMPTY(rp))
818 ep = MON_OFF2HDR(rp, rp->b_out);
819 mon_buff_area_free(rp, PKT_SIZE + ep->len_cap);
821 spin_unlock_irqrestore(&rp->b_lock, flags);
823 mutex_unlock(&rp->fetch_lock);
828 * Fetch at most max event offsets into the buffer and put them into vec.
829 * The events are usually freed later with mon_bin_flush.
830 * Return the effective number of events fetched.
832 static int mon_bin_fetch(struct file *file, struct mon_reader_bin *rp,
833 u32 __user *vec, unsigned int max)
835 unsigned int cur_out;
836 unsigned int bytes, avail;
838 unsigned int nevents;
839 struct mon_bin_hdr *ep;
843 mutex_lock(&rp->fetch_lock);
845 if ((rc = mon_bin_wait_event(file, rp)) < 0) {
846 mutex_unlock(&rp->fetch_lock);
850 spin_lock_irqsave(&rp->b_lock, flags);
852 spin_unlock_irqrestore(&rp->b_lock, flags);
857 while (bytes < avail) {
861 ep = MON_OFF2HDR(rp, cur_out);
862 if (put_user(cur_out, &vec[nevents])) {
863 mutex_unlock(&rp->fetch_lock);
868 size = ep->len_cap + PKT_SIZE;
869 size = (size + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
870 if ((cur_out += size) >= rp->b_size)
871 cur_out -= rp->b_size;
875 mutex_unlock(&rp->fetch_lock);
880 * Count events. This is almost the same as the above mon_bin_fetch,
881 * only we do not store offsets into user vector, and we have no limit.
883 static int mon_bin_queued(struct mon_reader_bin *rp)
885 unsigned int cur_out;
886 unsigned int bytes, avail;
888 unsigned int nevents;
889 struct mon_bin_hdr *ep;
892 mutex_lock(&rp->fetch_lock);
894 spin_lock_irqsave(&rp->b_lock, flags);
896 spin_unlock_irqrestore(&rp->b_lock, flags);
901 while (bytes < avail) {
902 ep = MON_OFF2HDR(rp, cur_out);
905 size = ep->len_cap + PKT_SIZE;
906 size = (size + PKT_ALIGN-1) & ~(PKT_ALIGN-1);
907 if ((cur_out += size) >= rp->b_size)
908 cur_out -= rp->b_size;
912 mutex_unlock(&rp->fetch_lock);
918 static int mon_bin_ioctl(struct inode *inode, struct file *file,
919 unsigned int cmd, unsigned long arg)
921 struct mon_reader_bin *rp = file->private_data;
922 // struct mon_bus* mbus = rp->r.m_bus;
924 struct mon_bin_hdr *ep;
929 case MON_IOCQ_URB_LEN:
931 * N.B. This only returns the size of data, without the header.
933 spin_lock_irqsave(&rp->b_lock, flags);
934 if (!MON_RING_EMPTY(rp)) {
935 ep = MON_OFF2HDR(rp, rp->b_out);
938 spin_unlock_irqrestore(&rp->b_lock, flags);
941 case MON_IOCQ_RING_SIZE:
945 case MON_IOCT_RING_SIZE:
947 * Changing the buffer size will flush it's contents; the new
948 * buffer is allocated before releasing the old one to be sure
949 * the device will stay functional also in case of memory
954 struct mon_pgmap *vec;
956 if (arg < BUFF_MIN || arg > BUFF_MAX)
959 size = CHUNK_ALIGN(arg);
960 if ((vec = kzalloc(sizeof(struct mon_pgmap) * (size/CHUNK_SIZE),
961 GFP_KERNEL)) == NULL) {
966 ret = mon_alloc_buff(vec, size/CHUNK_SIZE);
972 mutex_lock(&rp->fetch_lock);
973 spin_lock_irqsave(&rp->b_lock, flags);
974 mon_free_buff(rp->b_vec, size/CHUNK_SIZE);
978 rp->b_read = rp->b_in = rp->b_out = rp->b_cnt = 0;
980 spin_unlock_irqrestore(&rp->b_lock, flags);
981 mutex_unlock(&rp->fetch_lock);
985 case MON_IOCH_MFLUSH:
986 ret = mon_bin_flush(rp, arg);
992 struct mon_bin_get getb;
994 if (copy_from_user(&getb, (void __user *)arg,
995 sizeof(struct mon_bin_get)))
998 if (getb.alloc > 0x10000000) /* Want to cast to u32 */
1000 ret = mon_bin_get_event(file, rp, getb.hdr,
1001 (cmd == MON_IOCX_GET)? PKT_SZ_API0: PKT_SZ_API1,
1002 getb.data, (unsigned int)getb.alloc);
1006 case MON_IOCX_MFETCH:
1008 struct mon_bin_mfetch mfetch;
1009 struct mon_bin_mfetch __user *uptr;
1011 uptr = (struct mon_bin_mfetch __user *)arg;
1013 if (copy_from_user(&mfetch, uptr, sizeof(mfetch)))
1016 if (mfetch.nflush) {
1017 ret = mon_bin_flush(rp, mfetch.nflush);
1020 if (put_user(ret, &uptr->nflush))
1023 ret = mon_bin_fetch(file, rp, mfetch.offvec, mfetch.nfetch);
1026 if (put_user(ret, &uptr->nfetch))
1032 case MON_IOCG_STATS: {
1033 struct mon_bin_stats __user *sp;
1034 unsigned int nevents;
1035 unsigned int ndropped;
1037 spin_lock_irqsave(&rp->b_lock, flags);
1038 ndropped = rp->cnt_lost;
1040 spin_unlock_irqrestore(&rp->b_lock, flags);
1041 nevents = mon_bin_queued(rp);
1043 sp = (struct mon_bin_stats __user *)arg;
1044 if (put_user(rp->cnt_lost, &sp->dropped))
1046 if (put_user(nevents, &sp->queued))
1059 #ifdef CONFIG_COMPAT
1060 static long mon_bin_compat_ioctl(struct file *file,
1061 unsigned int cmd, unsigned long arg)
1063 struct mon_reader_bin *rp = file->private_data;
1068 case MON_IOCX_GET32:
1069 case MON_IOCX_GETX32:
1071 struct mon_bin_get32 getb;
1073 if (copy_from_user(&getb, (void __user *)arg,
1074 sizeof(struct mon_bin_get32)))
1077 ret = mon_bin_get_event(file, rp, compat_ptr(getb.hdr32),
1078 (cmd == MON_IOCX_GET32)? PKT_SZ_API0: PKT_SZ_API1,
1079 compat_ptr(getb.data32), getb.alloc32);
1085 case MON_IOCX_MFETCH32:
1087 struct mon_bin_mfetch32 mfetch;
1088 struct mon_bin_mfetch32 __user *uptr;
1090 uptr = (struct mon_bin_mfetch32 __user *) compat_ptr(arg);
1092 if (copy_from_user(&mfetch, uptr, sizeof(mfetch)))
1095 if (mfetch.nflush32) {
1096 ret = mon_bin_flush(rp, mfetch.nflush32);
1099 if (put_user(ret, &uptr->nflush32))
1102 ret = mon_bin_fetch(file, rp, compat_ptr(mfetch.offvec32),
1106 if (put_user(ret, &uptr->nfetch32))
1111 case MON_IOCG_STATS:
1112 return mon_bin_ioctl(NULL, file, cmd,
1113 (unsigned long) compat_ptr(arg));
1115 case MON_IOCQ_URB_LEN:
1116 case MON_IOCQ_RING_SIZE:
1117 case MON_IOCT_RING_SIZE:
1118 case MON_IOCH_MFLUSH:
1119 return mon_bin_ioctl(NULL, file, cmd, arg);
1126 #endif /* CONFIG_COMPAT */
1129 mon_bin_poll(struct file *file, struct poll_table_struct *wait)
1131 struct mon_reader_bin *rp = file->private_data;
1132 unsigned int mask = 0;
1133 unsigned long flags;
1135 if (file->f_mode & FMODE_READ)
1136 poll_wait(file, &rp->b_wait, wait);
1138 spin_lock_irqsave(&rp->b_lock, flags);
1139 if (!MON_RING_EMPTY(rp))
1140 mask |= POLLIN | POLLRDNORM; /* readable */
1141 spin_unlock_irqrestore(&rp->b_lock, flags);
1146 * open and close: just keep track of how many times the device is
1147 * mapped, to use the proper memory allocation function.
1149 static void mon_bin_vma_open(struct vm_area_struct *vma)
1151 struct mon_reader_bin *rp = vma->vm_private_data;
1155 static void mon_bin_vma_close(struct vm_area_struct *vma)
1157 struct mon_reader_bin *rp = vma->vm_private_data;
1162 * Map ring pages to user space.
1164 static int mon_bin_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1166 struct mon_reader_bin *rp = vma->vm_private_data;
1167 unsigned long offset, chunk_idx;
1168 struct page *pageptr;
1170 offset = vmf->pgoff << PAGE_SHIFT;
1171 if (offset >= rp->b_size)
1172 return VM_FAULT_SIGBUS;
1173 chunk_idx = offset / CHUNK_SIZE;
1174 pageptr = rp->b_vec[chunk_idx].pg;
1176 vmf->page = pageptr;
1180 static const struct vm_operations_struct mon_bin_vm_ops = {
1181 .open = mon_bin_vma_open,
1182 .close = mon_bin_vma_close,
1183 .fault = mon_bin_vma_fault,
1186 static int mon_bin_mmap(struct file *filp, struct vm_area_struct *vma)
1188 /* don't do anything here: "fault" will set up page table entries */
1189 vma->vm_ops = &mon_bin_vm_ops;
1190 vma->vm_flags |= VM_RESERVED;
1191 vma->vm_private_data = filp->private_data;
1192 mon_bin_vma_open(vma);
1196 static const struct file_operations mon_fops_binary = {
1197 .owner = THIS_MODULE,
1198 .open = mon_bin_open,
1199 .llseek = no_llseek,
1200 .read = mon_bin_read,
1201 /* .write = mon_text_write, */
1202 .poll = mon_bin_poll,
1203 .ioctl = mon_bin_ioctl,
1204 #ifdef CONFIG_COMPAT
1205 .compat_ioctl = mon_bin_compat_ioctl,
1207 .release = mon_bin_release,
1208 .mmap = mon_bin_mmap,
1211 static int mon_bin_wait_event(struct file *file, struct mon_reader_bin *rp)
1213 DECLARE_WAITQUEUE(waita, current);
1214 unsigned long flags;
1216 add_wait_queue(&rp->b_wait, &waita);
1217 set_current_state(TASK_INTERRUPTIBLE);
1219 spin_lock_irqsave(&rp->b_lock, flags);
1220 while (MON_RING_EMPTY(rp)) {
1221 spin_unlock_irqrestore(&rp->b_lock, flags);
1223 if (file->f_flags & O_NONBLOCK) {
1224 set_current_state(TASK_RUNNING);
1225 remove_wait_queue(&rp->b_wait, &waita);
1226 return -EWOULDBLOCK; /* Same as EAGAIN in Linux */
1229 if (signal_pending(current)) {
1230 remove_wait_queue(&rp->b_wait, &waita);
1233 set_current_state(TASK_INTERRUPTIBLE);
1235 spin_lock_irqsave(&rp->b_lock, flags);
1237 spin_unlock_irqrestore(&rp->b_lock, flags);
1239 set_current_state(TASK_RUNNING);
1240 remove_wait_queue(&rp->b_wait, &waita);
1244 static int mon_alloc_buff(struct mon_pgmap *map, int npages)
1247 unsigned long vaddr;
1249 for (n = 0; n < npages; n++) {
1250 vaddr = get_zeroed_page(GFP_KERNEL);
1253 free_page((unsigned long) map[n].ptr);
1256 map[n].ptr = (unsigned char *) vaddr;
1257 map[n].pg = virt_to_page((void *) vaddr);
1262 static void mon_free_buff(struct mon_pgmap *map, int npages)
1266 for (n = 0; n < npages; n++)
1267 free_page((unsigned long) map[n].ptr);
1270 int mon_bin_add(struct mon_bus *mbus, const struct usb_bus *ubus)
1273 unsigned minor = ubus? ubus->busnum: 0;
1275 if (minor >= MON_BIN_MAX_MINOR)
1278 dev = device_create(mon_bin_class, ubus ? ubus->controller : NULL,
1279 MKDEV(MAJOR(mon_bin_dev0), minor), NULL,
1284 mbus->classdev = dev;
1288 void mon_bin_del(struct mon_bus *mbus)
1290 device_destroy(mon_bin_class, mbus->classdev->devt);
1293 int __init mon_bin_init(void)
1297 mon_bin_class = class_create(THIS_MODULE, "usbmon");
1298 if (IS_ERR(mon_bin_class)) {
1299 rc = PTR_ERR(mon_bin_class);
1303 rc = alloc_chrdev_region(&mon_bin_dev0, 0, MON_BIN_MAX_MINOR, "usbmon");
1307 cdev_init(&mon_bin_cdev, &mon_fops_binary);
1308 mon_bin_cdev.owner = THIS_MODULE;
1310 rc = cdev_add(&mon_bin_cdev, mon_bin_dev0, MON_BIN_MAX_MINOR);
1317 unregister_chrdev_region(mon_bin_dev0, MON_BIN_MAX_MINOR);
1319 class_destroy(mon_bin_class);
1324 void mon_bin_exit(void)
1326 cdev_del(&mon_bin_cdev);
1327 unregister_chrdev_region(mon_bin_dev0, MON_BIN_MAX_MINOR);
1328 class_destroy(mon_bin_class);