V4L/DVB (10687): v4l2-common/v4l2-spec: support/document write-only and button controls
[linux-2.6-block.git] / include / media / v4l2-common.h
CommitLineData
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>
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/* ------------------------------------------------------------------------- */
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
35ea11ff
HV
83/* 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
9cb2318b
HV
98/* Control helper functions */
99
100int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
101 const char **menu_items);
69028d70 102const char *v4l2_ctrl_get_name(u32 id);
9cb2318b
HV
103const char **v4l2_ctrl_get_menu(u32 id);
104int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
105int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
106int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
107 struct v4l2_queryctrl *qctrl, const char **menu_items);
1e551266
HV
108#define V4L2_CTRL_MENU_IDS_END (0xffffffff)
109int v4l2_ctrl_query_menu_valid_items(struct v4l2_querymenu *qmenu, const u32 *ids);
2ba58894
HV
110
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. */
9cb2318b
HV
115u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
116
117/* ------------------------------------------------------------------------- */
118
f3d092b8
HV
119/* Register/chip ident helper function */
120
121struct i2c_client; /* forward reference */
aecde8b5
HV
122int v4l2_chip_match_i2c_client(struct i2c_client *c, const struct v4l2_dbg_match *match);
123int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_dbg_chip_ident *chip,
3434eb7e 124 u32 ident, u32 revision);
aecde8b5 125int v4l2_chip_match_host(const struct v4l2_dbg_match *match);
f3d092b8
HV
126
127/* ------------------------------------------------------------------------- */
128
8ffbc655
HV
129/* Helper function for I2C legacy drivers */
130
131struct i2c_driver;
132struct i2c_adapter;
133struct i2c_client;
d2653e92 134struct i2c_device_id;
dd99120c
HV
135struct v4l2_device;
136struct v4l2_subdev;
137struct v4l2_subdev_ops;
8ffbc655
HV
138
139int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
d2653e92
JD
140 const char *name,
141 int (*probe)(struct i2c_client *, const struct i2c_device_id *));
8ffbc655 142
dd99120c
HV
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. */
146struct 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. */
151struct 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 */
155void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
156 const struct v4l2_subdev_ops *ops);
157
c7d29e2f
HV
158enum v4l2_i2c_tuner_type {
159 ADDRS_RADIO, /* Radio tuner addresses */
160 ADDRS_DEMOD, /* Demod tuner addresses */
161 ADDRS_TV, /* TV tuner addresses */
162 /* TV tuner addresses if demod is present, this excludes
163 addresses used by the demodulator from the list of
164 candidates. */
165 ADDRS_TV_WITH_DEMOD,
166};
167/* Return a list of I2C tuner addresses to probe. Use only if the tuner
168 addresses are unknown. */
169const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
170
8ffbc655
HV
171/* ------------------------------------------------------------------------- */
172
7e8b09ea
HV
173/* Internal ioctls */
174
b2f0648f
HV
175/* VIDIOC_INT_DECODE_VBI_LINE */
176struct v4l2_decode_vbi_line {
177 u32 is_second_field; /* Set to 0 for the first (odd) field,
178 set to 1 for the second (even) field. */
179 u8 *p; /* Pointer to the sliced VBI data from the decoder.
180 On exit points to the start of the payload. */
181 u32 line; /* Line number of the sliced VBI data (1-23) */
182 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
183};
184
7f171123
MCC
185struct v4l2_priv_tun_config {
186 int tuner;
187 void *priv;
188};
189
5e453dc7 190/* audio ioctls */
757d2505
HV
191
192/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
5e453dc7 193#define AUDC_SET_RADIO _IO('d',88)
757d2505 194
5e453dc7 195/* tuner ioctls */
757d2505 196
5e453dc7 197/* Sets tuner type and its I2C addr */
757d2505
HV
198#define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
199
200/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
201 by VIDIOC_INT_S_STANDBY. */
202#define TUNER_SET_STANDBY _IOW('d', 91, int)
203
5e453dc7 204/* Sets tda9887 specific stuff, like port1, port2 and qss */
7f171123 205#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505
HV
206
207/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
208#define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
209
210/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
211 chip into standby mode, value 0 will make the chip fully active. Specific
212 bits can be used by certain chips to enable/disable specific subsystems.
213 Replacement of TUNER_SET_STANDBY. */
214#define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
5e453dc7 215
52ebc763 216/* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
b2f0648f 217
784e8fe4
HV
218/* Generic reset command. The argument selects which subsystems to reset.
219 Passing 0 will always reset the whole chip. */
220#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
b2f0648f 221
3578d3dd 222/* Set the frequency (in Hz) of the audio clock output.
b2f0648f 223 Used to slave an audio processor to the video decoder, ensuring that audio
3578d3dd
HV
224 and video remain synchronized.
225 Usual values for the frequency are 48000, 44100 or 32000 Hz.
226 If the frequency is not supported, then -EINVAL is returned. */
227#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
b2f0648f
HV
228
229/* Video decoders that support sliced VBI need to implement this ioctl.
230 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
231 data that was generated by the decoder. The driver then parses the sliced
232 VBI data and sets the other fields in the struct accordingly. The pointer p
233 is updated to point to the start of the payload which can be copied
234 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
235 valid VBI data was found, then the type field is set to 0 on return. */
236#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
237
238/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
239 filled with the data packets that should be output. Note that if you set
12db5607
MCC
240 the line field to 0, then that VBI signal is disabled. If no
241 valid VBI data was found, then the type field is set to 0 on return. */
b2f0648f
HV
242#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
243
244/* Used to obtain the sliced VBI packet from a readback register. Not all
245 video decoders support this. If no data is available because the readback
246 register contains invalid or erroneous data -EIO is returned. Note that
247 you must fill in the 'id' member and the 'field' member (to determine
248 whether CC data from the first or second field should be obtained). */
41f38b43 249#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
b2f0648f 250
9bb13a6d
MCC
251/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
252 clock used by driving digital audio streams at some board designs.
253 Usual values for the frequency are 1024000 and 2048000.
254 If the frequency is not supported, then -EINVAL is returned. */
255#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
256
757d2505
HV
257/* Routing definition, device dependent. It specifies which inputs (if any)
258 should be routed to which outputs (if any). */
259struct v4l2_routing {
260 u32 input;
261 u32 output;
262};
263
264/* These internal commands should be used to define the inputs and outputs
8bf2f8e7
HV
265 of an audio/video chip. They will replace the v4l2 API commands
266 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
267 that are meant to be used by the user.
268 The internal commands should be used to switch inputs/outputs
757d2505
HV
269 because only the driver knows how to map a 'Television' input to the precise
270 input/output routing of an A/D converter, or a DSP, or a video digitizer.
271 These four commands should only be sent directly to an i2c device, they
272 should not be broadcast as the routing is very device specific. */
273#define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
41f38b43 274#define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
757d2505 275#define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
41f38b43 276#define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
757d2505 277
b7f8292c
HV
278struct v4l2_crystal_freq {
279 u32 freq; /* frequency in Hz of the crystal */
280 u32 flags; /* device specific flags */
281};
282
283/* Sets the frequency of the crystal used to generate the clocks.
284 An extra flags field allows device specific configuration regarding
285 clock frequency dividers, etc. If not used, then set flags to 0.
286 If the frequency is not supported, then -EINVAL is returned. */
6bd6dff6 287#define VIDIOC_INT_S_CRYSTAL_FREQ _IOW('d', 113, struct v4l2_crystal_freq)
b7f8292c 288
9c4dfadb
JC
289/* Initialize the sensor registors to some sort of reasonable
290 default values. */
6bd6dff6 291#define VIDIOC_INT_INIT _IOW('d', 114, u32)
9c4dfadb 292
045290b2
HV
293/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
294 video input devices. */
6bd6dff6 295#define VIDIOC_INT_S_STD_OUTPUT _IOW('d', 115, v4l2_std_id)
045290b2
HV
296
297/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
298 video input devices. */
6bd6dff6
HV
299#define VIDIOC_INT_G_STD_OUTPUT _IOW('d', 116, v4l2_std_id)
300
301/* Set GPIO pins. Very simple right now, might need to be extended with
302 a v4l2_gpio struct if a direction is also needed. */
303#define VIDIOC_INT_S_GPIO _IOW('d', 117, u32)
045290b2 304
1b6f1d96
HV
305/* Get input status. Same as the status field in the v4l2_input struct. */
306#define VIDIOC_INT_G_INPUT_STATUS _IOR('d', 118, u32)
307
b2f0648f 308#endif /* V4L2_COMMON_H_ */