aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/media/usb/gspca/gspca.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/media/usb/gspca/gspca.h')
-rw-r--r--drivers/media/usb/gspca/gspca.h259
1 files changed, 259 insertions, 0 deletions
diff --git a/drivers/media/usb/gspca/gspca.h b/drivers/media/usb/gspca/gspca.h
new file mode 100644
index 000000000000..dc688c7f5e48
--- /dev/null
+++ b/drivers/media/usb/gspca/gspca.h
@@ -0,0 +1,259 @@
1#ifndef GSPCAV2_H
2#define GSPCAV2_H
3
4#include <linux/module.h>
5#include <linux/kernel.h>
6#include <linux/usb.h>
7#include <linux/videodev2.h>
8#include <media/v4l2-common.h>
9#include <media/v4l2-ctrls.h>
10#include <media/v4l2-device.h>
11#include <linux/mutex.h>
12
13/* compilation option */
14/*#define GSPCA_DEBUG 1*/
15
16#ifdef GSPCA_DEBUG
17/* GSPCA our debug messages */
18extern int gspca_debug;
19#define PDEBUG(level, fmt, ...) \
20do { \
21 if (gspca_debug & (level)) \
22 pr_info(fmt, ##__VA_ARGS__); \
23} while (0)
24
25#define D_ERR 0x01
26#define D_PROBE 0x02
27#define D_CONF 0x04
28#define D_STREAM 0x08
29#define D_FRAM 0x10
30#define D_PACK 0x20
31#define D_USBI 0x00
32#define D_USBO 0x00
33#define D_V4L2 0x0100
34#else
35#define PDEBUG(level, fmt, ...)
36#endif
37
38#define GSPCA_MAX_FRAMES 16 /* maximum number of video frame buffers */
39/* image transfers */
40#define MAX_NURBS 4 /* max number of URBs */
41
42
43/* used to list framerates supported by a camera mode (resolution) */
44struct framerates {
45 const u8 *rates;
46 int nrates;
47};
48
49/* control definition */
50struct gspca_ctrl {
51 s16 val; /* current value */
52 s16 def; /* default value */
53 s16 min, max; /* minimum and maximum values */
54};
55
56/* device information - set at probe time */
57struct cam {
58 const struct v4l2_pix_format *cam_mode; /* size nmodes */
59 const struct framerates *mode_framerates; /* must have size nmodes,
60 * just like cam_mode */
61 struct gspca_ctrl *ctrls; /* control table - size nctrls */
62 /* may be NULL */
63 u32 bulk_size; /* buffer size when image transfer by bulk */
64 u32 input_flags; /* value for ENUM_INPUT status flags */
65 u8 nmodes; /* size of cam_mode */
66 u8 no_urb_create; /* don't create transfer URBs */
67 u8 bulk_nurbs; /* number of URBs in bulk mode
68 * - cannot be > MAX_NURBS
69 * - when 0 and bulk_size != 0 means
70 * 1 URB and submit done by subdriver */
71 u8 bulk; /* image transfer by 0:isoc / 1:bulk */
72 u8 npkt; /* number of packets in an ISOC message
73 * 0 is the default value: 32 packets */
74 u8 needs_full_bandwidth;/* Set this flag to notify the bandwidth calc.
75 * code that the cam fills all image buffers to
76 * the max, even when using compression. */
77};
78
79struct gspca_dev;
80struct gspca_frame;
81
82/* subdriver operations */
83typedef int (*cam_op) (struct gspca_dev *);
84typedef void (*cam_v_op) (struct gspca_dev *);
85typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
86typedef int (*cam_jpg_op) (struct gspca_dev *,
87 struct v4l2_jpegcompression *);
88typedef int (*cam_reg_op) (struct gspca_dev *,
89 struct v4l2_dbg_register *);
90typedef int (*cam_ident_op) (struct gspca_dev *,
91 struct v4l2_dbg_chip_ident *);
92typedef void (*cam_streamparm_op) (struct gspca_dev *,
93 struct v4l2_streamparm *);
94typedef int (*cam_qmnu_op) (struct gspca_dev *,
95 struct v4l2_querymenu *);
96typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
97 u8 *data,
98 int len);
99typedef int (*cam_int_pkt_op) (struct gspca_dev *gspca_dev,
100 u8 *data,
101 int len);
102
103struct ctrl {
104 struct v4l2_queryctrl qctrl;
105 int (*set)(struct gspca_dev *, __s32);
106 int (*get)(struct gspca_dev *, __s32 *);
107 cam_v_op set_control;
108};
109
110/* subdriver description */
111struct sd_desc {
112/* information */
113 const char *name; /* sub-driver name */
114/* controls */
115 const struct ctrl *ctrls; /* static control definition */
116 int nctrls;
117/* mandatory operations */
118 cam_cf_op config; /* called on probe */
119 cam_op init; /* called on probe and resume */
120 cam_op init_controls; /* called on probe */
121 cam_op start; /* called on stream on after URBs creation */
122 cam_pkt_op pkt_scan;
123/* optional operations */
124 cam_op isoc_init; /* called on stream on before getting the EP */
125 cam_op isoc_nego; /* called when URB submit failed with NOSPC */
126 cam_v_op stopN; /* called on stream off - main alt */
127 cam_v_op stop0; /* called on stream off & disconnect - alt 0 */
128 cam_v_op dq_callback; /* called when a frame has been dequeued */
129 cam_jpg_op get_jcomp;
130 cam_jpg_op set_jcomp;
131 cam_qmnu_op querymenu;
132 cam_streamparm_op get_streamparm;
133 cam_streamparm_op set_streamparm;
134#ifdef CONFIG_VIDEO_ADV_DEBUG
135 cam_reg_op set_register;
136 cam_reg_op get_register;
137#endif
138 cam_ident_op get_chip_ident;
139#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
140 cam_int_pkt_op int_pkt_scan;
141 /* other_input makes the gspca core create gspca_dev->input even when
142 int_pkt_scan is NULL, for cams with non interrupt driven buttons */
143 u8 other_input;
144#endif
145};
146
147/* packet types when moving from iso buf to frame buf */
148enum gspca_packet_type {
149 DISCARD_PACKET,
150 FIRST_PACKET,
151 INTER_PACKET,
152 LAST_PACKET
153};
154
155struct gspca_frame {
156 __u8 *data; /* frame buffer */
157 int vma_use_count;
158 struct v4l2_buffer v4l2_buf;
159};
160
161struct gspca_dev {
162 struct video_device vdev; /* !! must be the first item */
163 struct module *module; /* subdriver handling the device */
164 struct v4l2_device v4l2_dev;
165 struct usb_device *dev;
166 struct file *capt_file; /* file doing video capture */
167 /* protected by queue_lock */
168#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
169 struct input_dev *input_dev;
170 char phys[64]; /* physical device path */
171#endif
172
173 struct cam cam; /* device information */
174 const struct sd_desc *sd_desc; /* subdriver description */
175 unsigned ctrl_dis; /* disabled controls (bit map) */
176 unsigned ctrl_inac; /* inactive controls (bit map) */
177 struct v4l2_ctrl_handler ctrl_handler;
178
179 /* autogain and exposure or gain control cluster, these are global as
180 the autogain/exposure functions in autogain_functions.c use them */
181 struct {
182 struct v4l2_ctrl *autogain;
183 struct v4l2_ctrl *exposure;
184 struct v4l2_ctrl *gain;
185 int exp_too_low_cnt, exp_too_high_cnt;
186 };
187
188#define USB_BUF_SZ 64
189 __u8 *usb_buf; /* buffer for USB exchanges */
190 struct urb *urb[MAX_NURBS];
191#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
192 struct urb *int_urb;
193#endif
194
195 __u8 *frbuf; /* buffer for nframes */
196 struct gspca_frame frame[GSPCA_MAX_FRAMES];
197 u8 *image; /* image beeing filled */
198 __u32 frsz; /* frame size */
199 u32 image_len; /* current length of image */
200 atomic_t fr_q; /* next frame to queue */
201 atomic_t fr_i; /* frame being filled */
202 signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
203 char nframes; /* number of frames */
204 u8 fr_o; /* next frame to dequeue */
205 __u8 last_packet_type;
206 __s8 empty_packet; /* if (-1) don't check empty packets */
207 __u8 streaming; /* protected by both mutexes (*) */
208
209 __u8 curr_mode; /* current camera mode */
210 __u32 pixfmt; /* current mode parameters */
211 __u16 width;
212 __u16 height;
213 __u32 sequence; /* frame sequence number */
214
215 wait_queue_head_t wq; /* wait queue */
216 struct mutex usb_lock; /* usb exchange protection */
217 struct mutex queue_lock; /* ISOC queue protection */
218 int usb_err; /* USB error - protected by usb_lock */
219 u16 pkt_size; /* ISOC packet size */
220#ifdef CONFIG_PM
221 char frozen; /* suspend - resume */
222#endif
223 char present; /* device connected */
224 char nbufread; /* number of buffers for read() */
225 char memory; /* memory type (V4L2_MEMORY_xxx) */
226 __u8 iface; /* USB interface number */
227 __u8 alt; /* USB alternate setting */
228 u8 audio; /* presence of audio device */
229
230 /* (*) These variables are proteced by both usb_lock and queue_lock,
231 that is any code setting them is holding *both*, which means that
232 any code getting them needs to hold at least one of them */
233};
234
235int gspca_dev_probe(struct usb_interface *intf,
236 const struct usb_device_id *id,
237 const struct sd_desc *sd_desc,
238 int dev_size,
239 struct module *module);
240int gspca_dev_probe2(struct usb_interface *intf,
241 const struct usb_device_id *id,
242 const struct sd_desc *sd_desc,
243 int dev_size,
244 struct module *module);
245void gspca_disconnect(struct usb_interface *intf);
246void gspca_frame_add(struct gspca_dev *gspca_dev,
247 enum gspca_packet_type packet_type,
248 const u8 *data,
249 int len);
250#ifdef CONFIG_PM
251int gspca_suspend(struct usb_interface *intf, pm_message_t message);
252int gspca_resume(struct usb_interface *intf);
253#endif
254int gspca_expo_autogain(struct gspca_dev *gspca_dev, int avg_lum,
255 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
256int gspca_coarse_grained_expo_autogain(struct gspca_dev *gspca_dev,
257 int avg_lum, int desired_avg_lum, int deadzone);
258
259#endif /* GSPCAV2_H */