blob: f5e1bb5e521777f1e5b6b29c61f4c4f9f19f9662 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * The USB Monitor, inspired by Dave Harding's USBMon.
4 *
5 * This is a text format reader.
6 */
7
8#include <linux/kernel.h>
9#include <linux/list.h>
10#include <linux/usb.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010012#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/time.h>
Tina Ruchandaniec4dca82015-10-29 22:58:28 -070014#include <linux/ktime.h>
Paul Gortmakerf940fcd2011-05-27 09:56:31 -040015#include <linux/export.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010016#include <linux/mutex.h>
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080017#include <linux/debugfs.h>
Alan Sternb375e112009-11-06 12:32:23 -050018#include <linux/scatterlist.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080019#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include "usb_mon.h"
22
23/*
24 * No, we do not want arbitrarily long data strings.
25 * Use the binary interface if you want to capture bulk data!
26 */
27#define DATA_MAX 32
28
29/*
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070030 * Defined by USB 2.0 clause 9.3, table 9.2.
31 */
32#define SETUP_MAX 8
33
34/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 * This limit exists to prevent OOMs when the user process stops reading.
Pete Zaitcev5b1c6742006-06-09 20:10:10 -070036 * If usbmon were available to unprivileged processes, it might be open
37 * to a local DoS. But we have to keep to root in order to prevent
38 * password sniffing from HID devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080040#define EVENT_MAX (4*PAGE_SIZE / sizeof(struct mon_event_text))
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080042/*
43 * Potentially unlimited number; we limit it for similar allocations.
44 * The usbfs limits this to 128, but we're not quite as generous.
45 */
46#define ISODESC_MAX 5
47
48#define PRINTF_DFL 250 /* with 5 ISOs segs */
49
50struct mon_iso_desc {
51 int status;
52 unsigned int offset;
53 unsigned int length; /* Unsigned here, signed in URB. Historic. */
54};
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56struct mon_event_text {
57 struct list_head e_link;
58 int type; /* submit, complete, etc. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 unsigned long id; /* From pointer, most of the time */
60 unsigned int tstamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080061 int busnum;
Pete Zaitcev30c74312007-08-14 00:33:40 -070062 char devnum;
63 char epnum;
64 char is_in;
65 char xfertype;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 int length; /* Depends on type: xfer length or act length */
67 int status;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080068 int interval;
69 int start_frame;
70 int error_count;
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070071 char setup_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 char data_flag;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080073 int numdesc; /* Full number */
74 struct mon_iso_desc isodesc[ISODESC_MAX];
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -070075 unsigned char setup[SETUP_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 unsigned char data[DATA_MAX];
77};
78
79#define SLAB_NAME_SZ 30
80struct mon_reader_text {
Christoph Lametere18b8902006-12-06 20:33:20 -080081 struct kmem_cache *e_slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 int nevents;
83 struct list_head e_list;
84 struct mon_reader r; /* In C, parent class can be placed anywhere */
85
86 wait_queue_head_t wait;
87 int printf_size;
88 char *printf_buf;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010089 struct mutex printf_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91 char slab_name[SLAB_NAME_SZ];
92};
93
Pete Zaitcev6f23ee12006-12-30 22:43:10 -080094static struct dentry *mon_dir; /* Usually /sys/kernel/debug/usbmon */
95
Alexey Dobriyan51cc5062008-07-25 19:45:34 -070096static void mon_text_ctor(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Pete Zaitcevf1c9e302007-02-24 19:27:33 -080098struct mon_text_ptr {
99 int cnt, limit;
100 char *pbuf;
101};
102
103static struct mon_event_text *
104 mon_text_read_wait(struct mon_reader_text *rp, struct file *file);
105static void mon_text_read_head_t(struct mon_reader_text *rp,
106 struct mon_text_ptr *p, const struct mon_event_text *ep);
107static void mon_text_read_head_u(struct mon_reader_text *rp,
108 struct mon_text_ptr *p, const struct mon_event_text *ep);
109static void mon_text_read_statset(struct mon_reader_text *rp,
110 struct mon_text_ptr *p, const struct mon_event_text *ep);
111static void mon_text_read_intstat(struct mon_reader_text *rp,
112 struct mon_text_ptr *p, const struct mon_event_text *ep);
113static void mon_text_read_isostat(struct mon_reader_text *rp,
114 struct mon_text_ptr *p, const struct mon_event_text *ep);
115static void mon_text_read_isodesc(struct mon_reader_text *rp,
116 struct mon_text_ptr *p, const struct mon_event_text *ep);
117static void mon_text_read_data(struct mon_reader_text *rp,
118 struct mon_text_ptr *p, const struct mon_event_text *ep);
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*
121 * mon_text_submit
122 * mon_text_complete
123 *
124 * May be called from an interrupt.
125 *
126 * This is called with the whole mon_bus locked, so no additional lock.
127 */
128
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700129static inline char mon_text_get_setup(struct mon_event_text *ep,
Alan Stern4d6cd482006-08-30 11:35:21 -0400130 struct urb *urb, char ev_type, struct mon_bus *mbus)
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700131{
132
Alan Stern18ea5d02007-07-30 17:10:36 -0400133 if (ep->xfertype != USB_ENDPOINT_XFER_CONTROL || ev_type != 'S')
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700134 return '-';
135
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700136 if (urb->setup_packet == NULL)
137 return 'Z'; /* '0' would be not as pretty. */
138
139 memcpy(ep->setup, urb->setup_packet, SETUP_MAX);
140 return 0;
141}
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static inline char mon_text_get_data(struct mon_event_text *ep, struct urb *urb,
Alan Stern4d6cd482006-08-30 11:35:21 -0400144 int len, char ev_type, struct mon_bus *mbus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
Alan Sternb375e112009-11-06 12:32:23 -0500146 void *src;
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 if (len <= 0)
149 return 'L';
Pete Zaitcev02568392005-08-15 16:53:57 -0700150 if (len >= DATA_MAX)
151 len = DATA_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Alan Stern18ea5d02007-07-30 17:10:36 -0400153 if (ep->is_in) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800154 if (ev_type != 'C')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800155 return '<';
156 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800157 if (ev_type != 'S')
Pete Zaitcevb9b09422005-12-03 21:52:10 -0800158 return '>';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 }
160
Alan Sternb375e112009-11-06 12:32:23 -0500161 if (urb->num_sgs == 0) {
162 src = urb->transfer_buffer;
163 if (src == NULL)
164 return 'Z'; /* '0' would be not as pretty. */
165 } else {
Matthew Wilcox910f8d02010-05-01 12:20:01 -0600166 struct scatterlist *sg = urb->sg;
Pete Zaitcev02568392005-08-15 16:53:57 -0700167
Alan Sternff9c8952010-04-02 13:27:28 -0400168 if (PageHighMem(sg_page(sg)))
Alan Sternb375e112009-11-06 12:32:23 -0500169 return 'D';
170
171 /* For the text interface we copy only the first sg buffer */
172 len = min_t(int, sg->length, len);
173 src = sg_virt(sg);
174 }
175
176 memcpy(ep->data, src, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 return 0;
178}
179
180static inline unsigned int mon_get_timestamp(void)
181{
Tina Ruchandaniec4dca82015-10-29 22:58:28 -0700182 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 unsigned int stamp;
184
Tina Ruchandaniec4dca82015-10-29 22:58:28 -0700185 ktime_get_ts64(&now);
186 stamp = now.tv_sec & 0xFFF; /* 2^32 = 4294967296. Limit to 4096s. */
187 stamp = stamp * USEC_PER_SEC + now.tv_nsec / NSEC_PER_USEC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 return stamp;
189}
190
191static void mon_text_event(struct mon_reader_text *rp, struct urb *urb,
Alan Stern9347d512007-08-24 15:41:41 -0400192 char ev_type, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
194 struct mon_event_text *ep;
195 unsigned int stamp;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800196 struct usb_iso_packet_descriptor *fp;
197 struct mon_iso_desc *dp;
198 int i, ndesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 stamp = mon_get_timestamp();
201
202 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800203 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 rp->r.m_bus->cnt_text_lost++;
205 return;
206 }
207
208 ep->type = ev_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 ep->id = (unsigned long) urb;
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700210 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400211 ep->devnum = urb->dev->devnum;
212 ep->epnum = usb_endpoint_num(&urb->ep->desc);
213 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
214 ep->is_in = usb_urb_dir_in(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 ep->tstamp = stamp;
216 ep->length = (ev_type == 'S') ?
217 urb->transfer_buffer_length : urb->actual_length;
218 /* Collecting status makes debugging sense for submits, too */
Alan Stern9347d512007-08-24 15:41:41 -0400219 ep->status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Alan Stern18ea5d02007-07-30 17:10:36 -0400221 if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800222 ep->interval = urb->interval;
Alan Stern18ea5d02007-07-30 17:10:36 -0400223 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800224 ep->interval = urb->interval;
225 ep->start_frame = urb->start_frame;
226 ep->error_count = urb->error_count;
227 }
228 ep->numdesc = urb->number_of_packets;
Alan Stern18ea5d02007-07-30 17:10:36 -0400229 if (ep->xfertype == USB_ENDPOINT_XFER_ISOC &&
230 urb->number_of_packets > 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800231 if ((ndesc = urb->number_of_packets) > ISODESC_MAX)
232 ndesc = ISODESC_MAX;
233 fp = urb->iso_frame_desc;
234 dp = ep->isodesc;
235 for (i = 0; i < ndesc; i++) {
236 dp->status = fp->status;
237 dp->offset = fp->offset;
238 dp->length = (ev_type == 'S') ?
239 fp->length : fp->actual_length;
240 fp++;
241 dp++;
242 }
Pete Zaitcevd25bc4d2011-02-03 22:01:36 -0700243 /* Wasteful, but simple to understand: ISO 'C' is sparse. */
244 if (ev_type == 'C')
245 ep->length = urb->transfer_buffer_length;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800246 }
247
Alan Stern4d6cd482006-08-30 11:35:21 -0400248 ep->setup_flag = mon_text_get_setup(ep, urb, ev_type, rp->r.m_bus);
249 ep->data_flag = mon_text_get_data(ep, urb, ep->length, ev_type,
250 rp->r.m_bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252 rp->nevents++;
253 list_add_tail(&ep->e_link, &rp->e_list);
254 wake_up(&rp->wait);
255}
256
257static void mon_text_submit(void *data, struct urb *urb)
258{
259 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400260 mon_text_event(rp, urb, 'S', -EINPROGRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
262
Alan Stern9347d512007-08-24 15:41:41 -0400263static void mon_text_complete(void *data, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
265 struct mon_reader_text *rp = data;
Alan Stern9347d512007-08-24 15:41:41 -0400266 mon_text_event(rp, urb, 'C', status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267}
268
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700269static void mon_text_error(void *data, struct urb *urb, int error)
270{
271 struct mon_reader_text *rp = data;
272 struct mon_event_text *ep;
273
274 if (rp->nevents >= EVENT_MAX ||
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800275 (ep = kmem_cache_alloc(rp->e_slab, GFP_ATOMIC)) == NULL) {
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700276 rp->r.m_bus->cnt_text_lost++;
277 return;
278 }
279
280 ep->type = 'E';
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700281 ep->id = (unsigned long) urb;
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700282 ep->busnum = urb->dev->bus->busnum;
Alan Stern18ea5d02007-07-30 17:10:36 -0400283 ep->devnum = urb->dev->devnum;
284 ep->epnum = usb_endpoint_num(&urb->ep->desc);
285 ep->xfertype = usb_endpoint_type(&urb->ep->desc);
286 ep->is_in = usb_urb_dir_in(urb);
Pete Zaitcev2bc0d1092010-01-05 11:50:07 -0700287 ep->tstamp = mon_get_timestamp();
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700288 ep->length = 0;
289 ep->status = error;
290
291 ep->setup_flag = '-';
292 ep->data_flag = 'E';
293
294 rp->nevents++;
295 list_add_tail(&ep->e_link, &rp->e_list);
296 wake_up(&rp->wait);
297}
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299/*
300 * Fetch next event from the circular buffer.
301 */
302static struct mon_event_text *mon_text_fetch(struct mon_reader_text *rp,
303 struct mon_bus *mbus)
304{
305 struct list_head *p;
306 unsigned long flags;
307
308 spin_lock_irqsave(&mbus->lock, flags);
309 if (list_empty(&rp->e_list)) {
310 spin_unlock_irqrestore(&mbus->lock, flags);
311 return NULL;
312 }
313 p = rp->e_list.next;
314 list_del(p);
315 --rp->nevents;
316 spin_unlock_irqrestore(&mbus->lock, flags);
317 return list_entry(p, struct mon_event_text, e_link);
318}
319
320/*
321 */
322static int mon_text_open(struct inode *inode, struct file *file)
323{
324 struct mon_bus *mbus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 struct mon_reader_text *rp;
326 int rc;
327
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100328 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700329 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100331 rp = kzalloc(sizeof(struct mon_reader_text), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 if (rp == NULL) {
333 rc = -ENOMEM;
334 goto err_alloc;
335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 INIT_LIST_HEAD(&rp->e_list);
337 init_waitqueue_head(&rp->wait);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100338 mutex_init(&rp->printf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 rp->printf_size = PRINTF_DFL;
341 rp->printf_buf = kmalloc(rp->printf_size, GFP_KERNEL);
342 if (rp->printf_buf == NULL) {
343 rc = -ENOMEM;
344 goto err_alloc_pr;
345 }
346
347 rp->r.m_bus = mbus;
348 rp->r.r_data = rp;
349 rp->r.rnf_submit = mon_text_submit;
Pete Zaitcev12e72fe2006-06-09 22:03:32 -0700350 rp->r.rnf_error = mon_text_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 rp->r.rnf_complete = mon_text_complete;
352
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700353 snprintf(rp->slab_name, SLAB_NAME_SZ, "mon_text_%p", rp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 rp->e_slab = kmem_cache_create(rp->slab_name,
355 sizeof(struct mon_event_text), sizeof(long), 0,
Paul Mundt20c2df82007-07-20 10:11:58 +0900356 mon_text_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 if (rp->e_slab == NULL) {
358 rc = -ENOMEM;
359 goto err_slab;
360 }
361
362 mon_reader_add(mbus, &rp->r);
363
364 file->private_data = rp;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100365 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 return 0;
367
368// err_busy:
369// kmem_cache_destroy(rp->e_slab);
370err_slab:
371 kfree(rp->printf_buf);
372err_alloc_pr:
373 kfree(rp);
374err_alloc:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100375 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 return rc;
377}
378
379/*
380 * For simplicity, we read one record in one system call and throw out
381 * what does not fit. This means that the following does not work:
382 * dd if=/dbg/usbmon/0t bs=10
383 * Also, we do not allow seeks and do not bother advancing the offset.
384 */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800385static ssize_t mon_text_read_t(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 size_t nbytes, loff_t *ppos)
387{
388 struct mon_reader_text *rp = file->private_data;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800389 struct mon_event_text *ep;
390 struct mon_text_ptr ptr;
391
Julia Lawall46c236d2015-12-26 22:57:44 +0100392 ep = mon_text_read_wait(rp, file);
393 if (IS_ERR(ep))
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800394 return PTR_ERR(ep);
395 mutex_lock(&rp->printf_lock);
396 ptr.cnt = 0;
397 ptr.pbuf = rp->printf_buf;
398 ptr.limit = rp->printf_size;
399
400 mon_text_read_head_t(rp, &ptr, ep);
401 mon_text_read_statset(rp, &ptr, ep);
402 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
403 " %d", ep->length);
404 mon_text_read_data(rp, &ptr, ep);
405
406 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
407 ptr.cnt = -EFAULT;
408 mutex_unlock(&rp->printf_lock);
409 kmem_cache_free(rp->e_slab, ep);
410 return ptr.cnt;
411}
412
413static ssize_t mon_text_read_u(struct file *file, char __user *buf,
414 size_t nbytes, loff_t *ppos)
415{
416 struct mon_reader_text *rp = file->private_data;
417 struct mon_event_text *ep;
418 struct mon_text_ptr ptr;
419
Julia Lawall46c236d2015-12-26 22:57:44 +0100420 ep = mon_text_read_wait(rp, file);
421 if (IS_ERR(ep))
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800422 return PTR_ERR(ep);
423 mutex_lock(&rp->printf_lock);
424 ptr.cnt = 0;
425 ptr.pbuf = rp->printf_buf;
426 ptr.limit = rp->printf_size;
427
428 mon_text_read_head_u(rp, &ptr, ep);
429 if (ep->type == 'E') {
430 mon_text_read_statset(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400431 } else if (ep->xfertype == USB_ENDPOINT_XFER_ISOC) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800432 mon_text_read_isostat(rp, &ptr, ep);
433 mon_text_read_isodesc(rp, &ptr, ep);
Alan Stern18ea5d02007-07-30 17:10:36 -0400434 } else if (ep->xfertype == USB_ENDPOINT_XFER_INT) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800435 mon_text_read_intstat(rp, &ptr, ep);
436 } else {
437 mon_text_read_statset(rp, &ptr, ep);
438 }
439 ptr.cnt += snprintf(ptr.pbuf + ptr.cnt, ptr.limit - ptr.cnt,
440 " %d", ep->length);
441 mon_text_read_data(rp, &ptr, ep);
442
443 if (copy_to_user(buf, rp->printf_buf, ptr.cnt))
444 ptr.cnt = -EFAULT;
445 mutex_unlock(&rp->printf_lock);
446 kmem_cache_free(rp->e_slab, ep);
447 return ptr.cnt;
448}
449
450static struct mon_event_text *mon_text_read_wait(struct mon_reader_text *rp,
451 struct file *file)
452{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 struct mon_bus *mbus = rp->r.m_bus;
454 DECLARE_WAITQUEUE(waita, current);
455 struct mon_event_text *ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 add_wait_queue(&rp->wait, &waita);
458 set_current_state(TASK_INTERRUPTIBLE);
459 while ((ep = mon_text_fetch(rp, mbus)) == NULL) {
460 if (file->f_flags & O_NONBLOCK) {
461 set_current_state(TASK_RUNNING);
462 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800463 return ERR_PTR(-EWOULDBLOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465 /*
466 * We do not count nwaiters, because ->release is supposed
467 * to be called when all openers are gone only.
468 */
469 schedule();
470 if (signal_pending(current)) {
471 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800472 return ERR_PTR(-EINTR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 }
474 set_current_state(TASK_INTERRUPTIBLE);
475 }
476 set_current_state(TASK_RUNNING);
477 remove_wait_queue(&rp->wait, &waita);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800478 return ep;
479}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800481static void mon_text_read_head_t(struct mon_reader_text *rp,
482 struct mon_text_ptr *p, const struct mon_event_text *ep)
483{
484 char udir, utype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Alan Stern18ea5d02007-07-30 17:10:36 -0400486 udir = (ep->is_in ? 'i' : 'o');
487 switch (ep->xfertype) {
488 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
489 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
490 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 default: /* PIPE_BULK */ utype = 'B';
492 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800493 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700494 "%lx %u %c %c%c:%03u:%02u",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400496 utype, udir, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800497}
498
499static void mon_text_read_head_u(struct mon_reader_text *rp,
500 struct mon_text_ptr *p, const struct mon_event_text *ep)
501{
502 char udir, utype;
503
Alan Stern18ea5d02007-07-30 17:10:36 -0400504 udir = (ep->is_in ? 'i' : 'o');
505 switch (ep->xfertype) {
506 case USB_ENDPOINT_XFER_ISOC: utype = 'Z'; break;
507 case USB_ENDPOINT_XFER_INT: utype = 'I'; break;
508 case USB_ENDPOINT_XFER_CONTROL: utype = 'C'; break;
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800509 default: /* PIPE_BULK */ utype = 'B';
510 }
511 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
512 "%lx %u %c %c%c:%d:%03u:%u",
513 ep->id, ep->tstamp, ep->type,
Alan Stern18ea5d02007-07-30 17:10:36 -0400514 utype, udir, ep->busnum, ep->devnum, ep->epnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800515}
516
517static void mon_text_read_statset(struct mon_reader_text *rp,
518 struct mon_text_ptr *p, const struct mon_event_text *ep)
519{
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700520
521 if (ep->setup_flag == 0) { /* Setup packet is present and captured */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800522 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700523 " s %02x %02x %04x %04x %04x",
524 ep->setup[0],
525 ep->setup[1],
526 (ep->setup[3] << 8) | ep->setup[2],
527 (ep->setup[5] << 8) | ep->setup[4],
528 (ep->setup[7] << 8) | ep->setup[6]);
529 } else if (ep->setup_flag != '-') { /* Unable to capture setup packet */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800530 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700531 " %c __ __ ____ ____ ____", ep->setup_flag);
532 } else { /* No setup for this kind of URB */
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800533 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
534 " %d", ep->status);
Pete Zaitcevae0d6cc2005-06-25 14:32:59 -0700535 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800536}
537
538static void mon_text_read_intstat(struct mon_reader_text *rp,
539 struct mon_text_ptr *p, const struct mon_event_text *ep)
540{
541 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
542 " %d:%d", ep->status, ep->interval);
543}
544
545static void mon_text_read_isostat(struct mon_reader_text *rp,
546 struct mon_text_ptr *p, const struct mon_event_text *ep)
547{
548 if (ep->type == 'S') {
549 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
550 " %d:%d:%d", ep->status, ep->interval, ep->start_frame);
551 } else {
552 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
553 " %d:%d:%d:%d",
554 ep->status, ep->interval, ep->start_frame, ep->error_count);
555 }
556}
557
558static void mon_text_read_isodesc(struct mon_reader_text *rp,
559 struct mon_text_ptr *p, const struct mon_event_text *ep)
560{
561 int ndesc; /* Display this many */
562 int i;
563 const struct mon_iso_desc *dp;
564
565 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
566 " %d", ep->numdesc);
567 ndesc = ep->numdesc;
568 if (ndesc > ISODESC_MAX)
569 ndesc = ISODESC_MAX;
570 if (ndesc < 0)
571 ndesc = 0;
572 dp = ep->isodesc;
573 for (i = 0; i < ndesc; i++) {
574 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
575 " %d:%u:%u", dp->status, dp->offset, dp->length);
576 dp++;
577 }
578}
579
580static void mon_text_read_data(struct mon_reader_text *rp,
581 struct mon_text_ptr *p, const struct mon_event_text *ep)
582{
583 int data_len, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
585 if ((data_len = ep->length) > 0) {
586 if (ep->data_flag == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800587 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
588 " =");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 if (data_len >= DATA_MAX)
590 data_len = DATA_MAX;
591 for (i = 0; i < data_len; i++) {
592 if (i % 4 == 0) {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800593 p->cnt += snprintf(p->pbuf + p->cnt,
594 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 " ");
596 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800597 p->cnt += snprintf(p->pbuf + p->cnt,
598 p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 "%02x", ep->data[i]);
600 }
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800601 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
602 "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800604 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 " %c\n", ep->data_flag);
606 }
607 } else {
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800608 p->cnt += snprintf(p->pbuf + p->cnt, p->limit - p->cnt, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610}
611
612static int mon_text_release(struct inode *inode, struct file *file)
613{
614 struct mon_reader_text *rp = file->private_data;
615 struct mon_bus *mbus;
616 /* unsigned long flags; */
617 struct list_head *p;
618 struct mon_event_text *ep;
619
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100620 mutex_lock(&mon_lock);
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700621 mbus = inode->i_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623 if (mbus->nreaders <= 0) {
624 printk(KERN_ERR TAG ": consistency error on close\n");
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100625 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 return 0;
627 }
628 mon_reader_del(mbus, &rp->r);
629
630 /*
631 * In theory, e_list is protected by mbus->lock. However,
632 * after mon_reader_del has finished, the following is the case:
633 * - we are not on reader list anymore, so new events won't be added;
634 * - whole mbus may be dropped if it was orphaned.
635 * So, we better not touch mbus.
636 */
637 /* spin_lock_irqsave(&mbus->lock, flags); */
638 while (!list_empty(&rp->e_list)) {
639 p = rp->e_list.next;
640 ep = list_entry(p, struct mon_event_text, e_link);
641 list_del(p);
642 --rp->nevents;
643 kmem_cache_free(rp->e_slab, ep);
644 }
645 /* spin_unlock_irqrestore(&mbus->lock, flags); */
646
647 kmem_cache_destroy(rp->e_slab);
648 kfree(rp->printf_buf);
649 kfree(rp);
650
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100651 mutex_unlock(&mon_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return 0;
653}
654
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800655static const struct file_operations mon_fops_text_t = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 .owner = THIS_MODULE,
657 .open = mon_text_open,
658 .llseek = no_llseek,
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800659 .read = mon_text_read_t,
660 .release = mon_text_release,
661};
662
663static const struct file_operations mon_fops_text_u = {
664 .owner = THIS_MODULE,
665 .open = mon_text_open,
666 .llseek = no_llseek,
667 .read = mon_text_read_u,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 .release = mon_text_release,
669};
670
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700671int mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800672{
673 struct dentry *d;
674 enum { NAMESZ = 10 };
675 char name[NAMESZ];
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700676 int busnum = ubus? ubus->busnum: 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800677 int rc;
678
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200679 if (mon_dir == NULL)
680 return 0;
681
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700682 if (ubus != NULL) {
683 rc = snprintf(name, NAMESZ, "%dt", busnum);
684 if (rc <= 0 || rc >= NAMESZ)
685 goto err_print_t;
686 d = debugfs_create_file(name, 0600, mon_dir, mbus,
687 &mon_fops_text_t);
688 if (d == NULL)
689 goto err_create_t;
690 mbus->dent_t = d;
691 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800692
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700693 rc = snprintf(name, NAMESZ, "%du", busnum);
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800694 if (rc <= 0 || rc >= NAMESZ)
695 goto err_print_u;
696 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_text_u);
697 if (d == NULL)
698 goto err_create_u;
699 mbus->dent_u = d;
700
Pete Zaitcevecb658d2007-04-11 13:47:26 -0700701 rc = snprintf(name, NAMESZ, "%ds", busnum);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800702 if (rc <= 0 || rc >= NAMESZ)
703 goto err_print_s;
704 d = debugfs_create_file(name, 0600, mon_dir, mbus, &mon_fops_stat);
705 if (d == NULL)
706 goto err_create_s;
707 mbus->dent_s = d;
708
709 return 1;
710
711err_create_s:
712err_print_s:
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800713 debugfs_remove(mbus->dent_u);
714 mbus->dent_u = NULL;
715err_create_u:
716err_print_u:
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700717 if (ubus != NULL) {
718 debugfs_remove(mbus->dent_t);
719 mbus->dent_t = NULL;
720 }
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800721err_create_t:
722err_print_t:
723 return 0;
724}
725
726void mon_text_del(struct mon_bus *mbus)
727{
Pete Zaitcevf1c9e302007-02-24 19:27:33 -0800728 debugfs_remove(mbus->dent_u);
Pete Zaitcevce7cd137f2007-05-03 16:51:16 -0700729 if (mbus->dent_t != NULL)
730 debugfs_remove(mbus->dent_t);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800731 debugfs_remove(mbus->dent_s);
732}
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734/*
735 * Slab interface: constructor.
736 */
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700737static void mon_text_ctor(void *mem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
739 /*
740 * Nothing to initialize. No, really!
741 * So, we fill it with garbage to emulate a reused object.
742 */
743 memset(mem, 0xe5, sizeof(struct mon_event_text));
744}
745
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800746int __init mon_text_init(void)
747{
748 struct dentry *mondir;
749
Greg Kroah-Hartmanf49ce962009-04-24 15:15:49 -0700750 mondir = debugfs_create_dir("usbmon", usb_debug_root);
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800751 if (IS_ERR(mondir)) {
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200752 /* debugfs not available, but we can use usbmon without it */
753 return 0;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800754 }
755 if (mondir == NULL) {
756 printk(KERN_NOTICE TAG ": unable to create usbmon directory\n");
Tobias Klauser8dec92b2011-07-07 09:28:21 +0200757 return -ENOMEM;
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800758 }
759 mon_dir = mondir;
760 return 0;
761}
762
Pete Zaitcev21641e32007-02-20 10:37:52 -0800763void mon_text_exit(void)
Pete Zaitcev6f23ee12006-12-30 22:43:10 -0800764{
765 debugfs_remove(mon_dir);
766}