blob: bd1faff8864454a9aa163603570fb62c935eab64 [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
48/* device information - set at probe time */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030049struct cam {
Jean-Francois Moine95d91422008-09-29 05:57:32 -030050 int bulk_size; /* buffer size when image transfer by bulk */
Jean-Francois Moinecc611b82008-12-29 07:49:41 -030051 const struct v4l2_pix_format *cam_mode; /* size nmodes */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030052 char nmodes;
Antonio Ospitedff369a2008-11-14 07:53:32 -030053 __u8 bulk_nurbs; /* number of URBs in bulk mode
54 * - cannot be > MAX_NURBS
55 * - when 0 and bulk_size != 0 means
56 * 1 URB and submit done by subdriver */
Jean-Francois Moine6929dc62009-04-21 13:45:56 -030057 u8 bulk; /* image transfer by 0:isoc / 1:bulk */
Jean-Francois Moine49cb6b02009-04-25 13:29:01 -030058 u8 npkt; /* number of packets in an ISOC message
59 * 0 is the default value: 32 packets */
Adam Bakerdfa76fa2009-03-29 19:17:10 -030060 u32 input_flags; /* value for ENUM_INPUT status flags */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030061};
62
63struct gspca_dev;
64struct gspca_frame;
65
66/* subdriver operations */
67typedef int (*cam_op) (struct gspca_dev *);
68typedef void (*cam_v_op) (struct gspca_dev *);
69typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
70typedef int (*cam_jpg_op) (struct gspca_dev *,
71 struct v4l2_jpegcompression *);
Jim Paris627a5ef2008-12-10 06:02:42 -030072typedef int (*cam_streamparm_op) (struct gspca_dev *,
73 struct v4l2_streamparm *);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030074typedef int (*cam_qmnu_op) (struct gspca_dev *,
75 struct v4l2_querymenu *);
76typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
77 struct gspca_frame *frame,
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -030078 __u8 *data,
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030079 int len);
80
81struct ctrl {
82 struct v4l2_queryctrl qctrl;
83 int (*set)(struct gspca_dev *, __s32);
84 int (*get)(struct gspca_dev *, __s32 *);
85};
86
87/* subdriver description */
88struct sd_desc {
89/* information */
Jean-Francois Moinea5ae2062008-07-04 11:16:16 -030090 const char *name; /* sub-driver name */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030091/* controls */
Jean-Francois Moinea5ae2062008-07-04 11:16:16 -030092 const struct ctrl *ctrls;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030093 int nctrls;
Jean-Francois Moine012d6b02008-09-03 17:12:16 -030094/* mandatory operations */
Hans de Goedee2997a72008-04-23 08:09:12 -030095 cam_cf_op config; /* called on probe */
Jean-Francois Moine012d6b02008-09-03 17:12:16 -030096 cam_op init; /* called on probe and resume */
Jean-Francois Moine72ab97c2008-09-20 06:39:08 -030097 cam_op start; /* called on stream on */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -030098 cam_pkt_op pkt_scan;
Jean-Francois Moinec2446b32008-07-05 11:49:20 -030099/* optional operations */
Jean-Francois Moine012d6b02008-09-03 17:12:16 -0300100 cam_v_op stopN; /* called on stream off - main alt */
Jean-Francois Moine98522a72008-11-18 06:33:08 -0300101 cam_v_op stop0; /* called on stream off & disconnect - alt 0 */
Jean-Francois Moinec2446b32008-07-05 11:49:20 -0300102 cam_v_op dq_callback; /* called when a frame has been dequeued */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300103 cam_jpg_op get_jcomp;
104 cam_jpg_op set_jcomp;
105 cam_qmnu_op querymenu;
Jim Paris627a5ef2008-12-10 06:02:42 -0300106 cam_streamparm_op get_streamparm;
107 cam_streamparm_op set_streamparm;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300108};
109
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300110/* packet types when moving from iso buf to frame buf */
Erik Andrene293e592008-10-03 08:46:50 -0300111enum gspca_packet_type {
112 DISCARD_PACKET,
113 FIRST_PACKET,
114 INTER_PACKET,
115 LAST_PACKET
116};
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300117
118struct gspca_frame {
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300119 __u8 *data; /* frame buffer */
120 __u8 *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 Moinea12ca6a2008-11-19 06:37:53 -0300126 struct video_device vdev; /* !! must be the first item */
Jean-Francois Moine5c4fa002008-11-18 15:52:31 -0300127 struct module *module; /* subdriver handling the device */
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 */
Jean-Francois Moinef50ba1b2008-09-03 17:12:14 -0300133 unsigned ctrl_dis; /* disabled controls (bit map) */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300134
Jean-Francois Moine8295d992008-09-03 17:12:19 -0300135#define USB_BUF_SZ 64
136 __u8 *usb_buf; /* buffer for USB exchanges */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300137 struct urb *urb[MAX_NURBS];
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300138
139 __u8 *frbuf; /* buffer for nframes */
140 struct gspca_frame frame[GSPCA_MAX_FRAMES];
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300141 __u32 frsz; /* frame size */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300142 char nframes; /* number of frames */
143 char fr_i; /* frame being filled */
144 char fr_q; /* next frame to queue */
145 char fr_o; /* next frame to dequeue */
146 signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
Jean-Francois Moineff374742008-10-23 07:29:51 -0300147 __u8 last_packet_type;
148 __s8 empty_packet; /* if (-1) don't check empty packets */
149 __u8 streaming;
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300150
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300151 __u8 curr_mode; /* current camera mode */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300152 __u32 pixfmt; /* current mode parameters */
Jean-Francois Moine6a7eba22008-06-30 15:50:11 -0300153 __u16 width;
154 __u16 height;
Jean-Francois Moineff374742008-10-23 07:29:51 -0300155 __u32 sequence; /* frame sequence number */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300156
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300157 wait_queue_head_t wq; /* wait queue */
158 struct mutex usb_lock; /* usb exchange protection */
159 struct mutex read_lock; /* read protection */
160 struct mutex queue_lock; /* ISOC queue protection */
Jean-Francois Moine6a709742008-09-03 16:48:10 -0300161#ifdef CONFIG_PM
162 char frozen; /* suspend - resume */
163#endif
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300164 char users; /* number of opens */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300165 char present; /* device connected */
166 char nbufread; /* number of buffers for read() */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300167 char nurbs; /* number of allocated URBs */
168 char memory; /* memory type (V4L2_MEMORY_xxx) */
Jean-Francois Moineff374742008-10-23 07:29:51 -0300169 __u8 iface; /* USB interface number */
170 __u8 alt; /* USB alternate setting */
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300171 __u8 nbalt; /* number of USB alternate settings */
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300172};
173
174int gspca_dev_probe(struct usb_interface *intf,
175 const struct usb_device_id *id,
176 const struct sd_desc *sd_desc,
Jean-Francois Moined43fa322008-06-12 10:58:58 -0300177 int dev_size,
178 struct module *module);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300179void gspca_disconnect(struct usb_interface *intf);
180struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
Erik Andrene293e592008-10-03 08:46:50 -0300181 enum gspca_packet_type packet_type,
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300182 struct gspca_frame *frame,
Jean-Francois Moinea5ae2062008-07-04 11:16:16 -0300183 const __u8 *data,
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300184 int len);
Jean-Francois Moine1b60e1a2008-09-20 05:44:21 -0300185struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev);
Jean-Francois Moine6a709742008-09-03 16:48:10 -0300186#ifdef CONFIG_PM
187int gspca_suspend(struct usb_interface *intf, pm_message_t message);
188int gspca_resume(struct usb_interface *intf);
189#endif
Hans de Goededcef3232008-07-10 10:40:53 -0300190int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
191 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
Jean-Francois Moine63eb9542008-04-12 09:58:09 -0300192#endif /* GSPCAV2_H */