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