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

#ifndef PWC_IOCTL_H
#define PWC_IOCTL_H

/* (C) 2001-2004 Nemosoft Unv.
   (C) 2004      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
*/

/* This is pwc-ioctl.h belonging to PWC 8.12.1
   It contains structures and defines to communicate from user space
   directly to the driver.
 */

/*
   Changes
   2001/08/03  Alvarado   Added ioctl constants to access methods for
			  changing white balance and red/blue gains
   2002/12/15  G. H. Fernandez-Toribio   VIDIOCGREALSIZE
   2003/12/13  Nemosft Unv. Some modifications to make interfacing to
	       PWCX easier
 */

/* These are private ioctl() commands, specific for the Philips webcams.
   They contain functions not found in other webcams, and settings not
   specified in the Video4Linux API.

   The #define names are built up like follows:
   VIDIOC		VIDeo IOCtl prefix
	 PWC		Philps WebCam
	    G           optional: Get
	    S           optional: Set
	     ... 	the function
 */


 /* Enumeration of image sizes */
#define PSZ_SQCIF	0x00
#define PSZ_QSIF	0x01
#define PSZ_QCIF	0x02
#define PSZ_SIF		0x03
#define PSZ_CIF		0x04
#define PSZ_VGA		0x05
#define PSZ_MAX		6


/* The frame rate is encoded in the video_window.flags parameter using
   the upper 16 bits, since some flags are defined nowadays. The following
   defines provide a mask and shift to filter out this value.

   In 'Snapshot' mode the camera freezes its automatic exposure and colour
   balance controls.
 */
#define PWC_FPS_SHIFT		16
#define PWC_FPS_MASK		0x00FF0000
#define PWC_FPS_FRMASK		0x003F0000
#define PWC_FPS_SNAPSHOT	0x00400000


/* structure for transferring x & y coordinates */
struct pwc_coord
{
	int x, y;		/* guess what */
	int size;		/* size, or offset */
};


/* Used with VIDIOCPWCPROBE */
struct pwc_probe
{
	char name[32];
	int type;
};

struct pwc_serial
{
	char serial[30];	/* String with serial number. Contains terminating 0 */
};

/* pwc_whitebalance.mode values */
#define PWC_WB_INDOOR		0
#define PWC_WB_OUTDOOR		1
#define PWC_WB_FL		2
#define PWC_WB_MANUAL		3
#define PWC_WB_AUTO		4

/* Used with VIDIOCPWC[SG]AWB (Auto White Balance).
   Set mode to one of the PWC_WB_* values above.
   *red and *blue are the respective gains of these colour components inside
   the camera; range 0..65535
   When 'mode' == PWC_WB_MANUAL, 'manual_red' and 'manual_blue' are set or read;
   otherwise undefined.
   'read_red' and 'read_blue' are read-only.
*/
struct pwc_whitebalance
{
	int mode;
	int manual_red, manual_blue;	/* R/W */
	int read_red, read_blue;	/* R/O */
};

/*
   'control_speed' and 'control_delay' are used in automatic whitebalance mode,
   and tell the camera how fast it should react to changes in lighting, and
   with how much delay. Valid values are 0..65535.
*/
struct pwc_wb_speed
{
	int control_speed;
	int control_delay;

};

/* Used with VIDIOCPWC[SG]LED */
struct pwc_leds
{
	int led_on;			/* Led on-time; range = 0..25000 */
	int led_off;			/* Led off-time; range = 0..25000  */
};

/* Image size (used with GREALSIZE) */
struct pwc_imagesize
{
	int width;
	int height;
};

/* Defines and structures for Motorized Pan & Tilt */
#define PWC_MPT_PAN		0x01
#define PWC_MPT_TILT		0x02
#define PWC_MPT_TIMEOUT		0x04 /* for status */

/* Set angles; when absolute != 0, the angle is absolute and the
   driver calculates the relative offset for you. This can only
   be used with VIDIOCPWCSANGLE; VIDIOCPWCGANGLE always returns
   absolute angles.
 */
struct pwc_mpt_angles
{
	int absolute;		/* write-only */
	int pan;		/* degrees * 100 */
	int tilt;		/* degress * 100 */
};

/* Range of angles of the camera, both horizontally and vertically.
 */
struct pwc_mpt_range
{
	int pan_min, pan_max;		/* degrees * 100 */
	int tilt_min, tilt_max;
};

struct pwc_mpt_status
{
	int status;
	int time_pan;
	int time_tilt;
};


/* This is used for out-of-kernel decompression. With it, you can get
   all the necessary information to initialize and use the decompressor
   routines in standalone applications.
 */
struct pwc_video_command
{
	int type;		/* camera type (645, 675, 730, etc.) */
	int release;		/* release number */

	int size;		/* one of PSZ_* */
	int alternate;
	int command_len;	/* length of USB video command */
	unsigned char command_buf[13];	/* Actual USB video command */
	int bandlength;		/* >0 = compressed */
	int frame_size;		/* Size of one (un)compressed frame */
};

/* Flags for PWCX subroutines. Not all modules honour all flags. */
#define PWCX_FLAG_PLANAR	0x0001
#define PWCX_FLAG_BAYER		0x0008


/* IOCTL definitions */

 /* Restore user settings */
#define VIDIOCPWCRUSER		_IO('v', 192)
 /* Save user settings */
#define VIDIOCPWCSUSER		_IO('v', 193)
 /* Restore factory settings */
#define VIDIOCPWCFACTORY	_IO('v', 194)

 /* You can manipulate the compression factor. A compression preference of 0
    means use uncompressed modes when available; 1 is low compression, 2 is
    medium and 3 is high compression preferred. Of course, the higher the
    compression, the lower the bandwidth used but more chance of artefacts
    in the image. The driver automatically chooses a higher compression when
    the preferred mode is not available.
  */
 /* Set preferred compression quality (0 = uncompressed, 3 = highest compression) */
#define VIDIOCPWCSCQUAL		_IOW('v', 195, int)
 /* Get preferred compression quality */
#define VIDIOCPWCGCQUAL		_IOR('v', 195, int)


/* Retrieve serial number of camera */
#define VIDIOCPWCGSERIAL	_IOR('v', 198, struct pwc_serial)

 /* This is a probe function; since so many devices are supported, it
    becomes difficult to include all the names in programs that want to
    check for the enhanced Philips stuff. So in stead, try this PROBE;
    it returns a structure with the original name, and the corresponding
    Philips type.
    To use, fill the structure with zeroes, call PROBE and if that succeeds,
    compare the name with that returned from VIDIOCGCAP; they should be the
    same. If so, you can be assured it is a Philips (OEM) cam and the type
    is valid.
 */
#define VIDIOCPWCPROBE		_IOR('v', 199, struct pwc_probe)

 /* Set AGC (Automatic Gain Control); int < 0 = auto, 0..65535 = fixed */
#define VIDIOCPWCSAGC		_IOW('v', 200, int)
 /* Get AGC; int < 0 = auto; >= 0 = fixed, range 0..65535 */
#define VIDIOCPWCGAGC		_IOR('v', 200, int)
 /* Set shutter speed; int < 0 = auto; >= 0 = fixed, range 0..65535 */
#define VIDIOCPWCSSHUTTER	_IOW('v', 201, int)

 /* Color compensation (Auto White Balance) */
#define VIDIOCPWCSAWB           _IOW('v', 202, struct pwc_whitebalance)
#define VIDIOCPWCGAWB           _IOR('v', 202, struct pwc_whitebalance)

 /* Auto WB speed */
#define VIDIOCPWCSAWBSPEED	_IOW('v', 203, struct pwc_wb_speed)
#define VIDIOCPWCGAWBSPEED	_IOR('v', 203, struct pwc_wb_speed)

 /* LEDs on/off/blink; int range 0..65535 */
#define VIDIOCPWCSLED           _IOW('v', 205, struct pwc_leds)
#define VIDIOCPWCGLED           _IOR('v', 205, struct pwc_leds)

  /* Contour (sharpness); int < 0 = auto, 0..65536 = fixed */
#define VIDIOCPWCSCONTOUR	_IOW('v', 206, int)
#define VIDIOCPWCGCONTOUR	_IOR('v', 206, int)

  /* Backlight compensation; 0 = off, otherwise on */
#define VIDIOCPWCSBACKLIGHT	_IOW('v', 207, int)
#define VIDIOCPWCGBACKLIGHT	_IOR('v', 207, int)

  /* Flickerless mode; = 0 off, otherwise on */
#define VIDIOCPWCSFLICKER	_IOW('v', 208, int)
#define VIDIOCPWCGFLICKER	_IOR('v', 208, int)

  /* Dynamic noise reduction; 0 off, 3 = high noise reduction */
#define VIDIOCPWCSDYNNOISE	_IOW('v', 209, int)
#define VIDIOCPWCGDYNNOISE	_IOR('v', 209, int)

 /* Real image size as used by the camera; tells you whether or not there's a gray border around the image */
#define VIDIOCPWCGREALSIZE	_IOR('v', 210, struct pwc_imagesize)

 /* Motorized pan & tilt functions */
#define VIDIOCPWCMPTRESET	_IOW('v', 211, int)
#define VIDIOCPWCMPTGRANGE	_IOR('v', 211, struct pwc_mpt_range)
#define VIDIOCPWCMPTSANGLE	_IOW('v', 212, struct pwc_mpt_angles)
#define VIDIOCPWCMPTGANGLE	_IOR('v', 212, struct pwc_mpt_angles)
#define VIDIOCPWCMPTSTATUS	_IOR('v', 213, struct pwc_mpt_status)

 /* Get the USB set-video command; needed for initializing libpwcx */
#define VIDIOCPWCGVIDCMD	_IOR('v', 215, struct pwc_video_command)
struct pwc_table_init_buffer {
   int len;
   char *buffer;

};
#define VIDIOCPWCGVIDTABLE	_IOR('v', 216, struct pwc_table_init_buffer)

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef PWC_IOCTL_H
	2	#define PWC_IOCTL_H
	3
	4	/* (C) 2001-2004 Nemosoft Unv.
	5	(C) 2004 Luc Saillard (luc@saillard.org)
	6
	7	NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
	8	driver and thus may have bugs that are not present in the original version.
	9	Please send bug reports and support requests to <luc@saillard.org>.
	10	The decompression routines have been implemented by reverse-engineering the
	11	Nemosoft binary pwcx module. Caveat emptor.
	12
	13	This program is free software; you can redistribute it and/or modify
	14	it under the terms of the GNU General Public License as published by
	15	the Free Software Foundation; either version 2 of the License, or
	16	(at your option) any later version.
	17
	18	This program is distributed in the hope that it will be useful,
	19	but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	GNU General Public License for more details.
	22
	23	You should have received a copy of the GNU General Public License
	24	along with this program; if not, write to the Free Software
	25	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	26	*/
	27
	28	/* This is pwc-ioctl.h belonging to PWC 8.12.1
	29	It contains structures and defines to communicate from user space
	30	directly to the driver.
	31	*/
	32
	33	/*
	34	Changes
	35	2001/08/03 Alvarado Added ioctl constants to access methods for
d56410e0	36	changing white balance and red/blue gains
1da177e4 LT	37	2002/12/15 G. H. Fernandez-Toribio VIDIOCGREALSIZE
1da177e4 LT	38	2003/12/13 Nemosft Unv. Some modifications to make interfacing to
d56410e0	39	PWCX easier
1da177e4 LT	40	*/
	41
	42	/* These are private ioctl() commands, specific for the Philips webcams.
	43	They contain functions not found in other webcams, and settings not
	44	specified in the Video4Linux API.
	45
	46	The #define names are built up like follows:
	47	VIDIOC VIDeo IOCtl prefix
d56410e0 MCC	48	PWC Philps WebCam
	49	G optional: Get
	50	S optional: Set
	51	... the function
1da177e4 LT	52	*/
	53
	54
	55	/* Enumeration of image sizes */
	56	#define PSZ_SQCIF 0x00
	57	#define PSZ_QSIF 0x01
	58	#define PSZ_QCIF 0x02
	59	#define PSZ_SIF 0x03
	60	#define PSZ_CIF 0x04
	61	#define PSZ_VGA 0x05
	62	#define PSZ_MAX 6
	63
	64
	65	/* The frame rate is encoded in the video_window.flags parameter using
	66	the upper 16 bits, since some flags are defined nowadays. The following
	67	defines provide a mask and shift to filter out this value.
	68
	69	In 'Snapshot' mode the camera freezes its automatic exposure and colour
	70	balance controls.
	71	*/
	72	#define PWC_FPS_SHIFT 16
	73	#define PWC_FPS_MASK 0x00FF0000
	74	#define PWC_FPS_FRMASK 0x003F0000
	75	#define PWC_FPS_SNAPSHOT 0x00400000
	76
	77
093cf723	78	/* structure for transferring x & y coordinates */
1da177e4 LT	79	struct pwc_coord
	80	{
	81	int x, y; /* guess what */
	82	int size; /* size, or offset */
	83	};
	84
	85
	86	/* Used with VIDIOCPWCPROBE */
	87	struct pwc_probe
	88	{
	89	char name[32];
	90	int type;
	91	};
	92
	93	struct pwc_serial
	94	{
	95	char serial[30]; /* String with serial number. Contains terminating 0 */
	96	};
d56410e0	97
1da177e4 LT	98	/* pwc_whitebalance.mode values */
	99	#define PWC_WB_INDOOR 0
	100	#define PWC_WB_OUTDOOR 1
	101	#define PWC_WB_FL 2
	102	#define PWC_WB_MANUAL 3
	103	#define PWC_WB_AUTO 4
	104
d56410e0	105	/* Used with VIDIOCPWC[SG]AWB (Auto White Balance).
1da177e4	106	Set mode to one of the PWC_WB_* values above.
d56410e0	107	red and blue are the respective gains of these colour components inside
1da177e4	108	the camera; range 0..65535
d56410e0	109	When 'mode' == PWC_WB_MANUAL, 'manual_red' and 'manual_blue' are set or read;
1da177e4 LT	110	otherwise undefined.
1da177e4 LT	111	'read_red' and 'read_blue' are read-only.
d56410e0	112	*/
1da177e4 LT	113	struct pwc_whitebalance
	114	{
	115	int mode;
	116	int manual_red, manual_blue; /* R/W */
	117	int read_red, read_blue; /* R/O */
	118	};
	119
d56410e0	120	/*
1da177e4	121	'control_speed' and 'control_delay' are used in automatic whitebalance mode,
d56410e0	122	and tell the camera how fast it should react to changes in lighting, and
1da177e4 LT	123	with how much delay. Valid values are 0..65535.
	124	*/
	125	struct pwc_wb_speed
	126	{
	127	int control_speed;
	128	int control_delay;
	129
	130	};
	131
	132	/* Used with VIDIOCPWC[SG]LED */
	133	struct pwc_leds
	134	{
	135	int led_on; /* Led on-time; range = 0..25000 */
	136	int led_off; /* Led off-time; range = 0..25000 */
	137	};
	138
	139	/* Image size (used with GREALSIZE) */
	140	struct pwc_imagesize
	141	{
	142	int width;
	143	int height;
	144	};
	145
	146	/* Defines and structures for Motorized Pan & Tilt */
	147	#define PWC_MPT_PAN 0x01
	148	#define PWC_MPT_TILT 0x02
	149	#define PWC_MPT_TIMEOUT 0x04 /* for status */
	150
d56410e0	151	/* Set angles; when absolute != 0, the angle is absolute and the
1da177e4 LT	152	driver calculates the relative offset for you. This can only
	153	be used with VIDIOCPWCSANGLE; VIDIOCPWCGANGLE always returns
	154	absolute angles.
d56410e0	155	*/
1da177e4 LT	156	struct pwc_mpt_angles
	157	{
	158	int absolute; /* write-only */
	159	int pan; /* degrees * 100 */
	160	int tilt; /* degress * 100 */
	161	};
	162
	163	/* Range of angles of the camera, both horizontally and vertically.
	164	*/
	165	struct pwc_mpt_range
	166	{
	167	int pan_min, pan_max; /* degrees * 100 */
	168	int tilt_min, tilt_max;
	169	};
	170
	171	struct pwc_mpt_status
	172	{
	173	int status;
	174	int time_pan;
	175	int time_tilt;
	176	};
	177
	178
	179	/* This is used for out-of-kernel decompression. With it, you can get
	180	all the necessary information to initialize and use the decompressor
	181	routines in standalone applications.
d56410e0	182	*/
1da177e4 LT	183	struct pwc_video_command
	184	{
	185	int type; /* camera type (645, 675, 730, etc.) */
	186	int release; /* release number */
	187
d56410e0 MCC	188	int size; /* one of PSZ_* */
d56410e0 MCC	189	int alternate;
1da177e4 LT	190	int command_len; /* length of USB video command */
	191	unsigned char command_buf[13]; /* Actual USB video command */
	192	int bandlength; /* >0 = compressed */
	193	int frame_size; /* Size of one (un)compressed frame */
	194	};
	195
	196	/* Flags for PWCX subroutines. Not all modules honour all flags. */
	197	#define PWCX_FLAG_PLANAR 0x0001
	198	#define PWCX_FLAG_BAYER 0x0008
	199
	200
	201	/* IOCTL definitions */
	202
	203	/* Restore user settings */
	204	#define VIDIOCPWCRUSER _IO('v', 192)
	205	/* Save user settings */
	206	#define VIDIOCPWCSUSER _IO('v', 193)
	207	/* Restore factory settings */
	208	#define VIDIOCPWCFACTORY _IO('v', 194)
	209
	210	/* You can manipulate the compression factor. A compression preference of 0
	211	means use uncompressed modes when available; 1 is low compression, 2 is
	212	medium and 3 is high compression preferred. Of course, the higher the
	213	compression, the lower the bandwidth used but more chance of artefacts
	214	in the image. The driver automatically chooses a higher compression when
	215	the preferred mode is not available.
	216	*/
	217	/* Set preferred compression quality (0 = uncompressed, 3 = highest compression) */
	218	#define VIDIOCPWCSCQUAL _IOW('v', 195, int)
	219	/* Get preferred compression quality */
	220	#define VIDIOCPWCGCQUAL _IOR('v', 195, int)
	221
	222
	223	/* Retrieve serial number of camera */
	224	#define VIDIOCPWCGSERIAL _IOR('v', 198, struct pwc_serial)
	225
	226	/* This is a probe function; since so many devices are supported, it
	227	becomes difficult to include all the names in programs that want to
	228	check for the enhanced Philips stuff. So in stead, try this PROBE;
	229	it returns a structure with the original name, and the corresponding
	230	Philips type.
	231	To use, fill the structure with zeroes, call PROBE and if that succeeds,
	232	compare the name with that returned from VIDIOCGCAP; they should be the
	233	same. If so, you can be assured it is a Philips (OEM) cam and the type
	234	is valid.
	235	*/
	236	#define VIDIOCPWCPROBE _IOR('v', 199, struct pwc_probe)
	237
	238	/* Set AGC (Automatic Gain Control); int < 0 = auto, 0..65535 = fixed */
	239	#define VIDIOCPWCSAGC _IOW('v', 200, int)
	240	/* Get AGC; int < 0 = auto; >= 0 = fixed, range 0..65535 */
	241	#define VIDIOCPWCGAGC _IOR('v', 200, int)
	242	/* Set shutter speed; int < 0 = auto; >= 0 = fixed, range 0..65535 */
	243	#define VIDIOCPWCSSHUTTER _IOW('v', 201, int)
	244
	245	/* Color compensation (Auto White Balance) */
	246	#define VIDIOCPWCSAWB _IOW('v', 202, struct pwc_whitebalance)
	247	#define VIDIOCPWCGAWB _IOR('v', 202, struct pwc_whitebalance)
	248
	249	/* Auto WB speed */
	250	#define VIDIOCPWCSAWBSPEED _IOW('v', 203, struct pwc_wb_speed)
	251	#define VIDIOCPWCGAWBSPEED _IOR('v', 203, struct pwc_wb_speed)
	252
	253	/* LEDs on/off/blink; int range 0..65535 */
254	#define VIDIOCPWCSLED _IOW('v', 205, struct pwc_leds)
255	#define VIDIOCPWCGLED _IOR('v', 205, struct pwc_leds)
256
257	/* Contour (sharpness); int < 0 = auto, 0..65536 = fixed */
258	#define VIDIOCPWCSCONTOUR _IOW('v', 206, int)
259	#define VIDIOCPWCGCONTOUR _IOR('v', 206, int)
260
261	/* Backlight compensation; 0 = off, otherwise on */
262	#define VIDIOCPWCSBACKLIGHT _IOW('v', 207, int)
263	#define VIDIOCPWCGBACKLIGHT _IOR('v', 207, int)
264
265	/* Flickerless mode; = 0 off, otherwise on */
266	#define VIDIOCPWCSFLICKER _IOW('v', 208, int)
d56410e0	267	#define VIDIOCPWCGFLICKER _IOR('v', 208, int)
1da177e4 LT	268
	269	/* Dynamic noise reduction; 0 off, 3 = high noise reduction */
	270	#define VIDIOCPWCSDYNNOISE _IOW('v', 209, int)
	271	#define VIDIOCPWCGDYNNOISE _IOR('v', 209, int)
	272
	273	/* Real image size as used by the camera; tells you whether or not there's a gray border around the image */
	274	#define VIDIOCPWCGREALSIZE _IOR('v', 210, struct pwc_imagesize)
	275
d56410e0	276	/* Motorized pan & tilt functions */
1da177e4 LT	277	#define VIDIOCPWCMPTRESET _IOW('v', 211, int)
	278	#define VIDIOCPWCMPTGRANGE _IOR('v', 211, struct pwc_mpt_range)
	279	#define VIDIOCPWCMPTSANGLE _IOW('v', 212, struct pwc_mpt_angles)
	280	#define VIDIOCPWCMPTGANGLE _IOR('v', 212, struct pwc_mpt_angles)
	281	#define VIDIOCPWCMPTSTATUS _IOR('v', 213, struct pwc_mpt_status)
	282
	283	/* Get the USB set-video command; needed for initializing libpwcx */
	284	#define VIDIOCPWCGVIDCMD _IOR('v', 215, struct pwc_video_command)
	285	struct pwc_table_init_buffer {
	286	int len;
	287	char *buffer;
	288
	289	};
	290	#define VIDIOCPWCGVIDTABLE _IOR('v', 216, struct pwc_table_init_buffer)
	291
	292	#endif