aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-22 15:22:41 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-23 07:04:21 -0400
commitc91661f1e69bec066c970f3a911de5713ec4a91e (patch)
treec928b36b2e314a0340981d41f0f2e11b9c317ae8
parent7a23c2574d0c7cf3d2ddbf967e3fc32531037a16 (diff)
[media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops
This struct is mentioned at the kAPI docbook. So, let's document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat
-rw-r--r--Documentation/media/kapi/v4l2-common.rst2
-rw-r--r--include/media/v4l2-ioctl.h266
2 files changed, 268 insertions, 0 deletions
diff --git a/Documentation/media/kapi/v4l2-common.rst b/Documentation/media/kapi/v4l2-common.rst
index d1ea1c9e35a0..525d804871ff 100644
--- a/Documentation/media/kapi/v4l2-common.rst
+++ b/Documentation/media/kapi/v4l2-common.rst
@@ -2,3 +2,5 @@ V4L2 common functions and data structures
2^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 2^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3 3
4.. kernel-doc:: include/media/v4l2-common.h 4.. kernel-doc:: include/media/v4l2-common.h
5
6.. kernel-doc:: include/media/v4l2-ioctl.h
diff --git a/include/media/v4l2-ioctl.h b/include/media/v4l2-ioctl.h
index 017ffb2220c7..8b1d19bc9b0e 100644
--- a/include/media/v4l2-ioctl.h
+++ b/include/media/v4l2-ioctl.h
@@ -17,6 +17,272 @@
17 17
18struct v4l2_fh; 18struct v4l2_fh;
19 19
20/**
21 * struct v4l2_ioctl_ops - describe operations for each V4L2 ioctl
22 *
23 * @vidioc_querycap: pointer to the function that implements
24 * :ref:`VIDIOC_QUERYCAP <vidioc_querycap>` ioctl
25 * @vidioc_enum_fmt_vid_cap: pointer to the function that implements
26 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
27 * for video capture in single plane mode
28 * @vidioc_enum_fmt_vid_overlay: pointer to the function that implements
29 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
30 * for video overlay
31 * @vidioc_enum_fmt_vid_out: pointer to the function that implements
32 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
33 * for video output in single plane mode
34 * @vidioc_enum_fmt_vid_cap_mplane: pointer to the function that implements
35 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
36 * for video capture in multiplane mode
37 * @vidioc_enum_fmt_vid_out_mplane: pointer to the function that implements
38 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
39 * for video output in multiplane mode
40 * @vidioc_enum_fmt_sdr_cap: pointer to the function that implements
41 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
42 * for Software Defined Radio capture
43 * @vidioc_enum_fmt_sdr_out: pointer to the function that implements
44 * :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
45 * for Software Defined Radio output
46 * @vidioc_g_fmt_vid_cap: pointer to the function that implements
47 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video capture
48 * in single plane mode
49 * @vidioc_g_fmt_vid_overlay: pointer to the function that implements
50 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video overlay
51 * @vidioc_g_fmt_vid_out: pointer to the function that implements
52 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video out
53 * in single plane mode
54 * @vidioc_g_fmt_vid_out_overlay: pointer to the function that implements
55 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video overlay output
56 * @vidioc_g_fmt_vbi_cap: pointer to the function that implements
57 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for raw VBI capture
58 * @vidioc_g_fmt_vbi_out: pointer to the function that implements
59 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for raw VBI output
60 * @vidioc_g_fmt_sliced_vbi_cap: pointer to the function that implements
61 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI capture
62 * @vidioc_g_fmt_sliced_vbi_out: pointer to the function that implements
63 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI output
64 * @vidioc_g_fmt_vid_cap_mplane: pointer to the function that implements
65 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video capture
66 * in multiple plane mode
67 * @vidioc_g_fmt_vid_out_mplane: pointer to the function that implements
68 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video out
69 * in multiplane plane mode
70 * @vidioc_g_fmt_sdr_cap: pointer to the function that implements
71 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
72 * Radio capture
73 * @vidioc_g_fmt_sdr_out: pointer to the function that implements
74 * :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
75 * Radio output
76 * @vidioc_s_fmt_vid_cap: pointer to the function that implements
77 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video capture
78 * in single plane mode
79 * @vidioc_s_fmt_vid_overlay: pointer to the function that implements
80 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video overlay
81 * @vidioc_s_fmt_vid_out: pointer to the function that implements
82 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video out
83 * in single plane mode
84 * @vidioc_s_fmt_vid_out_overlay: pointer to the function that implements
85 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video overlay output
86 * @vidioc_s_fmt_vbi_cap: pointer to the function that implements
87 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for raw VBI capture
88 * @vidioc_s_fmt_vbi_out: pointer to the function that implements
89 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for raw VBI output
90 * @vidioc_s_fmt_sliced_vbi_cap: pointer to the function that implements
91 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI capture
92 * @vidioc_s_fmt_sliced_vbi_out: pointer to the function that implements
93 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI output
94 * @vidioc_s_fmt_vid_cap_mplane: pointer to the function that implements
95 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video capture
96 * in multiple plane mode
97 * @vidioc_s_fmt_vid_out_mplane: pointer to the function that implements
98 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video out
99 * in multiplane plane mode
100 * @vidioc_s_fmt_sdr_cap: pointer to the function that implements
101 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
102 * Radio capture
103 * @vidioc_s_fmt_sdr_out: pointer to the function that implements
104 * :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
105 * Radio output
106 * @vidioc_try_fmt_vid_cap: pointer to the function that implements
107 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video capture
108 * in single plane mode
109 * @vidioc_try_fmt_vid_overlay: pointer to the function that implements
110 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video overlay
111 * @vidioc_try_fmt_vid_out: pointer to the function that implements
112 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video out
113 * in single plane mode
114 * @vidioc_try_fmt_vid_out_overlay: pointer to the function that implements
115 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video overlay
116 * output
117 * @vidioc_try_fmt_vbi_cap: pointer to the function that implements
118 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for raw VBI capture
119 * @vidioc_try_fmt_vbi_out: pointer to the function that implements
120 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for raw VBI output
121 * @vidioc_try_fmt_sliced_vbi_cap: pointer to the function that implements
122 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI
123 * capture
124 * @vidioc_try_fmt_sliced_vbi_out: pointer to the function that implements
125 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for sliced VBI output
126 * @vidioc_try_fmt_vid_cap_mplane: pointer to the function that implements
127 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video capture
128 * in multiple plane mode
129 * @vidioc_try_fmt_vid_out_mplane: pointer to the function that implements
130 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video out
131 * in multiplane plane mode
132 * @vidioc_try_fmt_sdr_cap: pointer to the function that implements
133 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
134 * Radio capture
135 * @vidioc_try_fmt_sdr_out: pointer to the function that implements
136 * :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
137 * Radio output
138 * @vidioc_reqbufs: pointer to the function that implements
139 * :ref:`VIDIOC_REQBUFS <vidioc_reqbufs>` ioctl
140 * @vidioc_querybuf: pointer to the function that implements
141 * :ref:`VIDIOC_QUERYBUF <vidioc_querybuf>` ioctl
142 * @vidioc_qbuf: pointer to the function that implements
143 * :ref:`VIDIOC_QBUF <vidioc_qbuf>` ioctl
144 * @vidioc_expbuf: pointer to the function that implements
145 * :ref:`VIDIOC_EXPBUF <vidioc_expbuf>` ioctl
146 * @vidioc_dqbuf: pointer to the function that implements
147 * :ref:`VIDIOC_DQBUF <vidioc_qbuf>` ioctl
148 * @vidioc_create_bufs: pointer to the function that implements
149 * :ref:`VIDIOC_CREATE_BUFS <vidioc_create_bufs>` ioctl
150 * @vidioc_prepare_buf: pointer to the function that implements
151 * :ref:`VIDIOC_PREPARE_BUF <vidioc_prepare_buf>` ioctl
152 * @vidioc_overlay: pointer to the function that implements
153 * :ref:`VIDIOC_OVERLAY <vidioc_overlay>` ioctl
154 * @vidioc_g_fbuf: pointer to the function that implements
155 * :ref:`VIDIOC_G_FBUF <vidioc_g_fbuf>` ioctl
156 * @vidioc_s_fbuf: pointer to the function that implements
157 * :ref:`VIDIOC_S_FBUF <vidioc_g_fbuf>` ioctl
158 * @vidioc_streamon: pointer to the function that implements
159 * :ref:`VIDIOC_STREAMON <vidioc_streamon>` ioctl
160 * @vidioc_streamoff: pointer to the function that implements
161 * :ref:`VIDIOC_STREAMOFF <vidioc_streamon>` ioctl
162 * @vidioc_g_std: pointer to the function that implements
163 * :ref:`VIDIOC_G_STD <vidioc_g_std>` ioctl
164 * @vidioc_s_std: pointer to the function that implements
165 * :ref:`VIDIOC_S_STD <vidioc_g_std>` ioctl
166 * @vidioc_querystd: pointer to the function that implements
167 * :ref:`VIDIOC_QUERYSTD <vidioc_querystd>` ioctl
168 * @vidioc_enum_input: pointer to the function that implements
169 * :ref:`VIDIOC_ENUM_INPUT <vidioc_g_input>` ioctl
170 * @vidioc_g_input: pointer to the function that implements
171 * :ref:`VIDIOC_G_INPUT <vidioc_g_input>` ioctl
172 * @vidioc_s_input: pointer to the function that implements
173 * :ref:`VIDIOC_S_INPUT <vidioc_g_input>` ioctl
174 * @vidioc_enum_output: pointer to the function that implements
175 * :ref:`VIDIOC_ENUM_OUTPUT <vidioc_g_output>` ioctl
176 * @vidioc_g_output: pointer to the function that implements
177 * :ref:`VIDIOC_G_OUTPUT <vidioc_g_output>` ioctl
178 * @vidioc_s_output: pointer to the function that implements
179 * :ref:`VIDIOC_S_OUTPUT <vidioc_g_output>` ioctl
180 * @vidioc_queryctrl: pointer to the function that implements
181 * :ref:`VIDIOC_QUERYCTRL <vidioc_queryctrl>` ioctl
182 * @vidioc_query_ext_ctrl: pointer to the function that implements
183 * :ref:`VIDIOC_QUERY_EXT_CTRL <vidioc_queryctrl>` ioctl
184 * @vidioc_g_ctrl: pointer to the function that implements
185 * :ref:`VIDIOC_G_CTRL <vidioc_g_ctrl>` ioctl
186 * @vidioc_s_ctrl: pointer to the function that implements
187 * :ref:`VIDIOC_S_CTRL <vidioc_g_ctrl>` ioctl
188 * @vidioc_g_ext_ctrls: pointer to the function that implements
189 * :ref:`VIDIOC_G_EXT_CTRLS <vidioc_g_ext_ctrls>` ioctl
190 * @vidioc_s_ext_ctrls: pointer to the function that implements
191 * :ref:`VIDIOC_S_EXT_CTRLS <vidioc_g_ext_ctrls>` ioctl
192 * @vidioc_try_ext_ctrls: pointer to the function that implements
193 * :ref:`VIDIOC_TRY_EXT_CTRLS <vidioc_g_ext_ctrls>` ioctl
194 * @vidioc_querymenu: pointer to the function that implements
195 * :ref:`VIDIOC_QUERYMENU <vidioc_queryctrl>` ioctl
196 * @vidioc_enumaudio: pointer to the function that implements
197 * :ref:`VIDIOC_ENUMAUDIO <vidioc_enumaudio>` ioctl
198 * @vidioc_g_audio: pointer to the function that implements
199 * :ref:`VIDIOC_G_AUDIO <vidioc_g_audio>` ioctl
200 * @vidioc_s_audio: pointer to the function that implements
201 * :ref:`VIDIOC_S_AUDIO <vidioc_g_audio>` ioctl
202 * @vidioc_enumaudout: pointer to the function that implements
203 * :ref:`VIDIOC_ENUMAUDOUT <vidioc_enumaudout>` ioctl
204 * @vidioc_g_audout: pointer to the function that implements
205 * :ref:`VIDIOC_G_AUDOUT <vidioc_g_audout>` ioctl
206 * @vidioc_s_audout: pointer to the function that implements
207 * :ref:`VIDIOC_S_AUDOUT <vidioc_g_audout>` ioctl
208 * @vidioc_g_modulator: pointer to the function that implements
209 * :ref:`VIDIOC_G_MODULATOR <vidioc_g_modulator>` ioctl
210 * @vidioc_s_modulator: pointer to the function that implements
211 * :ref:`VIDIOC_S_MODULATOR <vidioc_g_modulator>` ioctl
212 * @vidioc_cropcap: pointer to the function that implements
213 * :ref:`VIDIOC_CROPCAP <vidioc_cropcap>` ioctl
214 * @vidioc_g_crop: pointer to the function that implements
215 * :ref:`VIDIOC_G_CROP <vidioc_g_crop>` ioctl
216 * @vidioc_s_crop: pointer to the function that implements
217 * :ref:`VIDIOC_S_CROP <vidioc_g_crop>` ioctl
218 * @vidioc_g_selection: pointer to the function that implements
219 * :ref:`VIDIOC_G_SELECTION <vidioc_g_selection>` ioctl
220 * @vidioc_s_selection: pointer to the function that implements
221 * :ref:`VIDIOC_S_SELECTION <vidioc_g_selection>` ioctl
222 * @vidioc_g_jpegcomp: pointer to the function that implements
223 * :ref:`VIDIOC_G_JPEGCOMP <vidioc_g_jpegcomp>` ioctl
224 * @vidioc_s_jpegcomp: pointer to the function that implements
225 * :ref:`VIDIOC_S_JPEGCOMP <vidioc_g_jpegcomp>` ioctl
226 * @vidioc_g_enc_index: pointer to the function that implements
227 * :ref:`VIDIOC_G_ENC_INDEX <vidioc_g_enc_index>` ioctl
228 * @vidioc_encoder_cmd: pointer to the function that implements
229 * :ref:`VIDIOC_ENCODER_CMD <vidioc_encoder_cmd>` ioctl
230 * @vidioc_try_encoder_cmd: pointer to the function that implements
231 * :ref:`VIDIOC_TRY_ENCODER_CMD <vidioc_encoder_cmd>` ioctl
232 * @vidioc_decoder_cmd: pointer to the function that implements
233 * :ref:`VIDIOC_DECODER_CMD <vidioc_decoder_cmd>` ioctl
234 * @vidioc_try_decoder_cmd: pointer to the function that implements
235 * :ref:`VIDIOC_TRY_DECODER_CMD <vidioc_decoder_cmd>` ioctl
236 * @vidioc_g_parm: pointer to the function that implements
237 * :ref:`VIDIOC_G_PARM <vidioc_g_parm>` ioctl
238 * @vidioc_s_parm: pointer to the function that implements
239 * :ref:`VIDIOC_S_PARM <vidioc_g_parm>` ioctl
240 * @vidioc_g_tuner: pointer to the function that implements
241 * :ref:`VIDIOC_G_TUNER <vidioc_g_tuner>` ioctl
242 * @vidioc_s_tuner: pointer to the function that implements
243 * :ref:`VIDIOC_S_TUNER <vidioc_g_tuner>` ioctl
244 * @vidioc_g_frequency: pointer to the function that implements
245 * :ref:`VIDIOC_G_FREQUENCY <vidioc_g_frequency>` ioctl
246 * @vidioc_s_frequency: pointer to the function that implements
247 * :ref:`VIDIOC_S_FREQUENCY <vidioc_g_frequency>` ioctl
248 * @vidioc_enum_freq_bands: pointer to the function that implements
249 * :ref:`VIDIOC_ENUM_FREQ_BANDS <vidioc_enum_freq_bands>` ioctl
250 * @vidioc_g_sliced_vbi_cap: pointer to the function that implements
251 * :ref:`VIDIOC_G_SLICED_VBI_CAP <vidioc_g_sliced_vbi_cap>` ioctl
252 * @vidioc_log_status: pointer to the function that implements
253 * :ref:`VIDIOC_LOG_STATUS <vidioc_log_status>` ioctl
254 * @vidioc_s_hw_freq_seek: pointer to the function that implements
255 * :ref:`VIDIOC_S_HW_FREQ_SEEK <vidioc_s_hw_freq_seek>` ioctl
256 * @vidioc_g_register: pointer to the function that implements
257 * :ref:`VIDIOC_DBG_G_REGISTER <vidioc_dbg_g_register>` ioctl
258 * @vidioc_s_register: pointer to the function that implements
259 * :ref:`VIDIOC_DBG_S_REGISTER <vidioc_dbg_g_register>` ioctl
260 * @vidioc_g_chip_info: pointer to the function that implements
261 * :ref:`VIDIOC_DBG_G_CHIP_INFO <vidioc_dbg_g_chip_info>` ioctl
262 * @vidioc_enum_framesizes: pointer to the function that implements
263 * :ref:`VIDIOC_ENUM_FRAMESIZES <vidioc_enum_framesizes>` ioctl
264 * @vidioc_enum_frameintervals: pointer to the function that implements
265 * :ref:`VIDIOC_ENUM_FRAMEINTERVALS <vidioc_enum_frameintervals>` ioctl
266 * @vidioc_s_dv_timings: pointer to the function that implements
267 * :ref:`VIDIOC_S_DV_TIMINGS <vidioc_g_dv_timings>` ioctl
268 * @vidioc_g_dv_timings: pointer to the function that implements
269 * :ref:`VIDIOC_G_DV_TIMINGS <vidioc_g_dv_timings>` ioctl
270 * @vidioc_query_dv_timings: pointer to the function that implements
271 * :ref:`VIDIOC_QUERY_DV_TIMINGS <vidioc_query_dv_timings>` ioctl
272 * @vidioc_enum_dv_timings: pointer to the function that implements
273 * :ref:`VIDIOC_ENUM_DV_TIMINGS <vidioc_enum_dv_timings>` ioctl
274 * @vidioc_dv_timings_cap: pointer to the function that implements
275 * :ref:`VIDIOC_DV_TIMINGS_CAP <vidioc_dv_timings_cap>` ioctl
276 * @vidioc_g_edid: pointer to the function that implements
277 * :ref:`VIDIOC_G_EDID <vidioc_g_edid>` ioctl
278 * @vidioc_s_edid: pointer to the function that implements
279 * :ref:`VIDIOC_S_EDID <vidioc_g_edid>` ioctl
280 * @vidioc_subscribe_event: pointer to the function that implements
281 * :ref:`VIDIOC_SUBSCRIBE_EVENT <vidioc_subscribe_event>` ioctl
282 * @vidioc_unsubscribe_event: pointer to the function that implements
283 * :ref:`VIDIOC_UNSUBSCRIBE_EVENT <vidioc_unsubscribe_event>` ioctl
284 * @vidioc_default: pointed used to allow other ioctls
285 */
20struct v4l2_ioctl_ops { 286struct v4l2_ioctl_ops {
21 /* ioctl callbacks */ 287 /* ioctl callbacks */
22 288
generated by cgit v1.2.2 (git 2.25.0) at 2025-08-26 10:23:53 -0400