3 * V 4 L 2 D R I V E R H E L P E R A P I
5 * Moved from videodev2.h
7 * Some commonly needed functions for drivers (v4l2-common.o module)
12 #define OBSOLETE_OWNER 1 /* to be removed soon */
13 #define OBSOLETE_DEVDATA 1 /* to be removed soon */
15 #include <linux/poll.h>
17 #include <linux/device.h>
18 #include <linux/mutex.h>
19 #include <linux/compiler.h> /* need __user */
20 #ifdef CONFIG_VIDEO_V4L1_COMPAT
21 #include <linux/videodev.h>
23 #include <linux/videodev2.h>
28 #define VIDEO_MAJOR 81
29 /* Minor device allocation */
30 #define MINOR_VFL_TYPE_GRABBER_MIN 0
31 #define MINOR_VFL_TYPE_GRABBER_MAX 63
32 #define MINOR_VFL_TYPE_RADIO_MIN 64
33 #define MINOR_VFL_TYPE_RADIO_MAX 127
34 #define MINOR_VFL_TYPE_VTX_MIN 192
35 #define MINOR_VFL_TYPE_VTX_MAX 223
36 #define MINOR_VFL_TYPE_VBI_MIN 224
37 #define MINOR_VFL_TYPE_VBI_MAX 255
39 #define VFL_TYPE_GRABBER 0
40 #define VFL_TYPE_VBI 1
41 #define VFL_TYPE_RADIO 2
42 #define VFL_TYPE_VTX 3
44 /* Video standard functions */
45 extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
46 extern char *v4l2_norm_to_name(v4l2_std_id id);
47 extern int v4l2_video_std_construct(struct v4l2_standard *vs,
50 /* prority handling */
51 struct v4l2_prio_state {
54 int v4l2_prio_init(struct v4l2_prio_state *global);
55 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
56 enum v4l2_priority new);
57 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
58 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
59 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
60 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
62 /* names for fancy debug output */
63 extern char *v4l2_field_names[];
64 extern char *v4l2_type_names[];
66 /* Compatibility layer interface -- v4l1-compat module */
67 typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
68 unsigned int cmd, void *arg);
69 #ifdef CONFIG_VIDEO_V4L1_COMPAT
70 int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
71 int cmd, void *arg, v4l2_kioctl driver_ioctl);
73 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
76 /* 32 Bits compatibility layer for 64 bits processors */
77 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
81 * Newer version of video_device, handled by videodev2.c
82 * This version moves redundant code from video device code to
89 const struct file_operations *fops;
99 int debug; /* Activates debug level*/
101 /* Video standard vars */
102 v4l2_std_id tvnorms; /* Supported tv norms */
103 v4l2_std_id current_norm; /* Current tvnorm */
106 void (*release)(struct video_device *vfd);
108 /* ioctl callbacks */
110 /* VIDIOC_QUERYCAP handler */
111 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
113 /* Priority handling */
114 int (*vidioc_g_priority) (struct file *file, void *fh,
115 enum v4l2_priority *p);
116 int (*vidioc_s_priority) (struct file *file, void *fh,
117 enum v4l2_priority p);
119 /* VIDIOC_ENUM_FMT handlers */
120 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh,
121 struct v4l2_fmtdesc *f);
122 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh,
123 struct v4l2_fmtdesc *f);
124 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh,
125 struct v4l2_fmtdesc *f);
126 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh,
127 struct v4l2_fmtdesc *f);
128 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh,
129 struct v4l2_fmtdesc *f);
130 int (*vidioc_enum_fmt_vbi_output) (struct file *file, void *fh,
131 struct v4l2_fmtdesc *f);
132 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
133 struct v4l2_fmtdesc *f);
135 /* VIDIOC_G_FMT handlers */
136 int (*vidioc_g_fmt_cap) (struct file *file, void *fh,
137 struct v4l2_format *f);
138 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh,
139 struct v4l2_format *f);
140 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh,
141 struct v4l2_format *f);
142 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh,
143 struct v4l2_format *f);
144 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh,
145 struct v4l2_format *f);
146 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh,
147 struct v4l2_format *f);
148 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh,
149 struct v4l2_format *f);
151 /* VIDIOC_S_FMT handlers */
152 int (*vidioc_s_fmt_cap) (struct file *file, void *fh,
153 struct v4l2_format *f);
155 int (*vidioc_s_fmt_overlay) (struct file *file, void *fh,
156 struct v4l2_format *f);
157 int (*vidioc_s_fmt_vbi) (struct file *file, void *fh,
158 struct v4l2_format *f);
159 int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh,
160 struct v4l2_format *f);
161 int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh,
162 struct v4l2_format *f);
163 int (*vidioc_s_fmt_video_output)(struct file *file, void *fh,
164 struct v4l2_format *f);
165 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh,
166 struct v4l2_format *f);
168 /* VIDIOC_TRY_FMT handlers */
169 int (*vidioc_try_fmt_cap) (struct file *file, void *fh,
170 struct v4l2_format *f);
171 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh,
172 struct v4l2_format *f);
173 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh,
174 struct v4l2_format *f);
175 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh,
176 struct v4l2_format *f);
177 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh,
178 struct v4l2_format *f);
179 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh,
180 struct v4l2_format *f);
181 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh,
182 struct v4l2_format *f);
184 /* Buffer handlers */
185 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
186 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
187 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
188 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
191 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
192 #ifdef CONFIG_VIDEO_V4L1_COMPAT
193 /* buffer type is struct vidio_mbuf * */
194 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p);
196 int (*vidioc_g_fbuf) (struct file *file, void *fh,
197 struct v4l2_framebuffer *a);
198 int (*vidioc_s_fbuf) (struct file *file, void *fh,
199 struct v4l2_framebuffer *a);
202 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
203 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
206 G_STD and ENUMSTD are handled by videodev.c
208 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
209 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
212 int (*vidioc_enum_input)(struct file *file, void *fh,
213 struct v4l2_input *inp);
214 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
215 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
217 /* Output handling */
218 int (*vidioc_enumoutput) (struct file *file, void *fh,
219 struct v4l2_output *a);
220 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
221 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
223 /* Control handling */
224 int (*vidioc_queryctrl) (struct file *file, void *fh,
225 struct v4l2_queryctrl *a);
226 int (*vidioc_g_ctrl) (struct file *file, void *fh,
227 struct v4l2_control *a);
228 int (*vidioc_s_ctrl) (struct file *file, void *fh,
229 struct v4l2_control *a);
230 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
231 struct v4l2_ext_controls *a);
232 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
233 struct v4l2_ext_controls *a);
234 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
235 struct v4l2_ext_controls *a);
236 int (*vidioc_querymenu) (struct file *file, void *fh,
237 struct v4l2_querymenu *a);
240 int (*vidioc_enumaudio) (struct file *file, void *fh,
241 struct v4l2_audio *a);
242 int (*vidioc_g_audio) (struct file *file, void *fh,
243 struct v4l2_audio *a);
244 int (*vidioc_s_audio) (struct file *file, void *fh,
245 struct v4l2_audio *a);
247 /* Audio out ioctls */
248 int (*vidioc_enumaudout) (struct file *file, void *fh,
249 struct v4l2_audioout *a);
250 int (*vidioc_g_audout) (struct file *file, void *fh,
251 struct v4l2_audioout *a);
252 int (*vidioc_s_audout) (struct file *file, void *fh,
253 struct v4l2_audioout *a);
254 int (*vidioc_g_modulator) (struct file *file, void *fh,
255 struct v4l2_modulator *a);
256 int (*vidioc_s_modulator) (struct file *file, void *fh,
257 struct v4l2_modulator *a);
259 int (*vidioc_cropcap) (struct file *file, void *fh,
260 struct v4l2_cropcap *a);
261 int (*vidioc_g_crop) (struct file *file, void *fh,
262 struct v4l2_crop *a);
263 int (*vidioc_s_crop) (struct file *file, void *fh,
264 struct v4l2_crop *a);
265 /* Compression ioctls */
266 int (*vidioc_g_mpegcomp) (struct file *file, void *fh,
267 struct v4l2_mpeg_compression *a);
268 int (*vidioc_s_mpegcomp) (struct file *file, void *fh,
269 struct v4l2_mpeg_compression *a);
270 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
271 struct v4l2_jpegcompression *a);
272 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
273 struct v4l2_jpegcompression *a);
274 int (*vidioc_g_enc_index) (struct file *file, void *fh,
275 struct v4l2_enc_idx *a);
277 /* Stream type-dependent parameter ioctls */
278 int (*vidioc_g_parm) (struct file *file, void *fh,
279 struct v4l2_streamparm *a);
280 int (*vidioc_s_parm) (struct file *file, void *fh,
281 struct v4l2_streamparm *a);
284 int (*vidioc_g_tuner) (struct file *file, void *fh,
285 struct v4l2_tuner *a);
286 int (*vidioc_s_tuner) (struct file *file, void *fh,
287 struct v4l2_tuner *a);
288 int (*vidioc_g_frequency) (struct file *file, void *fh,
289 struct v4l2_frequency *a);
290 int (*vidioc_s_frequency) (struct file *file, void *fh,
291 struct v4l2_frequency *a);
294 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
295 struct v4l2_sliced_vbi_cap *a);
297 /* Log status ioctl */
298 int (*vidioc_log_status) (struct file *file, void *fh);
301 /* Debugging ioctls */
302 #ifdef CONFIG_VIDEO_ADV_DEBUG
303 int (*vidioc_g_register) (struct file *file, void *fh,
304 struct v4l2_register *reg);
305 int (*vidioc_s_register) (struct file *file, void *fh,
306 struct v4l2_register *reg);
310 #ifdef OBSOLETE_OWNER /* to be removed soon */
311 /* obsolete -- fops->owner is used instead */
312 struct module *owner;
313 /* dev->driver_data will be used instead some day.
314 * Use the video_{get|set}_drvdata() helper functions,
315 * so the switch over will be transparent for you.
316 * Or use {pci|usb}_{get|set}_drvdata() directly. */
320 /* for videodev.c intenal usage -- please don't touch */
321 int users; /* video_exclusive_{open|close} ... */
322 struct mutex lock; /* ... helper function uses these */
323 struct class_device class_dev; /* sysfs */
326 /* Version 2 functions */
327 extern int video_register_device(struct video_device *vfd, int type, int nr);
328 void video_unregister_device(struct video_device *);
329 extern int video_ioctl2(struct inode *inode, struct file *file,
330 unsigned int cmd, unsigned long arg);
332 /* helper functions to alloc / release struct video_device, the
333 later can be used for video_device->release() */
334 struct video_device *video_device_alloc(void);
335 void video_device_release(struct video_device *vfd);
337 /* Include support for obsoleted stuff */
338 extern int video_usercopy(struct inode *inode, struct file *file,
339 unsigned int cmd, unsigned long arg,
340 int (*func)(struct inode *inode, struct file *file,
341 unsigned int cmd, void *arg));
344 #ifdef CONFIG_VIDEO_V4L1_COMPAT
345 #include <linux/mm.h>
347 #define to_video_device(cd) container_of(cd, struct video_device, class_dev)
348 static inline int __must_check
349 video_device_create_file(struct video_device *vfd,
350 struct class_device_attribute *attr)
352 int ret = class_device_create_file(&vfd->class_dev, attr);
354 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret);
358 video_device_remove_file(struct video_device *vfd,
359 struct class_device_attribute *attr)
361 class_device_remove_file(&vfd->class_dev, attr);
364 #endif /* CONFIG_VIDEO_V4L1_COMPAT */
366 #ifdef OBSOLETE_OWNER /* to be removed soon */
367 /* helper functions to access driver private data. */
368 static inline void *video_get_drvdata(struct video_device *dev)
373 static inline void video_set_drvdata(struct video_device *dev, void *data)
380 #ifdef OBSOLETE_DEVDATA /* to be removed soon */
381 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */
382 extern struct video_device* video_devdata(struct file*);
383 extern int video_exclusive_open(struct inode *inode, struct file *file);
384 extern int video_exclusive_release(struct inode *inode, struct file *file);
387 #endif /* _V4L2_DEV_H */