[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 <[email protected]>

    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, 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);

/* 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_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 */
#define AUDC_SET_RADIO        _IO('d',88)
/* select from TV,radio,extern,MUTE */
#define AUDC_SET_INPUT        _IOW('d',89,int)

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

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

#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 <[email protected]>
	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
	37	#define v4l_client_printk(level, client, fmt, arg...) \
	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'. */
	52	#define v4l_dbg(level, client, fmt, arg...) \
	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
	61	/* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
	62	#define v4l_print_ioctl(name, cmd) \
	63	do { \
	64	printk(KERN_DEBUG "%s: ", name); \
	65	v4l_printk_ioctl(cmd); \
	66	} while (0)
	67
	68	/* Use this macro in I2C drivers where 'client' is the struct i2c_client
	69	pointer */
	70	#define v4l_i2c_print_ioctl(client, cmd) \
	71	do { \
	72	v4l_client_printk(KERN_DEBUG, client, ""); \
	73	v4l_printk_ioctl(cmd); \
	74	} while (0)
	75
	76	/* ------------------------------------------------------------------------- */
	77
	78	/* Internal ioctls */
	79
b2f0648f HV	80	/* VIDIOC_INT_G_REGISTER and VIDIOC_INT_S_REGISTER */
	81	struct v4l2_register {
	82	u32 i2c_id; /* I2C driver ID of the I2C chip. 0 for the I2C adapter. */
	83	unsigned long reg;
	84	u32 val;
	85	};
	86
	87	/* VIDIOC_INT_DECODE_VBI_LINE */
	88	struct v4l2_decode_vbi_line {
	89	u32 is_second_field; /* Set to 0 for the first (odd) field,
	90	set to 1 for the second (even) field. */
	91	u8 p; / Pointer to the sliced VBI data from the decoder.
	92	On exit points to the start of the payload. */
	93	u32 line; /* Line number of the sliced VBI data (1-23) */
	94	u32 type; /* VBI service type (V4L2_SLICED_). 0 if no service found /
	95	};
	96
	97	/* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */
	98	enum v4l2_chip_ident {
	99	/* general idents: reserved range 0-49 */
	100	V4L2_IDENT_UNKNOWN = 0,
	101
	102	/* module saa7115: reserved range 100-149 */
	103	V4L2_IDENT_SAA7114 = 104,
	104	V4L2_IDENT_SAA7115 = 105,
	105
	106	/* module saa7127: reserved range 150-199 */
	107	V4L2_IDENT_SAA7127 = 157,
	108	V4L2_IDENT_SAA7129 = 159,
	109
	110	/* module cx25840: reserved range 200-249 */
	111	V4L2_IDENT_CX25840 = 240,
	112	V4L2_IDENT_CX25841 = 241,
	113	V4L2_IDENT_CX25842 = 242,
	114	V4L2_IDENT_CX25843 = 243,
	115	};
	116
5e453dc7 MK	117	/* audio ioctls */
	118	/* v4l device was opened in Radio mode */
	119	#define AUDC_SET_RADIO _IO('d',88)
	120	/* select from TV,radio,extern,MUTE */
	121	#define AUDC_SET_INPUT _IOW('d',89,int)
	122
	123	/* tuner ioctls */
	124	/* Sets tuner type and its I2C addr */
	125	#define TUNER_SET_TYPE_ADDR _IOW('d',90,int)
	126	/* Puts tuner on powersaving state, disabling it, except for i2c */
	127	#define TUNER_SET_STANDBY _IOW('d',91,int)
	128	/* Sets tda9887 specific stuff, like port1, port2 and qss */
	129	#define TDA9887_SET_CONFIG _IOW('d',92,int)
	130
b2f0648f HV	131	/* only implemented if CONFIG_VIDEO_ADV_DEBUG is defined */
	132	#define VIDIOC_INT_S_REGISTER _IOR ('d', 100, struct v4l2_register)
	133	#define VIDIOC_INT_G_REGISTER _IOWR('d', 101, struct v4l2_register)
	134
	135	/* Reset the I2C chip */
	136	#define VIDIOC_INT_RESET _IO ('d', 102)
	137
3578d3dd	138	/* Set the frequency (in Hz) of the audio clock output.
b2f0648f	139	Used to slave an audio processor to the video decoder, ensuring that audio
3578d3dd HV	140	and video remain synchronized.
	141	Usual values for the frequency are 48000, 44100 or 32000 Hz.
	142	If the frequency is not supported, then -EINVAL is returned. */
	143	#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
b2f0648f HV	144
	145	/* Video decoders that support sliced VBI need to implement this ioctl.
	146	Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
	147	data that was generated by the decoder. The driver then parses the sliced
	148	VBI data and sets the other fields in the struct accordingly. The pointer p
	149	is updated to point to the start of the payload which can be copied
	150	verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
	151	valid VBI data was found, then the type field is set to 0 on return. */
	152	#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
	153
	154	/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
	155	filled with the data packets that should be output. Note that if you set
	156	the line field to 0, then that VBI signal is disabled. */
	157	#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
	158
	159	/* Used to obtain the sliced VBI packet from a readback register. Not all
	160	video decoders support this. If no data is available because the readback
	161	register contains invalid or erroneous data -EIO is returned. Note that
	162	you must fill in the 'id' member and the 'field' member (to determine
	163	whether CC data from the first or second field should be obtained). */
	164	#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data *)
	165
	166	/* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can
	167	be made. */
	168	#define VIDIOC_INT_G_CHIP_IDENT _IOR ('d', 107, enum v4l2_chip_ident *)
	169
9bb13a6d MCC	170	/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
	171	clock used by driving digital audio streams at some board designs.
	172	Usual values for the frequency are 1024000 and 2048000.
	173	If the frequency is not supported, then -EINVAL is returned. */
	174	#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
	175
b2f0648f	176	#endif /* V4L2_COMMON_H_ */