]>
Commit | Line | Data |
---|---|---|
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 | 27 | struct v4l2_ioctl_callbacks; |
bec43661 | 28 | struct video_device; |
9bea3514 | 29 | struct v4l2_device; |
0996517c | 30 | struct v4l2_ctrl_handler; |
a399810c | 31 | |
957b4aa9 LP |
32 | /* 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) | |
1babcb46 | 36 | #define V4L2_FL_USES_V4L2_FH (1) |
dc93a70c | 37 | |
bec43661 HV |
38 | struct 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 *); | |
069b7479 | 43 | long (*ioctl) (struct file *, unsigned int, unsigned long); |
bec43661 | 44 | long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); |
c01f1a5a DG |
45 | unsigned long (*get_unmapped_area) (struct file *, unsigned long, |
46 | unsigned long, unsigned long, unsigned long); | |
bec43661 HV |
47 | int (*mmap) (struct file *, struct vm_area_struct *); |
48 | int (*open) (struct file *); | |
49 | int (*release) (struct file *); | |
50 | }; | |
51 | ||
401998fa MCC |
52 | /* |
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 | */ | |
401998fa MCC |
57 | |
58 | struct video_device | |
59 | { | |
60 | /* device ops */ | |
bec43661 | 61 | const struct v4l2_file_operations *fops; |
401998fa | 62 | |
54bd5b66 | 63 | /* sysfs */ |
22a04f10 | 64 | struct device dev; /* v4l device */ |
dc93a70c | 65 | struct cdev *cdev; /* character device */ |
9bea3514 HV |
66 | |
67 | /* Set either parent or v4l2_dev if your driver uses v4l2_device */ | |
5e85e732 | 68 | struct device *parent; /* device parent */ |
9bea3514 | 69 | struct v4l2_device *v4l2_dev; /* v4l2_device parent */ |
54bd5b66 | 70 | |
0996517c HV |
71 | /* Control handler associated with this device node. May be NULL. */ |
72 | struct v4l2_ctrl_handler *ctrl_handler; | |
73 | ||
401998fa | 74 | /* device info */ |
401998fa | 75 | char name[32]; |
0ea6bc8d | 76 | int vfl_type; |
dc93a70c | 77 | /* 'minor' is set to -1 if the registration failed */ |
401998fa | 78 | int minor; |
dd89601d | 79 | u16 num; |
dc93a70c HV |
80 | /* use bitops to set/clear/test flags */ |
81 | unsigned long flags; | |
de1e575d | 82 | /* attribute to differentiate multiple indices on one physical device */ |
539a7555 | 83 | int index; |
401998fa | 84 | |
1babcb46 SA |
85 | /* 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 | ||
22a04f10 | 89 | int debug; /* Activates debug level*/ |
401998fa MCC |
90 | |
91 | /* Video standard vars */ | |
e75f9cee MCC |
92 | v4l2_std_id tvnorms; /* Supported tv norms */ |
93 | v4l2_std_id current_norm; /* Current tvnorm */ | |
401998fa MCC |
94 | |
95 | /* callbacks */ | |
dc93a70c | 96 | void (*release)(struct video_device *vdev); |
401998fa MCC |
97 | |
98 | /* ioctl callbacks */ | |
a399810c | 99 | const struct v4l2_ioctl_ops *ioctl_ops; |
401998fa MCC |
100 | }; |
101 | ||
bfa8a273 | 102 | /* dev to video-device */ |
22a04f10 | 103 | #define to_video_device(cd) container_of(cd, struct video_device, dev) |
e90ff923 | 104 | |
dc93a70c | 105 | /* Register video devices. Note that if video_register_device fails, |
bfa8a273 HV |
106 | 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 | |
957b4aa9 | 108 | you call video_device_release() on failure. */ |
dc93a70c | 109 | int __must_check video_register_device(struct video_device *vdev, int type, int nr); |
dc93a70c | 110 | |
6b5270d2 HV |
111 | /* Same as video_register_device, but no warning is issued if the desired |
112 | device node number was already in use. */ | |
113 | int __must_check video_register_device_no_warn(struct video_device *vdev, int type, int nr); | |
114 | ||
dc93a70c | 115 | /* Unregister video devices. Will do nothing if vdev == NULL or |
957b4aa9 | 116 | video_is_registered() returns false. */ |
dc93a70c | 117 | void video_unregister_device(struct video_device *vdev); |
401998fa | 118 | |
bfa8a273 HV |
119 | /* helper functions to alloc/release struct video_device, the |
120 | latter can also be used for video_device->release(). */ | |
e138c592 | 121 | struct video_device * __must_check video_device_alloc(void); |
bfa8a273 | 122 | |
dc93a70c HV |
123 | /* this release function frees the vdev pointer */ |
124 | void video_device_release(struct video_device *vdev); | |
bfa8a273 | 125 | |
f9e86b5e HV |
126 | /* 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. */ | |
dc93a70c | 129 | void video_device_release_empty(struct video_device *vdev); |
401998fa | 130 | |
401998fa | 131 | /* helper functions to access driver private data. */ |
dc93a70c | 132 | static inline void *video_get_drvdata(struct video_device *vdev) |
401998fa | 133 | { |
dc93a70c | 134 | return dev_get_drvdata(&vdev->dev); |
401998fa MCC |
135 | } |
136 | ||
dc93a70c | 137 | static inline void video_set_drvdata(struct video_device *vdev, void *data) |
401998fa | 138 | { |
dc93a70c | 139 | dev_set_drvdata(&vdev->dev, data); |
401998fa | 140 | } |
38ee04f0 | 141 | |
bfa8a273 HV |
142 | struct video_device *video_devdata(struct file *file); |
143 | ||
144 | /* Combine video_get_drvdata and video_devdata as this is | |
145 | used very often. */ | |
146 | static inline void *video_drvdata(struct file *file) | |
147 | { | |
148 | return video_get_drvdata(video_devdata(file)); | |
149 | } | |
401998fa | 150 | |
eac8ea53 LP |
151 | static inline const char *video_device_node_name(struct video_device *vdev) |
152 | { | |
153 | return dev_name(&vdev->dev); | |
154 | } | |
155 | ||
957b4aa9 | 156 | static inline int video_is_registered(struct video_device *vdev) |
dc93a70c | 157 | { |
957b4aa9 | 158 | return test_bit(V4L2_FL_REGISTERED, &vdev->flags); |
dc93a70c HV |
159 | } |
160 | ||
401998fa | 161 | #endif /* _V4L2_DEV_H */ |