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 14 #include <linux/poll.h> 15 #include <linux/fs.h> 16 #include <linux/device.h> 17 #include <linux/mutex.h> 18 #include <linux/compiler.h> /* need __user */ 19 #ifdef CONFIG_VIDEO_V4L1 20 #include <linux/videodev.h> 21 #else 22 #include <linux/videodev2.h> 23 #endif 24 25 #include <linux/fs.h> 26 27 #define VIDEO_MAJOR 81 28 /* Minor device allocation */ 29 #define MINOR_VFL_TYPE_GRABBER_MIN 0 30 #define MINOR_VFL_TYPE_GRABBER_MAX 63 31 #define MINOR_VFL_TYPE_RADIO_MIN 64 32 #define MINOR_VFL_TYPE_RADIO_MAX 127 33 #define MINOR_VFL_TYPE_VTX_MIN 192 34 #define MINOR_VFL_TYPE_VTX_MAX 223 35 #define MINOR_VFL_TYPE_VBI_MIN 224 36 #define MINOR_VFL_TYPE_VBI_MAX 255 37 38 #define VFL_TYPE_GRABBER 0 39 #define VFL_TYPE_VBI 1 40 #define VFL_TYPE_RADIO 2 41 #define VFL_TYPE_VTX 3 42 43 /* Video standard functions */ 44 extern unsigned int v4l2_video_std_fps(struct v4l2_standard *vs); 45 extern int v4l2_video_std_construct(struct v4l2_standard *vs, 46 int id, char *name); 47 48 /* prority handling */ 49 struct v4l2_prio_state { 50 atomic_t prios[4]; 51 }; 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); 59 60 /* names for fancy debug output */ 61 extern char *v4l2_field_names[]; 62 extern char *v4l2_type_names[]; 63 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); 70 #else 71 #define v4l_compat_translate_ioctl(inode,file,cmd,arg,ioctl) -EINVAL 72 #endif 73 74 /* 32 Bits compatibility layer for 64 bits processors */ 75 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd, 76 unsigned long arg); 77 78 /* 79 * Newer version of video_device, handled by videodev2.c 80 * This version moves redundant code from video device code to 81 * the common handler 82 */ 83 struct v4l2_tvnorm { 84 char *name; 85 v4l2_std_id id; 86 87 void *priv_data; 88 }; 89 90 struct video_device 91 { 92 /* device ops */ 93 const struct file_operations *fops; 94 95 /* device info */ 96 struct device *dev; 97 char name[32]; 98 int type; /* v4l1 */ 99 int type2; /* v4l2 */ 100 int hardware; 101 int minor; 102 103 int debug; /* Activates debug level*/ 104 105 /* Video standard vars */ 106 int tvnormsize; /* Size of tvnorm array */ 107 v4l2_std_id current_norm; /* Current tvnorm */ 108 struct v4l2_tvnorm *tvnorms; 109 110 /* callbacks */ 111 void (*release)(struct video_device *vfd); 112 113 /* ioctl callbacks */ 114 115 /* VIDIOC_QUERYCAP handler */ 116 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap); 117 118 /* Priority handling */ 119 int (*vidioc_g_priority) (struct file *file, void *fh, 120 enum v4l2_priority *p); 121 int (*vidioc_s_priority) (struct file *file, void *fh, 122 enum v4l2_priority p); 123 124 /* VIDIOC_ENUM_FMT handlers */ 125 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh, 126 struct v4l2_fmtdesc *f); 127 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh, 128 struct v4l2_fmtdesc *f); 129 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh, 130 struct v4l2_fmtdesc *f); 131 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh, 132 struct v4l2_fmtdesc *f); 133 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh, 134 struct v4l2_fmtdesc *f); 135 int (*vidioc_enum_fmt_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); 139 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_vbi_capture)(struct file *file, void *fh, 150 struct v4l2_format *f); 151 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh, 152 struct v4l2_format *f); 153 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh, 154 struct v4l2_format *f); 155 156 /* VIDIOC_S_FMT handlers */ 157 int (*vidioc_s_fmt_cap) (struct file *file, void *fh, 158 struct v4l2_format *f); 159 160 int (*vidioc_s_fmt_overlay) (struct file *file, void *fh, 161 struct v4l2_format *f); 162 int (*vidioc_s_fmt_vbi) (struct file *file, void *fh, 163 struct v4l2_format *f); 164 int (*vidioc_s_fmt_vbi_output) (struct file *file, void *fh, 165 struct v4l2_format *f); 166 int (*vidioc_s_fmt_vbi_capture)(struct file *file, void *fh, 167 struct v4l2_format *f); 168 int (*vidioc_s_fmt_video_output)(struct file *file, void *fh, 169 struct v4l2_format *f); 170 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh, 171 struct v4l2_format *f); 172 173 /* VIDIOC_TRY_FMT handlers */ 174 int (*vidioc_try_fmt_cap) (struct file *file, void *fh, 175 struct v4l2_format *f); 176 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh, 177 struct v4l2_format *f); 178 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh, 179 struct v4l2_format *f); 180 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh, 181 struct v4l2_format *f); 182 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh, 183 struct v4l2_format *f); 184 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh, 185 struct v4l2_format *f); 186 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh, 187 struct v4l2_format *f); 188 189 /* Buffer handlers */ 190 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b); 191 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b); 192 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 193 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 194 195 196 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i); 197 #ifdef HAVE_V4L1 198 /* buffer type is struct vidio_mbuf * */ 199 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p); 200 #endif 201 int (*vidioc_g_fbuf) (struct file *file, void *fh, 202 struct v4l2_framebuffer *a); 203 int (*vidioc_s_fbuf) (struct file *file, void *fh, 204 struct v4l2_framebuffer *a); 205 206 /* Stream on/off */ 207 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i); 208 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i); 209 210 /* Standard handling 211 G_STD and ENUMSTD are handled by videodev.c 212 */ 213 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id a); 214 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a); 215 216 /* Input handling */ 217 int (*vidioc_enum_input)(struct file *file, void *fh, 218 struct v4l2_input *inp); 219 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i); 220 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i); 221 222 /* Output handling */ 223 int (*vidioc_enumoutput) (struct file *file, void *fh, 224 struct v4l2_output *a); 225 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i); 226 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i); 227 228 /* Control handling */ 229 int (*vidioc_queryctrl) (struct file *file, void *fh, 230 struct v4l2_queryctrl *a); 231 int (*vidioc_g_ctrl) (struct file *file, void *fh, 232 struct v4l2_control *a); 233 int (*vidioc_s_ctrl) (struct file *file, void *fh, 234 struct v4l2_control *a); 235 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh, 236 struct v4l2_ext_controls *a); 237 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh, 238 struct v4l2_ext_controls *a); 239 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh, 240 struct v4l2_ext_controls *a); 241 int (*vidioc_querymenu) (struct file *file, void *fh, 242 struct v4l2_querymenu *a); 243 244 /* Audio ioctls */ 245 int (*vidioc_enumaudio) (struct file *file, void *fh, 246 struct v4l2_audio *a); 247 int (*vidioc_g_audio) (struct file *file, void *fh, 248 struct v4l2_audio *a); 249 int (*vidioc_s_audio) (struct file *file, void *fh, 250 struct v4l2_audio *a); 251 252 /* Audio out ioctls */ 253 int (*vidioc_enumaudout) (struct file *file, void *fh, 254 struct v4l2_audioout *a); 255 int (*vidioc_g_audout) (struct file *file, void *fh, 256 struct v4l2_audioout *a); 257 int (*vidioc_s_audout) (struct file *file, void *fh, 258 struct v4l2_audioout *a); 259 int (*vidioc_g_modulator) (struct file *file, void *fh, 260 struct v4l2_modulator *a); 261 int (*vidioc_s_modulator) (struct file *file, void *fh, 262 struct v4l2_modulator *a); 263 /* Crop ioctls */ 264 int (*vidioc_cropcap) (struct file *file, void *fh, 265 struct v4l2_cropcap *a); 266 int (*vidioc_g_crop) (struct file *file, void *fh, 267 struct v4l2_crop *a); 268 int (*vidioc_s_crop) (struct file *file, void *fh, 269 struct v4l2_crop *a); 270 /* Compression ioctls */ 271 int (*vidioc_g_mpegcomp) (struct file *file, void *fh, 272 struct v4l2_mpeg_compression *a); 273 int (*vidioc_s_mpegcomp) (struct file *file, void *fh, 274 struct v4l2_mpeg_compression *a); 275 int (*vidioc_g_jpegcomp) (struct file *file, void *fh, 276 struct v4l2_jpegcompression *a); 277 int (*vidioc_s_jpegcomp) (struct file *file, void *fh, 278 struct v4l2_jpegcompression *a); 279 280 /* Stream type-dependent parameter ioctls */ 281 int (*vidioc_g_parm) (struct file *file, void *fh, 282 struct v4l2_streamparm *a); 283 int (*vidioc_s_parm) (struct file *file, void *fh, 284 struct v4l2_streamparm *a); 285 286 /* Tuner ioctls */ 287 int (*vidioc_g_tuner) (struct file *file, void *fh, 288 struct v4l2_tuner *a); 289 int (*vidioc_s_tuner) (struct file *file, void *fh, 290 struct v4l2_tuner *a); 291 int (*vidioc_g_frequency) (struct file *file, void *fh, 292 struct v4l2_frequency *a); 293 int (*vidioc_s_frequency) (struct file *file, void *fh, 294 struct v4l2_frequency *a); 295 296 /* Sliced VBI cap */ 297 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh, 298 struct v4l2_sliced_vbi_cap *a); 299 300 /* Log status ioctl */ 301 int (*vidioc_log_status) (struct file *file, void *fh); 302 303 304 #ifdef OBSOLETE_OWNER /* to be removed soon */ 305 /* obsolete -- fops->owner is used instead */ 306 struct module *owner; 307 /* dev->driver_data will be used instead some day. 308 * Use the video_{get|set}_drvdata() helper functions, 309 * so the switch over will be transparent for you. 310 * Or use {pci|usb}_{get|set}_drvdata() directly. */ 311 void *priv; 312 #endif 313 314 /* for videodev.c intenal usage -- please don't touch */ 315 int users; /* video_exclusive_{open|close} ... */ 316 struct mutex lock; /* ... helper function uses these */ 317 struct class_device class_dev; /* sysfs */ 318 }; 319 320 /* Version 2 functions */ 321 extern int video_register_device(struct video_device *vfd, int type, int nr); 322 void video_unregister_device(struct video_device *); 323 extern int video_ioctl2(struct inode *inode, struct file *file, 324 unsigned int cmd, unsigned long arg); 325 326 /* helper functions to alloc / release struct video_device, the 327 later can be used for video_device->release() */ 328 struct video_device *video_device_alloc(void); 329 void video_device_release(struct video_device *vfd); 330 331 /* Include support for obsoleted stuff */ 332 extern int video_usercopy(struct inode *inode, struct file *file, 333 unsigned int cmd, unsigned long arg, 334 int (*func)(struct inode *inode, struct file *file, 335 unsigned int cmd, void *arg)); 336 337 338 #ifdef HAVE_V4L1 339 #include <linux/mm.h> 340 341 extern struct video_device* video_devdata(struct file*); 342 343 #define to_video_device(cd) container_of(cd, struct video_device, class_dev) 344 static inline int 345 video_device_create_file(struct video_device *vfd, 346 struct class_device_attribute *attr) 347 { 348 int ret = class_device_create_file(&vfd->class_dev, attr); 349 if (ret < 0) 350 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret); 351 return ret; 352 } 353 static inline void 354 video_device_remove_file(struct video_device *vfd, 355 struct class_device_attribute *attr) 356 { 357 class_device_remove_file(&vfd->class_dev, attr); 358 } 359 360 #ifdef OBSOLETE_OWNER /* to be removed soon */ 361 /* helper functions to access driver private data. */ 362 static inline void *video_get_drvdata(struct video_device *dev) 363 { 364 return dev->priv; 365 } 366 367 static inline void video_set_drvdata(struct video_device *dev, void *data) 368 { 369 dev->priv = data; 370 } 371 #endif 372 373 extern int video_exclusive_open(struct inode *inode, struct file *file); 374 extern int video_exclusive_release(struct inode *inode, struct file *file); 375 #endif /* HAVE_V4L1 */ 376 377 #endif /* _V4L2_DEV_H */ 378