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

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

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

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

/* Control helper functions */

int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
		const char * const *menu_items);
const char *v4l2_ctrl_get_name(u32 id);
const char * const *v4l2_ctrl_get_menu(u32 id);
const s64 const *v4l2_ctrl_get_int_menu(u32 id, u32 *len);
int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
		struct v4l2_queryctrl *qctrl, const char * const *menu_items);
#define V4L2_CTRL_MENU_IDS_END (0xffffffff)
int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids);

/* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a
   0-terminated array of control IDs. Each array must be sorted low to high
   and belong to the same control class. The array of u32 pointers must also
   be sorted, from low class IDs to high class IDs. */
u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);

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

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


/* Load an i2c module and return an initialized v4l2_subdev struct.
   The client_type argument is the name of the chip that's on the adapter. */
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;

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

/* Initialize a v4l2_subdev with data from an i2c_client struct */
void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
		const struct v4l2_subdev_ops *ops);
/* Return i2c client address of v4l2_subdev. */
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;

/* Load an spi module and return an initialized v4l2_subdev struct.
   The client_type argument is the name of the chip that's on the adapter. */
struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
		struct spi_master *master, struct spi_board_info *info);

/* Initialize a v4l2_subdev with data from an spi_device struct */
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...) \
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
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
	81	/* ------------------------------------------------------------------------- */
	82
9cb2318b HV	83	/* Control helper functions */
	84
	85	int v4l2_ctrl_check(struct v4l2_ext_control ctrl, struct v4l2_queryctrl qctrl,
513521ea	86	const char * const *menu_items);
69028d70	87	const char *v4l2_ctrl_get_name(u32 id);
513521ea	88	const char * const *v4l2_ctrl_get_menu(u32 id);
bfd22c49	89	const s64 const v4l2_ctrl_get_int_menu(u32 id, u32 len);
9cb2318b	90	int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
9cb2318b	91	int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
513521ea	92	struct v4l2_queryctrl qctrl, const char const *menu_items);
1e551266 HV	93	#define V4L2_CTRL_MENU_IDS_END (0xffffffff)
1e551266 HV	94	int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu qmenu, const u32 ids);
2ba58894 HV	95
	96	/* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a
	97	0-terminated array of control IDs. Each array must be sorted low to high
	98	and belong to the same control class. The array of u32 pointers must also
	99	be sorted, from low class IDs to high class IDs. */
9cb2318b HV	100	u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
	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
8ffbc655	114
dd99120c	115	/* Load an i2c module and return an initialized v4l2_subdev struct.
dd99120c	116	The client_type argument is the name of the chip that's on the adapter. */
3c7c9370	117	struct v4l2_subdev v4l2_i2c_new_subdev(struct v4l2_device v4l2_dev,
9a1f8b34	118	struct i2c_adapter adapter, const char client_type,
53dacb15	119	u8 addr, const unsigned short *probe_addrs);
f0222c7d	120
f0222c7d HV	121	struct i2c_board_info;
	122
	123	struct v4l2_subdev v4l2_i2c_new_subdev_board(struct v4l2_device v4l2_dev,
9a1f8b34 LP	124	struct i2c_adapter adapter, struct i2c_board_info info,
9a1f8b34 LP	125	const unsigned short *probe_addrs);
f0222c7d	126
9d380adf	127	/* Initialize a v4l2_subdev with data from an i2c_client struct */
dd99120c HV	128	void v4l2_i2c_subdev_init(struct v4l2_subdev sd, struct i2c_client client,
dd99120c HV	129	const struct v4l2_subdev_ops *ops);
ab373190 HV	130	/* Return i2c client address of v4l2_subdev. */
ab373190 HV	131	unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
dd99120c	132
c7d29e2f HV	133	enum v4l2_i2c_tuner_type {
	134	ADDRS_RADIO, /* Radio tuner addresses */
	135	ADDRS_DEMOD, /* Demod tuner addresses */
	136	ADDRS_TV, /* TV tuner addresses */
	137	/* TV tuner addresses if demod is present, this excludes
	138	addresses used by the demodulator from the list of
	139	candidates. */
	140	ADDRS_TV_WITH_DEMOD,
	141	};
	142	/* Return a list of I2C tuner addresses to probe. Use only if the tuner
	143	addresses are unknown. */
	144	const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
	145
8ffbc655	146	/* ------------------------------------------------------------------------- */
85e09219 DB	147
	148	/* SPI Helper functions */
	149	#if defined(CONFIG_SPI)
	150
	151	#include <linux/spi/spi.h>
	152
	153	struct spi_device;
	154
	155	/* Load an spi module and return an initialized v4l2_subdev struct.
	156	The client_type argument is the name of the chip that's on the adapter. */
	157	struct v4l2_subdev v4l2_spi_new_subdev(struct v4l2_device v4l2_dev,
	158	struct spi_master master, struct spi_board_info info);
	159
9d380adf	160	/* Initialize a v4l2_subdev with data from an spi_device struct */
85e09219 DB	161	void v4l2_spi_subdev_init(struct v4l2_subdev sd, struct spi_device spi,
	162	const struct v4l2_subdev_ops *ops);
	163	#endif
	164
	165	/* ------------------------------------------------------------------------- */
8ffbc655	166
6c31e598 HV	167	/* Note: these remaining ioctls/structs should be removed as well, but they are
	168	still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
	169	v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
	170	is needed in those modules. */
b2f0648f	171
78a3b4db	172	/* s_config */
7f171123 MCC	173	struct v4l2_priv_tun_config {
	174	int tuner;
	175	void *priv;
	176	};
7f171123	177	#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505	178
6c31e598 HV	179	#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
6c31e598 HV	180
757d2505 HV	181	struct v4l2_routing {
	182	u32 input;
	183	u32 output;
	184	};
1b6f1d96	185
b0d3159b TP	186	/* ------------------------------------------------------------------------- */
	187
	188	/* Miscellaneous helper functions */
	189
	190	void v4l_bound_align_image(unsigned int *w, unsigned int wmin,
	191	unsigned int wmax, unsigned int walign,
	192	unsigned int *h, unsigned int hmin,
	193	unsigned int hmax, unsigned int halign,
	194	unsigned int salign);
3fd8e647 HV	195
	196	struct v4l2_discrete_probe {
	197	const struct v4l2_frmsize_discrete *sizes;
	198	int num_sizes;
	199	};
	200
	201	const struct v4l2_frmsize_discrete *v4l2_find_nearest_format(
	202	const struct v4l2_discrete_probe *probe,
	203	s32 width, s32 height);
	204
abd23295 SA	205	void v4l2_get_timestamp(struct timeval *tv);
abd23295 SA	206
b2f0648f	207	#endif /* V4L2_COMMON_H_ */