Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 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 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 12 | #include <linux/poll.h> |
| 13 | #include <linux/fs.h> |
| 14 | #include <linux/device.h> |
Hans Verkuil | 7f8ecfa | 2008-08-29 17:31:35 -0300 | [diff] [blame] | 15 | #include <linux/cdev.h> |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 16 | #include <linux/mutex.h> |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 17 | #include <linux/videodev2.h> |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 18 | |
Laurent Pinchart | 2c0ab67 | 2009-12-09 08:40:10 -0300 | [diff] [blame] | 19 | #include <media/media-entity.h> |
| 20 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 21 | #define VIDEO_MAJOR 81 |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 22 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 23 | #define VFL_TYPE_GRABBER 0 |
| 24 | #define VFL_TYPE_VBI 1 |
| 25 | #define VFL_TYPE_RADIO 2 |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 26 | #define VFL_TYPE_SUBDEV 3 |
| 27 | #define VFL_TYPE_MAX 4 |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 28 | |
Hans Verkuil | a399810 | 2008-07-21 02:57:38 -0300 | [diff] [blame] | 29 | struct v4l2_ioctl_callbacks; |
Hans Verkuil | bec4366 | 2008-12-30 06:58:20 -0300 | [diff] [blame] | 30 | struct video_device; |
Hans Verkuil | 9bea351 | 2008-12-23 07:35:17 -0300 | [diff] [blame] | 31 | struct v4l2_device; |
Hans Verkuil | 0996517 | 2010-08-01 14:32:42 -0300 | [diff] [blame] | 32 | struct v4l2_ctrl_handler; |
Hans Verkuil | a399810 | 2008-07-21 02:57:38 -0300 | [diff] [blame] | 33 | |
Laurent Pinchart | 957b4aa | 2009-11-27 13:57:22 -0300 | [diff] [blame] | 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) |
Hans Verkuil | b1a873a | 2011-03-22 10:14:07 -0300 | [diff] [blame] | 38 | /* file->private_data points to struct v4l2_fh */ |
Sakari Ailus | 1babcb4 | 2010-03-23 09:25:26 -0300 | [diff] [blame] | 39 | #define V4L2_FL_USES_V4L2_FH (1) |
Hans Verkuil | b1a873a | 2011-03-22 10:14:07 -0300 | [diff] [blame] | 40 | /* Use the prio field of v4l2_fh for core priority checking */ |
| 41 | #define V4L2_FL_USE_FH_PRIO (2) |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 42 | |
Hans Verkuil | 0226549 | 2010-12-29 10:05:02 -0300 | [diff] [blame] | 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 | |
Hans Verkuil | bec4366 | 2008-12-30 06:58:20 -0300 | [diff] [blame] | 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 *); |
Hans Verkuil | 069b747 | 2008-12-30 07:04:34 -0300 | [diff] [blame] | 63 | long (*ioctl) (struct file *, unsigned int, unsigned long); |
Hans Verkuil | bec4366 | 2008-12-30 06:58:20 -0300 | [diff] [blame] | 64 | long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); |
| 65 | int (*mmap) (struct file *, struct vm_area_struct *); |
| 66 | int (*open) (struct file *); |
| 67 | int (*release) (struct file *); |
| 68 | }; |
| 69 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 70 | /* |
| 71 | * Newer version of video_device, handled by videodev2.c |
| 72 | * This version moves redundant code from video device code to |
| 73 | * the common handler |
| 74 | */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 75 | |
| 76 | struct video_device |
| 77 | { |
Laurent Pinchart | 2c0ab67 | 2009-12-09 08:40:10 -0300 | [diff] [blame] | 78 | #if defined(CONFIG_MEDIA_CONTROLLER) |
| 79 | struct media_entity entity; |
| 80 | #endif |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 81 | /* device ops */ |
Hans Verkuil | bec4366 | 2008-12-30 06:58:20 -0300 | [diff] [blame] | 82 | const struct v4l2_file_operations *fops; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 83 | |
Kay Sievers | 54bd5b6 | 2007-10-08 16:26:13 -0300 | [diff] [blame] | 84 | /* sysfs */ |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 85 | struct device dev; /* v4l device */ |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 86 | struct cdev *cdev; /* character device */ |
Hans Verkuil | 9bea351 | 2008-12-23 07:35:17 -0300 | [diff] [blame] | 87 | |
| 88 | /* Set either parent or v4l2_dev if your driver uses v4l2_device */ |
Hans Verkuil | 5e85e73 | 2008-07-20 06:31:39 -0300 | [diff] [blame] | 89 | struct device *parent; /* device parent */ |
Hans Verkuil | 9bea351 | 2008-12-23 07:35:17 -0300 | [diff] [blame] | 90 | struct v4l2_device *v4l2_dev; /* v4l2_device parent */ |
Kay Sievers | 54bd5b6 | 2007-10-08 16:26:13 -0300 | [diff] [blame] | 91 | |
Hans Verkuil | 0996517 | 2010-08-01 14:32:42 -0300 | [diff] [blame] | 92 | /* Control handler associated with this device node. May be NULL. */ |
| 93 | struct v4l2_ctrl_handler *ctrl_handler; |
| 94 | |
Hans Verkuil | 0f62fd6 | 2011-02-24 10:42:24 -0300 | [diff] [blame] | 95 | /* Priority state. If NULL, then v4l2_dev->prio will be used. */ |
| 96 | struct v4l2_prio_state *prio; |
| 97 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 98 | /* device info */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 99 | char name[32]; |
Hans Verkuil | 0ea6bc8 | 2008-07-26 08:26:43 -0300 | [diff] [blame] | 100 | int vfl_type; |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 101 | /* 'minor' is set to -1 if the registration failed */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 102 | int minor; |
Hans Verkuil | dd89601 | 2008-10-04 08:36:54 -0300 | [diff] [blame] | 103 | u16 num; |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 104 | /* use bitops to set/clear/test flags */ |
| 105 | unsigned long flags; |
Hans Verkuil | de1e575 | 2008-07-26 08:37:58 -0300 | [diff] [blame] | 106 | /* attribute to differentiate multiple indices on one physical device */ |
brandon@ifup.org | 539a755 | 2008-06-20 22:58:53 -0300 | [diff] [blame] | 107 | int index; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 108 | |
Sakari Ailus | 1babcb4 | 2010-03-23 09:25:26 -0300 | [diff] [blame] | 109 | /* V4L2 file handles */ |
| 110 | spinlock_t fh_lock; /* Lock for all v4l2_fhs */ |
| 111 | struct list_head fh_list; /* List of struct v4l2_fh */ |
| 112 | |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 113 | int debug; /* Activates debug level*/ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 114 | |
| 115 | /* Video standard vars */ |
Mauro Carvalho Chehab | e75f9ce | 2006-11-20 13:19:20 -0300 | [diff] [blame] | 116 | v4l2_std_id tvnorms; /* Supported tv norms */ |
| 117 | v4l2_std_id current_norm; /* Current tvnorm */ |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 118 | |
| 119 | /* callbacks */ |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 120 | void (*release)(struct video_device *vdev); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 121 | |
| 122 | /* ioctl callbacks */ |
Hans Verkuil | a399810 | 2008-07-21 02:57:38 -0300 | [diff] [blame] | 123 | const struct v4l2_ioctl_ops *ioctl_ops; |
Hans Verkuil | ee6869a | 2010-09-26 08:47:38 -0300 | [diff] [blame] | 124 | |
| 125 | /* serialization lock */ |
| 126 | struct mutex *lock; |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 127 | }; |
| 128 | |
Laurent Pinchart | 2c0ab67 | 2009-12-09 08:40:10 -0300 | [diff] [blame] | 129 | #define media_entity_to_video_device(entity) \ |
| 130 | container_of(entity, struct video_device, entity) |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 131 | /* dev to video-device */ |
Hans Verkuil | 22a04f1 | 2008-07-20 06:35:02 -0300 | [diff] [blame] | 132 | #define to_video_device(cd) container_of(cd, struct video_device, dev) |
Linus Torvalds | e90ff92 | 2007-09-13 21:09:01 -0300 | [diff] [blame] | 133 | |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 134 | int __must_check __video_register_device(struct video_device *vdev, int type, |
| 135 | int nr, int warn_if_nr_in_use, struct module *owner); |
| 136 | |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 137 | /* Register video devices. Note that if video_register_device fails, |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 138 | the release() callback of the video_device structure is *not* called, so |
| 139 | the caller is responsible for freeing any data. Usually that means that |
Laurent Pinchart | 957b4aa | 2009-11-27 13:57:22 -0300 | [diff] [blame] | 140 | you call video_device_release() on failure. */ |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 141 | static inline int __must_check video_register_device(struct video_device *vdev, |
| 142 | int type, int nr) |
| 143 | { |
| 144 | return __video_register_device(vdev, type, nr, 1, vdev->fops->owner); |
| 145 | } |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 146 | |
Hans Verkuil | 6b5270d | 2009-09-06 07:54:00 -0300 | [diff] [blame] | 147 | /* Same as video_register_device, but no warning is issued if the desired |
| 148 | device node number was already in use. */ |
Laurent Pinchart | 2096a5d | 2009-12-09 08:38:49 -0300 | [diff] [blame] | 149 | static inline int __must_check video_register_device_no_warn( |
| 150 | struct video_device *vdev, int type, int nr) |
| 151 | { |
| 152 | return __video_register_device(vdev, type, nr, 0, vdev->fops->owner); |
| 153 | } |
Hans Verkuil | 6b5270d | 2009-09-06 07:54:00 -0300 | [diff] [blame] | 154 | |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 155 | /* Unregister video devices. Will do nothing if vdev == NULL or |
Laurent Pinchart | 957b4aa | 2009-11-27 13:57:22 -0300 | [diff] [blame] | 156 | video_is_registered() returns false. */ |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 157 | void video_unregister_device(struct video_device *vdev); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 158 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 159 | /* helper functions to alloc/release struct video_device, the |
| 160 | latter can also be used for video_device->release(). */ |
Hans Verkuil | e138c59 | 2008-08-23 06:38:11 -0300 | [diff] [blame] | 161 | struct video_device * __must_check video_device_alloc(void); |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 162 | |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 163 | /* this release function frees the vdev pointer */ |
| 164 | void video_device_release(struct video_device *vdev); |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 165 | |
Hans Verkuil | f9e86b5 | 2008-08-23 05:47:41 -0300 | [diff] [blame] | 166 | /* this release function does nothing, use when the video_device is a |
| 167 | static global struct. Note that having a static video_device is |
| 168 | a dubious construction at best. */ |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 169 | void video_device_release_empty(struct video_device *vdev); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 170 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 171 | /* helper functions to access driver private data. */ |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 172 | static inline void *video_get_drvdata(struct video_device *vdev) |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 173 | { |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 174 | return dev_get_drvdata(&vdev->dev); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 175 | } |
| 176 | |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 177 | static inline void video_set_drvdata(struct video_device *vdev, void *data) |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 178 | { |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 179 | dev_set_drvdata(&vdev->dev, data); |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 180 | } |
Mauro Carvalho Chehab | 38ee04f | 2006-08-08 09:10:01 -0300 | [diff] [blame] | 181 | |
Hans Verkuil | bfa8a27 | 2008-08-23 07:48:38 -0300 | [diff] [blame] | 182 | struct video_device *video_devdata(struct file *file); |
| 183 | |
| 184 | /* Combine video_get_drvdata and video_devdata as this is |
| 185 | used very often. */ |
| 186 | static inline void *video_drvdata(struct file *file) |
| 187 | { |
| 188 | return video_get_drvdata(video_devdata(file)); |
| 189 | } |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 190 | |
Laurent Pinchart | eac8ea5 | 2009-11-27 13:56:50 -0300 | [diff] [blame] | 191 | static inline const char *video_device_node_name(struct video_device *vdev) |
| 192 | { |
| 193 | return dev_name(&vdev->dev); |
| 194 | } |
| 195 | |
Laurent Pinchart | 957b4aa | 2009-11-27 13:57:22 -0300 | [diff] [blame] | 196 | static inline int video_is_registered(struct video_device *vdev) |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 197 | { |
Laurent Pinchart | 957b4aa | 2009-11-27 13:57:22 -0300 | [diff] [blame] | 198 | return test_bit(V4L2_FL_REGISTERED, &vdev->flags); |
Hans Verkuil | dc93a70 | 2008-12-19 21:28:27 -0300 | [diff] [blame] | 199 | } |
| 200 | |
Mauro Carvalho Chehab | 401998f | 2006-06-04 10:06:18 -0300 | [diff] [blame] | 201 | #endif /* _V4L2_DEV_H */ |