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 <linux/mutex.h>
10 
11 /* compilation option */
12 #define GSPCA_DEBUG 1
13 
14 #ifdef GSPCA_DEBUG
15 /* GSPCA our debug messages */
16 extern 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
30 #define D_V4L2 0x0100
31 #else
32 #define PDEBUG(level, fmt, args...)
33 #endif
34 #undef err
35 #define err(fmt, args...) \
36 	printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args)
37 #undef info
38 #define info(fmt, args...) \
39 	printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args)
40 #undef warn
41 #define warn(fmt, args...) \
42 	printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args)
43 
44 #define GSPCA_MAX_FRAMES 16	/* maximum number of video frame buffers */
45 /* image transfers */
46 #define MAX_NURBS 4		/* max number of URBs */
47 
48 
49 /* used to list framerates supported by a camera mode (resolution) */
50 struct framerates {
51 	const u8 *rates;
52 	int nrates;
53 };
54 
55 /* control definition */
56 struct gspca_ctrl {
57 	s16 val;	/* current value */
58 	s16 def;	/* default value */
59 	s16 min, max;	/* minimum and maximum values */
60 };
61 
62 /* device information - set at probe time */
63 struct cam {
64 	const struct v4l2_pix_format *cam_mode;	/* size nmodes */
65 	const struct framerates *mode_framerates; /* must have size nmodes,
66 						   * just like cam_mode */
67 	struct gspca_ctrl *ctrls;	/* control table - size nctrls */
68 					/* may be NULL */
69 	u32 bulk_size;		/* buffer size when image transfer by bulk */
70 	u32 input_flags;	/* value for ENUM_INPUT status flags */
71 	u8 nmodes;		/* size of cam_mode */
72 	u8 no_urb_create;	/* don't create transfer URBs */
73 	u8 bulk_nurbs;		/* number of URBs in bulk mode
74 				 * - cannot be > MAX_NURBS
75 				 * - when 0 and bulk_size != 0 means
76 				 *   1 URB and submit done by subdriver */
77 	u8 bulk;		/* image transfer by 0:isoc / 1:bulk */
78 	u8 npkt;		/* number of packets in an ISOC message
79 				 * 0 is the default value: 32 packets */
80 	u8 reverse_alts;	/* Alt settings are in high to low order */
81 };
82 
83 struct gspca_dev;
84 struct gspca_frame;
85 
86 /* subdriver operations */
87 typedef int (*cam_op) (struct gspca_dev *);
88 typedef void (*cam_v_op) (struct gspca_dev *);
89 typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
90 typedef int (*cam_jpg_op) (struct gspca_dev *,
91 				struct v4l2_jpegcompression *);
92 typedef int (*cam_reg_op) (struct gspca_dev *,
93 				struct v4l2_dbg_register *);
94 typedef int (*cam_ident_op) (struct gspca_dev *,
95 				struct v4l2_dbg_chip_ident *);
96 typedef void (*cam_streamparm_op) (struct gspca_dev *,
97 				  struct v4l2_streamparm *);
98 typedef int (*cam_qmnu_op) (struct gspca_dev *,
99 			struct v4l2_querymenu *);
100 typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
101 				u8 *data,
102 				int len);
103 typedef int (*cam_int_pkt_op) (struct gspca_dev *gspca_dev,
104 				u8 *data,
105 				int len);
106 
107 struct ctrl {
108 	struct v4l2_queryctrl qctrl;
109 	int (*set)(struct gspca_dev *, __s32);
110 	int (*get)(struct gspca_dev *, __s32 *);
111 	cam_v_op set_control;
112 };
113 
114 /* subdriver description */
115 struct sd_desc {
116 /* information */
117 	const char *name;	/* sub-driver name */
118 /* controls */
119 	const struct ctrl *ctrls;	/* static control definition */
120 	int nctrls;
121 /* mandatory operations */
122 	cam_cf_op config;	/* called on probe */
123 	cam_op init;		/* called on probe and resume */
124 	cam_op start;		/* called on stream on after URBs creation */
125 	cam_pkt_op pkt_scan;
126 /* optional operations */
127 	cam_op isoc_init;	/* called on stream on before getting the EP */
128 	cam_op isoc_nego;	/* called when URB submit failed with NOSPC */
129 	cam_v_op stopN;		/* called on stream off - main alt */
130 	cam_v_op stop0;		/* called on stream off & disconnect - alt 0 */
131 	cam_v_op dq_callback;	/* called when a frame has been dequeued */
132 	cam_jpg_op get_jcomp;
133 	cam_jpg_op set_jcomp;
134 	cam_qmnu_op querymenu;
135 	cam_streamparm_op get_streamparm;
136 	cam_streamparm_op set_streamparm;
137 #ifdef CONFIG_VIDEO_ADV_DEBUG
138 	cam_reg_op set_register;
139 	cam_reg_op get_register;
140 #endif
141 	cam_ident_op get_chip_ident;
142 #if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
143 	cam_int_pkt_op int_pkt_scan;
144 	/* other_input makes the gspca core create gspca_dev->input even when
145 	   int_pkt_scan is NULL, for cams with non interrupt driven buttons */
146 	u8 other_input;
147 #endif
148 };
149 
150 /* packet types when moving from iso buf to frame buf */
151 enum gspca_packet_type {
152 	DISCARD_PACKET,
153 	FIRST_PACKET,
154 	INTER_PACKET,
155 	LAST_PACKET
156 };
157 
158 struct gspca_frame {
159 	__u8 *data;			/* frame buffer */
160 	int vma_use_count;
161 	struct v4l2_buffer v4l2_buf;
162 };
163 
164 struct gspca_dev {
165 	struct video_device vdev;	/* !! must be the first item */
166 	struct module *module;		/* subdriver handling the device */
167 	struct usb_device *dev;
168 	struct file *capt_file;		/* file doing video capture */
169 #if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
170 	struct input_dev *input_dev;
171 	char phys[64];			/* physical device path */
172 #endif
173 
174 	struct cam cam;				/* device information */
175 	const struct sd_desc *sd_desc;		/* subdriver description */
176 	unsigned ctrl_dis;		/* disabled controls (bit map) */
177 	unsigned ctrl_inac;		/* inactive controls (bit map) */
178 
179 #define USB_BUF_SZ 64
180 	__u8 *usb_buf;				/* buffer for USB exchanges */
181 	struct urb *urb[MAX_NURBS];
182 #if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
183 	struct urb *int_urb;
184 #endif
185 
186 	__u8 *frbuf;				/* buffer for nframes */
187 	struct gspca_frame frame[GSPCA_MAX_FRAMES];
188 	u8 *image;				/* image beeing filled */
189 	__u32 frsz;				/* frame size */
190 	u32 image_len;				/* current length of image */
191 	atomic_t fr_q;				/* next frame to queue */
192 	atomic_t fr_i;				/* frame being filled */
193 	signed char fr_queue[GSPCA_MAX_FRAMES];	/* frame queue */
194 	char nframes;				/* number of frames */
195 	u8 fr_o;				/* next frame to dequeue */
196 	__u8 last_packet_type;
197 	__s8 empty_packet;		/* if (-1) don't check empty packets */
198 	__u8 streaming;
199 
200 	__u8 curr_mode;			/* current camera mode */
201 	__u32 pixfmt;			/* current mode parameters */
202 	__u16 width;
203 	__u16 height;
204 	__u32 sequence;			/* frame sequence number */
205 
206 	wait_queue_head_t wq;		/* wait queue */
207 	struct mutex usb_lock;		/* usb exchange protection */
208 	struct mutex queue_lock;	/* ISOC queue protection */
209 	int usb_err;			/* USB error - protected by usb_lock */
210 	u16 pkt_size;			/* ISOC packet size */
211 #ifdef CONFIG_PM
212 	char frozen;			/* suspend - resume */
213 #endif
214 	char present;			/* device connected */
215 	char nbufread;			/* number of buffers for read() */
216 	char memory;			/* memory type (V4L2_MEMORY_xxx) */
217 	__u8 iface;			/* USB interface number */
218 	__u8 alt;			/* USB alternate setting */
219 	__u8 nbalt;			/* number of USB alternate settings */
220 	u8 audio;			/* presence of audio device */
221 };
222 
223 int gspca_dev_probe(struct usb_interface *intf,
224 		const struct usb_device_id *id,
225 		const struct sd_desc *sd_desc,
226 		int dev_size,
227 		struct module *module);
228 int gspca_dev_probe2(struct usb_interface *intf,
229 		const struct usb_device_id *id,
230 		const struct sd_desc *sd_desc,
231 		int dev_size,
232 		struct module *module);
233 void gspca_disconnect(struct usb_interface *intf);
234 void gspca_frame_add(struct gspca_dev *gspca_dev,
235 			enum gspca_packet_type packet_type,
236 			const u8 *data,
237 			int len);
238 #ifdef CONFIG_PM
239 int gspca_suspend(struct usb_interface *intf, pm_message_t message);
240 int gspca_resume(struct usb_interface *intf);
241 #endif
242 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
243 	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
244 #endif /* GSPCAV2_H */
245