blob: c48c24e4d0fa44bb6b2df6f646a1fc37ca737a5d [file] [log] [blame]
Hans Verkuilb2f06482005-11-13 16:07:55 -08001/*
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
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030029#include <media/v4l2-dev.h>
30
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020031/* 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
Mauro Carvalho Chehabcab462f2006-01-09 15:53:26 -020037#define v4l_client_printk(level, client, fmt, arg...) \
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020038 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'. */
Mauro Carvalho Chehabf167cb4e2006-01-11 19:41:49 -020052#define v4l_dbg(level, debug, client, fmt, arg...) \
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020053 do { \
54 if (debug >= (level)) \
55 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
56 } while (0)
57
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020058/* ------------------------------------------------------------------------- */
59
Hans Verkuildd991202008-11-23 12:19:45 -030060/* 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
Hans Verkuil35ea11f2008-07-20 08:12:02 -030083/* Priority helper functions */
84
85struct v4l2_prio_state {
86 atomic_t prios[4];
87};
88int v4l2_prio_init(struct v4l2_prio_state *global);
89int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
90 enum v4l2_priority new);
91int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
92int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
93enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
94int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
95
96/* ------------------------------------------------------------------------- */
97
Hans Verkuil9cb23182006-06-18 14:11:08 -030098/* Control helper functions */
99
100int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
101 const char **menu_items);
Hans Verkuil69028d72008-08-08 07:55:00 -0300102const char *v4l2_ctrl_get_name(u32 id);
Hans Verkuil9cb23182006-06-18 14:11:08 -0300103const char **v4l2_ctrl_get_menu(u32 id);
104int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
Hans Verkuil9cb23182006-06-18 14:11:08 -0300105int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
106 struct v4l2_queryctrl *qctrl, const char **menu_items);
Hans Verkuil1e551262008-08-08 08:34:19 -0300107#define V4L2_CTRL_MENU_IDS_END (0xffffffff)
108int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids);
Hans Verkuil2ba58892009-02-13 10:57:48 -0300109
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. */
Hans Verkuil9cb23182006-06-18 14:11:08 -0300114u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
115
116/* ------------------------------------------------------------------------- */
117
Hans Verkuilf3d092b2007-02-23 20:55:14 -0300118/* Register/chip ident helper function */
119
120struct i2c_client; /* forward reference */
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300121int v4l2_chip_match_i2c_client(struct i2c_client *c, const struct v4l2_dbg_match *match);
122int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_dbg_chip_ident *chip,
Hans Verkuil3434eb72007-04-27 12:31:08 -0300123 u32 ident, u32 revision);
Hans Verkuilaecde8b52008-12-30 07:14:19 -0300124int v4l2_chip_match_host(const struct v4l2_dbg_match *match);
Hans Verkuilf3d092b2007-02-23 20:55:14 -0300125
126/* ------------------------------------------------------------------------- */
127
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300128/* I2C Helper functions */
Hans Verkuil8ffbc652007-09-12 08:32:50 -0300129
130struct i2c_driver;
131struct i2c_adapter;
132struct i2c_client;
Jean Delvared2653e92008-04-29 23:11:39 +0200133struct i2c_device_id;
Hans Verkuildd991202008-11-23 12:19:45 -0300134struct v4l2_device;
135struct v4l2_subdev;
136struct v4l2_subdev_ops;
Hans Verkuil8ffbc652007-09-12 08:32:50 -0300137
Hans Verkuil8ffbc652007-09-12 08:32:50 -0300138
Hans Verkuildd991202008-11-23 12:19:45 -0300139/* 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. */
Hans Verkuile6574f22009-04-01 03:57:53 -0300142struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
143 struct i2c_adapter *adapter,
Hans Verkuildd991202008-11-23 12:19:45 -0300144 const char *module_name, const char *client_type, u8 addr);
145/* Probe and load an i2c module and return an initialized v4l2_subdev struct.
146 Only call request_module if module_name != NULL.
147 The client_type argument is the name of the chip that's on the adapter. */
Hans Verkuile6574f22009-04-01 03:57:53 -0300148struct v4l2_subdev *v4l2_i2c_new_probed_subdev(struct v4l2_device *v4l2_dev,
149 struct i2c_adapter *adapter,
Hans Verkuildd991202008-11-23 12:19:45 -0300150 const char *module_name, const char *client_type,
151 const unsigned short *addrs);
Hans Verkuil868f9852009-03-30 11:40:54 -0300152/* Like v4l2_i2c_new_probed_subdev, except probe for a single address. */
153struct v4l2_subdev *v4l2_i2c_new_probed_subdev_addr(struct v4l2_device *v4l2_dev,
154 struct i2c_adapter *adapter,
155 const char *module_name, const char *client_type, u8 addr);
Hans Verkuildd991202008-11-23 12:19:45 -0300156/* Initialize an v4l2_subdev with data from an i2c_client struct */
157void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
158 const struct v4l2_subdev_ops *ops);
Hans Verkuilab3731902009-02-21 18:08:41 -0300159/* Return i2c client address of v4l2_subdev. */
160unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
Hans Verkuildd991202008-11-23 12:19:45 -0300161
Hans Verkuilc7d29e22009-01-18 19:37:59 -0300162enum v4l2_i2c_tuner_type {
163 ADDRS_RADIO, /* Radio tuner addresses */
164 ADDRS_DEMOD, /* Demod tuner addresses */
165 ADDRS_TV, /* TV tuner addresses */
166 /* TV tuner addresses if demod is present, this excludes
167 addresses used by the demodulator from the list of
168 candidates. */
169 ADDRS_TV_WITH_DEMOD,
170};
171/* Return a list of I2C tuner addresses to probe. Use only if the tuner
172 addresses are unknown. */
173const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
174
Hans Verkuil8ffbc652007-09-12 08:32:50 -0300175/* ------------------------------------------------------------------------- */
176
Hans Verkuil6c31e592009-04-02 11:37:41 -0300177/* Note: these remaining ioctls/structs should be removed as well, but they are
178 still used in tuner-simple.c (TUNER_SET_CONFIG), cx18/ivtv (RESET) and
179 v4l2-int-device.h (v4l2_routing). To remove these ioctls some more cleanup
180 is needed in those modules. */
Hans Verkuil7e8b09e2006-01-09 15:32:40 -0200181
Hans Verkuil78a3b4d2009-04-01 03:41:09 -0300182/* s_config */
Mauro Carvalho Chehab7f171122007-10-18 19:56:47 -0300183struct v4l2_priv_tun_config {
184 int tuner;
185 void *priv;
186};
Mauro Carvalho Chehab7f171122007-10-18 19:56:47 -0300187#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
Hans Verkuil757d2502006-01-23 17:11:10 -0200188
Hans Verkuil6c31e592009-04-02 11:37:41 -0300189#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
190
Hans Verkuil757d2502006-01-23 17:11:10 -0200191struct v4l2_routing {
192 u32 input;
193 u32 output;
194};
Hans Verkuil1b6f1d92009-02-13 07:48:21 -0300195
Hans Verkuilb2f06482005-11-13 16:07:55 -0800196#endif /* V4L2_COMMON_H_ */