blob: 8266d5ade2ffd39532cc4e3347e549524334c273 [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 Verkuildc93a702008-12-19 21:28:27 -030042
Hans Verkuil02265492010-12-29 10:05:02 -030043/* Priority helper functions */
44
45struct v4l2_prio_state {
46 atomic_t prios[4];
47};
48
49void v4l2_prio_init(struct v4l2_prio_state *global);
50int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
51 enum v4l2_priority new);
52void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
53void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
54enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
55int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
56
57
Hans Verkuilbec43662008-12-30 06:58:20 -030058struct 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 Verkuil069b7472008-12-30 07:04:34 -030063 long (*ioctl) (struct file *, unsigned int, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030064 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 Chehab401998f2006-06-04 10:06:18 -030070/*
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 Chehab401998f2006-06-04 10:06:18 -030075
76struct video_device
77{
Laurent Pinchart2c0ab672009-12-09 08:40:10 -030078#if defined(CONFIG_MEDIA_CONTROLLER)
79 struct media_entity entity;
80#endif
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030081 /* device ops */
Hans Verkuilbec43662008-12-30 06:58:20 -030082 const struct v4l2_file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030083
Kay Sievers54bd5b62007-10-08 16:26:13 -030084 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030085 struct device dev; /* v4l device */
Hans Verkuildc93a702008-12-19 21:28:27 -030086 struct cdev *cdev; /* character device */
Hans Verkuil9bea3512008-12-23 07:35:17 -030087
88 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
Hans Verkuil5e85e732008-07-20 06:31:39 -030089 struct device *parent; /* device parent */
Hans Verkuil9bea3512008-12-23 07:35:17 -030090 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -030091
Hans Verkuil09965172010-08-01 14:32:42 -030092 /* Control handler associated with this device node. May be NULL. */
93 struct v4l2_ctrl_handler *ctrl_handler;
94
Hans Verkuil0f62fd62011-02-24 10:42:24 -030095 /* Priority state. If NULL, then v4l2_dev->prio will be used. */
96 struct v4l2_prio_state *prio;
97
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030098 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030099 char name[32];
Hans Verkuil0ea6bc82008-07-26 08:26:43 -0300100 int vfl_type;
Hans Verkuildc93a702008-12-19 21:28:27 -0300101 /* 'minor' is set to -1 if the registration failed */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300102 int minor;
Hans Verkuildd896012008-10-04 08:36:54 -0300103 u16 num;
Hans Verkuildc93a702008-12-19 21:28:27 -0300104 /* use bitops to set/clear/test flags */
105 unsigned long flags;
Hans Verkuilde1e5752008-07-26 08:37:58 -0300106 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -0300107 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300108
Sakari Ailus1babcb42010-03-23 09:25:26 -0300109 /* 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 Verkuil22a04f12008-07-20 06:35:02 -0300113 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300114
115 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -0300116 v4l2_std_id tvnorms; /* Supported tv norms */
117 v4l2_std_id current_norm; /* Current tvnorm */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300118
119 /* callbacks */
Hans Verkuildc93a702008-12-19 21:28:27 -0300120 void (*release)(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300121
122 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -0300123 const struct v4l2_ioctl_ops *ioctl_ops;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300124
125 /* serialization lock */
126 struct mutex *lock;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300127};
128
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300129#define media_entity_to_video_device(entity) \
130 container_of(entity, struct video_device, entity)
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300131/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -0300132#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -0300133
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300134int __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 Verkuildc93a702008-12-19 21:28:27 -0300137/* Register video devices. Note that if video_register_device fails,
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300138 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 Pinchart957b4aa2009-11-27 13:57:22 -0300140 you call video_device_release() on failure. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300141static 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 Verkuildc93a702008-12-19 21:28:27 -0300146
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300147/* Same as video_register_device, but no warning is issued if the desired
148 device node number was already in use. */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300149static 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 Verkuil6b5270d2009-09-06 07:54:00 -0300154
Hans Verkuildc93a702008-12-19 21:28:27 -0300155/* Unregister video devices. Will do nothing if vdev == NULL or
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300156 video_is_registered() returns false. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300157void video_unregister_device(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300158
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300159/* helper functions to alloc/release struct video_device, the
160 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -0300161struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300162
Hans Verkuildc93a702008-12-19 21:28:27 -0300163/* this release function frees the vdev pointer */
164void video_device_release(struct video_device *vdev);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300165
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300166/* 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 Verkuildc93a702008-12-19 21:28:27 -0300169void video_device_release_empty(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300170
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300171/* helper functions to access driver private data. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300172static inline void *video_get_drvdata(struct video_device *vdev)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300173{
Hans Verkuildc93a702008-12-19 21:28:27 -0300174 return dev_get_drvdata(&vdev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300175}
176
Hans Verkuildc93a702008-12-19 21:28:27 -0300177static inline void video_set_drvdata(struct video_device *vdev, void *data)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300178{
Hans Verkuildc93a702008-12-19 21:28:27 -0300179 dev_set_drvdata(&vdev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300180}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300181
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300182struct video_device *video_devdata(struct file *file);
183
184/* Combine video_get_drvdata and video_devdata as this is
185 used very often. */
186static inline void *video_drvdata(struct file *file)
187{
188 return video_get_drvdata(video_devdata(file));
189}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300190
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300191static inline const char *video_device_node_name(struct video_device *vdev)
192{
193 return dev_name(&vdev->dev);
194}
195
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300196static inline int video_is_registered(struct video_device *vdev)
Hans Verkuildc93a702008-12-19 21:28:27 -0300197{
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300198 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300199}
200
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300201#endif /* _V4L2_DEV_H */