]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/media/v4l2-dev.h
bnx2: Remove now useless VPD code
[net-next-2.6.git] / include / media / v4l2-dev.h
CommitLineData
401998fa
MCC
1/*
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
401998fa
MCC
12#include <linux/poll.h>
13#include <linux/fs.h>
14#include <linux/device.h>
7f8ecfab 15#include <linux/cdev.h>
401998fa 16#include <linux/mutex.h>
401998fa 17#include <linux/videodev2.h>
401998fa 18
401998fa 19#define VIDEO_MAJOR 81
bfa8a273 20
401998fa
MCC
21#define VFL_TYPE_GRABBER 0
22#define VFL_TYPE_VBI 1
23#define VFL_TYPE_RADIO 2
24#define VFL_TYPE_VTX 3
dd89601d 25#define VFL_TYPE_MAX 4
401998fa 26
a399810c 27struct v4l2_ioctl_callbacks;
bec43661 28struct video_device;
9bea3514 29struct v4l2_device;
a399810c 30
957b4aa9
LP
31/* Flag to mark the video_device struct as registered.
32 Drivers can clear this flag if they want to block all future
33 device access. It is cleared by video_unregister_device. */
34#define V4L2_FL_REGISTERED (0)
dc93a70c 35
bec43661
HV
36struct 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 *);
069b7479 41 long (*ioctl) (struct file *, unsigned int, unsigned long);
bec43661 42 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
c01f1a5a
DG
43 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
44 unsigned long, unsigned long, unsigned long);
bec43661
HV
45 int (*mmap) (struct file *, struct vm_area_struct *);
46 int (*open) (struct file *);
47 int (*release) (struct file *);
48};
49
401998fa
MCC
50/*
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 */
401998fa
MCC
55
56struct video_device
57{
58 /* device ops */
bec43661 59 const struct v4l2_file_operations *fops;
401998fa 60
54bd5b66 61 /* sysfs */
22a04f10 62 struct device dev; /* v4l device */
dc93a70c 63 struct cdev *cdev; /* character device */
9bea3514
HV
64
65 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
5e85e732 66 struct device *parent; /* device parent */
9bea3514 67 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
54bd5b66 68
401998fa 69 /* device info */
401998fa 70 char name[32];
0ea6bc8d 71 int vfl_type;
dc93a70c 72 /* 'minor' is set to -1 if the registration failed */
401998fa 73 int minor;
dd89601d 74 u16 num;
dc93a70c
HV
75 /* use bitops to set/clear/test flags */
76 unsigned long flags;
de1e575d 77 /* attribute to differentiate multiple indices on one physical device */
539a7555 78 int index;
401998fa 79
22a04f10 80 int debug; /* Activates debug level*/
401998fa
MCC
81
82 /* Video standard vars */
e75f9cee
MCC
83 v4l2_std_id tvnorms; /* Supported tv norms */
84 v4l2_std_id current_norm; /* Current tvnorm */
401998fa
MCC
85
86 /* callbacks */
dc93a70c 87 void (*release)(struct video_device *vdev);
401998fa
MCC
88
89 /* ioctl callbacks */
a399810c 90 const struct v4l2_ioctl_ops *ioctl_ops;
401998fa
MCC
91};
92
bfa8a273 93/* dev to video-device */
22a04f10 94#define to_video_device(cd) container_of(cd, struct video_device, dev)
e90ff923 95
dc93a70c 96/* Register video devices. Note that if video_register_device fails,
bfa8a273
HV
97 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
957b4aa9 99 you call video_device_release() on failure. */
dc93a70c 100int __must_check video_register_device(struct video_device *vdev, int type, int nr);
dc93a70c 101
6b5270d2
HV
102/* Same as video_register_device, but no warning is issued if the desired
103 device node number was already in use. */
104int __must_check video_register_device_no_warn(struct video_device *vdev, int type, int nr);
105
dc93a70c 106/* Unregister video devices. Will do nothing if vdev == NULL or
957b4aa9 107 video_is_registered() returns false. */
dc93a70c 108void video_unregister_device(struct video_device *vdev);
401998fa 109
bfa8a273
HV
110/* helper functions to alloc/release struct video_device, the
111 latter can also be used for video_device->release(). */
e138c592 112struct video_device * __must_check video_device_alloc(void);
bfa8a273 113
dc93a70c
HV
114/* this release function frees the vdev pointer */
115void video_device_release(struct video_device *vdev);
bfa8a273 116
f9e86b5e
HV
117/* 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. */
dc93a70c 120void video_device_release_empty(struct video_device *vdev);
401998fa 121
401998fa 122/* helper functions to access driver private data. */
dc93a70c 123static inline void *video_get_drvdata(struct video_device *vdev)
401998fa 124{
dc93a70c 125 return dev_get_drvdata(&vdev->dev);
401998fa
MCC
126}
127
dc93a70c 128static inline void video_set_drvdata(struct video_device *vdev, void *data)
401998fa 129{
dc93a70c 130 dev_set_drvdata(&vdev->dev, data);
401998fa 131}
38ee04f0 132
bfa8a273
HV
133struct 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}
401998fa 141
eac8ea53
LP
142static inline const char *video_device_node_name(struct video_device *vdev)
143{
144 return dev_name(&vdev->dev);
145}
146
957b4aa9 147static inline int video_is_registered(struct video_device *vdev)
dc93a70c 148{
957b4aa9 149 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
dc93a70c
HV
150}
151
401998fa 152#endif /* _V4L2_DEV_H */