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

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

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

/* These printk constructs can be used with v4l2_device and v4l2_subdev */
#define v4l2_printk(level, dev, fmt, arg...) \
	printk(level "%s: " fmt, (dev)->name , ## arg)

#define v4l2_err(dev, fmt, arg...) \
	v4l2_printk(KERN_ERR, dev, fmt , ## arg)

#define v4l2_warn(dev, fmt, arg...) \
	v4l2_printk(KERN_WARNING, dev, fmt , ## arg)

#define v4l2_info(dev, fmt, arg...) \
	v4l2_printk(KERN_INFO, dev, fmt , ## arg)

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

/**
 * v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl
 *
 * @qctrl: pointer to the &struct v4l2_queryctrl to be filled
 * @min: minimum value for the control
 * @max: maximum value for the control
 * @step: control step
 * @def: default value for the control
 *
 * Fills the &struct v4l2_queryctrl fields for the query control.
 *
 * .. note::
 *
 *    This function assumes that the @qctrl->id field is filled.
 *
 * Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
 */

int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
			 s32 min, s32 max, s32 step, s32 def);

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

/* I2C Helper functions */

struct i2c_driver;
struct i2c_adapter;
struct i2c_client;
struct i2c_device_id;
struct v4l2_device;
struct v4l2_subdev;
struct v4l2_subdev_ops;

/**
 * v4l2_i2c_new_subdev - Load an i2c module and return an initialized
 *	&struct v4l2_subdev.
 *
 * @v4l2_dev: pointer to &struct v4l2_device
 * @adapter: pointer to struct i2c_adapter
 * @client_type:  name of the chip that's on the adapter.
 * @addr: I2C address. If zero, it will use @probe_addrs
 * @probe_addrs: array with a list of address. The last entry at such
 * 	array should be %I2C_CLIENT_END.
 *
 * returns a &struct v4l2_subdev pointer.
 */
struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
		struct i2c_adapter *adapter, const char *client_type,
		u8 addr, const unsigned short *probe_addrs);

struct i2c_board_info;

/**
 * v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized
 *	&struct v4l2_subdev.
 *
 * @v4l2_dev: pointer to &struct v4l2_device
 * @adapter: pointer to struct i2c_adapter
 * @info: pointer to struct i2c_board_info used to replace the irq,
 *	 platform_data and addr arguments.
 * @probe_addrs: array with a list of address. The last entry at such
 * 	array should be %I2C_CLIENT_END.
 *
 * returns a &struct v4l2_subdev pointer.
 */
struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
		struct i2c_adapter *adapter, struct i2c_board_info *info,
		const unsigned short *probe_addrs);

/**
 * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
 *	an i2c_client struct.
 *
 * @sd: pointer to &struct v4l2_subdev
 * @client: pointer to struct i2c_client
 * @ops: pointer to &struct v4l2_subdev_ops
 */
void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
		const struct v4l2_subdev_ops *ops);

/**
 * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
 *
 * @sd: pointer to &struct v4l2_subdev
 *
 * Returns the address of an I2C sub-device
 */
unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);

enum v4l2_i2c_tuner_type {
	ADDRS_RADIO,	/* Radio tuner addresses */
	ADDRS_DEMOD,	/* Demod tuner addresses */
	ADDRS_TV,	/* TV tuner addresses */
	/* TV tuner addresses if demod is present, this excludes
	   addresses used by the demodulator from the list of
	   candidates. */
	ADDRS_TV_WITH_DEMOD,
};
/* Return a list of I2C tuner addresses to probe. Use only if the tuner
   addresses are unknown. */
const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);

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

/* SPI Helper functions */
#if defined(CONFIG_SPI)

#include <linux/spi/spi.h>

struct spi_device;

/**
 *  v4l2_spi_new_subdev - Load an spi module and return an initialized
 *	&struct v4l2_subdev.
 *
 *
 * @v4l2_dev: pointer to &struct v4l2_device.
 * @master: pointer to struct spi_master.
 * @info: pointer to struct spi_board_info.
 *
 * returns a &struct v4l2_subdev pointer.
 */
struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
		struct spi_master *master, struct spi_board_info *info);

/**
 * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
 *	spi_device struct.
 *
 * @sd: pointer to &struct v4l2_subdev
 * @spi: pointer to struct spi_device.
 * @ops: pointer to &struct v4l2_subdev_ops
 */
void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
		const struct v4l2_subdev_ops *ops);
#endif

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

/* Note: these remaining ioctls/structs should be removed as well, but they are
   still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
   v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
   is needed in those modules. */

/* s_config */
struct v4l2_priv_tun_config {
	int tuner;
	void *priv;
};
#define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)

#define VIDIOC_INT_RESET            	_IOW ('d', 102, u32)

struct v4l2_routing {
	u32 input;
	u32 output;
};

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

/* Miscellaneous helper functions */

void v4l_bound_align_image(unsigned int *w, unsigned int wmin,
			   unsigned int wmax, unsigned int walign,
			   unsigned int *h, unsigned int hmin,
			   unsigned int hmax, unsigned int halign,
			   unsigned int salign);

struct v4l2_discrete_probe {
	const struct v4l2_frmsize_discrete	*sizes;
	int					num_sizes;
};

const struct v4l2_frmsize_discrete *v4l2_find_nearest_format(
		const struct v4l2_discrete_probe *probe,
		s32 width, s32 height);

void v4l2_get_timestamp(struct timeval *tv);

#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	/* 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...) \
f9d32f25	38	v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \
7e8b09ea HV	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
7e8b09ea HV	58	/* ------------------------------------------------------------------------- */
7e8b09ea HV	59
dd99120c HV	60	/* These printk constructs can be used with v4l2_device and v4l2_subdev */
	61	#define v4l2_printk(level, dev, fmt, arg...) \
	62	printk(level "%s: " fmt, (dev)->name , ## arg)
	63
	64	#define v4l2_err(dev, fmt, arg...) \
	65	v4l2_printk(KERN_ERR, dev, fmt , ## arg)
	66
	67	#define v4l2_warn(dev, fmt, arg...) \
	68	v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
	69
	70	#define v4l2_info(dev, fmt, arg...) \
	71	v4l2_printk(KERN_INFO, dev, fmt , ## arg)
	72
	73	/* These three macros assume that the debug level is set with a module
	74	parameter called 'debug'. */
	75	#define v4l2_dbg(level, debug, dev, fmt, arg...) \
	76	do { \
	77	if (debug >= (level)) \
	78	v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \
	79	} while (0)
	80
b8719158 MCC	81	/**
	82	* v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl
	83	*
	84	* @qctrl: pointer to the &struct v4l2_queryctrl to be filled
	85	* @min: minimum value for the control
	86	* @max: maximum value for the control
	87	* @step: control step
	88	* @def: default value for the control
	89	*
	90	* Fills the &struct v4l2_queryctrl fields for the query control.
	91	*
	92	* .. note::
	93	*
	94	* This function assumes that the @qctrl->id field is filled.
	95	*
	96	* Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
	97	*/
dd99120c	98
b8719158 MCC	99	int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
b8719158 MCC	100	s32 min, s32 max, s32 step, s32 def);
9cb2318b HV	101
	102	/* ------------------------------------------------------------------------- */
	103
78a3b4db	104	/* I2C Helper functions */
8ffbc655 HV	105
	106	struct i2c_driver;
	107	struct i2c_adapter;
	108	struct i2c_client;
d2653e92	109	struct i2c_device_id;
dd99120c HV	110	struct v4l2_device;
	111	struct v4l2_subdev;
	112	struct v4l2_subdev_ops;
8ffbc655	113
a39c57f8 MCC	114	/**
	115	* v4l2_i2c_new_subdev - Load an i2c module and return an initialized
	116	* &struct v4l2_subdev.
	117	*
	118	* @v4l2_dev: pointer to &struct v4l2_device
	119	* @adapter: pointer to struct i2c_adapter
	120	* @client_type: name of the chip that's on the adapter.
	121	* @addr: I2C address. If zero, it will use @probe_addrs
	122	* @probe_addrs: array with a list of address. The last entry at such
	123	* array should be %I2C_CLIENT_END.
	124	*
	125	* returns a &struct v4l2_subdev pointer.
	126	*/
3c7c9370	127	struct v4l2_subdev v4l2_i2c_new_subdev(struct v4l2_device v4l2_dev,
9a1f8b34	128	struct i2c_adapter adapter, const char client_type,
53dacb15	129	u8 addr, const unsigned short *probe_addrs);
f0222c7d	130
f0222c7d HV	131	struct i2c_board_info;
f0222c7d HV	132
a39c57f8 MCC	133	/**
	134	* v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized
	135	* &struct v4l2_subdev.
	136	*
	137	* @v4l2_dev: pointer to &struct v4l2_device
	138	* @adapter: pointer to struct i2c_adapter
	139	* @info: pointer to struct i2c_board_info used to replace the irq,
	140	* platform_data and addr arguments.
	141	* @probe_addrs: array with a list of address. The last entry at such
	142	* array should be %I2C_CLIENT_END.
	143	*
	144	* returns a &struct v4l2_subdev pointer.
	145	*/
f0222c7d	146	struct v4l2_subdev v4l2_i2c_new_subdev_board(struct v4l2_device v4l2_dev,
9a1f8b34 LP	147	struct i2c_adapter adapter, struct i2c_board_info info,
9a1f8b34 LP	148	const unsigned short *probe_addrs);
f0222c7d	149
a39c57f8 MCC	150	/**
	151	* v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
	152	* an i2c_client struct.
	153	*
	154	* @sd: pointer to &struct v4l2_subdev
	155	* @client: pointer to struct i2c_client
	156	* @ops: pointer to &struct v4l2_subdev_ops
	157	*/
dd99120c HV	158	void v4l2_i2c_subdev_init(struct v4l2_subdev sd, struct i2c_client client,
dd99120c HV	159	const struct v4l2_subdev_ops *ops);
a39c57f8 MCC	160
	161	/**
	162	* v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
	163	*
	164	* @sd: pointer to &struct v4l2_subdev
	165	*
	166	* Returns the address of an I2C sub-device
	167	*/
ab373190	168	unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
dd99120c	169
c7d29e2f HV	170	enum v4l2_i2c_tuner_type {
	171	ADDRS_RADIO, /* Radio tuner addresses */
	172	ADDRS_DEMOD, /* Demod tuner addresses */
	173	ADDRS_TV, /* TV tuner addresses */
	174	/* TV tuner addresses if demod is present, this excludes
	175	addresses used by the demodulator from the list of
	176	candidates. */
	177	ADDRS_TV_WITH_DEMOD,
	178	};
	179	/* Return a list of I2C tuner addresses to probe. Use only if the tuner
	180	addresses are unknown. */
	181	const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
	182
8ffbc655	183	/* ------------------------------------------------------------------------- */
85e09219 DB	184
	185	/* SPI Helper functions */
	186	#if defined(CONFIG_SPI)
	187
	188	#include <linux/spi/spi.h>
	189
	190	struct spi_device;
	191
b8719158 MCC	192	/**
	193	* v4l2_spi_new_subdev - Load an spi module and return an initialized
	194	* &struct v4l2_subdev.
	195	*
	196	*
	197	* @v4l2_dev: pointer to &struct v4l2_device.
	198	* @master: pointer to struct spi_master.
	199	* @info: pointer to struct spi_board_info.
	200	*
	201	* returns a &struct v4l2_subdev pointer.
	202	*/
85e09219 DB	203	struct v4l2_subdev v4l2_spi_new_subdev(struct v4l2_device v4l2_dev,
	204	struct spi_master master, struct spi_board_info info);
	205
b8719158 MCC	206	/**
	207	* v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
	208	* spi_device struct.
	209	*
	210	* @sd: pointer to &struct v4l2_subdev
	211	* @spi: pointer to struct spi_device.
	212	* @ops: pointer to &struct v4l2_subdev_ops
	213	*/
85e09219 DB	214	void v4l2_spi_subdev_init(struct v4l2_subdev sd, struct spi_device spi,
	215	const struct v4l2_subdev_ops *ops);
	216	#endif
	217
	218	/* ------------------------------------------------------------------------- */
8ffbc655	219
6c31e598 HV	220	/* Note: these remaining ioctls/structs should be removed as well, but they are
	221	still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
	222	v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
	223	is needed in those modules. */
b2f0648f	224
78a3b4db	225	/* s_config */
7f171123 MCC	226	struct v4l2_priv_tun_config {
	227	int tuner;
	228	void *priv;
	229	};
7f171123	230	#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505	231
6c31e598 HV	232	#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
6c31e598 HV	233
757d2505 HV	234	struct v4l2_routing {
	235	u32 input;
	236	u32 output;
	237	};
1b6f1d96	238
b0d3159b TP	239	/* ------------------------------------------------------------------------- */
	240
	241	/* Miscellaneous helper functions */
	242
	243	void v4l_bound_align_image(unsigned int *w, unsigned int wmin,
	244	unsigned int wmax, unsigned int walign,
	245	unsigned int *h, unsigned int hmin,
	246	unsigned int hmax, unsigned int halign,
	247	unsigned int salign);
3fd8e647 HV	248
	249	struct v4l2_discrete_probe {
	250	const struct v4l2_frmsize_discrete *sizes;
	251	int num_sizes;
	252	};
	253
	254	const struct v4l2_frmsize_discrete *v4l2_find_nearest_format(
	255	const struct v4l2_discrete_probe *probe,
	256	s32 width, s32 height);
	257
abd23295 SA	258	void v4l2_get_timestamp(struct timeval *tv);
abd23295 SA	259
b2f0648f	260	#endif /* V4L2_COMMON_H_ */