video: tegra: dtv: Add ioctl for buffer size query
[linux-3.10.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
44         /* VIDIOC_G_FMT handlers */
45         int (*vidioc_g_fmt_vid_cap)    (struct file *file, void *fh,
46                                         struct v4l2_format *f);
47         int (*vidioc_g_fmt_vid_overlay)(struct file *file, void *fh,
48                                         struct v4l2_format *f);
49         int (*vidioc_g_fmt_vid_out)    (struct file *file, void *fh,
50                                         struct v4l2_format *f);
51         int (*vidioc_g_fmt_vid_out_overlay)(struct file *file, void *fh,
52                                         struct v4l2_format *f);
53         int (*vidioc_g_fmt_vbi_cap)    (struct file *file, void *fh,
54                                         struct v4l2_format *f);
55         int (*vidioc_g_fmt_vbi_out)    (struct file *file, void *fh,
56                                         struct v4l2_format *f);
57         int (*vidioc_g_fmt_sliced_vbi_cap)(struct file *file, void *fh,
58                                         struct v4l2_format *f);
59         int (*vidioc_g_fmt_sliced_vbi_out)(struct file *file, void *fh,
60                                         struct v4l2_format *f);
61         int (*vidioc_g_fmt_vid_cap_mplane)(struct file *file, void *fh,
62                                            struct v4l2_format *f);
63         int (*vidioc_g_fmt_vid_out_mplane)(struct file *file, void *fh,
64                                            struct v4l2_format *f);
65
66         /* VIDIOC_S_FMT handlers */
67         int (*vidioc_s_fmt_vid_cap)    (struct file *file, void *fh,
68                                         struct v4l2_format *f);
69         int (*vidioc_s_fmt_vid_overlay)(struct file *file, void *fh,
70                                         struct v4l2_format *f);
71         int (*vidioc_s_fmt_vid_out)    (struct file *file, void *fh,
72                                         struct v4l2_format *f);
73         int (*vidioc_s_fmt_vid_out_overlay)(struct file *file, void *fh,
74                                         struct v4l2_format *f);
75         int (*vidioc_s_fmt_vbi_cap)    (struct file *file, void *fh,
76                                         struct v4l2_format *f);
77         int (*vidioc_s_fmt_vbi_out)    (struct file *file, void *fh,
78                                         struct v4l2_format *f);
79         int (*vidioc_s_fmt_sliced_vbi_cap)(struct file *file, void *fh,
80                                         struct v4l2_format *f);
81         int (*vidioc_s_fmt_sliced_vbi_out)(struct file *file, void *fh,
82                                         struct v4l2_format *f);
83         int (*vidioc_s_fmt_vid_cap_mplane)(struct file *file, void *fh,
84                                            struct v4l2_format *f);
85         int (*vidioc_s_fmt_vid_out_mplane)(struct file *file, void *fh,
86                                            struct v4l2_format *f);
87
88         /* VIDIOC_TRY_FMT handlers */
89         int (*vidioc_try_fmt_vid_cap)    (struct file *file, void *fh,
90                                           struct v4l2_format *f);
91         int (*vidioc_try_fmt_vid_overlay)(struct file *file, void *fh,
92                                           struct v4l2_format *f);
93         int (*vidioc_try_fmt_vid_out)    (struct file *file, void *fh,
94                                           struct v4l2_format *f);
95         int (*vidioc_try_fmt_vid_out_overlay)(struct file *file, void *fh,
96                                           struct v4l2_format *f);
97         int (*vidioc_try_fmt_vbi_cap)    (struct file *file, void *fh,
98                                           struct v4l2_format *f);
99         int (*vidioc_try_fmt_vbi_out)    (struct file *file, void *fh,
100                                           struct v4l2_format *f);
101         int (*vidioc_try_fmt_sliced_vbi_cap)(struct file *file, void *fh,
102                                           struct v4l2_format *f);
103         int (*vidioc_try_fmt_sliced_vbi_out)(struct file *file, void *fh,
104                                           struct v4l2_format *f);
105         int (*vidioc_try_fmt_vid_cap_mplane)(struct file *file, void *fh,
106                                              struct v4l2_format *f);
107         int (*vidioc_try_fmt_vid_out_mplane)(struct file *file, void *fh,
108                                              struct v4l2_format *f);
109
110         /* Buffer handlers */
111         int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
112         int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
113         int (*vidioc_qbuf)    (struct file *file, void *fh, struct v4l2_buffer *b);
114         int (*vidioc_expbuf)  (struct file *file, void *fh,
115                                 struct v4l2_exportbuffer *e);
116         int (*vidioc_dqbuf)   (struct file *file, void *fh, struct v4l2_buffer *b);
117
118         int (*vidioc_create_bufs)(struct file *file, void *fh, struct v4l2_create_buffers *b);
119         int (*vidioc_prepare_buf)(struct file *file, void *fh, struct v4l2_buffer *b);
120
121         int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
122         int (*vidioc_g_fbuf)   (struct file *file, void *fh,
123                                 struct v4l2_framebuffer *a);
124         int (*vidioc_s_fbuf)   (struct file *file, void *fh,
125                                 const struct v4l2_framebuffer *a);
126
127                 /* Stream on/off */
128         int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
129         int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
130
131                 /* Standard handling
132                         ENUMSTD is handled by videodev.c
133                  */
134         int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
135         int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id norm);
136         int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
137
138                 /* Input handling */
139         int (*vidioc_enum_input)(struct file *file, void *fh,
140                                  struct v4l2_input *inp);
141         int (*vidioc_g_input)   (struct file *file, void *fh, unsigned int *i);
142         int (*vidioc_s_input)   (struct file *file, void *fh, unsigned int i);
143
144                 /* Output handling */
145         int (*vidioc_enum_output) (struct file *file, void *fh,
146                                   struct v4l2_output *a);
147         int (*vidioc_g_output)   (struct file *file, void *fh, unsigned int *i);
148         int (*vidioc_s_output)   (struct file *file, void *fh, unsigned int i);
149
150                 /* Control handling */
151         int (*vidioc_queryctrl)        (struct file *file, void *fh,
152                                         struct v4l2_queryctrl *a);
153         int (*vidioc_g_ctrl)           (struct file *file, void *fh,
154                                         struct v4l2_control *a);
155         int (*vidioc_s_ctrl)           (struct file *file, void *fh,
156                                         struct v4l2_control *a);
157         int (*vidioc_g_ext_ctrls)      (struct file *file, void *fh,
158                                         struct v4l2_ext_controls *a);
159         int (*vidioc_s_ext_ctrls)      (struct file *file, void *fh,
160                                         struct v4l2_ext_controls *a);
161         int (*vidioc_try_ext_ctrls)    (struct file *file, void *fh,
162                                         struct v4l2_ext_controls *a);
163         int (*vidioc_querymenu)        (struct file *file, void *fh,
164                                         struct v4l2_querymenu *a);
165
166         /* Audio ioctls */
167         int (*vidioc_enumaudio)        (struct file *file, void *fh,
168                                         struct v4l2_audio *a);
169         int (*vidioc_g_audio)          (struct file *file, void *fh,
170                                         struct v4l2_audio *a);
171         int (*vidioc_s_audio)          (struct file *file, void *fh,
172                                         const struct v4l2_audio *a);
173
174         /* Audio out ioctls */
175         int (*vidioc_enumaudout)       (struct file *file, void *fh,
176                                         struct v4l2_audioout *a);
177         int (*vidioc_g_audout)         (struct file *file, void *fh,
178                                         struct v4l2_audioout *a);
179         int (*vidioc_s_audout)         (struct file *file, void *fh,
180                                         const struct v4l2_audioout *a);
181         int (*vidioc_g_modulator)      (struct file *file, void *fh,
182                                         struct v4l2_modulator *a);
183         int (*vidioc_s_modulator)      (struct file *file, void *fh,
184                                         const struct v4l2_modulator *a);
185         /* Crop ioctls */
186         int (*vidioc_cropcap)          (struct file *file, void *fh,
187                                         struct v4l2_cropcap *a);
188         int (*vidioc_g_crop)           (struct file *file, void *fh,
189                                         struct v4l2_crop *a);
190         int (*vidioc_s_crop)           (struct file *file, void *fh,
191                                         const struct v4l2_crop *a);
192         int (*vidioc_g_selection)      (struct file *file, void *fh,
193                                         struct v4l2_selection *s);
194         int (*vidioc_s_selection)      (struct file *file, void *fh,
195                                         struct v4l2_selection *s);
196         /* Compression ioctls */
197         int (*vidioc_g_jpegcomp)       (struct file *file, void *fh,
198                                         struct v4l2_jpegcompression *a);
199         int (*vidioc_s_jpegcomp)       (struct file *file, void *fh,
200                                         const struct v4l2_jpegcompression *a);
201         int (*vidioc_g_enc_index)      (struct file *file, void *fh,
202                                         struct v4l2_enc_idx *a);
203         int (*vidioc_encoder_cmd)      (struct file *file, void *fh,
204                                         struct v4l2_encoder_cmd *a);
205         int (*vidioc_try_encoder_cmd)  (struct file *file, void *fh,
206                                         struct v4l2_encoder_cmd *a);
207         int (*vidioc_decoder_cmd)      (struct file *file, void *fh,
208                                         struct v4l2_decoder_cmd *a);
209         int (*vidioc_try_decoder_cmd)  (struct file *file, void *fh,
210                                         struct v4l2_decoder_cmd *a);
211
212         /* Stream type-dependent parameter ioctls */
213         int (*vidioc_g_parm)           (struct file *file, void *fh,
214                                         struct v4l2_streamparm *a);
215         int (*vidioc_s_parm)           (struct file *file, void *fh,
216                                         struct v4l2_streamparm *a);
217
218         /* Tuner ioctls */
219         int (*vidioc_g_tuner)          (struct file *file, void *fh,
220                                         struct v4l2_tuner *a);
221         int (*vidioc_s_tuner)          (struct file *file, void *fh,
222                                         const struct v4l2_tuner *a);
223         int (*vidioc_g_frequency)      (struct file *file, void *fh,
224                                         struct v4l2_frequency *a);
225         int (*vidioc_s_frequency)      (struct file *file, void *fh,
226                                         const struct v4l2_frequency *a);
227         int (*vidioc_enum_freq_bands) (struct file *file, void *fh,
228                                     struct v4l2_frequency_band *band);
229
230         /* Sliced VBI cap */
231         int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
232                                         struct v4l2_sliced_vbi_cap *a);
233
234         /* Log status ioctl */
235         int (*vidioc_log_status)       (struct file *file, void *fh);
236
237         int (*vidioc_s_hw_freq_seek)   (struct file *file, void *fh,
238                                         const struct v4l2_hw_freq_seek *a);
239
240         /* Debugging ioctls */
241 #ifdef CONFIG_VIDEO_ADV_DEBUG
242         int (*vidioc_g_register)       (struct file *file, void *fh,
243                                         struct v4l2_dbg_register *reg);
244         int (*vidioc_s_register)       (struct file *file, void *fh,
245                                         const struct v4l2_dbg_register *reg);
246
247         int (*vidioc_g_chip_info)      (struct file *file, void *fh,
248                                         struct v4l2_dbg_chip_info *chip);
249 #endif
250         int (*vidioc_g_chip_ident)     (struct file *file, void *fh,
251                                         struct v4l2_dbg_chip_ident *chip);
252
253         int (*vidioc_enum_framesizes)   (struct file *file, void *fh,
254                                          struct v4l2_frmsizeenum *fsize);
255
256         int (*vidioc_enum_frameintervals) (struct file *file, void *fh,
257                                            struct v4l2_frmivalenum *fival);
258
259         /* DV Timings IOCTLs */
260         int (*vidioc_s_dv_timings) (struct file *file, void *fh,
261                                     struct v4l2_dv_timings *timings);
262         int (*vidioc_g_dv_timings) (struct file *file, void *fh,
263                                     struct v4l2_dv_timings *timings);
264         int (*vidioc_query_dv_timings) (struct file *file, void *fh,
265                                     struct v4l2_dv_timings *timings);
266         int (*vidioc_enum_dv_timings) (struct file *file, void *fh,
267                                     struct v4l2_enum_dv_timings *timings);
268         int (*vidioc_dv_timings_cap) (struct file *file, void *fh,
269                                     struct v4l2_dv_timings_cap *cap);
270
271         int (*vidioc_subscribe_event)  (struct v4l2_fh *fh,
272                                         const struct v4l2_event_subscription *sub);
273         int (*vidioc_unsubscribe_event)(struct v4l2_fh *fh,
274                                         const struct v4l2_event_subscription *sub);
275
276         /* For other private ioctls */
277         long (*vidioc_default)         (struct file *file, void *fh,
278                                         bool valid_prio, unsigned int cmd, void *arg);
279 };
280
281
282 /* v4l debugging and diagnostics */
283
284 /* Debug bitmask flags to be used on V4L2 */
285 #define V4L2_DEBUG_IOCTL     0x01
286 #define V4L2_DEBUG_IOCTL_ARG 0x02
287
288 /*  Video standard functions  */
289 extern const char *v4l2_norm_to_name(v4l2_std_id id);
290 extern void v4l2_video_std_frame_period(int id, struct v4l2_fract *frameperiod);
291 extern int v4l2_video_std_construct(struct v4l2_standard *vs,
292                                     int id, const char *name);
293 /* Prints the ioctl in a human-readable format. If prefix != NULL,
294    then do printk(KERN_DEBUG "%s: ", prefix) first. */
295 extern void v4l_printk_ioctl(const char *prefix, unsigned int cmd);
296
297 /* Internal use only: get the mutex (if any) that we need to lock for the
298    given command. */
299 struct video_device;
300 extern struct mutex *v4l2_ioctl_get_lock(struct video_device *vdev, unsigned cmd);
301
302 /* names for fancy debug output */
303 extern const char *v4l2_field_names[];
304 extern const char *v4l2_type_names[];
305
306 #ifdef CONFIG_COMPAT
307 /* 32 Bits compatibility layer for 64 bits processors */
308 extern long v4l2_compat_ioctl32(struct file *file, unsigned int cmd,
309                                 unsigned long arg);
310 #endif
311
312 typedef long (*v4l2_kioctl)(struct file *file,
313                 unsigned int cmd, void *arg);
314
315 /* Include support for obsoleted stuff */
316 extern long video_usercopy(struct file *file, unsigned int cmd,
317                                 unsigned long arg, v4l2_kioctl func);
318
319 /* Standard handlers for V4L ioctl's */
320 extern long video_ioctl2(struct file *file,
321                         unsigned int cmd, unsigned long arg);
322
323 #endif /* _V4L2_IOCTL_H */