[media] v4l2: add v4l2_prio_state to v4l2_device and video_device
[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 #include <media/media-entity.h>
20
21 #define VIDEO_MAJOR     81
22
23 #define VFL_TYPE_GRABBER        0
24 #define VFL_TYPE_VBI            1
25 #define VFL_TYPE_RADIO          2
26 #define VFL_TYPE_SUBDEV         3
27 #define VFL_TYPE_MAX            4
28
29 struct v4l2_ioctl_callbacks;
30 struct video_device;
31 struct v4l2_device;
32 struct v4l2_ctrl_handler;
33
34 /* Flag to mark the video_device struct as registered.
35    Drivers can clear this flag if they want to block all future
36    device access. It is cleared by video_unregister_device. */
37 #define V4L2_FL_REGISTERED      (0)
38 #define V4L2_FL_USES_V4L2_FH    (1)
39
40 /* Priority helper functions */
41
42 struct v4l2_prio_state {
43         atomic_t prios[4];
44 };
45
46 void v4l2_prio_init(struct v4l2_prio_state *global);
47 int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
48                      enum v4l2_priority new);
49 void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
50 void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
51 enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
52 int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
53
54
55 struct v4l2_file_operations {
56         struct module *owner;
57         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
58         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
59         unsigned int (*poll) (struct file *, struct poll_table_struct *);
60         long (*ioctl) (struct file *, unsigned int, unsigned long);
61         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
62         int (*mmap) (struct file *, struct vm_area_struct *);
63         int (*open) (struct file *);
64         int (*release) (struct file *);
65 };
66
67 /*
68  * Newer version of video_device, handled by videodev2.c
69  *      This version moves redundant code from video device code to
70  *      the common handler
71  */
72
73 struct video_device
74 {
75 #if defined(CONFIG_MEDIA_CONTROLLER)
76         struct media_entity entity;
77 #endif
78         /* device ops */
79         const struct v4l2_file_operations *fops;
80
81         /* sysfs */
82         struct device dev;              /* v4l device */
83         struct cdev *cdev;              /* character device */
84
85         /* Set either parent or v4l2_dev if your driver uses v4l2_device */
86         struct device *parent;          /* device parent */
87         struct v4l2_device *v4l2_dev;   /* v4l2_device parent */
88
89         /* Control handler associated with this device node. May be NULL. */
90         struct v4l2_ctrl_handler *ctrl_handler;
91
92         /* Priority state. If NULL, then v4l2_dev->prio will be used. */
93         struct v4l2_prio_state *prio;
94
95         /* device info */
96         char name[32];
97         int vfl_type;
98         /* 'minor' is set to -1 if the registration failed */
99         int minor;
100         u16 num;
101         /* use bitops to set/clear/test flags */
102         unsigned long flags;
103         /* attribute to differentiate multiple indices on one physical device */
104         int index;
105
106         /* V4L2 file handles */
107         spinlock_t              fh_lock; /* Lock for all v4l2_fhs */
108         struct list_head        fh_list; /* List of struct v4l2_fh */
109
110         int debug;                      /* Activates debug level*/
111
112         /* Video standard vars */
113         v4l2_std_id tvnorms;            /* Supported tv norms */
114         v4l2_std_id current_norm;       /* Current tvnorm */
115
116         /* callbacks */
117         void (*release)(struct video_device *vdev);
118
119         /* ioctl callbacks */
120         const struct v4l2_ioctl_ops *ioctl_ops;
121
122         /* serialization lock */
123         struct mutex *lock;
124 };
125
126 #define media_entity_to_video_device(entity) \
127         container_of(entity, struct video_device, entity)
128 /* dev to video-device */
129 #define to_video_device(cd) container_of(cd, struct video_device, dev)
130
131 int __must_check __video_register_device(struct video_device *vdev, int type,
132                 int nr, int warn_if_nr_in_use, struct module *owner);
133
134 /* Register video devices. Note that if video_register_device fails,
135    the release() callback of the video_device structure is *not* called, so
136    the caller is responsible for freeing any data. Usually that means that
137    you call video_device_release() on failure. */
138 static inline int __must_check video_register_device(struct video_device *vdev,
139                 int type, int nr)
140 {
141         return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
142 }
143
144 /* Same as video_register_device, but no warning is issued if the desired
145    device node number was already in use. */
146 static inline int __must_check video_register_device_no_warn(
147                 struct video_device *vdev, int type, int nr)
148 {
149         return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
150 }
151
152 /* Unregister video devices. Will do nothing if vdev == NULL or
153    video_is_registered() returns false. */
154 void video_unregister_device(struct video_device *vdev);
155
156 /* helper functions to alloc/release struct video_device, the
157    latter can also be used for video_device->release(). */
158 struct video_device * __must_check video_device_alloc(void);
159
160 /* this release function frees the vdev pointer */
161 void video_device_release(struct video_device *vdev);
162
163 /* this release function does nothing, use when the video_device is a
164    static global struct. Note that having a static video_device is
165    a dubious construction at best. */
166 void video_device_release_empty(struct video_device *vdev);
167
168 /* helper functions to access driver private data. */
169 static inline void *video_get_drvdata(struct video_device *vdev)
170 {
171         return dev_get_drvdata(&vdev->dev);
172 }
173
174 static inline void video_set_drvdata(struct video_device *vdev, void *data)
175 {
176         dev_set_drvdata(&vdev->dev, data);
177 }
178
179 struct video_device *video_devdata(struct file *file);
180
181 /* Combine video_get_drvdata and video_devdata as this is
182    used very often. */
183 static inline void *video_drvdata(struct file *file)
184 {
185         return video_get_drvdata(video_devdata(file));
186 }
187
188 static inline const char *video_device_node_name(struct video_device *vdev)
189 {
190         return dev_name(&vdev->dev);
191 }
192
193 static inline int video_is_registered(struct video_device *vdev)
194 {
195         return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
196 }
197
198 #endif /* _V4L2_DEV_H */