V4L/DVB (8195): gspca: Input buffer overwritten in spca561 + cleanup code.
[safe/jmp/linux-2.6] / drivers / media / video / gspca / gspca.h
1 #ifndef GSPCAV2_H
2 #define GSPCAV2_H
3
4 #include <linux/module.h>
5 #include <linux/version.h>
6 #include <linux/kernel.h>
7 #include <linux/usb.h>
8 #include <linux/videodev2.h>
9 #include <media/v4l2-common.h>
10 #include <linux/mutex.h>
11
12 #ifdef CONFIG_VIDEO_ADV_DEBUG
13 /* GSPCA our debug messages */
14 extern int gspca_debug;
15 #define PDEBUG(level, fmt, args...) \
16         do {\
17                 if (gspca_debug & (level)) \
18                         printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args); \
19         } while (0)
20 #define D_ERR  0x01
21 #define D_PROBE 0x02
22 #define D_CONF 0x04
23 #define D_STREAM 0x08
24 #define D_FRAM 0x10
25 #define D_PACK 0x20
26 #define D_USBI 0x40
27 #define D_USBO 0x80
28 #define D_V4L2 0x0100
29 #else
30 #define PDEBUG(level, fmt, args...)
31 #endif
32 #undef err
33 #define err(fmt, args...) \
34         do {\
35                 printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args); \
36         } while (0)
37 #undef info
38 #define info(fmt, args...) \
39         do {\
40                 printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args); \
41         } while (0)
42 #undef warn
43 #define warn(fmt, args...) \
44         do {\
45                 printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args); \
46         } while (0)
47
48 #define GSPCA_MAX_FRAMES 16     /* maximum number of video frame buffers */
49 /* ISOC transfers */
50 #define MAX_NURBS 16            /* max number of URBs */
51 #define ISO_MAX_PKT 32          /* max number of packets in an ISOC transfer */
52 #define ISO_MAX_SIZE 0x8000     /* max size of one URB buffer (32 Kb) */
53
54 /* device information - set at probe time */
55 struct cam_mode {
56         __u32 pixfmt;
57         short width;
58         short height;
59         short mode;             /* subdriver value */
60 };
61 struct cam {
62         char *dev_name;
63         struct cam_mode *cam_mode;      /* size nmodes */
64         char nmodes;
65         __u8 epaddr;
66 };
67
68 struct gspca_dev;
69 struct gspca_frame;
70
71 /* subdriver operations */
72 typedef int (*cam_op) (struct gspca_dev *);
73 typedef void (*cam_v_op) (struct gspca_dev *);
74 typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
75 typedef int (*cam_jpg_op) (struct gspca_dev *,
76                                 struct v4l2_jpegcompression *);
77 typedef int (*cam_qmnu_op) (struct gspca_dev *,
78                         struct v4l2_querymenu *);
79 typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
80                                 struct gspca_frame *frame,
81                                 __u8 *data,
82                                 int len);
83
84 struct ctrl {
85         struct v4l2_queryctrl qctrl;
86         int (*set)(struct gspca_dev *, __s32);
87         int (*get)(struct gspca_dev *, __s32 *);
88 };
89
90 /* subdriver description */
91 struct sd_desc {
92 /* information */
93         const char *name;       /* sub-driver name */
94 /* controls */
95         const struct ctrl *ctrls;
96         int nctrls;
97 /* operations */
98         cam_cf_op config;       /* called on probe */
99         cam_op open;            /* called on open */
100         cam_v_op start;         /* called on stream on */
101         cam_v_op stopN;         /* called on stream off - main alt */
102         cam_v_op stop0;         /* called on stream off - alt 0 */
103         cam_v_op close;         /* called on close */
104         cam_v_op dq_callback;   /* called when a frame has been dequeued */
105         cam_pkt_op pkt_scan;
106         cam_jpg_op get_jcomp;
107         cam_jpg_op set_jcomp;
108         cam_qmnu_op querymenu;
109 };
110
111 /* packet types when moving from iso buf to frame buf */
112 #define DISCARD_PACKET  0
113 #define FIRST_PACKET    1
114 #define INTER_PACKET    2
115 #define LAST_PACKET     3
116
117 struct gspca_frame {
118         __u8 *data;                     /* frame buffer */
119         __u8 *data_end;                 /* end of frame while filling */
120         int vma_use_count;
121         struct v4l2_buffer v4l2_buf;
122 };
123
124 struct gspca_dev {
125         struct video_device vdev;       /* !! must be the first item */
126         struct file_operations fops;
127         struct usb_device *dev;
128         struct file *capt_file;         /* file doing video capture */
129
130         struct cam cam;                         /* device information */
131         const struct sd_desc *sd_desc;          /* subdriver description */
132
133         struct urb *urb[MAX_NURBS];
134
135         __u8 *frbuf;                            /* buffer for nframes */
136         struct gspca_frame frame[GSPCA_MAX_FRAMES];
137         __u32 frsz;                             /* frame size */
138         char nframes;                           /* number of frames */
139         char fr_i;                              /* frame being filled */
140         char fr_q;                              /* next frame to queue */
141         char fr_o;                              /* next frame to dequeue */
142         signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
143         char last_packet_type;
144
145         __u8 iface;                     /* USB interface number */
146         __u8 alt;                       /* USB alternate setting */
147         __u8 curr_mode;                 /* current camera mode */
148         __u32 pixfmt;                   /* current mode parameters */
149         __u16 width;
150         __u16 height;
151
152         atomic_t nevent;                /* number of frames done */
153         wait_queue_head_t wq;           /* wait queue */
154         struct mutex usb_lock;          /* usb exchange protection */
155         struct mutex read_lock;         /* read protection */
156         struct mutex queue_lock;        /* ISOC queue protection */
157         __u32 sequence;                 /* frame sequence number */
158         char streaming;
159         char users;                     /* number of opens */
160         char present;                   /* device connected */
161         char nbufread;                  /* number of buffers for read() */
162         char nurbs;                     /* number of allocated URBs */
163         char memory;                    /* memory type (V4L2_MEMORY_xxx) */
164         __u8 urb_in;                    /* URB pointers - used when !mmap */
165         __u8 urb_out;
166         __u8 nbalt;                     /* number of USB alternate settings */
167 };
168
169 int gspca_dev_probe(struct usb_interface *intf,
170                 const struct usb_device_id *id,
171                 const struct sd_desc *sd_desc,
172                 int dev_size,
173                 struct module *module);
174 void gspca_disconnect(struct usb_interface *intf);
175 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
176                                     int packet_type,
177                                     struct gspca_frame *frame,
178                                     const __u8 *data,
179                                     int len);
180 #endif /* GSPCAV2_H */