blob: d129b56e1a9fdea13fbe919f99a0b654f20443c7 [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
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030019#define VIDEO_MAJOR 81
Hans Verkuilbfa8a272008-08-23 07:48:38 -030020
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030021/* Minor device allocation */
22#define MINOR_VFL_TYPE_GRABBER_MIN 0
23#define MINOR_VFL_TYPE_GRABBER_MAX 63
24#define MINOR_VFL_TYPE_RADIO_MIN 64
25#define MINOR_VFL_TYPE_RADIO_MAX 127
26#define MINOR_VFL_TYPE_VTX_MIN 192
27#define MINOR_VFL_TYPE_VTX_MAX 223
28#define MINOR_VFL_TYPE_VBI_MIN 224
29#define MINOR_VFL_TYPE_VBI_MAX 255
30
31#define VFL_TYPE_GRABBER 0
32#define VFL_TYPE_VBI 1
33#define VFL_TYPE_RADIO 2
34#define VFL_TYPE_VTX 3
35
Hans Verkuila3998102008-07-21 02:57:38 -030036struct v4l2_ioctl_callbacks;
37
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030038/*
39 * Newer version of video_device, handled by videodev2.c
40 * This version moves redundant code from video device code to
41 * the common handler
42 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030043
44struct video_device
45{
46 /* device ops */
Mauro Carvalho Chehab5e87efa2006-06-05 10:26:32 -030047 const struct file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030048
Kay Sievers54bd5b62007-10-08 16:26:13 -030049 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030050 struct device dev; /* v4l device */
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030051 struct cdev cdev; /* character device */
52 void (*cdev_release)(struct kobject *kobj);
Hans Verkuil5e85e732008-07-20 06:31:39 -030053 struct device *parent; /* device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -030054
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030055 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030056 char name[32];
Hans Verkuil0ea6bc82008-07-26 08:26:43 -030057 int vfl_type;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030058 int minor;
Hans Verkuilde1e5752008-07-26 08:37:58 -030059 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -030060 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030061
Hans Verkuil22a04f12008-07-20 06:35:02 -030062 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030063
64 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -030065 v4l2_std_id tvnorms; /* Supported tv norms */
66 v4l2_std_id current_norm; /* Current tvnorm */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030067
68 /* callbacks */
69 void (*release)(struct video_device *vfd);
70
71 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -030072 const struct v4l2_ioctl_ops *ioctl_ops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030073};
74
Hans Verkuilbfa8a272008-08-23 07:48:38 -030075/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -030076#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -030077
Hans Verkuilbfa8a272008-08-23 07:48:38 -030078/* Register and unregister devices. Note that if video_register_device fails,
79 the release() callback of the video_device structure is *not* called, so
80 the caller is responsible for freeing any data. Usually that means that
81 you call video_device_release() on failure. */
Hans Verkuile138c592008-08-23 06:38:11 -030082int __must_check video_register_device(struct video_device *vfd, int type, int nr);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030083int __must_check video_register_device_index(struct video_device *vfd,
84 int type, int nr, int index);
85void video_unregister_device(struct video_device *vfd);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030086
Hans Verkuilbfa8a272008-08-23 07:48:38 -030087/* helper functions to alloc/release struct video_device, the
88 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -030089struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030090
Hans Verkuilf9e86b52008-08-23 05:47:41 -030091/* this release function frees the vfd pointer */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030092void video_device_release(struct video_device *vfd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030093
Hans Verkuilf9e86b52008-08-23 05:47:41 -030094/* this release function does nothing, use when the video_device is a
95 static global struct. Note that having a static video_device is
96 a dubious construction at best. */
97void video_device_release_empty(struct video_device *vfd);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030098
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030099/* helper functions to access driver private data. */
100static inline void *video_get_drvdata(struct video_device *dev)
101{
Hans Verkuil601e9442008-08-23 07:24:07 -0300102 return dev_get_drvdata(&dev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300103}
104
105static inline void video_set_drvdata(struct video_device *dev, void *data)
106{
Hans Verkuil601e9442008-08-23 07:24:07 -0300107 dev_set_drvdata(&dev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300108}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300109
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300110struct video_device *video_devdata(struct file *file);
111
112/* Combine video_get_drvdata and video_devdata as this is
113 used very often. */
114static inline void *video_drvdata(struct file *file)
115{
116 return video_get_drvdata(video_devdata(file));
117}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300118
119#endif /* _V4L2_DEV_H */