blob: a056e6ee1b6820c05d87ae6e178cc0a6008dc814 [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 Verkuila3998102008-07-21 02:57:38 -030029struct v4l2_ioctl_callbacks;
Hans Verkuilbec43662008-12-30 06:58:20 -030030struct video_device;
Hans Verkuil9bea3512008-12-23 07:35:17 -030031struct v4l2_device;
Hans Verkuil09965172010-08-01 14:32:42 -030032struct v4l2_ctrl_handler;
Hans Verkuila3998102008-07-21 02:57:38 -030033
Laurent Pinchart957b4aa2009-11-27 13:57:22 -030034/* 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 Verkuilb1a873a2011-03-22 10:14:07 -030038/* file->private_data points to struct v4l2_fh */
Sakari Ailus1babcb42010-03-23 09:25:26 -030039#define V4L2_FL_USES_V4L2_FH (1)
Hans Verkuilb1a873a2011-03-22 10:14:07 -030040/* Use the prio field of v4l2_fh for core priority checking */
41#define V4L2_FL_USE_FH_PRIO (2)
Hans Verkuil5126f252012-05-10 04:57:22 -030042/* If ioctl core locking is in use, then apply that also to all
Hans Verkuil47bd4bc2012-05-14 11:28:44 -030043 file operations. Don't use this flag in new drivers! */
Hans Verkuil5126f252012-05-10 04:57:22 -030044#define V4L2_FL_LOCK_ALL_FOPS (3)
Hans Verkuildc93a702008-12-19 21:28:27 -030045
Hans Verkuil02265492010-12-29 10:05:02 -030046/* Priority helper functions */
47
48struct v4l2_prio_state {
49 atomic_t prios[4];
50};
51
52void v4l2_prio_init(struct v4l2_prio_state *global);
53int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
54 enum v4l2_priority new);
55void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
56void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
57enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
58int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
59
60
Hans Verkuilbec43662008-12-30 06:58:20 -030061struct v4l2_file_operations {
62 struct module *owner;
63 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
64 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
65 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Hans Verkuil069b7472008-12-30 07:04:34 -030066 long (*ioctl) (struct file *, unsigned int, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030067 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
Laurent Pinchartb9d0aa62011-12-18 20:41:19 -030068#ifdef CONFIG_COMPAT
69 long (*compat_ioctl32) (struct file *, unsigned int, unsigned long);
70#endif
Bob Liuecc65172011-05-06 05:20:09 -030071 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
72 unsigned long, unsigned long, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030073 int (*mmap) (struct file *, struct vm_area_struct *);
74 int (*open) (struct file *);
75 int (*release) (struct file *);
76};
77
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030078/*
79 * Newer version of video_device, handled by videodev2.c
80 * This version moves redundant code from video device code to
81 * the common handler
82 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030083
84struct video_device
85{
Laurent Pinchart2c0ab672009-12-09 08:40:10 -030086#if defined(CONFIG_MEDIA_CONTROLLER)
87 struct media_entity entity;
88#endif
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030089 /* device ops */
Hans Verkuilbec43662008-12-30 06:58:20 -030090 const struct v4l2_file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030091
Kay Sievers54bd5b62007-10-08 16:26:13 -030092 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030093 struct device dev; /* v4l device */
Hans Verkuildc93a702008-12-19 21:28:27 -030094 struct cdev *cdev; /* character device */
Hans Verkuil9bea3512008-12-23 07:35:17 -030095
96 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
Hans Verkuil5e85e732008-07-20 06:31:39 -030097 struct device *parent; /* device parent */
Hans Verkuil9bea3512008-12-23 07:35:17 -030098 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -030099
Hans Verkuil09965172010-08-01 14:32:42 -0300100 /* Control handler associated with this device node. May be NULL. */
101 struct v4l2_ctrl_handler *ctrl_handler;
102
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300103 /* Priority state. If NULL, then v4l2_dev->prio will be used. */
104 struct v4l2_prio_state *prio;
105
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300106 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300107 char name[32];
Hans Verkuil0ea6bc82008-07-26 08:26:43 -0300108 int vfl_type;
Hans Verkuildc93a702008-12-19 21:28:27 -0300109 /* 'minor' is set to -1 if the registration failed */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300110 int minor;
Hans Verkuildd896012008-10-04 08:36:54 -0300111 u16 num;
Hans Verkuildc93a702008-12-19 21:28:27 -0300112 /* use bitops to set/clear/test flags */
113 unsigned long flags;
Hans Verkuilde1e5752008-07-26 08:37:58 -0300114 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -0300115 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300116
Sakari Ailus1babcb42010-03-23 09:25:26 -0300117 /* V4L2 file handles */
118 spinlock_t fh_lock; /* Lock for all v4l2_fhs */
119 struct list_head fh_list; /* List of struct v4l2_fh */
120
Hans Verkuil22a04f12008-07-20 06:35:02 -0300121 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300122
123 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -0300124 v4l2_std_id tvnorms; /* Supported tv norms */
125 v4l2_std_id current_norm; /* Current tvnorm */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300126
127 /* callbacks */
Hans Verkuildc93a702008-12-19 21:28:27 -0300128 void (*release)(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300129
130 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -0300131 const struct v4l2_ioctl_ops *ioctl_ops;
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300132 DECLARE_BITMAP(valid_ioctls, BASE_VIDIOC_PRIVATE);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300133
134 /* serialization lock */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300135 DECLARE_BITMAP(disable_locking, BASE_VIDIOC_PRIVATE);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300136 struct mutex *lock;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300137};
138
Laurent Pinchart6e3ea0e2011-05-02 16:21:03 -0300139#define media_entity_to_video_device(__e) \
140 container_of(__e, struct video_device, entity)
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300141/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -0300142#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -0300143
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300144int __must_check __video_register_device(struct video_device *vdev, int type,
145 int nr, int warn_if_nr_in_use, struct module *owner);
146
Hans Verkuildc93a702008-12-19 21:28:27 -0300147/* Register video devices. Note that if video_register_device fails,
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300148 the release() callback of the video_device structure is *not* called, so
149 the caller is responsible for freeing any data. Usually that means that
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300150 you call video_device_release() on failure. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300151static inline int __must_check video_register_device(struct video_device *vdev,
152 int type, int nr)
153{
154 return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
155}
Hans Verkuildc93a702008-12-19 21:28:27 -0300156
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300157/* Same as video_register_device, but no warning is issued if the desired
158 device node number was already in use. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300159static inline int __must_check video_register_device_no_warn(
160 struct video_device *vdev, int type, int nr)
161{
162 return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
163}
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300164
Hans Verkuildc93a702008-12-19 21:28:27 -0300165/* Unregister video devices. Will do nothing if vdev == NULL or
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300166 video_is_registered() returns false. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300167void video_unregister_device(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300168
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300169/* helper functions to alloc/release struct video_device, the
170 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -0300171struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300172
Hans Verkuildc93a702008-12-19 21:28:27 -0300173/* this release function frees the vdev pointer */
174void video_device_release(struct video_device *vdev);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300175
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300176/* this release function does nothing, use when the video_device is a
177 static global struct. Note that having a static video_device is
178 a dubious construction at best. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300179void video_device_release_empty(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300180
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300181/* returns true if cmd is a known V4L2 ioctl */
182bool v4l2_is_known_ioctl(unsigned int cmd);
183
184/* mark that this command shouldn't use core locking */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300185static inline void v4l2_disable_ioctl_locking(struct video_device *vdev, unsigned int cmd)
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300186{
187 if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
Hans Verkuil152a3a72012-05-14 11:32:48 -0300188 set_bit(_IOC_NR(cmd), vdev->disable_locking);
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300189}
190
Hans Verkuil152a3a72012-05-14 11:32:48 -0300191/* Mark that this command isn't implemented. This must be called before
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300192 video_device_register. See also the comments in determine_valid_ioctls().
193 This function allows drivers to provide just one v4l2_ioctl_ops struct, but
194 disable ioctls based on the specific card that is actually found. */
Hans Verkuil152a3a72012-05-14 11:32:48 -0300195static inline void v4l2_disable_ioctl(struct video_device *vdev, unsigned int cmd)
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300196{
197 if (_IOC_NR(cmd) < BASE_VIDIOC_PRIVATE)
198 set_bit(_IOC_NR(cmd), vdev->valid_ioctls);
199}
200
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300201/* helper functions to access driver private data. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300202static inline void *video_get_drvdata(struct video_device *vdev)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300203{
Hans Verkuildc93a702008-12-19 21:28:27 -0300204 return dev_get_drvdata(&vdev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300205}
206
Hans Verkuildc93a702008-12-19 21:28:27 -0300207static inline void video_set_drvdata(struct video_device *vdev, void *data)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300208{
Hans Verkuildc93a702008-12-19 21:28:27 -0300209 dev_set_drvdata(&vdev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300210}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300211
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300212struct video_device *video_devdata(struct file *file);
213
214/* Combine video_get_drvdata and video_devdata as this is
215 used very often. */
216static inline void *video_drvdata(struct file *file)
217{
218 return video_get_drvdata(video_devdata(file));
219}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300220
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300221static inline const char *video_device_node_name(struct video_device *vdev)
222{
223 return dev_name(&vdev->dev);
224}
225
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300226static inline int video_is_registered(struct video_device *vdev)
Hans Verkuildc93a702008-12-19 21:28:27 -0300227{
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300228 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300229}
230
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300231#endif /* _V4L2_DEV_H */