blob: 3bfb3641cf36c7818d033f6442b47d1468fa53f5 [file] [log] [blame]
Jean-Francois Moine63eb9542008-04-12 09:58:09 -03001#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 GSPCA_DEBUG
13/* GSPCA our debug messages */
14extern 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#else
29#define PDEBUG(level, fmt, args...)
30#endif
31#undef err
32#define err(fmt, args...) \
33 do {\
34 printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args); \
35 } while (0)
36#undef info
37#define info(fmt, args...) \
38 do {\
39 printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args); \
40 } while (0)
41#undef warn
42#define warn(fmt, args...) \
43 do {\
44 printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args); \
45 } while (0)
46
47#define GSPCA_MAX_FRAMES 16 /* maximum number of video frame buffers */
48/* ISOC transfers */
49#define NURBS 4 /* number of URBs */
50#define ISO_MAX_PKT 32 /* max number of packets in an ISOC transfer */
51#define ISO_MAX_SIZE 0x10000 /* max size of one URB buffer (64 Kb) */
52
53/* device information - set at probe time */
54struct cam_mode {
55 __u32 pixfmt;
56 short width;
57 short height;
58 short mode; /* subdriver value */
59 short reserved; /* subdriver value */
60};
61struct cam {
62 char *dev_name;
63 struct cam_mode *cam_mode; /* size nmodes */
64 char nmodes;
65 __u8 epaddr;
66};
67
68struct gspca_dev;
69struct gspca_frame;
70
71/* subdriver operations */
72typedef int (*cam_op) (struct gspca_dev *);
73typedef void (*cam_v_op) (struct gspca_dev *);
74typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
75typedef int (*cam_jpg_op) (struct gspca_dev *,
76 struct v4l2_jpegcompression *);
77typedef int (*cam_qmnu_op) (struct gspca_dev *,
78 struct v4l2_querymenu *);
79typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
80 struct gspca_frame *frame,
81 unsigned char *data,
82 int len);
83
84struct 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 */
91struct sd_desc {
92/* information */
Hans de Goedee2997a72008-04-23 08:09:12 -030093 char *name; /* sub-driver name */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030094/* controls */
95 struct ctrl *ctrls;
96 int nctrls;
97/* operations */
Hans de Goedee2997a72008-04-23 08:09:12 -030098 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 */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300105 cam_pkt_op pkt_scan;
106 cam_jpg_op get_jcomp;
107 cam_jpg_op set_jcomp;
108 cam_qmnu_op querymenu;
109};
110
111struct gspca_pktbuf {
112 char *data;
113 struct urb *urb;
114};
115
116/* packet types when moving from iso buf to frame buf */
117#define DISCARD_PACKET 0
118#define FIRST_PACKET 1
119#define INTER_PACKET 2
120#define LAST_PACKET 3
121
122struct gspca_frame {
123 unsigned char *data; /* frame buffer */
124 unsigned char *data_end; /* current end of frame while filling */
125 int vma_use_count;
126 struct v4l2_buffer v4l2_buf;
127};
128
129struct gspca_dev {
130 struct video_device vdev; /* !! must be the first item */
131 struct usb_device *dev;
132
133 struct cam cam; /* device information */
134 const struct sd_desc *sd_desc; /* subdriver description */
135
136 struct gspca_pktbuf pktbuf[NURBS];
137
138 __u8 *frbuf; /* buffer for nframes */
139 struct gspca_frame frame[GSPCA_MAX_FRAMES];
140 unsigned int frsz; /* frame size */
141 char nframes; /* number of frames */
142 char fr_i; /* frame being filled */
143 char fr_q; /* next frame to queue */
144 char fr_o; /* next frame to dequeue */
145 signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
146 char last_packet_type;
147
148 __u8 iface; /* USB interface number */
149 __u8 alt; /* USB alternate setting */
150 char curr_mode; /* current camera mode */
151 __u32 pixfmt; /* current mode parameters */
152 short width;
153 short height;
154
155 atomic_t nevent; /* number of frames done */
156 wait_queue_head_t wq; /* wait queue */
157 struct mutex usb_lock; /* usb exchange protection */
158 struct mutex read_lock; /* read protection */
159 struct mutex queue_lock; /* ISOC queue protection */
160 __u32 sequence; /* frame sequence number */
161 signed char streaming;
162 char users; /* # open */
163 char present; /* device connected */
164 char nbufread; /* number of buffers for read() */
165};
166
167int gspca_dev_probe(struct usb_interface *intf,
168 const struct usb_device_id *id,
169 const struct sd_desc *sd_desc,
170 int dev_size);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300171void gspca_disconnect(struct usb_interface *intf);
172struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
173 int packet_type,
174 struct gspca_frame *frame,
175 unsigned char *data,
176 int len);
177#endif /* GSPCAV2_H */