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