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 unsigned int v4l2_video_std_fps(struct v4l2_standard
*vs
);
44 extern char *v4l2_norm_to_name(v4l2_std_id id
);
45 extern int v4l2_video_std_construct(struct v4l2_standard
*vs
,
48 /* prority handling */
49 struct v4l2_prio_state
{
52 int v4l2_prio_init(struct v4l2_prio_state
*global
);
53 int v4l2_prio_change(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
,
54 enum v4l2_priority
new);
55 int v4l2_prio_open(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
56 int v4l2_prio_close(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
57 enum v4l2_priority
v4l2_prio_max(struct v4l2_prio_state
*global
);
58 int v4l2_prio_check(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
);
60 /* names for fancy debug output */
61 extern char *v4l2_field_names
[];
62 extern char *v4l2_type_names
[];
64 /* Compatibility layer interface -- v4l1-compat module */
65 typedef int (*v4l2_kioctl
)(struct inode
*inode
, struct file
*file
,
66 unsigned int cmd
, void *arg
);
67 #ifdef CONFIG_VIDEO_V4L1_COMPAT
68 int v4l_compat_translate_ioctl(struct inode
*inode
, struct file
*file
,
69 int cmd
, void *arg
, v4l2_kioctl driver_ioctl
);
71 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
74 /* 32 Bits compatibility layer for 64 bits processors */
75 extern long v4l_compat_ioctl32(struct file
*file
, unsigned int cmd
,
79 * Newer version of video_device, handled by videodev2.c
80 * This version moves redundant code from video device code to
87 const struct file_operations
*fops
;
97 int debug
; /* Activates debug level*/
99 /* Video standard vars */
100 v4l2_std_id tvnorms
; /* Supported tv norms */
101 v4l2_std_id current_norm
; /* Current tvnorm */
104 void (*release
)(struct video_device
*vfd
);
106 /* ioctl callbacks */
108 /* VIDIOC_QUERYCAP handler */
109 int (*vidioc_querycap
)(struct file
*file
, void *fh
, struct v4l2_capability
*cap
);
111 /* Priority handling */
112 int (*vidioc_g_priority
) (struct file
*file
, void *fh
,
113 enum v4l2_priority
*p
);
114 int (*vidioc_s_priority
) (struct file
*file
, void *fh
,
115 enum v4l2_priority p
);
117 /* VIDIOC_ENUM_FMT handlers */
118 int (*vidioc_enum_fmt_cap
) (struct file
*file
, void *fh
,
119 struct v4l2_fmtdesc
*f
);
120 int (*vidioc_enum_fmt_overlay
) (struct file
*file
, void *fh
,
121 struct v4l2_fmtdesc
*f
);
122 int (*vidioc_enum_fmt_vbi
) (struct file
*file
, void *fh
,
123 struct v4l2_fmtdesc
*f
);
124 int (*vidioc_enum_fmt_vbi_capture
) (struct file
*file
, void *fh
,
125 struct v4l2_fmtdesc
*f
);
126 int (*vidioc_enum_fmt_video_output
)(struct file
*file
, void *fh
,
127 struct v4l2_fmtdesc
*f
);
128 int (*vidioc_enum_fmt_output_overlay
) (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_output_overlay
) (struct file
*file
, void *fh
,
149 struct v4l2_format
*f
);
150 int (*vidioc_g_fmt_type_private
)(struct file
*file
, void *fh
,
151 struct v4l2_format
*f
);
153 /* VIDIOC_S_FMT handlers */
154 int (*vidioc_s_fmt_cap
) (struct file
*file
, void *fh
,
155 struct v4l2_format
*f
);
157 int (*vidioc_s_fmt_overlay
) (struct file
*file
, void *fh
,
158 struct v4l2_format
*f
);
159 int (*vidioc_s_fmt_vbi
) (struct file
*file
, void *fh
,
160 struct v4l2_format
*f
);
161 int (*vidioc_s_fmt_vbi_output
) (struct file
*file
, void *fh
,
162 struct v4l2_format
*f
);
163 int (*vidioc_s_fmt_vbi_capture
)(struct file
*file
, void *fh
,
164 struct v4l2_format
*f
);
165 int (*vidioc_s_fmt_video_output
)(struct file
*file
, void *fh
,
166 struct v4l2_format
*f
);
167 int (*vidioc_s_fmt_output_overlay
) (struct file
*file
, void *fh
,
168 struct v4l2_format
*f
);
169 int (*vidioc_s_fmt_type_private
)(struct file
*file
, void *fh
,
170 struct v4l2_format
*f
);
172 /* VIDIOC_TRY_FMT handlers */
173 int (*vidioc_try_fmt_cap
) (struct file
*file
, void *fh
,
174 struct v4l2_format
*f
);
175 int (*vidioc_try_fmt_overlay
) (struct file
*file
, void *fh
,
176 struct v4l2_format
*f
);
177 int (*vidioc_try_fmt_vbi
) (struct file
*file
, void *fh
,
178 struct v4l2_format
*f
);
179 int (*vidioc_try_fmt_vbi_output
) (struct file
*file
, void *fh
,
180 struct v4l2_format
*f
);
181 int (*vidioc_try_fmt_vbi_capture
)(struct file
*file
, void *fh
,
182 struct v4l2_format
*f
);
183 int (*vidioc_try_fmt_video_output
)(struct file
*file
, void *fh
,
184 struct v4l2_format
*f
);
185 int (*vidioc_try_fmt_output_overlay
)(struct file
*file
, void *fh
,
186 struct v4l2_format
*f
);
187 int (*vidioc_try_fmt_type_private
)(struct file
*file
, void *fh
,
188 struct v4l2_format
*f
);
190 /* Buffer handlers */
191 int (*vidioc_reqbufs
) (struct file
*file
, void *fh
, struct v4l2_requestbuffers
*b
);
192 int (*vidioc_querybuf
)(struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
193 int (*vidioc_qbuf
) (struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
194 int (*vidioc_dqbuf
) (struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
197 int (*vidioc_overlay
) (struct file
*file
, void *fh
, unsigned int i
);
198 #ifdef CONFIG_VIDEO_V4L1_COMPAT
199 /* buffer type is struct vidio_mbuf * */
200 int (*vidiocgmbuf
) (struct file
*file
, void *fh
, struct video_mbuf
*p
);
202 int (*vidioc_g_fbuf
) (struct file
*file
, void *fh
,
203 struct v4l2_framebuffer
*a
);
204 int (*vidioc_s_fbuf
) (struct file
*file
, void *fh
,
205 struct v4l2_framebuffer
*a
);
208 int (*vidioc_streamon
) (struct file
*file
, void *fh
, enum v4l2_buf_type i
);
209 int (*vidioc_streamoff
)(struct file
*file
, void *fh
, enum v4l2_buf_type i
);
212 G_STD and ENUMSTD are handled by videodev.c
214 int (*vidioc_s_std
) (struct file
*file
, void *fh
, v4l2_std_id
*norm
);
215 int (*vidioc_querystd
) (struct file
*file
, void *fh
, v4l2_std_id
*a
);
218 int (*vidioc_enum_input
)(struct file
*file
, void *fh
,
219 struct v4l2_input
*inp
);
220 int (*vidioc_g_input
) (struct file
*file
, void *fh
, unsigned int *i
);
221 int (*vidioc_s_input
) (struct file
*file
, void *fh
, unsigned int i
);
223 /* Output handling */
224 int (*vidioc_enumoutput
) (struct file
*file
, void *fh
,
225 struct v4l2_output
*a
);
226 int (*vidioc_g_output
) (struct file
*file
, void *fh
, unsigned int *i
);
227 int (*vidioc_s_output
) (struct file
*file
, void *fh
, unsigned int i
);
229 /* Control handling */
230 int (*vidioc_queryctrl
) (struct file
*file
, void *fh
,
231 struct v4l2_queryctrl
*a
);
232 int (*vidioc_g_ctrl
) (struct file
*file
, void *fh
,
233 struct v4l2_control
*a
);
234 int (*vidioc_s_ctrl
) (struct file
*file
, void *fh
,
235 struct v4l2_control
*a
);
236 int (*vidioc_g_ext_ctrls
) (struct file
*file
, void *fh
,
237 struct v4l2_ext_controls
*a
);
238 int (*vidioc_s_ext_ctrls
) (struct file
*file
, void *fh
,
239 struct v4l2_ext_controls
*a
);
240 int (*vidioc_try_ext_ctrls
) (struct file
*file
, void *fh
,
241 struct v4l2_ext_controls
*a
);
242 int (*vidioc_querymenu
) (struct file
*file
, void *fh
,
243 struct v4l2_querymenu
*a
);
246 int (*vidioc_enumaudio
) (struct file
*file
, void *fh
,
247 struct v4l2_audio
*a
);
248 int (*vidioc_g_audio
) (struct file
*file
, void *fh
,
249 struct v4l2_audio
*a
);
250 int (*vidioc_s_audio
) (struct file
*file
, void *fh
,
251 struct v4l2_audio
*a
);
253 /* Audio out ioctls */
254 int (*vidioc_enumaudout
) (struct file
*file
, void *fh
,
255 struct v4l2_audioout
*a
);
256 int (*vidioc_g_audout
) (struct file
*file
, void *fh
,
257 struct v4l2_audioout
*a
);
258 int (*vidioc_s_audout
) (struct file
*file
, void *fh
,
259 struct v4l2_audioout
*a
);
260 int (*vidioc_g_modulator
) (struct file
*file
, void *fh
,
261 struct v4l2_modulator
*a
);
262 int (*vidioc_s_modulator
) (struct file
*file
, void *fh
,
263 struct v4l2_modulator
*a
);
265 int (*vidioc_cropcap
) (struct file
*file
, void *fh
,
266 struct v4l2_cropcap
*a
);
267 int (*vidioc_g_crop
) (struct file
*file
, void *fh
,
268 struct v4l2_crop
*a
);
269 int (*vidioc_s_crop
) (struct file
*file
, void *fh
,
270 struct v4l2_crop
*a
);
271 /* Compression ioctls */
272 int (*vidioc_g_mpegcomp
) (struct file
*file
, void *fh
,
273 struct v4l2_mpeg_compression
*a
);
274 int (*vidioc_s_mpegcomp
) (struct file
*file
, void *fh
,
275 struct v4l2_mpeg_compression
*a
);
276 int (*vidioc_g_jpegcomp
) (struct file
*file
, void *fh
,
277 struct v4l2_jpegcompression
*a
);
278 int (*vidioc_s_jpegcomp
) (struct file
*file
, void *fh
,
279 struct v4l2_jpegcompression
*a
);
280 int (*vidioc_g_enc_index
) (struct file
*file
, void *fh
,
281 struct v4l2_enc_idx
*a
);
282 int (*vidioc_encoder_cmd
) (struct file
*file
, void *fh
,
283 struct v4l2_encoder_cmd
*a
);
284 int (*vidioc_try_encoder_cmd
) (struct file
*file
, void *fh
,
285 struct v4l2_encoder_cmd
*a
);
287 /* Stream type-dependent parameter ioctls */
288 int (*vidioc_g_parm
) (struct file
*file
, void *fh
,
289 struct v4l2_streamparm
*a
);
290 int (*vidioc_s_parm
) (struct file
*file
, void *fh
,
291 struct v4l2_streamparm
*a
);
294 int (*vidioc_g_tuner
) (struct file
*file
, void *fh
,
295 struct v4l2_tuner
*a
);
296 int (*vidioc_s_tuner
) (struct file
*file
, void *fh
,
297 struct v4l2_tuner
*a
);
298 int (*vidioc_g_frequency
) (struct file
*file
, void *fh
,
299 struct v4l2_frequency
*a
);
300 int (*vidioc_s_frequency
) (struct file
*file
, void *fh
,
301 struct v4l2_frequency
*a
);
304 int (*vidioc_g_sliced_vbi_cap
) (struct file
*file
, void *fh
,
305 struct v4l2_sliced_vbi_cap
*a
);
307 /* Log status ioctl */
308 int (*vidioc_log_status
) (struct file
*file
, void *fh
);
311 /* Debugging ioctls */
312 #ifdef CONFIG_VIDEO_ADV_DEBUG
313 int (*vidioc_g_register
) (struct file
*file
, void *fh
,
314 struct v4l2_register
*reg
);
315 int (*vidioc_s_register
) (struct file
*file
, void *fh
,
316 struct v4l2_register
*reg
);
318 int (*vidioc_g_chip_ident
) (struct file
*file
, void *fh
,
319 struct v4l2_chip_ident
*chip
);
322 #ifdef OBSOLETE_OWNER /* to be removed soon */
323 /* obsolete -- fops->owner is used instead */
324 struct module
*owner
;
325 /* dev->driver_data will be used instead some day.
326 * Use the video_{get|set}_drvdata() helper functions,
327 * so the switch over will be transparent for you.
328 * Or use {pci|usb}_{get|set}_drvdata() directly. */
332 /* for videodev.c intenal usage -- please don't touch */
333 int users
; /* video_exclusive_{open|close} ... */
334 struct mutex lock
; /* ... helper function uses these */
335 struct class_device class_dev
; /* sysfs */
338 /* Class-dev to video-device */
339 #define to_video_device(cd) container_of(cd, struct video_device, class_dev)
341 /* Version 2 functions */
342 extern int video_register_device(struct video_device
*vfd
, int type
, int nr
);
343 void video_unregister_device(struct video_device
*);
344 extern int video_ioctl2(struct inode
*inode
, struct file
*file
,
345 unsigned int cmd
, unsigned long arg
);
347 /* helper functions to alloc / release struct video_device, the
348 later can be used for video_device->release() */
349 struct video_device
*video_device_alloc(void);
350 void video_device_release(struct video_device
*vfd
);
352 /* Include support for obsoleted stuff */
353 extern int video_usercopy(struct inode
*inode
, struct file
*file
,
354 unsigned int cmd
, unsigned long arg
,
355 int (*func
)(struct inode
*inode
, struct file
*file
,
356 unsigned int cmd
, void *arg
));
358 #ifdef CONFIG_VIDEO_V4L1_COMPAT
359 #include <linux/mm.h>
361 static inline int __must_check
362 video_device_create_file(struct video_device
*vfd
,
363 struct class_device_attribute
*attr
)
365 int ret
= class_device_create_file(&vfd
->class_dev
, attr
);
367 printk(KERN_WARNING
"%s error: %d\n", __FUNCTION__
, ret
);
371 video_device_remove_file(struct video_device
*vfd
,
372 struct class_device_attribute
*attr
)
374 class_device_remove_file(&vfd
->class_dev
, attr
);
377 #endif /* CONFIG_VIDEO_V4L1_COMPAT */
379 #ifdef OBSOLETE_OWNER /* to be removed soon */
380 /* helper functions to access driver private data. */
381 static inline void *video_get_drvdata(struct video_device
*dev
)
386 static inline void video_set_drvdata(struct video_device
*dev
, void *data
)
393 #ifdef OBSOLETE_DEVDATA /* to be removed soon */
394 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */
395 extern struct video_device
* video_devdata(struct file
*);
396 extern int video_exclusive_open(struct inode
*inode
, struct file
*file
);
397 extern int video_exclusive_release(struct inode
*inode
, struct file
*file
);
400 #endif /* _V4L2_DEV_H */