3 * V 4 L 2 D R I V E R H E L P E R A P I
5 * Moved from videodev2.h
7 * Some commonly needed functions for drivers (v4l2-common.o module)
12 #include <linux/poll.h>
14 #include <linux/mutex.h>
15 #include <linux/compiler.h> /* need __user */
16 #include <linux/videodev2.h>
20 struct v4l2_ioctl_ops
{
23 /* VIDIOC_QUERYCAP handler */
24 int (*vidioc_querycap
)(struct file
*file
, void *fh
, struct v4l2_capability
*cap
);
26 /* VIDIOC_ENUM_FMT handlers */
27 int (*vidioc_enum_fmt_vid_cap
) (struct file
*file
, void *fh
,
28 struct v4l2_fmtdesc
*f
);
29 int (*vidioc_enum_fmt_vid_overlay
) (struct file
*file
, void *fh
,
30 struct v4l2_fmtdesc
*f
);
31 int (*vidioc_enum_fmt_vid_out
) (struct file
*file
, void *fh
,
32 struct v4l2_fmtdesc
*f
);
33 int (*vidioc_enum_fmt_vid_cap_mplane
)(struct file
*file
, void *fh
,
34 struct v4l2_fmtdesc
*f
);
35 int (*vidioc_enum_fmt_vid_out_mplane
)(struct file
*file
, void *fh
,
36 struct v4l2_fmtdesc
*f
);
37 int (*vidioc_enum_fmt_sdr_cap
) (struct file
*file
, void *fh
,
38 struct v4l2_fmtdesc
*f
);
39 int (*vidioc_enum_fmt_sdr_out
) (struct file
*file
, void *fh
,
40 struct v4l2_fmtdesc
*f
);
42 /* VIDIOC_G_FMT handlers */
43 int (*vidioc_g_fmt_vid_cap
) (struct file
*file
, void *fh
,
44 struct v4l2_format
*f
);
45 int (*vidioc_g_fmt_vid_overlay
)(struct file
*file
, void *fh
,
46 struct v4l2_format
*f
);
47 int (*vidioc_g_fmt_vid_out
) (struct file
*file
, void *fh
,
48 struct v4l2_format
*f
);
49 int (*vidioc_g_fmt_vid_out_overlay
)(struct file
*file
, void *fh
,
50 struct v4l2_format
*f
);
51 int (*vidioc_g_fmt_vbi_cap
) (struct file
*file
, void *fh
,
52 struct v4l2_format
*f
);
53 int (*vidioc_g_fmt_vbi_out
) (struct file
*file
, void *fh
,
54 struct v4l2_format
*f
);
55 int (*vidioc_g_fmt_sliced_vbi_cap
)(struct file
*file
, void *fh
,
56 struct v4l2_format
*f
);
57 int (*vidioc_g_fmt_sliced_vbi_out
)(struct file
*file
, void *fh
,
58 struct v4l2_format
*f
);
59 int (*vidioc_g_fmt_vid_cap_mplane
)(struct file
*file
, void *fh
,
60 struct v4l2_format
*f
);
61 int (*vidioc_g_fmt_vid_out_mplane
)(struct file
*file
, void *fh
,
62 struct v4l2_format
*f
);
63 int (*vidioc_g_fmt_sdr_cap
) (struct file
*file
, void *fh
,
64 struct v4l2_format
*f
);
65 int (*vidioc_g_fmt_sdr_out
) (struct file
*file
, void *fh
,
66 struct v4l2_format
*f
);
68 /* VIDIOC_S_FMT handlers */
69 int (*vidioc_s_fmt_vid_cap
) (struct file
*file
, void *fh
,
70 struct v4l2_format
*f
);
71 int (*vidioc_s_fmt_vid_overlay
)(struct file
*file
, void *fh
,
72 struct v4l2_format
*f
);
73 int (*vidioc_s_fmt_vid_out
) (struct file
*file
, void *fh
,
74 struct v4l2_format
*f
);
75 int (*vidioc_s_fmt_vid_out_overlay
)(struct file
*file
, void *fh
,
76 struct v4l2_format
*f
);
77 int (*vidioc_s_fmt_vbi_cap
) (struct file
*file
, void *fh
,
78 struct v4l2_format
*f
);
79 int (*vidioc_s_fmt_vbi_out
) (struct file
*file
, void *fh
,
80 struct v4l2_format
*f
);
81 int (*vidioc_s_fmt_sliced_vbi_cap
)(struct file
*file
, void *fh
,
82 struct v4l2_format
*f
);
83 int (*vidioc_s_fmt_sliced_vbi_out
)(struct file
*file
, void *fh
,
84 struct v4l2_format
*f
);
85 int (*vidioc_s_fmt_vid_cap_mplane
)(struct file
*file
, void *fh
,
86 struct v4l2_format
*f
);
87 int (*vidioc_s_fmt_vid_out_mplane
)(struct file
*file
, void *fh
,
88 struct v4l2_format
*f
);
89 int (*vidioc_s_fmt_sdr_cap
) (struct file
*file
, void *fh
,
90 struct v4l2_format
*f
);
91 int (*vidioc_s_fmt_sdr_out
) (struct file
*file
, void *fh
,
92 struct v4l2_format
*f
);
94 /* VIDIOC_TRY_FMT handlers */
95 int (*vidioc_try_fmt_vid_cap
) (struct file
*file
, void *fh
,
96 struct v4l2_format
*f
);
97 int (*vidioc_try_fmt_vid_overlay
)(struct file
*file
, void *fh
,
98 struct v4l2_format
*f
);
99 int (*vidioc_try_fmt_vid_out
) (struct file
*file
, void *fh
,
100 struct v4l2_format
*f
);
101 int (*vidioc_try_fmt_vid_out_overlay
)(struct file
*file
, void *fh
,
102 struct v4l2_format
*f
);
103 int (*vidioc_try_fmt_vbi_cap
) (struct file
*file
, void *fh
,
104 struct v4l2_format
*f
);
105 int (*vidioc_try_fmt_vbi_out
) (struct file
*file
, void *fh
,
106 struct v4l2_format
*f
);
107 int (*vidioc_try_fmt_sliced_vbi_cap
)(struct file
*file
, void *fh
,
108 struct v4l2_format
*f
);
109 int (*vidioc_try_fmt_sliced_vbi_out
)(struct file
*file
, void *fh
,
110 struct v4l2_format
*f
);
111 int (*vidioc_try_fmt_vid_cap_mplane
)(struct file
*file
, void *fh
,
112 struct v4l2_format
*f
);
113 int (*vidioc_try_fmt_vid_out_mplane
)(struct file
*file
, void *fh
,
114 struct v4l2_format
*f
);
115 int (*vidioc_try_fmt_sdr_cap
) (struct file
*file
, void *fh
,
116 struct v4l2_format
*f
);
117 int (*vidioc_try_fmt_sdr_out
) (struct file
*file
, void *fh
,
118 struct v4l2_format
*f
);
120 /* Buffer handlers */
121 int (*vidioc_reqbufs
) (struct file
*file
, void *fh
, struct v4l2_requestbuffers
*b
);
122 int (*vidioc_querybuf
)(struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
123 int (*vidioc_qbuf
) (struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
124 int (*vidioc_expbuf
) (struct file
*file
, void *fh
,
125 struct v4l2_exportbuffer
*e
);
126 int (*vidioc_dqbuf
) (struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
128 int (*vidioc_create_bufs
)(struct file
*file
, void *fh
, struct v4l2_create_buffers
*b
);
129 int (*vidioc_prepare_buf
)(struct file
*file
, void *fh
, struct v4l2_buffer
*b
);
131 int (*vidioc_overlay
) (struct file
*file
, void *fh
, unsigned int i
);
132 int (*vidioc_g_fbuf
) (struct file
*file
, void *fh
,
133 struct v4l2_framebuffer
*a
);
134 int (*vidioc_s_fbuf
) (struct file
*file
, void *fh
,
135 const struct v4l2_framebuffer
*a
);
138 int (*vidioc_streamon
) (struct file
*file
, void *fh
, enum v4l2_buf_type i
);
139 int (*vidioc_streamoff
)(struct file
*file
, void *fh
, enum v4l2_buf_type i
);
142 ENUMSTD is handled by videodev.c
144 int (*vidioc_g_std
) (struct file
*file
, void *fh
, v4l2_std_id
*norm
);
145 int (*vidioc_s_std
) (struct file
*file
, void *fh
, v4l2_std_id norm
);
146 int (*vidioc_querystd
) (struct file
*file
, void *fh
, v4l2_std_id
*a
);
149 int (*vidioc_enum_input
)(struct file
*file
, void *fh
,
150 struct v4l2_input
*inp
);
151 int (*vidioc_g_input
) (struct file
*file
, void *fh
, unsigned int *i
);
152 int (*vidioc_s_input
) (struct file
*file
, void *fh
, unsigned int i
);
154 /* Output handling */
155 int (*vidioc_enum_output
) (struct file
*file
, void *fh
,
156 struct v4l2_output
*a
);
157 int (*vidioc_g_output
) (struct file
*file
, void *fh
, unsigned int *i
);
158 int (*vidioc_s_output
) (struct file
*file
, void *fh
, unsigned int i
);
160 /* Control handling */
161 int (*vidioc_queryctrl
) (struct file
*file
, void *fh
,
162 struct v4l2_queryctrl
*a
);
163 int (*vidioc_query_ext_ctrl
) (struct file
*file
, void *fh
,
164 struct v4l2_query_ext_ctrl
*a
);
165 int (*vidioc_g_ctrl
) (struct file
*file
, void *fh
,
166 struct v4l2_control
*a
);
167 int (*vidioc_s_ctrl
) (struct file
*file
, void *fh
,
168 struct v4l2_control
*a
);
169 int (*vidioc_g_ext_ctrls
) (struct file
*file
, void *fh
,
170 struct v4l2_ext_controls
*a
);
171 int (*vidioc_s_ext_ctrls
) (struct file
*file
, void *fh
,
172 struct v4l2_ext_controls
*a
);
173 int (*vidioc_try_ext_ctrls
) (struct file
*file
, void *fh
,
174 struct v4l2_ext_controls
*a
);
175 int (*vidioc_querymenu
) (struct file
*file
, void *fh
,
176 struct v4l2_querymenu
*a
);
179 int (*vidioc_enumaudio
) (struct file
*file
, void *fh
,
180 struct v4l2_audio
*a
);
181 int (*vidioc_g_audio
) (struct file
*file
, void *fh
,
182 struct v4l2_audio
*a
);
183 int (*vidioc_s_audio
) (struct file
*file
, void *fh
,
184 const struct v4l2_audio
*a
);
186 /* Audio out ioctls */
187 int (*vidioc_enumaudout
) (struct file
*file
, void *fh
,
188 struct v4l2_audioout
*a
);
189 int (*vidioc_g_audout
) (struct file
*file
, void *fh
,
190 struct v4l2_audioout
*a
);
191 int (*vidioc_s_audout
) (struct file
*file
, void *fh
,
192 const struct v4l2_audioout
*a
);
193 int (*vidioc_g_modulator
) (struct file
*file
, void *fh
,
194 struct v4l2_modulator
*a
);
195 int (*vidioc_s_modulator
) (struct file
*file
, void *fh
,
196 const struct v4l2_modulator
*a
);
198 int (*vidioc_cropcap
) (struct file
*file
, void *fh
,
199 struct v4l2_cropcap
*a
);
200 int (*vidioc_g_crop
) (struct file
*file
, void *fh
,
201 struct v4l2_crop
*a
);
202 int (*vidioc_s_crop
) (struct file
*file
, void *fh
,
203 const struct v4l2_crop
*a
);
204 int (*vidioc_g_selection
) (struct file
*file
, void *fh
,
205 struct v4l2_selection
*s
);
206 int (*vidioc_s_selection
) (struct file
*file
, void *fh
,
207 struct v4l2_selection
*s
);
208 /* Compression ioctls */
209 int (*vidioc_g_jpegcomp
) (struct file
*file
, void *fh
,
210 struct v4l2_jpegcompression
*a
);
211 int (*vidioc_s_jpegcomp
) (struct file
*file
, void *fh
,
212 const struct v4l2_jpegcompression
*a
);
213 int (*vidioc_g_enc_index
) (struct file
*file
, void *fh
,
214 struct v4l2_enc_idx
*a
);
215 int (*vidioc_encoder_cmd
) (struct file
*file
, void *fh
,
216 struct v4l2_encoder_cmd
*a
);
217 int (*vidioc_try_encoder_cmd
) (struct file
*file
, void *fh
,
218 struct v4l2_encoder_cmd
*a
);
219 int (*vidioc_decoder_cmd
) (struct file
*file
, void *fh
,
220 struct v4l2_decoder_cmd
*a
);
221 int (*vidioc_try_decoder_cmd
) (struct file
*file
, void *fh
,
222 struct v4l2_decoder_cmd
*a
);
224 /* Stream type-dependent parameter ioctls */
225 int (*vidioc_g_parm
) (struct file
*file
, void *fh
,
226 struct v4l2_streamparm
*a
);
227 int (*vidioc_s_parm
) (struct file
*file
, void *fh
,
228 struct v4l2_streamparm
*a
);
231 int (*vidioc_g_tuner
) (struct file
*file
, void *fh
,
232 struct v4l2_tuner
*a
);
233 int (*vidioc_s_tuner
) (struct file
*file
, void *fh
,
234 const struct v4l2_tuner
*a
);
235 int (*vidioc_g_frequency
) (struct file
*file
, void *fh
,
236 struct v4l2_frequency
*a
);
237 int (*vidioc_s_frequency
) (struct file
*file
, void *fh
,
238 const struct v4l2_frequency
*a
);
239 int (*vidioc_enum_freq_bands
) (struct file
*file
, void *fh
,
240 struct v4l2_frequency_band
*band
);
243 int (*vidioc_g_sliced_vbi_cap
) (struct file
*file
, void *fh
,
244 struct v4l2_sliced_vbi_cap
*a
);
246 /* Log status ioctl */
247 int (*vidioc_log_status
) (struct file
*file
, void *fh
);
249 int (*vidioc_s_hw_freq_seek
) (struct file
*file
, void *fh
,
250 const struct v4l2_hw_freq_seek
*a
);
252 /* Debugging ioctls */
253 #ifdef CONFIG_VIDEO_ADV_DEBUG
254 int (*vidioc_g_register
) (struct file
*file
, void *fh
,
255 struct v4l2_dbg_register
*reg
);
256 int (*vidioc_s_register
) (struct file
*file
, void *fh
,
257 const struct v4l2_dbg_register
*reg
);
259 int (*vidioc_g_chip_info
) (struct file
*file
, void *fh
,
260 struct v4l2_dbg_chip_info
*chip
);
263 int (*vidioc_enum_framesizes
) (struct file
*file
, void *fh
,
264 struct v4l2_frmsizeenum
*fsize
);
266 int (*vidioc_enum_frameintervals
) (struct file
*file
, void *fh
,
267 struct v4l2_frmivalenum
*fival
);
269 /* DV Timings IOCTLs */
270 int (*vidioc_s_dv_timings
) (struct file
*file
, void *fh
,
271 struct v4l2_dv_timings
*timings
);
272 int (*vidioc_g_dv_timings
) (struct file
*file
, void *fh
,
273 struct v4l2_dv_timings
*timings
);
274 int (*vidioc_query_dv_timings
) (struct file
*file
, void *fh
,
275 struct v4l2_dv_timings
*timings
);
276 int (*vidioc_enum_dv_timings
) (struct file
*file
, void *fh
,
277 struct v4l2_enum_dv_timings
*timings
);
278 int (*vidioc_dv_timings_cap
) (struct file
*file
, void *fh
,
279 struct v4l2_dv_timings_cap
*cap
);
280 int (*vidioc_g_edid
) (struct file
*file
, void *fh
, struct v4l2_edid
*edid
);
281 int (*vidioc_s_edid
) (struct file
*file
, void *fh
, struct v4l2_edid
*edid
);
283 int (*vidioc_subscribe_event
) (struct v4l2_fh
*fh
,
284 const struct v4l2_event_subscription
*sub
);
285 int (*vidioc_unsubscribe_event
)(struct v4l2_fh
*fh
,
286 const struct v4l2_event_subscription
*sub
);
288 /* For other private ioctls */
289 long (*vidioc_default
) (struct file
*file
, void *fh
,
290 bool valid_prio
, unsigned int cmd
, void *arg
);
294 /* v4l debugging and diagnostics */
296 /* Device debug flags to be used with the video device debug attribute */
298 /* Just log the ioctl name + error code */
299 #define V4L2_DEV_DEBUG_IOCTL 0x01
300 /* Log the ioctl name arguments + error code */
301 #define V4L2_DEV_DEBUG_IOCTL_ARG 0x02
302 /* Log the file operations open, release, mmap and get_unmapped_area */
303 #define V4L2_DEV_DEBUG_FOP 0x04
304 /* Log the read and write file operations and the VIDIOC_(D)QBUF ioctls */
305 #define V4L2_DEV_DEBUG_STREAMING 0x08
307 #define V4L2_DEV_DEBUG_POLL 0x10
309 /* Video standard functions */
310 extern const char *v4l2_norm_to_name(v4l2_std_id id
);
311 extern void v4l2_video_std_frame_period(int id
, struct v4l2_fract
*frameperiod
);
312 extern int v4l2_video_std_construct(struct v4l2_standard
*vs
,
313 int id
, const char *name
);
314 /* Prints the ioctl in a human-readable format. If prefix != NULL,
315 then do printk(KERN_DEBUG "%s: ", prefix) first. */
316 extern void v4l_printk_ioctl(const char *prefix
, unsigned int cmd
);
318 /* Internal use only: get the mutex (if any) that we need to lock for the
321 extern struct mutex
*v4l2_ioctl_get_lock(struct video_device
*vdev
, unsigned cmd
);
323 /* names for fancy debug output */
324 extern const char *v4l2_field_names
[];
325 extern const char *v4l2_type_names
[];
328 /* 32 Bits compatibility layer for 64 bits processors */
329 extern long v4l2_compat_ioctl32(struct file
*file
, unsigned int cmd
,
333 typedef long (*v4l2_kioctl
)(struct file
*file
,
334 unsigned int cmd
, void *arg
);
336 /* Include support for obsoleted stuff */
337 extern long video_usercopy(struct file
*file
, unsigned int cmd
,
338 unsigned long arg
, v4l2_kioctl func
);
340 /* Standard handlers for V4L ioctl's */
341 extern long video_ioctl2(struct file
*file
,
342 unsigned int cmd
, unsigned long arg
);
344 #endif /* _V4L2_IOCTL_H */
