blob: ad408251d9557c2504bd35dcd53ae416344bf08d [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>
Paul Gortmakerf940fcd2011-05-27 09:56:31 -040012#include <linux/export.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010013#include <linux/mutex.h>
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080014#include <linux/debugfs.h>
Alan Sternb375e112009-11-06 12:32:23 -050015#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <asm/uaccess.h>
17
18#include "usb_mon.h"
19
20/*
21 * No, we do not want arbitrarily long data strings.
22 * Use the binary interface if you want to capture bulk data!
23 */
24#define DATA_MAX 32
25
26/*
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070027 * Defined by USB 2.0 clause 9.3, table 9.2.
28 */
29#define SETUP_MAX 8
30
31/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 * This limit exists to prevent OOMs when the user process stops reading.
Pete Zaitcev5b1c6742006-06-09 20:10:10 -070033 * If usbmon were available to unprivileged processes, it might be open
34 * to a local DoS. But we have to keep to root in order to prevent
35 * password sniffing from HID devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080037#define EVENT_MAX (4*PAGE_SIZE / sizeof(struct mon_event_text))
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080039/*
40 * Potentially unlimited number; we limit it for similar allocations.
41 * The usbfs limits this to 128, but we're not quite as generous.
42 */
43#define ISODESC_MAX 5
44
45#define PRINTF_DFL 250 /* with 5 ISOs segs */
46
47struct mon_iso_desc {
48 int status;
49 unsigned int offset;
50 unsigned int length; /* Unsigned here, signed in URB. Historic. */
51};
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53struct mon_event_text {
54 struct list_head e_link;
55 int type; /* submit, complete, etc. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 unsigned long id; /* From pointer, most of the time */
57 unsigned int tstamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080058 int busnum;
Pete Zaitcev30c74312007-08-14 00:33:40 -070059 char devnum;
60 char epnum;
61 char is_in;
62 char xfertype;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 int length; /* Depends on type: xfer length or act length */
64 int status;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080065 int interval;
66 int start_frame;
67 int error_count;
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070068 char setup_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 char data_flag;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080070 int numdesc; /* Full number */
71 struct mon_iso_desc isodesc[ISODESC_MAX];
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070072 unsigned char setup[SETUP_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 unsigned char data[DATA_MAX];
74};
75
76#define SLAB_NAME_SZ 30
77struct mon_reader_text {
Christoph Lametere18b8902006-12-06 20:33:20 -080078 struct kmem_cache *e_slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 int nevents;
80 struct list_head e_list;
81 struct mon_reader r; /* In C, parent class can be placed anywhere */
82
83 wait_queue_head_t wait;
84 int printf_size;
85 char *printf_buf;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010086 struct mutex printf_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
88 char slab_name[SLAB_NAME_SZ];
89};
90
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080091static struct dentry *mon_dir; /* Usually /sys/kernel/debug/usbmon */
92
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070093static void mon_text_ctor(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080095struct mon_text_ptr {
96 int cnt, limit;
97 char *pbuf;
98};
99
100static struct mon_event_text *
101 mon_text_read_wait(struct mon_reader_text *rp, struct file *file);
102static void mon_text_read_head_t(struct mon_reader_text *rp,
103 struct mon_text_ptr *p, const struct mon_event_text *ep);
104static void mon_text_read_head_u(struct mon_reader_text *rp,
105 struct mon_text_ptr *p, const struct mon_event_text *ep);
106static void mon_text_read_statset(struct mon_reader_text *rp,
107 struct mon_text_ptr *p, const struct mon_event_text *ep);
108static void mon_text_read_intstat(struct mon_reader_text *rp,
109 struct mon_text_ptr *p, const struct mon_event_text *ep);
110static void mon_text_read_isostat(struct mon_reader_text *rp,
111 struct mon_text_ptr *p, const struct mon_event_text *ep);
112static void mon_text_read_isodesc(struct mon_reader_text *rp,
113 struct mon_text_ptr *p, const struct mon_event_text *ep);
114static void mon_text_read_data(struct mon_reader_text *rp,
115 struct mon_text_ptr *p, const struct mon_event_text *ep);
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117/*
118 * mon_text_submit
119 * mon_text_complete
120 *
121 * May be called from an interrupt.
122 *
123 * This is called with the whole mon_bus locked, so no additional lock.
124 */
125
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700126static inline char mon_text_get_setup(struct mon_event_text *ep,
Alan Stern4d6cd482006-08-30 11:35:21 -0400127 struct urb *urb, char ev_type, struct mon_bus *mbus)
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700128{
129
Alan Stern18ea5d02007-07-30 17:10:36 -0400130 if (ep->xfertype != USB_ENDPOINT_XFER_CONTROL || ev_type != 'S')
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700131 return '-';
132
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700133 if (urb->setup_packet == NULL)
134 return 'Z'; /* '0' would be not as pretty. */
135
136 memcpy(ep->setup, urb->setup_packet, SETUP_MAX);
137 return 0;
138}
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static inline char mon_text_get_data(struct mon_event_text *ep, struct urb *urb,
Alan Stern4d6cd482006-08-30 11:35:21 -0400141 int len, char ev_type, struct mon_bus *mbus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Alan Sternb375e112009-11-06 12:32:23 -0500143 void *src;
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 if (len <= 0)
146 return 'L';
Pete Zaitcev02568392005-08-15 16:53:57 -0700147 if (len >= DATA_MAX)
148 len = DATA_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Alan Stern18ea5d02007-07-30 17:10:36 -0400150 if (ep->is_in) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800151 if (ev_type != 'C')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800152 return '<';
153 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800154 if (ev_type != 'S')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800155 return '>';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 }
157
Alan Sternb375e112009-11-06 12:32:23 -0500158 if (urb->num_sgs == 0) {
159 src = urb->transfer_buffer;
160 if (src == NULL)
161 return 'Z'; /* '0' would be not as pretty. */
162 } else {
Matthew Wilcox910f8d02010-05-01 12:20:01 -0600163 struct scatterlist *sg = urb->sg;
Pete Zaitcev02568392005-08-15 16:53:57 -0700164
Alan Sternff9c8952010-04-02 13:27:28 -0400165 if (PageHighMem(sg_page(sg)))
Alan Sternb375e112009-11-06 12:32:23 -0500166 return 'D';
167
168 /* For the text interface we copy only the first sg buffer */
169 len = min_t(int, sg->length, len);
170 src = sg_virt(sg);
171 }
172
173 memcpy(ep->data, src, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 return 0;
175}
176
177static inline unsigned int mon_get_timestamp(void)
178{
179 struct timeval tval;
180 unsigned int stamp;
181
182 do_gettimeofday(&tval);
Pete Zaitcev47cb17082010-02-19 23:55:57 -0700183 stamp = tval.tv_sec & 0xFFF; /* 2^32 = 4294967296. Limit to 4096s. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 stamp = stamp * 1000000 + tval.tv_usec;
185 return stamp;
186}
187
188static void mon_text_event(struct mon_reader_text *rp, struct urb *urb,
Alan Stern9347d512007-08-24 15:41:41 -0400189 char ev_type, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
191 struct mon_event_text *ep;
192 unsigned int stamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800193 struct usb_iso_packet_descriptor *fp;
194 struct mon_iso_desc *dp;
195 int i, ndesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197 stamp = mon_get_timestamp();
198
199 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800200 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 rp->r.m_bus->cnt_text_lost++;
202 return;
203 }
204
205 ep->type = ev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 ep->id = (unsigned long) urb;
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700207 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400208 ep->devnum = urb->dev->devnum;
209 ep->epnum = usb_endpoint_num(&urb->ep->desc);
210 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
211 ep->is_in = usb_urb_dir_in(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 ep->tstamp = stamp;
213 ep->length = (ev_type == 'S') ?
214 urb->transfer_buffer_length : urb->actual_length;
215 /* Collecting status makes debugging sense for submits, too */
Alan Stern9347d512007-08-24 15:41:41 -0400216 ep->status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Alan Stern18ea5d02007-07-30 17:10:36 -0400218 if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800219 ep->interval = urb->interval;
Alan Stern18ea5d02007-07-30 17:10:36 -0400220 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800221 ep->interval = urb->interval;
222 ep->start_frame = urb->start_frame;
223 ep->error_count = urb->error_count;
224 }
225 ep->numdesc = urb->number_of_packets;
Alan Stern18ea5d02007-07-30 17:10:36 -0400226 if (ep->xfertype == USB_ENDPOINT_XFER_ISOC &&
227 urb->number_of_packets > 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800228 if ((ndesc = urb->number_of_packets) > ISODESC_MAX)
229 ndesc = ISODESC_MAX;
230 fp = urb->iso_frame_desc;
231 dp = ep->isodesc;
232 for (i = 0; i < ndesc; i++) {
233 dp->status = fp->status;
234 dp->offset = fp->offset;
235 dp->length = (ev_type == 'S') ?
236 fp->length : fp->actual_length;
237 fp++;
238 dp++;
239 }
Pete Zaitcevd25bc4d2011-02-03 22:01:36 -0700240 /* Wasteful, but simple to understand: ISO 'C' is sparse. */
241 if (ev_type == 'C')
242 ep->length = urb->transfer_buffer_length;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800243 }
244
Alan Stern4d6cd482006-08-30 11:35:21 -0400245 ep->setup_flag = mon_text_get_setup(ep, urb, ev_type, rp->r.m_bus);
246 ep->data_flag = mon_text_get_data(ep, urb, ep->length, ev_type,
247 rp->r.m_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 rp->nevents++;
250 list_add_tail(&ep->e_link, &rp->e_list);
251 wake_up(&rp->wait);
252}
253
254static void mon_text_submit(void *data, struct urb *urb)
255{
256 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400257 mon_text_event(rp, urb, 'S', -EINPROGRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258}
259
Alan Stern9347d512007-08-24 15:41:41 -0400260static void mon_text_complete(void *data, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
262 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400263 mon_text_event(rp, urb, 'C', status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264}
265
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700266static void mon_text_error(void *data, struct urb *urb, int error)
267{
268 struct mon_reader_text *rp = data;
269 struct mon_event_text *ep;
270
271 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800272 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700273 rp->r.m_bus->cnt_text_lost++;
274 return;
275 }
276
277 ep->type = 'E';
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700278 ep->id = (unsigned long) urb;
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700279 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400280 ep->devnum = urb->dev->devnum;
281 ep->epnum = usb_endpoint_num(&urb->ep->desc);
282 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
283 ep->is_in = usb_urb_dir_in(urb);
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700284 ep->tstamp = mon_get_timestamp();
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700285 ep->length = 0;
286 ep->status = error;
287
288 ep->setup_flag = '-';
289 ep->data_flag = 'E';
290
291 rp->nevents++;
292 list_add_tail(&ep->e_link, &rp->e_list);
293 wake_up(&rp->wait);
294}
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296/*
297 * Fetch next event from the circular buffer.
298 */
299static struct mon_event_text *mon_text_fetch(struct mon_reader_text *rp,
300 struct mon_bus *mbus)
301{
302 struct list_head *p;
303 unsigned long flags;
304
305 spin_lock_irqsave(&mbus->lock, flags);
306 if (list_empty(&rp->e_list)) {
307 spin_unlock_irqrestore(&mbus->lock, flags);
308 return NULL;
309 }
310 p = rp->e_list.next;
311 list_del(p);
312 --rp->nevents;
313 spin_unlock_irqrestore(&mbus->lock, flags);
314 return list_entry(p, struct mon_event_text, e_link);
315}
316
317/*
318 */
319static int mon_text_open(struct inode *inode, struct file *file)
320{
321 struct mon_bus *mbus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 struct mon_reader_text *rp;
323 int rc;
324
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100325 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700326 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100328 rp = kzalloc(sizeof(struct mon_reader_text), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (rp == NULL) {
330 rc = -ENOMEM;
331 goto err_alloc;
332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 INIT_LIST_HEAD(&rp->e_list);
334 init_waitqueue_head(&rp->wait);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100335 mutex_init(&rp->printf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 rp->printf_size = PRINTF_DFL;
338 rp->printf_buf = kmalloc(rp->printf_size, GFP_KERNEL);
339 if (rp->printf_buf == NULL) {
340 rc = -ENOMEM;
341 goto err_alloc_pr;
342 }
343
344 rp->r.m_bus = mbus;
345 rp->r.r_data = rp;
346 rp->r.rnf_submit = mon_text_submit;
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700347 rp->r.rnf_error = mon_text_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 rp->r.rnf_complete = mon_text_complete;
349
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700350 snprintf(rp->slab_name, SLAB_NAME_SZ, "mon_text_%p", rp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 rp->e_slab = kmem_cache_create(rp->slab_name,
352 sizeof(struct mon_event_text), sizeof(long), 0,
Paul Mundt20c2df82007-07-20 10:11:58 +0900353 mon_text_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (rp->e_slab == NULL) {
355 rc = -ENOMEM;
356 goto err_slab;
357 }
358
359 mon_reader_add(mbus, &rp->r);
360
361 file->private_data = rp;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100362 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 return 0;
364
365// err_busy:
366// kmem_cache_destroy(rp->e_slab);
367err_slab:
368 kfree(rp->printf_buf);
369err_alloc_pr:
370 kfree(rp);
371err_alloc:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100372 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 return rc;
374}
375
376/*
377 * For simplicity, we read one record in one system call and throw out
378 * what does not fit. This means that the following does not work:
379 * dd if=/dbg/usbmon/0t bs=10
380 * Also, we do not allow seeks and do not bother advancing the offset.
381 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800382static ssize_t mon_text_read_t(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 size_t nbytes, loff_t *ppos)
384{
385 struct mon_reader_text *rp = file->private_data;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800386 struct mon_event_text *ep;
387 struct mon_text_ptr ptr;
388
389 if (IS_ERR(ep = mon_text_read_wait(rp, file)))
390 return PTR_ERR(ep);
391 mutex_lock(&rp->printf_lock);
392 ptr.cnt = 0;
393 ptr.pbuf = rp->printf_buf;
394 ptr.limit = rp->printf_size;
395
396 mon_text_read_head_t(rp, &ptr, ep);
397 mon_text_read_statset(rp, &ptr, ep);
398 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
399 " %d", ep->length);
400 mon_text_read_data(rp, &ptr, ep);
401
402 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
403 ptr.cnt = -EFAULT;
404 mutex_unlock(&rp->printf_lock);
405 kmem_cache_free(rp->e_slab, ep);
406 return ptr.cnt;
407}
408
409static ssize_t mon_text_read_u(struct file *file, char __user *buf,
410 size_t nbytes, loff_t *ppos)
411{
412 struct mon_reader_text *rp = file->private_data;
413 struct mon_event_text *ep;
414 struct mon_text_ptr ptr;
415
416 if (IS_ERR(ep = mon_text_read_wait(rp, file)))
417 return PTR_ERR(ep);
418 mutex_lock(&rp->printf_lock);
419 ptr.cnt = 0;
420 ptr.pbuf = rp->printf_buf;
421 ptr.limit = rp->printf_size;
422
423 mon_text_read_head_u(rp, &ptr, ep);
424 if (ep->type == 'E') {
425 mon_text_read_statset(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400426 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800427 mon_text_read_isostat(rp, &ptr, ep);
428 mon_text_read_isodesc(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400429 } else if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800430 mon_text_read_intstat(rp, &ptr, ep);
431 } else {
432 mon_text_read_statset(rp, &ptr, ep);
433 }
434 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
435 " %d", ep->length);
436 mon_text_read_data(rp, &ptr, ep);
437
438 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
439 ptr.cnt = -EFAULT;
440 mutex_unlock(&rp->printf_lock);
441 kmem_cache_free(rp->e_slab, ep);
442 return ptr.cnt;
443}
444
445static struct mon_event_text *mon_text_read_wait(struct mon_reader_text *rp,
446 struct file *file)
447{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 struct mon_bus *mbus = rp->r.m_bus;
449 DECLARE_WAITQUEUE(waita, current);
450 struct mon_event_text *ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452 add_wait_queue(&rp->wait, &waita);
453 set_current_state(TASK_INTERRUPTIBLE);
454 while ((ep = mon_text_fetch(rp, mbus)) == NULL) {
455 if (file->f_flags & O_NONBLOCK) {
456 set_current_state(TASK_RUNNING);
457 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800458 return ERR_PTR(-EWOULDBLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 }
460 /*
461 * We do not count nwaiters, because ->release is supposed
462 * to be called when all openers are gone only.
463 */
464 schedule();
465 if (signal_pending(current)) {
466 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800467 return ERR_PTR(-EINTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 }
469 set_current_state(TASK_INTERRUPTIBLE);
470 }
471 set_current_state(TASK_RUNNING);
472 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800473 return ep;
474}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800476static void mon_text_read_head_t(struct mon_reader_text *rp,
477 struct mon_text_ptr *p, const struct mon_event_text *ep)
478{
479 char udir, utype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Alan Stern18ea5d02007-07-30 17:10:36 -0400481 udir = (ep->is_in ? 'i' : 'o');
482 switch (ep->xfertype) {
483 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
484 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
485 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 default: /* PIPE_BULK */ utype = 'B';
487 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800488 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700489 "%lx %u %c %c%c:%03u:%02u",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400491 utype, udir, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800492}
493
494static void mon_text_read_head_u(struct mon_reader_text *rp,
495 struct mon_text_ptr *p, const struct mon_event_text *ep)
496{
497 char udir, utype;
498
Alan Stern18ea5d02007-07-30 17:10:36 -0400499 udir = (ep->is_in ? 'i' : 'o');
500 switch (ep->xfertype) {
501 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
502 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
503 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800504 default: /* PIPE_BULK */ utype = 'B';
505 }
506 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
507 "%lx %u %c %c%c:%d:%03u:%u",
508 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400509 utype, udir, ep->busnum, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800510}
511
512static void mon_text_read_statset(struct mon_reader_text *rp,
513 struct mon_text_ptr *p, const struct mon_event_text *ep)
514{
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700515
516 if (ep->setup_flag == 0) { /* Setup packet is present and captured */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800517 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700518 " s %02x %02x %04x %04x %04x",
519 ep->setup[0],
520 ep->setup[1],
521 (ep->setup[3] << 8) | ep->setup[2],
522 (ep->setup[5] << 8) | ep->setup[4],
523 (ep->setup[7] << 8) | ep->setup[6]);
524 } else if (ep->setup_flag != '-') { /* Unable to capture setup packet */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800525 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700526 " %c __ __ ____ ____ ____", ep->setup_flag);
527 } else { /* No setup for this kind of URB */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800528 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
529 " %d", ep->status);
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700530 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800531}
532
533static void mon_text_read_intstat(struct mon_reader_text *rp,
534 struct mon_text_ptr *p, const struct mon_event_text *ep)
535{
536 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
537 " %d:%d", ep->status, ep->interval);
538}
539
540static void mon_text_read_isostat(struct mon_reader_text *rp,
541 struct mon_text_ptr *p, const struct mon_event_text *ep)
542{
543 if (ep->type == 'S') {
544 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
545 " %d:%d:%d", ep->status, ep->interval, ep->start_frame);
546 } else {
547 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
548 " %d:%d:%d:%d",
549 ep->status, ep->interval, ep->start_frame, ep->error_count);
550 }
551}
552
553static void mon_text_read_isodesc(struct mon_reader_text *rp,
554 struct mon_text_ptr *p, const struct mon_event_text *ep)
555{
556 int ndesc; /* Display this many */
557 int i;
558 const struct mon_iso_desc *dp;
559
560 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
561 " %d", ep->numdesc);
562 ndesc = ep->numdesc;
563 if (ndesc > ISODESC_MAX)
564 ndesc = ISODESC_MAX;
565 if (ndesc < 0)
566 ndesc = 0;
567 dp = ep->isodesc;
568 for (i = 0; i < ndesc; i++) {
569 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
570 " %d:%u:%u", dp->status, dp->offset, dp->length);
571 dp++;
572 }
573}
574
575static void mon_text_read_data(struct mon_reader_text *rp,
576 struct mon_text_ptr *p, const struct mon_event_text *ep)
577{
578 int data_len, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580 if ((data_len = ep->length) > 0) {
581 if (ep->data_flag == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800582 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
583 " =");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 if (data_len >= DATA_MAX)
585 data_len = DATA_MAX;
586 for (i = 0; i < data_len; i++) {
587 if (i % 4 == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800588 p->cnt += snprintf(p->pbuf + p->cnt,
589 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 " ");
591 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800592 p->cnt += snprintf(p->pbuf + p->cnt,
593 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 "%02x", ep->data[i]);
595 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800596 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
597 "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800599 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 " %c\n", ep->data_flag);
601 }
602 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800603 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605}
606
607static int mon_text_release(struct inode *inode, struct file *file)
608{
609 struct mon_reader_text *rp = file->private_data;
610 struct mon_bus *mbus;
611 /* unsigned long flags; */
612 struct list_head *p;
613 struct mon_event_text *ep;
614
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100615 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700616 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 if (mbus->nreaders <= 0) {
619 printk(KERN_ERR TAG ": consistency error on close\n");
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100620 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return 0;
622 }
623 mon_reader_del(mbus, &rp->r);
624
625 /*
626 * In theory, e_list is protected by mbus->lock. However,
627 * after mon_reader_del has finished, the following is the case:
628 * - we are not on reader list anymore, so new events won't be added;
629 * - whole mbus may be dropped if it was orphaned.
630 * So, we better not touch mbus.
631 */
632 /* spin_lock_irqsave(&mbus->lock, flags); */
633 while (!list_empty(&rp->e_list)) {
634 p = rp->e_list.next;
635 ep = list_entry(p, struct mon_event_text, e_link);
636 list_del(p);
637 --rp->nevents;
638 kmem_cache_free(rp->e_slab, ep);
639 }
640 /* spin_unlock_irqrestore(&mbus->lock, flags); */
641
642 kmem_cache_destroy(rp->e_slab);
643 kfree(rp->printf_buf);
644 kfree(rp);
645
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100646 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return 0;
648}
649
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800650static const struct file_operations mon_fops_text_t = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 .owner = THIS_MODULE,
652 .open = mon_text_open,
653 .llseek = no_llseek,
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800654 .read = mon_text_read_t,
655 .release = mon_text_release,
656};
657
658static const struct file_operations mon_fops_text_u = {
659 .owner = THIS_MODULE,
660 .open = mon_text_open,
661 .llseek = no_llseek,
662 .read = mon_text_read_u,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 .release = mon_text_release,
664};
665
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700666int mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800667{
668 struct dentry *d;
669 enum { NAMESZ = 10 };
670 char name[NAMESZ];
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700671 int busnum = ubus? ubus->busnum: 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800672 int rc;
673
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200674 if (mon_dir == NULL)
675 return 0;
676
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700677 if (ubus != NULL) {
678 rc = snprintf(name, NAMESZ, "%dt", busnum);
679 if (rc <= 0 || rc >= NAMESZ)
680 goto err_print_t;
681 d = debugfs_create_file(name, 0600, mon_dir, mbus,
682 &mon_fops_text_t);
683 if (d == NULL)
684 goto err_create_t;
685 mbus->dent_t = d;
686 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800687
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700688 rc = snprintf(name, NAMESZ, "%du", busnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800689 if (rc <= 0 || rc >= NAMESZ)
690 goto err_print_u;
691 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_text_u);
692 if (d == NULL)
693 goto err_create_u;
694 mbus->dent_u = d;
695
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700696 rc = snprintf(name, NAMESZ, "%ds", busnum);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800697 if (rc <= 0 || rc >= NAMESZ)
698 goto err_print_s;
699 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_stat);
700 if (d == NULL)
701 goto err_create_s;
702 mbus->dent_s = d;
703
704 return 1;
705
706err_create_s:
707err_print_s:
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800708 debugfs_remove(mbus->dent_u);
709 mbus->dent_u = NULL;
710err_create_u:
711err_print_u:
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700712 if (ubus != NULL) {
713 debugfs_remove(mbus->dent_t);
714 mbus->dent_t = NULL;
715 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800716err_create_t:
717err_print_t:
718 return 0;
719}
720
721void mon_text_del(struct mon_bus *mbus)
722{
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800723 debugfs_remove(mbus->dent_u);
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700724 if (mbus->dent_t != NULL)
725 debugfs_remove(mbus->dent_t);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800726 debugfs_remove(mbus->dent_s);
727}
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729/*
730 * Slab interface: constructor.
731 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700732static void mon_text_ctor(void *mem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
734 /*
735 * Nothing to initialize. No, really!
736 * So, we fill it with garbage to emulate a reused object.
737 */
738 memset(mem, 0xe5, sizeof(struct mon_event_text));
739}
740
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800741int __init mon_text_init(void)
742{
743 struct dentry *mondir;
744
Greg Kroah-Hartmanf49ce962009-04-24 15:15:49 -0700745 mondir = debugfs_create_dir("usbmon", usb_debug_root);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800746 if (IS_ERR(mondir)) {
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200747 /* debugfs not available, but we can use usbmon without it */
748 return 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800749 }
750 if (mondir == NULL) {
751 printk(KERN_NOTICE TAG ": unable to create usbmon directory\n");
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200752 return -ENOMEM;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800753 }
754 mon_dir = mondir;
755 return 0;
756}
757
Pete Zaitcev21641e32007-02-20 10:37:52 -0800758void mon_text_exit(void)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800759{
760 debugfs_remove(mon_dir);
761}