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/device.h> 15 #include <linux/mutex.h> 16 #include <linux/compiler.h> /* need __user */ 17 #ifdef CONFIG_VIDEO_V4L1_COMPAT 18 #include <linux/videodev.h> 19 #else 20 #include <linux/videodev2.h> 21 #endif 22 23 struct v4l2_ioctl_ops { 24 /* ioctl callbacks */ 25 26 /* VIDIOC_QUERYCAP handler */ 27 int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap); 28 29 /* Priority handling */ 30 int (*vidioc_g_priority) (struct file *file, void *fh, 31 enum v4l2_priority *p); 32 int (*vidioc_s_priority) (struct file *file, void *fh, 33 enum v4l2_priority p); 34 35 /* VIDIOC_ENUM_FMT handlers */ 36 int (*vidioc_enum_fmt_vid_cap) (struct file *file, void *fh, 37 struct v4l2_fmtdesc *f); 38 int (*vidioc_enum_fmt_vid_overlay) (struct file *file, void *fh, 39 struct v4l2_fmtdesc *f); 40 int (*vidioc_enum_fmt_vid_out) (struct file *file, void *fh, 41 struct v4l2_fmtdesc *f); 42 #if 1 43 /* deprecated, will be removed in 2.6.28 */ 44 int (*vidioc_enum_fmt_vbi_cap) (struct file *file, void *fh, 45 struct v4l2_fmtdesc *f); 46 #endif 47 int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh, 48 struct v4l2_fmtdesc *f); 49 50 /* VIDIOC_G_FMT handlers */ 51 int (*vidioc_g_fmt_vid_cap) (struct file *file, void *fh, 52 struct v4l2_format *f); 53 int (*vidioc_g_fmt_vid_overlay)(struct file *file, void *fh, 54 struct v4l2_format *f); 55 int (*vidioc_g_fmt_vid_out) (struct file *file, void *fh, 56 struct v4l2_format *f); 57 int (*vidioc_g_fmt_vid_out_overlay)(struct file *file, void *fh, 58 struct v4l2_format *f); 59 int (*vidioc_g_fmt_vbi_cap) (struct file *file, void *fh, 60 struct v4l2_format *f); 61 int (*vidioc_g_fmt_vbi_out) (struct file *file, void *fh, 62 struct v4l2_format *f); 63 int (*vidioc_g_fmt_sliced_vbi_cap)(struct file *file, void *fh, 64 struct v4l2_format *f); 65 int (*vidioc_g_fmt_sliced_vbi_out)(struct file *file, void *fh, 66 struct v4l2_format *f); 67 int (*vidioc_g_fmt_type_private)(struct file *file, void *fh, 68 struct v4l2_format *f); 69 70 /* VIDIOC_S_FMT handlers */ 71 int (*vidioc_s_fmt_vid_cap) (struct file *file, void *fh, 72 struct v4l2_format *f); 73 int (*vidioc_s_fmt_vid_overlay)(struct file *file, void *fh, 74 struct v4l2_format *f); 75 int (*vidioc_s_fmt_vid_out) (struct file *file, void *fh, 76 struct v4l2_format *f); 77 int (*vidioc_s_fmt_vid_out_overlay)(struct file *file, void *fh, 78 struct v4l2_format *f); 79 int (*vidioc_s_fmt_vbi_cap) (struct file *file, void *fh, 80 struct v4l2_format *f); 81 int (*vidioc_s_fmt_vbi_out) (struct file *file, void *fh, 82 struct v4l2_format *f); 83 int (*vidioc_s_fmt_sliced_vbi_cap)(struct file *file, void *fh, 84 struct v4l2_format *f); 85 int (*vidioc_s_fmt_sliced_vbi_out)(struct file *file, void *fh, 86 struct v4l2_format *f); 87 int (*vidioc_s_fmt_type_private)(struct file *file, void *fh, 88 struct v4l2_format *f); 89 90 /* VIDIOC_TRY_FMT handlers */ 91 int (*vidioc_try_fmt_vid_cap) (struct file *file, void *fh, 92 struct v4l2_format *f); 93 int (*vidioc_try_fmt_vid_overlay)(struct file *file, void *fh, 94 struct v4l2_format *f); 95 int (*vidioc_try_fmt_vid_out) (struct file *file, void *fh, 96 struct v4l2_format *f); 97 int (*vidioc_try_fmt_vid_out_overlay)(struct file *file, void *fh, 98 struct v4l2_format *f); 99 int (*vidioc_try_fmt_vbi_cap) (struct file *file, void *fh, 100 struct v4l2_format *f); 101 int (*vidioc_try_fmt_vbi_out) (struct file *file, void *fh, 102 struct v4l2_format *f); 103 int (*vidioc_try_fmt_sliced_vbi_cap)(struct file *file, void *fh, 104 struct v4l2_format *f); 105 int (*vidioc_try_fmt_sliced_vbi_out)(struct file *file, void *fh, 106 struct v4l2_format *f); 107 int (*vidioc_try_fmt_type_private)(struct file *file, void *fh, 108 struct v4l2_format *f); 109 110 /* Buffer handlers */ 111 int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b); 112 int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b); 113 int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 114 int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b); 115 116 117 int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i); 118 #ifdef CONFIG_VIDEO_V4L1_COMPAT 119 /* buffer type is struct vidio_mbuf * */ 120 int (*vidiocgmbuf) (struct file *file, void *fh, struct video_mbuf *p); 121 #endif 122 int (*vidioc_g_fbuf) (struct file *file, void *fh, 123 struct v4l2_framebuffer *a); 124 int (*vidioc_s_fbuf) (struct file *file, void *fh, 125 struct v4l2_framebuffer *a); 126 127 /* Stream on/off */ 128 int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i); 129 int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i); 130 131 /* Standard handling 132 ENUMSTD is handled by videodev.c 133 */ 134 int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm); 135 int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm); 136 int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a); 137 138 /* Input handling */ 139 int (*vidioc_enum_input)(struct file *file, void *fh, 140 struct v4l2_input *inp); 141 int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i); 142 int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i); 143 144 /* Output handling */ 145 int (*vidioc_enum_output) (struct file *file, void *fh, 146 struct v4l2_output *a); 147 int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i); 148 int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i); 149 150 /* Control handling */ 151 int (*vidioc_queryctrl) (struct file *file, void *fh, 152 struct v4l2_queryctrl *a); 153 int (*vidioc_g_ctrl) (struct file *file, void *fh, 154 struct v4l2_control *a); 155 int (*vidioc_s_ctrl) (struct file *file, void *fh, 156 struct v4l2_control *a); 157 int (*vidioc_g_ext_ctrls) (struct file *file, void *fh, 158 struct v4l2_ext_controls *a); 159 int (*vidioc_s_ext_ctrls) (struct file *file, void *fh, 160 struct v4l2_ext_controls *a); 161 int (*vidioc_try_ext_ctrls) (struct file *file, void *fh, 162 struct v4l2_ext_controls *a); 163 int (*vidioc_querymenu) (struct file *file, void *fh, 164 struct v4l2_querymenu *a); 165 166 /* Audio ioctls */ 167 int (*vidioc_enumaudio) (struct file *file, void *fh, 168 struct v4l2_audio *a); 169 int (*vidioc_g_audio) (struct file *file, void *fh, 170 struct v4l2_audio *a); 171 int (*vidioc_s_audio) (struct file *file, void *fh, 172 struct v4l2_audio *a); 173 174 /* Audio out ioctls */ 175 int (*vidioc_enumaudout) (struct file *file, void *fh, 176 struct v4l2_audioout *a); 177 int (*vidioc_g_audout) (struct file *file, void *fh, 178 struct v4l2_audioout *a); 179 int (*vidioc_s_audout) (struct file *file, void *fh, 180 struct v4l2_audioout *a); 181 int (*vidioc_g_modulator) (struct file *file, void *fh, 182 struct v4l2_modulator *a); 183 int (*vidioc_s_modulator) (struct file *file, void *fh, 184 struct v4l2_modulator *a); 185 /* Crop ioctls */ 186 int (*vidioc_cropcap) (struct file *file, void *fh, 187 struct v4l2_cropcap *a); 188 int (*vidioc_g_crop) (struct file *file, void *fh, 189 struct v4l2_crop *a); 190 int (*vidioc_s_crop) (struct file *file, void *fh, 191 struct v4l2_crop *a); 192 /* Compression ioctls */ 193 int (*vidioc_g_jpegcomp) (struct file *file, void *fh, 194 struct v4l2_jpegcompression *a); 195 int (*vidioc_s_jpegcomp) (struct file *file, void *fh, 196 struct v4l2_jpegcompression *a); 197 int (*vidioc_g_enc_index) (struct file *file, void *fh, 198 struct v4l2_enc_idx *a); 199 int (*vidioc_encoder_cmd) (struct file *file, void *fh, 200 struct v4l2_encoder_cmd *a); 201 int (*vidioc_try_encoder_cmd) (struct file *file, void *fh, 202 struct v4l2_encoder_cmd *a); 203 204 /* Stream type-dependent parameter ioctls */ 205 int (*vidioc_g_parm) (struct file *file, void *fh, 206 struct v4l2_streamparm *a); 207 int (*vidioc_s_parm) (struct file *file, void *fh, 208 struct v4l2_streamparm *a); 209 210 /* Tuner ioctls */ 211 int (*vidioc_g_tuner) (struct file *file, void *fh, 212 struct v4l2_tuner *a); 213 int (*vidioc_s_tuner) (struct file *file, void *fh, 214 struct v4l2_tuner *a); 215 int (*vidioc_g_frequency) (struct file *file, void *fh, 216 struct v4l2_frequency *a); 217 int (*vidioc_s_frequency) (struct file *file, void *fh, 218 struct v4l2_frequency *a); 219 220 /* Sliced VBI cap */ 221 int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh, 222 struct v4l2_sliced_vbi_cap *a); 223 224 /* Log status ioctl */ 225 int (*vidioc_log_status) (struct file *file, void *fh); 226 227 int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh, 228 struct v4l2_hw_freq_seek *a); 229 230 /* Debugging ioctls */ 231 #ifdef CONFIG_VIDEO_ADV_DEBUG 232 int (*vidioc_g_register) (struct file *file, void *fh, 233 struct v4l2_register *reg); 234 int (*vidioc_s_register) (struct file *file, void *fh, 235 struct v4l2_register *reg); 236 #endif 237 int (*vidioc_g_chip_ident) (struct file *file, void *fh, 238 struct v4l2_chip_ident *chip); 239 240 /* For other private ioctls */ 241 int (*vidioc_default) (struct file *file, void *fh, 242 int cmd, void *arg); 243 }; 244 245 246 /* v4l debugging and diagnostics */ 247 248 /* Debug bitmask flags to be used on V4L2 */ 249 #define V4L2_DEBUG_IOCTL 0x01 250 #define V4L2_DEBUG_IOCTL_ARG 0x02 251 252 /* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */ 253 #define v4l_print_ioctl(name, cmd) \ 254 do { \ 255 printk(KERN_DEBUG "%s: ", name); \ 256 v4l_printk_ioctl(cmd); \ 257 } while (0) 258 259 /* Use this macro in I2C drivers where 'client' is the struct i2c_client 260 pointer */ 261 #define v4l_i2c_print_ioctl(client, cmd) \ 262 do { \ 263 v4l_client_printk(KERN_DEBUG, client, ""); \ 264 v4l_printk_ioctl(cmd); \ 265 } while (0) 266 267 /* Video standard functions */ 268 extern const char *v4l2_norm_to_name(v4l2_std_id id); 269 extern int v4l2_video_std_construct(struct v4l2_standard *vs, 270 int id, const char *name); 271 /* Prints the ioctl in a human-readable format */ 272 extern void v4l_printk_ioctl(unsigned int cmd); 273 274 /* names for fancy debug output */ 275 extern const char *v4l2_field_names[]; 276 extern const char *v4l2_type_names[]; 277 278 /* Compatibility layer interface -- v4l1-compat module */ 279 typedef int (*v4l2_kioctl)(struct inode *inode, struct file *file, 280 unsigned int cmd, void *arg); 281 #ifdef CONFIG_VIDEO_V4L1_COMPAT 282 int v4l_compat_translate_ioctl(struct inode *inode, struct file *file, 283 int cmd, void *arg, v4l2_kioctl driver_ioctl); 284 #else 285 #define v4l_compat_translate_ioctl(inode, file, cmd, arg, ioctl) (-EINVAL) 286 #endif 287 288 /* 32 Bits compatibility layer for 64 bits processors */ 289 extern long v4l_compat_ioctl32(struct file *file, unsigned int cmd, 290 unsigned long arg); 291 292 extern int video_ioctl2(struct inode *inode, struct file *file, 293 unsigned int cmd, unsigned long arg); 294 295 /* Include support for obsoleted stuff */ 296 extern int video_usercopy(struct inode *inode, struct file *file, 297 unsigned int cmd, unsigned long arg, 298 int (*func)(struct inode *inode, struct file *file, 299 unsigned int cmd, void *arg)); 300 301 #endif /* _V4L2_IOCTL_H */ 302