]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - include/media/v4l2-common.h
V4L/DVB (6450): tda9887: add missing module license
[mirror_ubuntu-hirsute-kernel.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/* v4l debugging and diagnostics */
32
401998fa
MCC
33/* Debug bitmask flags to be used on V4L2 */
34#define V4L2_DEBUG_IOCTL 0x01
35#define V4L2_DEBUG_IOCTL_ARG 0x02
36
7e8b09ea
HV
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
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
cab462f7 43#define v4l_client_printk(level, client, fmt, arg...) \
7e8b09ea
HV
44 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'. */
f167cb4e 58#define v4l_dbg(level, debug, client, fmt, arg...) \
7e8b09ea
HV
59 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
9cb2318b
HV
84/* 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
f3d092b8
HV
97/* 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);
3434eb7e
HV
101int v4l2_chip_ident_i2c_client(struct i2c_client *c, struct v4l2_chip_ident *chip,
102 u32 ident, u32 revision);
f3d092b8
HV
103int v4l2_chip_match_host(u32 id_type, u32 chip_id);
104
105/* ------------------------------------------------------------------------- */
106
7e8b09ea
HV
107/* Internal ioctls */
108
b2f0648f
HV
109/* 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
7f171123
MCC
119struct v4l2_priv_tun_config {
120 int tuner;
121 void *priv;
122};
123
5e453dc7 124/* audio ioctls */
757d2505
HV
125
126/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
5e453dc7 127#define AUDC_SET_RADIO _IO('d',88)
757d2505 128
5e453dc7 129/* tuner ioctls */
757d2505 130
5e453dc7 131/* Sets tuner type and its I2C addr */
757d2505
HV
132#define TUNER_SET_TYPE_ADDR _IOW('d', 90, int)
133
134/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
135 by VIDIOC_INT_S_STANDBY. */
136#define TUNER_SET_STANDBY _IOW('d', 91, int)
137
5e453dc7 138/* Sets tda9887 specific stuff, like port1, port2 and qss */
7f171123 139#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505
HV
140
141/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
142#define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type)
143
144/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
145 chip into standby mode, value 0 will make the chip fully active. Specific
146 bits can be used by certain chips to enable/disable specific subsystems.
147 Replacement of TUNER_SET_STANDBY. */
148#define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32)
5e453dc7 149
52ebc763 150/* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */
b2f0648f 151
784e8fe4
HV
152/* Generic reset command. The argument selects which subsystems to reset.
153 Passing 0 will always reset the whole chip. */
154#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
b2f0648f 155
3578d3dd 156/* Set the frequency (in Hz) of the audio clock output.
b2f0648f 157 Used to slave an audio processor to the video decoder, ensuring that audio
3578d3dd
HV
158 and video remain synchronized.
159 Usual values for the frequency are 48000, 44100 or 32000 Hz.
160 If the frequency is not supported, then -EINVAL is returned. */
161#define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32)
b2f0648f
HV
162
163/* Video decoders that support sliced VBI need to implement this ioctl.
164 Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
165 data that was generated by the decoder. The driver then parses the sliced
166 VBI data and sets the other fields in the struct accordingly. The pointer p
167 is updated to point to the start of the payload which can be copied
168 verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
169 valid VBI data was found, then the type field is set to 0 on return. */
170#define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line)
171
172/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
173 filled with the data packets that should be output. Note that if you set
12db5607
MCC
174 the line field to 0, then that VBI signal is disabled. If no
175 valid VBI data was found, then the type field is set to 0 on return. */
b2f0648f
HV
176#define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data)
177
178/* Used to obtain the sliced VBI packet from a readback register. Not all
179 video decoders support this. If no data is available because the readback
180 register contains invalid or erroneous data -EIO is returned. Note that
181 you must fill in the 'id' member and the 'field' member (to determine
182 whether CC data from the first or second field should be obtained). */
41f38b43 183#define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data)
b2f0648f 184
9bb13a6d
MCC
185/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
186 clock used by driving digital audio streams at some board designs.
187 Usual values for the frequency are 1024000 and 2048000.
188 If the frequency is not supported, then -EINVAL is returned. */
189#define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32)
190
757d2505
HV
191/* Routing definition, device dependent. It specifies which inputs (if any)
192 should be routed to which outputs (if any). */
193struct v4l2_routing {
194 u32 input;
195 u32 output;
196};
197
198/* These internal commands should be used to define the inputs and outputs
8bf2f8e7
HV
199 of an audio/video chip. They will replace the v4l2 API commands
200 VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
201 that are meant to be used by the user.
202 The internal commands should be used to switch inputs/outputs
757d2505
HV
203 because only the driver knows how to map a 'Television' input to the precise
204 input/output routing of an A/D converter, or a DSP, or a video digitizer.
205 These four commands should only be sent directly to an i2c device, they
206 should not be broadcast as the routing is very device specific. */
207#define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing)
41f38b43 208#define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing)
757d2505 209#define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing)
41f38b43 210#define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing)
757d2505 211
b7f8292c
HV
212struct v4l2_crystal_freq {
213 u32 freq; /* frequency in Hz of the crystal */
214 u32 flags; /* device specific flags */
215};
216
217/* Sets the frequency of the crystal used to generate the clocks.
218 An extra flags field allows device specific configuration regarding
219 clock frequency dividers, etc. If not used, then set flags to 0.
220 If the frequency is not supported, then -EINVAL is returned. */
221#define VIDIOC_INT_S_CRYSTAL_FREQ _IOW ('d', 113, struct v4l2_crystal_freq)
222
9c4dfadb
JC
223/* Initialize the sensor registors to some sort of reasonable
224 default values. */
225#define VIDIOC_INT_INIT _IOW ('d', 114, u32)
226
045290b2
HV
227/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
228 video input devices. */
229#define VIDIOC_INT_S_STD_OUTPUT _IOW ('d', 115, v4l2_std_id)
230
231/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
232 video input devices. */
233#define VIDIOC_INT_G_STD_OUTPUT _IOW ('d', 116, v4l2_std_id)
234
b2f0648f 235#endif /* V4L2_COMMON_H_ */