]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/media/v4l2-ioctl.h
Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris/linux...
[mirror_ubuntu-artful-kernel.git] / include / media / v4l2-ioctl.h
1 /*
2 *
3 * V 4 L 2 D R I V E R H E L P E R A P I
4 *
5 * Moved from videodev2.h
6 *
7 * Some commonly needed functions for drivers (v4l2-common.o module)
8 */
9 #ifndef _V4L2_IOCTL_H
10 #define _V4L2_IOCTL_H
11
12 #include <linux/poll.h>
13 #include <linux/fs.h>
14 #include <linux/mutex.h>
15 #include <linux/compiler.h> /* need __user */
16 #include <linux/videodev2.h>
17
18 struct v4l2_fh;
19
20 struct v4l2_ioctl_ops {
21 /* ioctl callbacks */
22
23 /* VIDIOC_QUERYCAP handler */
24 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
25
26 /* Priority handling */
27 int (*vidioc_g_priority) (struct file *file, void *fh,
28 enum v4l2_priority *p);
29 int (*vidioc_s_priority) (struct file *file, void *fh,
30 enum v4l2_priority p);
31
32 /* VIDIOC_ENUM_FMT handlers */
33 int (*vidioc_enum_fmt_vid_cap) (struct file *file, void *fh,
34 struct v4l2_fmtdesc *f);
35 int (*vidioc_enum_fmt_vid_overlay) (struct file *file, void *fh,
36 struct v4l2_fmtdesc *f);
37 int (*vidioc_enum_fmt_vid_out) (struct file *file, void *fh,
38 struct v4l2_fmtdesc *f);
39 int (*vidioc_enum_fmt_vid_cap_mplane)(struct file *file, void *fh,
40 struct v4l2_fmtdesc *f);
41 int (*vidioc_enum_fmt_vid_out_mplane)(struct file *file, void *fh,
42 struct v4l2_fmtdesc *f);
43 int (*vidioc_enum_fmt_sdr_cap) (struct file *file, void *fh,
44 struct v4l2_fmtdesc *f);
45
46 /* VIDIOC_G_FMT handlers */
47 int (*vidioc_g_fmt_vid_cap) (struct file *file, void *fh,
48 struct v4l2_format *f);
49 int (*vidioc_g_fmt_vid_overlay)(struct file *file, void *fh,
50 struct v4l2_format *f);
51 int (*vidioc_g_fmt_vid_out) (struct file *file, void *fh,
52 struct v4l2_format *f);
53 int (*vidioc_g_fmt_vid_out_overlay)(struct file *file, void *fh,
54 struct v4l2_format *f);
55 int (*vidioc_g_fmt_vbi_cap) (struct file *file, void *fh,
56 struct v4l2_format *f);
57 int (*vidioc_g_fmt_vbi_out) (struct file *file, void *fh,
58 struct v4l2_format *f);
59 int (*vidioc_g_fmt_sliced_vbi_cap)(struct file *file, void *fh,
60 struct v4l2_format *f);
61 int (*vidioc_g_fmt_sliced_vbi_out)(struct file *file, void *fh,
62 struct v4l2_format *f);
63 int (*vidioc_g_fmt_vid_cap_mplane)(struct file *file, void *fh,
64 struct v4l2_format *f);
65 int (*vidioc_g_fmt_vid_out_mplane)(struct file *file, void *fh,
66 struct v4l2_format *f);
67 int (*vidioc_g_fmt_sdr_cap) (struct file *file, void *fh,
68 struct v4l2_format *f);
69
70 /* VIDIOC_S_FMT handlers */
71 int (*vidioc_s_fmt_vid_cap) (struct file *file, void *fh,
72 struct v4l2_format *f);
73 int (*vidioc_s_fmt_vid_overlay)(struct file *file, void *fh,
74 struct v4l2_format *f);
75 int (*vidioc_s_fmt_vid_out) (struct file *file, void *fh,
76 struct v4l2_format *f);
77 int (*vidioc_s_fmt_vid_out_overlay)(struct file *file, void *fh,
78 struct v4l2_format *f);
79 int (*vidioc_s_fmt_vbi_cap) (struct file *file, void *fh,
80 struct v4l2_format *f);
81 int (*vidioc_s_fmt_vbi_out) (struct file *file, void *fh,
82 struct v4l2_format *f);
83 int (*vidioc_s_fmt_sliced_vbi_cap)(struct file *file, void *fh,
84 struct v4l2_format *f);
85 int (*vidioc_s_fmt_sliced_vbi_out)(struct file *file, void *fh,
86 struct v4l2_format *f);
87 int (*vidioc_s_fmt_vid_cap_mplane)(struct file *file, void *fh,
88 struct v4l2_format *f);
89 int (*vidioc_s_fmt_vid_out_mplane)(struct file *file, void *fh,
90 struct v4l2_format *f);
91 int (*vidioc_s_fmt_sdr_cap) (struct file *file, void *fh,
92 struct v4l2_format *f);
93
94 /* VIDIOC_TRY_FMT handlers */
95 int (*vidioc_try_fmt_vid_cap) (struct file *file, void *fh,
96 struct v4l2_format *f);
97 int (*vidioc_try_fmt_vid_overlay)(struct file *file, void *fh,
98 struct v4l2_format *f);
99 int (*vidioc_try_fmt_vid_out) (struct file *file, void *fh,
100 struct v4l2_format *f);
101 int (*vidioc_try_fmt_vid_out_overlay)(struct file *file, void *fh,
102 struct v4l2_format *f);
103 int (*vidioc_try_fmt_vbi_cap) (struct file *file, void *fh,
104 struct v4l2_format *f);
105 int (*vidioc_try_fmt_vbi_out) (struct file *file, void *fh,
106 struct v4l2_format *f);
107 int (*vidioc_try_fmt_sliced_vbi_cap)(struct file *file, void *fh,
108 struct v4l2_format *f);
109 int (*vidioc_try_fmt_sliced_vbi_out)(struct file *file, void *fh,
110 struct v4l2_format *f);
111 int (*vidioc_try_fmt_vid_cap_mplane)(struct file *file, void *fh,
112 struct v4l2_format *f);
113 int (*vidioc_try_fmt_vid_out_mplane)(struct file *file, void *fh,
114 struct v4l2_format *f);
115 int (*vidioc_try_fmt_sdr_cap) (struct file *file, void *fh,
116 struct v4l2_format *f);
117
118 /* Buffer handlers */
119 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
120 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
121 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
122 int (*vidioc_expbuf) (struct file *file, void *fh,
123 struct v4l2_exportbuffer *e);
124 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
125
126 int (*vidioc_create_bufs)(struct file *file, void *fh, struct v4l2_create_buffers *b);
127 int (*vidioc_prepare_buf)(struct file *file, void *fh, struct v4l2_buffer *b);
128
129 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
130 int (*vidioc_g_fbuf) (struct file *file, void *fh,
131 struct v4l2_framebuffer *a);
132 int (*vidioc_s_fbuf) (struct file *file, void *fh,
133 const struct v4l2_framebuffer *a);
134
135 /* Stream on/off */
136 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
137 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
138
139 /* Standard handling
140 ENUMSTD is handled by videodev.c
141 */
142 int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
143 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id norm);
144 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
145
146 /* Input handling */
147 int (*vidioc_enum_input)(struct file *file, void *fh,
148 struct v4l2_input *inp);
149 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
150 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
151
152 /* Output handling */
153 int (*vidioc_enum_output) (struct file *file, void *fh,
154 struct v4l2_output *a);
155 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
156 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
157
158 /* Control handling */
159 int (*vidioc_queryctrl) (struct file *file, void *fh,
160 struct v4l2_queryctrl *a);
161 int (*vidioc_query_ext_ctrl) (struct file *file, void *fh,
162 struct v4l2_query_ext_ctrl *a);
163 int (*vidioc_g_ctrl) (struct file *file, void *fh,
164 struct v4l2_control *a);
165 int (*vidioc_s_ctrl) (struct file *file, void *fh,
166 struct v4l2_control *a);
167 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
168 struct v4l2_ext_controls *a);
169 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
170 struct v4l2_ext_controls *a);
171 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
172 struct v4l2_ext_controls *a);
173 int (*vidioc_querymenu) (struct file *file, void *fh,
174 struct v4l2_querymenu *a);
175
176 /* Audio ioctls */
177 int (*vidioc_enumaudio) (struct file *file, void *fh,
178 struct v4l2_audio *a);
179 int (*vidioc_g_audio) (struct file *file, void *fh,
180 struct v4l2_audio *a);
181 int (*vidioc_s_audio) (struct file *file, void *fh,
182 const struct v4l2_audio *a);
183
184 /* Audio out ioctls */
185 int (*vidioc_enumaudout) (struct file *file, void *fh,
186 struct v4l2_audioout *a);
187 int (*vidioc_g_audout) (struct file *file, void *fh,
188 struct v4l2_audioout *a);
189 int (*vidioc_s_audout) (struct file *file, void *fh,
190 const struct v4l2_audioout *a);
191 int (*vidioc_g_modulator) (struct file *file, void *fh,
192 struct v4l2_modulator *a);
193 int (*vidioc_s_modulator) (struct file *file, void *fh,
194 const struct v4l2_modulator *a);
195 /* Crop ioctls */
196 int (*vidioc_cropcap) (struct file *file, void *fh,
197 struct v4l2_cropcap *a);
198 int (*vidioc_g_crop) (struct file *file, void *fh,
199 struct v4l2_crop *a);
200 int (*vidioc_s_crop) (struct file *file, void *fh,
201 const struct v4l2_crop *a);
202 int (*vidioc_g_selection) (struct file *file, void *fh,
203 struct v4l2_selection *s);
204 int (*vidioc_s_selection) (struct file *file, void *fh,
205 struct v4l2_selection *s);
206 /* Compression ioctls */
207 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
208 struct v4l2_jpegcompression *a);
209 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
210 const struct v4l2_jpegcompression *a);
211 int (*vidioc_g_enc_index) (struct file *file, void *fh,
212 struct v4l2_enc_idx *a);
213 int (*vidioc_encoder_cmd) (struct file *file, void *fh,
214 struct v4l2_encoder_cmd *a);
215 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh,
216 struct v4l2_encoder_cmd *a);
217 int (*vidioc_decoder_cmd) (struct file *file, void *fh,
218 struct v4l2_decoder_cmd *a);
219 int (*vidioc_try_decoder_cmd) (struct file *file, void *fh,
220 struct v4l2_decoder_cmd *a);
221
222 /* Stream type-dependent parameter ioctls */
223 int (*vidioc_g_parm) (struct file *file, void *fh,
224 struct v4l2_streamparm *a);
225 int (*vidioc_s_parm) (struct file *file, void *fh,
226 struct v4l2_streamparm *a);
227
228 /* Tuner ioctls */
229 int (*vidioc_g_tuner) (struct file *file, void *fh,
230 struct v4l2_tuner *a);
231 int (*vidioc_s_tuner) (struct file *file, void *fh,
232 const struct v4l2_tuner *a);
233 int (*vidioc_g_frequency) (struct file *file, void *fh,
234 struct v4l2_frequency *a);
235 int (*vidioc_s_frequency) (struct file *file, void *fh,
236 const struct v4l2_frequency *a);
237 int (*vidioc_enum_freq_bands) (struct file *file, void *fh,
238 struct v4l2_frequency_band *band);
239
240 /* Sliced VBI cap */
241 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
242 struct v4l2_sliced_vbi_cap *a);
243
244 /* Log status ioctl */
245 int (*vidioc_log_status) (struct file *file, void *fh);
246
247 int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh,
248 const struct v4l2_hw_freq_seek *a);
249
250 /* Debugging ioctls */
251 #ifdef CONFIG_VIDEO_ADV_DEBUG
252 int (*vidioc_g_register) (struct file *file, void *fh,
253 struct v4l2_dbg_register *reg);
254 int (*vidioc_s_register) (struct file *file, void *fh,
255 const struct v4l2_dbg_register *reg);
256
257 int (*vidioc_g_chip_info) (struct file *file, void *fh,
258 struct v4l2_dbg_chip_info *chip);
259 #endif
260
261 int (*vidioc_enum_framesizes) (struct file *file, void *fh,
262 struct v4l2_frmsizeenum *fsize);
263
264 int (*vidioc_enum_frameintervals) (struct file *file, void *fh,
265 struct v4l2_frmivalenum *fival);
266
267 /* DV Timings IOCTLs */
268 int (*vidioc_s_dv_timings) (struct file *file, void *fh,
269 struct v4l2_dv_timings *timings);
270 int (*vidioc_g_dv_timings) (struct file *file, void *fh,
271 struct v4l2_dv_timings *timings);
272 int (*vidioc_query_dv_timings) (struct file *file, void *fh,
273 struct v4l2_dv_timings *timings);
274 int (*vidioc_enum_dv_timings) (struct file *file, void *fh,
275 struct v4l2_enum_dv_timings *timings);
276 int (*vidioc_dv_timings_cap) (struct file *file, void *fh,
277 struct v4l2_dv_timings_cap *cap);
278 int (*vidioc_g_edid) (struct file *file, void *fh, struct v4l2_edid *edid);
279 int (*vidioc_s_edid) (struct file *file, void *fh, struct v4l2_edid *edid);
280
281 int (*vidioc_subscribe_event) (struct v4l2_fh *fh,
282 const struct v4l2_event_subscription *sub);
283 int (*vidioc_unsubscribe_event)(struct v4l2_fh *fh,
284 const struct v4l2_event_subscription *sub);
285
286 /* For other private ioctls */
287 long (*vidioc_default) (struct file *file, void *fh,
288 bool valid_prio, unsigned int cmd, void *arg);
289 };
290
291
292 /* v4l debugging and diagnostics */
293
294 /* Device debug flags to be used with the video device debug attribute */
295
296 /* Just log the ioctl name + error code */
297 #define V4L2_DEV_DEBUG_IOCTL 0x01
298 /* Log the ioctl name arguments + error code */
299 #define V4L2_DEV_DEBUG_IOCTL_ARG 0x02
300 /* Log the file operations open, release, mmap and get_unmapped_area */
301 #define V4L2_DEV_DEBUG_FOP 0x04
302 /* Log the read and write file operations and the VIDIOC_(D)QBUF ioctls */
303 #define V4L2_DEV_DEBUG_STREAMING 0x08
304 /* Log poll() */
305 #define V4L2_DEV_DEBUG_POLL 0x10
306
307 /* Video standard functions */
308 extern const char *v4l2_norm_to_name(v4l2_std_id id);
309 extern void v4l2_video_std_frame_period(int id, struct v4l2_fract *frameperiod);
310 extern int v4l2_video_std_construct(struct v4l2_standard *vs,
311 int id, const char *name);
312 /* Prints the ioctl in a human-readable format. If prefix != NULL,
313 then do printk(KERN_DEBUG "%s: ", prefix) first. */
314 extern void v4l_printk_ioctl(const char *prefix, unsigned int cmd);
315
316 /* Internal use only: get the mutex (if any) that we need to lock for the
317 given command. */
318 struct video_device;
319 extern struct mutex *v4l2_ioctl_get_lock(struct video_device *vdev, unsigned cmd);
320
321 /* names for fancy debug output */
322 extern const char *v4l2_field_names[];
323 extern const char *v4l2_type_names[];
324
325 #ifdef CONFIG_COMPAT
326 /* 32 Bits compatibility layer for 64 bits processors */
327 extern long v4l2_compat_ioctl32(struct file *file, unsigned int cmd,
328 unsigned long arg);
329 #endif
330
331 typedef long (*v4l2_kioctl)(struct file *file,
332 unsigned int cmd, void *arg);
333
334 /* Include support for obsoleted stuff */
335 extern long video_usercopy(struct file *file, unsigned int cmd,
336 unsigned long arg, v4l2_kioctl func);
337
338 /* Standard handlers for V4L ioctl's */
339 extern long video_ioctl2(struct file *file,
340 unsigned int cmd, unsigned long arg);
341
342 #endif /* _V4L2_IOCTL_H */