V4L/DVB (8427): videodev: split off the ioctl handling into v4l2-ioctl.c
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / media / v4l2-dev.h
CommitLineData
401998fa
MCC
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_DEV_H
10#define _V4L2_DEV_H
11
38ee04f0
MCC
12#define OBSOLETE_OWNER 1 /* to be removed soon */
13#define OBSOLETE_DEVDATA 1 /* to be removed soon */
401998fa
MCC
14
15#include <linux/poll.h>
16#include <linux/fs.h>
17#include <linux/device.h>
18#include <linux/mutex.h>
19#include <linux/compiler.h> /* need __user */
487206f2 20#ifdef CONFIG_VIDEO_V4L1_COMPAT
401998fa
MCC
21#include <linux/videodev.h>
22#else
23#include <linux/videodev2.h>
24#endif
25
401998fa
MCC
26#define VIDEO_MAJOR 81
27/* Minor device allocation */
28#define MINOR_VFL_TYPE_GRABBER_MIN 0
29#define MINOR_VFL_TYPE_GRABBER_MAX 63
30#define MINOR_VFL_TYPE_RADIO_MIN 64
31#define MINOR_VFL_TYPE_RADIO_MAX 127
32#define MINOR_VFL_TYPE_VTX_MIN 192
33#define MINOR_VFL_TYPE_VTX_MAX 223
34#define MINOR_VFL_TYPE_VBI_MIN 224
35#define MINOR_VFL_TYPE_VBI_MAX 255
36
37#define VFL_TYPE_GRABBER 0
38#define VFL_TYPE_VBI 1
39#define VFL_TYPE_RADIO 2
40#define VFL_TYPE_VTX 3
41
401998fa 42/* Video standard functions */
7fa8e6fa 43extern const char *v4l2_norm_to_name(v4l2_std_id id);
401998fa 44extern int v4l2_video_std_construct(struct v4l2_standard *vs,
7fa8e6fa 45 int id, const char *name);
057596ee
MCC
46/* Prints the ioctl in a human-readable format */
47extern void v4l_printk_ioctl(unsigned int cmd);
401998fa
MCC
48
49/* prority handling */
50struct v4l2_prio_state {
51 atomic_t prios[4];
52};
53int v4l2_prio_init(struct v4l2_prio_state *global);
54int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
55 enum v4l2_priority new);
56int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
57int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
58enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
59int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
60
61/* names for fancy debug output */
21575c13
HV
62extern const char *v4l2_field_names[];
63extern const char *v4l2_type_names[];
401998fa
MCC
64
65/* Compatibility layer interface -- v4l1-compat module */
66typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
67 unsigned int cmd, void *arg);
68#ifdef CONFIG_VIDEO_V4L1_COMPAT
69int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
70 int cmd, void *arg, v4l2_kioctl driver_ioctl);
71#else
72#define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
73#endif
74
75/* 32 Bits compatibility layer for 64 bits processors */
76extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
77 unsigned long arg);
78
79/*
80 * Newer version of video_device, handled by videodev2.c
81 * This version moves redundant code from video device code to
82 * the common handler
83 */
401998fa
MCC
84
85struct video_device
86{
87 /* device ops */
5e87efa3 88 const struct file_operations *fops;
401998fa 89
54bd5b66
KS
90 /* sysfs */
91 struct device class_dev; /* v4l device */
92 struct device *dev; /* device parent */
93
401998fa 94 /* device info */
401998fa
MCC
95 char name[32];
96 int type; /* v4l1 */
97 int type2; /* v4l2 */
401998fa 98 int minor;
539a7555 99 /* attribute to diferentiate multiple indexs on one physical device */
100 int index;
401998fa
MCC
101
102 int debug; /* Activates debug level*/
103
104 /* Video standard vars */
e75f9cee
MCC
105 v4l2_std_id tvnorms; /* Supported tv norms */
106 v4l2_std_id current_norm; /* Current tvnorm */
401998fa
MCC
107
108 /* callbacks */
109 void (*release)(struct video_device *vfd);
110
111 /* ioctl callbacks */
112
113 /* VIDIOC_QUERYCAP handler */
114 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
115
116 /* Priority handling */
117 int (*vidioc_g_priority) (struct file *file, void *fh,
118 enum v4l2_priority *p);
119 int (*vidioc_s_priority) (struct file *file, void *fh,
120 enum v4l2_priority p);
121
122 /* VIDIOC_ENUM_FMT handlers */
78b526a4 123 int (*vidioc_enum_fmt_vid_cap) (struct file *file, void *fh,
401998fa 124 struct v4l2_fmtdesc *f);
78b526a4 125 int (*vidioc_enum_fmt_vid_overlay) (struct file *file, void *fh,
401998fa 126 struct v4l2_fmtdesc *f);
78b526a4 127 int (*vidioc_enum_fmt_vid_out) (struct file *file, void *fh,
401998fa 128 struct v4l2_fmtdesc *f);
78b526a4
HV
129#if 1
130 /* deprecated, will be removed in 2.6.28 */
131 int (*vidioc_enum_fmt_vbi_cap) (struct file *file, void *fh,
0e3bd2b9 132 struct v4l2_fmtdesc *f);
78b526a4 133#endif
401998fa
MCC
134 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
135 struct v4l2_fmtdesc *f);
136
137 /* VIDIOC_G_FMT handlers */
78b526a4 138 int (*vidioc_g_fmt_vid_cap) (struct file *file, void *fh,
401998fa 139 struct v4l2_format *f);
78b526a4 140 int (*vidioc_g_fmt_vid_overlay)(struct file *file, void *fh,
401998fa 141 struct v4l2_format *f);
78b526a4 142 int (*vidioc_g_fmt_vid_out) (struct file *file, void *fh,
401998fa 143 struct v4l2_format *f);
78b526a4 144 int (*vidioc_g_fmt_vid_out_overlay)(struct file *file, void *fh,
401998fa 145 struct v4l2_format *f);
78b526a4 146 int (*vidioc_g_fmt_vbi_cap) (struct file *file, void *fh,
0e3bd2b9 147 struct v4l2_format *f);
78b526a4 148 int (*vidioc_g_fmt_vbi_out) (struct file *file, void *fh,
401998fa 149 struct v4l2_format *f);
78b526a4 150 int (*vidioc_g_fmt_sliced_vbi_cap)(struct file *file, void *fh,
401998fa 151 struct v4l2_format *f);
78b526a4 152 int (*vidioc_g_fmt_sliced_vbi_out)(struct file *file, void *fh,
b2787845 153 struct v4l2_format *f);
401998fa
MCC
154 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh,
155 struct v4l2_format *f);
156
157 /* VIDIOC_S_FMT handlers */
78b526a4 158 int (*vidioc_s_fmt_vid_cap) (struct file *file, void *fh,
401998fa 159 struct v4l2_format *f);
78b526a4 160 int (*vidioc_s_fmt_vid_overlay)(struct file *file, void *fh,
401998fa 161 struct v4l2_format *f);
78b526a4 162 int (*vidioc_s_fmt_vid_out) (struct file *file, void *fh,
401998fa 163 struct v4l2_format *f);
78b526a4 164 int (*vidioc_s_fmt_vid_out_overlay)(struct file *file, void *fh,
401998fa 165 struct v4l2_format *f);
78b526a4 166 int (*vidioc_s_fmt_vbi_cap) (struct file *file, void *fh,
0e3bd2b9 167 struct v4l2_format *f);
78b526a4 168 int (*vidioc_s_fmt_vbi_out) (struct file *file, void *fh,
401998fa 169 struct v4l2_format *f);
78b526a4 170 int (*vidioc_s_fmt_sliced_vbi_cap)(struct file *file, void *fh,
401998fa 171 struct v4l2_format *f);
78b526a4 172 int (*vidioc_s_fmt_sliced_vbi_out)(struct file *file, void *fh,
b2787845 173 struct v4l2_format *f);
401998fa
MCC
174 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh,
175 struct v4l2_format *f);
176
177 /* VIDIOC_TRY_FMT handlers */
78b526a4 178 int (*vidioc_try_fmt_vid_cap) (struct file *file, void *fh,
401998fa 179 struct v4l2_format *f);
78b526a4 180 int (*vidioc_try_fmt_vid_overlay)(struct file *file, void *fh,
401998fa 181 struct v4l2_format *f);
78b526a4 182 int (*vidioc_try_fmt_vid_out) (struct file *file, void *fh,
401998fa 183 struct v4l2_format *f);
78b526a4 184 int (*vidioc_try_fmt_vid_out_overlay)(struct file *file, void *fh,
401998fa 185 struct v4l2_format *f);
78b526a4 186 int (*vidioc_try_fmt_vbi_cap) (struct file *file, void *fh,
0e3bd2b9 187 struct v4l2_format *f);
78b526a4 188 int (*vidioc_try_fmt_vbi_out) (struct file *file, void *fh,
401998fa 189 struct v4l2_format *f);
78b526a4 190 int (*vidioc_try_fmt_sliced_vbi_cap)(struct file *file, void *fh,
401998fa 191 struct v4l2_format *f);
78b526a4 192 int (*vidioc_try_fmt_sliced_vbi_out)(struct file *file, void *fh,
b2787845 193 struct v4l2_format *f);
401998fa
MCC
194 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh,
195 struct v4l2_format *f);
196
197 /* Buffer handlers */
198 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
199 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
200 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
201 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
202
203
204 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
8a905162 205#ifdef CONFIG_VIDEO_V4L1_COMPAT
401998fa
MCC
206 /* buffer type is struct vidio_mbuf * */
207 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p);
208#endif
209 int (*vidioc_g_fbuf) (struct file *file, void *fh,
210 struct v4l2_framebuffer *a);
211 int (*vidioc_s_fbuf) (struct file *file, void *fh,
212 struct v4l2_framebuffer *a);
213
214 /* Stream on/off */
215 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
216 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
217
218 /* Standard handling
b2de2313 219 ENUMSTD is handled by videodev.c
401998fa 220 */
b2de2313 221 int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
e75f9cee 222 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
401998fa
MCC
223 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
224
225 /* Input handling */
226 int (*vidioc_enum_input)(struct file *file, void *fh,
227 struct v4l2_input *inp);
228 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
229 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
230
231 /* Output handling */
0e3bd2b9 232 int (*vidioc_enum_output) (struct file *file, void *fh,
401998fa
MCC
233 struct v4l2_output *a);
234 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
235 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
236
237 /* Control handling */
238 int (*vidioc_queryctrl) (struct file *file, void *fh,
239 struct v4l2_queryctrl *a);
240 int (*vidioc_g_ctrl) (struct file *file, void *fh,
241 struct v4l2_control *a);
242 int (*vidioc_s_ctrl) (struct file *file, void *fh,
243 struct v4l2_control *a);
05976914
HV
244 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
245 struct v4l2_ext_controls *a);
246 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
247 struct v4l2_ext_controls *a);
248 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
249 struct v4l2_ext_controls *a);
401998fa
MCC
250 int (*vidioc_querymenu) (struct file *file, void *fh,
251 struct v4l2_querymenu *a);
252
253 /* Audio ioctls */
254 int (*vidioc_enumaudio) (struct file *file, void *fh,
255 struct v4l2_audio *a);
256 int (*vidioc_g_audio) (struct file *file, void *fh,
257 struct v4l2_audio *a);
258 int (*vidioc_s_audio) (struct file *file, void *fh,
259 struct v4l2_audio *a);
260
261 /* Audio out ioctls */
262 int (*vidioc_enumaudout) (struct file *file, void *fh,
263 struct v4l2_audioout *a);
264 int (*vidioc_g_audout) (struct file *file, void *fh,
265 struct v4l2_audioout *a);
266 int (*vidioc_s_audout) (struct file *file, void *fh,
267 struct v4l2_audioout *a);
268 int (*vidioc_g_modulator) (struct file *file, void *fh,
269 struct v4l2_modulator *a);
270 int (*vidioc_s_modulator) (struct file *file, void *fh,
271 struct v4l2_modulator *a);
272 /* Crop ioctls */
273 int (*vidioc_cropcap) (struct file *file, void *fh,
274 struct v4l2_cropcap *a);
275 int (*vidioc_g_crop) (struct file *file, void *fh,
276 struct v4l2_crop *a);
277 int (*vidioc_s_crop) (struct file *file, void *fh,
278 struct v4l2_crop *a);
279 /* Compression ioctls */
401998fa
MCC
280 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
281 struct v4l2_jpegcompression *a);
282 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
283 struct v4l2_jpegcompression *a);
db6eb5b3
HV
284 int (*vidioc_g_enc_index) (struct file *file, void *fh,
285 struct v4l2_enc_idx *a);
ada6ecd2
HV
286 int (*vidioc_encoder_cmd) (struct file *file, void *fh,
287 struct v4l2_encoder_cmd *a);
288 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh,
289 struct v4l2_encoder_cmd *a);
401998fa
MCC
290
291 /* Stream type-dependent parameter ioctls */
292 int (*vidioc_g_parm) (struct file *file, void *fh,
293 struct v4l2_streamparm *a);
294 int (*vidioc_s_parm) (struct file *file, void *fh,
295 struct v4l2_streamparm *a);
296
297 /* Tuner ioctls */
298 int (*vidioc_g_tuner) (struct file *file, void *fh,
299 struct v4l2_tuner *a);
300 int (*vidioc_s_tuner) (struct file *file, void *fh,
301 struct v4l2_tuner *a);
302 int (*vidioc_g_frequency) (struct file *file, void *fh,
303 struct v4l2_frequency *a);
304 int (*vidioc_s_frequency) (struct file *file, void *fh,
305 struct v4l2_frequency *a);
306
307 /* Sliced VBI cap */
308 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
309 struct v4l2_sliced_vbi_cap *a);
310
311 /* Log status ioctl */
312 int (*vidioc_log_status) (struct file *file, void *fh);
313
1d0ba5f3
TL
314 int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh,
315 struct v4l2_hw_freq_seek *a);
401998fa 316
dbbff48f
TP
317 /* Debugging ioctls */
318#ifdef CONFIG_VIDEO_ADV_DEBUG
319 int (*vidioc_g_register) (struct file *file, void *fh,
320 struct v4l2_register *reg);
321 int (*vidioc_s_register) (struct file *file, void *fh,
322 struct v4l2_register *reg);
323#endif
3434eb7e
HV
324 int (*vidioc_g_chip_ident) (struct file *file, void *fh,
325 struct v4l2_chip_ident *chip);
dbbff48f 326
130ca945
DSL
327 /* For other private ioctls */
328 int (*vidioc_default) (struct file *file, void *fh,
329 int cmd, void *arg);
330
dbbff48f 331
5e87efa3 332#ifdef OBSOLETE_OWNER /* to be removed soon */
401998fa
MCC
333/* obsolete -- fops->owner is used instead */
334struct module *owner;
335/* dev->driver_data will be used instead some day.
336 * Use the video_{get|set}_drvdata() helper functions,
337 * so the switch over will be transparent for you.
338 * Or use {pci|usb}_{get|set}_drvdata() directly. */
339void *priv;
340#endif
341
342 /* for videodev.c intenal usage -- please don't touch */
343 int users; /* video_exclusive_{open|close} ... */
344 struct mutex lock; /* ... helper function uses these */
401998fa
MCC
345};
346
e90ff923
LT
347/* Class-dev to video-device */
348#define to_video_device(cd) container_of(cd, struct video_device, class_dev)
349
401998fa
MCC
350/* Version 2 functions */
351extern int video_register_device(struct video_device *vfd, int type, int nr);
539a7555 352int video_register_device_index(struct video_device *vfd, int type, int nr,
353 int index);
401998fa
MCC
354void video_unregister_device(struct video_device *);
355extern int video_ioctl2(struct inode *inode, struct file *file,
356 unsigned int cmd, unsigned long arg);
357
358/* helper functions to alloc / release struct video_device, the
359 later can be used for video_device->release() */
360struct video_device *video_device_alloc(void);
361void video_device_release(struct video_device *vfd);
362
363/* Include support for obsoleted stuff */
364extern int video_usercopy(struct inode *inode, struct file *file,
365 unsigned int cmd, unsigned long arg,
366 int (*func)(struct inode *inode, struct file *file,
367 unsigned int cmd, void *arg));
368
8a905162 369#ifdef CONFIG_VIDEO_V4L1_COMPAT
401998fa
MCC
370#include <linux/mm.h>
371
8a6914ab 372static inline int __must_check
401998fa 373video_device_create_file(struct video_device *vfd,
54bd5b66 374 struct device_attribute *attr)
401998fa 375{
54bd5b66 376 int ret = device_create_file(&vfd->class_dev, attr);
3117beec 377 if (ret < 0)
2bc93aa3 378 printk(KERN_WARNING "%s error: %d\n", __func__, ret);
3117beec 379 return ret;
401998fa
MCC
380}
381static inline void
382video_device_remove_file(struct video_device *vfd,
54bd5b66 383 struct device_attribute *attr)
401998fa 384{
54bd5b66 385 device_remove_file(&vfd->class_dev, attr);
401998fa
MCC
386}
387
8a905162
MCC
388#endif /* CONFIG_VIDEO_V4L1_COMPAT */
389
5e87efa3 390#ifdef OBSOLETE_OWNER /* to be removed soon */
401998fa
MCC
391/* helper functions to access driver private data. */
392static inline void *video_get_drvdata(struct video_device *dev)
393{
394 return dev->priv;
395}
396
397static inline void video_set_drvdata(struct video_device *dev, void *data)
398{
399 dev->priv = data;
400}
38ee04f0 401
401998fa
MCC
402#endif
403
38ee04f0
MCC
404#ifdef OBSOLETE_DEVDATA /* to be removed soon */
405/* Obsolete stuff - Still needed for radio devices and obsolete drivers */
406extern struct video_device* video_devdata(struct file*);
401998fa
MCC
407extern int video_exclusive_open(struct inode *inode, struct file *file);
408extern int video_exclusive_release(struct inode *inode, struct file *file);
38ee04f0 409#endif
401998fa
MCC
410
411#endif /* _V4L2_DEV_H */