[media] Spec: document CREATE_BUFS behavior if count == 0
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / media / v4l2-ioctl.h
CommitLineData
35ea11ff
HV
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>
35ea11ff
HV
14#include <linux/mutex.h>
15#include <linux/compiler.h> /* need __user */
35ea11ff 16#include <linux/videodev2.h>
35ea11ff 17
d3d7c963
SA
18struct v4l2_fh;
19
a399810c
HV
20struct 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);
d14e6d76
PO
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);
a399810c
HV
43 int (*vidioc_enum_fmt_type_private)(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);
d14e6d76
PO
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);
a399810c
HV
67 int (*vidioc_g_fmt_type_private)(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);
d14e6d76
PO
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);
a399810c
HV
91 int (*vidioc_s_fmt_type_private)(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);
d14e6d76
PO
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);
a399810c
HV
115 int (*vidioc_try_fmt_type_private)(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_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
123
2150158b
GL
124 int (*vidioc_create_bufs)(struct file *file, void *fh, struct v4l2_create_buffers *b);
125 int (*vidioc_prepare_buf)(struct file *file, void *fh, struct v4l2_buffer *b);
a399810c
HV
126
127 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
a399810c
HV
128 int (*vidioc_g_fbuf) (struct file *file, void *fh,
129 struct v4l2_framebuffer *a);
130 int (*vidioc_s_fbuf) (struct file *file, void *fh,
131 struct v4l2_framebuffer *a);
132
133 /* Stream on/off */
134 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
135 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
136
137 /* Standard handling
138 ENUMSTD is handled by videodev.c
139 */
140 int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
141 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
142 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
143
144 /* Input handling */
145 int (*vidioc_enum_input)(struct file *file, void *fh,
146 struct v4l2_input *inp);
147 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
148 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
149
150 /* Output handling */
151 int (*vidioc_enum_output) (struct file *file, void *fh,
152 struct v4l2_output *a);
153 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
154 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
155
156 /* Control handling */
157 int (*vidioc_queryctrl) (struct file *file, void *fh,
158 struct v4l2_queryctrl *a);
159 int (*vidioc_g_ctrl) (struct file *file, void *fh,
160 struct v4l2_control *a);
161 int (*vidioc_s_ctrl) (struct file *file, void *fh,
162 struct v4l2_control *a);
163 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
164 struct v4l2_ext_controls *a);
165 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
166 struct v4l2_ext_controls *a);
167 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
168 struct v4l2_ext_controls *a);
169 int (*vidioc_querymenu) (struct file *file, void *fh,
170 struct v4l2_querymenu *a);
171
172 /* Audio ioctls */
173 int (*vidioc_enumaudio) (struct file *file, void *fh,
174 struct v4l2_audio *a);
175 int (*vidioc_g_audio) (struct file *file, void *fh,
176 struct v4l2_audio *a);
177 int (*vidioc_s_audio) (struct file *file, void *fh,
178 struct v4l2_audio *a);
179
180 /* Audio out ioctls */
181 int (*vidioc_enumaudout) (struct file *file, void *fh,
182 struct v4l2_audioout *a);
183 int (*vidioc_g_audout) (struct file *file, void *fh,
184 struct v4l2_audioout *a);
185 int (*vidioc_s_audout) (struct file *file, void *fh,
186 struct v4l2_audioout *a);
187 int (*vidioc_g_modulator) (struct file *file, void *fh,
188 struct v4l2_modulator *a);
189 int (*vidioc_s_modulator) (struct file *file, void *fh,
190 struct v4l2_modulator *a);
191 /* Crop ioctls */
192 int (*vidioc_cropcap) (struct file *file, void *fh,
193 struct v4l2_cropcap *a);
194 int (*vidioc_g_crop) (struct file *file, void *fh,
195 struct v4l2_crop *a);
196 int (*vidioc_s_crop) (struct file *file, void *fh,
197 struct v4l2_crop *a);
0e8caace
TS
198 int (*vidioc_g_selection) (struct file *file, void *fh,
199 struct v4l2_selection *s);
200 int (*vidioc_s_selection) (struct file *file, void *fh,
201 struct v4l2_selection *s);
a399810c
HV
202 /* Compression ioctls */
203 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
204 struct v4l2_jpegcompression *a);
205 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
206 struct v4l2_jpegcompression *a);
207 int (*vidioc_g_enc_index) (struct file *file, void *fh,
208 struct v4l2_enc_idx *a);
209 int (*vidioc_encoder_cmd) (struct file *file, void *fh,
210 struct v4l2_encoder_cmd *a);
211 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh,
212 struct v4l2_encoder_cmd *a);
a45c0ad5
HV
213 int (*vidioc_decoder_cmd) (struct file *file, void *fh,
214 struct v4l2_decoder_cmd *a);
215 int (*vidioc_try_decoder_cmd) (struct file *file, void *fh,
216 struct v4l2_decoder_cmd *a);
a399810c
HV
217
218 /* Stream type-dependent parameter ioctls */
219 int (*vidioc_g_parm) (struct file *file, void *fh,
220 struct v4l2_streamparm *a);
221 int (*vidioc_s_parm) (struct file *file, void *fh,
222 struct v4l2_streamparm *a);
223
224 /* Tuner ioctls */
225 int (*vidioc_g_tuner) (struct file *file, void *fh,
226 struct v4l2_tuner *a);
227 int (*vidioc_s_tuner) (struct file *file, void *fh,
228 struct v4l2_tuner *a);
229 int (*vidioc_g_frequency) (struct file *file, void *fh,
230 struct v4l2_frequency *a);
231 int (*vidioc_s_frequency) (struct file *file, void *fh,
232 struct v4l2_frequency *a);
233
234 /* Sliced VBI cap */
235 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
236 struct v4l2_sliced_vbi_cap *a);
237
238 /* Log status ioctl */
239 int (*vidioc_log_status) (struct file *file, void *fh);
240
241 int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh,
242 struct v4l2_hw_freq_seek *a);
243
244 /* Debugging ioctls */
245#ifdef CONFIG_VIDEO_ADV_DEBUG
246 int (*vidioc_g_register) (struct file *file, void *fh,
aecde8b5 247 struct v4l2_dbg_register *reg);
a399810c 248 int (*vidioc_s_register) (struct file *file, void *fh,
aecde8b5 249 struct v4l2_dbg_register *reg);
a399810c
HV
250#endif
251 int (*vidioc_g_chip_ident) (struct file *file, void *fh,
aecde8b5 252 struct v4l2_dbg_chip_ident *chip);
a399810c 253
74d83fa0
MCC
254 int (*vidioc_enum_framesizes) (struct file *file, void *fh,
255 struct v4l2_frmsizeenum *fsize);
256
257 int (*vidioc_enum_frameintervals) (struct file *file, void *fh,
258 struct v4l2_frmivalenum *fival);
259
b6456c0c
MK
260 /* DV Timings IOCTLs */
261 int (*vidioc_enum_dv_presets) (struct file *file, void *fh,
262 struct v4l2_dv_enum_preset *preset);
263
264 int (*vidioc_s_dv_preset) (struct file *file, void *fh,
265 struct v4l2_dv_preset *preset);
266 int (*vidioc_g_dv_preset) (struct file *file, void *fh,
267 struct v4l2_dv_preset *preset);
268 int (*vidioc_query_dv_preset) (struct file *file, void *fh,
269 struct v4l2_dv_preset *qpreset);
270 int (*vidioc_s_dv_timings) (struct file *file, void *fh,
271 struct v4l2_dv_timings *timings);
272 int (*vidioc_g_dv_timings) (struct file *file, void *fh,
273 struct v4l2_dv_timings *timings);
5d7758ee
HV
274 int (*vidioc_query_dv_timings) (struct file *file, void *fh,
275 struct v4l2_dv_timings *timings);
276 int (*vidioc_enum_dv_timings) (struct file *file, void *fh,
277 struct v4l2_enum_dv_timings *timings);
278 int (*vidioc_dv_timings_cap) (struct file *file, void *fh,
279 struct v4l2_dv_timings_cap *cap);
b6456c0c 280
d3d7c963
SA
281 int (*vidioc_subscribe_event) (struct v4l2_fh *fh,
282 struct v4l2_event_subscription *sub);
283 int (*vidioc_unsubscribe_event)(struct v4l2_fh *fh,
284 struct v4l2_event_subscription *sub);
285
a399810c 286 /* For other private ioctls */
069b7479 287 long (*vidioc_default) (struct file *file, void *fh,
99cd47bc 288 bool valid_prio, int cmd, void *arg);
a399810c
HV
289};
290
291
2864462e
MCC
292/* v4l debugging and diagnostics */
293
294/* Debug bitmask flags to be used on V4L2 */
295#define V4L2_DEBUG_IOCTL 0x01
296#define V4L2_DEBUG_IOCTL_ARG 0x02
297
35ea11ff
HV
298/* Video standard functions */
299extern const char *v4l2_norm_to_name(v4l2_std_id id);
51f0b8d5 300extern void v4l2_video_std_frame_period(int id, struct v4l2_fract *frameperiod);
35ea11ff
HV
301extern int v4l2_video_std_construct(struct v4l2_standard *vs,
302 int id, const char *name);
4a085168
HV
303/* Prints the ioctl in a human-readable format. If prefix != NULL,
304 then do printk(KERN_DEBUG "%s: ", prefix) first. */
305extern void v4l_printk_ioctl(const char *prefix, unsigned int cmd);
35ea11ff
HV
306
307/* names for fancy debug output */
308extern const char *v4l2_field_names[];
309extern const char *v4l2_type_names[];
310
bec43661 311#ifdef CONFIG_COMPAT
35ea11ff 312/* 32 Bits compatibility layer for 64 bits processors */
9bb7cde7 313extern long v4l2_compat_ioctl32(struct file *file, unsigned int cmd,
35ea11ff 314 unsigned long arg);
bec43661 315#endif
35ea11ff 316
08af245d
HV
317typedef long (*v4l2_kioctl)(struct file *file,
318 unsigned int cmd, void *arg);
319
35ea11ff 320/* Include support for obsoleted stuff */
069b7479 321extern long video_usercopy(struct file *file, unsigned int cmd,
f473bf76 322 unsigned long arg, v4l2_kioctl func);
35ea11ff 323
8a522c91 324/* Standard handlers for V4L ioctl's */
069b7479 325extern long video_ioctl2(struct file *file,
8a522c91
MCC
326 unsigned int cmd, unsigned long arg);
327
35ea11ff 328#endif /* _V4L2_IOCTL_H */