[media] Two small string fixes in v4l2-ctrls.c
[GitHub/mt8127/android_kernel_alcatel_ttab.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
2c0ab67b
LP
19#include <media/media-entity.h>
20
401998fa 21#define VIDEO_MAJOR 81
bfa8a273 22
401998fa
MCC
23#define VFL_TYPE_GRABBER 0
24#define VFL_TYPE_VBI 1
25#define VFL_TYPE_RADIO 2
2096a5dc
LP
26#define VFL_TYPE_SUBDEV 3
27#define VFL_TYPE_MAX 4
401998fa 28
a399810c 29struct v4l2_ioctl_callbacks;
bec43661 30struct video_device;
9bea3514 31struct v4l2_device;
0996517c 32struct v4l2_ctrl_handler;
a399810c 33
957b4aa9
LP
34/* Flag to mark the video_device struct as registered.
35 Drivers can clear this flag if they want to block all future
36 device access. It is cleared by video_unregister_device. */
37#define V4L2_FL_REGISTERED (0)
b1a873a3 38/* file->private_data points to struct v4l2_fh */
1babcb46 39#define V4L2_FL_USES_V4L2_FH (1)
b1a873a3
HV
40/* Use the prio field of v4l2_fh for core priority checking */
41#define V4L2_FL_USE_FH_PRIO (2)
dc93a70c 42
02265493
HV
43/* Priority helper functions */
44
45struct v4l2_prio_state {
46 atomic_t prios[4];
47};
48
49void v4l2_prio_init(struct v4l2_prio_state *global);
50int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
51 enum v4l2_priority new);
52void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local);
53void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local);
54enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global);
55int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local);
56
57
bec43661
HV
58struct v4l2_file_operations {
59 struct module *owner;
60 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
61 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
62 unsigned int (*poll) (struct file *, struct poll_table_struct *);
069b7479 63 long (*ioctl) (struct file *, unsigned int, unsigned long);
bec43661 64 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
ecc6517d
BL
65 unsigned long (*get_unmapped_area) (struct file *, unsigned long,
66 unsigned long, unsigned long, unsigned long);
bec43661
HV
67 int (*mmap) (struct file *, struct vm_area_struct *);
68 int (*open) (struct file *);
69 int (*release) (struct file *);
70};
71
401998fa
MCC
72/*
73 * Newer version of video_device, handled by videodev2.c
74 * This version moves redundant code from video device code to
75 * the common handler
76 */
401998fa
MCC
77
78struct video_device
79{
2c0ab67b
LP
80#if defined(CONFIG_MEDIA_CONTROLLER)
81 struct media_entity entity;
82#endif
401998fa 83 /* device ops */
bec43661 84 const struct v4l2_file_operations *fops;
401998fa 85
54bd5b66 86 /* sysfs */
22a04f10 87 struct device dev; /* v4l device */
dc93a70c 88 struct cdev *cdev; /* character device */
9bea3514
HV
89
90 /* Set either parent or v4l2_dev if your driver uses v4l2_device */
5e85e732 91 struct device *parent; /* device parent */
9bea3514 92 struct v4l2_device *v4l2_dev; /* v4l2_device parent */
54bd5b66 93
0996517c
HV
94 /* Control handler associated with this device node. May be NULL. */
95 struct v4l2_ctrl_handler *ctrl_handler;
96
0f62fd6a
HV
97 /* Priority state. If NULL, then v4l2_dev->prio will be used. */
98 struct v4l2_prio_state *prio;
99
401998fa 100 /* device info */
401998fa 101 char name[32];
0ea6bc8d 102 int vfl_type;
dc93a70c 103 /* 'minor' is set to -1 if the registration failed */
401998fa 104 int minor;
dd89601d 105 u16 num;
dc93a70c
HV
106 /* use bitops to set/clear/test flags */
107 unsigned long flags;
de1e575d 108 /* attribute to differentiate multiple indices on one physical device */
539a7555 109 int index;
401998fa 110
1babcb46
SA
111 /* V4L2 file handles */
112 spinlock_t fh_lock; /* Lock for all v4l2_fhs */
113 struct list_head fh_list; /* List of struct v4l2_fh */
114
22a04f10 115 int debug; /* Activates debug level*/
401998fa
MCC
116
117 /* Video standard vars */
e75f9cee
MCC
118 v4l2_std_id tvnorms; /* Supported tv norms */
119 v4l2_std_id current_norm; /* Current tvnorm */
401998fa
MCC
120
121 /* callbacks */
dc93a70c 122 void (*release)(struct video_device *vdev);
401998fa
MCC
123
124 /* ioctl callbacks */
a399810c 125 const struct v4l2_ioctl_ops *ioctl_ops;
ee6869af
HV
126
127 /* serialization lock */
128 struct mutex *lock;
401998fa
MCC
129};
130
6e3ea0e7
LP
131#define media_entity_to_video_device(__e) \
132 container_of(__e, struct video_device, entity)
bfa8a273 133/* dev to video-device */
22a04f10 134#define to_video_device(cd) container_of(cd, struct video_device, dev)
e90ff923 135
2096a5dc
LP
136int __must_check __video_register_device(struct video_device *vdev, int type,
137 int nr, int warn_if_nr_in_use, struct module *owner);
138
dc93a70c 139/* Register video devices. Note that if video_register_device fails,
bfa8a273
HV
140 the release() callback of the video_device structure is *not* called, so
141 the caller is responsible for freeing any data. Usually that means that
957b4aa9 142 you call video_device_release() on failure. */
2096a5dc
LP
143static inline int __must_check video_register_device(struct video_device *vdev,
144 int type, int nr)
145{
146 return __video_register_device(vdev, type, nr, 1, vdev->fops->owner);
147}
dc93a70c 148
6b5270d2
HV
149/* Same as video_register_device, but no warning is issued if the desired
150 device node number was already in use. */
2096a5dc
LP
151static inline int __must_check video_register_device_no_warn(
152 struct video_device *vdev, int type, int nr)
153{
154 return __video_register_device(vdev, type, nr, 0, vdev->fops->owner);
155}
6b5270d2 156
dc93a70c 157/* Unregister video devices. Will do nothing if vdev == NULL or
957b4aa9 158 video_is_registered() returns false. */
dc93a70c 159void video_unregister_device(struct video_device *vdev);
401998fa 160
bfa8a273
HV
161/* helper functions to alloc/release struct video_device, the
162 latter can also be used for video_device->release(). */
e138c592 163struct video_device * __must_check video_device_alloc(void);
bfa8a273 164
dc93a70c
HV
165/* this release function frees the vdev pointer */
166void video_device_release(struct video_device *vdev);
bfa8a273 167
f9e86b5e
HV
168/* this release function does nothing, use when the video_device is a
169 static global struct. Note that having a static video_device is
170 a dubious construction at best. */
dc93a70c 171void video_device_release_empty(struct video_device *vdev);
401998fa 172
401998fa 173/* helper functions to access driver private data. */
dc93a70c 174static inline void *video_get_drvdata(struct video_device *vdev)
401998fa 175{
dc93a70c 176 return dev_get_drvdata(&vdev->dev);
401998fa
MCC
177}
178
dc93a70c 179static inline void video_set_drvdata(struct video_device *vdev, void *data)
401998fa 180{
dc93a70c 181 dev_set_drvdata(&vdev->dev, data);
401998fa 182}
38ee04f0 183
bfa8a273
HV
184struct video_device *video_devdata(struct file *file);
185
186/* Combine video_get_drvdata and video_devdata as this is
187 used very often. */
188static inline void *video_drvdata(struct file *file)
189{
190 return video_get_drvdata(video_devdata(file));
191}
401998fa 192
eac8ea53
LP
193static inline const char *video_device_node_name(struct video_device *vdev)
194{
195 return dev_name(&vdev->dev);
196}
197
957b4aa9 198static inline int video_is_registered(struct video_device *vdev)
dc93a70c 199{
957b4aa9 200 return test_bit(V4L2_FL_REGISTERED, &vdev->flags);
dc93a70c
HV
201}
202
401998fa 203#endif /* _V4L2_DEV_H */