blob: e59334b09c4126ac75077c8b5333222f5e66f4b8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * The USB Monitor, inspired by Dave Harding's USBMon.
3 *
4 * This is a text format reader.
5 */
6
7#include <linux/kernel.h>
8#include <linux/list.h>
9#include <linux/usb.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090010#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/time.h>
Tina Ruchandaniec4dca82015-10-29 22:58:28 -070012#include <linux/ktime.h>
Paul Gortmakerf940fcd2011-05-27 09:56:31 -040013#include <linux/export.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010014#include <linux/mutex.h>
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080015#include <linux/debugfs.h>
Alan Sternb375e112009-11-06 12:32:23 -050016#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <asm/uaccess.h>
18
19#include "usb_mon.h"
20
21/*
22 * No, we do not want arbitrarily long data strings.
23 * Use the binary interface if you want to capture bulk data!
24 */
25#define DATA_MAX 32
26
27/*
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070028 * Defined by USB 2.0 clause 9.3, table 9.2.
29 */
30#define SETUP_MAX 8
31
32/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * This limit exists to prevent OOMs when the user process stops reading.
Pete Zaitcev5b1c6742006-06-09 20:10:10 -070034 * If usbmon were available to unprivileged processes, it might be open
35 * to a local DoS. But we have to keep to root in order to prevent
36 * password sniffing from HID devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080038#define EVENT_MAX (4*PAGE_SIZE / sizeof(struct mon_event_text))
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080040/*
41 * Potentially unlimited number; we limit it for similar allocations.
42 * The usbfs limits this to 128, but we're not quite as generous.
43 */
44#define ISODESC_MAX 5
45
46#define PRINTF_DFL 250 /* with 5 ISOs segs */
47
48struct mon_iso_desc {
49 int status;
50 unsigned int offset;
51 unsigned int length; /* Unsigned here, signed in URB. Historic. */
52};
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54struct mon_event_text {
55 struct list_head e_link;
56 int type; /* submit, complete, etc. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 unsigned long id; /* From pointer, most of the time */
58 unsigned int tstamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080059 int busnum;
Pete Zaitcev30c74312007-08-14 00:33:40 -070060 char devnum;
61 char epnum;
62 char is_in;
63 char xfertype;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 int length; /* Depends on type: xfer length or act length */
65 int status;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080066 int interval;
67 int start_frame;
68 int error_count;
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070069 char setup_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 char data_flag;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080071 int numdesc; /* Full number */
72 struct mon_iso_desc isodesc[ISODESC_MAX];
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070073 unsigned char setup[SETUP_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 unsigned char data[DATA_MAX];
75};
76
77#define SLAB_NAME_SZ 30
78struct mon_reader_text {
Christoph Lametere18b8902006-12-06 20:33:20 -080079 struct kmem_cache *e_slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 int nevents;
81 struct list_head e_list;
82 struct mon_reader r; /* In C, parent class can be placed anywhere */
83
84 wait_queue_head_t wait;
85 int printf_size;
86 char *printf_buf;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010087 struct mutex printf_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 char slab_name[SLAB_NAME_SZ];
90};
91
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080092static struct dentry *mon_dir; /* Usually /sys/kernel/debug/usbmon */
93
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070094static void mon_text_ctor(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080096struct mon_text_ptr {
97 int cnt, limit;
98 char *pbuf;
99};
100
101static struct mon_event_text *
102 mon_text_read_wait(struct mon_reader_text *rp, struct file *file);
103static void mon_text_read_head_t(struct mon_reader_text *rp,
104 struct mon_text_ptr *p, const struct mon_event_text *ep);
105static void mon_text_read_head_u(struct mon_reader_text *rp,
106 struct mon_text_ptr *p, const struct mon_event_text *ep);
107static void mon_text_read_statset(struct mon_reader_text *rp,
108 struct mon_text_ptr *p, const struct mon_event_text *ep);
109static void mon_text_read_intstat(struct mon_reader_text *rp,
110 struct mon_text_ptr *p, const struct mon_event_text *ep);
111static void mon_text_read_isostat(struct mon_reader_text *rp,
112 struct mon_text_ptr *p, const struct mon_event_text *ep);
113static void mon_text_read_isodesc(struct mon_reader_text *rp,
114 struct mon_text_ptr *p, const struct mon_event_text *ep);
115static void mon_text_read_data(struct mon_reader_text *rp,
116 struct mon_text_ptr *p, const struct mon_event_text *ep);
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118/*
119 * mon_text_submit
120 * mon_text_complete
121 *
122 * May be called from an interrupt.
123 *
124 * This is called with the whole mon_bus locked, so no additional lock.
125 */
126
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700127static inline char mon_text_get_setup(struct mon_event_text *ep,
Alan Stern4d6cd482006-08-30 11:35:21 -0400128 struct urb *urb, char ev_type, struct mon_bus *mbus)
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700129{
130
Alan Stern18ea5d02007-07-30 17:10:36 -0400131 if (ep->xfertype != USB_ENDPOINT_XFER_CONTROL || ev_type != 'S')
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700132 return '-';
133
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700134 if (urb->setup_packet == NULL)
135 return 'Z'; /* '0' would be not as pretty. */
136
137 memcpy(ep->setup, urb->setup_packet, SETUP_MAX);
138 return 0;
139}
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141static inline char mon_text_get_data(struct mon_event_text *ep, struct urb *urb,
Alan Stern4d6cd482006-08-30 11:35:21 -0400142 int len, char ev_type, struct mon_bus *mbus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
Alan Sternb375e112009-11-06 12:32:23 -0500144 void *src;
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 if (len <= 0)
147 return 'L';
Pete Zaitcev02568392005-08-15 16:53:57 -0700148 if (len >= DATA_MAX)
149 len = DATA_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Alan Stern18ea5d02007-07-30 17:10:36 -0400151 if (ep->is_in) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800152 if (ev_type != 'C')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800153 return '<';
154 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800155 if (ev_type != 'S')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800156 return '>';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
158
Alan Sternb375e112009-11-06 12:32:23 -0500159 if (urb->num_sgs == 0) {
160 src = urb->transfer_buffer;
161 if (src == NULL)
162 return 'Z'; /* '0' would be not as pretty. */
163 } else {
Matthew Wilcox910f8d02010-05-01 12:20:01 -0600164 struct scatterlist *sg = urb->sg;
Pete Zaitcev02568392005-08-15 16:53:57 -0700165
Alan Sternff9c8952010-04-02 13:27:28 -0400166 if (PageHighMem(sg_page(sg)))
Alan Sternb375e112009-11-06 12:32:23 -0500167 return 'D';
168
169 /* For the text interface we copy only the first sg buffer */
170 len = min_t(int, sg->length, len);
171 src = sg_virt(sg);
172 }
173
174 memcpy(ep->data, src, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 return 0;
176}
177
178static inline unsigned int mon_get_timestamp(void)
179{
Tina Ruchandaniec4dca82015-10-29 22:58:28 -0700180 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 unsigned int stamp;
182
Tina Ruchandaniec4dca82015-10-29 22:58:28 -0700183 ktime_get_ts64(&now);
184 stamp = now.tv_sec & 0xFFF; /* 2^32 = 4294967296. Limit to 4096s. */
185 stamp = stamp * USEC_PER_SEC + now.tv_nsec / NSEC_PER_USEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 return stamp;
187}
188
189static void mon_text_event(struct mon_reader_text *rp, struct urb *urb,
Alan Stern9347d512007-08-24 15:41:41 -0400190 char ev_type, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191{
192 struct mon_event_text *ep;
193 unsigned int stamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800194 struct usb_iso_packet_descriptor *fp;
195 struct mon_iso_desc *dp;
196 int i, ndesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 stamp = mon_get_timestamp();
199
200 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800201 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 rp->r.m_bus->cnt_text_lost++;
203 return;
204 }
205
206 ep->type = ev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 ep->id = (unsigned long) urb;
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700208 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400209 ep->devnum = urb->dev->devnum;
210 ep->epnum = usb_endpoint_num(&urb->ep->desc);
211 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
212 ep->is_in = usb_urb_dir_in(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 ep->tstamp = stamp;
214 ep->length = (ev_type == 'S') ?
215 urb->transfer_buffer_length : urb->actual_length;
216 /* Collecting status makes debugging sense for submits, too */
Alan Stern9347d512007-08-24 15:41:41 -0400217 ep->status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Alan Stern18ea5d02007-07-30 17:10:36 -0400219 if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800220 ep->interval = urb->interval;
Alan Stern18ea5d02007-07-30 17:10:36 -0400221 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800222 ep->interval = urb->interval;
223 ep->start_frame = urb->start_frame;
224 ep->error_count = urb->error_count;
225 }
226 ep->numdesc = urb->number_of_packets;
Alan Stern18ea5d02007-07-30 17:10:36 -0400227 if (ep->xfertype == USB_ENDPOINT_XFER_ISOC &&
228 urb->number_of_packets > 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800229 if ((ndesc = urb->number_of_packets) > ISODESC_MAX)
230 ndesc = ISODESC_MAX;
231 fp = urb->iso_frame_desc;
232 dp = ep->isodesc;
233 for (i = 0; i < ndesc; i++) {
234 dp->status = fp->status;
235 dp->offset = fp->offset;
236 dp->length = (ev_type == 'S') ?
237 fp->length : fp->actual_length;
238 fp++;
239 dp++;
240 }
Pete Zaitcevd25bc4d2011-02-03 22:01:36 -0700241 /* Wasteful, but simple to understand: ISO 'C' is sparse. */
242 if (ev_type == 'C')
243 ep->length = urb->transfer_buffer_length;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800244 }
245
Alan Stern4d6cd482006-08-30 11:35:21 -0400246 ep->setup_flag = mon_text_get_setup(ep, urb, ev_type, rp->r.m_bus);
247 ep->data_flag = mon_text_get_data(ep, urb, ep->length, ev_type,
248 rp->r.m_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250 rp->nevents++;
251 list_add_tail(&ep->e_link, &rp->e_list);
252 wake_up(&rp->wait);
253}
254
255static void mon_text_submit(void *data, struct urb *urb)
256{
257 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400258 mon_text_event(rp, urb, 'S', -EINPROGRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259}
260
Alan Stern9347d512007-08-24 15:41:41 -0400261static void mon_text_complete(void *data, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
263 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400264 mon_text_event(rp, urb, 'C', status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
266
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700267static void mon_text_error(void *data, struct urb *urb, int error)
268{
269 struct mon_reader_text *rp = data;
270 struct mon_event_text *ep;
271
272 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800273 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700274 rp->r.m_bus->cnt_text_lost++;
275 return;
276 }
277
278 ep->type = 'E';
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700279 ep->id = (unsigned long) urb;
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700280 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400281 ep->devnum = urb->dev->devnum;
282 ep->epnum = usb_endpoint_num(&urb->ep->desc);
283 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
284 ep->is_in = usb_urb_dir_in(urb);
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700285 ep->tstamp = mon_get_timestamp();
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700286 ep->length = 0;
287 ep->status = error;
288
289 ep->setup_flag = '-';
290 ep->data_flag = 'E';
291
292 rp->nevents++;
293 list_add_tail(&ep->e_link, &rp->e_list);
294 wake_up(&rp->wait);
295}
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297/*
298 * Fetch next event from the circular buffer.
299 */
300static struct mon_event_text *mon_text_fetch(struct mon_reader_text *rp,
301 struct mon_bus *mbus)
302{
303 struct list_head *p;
304 unsigned long flags;
305
306 spin_lock_irqsave(&mbus->lock, flags);
307 if (list_empty(&rp->e_list)) {
308 spin_unlock_irqrestore(&mbus->lock, flags);
309 return NULL;
310 }
311 p = rp->e_list.next;
312 list_del(p);
313 --rp->nevents;
314 spin_unlock_irqrestore(&mbus->lock, flags);
315 return list_entry(p, struct mon_event_text, e_link);
316}
317
318/*
319 */
320static int mon_text_open(struct inode *inode, struct file *file)
321{
322 struct mon_bus *mbus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 struct mon_reader_text *rp;
324 int rc;
325
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100326 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700327 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100329 rp = kzalloc(sizeof(struct mon_reader_text), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (rp == NULL) {
331 rc = -ENOMEM;
332 goto err_alloc;
333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 INIT_LIST_HEAD(&rp->e_list);
335 init_waitqueue_head(&rp->wait);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100336 mutex_init(&rp->printf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 rp->printf_size = PRINTF_DFL;
339 rp->printf_buf = kmalloc(rp->printf_size, GFP_KERNEL);
340 if (rp->printf_buf == NULL) {
341 rc = -ENOMEM;
342 goto err_alloc_pr;
343 }
344
345 rp->r.m_bus = mbus;
346 rp->r.r_data = rp;
347 rp->r.rnf_submit = mon_text_submit;
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700348 rp->r.rnf_error = mon_text_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 rp->r.rnf_complete = mon_text_complete;
350
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700351 snprintf(rp->slab_name, SLAB_NAME_SZ, "mon_text_%p", rp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 rp->e_slab = kmem_cache_create(rp->slab_name,
353 sizeof(struct mon_event_text), sizeof(long), 0,
Paul Mundt20c2df82007-07-20 10:11:58 +0900354 mon_text_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 if (rp->e_slab == NULL) {
356 rc = -ENOMEM;
357 goto err_slab;
358 }
359
360 mon_reader_add(mbus, &rp->r);
361
362 file->private_data = rp;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100363 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 return 0;
365
366// err_busy:
367// kmem_cache_destroy(rp->e_slab);
368err_slab:
369 kfree(rp->printf_buf);
370err_alloc_pr:
371 kfree(rp);
372err_alloc:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100373 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 return rc;
375}
376
377/*
378 * For simplicity, we read one record in one system call and throw out
379 * what does not fit. This means that the following does not work:
380 * dd if=/dbg/usbmon/0t bs=10
381 * Also, we do not allow seeks and do not bother advancing the offset.
382 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800383static ssize_t mon_text_read_t(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 size_t nbytes, loff_t *ppos)
385{
386 struct mon_reader_text *rp = file->private_data;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800387 struct mon_event_text *ep;
388 struct mon_text_ptr ptr;
389
Julia Lawall46c236d2015-12-26 22:57:44 +0100390 ep = mon_text_read_wait(rp, file);
391 if (IS_ERR(ep))
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800392 return PTR_ERR(ep);
393 mutex_lock(&rp->printf_lock);
394 ptr.cnt = 0;
395 ptr.pbuf = rp->printf_buf;
396 ptr.limit = rp->printf_size;
397
398 mon_text_read_head_t(rp, &ptr, ep);
399 mon_text_read_statset(rp, &ptr, ep);
400 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
401 " %d", ep->length);
402 mon_text_read_data(rp, &ptr, ep);
403
404 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
405 ptr.cnt = -EFAULT;
406 mutex_unlock(&rp->printf_lock);
407 kmem_cache_free(rp->e_slab, ep);
408 return ptr.cnt;
409}
410
411static ssize_t mon_text_read_u(struct file *file, char __user *buf,
412 size_t nbytes, loff_t *ppos)
413{
414 struct mon_reader_text *rp = file->private_data;
415 struct mon_event_text *ep;
416 struct mon_text_ptr ptr;
417
Julia Lawall46c236d2015-12-26 22:57:44 +0100418 ep = mon_text_read_wait(rp, file);
419 if (IS_ERR(ep))
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800420 return PTR_ERR(ep);
421 mutex_lock(&rp->printf_lock);
422 ptr.cnt = 0;
423 ptr.pbuf = rp->printf_buf;
424 ptr.limit = rp->printf_size;
425
426 mon_text_read_head_u(rp, &ptr, ep);
427 if (ep->type == 'E') {
428 mon_text_read_statset(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400429 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800430 mon_text_read_isostat(rp, &ptr, ep);
431 mon_text_read_isodesc(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400432 } else if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800433 mon_text_read_intstat(rp, &ptr, ep);
434 } else {
435 mon_text_read_statset(rp, &ptr, ep);
436 }
437 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
438 " %d", ep->length);
439 mon_text_read_data(rp, &ptr, ep);
440
441 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
442 ptr.cnt = -EFAULT;
443 mutex_unlock(&rp->printf_lock);
444 kmem_cache_free(rp->e_slab, ep);
445 return ptr.cnt;
446}
447
448static struct mon_event_text *mon_text_read_wait(struct mon_reader_text *rp,
449 struct file *file)
450{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 struct mon_bus *mbus = rp->r.m_bus;
452 DECLARE_WAITQUEUE(waita, current);
453 struct mon_event_text *ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455 add_wait_queue(&rp->wait, &waita);
456 set_current_state(TASK_INTERRUPTIBLE);
457 while ((ep = mon_text_fetch(rp, mbus)) == NULL) {
458 if (file->f_flags & O_NONBLOCK) {
459 set_current_state(TASK_RUNNING);
460 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800461 return ERR_PTR(-EWOULDBLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 }
463 /*
464 * We do not count nwaiters, because ->release is supposed
465 * to be called when all openers are gone only.
466 */
467 schedule();
468 if (signal_pending(current)) {
469 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800470 return ERR_PTR(-EINTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 }
472 set_current_state(TASK_INTERRUPTIBLE);
473 }
474 set_current_state(TASK_RUNNING);
475 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800476 return ep;
477}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800479static void mon_text_read_head_t(struct mon_reader_text *rp,
480 struct mon_text_ptr *p, const struct mon_event_text *ep)
481{
482 char udir, utype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Alan Stern18ea5d02007-07-30 17:10:36 -0400484 udir = (ep->is_in ? 'i' : 'o');
485 switch (ep->xfertype) {
486 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
487 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
488 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 default: /* PIPE_BULK */ utype = 'B';
490 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800491 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700492 "%lx %u %c %c%c:%03u:%02u",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400494 utype, udir, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800495}
496
497static void mon_text_read_head_u(struct mon_reader_text *rp,
498 struct mon_text_ptr *p, const struct mon_event_text *ep)
499{
500 char udir, utype;
501
Alan Stern18ea5d02007-07-30 17:10:36 -0400502 udir = (ep->is_in ? 'i' : 'o');
503 switch (ep->xfertype) {
504 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
505 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
506 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800507 default: /* PIPE_BULK */ utype = 'B';
508 }
509 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
510 "%lx %u %c %c%c:%d:%03u:%u",
511 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400512 utype, udir, ep->busnum, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800513}
514
515static void mon_text_read_statset(struct mon_reader_text *rp,
516 struct mon_text_ptr *p, const struct mon_event_text *ep)
517{
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700518
519 if (ep->setup_flag == 0) { /* Setup packet is present and captured */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800520 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700521 " s %02x %02x %04x %04x %04x",
522 ep->setup[0],
523 ep->setup[1],
524 (ep->setup[3] << 8) | ep->setup[2],
525 (ep->setup[5] << 8) | ep->setup[4],
526 (ep->setup[7] << 8) | ep->setup[6]);
527 } else if (ep->setup_flag != '-') { /* Unable to capture setup packet */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800528 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700529 " %c __ __ ____ ____ ____", ep->setup_flag);
530 } else { /* No setup for this kind of URB */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800531 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
532 " %d", ep->status);
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700533 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800534}
535
536static void mon_text_read_intstat(struct mon_reader_text *rp,
537 struct mon_text_ptr *p, const struct mon_event_text *ep)
538{
539 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
540 " %d:%d", ep->status, ep->interval);
541}
542
543static void mon_text_read_isostat(struct mon_reader_text *rp,
544 struct mon_text_ptr *p, const struct mon_event_text *ep)
545{
546 if (ep->type == 'S') {
547 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
548 " %d:%d:%d", ep->status, ep->interval, ep->start_frame);
549 } else {
550 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
551 " %d:%d:%d:%d",
552 ep->status, ep->interval, ep->start_frame, ep->error_count);
553 }
554}
555
556static void mon_text_read_isodesc(struct mon_reader_text *rp,
557 struct mon_text_ptr *p, const struct mon_event_text *ep)
558{
559 int ndesc; /* Display this many */
560 int i;
561 const struct mon_iso_desc *dp;
562
563 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
564 " %d", ep->numdesc);
565 ndesc = ep->numdesc;
566 if (ndesc > ISODESC_MAX)
567 ndesc = ISODESC_MAX;
568 if (ndesc < 0)
569 ndesc = 0;
570 dp = ep->isodesc;
571 for (i = 0; i < ndesc; i++) {
572 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
573 " %d:%u:%u", dp->status, dp->offset, dp->length);
574 dp++;
575 }
576}
577
578static void mon_text_read_data(struct mon_reader_text *rp,
579 struct mon_text_ptr *p, const struct mon_event_text *ep)
580{
581 int data_len, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
583 if ((data_len = ep->length) > 0) {
584 if (ep->data_flag == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800585 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
586 " =");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 if (data_len >= DATA_MAX)
588 data_len = DATA_MAX;
589 for (i = 0; i < data_len; i++) {
590 if (i % 4 == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800591 p->cnt += snprintf(p->pbuf + p->cnt,
592 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 " ");
594 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800595 p->cnt += snprintf(p->pbuf + p->cnt,
596 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 "%02x", ep->data[i]);
598 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800599 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
600 "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800602 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 " %c\n", ep->data_flag);
604 }
605 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800606 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608}
609
610static int mon_text_release(struct inode *inode, struct file *file)
611{
612 struct mon_reader_text *rp = file->private_data;
613 struct mon_bus *mbus;
614 /* unsigned long flags; */
615 struct list_head *p;
616 struct mon_event_text *ep;
617
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100618 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700619 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621 if (mbus->nreaders <= 0) {
622 printk(KERN_ERR TAG ": consistency error on close\n");
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100623 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return 0;
625 }
626 mon_reader_del(mbus, &rp->r);
627
628 /*
629 * In theory, e_list is protected by mbus->lock. However,
630 * after mon_reader_del has finished, the following is the case:
631 * - we are not on reader list anymore, so new events won't be added;
632 * - whole mbus may be dropped if it was orphaned.
633 * So, we better not touch mbus.
634 */
635 /* spin_lock_irqsave(&mbus->lock, flags); */
636 while (!list_empty(&rp->e_list)) {
637 p = rp->e_list.next;
638 ep = list_entry(p, struct mon_event_text, e_link);
639 list_del(p);
640 --rp->nevents;
641 kmem_cache_free(rp->e_slab, ep);
642 }
643 /* spin_unlock_irqrestore(&mbus->lock, flags); */
644
645 kmem_cache_destroy(rp->e_slab);
646 kfree(rp->printf_buf);
647 kfree(rp);
648
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100649 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return 0;
651}
652
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800653static const struct file_operations mon_fops_text_t = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 .owner = THIS_MODULE,
655 .open = mon_text_open,
656 .llseek = no_llseek,
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800657 .read = mon_text_read_t,
658 .release = mon_text_release,
659};
660
661static const struct file_operations mon_fops_text_u = {
662 .owner = THIS_MODULE,
663 .open = mon_text_open,
664 .llseek = no_llseek,
665 .read = mon_text_read_u,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 .release = mon_text_release,
667};
668
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700669int mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800670{
671 struct dentry *d;
672 enum { NAMESZ = 10 };
673 char name[NAMESZ];
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700674 int busnum = ubus? ubus->busnum: 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800675 int rc;
676
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200677 if (mon_dir == NULL)
678 return 0;
679
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700680 if (ubus != NULL) {
681 rc = snprintf(name, NAMESZ, "%dt", busnum);
682 if (rc <= 0 || rc >= NAMESZ)
683 goto err_print_t;
684 d = debugfs_create_file(name, 0600, mon_dir, mbus,
685 &mon_fops_text_t);
686 if (d == NULL)
687 goto err_create_t;
688 mbus->dent_t = d;
689 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800690
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700691 rc = snprintf(name, NAMESZ, "%du", busnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800692 if (rc <= 0 || rc >= NAMESZ)
693 goto err_print_u;
694 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_text_u);
695 if (d == NULL)
696 goto err_create_u;
697 mbus->dent_u = d;
698
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700699 rc = snprintf(name, NAMESZ, "%ds", busnum);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800700 if (rc <= 0 || rc >= NAMESZ)
701 goto err_print_s;
702 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_stat);
703 if (d == NULL)
704 goto err_create_s;
705 mbus->dent_s = d;
706
707 return 1;
708
709err_create_s:
710err_print_s:
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800711 debugfs_remove(mbus->dent_u);
712 mbus->dent_u = NULL;
713err_create_u:
714err_print_u:
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700715 if (ubus != NULL) {
716 debugfs_remove(mbus->dent_t);
717 mbus->dent_t = NULL;
718 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800719err_create_t:
720err_print_t:
721 return 0;
722}
723
724void mon_text_del(struct mon_bus *mbus)
725{
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800726 debugfs_remove(mbus->dent_u);
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700727 if (mbus->dent_t != NULL)
728 debugfs_remove(mbus->dent_t);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800729 debugfs_remove(mbus->dent_s);
730}
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
733 * Slab interface: constructor.
734 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700735static void mon_text_ctor(void *mem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736{
737 /*
738 * Nothing to initialize. No, really!
739 * So, we fill it with garbage to emulate a reused object.
740 */
741 memset(mem, 0xe5, sizeof(struct mon_event_text));
742}
743
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800744int __init mon_text_init(void)
745{
746 struct dentry *mondir;
747
Greg Kroah-Hartmanf49ce962009-04-24 15:15:49 -0700748 mondir = debugfs_create_dir("usbmon", usb_debug_root);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800749 if (IS_ERR(mondir)) {
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200750 /* debugfs not available, but we can use usbmon without it */
751 return 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800752 }
753 if (mondir == NULL) {
754 printk(KERN_NOTICE TAG ": unable to create usbmon directory\n");
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200755 return -ENOMEM;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800756 }
757 mon_dir = mondir;
758 return 0;
759}
760
Pete Zaitcev21641e32007-02-20 10:37:52 -0800761void mon_text_exit(void)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800762{
763 debugfs_remove(mon_dir);
764}