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