[mirror_ubuntu-zesty-kernel.git] / drivers / media / video / pwc / pwc.h

/* (C) 1999-2003 Nemosoft Unv.
   (C) 2004-2006 Luc Saillard (luc@saillard.org)

   NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
   driver and thus may have bugs that are not present in the original version.
   Please send bug reports and support requests to <luc@saillard.org>.
   The decompression routines have been implemented by reverse-engineering the
   Nemosoft binary pwcx module. Caveat emptor.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef PWC_H
#define PWC_H

#include <linux/module.h>
#include <linux/usb.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/mutex.h>
#include <linux/mm.h>
#include <linux/slab.h>
#include <asm/errno.h>
#include <linux/videodev2.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-ctrls.h>
#include <media/videobuf2-vmalloc.h>
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
#include <linux/input.h>
#endif

#include <media/pwc-ioctl.h>

/* Version block */
#define PWC_VERSION	"10.0.15"
#define PWC_NAME 	"pwc"
#define PFX		PWC_NAME ": "


/* Trace certain actions in the driver */
#define PWC_DEBUG_LEVEL_MODULE	(1<<0)
#define PWC_DEBUG_LEVEL_PROBE	(1<<1)
#define PWC_DEBUG_LEVEL_OPEN	(1<<2)
#define PWC_DEBUG_LEVEL_READ	(1<<3)
#define PWC_DEBUG_LEVEL_MEMORY	(1<<4)
#define PWC_DEBUG_LEVEL_FLOW	(1<<5)
#define PWC_DEBUG_LEVEL_SIZE	(1<<6)
#define PWC_DEBUG_LEVEL_IOCTL	(1<<7)
#define PWC_DEBUG_LEVEL_TRACE	(1<<8)

#define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
#define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
#define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
#define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
#define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
#define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
#define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
#define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
#define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)


#ifdef CONFIG_USB_PWC_DEBUG

#define PWC_DEBUG_LEVEL	(PWC_DEBUG_LEVEL_MODULE)

#define PWC_DEBUG(level, fmt, args...) do {\
	if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
		printk(KERN_DEBUG PFX fmt, ##args); \
	} while (0)

#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
#define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)

#else /* if ! CONFIG_USB_PWC_DEBUG */

#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
#define PWC_TRACE(fmt, args...) do { } while(0)
#define PWC_DEBUG(level, fmt, args...) do { } while(0)

#define pwc_trace 0

#endif

/* Defines for ToUCam cameras */
#define TOUCAM_HEADER_SIZE		8
#define TOUCAM_TRAILER_SIZE		4

#define FEATURE_MOTOR_PANTILT		0x0001
#define FEATURE_CODEC1			0x0002
#define FEATURE_CODEC2			0x0004

/* Ignore errors in the first N frames, to allow for startup delays */
#define FRAME_LOWMARK 5

/* Size and number of buffers for the ISO pipe. */
#define MAX_ISO_BUFS		3
#define ISO_FRAMES_PER_DESC	10
#define ISO_MAX_FRAME_SIZE	960
#define ISO_BUFFER_SIZE 	(ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)

/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
#define PWC_FRAME_SIZE 		(460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)

/* Absolute minimum and maximum number of buffers available for mmap() */
#define MIN_FRAMES		2
#define MAX_FRAMES		16

/* Some macros to quickly find the type of a webcam */
#define DEVICE_USE_CODEC1(x) ((x)<675)
#define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
#define DEVICE_USE_CODEC3(x) ((x)>=700)
#define DEVICE_USE_CODEC23(x) ((x)>=675)

/* from pwc-dec.h */
#define PWCX_FLAG_PLANAR        0x0001

/* Request types: video */
#define SET_LUM_CTL			0x01
#define GET_LUM_CTL			0x02
#define SET_CHROM_CTL			0x03
#define GET_CHROM_CTL			0x04
#define SET_STATUS_CTL			0x05
#define GET_STATUS_CTL			0x06
#define SET_EP_STREAM_CTL		0x07
#define GET_EP_STREAM_CTL		0x08
#define GET_XX_CTL			0x09
#define SET_XX_CTL			0x0A
#define GET_XY_CTL			0x0B
#define SET_XY_CTL			0x0C
#define SET_MPT_CTL			0x0D
#define GET_MPT_CTL			0x0E

/* Selectors for the Luminance controls [GS]ET_LUM_CTL */
#define AGC_MODE_FORMATTER			0x2000
#define PRESET_AGC_FORMATTER			0x2100
#define SHUTTER_MODE_FORMATTER			0x2200
#define PRESET_SHUTTER_FORMATTER		0x2300
#define PRESET_CONTOUR_FORMATTER		0x2400
#define AUTO_CONTOUR_FORMATTER			0x2500
#define BACK_LIGHT_COMPENSATION_FORMATTER	0x2600
#define CONTRAST_FORMATTER			0x2700
#define DYNAMIC_NOISE_CONTROL_FORMATTER		0x2800
#define FLICKERLESS_MODE_FORMATTER		0x2900
#define AE_CONTROL_SPEED			0x2A00
#define BRIGHTNESS_FORMATTER			0x2B00
#define GAMMA_FORMATTER				0x2C00

/* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
#define WB_MODE_FORMATTER			0x1000
#define AWB_CONTROL_SPEED_FORMATTER		0x1100
#define AWB_CONTROL_DELAY_FORMATTER		0x1200
#define PRESET_MANUAL_RED_GAIN_FORMATTER	0x1300
#define PRESET_MANUAL_BLUE_GAIN_FORMATTER	0x1400
#define COLOUR_MODE_FORMATTER			0x1500
#define SATURATION_MODE_FORMATTER1		0x1600
#define SATURATION_MODE_FORMATTER2		0x1700

/* Selectors for the Status controls [GS]ET_STATUS_CTL */
#define SAVE_USER_DEFAULTS_FORMATTER		0x0200
#define RESTORE_USER_DEFAULTS_FORMATTER		0x0300
#define RESTORE_FACTORY_DEFAULTS_FORMATTER	0x0400
#define READ_AGC_FORMATTER			0x0500
#define READ_SHUTTER_FORMATTER			0x0600
#define READ_RED_GAIN_FORMATTER			0x0700
#define READ_BLUE_GAIN_FORMATTER		0x0800

/* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
#define PT_RELATIVE_CONTROL_FORMATTER		0x01
#define PT_RESET_CONTROL_FORMATTER		0x02
#define PT_STATUS_FORMATTER			0x03

/* intermediate buffers with raw data from the USB cam */
struct pwc_frame_buf
{
	struct vb2_buffer vb;	/* common v4l buffer stuff -- must be first */
	struct list_head list;
	void *data;
	int filled;		/* number of bytes filled */
};

struct pwc_device
{
	struct video_device vdev;
	struct mutex modlock;

	/* Pointer to our usb_device, may be NULL after unplug */
	struct usb_device *udev;
	/* Protects the setting of udev to NULL by our disconnect handler */
	struct mutex udevlock;

	/* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
	int type;
	int release;		/* release number */
	int features;		/* feature bits */
	char serial[30];	/* serial number (string) */

	/*** Video data ***/
	struct file *capt_file;	/* file doing video capture */
	int vendpoint;		/* video isoc endpoint */
	int vcinterface;	/* video control interface */
	int valternate;		/* alternate interface needed */
	int vframes, vsize;	/* frames-per-second & size (see PSZ_*) */
	int pixfmt;		/* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
	int vframe_count;	/* received frames */
	int vmax_packet_size;	/* USB maxpacket size */
	int vlast_packet_size;	/* for frame synchronisation */
	int visoc_errors;	/* number of contiguous ISOC errors */
	int vcompression;	/* desired compression factor */
	int vbandlength;	/* compressed band length; 0 is uncompressed */
	char vsnapshot;		/* snapshot mode */
	char vsync;		/* used by isoc handler */
	char vmirror;		/* for ToUCaM series */
	char power_save;	/* Do powersaving for this cam */

	int cmd_len;
	unsigned char cmd_buf[13];

	struct urb *urbs[MAX_ISO_BUFS];
	char iso_init;

	/* videobuf2 queue and queued buffers list */
	struct vb2_queue vb_queue;
	struct list_head queued_bufs;
	spinlock_t queued_bufs_lock;

	/*
	 * Frame currently being filled, this only gets touched by the
	 * isoc urb complete handler, and by stream start / stop since
	 * start / stop touch it before / after starting / killing the urbs
	 * no locking is needed around this
	 */
	struct pwc_frame_buf *fill_buf;

	int frame_header_size, frame_trailer_size;
	int frame_size;
	int frame_total_size;	/* including header & trailer */
	int drop_frames;

	void *decompress_data;	/* private data for decompression engine */

	/*
	 * We have an 'image' and a 'view', where 'image' is the fixed-size img
	 * as delivered by the camera, and 'view' is the size requested by the
	 * program. The camera image is centered in this viewport, laced with
	 * a gray or black border. view_min <= image <= view <= view_max;
	 */
	int image_mask;				/* supported sizes */
	struct pwc_coord view_min, view_max;	/* minimum and maximum view */
	struct pwc_coord abs_max;		/* maximum supported size */
	struct pwc_coord image, view;		/* image and viewport size */
	struct pwc_coord offset;		/* offset of the viewport */

	/*** motorized pan/tilt feature */
	struct pwc_mpt_range angle_range;
	int pan_angle;			/* in degrees * 100 */
	int tilt_angle;			/* absolute angle; 0,0 is home */

	/*
	 * Set to 1 when the user push the button, reset to 0
	 * when this value is read from sysfs.
	 */
	int snapshot_button_status;
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	struct input_dev *button_dev;	/* webcam snapshot button input */
	char button_phys[64];
#endif

	/* controls */
	struct v4l2_ctrl_handler	ctrl_handler;
	u16				saturation_fmt;
	struct v4l2_ctrl		*brightness;
	struct v4l2_ctrl		*contrast;
	struct v4l2_ctrl		*saturation;
	struct v4l2_ctrl		*gamma;
	struct {
		/* awb / red-blue balance cluster */
		struct v4l2_ctrl	*auto_white_balance;
		struct v4l2_ctrl	*red_balance;
		struct v4l2_ctrl	*blue_balance;
		/* usb ctrl transfers are slow, so we cache things */
		int			color_bal_valid;
		unsigned long		last_color_bal_update; /* In jiffies */
		s32			last_red_balance;
		s32			last_blue_balance;
	};
	struct {
		/* autogain / gain cluster */
		struct v4l2_ctrl	*autogain;
		struct v4l2_ctrl	*gain;
		int			gain_valid;
		unsigned long		last_gain_update; /* In jiffies */
		s32			last_gain;
	};
	struct {
		/* exposure_auto / exposure cluster */
		struct v4l2_ctrl	*exposure_auto;
		struct v4l2_ctrl	*exposure;
		int			exposure_valid;
		unsigned long		last_exposure_update; /* In jiffies */
		s32			last_exposure;
	};
	struct v4l2_ctrl		*colorfx;
	struct {
		/* autocontour/contour cluster */
		struct v4l2_ctrl	*autocontour;
		struct v4l2_ctrl	*contour;
	};
	struct v4l2_ctrl		*backlight;
	struct v4l2_ctrl		*flicker;
	struct v4l2_ctrl		*noise_reduction;
	struct v4l2_ctrl		*save_user;
	struct v4l2_ctrl		*restore_user;
	struct v4l2_ctrl		*restore_factory;
	struct {
		/* motor control cluster */
		struct v4l2_ctrl	*motor_pan;
		struct v4l2_ctrl	*motor_tilt;
		struct v4l2_ctrl	*motor_pan_reset;
		struct v4l2_ctrl	*motor_tilt_reset;
	};
	/* CODEC3 models have both gain and exposure controlled by autogain */
	struct v4l2_ctrl		*autogain_expo_cluster[3];
};

/* Global variables */
#ifdef CONFIG_USB_PWC_DEBUG
extern int pwc_trace;
#endif

/** Functions in pwc-misc.c */
/* sizes in pixels */
extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];

int pwc_decode_size(struct pwc_device *pdev, int width, int height);
void pwc_construct(struct pwc_device *pdev);

/** Functions in pwc-ctrl.c */
/* Request a certain video mode. Returns < 0 if not possible */
extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
extern int pwc_get_cmos_sensor(struct pwc_device *pdev, int *sensor);
extern int send_control_msg(struct pwc_device *pdev,
			    u8 request, u16 value, void *buf, int buflen);

/* Control get / set helpers */
int pwc_get_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data);
int pwc_get_s8_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *data);
#define pwc_set_s8_ctrl pwc_set_u8_ctrl
int pwc_get_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, int *dat);
int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data);
int pwc_button_ctrl(struct pwc_device *pdev, u16 value);
int pwc_init_controls(struct pwc_device *pdev);

/* Power down or up the camera; not supported by all models */
extern void pwc_camera_power(struct pwc_device *pdev, int power);

/* Private ioctl()s; see pwc-ioctl.h */
extern long pwc_ioctl(struct pwc_device *pdev, unsigned int cmd, void *arg);

extern const struct v4l2_ioctl_ops pwc_ioctl_ops;

/** pwc-uncompress.c */
/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
int pwc_decompress(struct pwc_device *pdev, struct pwc_frame_buf *fbuf);

#endif
Commit	Line	Data
1da177e4	1	/* (C) 1999-2003 Nemosoft Unv.
2b455db6	2	(C) 2004-2006 Luc Saillard (luc@saillard.org)
1da177e4 LT	3
	4	NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
	5	driver and thus may have bugs that are not present in the original version.
	6	Please send bug reports and support requests to <luc@saillard.org>.
	7	The decompression routines have been implemented by reverse-engineering the
	8	Nemosoft binary pwcx module. Caveat emptor.
	9
	10	This program is free software; you can redistribute it and/or modify
	11	it under the terms of the GNU General Public License as published by
	12	the Free Software Foundation; either version 2 of the License, or
	13	(at your option) any later version.
	14
	15	This program is distributed in the hope that it will be useful,
	16	but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	GNU General Public License for more details.
	19
	20	You should have received a copy of the GNU General Public License
	21	along with this program; if not, write to the Free Software
	22	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*/
	24
	25	#ifndef PWC_H
	26	#define PWC_H
	27
1da177e4 LT	28	#include <linux/module.h>
	29	#include <linux/usb.h>
	30	#include <linux/spinlock.h>
1da177e4	31	#include <linux/wait.h>
b9378fdb	32	#include <linux/mutex.h>
38413fd2	33	#include <linux/mm.h>
5a0e3ad6	34	#include <linux/slab.h>
1da177e4	35	#include <asm/errno.h>
479567ce	36	#include <linux/videodev2.h>
5e87efa3	37	#include <media/v4l2-common.h>
35ea11ff	38	#include <media/v4l2-ioctl.h>
6c9cac89	39	#include <media/v4l2-ctrls.h>
885fe18f	40	#include <media/videobuf2-vmalloc.h>
e32a7ecc NPT	41	#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	42	#include <linux/input.h>
	43	#endif
1da177e4	44
2b455db6	45	#include <media/pwc-ioctl.h>
1da177e4	46
2b455db6	47	/* Version block */
880c35c5	48	#define PWC_VERSION "10.0.15"
2b455db6 LS	49	#define PWC_NAME "pwc"
	50	#define PFX PWC_NAME ": "
	51
1da177e4 LT	52
1da177e4 LT	53	/* Trace certain actions in the driver */
2b455db6 LS	54	#define PWC_DEBUG_LEVEL_MODULE (1<<0)
	55	#define PWC_DEBUG_LEVEL_PROBE (1<<1)
	56	#define PWC_DEBUG_LEVEL_OPEN (1<<2)
	57	#define PWC_DEBUG_LEVEL_READ (1<<3)
	58	#define PWC_DEBUG_LEVEL_MEMORY (1<<4)
	59	#define PWC_DEBUG_LEVEL_FLOW (1<<5)
	60	#define PWC_DEBUG_LEVEL_SIZE (1<<6)
	61	#define PWC_DEBUG_LEVEL_IOCTL (1<<7)
	62	#define PWC_DEBUG_LEVEL_TRACE (1<<8)
	63
	64	#define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
	65	#define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
	66	#define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
	67	#define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
	68	#define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
	69	#define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
	70	#define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
	71	#define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
	72	#define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
	73
	74
05ad3907	75	#ifdef CONFIG_USB_PWC_DEBUG
2b455db6 LS	76
	77	#define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
	78
	79	#define PWC_DEBUG(level, fmt, args...) do {\
1a4ede65 HG	80	if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
	81	printk(KERN_DEBUG PFX fmt, ##args); \
	82	} while (0)
2b455db6 LS	83
	84	#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
	85	#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
	86	#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
	87	#define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
	88
9ee6d78c	89	#else /* if ! CONFIG_USB_PWC_DEBUG */
2b455db6 LS	90
	91	#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
	92	#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
	93	#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
	94	#define PWC_TRACE(fmt, args...) do { } while(0)
	95	#define PWC_DEBUG(level, fmt, args...) do { } while(0)
	96
	97	#define pwc_trace 0
1da177e4	98
2b455db6	99	#endif
1da177e4 LT	100
	101	/* Defines for ToUCam cameras */
	102	#define TOUCAM_HEADER_SIZE 8
	103	#define TOUCAM_TRAILER_SIZE 4
	104
	105	#define FEATURE_MOTOR_PANTILT 0x0001
2b455db6 LS	106	#define FEATURE_CODEC1 0x0002
2b455db6 LS	107	#define FEATURE_CODEC2 0x0004
1da177e4	108
1da177e4 LT	109	/* Ignore errors in the first N frames, to allow for startup delays */
	110	#define FRAME_LOWMARK 5
	111
	112	/* Size and number of buffers for the ISO pipe. */
885fe18f	113	#define MAX_ISO_BUFS 3
1da177e4 LT	114	#define ISO_FRAMES_PER_DESC 10
	115	#define ISO_MAX_FRAME_SIZE 960
	116	#define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
	117
1da177e4 LT	118	/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
	119	#define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
	120
885fe18f HG	121	/* Absolute minimum and maximum number of buffers available for mmap() */
	122	#define MIN_FRAMES 2
	123	#define MAX_FRAMES 16
1da177e4	124
2b455db6 LS	125	/* Some macros to quickly find the type of a webcam */
	126	#define DEVICE_USE_CODEC1(x) ((x)<675)
	127	#define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
	128	#define DEVICE_USE_CODEC3(x) ((x)>=700)
	129	#define DEVICE_USE_CODEC23(x) ((x)>=675)
	130
e3aec98c HG	131	/* from pwc-dec.h */
	132	#define PWCX_FLAG_PLANAR 0x0001
	133
6c9cac89 HG	134	/* Request types: video */
	135	#define SET_LUM_CTL 0x01
	136	#define GET_LUM_CTL 0x02
	137	#define SET_CHROM_CTL 0x03
	138	#define GET_CHROM_CTL 0x04
	139	#define SET_STATUS_CTL 0x05
	140	#define GET_STATUS_CTL 0x06
	141	#define SET_EP_STREAM_CTL 0x07
	142	#define GET_EP_STREAM_CTL 0x08
	143	#define GET_XX_CTL 0x09
	144	#define SET_XX_CTL 0x0A
	145	#define GET_XY_CTL 0x0B
	146	#define SET_XY_CTL 0x0C
	147	#define SET_MPT_CTL 0x0D
	148	#define GET_MPT_CTL 0x0E
	149
	150	/* Selectors for the Luminance controls [GS]ET_LUM_CTL */
	151	#define AGC_MODE_FORMATTER 0x2000
	152	#define PRESET_AGC_FORMATTER 0x2100
	153	#define SHUTTER_MODE_FORMATTER 0x2200
	154	#define PRESET_SHUTTER_FORMATTER 0x2300
	155	#define PRESET_CONTOUR_FORMATTER 0x2400
	156	#define AUTO_CONTOUR_FORMATTER 0x2500
	157	#define BACK_LIGHT_COMPENSATION_FORMATTER 0x2600
	158	#define CONTRAST_FORMATTER 0x2700
	159	#define DYNAMIC_NOISE_CONTROL_FORMATTER 0x2800
	160	#define FLICKERLESS_MODE_FORMATTER 0x2900
	161	#define AE_CONTROL_SPEED 0x2A00
	162	#define BRIGHTNESS_FORMATTER 0x2B00
	163	#define GAMMA_FORMATTER 0x2C00
	164
	165	/* Selectors for the Chrominance controls [GS]ET_CHROM_CTL */
	166	#define WB_MODE_FORMATTER 0x1000
	167	#define AWB_CONTROL_SPEED_FORMATTER 0x1100
	168	#define AWB_CONTROL_DELAY_FORMATTER 0x1200
	169	#define PRESET_MANUAL_RED_GAIN_FORMATTER 0x1300
	170	#define PRESET_MANUAL_BLUE_GAIN_FORMATTER 0x1400
	171	#define COLOUR_MODE_FORMATTER 0x1500
	172	#define SATURATION_MODE_FORMATTER1 0x1600
	173	#define SATURATION_MODE_FORMATTER2 0x1700
	174
	175	/* Selectors for the Status controls [GS]ET_STATUS_CTL */
	176	#define SAVE_USER_DEFAULTS_FORMATTER 0x0200
	177	#define RESTORE_USER_DEFAULTS_FORMATTER 0x0300
	178	#define RESTORE_FACTORY_DEFAULTS_FORMATTER 0x0400
	179	#define READ_AGC_FORMATTER 0x0500
	180	#define READ_SHUTTER_FORMATTER 0x0600
	181	#define READ_RED_GAIN_FORMATTER 0x0700
	182	#define READ_BLUE_GAIN_FORMATTER 0x0800
	183
	184	/* Formatters for the motorized pan & tilt [GS]ET_MPT_CTL */
	185	#define PT_RELATIVE_CONTROL_FORMATTER 0x01
	186	#define PT_RESET_CONTROL_FORMATTER 0x02
	187	#define PT_STATUS_FORMATTER 0x03
	188
1da177e4 LT	189	/* intermediate buffers with raw data from the USB cam */
	190	struct pwc_frame_buf
	191	{
885fe18f HG	192	struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */
	193	struct list_head list;
	194	void *data;
	195	int filled; /* number of bytes filled */
1da177e4 LT	196	};
	197
	198	struct pwc_device
	199	{
9a7b2d1f	200	struct video_device vdev;
1a4ede65 HG	201	struct mutex modlock;
	202
	203	/* Pointer to our usb_device, may be NULL after unplug */
	204	struct usb_device *udev;
c1127134 HG	205	/* Protects the setting of udev to NULL by our disconnect handler */
	206	struct mutex udevlock;
	207
1a4ede65 HG	208	/* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
	209	int type;
	210	int release; /* release number */
	211	int features; /* feature bits */
	212	char serial[30]; /* serial number (string) */
1a4ede65 HG	213
1a4ede65 HG	214	/* Video data */
4fba471e	215	struct file capt_file; / file doing video capture */
1a4ede65 HG	216	int vendpoint; /* video isoc endpoint */
	217	int vcinterface; /* video control interface */
	218	int valternate; /* alternate interface needed */
	219	int vframes, vsize; /* frames-per-second & size (see PSZ_) /
	220	int pixfmt; /* pixelformat: V4L2_PIX_FMT_YUV420 or _PWCX */
	221	int vframe_count; /* received frames */
	222	int vmax_packet_size; /* USB maxpacket size */
	223	int vlast_packet_size; /* for frame synchronisation */
	224	int visoc_errors; /* number of contiguous ISOC errors */
	225	int vcompression; /* desired compression factor */
	226	int vbandlength; /* compressed band length; 0 is uncompressed */
	227	char vsnapshot; /* snapshot mode */
	228	char vsync; /* used by isoc handler */
	229	char vmirror; /* for ToUCaM series */
3b4d0ec7	230	char power_save; /* Do powersaving for this cam */
d56410e0	231
1a4ede65 HG	232	int cmd_len;
1a4ede65 HG	233	unsigned char cmd_buf[13];
1da177e4	234
04613c5e	235	struct urb *urbs[MAX_ISO_BUFS];
1a4ede65	236	char iso_init;
1da177e4	237
885fe18f HG	238	/* videobuf2 queue and queued buffers list */
	239	struct vb2_queue vb_queue;
	240	struct list_head queued_bufs;
	241	spinlock_t queued_bufs_lock;
	242
	243	/*
	244	* Frame currently being filled, this only gets touched by the
	245	* isoc urb complete handler, and by stream start / stop since
	246	* start / stop touch it before / after starting / killing the urbs
	247	* no locking is needed around this
	248	*/
	249	struct pwc_frame_buf *fill_buf;
	250
1a4ede65 HG	251	int frame_header_size, frame_trailer_size;
	252	int frame_size;
	253	int frame_total_size; /* including header & trailer */
	254	int drop_frames;
	255
	256	void decompress_data; / private data for decompression engine */
	257
	258	/*
	259	* We have an 'image' and a 'view', where 'image' is the fixed-size img
	260	* as delivered by the camera, and 'view' is the size requested by the
	261	* program. The camera image is centered in this viewport, laced with
	262	* a gray or black border. view_min <= image <= view <= view_max;
	263	*/
	264	int image_mask; /* supported sizes */
	265	struct pwc_coord view_min, view_max; /* minimum and maximum view */
	266	struct pwc_coord abs_max; /* maximum supported size */
	267	struct pwc_coord image, view; /* image and viewport size */
	268	struct pwc_coord offset; /* offset of the viewport */
	269
	270	/*** motorized pan/tilt feature */
	271	struct pwc_mpt_range angle_range;
	272	int pan_angle; /* in degrees * 100 */
	273	int tilt_angle; /* absolute angle; 0,0 is home */
	274
	275	/*
	276	* Set to 1 when the user push the button, reset to 0
	277	* when this value is read from sysfs.
	278	*/
	279	int snapshot_button_status;
e32a7ecc	280	#ifdef CONFIG_USB_PWC_INPUT_EVDEV
1a4ede65 HG	281	struct input_dev button_dev; / webcam snapshot button input */
1a4ede65 HG	282	char button_phys[64];
e32a7ecc	283	#endif
6c9cac89 HG	284
	285	/* controls */
	286	struct v4l2_ctrl_handler ctrl_handler;
	287	u16 saturation_fmt;
	288	struct v4l2_ctrl *brightness;
	289	struct v4l2_ctrl *contrast;
	290	struct v4l2_ctrl *saturation;
	291	struct v4l2_ctrl *gamma;
	292	struct {
	293	/* awb / red-blue balance cluster */
	294	struct v4l2_ctrl *auto_white_balance;
	295	struct v4l2_ctrl *red_balance;
	296	struct v4l2_ctrl *blue_balance;
	297	/* usb ctrl transfers are slow, so we cache things */
	298	int color_bal_valid;
	299	unsigned long last_color_bal_update; /* In jiffies */
	300	s32 last_red_balance;
	301	s32 last_blue_balance;
	302	};
	303	struct {
	304	/* autogain / gain cluster */
	305	struct v4l2_ctrl *autogain;
	306	struct v4l2_ctrl *gain;
	307	int gain_valid;
	308	unsigned long last_gain_update; /* In jiffies */
	309	s32 last_gain;
	310	};
	311	struct {
	312	/* exposure_auto / exposure cluster */
	313	struct v4l2_ctrl *exposure_auto;
	314	struct v4l2_ctrl *exposure;
	315	int exposure_valid;
	316	unsigned long last_exposure_update; /* In jiffies */
	317	s32 last_exposure;
	318	};
	319	struct v4l2_ctrl *colorfx;
	320	struct {
	321	/* autocontour/contour cluster */
	322	struct v4l2_ctrl *autocontour;
	323	struct v4l2_ctrl *contour;
	324	};
	325	struct v4l2_ctrl *backlight;
	326	struct v4l2_ctrl *flicker;
	327	struct v4l2_ctrl *noise_reduction;
	328	struct v4l2_ctrl *save_user;
	329	struct v4l2_ctrl *restore_user;
	330	struct v4l2_ctrl *restore_factory;
294e2896 HG	331	struct {
	332	/* motor control cluster */
	333	struct v4l2_ctrl *motor_pan;
	334	struct v4l2_ctrl *motor_tilt;
	335	struct v4l2_ctrl *motor_pan_reset;
	336	struct v4l2_ctrl *motor_tilt_reset;
	337	};
6c9cac89 HG	338	/* CODEC3 models have both gain and exposure controlled by autogain */
6c9cac89 HG	339	struct v4l2_ctrl *autogain_expo_cluster[3];
1da177e4 LT	340	};
1da177e4 LT	341
2b455db6	342	/* Global variables */
05ad3907	343	#ifdef CONFIG_USB_PWC_DEBUG
1da177e4	344	extern int pwc_trace;
2b455db6	345	#endif
1da177e4 LT	346
	347	/** Functions in pwc-misc.c */
	348	/* sizes in pixels */
2b455db6	349	extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
1da177e4 LT	350
	351	int pwc_decode_size(struct pwc_device *pdev, int width, int height);
	352	void pwc_construct(struct pwc_device *pdev);
	353
	354	/** Functions in pwc-ctrl.c */
	355	/* Request a certain video mode. Returns < 0 if not possible */
	356	extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
9ee6d78c	357	extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
2b455db6 LS	358	extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
2b455db6 LS	359	extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
1da177e4	360	extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
1da177e4	361	extern int pwc_get_cmos_sensor(struct pwc_device pdev, int sensor);
294e2896 HG	362	extern int send_control_msg(struct pwc_device *pdev,
294e2896 HG	363	u8 request, u16 value, void *buf, int buflen);
6c9cac89 HG	364
	365	/* Control get / set helpers */
	366	int pwc_get_u8_ctrl(struct pwc_device pdev, u8 request, u16 value, int data);
	367	int pwc_set_u8_ctrl(struct pwc_device *pdev, u8 request, u16 value, u8 data);
	368	int pwc_get_s8_ctrl(struct pwc_device pdev, u8 request, u16 value, int data);
	369	#define pwc_set_s8_ctrl pwc_set_u8_ctrl
	370	int pwc_get_u16_ctrl(struct pwc_device pdev, u8 request, u16 value, int dat);
	371	int pwc_set_u16_ctrl(struct pwc_device *pdev, u8 request, u16 value, u16 data);
	372	int pwc_button_ctrl(struct pwc_device *pdev, u16 value);
	373	int pwc_init_controls(struct pwc_device *pdev);
1da177e4 LT	374
1da177e4 LT	375	/* Power down or up the camera; not supported by all models */
3b4d0ec7	376	extern void pwc_camera_power(struct pwc_device *pdev, int power);
1da177e4 LT	377
1da177e4 LT	378	/* Private ioctl()s; see pwc-ioctl.h */
069b7479	379	extern long pwc_ioctl(struct pwc_device pdev, unsigned int cmd, void arg);
1da177e4	380
afa38521	381	extern const struct v4l2_ioctl_ops pwc_ioctl_ops;
1da177e4 LT	382
	383	/** pwc-uncompress.c */
	384	/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
885fe18f	385	int pwc_decompress(struct pwc_device pdev, struct pwc_frame_buf fbuf);
1da177e4	386
1da177e4	387	#endif