blob: 1efcacbed01a055bf577ff20b48045e86f3beaba [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 Verkuil09965172010-08-01 14:32:42 -030030struct v4l2_ctrl_handler;
Hans Verkuila3998102008-07-21 02:57:38 -030031
Laurent Pinchart957b4aa2009-11-27 13:57:22 -030032/* Flag to mark the video_device struct as registered.
33 Drivers can clear this flag if they want to block all future
34 device access. It is cleared by video_unregister_device. */
35#define V4L2_FL_REGISTERED (0)
Sakari Ailus1babcb42010-03-23 09:25:26 -030036#define V4L2_FL_USES_V4L2_FH (1)
Hans Verkuildc93a702008-12-19 21:28:27 -030037
Hans Verkuilbec43662008-12-30 06:58:20 -030038struct v4l2_file_operations {
39 struct module *owner;
40 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
41 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
42 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Hans Verkuil069b7472008-12-30 07:04:34 -030043 long (*ioctl) (struct file *, unsigned int, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030044 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
Daniel Glöcknerc01f1a52009-03-26 11:31:08 -030045 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
46 unsigned long, unsigned long, unsigned long);
Hans Verkuilbec43662008-12-30 06:58:20 -030047 int (*mmap) (struct file *, struct vm_area_struct *);
48 int (*open) (struct file *);
49 int (*release) (struct file *);
50};
51
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030052/*
53 * Newer version of video_device, handled by videodev2.c
54 * This version moves redundant code from video device code to
55 * the common handler
56 */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030057
58struct video_device
59{
60 /* device ops */
Hans Verkuilbec43662008-12-30 06:58:20 -030061 const struct v4l2_file_operations *fops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030062
Kay Sievers54bd5b62007-10-08 16:26:13 -030063 /* sysfs */
Hans Verkuil22a04f12008-07-20 06:35:02 -030064 struct device dev; /* v4l device */
Hans Verkuildc93a702008-12-19 21:28:27 -030065 struct cdev *cdev; /* character device */
Hans Verkuil9bea3512008-12-23 07:35:17 -030066
67 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
Hans Verkuil5e85e732008-07-20 06:31:39 -030068 struct device *parent; /* device parent */
Hans Verkuil9bea3512008-12-23 07:35:17 -030069 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
Kay Sievers54bd5b62007-10-08 16:26:13 -030070
Hans Verkuil09965172010-08-01 14:32:42 -030071 /* Control handler associated with this device node. May be NULL. */
72 struct v4l2_ctrl_handler *ctrl_handler;
73
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030074 /* device info */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030075 char name[32];
Hans Verkuil0ea6bc82008-07-26 08:26:43 -030076 int vfl_type;
Hans Verkuildc93a702008-12-19 21:28:27 -030077 /* 'minor' is set to -1 if the registration failed */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030078 int minor;
Hans Verkuildd896012008-10-04 08:36:54 -030079 u16 num;
Hans Verkuildc93a702008-12-19 21:28:27 -030080 /* use bitops to set/clear/test flags */
81 unsigned long flags;
Hans Verkuilde1e5752008-07-26 08:37:58 -030082 /* attribute to differentiate multiple indices on one physical device */
brandon@ifup.org539a7552008-06-20 22:58:53 -030083 int index;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030084
Sakari Ailus1babcb42010-03-23 09:25:26 -030085 /* V4L2 file handles */
86 spinlock_t fh_lock; /* Lock for all v4l2_fhs */
87 struct list_head fh_list; /* List of struct v4l2_fh */
88
Hans Verkuil22a04f12008-07-20 06:35:02 -030089 int debug; /* Activates debug level*/
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030090
91 /* Video standard vars */
Mauro Carvalho Chehabe75f9ce2006-11-20 13:19:20 -030092 v4l2_std_id tvnorms; /* Supported tv norms */
93 v4l2_std_id current_norm; /* Current tvnorm */
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030094
95 /* callbacks */
Hans Verkuildc93a702008-12-19 21:28:27 -030096 void (*release)(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -030097
98 /* ioctl callbacks */
Hans Verkuila3998102008-07-21 02:57:38 -030099 const struct v4l2_ioctl_ops *ioctl_ops;
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300100};
101
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300102/* dev to video-device */
Hans Verkuil22a04f12008-07-20 06:35:02 -0300103#define to_video_device(cd) container_of(cd, struct video_device, dev)
Linus Torvaldse90ff922007-09-13 21:09:01 -0300104
Hans Verkuildc93a702008-12-19 21:28:27 -0300105/* Register video devices. Note that if video_register_device fails,
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300106 the release() callback of the video_device structure is *not* called, so
107 the caller is responsible for freeing any data. Usually that means that
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300108 you call video_device_release() on failure. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300109int __must_check video_register_device(struct video_device *vdev, int type, int nr);
Hans Verkuildc93a702008-12-19 21:28:27 -0300110
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300111/* Same as video_register_device, but no warning is issued if the desired
112 device node number was already in use. */
113int __must_check video_register_device_no_warn(struct video_device *vdev, int type, int nr);
114
Hans Verkuildc93a702008-12-19 21:28:27 -0300115/* Unregister video devices. Will do nothing if vdev == NULL or
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300116 video_is_registered() returns false. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300117void video_unregister_device(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300118
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300119/* helper functions to alloc/release struct video_device, the
120 latter can also be used for video_device->release(). */
Hans Verkuile138c592008-08-23 06:38:11 -0300121struct video_device * __must_check video_device_alloc(void);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300122
Hans Verkuildc93a702008-12-19 21:28:27 -0300123/* this release function frees the vdev pointer */
124void video_device_release(struct video_device *vdev);
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300125
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300126/* this release function does nothing, use when the video_device is a
127 static global struct. Note that having a static video_device is
128 a dubious construction at best. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300129void video_device_release_empty(struct video_device *vdev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300130
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300131/* helper functions to access driver private data. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300132static inline void *video_get_drvdata(struct video_device *vdev)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300133{
Hans Verkuildc93a702008-12-19 21:28:27 -0300134 return dev_get_drvdata(&vdev->dev);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300135}
136
Hans Verkuildc93a702008-12-19 21:28:27 -0300137static inline void video_set_drvdata(struct video_device *vdev, void *data)
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300138{
Hans Verkuildc93a702008-12-19 21:28:27 -0300139 dev_set_drvdata(&vdev->dev, data);
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300140}
Mauro Carvalho Chehab38ee04f2006-08-08 09:10:01 -0300141
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300142struct video_device *video_devdata(struct file *file);
143
144/* Combine video_get_drvdata and video_devdata as this is
145 used very often. */
146static inline void *video_drvdata(struct file *file)
147{
148 return video_get_drvdata(video_devdata(file));
149}
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300150
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300151static inline const char *video_device_node_name(struct video_device *vdev)
152{
153 return dev_name(&vdev->dev);
154}
155
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300156static inline int video_is_registered(struct video_device *vdev)
Hans Verkuildc93a702008-12-19 21:28:27 -0300157{
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300158 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300159}
160
Mauro Carvalho Chehab401998f2006-06-04 10:06:18 -0300161#endif /* _V4L2_DEV_H */