Commit | Line | Data |
---|---|---|
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 */ | |
65 | extern 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 | ||
86 | int v4l2_ctrl_check(struct v4l2_ext_control *ctrl, struct v4l2_queryctrl *qctrl, | |
87 | const char **menu_items); | |
88 | const char **v4l2_ctrl_get_menu(u32 id); | |
89 | int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, s32 min, s32 max, s32 step, s32 def); | |
90 | int v4l2_ctrl_query_fill_std(struct v4l2_queryctrl *qctrl); | |
91 | int v4l2_ctrl_query_menu(struct v4l2_querymenu *qmenu, | |
92 | struct v4l2_queryctrl *qctrl, const char **menu_items); | |
93 | u32 v4l2_ctrl_next(const u32 * const *ctrl_classes, u32 id); | |
94 | ||
95 | /* ------------------------------------------------------------------------- */ | |
96 | ||
7e8b09ea HV |
97 | /* Internal ioctls */ |
98 | ||
b2f0648f HV |
99 | /* VIDIOC_INT_DECODE_VBI_LINE */ |
100 | struct v4l2_decode_vbi_line { | |
101 | u32 is_second_field; /* Set to 0 for the first (odd) field, | |
102 | set to 1 for the second (even) field. */ | |
103 | u8 *p; /* Pointer to the sliced VBI data from the decoder. | |
104 | On exit points to the start of the payload. */ | |
105 | u32 line; /* Line number of the sliced VBI data (1-23) */ | |
106 | u32 type; /* VBI service type (V4L2_SLICED_*). 0 if no service found */ | |
107 | }; | |
108 | ||
109 | /* VIDIOC_INT_G_CHIP_IDENT: identifies the actual chip installed on the board */ | |
110 | enum v4l2_chip_ident { | |
111 | /* general idents: reserved range 0-49 */ | |
112 | V4L2_IDENT_UNKNOWN = 0, | |
113 | ||
89f75ffc MCC |
114 | /* module saa7110: just ident= 100 */ |
115 | V4L2_IDENT_SAA7110 = 100, | |
116 | ||
117 | /* module saa7111: just ident= 101 */ | |
118 | V4L2_IDENT_SAA7111 = 101, | |
119 | ||
120 | /* module saa7115: reserved range 102-149 */ | |
f5762e44 | 121 | V4L2_IDENT_SAA7113 = 103, |
b2f0648f HV |
122 | V4L2_IDENT_SAA7114 = 104, |
123 | V4L2_IDENT_SAA7115 = 105, | |
89f75ffc | 124 | V4L2_IDENT_SAA7118 = 108, |
b2f0648f HV |
125 | |
126 | /* module saa7127: reserved range 150-199 */ | |
127 | V4L2_IDENT_SAA7127 = 157, | |
128 | V4L2_IDENT_SAA7129 = 159, | |
129 | ||
130 | /* module cx25840: reserved range 200-249 */ | |
e2b8cf4c HV |
131 | V4L2_IDENT_CX25836 = 236, |
132 | V4L2_IDENT_CX25837 = 237, | |
b2f0648f HV |
133 | V4L2_IDENT_CX25840 = 240, |
134 | V4L2_IDENT_CX25841 = 241, | |
135 | V4L2_IDENT_CX25842 = 242, | |
136 | V4L2_IDENT_CX25843 = 243, | |
111f3356 JC |
137 | |
138 | /* OmniVision sensors - range 250-299 */ | |
139 | V4L2_IDENT_OV7670 = 250, | |
b2f0648f HV |
140 | }; |
141 | ||
5e453dc7 | 142 | /* audio ioctls */ |
757d2505 HV |
143 | |
144 | /* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */ | |
5e453dc7 | 145 | #define AUDC_SET_RADIO _IO('d',88) |
757d2505 | 146 | |
5e453dc7 | 147 | /* tuner ioctls */ |
757d2505 | 148 | |
5e453dc7 | 149 | /* Sets tuner type and its I2C addr */ |
757d2505 HV |
150 | #define TUNER_SET_TYPE_ADDR _IOW('d', 90, int) |
151 | ||
152 | /* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced | |
153 | by VIDIOC_INT_S_STANDBY. */ | |
154 | #define TUNER_SET_STANDBY _IOW('d', 91, int) | |
155 | ||
5e453dc7 | 156 | /* Sets tda9887 specific stuff, like port1, port2 and qss */ |
757d2505 HV |
157 | #define TDA9887_SET_CONFIG _IOW('d', 92, int) |
158 | ||
159 | /* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */ | |
160 | #define VIDIOC_INT_S_TUNER_MODE _IOW('d', 93, enum v4l2_tuner_type) | |
161 | ||
162 | /* Generic standby command. Passing -1 (all bits set to 1) will put the whole | |
163 | chip into standby mode, value 0 will make the chip fully active. Specific | |
164 | bits can be used by certain chips to enable/disable specific subsystems. | |
165 | Replacement of TUNER_SET_STANDBY. */ | |
166 | #define VIDIOC_INT_S_STANDBY _IOW('d', 94, u32) | |
5e453dc7 | 167 | |
52ebc763 | 168 | /* 100, 101 used by VIDIOC_DBG_[SG]_REGISTER */ |
b2f0648f | 169 | |
784e8fe4 HV |
170 | /* Generic reset command. The argument selects which subsystems to reset. |
171 | Passing 0 will always reset the whole chip. */ | |
172 | #define VIDIOC_INT_RESET _IOW ('d', 102, u32) | |
b2f0648f | 173 | |
3578d3dd | 174 | /* Set the frequency (in Hz) of the audio clock output. |
b2f0648f | 175 | Used to slave an audio processor to the video decoder, ensuring that audio |
3578d3dd HV |
176 | and video remain synchronized. |
177 | Usual values for the frequency are 48000, 44100 or 32000 Hz. | |
178 | If the frequency is not supported, then -EINVAL is returned. */ | |
179 | #define VIDIOC_INT_AUDIO_CLOCK_FREQ _IOW ('d', 103, u32) | |
b2f0648f HV |
180 | |
181 | /* Video decoders that support sliced VBI need to implement this ioctl. | |
182 | Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI | |
183 | data that was generated by the decoder. The driver then parses the sliced | |
184 | VBI data and sets the other fields in the struct accordingly. The pointer p | |
185 | is updated to point to the start of the payload which can be copied | |
186 | verbatim into the data field of the v4l2_sliced_vbi_data struct. If no | |
187 | valid VBI data was found, then the type field is set to 0 on return. */ | |
188 | #define VIDIOC_INT_DECODE_VBI_LINE _IOWR('d', 104, struct v4l2_decode_vbi_line) | |
189 | ||
190 | /* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is | |
191 | filled with the data packets that should be output. Note that if you set | |
12db5607 MCC |
192 | the line field to 0, then that VBI signal is disabled. If no |
193 | valid VBI data was found, then the type field is set to 0 on return. */ | |
b2f0648f HV |
194 | #define VIDIOC_INT_S_VBI_DATA _IOW ('d', 105, struct v4l2_sliced_vbi_data) |
195 | ||
196 | /* Used to obtain the sliced VBI packet from a readback register. Not all | |
197 | video decoders support this. If no data is available because the readback | |
198 | register contains invalid or erroneous data -EIO is returned. Note that | |
199 | you must fill in the 'id' member and the 'field' member (to determine | |
200 | whether CC data from the first or second field should be obtained). */ | |
41f38b43 | 201 | #define VIDIOC_INT_G_VBI_DATA _IOWR('d', 106, struct v4l2_sliced_vbi_data) |
b2f0648f HV |
202 | |
203 | /* Returns the chip identifier or V4L2_IDENT_UNKNOWN if no identification can | |
204 | be made. */ | |
41f38b43 | 205 | #define VIDIOC_INT_G_CHIP_IDENT _IOR ('d', 107, enum v4l2_chip_ident) |
b2f0648f | 206 | |
9bb13a6d MCC |
207 | /* Sets I2S speed in bps. This is used to provide a standard way to select I2S |
208 | clock used by driving digital audio streams at some board designs. | |
209 | Usual values for the frequency are 1024000 and 2048000. | |
210 | If the frequency is not supported, then -EINVAL is returned. */ | |
211 | #define VIDIOC_INT_I2S_CLOCK_FREQ _IOW ('d', 108, u32) | |
212 | ||
757d2505 HV |
213 | /* Routing definition, device dependent. It specifies which inputs (if any) |
214 | should be routed to which outputs (if any). */ | |
215 | struct v4l2_routing { | |
216 | u32 input; | |
217 | u32 output; | |
218 | }; | |
219 | ||
220 | /* These internal commands should be used to define the inputs and outputs | |
8bf2f8e7 HV |
221 | of an audio/video chip. They will replace the v4l2 API commands |
222 | VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT | |
223 | that are meant to be used by the user. | |
224 | The internal commands should be used to switch inputs/outputs | |
757d2505 HV |
225 | because only the driver knows how to map a 'Television' input to the precise |
226 | input/output routing of an A/D converter, or a DSP, or a video digitizer. | |
227 | These four commands should only be sent directly to an i2c device, they | |
228 | should not be broadcast as the routing is very device specific. */ | |
229 | #define VIDIOC_INT_S_AUDIO_ROUTING _IOW ('d', 109, struct v4l2_routing) | |
41f38b43 | 230 | #define VIDIOC_INT_G_AUDIO_ROUTING _IOR ('d', 110, struct v4l2_routing) |
757d2505 | 231 | #define VIDIOC_INT_S_VIDEO_ROUTING _IOW ('d', 111, struct v4l2_routing) |
41f38b43 | 232 | #define VIDIOC_INT_G_VIDEO_ROUTING _IOR ('d', 112, struct v4l2_routing) |
757d2505 | 233 | |
b7f8292c HV |
234 | struct v4l2_crystal_freq { |
235 | u32 freq; /* frequency in Hz of the crystal */ | |
236 | u32 flags; /* device specific flags */ | |
237 | }; | |
238 | ||
239 | /* Sets the frequency of the crystal used to generate the clocks. | |
240 | An extra flags field allows device specific configuration regarding | |
241 | clock frequency dividers, etc. If not used, then set flags to 0. | |
242 | If the frequency is not supported, then -EINVAL is returned. */ | |
243 | #define VIDIOC_INT_S_CRYSTAL_FREQ _IOW ('d', 113, struct v4l2_crystal_freq) | |
244 | ||
9c4dfadb JC |
245 | /* Initialize the sensor registors to some sort of reasonable |
246 | default values. */ | |
247 | #define VIDIOC_INT_INIT _IOW ('d', 114, u32) | |
248 | ||
b2f0648f | 249 | #endif /* V4L2_COMMON_H_ */ |