Commit | Line | Data |
---|---|---|
401998fa MCC |
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 | ||
401998fa MCC |
12 | #include <linux/poll.h> |
13 | #include <linux/fs.h> | |
14 | #include <linux/device.h> | |
7f8ecfab | 15 | #include <linux/cdev.h> |
401998fa | 16 | #include <linux/mutex.h> |
401998fa | 17 | #include <linux/videodev2.h> |
401998fa | 18 | |
2c0ab67b LP |
19 | #include <media/media-entity.h> |
20 | ||
401998fa | 21 | #define VIDEO_MAJOR 81 |
bfa8a273 | 22 | |
401998fa MCC |
23 | #define VFL_TYPE_GRABBER 0 |
24 | #define VFL_TYPE_VBI 1 | |
25 | #define VFL_TYPE_RADIO 2 | |
2096a5dc LP |
26 | #define VFL_TYPE_SUBDEV 3 |
27 | #define VFL_TYPE_MAX 4 | |
401998fa | 28 | |
a399810c | 29 | struct v4l2_ioctl_callbacks; |
bec43661 | 30 | struct video_device; |
9bea3514 | 31 | struct v4l2_device; |
0996517c | 32 | struct v4l2_ctrl_handler; |
a399810c | 33 | |
957b4aa9 LP |
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) | |
b1a873a3 | 38 | /* file->private_data points to struct v4l2_fh */ |
1babcb46 | 39 | #define V4L2_FL_USES_V4L2_FH (1) |
b1a873a3 HV |
40 | /* Use the prio field of v4l2_fh for core priority checking */ |
41 | #define V4L2_FL_USE_FH_PRIO (2) | |
dc93a70c | 42 | |
02265493 HV |
43 | /* Priority helper functions */ |
44 | ||
45 | struct v4l2_prio_state { | |
46 | atomic_t prios[4]; | |
47 | }; | |
48 | ||
49 | void v4l2_prio_init(struct v4l2_prio_state *global); | |
50 | int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local, | |
51 | enum v4l2_priority new); | |
52 | void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local); | |
53 | void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local); | |
54 | enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global); | |
55 | int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local); | |
56 | ||
57 | ||
bec43661 HV |
58 | struct v4l2_file_operations { |
59 | struct module *owner; | |
60 | ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); | |
61 | ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); | |
62 | unsigned int (*poll) (struct file *, struct poll_table_struct *); | |
069b7479 | 63 | long (*ioctl) (struct file *, unsigned int, unsigned long); |
bec43661 | 64 | long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); |
b9d0aa6e LP |
65 | #ifdef CONFIG_COMPAT |
66 | long (*compat_ioctl32) (struct file *, unsigned int, unsigned long); | |
67 | #endif | |
ecc6517d BL |
68 | unsigned long (*get_unmapped_area) (struct file *, unsigned long, |
69 | unsigned long, unsigned long, unsigned long); | |
bec43661 HV |
70 | int (*mmap) (struct file *, struct vm_area_struct *); |
71 | int (*open) (struct file *); | |
72 | int (*release) (struct file *); | |
73 | }; | |
74 | ||
401998fa MCC |
75 | /* |
76 | * Newer version of video_device, handled by videodev2.c | |
77 | * This version moves redundant code from video device code to | |
78 | * the common handler | |
79 | */ | |
401998fa MCC |
80 | |
81 | struct video_device | |
82 | { | |
2c0ab67b LP |
83 | #if defined(CONFIG_MEDIA_CONTROLLER) |
84 | struct media_entity entity; | |
85 | #endif | |
401998fa | 86 | /* device ops */ |
bec43661 | 87 | const struct v4l2_file_operations *fops; |
401998fa | 88 | |
54bd5b66 | 89 | /* sysfs */ |
22a04f10 | 90 | struct device dev; /* v4l device */ |
dc93a70c | 91 | struct cdev *cdev; /* character device */ |
9bea3514 HV |
92 | |
93 | /* Set either parent or v4l2_dev if your driver uses v4l2_device */ | |
5e85e732 | 94 | struct device *parent; /* device parent */ |
9bea3514 | 95 | struct v4l2_device *v4l2_dev; /* v4l2_device parent */ |
54bd5b66 | 96 | |
0996517c HV |
97 | /* Control handler associated with this device node. May be NULL. */ |
98 | struct v4l2_ctrl_handler *ctrl_handler; | |
99 | ||
0f62fd6a HV |
100 | /* Priority state. If NULL, then v4l2_dev->prio will be used. */ |
101 | struct v4l2_prio_state *prio; | |
102 | ||
401998fa | 103 | /* device info */ |
401998fa | 104 | char name[32]; |
0ea6bc8d | 105 | int vfl_type; |
dc93a70c | 106 | /* 'minor' is set to -1 if the registration failed */ |
401998fa | 107 | int minor; |
dd89601d | 108 | u16 num; |
dc93a70c HV |
109 | /* use bitops to set/clear/test flags */ |
110 | unsigned long flags; | |
de1e575d | 111 | /* attribute to differentiate multiple indices on one physical device */ |
539a7555 | 112 | int index; |
401998fa | 113 | |
1babcb46 SA |
114 | /* V4L2 file handles */ |
115 | spinlock_t fh_lock; /* Lock for all v4l2_fhs */ | |
116 | struct list_head fh_list; /* List of struct v4l2_fh */ | |
117 | ||
22a04f10 | 118 | int debug; /* Activates debug level*/ |
401998fa MCC |
119 | |
120 | /* Video standard vars */ | |
e75f9cee MCC |
121 | v4l2_std_id tvnorms; /* Supported tv norms */ |
122 | v4l2_std_id current_norm; /* Current tvnorm */ | |
401998fa MCC |
123 | |
124 | /* callbacks */ | |
dc93a70c | 125 | void (*release)(struct video_device *vdev); |
401998fa MCC |
126 | |
127 | /* ioctl callbacks */ | |
a399810c | 128 | const struct v4l2_ioctl_ops *ioctl_ops; |
ee6869af HV |
129 | |
130 | /* serialization lock */ | |
8ab75e3e | 131 | DECLARE_BITMAP(dont_use_lock, BASE_VIDIOC_PRIVATE); |
ee6869af | 132 | struct mutex *lock; |
401998fa MCC |
133 | }; |
134 | ||
6e3ea0e7 LP |
135 | #define media_entity_to_video_device(__e) \ |
136 | container_of(__e, struct video_device, entity) | |
bfa8a273 | 137 | /* dev to video-device */ |
22a04f10 | 138 | #define to_video_device(cd) container_of(cd, struct video_device, dev) |
e90ff923 | 139 | |
2096a5dc LP |
140 | int __must_check __video_register_device(struct video_device *vdev, int type, |
141 | int nr, int warn_if_nr_in_use, struct module *owner); | |
142 | ||
dc93a70c | 143 | /* Register video devices. Note that if video_register_device fails, |
bfa8a273 HV |
144 | the release() callback of the video_device structure is *not* called, so |
145 | the caller is responsible for freeing any data. Usually that means that | |
957b4aa9 | 146 | you call video_device_release() on failure. */ |
2096a5dc LP |
147 | static inline int __must_check video_register_device(struct video_device *vdev, |
148 | int type, int nr) | |
149 | { | |
150 | return __video_register_device(vdev, type, nr, 1, vdev->fops->owner); | |
151 | } | |
dc93a70c | 152 | |
6b5270d2 HV |
153 | /* Same as video_register_device, but no warning is issued if the desired |
154 | device node number was already in use. */ | |
2096a5dc LP |
155 | static inline int __must_check video_register_device_no_warn( |
156 | struct video_device *vdev, int type, int nr) | |
157 | { | |
158 | return __video_register_device(vdev, type, nr, 0, vdev->fops->owner); | |
159 | } | |
6b5270d2 | 160 | |
dc93a70c | 161 | /* Unregister video devices. Will do nothing if vdev == NULL or |
957b4aa9 | 162 | video_is_registered() returns false. */ |
dc93a70c | 163 | void video_unregister_device(struct video_device *vdev); |
401998fa | 164 | |
bfa8a273 HV |
165 | /* helper functions to alloc/release struct video_device, the |
166 | latter can also be used for video_device->release(). */ | |
e138c592 | 167 | struct video_device * __must_check video_device_alloc(void); |
bfa8a273 | 168 | |
dc93a70c HV |
169 | /* this release function frees the vdev pointer */ |
170 | void video_device_release(struct video_device *vdev); | |
bfa8a273 | 171 | |
f9e86b5e HV |
172 | /* this release function does nothing, use when the video_device is a |
173 | static global struct. Note that having a static video_device is | |
174 | a dubious construction at best. */ | |
dc93a70c | 175 | void video_device_release_empty(struct video_device *vdev); |
401998fa | 176 | |
8ab75e3e HV |
177 | /* returns true if cmd is a known V4L2 ioctl */ |
178 | bool v4l2_is_known_ioctl(unsigned int cmd); | |
179 | ||
180 | /* mark that this command shouldn't use core locking */ | |
181 | static inline void v4l2_dont_use_lock(struct video_device *vdev, unsigned int cmd) | |
182 | { | |
183 | if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE) | |
184 | set_bit(_IOC_NR(cmd), vdev->dont_use_lock); | |
185 | } | |
186 | ||
401998fa | 187 | /* helper functions to access driver private data. */ |
dc93a70c | 188 | static inline void *video_get_drvdata(struct video_device *vdev) |
401998fa | 189 | { |
dc93a70c | 190 | return dev_get_drvdata(&vdev->dev); |
401998fa MCC |
191 | } |
192 | ||
dc93a70c | 193 | static inline void video_set_drvdata(struct video_device *vdev, void *data) |
401998fa | 194 | { |
dc93a70c | 195 | dev_set_drvdata(&vdev->dev, data); |
401998fa | 196 | } |
38ee04f0 | 197 | |
bfa8a273 HV |
198 | struct video_device *video_devdata(struct file *file); |
199 | ||
200 | /* Combine video_get_drvdata and video_devdata as this is | |
201 | used very often. */ | |
202 | static inline void *video_drvdata(struct file *file) | |
203 | { | |
204 | return video_get_drvdata(video_devdata(file)); | |
205 | } | |
401998fa | 206 | |
eac8ea53 LP |
207 | static inline const char *video_device_node_name(struct video_device *vdev) |
208 | { | |
209 | return dev_name(&vdev->dev); | |
210 | } | |
211 | ||
957b4aa9 | 212 | static inline int video_is_registered(struct video_device *vdev) |
dc93a70c | 213 | { |
957b4aa9 | 214 | return test_bit(V4L2_FL_REGISTERED, &vdev->flags); |
dc93a70c HV |
215 | } |
216 | ||
401998fa | 217 | #endif /* _V4L2_DEV_H */ |