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 /* v4l debugging and diagnostics */
33 /* Debug bitmask flags to be used on V4L2 */
34 #define V4L2_DEBUG_IOCTL 0x01
35 #define V4L2_DEBUG_IOCTL_ARG 0x02
37 /* Common printk constucts for v4l-i2c drivers. These macros create a unique
38 prefix consisting of the driver name, the adapter number and the i2c
40 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
41 printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
43 #define v4l_client_printk(level, client, fmt, arg...) \
44 v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
45 (client)->addr, fmt , ## arg)
47 #define v4l_err(client, fmt, arg...) \
48 v4l_client_printk(KERN_ERR, client, fmt , ## arg)
50 #define v4l_warn(client, fmt, arg...) \
51 v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
53 #define v4l_info(client, fmt, arg...) \
54 v4l_client_printk(KERN_INFO, client, fmt , ## arg)
56 /* These three macros assume that the debug level is set with a module
57 parameter called 'debug'. */
58 #define v4l_dbg(level, debug, client, fmt, arg...) \
60 if (debug >= (level)) \
61 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
65 /* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
66 #define v4l_print_ioctl(name, cmd) \
68 printk(KERN_DEBUG "%s: ", name); \
69 v4l_printk_ioctl(cmd); \
72 /* Use this macro in I2C drivers where 'client' is the struct i2c_client
74 #define v4l_i2c_print_ioctl(client, cmd) \
76 v4l_client_printk(KERN_DEBUG, client, ""); \
77 v4l_printk_ioctl(cmd); \
80 /* ------------------------------------------------------------------------- */
82 /* Priority helper functions */
84 struct v4l2_prio_state {
87 int v4l2_prio_init(struct v4l2_prio_state *global);
88 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
89 enum v4l2_priority new);
90 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
91 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
92 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
93 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
95 /* ------------------------------------------------------------------------- */
97 /* Control helper functions */
99 int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
100 const char **menu_items);
101 const char **v4l2_ctrl_get_menu(u32 id);
102 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
103 int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
104 int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
105 struct v4l2_queryctrl *qctrl, const char **menu_items);
106 u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
108 /* ------------------------------------------------------------------------- */
110 /* Register/chip ident helper function */
112 struct i2c_client; /* forward reference */
113 int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
114 int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
115 u32 ident, u32 revision);
116 int v4l2_chip_match_host(u32 id_type, u32 chip_id);
118 /* ------------------------------------------------------------------------- */
120 /* Helper function for I2C legacy drivers */
125 struct i2c_device_id;
127 int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
129 int (*probe)(struct i2c_client *, const struct i2c_device_id *));
131 /* ------------------------------------------------------------------------- */
133 /* Internal ioctls */
135 /* VIDIOC_INT_DECODE_VBI_LINE */
136 struct v4l2_decode_vbi_line {
137 u32 is_second_field; /* Set to 0 for the first (odd) field,
138 set to 1 for the second (even) field. */
139 u8 *p; /* Pointer to the sliced VBI data from the decoder.
140 On exit points to the start of the payload. */
141 u32 line; /* Line number of the sliced VBI data (1-23) */
142 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
145 struct v4l2_priv_tun_config {
152 /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
153 #define AUDC_SET_RADIO _IO('d',88)
157 /* Sets tuner type and its I2C addr */
158 #define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
160 /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
161 by VIDIOC_INT_S_STANDBY. */
162 #define TUNER_SET_STANDBY _IOW('d', 91, int)
164 /* Sets tda9887 specific stuff, like port1, port2 and qss */
165 #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
167 /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
168 #define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
170 /* Generic standby command. Passing -1 (all bits set to 1) will put the whole
171 chip into standby mode, value 0 will make the chip fully active. Specific
172 bits can be used by certain chips to enable/disable specific subsystems.
173 Replacement of TUNER_SET_STANDBY. */
174 #define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
176 /* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
178 /* Generic reset command. The argument selects which subsystems to reset.
179 Passing 0 will always reset the whole chip. */
180 #define VIDIOC_INT_RESET _IOW ('d', 102, u32)
182 /* Set the frequency (in Hz) of the audio clock output.
183 Used to slave an audio processor to the video decoder, ensuring that audio
184 and video remain synchronized.
185 Usual values for the frequency are 48000, 44100 or 32000 Hz.
186 If the frequency is not supported, then -EINVAL is returned. */
187 #define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
189 /* Video decoders that support sliced VBI need to implement this ioctl.
190 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
191 data that was generated by the decoder. The driver then parses the sliced
192 VBI data and sets the other fields in the struct accordingly. The pointer p
193 is updated to point to the start of the payload which can be copied
194 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
195 valid VBI data was found, then the type field is set to 0 on return. */
196 #define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
198 /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
199 filled with the data packets that should be output. Note that if you set
200 the line field to 0, then that VBI signal is disabled. If no
201 valid VBI data was found, then the type field is set to 0 on return. */
202 #define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
204 /* Used to obtain the sliced VBI packet from a readback register. Not all
205 video decoders support this. If no data is available because the readback
206 register contains invalid or erroneous data -EIO is returned. Note that
207 you must fill in the 'id' member and the 'field' member (to determine
208 whether CC data from the first or second field should be obtained). */
209 #define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
211 /* Sets I2S speed in bps. This is used to provide a standard way to select I2S
212 clock used by driving digital audio streams at some board designs.
213 Usual values for the frequency are 1024000 and 2048000.
214 If the frequency is not supported, then -EINVAL is returned. */
215 #define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
217 /* Routing definition, device dependent. It specifies which inputs (if any)
218 should be routed to which outputs (if any). */
219 struct v4l2_routing {
224 /* These internal commands should be used to define the inputs and outputs
225 of an audio/video chip. They will replace the v4l2 API commands
226 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
227 that are meant to be used by the user.
228 The internal commands should be used to switch inputs/outputs
229 because only the driver knows how to map a 'Television' input to the precise
230 input/output routing of an A/D converter, or a DSP, or a video digitizer.
231 These four commands should only be sent directly to an i2c device, they
232 should not be broadcast as the routing is very device specific. */
233 #define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
234 #define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
235 #define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
236 #define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
238 struct v4l2_crystal_freq {
239 u32 freq; /* frequency in Hz of the crystal */
240 u32 flags; /* device specific flags */
243 /* Sets the frequency of the crystal used to generate the clocks.
244 An extra flags field allows device specific configuration regarding
245 clock frequency dividers, etc. If not used, then set flags to 0.
246 If the frequency is not supported, then -EINVAL is returned. */
247 #define VIDIOC_INT_S_CRYSTAL_FREQ _IOW ('d', 113, struct v4l2_crystal_freq)
249 /* Initialize the sensor registors to some sort of reasonable
251 #define VIDIOC_INT_INIT _IOW ('d', 114, u32)
253 /* Set v4l2_std_id for video OUTPUT devices. This is ignored by
254 video input devices. */
255 #define VIDIOC_INT_S_STD_OUTPUT _IOW ('d', 115, v4l2_std_id)
257 /* Get v4l2_std_id for video OUTPUT devices. This is ignored by
258 video input devices. */
259 #define VIDIOC_INT_G_STD_OUTPUT _IOW ('d', 116, v4l2_std_id)
261 #endif /* V4L2_COMMON_H_ */