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 #define VFL_TYPE_GRABBER        0
  22 #define VFL_TYPE_VBI            1
  23 #define VFL_TYPE_RADIO          2
  24 #define VFL_TYPE_VTX            3
  25 #define VFL_TYPE_MAX            4
  26
  27 struct v4l2_ioctl_callbacks;
  28
  29 /* Flag to mark the video_device struct as unregistered.
  30    Drivers can set this flag if they want to block all future
  31    device access. It is set by video_unregister_device. */
  32 #define V4L2_FL_UNREGISTERED    (0)
  33
  34 /*
  35  * Newer version of video_device, handled by videodev2.c
  36  *      This version moves redundant code from video device code to
  37  *      the common handler
  38  */
  39
  40 struct video_device
  41 {
  42         /* device ops */
  43         const struct file_operations *fops;
  44
  45         /* sysfs */
  46         struct device dev;              /* v4l device */
  47         struct cdev *cdev;              /* character device */
  48         struct device *parent;          /* device parent */
  49
  50         /* device info */
  51         char name[32];
  52         int vfl_type;
  53         /* 'minor' is set to -1 if the registration failed */
  54         int minor;
  55         u16 num;
  56         /* use bitops to set/clear/test flags */
  57         unsigned long flags;
  58         /* attribute to differentiate multiple indices on one physical device */
  59         int index;
  60
  61         int debug;                      /* Activates debug level*/
  62
  63         /* Video standard vars */
  64         v4l2_std_id tvnorms;            /* Supported tv norms */
  65         v4l2_std_id current_norm;       /* Current tvnorm */
  66
  67         /* callbacks */
  68         void (*release)(struct video_device *vdev);
  69
  70         /* ioctl callbacks */
  71         const struct v4l2_ioctl_ops *ioctl_ops;
  72 };
  73
  74 /* dev to video-device */
  75 #define to_video_device(cd) container_of(cd, struct video_device, dev)
  76
  77 /* Register video devices. Note that if video_register_device fails,
  78    the release() callback of the video_device structure is *not* called, so
  79    the caller is responsible for freeing any data. Usually that means that
  80    you call video_device_release() on failure.
  81
  82    Also note that vdev->minor is set to -1 if the registration failed. */
  83 int __must_check video_register_device(struct video_device *vdev, int type, int nr);
  84 int __must_check video_register_device_index(struct video_device *vdev,
  85                                                 int type, int nr, int index);
  86
  87 /* Unregister video devices. Will do nothing if vdev == NULL or
  88    vdev->minor < 0. */
  89 void video_unregister_device(struct video_device *vdev);
  90
  91 /* helper functions to alloc/release struct video_device, the
  92    latter can also be used for video_device->release(). */
  93 struct video_device * __must_check video_device_alloc(void);
  94
  95 /* this release function frees the vdev pointer */
  96 void video_device_release(struct video_device *vdev);
  97
  98 /* this release function does nothing, use when the video_device is a
  99    static global struct. Note that having a static video_device is
 100    a dubious construction at best. */
 101 void video_device_release_empty(struct video_device *vdev);
 102
 103 /* helper functions to access driver private data. */
 104 static inline void *video_get_drvdata(struct video_device *vdev)
 105 {
 106         return dev_get_drvdata(&vdev->dev);
 107 }
 108
 109 static inline void video_set_drvdata(struct video_device *vdev, void *data)
 110 {
 111         dev_set_drvdata(&vdev->dev, data);
 112 }
 113
 114 struct video_device *video_devdata(struct file *file);
 115
 116 /* Combine video_get_drvdata and video_devdata as this is
 117    used very often. */
 118 static inline void *video_drvdata(struct file *file)
 119 {
 120         return video_get_drvdata(video_devdata(file));
 121 }
 122
 123 static inline int video_is_unregistered(struct video_device *vdev)
 124 {
 125         return test_bit(V4L2_FL_UNREGISTERED, &vdev->flags);
 126 }
 127
 128 #endif /* _V4L2_DEV_H */