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

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

/* Priority helper functions */

struct v4l2_prio_state {
	atomic_t prios[4];
};
void v4l2_prio_init(struct v4l2_prio_state *global);
int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
		     enum v4l2_priority new);
void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);

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

/* 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_name(u32 id);
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_menu(struct v4l2_querymenu *qmenu,
		struct v4l2_queryctrl *qctrl, const char **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);

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

/* Register/chip ident helper function */

struct i2c_client; /* forward reference */
int v4l2_chip_match_i2c_client(struct i2c_client *c, const struct v4l2_dbg_match *match);
int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_dbg_chip_ident *chip,
		u32 ident, u32 revision);
int v4l2_chip_match_host(const struct v4l2_dbg_match *match);

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

/* 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.
   Only call request_module if module_name != NULL.
   The client_type argument is the name of the chip that's on the adapter. */
struct v4l2_subdev *v4l2_i2c_new_subdev_cfg(struct v4l2_device *v4l2_dev,
		struct i2c_adapter *adapter,
		const char *module_name, const char *client_type,
		int irq, void *platform_data,
		u8 addr, const unsigned short *probe_addrs);

/* Load an i2c module and return an initialized v4l2_subdev struct.
   Only call request_module if module_name != NULL.
   The client_type argument is the name of the chip that's on the adapter. */
static inline struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
		struct i2c_adapter *adapter,
		const char *module_name, const char *client_type,
		u8 addr, const unsigned short *probe_addrs)
{
	return v4l2_i2c_new_subdev_cfg(v4l2_dev, adapter, module_name,
				client_type, 0, NULL, addr, probe_addrs);
}

struct i2c_board_info;

struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
		struct i2c_adapter *adapter, const char *module_name,
		struct i2c_board_info *info, const unsigned short *probe_addrs);

/* Initialize an 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 an 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);
int v4l_fill_dv_preset_info(u32 preset, struct v4l2_dv_enum_preset *info);

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

#endif /* V4L2_COMMON_H_ */
Commit	Line	Data
	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
	29	#include <media/v4l2-dev.h>
	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, debug, client, fmt, arg...) \
	53	do { \
	54	if (debug >= (level)) \
	55	v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
	56	} while (0)
	57
	58	/* ------------------------------------------------------------------------- */
	59
	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
	83	/* Priority helper functions */
	84
	85	struct v4l2_prio_state {
	86	atomic_t prios[4];
	87	};
	88	void v4l2_prio_init(struct v4l2_prio_state *global);
	89	int v4l2_prio_change(struct v4l2_prio_state global, enum v4l2_priority local,
	90	enum v4l2_priority new);
	91	void v4l2_prio_open(struct v4l2_prio_state global, enum v4l2_priority local);
	92	void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
	93	enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
	94	int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
	95
	96	/* ------------------------------------------------------------------------- */
	97
	98	/* Control helper functions */
	99
	100	int v4l2_ctrl_check(struct v4l2_ext_control ctrl, struct v4l2_queryctrl qctrl,
	101	const char **menu_items);
	102	const char *v4l2_ctrl_get_name(u32 id);
	103	const char **v4l2_ctrl_get_menu(u32 id);
	104	int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
	105	int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
	106	struct v4l2_queryctrl qctrl, const char *menu_items);
	107	#define V4L2_CTRL_MENU_IDS_END (0xffffffff)
	108	int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu qmenu, const u32 ids);
	109
	110	/* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a
	111	0-terminated array of control IDs. Each array must be sorted low to high
	112	and belong to the same control class. The array of u32 pointers must also
	113	be sorted, from low class IDs to high class IDs. */
	114	u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
	115
	116	/* ------------------------------------------------------------------------- */
	117
	118	/* Register/chip ident helper function */
	119
	120	struct i2c_client; /* forward reference */
	121	int v4l2_chip_match_i2c_client(struct i2c_client c, const struct v4l2_dbg_match match);
	122	int v4l2_chip_ident_i2c_client(struct i2c_client c, struct v4l2_dbg_chip_ident chip,
	123	u32 ident, u32 revision);
	124	int v4l2_chip_match_host(const struct v4l2_dbg_match *match);
	125
	126	/* ------------------------------------------------------------------------- */
	127
	128	/* I2C Helper functions */
	129
	130	struct i2c_driver;
	131	struct i2c_adapter;
	132	struct i2c_client;
	133	struct i2c_device_id;
	134	struct v4l2_device;
	135	struct v4l2_subdev;
	136	struct v4l2_subdev_ops;
	137
	138
	139	/* Load an i2c module and return an initialized v4l2_subdev struct.
	140	Only call request_module if module_name != NULL.
	141	The client_type argument is the name of the chip that's on the adapter. */
	142	struct v4l2_subdev v4l2_i2c_new_subdev_cfg(struct v4l2_device v4l2_dev,
	143	struct i2c_adapter *adapter,
	144	const char module_name, const char client_type,
	145	int irq, void *platform_data,
	146	u8 addr, const unsigned short *probe_addrs);
	147
	148	/* Load an i2c module and return an initialized v4l2_subdev struct.
	149	Only call request_module if module_name != NULL.
	150	The client_type argument is the name of the chip that's on the adapter. */
	151	static inline struct v4l2_subdev v4l2_i2c_new_subdev(struct v4l2_device v4l2_dev,
	152	struct i2c_adapter *adapter,
	153	const char module_name, const char client_type,
	154	u8 addr, const unsigned short *probe_addrs)
	155	{
	156	return v4l2_i2c_new_subdev_cfg(v4l2_dev, adapter, module_name,
	157	client_type, 0, NULL, addr, probe_addrs);
	158	}
	159
	160	struct i2c_board_info;
	161
	162	struct v4l2_subdev v4l2_i2c_new_subdev_board(struct v4l2_device v4l2_dev,
	163	struct i2c_adapter adapter, const char module_name,
	164	struct i2c_board_info info, const unsigned short probe_addrs);
	165
	166	/* Initialize an v4l2_subdev with data from an i2c_client struct */
	167	void v4l2_i2c_subdev_init(struct v4l2_subdev sd, struct i2c_client client,
	168	const struct v4l2_subdev_ops *ops);
	169	/* Return i2c client address of v4l2_subdev. */
	170	unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
	171
	172	enum v4l2_i2c_tuner_type {
	173	ADDRS_RADIO, /* Radio tuner addresses */
	174	ADDRS_DEMOD, /* Demod tuner addresses */
	175	ADDRS_TV, /* TV tuner addresses */
	176	/* TV tuner addresses if demod is present, this excludes
	177	addresses used by the demodulator from the list of
	178	candidates. */
	179	ADDRS_TV_WITH_DEMOD,
	180	};
	181	/* Return a list of I2C tuner addresses to probe. Use only if the tuner
	182	addresses are unknown. */
	183	const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
	184
	185	/* ------------------------------------------------------------------------- */
	186
	187	/* SPI Helper functions */
	188	#if defined(CONFIG_SPI)
	189
	190	#include <linux/spi/spi.h>
	191
	192	struct spi_device;
	193
	194	/* Load an spi module and return an initialized v4l2_subdev struct.
	195	The client_type argument is the name of the chip that's on the adapter. */
	196	struct v4l2_subdev v4l2_spi_new_subdev(struct v4l2_device v4l2_dev,
	197	struct spi_master master, struct spi_board_info info);
	198
	199	/* Initialize an v4l2_subdev with data from an spi_device struct */
	200	void v4l2_spi_subdev_init(struct v4l2_subdev sd, struct spi_device spi,
	201	const struct v4l2_subdev_ops *ops);
	202	#endif
	203
	204	/* ------------------------------------------------------------------------- */
	205
	206	/* Note: these remaining ioctls/structs should be removed as well, but they are
	207	still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
	208	v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
	209	is needed in those modules. */
	210
	211	/* s_config */
	212	struct v4l2_priv_tun_config {
	213	int tuner;
	214	void *priv;
	215	};
	216	#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
	217
	218	#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
	219
	220	struct v4l2_routing {
	221	u32 input;
	222	u32 output;
	223	};
	224
	225	/* ------------------------------------------------------------------------- */
	226
	227	/* Miscellaneous helper functions */
	228
	229	void v4l_bound_align_image(unsigned int *w, unsigned int wmin,
	230	unsigned int wmax, unsigned int walign,
	231	unsigned int *h, unsigned int hmin,
	232	unsigned int hmax, unsigned int halign,
	233	unsigned int salign);
	234	int v4l_fill_dv_preset_info(u32 preset, struct v4l2_dv_enum_preset *info);
	235
	236	struct v4l2_discrete_probe {
	237	const struct v4l2_frmsize_discrete *sizes;
	238	int num_sizes;
	239	};
	240
	241	const struct v4l2_frmsize_discrete *v4l2_find_nearest_format(
	242	const struct v4l2_discrete_probe *probe,
	243	s32 width, s32 height);
	244
	245	#endif /* V4L2_COMMON_H_ */