Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
12#define OBSOLETE_OWNER 1 /* to be removed soon */
13#define OBSOLETE_DEVDATA 1 /* to be removed soon */
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 */
20#ifdef CONFIG_VIDEO_V4L1_COMPAT
21#include <linux/videodev.h>
22#else
23#include <linux/videodev2.h>
24#endif
25
26#include <linux/fs.h>
27
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
38
39#define VFL_TYPE_GRABBER 0
40#define VFL_TYPE_VBI 1
41#define VFL_TYPE_RADIO 2
42#define VFL_TYPE_VTX 3
43
44/* Video standard functions */
45extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs);
46extern char *v4l2_norm_to_name(v4l2_std_id id);
47extern int v4l2_video_std_construct(struct v4l2_standard *vs,
48 int id, char *name);
49
50/* prority handling */
51struct v4l2_prio_state {
52 atomic_t prios[4];
53};
54int v4l2_prio_init(struct v4l2_prio_state *global);
55int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
56 enum v4l2_priority new);
57int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
58int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local);
59enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
60int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local);
61
62/* names for fancy debug output */
63extern char *v4l2_field_names[];
64extern char *v4l2_type_names[];
65
66/* Compatibility layer interface -- v4l1-compat module */
67typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file,
68 unsigned int cmd, void *arg);
69#ifdef CONFIG_VIDEO_V4L1_COMPAT
70int v4l_compat_translate_ioctl(struct inode *inode, struct file *file,
71 int cmd, void *arg, v4l2_kioctl driver_ioctl);
72#else
73#define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL
74#endif
75
76/* 32 Bits compatibility layer for 64 bits processors */
77extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd,
78 unsigned long arg);
79
80/*
81 * Newer version of video_device, handled by videodev2.c
82 * This version moves redundant code from video device code to
83 * the common handler
84 */
85
86struct video_device
87{
88 /* device ops */
89 const struct file_operations *fops;
90
91 /* device info */
92 struct device *dev;
93 char name[32];
94 int type; /* v4l1 */
95 int type2; /* v4l2 */
96 int hardware;
97 int minor;
98
99 int debug; /* Activates debug level*/
100
101 /* Video standard vars */
102 v4l2_std_id tvnorms; /* Supported tv norms */
103 v4l2_std_id current_norm; /* Current tvnorm */
104
105 /* callbacks */
106 void (*release)(struct video_device *vfd);
107
108 /* ioctl callbacks */
109
110 /* VIDIOC_QUERYCAP handler */
111 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
112
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);
118
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);
134
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);
150
151 /* VIDIOC_S_FMT handlers */
152 int (*vidioc_s_fmt_cap) (struct file *file, void *fh,
153 struct v4l2_format *f);
154
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);
167
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);
183
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);
189
190
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);
195#endif
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);
200
201 /* Stream on/off */
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);
204
205 /* Standard handling
206 G_STD and ENUMSTD are handled by videodev.c
207 */
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);
210
211 /* Input handling */
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);
216
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);
222
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);
238
239 /* Audio ioctls */
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);
246
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);
258 /* Crop ioctls */
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
275 /* Stream type-dependent parameter ioctls */
276 int (*vidioc_g_parm) (struct file *file, void *fh,
277 struct v4l2_streamparm *a);
278 int (*vidioc_s_parm) (struct file *file, void *fh,
279 struct v4l2_streamparm *a);
280
281 /* Tuner ioctls */
282 int (*vidioc_g_tuner) (struct file *file, void *fh,
283 struct v4l2_tuner *a);
284 int (*vidioc_s_tuner) (struct file *file, void *fh,
285 struct v4l2_tuner *a);
286 int (*vidioc_g_frequency) (struct file *file, void *fh,
287 struct v4l2_frequency *a);
288 int (*vidioc_s_frequency) (struct file *file, void *fh,
289 struct v4l2_frequency *a);
290
291 /* Sliced VBI cap */
292 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
293 struct v4l2_sliced_vbi_cap *a);
294
295 /* Log status ioctl */
296 int (*vidioc_log_status) (struct file *file, void *fh);
297
298
299 /* Debugging ioctls */
300#ifdef CONFIG_VIDEO_ADV_DEBUG
301 int (*vidioc_g_register) (struct file *file, void *fh,
302 struct v4l2_register *reg);
303 int (*vidioc_s_register) (struct file *file, void *fh,
304 struct v4l2_register *reg);
305#endif
306
307
308#ifdef OBSOLETE_OWNER /* to be removed soon */
309/* obsolete -- fops->owner is used instead */
310struct module *owner;
311/* dev->driver_data will be used instead some day.
312 * Use the video_{get|set}_drvdata() helper functions,
313 * so the switch over will be transparent for you.
314 * Or use {pci|usb}_{get|set}_drvdata() directly. */
315void *priv;
316#endif
317
318 /* for videodev.c intenal usage -- please don't touch */
319 int users; /* video_exclusive_{open|close} ... */
320 struct mutex lock; /* ... helper function uses these */
321 struct class_device class_dev; /* sysfs */
322};
323
324/* Version 2 functions */
325extern int video_register_device(struct video_device *vfd, int type, int nr);
326void video_unregister_device(struct video_device *);
327extern int video_ioctl2(struct inode *inode, struct file *file,
328 unsigned int cmd, unsigned long arg);
329
330/* helper functions to alloc / release struct video_device, the
331 later can be used for video_device->release() */
332struct video_device *video_device_alloc(void);
333void video_device_release(struct video_device *vfd);
334
335/* Include support for obsoleted stuff */
336extern int video_usercopy(struct inode *inode, struct file *file,
337 unsigned int cmd, unsigned long arg,
338 int (*func)(struct inode *inode, struct file *file,
339 unsigned int cmd, void *arg));
340
341
342#ifdef CONFIG_VIDEO_V4L1_COMPAT
343#include <linux/mm.h>
344
345#define to_video_device(cd) container_of(cd, struct video_device, class_dev)
346static inline int __must_check
347video_device_create_file(struct video_device *vfd,
348 struct class_device_attribute *attr)
349{
350 int ret = class_device_create_file(&vfd->class_dev, attr);
351 if (ret < 0)
352 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret);
353 return ret;
354}
355static inline void
356video_device_remove_file(struct video_device *vfd,
357 struct class_device_attribute *attr)
358{
359 class_device_remove_file(&vfd->class_dev, attr);
360}
361
362#endif /* CONFIG_VIDEO_V4L1_COMPAT */
363
364#ifdef OBSOLETE_OWNER /* to be removed soon */
365/* helper functions to access driver private data. */
366static inline void *video_get_drvdata(struct video_device *dev)
367{
368 return dev->priv;
369}
370
371static inline void video_set_drvdata(struct video_device *dev, void *data)
372{
373 dev->priv = data;
374}
375
376#endif
377
378#ifdef OBSOLETE_DEVDATA /* to be removed soon */
379/* Obsolete stuff - Still needed for radio devices and obsolete drivers */
380extern struct video_device* video_devdata(struct file*);
381extern int video_exclusive_open(struct inode *inode, struct file *file);
382extern int video_exclusive_release(struct inode *inode, struct file *file);
383#endif
384
385#endif /* _V4L2_DEV_H */