blob: a545d65f6e57b2e53bd81f104c90e2bd514e5028 [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>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010012#include <linux/mutex.h>
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080013#include <linux/debugfs.h>
Alan Sternb375e112009-11-06 12:32:23 -050014#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <asm/uaccess.h>
16
17#include "usb_mon.h"
18
19/*
20 * No, we do not want arbitrarily long data strings.
21 * Use the binary interface if you want to capture bulk data!
22 */
23#define DATA_MAX 32
24
25/*
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070026 * Defined by USB 2.0 clause 9.3, table 9.2.
27 */
28#define SETUP_MAX 8
29
30/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * This limit exists to prevent OOMs when the user process stops reading.
Pete Zaitcev5b1c6742006-06-09 20:10:10 -070032 * If usbmon were available to unprivileged processes, it might be open
33 * to a local DoS. But we have to keep to root in order to prevent
34 * password sniffing from HID devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080036#define EVENT_MAX (4*PAGE_SIZE / sizeof(struct mon_event_text))
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080038/*
39 * Potentially unlimited number; we limit it for similar allocations.
40 * The usbfs limits this to 128, but we're not quite as generous.
41 */
42#define ISODESC_MAX 5
43
44#define PRINTF_DFL 250 /* with 5 ISOs segs */
45
46struct mon_iso_desc {
47 int status;
48 unsigned int offset;
49 unsigned int length; /* Unsigned here, signed in URB. Historic. */
50};
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52struct mon_event_text {
53 struct list_head e_link;
54 int type; /* submit, complete, etc. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 unsigned long id; /* From pointer, most of the time */
56 unsigned int tstamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080057 int busnum;
Pete Zaitcev30c74312007-08-14 00:33:40 -070058 char devnum;
59 char epnum;
60 char is_in;
61 char xfertype;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 int length; /* Depends on type: xfer length or act length */
63 int status;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080064 int interval;
65 int start_frame;
66 int error_count;
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070067 char setup_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 char data_flag;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080069 int numdesc; /* Full number */
70 struct mon_iso_desc isodesc[ISODESC_MAX];
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070071 unsigned char setup[SETUP_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 unsigned char data[DATA_MAX];
73};
74
75#define SLAB_NAME_SZ 30
76struct mon_reader_text {
Christoph Lametere18b8902006-12-06 20:33:20 -080077 struct kmem_cache *e_slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 int nevents;
79 struct list_head e_list;
80 struct mon_reader r; /* In C, parent class can be placed anywhere */
81
82 wait_queue_head_t wait;
83 int printf_size;
84 char *printf_buf;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010085 struct mutex printf_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87 char slab_name[SLAB_NAME_SZ];
88};
89
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080090static struct dentry *mon_dir; /* Usually /sys/kernel/debug/usbmon */
91
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070092static void mon_text_ctor(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080094struct mon_text_ptr {
95 int cnt, limit;
96 char *pbuf;
97};
98
99static struct mon_event_text *
100 mon_text_read_wait(struct mon_reader_text *rp, struct file *file);
101static void mon_text_read_head_t(struct mon_reader_text *rp,
102 struct mon_text_ptr *p, const struct mon_event_text *ep);
103static void mon_text_read_head_u(struct mon_reader_text *rp,
104 struct mon_text_ptr *p, const struct mon_event_text *ep);
105static void mon_text_read_statset(struct mon_reader_text *rp,
106 struct mon_text_ptr *p, const struct mon_event_text *ep);
107static void mon_text_read_intstat(struct mon_reader_text *rp,
108 struct mon_text_ptr *p, const struct mon_event_text *ep);
109static void mon_text_read_isostat(struct mon_reader_text *rp,
110 struct mon_text_ptr *p, const struct mon_event_text *ep);
111static void mon_text_read_isodesc(struct mon_reader_text *rp,
112 struct mon_text_ptr *p, const struct mon_event_text *ep);
113static void mon_text_read_data(struct mon_reader_text *rp,
114 struct mon_text_ptr *p, const struct mon_event_text *ep);
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116/*
117 * mon_text_submit
118 * mon_text_complete
119 *
120 * May be called from an interrupt.
121 *
122 * This is called with the whole mon_bus locked, so no additional lock.
123 */
124
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700125static inline char mon_text_get_setup(struct mon_event_text *ep,
Alan Stern4d6cd482006-08-30 11:35:21 -0400126 struct urb *urb, char ev_type, struct mon_bus *mbus)
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700127{
128
Alan Stern18ea5d02007-07-30 17:10:36 -0400129 if (ep->xfertype != USB_ENDPOINT_XFER_CONTROL || ev_type != 'S')
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700130 return '-';
131
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700132 if (urb->setup_packet == NULL)
133 return 'Z'; /* '0' would be not as pretty. */
134
135 memcpy(ep->setup, urb->setup_packet, SETUP_MAX);
136 return 0;
137}
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139static inline char mon_text_get_data(struct mon_event_text *ep, struct urb *urb,
Alan Stern4d6cd482006-08-30 11:35:21 -0400140 int len, char ev_type, struct mon_bus *mbus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141{
Alan Sternb375e112009-11-06 12:32:23 -0500142 void *src;
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 if (len <= 0)
145 return 'L';
Pete Zaitcev02568392005-08-15 16:53:57 -0700146 if (len >= DATA_MAX)
147 len = DATA_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Alan Stern18ea5d02007-07-30 17:10:36 -0400149 if (ep->is_in) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800150 if (ev_type != 'C')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800151 return '<';
152 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800153 if (ev_type != 'S')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800154 return '>';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 }
156
Alan Sternb375e112009-11-06 12:32:23 -0500157 if (urb->num_sgs == 0) {
158 src = urb->transfer_buffer;
159 if (src == NULL)
160 return 'Z'; /* '0' would be not as pretty. */
161 } else {
Matthew Wilcox910f8d02010-05-01 12:20:01 -0600162 struct scatterlist *sg = urb->sg;
Pete Zaitcev02568392005-08-15 16:53:57 -0700163
Alan Sternff9c8952010-04-02 13:27:28 -0400164 if (PageHighMem(sg_page(sg)))
Alan Sternb375e112009-11-06 12:32:23 -0500165 return 'D';
166
167 /* For the text interface we copy only the first sg buffer */
168 len = min_t(int, sg->length, len);
169 src = sg_virt(sg);
170 }
171
172 memcpy(ep->data, src, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 return 0;
174}
175
176static inline unsigned int mon_get_timestamp(void)
177{
178 struct timeval tval;
179 unsigned int stamp;
180
181 do_gettimeofday(&tval);
Pete Zaitcev47cb17082010-02-19 23:55:57 -0700182 stamp = tval.tv_sec & 0xFFF; /* 2^32 = 4294967296. Limit to 4096s. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 stamp = stamp * 1000000 + tval.tv_usec;
184 return stamp;
185}
186
187static void mon_text_event(struct mon_reader_text *rp, struct urb *urb,
Alan Stern9347d512007-08-24 15:41:41 -0400188 char ev_type, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
190 struct mon_event_text *ep;
191 unsigned int stamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800192 struct usb_iso_packet_descriptor *fp;
193 struct mon_iso_desc *dp;
194 int i, ndesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 stamp = mon_get_timestamp();
197
198 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800199 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 rp->r.m_bus->cnt_text_lost++;
201 return;
202 }
203
204 ep->type = ev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 ep->id = (unsigned long) urb;
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700206 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400207 ep->devnum = urb->dev->devnum;
208 ep->epnum = usb_endpoint_num(&urb->ep->desc);
209 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
210 ep->is_in = usb_urb_dir_in(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 ep->tstamp = stamp;
212 ep->length = (ev_type == 'S') ?
213 urb->transfer_buffer_length : urb->actual_length;
214 /* Collecting status makes debugging sense for submits, too */
Alan Stern9347d512007-08-24 15:41:41 -0400215 ep->status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Alan Stern18ea5d02007-07-30 17:10:36 -0400217 if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800218 ep->interval = urb->interval;
Alan Stern18ea5d02007-07-30 17:10:36 -0400219 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800220 ep->interval = urb->interval;
221 ep->start_frame = urb->start_frame;
222 ep->error_count = urb->error_count;
223 }
224 ep->numdesc = urb->number_of_packets;
Alan Stern18ea5d02007-07-30 17:10:36 -0400225 if (ep->xfertype == USB_ENDPOINT_XFER_ISOC &&
226 urb->number_of_packets > 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800227 if ((ndesc = urb->number_of_packets) > ISODESC_MAX)
228 ndesc = ISODESC_MAX;
229 fp = urb->iso_frame_desc;
230 dp = ep->isodesc;
231 for (i = 0; i < ndesc; i++) {
232 dp->status = fp->status;
233 dp->offset = fp->offset;
234 dp->length = (ev_type == 'S') ?
235 fp->length : fp->actual_length;
236 fp++;
237 dp++;
238 }
239 }
240
Alan Stern4d6cd482006-08-30 11:35:21 -0400241 ep->setup_flag = mon_text_get_setup(ep, urb, ev_type, rp->r.m_bus);
242 ep->data_flag = mon_text_get_data(ep, urb, ep->length, ev_type,
243 rp->r.m_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245 rp->nevents++;
246 list_add_tail(&ep->e_link, &rp->e_list);
247 wake_up(&rp->wait);
248}
249
250static void mon_text_submit(void *data, struct urb *urb)
251{
252 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400253 mon_text_event(rp, urb, 'S', -EINPROGRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
Alan Stern9347d512007-08-24 15:41:41 -0400256static void mon_text_complete(void *data, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
258 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400259 mon_text_event(rp, urb, 'C', status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260}
261
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700262static void mon_text_error(void *data, struct urb *urb, int error)
263{
264 struct mon_reader_text *rp = data;
265 struct mon_event_text *ep;
266
267 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800268 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700269 rp->r.m_bus->cnt_text_lost++;
270 return;
271 }
272
273 ep->type = 'E';
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700274 ep->id = (unsigned long) urb;
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700275 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400276 ep->devnum = urb->dev->devnum;
277 ep->epnum = usb_endpoint_num(&urb->ep->desc);
278 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
279 ep->is_in = usb_urb_dir_in(urb);
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700280 ep->tstamp = mon_get_timestamp();
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700281 ep->length = 0;
282 ep->status = error;
283
284 ep->setup_flag = '-';
285 ep->data_flag = 'E';
286
287 rp->nevents++;
288 list_add_tail(&ep->e_link, &rp->e_list);
289 wake_up(&rp->wait);
290}
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292/*
293 * Fetch next event from the circular buffer.
294 */
295static struct mon_event_text *mon_text_fetch(struct mon_reader_text *rp,
296 struct mon_bus *mbus)
297{
298 struct list_head *p;
299 unsigned long flags;
300
301 spin_lock_irqsave(&mbus->lock, flags);
302 if (list_empty(&rp->e_list)) {
303 spin_unlock_irqrestore(&mbus->lock, flags);
304 return NULL;
305 }
306 p = rp->e_list.next;
307 list_del(p);
308 --rp->nevents;
309 spin_unlock_irqrestore(&mbus->lock, flags);
310 return list_entry(p, struct mon_event_text, e_link);
311}
312
313/*
314 */
315static int mon_text_open(struct inode *inode, struct file *file)
316{
317 struct mon_bus *mbus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 struct mon_reader_text *rp;
319 int rc;
320
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100321 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700322 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100324 rp = kzalloc(sizeof(struct mon_reader_text), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 if (rp == NULL) {
326 rc = -ENOMEM;
327 goto err_alloc;
328 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 INIT_LIST_HEAD(&rp->e_list);
330 init_waitqueue_head(&rp->wait);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100331 mutex_init(&rp->printf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333 rp->printf_size = PRINTF_DFL;
334 rp->printf_buf = kmalloc(rp->printf_size, GFP_KERNEL);
335 if (rp->printf_buf == NULL) {
336 rc = -ENOMEM;
337 goto err_alloc_pr;
338 }
339
340 rp->r.m_bus = mbus;
341 rp->r.r_data = rp;
342 rp->r.rnf_submit = mon_text_submit;
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700343 rp->r.rnf_error = mon_text_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 rp->r.rnf_complete = mon_text_complete;
345
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700346 snprintf(rp->slab_name, SLAB_NAME_SZ, "mon_text_%p", rp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 rp->e_slab = kmem_cache_create(rp->slab_name,
348 sizeof(struct mon_event_text), sizeof(long), 0,
Paul Mundt20c2df82007-07-20 10:11:58 +0900349 mon_text_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 if (rp->e_slab == NULL) {
351 rc = -ENOMEM;
352 goto err_slab;
353 }
354
355 mon_reader_add(mbus, &rp->r);
356
357 file->private_data = rp;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100358 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 return 0;
360
361// err_busy:
362// kmem_cache_destroy(rp->e_slab);
363err_slab:
364 kfree(rp->printf_buf);
365err_alloc_pr:
366 kfree(rp);
367err_alloc:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100368 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return rc;
370}
371
372/*
373 * For simplicity, we read one record in one system call and throw out
374 * what does not fit. This means that the following does not work:
375 * dd if=/dbg/usbmon/0t bs=10
376 * Also, we do not allow seeks and do not bother advancing the offset.
377 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800378static ssize_t mon_text_read_t(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 size_t nbytes, loff_t *ppos)
380{
381 struct mon_reader_text *rp = file->private_data;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800382 struct mon_event_text *ep;
383 struct mon_text_ptr ptr;
384
385 if (IS_ERR(ep = mon_text_read_wait(rp, file)))
386 return PTR_ERR(ep);
387 mutex_lock(&rp->printf_lock);
388 ptr.cnt = 0;
389 ptr.pbuf = rp->printf_buf;
390 ptr.limit = rp->printf_size;
391
392 mon_text_read_head_t(rp, &ptr, ep);
393 mon_text_read_statset(rp, &ptr, ep);
394 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
395 " %d", ep->length);
396 mon_text_read_data(rp, &ptr, ep);
397
398 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
399 ptr.cnt = -EFAULT;
400 mutex_unlock(&rp->printf_lock);
401 kmem_cache_free(rp->e_slab, ep);
402 return ptr.cnt;
403}
404
405static ssize_t mon_text_read_u(struct file *file, char __user *buf,
406 size_t nbytes, loff_t *ppos)
407{
408 struct mon_reader_text *rp = file->private_data;
409 struct mon_event_text *ep;
410 struct mon_text_ptr ptr;
411
412 if (IS_ERR(ep = mon_text_read_wait(rp, file)))
413 return PTR_ERR(ep);
414 mutex_lock(&rp->printf_lock);
415 ptr.cnt = 0;
416 ptr.pbuf = rp->printf_buf;
417 ptr.limit = rp->printf_size;
418
419 mon_text_read_head_u(rp, &ptr, ep);
420 if (ep->type == 'E') {
421 mon_text_read_statset(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400422 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800423 mon_text_read_isostat(rp, &ptr, ep);
424 mon_text_read_isodesc(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400425 } else if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800426 mon_text_read_intstat(rp, &ptr, ep);
427 } else {
428 mon_text_read_statset(rp, &ptr, ep);
429 }
430 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
431 " %d", ep->length);
432 mon_text_read_data(rp, &ptr, ep);
433
434 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
435 ptr.cnt = -EFAULT;
436 mutex_unlock(&rp->printf_lock);
437 kmem_cache_free(rp->e_slab, ep);
438 return ptr.cnt;
439}
440
441static struct mon_event_text *mon_text_read_wait(struct mon_reader_text *rp,
442 struct file *file)
443{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 struct mon_bus *mbus = rp->r.m_bus;
445 DECLARE_WAITQUEUE(waita, current);
446 struct mon_event_text *ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448 add_wait_queue(&rp->wait, &waita);
449 set_current_state(TASK_INTERRUPTIBLE);
450 while ((ep = mon_text_fetch(rp, mbus)) == NULL) {
451 if (file->f_flags & O_NONBLOCK) {
452 set_current_state(TASK_RUNNING);
453 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800454 return ERR_PTR(-EWOULDBLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 }
456 /*
457 * We do not count nwaiters, because ->release is supposed
458 * to be called when all openers are gone only.
459 */
460 schedule();
461 if (signal_pending(current)) {
462 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800463 return ERR_PTR(-EINTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465 set_current_state(TASK_INTERRUPTIBLE);
466 }
467 set_current_state(TASK_RUNNING);
468 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800469 return ep;
470}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800472static void mon_text_read_head_t(struct mon_reader_text *rp,
473 struct mon_text_ptr *p, const struct mon_event_text *ep)
474{
475 char udir, utype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Alan Stern18ea5d02007-07-30 17:10:36 -0400477 udir = (ep->is_in ? 'i' : 'o');
478 switch (ep->xfertype) {
479 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
480 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
481 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 default: /* PIPE_BULK */ utype = 'B';
483 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800484 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700485 "%lx %u %c %c%c:%03u:%02u",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400487 utype, udir, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800488}
489
490static void mon_text_read_head_u(struct mon_reader_text *rp,
491 struct mon_text_ptr *p, const struct mon_event_text *ep)
492{
493 char udir, utype;
494
Alan Stern18ea5d02007-07-30 17:10:36 -0400495 udir = (ep->is_in ? 'i' : 'o');
496 switch (ep->xfertype) {
497 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
498 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
499 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800500 default: /* PIPE_BULK */ utype = 'B';
501 }
502 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
503 "%lx %u %c %c%c:%d:%03u:%u",
504 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400505 utype, udir, ep->busnum, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800506}
507
508static void mon_text_read_statset(struct mon_reader_text *rp,
509 struct mon_text_ptr *p, const struct mon_event_text *ep)
510{
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700511
512 if (ep->setup_flag == 0) { /* Setup packet is present and captured */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800513 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700514 " s %02x %02x %04x %04x %04x",
515 ep->setup[0],
516 ep->setup[1],
517 (ep->setup[3] << 8) | ep->setup[2],
518 (ep->setup[5] << 8) | ep->setup[4],
519 (ep->setup[7] << 8) | ep->setup[6]);
520 } else if (ep->setup_flag != '-') { /* Unable to capture setup packet */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800521 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700522 " %c __ __ ____ ____ ____", ep->setup_flag);
523 } else { /* No setup for this kind of URB */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800524 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
525 " %d", ep->status);
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700526 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800527}
528
529static void mon_text_read_intstat(struct mon_reader_text *rp,
530 struct mon_text_ptr *p, const struct mon_event_text *ep)
531{
532 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
533 " %d:%d", ep->status, ep->interval);
534}
535
536static void mon_text_read_isostat(struct mon_reader_text *rp,
537 struct mon_text_ptr *p, const struct mon_event_text *ep)
538{
539 if (ep->type == 'S') {
540 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
541 " %d:%d:%d", ep->status, ep->interval, ep->start_frame);
542 } else {
543 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
544 " %d:%d:%d:%d",
545 ep->status, ep->interval, ep->start_frame, ep->error_count);
546 }
547}
548
549static void mon_text_read_isodesc(struct mon_reader_text *rp,
550 struct mon_text_ptr *p, const struct mon_event_text *ep)
551{
552 int ndesc; /* Display this many */
553 int i;
554 const struct mon_iso_desc *dp;
555
556 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
557 " %d", ep->numdesc);
558 ndesc = ep->numdesc;
559 if (ndesc > ISODESC_MAX)
560 ndesc = ISODESC_MAX;
561 if (ndesc < 0)
562 ndesc = 0;
563 dp = ep->isodesc;
564 for (i = 0; i < ndesc; i++) {
565 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
566 " %d:%u:%u", dp->status, dp->offset, dp->length);
567 dp++;
568 }
569}
570
571static void mon_text_read_data(struct mon_reader_text *rp,
572 struct mon_text_ptr *p, const struct mon_event_text *ep)
573{
574 int data_len, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576 if ((data_len = ep->length) > 0) {
577 if (ep->data_flag == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800578 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
579 " =");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 if (data_len >= DATA_MAX)
581 data_len = DATA_MAX;
582 for (i = 0; i < data_len; i++) {
583 if (i % 4 == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800584 p->cnt += snprintf(p->pbuf + p->cnt,
585 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 " ");
587 }
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 "%02x", ep->data[i]);
591 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800592 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
593 "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800595 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 " %c\n", ep->data_flag);
597 }
598 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800599 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601}
602
603static int mon_text_release(struct inode *inode, struct file *file)
604{
605 struct mon_reader_text *rp = file->private_data;
606 struct mon_bus *mbus;
607 /* unsigned long flags; */
608 struct list_head *p;
609 struct mon_event_text *ep;
610
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100611 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700612 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614 if (mbus->nreaders <= 0) {
615 printk(KERN_ERR TAG ": consistency error on close\n");
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100616 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return 0;
618 }
619 mon_reader_del(mbus, &rp->r);
620
621 /*
622 * In theory, e_list is protected by mbus->lock. However,
623 * after mon_reader_del has finished, the following is the case:
624 * - we are not on reader list anymore, so new events won't be added;
625 * - whole mbus may be dropped if it was orphaned.
626 * So, we better not touch mbus.
627 */
628 /* spin_lock_irqsave(&mbus->lock, flags); */
629 while (!list_empty(&rp->e_list)) {
630 p = rp->e_list.next;
631 ep = list_entry(p, struct mon_event_text, e_link);
632 list_del(p);
633 --rp->nevents;
634 kmem_cache_free(rp->e_slab, ep);
635 }
636 /* spin_unlock_irqrestore(&mbus->lock, flags); */
637
638 kmem_cache_destroy(rp->e_slab);
639 kfree(rp->printf_buf);
640 kfree(rp);
641
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100642 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 return 0;
644}
645
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800646static const struct file_operations mon_fops_text_t = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 .owner = THIS_MODULE,
648 .open = mon_text_open,
649 .llseek = no_llseek,
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800650 .read = mon_text_read_t,
651 .release = mon_text_release,
652};
653
654static const struct file_operations mon_fops_text_u = {
655 .owner = THIS_MODULE,
656 .open = mon_text_open,
657 .llseek = no_llseek,
658 .read = mon_text_read_u,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 .release = mon_text_release,
660};
661
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700662int mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800663{
664 struct dentry *d;
665 enum { NAMESZ = 10 };
666 char name[NAMESZ];
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700667 int busnum = ubus? ubus->busnum: 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800668 int rc;
669
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700670 if (ubus != NULL) {
671 rc = snprintf(name, NAMESZ, "%dt", busnum);
672 if (rc <= 0 || rc >= NAMESZ)
673 goto err_print_t;
674 d = debugfs_create_file(name, 0600, mon_dir, mbus,
675 &mon_fops_text_t);
676 if (d == NULL)
677 goto err_create_t;
678 mbus->dent_t = d;
679 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800680
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700681 rc = snprintf(name, NAMESZ, "%du", busnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800682 if (rc <= 0 || rc >= NAMESZ)
683 goto err_print_u;
684 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_text_u);
685 if (d == NULL)
686 goto err_create_u;
687 mbus->dent_u = d;
688
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700689 rc = snprintf(name, NAMESZ, "%ds", busnum);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800690 if (rc <= 0 || rc >= NAMESZ)
691 goto err_print_s;
692 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_stat);
693 if (d == NULL)
694 goto err_create_s;
695 mbus->dent_s = d;
696
697 return 1;
698
699err_create_s:
700err_print_s:
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800701 debugfs_remove(mbus->dent_u);
702 mbus->dent_u = NULL;
703err_create_u:
704err_print_u:
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700705 if (ubus != NULL) {
706 debugfs_remove(mbus->dent_t);
707 mbus->dent_t = NULL;
708 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800709err_create_t:
710err_print_t:
711 return 0;
712}
713
714void mon_text_del(struct mon_bus *mbus)
715{
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800716 debugfs_remove(mbus->dent_u);
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700717 if (mbus->dent_t != NULL)
718 debugfs_remove(mbus->dent_t);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800719 debugfs_remove(mbus->dent_s);
720}
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722/*
723 * Slab interface: constructor.
724 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700725static void mon_text_ctor(void *mem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
727 /*
728 * Nothing to initialize. No, really!
729 * So, we fill it with garbage to emulate a reused object.
730 */
731 memset(mem, 0xe5, sizeof(struct mon_event_text));
732}
733
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800734int __init mon_text_init(void)
735{
736 struct dentry *mondir;
737
Greg Kroah-Hartmanf49ce962009-04-24 15:15:49 -0700738 mondir = debugfs_create_dir("usbmon", usb_debug_root);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800739 if (IS_ERR(mondir)) {
740 printk(KERN_NOTICE TAG ": debugfs is not available\n");
741 return -ENODEV;
742 }
743 if (mondir == NULL) {
744 printk(KERN_NOTICE TAG ": unable to create usbmon directory\n");
745 return -ENODEV;
746 }
747 mon_dir = mondir;
748 return 0;
749}
750
Pete Zaitcev21641e32007-02-20 10:37:52 -0800751void mon_text_exit(void)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800752{
753 debugfs_remove(mon_dir);
754}