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