2 v4l2 common internal API header
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
9 Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
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.
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.
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
26 #ifndef V4L2_COMMON_H_
27 #define V4L2_COMMON_H_
29 #include <media/v4l2-dev.h>
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
34 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
35 printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
37 #define v4l_client_printk(level, client, fmt, arg...) \
38 v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
39 (client)->addr, fmt , ## arg)
41 #define v4l_err(client, fmt, arg...) \
42 v4l_client_printk(KERN_ERR, client, fmt , ## arg)
44 #define v4l_warn(client, fmt, arg...) \
45 v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
47 #define v4l_info(client, fmt, arg...) \
48 v4l_client_printk(KERN_INFO, client, fmt , ## arg)
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...) \
54 if (debug >= (level)) \
55 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
58 /* ------------------------------------------------------------------------- */
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)
64 #define v4l2_err(dev, fmt, arg...) \
65 v4l2_printk(KERN_ERR, dev, fmt , ## arg)
67 #define v4l2_warn(dev, fmt, arg...) \
68 v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
70 #define v4l2_info(dev, fmt, arg...) \
71 v4l2_printk(KERN_INFO, dev, fmt , ## arg)
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...) \
77 if (debug >= (level)) \
78 v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \
81 /* ------------------------------------------------------------------------- */
83 /* Priority helper functions */
85 struct v4l2_prio_state {
88 int 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 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
92 int 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);
96 /* ------------------------------------------------------------------------- */
98 /* Control helper functions */
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_fill_std(struct v4l2_queryctrl *qctrl);
106 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
107 struct v4l2_queryctrl *qctrl, const char **menu_items);
108 #define V4L2_CTRL_MENU_IDS_END (0xffffffff)
109 int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids);
111 /* Note: ctrl_classes points to an array of u32 pointers. Each u32 array is a
112 0-terminated array of control IDs. Each array must be sorted low to high
113 and belong to the same control class. The array of u32 pointers must also
114 be sorted, from low class IDs to high class IDs. */
115 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
117 /* ------------------------------------------------------------------------- */
119 /* Register/chip ident helper function */
121 struct i2c_client; /* forward reference */
122 int v4l2_chip_match_i2c_client(struct i2c_client *c, const struct v4l2_dbg_match *match);
123 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_dbg_chip_ident *chip,
124 u32 ident, u32 revision);
125 int v4l2_chip_match_host(const struct v4l2_dbg_match *match);
127 /* ------------------------------------------------------------------------- */
129 /* Helper function for I2C legacy drivers */
134 struct i2c_device_id;
137 struct v4l2_subdev_ops;
139 int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
141 int (*probe)(struct i2c_client *, const struct i2c_device_id *));
143 /* Load an i2c module and return an initialized v4l2_subdev struct.
144 Only call request_module if module_name != NULL.
145 The client_type argument is the name of the chip that's on the adapter. */
146 struct v4l2_subdev *v4l2_i2c_new_subdev(struct i2c_adapter *adapter,
147 const char *module_name, const char *client_type, u8 addr);
148 /* Probe and 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 struct v4l2_subdev *v4l2_i2c_new_probed_subdev(struct i2c_adapter *adapter,
152 const char *module_name, const char *client_type,
153 const unsigned short *addrs);
154 /* Initialize an v4l2_subdev with data from an i2c_client struct */
155 void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
156 const struct v4l2_subdev_ops *ops);
157 /* Return i2c client address of v4l2_subdev. */
158 unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
160 enum v4l2_i2c_tuner_type {
161 ADDRS_RADIO, /* Radio tuner addresses */
162 ADDRS_DEMOD, /* Demod tuner addresses */
163 ADDRS_TV, /* TV tuner addresses */
164 /* TV tuner addresses if demod is present, this excludes
165 addresses used by the demodulator from the list of
169 /* Return a list of I2C tuner addresses to probe. Use only if the tuner
170 addresses are unknown. */
171 const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
173 /* ------------------------------------------------------------------------- */
175 /* Internal ioctls */
177 /* VIDIOC_INT_DECODE_VBI_LINE */
178 struct v4l2_decode_vbi_line {
179 u32 is_second_field; /* Set to 0 for the first (odd) field,
180 set to 1 for the second (even) field. */
181 u8 *p; /* Pointer to the sliced VBI data from the decoder.
182 On exit points to the start of the payload. */
183 u32 line; /* Line number of the sliced VBI data (1-23) */
184 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
187 struct v4l2_priv_tun_config {
194 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
195 #define AUDC_SET_RADIO _IO('d',88)
199 /* Sets tuner type and its I2C addr */
200 #define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
202 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
203 by VIDIOC_INT_S_STANDBY. */
204 #define TUNER_SET_STANDBY _IOW('d', 91, int)
206 /* Sets tda9887 specific stuff, like port1, port2 and qss */
207 #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
209 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
210 #define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
212 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole
213 chip into standby mode, value 0 will make the chip fully active. Specific
214 bits can be used by certain chips to enable/disable specific subsystems.
215 Replacement of TUNER_SET_STANDBY. */
216 #define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
218 /* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
220 /* Generic reset command. The argument selects which subsystems to reset.
221 Passing 0 will always reset the whole chip. */
222 #define VIDIOC_INT_RESET _IOW ('d', 102, u32)
224 /* Set the frequency (in Hz) of the audio clock output.
225 Used to slave an audio processor to the video decoder, ensuring that audio
226 and video remain synchronized.
227 Usual values for the frequency are 48000, 44100 or 32000 Hz.
228 If the frequency is not supported, then -EINVAL is returned. */
229 #define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
231 /* Video decoders that support sliced VBI need to implement this ioctl.
232 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
233 data that was generated by the decoder. The driver then parses the sliced
234 VBI data and sets the other fields in the struct accordingly. The pointer p
235 is updated to point to the start of the payload which can be copied
236 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
237 valid VBI data was found, then the type field is set to 0 on return. */
238 #define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
240 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
241 filled with the data packets that should be output. Note that if you set
242 the line field to 0, then that VBI signal is disabled. If no
243 valid VBI data was found, then the type field is set to 0 on return. */
244 #define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
246 /* Used to obtain the sliced VBI packet from a readback register. Not all
247 video decoders support this. If no data is available because the readback
248 register contains invalid or erroneous data -EIO is returned. Note that
249 you must fill in the 'id' member and the 'field' member (to determine
250 whether CC data from the first or second field should be obtained). */
251 #define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
253 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
254 clock used by driving digital audio streams at some board designs.
255 Usual values for the frequency are 1024000 and 2048000.
256 If the frequency is not supported, then -EINVAL is returned. */
257 #define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
259 /* Routing definition, device dependent. It specifies which inputs (if any)
260 should be routed to which outputs (if any). */
261 struct v4l2_routing {
266 /* These internal commands should be used to define the inputs and outputs
267 of an audio/video chip. They will replace the v4l2 API commands
268 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
269 that are meant to be used by the user.
270 The internal commands should be used to switch inputs/outputs
271 because only the driver knows how to map a 'Television' input to the precise
272 input/output routing of an A/D converter, or a DSP, or a video digitizer.
273 These four commands should only be sent directly to an i2c device, they
274 should not be broadcast as the routing is very device specific. */
275 #define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
276 #define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
277 #define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
278 #define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
280 struct v4l2_crystal_freq {
281 u32 freq; /* frequency in Hz of the crystal */
282 u32 flags; /* device specific flags */
285 /* Sets the frequency of the crystal used to generate the clocks.
286 An extra flags field allows device specific configuration regarding
287 clock frequency dividers, etc. If not used, then set flags to 0.
288 If the frequency is not supported, then -EINVAL is returned. */
289 #define VIDIOC_INT_S_CRYSTAL_FREQ _IOW('d', 113, struct v4l2_crystal_freq)
291 /* Initialize the sensor registors to some sort of reasonable
293 #define VIDIOC_INT_INIT _IOW('d', 114, u32)
295 /* Set v4l2_std_id for video OUTPUT devices. This is ignored by
296 video input devices. */
297 #define VIDIOC_INT_S_STD_OUTPUT _IOW('d', 115, v4l2_std_id)
299 /* Get v4l2_std_id for video OUTPUT devices. This is ignored by
300 video input devices. */
301 #define VIDIOC_INT_G_STD_OUTPUT _IOW('d', 116, v4l2_std_id)
303 /* Set GPIO pins. Very simple right now, might need to be extended with
304 a v4l2_gpio struct if a direction is also needed. */
305 #define VIDIOC_INT_S_GPIO _IOW('d', 117, u32)
307 /* Get input status. Same as the status field in the v4l2_input struct. */
308 #define VIDIOC_INT_G_INPUT_STATUS _IOR('d', 118, u32)
310 #endif /* V4L2_COMMON_H_ */