[GitHub/mt8127/android_kernel_alcatel_ttab.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 <linux/mutex.h>

/* compilation option */
#define GSPCA_DEBUG 1

#ifdef GSPCA_DEBUG
/* GSPCA our debug messages */
extern int gspca_debug;
#define PDEBUG(level, fmt, args...) \
	do {\
		if (gspca_debug & (level)) \
			printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## 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 0x40
#define D_USBO 0x80
#define D_V4L2 0x0100
#else
#define PDEBUG(level, fmt, args...)
#endif
#undef err
#define err(fmt, args...) \
	printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args)
#undef info
#define info(fmt, args...) \
	printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args)
#undef warn
#define warn(fmt, args...) \
	printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args)

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

/* device information - set at probe time */
struct cam {
	int bulk_size;		/* buffer size when image transfer by bulk */
	const struct v4l2_pix_format *cam_mode;	/* size nmodes */
	char nmodes;
	__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 */
	u32 input_flags;	/* value for ENUM_INPUT status flags */
};

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 int (*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,
				struct gspca_frame *frame,
				__u8 *data,
				int len);

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

/* subdriver description */
struct sd_desc {
/* information */
	const char *name;	/* sub-driver name */
/* controls */
	const struct ctrl *ctrls;
	int nctrls;
/* mandatory operations */
	cam_cf_op config;	/* called on probe */
	cam_op init;		/* called on probe and resume */
	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;
};

/* 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 */
	__u8 *data_end;			/* end of frame while filling */
	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 usb_device *dev;
	struct file *capt_file;		/* file doing video capture */

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

#define USB_BUF_SZ 64
	__u8 *usb_buf;				/* buffer for USB exchanges */
	struct urb *urb[MAX_NURBS];

	__u8 *frbuf;				/* buffer for nframes */
	struct gspca_frame frame[GSPCA_MAX_FRAMES];
	__u32 frsz;				/* frame size */
	char nframes;				/* number of frames */
	char fr_i;				/* frame being filled */
	char fr_q;				/* next frame to queue */
	char fr_o;				/* next frame to dequeue */
	signed char fr_queue[GSPCA_MAX_FRAMES];	/* frame queue */
	__u8 last_packet_type;
	__s8 empty_packet;		/* if (-1) don't check empty packets */
	__u8 streaming;

	__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 read_lock;		/* read protection */
	struct mutex queue_lock;	/* ISOC queue protection */
#ifdef CONFIG_PM
	char frozen;			/* suspend - resume */
#endif
	char users;			/* number of opens */
	char present;			/* device connected */
	char nbufread;			/* number of buffers for read() */
	char nurbs;			/* number of allocated URBs */
	char memory;			/* memory type (V4L2_MEMORY_xxx) */
	__u8 iface;			/* USB interface number */
	__u8 alt;			/* USB alternate setting */
	__u8 nbalt;			/* number of USB alternate settings */
	u16 pkt_size;			/* ISOC packet size */
};

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);
void gspca_disconnect(struct usb_interface *intf);
struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
				    enum gspca_packet_type packet_type,
				    struct gspca_frame *frame,
				    const __u8 *data,
				    int len);
struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev);
#ifdef CONFIG_PM
int gspca_suspend(struct usb_interface *intf, pm_message_t message);
int gspca_resume(struct usb_interface *intf);
#endif
int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
#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>
	9	#include <linux/mutex.h>
	10
335b3f88 JFM	11	/* compilation option */
	12	#define GSPCA_DEBUG 1
	13
	14	#ifdef GSPCA_DEBUG
63eb9546 JFM	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
d43fa32f	30	#define D_V4L2 0x0100
63eb9546 JFM	31	#else
	32	#define PDEBUG(level, fmt, args...)
	33	#endif
	34	#undef err
	35	#define err(fmt, args...) \
11fb06bd	36	printk(KERN_ERR MODULE_NAME ": " fmt "\n", ## args)
63eb9546 JFM	37	#undef info
63eb9546 JFM	38	#define info(fmt, args...) \
11fb06bd	39	printk(KERN_INFO MODULE_NAME ": " fmt "\n", ## args)
63eb9546 JFM	40	#undef warn
63eb9546 JFM	41	#define warn(fmt, args...) \
11fb06bd	42	printk(KERN_WARNING MODULE_NAME ": " fmt "\n", ## args)
63eb9546 JFM	43
63eb9546 JFM	44	#define GSPCA_MAX_FRAMES 16 /* maximum number of video frame buffers */
0be01004 JFM	45	/* image transfers */
0be01004 JFM	46	#define MAX_NURBS 4 /* max number of URBs */
63eb9546 JFM	47
63eb9546 JFM	48	/* device information - set at probe time */
63eb9546	49	struct cam {
95d9142c	50	int bulk_size; /* buffer size when image transfer by bulk */
cc611b8a	51	const struct v4l2_pix_format cam_mode; / size nmodes */
63eb9546	52	char nmodes;
dff369aa AO	53	__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 */
6929dc6b	57	u8 bulk; /* image transfer by 0:isoc / 1:bulk */
49cb6b04 JFM	58	u8 npkt; /* number of packets in an ISOC message
49cb6b04 JFM	59	* 0 is the default value: 32 packets */
dfa76fa2	60	u32 input_flags; /* value for ENUM_INPUT status flags */
63eb9546 JFM	61	};
	62
	63	struct gspca_dev;
	64	struct gspca_frame;
	65
	66	/* subdriver operations */
	67	typedef int (cam_op) (struct gspca_dev );
	68	typedef void (cam_v_op) (struct gspca_dev );
	69	typedef int (cam_cf_op) (struct gspca_dev , const struct usb_device_id *);
	70	typedef int (cam_jpg_op) (struct gspca_dev ,
	71	struct v4l2_jpegcompression *);
af1d9afa BJ	72	typedef int (cam_reg_op) (struct gspca_dev ,
	73	struct v4l2_dbg_register *);
	74	typedef int (cam_ident_op) (struct gspca_dev ,
	75	struct v4l2_dbg_chip_ident *);
627a5ef7 JP	76	typedef int (cam_streamparm_op) (struct gspca_dev ,
627a5ef7 JP	77	struct v4l2_streamparm *);
63eb9546 JFM	78	typedef int (cam_qmnu_op) (struct gspca_dev ,
	79	struct v4l2_querymenu *);
	80	typedef void (cam_pkt_op) (struct gspca_dev gspca_dev,
	81	struct gspca_frame *frame,
6a7eba24	82	__u8 *data,
63eb9546 JFM	83	int len);
	84
	85	struct ctrl {
	86	struct v4l2_queryctrl qctrl;
	87	int (set)(struct gspca_dev , __s32);
	88	int (get)(struct gspca_dev , __s32 *);
	89	};
	90
	91	/* subdriver description */
	92	struct sd_desc {
	93	/* information */
a5ae2062	94	const char name; / sub-driver name */
63eb9546	95	/* controls */
a5ae2062	96	const struct ctrl *ctrls;
63eb9546	97	int nctrls;
012d6b02	98	/* mandatory operations */
e2997a72	99	cam_cf_op config; /* called on probe */
012d6b02	100	cam_op init; /* called on probe and resume */
1f53b0b0	101	cam_op start; /* called on stream on after URBs creation */
63eb9546	102	cam_pkt_op pkt_scan;
c2446b3e	103	/* optional operations */
1f53b0b0 JFM	104	cam_op isoc_init; /* called on stream on before getting the EP */
1f53b0b0 JFM	105	cam_op isoc_nego; /* called when URB submit failed with NOSPC */
012d6b02	106	cam_v_op stopN; /* called on stream off - main alt */
98522a7b	107	cam_v_op stop0; /* called on stream off & disconnect - alt 0 */
c2446b3e	108	cam_v_op dq_callback; /* called when a frame has been dequeued */
63eb9546 JFM	109	cam_jpg_op get_jcomp;
	110	cam_jpg_op set_jcomp;
	111	cam_qmnu_op querymenu;
627a5ef7 JP	112	cam_streamparm_op get_streamparm;
627a5ef7 JP	113	cam_streamparm_op set_streamparm;
af1d9afa BJ	114	#ifdef CONFIG_VIDEO_ADV_DEBUG
	115	cam_reg_op set_register;
	116	cam_reg_op get_register;
	117	#endif
	118	cam_ident_op get_chip_ident;
63eb9546 JFM	119	};
63eb9546 JFM	120
63eb9546	121	/* packet types when moving from iso buf to frame buf */
e293e599 EA	122	enum gspca_packet_type {
	123	DISCARD_PACKET,
	124	FIRST_PACKET,
	125	INTER_PACKET,
	126	LAST_PACKET
	127	};
63eb9546 JFM	128
63eb9546 JFM	129	struct gspca_frame {
6a7eba24 JFM	130	__u8 data; / frame buffer */
6a7eba24 JFM	131	__u8 data_end; / end of frame while filling */
63eb9546 JFM	132	int vma_use_count;
	133	struct v4l2_buffer v4l2_buf;
	134	};
	135
	136	struct gspca_dev {
a12ca6a6	137	struct video_device vdev; /* !! must be the first item */
5c4fa002	138	struct module module; / subdriver handling the device */
63eb9546	139	struct usb_device *dev;
4aa0d037	140	struct file capt_file; / file doing video capture */
63eb9546 JFM	141
	142	struct cam cam; /* device information */
	143	const struct sd_desc sd_desc; / subdriver description */
f50ba1be	144	unsigned ctrl_dis; /* disabled controls (bit map) */
63eb9546	145
8295d99e JFM	146	#define USB_BUF_SZ 64
8295d99e JFM	147	__u8 usb_buf; / buffer for USB exchanges */
d43fa32f	148	struct urb *urb[MAX_NURBS];
63eb9546 JFM	149
	150	__u8 frbuf; / buffer for nframes */
	151	struct gspca_frame frame[GSPCA_MAX_FRAMES];
6a7eba24	152	__u32 frsz; /* frame size */
63eb9546 JFM	153	char nframes; /* number of frames */
	154	char fr_i; /* frame being filled */
	155	char fr_q; /* next frame to queue */
	156	char fr_o; /* next frame to dequeue */
	157	signed char fr_queue[GSPCA_MAX_FRAMES]; /* frame queue */
ff374747 JFM	158	__u8 last_packet_type;
	159	__s8 empty_packet; /* if (-1) don't check empty packets */
	160	__u8 streaming;
63eb9546	161
6a7eba24	162	__u8 curr_mode; /* current camera mode */
63eb9546	163	__u32 pixfmt; /* current mode parameters */
6a7eba24 JFM	164	__u16 width;
6a7eba24 JFM	165	__u16 height;
ff374747	166	__u32 sequence; /* frame sequence number */
63eb9546	167
63eb9546 JFM	168	wait_queue_head_t wq; /* wait queue */
	169	struct mutex usb_lock; /* usb exchange protection */
	170	struct mutex read_lock; /* read protection */
	171	struct mutex queue_lock; /* ISOC queue protection */
6a709749 JFM	172	#ifdef CONFIG_PM
	173	char frozen; /* suspend - resume */
	174	#endif
d43fa32f	175	char users; /* number of opens */
63eb9546 JFM	176	char present; /* device connected */
63eb9546 JFM	177	char nbufread; /* number of buffers for read() */
d43fa32f JFM	178	char nurbs; /* number of allocated URBs */
d43fa32f JFM	179	char memory; /* memory type (V4L2_MEMORY_xxx) */
ff374747 JFM	180	__u8 iface; /* USB interface number */
ff374747 JFM	181	__u8 alt; /* USB alternate setting */
d43fa32f	182	__u8 nbalt; /* number of USB alternate settings */
1f53b0b0	183	u16 pkt_size; /* ISOC packet size */
63eb9546 JFM	184	};
	185
	186	int gspca_dev_probe(struct usb_interface *intf,
	187	const struct usb_device_id *id,
	188	const struct sd_desc *sd_desc,
d43fa32f JFM	189	int dev_size,
d43fa32f JFM	190	struct module *module);
63eb9546 JFM	191	void gspca_disconnect(struct usb_interface *intf);
63eb9546 JFM	192	struct gspca_frame gspca_frame_add(struct gspca_dev gspca_dev,
e293e599	193	enum gspca_packet_type packet_type,
63eb9546	194	struct gspca_frame *frame,
a5ae2062	195	const __u8 *data,
63eb9546	196	int len);
1b60e1ad	197	struct gspca_frame gspca_get_i_frame(struct gspca_dev gspca_dev);
6a709749 JFM	198	#ifdef CONFIG_PM
	199	int gspca_suspend(struct usb_interface *intf, pm_message_t message);
	200	int gspca_resume(struct usb_interface *intf);
	201	#endif
dcef3237 HG	202	int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
dcef3237 HG	203	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee);
63eb9546	204	#endif /* GSPCAV2_H */