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 /* Prints the ioctl in a human-readable format */ 48 extern void v4l_printk_ioctl(unsigned int cmd); 49 50 /* prority handling */ 51 struct v4l2_prio_state { 52 atomic_t prios[4]; 53 }; 54 int v4l2_prio_init(struct v4l2_prio_state *global); 55 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local, 56 enum v4l2_priority new); 57 int v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local); 58 int v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority *local); 59 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global); 60 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority *local); 61 62 /* names for fancy debug output */ 63 extern char *v4l2_field_names[]; 64 extern char *v4l2_type_names[]; 65 66 /* Compatibility layer interface -- v4l1-compat module */ 67 typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file, 68 unsigned int cmd, void *arg); 69 #ifdef CONFIG_VIDEO_V4L1_COMPAT 70 int 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 */ 77 extern 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 86 struct video_device 87 { 88 /* device ops */ 89 const struct file_operations *fops; 90 91 /* sysfs */ 92 struct device class_dev; /* v4l device */ 93 struct device *dev; /* device parent */ 94 95 /* device info */ 96 char name[32]; 97 int type; /* v4l1 */ 98 int type2; /* v4l2 */ 99 int minor; 100 101 int debug; /* Activates debug level*/ 102 103 /* Video standard vars */ 104 v4l2_std_id tvnorms; /* Supported tv norms */ 105 v4l2_std_id current_norm; /* Current tvnorm */ 106 107 /* callbacks */ 108 void (*release)(struct video_device *vfd); 109 110 /* ioctl callbacks */ 111 112 /* VIDIOC_QUERYCAP handler */ 113 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap); 114 115 /* Priority handling */ 116 int (*vidioc_g_priority) (struct file *file, void *fh, 117 enum v4l2_priority *p); 118 int (*vidioc_s_priority) (struct file *file, void *fh, 119 enum v4l2_priority p); 120 121 /* VIDIOC_ENUM_FMT handlers */ 122 int (*vidioc_enum_fmt_cap) (struct file *file, void *fh, 123 struct v4l2_fmtdesc *f); 124 int (*vidioc_enum_fmt_overlay) (struct file *file, void *fh, 125 struct v4l2_fmtdesc *f); 126 int (*vidioc_enum_fmt_vbi) (struct file *file, void *fh, 127 struct v4l2_fmtdesc *f); 128 int (*vidioc_enum_fmt_vbi_capture) (struct file *file, void *fh, 129 struct v4l2_fmtdesc *f); 130 int (*vidioc_enum_fmt_video_output)(struct file *file, void *fh, 131 struct v4l2_fmtdesc *f); 132 int (*vidioc_enum_fmt_output_overlay) (struct file *file, void *fh, 133 struct v4l2_fmtdesc *f); 134 int (*vidioc_enum_fmt_vbi_output) (struct file *file, void *fh, 135 struct v4l2_fmtdesc *f); 136 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh, 137 struct v4l2_fmtdesc *f); 138 139 /* VIDIOC_G_FMT handlers */ 140 int (*vidioc_g_fmt_cap) (struct file *file, void *fh, 141 struct v4l2_format *f); 142 int (*vidioc_g_fmt_overlay) (struct file *file, void *fh, 143 struct v4l2_format *f); 144 int (*vidioc_g_fmt_vbi) (struct file *file, void *fh, 145 struct v4l2_format *f); 146 int (*vidioc_g_fmt_vbi_output) (struct file *file, void *fh, 147 struct v4l2_format *f); 148 int (*vidioc_g_fmt_vbi_capture)(struct file *file, void *fh, 149 struct v4l2_format *f); 150 int (*vidioc_g_fmt_video_output)(struct file *file, void *fh, 151 struct v4l2_format *f); 152 int (*vidioc_g_fmt_output_overlay) (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_output_overlay) (struct file *file, void *fh, 172 struct v4l2_format *f); 173 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh, 174 struct v4l2_format *f); 175 176 /* VIDIOC_TRY_FMT handlers */ 177 int (*vidioc_try_fmt_cap) (struct file *file, void *fh, 178 struct v4l2_format *f); 179 int (*vidioc_try_fmt_overlay) (struct file *file, void *fh, 180 struct v4l2_format *f); 181 int (*vidioc_try_fmt_vbi) (struct file *file, void *fh, 182 struct v4l2_format *f); 183 int (*vidioc_try_fmt_vbi_output) (struct file *file, void *fh, 184 struct v4l2_format *f); 185 int (*vidioc_try_fmt_vbi_capture)(struct file *file, void *fh, 186 struct v4l2_format *f); 187 int (*vidioc_try_fmt_video_output)(struct file *file, void *fh, 188 struct v4l2_format *f); 189 int (*vidioc_try_fmt_output_overlay)(struct file *file, void *fh, 190 struct v4l2_format *f); 191 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh, 192 struct v4l2_format *f); 193 194 /* Buffer handlers */ 195 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b); 196 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b); 197 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 198 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 199 200 201 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i); 202 #ifdef CONFIG_VIDEO_V4L1_COMPAT 203 /* buffer type is struct vidio_mbuf * */ 204 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p); 205 #endif 206 int (*vidioc_g_fbuf) (struct file *file, void *fh, 207 struct v4l2_framebuffer *a); 208 int (*vidioc_s_fbuf) (struct file *file, void *fh, 209 struct v4l2_framebuffer *a); 210 211 /* Stream on/off */ 212 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i); 213 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i); 214 215 /* Standard handling 216 G_STD and ENUMSTD are handled by videodev.c 217 */ 218 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm); 219 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a); 220 221 /* Input handling */ 222 int (*vidioc_enum_input)(struct file *file, void *fh, 223 struct v4l2_input *inp); 224 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i); 225 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i); 226 227 /* Output handling */ 228 int (*vidioc_enumoutput) (struct file *file, void *fh, 229 struct v4l2_output *a); 230 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i); 231 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i); 232 233 /* Control handling */ 234 int (*vidioc_queryctrl) (struct file *file, void *fh, 235 struct v4l2_queryctrl *a); 236 int (*vidioc_g_ctrl) (struct file *file, void *fh, 237 struct v4l2_control *a); 238 int (*vidioc_s_ctrl) (struct file *file, void *fh, 239 struct v4l2_control *a); 240 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh, 241 struct v4l2_ext_controls *a); 242 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh, 243 struct v4l2_ext_controls *a); 244 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh, 245 struct v4l2_ext_controls *a); 246 int (*vidioc_querymenu) (struct file *file, void *fh, 247 struct v4l2_querymenu *a); 248 249 /* Audio ioctls */ 250 int (*vidioc_enumaudio) (struct file *file, void *fh, 251 struct v4l2_audio *a); 252 int (*vidioc_g_audio) (struct file *file, void *fh, 253 struct v4l2_audio *a); 254 int (*vidioc_s_audio) (struct file *file, void *fh, 255 struct v4l2_audio *a); 256 257 /* Audio out ioctls */ 258 int (*vidioc_enumaudout) (struct file *file, void *fh, 259 struct v4l2_audioout *a); 260 int (*vidioc_g_audout) (struct file *file, void *fh, 261 struct v4l2_audioout *a); 262 int (*vidioc_s_audout) (struct file *file, void *fh, 263 struct v4l2_audioout *a); 264 int (*vidioc_g_modulator) (struct file *file, void *fh, 265 struct v4l2_modulator *a); 266 int (*vidioc_s_modulator) (struct file *file, void *fh, 267 struct v4l2_modulator *a); 268 /* Crop ioctls */ 269 int (*vidioc_cropcap) (struct file *file, void *fh, 270 struct v4l2_cropcap *a); 271 int (*vidioc_g_crop) (struct file *file, void *fh, 272 struct v4l2_crop *a); 273 int (*vidioc_s_crop) (struct file *file, void *fh, 274 struct v4l2_crop *a); 275 /* Compression ioctls */ 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); 286 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); 292 293 /* Tuner ioctls */ 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); 302 303 /* Sliced VBI cap */ 304 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh, 305 struct v4l2_sliced_vbi_cap *a); 306 307 /* Log status ioctl */ 308 int (*vidioc_log_status) (struct file *file, void *fh); 309 310 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); 317 #endif 318 int (*vidioc_g_chip_ident) (struct file *file, void *fh, 319 struct v4l2_chip_ident *chip); 320 321 /* For other private ioctls */ 322 int (*vidioc_default) (struct file *file, void *fh, 323 int cmd, void *arg); 324 325 326 #ifdef OBSOLETE_OWNER /* to be removed soon */ 327 /* obsolete -- fops->owner is used instead */ 328 struct module *owner; 329 /* dev->driver_data will be used instead some day. 330 * Use the video_{get|set}_drvdata() helper functions, 331 * so the switch over will be transparent for you. 332 * Or use {pci|usb}_{get|set}_drvdata() directly. */ 333 void *priv; 334 #endif 335 336 /* for videodev.c intenal usage -- please don't touch */ 337 int users; /* video_exclusive_{open|close} ... */ 338 struct mutex lock; /* ... helper function uses these */ 339 }; 340 341 /* Class-dev to video-device */ 342 #define to_video_device(cd) container_of(cd, struct video_device, class_dev) 343 344 /* Version 2 functions */ 345 extern int video_register_device(struct video_device *vfd, int type, int nr); 346 void video_unregister_device(struct video_device *); 347 extern int video_ioctl2(struct inode *inode, struct file *file, 348 unsigned int cmd, unsigned long arg); 349 350 /* helper functions to alloc / release struct video_device, the 351 later can be used for video_device->release() */ 352 struct video_device *video_device_alloc(void); 353 void video_device_release(struct video_device *vfd); 354 355 /* Include support for obsoleted stuff */ 356 extern int video_usercopy(struct inode *inode, struct file *file, 357 unsigned int cmd, unsigned long arg, 358 int (*func)(struct inode *inode, struct file *file, 359 unsigned int cmd, void *arg)); 360 361 #ifdef CONFIG_VIDEO_V4L1_COMPAT 362 #include <linux/mm.h> 363 364 static inline int __must_check 365 video_device_create_file(struct video_device *vfd, 366 struct device_attribute *attr) 367 { 368 int ret = device_create_file(&vfd->class_dev, attr); 369 if (ret < 0) 370 printk(KERN_WARNING "%s error: %d\n", __FUNCTION__, ret); 371 return ret; 372 } 373 static inline void 374 video_device_remove_file(struct video_device *vfd, 375 struct device_attribute *attr) 376 { 377 device_remove_file(&vfd->class_dev, attr); 378 } 379 380 #endif /* CONFIG_VIDEO_V4L1_COMPAT */ 381 382 #ifdef OBSOLETE_OWNER /* to be removed soon */ 383 /* helper functions to access driver private data. */ 384 static inline void *video_get_drvdata(struct video_device *dev) 385 { 386 return dev->priv; 387 } 388 389 static inline void video_set_drvdata(struct video_device *dev, void *data) 390 { 391 dev->priv = data; 392 } 393 394 #endif 395 396 #ifdef OBSOLETE_DEVDATA /* to be removed soon */ 397 /* Obsolete stuff - Still needed for radio devices and obsolete drivers */ 398 extern struct video_device* video_devdata(struct file*); 399 extern int video_exclusive_open(struct inode *inode, struct file *file); 400 extern int video_exclusive_release(struct inode *inode, struct file *file); 401 #endif 402 403 #endif /* _V4L2_DEV_H */ 404