v4l2-dev.h 3.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 *
 *	V 4 L 2   D R I V E R   H E L P E R   A P I
 *
 * Moved from videodev2.h
 *
 *	Some commonly needed functions for drivers (v4l2-common.o module)
 */
#ifndef _V4L2_DEV_H
#define _V4L2_DEV_H

#include <linux/poll.h>
#include <linux/fs.h>
#include <linux/device.h>
15
#include <linux/cdev.h>
16 17 18 19
#include <linux/mutex.h>
#include <linux/videodev2.h>

#define VIDEO_MAJOR	81
20

21 22 23 24
#define VFL_TYPE_GRABBER	0
#define VFL_TYPE_VBI		1
#define VFL_TYPE_RADIO		2
#define VFL_TYPE_VTX		3
25
#define VFL_TYPE_MAX		4
26

27 28
struct v4l2_ioctl_callbacks;

29 30 31 32 33 34 35 36 37
/*
 * Newer version of video_device, handled by videodev2.c
 * 	This version moves redundant code from video device code to
 *	the common handler
 */

struct video_device
{
	/* device ops */
38
	const struct file_operations *fops;
39

40
	/* sysfs */
41
	struct device dev;		/* v4l device */
42 43
	struct cdev cdev;		/* character device */
	void (*cdev_release)(struct kobject *kobj);
44
	struct device *parent;		/* device parent */
45

46 47
	/* device info */
	char name[32];
48
	int vfl_type;
49
	int minor;
50
	u16 num;
51
	/* attribute to differentiate multiple indices on one physical device */
52
	int index;
53

54
	int debug;			/* Activates debug level*/
55 56

	/* Video standard vars */
57 58
	v4l2_std_id tvnorms;		/* Supported tv norms */
	v4l2_std_id current_norm;	/* Current tvnorm */
59 60 61 62 63

	/* callbacks */
	void (*release)(struct video_device *vfd);

	/* ioctl callbacks */
64
	const struct v4l2_ioctl_ops *ioctl_ops;
65 66
};

67
/* dev to video-device */
68
#define to_video_device(cd) container_of(cd, struct video_device, dev)
69

70 71 72 73
/* Register and unregister devices. Note that if video_register_device fails,
   the release() callback of the video_device structure is *not* called, so
   the caller is responsible for freeing any data. Usually that means that
   you call video_device_release() on failure. */
74
int __must_check video_register_device(struct video_device *vfd, int type, int nr);
75 76 77
int __must_check video_register_device_index(struct video_device *vfd,
						int type, int nr, int index);
void video_unregister_device(struct video_device *vfd);
78

79 80
/* helper functions to alloc/release struct video_device, the
   latter can also be used for video_device->release(). */
81
struct video_device * __must_check video_device_alloc(void);
82

83
/* this release function frees the vfd pointer */
84
void video_device_release(struct video_device *vfd);
85

86 87 88 89
/* this release function does nothing, use when the video_device is a
   static global struct. Note that having a static video_device is
   a dubious construction at best. */
void video_device_release_empty(struct video_device *vfd);
90 91 92 93

/* helper functions to access driver private data. */
static inline void *video_get_drvdata(struct video_device *dev)
{
94
	return dev_get_drvdata(&dev->dev);
95 96 97 98
}

static inline void video_set_drvdata(struct video_device *dev, void *data)
{
99
	dev_set_drvdata(&dev->dev, data);
100
}
101

102 103 104 105 106 107 108 109
struct video_device *video_devdata(struct file *file);

/* Combine video_get_drvdata and video_devdata as this is
   used very often. */
static inline void *video_drvdata(struct file *file)
{
	return video_get_drvdata(video_devdata(file));
}
110 111

#endif /* _V4L2_DEV_H */