[deliverable/linux.git] / include / media / v4l2-common.h

/*
    v4l2 common internal API header

    This header contains internal shared ioctl definitions for use by the
    internal low-level v4l2 drivers.
    Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal
    define,

    Copyright (C) 2005  Hans Verkuil <hverkuil@xs4all.nl>

    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 V4L2_COMMON_H_
#define V4L2_COMMON_H_

/* v4l debugging and diagnostics */

/* Common printk constucts for v4l-i2c drivers. These macros create a unique
   prefix consisting of the driver name, the adapter number and the i2c
   address. */
#define v4l_printk(level, name, adapter, addr, fmt, arg...) \
	printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)

#define v4l_client_printk(level, client, fmt, arg...)			    \
	v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
		   (client)->addr, fmt , ## arg)

#define v4l_err(client, fmt, arg...) \
	v4l_client_printk(KERN_ERR, client, fmt , ## arg)

#define v4l_warn(client, fmt, arg...) \
	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)

#define v4l_info(client, fmt, arg...) \
	v4l_client_printk(KERN_INFO, client, fmt , ## arg)

/* These three macros assume that the debug level is set with a module
   parameter called 'debug'. */
#define v4l_dbg(level, debug, client, fmt, arg...)			     \
	do { 								     \
		if (debug >= (level))					     \
			v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
	} while (0)

/* Prints the ioctl in a human-readable format */
extern void v4l_printk_ioctl(unsigned int cmd);

/* Prints the ioctl and arg in a human-readable format */
extern void v4l_printk_ioctl_arg(char *s,unsigned int cmd, void *arg);

/* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
#define v4l_print_ioctl(name, cmd)  		 \
	do {  					 \
		printk(KERN_DEBUG "%s: ", name); \
		v4l_printk_ioctl(cmd);		 \
	} while (0)

/* Use this macro in I2C drivers where 'client' is the struct i2c_client
   pointer */
#define v4l_i2c_print_ioctl(client, cmd) 		   \
	do {      					   \
		v4l_client_printk(KERN_DEBUG, client, ""); \
		v4l_printk_ioctl(cmd);			   \
	} while (0)

/* ------------------------------------------------------------------------- */

/* Internal ioctls */

/* VIDIOC_INT_G_REGISTER and VIDIOC_INT_S_REGISTER */
struct v4l2_register {
	u32 i2c_id; 		/* I2C driver ID of the I2C chip. 0 for the I2C adapter. */
	unsigned long reg;
	u32 val;
};

/* VIDIOC_INT_DECODE_VBI_LINE */
struct v4l2_decode_vbi_line {
	u32 is_second_field;	/* Set to 0 for the first (odd) field,
				   set to 1 for the second (even) field. */
	u8 *p; 			/* Pointer to the sliced VBI data from the decoder.
				   On exit points to the start of the payload. */
	u32 line;		/* Line number of the sliced VBI data (1-23) */
	u32 type;		/* VBI service type (V4L2_SLICED_*). 0 if no service found */
};

/* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */
enum v4l2_chip_ident {
	/* general idents: reserved range 0-49 */
	V4L2_IDENT_UNKNOWN = 0,

	/* module saa7115: reserved range 100-149 */
	V4L2_IDENT_SAA7113 = 103,
	V4L2_IDENT_SAA7114 = 104,
	V4L2_IDENT_SAA7115 = 105,

	/* module saa7127: reserved range 150-199 */
	V4L2_IDENT_SAA7127 = 157,
	V4L2_IDENT_SAA7129 = 159,

	/* module cx25840: reserved range 200-249 */
	V4L2_IDENT_CX25840 = 240,
	V4L2_IDENT_CX25841 = 241,
	V4L2_IDENT_CX25842 = 242,
	V4L2_IDENT_CX25843 = 243,
};

/* audio ioctls */

/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
#define AUDC_SET_RADIO        _IO('d',88)

/* select from TV,radio,extern,MUTE, to be replaced with VIDIOC_INT_S_AUDIO_ROUTING */
#define AUDC_SET_INPUT        _IOW('d',89,int)

/* msp3400 ioctl: will be removed in the near future, to be replaced by
   VIDIOC_INT_S_AUDIO_ROUTING. */
struct msp_matrix {
  int input;
  int output;
};
#define MSP_SET_MATRIX     _IOW('m',17,struct msp_matrix)

/* tuner ioctls */

/* Sets tuner type and its I2C addr */
#define TUNER_SET_TYPE_ADDR          _IOW('d', 90, int)

/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
   by VIDIOC_INT_S_STANDBY. */
#define TUNER_SET_STANDBY            _IOW('d', 91, int)

/* Sets tda9887 specific stuff, like port1, port2 and qss */
#define TDA9887_SET_CONFIG           _IOW('d', 92, int)

/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
#define VIDIOC_INT_S_TUNER_MODE	     _IOW('d', 93, enum v4l2_tuner_type)

/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
   chip into standby mode, value 0 will make the chip fully active. Specific
   bits can be used by certain chips to enable/disable specific subsystems.
   Replacement of TUNER_SET_STANDBY. */
#define VIDIOC_INT_S_STANDBY 	     _IOW('d', 94, u32)

/* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
#define	VIDIOC_INT_S_REGISTER 		_IOR ('d', 100, struct v4l2_register)
#define	VIDIOC_INT_G_REGISTER 		_IOWR('d', 101, struct v4l2_register)

/* Reset the I2C chip */
#define VIDIOC_INT_RESET            	_IO  ('d', 102)

/* Set the frequency (in Hz) of the audio clock output.
   Used to slave an audio processor to the video decoder, ensuring that audio
   and video remain synchronized.
   Usual values for the frequency are 48000, 44100 or 32000 Hz.
   If the frequency is not supported, then -EINVAL is returned. */
#define VIDIOC_INT_AUDIO_CLOCK_FREQ 	_IOW ('d', 103, u32)

/* Video decoders that support sliced VBI need to implement this ioctl.
   Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
   data that was generated by the decoder. The driver then parses the sliced
   VBI data and sets the other fields in the struct accordingly. The pointer p
   is updated to point to the start of the payload which can be copied
   verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
   valid VBI data was found, then the type field is set to 0 on return. */
#define VIDIOC_INT_DECODE_VBI_LINE  	_IOWR('d', 104, struct v4l2_decode_vbi_line)

/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
   filled with the data packets that should be output. Note that if you set
   the line field to 0, then that VBI signal is disabled. If no
   valid VBI data was found, then the type field is set to 0 on return. */
#define VIDIOC_INT_S_VBI_DATA 		_IOW ('d', 105, struct v4l2_sliced_vbi_data)

/* Used to obtain the sliced VBI packet from a readback register. Not all
   video decoders support this. If no data is available because the readback
   register contains invalid or erroneous data -EIO is returned. Note that
   you must fill in the 'id' member and the 'field' member (to determine
   whether CC data from the first or second field should be obtained). */
#define VIDIOC_INT_G_VBI_DATA 		_IOWR('d', 106, struct v4l2_sliced_vbi_data)

/* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can
   be made. */
#define VIDIOC_INT_G_CHIP_IDENT		_IOR ('d', 107, enum v4l2_chip_ident)

/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
   clock used by driving digital audio streams at some board designs.
   Usual values for the frequency are 1024000 and 2048000.
   If the frequency is not supported, then -EINVAL is returned. */
#define VIDIOC_INT_I2S_CLOCK_FREQ 	_IOW ('d', 108, u32)

/* Routing definition, device dependent. It specifies which inputs (if any)
   should be routed to which outputs (if any). */
struct v4l2_routing {
	u32 input;
	u32 output;
};

/* These internal commands should be used to define the inputs and outputs
   of an audio/video chip. They will replace AUDC_SET_INPUT.
   The v4l2 API commands VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT,
   VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT are meant to be used by the
   user. Internally these commands should be used to switch inputs/outputs
   because only the driver knows how to map a 'Television' input to the precise
   input/output routing of an A/D converter, or a DSP, or a video digitizer.
   These four commands should only be sent directly to an i2c device, they
   should not be broadcast as the routing is very device specific. */
#define	VIDIOC_INT_S_AUDIO_ROUTING	_IOW ('d', 109, struct v4l2_routing)
#define	VIDIOC_INT_G_AUDIO_ROUTING	_IOR ('d', 110, struct v4l2_routing)
#define	VIDIOC_INT_S_VIDEO_ROUTING	_IOW ('d', 111, struct v4l2_routing)
#define	VIDIOC_INT_G_VIDEO_ROUTING	_IOR ('d', 112, struct v4l2_routing)

#endif /* V4L2_COMMON_H_ */
Commit	Line	Data
b2f0648f HV	1	/*
	2	v4l2 common internal API header
	3
	4	This header contains internal shared ioctl definitions for use by the
	5	internal low-level v4l2 drivers.
	6	Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal
	7	define,
	8
	9	Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
	10
	11	This program is free software; you can redistribute it and/or modify
	12	it under the terms of the GNU General Public License as published by
	13	the Free Software Foundation; either version 2 of the License, or
	14	(at your option) any later version.
	15
	16	This program is distributed in the hope that it will be useful,
	17	but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	GNU General Public License for more details.
	20
	21	You should have received a copy of the GNU General Public License
	22	along with this program; if not, write to the Free Software
	23	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	24	*/
	25
	26	#ifndef V4L2_COMMON_H_
	27	#define V4L2_COMMON_H_
	28
7e8b09ea HV	29	/* v4l debugging and diagnostics */
	30
	31	/* Common printk constucts for v4l-i2c drivers. These macros create a unique
	32	prefix consisting of the driver name, the adapter number and the i2c
	33	address. */
	34	#define v4l_printk(level, name, adapter, addr, fmt, arg...) \
	35	printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
	36
cab462f7	37	#define v4l_client_printk(level, client, fmt, arg...) \
7e8b09ea HV	38	v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
	39	(client)->addr, fmt , ## arg)
	40
	41	#define v4l_err(client, fmt, arg...) \
	42	v4l_client_printk(KERN_ERR, client, fmt , ## arg)
	43
	44	#define v4l_warn(client, fmt, arg...) \
	45	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
	46
	47	#define v4l_info(client, fmt, arg...) \
	48	v4l_client_printk(KERN_INFO, client, fmt , ## arg)
	49
	50	/* These three macros assume that the debug level is set with a module
	51	parameter called 'debug'. */
f167cb4e	52	#define v4l_dbg(level, debug, client, fmt, arg...) \
7e8b09ea HV	53	do { \
	54	if (debug >= (level)) \
	55	v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
	56	} while (0)
	57
	58	/* Prints the ioctl in a human-readable format */
	59	extern void v4l_printk_ioctl(unsigned int cmd);
	60
41f38b43 MCC	61	/* Prints the ioctl and arg in a human-readable format */
	62	extern void v4l_printk_ioctl_arg(char s,unsigned int cmd, void arg);
	63
7e8b09ea HV	64	/* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
	65	#define v4l_print_ioctl(name, cmd) \
	66	do { \
	67	printk(KERN_DEBUG "%s: ", name); \
	68	v4l_printk_ioctl(cmd); \
	69	} while (0)
	70
	71	/* Use this macro in I2C drivers where 'client' is the struct i2c_client
	72	pointer */
	73	#define v4l_i2c_print_ioctl(client, cmd) \
	74	do { \
	75	v4l_client_printk(KERN_DEBUG, client, ""); \
	76	v4l_printk_ioctl(cmd); \
	77	} while (0)
	78
	79	/* ------------------------------------------------------------------------- */
	80
	81	/* Internal ioctls */
	82
b2f0648f HV	83	/* VIDIOC_INT_G_REGISTER and VIDIOC_INT_S_REGISTER */
	84	struct v4l2_register {
	85	u32 i2c_id; /* I2C driver ID of the I2C chip. 0 for the I2C adapter. */
	86	unsigned long reg;
	87	u32 val;
	88	};
	89
	90	/* VIDIOC_INT_DECODE_VBI_LINE */
	91	struct v4l2_decode_vbi_line {
	92	u32 is_second_field; /* Set to 0 for the first (odd) field,
	93	set to 1 for the second (even) field. */
	94	u8 p; / Pointer to the sliced VBI data from the decoder.
	95	On exit points to the start of the payload. */
	96	u32 line; /* Line number of the sliced VBI data (1-23) */
	97	u32 type; /* VBI service type (V4L2_SLICED_). 0 if no service found /
	98	};
	99
	100	/* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */
	101	enum v4l2_chip_ident {
	102	/* general idents: reserved range 0-49 */
	103	V4L2_IDENT_UNKNOWN = 0,
	104
	105	/* module saa7115: reserved range 100-149 */
f5762e44	106	V4L2_IDENT_SAA7113 = 103,
b2f0648f HV	107	V4L2_IDENT_SAA7114 = 104,
	108	V4L2_IDENT_SAA7115 = 105,
	109
	110	/* module saa7127: reserved range 150-199 */
	111	V4L2_IDENT_SAA7127 = 157,
	112	V4L2_IDENT_SAA7129 = 159,
	113
	114	/* module cx25840: reserved range 200-249 */
	115	V4L2_IDENT_CX25840 = 240,
	116	V4L2_IDENT_CX25841 = 241,
	117	V4L2_IDENT_CX25842 = 242,
	118	V4L2_IDENT_CX25843 = 243,
	119	};
	120
5e453dc7	121	/* audio ioctls */
757d2505 HV	122
757d2505 HV	123	/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
5e453dc7	124	#define AUDC_SET_RADIO _IO('d',88)
757d2505 HV	125
757d2505 HV	126	/* select from TV,radio,extern,MUTE, to be replaced with VIDIOC_INT_S_AUDIO_ROUTING */
5e453dc7 MK	127	#define AUDC_SET_INPUT _IOW('d',89,int)
5e453dc7 MK	128
757d2505 HV	129	/* msp3400 ioctl: will be removed in the near future, to be replaced by
757d2505 HV	130	VIDIOC_INT_S_AUDIO_ROUTING. */
27487d44 HV	131	struct msp_matrix {
	132	int input;
	133	int output;
	134	};
	135	#define MSP_SET_MATRIX _IOW('m',17,struct msp_matrix)
	136
5e453dc7	137	/* tuner ioctls */
757d2505	138
5e453dc7	139	/* Sets tuner type and its I2C addr */
757d2505 HV	140	#define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
	141
	142	/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
	143	by VIDIOC_INT_S_STANDBY. */
	144	#define TUNER_SET_STANDBY _IOW('d', 91, int)
	145
5e453dc7	146	/* Sets tda9887 specific stuff, like port1, port2 and qss */
757d2505 HV	147	#define TDA9887_SET_CONFIG _IOW('d', 92, int)
	148
	149	/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
	150	#define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
	151
	152	/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
	153	chip into standby mode, value 0 will make the chip fully active. Specific
	154	bits can be used by certain chips to enable/disable specific subsystems.
	155	Replacement of TUNER_SET_STANDBY. */
	156	#define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
5e453dc7	157
b2f0648f HV	158	/* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
	159	#define VIDIOC_INT_S_REGISTER _IOR ('d', 100, struct v4l2_register)
	160	#define VIDIOC_INT_G_REGISTER _IOWR('d', 101, struct v4l2_register)
	161
	162	/* Reset the I2C chip */
	163	#define VIDIOC_INT_RESET _IO ('d', 102)
	164
3578d3dd	165	/* Set the frequency (in Hz) of the audio clock output.
b2f0648f	166	Used to slave an audio processor to the video decoder, ensuring that audio
3578d3dd HV	167	and video remain synchronized.
	168	Usual values for the frequency are 48000, 44100 or 32000 Hz.
	169	If the frequency is not supported, then -EINVAL is returned. */
	170	#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
b2f0648f HV	171
	172	/* Video decoders that support sliced VBI need to implement this ioctl.
	173	Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
	174	data that was generated by the decoder. The driver then parses the sliced
	175	VBI data and sets the other fields in the struct accordingly. The pointer p
	176	is updated to point to the start of the payload which can be copied
	177	verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
	178	valid VBI data was found, then the type field is set to 0 on return. */
	179	#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
	180
	181	/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
	182	filled with the data packets that should be output. Note that if you set
12db5607 MCC	183	the line field to 0, then that VBI signal is disabled. If no
12db5607 MCC	184	valid VBI data was found, then the type field is set to 0 on return. */
b2f0648f HV	185	#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
	186
	187	/* Used to obtain the sliced VBI packet from a readback register. Not all
	188	video decoders support this. If no data is available because the readback
	189	register contains invalid or erroneous data -EIO is returned. Note that
	190	you must fill in the 'id' member and the 'field' member (to determine
	191	whether CC data from the first or second field should be obtained). */
41f38b43	192	#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
b2f0648f HV	193
	194	/* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can
	195	be made. */
41f38b43	196	#define VIDIOC_INT_G_CHIP_IDENT _IOR ('d', 107, enum v4l2_chip_ident)
b2f0648f	197
9bb13a6d MCC	198	/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
	199	clock used by driving digital audio streams at some board designs.
	200	Usual values for the frequency are 1024000 and 2048000.
	201	If the frequency is not supported, then -EINVAL is returned. */
	202	#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
	203
757d2505 HV	204	/* Routing definition, device dependent. It specifies which inputs (if any)
	205	should be routed to which outputs (if any). */
	206	struct v4l2_routing {
	207	u32 input;
	208	u32 output;
	209	};
	210
	211	/* These internal commands should be used to define the inputs and outputs
	212	of an audio/video chip. They will replace AUDC_SET_INPUT.
	213	The v4l2 API commands VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT,
	214	VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT are meant to be used by the
	215	user. Internally these commands should be used to switch inputs/outputs
	216	because only the driver knows how to map a 'Television' input to the precise
	217	input/output routing of an A/D converter, or a DSP, or a video digitizer.
	218	These four commands should only be sent directly to an i2c device, they
	219	should not be broadcast as the routing is very device specific. */
	220	#define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
41f38b43	221	#define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
757d2505	222	#define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
41f38b43	223	#define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
757d2505	224
b2f0648f	225	#endif /* V4L2_COMMON_H_ */