[deliverable/linux.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/version.h>
#include <linux/mutex.h>
#include <linux/mm.h>
#include <asm/errno.h>
#include <linux/videodev.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
#include <linux/input.h>
#endif

#include "pwc-uncompress.h"
#include <media/pwc-ioctl.h>

/* Version block */
#define PWC_MAJOR	10
#define PWC_MINOR	0
#define PWC_EXTRAMINOR	12
#define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR)
#define PWC_VERSION 	"10.0.13"
#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

/* Turn certain features on/off */
#define PWC_INT_PIPE 0

/* 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		2
#define ISO_FRAMES_PER_DESC	10
#define ISO_MAX_FRAME_SIZE	960
#define ISO_BUFFER_SIZE 	(ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)

/* Frame buffers: contains compressed or uncompressed video data. */
#define MAX_FRAMES		5
/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
#define PWC_FRAME_SIZE 		(460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)

/* Absolute maximum number of buffers available for mmap() */
#define MAX_IMAGES 		10

/* 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)


#ifndef V4L2_PIX_FMT_PWC1
#define V4L2_PIX_FMT_PWC1	v4l2_fourcc('P','W','C','1')
#define V4L2_PIX_FMT_PWC2	v4l2_fourcc('P','W','C','2')
#endif

/* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
struct pwc_iso_buf
{
	void *data;
	int  length;
	int  read;
	struct urb *urb;
};

/* intermediate buffers with raw data from the USB cam */
struct pwc_frame_buf
{
   void *data;
   volatile int filled;		/* number of bytes filled */
   struct pwc_frame_buf *next;	/* list */
};

/* additionnal informations used when dealing image between kernel and userland */
struct pwc_imgbuf
{
	unsigned long offset;	/* offset of this buffer in the big array of image_data */
	int   vma_use_count;	/* count the number of time this memory is mapped */
};

struct pwc_device
{
   struct video_device *vdev;

   /* Pointer to our usb_device */
   struct usb_device *udev;

   int type;                    /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
   int release;			/* release number */
   int features;		/* feature bits */
   char serial[30];		/* serial number (string) */
   int error_status;		/* set when something goes wrong with the cam (unplugged, USB errors) */
   int usb_init;		/* set when the cam has been initialized over USB */

   /*** Video data ***/
   int vopen;			/* flag */
   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 vpalette;		/* palette: 420P, RAW or RGBBAYER */
   int vframe_count;		/* received frames */
   int vframes_dumped; 		/* counter for dumped frames */
   int vframes_error;		/* frames received in error */
   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 unplugged;

   int cmd_len;
   unsigned char cmd_buf[13];

   /* The image acquisition requires 3 to 4 steps:
      1. data is gathered in short packets from the USB controller
      2. data is synchronized and packed into a frame buffer
      3a. in case data is compressed, decompress it directly into image buffer
      3b. in case data is uncompressed, copy into image buffer with viewport
      4. data is transferred to the user process

      Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
      We have in effect a back-to-back-double-buffer system.
    */
   /* 1: isoc */
   struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
   char iso_init;

   /* 2: frame */
   struct pwc_frame_buf *fbuf;	/* all frames */
   struct pwc_frame_buf *empty_frames, *empty_frames_tail;	/* all empty frames */
   struct pwc_frame_buf *full_frames, *full_frames_tail;	/* all filled frames */
   struct pwc_frame_buf *fill_frame;	/* frame currently being filled */
   struct pwc_frame_buf *read_frame;	/* frame currently read by user process */
   int frame_header_size, frame_trailer_size;
   int frame_size;
   int frame_total_size; /* including header & trailer */
   int drop_frames;

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

   /* 4: image */
   /* We have an 'image' and a 'view', where 'image' is the fixed-size image
      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;			/* bitmask of supported sizes */
   struct pwc_coord view_min, view_max;	/* minimum and maximum viewable sizes */
   struct pwc_coord abs_max;            /* maximum supported size with compression */
   struct pwc_coord image, view;	/* image and viewport size */
   struct pwc_coord offset;		/* offset within the viewport */

   void *image_data;			/* total buffer, which is subdivided into ... */
   struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */
   int fill_image;			/* ...which are rotated. */
   int len_per_image;			/* length per image */
   int image_read_pos;			/* In case we read data in pieces, keep track of were we are in the imagebuffer */
   int image_used[MAX_IMAGES];		/* For MCAPTURE and SYNC */

   struct mutex modlock;		/* to prevent races in video_open(), etc */
   spinlock_t ptrlock;			/* for manipulating the buffer pointers */

   /*** 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 position */
   int snapshot_button_status;		/* set to 1 when the user push the button, reset to 0 when this value is read */
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
   struct input_dev *button_dev;	/* webcam snapshot button input */
#endif

   /*** Misc. data ***/
   wait_queue_head_t frameq;		/* When waiting for a frame to finish... */
#if PWC_INT_PIPE
   void *usb_int_handler;		/* for the interrupt endpoint */
#endif
};

#ifdef __cplusplus
extern "C" {
#endif

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

/** functions in pwc-if.c */
int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
int pwc_handle_frame(struct pwc_device *pdev);
void pwc_next_image(struct pwc_device *pdev);
int pwc_isoc_init(struct pwc_device *pdev);
void pwc_isoc_cleanup(struct pwc_device *pdev);

/** 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);
/* Calculate the number of bytes per image (not frame) */
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);

/* Various controls; should be obvious. Value 0..65535, or < 0 on error */
extern int pwc_get_brightness(struct pwc_device *pdev);
extern int pwc_set_brightness(struct pwc_device *pdev, int value);
extern int pwc_get_contrast(struct pwc_device *pdev);
extern int pwc_set_contrast(struct pwc_device *pdev, int value);
extern int pwc_get_gamma(struct pwc_device *pdev);
extern int pwc_set_gamma(struct pwc_device *pdev, int value);
extern int pwc_get_saturation(struct pwc_device *pdev, int *value);
extern int pwc_set_saturation(struct pwc_device *pdev, int value);
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 pwc_restore_user(struct pwc_device *pdev);
extern int pwc_save_user(struct pwc_device *pdev);
extern int pwc_restore_factory(struct pwc_device *pdev);

/* exported for use by v4l2 controls */
extern int pwc_get_red_gain(struct pwc_device *pdev, int *value);
extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
extern int pwc_get_blue_gain(struct pwc_device *pdev, int *value);
extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
extern int pwc_get_awb(struct pwc_device *pdev);
extern int pwc_set_awb(struct pwc_device *pdev, int mode);
extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
extern int pwc_get_agc(struct pwc_device *pdev, int *value);
extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
extern int pwc_get_shutter_speed(struct pwc_device *pdev, int *value);

extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
extern int pwc_get_colour_mode(struct pwc_device *pdev, int *colour);
extern int pwc_set_contour(struct pwc_device *pdev, int contour);
extern int pwc_get_contour(struct pwc_device *pdev, int *contour);
extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
extern int pwc_get_backlight(struct pwc_device *pdev, int *backlight);
extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
extern int pwc_get_flicker(struct pwc_device *pdev, int *flicker);
extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
extern int pwc_get_dynamic_noise(struct pwc_device *pdev, int *noise);

/* Power down or up the camera; not supported by all models */
extern int 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);

/** Functions in pwc-v4l.c */
extern long pwc_video_do_ioctl(struct file *file, unsigned int cmd, void *arg);

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

#ifdef __cplusplus
}
#endif


#endif
/* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */
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>
2b455db6	32	#include <linux/version.h>
b9378fdb	33	#include <linux/mutex.h>
38413fd2	34	#include <linux/mm.h>
1da177e4	35	#include <asm/errno.h>
2b455db6	36	#include <linux/videodev.h>
5e87efa3	37	#include <media/v4l2-common.h>
35ea11ff	38	#include <media/v4l2-ioctl.h>
e32a7ecc NPT	39	#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	40	#include <linux/input.h>
	41	#endif
1da177e4 LT	42
1da177e4 LT	43	#include "pwc-uncompress.h"
2b455db6	44	#include <media/pwc-ioctl.h>
1da177e4	45
2b455db6 LS	46	/* Version block */
	47	#define PWC_MAJOR 10
	48	#define PWC_MINOR 0
	49	#define PWC_EXTRAMINOR 12
	50	#define PWC_VERSION_CODE KERNEL_VERSION(PWC_MAJOR,PWC_MINOR,PWC_EXTRAMINOR)
9ee6d78c	51	#define PWC_VERSION "10.0.13"
2b455db6 LS	52	#define PWC_NAME "pwc"
	53	#define PFX PWC_NAME ": "
	54
1da177e4 LT	55
1da177e4 LT	56	/* Trace certain actions in the driver */
2b455db6 LS	57	#define PWC_DEBUG_LEVEL_MODULE (1<<0)
	58	#define PWC_DEBUG_LEVEL_PROBE (1<<1)
	59	#define PWC_DEBUG_LEVEL_OPEN (1<<2)
	60	#define PWC_DEBUG_LEVEL_READ (1<<3)
	61	#define PWC_DEBUG_LEVEL_MEMORY (1<<4)
	62	#define PWC_DEBUG_LEVEL_FLOW (1<<5)
	63	#define PWC_DEBUG_LEVEL_SIZE (1<<6)
	64	#define PWC_DEBUG_LEVEL_IOCTL (1<<7)
	65	#define PWC_DEBUG_LEVEL_TRACE (1<<8)
	66
	67	#define PWC_DEBUG_MODULE(fmt, args...) PWC_DEBUG(MODULE, fmt, ##args)
	68	#define PWC_DEBUG_PROBE(fmt, args...) PWC_DEBUG(PROBE, fmt, ##args)
	69	#define PWC_DEBUG_OPEN(fmt, args...) PWC_DEBUG(OPEN, fmt, ##args)
	70	#define PWC_DEBUG_READ(fmt, args...) PWC_DEBUG(READ, fmt, ##args)
	71	#define PWC_DEBUG_MEMORY(fmt, args...) PWC_DEBUG(MEMORY, fmt, ##args)
	72	#define PWC_DEBUG_FLOW(fmt, args...) PWC_DEBUG(FLOW, fmt, ##args)
	73	#define PWC_DEBUG_SIZE(fmt, args...) PWC_DEBUG(SIZE, fmt, ##args)
	74	#define PWC_DEBUG_IOCTL(fmt, args...) PWC_DEBUG(IOCTL, fmt, ##args)
	75	#define PWC_DEBUG_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
	76
	77
05ad3907	78	#ifdef CONFIG_USB_PWC_DEBUG
2b455db6 LS	79
	80	#define PWC_DEBUG_LEVEL (PWC_DEBUG_LEVEL_MODULE)
	81
	82	#define PWC_DEBUG(level, fmt, args...) do {\
	83	if ((PWC_DEBUG_LEVEL_ ##level) & pwc_trace) \
	84	printk(KERN_DEBUG PFX fmt, ##args); \
	85	} while(0)
	86
	87	#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
	88	#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
	89	#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
	90	#define PWC_TRACE(fmt, args...) PWC_DEBUG(TRACE, fmt, ##args)
	91
9ee6d78c	92	#else /* if ! CONFIG_USB_PWC_DEBUG */
2b455db6 LS	93
	94	#define PWC_ERROR(fmt, args...) printk(KERN_ERR PFX fmt, ##args)
	95	#define PWC_WARNING(fmt, args...) printk(KERN_WARNING PFX fmt, ##args)
	96	#define PWC_INFO(fmt, args...) printk(KERN_INFO PFX fmt, ##args)
	97	#define PWC_TRACE(fmt, args...) do { } while(0)
	98	#define PWC_DEBUG(level, fmt, args...) do { } while(0)
	99
	100	#define pwc_trace 0
1da177e4	101
2b455db6	102	#endif
1da177e4 LT	103
	104	/* Defines for ToUCam cameras */
	105	#define TOUCAM_HEADER_SIZE 8
	106	#define TOUCAM_TRAILER_SIZE 4
	107
	108	#define FEATURE_MOTOR_PANTILT 0x0001
2b455db6 LS	109	#define FEATURE_CODEC1 0x0002
2b455db6 LS	110	#define FEATURE_CODEC2 0x0004
1da177e4 LT	111
	112	/* Turn certain features on/off */
	113	#define PWC_INT_PIPE 0
	114
	115	/* Ignore errors in the first N frames, to allow for startup delays */
	116	#define FRAME_LOWMARK 5
	117
	118	/* Size and number of buffers for the ISO pipe. */
	119	#define MAX_ISO_BUFS 2
	120	#define ISO_FRAMES_PER_DESC 10
	121	#define ISO_MAX_FRAME_SIZE 960
	122	#define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
	123
	124	/* Frame buffers: contains compressed or uncompressed video data. */
	125	#define MAX_FRAMES 5
	126	/* Maximum size after decompression is 640x480 YUV data, 1.5 * 640 * 480 */
	127	#define PWC_FRAME_SIZE (460800 + TOUCAM_HEADER_SIZE + TOUCAM_TRAILER_SIZE)
	128
	129	/* Absolute maximum number of buffers available for mmap() */
	130	#define MAX_IMAGES 10
	131
2b455db6 LS	132	/* Some macros to quickly find the type of a webcam */
	133	#define DEVICE_USE_CODEC1(x) ((x)<675)
	134	#define DEVICE_USE_CODEC2(x) ((x)>=675 && (x)<700)
	135	#define DEVICE_USE_CODEC3(x) ((x)>=700)
	136	#define DEVICE_USE_CODEC23(x) ((x)>=675)
	137
	138
	139	#ifndef V4L2_PIX_FMT_PWC1
	140	#define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P','W','C','1')
	141	#define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P','W','C','2')
	142	#endif
	143
1da177e4 LT	144	/* The following structures were based on cpia.h. Why reinvent the wheel? :-) */
	145	struct pwc_iso_buf
	146	{
	147	void *data;
	148	int length;
	149	int read;
	150	struct urb *urb;
	151	};
	152
	153	/* intermediate buffers with raw data from the USB cam */
	154	struct pwc_frame_buf
	155	{
	156	void *data;
	157	volatile int filled; /* number of bytes filled */
	158	struct pwc_frame_buf next; / list */
2b455db6 LS	159	};
	160
	161	/* additionnal informations used when dealing image between kernel and userland */
	162	struct pwc_imgbuf
	163	{
	164	unsigned long offset; /* offset of this buffer in the big array of image_data */
	165	int vma_use_count; /* count the number of time this memory is mapped */
1da177e4 LT	166	};
	167
	168	struct pwc_device
	169	{
	170	struct video_device *vdev;
2b455db6	171
1da177e4 LT	172	/* Pointer to our usb_device */
1da177e4 LT	173	struct usb_device *udev;
d56410e0	174
1da177e4 LT	175	int type; /* type of cam (645, 646, 675, 680, 690, 720, 730, 740, 750) */
	176	int release; /* release number */
	177	int features; /* feature bits */
	178	char serial[30]; /* serial number (string) */
	179	int error_status; /* set when something goes wrong with the cam (unplugged, USB errors) */
	180	int usb_init; /* set when the cam has been initialized over USB */
	181
	182	/* Video data */
	183	int vopen; /* flag */
	184	int vendpoint; /* video isoc endpoint */
	185	int vcinterface; /* video control interface */
	186	int valternate; /* alternate interface needed */
	187	int vframes, vsize; /* frames-per-second & size (see PSZ_) /
	188	int vpalette; /* palette: 420P, RAW or RGBBAYER */
	189	int vframe_count; /* received frames */
	190	int vframes_dumped; /* counter for dumped frames */
	191	int vframes_error; /* frames received in error */
	192	int vmax_packet_size; /* USB maxpacket size */
	193	int vlast_packet_size; /* for frame synchronisation */
	194	int visoc_errors; /* number of contiguous ISOC errors */
	195	int vcompression; /* desired compression factor */
	196	int vbandlength; /* compressed band length; 0 is uncompressed */
	197	char vsnapshot; /* snapshot mode */
	198	char vsync; /* used by isoc handler */
	199	char vmirror; /* for ToUCaM series */
85237f20	200	char unplugged;
d56410e0	201
1da177e4 LT	202	int cmd_len;
	203	unsigned char cmd_buf[13];
	204
	205	/* The image acquisition requires 3 to 4 steps:
	206	1. data is gathered in short packets from the USB controller
	207	2. data is synchronized and packed into a frame buffer
	208	3a. in case data is compressed, decompress it directly into image buffer
	209	3b. in case data is uncompressed, copy into image buffer with viewport
	210	4. data is transferred to the user process
	211
	212	Note that MAX_ISO_BUFS != MAX_FRAMES != MAX_IMAGES....
	213	We have in effect a back-to-back-double-buffer system.
	214	*/
	215	/* 1: isoc */
	216	struct pwc_iso_buf sbuf[MAX_ISO_BUFS];
	217	char iso_init;
	218
	219	/* 2: frame */
	220	struct pwc_frame_buf fbuf; / all frames */
	221	struct pwc_frame_buf empty_frames, empty_frames_tail; /* all empty frames */
	222	struct pwc_frame_buf full_frames, full_frames_tail; /* all filled frames */
	223	struct pwc_frame_buf fill_frame; / frame currently being filled */
	224	struct pwc_frame_buf read_frame; / frame currently read by user process */
	225	int frame_header_size, frame_trailer_size;
	226	int frame_size;
	227	int frame_total_size; /* including header & trailer */
	228	int drop_frames;
1da177e4 LT	229
1da177e4 LT	230	/* 3: decompression */
1da177e4 LT	231	void decompress_data; / private data for decompression engine */
	232
	233	/* 4: image */
	234	/* We have an 'image' and a 'view', where 'image' is the fixed-size image
	235	as delivered by the camera, and 'view' is the size requested by the
	236	program. The camera image is centered in this viewport, laced with
	237	a gray or black border. view_min <= image <= view <= view_max;
	238	*/
	239	int image_mask; /* bitmask of supported sizes */
	240	struct pwc_coord view_min, view_max; /* minimum and maximum viewable sizes */
	241	struct pwc_coord abs_max; /* maximum supported size with compression */
	242	struct pwc_coord image, view; /* image and viewport size */
	243	struct pwc_coord offset; /* offset within the viewport */
	244
	245	void image_data; / total buffer, which is subdivided into ... */
2b455db6	246	struct pwc_imgbuf images[MAX_IMAGES];/* ...several images... */
1da177e4 LT	247	int fill_image; /* ...which are rotated. */
	248	int len_per_image; /* length per image */
	249	int image_read_pos; /* In case we read data in pieces, keep track of were we are in the imagebuffer */
	250	int image_used[MAX_IMAGES]; /* For MCAPTURE and SYNC */
	251
b9378fdb	252	struct mutex modlock; /* to prevent races in video_open(), etc */
1da177e4 LT	253	spinlock_t ptrlock; /* for manipulating the buffer pointers */
	254
	255	/*** motorized pan/tilt feature */
	256	struct pwc_mpt_range angle_range;
	257	int pan_angle; /* in degrees * 100 */
	258	int tilt_angle; /* absolute angle; 0,0 is home position */
2b455db6	259	int snapshot_button_status; /* set to 1 when the user push the button, reset to 0 when this value is read */
e32a7ecc NPT	260	#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	261	struct input_dev button_dev; / webcam snapshot button input */
	262	#endif
1da177e4 LT	263
	264	/* Misc. data */
	265	wait_queue_head_t frameq; /* When waiting for a frame to finish... */
	266	#if PWC_INT_PIPE
	267	void usb_int_handler; / for the interrupt endpoint */
	268	#endif
	269	};
	270
1da177e4 LT	271	#ifdef __cplusplus
	272	extern "C" {
	273	#endif
	274
2b455db6	275	/* Global variables */
05ad3907	276	#ifdef CONFIG_USB_PWC_DEBUG
1da177e4	277	extern int pwc_trace;
2b455db6	278	#endif
2b455db6	279	extern int pwc_mbufs;
1da177e4 LT	280
	281	/** functions in pwc-if.c */
	282	int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot);
2b455db6 LS	283	int pwc_handle_frame(struct pwc_device *pdev);
	284	void pwc_next_image(struct pwc_device *pdev);
	285	int pwc_isoc_init(struct pwc_device *pdev);
	286	void pwc_isoc_cleanup(struct pwc_device *pdev);
1da177e4 LT	287
	288	/** Functions in pwc-misc.c */
	289	/* sizes in pixels */
2b455db6	290	extern const struct pwc_coord pwc_image_sizes[PSZ_MAX];
1da177e4 LT	291
	292	int pwc_decode_size(struct pwc_device *pdev, int width, int height);
	293	void pwc_construct(struct pwc_device *pdev);
	294
	295	/** Functions in pwc-ctrl.c */
	296	/* Request a certain video mode. Returns < 0 if not possible */
	297	extern int pwc_set_video_mode(struct pwc_device *pdev, int width, int height, int frames, int compression, int snapshot);
9ee6d78c	298	extern unsigned int pwc_get_fps(struct pwc_device *pdev, unsigned int index, unsigned int size);
2b455db6 LS	299	/* Calculate the number of bytes per image (not frame) */
	300	extern int pwc_mpt_reset(struct pwc_device *pdev, int flags);
	301	extern int pwc_mpt_set_angle(struct pwc_device *pdev, int pan, int tilt);
1da177e4 LT	302
	303	/* Various controls; should be obvious. Value 0..65535, or < 0 on error */
	304	extern int pwc_get_brightness(struct pwc_device *pdev);
	305	extern int pwc_set_brightness(struct pwc_device *pdev, int value);
	306	extern int pwc_get_contrast(struct pwc_device *pdev);
	307	extern int pwc_set_contrast(struct pwc_device *pdev, int value);
	308	extern int pwc_get_gamma(struct pwc_device *pdev);
	309	extern int pwc_set_gamma(struct pwc_device *pdev, int value);
2b455db6	310	extern int pwc_get_saturation(struct pwc_device pdev, int value);
1da177e4 LT	311	extern int pwc_set_saturation(struct pwc_device *pdev, int value);
1da177e4 LT	312	extern int pwc_set_leds(struct pwc_device *pdev, int on_value, int off_value);
1da177e4	313	extern int pwc_get_cmos_sensor(struct pwc_device pdev, int sensor);
2b455db6 LS	314	extern int pwc_restore_user(struct pwc_device *pdev);
	315	extern int pwc_save_user(struct pwc_device *pdev);
	316	extern int pwc_restore_factory(struct pwc_device *pdev);
	317
	318	/* exported for use by v4l2 controls */
	319	extern int pwc_get_red_gain(struct pwc_device pdev, int value);
	320	extern int pwc_set_red_gain(struct pwc_device *pdev, int value);
	321	extern int pwc_get_blue_gain(struct pwc_device pdev, int value);
	322	extern int pwc_set_blue_gain(struct pwc_device *pdev, int value);
	323	extern int pwc_get_awb(struct pwc_device *pdev);
	324	extern int pwc_set_awb(struct pwc_device *pdev, int mode);
	325	extern int pwc_set_agc(struct pwc_device *pdev, int mode, int value);
	326	extern int pwc_get_agc(struct pwc_device pdev, int value);
	327	extern int pwc_set_shutter_speed(struct pwc_device *pdev, int mode, int value);
	328	extern int pwc_get_shutter_speed(struct pwc_device pdev, int value);
	329
	330	extern int pwc_set_colour_mode(struct pwc_device *pdev, int colour);
	331	extern int pwc_get_colour_mode(struct pwc_device pdev, int colour);
	332	extern int pwc_set_contour(struct pwc_device *pdev, int contour);
	333	extern int pwc_get_contour(struct pwc_device pdev, int contour);
	334	extern int pwc_set_backlight(struct pwc_device *pdev, int backlight);
	335	extern int pwc_get_backlight(struct pwc_device pdev, int backlight);
	336	extern int pwc_set_flicker(struct pwc_device *pdev, int flicker);
	337	extern int pwc_get_flicker(struct pwc_device pdev, int flicker);
	338	extern int pwc_set_dynamic_noise(struct pwc_device *pdev, int noise);
	339	extern int pwc_get_dynamic_noise(struct pwc_device pdev, int noise);
1da177e4 LT	340
	341	/* Power down or up the camera; not supported by all models */
	342	extern int pwc_camera_power(struct pwc_device *pdev, int power);
	343
	344	/* Private ioctl()s; see pwc-ioctl.h */
069b7479	345	extern long pwc_ioctl(struct pwc_device pdev, unsigned int cmd, void arg);
1da177e4	346
2b455db6	347	/** Functions in pwc-v4l.c */
069b7479	348	extern long pwc_video_do_ioctl(struct file file, unsigned int cmd, void arg);
1da177e4 LT	349
	350	/** pwc-uncompress.c */
	351	/* Expand frame to image, possibly including decompression. Uses read_frame and fill_image */
	352	extern int pwc_decompress(struct pwc_device *pdev);
	353
	354	#ifdef __cplusplus
	355	}
	356	#endif
	357
	358
	359	#endif
2b455db6	360	/* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */