blob: 2058dd45e91547b849dfbb1a8ca000b470d8d862 [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#define VFL_TYPE_GRABBER 0
22#define VFL_TYPE_VBI 1
23#define VFL_TYPE_RADIO 2
24#define VFL_TYPE_VTX 3
Hans Verkuildd896012008-10-04 08:36:54 -030025#define VFL_TYPE_MAX 4
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030026
Hans Verkuila3998102008-07-21 02:57:38 -030027struct v4l2_ioctl_callbacks;
Hans Verkuilbec43662008-12-30 06:58:20 -030028struct video_device;
Hans Verkuil9bea3512008-12-23 07:35:17 -030029struct v4l2_device;
Hans Verkuila3998102008-07-21 02:57:38 -030030
Hans Verkuildc93a702008-12-19 21:28:27 -030031/* Flag to mark the video_device struct as unregistered.
32 Drivers can set this flag if they want to block all future
33 device access. It is set by video_unregister_device. */
34#define V4L2_FL_UNREGISTERED (0)
35
Hans Verkuilbec43662008-12-30 06:58:20 -030036struct v4l2_file_operations {
37 struct module *owner;
38 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
39 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
40 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Hans Verkuil069b7472008-12-30 07:04:34 -030041 long (*ioctl) (struct file *, unsigned int, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030042 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
Daniel Glöcknerc01f1a52009-03-26 11:31:08 -030043 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
44 unsigned long, unsigned long, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030045 int (*mmap) (struct file *, struct vm_area_struct *);
46 int (*open) (struct file *);
47 int (*release) (struct file *);
48};
49
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030050/*
51 * Newer version of video_device, handled by videodev2.c
52 * This version moves redundant code from video device code to
53 * the common handler
54 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030055
56struct video_device
57{
58 /* device ops */
Hans Verkuilbec43662008-12-30 06:58:20 -030059 const struct v4l2_file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030060
Kay Sievers54bd5b62007-10-08 16:26:13 -030061 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030062 struct device dev; /* v4l device */
Hans Verkuildc93a702008-12-19 21:28:27 -030063 struct cdev *cdev; /* character device */
Hans Verkuil9bea3512008-12-23 07:35:17 -030064
65 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
Hans Verkuil5e85e732008-07-20 06:31:39 -030066 struct device *parent; /* device parent */
Hans Verkuil9bea3512008-12-23 07:35:17 -030067 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -030068
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030069 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030070 char name[32];
Hans Verkuil0ea6bc82008-07-26 08:26:43 -030071 int vfl_type;
Hans Verkuildc93a702008-12-19 21:28:27 -030072 /* 'minor' is set to -1 if the registration failed */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030073 int minor;
Hans Verkuildd896012008-10-04 08:36:54 -030074 u16 num;
Hans Verkuildc93a702008-12-19 21:28:27 -030075 /* use bitops to set/clear/test flags */
76 unsigned long flags;
Hans Verkuilde1e5752008-07-26 08:37:58 -030077 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -030078 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030079
Hans Verkuil22a04f12008-07-20 06:35:02 -030080 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030081
82 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -030083 v4l2_std_id tvnorms; /* Supported tv norms */
84 v4l2_std_id current_norm; /* Current tvnorm */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030085
86 /* callbacks */
Hans Verkuildc93a702008-12-19 21:28:27 -030087 void (*release)(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030088
89 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -030090 const struct v4l2_ioctl_ops *ioctl_ops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030091};
92
Hans Verkuilbfa8a272008-08-23 07:48:38 -030093/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -030094#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -030095
Hans Verkuildc93a702008-12-19 21:28:27 -030096/* Register video devices. Note that if video_register_device fails,
Hans Verkuilbfa8a272008-08-23 07:48:38 -030097 the release() callback of the video_device structure is *not* called, so
98 the caller is responsible for freeing any data. Usually that means that
Hans Verkuildc93a702008-12-19 21:28:27 -030099 you call video_device_release() on failure.
100
101 Also note that vdev->minor is set to -1 if the registration failed. */
102int __must_check video_register_device(struct video_device *vdev, int type, int nr);
103int __must_check video_register_device_index(struct video_device *vdev,
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300104 int type, int nr, int index);
Hans Verkuildc93a702008-12-19 21:28:27 -0300105
106/* Unregister video devices. Will do nothing if vdev == NULL or
107 vdev->minor < 0. */
108void video_unregister_device(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300109
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300110/* helper functions to alloc/release struct video_device, the
111 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -0300112struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300113
Hans Verkuildc93a702008-12-19 21:28:27 -0300114/* this release function frees the vdev pointer */
115void video_device_release(struct video_device *vdev);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300116
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300117/* this release function does nothing, use when the video_device is a
118 static global struct. Note that having a static video_device is
119 a dubious construction at best. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300120void video_device_release_empty(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300121
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300122/* helper functions to access driver private data. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300123static inline void *video_get_drvdata(struct video_device *vdev)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300124{
Hans Verkuildc93a702008-12-19 21:28:27 -0300125 return dev_get_drvdata(&vdev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300126}
127
Hans Verkuildc93a702008-12-19 21:28:27 -0300128static inline void video_set_drvdata(struct video_device *vdev, void *data)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300129{
Hans Verkuildc93a702008-12-19 21:28:27 -0300130 dev_set_drvdata(&vdev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300131}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300132
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300133struct video_device *video_devdata(struct file *file);
134
135/* Combine video_get_drvdata and video_devdata as this is
136 used very often. */
137static inline void *video_drvdata(struct file *file)
138{
139 return video_get_drvdata(video_devdata(file));
140}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300141
Hans Verkuildc93a702008-12-19 21:28:27 -0300142static inline int video_is_unregistered(struct video_device *vdev)
143{
144 return test_bit(V4L2_FL_UNREGISTERED, &vdev->flags);
145}
146
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300147#endif /* _V4L2_DEV_H */