blob: b749c36d9f7eacf263efbdc222b8fed9603dc672 [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>
Jean-Francois Moine63eb9542008-04-12 09:58:09 -03005#include <linux/kernel.h>
6#include <linux/usb.h>
7#include <linux/videodev2.h>
8#include <media/v4l2-common.h>
9#include <linux/mutex.h>
10
Jean-Francois Moine335b3f82008-07-30 04:53:02 -030011/* compilation option */
12#define GSPCA_DEBUG 1
13
14#ifdef GSPCA_DEBUG
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030015/* GSPCA our debug messages */
16extern int gspca_debug;
17#define PDEBUG(level, fmt, args...) \
18 do {\
19 if (gspca_debug & (level)) \
20 printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args); \
21 } while (0)
22#define D_ERR 0x01
23#define D_PROBE 0x02
24#define D_CONF 0x04
25#define D_STREAM 0x08
26#define D_FRAM 0x10
27#define D_PACK 0x20
28#define D_USBI 0x40
29#define D_USBO 0x80
Jean-Francois Moined43fa322008-06-12 10:58:58 -030030#define D_V4L2 0x0100
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030031#else
32#define PDEBUG(level, fmt, args...)
33#endif
34#undef err
35#define err(fmt, args...) \
Jean-Francois Moine11fb06b2009-01-01 13:20:42 -030036 printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args)
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030037#undef info
38#define info(fmt, args...) \
Jean-Francois Moine11fb06b2009-01-01 13:20:42 -030039 printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args)
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030040#undef warn
41#define warn(fmt, args...) \
Jean-Francois Moine11fb06b2009-01-01 13:20:42 -030042 printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args)
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030043
44#define GSPCA_MAX_FRAMES 16 /* maximum number of video frame buffers */
Jean-Francois Moine0be01002008-09-04 07:01:50 -030045/* image transfers */
46#define MAX_NURBS 4 /* max number of URBs */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030047
Antonio Ospite28ffe772009-12-02 06:18:46 -030048
49/* used to list framerates supported by a camera mode (resolution) */
50struct framerates {
Antonio Ospite29b87f02010-01-17 03:27:04 -030051 const u8 *rates;
Antonio Ospite28ffe772009-12-02 06:18:46 -030052 int nrates;
53};
54
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030055/* device information - set at probe time */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030056struct cam {
Jean-Francois Moinecc611b82008-12-29 07:49:41 -030057 const struct v4l2_pix_format *cam_mode; /* size nmodes */
Antonio Ospite28ffe772009-12-02 06:18:46 -030058 const struct framerates *mode_framerates; /* must have size nmode,
59 * just like cam_mode */
Jean-Francois Moine47aaca92009-12-15 05:23:04 -030060 u32 bulk_size; /* buffer size when image transfer by bulk */
61 u32 input_flags; /* value for ENUM_INPUT status flags */
62 u8 nmodes; /* size of cam_mode */
63 u8 no_urb_create; /* don't create transfer URBs */
64 u8 bulk_nurbs; /* number of URBs in bulk mode
Antonio Ospitedff369a2008-11-14 07:53:32 -030065 * - cannot be > MAX_NURBS
66 * - when 0 and bulk_size != 0 means
67 * 1 URB and submit done by subdriver */
Jean-Francois Moine6929dc62009-04-21 13:45:56 -030068 u8 bulk; /* image transfer by 0:isoc / 1:bulk */
Jean-Francois Moine49cb6b02009-04-25 13:29:01 -030069 u8 npkt; /* number of packets in an ISOC message
70 * 0 is the default value: 32 packets */
Jean-Francois Moine47aaca92009-12-15 05:23:04 -030071 u8 reverse_alts; /* Alt settings are in high to low order */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030072};
73
74struct gspca_dev;
75struct gspca_frame;
76
77/* subdriver operations */
78typedef int (*cam_op) (struct gspca_dev *);
79typedef void (*cam_v_op) (struct gspca_dev *);
80typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
81typedef int (*cam_jpg_op) (struct gspca_dev *,
82 struct v4l2_jpegcompression *);
Brian Johnsonaf1d9af2009-07-19 05:29:20 -030083typedef int (*cam_reg_op) (struct gspca_dev *,
84 struct v4l2_dbg_register *);
85typedef int (*cam_ident_op) (struct gspca_dev *,
86 struct v4l2_dbg_chip_ident *);
Jim Paris627a5ef2008-12-10 06:02:42 -030087typedef int (*cam_streamparm_op) (struct gspca_dev *,
88 struct v4l2_streamparm *);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030089typedef int (*cam_qmnu_op) (struct gspca_dev *,
90 struct v4l2_querymenu *);
91typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
Jean-Francois Moine76dd2722009-11-13 09:21:03 -030092 u8 *data,
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030093 int len);
Márton Németh0274d422010-01-28 06:39:49 -030094typedef int (*cam_int_pkt_op) (struct gspca_dev *gspca_dev,
95 u8 *data,
96 int len);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030097
98struct ctrl {
99 struct v4l2_queryctrl qctrl;
100 int (*set)(struct gspca_dev *, __s32);
101 int (*get)(struct gspca_dev *, __s32 *);
102};
103
104/* subdriver description */
105struct sd_desc {
106/* information */
Jean-Francois Moinea5ae2062008-07-04 11:16:16 -0300107 const char *name; /* sub-driver name */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300108/* controls */
Jean-Francois Moinea5ae2062008-07-04 11:16:16 -0300109 const struct ctrl *ctrls;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300110 int nctrls;
Jean-Francois Moine012d6b02008-09-03 17:12:16 -0300111/* mandatory operations */
Hans de Goedee2997a72008-04-23 08:09:12 -0300112 cam_cf_op config; /* called on probe */
Jean-Francois Moine012d6b02008-09-03 17:12:16 -0300113 cam_op init; /* called on probe and resume */
Jean-Francois Moine1f53b0b2009-06-30 07:07:01 -0300114 cam_op start; /* called on stream on after URBs creation */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300115 cam_pkt_op pkt_scan;
Jean-Francois Moinec2446b32008-07-05 11:49:20 -0300116/* optional operations */
Jean-Francois Moine1f53b0b2009-06-30 07:07:01 -0300117 cam_op isoc_init; /* called on stream on before getting the EP */
118 cam_op isoc_nego; /* called when URB submit failed with NOSPC */
Jean-Francois Moine012d6b02008-09-03 17:12:16 -0300119 cam_v_op stopN; /* called on stream off - main alt */
Jean-Francois Moine98522a72008-11-18 06:33:08 -0300120 cam_v_op stop0; /* called on stream off & disconnect - alt 0 */
Jean-Francois Moinec2446b32008-07-05 11:49:20 -0300121 cam_v_op dq_callback; /* called when a frame has been dequeued */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300122 cam_jpg_op get_jcomp;
123 cam_jpg_op set_jcomp;
124 cam_qmnu_op querymenu;
Jim Paris627a5ef2008-12-10 06:02:42 -0300125 cam_streamparm_op get_streamparm;
126 cam_streamparm_op set_streamparm;
Brian Johnsonaf1d9af2009-07-19 05:29:20 -0300127#ifdef CONFIG_VIDEO_ADV_DEBUG
128 cam_reg_op set_register;
129 cam_reg_op get_register;
130#endif
131 cam_ident_op get_chip_ident;
Randy Dunlapf7628012010-03-30 14:32:04 -0300132#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
Márton Németh0274d422010-01-28 06:39:49 -0300133 cam_int_pkt_op int_pkt_scan;
Hans de Goedeac82f592010-02-19 04:28:39 -0300134 /* other_input makes the gspca core create gspca_dev->input even when
135 int_pkt_scan is NULL, for cams with non interrupt driven buttons */
136 u8 other_input;
Márton Németh0274d422010-01-28 06:39:49 -0300137#endif
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300138};
139
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300140/* packet types when moving from iso buf to frame buf */
Erik Andrene293e592008-10-03 08:46:50 -0300141enum gspca_packet_type {
142 DISCARD_PACKET,
143 FIRST_PACKET,
144 INTER_PACKET,
145 LAST_PACKET
146};
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300147
148struct gspca_frame {
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300149 __u8 *data; /* frame buffer */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300150 int vma_use_count;
151 struct v4l2_buffer v4l2_buf;
152};
153
154struct gspca_dev {
Jean-Francois Moinea12ca6a2008-11-19 06:37:53 -0300155 struct video_device vdev; /* !! must be the first item */
Jean-Francois Moine5c4fa002008-11-18 15:52:31 -0300156 struct module *module; /* subdriver handling the device */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300157 struct usb_device *dev;
Jean-Francois Moine4aa0d032008-05-04 06:46:21 -0300158 struct file *capt_file; /* file doing video capture */
Randy Dunlapf7628012010-03-30 14:32:04 -0300159#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
Márton Németh0274d422010-01-28 06:39:49 -0300160 struct input_dev *input_dev;
161 char phys[64]; /* physical device path */
162#endif
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300163
164 struct cam cam; /* device information */
165 const struct sd_desc *sd_desc; /* subdriver description */
Jean-Francois Moinef50ba1b2008-09-03 17:12:14 -0300166 unsigned ctrl_dis; /* disabled controls (bit map) */
Jean-Francois Moine4af85662009-11-12 15:59:27 -0300167 unsigned ctrl_inac; /* inactive controls (bit map) */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300168
Jean-Francois Moine8295d992008-09-03 17:12:19 -0300169#define USB_BUF_SZ 64
170 __u8 *usb_buf; /* buffer for USB exchanges */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300171 struct urb *urb[MAX_NURBS];
Randy Dunlapf7628012010-03-30 14:32:04 -0300172#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
Márton Németh0274d422010-01-28 06:39:49 -0300173 struct urb *int_urb;
174#endif
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300175
176 __u8 *frbuf; /* buffer for nframes */
177 struct gspca_frame frame[GSPCA_MAX_FRAMES];
Jean-François Moineb192ca92010-06-27 03:08:19 -0300178 u8 *image; /* image beeing filled */
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300179 __u32 frsz; /* frame size */
Jean-François Moineb192ca92010-06-27 03:08:19 -0300180 u32 image_len; /* current length of image */
Jean-François Moinef7059ea2010-07-06 04:32:27 -0300181 atomic_t fr_q; /* next frame to queue */
182 atomic_t fr_i; /* frame being filled */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300183 signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
Jean-François Moinef7059ea2010-07-06 04:32:27 -0300184 char nframes; /* number of frames */
185 u8 fr_o; /* next frame to dequeue */
Jean-Francois Moineff374742008-10-23 07:29:51 -0300186 __u8 last_packet_type;
187 __s8 empty_packet; /* if (-1) don't check empty packets */
188 __u8 streaming;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300189
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300190 __u8 curr_mode; /* current camera mode */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300191 __u32 pixfmt; /* current mode parameters */
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300192 __u16 width;
193 __u16 height;
Jean-Francois Moineff374742008-10-23 07:29:51 -0300194 __u32 sequence; /* frame sequence number */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300195
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300196 wait_queue_head_t wq; /* wait queue */
197 struct mutex usb_lock; /* usb exchange protection */
198 struct mutex read_lock; /* read protection */
199 struct mutex queue_lock; /* ISOC queue protection */
Jean-Francois Moine8c4ebae2009-12-02 07:14:33 -0300200 int usb_err; /* USB error - protected by usb_lock */
Jean-François Moine35680ba2010-07-14 06:30:18 -0300201 u16 pkt_size; /* ISOC packet size */
Jean-Francois Moine6a709742008-09-03 16:48:10 -0300202#ifdef CONFIG_PM
203 char frozen; /* suspend - resume */
204#endif
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300205 char users; /* number of opens */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300206 char present; /* device connected */
207 char nbufread; /* number of buffers for read() */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300208 char memory; /* memory type (V4L2_MEMORY_xxx) */
Jean-Francois Moineff374742008-10-23 07:29:51 -0300209 __u8 iface; /* USB interface number */
210 __u8 alt; /* USB alternate setting */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300211 __u8 nbalt; /* number of USB alternate settings */
Jean-François Moine35680ba2010-07-14 06:30:18 -0300212 u8 audio; /* presence of audio device */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300213};
214
215int gspca_dev_probe(struct usb_interface *intf,
216 const struct usb_device_id *id,
217 const struct sd_desc *sd_desc,
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300218 int dev_size,
219 struct module *module);
Jean-François Moine44628642010-06-05 07:47:36 -0300220int gspca_dev_probe2(struct usb_interface *intf,
221 const struct usb_device_id *id,
222 const struct sd_desc *sd_desc,
223 int dev_size,
224 struct module *module);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300225void gspca_disconnect(struct usb_interface *intf);
Jean-Francois Moine76dd2722009-11-13 09:21:03 -0300226void gspca_frame_add(struct gspca_dev *gspca_dev,
227 enum gspca_packet_type packet_type,
228 const u8 *data,
229 int len);
Jean-Francois Moine6a709742008-09-03 16:48:10 -0300230#ifdef CONFIG_PM
231int gspca_suspend(struct usb_interface *intf, pm_message_t message);
232int gspca_resume(struct usb_interface *intf);
233#endif
Hans de Goededcef3232008-07-10 10:40:53 -0300234int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
235 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300236#endif /* GSPCAV2_H */