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 #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 36 37 #define VFL_TYPE_GRABBER 0 38 #define VFL_TYPE_VBI 1 39 #define VFL_TYPE_RADIO 2 40 #define VFL_TYPE_VTX 3 41 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, 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 84 struct video_device 85 { 86 /* device ops */ 87 const struct file_operations *fops; 88 89 /* sysfs */ 90 struct device class_dev; /* v4l device */ 91 struct device *dev; /* device parent */ 92 93 /* device info */ 94 char name[32]; 95 int type; /* v4l1 */ 96 int type2; /* v4l2 */ 97 int hardware; 98 int minor; 99 100 int debug; /* Activates debug level*/ 101 102 /* Video standard vars */ 103 v4l2_std_id tvnorms; /* Supported tv norms */ 104 v4l2_std_id current_norm; /* Current tvnorm */ 105 106 /* callbacks */ 107 void (*release)(struct video_device *vfd); 108 109 /* ioctl callbacks */ 110 111 /* VIDIOC_QUERYCAP handler */ 112 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap); 113 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); 119 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_type_private)(struct file *file, void *fh, 136 struct v4l2_fmtdesc *f); 137 138 /* VIDIOC_G_FMT handlers */ 139 int (*vidioc_g_fmt_cap) (struct file *file, void *fh, 140 struct v4l2_format *f); 141 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh, 142 struct v4l2_format *f); 143 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh, 144 struct v4l2_format *f); 145 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh, 146 struct v4l2_format *f); 147 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh, 148 struct v4l2_format *f); 149 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh, 150 struct v4l2_format *f); 151 int (*vidioc_g_fmt_output_overlay) (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_output_overlay) (struct file *file, void *fh, 171 struct v4l2_format *f); 172 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh, 173 struct v4l2_format *f); 174 175 /* VIDIOC_TRY_FMT handlers */ 176 int (*vidioc_try_fmt_cap) (struct file *file, void *fh, 177 struct v4l2_format *f); 178 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh, 179 struct v4l2_format *f); 180 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh, 181 struct v4l2_format *f); 182 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh, 183 struct v4l2_format *f); 184 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh, 185 struct v4l2_format *f); 186 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh, 187 struct v4l2_format *f); 188 int (*vidioc_try_fmt_output_overlay)(struct file *file, void *fh, 189 struct v4l2_format *f); 190 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh, 191 struct v4l2_format *f); 192 193 /* Buffer handlers */ 194 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b); 195 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b); 196 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 197 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 198 199 200 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i); 201 #ifdef CONFIG_VIDEO_V4L1_COMPAT 202 /* buffer type is struct vidio_mbuf * */ 203 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p); 204 #endif 205 int (*vidioc_g_fbuf) (struct file *file, void *fh, 206 struct v4l2_framebuffer *a); 207 int (*vidioc_s_fbuf) (struct file *file, void *fh, 208 struct v4l2_framebuffer *a); 209 210 /* Stream on/off */ 211 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i); 212 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i); 213 214 /* Standard handling 215 G_STD and ENUMSTD are handled by videodev.c 216 */ 217 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm); 218 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a); 219 220 /* Input handling */ 221 int (*vidioc_enum_input)(struct file *file, void *fh, 222 struct v4l2_input *inp); 223 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i); 224 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i); 225 226 /* Output handling */ 227 int (*vidioc_enumoutput) (struct file *file, void *fh, 228 struct v4l2_output *a); 229 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i); 230 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i); 231 232 /* Control handling */ 233 int (*vidioc_queryctrl) (struct file *file, void *fh, 234 struct v4l2_queryctrl *a); 235 int (*vidioc_g_ctrl) (struct file *file, void *fh, 236 struct v4l2_control *a); 237 int (*vidioc_s_ctrl) (struct file *file, void *fh, 238 struct v4l2_control *a); 239 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh, 240 struct v4l2_ext_controls *a); 241 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh, 242 struct v4l2_ext_controls *a); 243 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh, 244 struct v4l2_ext_controls *a); 245 int (*vidioc_querymenu) (struct file *file, void *fh, 246 struct v4l2_querymenu *a); 247 248 /* Audio ioctls */ 249 int (*vidioc_enumaudio) (struct file *file, void *fh, 250 struct v4l2_audio *a); 251 int (*vidioc_g_audio) (struct file *file, void *fh, 252 struct v4l2_audio *a); 253 int (*vidioc_s_audio) (struct file *file, void *fh, 254 struct v4l2_audio *a); 255 256 /* Audio out ioctls */ 257 int (*vidioc_enumaudout) (struct file *file, void *fh, 258 struct v4l2_audioout *a); 259 int (*vidioc_g_audout) (struct file *file, void *fh, 260 struct v4l2_audioout *a); 261 int (*vidioc_s_audout) (struct file *file, void *fh, 262 struct v4l2_audioout *a); 263 int (*vidioc_g_modulator) (struct file *file, void *fh, 264 struct v4l2_modulator *a); 265 int (*vidioc_s_modulator) (struct file *file, void *fh, 266 struct v4l2_modulator *a); 267 /* Crop ioctls */ 268 int (*vidioc_cropcap) (struct file *file, void *fh, 269 struct v4l2_cropcap *a); 270 int (*vidioc_g_crop) (struct file *file, void *fh, 271 struct v4l2_crop *a); 272 int (*vidioc_s_crop) (struct file *file, void *fh, 273 struct v4l2_crop *a); 274 /* Compression ioctls */ 275 int (*vidioc_g_mpegcomp) (struct file *file, void *fh, 276 struct v4l2_mpeg_compression *a); 277 int (*vidioc_s_mpegcomp) (struct file *file, void *fh, 278 struct v4l2_mpeg_compression *a); 279 int (*vidioc_g_jpegcomp) (struct file *file, void *fh, 280 struct v4l2_jpegcompression *a); 281 int (*vidioc_s_jpegcomp) (struct file *file, void *fh, 282 struct v4l2_jpegcompression *a); 283 int (*vidioc_g_enc_index) (struct file *file, void *fh, 284 struct v4l2_enc_idx *a); 285 int (*vidioc_encoder_cmd) (struct file *file, void *fh, 286 struct v4l2_encoder_cmd *a); 287 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh, 288 struct v4l2_encoder_cmd *a); 289 290 /* Stream type-dependent parameter ioctls */ 291 int (*vidioc_g_parm) (struct file *file, void *fh, 292 struct v4l2_streamparm *a); 293 int (*vidioc_s_parm) (struct file *file, void *fh, 294 struct v4l2_streamparm *a); 295 296 /* Tuner ioctls */ 297 int (*vidioc_g_tuner) (struct file *file, void *fh, 298 struct v4l2_tuner *a); 299 int (*vidioc_s_tuner) (struct file *file, void *fh, 300 struct v4l2_tuner *a); 301 int (*vidioc_g_frequency) (struct file *file, void *fh, 302 struct v4l2_frequency *a); 303 int (*vidioc_s_frequency) (struct file *file, void *fh, 304 struct v4l2_frequency *a); 305 306 /* Sliced VBI cap */ 307 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh, 308 struct v4l2_sliced_vbi_cap *a); 309 310 /* Log status ioctl */ 311 int (*vidioc_log_status) (struct file *file, void *fh); 312 313 314 /* Debugging ioctls */ 315 #ifdef CONFIG_VIDEO_ADV_DEBUG 316 int (*vidioc_g_register) (struct file *file, void *fh, 317 struct v4l2_register *reg); 318 int (*vidioc_s_register) (struct file *file, void *fh, 319 struct v4l2_register *reg); 320 #endif 321 int (*vidioc_g_chip_ident) (struct file *file, void *fh, 322 struct v4l2_chip_ident *chip); 323 324 325 #ifdef OBSOLETE_OWNER /* to be removed soon */ 326 /* obsolete -- fops->owner is used instead */ 327 struct module *owner; 328 /* dev->driver_data will be used instead some day. 329 * Use the video_{get|set}_drvdata() helper functions, 330 * so the switch over will be transparent for you. 331 * Or use {pci|usb}_{get|set}_drvdata() directly. */ 332 void *priv; 333 #endif 334 335 /* for videodev.c intenal usage -- please don't touch */ 336 int users; /* video_exclusive_{open|close} ... */ 337 struct mutex lock; /* ... helper function uses these */ 338 }; 339 340 /* Class-dev to video-device */ 341 #define to_video_device(cd) container_of(cd, struct video_device, class_dev) 342 343 /* Version 2 functions */ 344 extern int video_register_device(struct video_device *vfd, int type, int nr); 345 void video_unregister_device(struct video_device *); 346 extern int video_ioctl2(struct inode *inode, struct file *file, 347 unsigned int cmd, unsigned long arg); 348 349 /* helper functions to alloc / release struct video_device, the 350 later can be used for video_device->release() */ 351 struct video_device *video_device_alloc(void); 352 void video_device_release(struct video_device *vfd); 353 354 /* Include support for obsoleted stuff */ 355 extern int video_usercopy(struct inode *inode, struct file *file, 356 unsigned int cmd, unsigned long arg, 357 int (*func)(struct inode *inode, struct file *file, 358 unsigned int cmd, void *arg)); 359 360 #ifdef CONFIG_VIDEO_V4L1_COMPAT 361 #include <linux/mm.h> 362 363 static inline int __must_check 364 video_device_create_file(struct video_device *vfd, 365 struct device_attribute *attr) 366 { 367 int ret = device_create_file(&vfd->class_dev, attr); 368 if (ret < 0) 369 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret); 370 return ret; 371 } 372 static inline void 373 video_device_remove_file(struct video_device *vfd, 374 struct device_attribute *attr) 375 { 376 device_remove_file(&vfd->class_dev, attr); 377 } 378 379 #endif /* CONFIG_VIDEO_V4L1_COMPAT */ 380 381 #ifdef OBSOLETE_OWNER /* to be removed soon */ 382 /* helper functions to access driver private data. */ 383 static inline void *video_get_drvdata(struct video_device *dev) 384 { 385 return dev->priv; 386 } 387 388 static inline void video_set_drvdata(struct video_device *dev, void *data) 389 { 390 dev->priv = data; 391 } 392 393 #endif 394 395 #ifdef OBSOLETE_DEVDATA /* to be removed soon */ 396 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */ 397 extern struct video_device* video_devdata(struct file*); 398 extern int video_exclusive_open(struct inode *inode, struct file *file); 399 extern int video_exclusive_release(struct inode *inode, struct file *file); 400 #endif 401 402 #endif /* _V4L2_DEV_H */ 403