v4l2-ioctl.h 14 KB

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