usbmon: Extended text API
[powerpc.git] / drivers / usb / mon / usb_mon.h
1 /*
2  * The USB Monitor, inspired by Dave Harding's USBMon.
3  *
4  * Copyright (C) 2005 Pete Zaitcev (zaitcev@redhat.com)
5  */
6
7 #ifndef __USB_MON_H
8 #define __USB_MON_H
9
10 #include <linux/list.h>
11 #include <linux/slab.h>
12 #include <linux/kref.h>
13 /* #include <linux/usb.h> */    /* We use struct pointers only in this header */
14
15 #define TAG "usbmon"
16
17 struct mon_bus {
18         struct list_head bus_link;
19         spinlock_t lock;
20         struct usb_bus *u_bus;
21
22         int text_inited;
23         struct dentry *dent_s;          /* Debugging file */
24         struct dentry *dent_t;          /* Text interface file */
25         struct dentry *dent_u;          /* Second text interface file */
26         int uses_dma;
27
28         /* Ref */
29         int nreaders;                   /* Under mon_lock AND mbus->lock */
30         struct list_head r_list;        /* Chain of readers (usually one) */
31         struct kref ref;                /* Under mon_lock */
32
33         /* Stats */
34         unsigned int cnt_events;
35         unsigned int cnt_text_lost;
36 };
37
38 /*
39  * An instance of a process which opened a file (but can fork later)
40  */
41 struct mon_reader {
42         struct list_head r_link;
43         struct mon_bus *m_bus;
44         void *r_data;           /* Use container_of instead? */
45
46         void (*rnf_submit)(void *data, struct urb *urb);
47         void (*rnf_error)(void *data, struct urb *urb, int error);
48         void (*rnf_complete)(void *data, struct urb *urb);
49 };
50
51 void mon_reader_add(struct mon_bus *mbus, struct mon_reader *r);
52 void mon_reader_del(struct mon_bus *mbus, struct mon_reader *r);
53
54 struct mon_bus *mon_bus_lookup(unsigned int num);
55
56 int /*bool*/ mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus);
57 void mon_text_del(struct mon_bus *mbus);
58 // void mon_bin_add(struct mon_bus *);
59
60 int __init mon_text_init(void);
61 void mon_text_exit(void);
62 int __init mon_bin_init(void);
63 void mon_bin_exit(void);
64
65 /*
66  * DMA interface.
67  *
68  * XXX The vectored side needs a serious re-thinking. Abstracting vectors,
69  * like in Paolo's original patch, produces a double pkmap. We need an idea.
70 */
71 extern char mon_dmapeek(unsigned char *dst, dma_addr_t dma_addr, int len);
72
73 struct mon_reader_bin;
74 extern void mon_dmapeek_vec(const struct mon_reader_bin *rp,
75     unsigned int offset, dma_addr_t dma_addr, unsigned int len);
76 extern unsigned int mon_copy_to_buff(const struct mon_reader_bin *rp,
77     unsigned int offset, const unsigned char *from, unsigned int len);
78
79 /*
80  */
81 extern struct mutex mon_lock;
82
83 extern const struct file_operations mon_fops_stat;
84
85 #endif /* __USB_MON_H */