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,
80 /* Forward definition of v4l2-common.h defined structure */
84 * Newer version of video_device, handled by videodev2.c
85 * This version moves redundant code from video device code to
92 const struct file_operations *fops;
102 int debug; /* Activates debug level*/
104 /* Video standard vars */
105 v4l2_std_id tvnorms; /* Supported tv norms */
106 v4l2_std_id current_norm; /* Current tvnorm */
109 void (*release)(struct video_device *vfd);
111 /* ioctl callbacks */
113 /* VIDIOC_QUERYCAP handler */
114 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
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);
122 /* VIDIOC_ENUM_FMT handlers */
123 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh,
124 struct v4l2_fmtdesc *f);
125 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh,
126 struct v4l2_fmtdesc *f);
127 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh,
128 struct v4l2_fmtdesc *f);
129 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh,
130 struct v4l2_fmtdesc *f);
131 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh,
132 struct v4l2_fmtdesc *f);
133 int (*vidioc_enum_fmt_vbi_output) (struct file *file, void *fh,
134 struct v4l2_fmtdesc *f);
135 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
136 struct v4l2_fmtdesc *f);
138 /* VIDIOC_G_FMT handlers */
139 int (*vidioc_g_fmt_cap) (struct file *file, void *fh,
140 struct v4l2_format *f);
141 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh,
142 struct v4l2_format *f);
143 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh,
144 struct v4l2_format *f);
145 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh,
146 struct v4l2_format *f);
147 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh,
148 struct v4l2_format *f);
149 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh,
150 struct v4l2_format *f);
151 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh,
152 struct v4l2_format *f);
154 /* VIDIOC_S_FMT handlers */
155 int (*vidioc_s_fmt_cap) (struct file *file, void *fh,
156 struct v4l2_format *f);
158 int (*vidioc_s_fmt_overlay) (struct file *file, void *fh,
159 struct v4l2_format *f);
160 int (*vidioc_s_fmt_vbi) (struct file *file, void *fh,
161 struct v4l2_format *f);
162 int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh,
163 struct v4l2_format *f);
164 int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh,
165 struct v4l2_format *f);
166 int (*vidioc_s_fmt_video_output)(struct file *file, void *fh,
167 struct v4l2_format *f);
168 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh,
169 struct v4l2_format *f);
171 /* VIDIOC_TRY_FMT handlers */
172 int (*vidioc_try_fmt_cap) (struct file *file, void *fh,
173 struct v4l2_format *f);
174 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh,
175 struct v4l2_format *f);
176 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh,
177 struct v4l2_format *f);
178 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh,
179 struct v4l2_format *f);
180 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh,
181 struct v4l2_format *f);
182 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh,
183 struct v4l2_format *f);
184 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh,
185 struct v4l2_format *f);
187 /* Buffer handlers */
188 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
189 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
190 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
191 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
194 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
195 #ifdef CONFIG_VIDEO_V4L1_COMPAT
196 /* buffer type is struct vidio_mbuf * */
197 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p);
199 int (*vidioc_g_fbuf) (struct file *file, void *fh,
200 struct v4l2_framebuffer *a);
201 int (*vidioc_s_fbuf) (struct file *file, void *fh,
202 struct v4l2_framebuffer *a);
205 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
206 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
209 G_STD and ENUMSTD are handled by videodev.c
211 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
212 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
215 int (*vidioc_enum_input)(struct file *file, void *fh,
216 struct v4l2_input *inp);
217 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
218 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
220 /* Output handling */
221 int (*vidioc_enumoutput) (struct file *file, void *fh,
222 struct v4l2_output *a);
223 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
224 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
226 /* Control handling */
227 int (*vidioc_queryctrl) (struct file *file, void *fh,
228 struct v4l2_queryctrl *a);
229 int (*vidioc_g_ctrl) (struct file *file, void *fh,
230 struct v4l2_control *a);
231 int (*vidioc_s_ctrl) (struct file *file, void *fh,
232 struct v4l2_control *a);
233 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
234 struct v4l2_ext_controls *a);
235 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
236 struct v4l2_ext_controls *a);
237 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
238 struct v4l2_ext_controls *a);
239 int (*vidioc_querymenu) (struct file *file, void *fh,
240 struct v4l2_querymenu *a);
243 int (*vidioc_enumaudio) (struct file *file, void *fh,
244 struct v4l2_audio *a);
245 int (*vidioc_g_audio) (struct file *file, void *fh,
246 struct v4l2_audio *a);
247 int (*vidioc_s_audio) (struct file *file, void *fh,
248 struct v4l2_audio *a);
250 /* Audio out ioctls */
251 int (*vidioc_enumaudout) (struct file *file, void *fh,
252 struct v4l2_audioout *a);
253 int (*vidioc_g_audout) (struct file *file, void *fh,
254 struct v4l2_audioout *a);
255 int (*vidioc_s_audout) (struct file *file, void *fh,
256 struct v4l2_audioout *a);
257 int (*vidioc_g_modulator) (struct file *file, void *fh,
258 struct v4l2_modulator *a);
259 int (*vidioc_s_modulator) (struct file *file, void *fh,
260 struct v4l2_modulator *a);
262 int (*vidioc_cropcap) (struct file *file, void *fh,
263 struct v4l2_cropcap *a);
264 int (*vidioc_g_crop) (struct file *file, void *fh,
265 struct v4l2_crop *a);
266 int (*vidioc_s_crop) (struct file *file, void *fh,
267 struct v4l2_crop *a);
268 /* Compression ioctls */
269 int (*vidioc_g_mpegcomp) (struct file *file, void *fh,
270 struct v4l2_mpeg_compression *a);
271 int (*vidioc_s_mpegcomp) (struct file *file, void *fh,
272 struct v4l2_mpeg_compression *a);
273 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
274 struct v4l2_jpegcompression *a);
275 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
276 struct v4l2_jpegcompression *a);
278 /* Stream type-dependent parameter ioctls */
279 int (*vidioc_g_parm) (struct file *file, void *fh,
280 struct v4l2_streamparm *a);
281 int (*vidioc_s_parm) (struct file *file, void *fh,
282 struct v4l2_streamparm *a);
285 int (*vidioc_g_tuner) (struct file *file, void *fh,
286 struct v4l2_tuner *a);
287 int (*vidioc_s_tuner) (struct file *file, void *fh,
288 struct v4l2_tuner *a);
289 int (*vidioc_g_frequency) (struct file *file, void *fh,
290 struct v4l2_frequency *a);
291 int (*vidioc_s_frequency) (struct file *file, void *fh,
292 struct v4l2_frequency *a);
295 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
296 struct v4l2_sliced_vbi_cap *a);
298 /* Log status ioctl */
299 int (*vidioc_log_status) (struct file *file, void *fh);
302 /* Debugging ioctls */
303 #ifdef CONFIG_VIDEO_ADV_DEBUG
304 int (*vidioc_g_register) (struct file *file, void *fh,
305 struct v4l2_register *reg);
306 int (*vidioc_s_register) (struct file *file, void *fh,
307 struct v4l2_register *reg);
311 #ifdef OBSOLETE_OWNER /* to be removed soon */
312 /* obsolete -- fops->owner is used instead */
313 struct module *owner;
314 /* dev->driver_data will be used instead some day.
315 * Use the video_{get|set}_drvdata() helper functions,
316 * so the switch over will be transparent for you.
317 * Or use {pci|usb}_{get|set}_drvdata() directly. */
321 /* for videodev.c intenal usage -- please don't touch */
322 int users; /* video_exclusive_{open|close} ... */
323 struct mutex lock; /* ... helper function uses these */
324 struct class_device class_dev; /* sysfs */
327 /* Version 2 functions */
328 extern int video_register_device(struct video_device *vfd, int type, int nr);
329 void video_unregister_device(struct video_device *);
330 extern int video_ioctl2(struct inode *inode, struct file *file,
331 unsigned int cmd, unsigned long arg);
333 /* helper functions to alloc / release struct video_device, the
334 later can be used for video_device->release() */
335 struct video_device *video_device_alloc(void);
336 void video_device_release(struct video_device *vfd);
338 /* Include support for obsoleted stuff */
339 extern int video_usercopy(struct inode *inode, struct file *file,
340 unsigned int cmd, unsigned long arg,
341 int (*func)(struct inode *inode, struct file *file,
342 unsigned int cmd, void *arg));
345 #ifdef CONFIG_VIDEO_V4L1_COMPAT
346 #include <linux/mm.h>
348 #define to_video_device(cd) container_of(cd, struct video_device, class_dev)
349 static inline int __must_check
350 video_device_create_file(struct video_device *vfd,
351 struct class_device_attribute *attr)
353 int ret = class_device_create_file(&vfd->class_dev, attr);
355 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret);
359 video_device_remove_file(struct video_device *vfd,
360 struct class_device_attribute *attr)
362 class_device_remove_file(&vfd->class_dev, attr);
365 #endif /* CONFIG_VIDEO_V4L1_COMPAT */
367 #ifdef OBSOLETE_OWNER /* to be removed soon */
368 /* helper functions to access driver private data. */
369 static inline void *video_get_drvdata(struct video_device *dev)
374 static inline void video_set_drvdata(struct video_device *dev, void *data)
381 #ifdef OBSOLETE_DEVDATA /* to be removed soon */
382 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */
383 extern struct video_device* video_devdata(struct file*);
384 extern int video_exclusive_open(struct inode *inode, struct file *file);
385 extern int video_exclusive_release(struct inode *inode, struct file *file);
388 #endif /* _V4L2_DEV_H */