[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_

#include <media/v4l2-dev.h>

/* v4l debugging and diagnostics */

/* Debug bitmask flags to be used on V4L2 */
#define V4L2_DEBUG_IOCTL     0x01
#define V4L2_DEBUG_IOCTL_ARG 0x02

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


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

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

/* Control helper functions */

int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
		const char **menu_items);
const char **v4l2_ctrl_get_menu(u32 id);
int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
		struct v4l2_queryctrl *qctrl, const char **menu_items);
u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);

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

/* Register/chip ident helper function */

struct i2c_client; /* forward reference */
int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
		u32 ident, u32 revision);
int v4l2_chip_match_host(u32 id_type, u32 chip_id);

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

/* Helper function for I2C legacy drivers */

struct i2c_driver;
struct i2c_adapter;
struct i2c_client;
struct i2c_device_id;

int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
		const char *name,
		int (*probe)(struct i2c_client *, const struct i2c_device_id *));

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

/* Internal ioctls */

/* 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 */
};

struct v4l2_priv_tun_config {
	int tuner;
	void *priv;
};

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

/* 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 TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)

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

/* 100, 101 used by  VIDIOC_DBG_[SG]_REGISTER */

/* Generic reset command. The argument selects which subsystems to reset.
   Passing 0 will always reset the whole chip. */
#define VIDIOC_INT_RESET            	_IOW ('d', 102, u32)

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

/* 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 the v4l2 API commands
   VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
   that are meant to be used by the user.
   The internal 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)

struct v4l2_crystal_freq {
	u32 freq;	/* frequency in Hz of the crystal */
	u32 flags; 	/* device specific flags */
};

/* Sets the frequency of the crystal used to generate the clocks.
   An extra flags field allows device specific configuration regarding
   clock frequency dividers, etc. If not used, then set flags to 0.
   If the frequency is not supported, then -EINVAL is returned. */
#define VIDIOC_INT_S_CRYSTAL_FREQ 	_IOW ('d', 113, struct v4l2_crystal_freq)

/* Initialize the sensor registors to some sort of reasonable
   default values. */
#define VIDIOC_INT_INIT			_IOW ('d', 114, u32)

/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
   video input devices. */
#define VIDIOC_INT_S_STD_OUTPUT		_IOW  ('d', 115, v4l2_std_id)

/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
   video input devices. */
#define VIDIOC_INT_G_STD_OUTPUT		_IOW  ('d', 116, v4l2_std_id)

#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
401998fa MCC	29	#include <media/v4l2-dev.h>
401998fa MCC	30
7e8b09ea HV	31	/* v4l debugging and diagnostics */
7e8b09ea HV	32
401998fa MCC	33	/* Debug bitmask flags to be used on V4L2 */
	34	#define V4L2_DEBUG_IOCTL 0x01
	35	#define V4L2_DEBUG_IOCTL_ARG 0x02
	36
7e8b09ea HV	37	/* Common printk constucts for v4l-i2c drivers. These macros create a unique
	38	prefix consisting of the driver name, the adapter number and the i2c
	39	address. */
	40	#define v4l_printk(level, name, adapter, addr, fmt, arg...) \
	41	printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
	42
cab462f7	43	#define v4l_client_printk(level, client, fmt, arg...) \
7e8b09ea HV	44	v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
	45	(client)->addr, fmt , ## arg)
	46
	47	#define v4l_err(client, fmt, arg...) \
	48	v4l_client_printk(KERN_ERR, client, fmt , ## arg)
	49
	50	#define v4l_warn(client, fmt, arg...) \
	51	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
	52
	53	#define v4l_info(client, fmt, arg...) \
	54	v4l_client_printk(KERN_INFO, client, fmt , ## arg)
	55
	56	/* These three macros assume that the debug level is set with a module
	57	parameter called 'debug'. */
f167cb4e	58	#define v4l_dbg(level, debug, client, fmt, arg...) \
7e8b09ea HV	59	do { \
	60	if (debug >= (level)) \
	61	v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
	62	} while (0)
	63
7e8b09ea HV	64
	65	/* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
	66	#define v4l_print_ioctl(name, cmd) \
	67	do { \
	68	printk(KERN_DEBUG "%s: ", name); \
	69	v4l_printk_ioctl(cmd); \
	70	} while (0)
	71
	72	/* Use this macro in I2C drivers where 'client' is the struct i2c_client
	73	pointer */
	74	#define v4l_i2c_print_ioctl(client, cmd) \
	75	do { \
	76	v4l_client_printk(KERN_DEBUG, client, ""); \
	77	v4l_printk_ioctl(cmd); \
	78	} while (0)
	79
	80	/* ------------------------------------------------------------------------- */
	81
9cb2318b HV	82	/* Control helper functions */
	83
	84	int v4l2_ctrl_check(struct v4l2_ext_control ctrl, struct v4l2_queryctrl qctrl,
	85	const char **menu_items);
	86	const char **v4l2_ctrl_get_menu(u32 id);
	87	int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
	88	int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
	89	int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
	90	struct v4l2_queryctrl qctrl, const char *menu_items);
	91	u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
	92
	93	/* ------------------------------------------------------------------------- */
	94
f3d092b8 HV	95	/* Register/chip ident helper function */
	96
	97	struct i2c_client; /* forward reference */
	98	int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
3434eb7e HV	99	int v4l2_chip_ident_i2c_client(struct i2c_client c, struct v4l2_chip_ident chip,
3434eb7e HV	100	u32 ident, u32 revision);
f3d092b8 HV	101	int v4l2_chip_match_host(u32 id_type, u32 chip_id);
	102
	103	/* ------------------------------------------------------------------------- */
	104
8ffbc655 HV	105	/* Helper function for I2C legacy drivers */
	106
	107	struct i2c_driver;
	108	struct i2c_adapter;
	109	struct i2c_client;
d2653e92	110	struct i2c_device_id;
8ffbc655 HV	111
8ffbc655 HV	112	int v4l2_i2c_attach(struct i2c_adapter adapter, int address, struct i2c_driver driver,
d2653e92 JD	113	const char *name,
d2653e92 JD	114	int (probe)(struct i2c_client , const struct i2c_device_id *));
8ffbc655 HV	115
	116	/* ------------------------------------------------------------------------- */
	117
7e8b09ea HV	118	/* Internal ioctls */
7e8b09ea HV	119
b2f0648f HV	120	/* VIDIOC_INT_DECODE_VBI_LINE */
	121	struct v4l2_decode_vbi_line {
	122	u32 is_second_field; /* Set to 0 for the first (odd) field,
	123	set to 1 for the second (even) field. */
	124	u8 p; / Pointer to the sliced VBI data from the decoder.
	125	On exit points to the start of the payload. */
	126	u32 line; /* Line number of the sliced VBI data (1-23) */
	127	u32 type; /* VBI service type (V4L2_SLICED_). 0 if no service found /
	128	};
	129
7f171123 MCC	130	struct v4l2_priv_tun_config {
	131	int tuner;
	132	void *priv;
	133	};
	134
5e453dc7	135	/* audio ioctls */
757d2505 HV	136
757d2505 HV	137	/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
5e453dc7	138	#define AUDC_SET_RADIO _IO('d',88)
757d2505	139
5e453dc7	140	/* tuner ioctls */
757d2505	141
5e453dc7	142	/* Sets tuner type and its I2C addr */
757d2505 HV	143	#define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
	144
	145	/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
	146	by VIDIOC_INT_S_STANDBY. */
	147	#define TUNER_SET_STANDBY _IOW('d', 91, int)
	148
5e453dc7	149	/* Sets tda9887 specific stuff, like port1, port2 and qss */
7f171123	150	#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505 HV	151
	152	/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
	153	#define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
	154
	155	/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
	156	chip into standby mode, value 0 will make the chip fully active. Specific
	157	bits can be used by certain chips to enable/disable specific subsystems.
	158	Replacement of TUNER_SET_STANDBY. */
	159	#define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
5e453dc7	160
52ebc763	161	/* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
b2f0648f	162
784e8fe4 HV	163	/* Generic reset command. The argument selects which subsystems to reset.
	164	Passing 0 will always reset the whole chip. */
	165	#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
b2f0648f	166
3578d3dd	167	/* Set the frequency (in Hz) of the audio clock output.
b2f0648f	168	Used to slave an audio processor to the video decoder, ensuring that audio
3578d3dd HV	169	and video remain synchronized.
	170	Usual values for the frequency are 48000, 44100 or 32000 Hz.
	171	If the frequency is not supported, then -EINVAL is returned. */
	172	#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
b2f0648f HV	173
	174	/* Video decoders that support sliced VBI need to implement this ioctl.
	175	Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
	176	data that was generated by the decoder. The driver then parses the sliced
	177	VBI data and sets the other fields in the struct accordingly. The pointer p
	178	is updated to point to the start of the payload which can be copied
	179	verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
	180	valid VBI data was found, then the type field is set to 0 on return. */
	181	#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
	182
	183	/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
	184	filled with the data packets that should be output. Note that if you set
12db5607 MCC	185	the line field to 0, then that VBI signal is disabled. If no
12db5607 MCC	186	valid VBI data was found, then the type field is set to 0 on return. */
b2f0648f HV	187	#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
	188
	189	/* Used to obtain the sliced VBI packet from a readback register. Not all
	190	video decoders support this. If no data is available because the readback
	191	register contains invalid or erroneous data -EIO is returned. Note that
	192	you must fill in the 'id' member and the 'field' member (to determine
	193	whether CC data from the first or second field should be obtained). */
41f38b43	194	#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
b2f0648f	195
9bb13a6d MCC	196	/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
	197	clock used by driving digital audio streams at some board designs.
	198	Usual values for the frequency are 1024000 and 2048000.
	199	If the frequency is not supported, then -EINVAL is returned. */
	200	#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
	201
757d2505 HV	202	/* Routing definition, device dependent. It specifies which inputs (if any)
	203	should be routed to which outputs (if any). */
	204	struct v4l2_routing {
	205	u32 input;
	206	u32 output;
	207	};
	208
	209	/* These internal commands should be used to define the inputs and outputs
8bf2f8e7 HV	210	of an audio/video chip. They will replace the v4l2 API commands
	211	VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
	212	that are meant to be used by the user.
	213	The internal commands should be used to switch inputs/outputs
757d2505 HV	214	because only the driver knows how to map a 'Television' input to the precise
	215	input/output routing of an A/D converter, or a DSP, or a video digitizer.
	216	These four commands should only be sent directly to an i2c device, they
	217	should not be broadcast as the routing is very device specific. */
	218	#define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
41f38b43	219	#define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
757d2505	220	#define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
41f38b43	221	#define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
757d2505	222
b7f8292c HV	223	struct v4l2_crystal_freq {
	224	u32 freq; /* frequency in Hz of the crystal */
	225	u32 flags; /* device specific flags */
	226	};
	227
	228	/* Sets the frequency of the crystal used to generate the clocks.
	229	An extra flags field allows device specific configuration regarding
	230	clock frequency dividers, etc. If not used, then set flags to 0.
	231	If the frequency is not supported, then -EINVAL is returned. */
	232	#define VIDIOC_INT_S_CRYSTAL_FREQ _IOW ('d', 113, struct v4l2_crystal_freq)
	233
9c4dfadb JC	234	/* Initialize the sensor registors to some sort of reasonable
	235	default values. */
	236	#define VIDIOC_INT_INIT _IOW ('d', 114, u32)
	237
045290b2 HV	238	/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
	239	video input devices. */
	240	#define VIDIOC_INT_S_STD_OUTPUT _IOW ('d', 115, v4l2_std_id)
	241
	242	/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
	243	video input devices. */
	244	#define VIDIOC_INT_G_STD_OUTPUT _IOW ('d', 116, v4l2_std_id)
	245
b2f0648f	246	#endif /* V4L2_COMMON_H_ */