[linux-2.6-block.git] / drivers / media / video / gspca / gspca.h

#ifndef GSPCAV2_H
#define GSPCAV2_H

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/usb.h>
#include <linux/videodev2.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-device.h>
#include <linux/mutex.h>

/* compilation option */
/*#define GSPCA_DEBUG 1*/

#ifdef GSPCA_DEBUG
/* GSPCA our debug messages */
extern int gspca_debug;
#define PDEBUG(level, fmt, ...)					\
do {								\
	if (gspca_debug & (level))				\
		pr_info(fmt, ##__VA_ARGS__);			\
} while (0)

#define D_ERR  0x01
#define D_PROBE 0x02
#define D_CONF 0x04
#define D_STREAM 0x08
#define D_FRAM 0x10
#define D_PACK 0x20
#define D_USBI 0x00
#define D_USBO 0x00
#define D_V4L2 0x0100
#else
#define PDEBUG(level, fmt, ...)
#endif

#define GSPCA_MAX_FRAMES 16	/* maximum number of video frame buffers */
/* image transfers */
#define MAX_NURBS 4		/* max number of URBs */


/* used to list framerates supported by a camera mode (resolution) */
struct framerates {
	const u8 *rates;
	int nrates;
};

/* control definition */
struct gspca_ctrl {
	s16 val;	/* current value */
	s16 def;	/* default value */
	s16 min, max;	/* minimum and maximum values */
};

/* device information - set at probe time */
struct cam {
	const struct v4l2_pix_format *cam_mode;	/* size nmodes */
	const struct framerates *mode_framerates; /* must have size nmodes,
						   * just like cam_mode */
	struct gspca_ctrl *ctrls;	/* control table - size nctrls */
					/* may be NULL */
	u32 bulk_size;		/* buffer size when image transfer by bulk */
	u32 input_flags;	/* value for ENUM_INPUT status flags */
	u8 nmodes;		/* size of cam_mode */
	u8 no_urb_create;	/* don't create transfer URBs */
	u8 bulk_nurbs;		/* number of URBs in bulk mode
				 * - cannot be > MAX_NURBS
				 * - when 0 and bulk_size != 0 means
				 *   1 URB and submit done by subdriver */
	u8 bulk;		/* image transfer by 0:isoc / 1:bulk */
	u8 npkt;		/* number of packets in an ISOC message
				 * 0 is the default value: 32 packets */
	u8 needs_full_bandwidth;/* Set this flag to notify the bandwidth calc.
				 * code that the cam fills all image buffers to
				 * the max, even when using compression. */
};

struct gspca_dev;
struct gspca_frame;

/* subdriver operations */
typedef int (*cam_op) (struct gspca_dev *);
typedef void (*cam_v_op) (struct gspca_dev *);
typedef int (*cam_cf_op) (struct gspca_dev *, const struct usb_device_id *);
typedef int (*cam_jpg_op) (struct gspca_dev *,
				struct v4l2_jpegcompression *);
typedef int (*cam_reg_op) (struct gspca_dev *,
				struct v4l2_dbg_register *);
typedef int (*cam_ident_op) (struct gspca_dev *,
				struct v4l2_dbg_chip_ident *);
typedef void (*cam_streamparm_op) (struct gspca_dev *,
				  struct v4l2_streamparm *);
typedef int (*cam_qmnu_op) (struct gspca_dev *,
			struct v4l2_querymenu *);
typedef void (*cam_pkt_op) (struct gspca_dev *gspca_dev,
				u8 *data,
				int len);
typedef int (*cam_int_pkt_op) (struct gspca_dev *gspca_dev,
				u8 *data,
				int len);

struct ctrl {
	struct v4l2_queryctrl qctrl;
	int (*set)(struct gspca_dev *, __s32);
	int (*get)(struct gspca_dev *, __s32 *);
	cam_v_op set_control;
};

/* subdriver description */
struct sd_desc {
/* information */
	const char *name;	/* sub-driver name */
/* controls */
	const struct ctrl *ctrls;	/* static control definition */
	int nctrls;
/* mandatory operations */
	cam_cf_op config;	/* called on probe */
	cam_op init;		/* called on probe and resume */
	cam_op init_controls;	/* called on probe */
	cam_op start;		/* called on stream on after URBs creation */
	cam_pkt_op pkt_scan;
/* optional operations */
	cam_op isoc_init;	/* called on stream on before getting the EP */
	cam_op isoc_nego;	/* called when URB submit failed with NOSPC */
	cam_v_op stopN;		/* called on stream off - main alt */
	cam_v_op stop0;		/* called on stream off & disconnect - alt 0 */
	cam_v_op dq_callback;	/* called when a frame has been dequeued */
	cam_jpg_op get_jcomp;
	cam_jpg_op set_jcomp;
	cam_qmnu_op querymenu;
	cam_streamparm_op get_streamparm;
	cam_streamparm_op set_streamparm;
#ifdef CONFIG_VIDEO_ADV_DEBUG
	cam_reg_op set_register;
	cam_reg_op get_register;
#endif
	cam_ident_op get_chip_ident;
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
	cam_int_pkt_op int_pkt_scan;
	/* other_input makes the gspca core create gspca_dev->input even when
	   int_pkt_scan is NULL, for cams with non interrupt driven buttons */
	u8 other_input;
#endif
};

/* packet types when moving from iso buf to frame buf */
enum gspca_packet_type {
	DISCARD_PACKET,
	FIRST_PACKET,
	INTER_PACKET,
	LAST_PACKET
};

struct gspca_frame {
	__u8 *data;			/* frame buffer */
	int vma_use_count;
	struct v4l2_buffer v4l2_buf;
};

struct gspca_dev {
	struct video_device vdev;	/* !! must be the first item */
	struct module *module;		/* subdriver handling the device */
	struct v4l2_device v4l2_dev;
	struct usb_device *dev;
	struct file *capt_file;		/* file doing video capture */
					/* protected by queue_lock */
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
	struct input_dev *input_dev;
	char phys[64];			/* physical device path */
#endif

	struct cam cam;				/* device information */
	const struct sd_desc *sd_desc;		/* subdriver description */
	unsigned ctrl_dis;		/* disabled controls (bit map) */
	unsigned ctrl_inac;		/* inactive controls (bit map) */
	struct v4l2_ctrl_handler ctrl_handler;

	/* autogain and exposure or gain control cluster, these are global as
	   the autogain/exposure functions in autogain_functions.c use them */
	struct {
		struct v4l2_ctrl *autogain;
		struct v4l2_ctrl *exposure;
		struct v4l2_ctrl *gain;
		int exp_too_low_cnt, exp_too_high_cnt;
	};

#define USB_BUF_SZ 64
	__u8 *usb_buf;				/* buffer for USB exchanges */
	struct urb *urb[MAX_NURBS];
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
	struct urb *int_urb;
#endif

	__u8 *frbuf;				/* buffer for nframes */
	struct gspca_frame frame[GSPCA_MAX_FRAMES];
	u8 *image;				/* image beeing filled */
	__u32 frsz;				/* frame size */
	u32 image_len;				/* current length of image */
	atomic_t fr_q;				/* next frame to queue */
	atomic_t fr_i;				/* frame being filled */
	signed char fr_queue[GSPCA_MAX_FRAMES];	/* frame queue */
	char nframes;				/* number of frames */
	u8 fr_o;				/* next frame to dequeue */
	__u8 last_packet_type;
	__s8 empty_packet;		/* if (-1) don't check empty packets */
	__u8 streaming;			/* protected by both mutexes (*) */

	__u8 curr_mode;			/* current camera mode */
	__u32 pixfmt;			/* current mode parameters */
	__u16 width;
	__u16 height;
	__u32 sequence;			/* frame sequence number */

	wait_queue_head_t wq;		/* wait queue */
	struct mutex usb_lock;		/* usb exchange protection */
	struct mutex queue_lock;	/* ISOC queue protection */
	int usb_err;			/* USB error - protected by usb_lock */
	u16 pkt_size;			/* ISOC packet size */
#ifdef CONFIG_PM
	char frozen;			/* suspend - resume */
#endif
	char present;			/* device connected */
	char nbufread;			/* number of buffers for read() */
	char memory;			/* memory type (V4L2_MEMORY_xxx) */
	__u8 iface;			/* USB interface number */
	__u8 alt;			/* USB alternate setting */
	u8 audio;			/* presence of audio device */

	/* (*) These variables are proteced by both usb_lock and queue_lock,
	   that is any code setting them is holding *both*, which means that
	   any code getting them needs to hold at least one of them */
};

int gspca_dev_probe(struct usb_interface *intf,
		const struct usb_device_id *id,
		const struct sd_desc *sd_desc,
		int dev_size,
		struct module *module);
int gspca_dev_probe2(struct usb_interface *intf,
		const struct usb_device_id *id,
		const struct sd_desc *sd_desc,
		int dev_size,
		struct module *module);
void gspca_disconnect(struct usb_interface *intf);
void gspca_frame_add(struct gspca_dev *gspca_dev,
			enum gspca_packet_type packet_type,
			const u8 *data,
			int len);
#ifdef CONFIG_PM
int gspca_suspend(struct usb_interface *intf, pm_message_t message);
int gspca_resume(struct usb_interface *intf);
#endif
int gspca_expo_autogain(struct gspca_dev *gspca_dev, int avg_lum,
	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
int gspca_coarse_grained_expo_autogain(struct gspca_dev *gspca_dev,
        int avg_lum, int desired_avg_lum, int deadzone);

#endif /* GSPCAV2_H */
Commit	Line	Data
63eb9546 JFM	1	#ifndef GSPCAV2_H
	2	#define GSPCAV2_H
	3
	4	#include <linux/module.h>
63eb9546 JFM	5	#include <linux/kernel.h>
	6	#include <linux/usb.h>
	7	#include <linux/videodev2.h>
	8	#include <media/v4l2-common.h>
8cd05842	9	#include <media/v4l2-ctrls.h>
2333565d	10	#include <media/v4l2-device.h>
63eb9546 JFM	11	#include <linux/mutex.h>
63eb9546 JFM	12
335b3f88	13	/* compilation option */
cf221766	14	/#define GSPCA_DEBUG 1/
335b3f88 JFM	15
335b3f88 JFM	16	#ifdef GSPCA_DEBUG
63eb9546 JFM	17	/* GSPCA our debug messages */
63eb9546 JFM	18	extern int gspca_debug;
133a9fe9 JP	19	#define PDEBUG(level, fmt, ...) \
	20	do { \
	21	if (gspca_debug & (level)) \
	22	pr_info(fmt, ##__VA_ARGS__); \
	23	} while (0)
	24
63eb9546 JFM	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
f8e5677f JFM	31	#define D_USBI 0x00
f8e5677f JFM	32	#define D_USBO 0x00
d43fa32f	33	#define D_V4L2 0x0100
63eb9546	34	#else
133a9fe9	35	#define PDEBUG(level, fmt, ...)
63eb9546	36	#endif
63eb9546 JFM	37
63eb9546 JFM	38	#define GSPCA_MAX_FRAMES 16 /* maximum number of video frame buffers */
0be01004 JFM	39	/* image transfers */
0be01004 JFM	40	#define MAX_NURBS 4 /* max number of URBs */
63eb9546	41
28ffe77f AO	42
	43	/* used to list framerates supported by a camera mode (resolution) */
	44	struct framerates {
29b87f04	45	const u8 *rates;
28ffe77f AO	46	int nrates;
	47	};
	48
6a33091f JFM	49	/* control definition */
	50	struct gspca_ctrl {
	51	s16 val; /* current value */
	52	s16 def; /* default value */
	53	s16 min, max; /* minimum and maximum values */
	54	};
	55
63eb9546	56	/* device information - set at probe time */
63eb9546	57	struct cam {
cc611b8a	58	const struct v4l2_pix_format cam_mode; / size nmodes */
2bbf53bd	59	const struct framerates mode_framerates; / must have size nmodes,
28ffe77f	60	* just like cam_mode */
6a33091f JFM	61	struct gspca_ctrl ctrls; / control table - size nctrls */
6a33091f JFM	62	/* may be NULL */
47aaca96 JFM	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
dff369aa AO	68	* - cannot be > MAX_NURBS
	69	* - when 0 and bulk_size != 0 means
	70	* 1 URB and submit done by subdriver */
6929dc6b	71	u8 bulk; /* image transfer by 0:isoc / 1:bulk */
49cb6b04 JFM	72	u8 npkt; /* number of packets in an ISOC message
49cb6b04 JFM	73	* 0 is the default value: 32 packets */
eb3fb7c9 HG	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. */
63eb9546 JFM	77	};
	78
	79	struct gspca_dev;
	80	struct gspca_frame;
	81
	82	/* subdriver operations */
	83	typedef int (cam_op) (struct gspca_dev );
	84	typedef void (cam_v_op) (struct gspca_dev );
	85	typedef int (cam_cf_op) (struct gspca_dev , const struct usb_device_id *);
	86	typedef int (cam_jpg_op) (struct gspca_dev ,
	87	struct v4l2_jpegcompression *);
af1d9afa BJ	88	typedef int (cam_reg_op) (struct gspca_dev ,
	89	struct v4l2_dbg_register *);
	90	typedef int (cam_ident_op) (struct gspca_dev ,
	91	struct v4l2_dbg_chip_ident *);
668f44a6	92	typedef void (cam_streamparm_op) (struct gspca_dev ,
627a5ef7	93	struct v4l2_streamparm *);
63eb9546 JFM	94	typedef int (cam_qmnu_op) (struct gspca_dev ,
	95	struct v4l2_querymenu *);
	96	typedef void (cam_pkt_op) (struct gspca_dev gspca_dev,
76dd272b	97	u8 *data,
63eb9546	98	int len);
0274d42e MN	99	typedef int (cam_int_pkt_op) (struct gspca_dev gspca_dev,
	100	u8 *data,
	101	int len);
63eb9546 JFM	102
	103	struct ctrl {
	104	struct v4l2_queryctrl qctrl;
	105	int (set)(struct gspca_dev , __s32);
	106	int (get)(struct gspca_dev , __s32 *);
6a33091f	107	cam_v_op set_control;
63eb9546 JFM	108	};
	109
	110	/* subdriver description */
	111	struct sd_desc {
	112	/* information */
a5ae2062	113	const char name; / sub-driver name */
63eb9546	114	/* controls */
6a33091f	115	const struct ctrl ctrls; / static control definition */
63eb9546	116	int nctrls;
012d6b02	117	/* mandatory operations */
e2997a72	118	cam_cf_op config; /* called on probe */
012d6b02	119	cam_op init; /* called on probe and resume */
62bba5dd	120	cam_op init_controls; /* called on probe */
1f53b0b0	121	cam_op start; /* called on stream on after URBs creation */
63eb9546	122	cam_pkt_op pkt_scan;
c2446b3e	123	/* optional operations */
1f53b0b0 JFM	124	cam_op isoc_init; /* called on stream on before getting the EP */
1f53b0b0 JFM	125	cam_op isoc_nego; /* called when URB submit failed with NOSPC */
012d6b02	126	cam_v_op stopN; /* called on stream off - main alt */
98522a7b	127	cam_v_op stop0; /* called on stream off & disconnect - alt 0 */
c2446b3e	128	cam_v_op dq_callback; /* called when a frame has been dequeued */
63eb9546 JFM	129	cam_jpg_op get_jcomp;
	130	cam_jpg_op set_jcomp;
	131	cam_qmnu_op querymenu;
627a5ef7 JP	132	cam_streamparm_op get_streamparm;
627a5ef7 JP	133	cam_streamparm_op set_streamparm;
af1d9afa BJ	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;
f7628015	139	#if defined(CONFIG_INPUT) \|\| defined(CONFIG_INPUT_MODULE)
0274d42e	140	cam_int_pkt_op int_pkt_scan;
ac82f59f HG	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;
0274d42e	144	#endif
63eb9546 JFM	145	};
63eb9546 JFM	146
63eb9546	147	/* packet types when moving from iso buf to frame buf */
e293e599 EA	148	enum gspca_packet_type {
	149	DISCARD_PACKET,
	150	FIRST_PACKET,
	151	INTER_PACKET,
	152	LAST_PACKET
	153	};
63eb9546 JFM	154
63eb9546 JFM	155	struct gspca_frame {
6a7eba24	156	__u8 data; / frame buffer */
63eb9546 JFM	157	int vma_use_count;
	158	struct v4l2_buffer v4l2_buf;
	159	};
	160
	161	struct gspca_dev {
a12ca6a6	162	struct video_device vdev; /* !! must be the first item */
5c4fa002	163	struct module module; / subdriver handling the device */
2333565d	164	struct v4l2_device v4l2_dev;
63eb9546	165	struct usb_device *dev;
4aa0d037	166	struct file capt_file; / file doing video capture */
a3d6e8cc	167	/* protected by queue_lock */
f7628015	168	#if defined(CONFIG_INPUT) \|\| defined(CONFIG_INPUT_MODULE)
0274d42e MN	169	struct input_dev *input_dev;
	170	char phys[64]; /* physical device path */
	171	#endif
63eb9546 JFM	172
	173	struct cam cam; /* device information */
	174	const struct sd_desc sd_desc; / subdriver description */
f50ba1be	175	unsigned ctrl_dis; /* disabled controls (bit map) */
4af85668	176	unsigned ctrl_inac; /* inactive controls (bit map) */
a8a47860	177	struct v4l2_ctrl_handler ctrl_handler;
63eb9546	178
8cd05842 HG	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
8295d99e JFM	188	#define USB_BUF_SZ 64
8295d99e JFM	189	__u8 usb_buf; / buffer for USB exchanges */
d43fa32f	190	struct urb *urb[MAX_NURBS];
f7628015	191	#if defined(CONFIG_INPUT) \|\| defined(CONFIG_INPUT_MODULE)
0274d42e MN	192	struct urb *int_urb;
0274d42e MN	193	#endif
63eb9546 JFM	194
	195	__u8 frbuf; / buffer for nframes */
	196	struct gspca_frame frame[GSPCA_MAX_FRAMES];
b192ca98	197	u8 image; / image beeing filled */
6a7eba24	198	__u32 frsz; /* frame size */
b192ca98	199	u32 image_len; /* current length of image */
f7059eaa JFM	200	atomic_t fr_q; /* next frame to queue */
f7059eaa JFM	201	atomic_t fr_i; /* frame being filled */
63eb9546	202	signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
f7059eaa JFM	203	char nframes; /* number of frames */
f7059eaa JFM	204	u8 fr_o; /* next frame to dequeue */
ff374747 JFM	205	__u8 last_packet_type;
ff374747 JFM	206	__s8 empty_packet; /* if (-1) don't check empty packets */
a3d6e8cc	207	__u8 streaming; /* protected by both mutexes () /
63eb9546	208
6a7eba24	209	__u8 curr_mode; /* current camera mode */
63eb9546	210	__u32 pixfmt; /* current mode parameters */
6a7eba24 JFM	211	__u16 width;
6a7eba24 JFM	212	__u16 height;
ff374747	213	__u32 sequence; /* frame sequence number */
63eb9546	214
63eb9546 JFM	215	wait_queue_head_t wq; /* wait queue */
63eb9546 JFM	216	struct mutex usb_lock; /* usb exchange protection */
63eb9546	217	struct mutex queue_lock; /* ISOC queue protection */
8c4ebae4	218	int usb_err; /* USB error - protected by usb_lock */
35680baa	219	u16 pkt_size; /* ISOC packet size */
6a709749 JFM	220	#ifdef CONFIG_PM
	221	char frozen; /* suspend - resume */
	222	#endif
63eb9546 JFM	223	char present; /* device connected */
63eb9546 JFM	224	char nbufread; /* number of buffers for read() */
d43fa32f	225	char memory; /* memory type (V4L2_MEMORY_xxx) */
ff374747 JFM	226	__u8 iface; /* USB interface number */
ff374747 JFM	227	__u8 alt; /* USB alternate setting */
35680baa	228	u8 audio; /* presence of audio device */
a3d6e8cc HV	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 */
63eb9546 JFM	233	};
	234
	235	int gspca_dev_probe(struct usb_interface *intf,
	236	const struct usb_device_id *id,
	237	const struct sd_desc *sd_desc,
d43fa32f JFM	238	int dev_size,
d43fa32f JFM	239	struct module *module);
4462864d JFM	240	int 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);
63eb9546	245	void gspca_disconnect(struct usb_interface *intf);
76dd272b JFM	246	void gspca_frame_add(struct gspca_dev *gspca_dev,
	247	enum gspca_packet_type packet_type,
	248	const u8 *data,
	249	int len);
6a709749 JFM	250	#ifdef CONFIG_PM
	251	int gspca_suspend(struct usb_interface *intf, pm_message_t message);
	252	int gspca_resume(struct usb_interface *intf);
	253	#endif
8cd05842 HG	254	int gspca_expo_autogain(struct gspca_dev *gspca_dev, int avg_lum,
	255	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
	256	int gspca_coarse_grained_expo_autogain(struct gspca_dev *gspca_dev,
	257	int avg_lum, int desired_avg_lum, int deadzone);
	258
63eb9546	259	#endif /* GSPCAV2_H */