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>
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
37 #define VFL_TYPE_GRABBER 0
38 #define VFL_TYPE_VBI 1
39 #define VFL_TYPE_RADIO 2
40 #define VFL_TYPE_VTX 3
42 /* Video standard functions */
43 extern const char *v4l2_norm_to_name(v4l2_std_id id);
44 extern int v4l2_video_std_construct(struct v4l2_standard *vs,
45 int id, const char *name);
46 /* Prints the ioctl in a human-readable format */
47 extern void v4l_printk_ioctl(unsigned int cmd);
49 /* prority handling */
50 struct v4l2_prio_state {
53 int v4l2_prio_init(struct v4l2_prio_state *global);
54 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
55 enum v4l2_priority new);
56 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
57 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
58 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
59 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
61 /* names for fancy debug output */
62 extern char *v4l2_field_names[];
63 extern char *v4l2_type_names[];
65 /* Compatibility layer interface -- v4l1-compat module */
66 typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
67 unsigned int cmd, void *arg);
68 #ifdef CONFIG_VIDEO_V4L1_COMPAT
69 int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
70 int cmd, void *arg, v4l2_kioctl driver_ioctl);
72 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
75 /* 32 Bits compatibility layer for 64 bits processors */
76 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
80 * Newer version of video_device, handled by videodev2.c
81 * This version moves redundant code from video device code to
88 const struct file_operations *fops;
91 struct device class_dev; /* v4l device */
92 struct device *dev; /* device parent */
100 int debug; /* Activates debug level*/
102 /* Video standard vars */
103 v4l2_std_id tvnorms; /* Supported tv norms */
104 v4l2_std_id current_norm; /* Current tvnorm */
107 void (*release)(struct video_device *vfd);
109 /* ioctl callbacks */
111 /* VIDIOC_QUERYCAP handler */
112 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
114 /* Priority handling */
115 int (*vidioc_g_priority) (struct file *file, void *fh,
116 enum v4l2_priority *p);
117 int (*vidioc_s_priority) (struct file *file, void *fh,
118 enum v4l2_priority p);
120 /* VIDIOC_ENUM_FMT handlers */
121 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh,
122 struct v4l2_fmtdesc *f);
123 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh,
124 struct v4l2_fmtdesc *f);
125 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh,
126 struct v4l2_fmtdesc *f);
127 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh,
128 struct v4l2_fmtdesc *f);
129 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh,
130 struct v4l2_fmtdesc *f);
131 int (*vidioc_enum_fmt_output_overlay) (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_sliced_vbi_output) (struct file *file, void *fh,
136 struct v4l2_fmtdesc *f);
137 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
138 struct v4l2_fmtdesc *f);
140 /* VIDIOC_G_FMT handlers */
141 int (*vidioc_g_fmt_cap) (struct file *file, void *fh,
142 struct v4l2_format *f);
143 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh,
144 struct v4l2_format *f);
145 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh,
146 struct v4l2_format *f);
147 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh,
148 struct v4l2_format *f);
149 int (*vidioc_g_fmt_sliced_vbi_output) (struct file *file, void *fh,
150 struct v4l2_format *f);
151 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh,
152 struct v4l2_format *f);
153 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh,
154 struct v4l2_format *f);
155 int (*vidioc_g_fmt_output_overlay) (struct file *file, void *fh,
156 struct v4l2_format *f);
157 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh,
158 struct v4l2_format *f);
160 /* VIDIOC_S_FMT handlers */
161 int (*vidioc_s_fmt_cap) (struct file *file, void *fh,
162 struct v4l2_format *f);
164 int (*vidioc_s_fmt_overlay) (struct file *file, void *fh,
165 struct v4l2_format *f);
166 int (*vidioc_s_fmt_vbi) (struct file *file, void *fh,
167 struct v4l2_format *f);
168 int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh,
169 struct v4l2_format *f);
170 int (*vidioc_s_fmt_sliced_vbi_output) (struct file *file, void *fh,
171 struct v4l2_format *f);
172 int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh,
173 struct v4l2_format *f);
174 int (*vidioc_s_fmt_video_output)(struct file *file, void *fh,
175 struct v4l2_format *f);
176 int (*vidioc_s_fmt_output_overlay) (struct file *file, void *fh,
177 struct v4l2_format *f);
178 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh,
179 struct v4l2_format *f);
181 /* VIDIOC_TRY_FMT handlers */
182 int (*vidioc_try_fmt_cap) (struct file *file, void *fh,
183 struct v4l2_format *f);
184 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh,
185 struct v4l2_format *f);
186 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh,
187 struct v4l2_format *f);
188 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh,
189 struct v4l2_format *f);
190 int (*vidioc_try_fmt_sliced_vbi_output) (struct file *file, void *fh,
191 struct v4l2_format *f);
192 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh,
193 struct v4l2_format *f);
194 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh,
195 struct v4l2_format *f);
196 int (*vidioc_try_fmt_output_overlay)(struct file *file, void *fh,
197 struct v4l2_format *f);
198 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh,
199 struct v4l2_format *f);
201 /* Buffer handlers */
202 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
203 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
204 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
205 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
208 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
209 #ifdef CONFIG_VIDEO_V4L1_COMPAT
210 /* buffer type is struct vidio_mbuf * */
211 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p);
213 int (*vidioc_g_fbuf) (struct file *file, void *fh,
214 struct v4l2_framebuffer *a);
215 int (*vidioc_s_fbuf) (struct file *file, void *fh,
216 struct v4l2_framebuffer *a);
219 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
220 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
223 ENUMSTD is handled by videodev.c
225 int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
226 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
227 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
230 int (*vidioc_enum_input)(struct file *file, void *fh,
231 struct v4l2_input *inp);
232 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
233 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
235 /* Output handling */
236 int (*vidioc_enum_output) (struct file *file, void *fh,
237 struct v4l2_output *a);
238 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
239 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
241 /* Control handling */
242 int (*vidioc_queryctrl) (struct file *file, void *fh,
243 struct v4l2_queryctrl *a);
244 int (*vidioc_g_ctrl) (struct file *file, void *fh,
245 struct v4l2_control *a);
246 int (*vidioc_s_ctrl) (struct file *file, void *fh,
247 struct v4l2_control *a);
248 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
249 struct v4l2_ext_controls *a);
250 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
251 struct v4l2_ext_controls *a);
252 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
253 struct v4l2_ext_controls *a);
254 int (*vidioc_querymenu) (struct file *file, void *fh,
255 struct v4l2_querymenu *a);
258 int (*vidioc_enumaudio) (struct file *file, void *fh,
259 struct v4l2_audio *a);
260 int (*vidioc_g_audio) (struct file *file, void *fh,
261 struct v4l2_audio *a);
262 int (*vidioc_s_audio) (struct file *file, void *fh,
263 struct v4l2_audio *a);
265 /* Audio out ioctls */
266 int (*vidioc_enumaudout) (struct file *file, void *fh,
267 struct v4l2_audioout *a);
268 int (*vidioc_g_audout) (struct file *file, void *fh,
269 struct v4l2_audioout *a);
270 int (*vidioc_s_audout) (struct file *file, void *fh,
271 struct v4l2_audioout *a);
272 int (*vidioc_g_modulator) (struct file *file, void *fh,
273 struct v4l2_modulator *a);
274 int (*vidioc_s_modulator) (struct file *file, void *fh,
275 struct v4l2_modulator *a);
277 int (*vidioc_cropcap) (struct file *file, void *fh,
278 struct v4l2_cropcap *a);
279 int (*vidioc_g_crop) (struct file *file, void *fh,
280 struct v4l2_crop *a);
281 int (*vidioc_s_crop) (struct file *file, void *fh,
282 struct v4l2_crop *a);
283 /* Compression ioctls */
284 int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
285 struct v4l2_jpegcompression *a);
286 int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
287 struct v4l2_jpegcompression *a);
288 int (*vidioc_g_enc_index) (struct file *file, void *fh,
289 struct v4l2_enc_idx *a);
290 int (*vidioc_encoder_cmd) (struct file *file, void *fh,
291 struct v4l2_encoder_cmd *a);
292 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh,
293 struct v4l2_encoder_cmd *a);
295 /* Stream type-dependent parameter ioctls */
296 int (*vidioc_g_parm) (struct file *file, void *fh,
297 struct v4l2_streamparm *a);
298 int (*vidioc_s_parm) (struct file *file, void *fh,
299 struct v4l2_streamparm *a);
302 int (*vidioc_g_tuner) (struct file *file, void *fh,
303 struct v4l2_tuner *a);
304 int (*vidioc_s_tuner) (struct file *file, void *fh,
305 struct v4l2_tuner *a);
306 int (*vidioc_g_frequency) (struct file *file, void *fh,
307 struct v4l2_frequency *a);
308 int (*vidioc_s_frequency) (struct file *file, void *fh,
309 struct v4l2_frequency *a);
312 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
313 struct v4l2_sliced_vbi_cap *a);
315 /* Log status ioctl */
316 int (*vidioc_log_status) (struct file *file, void *fh);
318 int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh,
319 struct v4l2_hw_freq_seek *a);
321 /* Debugging ioctls */
322 #ifdef CONFIG_VIDEO_ADV_DEBUG
323 int (*vidioc_g_register) (struct file *file, void *fh,
324 struct v4l2_register *reg);
325 int (*vidioc_s_register) (struct file *file, void *fh,
326 struct v4l2_register *reg);
328 int (*vidioc_g_chip_ident) (struct file *file, void *fh,
329 struct v4l2_chip_ident *chip);
331 /* For other private ioctls */
332 int (*vidioc_default) (struct file *file, void *fh,
336 #ifdef OBSOLETE_OWNER /* to be removed soon */
337 /* obsolete -- fops->owner is used instead */
338 struct module *owner;
339 /* dev->driver_data will be used instead some day.
340 * Use the video_{get|set}_drvdata() helper functions,
341 * so the switch over will be transparent for you.
342 * Or use {pci|usb}_{get|set}_drvdata() directly. */
346 /* for videodev.c intenal usage -- please don't touch */
347 int users; /* video_exclusive_{open|close} ... */
348 struct mutex lock; /* ... helper function uses these */
351 /* Class-dev to video-device */
352 #define to_video_device(cd) container_of(cd, struct video_device, class_dev)
354 /* Version 2 functions */
355 extern int video_register_device(struct video_device *vfd, int type, int nr);
356 void video_unregister_device(struct video_device *);
357 extern int video_ioctl2(struct inode *inode, struct file *file,
358 unsigned int cmd, unsigned long arg);
360 /* helper functions to alloc / release struct video_device, the
361 later can be used for video_device->release() */
362 struct video_device *video_device_alloc(void);
363 void video_device_release(struct video_device *vfd);
365 /* Include support for obsoleted stuff */
366 extern int video_usercopy(struct inode *inode, struct file *file,
367 unsigned int cmd, unsigned long arg,
368 int (*func)(struct inode *inode, struct file *file,
369 unsigned int cmd, void *arg));
371 #ifdef CONFIG_VIDEO_V4L1_COMPAT
372 #include <linux/mm.h>
374 static inline int __must_check
375 video_device_create_file(struct video_device *vfd,
376 struct device_attribute *attr)
378 int ret = device_create_file(&vfd->class_dev, attr);
380 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret);
384 video_device_remove_file(struct video_device *vfd,
385 struct device_attribute *attr)
387 device_remove_file(&vfd->class_dev, attr);
390 #endif /* CONFIG_VIDEO_V4L1_COMPAT */
392 #ifdef OBSOLETE_OWNER /* to be removed soon */
393 /* helper functions to access driver private data. */
394 static inline void *video_get_drvdata(struct video_device *dev)
399 static inline void video_set_drvdata(struct video_device *dev, void *data)
406 #ifdef OBSOLETE_DEVDATA /* to be removed soon */
407 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */
408 extern struct video_device* video_devdata(struct file*);
409 extern int video_exclusive_open(struct inode *inode, struct file *file);
410 extern int video_exclusive_release(struct inode *inode, struct file *file);
413 #endif /* _V4L2_DEV_H */