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 */ 45 extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs); 46 extern int v4l2_video_std_construct(struct v4l2_standard *vs, 47 int id, char *name); 48 49 /* prority handling */ 50 struct v4l2_prio_state { 51 atomic_t prios[4]; 52 }; 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); 60 61 /* names for fancy debug output */ 62 extern char *v4l2_field_names[]; 63 extern char *v4l2_type_names[]; 64 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); 71 #else 72 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL 73 #endif 74 75 /* 32 Bits compatibility layer for 64 bits processors */ 76 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd, 77 unsigned long arg); 78 79 /* 80 * Newer version of video_device, handled by videodev2.c 81 * This version moves redundant code from video device code to 82 * the common handler 83 */ 84 struct v4l2_tvnorm { 85 char *name; 86 v4l2_std_id id; 87 88 void *priv_data; 89 }; 90 91 struct video_device 92 { 93 /* device ops */ 94 const struct file_operations *fops; 95 96 /* device info */ 97 struct device *dev; 98 char name[32]; 99 int type; /* v4l1 */ 100 int type2; /* v4l2 */ 101 int hardware; 102 int minor; 103 104 int debug; /* Activates debug level*/ 105 106 /* Video standard vars */ 107 int tvnormsize; /* Size of tvnorm array */ 108 v4l2_std_id current_norm; /* Current tvnorm */ 109 struct v4l2_tvnorm *tvnorms; 110 111 /* callbacks */ 112 void (*release)(struct video_device *vfd); 113 114 /* ioctl callbacks */ 115 116 /* VIDIOC_QUERYCAP handler */ 117 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap); 118 119 /* Priority handling */ 120 int (*vidioc_g_priority) (struct file *file, void *fh, 121 enum v4l2_priority *p); 122 int (*vidioc_s_priority) (struct file *file, void *fh, 123 enum v4l2_priority p); 124 125 /* VIDIOC_ENUM_FMT handlers */ 126 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh, 127 struct v4l2_fmtdesc *f); 128 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh, 129 struct v4l2_fmtdesc *f); 130 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh, 131 struct v4l2_fmtdesc *f); 132 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh, 133 struct v4l2_fmtdesc *f); 134 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh, 135 struct v4l2_fmtdesc *f); 136 int (*vidioc_enum_fmt_vbi_output) (struct file *file, void *fh, 137 struct v4l2_fmtdesc *f); 138 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh, 139 struct v4l2_fmtdesc *f); 140 141 /* VIDIOC_G_FMT handlers */ 142 int (*vidioc_g_fmt_cap) (struct file *file, void *fh, 143 struct v4l2_format *f); 144 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh, 145 struct v4l2_format *f); 146 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh, 147 struct v4l2_format *f); 148 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh, 149 struct v4l2_format *f); 150 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh, 151 struct v4l2_format *f); 152 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh, 153 struct v4l2_format *f); 154 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh, 155 struct v4l2_format *f); 156 157 /* VIDIOC_S_FMT handlers */ 158 int (*vidioc_s_fmt_cap) (struct file *file, void *fh, 159 struct v4l2_format *f); 160 161 int (*vidioc_s_fmt_overlay) (struct file *file, void *fh, 162 struct v4l2_format *f); 163 int (*vidioc_s_fmt_vbi) (struct file *file, void *fh, 164 struct v4l2_format *f); 165 int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh, 166 struct v4l2_format *f); 167 int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh, 168 struct v4l2_format *f); 169 int (*vidioc_s_fmt_video_output)(struct file *file, void *fh, 170 struct v4l2_format *f); 171 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh, 172 struct v4l2_format *f); 173 174 /* VIDIOC_TRY_FMT handlers */ 175 int (*vidioc_try_fmt_cap) (struct file *file, void *fh, 176 struct v4l2_format *f); 177 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh, 178 struct v4l2_format *f); 179 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh, 180 struct v4l2_format *f); 181 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh, 182 struct v4l2_format *f); 183 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh, 184 struct v4l2_format *f); 185 int (*vidioc_try_fmt_video_output)(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); 189 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); 195 196 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); 201 #endif 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); 206 207 /* Stream on/off */ 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); 210 211 /* Standard handling 212 G_STD and ENUMSTD are handled by videodev.c 213 */ 214 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id a); 215 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a); 216 217 /* Input handling */ 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); 222 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); 228 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); 244 245 /* Audio ioctls */ 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); 252 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); 264 /* Crop ioctls */ 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 281 /* Stream type-dependent parameter ioctls */ 282 int (*vidioc_g_parm) (struct file *file, void *fh, 283 struct v4l2_streamparm *a); 284 int (*vidioc_s_parm) (struct file *file, void *fh, 285 struct v4l2_streamparm *a); 286 287 /* Tuner ioctls */ 288 int (*vidioc_g_tuner) (struct file *file, void *fh, 289 struct v4l2_tuner *a); 290 int (*vidioc_s_tuner) (struct file *file, void *fh, 291 struct v4l2_tuner *a); 292 int (*vidioc_g_frequency) (struct file *file, void *fh, 293 struct v4l2_frequency *a); 294 int (*vidioc_s_frequency) (struct file *file, void *fh, 295 struct v4l2_frequency *a); 296 297 /* Sliced VBI cap */ 298 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh, 299 struct v4l2_sliced_vbi_cap *a); 300 301 /* Log status ioctl */ 302 int (*vidioc_log_status) (struct file *file, void *fh); 303 304 305 #ifdef OBSOLETE_OWNER /* to be removed soon */ 306 /* obsolete -- fops->owner is used instead */ 307 struct module *owner; 308 /* dev->driver_data will be used instead some day. 309 * Use the video_{get|set}_drvdata() helper functions, 310 * so the switch over will be transparent for you. 311 * Or use {pci|usb}_{get|set}_drvdata() directly. */ 312 void *priv; 313 #endif 314 315 /* for videodev.c intenal usage -- please don't touch */ 316 int users; /* video_exclusive_{open|close} ... */ 317 struct mutex lock; /* ... helper function uses these */ 318 struct class_device class_dev; /* sysfs */ 319 }; 320 321 /* Version 2 functions */ 322 extern int video_register_device(struct video_device *vfd, int type, int nr); 323 void video_unregister_device(struct video_device *); 324 extern int video_ioctl2(struct inode *inode, struct file *file, 325 unsigned int cmd, unsigned long arg); 326 327 /* helper functions to alloc / release struct video_device, the 328 later can be used for video_device->release() */ 329 struct video_device *video_device_alloc(void); 330 void video_device_release(struct video_device *vfd); 331 332 /* Include support for obsoleted stuff */ 333 extern int video_usercopy(struct inode *inode, struct file *file, 334 unsigned int cmd, unsigned long arg, 335 int (*func)(struct inode *inode, struct file *file, 336 unsigned int cmd, void *arg)); 337 338 339 #ifdef CONFIG_VIDEO_V4L1_COMPAT 340 #include <linux/mm.h> 341 342 #define to_video_device(cd) container_of(cd, struct video_device, class_dev) 343 static inline int __must_check 344 video_device_create_file(struct video_device *vfd, 345 struct class_device_attribute *attr) 346 { 347 int ret = class_device_create_file(&vfd->class_dev, attr); 348 if (ret < 0) 349 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret); 350 return ret; 351 } 352 static inline void 353 video_device_remove_file(struct video_device *vfd, 354 struct class_device_attribute *attr) 355 { 356 class_device_remove_file(&vfd->class_dev, attr); 357 } 358 359 #endif /* CONFIG_VIDEO_V4L1_COMPAT */ 360 361 #ifdef OBSOLETE_OWNER /* to be removed soon */ 362 /* helper functions to access driver private data. */ 363 static inline void *video_get_drvdata(struct video_device *dev) 364 { 365 return dev->priv; 366 } 367 368 static inline void video_set_drvdata(struct video_device *dev, void *data) 369 { 370 dev->priv = data; 371 } 372 373 #endif 374 375 #ifdef OBSOLETE_DEVDATA /* to be removed soon */ 376 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */ 377 extern struct video_device* video_devdata(struct file*); 378 extern int video_exclusive_open(struct inode *inode, struct file *file); 379 extern int video_exclusive_release(struct inode *inode, struct file *file); 380 #endif 381 382 #endif /* _V4L2_DEV_H */ 383