v4l2-ioctl.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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/device.h>
  14. #include <linux/mutex.h>
  15. #include <linux/compiler.h> /* need __user */
  16. #include <linux/videodev2.h>
  17. struct v4l2_fh;
  18. struct v4l2_ioctl_ops {
  19. /* ioctl callbacks */
  20. /* VIDIOC_QUERYCAP handler */
  21. int (*vidioc_querycap)(struct file *file, void *fh, struct v4l2_capability *cap);
  22. /* Priority handling */
  23. int (*vidioc_g_priority) (struct file *file, void *fh,
  24. enum v4l2_priority *p);
  25. int (*vidioc_s_priority) (struct file *file, void *fh,
  26. enum v4l2_priority p);
  27. /* VIDIOC_ENUM_FMT handlers */
  28. int (*vidioc_enum_fmt_vid_cap) (struct file *file, void *fh,
  29. struct v4l2_fmtdesc *f);
  30. int (*vidioc_enum_fmt_vid_overlay) (struct file *file, void *fh,
  31. struct v4l2_fmtdesc *f);
  32. int (*vidioc_enum_fmt_vid_out) (struct file *file, void *fh,
  33. struct v4l2_fmtdesc *f);
  34. int (*vidioc_enum_fmt_vid_cap_mplane)(struct file *file, void *fh,
  35. struct v4l2_fmtdesc *f);
  36. int (*vidioc_enum_fmt_vid_out_mplane)(struct file *file, void *fh,
  37. struct v4l2_fmtdesc *f);
  38. int (*vidioc_enum_fmt_type_private)(struct file *file, void *fh,
  39. struct v4l2_fmtdesc *f);
  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_type_private)(struct file *file, void *fh,
  62. struct v4l2_format *f);
  63. /* VIDIOC_S_FMT handlers */
  64. int (*vidioc_s_fmt_vid_cap) (struct file *file, void *fh,
  65. struct v4l2_format *f);
  66. int (*vidioc_s_fmt_vid_overlay)(struct file *file, void *fh,
  67. struct v4l2_format *f);
  68. int (*vidioc_s_fmt_vid_out) (struct file *file, void *fh,
  69. struct v4l2_format *f);
  70. int (*vidioc_s_fmt_vid_out_overlay)(struct file *file, void *fh,
  71. struct v4l2_format *f);
  72. int (*vidioc_s_fmt_vbi_cap) (struct file *file, void *fh,
  73. struct v4l2_format *f);
  74. int (*vidioc_s_fmt_vbi_out) (struct file *file, void *fh,
  75. struct v4l2_format *f);
  76. int (*vidioc_s_fmt_sliced_vbi_cap)(struct file *file, void *fh,
  77. struct v4l2_format *f);
  78. int (*vidioc_s_fmt_sliced_vbi_out)(struct file *file, void *fh,
  79. struct v4l2_format *f);
  80. int (*vidioc_s_fmt_vid_cap_mplane)(struct file *file, void *fh,
  81. struct v4l2_format *f);
  82. int (*vidioc_s_fmt_vid_out_mplane)(struct file *file, void *fh,
  83. struct v4l2_format *f);
  84. int (*vidioc_s_fmt_type_private)(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_type_private)(struct file *file, void *fh,
  108. struct v4l2_format *f);
  109. /* Buffer handlers */
  110. int (*vidioc_reqbufs) (struct file *file, void *fh, struct v4l2_requestbuffers *b);
  111. int (*vidioc_querybuf)(struct file *file, void *fh, struct v4l2_buffer *b);
  112. int (*vidioc_qbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
  113. int (*vidioc_dqbuf) (struct file *file, void *fh, struct v4l2_buffer *b);
  114. int (*vidioc_overlay) (struct file *file, void *fh, unsigned int i);
  115. int (*vidioc_g_fbuf) (struct file *file, void *fh,
  116. struct v4l2_framebuffer *a);
  117. int (*vidioc_s_fbuf) (struct file *file, void *fh,
  118. struct v4l2_framebuffer *a);
  119. /* Stream on/off */
  120. int (*vidioc_streamon) (struct file *file, void *fh, enum v4l2_buf_type i);
  121. int (*vidioc_streamoff)(struct file *file, void *fh, enum v4l2_buf_type i);
  122. /* Standard handling
  123. ENUMSTD is handled by videodev.c
  124. */
  125. int (*vidioc_g_std) (struct file *file, void *fh, v4l2_std_id *norm);
  126. int (*vidioc_s_std) (struct file *file, void *fh, v4l2_std_id *norm);
  127. int (*vidioc_querystd) (struct file *file, void *fh, v4l2_std_id *a);
  128. /* Input handling */
  129. int (*vidioc_enum_input)(struct file *file, void *fh,
  130. struct v4l2_input *inp);
  131. int (*vidioc_g_input) (struct file *file, void *fh, unsigned int *i);
  132. int (*vidioc_s_input) (struct file *file, void *fh, unsigned int i);
  133. /* Output handling */
  134. int (*vidioc_enum_output) (struct file *file, void *fh,
  135. struct v4l2_output *a);
  136. int (*vidioc_g_output) (struct file *file, void *fh, unsigned int *i);
  137. int (*vidioc_s_output) (struct file *file, void *fh, unsigned int i);
  138. /* Control handling */
  139. int (*vidioc_queryctrl) (struct file *file, void *fh,
  140. struct v4l2_queryctrl *a);
  141. int (*vidioc_g_ctrl) (struct file *file, void *fh,
  142. struct v4l2_control *a);
  143. int (*vidioc_s_ctrl) (struct file *file, void *fh,
  144. struct v4l2_control *a);
  145. int (*vidioc_g_ext_ctrls) (struct file *file, void *fh,
  146. struct v4l2_ext_controls *a);
  147. int (*vidioc_s_ext_ctrls) (struct file *file, void *fh,
  148. struct v4l2_ext_controls *a);
  149. int (*vidioc_try_ext_ctrls) (struct file *file, void *fh,
  150. struct v4l2_ext_controls *a);
  151. int (*vidioc_querymenu) (struct file *file, void *fh,
  152. struct v4l2_querymenu *a);
  153. /* Audio ioctls */
  154. int (*vidioc_enumaudio) (struct file *file, void *fh,
  155. struct v4l2_audio *a);
  156. int (*vidioc_g_audio) (struct file *file, void *fh,
  157. struct v4l2_audio *a);
  158. int (*vidioc_s_audio) (struct file *file, void *fh,
  159. struct v4l2_audio *a);
  160. /* Audio out ioctls */
  161. int (*vidioc_enumaudout) (struct file *file, void *fh,
  162. struct v4l2_audioout *a);
  163. int (*vidioc_g_audout) (struct file *file, void *fh,
  164. struct v4l2_audioout *a);
  165. int (*vidioc_s_audout) (struct file *file, void *fh,
  166. struct v4l2_audioout *a);
  167. int (*vidioc_g_modulator) (struct file *file, void *fh,
  168. struct v4l2_modulator *a);
  169. int (*vidioc_s_modulator) (struct file *file, void *fh,
  170. struct v4l2_modulator *a);
  171. /* Crop ioctls */
  172. int (*vidioc_cropcap) (struct file *file, void *fh,
  173. struct v4l2_cropcap *a);
  174. int (*vidioc_g_crop) (struct file *file, void *fh,
  175. struct v4l2_crop *a);
  176. int (*vidioc_s_crop) (struct file *file, void *fh,
  177. struct v4l2_crop *a);
  178. /* Compression ioctls */
  179. int (*vidioc_g_jpegcomp) (struct file *file, void *fh,
  180. struct v4l2_jpegcompression *a);
  181. int (*vidioc_s_jpegcomp) (struct file *file, void *fh,
  182. struct v4l2_jpegcompression *a);
  183. int (*vidioc_g_enc_index) (struct file *file, void *fh,
  184. struct v4l2_enc_idx *a);
  185. int (*vidioc_encoder_cmd) (struct file *file, void *fh,
  186. struct v4l2_encoder_cmd *a);
  187. int (*vidioc_try_encoder_cmd) (struct file *file, void *fh,
  188. struct v4l2_encoder_cmd *a);
  189. /* Stream type-dependent parameter ioctls */
  190. int (*vidioc_g_parm) (struct file *file, void *fh,
  191. struct v4l2_streamparm *a);
  192. int (*vidioc_s_parm) (struct file *file, void *fh,
  193. struct v4l2_streamparm *a);
  194. /* Tuner ioctls */
  195. int (*vidioc_g_tuner) (struct file *file, void *fh,
  196. struct v4l2_tuner *a);
  197. int (*vidioc_s_tuner) (struct file *file, void *fh,
  198. struct v4l2_tuner *a);
  199. int (*vidioc_g_frequency) (struct file *file, void *fh,
  200. struct v4l2_frequency *a);
  201. int (*vidioc_s_frequency) (struct file *file, void *fh,
  202. struct v4l2_frequency *a);
  203. /* Sliced VBI cap */
  204. int (*vidioc_g_sliced_vbi_cap) (struct file *file, void *fh,
  205. struct v4l2_sliced_vbi_cap *a);
  206. /* Log status ioctl */
  207. int (*vidioc_log_status) (struct file *file, void *fh);
  208. int (*vidioc_s_hw_freq_seek) (struct file *file, void *fh,
  209. struct v4l2_hw_freq_seek *a);
  210. /* Debugging ioctls */
  211. #ifdef CONFIG_VIDEO_ADV_DEBUG
  212. int (*vidioc_g_register) (struct file *file, void *fh,
  213. struct v4l2_dbg_register *reg);
  214. int (*vidioc_s_register) (struct file *file, void *fh,
  215. struct v4l2_dbg_register *reg);
  216. #endif
  217. int (*vidioc_g_chip_ident) (struct file *file, void *fh,
  218. struct v4l2_dbg_chip_ident *chip);
  219. int (*vidioc_enum_framesizes) (struct file *file, void *fh,
  220. struct v4l2_frmsizeenum *fsize);
  221. int (*vidioc_enum_frameintervals) (struct file *file, void *fh,
  222. struct v4l2_frmivalenum *fival);
  223. /* DV Timings IOCTLs */
  224. int (*vidioc_enum_dv_presets) (struct file *file, void *fh,
  225. struct v4l2_dv_enum_preset *preset);
  226. int (*vidioc_s_dv_preset) (struct file *file, void *fh,
  227. struct v4l2_dv_preset *preset);
  228. int (*vidioc_g_dv_preset) (struct file *file, void *fh,
  229. struct v4l2_dv_preset *preset);
  230. int (*vidioc_query_dv_preset) (struct file *file, void *fh,
  231. struct v4l2_dv_preset *qpreset);
  232. int (*vidioc_s_dv_timings) (struct file *file, void *fh,
  233. struct v4l2_dv_timings *timings);
  234. int (*vidioc_g_dv_timings) (struct file *file, void *fh,
  235. struct v4l2_dv_timings *timings);
  236. int (*vidioc_subscribe_event) (struct v4l2_fh *fh,
  237. struct v4l2_event_subscription *sub);
  238. int (*vidioc_unsubscribe_event)(struct v4l2_fh *fh,
  239. struct v4l2_event_subscription *sub);
  240. /* For other private ioctls */
  241. long (*vidioc_default) (struct file *file, void *fh,
  242. bool valid_prio, int cmd, void *arg);
  243. };
  244. /* v4l debugging and diagnostics */
  245. /* Debug bitmask flags to be used on V4L2 */
  246. #define V4L2_DEBUG_IOCTL 0x01
  247. #define V4L2_DEBUG_IOCTL_ARG 0x02
  248. /* Use this macro for non-I2C drivers. Pass the driver name as the first arg. */
  249. #define v4l_print_ioctl(name, cmd) \
  250. do { \
  251. printk(KERN_DEBUG "%s: ", name); \
  252. v4l_printk_ioctl(cmd); \
  253. } while (0)
  254. /* Use this macro in I2C drivers where 'client' is the struct i2c_client
  255. pointer */
  256. #define v4l_i2c_print_ioctl(client, cmd) \
  257. do { \
  258. v4l_client_printk(KERN_DEBUG, client, ""); \
  259. v4l_printk_ioctl(cmd); \
  260. } while (0)
  261. /* Video standard functions */
  262. extern const char *v4l2_norm_to_name(v4l2_std_id id);
  263. extern void v4l2_video_std_frame_period(int id, struct v4l2_fract *frameperiod);
  264. extern int v4l2_video_std_construct(struct v4l2_standard *vs,
  265. int id, const char *name);
  266. /* Prints the ioctl in a human-readable format */
  267. extern void v4l_printk_ioctl(unsigned int cmd);
  268. /* names for fancy debug output */
  269. extern const char *v4l2_field_names[];
  270. extern const char *v4l2_type_names[];
  271. #ifdef CONFIG_COMPAT
  272. /* 32 Bits compatibility layer for 64 bits processors */
  273. extern long v4l2_compat_ioctl32(struct file *file, unsigned int cmd,
  274. unsigned long arg);
  275. #endif
  276. typedef long (*v4l2_kioctl)(struct file *file,
  277. unsigned int cmd, void *arg);
  278. /* Include support for obsoleted stuff */
  279. extern long video_usercopy(struct file *file, unsigned int cmd,
  280. unsigned long arg, v4l2_kioctl func);
  281. /* Standard handlers for V4L ioctl's */
  282. extern long video_ioctl2(struct file *file,
  283. unsigned int cmd, unsigned long arg);
  284. #endif /* _V4L2_IOCTL_H */