blob: e69d8472a284c41ce6ca78519fd18c8be61058a1 [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
Jean-Francois Moined43fa322008-06-12 10:58:58 -030028#define D_V4L2 0x0100
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030029#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 */
Jean-Francois Moined43fa322008-06-12 10:58:58 -030050#define MAX_NURBS 32 /* max number of URBs (read & userptr) */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030051#define ISO_MAX_PKT 32 /* max number of packets in an ISOC transfer */
Jean-Francois Moined43fa322008-06-12 10:58:58 -030052#define ISO_MAX_SIZE 0x8000 /* max size of one URB buffer (32 Kb) */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030053
54/* device information - set at probe time */
55struct cam_mode {
56 __u32 pixfmt;
57 short width;
58 short height;
59 short mode; /* subdriver value */
60 short reserved; /* subdriver value */
61};
62struct cam {
63 char *dev_name;
64 struct cam_mode *cam_mode; /* size nmodes */
65 char nmodes;
66 __u8 epaddr;
67};
68
69struct gspca_dev;
70struct gspca_frame;
71
72/* subdriver operations */
73typedef int (*cam_op) (struct gspca_dev *);
74typedef void (*cam_v_op) (struct gspca_dev *);
75typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
76typedef int (*cam_jpg_op) (struct gspca_dev *,
77 struct v4l2_jpegcompression *);
78typedef int (*cam_qmnu_op) (struct gspca_dev *,
79 struct v4l2_querymenu *);
80typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
81 struct gspca_frame *frame,
82 unsigned char *data,
83 int len);
84
85struct ctrl {
86 struct v4l2_queryctrl qctrl;
87 int (*set)(struct gspca_dev *, __s32);
88 int (*get)(struct gspca_dev *, __s32 *);
89};
90
91/* subdriver description */
92struct sd_desc {
93/* information */
Hans de Goedee2997a72008-04-23 08:09:12 -030094 char *name; /* sub-driver name */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030095/* controls */
96 struct ctrl *ctrls;
97 int nctrls;
98/* operations */
Hans de Goedee2997a72008-04-23 08:09:12 -030099 cam_cf_op config; /* called on probe */
100 cam_op open; /* called on open */
101 cam_v_op start; /* called on stream on */
102 cam_v_op stopN; /* called on stream off - main alt */
103 cam_v_op stop0; /* called on stream off - alt 0 */
104 cam_v_op close; /* called on close */
105 cam_v_op dq_callback; /* called when a frame has been dequeued */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300106 cam_pkt_op pkt_scan;
107 cam_jpg_op get_jcomp;
108 cam_jpg_op set_jcomp;
109 cam_qmnu_op querymenu;
110};
111
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300112/* packet types when moving from iso buf to frame buf */
113#define DISCARD_PACKET 0
114#define FIRST_PACKET 1
115#define INTER_PACKET 2
116#define LAST_PACKET 3
117
118struct gspca_frame {
119 unsigned char *data; /* frame buffer */
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300120 unsigned char *data_end; /* end of frame while filling */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300121 int vma_use_count;
122 struct v4l2_buffer v4l2_buf;
123};
124
125struct gspca_dev {
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300126 struct video_device vdev; /* !! must be the first item */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300127 struct file_operations fops;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300128 struct usb_device *dev;
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300129 struct file *capt_file; /* file doing video capture */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300130
131 struct cam cam; /* device information */
132 const struct sd_desc *sd_desc; /* subdriver description */
133
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300134 struct urb *urb[MAX_NURBS];
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300135
136 __u8 *frbuf; /* buffer for nframes */
137 struct gspca_frame frame[GSPCA_MAX_FRAMES];
138 unsigned int frsz; /* frame size */
139 char nframes; /* number of frames */
140 char fr_i; /* frame being filled */
141 char fr_q; /* next frame to queue */
142 char fr_o; /* next frame to dequeue */
143 signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
144 char last_packet_type;
145
146 __u8 iface; /* USB interface number */
147 __u8 alt; /* USB alternate setting */
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300148 unsigned char curr_mode; /* current camera mode */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300149 __u32 pixfmt; /* current mode parameters */
150 short width;
151 short height;
152
153 atomic_t nevent; /* number of frames done */
154 wait_queue_head_t wq; /* wait queue */
155 struct mutex usb_lock; /* usb exchange protection */
156 struct mutex read_lock; /* read protection */
157 struct mutex queue_lock; /* ISOC queue protection */
158 __u32 sequence; /* frame sequence number */
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300159 char streaming;
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300160 char users; /* number of opens */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300161 char present; /* device connected */
162 char nbufread; /* number of buffers for read() */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300163 char nurbs; /* number of allocated URBs */
164 char memory; /* memory type (V4L2_MEMORY_xxx) */
165 __u8 urb_in; /* URB pointers - used when !mmap */
166 __u8 urb_out;
167 __u8 nbalt; /* number of USB alternate settings */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300168};
169
170int gspca_dev_probe(struct usb_interface *intf,
171 const struct usb_device_id *id,
172 const struct sd_desc *sd_desc,
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300173 int dev_size,
174 struct module *module);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300175void gspca_disconnect(struct usb_interface *intf);
176struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
177 int packet_type,
178 struct gspca_frame *frame,
179 unsigned char *data,
180 int len);
181#endif /* GSPCAV2_H */