[mirror_ubuntu-jammy-kernel.git] / drivers / usb / mon / usb_mon.h

/*
 * The USB Monitor, inspired by Dave Harding's USBMon.
 *
 * Copyright (C) 2005 Pete Zaitcev (zaitcev@redhat.com)
 */

#ifndef __USB_MON_H
#define __USB_MON_H

#include <linux/list.h>
#include <linux/slab.h>
#include <linux/kref.h>
/* #include <linux/usb.h> */	/* We use struct pointers only in this header */

#define TAG "usbmon"

struct mon_bus {
	struct list_head bus_link;
	spinlock_t lock;
	struct usb_bus *u_bus;

	int text_inited;
	struct dentry *dent_s;		/* Debugging file */
	struct dentry *dent_t;		/* Text interface file */
	int uses_dma;

	/* Ref */
	int nreaders;			/* Under mon_lock AND mbus->lock */
	struct list_head r_list;	/* Chain of readers (usually one) */
	struct kref ref;		/* Under mon_lock */

	/* Stats */
	unsigned int cnt_events;
	unsigned int cnt_text_lost;
};

/*
 * An instance of a process which opened a file (but can fork later)
 */
struct mon_reader {
	struct list_head r_link;
	struct mon_bus *m_bus;
	void *r_data;		/* Use container_of instead? */

	void (*rnf_submit)(void *data, struct urb *urb);
	void (*rnf_error)(void *data, struct urb *urb, int error);
	void (*rnf_complete)(void *data, struct urb *urb);
};

void mon_reader_add(struct mon_bus *mbus, struct mon_reader *r);
void mon_reader_del(struct mon_bus *mbus, struct mon_reader *r);

struct mon_bus *mon_bus_lookup(unsigned int num);

int /*bool*/ mon_text_add(struct mon_bus *mbus, const struct usb_bus *ubus);
void mon_text_del(struct mon_bus *mbus);
// void mon_bin_add(struct mon_bus *);

int __init mon_text_init(void);
void __exit mon_text_exit(void);
int __init mon_bin_init(void);
void __exit mon_bin_exit(void);

/*
 * DMA interface.
 *
 * XXX The vectored side needs a serious re-thinking. Abstracting vectors,
 * like in Paolo's original patch, produces a double pkmap. We need an idea.
*/
extern char mon_dmapeek(unsigned char *dst, dma_addr_t dma_addr, int len);

struct mon_reader_bin;
extern void mon_dmapeek_vec(const struct mon_reader_bin *rp,
    unsigned int offset, dma_addr_t dma_addr, unsigned int len);
extern unsigned int mon_copy_to_buff(const struct mon_reader_bin *rp,
    unsigned int offset, const unsigned char *from, unsigned int len);

/*
 */
extern struct mutex mon_lock;

extern const struct file_operations mon_fops_stat;

#endif /* __USB_MON_H */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* The USB Monitor, inspired by Dave Harding's USBMon.
da5ca008 PZ	3	*
da5ca008 PZ	4	* Copyright (C) 2005 Pete Zaitcev (zaitcev@redhat.com)
1da177e4 LT	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;
6f23ee1f PZ	20	struct usb_bus *u_bus;
	21
	22	int text_inited;
1da177e4 LT	23	struct dentry dent_s; / Debugging file */
1da177e4 LT	24	struct dentry dent_t; / Text interface file */
4d6cd483	25	int uses_dma;
1da177e4 LT	26
	27	/* Ref */
	28	int nreaders; /* Under mon_lock AND mbus->lock */
	29	struct list_head r_list; /* Chain of readers (usually one) */
	30	struct kref ref; /* Under mon_lock */
	31
	32	/* Stats */
5b1c674d	33	unsigned int cnt_events;
1da177e4 LT	34	unsigned int cnt_text_lost;
	35	};
	36
	37	/*
	38	* An instance of a process which opened a file (but can fork later)
	39	*/
	40	struct mon_reader {
	41	struct list_head r_link;
	42	struct mon_bus *m_bus;
	43	void r_data; / Use container_of instead? */
	44
	45	void (rnf_submit)(void data, struct urb *urb);
12e72fea	46	void (rnf_error)(void data, struct urb *urb, int error);
1da177e4 LT	47	void (rnf_complete)(void data, struct urb *urb);
	48	};
	49
	50	void mon_reader_add(struct mon_bus mbus, struct mon_reader r);
	51	void mon_reader_del(struct mon_bus mbus, struct mon_reader r);
	52
6f23ee1f PZ	53	struct mon_bus *mon_bus_lookup(unsigned int num);
	54
	55	int /bool/ mon_text_add(struct mon_bus mbus, const struct usb_bus ubus);
	56	void mon_text_del(struct mon_bus *mbus);
	57	// void mon_bin_add(struct mon_bus *);
	58
	59	int __init mon_text_init(void);
	60	void __exit mon_text_exit(void);
	61	int __init mon_bin_init(void);
	62	void __exit mon_bin_exit(void);
	63
02568396	64	/*
6f23ee1f PZ	65	* DMA interface.
	66	*
	67	* XXX The vectored side needs a serious re-thinking. Abstracting vectors,
	68	* like in Paolo's original patch, produces a double pkmap. We need an idea.
	69	*/
02568396 PZ	70	extern char mon_dmapeek(unsigned char *dst, dma_addr_t dma_addr, int len);
02568396 PZ	71
6f23ee1f PZ	72	struct mon_reader_bin;
	73	extern void mon_dmapeek_vec(const struct mon_reader_bin *rp,
	74	unsigned int offset, dma_addr_t dma_addr, unsigned int len);
	75	extern unsigned int mon_copy_to_buff(const struct mon_reader_bin *rp,
	76	unsigned int offset, const unsigned char *from, unsigned int len);
	77
	78	/*
	79	*/
4186ecf8	80	extern struct mutex mon_lock;
1da177e4	81
066202dd	82	extern const struct file_operations mon_fops_stat;
1da177e4 LT	83
1da177e4 LT	84	#endif /* __USB_MON_H */