blob: 181a40c46a52d866f5c1d3cb83cdbfeeea0387c1 [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/* v4l debugging and diagnostics */
32
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030033/* Debug bitmask flags to be used on V4L2 */
34#define V4L2_DEBUG_IOCTL 0x01
35#define V4L2_DEBUG_IOCTL_ARG 0x02
36
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020037/* 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
39 address. */
40#define v4l_printk(level, name, adapter, addr, fmt, arg...) \
41 printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
42
Mauro Carvalho Chehabcab462f2006-01-09 15:53:26 -020043#define v4l_client_printk(level, client, fmt, arg...) \
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020044 v4l_printk(level, (client)->driver->driver.name, (client)->adapter, \
45 (client)->addr, fmt , ## arg)
46
47#define v4l_err(client, fmt, arg...) \
48 v4l_client_printk(KERN_ERR, client, fmt , ## arg)
49
50#define v4l_warn(client, fmt, arg...) \
51 v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
52
53#define v4l_info(client, fmt, arg...) \
54 v4l_client_printk(KERN_INFO, client, fmt , ## arg)
55
56/* These three macros assume that the debug level is set with a module
57 parameter called 'debug'. */
Mauro Carvalho Chehabf167cb42006-01-11 19:41:49 -020058#define v4l_dbg(level, debug, client, fmt, arg...) \
Hans Verkuil7e8b09e2006-01-09 15:32:40 -020059 do { \
60 if (debug >= (level)) \
61 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
62 } while (0)
63
64/* Prints the ioctl in a human-readable format */
65extern void v4l_printk_ioctl(unsigned int cmd);
66
67/* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
68#define v4l_print_ioctl(name, cmd) \
69 do { \
70 printk(KERN_DEBUG "%s: ", name); \
71 v4l_printk_ioctl(cmd); \
72 } while (0)
73
74/* Use this macro in I2C drivers where 'client' is the struct i2c_client
75 pointer */
76#define v4l_i2c_print_ioctl(client, cmd) \
77 do { \
78 v4l_client_printk(KERN_DEBUG, client, ""); \
79 v4l_printk_ioctl(cmd); \
80 } while (0)
81
82/* ------------------------------------------------------------------------- */
83
Hans Verkuil9cb23182006-06-18 14:11:08 -030084/* Control helper functions */
85
86int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl,
87 const char **menu_items);
88const char **v4l2_ctrl_get_menu(u32 id);
89int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def);
90int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl);
91int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu,
92 struct v4l2_queryctrl *qctrl, const char **menu_items);
93u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id);
94
95/* ------------------------------------------------------------------------- */
96
Hans Verkuilf3d092b2007-02-23 20:55:14 -030097/* Register/chip ident helper function */
98
99struct i2c_client; /* forward reference */
100int v4l2_chip_match_i2c_client(struct i2c_client *c, u32 id_type, u32 chip_id);
Hans Verkuil3434eb72007-04-27 12:31:08 -0300101int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
102 u32 ident, u32 revision);
Hans Verkuilf3d092b2007-02-23 20:55:14 -0300103int v4l2_chip_match_host(u32 id_type, u32 chip_id);
104
105/* ------------------------------------------------------------------------- */
106
Hans Verkuil7e8b09e2006-01-09 15:32:40 -0200107/* Internal ioctls */
108
Hans Verkuilb2f06482005-11-13 16:07:55 -0800109/* VIDIOC_INT_DECODE_VBI_LINE */
110struct v4l2_decode_vbi_line {
111 u32 is_second_field; /* Set to 0 for the first (odd) field,
112 set to 1 for the second (even) field. */
113 u8 *p; /* Pointer to the sliced VBI data from the decoder.
114 On exit points to the start of the payload. */
115 u32 line; /* Line number of the sliced VBI data (1-23) */
116 u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */
117};
118
Michael Krufky5e453dc2006-01-09 15:32:31 -0200119/* audio ioctls */
Hans Verkuil757d2502006-01-23 17:11:10 -0200120
121/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
Michael Krufky5e453dc2006-01-09 15:32:31 -0200122#define AUDC_SET_RADIO _IO('d',88)
Hans Verkuil757d2502006-01-23 17:11:10 -0200123
Michael Krufky5e453dc2006-01-09 15:32:31 -0200124/* tuner ioctls */
Hans Verkuil757d2502006-01-23 17:11:10 -0200125
Michael Krufky5e453dc2006-01-09 15:32:31 -0200126/* Sets tuner type and its I2C addr */
Hans Verkuil757d2502006-01-23 17:11:10 -0200127#define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
128
129/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
130 by VIDIOC_INT_S_STANDBY. */
131#define TUNER_SET_STANDBY _IOW('d', 91, int)
132
Michael Krufky5e453dc2006-01-09 15:32:31 -0200133/* Sets tda9887 specific stuff, like port1, port2 and qss */
Hans Verkuil757d2502006-01-23 17:11:10 -0200134#define TDA9887_SET_CONFIG _IOW('d', 92, int)
135
136/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
137#define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
138
139/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
140 chip into standby mode, value 0 will make the chip fully active. Specific
141 bits can be used by certain chips to enable/disable specific subsystems.
142 Replacement of TUNER_SET_STANDBY. */
143#define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
Michael Krufky5e453dc2006-01-09 15:32:31 -0200144
Trent Piepho52ebc762007-01-23 22:38:13 -0300145/* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
Hans Verkuilb2f06482005-11-13 16:07:55 -0800146
Hans Verkuil784e8fe42006-08-26 03:17:58 -0300147/* Generic reset command. The argument selects which subsystems to reset.
148 Passing 0 will always reset the whole chip. */
149#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
Hans Verkuilb2f06482005-11-13 16:07:55 -0800150
Hans Verkuil3578d3d2006-01-09 15:25:41 -0200151/* Set the frequency (in Hz) of the audio clock output.
Hans Verkuilb2f06482005-11-13 16:07:55 -0800152 Used to slave an audio processor to the video decoder, ensuring that audio
Hans Verkuil3578d3d2006-01-09 15:25:41 -0200153 and video remain synchronized.
154 Usual values for the frequency are 48000, 44100 or 32000 Hz.
155 If the frequency is not supported, then -EINVAL is returned. */
156#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
Hans Verkuilb2f06482005-11-13 16:07:55 -0800157
158/* Video decoders that support sliced VBI need to implement this ioctl.
159 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
160 data that was generated by the decoder. The driver then parses the sliced
161 VBI data and sets the other fields in the struct accordingly. The pointer p
162 is updated to point to the start of the payload which can be copied
163 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
164 valid VBI data was found, then the type field is set to 0 on return. */
165#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
166
167/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
168 filled with the data packets that should be output. Note that if you set
Mauro Carvalho Chehab12db5602006-01-23 17:11:08 -0200169 the line field to 0, then that VBI signal is disabled. If no
170 valid VBI data was found, then the type field is set to 0 on return. */
Hans Verkuilb2f06482005-11-13 16:07:55 -0800171#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
172
173/* Used to obtain the sliced VBI packet from a readback register. Not all
174 video decoders support this. If no data is available because the readback
175 register contains invalid or erroneous data -EIO is returned. Note that
176 you must fill in the 'id' member and the 'field' member (to determine
177 whether CC data from the first or second field should be obtained). */
Mauro Carvalho Chehab41f38b42006-02-27 00:08:49 -0300178#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
Hans Verkuilb2f06482005-11-13 16:07:55 -0800179
Mauro Carvalho Chehab9bb13a62006-01-09 15:25:37 -0200180/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
181 clock used by driving digital audio streams at some board designs.
182 Usual values for the frequency are 1024000 and 2048000.
183 If the frequency is not supported, then -EINVAL is returned. */
184#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
185
Hans Verkuil757d2502006-01-23 17:11:10 -0200186/* Routing definition, device dependent. It specifies which inputs (if any)
187 should be routed to which outputs (if any). */
188struct v4l2_routing {
189 u32 input;
190 u32 output;
191};
192
193/* These internal commands should be used to define the inputs and outputs
Hans Verkuil8bf2f8e2006-03-18 21:31:00 -0300194 of an audio/video chip. They will replace the v4l2 API commands
195 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
196 that are meant to be used by the user.
197 The internal commands should be used to switch inputs/outputs
Hans Verkuil757d2502006-01-23 17:11:10 -0200198 because only the driver knows how to map a 'Television' input to the precise
199 input/output routing of an A/D converter, or a DSP, or a video digitizer.
200 These four commands should only be sent directly to an i2c device, they
201 should not be broadcast as the routing is very device specific. */
202#define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
Mauro Carvalho Chehab41f38b42006-02-27 00:08:49 -0300203#define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
Hans Verkuil757d2502006-01-23 17:11:10 -0200204#define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
Mauro Carvalho Chehab41f38b42006-02-27 00:08:49 -0300205#define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
Hans Verkuil757d2502006-01-23 17:11:10 -0200206
Hans Verkuilb7f82922006-04-02 12:50:42 -0300207struct v4l2_crystal_freq {
208 u32 freq; /* frequency in Hz of the crystal */
209 u32 flags; /* device specific flags */
210};
211
212/* Sets the frequency of the crystal used to generate the clocks.
213 An extra flags field allows device specific configuration regarding
214 clock frequency dividers, etc. If not used, then set flags to 0.
215 If the frequency is not supported, then -EINVAL is returned. */
216#define VIDIOC_INT_S_CRYSTAL_FREQ _IOW ('d', 113, struct v4l2_crystal_freq)
217
Jonathan Corbet9c4dfad2006-11-04 09:22:27 -0300218/* Initialize the sensor registors to some sort of reasonable
219 default values. */
220#define VIDIOC_INT_INIT _IOW ('d', 114, u32)
221
Hans Verkuil045290b2007-04-27 12:31:04 -0300222/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
223 video input devices. */
224#define VIDIOC_INT_S_STD_OUTPUT _IOW ('d', 115, v4l2_std_id)
225
226/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
227 video input devices. */
228#define VIDIOC_INT_G_STD_OUTPUT _IOW ('d', 116, v4l2_std_id)
229
Hans Verkuilb2f06482005-11-13 16:07:55 -0800230#endif /* V4L2_COMMON_H_ */