include/media/v4l2-dev.h

   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 #include <linux/poll.h>
  13 #include <linux/fs.h>
  14 #include <linux/device.h>
  15 #include <linux/cdev.h>
  16 #include <linux/mutex.h>
  17 #include <linux/videodev2.h>
  18
  19 #define VIDEO_MAJOR     81
  20
  21 /* Minor device allocation */
  22 #define MINOR_VFL_TYPE_GRABBER_MIN   0
  23 #define MINOR_VFL_TYPE_GRABBER_MAX  63
  24 #define MINOR_VFL_TYPE_RADIO_MIN    64
  25 #define MINOR_VFL_TYPE_RADIO_MAX   127
  26 #define MINOR_VFL_TYPE_VTX_MIN     192
  27 #define MINOR_VFL_TYPE_VTX_MAX     223
  28 #define MINOR_VFL_TYPE_VBI_MIN     224
  29 #define MINOR_VFL_TYPE_VBI_MAX     255
  30
  31 #define VFL_TYPE_GRABBER        0
  32 #define VFL_TYPE_VBI            1
  33 #define VFL_TYPE_RADIO          2
  34 #define VFL_TYPE_VTX            3
  35
  36 struct v4l2_ioctl_callbacks;
  37
  38 /*
  39  * Newer version of video_device, handled by videodev2.c
  40  *      This version moves redundant code from video device code to
  41  *      the common handler
  42  */
  43
  44 struct video_device
  45 {
  46         /* device ops */
  47         const struct file_operations *fops;
  48
  49         /* sysfs */
  50         struct device dev;              /* v4l device */
  51         struct cdev cdev;               /* character device */
  52         void (*cdev_release)(struct kobject *kobj);
  53         struct device *parent;          /* device parent */
  54
  55         /* device info */
  56         char name[32];
  57         int vfl_type;
  58         int minor;
  59         /* attribute to differentiate multiple indices on one physical device */
  60         int index;
  61
  62         int debug;                      /* Activates debug level*/
  63
  64         /* Video standard vars */
  65         v4l2_std_id tvnorms;            /* Supported tv norms */
  66         v4l2_std_id current_norm;       /* Current tvnorm */
  67
  68         /* callbacks */
  69         void (*release)(struct video_device *vfd);
  70
  71         /* ioctl callbacks */
  72         const struct v4l2_ioctl_ops *ioctl_ops;
  73 };
  74
  75 /* dev to video-device */
  76 #define to_video_device(cd) container_of(cd, struct video_device, dev)
  77
  78 /* Register and unregister devices. Note that if video_register_device fails,
  79    the release() callback of the video_device structure is *not* called, so
  80    the caller is responsible for freeing any data. Usually that means that
  81    you call video_device_release() on failure. */
  82 int __must_check video_register_device(struct video_device *vfd, int type, int nr);
  83 int __must_check video_register_device_index(struct video_device *vfd,
  84                                                 int type, int nr, int index);
  85 void video_unregister_device(struct video_device *vfd);
  86
  87 /* helper functions to alloc/release struct video_device, the
  88    latter can also be used for video_device->release(). */
  89 struct video_device * __must_check video_device_alloc(void);
  90
  91 /* this release function frees the vfd pointer */
  92 void video_device_release(struct video_device *vfd);
  93
  94 /* this release function does nothing, use when the video_device is a
  95    static global struct. Note that having a static video_device is
  96    a dubious construction at best. */
  97 void video_device_release_empty(struct video_device *vfd);
  98
  99 /* helper functions to access driver private data. */
 100 static inline void *video_get_drvdata(struct video_device *dev)
 101 {
 102         return dev_get_drvdata(&dev->dev);
 103 }
 104
 105 static inline void video_set_drvdata(struct video_device *dev, void *data)
 106 {
 107         dev_set_drvdata(&dev->dev, data);
 108 }
 109
 110 struct video_device *video_devdata(struct file *file);
 111
 112 /* Combine video_get_drvdata and video_devdata as this is
 113    used very often. */
 114 static inline void *video_drvdata(struct file *file)
 115 {
 116         return video_get_drvdata(video_devdata(file));
 117 }
 118
 119 #endif /* _V4L2_DEV_H */