blob: c768c9f8abc2ca0f1125cf7c1ce9135587bbefbc [file] [log] [blame]
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -03001/*
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 Chehab401998f2006-06-04 10:06:18 -030012#include <linux/poll.h>
13#include <linux/fs.h>
14#include <linux/device.h>
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030015#include <linux/cdev.h>
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030016#include <linux/mutex.h>
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030017#include <linux/videodev2.h>
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030018
Laurent Pinchart2c0ab672009-12-09 08:40:10 -030019#include <media/media-entity.h>
20
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030021#define VIDEO_MAJOR 81
Hans Verkuilbfa8a272008-08-23 07:48:38 -030022
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030023#define VFL_TYPE_GRABBER 0
24#define VFL_TYPE_VBI 1
25#define VFL_TYPE_RADIO 2
Laurent Pinchart2096a5d2009-12-09 08:38:49 -030026#define VFL_TYPE_SUBDEV 3
27#define VFL_TYPE_MAX 4
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030028
Hans Verkuil5c778792012-09-05 05:33:21 -030029/* Is this a receiver, transmitter or mem-to-mem? */
30/* Ignored for VFL_TYPE_SUBDEV. */
31#define VFL_DIR_RX 0
32#define VFL_DIR_TX 1
33#define VFL_DIR_M2M 2
34
Hans Verkuila3998102008-07-21 02:57:38 -030035struct v4l2_ioctl_callbacks;
Hans Verkuilbec43662008-12-30 06:58:20 -030036struct video_device;
Hans Verkuil9bea3512008-12-23 07:35:17 -030037struct v4l2_device;
Hans Verkuil09965172010-08-01 14:32:42 -030038struct v4l2_ctrl_handler;
Hans Verkuila3998102008-07-21 02:57:38 -030039
Laurent Pinchart957b4aa2009-11-27 13:57:22 -030040/* Flag to mark the video_device struct as registered.
41 Drivers can clear this flag if they want to block all future
42 device access. It is cleared by video_unregister_device. */
43#define V4L2_FL_REGISTERED (0)
Hans Verkuilb1a873a2011-03-22 10:14:07 -030044/* file->private_data points to struct v4l2_fh */
Sakari Ailus1babcb42010-03-23 09:25:26 -030045#define V4L2_FL_USES_V4L2_FH (1)
Hans Verkuilb1a873a2011-03-22 10:14:07 -030046/* Use the prio field of v4l2_fh for core priority checking */
47#define V4L2_FL_USE_FH_PRIO (2)
Hans Verkuildc93a702008-12-19 21:28:27 -030048
Hans Verkuil02265492010-12-29 10:05:02 -030049/* Priority helper functions */
50
51struct v4l2_prio_state {
52 atomic_t prios[4];
53};
54
55void v4l2_prio_init(struct v4l2_prio_state *global);
56int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
57 enum v4l2_priority new);
58void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
59void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
60enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
61int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
62
63
Hans Verkuilbec43662008-12-30 06:58:20 -030064struct v4l2_file_operations {
65 struct module *owner;
66 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
67 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
68 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Hans Verkuil069b7472008-12-30 07:04:34 -030069 long (*ioctl) (struct file *, unsigned int, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030070 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
Laurent Pinchartb9d0aa62011-12-18 20:41:19 -030071#ifdef CONFIG_COMPAT
72 long (*compat_ioctl32) (struct file *, unsigned int, unsigned long);
73#endif
Bob Liuecc65172011-05-06 05:20:09 -030074 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
75 unsigned long, unsigned long, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030076 int (*mmap) (struct file *, struct vm_area_struct *);
77 int (*open) (struct file *);
78 int (*release) (struct file *);
79};
80
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030081/*
82 * Newer version of video_device, handled by videodev2.c
83 * This version moves redundant code from video device code to
84 * the common handler
85 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030086
87struct video_device
88{
Laurent Pinchart2c0ab672009-12-09 08:40:10 -030089#if defined(CONFIG_MEDIA_CONTROLLER)
90 struct media_entity entity;
91#endif
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030092 /* device ops */
Hans Verkuilbec43662008-12-30 06:58:20 -030093 const struct v4l2_file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030094
Kay Sievers54bd5b62007-10-08 16:26:13 -030095 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030096 struct device dev; /* v4l device */
Hans Verkuildc93a702008-12-19 21:28:27 -030097 struct cdev *cdev; /* character device */
Hans Verkuil9bea3512008-12-23 07:35:17 -030098
Hans Verkuil9bea3512008-12-23 07:35:17 -030099 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
Hans Verkuil1c1d86a2013-06-12 11:15:12 -0300100 /* Only set parent if that can't be deduced from v4l2_dev */
101 struct device *dev_parent; /* device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -0300102
Hans Verkuil09965172010-08-01 14:32:42 -0300103 /* Control handler associated with this device node. May be NULL. */
104 struct v4l2_ctrl_handler *ctrl_handler;
105
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300106 /* vb2_queue associated with this device node. May be NULL. */
107 struct vb2_queue *queue;
108
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300109 /* Priority state. If NULL, then v4l2_dev->prio will be used. */
110 struct v4l2_prio_state *prio;
111
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300112 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300113 char name[32];
Hans Verkuil5c778792012-09-05 05:33:21 -0300114 int vfl_type; /* device type */
115 int vfl_dir; /* receiver, transmitter or m2m */
Hans Verkuildc93a702008-12-19 21:28:27 -0300116 /* 'minor' is set to -1 if the registration failed */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300117 int minor;
Hans Verkuildd896012008-10-04 08:36:54 -0300118 u16 num;
Hans Verkuildc93a702008-12-19 21:28:27 -0300119 /* use bitops to set/clear/test flags */
120 unsigned long flags;
Hans Verkuilde1e5752008-07-26 08:37:58 -0300121 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -0300122 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300123
Sakari Ailus1babcb42010-03-23 09:25:26 -0300124 /* V4L2 file handles */
125 spinlock_t fh_lock; /* Lock for all v4l2_fhs */
126 struct list_head fh_list; /* List of struct v4l2_fh */
127
Hans Verkuil22a04f12008-07-20 06:35:02 -0300128 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300129
130 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -0300131 v4l2_std_id tvnorms; /* Supported tv norms */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300132
133 /* callbacks */
Hans Verkuildc93a702008-12-19 21:28:27 -0300134 void (*release)(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300135
136 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -0300137 const struct v4l2_ioctl_ops *ioctl_ops;
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300138 DECLARE_BITMAP(valid_ioctls, BASE_VIDIOC_PRIVATE);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300139
140 /* serialization lock */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300141 DECLARE_BITMAP(disable_locking, BASE_VIDIOC_PRIVATE);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300142 struct mutex *lock;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300143};
144
Laurent Pinchart6e3ea0e2011-05-02 16:21:03 -0300145#define media_entity_to_video_device(__e) \
146 container_of(__e, struct video_device, entity)
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300147/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -0300148#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -0300149
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300150int __must_check __video_register_device(struct video_device *vdev, int type,
151 int nr, int warn_if_nr_in_use, struct module *owner);
152
Hans Verkuildc93a702008-12-19 21:28:27 -0300153/* Register video devices. Note that if video_register_device fails,
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300154 the release() callback of the video_device structure is *not* called, so
155 the caller is responsible for freeing any data. Usually that means that
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300156 you call video_device_release() on failure. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300157static inline int __must_check video_register_device(struct video_device *vdev,
158 int type, int nr)
159{
160 return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
161}
Hans Verkuildc93a702008-12-19 21:28:27 -0300162
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300163/* Same as video_register_device, but no warning is issued if the desired
164 device node number was already in use. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300165static inline int __must_check video_register_device_no_warn(
166 struct video_device *vdev, int type, int nr)
167{
168 return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
169}
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300170
Hans Verkuildc93a702008-12-19 21:28:27 -0300171/* Unregister video devices. Will do nothing if vdev == NULL or
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300172 video_is_registered() returns false. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300173void video_unregister_device(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300174
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300175/* helper functions to alloc/release struct video_device, the
176 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -0300177struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300178
Hans Verkuildc93a702008-12-19 21:28:27 -0300179/* this release function frees the vdev pointer */
180void video_device_release(struct video_device *vdev);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300181
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300182/* this release function does nothing, use when the video_device is a
183 static global struct. Note that having a static video_device is
184 a dubious construction at best. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300185void video_device_release_empty(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300186
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300187/* returns true if cmd is a known V4L2 ioctl */
188bool v4l2_is_known_ioctl(unsigned int cmd);
189
190/* mark that this command shouldn't use core locking */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300191static inline void v4l2_disable_ioctl_locking(struct video_device *vdev, unsigned int cmd)
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300192{
193 if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
Hans Verkuil152a3a72012-05-14 11:32:48 -0300194 set_bit(_IOC_NR(cmd), vdev->disable_locking);
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300195}
196
Hans Verkuil152a3a72012-05-14 11:32:48 -0300197/* Mark that this command isn't implemented. This must be called before
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300198 video_device_register. See also the comments in determine_valid_ioctls().
199 This function allows drivers to provide just one v4l2_ioctl_ops struct, but
200 disable ioctls based on the specific card that is actually found. */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300201static inline void v4l2_disable_ioctl(struct video_device *vdev, unsigned int cmd)
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300202{
203 if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
204 set_bit(_IOC_NR(cmd), vdev->valid_ioctls);
205}
206
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300207/* helper functions to access driver private data. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300208static inline void *video_get_drvdata(struct video_device *vdev)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300209{
Hans Verkuildc93a702008-12-19 21:28:27 -0300210 return dev_get_drvdata(&vdev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300211}
212
Hans Verkuildc93a702008-12-19 21:28:27 -0300213static inline void video_set_drvdata(struct video_device *vdev, void *data)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300214{
Hans Verkuildc93a702008-12-19 21:28:27 -0300215 dev_set_drvdata(&vdev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300216}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300217
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300218struct video_device *video_devdata(struct file *file);
219
220/* Combine video_get_drvdata and video_devdata as this is
221 used very often. */
222static inline void *video_drvdata(struct file *file)
223{
224 return video_get_drvdata(video_devdata(file));
225}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300226
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300227static inline const char *video_device_node_name(struct video_device *vdev)
228{
229 return dev_name(&vdev->dev);
230}
231
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300232static inline int video_is_registered(struct video_device *vdev)
Hans Verkuildc93a702008-12-19 21:28:27 -0300233{
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300234 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300235}
236
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300237#endif /* _V4L2_DEV_H */