1 /*
2 V4L2 controls framework implementation.
3
4 Copyright (C) 2010 Hans Verkuil <hverkuil@xs4all.nl>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21 #include <linux/ctype.h>
22 #include <linux/slab.h>
23 #include <linux/export.h>
24 #include <media/v4l2-ioctl.h>
25 #include <media/v4l2-device.h>
26 #include <media/v4l2-ctrls.h>
27 #include <media/v4l2-event.h>
28 #include <media/v4l2-dev.h>
29
30 #define has_op(master, op) \
31 (master->ops && master->ops->op)
32 #define call_op(master, op) \
33 (has_op(master, op) ? master->ops->op(master) : 0)
34
35 /* Internal temporary helper struct, one for each v4l2_ext_control */
36 struct v4l2_ctrl_helper {
37 /* Pointer to the control reference of the master control */
38 struct v4l2_ctrl_ref *mref;
39 /* The control corresponding to the v4l2_ext_control ID field. */
40 struct v4l2_ctrl *ctrl;
41 /* v4l2_ext_control index of the next control belonging to the
42 same cluster, or 0 if there isn't any. */
43 u32 next;
44 };
45
46 /* Small helper function to determine if the autocluster is set to manual
47 mode. */
is_cur_manual(const struct v4l2_ctrl * master)48 static bool is_cur_manual(const struct v4l2_ctrl *master)
49 {
50 return master->is_auto && master->cur.val == master->manual_mode_value;
51 }
52
53 /* Same as above, but this checks the against the new value instead of the
54 current value. */
is_new_manual(const struct v4l2_ctrl * master)55 static bool is_new_manual(const struct v4l2_ctrl *master)
56 {
57 return master->is_auto && master->val == master->manual_mode_value;
58 }
59
60 /* Returns NULL or a character pointer array containing the menu for
61 the given control ID. The pointer array ends with a NULL pointer.
62 An empty string signifies a menu entry that is invalid. This allows
63 drivers to disable certain options if it is not supported. */
v4l2_ctrl_get_menu(u32 id)64 const char * const *v4l2_ctrl_get_menu(u32 id)
65 {
66 static const char * const mpeg_audio_sampling_freq[] = {
67 "44.1 kHz",
68 "48 kHz",
69 "32 kHz",
70 NULL
71 };
72 static const char * const mpeg_audio_encoding[] = {
73 "MPEG-1/2 Layer I",
74 "MPEG-1/2 Layer II",
75 "MPEG-1/2 Layer III",
76 "MPEG-2/4 AAC",
77 "AC-3",
78 NULL
79 };
80 static const char * const mpeg_audio_l1_bitrate[] = {
81 "32 kbps",
82 "64 kbps",
83 "96 kbps",
84 "128 kbps",
85 "160 kbps",
86 "192 kbps",
87 "224 kbps",
88 "256 kbps",
89 "288 kbps",
90 "320 kbps",
91 "352 kbps",
92 "384 kbps",
93 "416 kbps",
94 "448 kbps",
95 NULL
96 };
97 static const char * const mpeg_audio_l2_bitrate[] = {
98 "32 kbps",
99 "48 kbps",
100 "56 kbps",
101 "64 kbps",
102 "80 kbps",
103 "96 kbps",
104 "112 kbps",
105 "128 kbps",
106 "160 kbps",
107 "192 kbps",
108 "224 kbps",
109 "256 kbps",
110 "320 kbps",
111 "384 kbps",
112 NULL
113 };
114 static const char * const mpeg_audio_l3_bitrate[] = {
115 "32 kbps",
116 "40 kbps",
117 "48 kbps",
118 "56 kbps",
119 "64 kbps",
120 "80 kbps",
121 "96 kbps",
122 "112 kbps",
123 "128 kbps",
124 "160 kbps",
125 "192 kbps",
126 "224 kbps",
127 "256 kbps",
128 "320 kbps",
129 NULL
130 };
131 static const char * const mpeg_audio_ac3_bitrate[] = {
132 "32 kbps",
133 "40 kbps",
134 "48 kbps",
135 "56 kbps",
136 "64 kbps",
137 "80 kbps",
138 "96 kbps",
139 "112 kbps",
140 "128 kbps",
141 "160 kbps",
142 "192 kbps",
143 "224 kbps",
144 "256 kbps",
145 "320 kbps",
146 "384 kbps",
147 "448 kbps",
148 "512 kbps",
149 "576 kbps",
150 "640 kbps",
151 NULL
152 };
153 static const char * const mpeg_audio_mode[] = {
154 "Stereo",
155 "Joint Stereo",
156 "Dual",
157 "Mono",
158 NULL
159 };
160 static const char * const mpeg_audio_mode_extension[] = {
161 "Bound 4",
162 "Bound 8",
163 "Bound 12",
164 "Bound 16",
165 NULL
166 };
167 static const char * const mpeg_audio_emphasis[] = {
168 "No Emphasis",
169 "50/15 us",
170 "CCITT J17",
171 NULL
172 };
173 static const char * const mpeg_audio_crc[] = {
174 "No CRC",
175 "16-bit CRC",
176 NULL
177 };
178 static const char * const mpeg_audio_dec_playback[] = {
179 "Auto",
180 "Stereo",
181 "Left",
182 "Right",
183 "Mono",
184 "Swapped Stereo",
185 NULL
186 };
187 static const char * const mpeg_video_encoding[] = {
188 "MPEG-1",
189 "MPEG-2",
190 "MPEG-4 AVC",
191 NULL
192 };
193 static const char * const mpeg_video_aspect[] = {
194 "1x1",
195 "4x3",
196 "16x9",
197 "2.21x1",
198 NULL
199 };
200 static const char * const mpeg_video_bitrate_mode[] = {
201 "Variable Bitrate",
202 "Constant Bitrate",
203 NULL
204 };
205 static const char * const mpeg_stream_type[] = {
206 "MPEG-2 Program Stream",
207 "MPEG-2 Transport Stream",
208 "MPEG-1 System Stream",
209 "MPEG-2 DVD-compatible Stream",
210 "MPEG-1 VCD-compatible Stream",
211 "MPEG-2 SVCD-compatible Stream",
212 NULL
213 };
214 static const char * const mpeg_stream_vbi_fmt[] = {
215 "No VBI",
216 "Private Packet, IVTV Format",
217 NULL
218 };
219 static const char * const camera_power_line_frequency[] = {
220 "Disabled",
221 "50 Hz",
222 "60 Hz",
223 "Auto",
224 NULL
225 };
226 static const char * const camera_exposure_auto[] = {
227 "Auto Mode",
228 "Manual Mode",
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
231 NULL
232 };
233 static const char * const colorfx[] = {
234 "None",
235 "Black & White",
236 "Sepia",
237 "Negative",
238 "Emboss",
239 "Sketch",
240 "Sky Blue",
241 "Grass Green",
242 "Skin Whiten",
243 "Vivid",
244 NULL
245 };
246 static const char * const tune_preemphasis[] = {
247 "No Preemphasis",
248 "50 Microseconds",
249 "75 Microseconds",
250 NULL,
251 };
252 static const char * const header_mode[] = {
253 "Separate Buffer",
254 "Joined With 1st Frame",
255 NULL,
256 };
257 static const char * const multi_slice[] = {
258 "Single",
259 "Max Macroblocks",
260 "Max Bytes",
261 NULL,
262 };
263 static const char * const entropy_mode[] = {
264 "CAVLC",
265 "CABAC",
266 NULL,
267 };
268 static const char * const mpeg_h264_level[] = {
269 "1",
270 "1b",
271 "1.1",
272 "1.2",
273 "1.3",
274 "2",
275 "2.1",
276 "2.2",
277 "3",
278 "3.1",
279 "3.2",
280 "4",
281 "4.1",
282 "4.2",
283 "5",
284 "5.1",
285 NULL,
286 };
287 static const char * const h264_loop_filter[] = {
288 "Enabled",
289 "Disabled",
290 "Disabled at Slice Boundary",
291 NULL,
292 };
293 static const char * const h264_profile[] = {
294 "Baseline",
295 "Constrained Baseline",
296 "Main",
297 "Extended",
298 "High",
299 "High 10",
300 "High 422",
301 "High 444 Predictive",
302 "High 10 Intra",
303 "High 422 Intra",
304 "High 444 Intra",
305 "CAVLC 444 Intra",
306 "Scalable Baseline",
307 "Scalable High",
308 "Scalable High Intra",
309 "Multiview High",
310 NULL,
311 };
312 static const char * const vui_sar_idc[] = {
313 "Unspecified",
314 "1:1",
315 "12:11",
316 "10:11",
317 "16:11",
318 "40:33",
319 "24:11",
320 "20:11",
321 "32:11",
322 "80:33",
323 "18:11",
324 "15:11",
325 "64:33",
326 "160:99",
327 "4:3",
328 "3:2",
329 "2:1",
330 "Extended SAR",
331 NULL,
332 };
333 static const char * const mpeg_mpeg4_level[] = {
334 "0",
335 "0b",
336 "1",
337 "2",
338 "3",
339 "3b",
340 "4",
341 "5",
342 NULL,
343 };
344 static const char * const mpeg4_profile[] = {
345 "Simple",
346 "Advanced Simple",
347 "Core",
348 "Simple Scalable",
349 "Advanced Coding Efficency",
350 NULL,
351 };
352
353 static const char * const flash_led_mode[] = {
354 "Off",
355 "Flash",
356 "Torch",
357 NULL,
358 };
359 static const char * const flash_strobe_source[] = {
360 "Software",
361 "External",
362 NULL,
363 };
364
365 static const char * const jpeg_chroma_subsampling[] = {
366 "4:4:4",
367 "4:2:2",
368 "4:2:0",
369 "4:1:1",
370 "4:1:0",
371 "Gray",
372 NULL,
373 };
374
375 switch (id) {
376 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
377 return mpeg_audio_sampling_freq;
378 case V4L2_CID_MPEG_AUDIO_ENCODING:
379 return mpeg_audio_encoding;
380 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
381 return mpeg_audio_l1_bitrate;
382 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
383 return mpeg_audio_l2_bitrate;
384 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
385 return mpeg_audio_l3_bitrate;
386 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
387 return mpeg_audio_ac3_bitrate;
388 case V4L2_CID_MPEG_AUDIO_MODE:
389 return mpeg_audio_mode;
390 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
391 return mpeg_audio_mode_extension;
392 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
393 return mpeg_audio_emphasis;
394 case V4L2_CID_MPEG_AUDIO_CRC:
395 return mpeg_audio_crc;
396 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
397 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
398 return mpeg_audio_dec_playback;
399 case V4L2_CID_MPEG_VIDEO_ENCODING:
400 return mpeg_video_encoding;
401 case V4L2_CID_MPEG_VIDEO_ASPECT:
402 return mpeg_video_aspect;
403 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
404 return mpeg_video_bitrate_mode;
405 case V4L2_CID_MPEG_STREAM_TYPE:
406 return mpeg_stream_type;
407 case V4L2_CID_MPEG_STREAM_VBI_FMT:
408 return mpeg_stream_vbi_fmt;
409 case V4L2_CID_POWER_LINE_FREQUENCY:
410 return camera_power_line_frequency;
411 case V4L2_CID_EXPOSURE_AUTO:
412 return camera_exposure_auto;
413 case V4L2_CID_COLORFX:
414 return colorfx;
415 case V4L2_CID_TUNE_PREEMPHASIS:
416 return tune_preemphasis;
417 case V4L2_CID_FLASH_LED_MODE:
418 return flash_led_mode;
419 case V4L2_CID_FLASH_STROBE_SOURCE:
420 return flash_strobe_source;
421 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
422 return header_mode;
423 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
424 return multi_slice;
425 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
426 return entropy_mode;
427 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
428 return mpeg_h264_level;
429 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
430 return h264_loop_filter;
431 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
432 return h264_profile;
433 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
434 return vui_sar_idc;
435 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
436 return mpeg_mpeg4_level;
437 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
438 return mpeg4_profile;
439 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
440 return jpeg_chroma_subsampling;
441
442 default:
443 return NULL;
444 }
445 }
446 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
447
448 /* Return the control name. */
v4l2_ctrl_get_name(u32 id)449 const char *v4l2_ctrl_get_name(u32 id)
450 {
451 switch (id) {
452 /* USER controls */
453 /* Keep the order of the 'case's the same as in videodev2.h! */
454 case V4L2_CID_USER_CLASS: return "User Controls";
455 case V4L2_CID_BRIGHTNESS: return "Brightness";
456 case V4L2_CID_CONTRAST: return "Contrast";
457 case V4L2_CID_SATURATION: return "Saturation";
458 case V4L2_CID_HUE: return "Hue";
459 case V4L2_CID_AUDIO_VOLUME: return "Volume";
460 case V4L2_CID_AUDIO_BALANCE: return "Balance";
461 case V4L2_CID_AUDIO_BASS: return "Bass";
462 case V4L2_CID_AUDIO_TREBLE: return "Treble";
463 case V4L2_CID_AUDIO_MUTE: return "Mute";
464 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
465 case V4L2_CID_BLACK_LEVEL: return "Black Level";
466 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
467 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
468 case V4L2_CID_RED_BALANCE: return "Red Balance";
469 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
470 case V4L2_CID_GAMMA: return "Gamma";
471 case V4L2_CID_EXPOSURE: return "Exposure";
472 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
473 case V4L2_CID_GAIN: return "Gain";
474 case V4L2_CID_HFLIP: return "Horizontal Flip";
475 case V4L2_CID_VFLIP: return "Vertical Flip";
476 case V4L2_CID_HCENTER: return "Horizontal Center";
477 case V4L2_CID_VCENTER: return "Vertical Center";
478 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
479 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
480 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
481 case V4L2_CID_SHARPNESS: return "Sharpness";
482 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
483 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
484 case V4L2_CID_COLOR_KILLER: return "Color Killer";
485 case V4L2_CID_COLORFX: return "Color Effects";
486 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
487 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
488 case V4L2_CID_ROTATE: return "Rotate";
489 case V4L2_CID_BG_COLOR: return "Background Color";
490 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
491 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
492 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
493 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
494 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
495 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
496
497 /* MPEG controls */
498 /* Keep the order of the 'case's the same as in videodev2.h! */
499 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
500 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
501 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
502 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
503 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
504 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
505 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
506 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
507 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
508 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
509 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
510 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
511 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
512 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
513 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
514 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
515 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
516 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
517 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
518 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
519 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
520 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
521 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
522 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
523 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
524 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
525 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
526 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
527 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
528 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
529 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
530 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
531 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
532 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
533 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
534 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
535 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
536 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
537 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
538 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
539 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
540 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
541 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
542 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
543 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
544 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
545 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
546 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
547 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
548 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
549 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
550 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
551 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
552 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
553 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
554 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
555 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
556 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
557 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
558 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
559 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
560 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
561 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
562 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
563 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
564 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
565 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
566 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
567 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
568 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
569 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
570 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
571 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
572 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
573 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
574 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
575 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
576 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
577 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
578
579 /* CAMERA controls */
580 /* Keep the order of the 'case's the same as in videodev2.h! */
581 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
582 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
583 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
584 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
585 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
586 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
587 case V4L2_CID_PAN_RESET: return "Pan, Reset";
588 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
589 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
590 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
591 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
592 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
593 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
594 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
595 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
596 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
597 case V4L2_CID_PRIVACY: return "Privacy";
598 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
599 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
600
601 /* FM Radio Modulator control */
602 /* Keep the order of the 'case's the same as in videodev2.h! */
603 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
604 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
605 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
606 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
607 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
608 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
609 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
610 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
611 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
612 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
613 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
614 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
615 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
616 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
617 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
618 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
619 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
620 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
621 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
622 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
623
624 /* Flash controls */
625 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
626 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
627 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
628 case V4L2_CID_FLASH_STROBE: return "Strobe";
629 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
630 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
631 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
632 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
633 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
634 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
635 case V4L2_CID_FLASH_FAULT: return "Faults";
636 case V4L2_CID_FLASH_CHARGE: return "Charge";
637 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
638
639 /* JPEG encoder controls */
640 /* Keep the order of the 'case's the same as in videodev2.h! */
641 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
642 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
643 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
644 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
645 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
646
647 default:
648 return NULL;
649 }
650 }
651 EXPORT_SYMBOL(v4l2_ctrl_get_name);
652
v4l2_ctrl_fill(u32 id,const char ** name,enum v4l2_ctrl_type * type,s32 * min,s32 * max,s32 * step,s32 * def,u32 * flags)653 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
654 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
655 {
656 *name = v4l2_ctrl_get_name(id);
657 *flags = 0;
658
659 switch (id) {
660 case V4L2_CID_AUDIO_MUTE:
661 case V4L2_CID_AUDIO_LOUDNESS:
662 case V4L2_CID_AUTO_WHITE_BALANCE:
663 case V4L2_CID_AUTOGAIN:
664 case V4L2_CID_HFLIP:
665 case V4L2_CID_VFLIP:
666 case V4L2_CID_HUE_AUTO:
667 case V4L2_CID_CHROMA_AGC:
668 case V4L2_CID_COLOR_KILLER:
669 case V4L2_CID_MPEG_AUDIO_MUTE:
670 case V4L2_CID_MPEG_VIDEO_MUTE:
671 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
672 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
673 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
674 case V4L2_CID_FOCUS_AUTO:
675 case V4L2_CID_PRIVACY:
676 case V4L2_CID_AUDIO_LIMITER_ENABLED:
677 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
678 case V4L2_CID_PILOT_TONE_ENABLED:
679 case V4L2_CID_ILLUMINATORS_1:
680 case V4L2_CID_ILLUMINATORS_2:
681 case V4L2_CID_FLASH_STROBE_STATUS:
682 case V4L2_CID_FLASH_CHARGE:
683 case V4L2_CID_FLASH_READY:
684 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
685 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
686 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
687 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
688 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
689 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
690 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
691 *type = V4L2_CTRL_TYPE_BOOLEAN;
692 *min = 0;
693 *max = *step = 1;
694 break;
695 case V4L2_CID_PAN_RESET:
696 case V4L2_CID_TILT_RESET:
697 case V4L2_CID_FLASH_STROBE:
698 case V4L2_CID_FLASH_STROBE_STOP:
699 *type = V4L2_CTRL_TYPE_BUTTON;
700 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
701 *min = *max = *step = *def = 0;
702 break;
703 case V4L2_CID_POWER_LINE_FREQUENCY:
704 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
705 case V4L2_CID_MPEG_AUDIO_ENCODING:
706 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
707 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
708 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
709 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
710 case V4L2_CID_MPEG_AUDIO_MODE:
711 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
712 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
713 case V4L2_CID_MPEG_AUDIO_CRC:
714 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
715 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
716 case V4L2_CID_MPEG_VIDEO_ENCODING:
717 case V4L2_CID_MPEG_VIDEO_ASPECT:
718 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
719 case V4L2_CID_MPEG_STREAM_TYPE:
720 case V4L2_CID_MPEG_STREAM_VBI_FMT:
721 case V4L2_CID_EXPOSURE_AUTO:
722 case V4L2_CID_COLORFX:
723 case V4L2_CID_TUNE_PREEMPHASIS:
724 case V4L2_CID_FLASH_LED_MODE:
725 case V4L2_CID_FLASH_STROBE_SOURCE:
726 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
727 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
728 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
729 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
730 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
731 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
732 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
733 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
734 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
735 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
736 *type = V4L2_CTRL_TYPE_MENU;
737 break;
738 case V4L2_CID_RDS_TX_PS_NAME:
739 case V4L2_CID_RDS_TX_RADIO_TEXT:
740 *type = V4L2_CTRL_TYPE_STRING;
741 break;
742 case V4L2_CID_USER_CLASS:
743 case V4L2_CID_CAMERA_CLASS:
744 case V4L2_CID_MPEG_CLASS:
745 case V4L2_CID_FM_TX_CLASS:
746 case V4L2_CID_FLASH_CLASS:
747 case V4L2_CID_JPEG_CLASS:
748 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
749 /* You can neither read not write these */
750 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
751 *min = *max = *step = *def = 0;
752 break;
753 case V4L2_CID_BG_COLOR:
754 *type = V4L2_CTRL_TYPE_INTEGER;
755 *step = 1;
756 *min = 0;
757 /* Max is calculated as RGB888 that is 2^24 */
758 *max = 0xFFFFFF;
759 break;
760 case V4L2_CID_FLASH_FAULT:
761 case V4L2_CID_JPEG_ACTIVE_MARKER:
762 *type = V4L2_CTRL_TYPE_BITMASK;
763 break;
764 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
765 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
766 *type = V4L2_CTRL_TYPE_INTEGER;
767 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
768 break;
769 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
770 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
771 *type = V4L2_CTRL_TYPE_INTEGER64;
772 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_VOLATILE;
773 break;
774 default:
775 *type = V4L2_CTRL_TYPE_INTEGER;
776 break;
777 }
778 switch (id) {
779 case V4L2_CID_MPEG_AUDIO_ENCODING:
780 case V4L2_CID_MPEG_AUDIO_MODE:
781 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
782 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
783 case V4L2_CID_MPEG_STREAM_TYPE:
784 *flags |= V4L2_CTRL_FLAG_UPDATE;
785 break;
786 case V4L2_CID_AUDIO_VOLUME:
787 case V4L2_CID_AUDIO_BALANCE:
788 case V4L2_CID_AUDIO_BASS:
789 case V4L2_CID_AUDIO_TREBLE:
790 case V4L2_CID_BRIGHTNESS:
791 case V4L2_CID_CONTRAST:
792 case V4L2_CID_SATURATION:
793 case V4L2_CID_HUE:
794 case V4L2_CID_RED_BALANCE:
795 case V4L2_CID_BLUE_BALANCE:
796 case V4L2_CID_GAMMA:
797 case V4L2_CID_SHARPNESS:
798 case V4L2_CID_CHROMA_GAIN:
799 case V4L2_CID_RDS_TX_DEVIATION:
800 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
801 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
802 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
803 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
804 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
805 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
806 case V4L2_CID_PILOT_TONE_DEVIATION:
807 case V4L2_CID_PILOT_TONE_FREQUENCY:
808 case V4L2_CID_TUNE_POWER_LEVEL:
809 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
810 *flags |= V4L2_CTRL_FLAG_SLIDER;
811 break;
812 case V4L2_CID_PAN_RELATIVE:
813 case V4L2_CID_TILT_RELATIVE:
814 case V4L2_CID_FOCUS_RELATIVE:
815 case V4L2_CID_IRIS_RELATIVE:
816 case V4L2_CID_ZOOM_RELATIVE:
817 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
818 break;
819 case V4L2_CID_FLASH_STROBE_STATUS:
820 case V4L2_CID_FLASH_READY:
821 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
822 break;
823 }
824 }
825 EXPORT_SYMBOL(v4l2_ctrl_fill);
826
827 /* Helper function to determine whether the control type is compatible with
828 VIDIOC_G/S_CTRL. */
type_is_int(const struct v4l2_ctrl * ctrl)829 static bool type_is_int(const struct v4l2_ctrl *ctrl)
830 {
831 switch (ctrl->type) {
832 case V4L2_CTRL_TYPE_INTEGER64:
833 case V4L2_CTRL_TYPE_STRING:
834 /* Nope, these need v4l2_ext_control */
835 return false;
836 default:
837 return true;
838 }
839 }
840
fill_event(struct v4l2_event * ev,struct v4l2_ctrl * ctrl,u32 changes)841 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
842 {
843 memset(ev->reserved, 0, sizeof(ev->reserved));
844 ev->type = V4L2_EVENT_CTRL;
845 ev->id = ctrl->id;
846 ev->u.ctrl.changes = changes;
847 ev->u.ctrl.type = ctrl->type;
848 ev->u.ctrl.flags = ctrl->flags;
849 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
850 ev->u.ctrl.value64 = 0;
851 else
852 ev->u.ctrl.value64 = ctrl->cur.val64;
853 ev->u.ctrl.minimum = ctrl->minimum;
854 ev->u.ctrl.maximum = ctrl->maximum;
855 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
856 ev->u.ctrl.step = 1;
857 else
858 ev->u.ctrl.step = ctrl->step;
859 ev->u.ctrl.default_value = ctrl->default_value;
860 }
861
send_event(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,u32 changes)862 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
863 {
864 struct v4l2_event ev;
865 struct v4l2_subscribed_event *sev;
866
867 if (list_empty(&ctrl->ev_subs))
868 return;
869 fill_event(&ev, ctrl, changes);
870
871 list_for_each_entry(sev, &ctrl->ev_subs, node)
872 if (sev->fh != fh ||
873 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
874 v4l2_event_queue_fh(sev->fh, &ev);
875 }
876
877 /* Helper function: copy the current control value back to the caller */
cur_to_user(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)878 static int cur_to_user(struct v4l2_ext_control *c,
879 struct v4l2_ctrl *ctrl)
880 {
881 u32 len;
882
883 switch (ctrl->type) {
884 case V4L2_CTRL_TYPE_STRING:
885 len = strlen(ctrl->cur.string);
886 if (c->size < len + 1) {
887 c->size = len + 1;
888 return -ENOSPC;
889 }
890 return copy_to_user(c->string, ctrl->cur.string,
891 len + 1) ? -EFAULT : 0;
892 case V4L2_CTRL_TYPE_INTEGER64:
893 c->value64 = ctrl->cur.val64;
894 break;
895 default:
896 c->value = ctrl->cur.val;
897 break;
898 }
899 return 0;
900 }
901
902 /* Helper function: copy the caller-provider value as the new control value */
user_to_new(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)903 static int user_to_new(struct v4l2_ext_control *c,
904 struct v4l2_ctrl *ctrl)
905 {
906 int ret;
907 u32 size;
908
909 ctrl->is_new = 1;
910 switch (ctrl->type) {
911 case V4L2_CTRL_TYPE_INTEGER64:
912 ctrl->val64 = c->value64;
913 break;
914 case V4L2_CTRL_TYPE_STRING:
915 size = c->size;
916 if (size == 0)
917 return -ERANGE;
918 if (size > ctrl->maximum + 1)
919 size = ctrl->maximum + 1;
920 ret = copy_from_user(ctrl->string, c->string, size);
921 if (!ret) {
922 char last = ctrl->string[size - 1];
923
924 ctrl->string[size - 1] = 0;
925 /* If the string was longer than ctrl->maximum,
926 then return an error. */
927 if (strlen(ctrl->string) == ctrl->maximum && last)
928 return -ERANGE;
929 }
930 return ret ? -EFAULT : 0;
931 default:
932 ctrl->val = c->value;
933 break;
934 }
935 return 0;
936 }
937
938 /* Helper function: copy the new control value back to the caller */
new_to_user(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)939 static int new_to_user(struct v4l2_ext_control *c,
940 struct v4l2_ctrl *ctrl)
941 {
942 u32 len;
943
944 switch (ctrl->type) {
945 case V4L2_CTRL_TYPE_STRING:
946 len = strlen(ctrl->string);
947 if (c->size < len + 1) {
948 c->size = ctrl->maximum + 1;
949 return -ENOSPC;
950 }
951 return copy_to_user(c->string, ctrl->string,
952 len + 1) ? -EFAULT : 0;
953 case V4L2_CTRL_TYPE_INTEGER64:
954 c->value64 = ctrl->val64;
955 break;
956 default:
957 c->value = ctrl->val;
958 break;
959 }
960 return 0;
961 }
962
963 /* Copy the new value to the current value. */
new_to_cur(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,bool update_inactive)964 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
965 bool update_inactive)
966 {
967 bool changed = false;
968
969 if (ctrl == NULL)
970 return;
971 switch (ctrl->type) {
972 case V4L2_CTRL_TYPE_BUTTON:
973 changed = true;
974 break;
975 case V4L2_CTRL_TYPE_STRING:
976 /* strings are always 0-terminated */
977 changed = strcmp(ctrl->string, ctrl->cur.string);
978 strcpy(ctrl->cur.string, ctrl->string);
979 break;
980 case V4L2_CTRL_TYPE_INTEGER64:
981 changed = ctrl->val64 != ctrl->cur.val64;
982 ctrl->cur.val64 = ctrl->val64;
983 break;
984 default:
985 changed = ctrl->val != ctrl->cur.val;
986 ctrl->cur.val = ctrl->val;
987 break;
988 }
989 if (update_inactive) {
990 /* Note: update_inactive can only be true for auto clusters. */
991 ctrl->flags &=
992 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
993 if (!is_cur_manual(ctrl->cluster[0])) {
994 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
995 if (ctrl->cluster[0]->has_volatiles)
996 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
997 }
998 fh = NULL;
999 }
1000 if (changed || update_inactive) {
1001 /* If a control was changed that was not one of the controls
1002 modified by the application, then send the event to all. */
1003 if (!ctrl->is_new)
1004 fh = NULL;
1005 send_event(fh, ctrl,
1006 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1007 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
1008 }
1009 }
1010
1011 /* Copy the current value to the new value */
cur_to_new(struct v4l2_ctrl * ctrl)1012 static void cur_to_new(struct v4l2_ctrl *ctrl)
1013 {
1014 if (ctrl == NULL)
1015 return;
1016 switch (ctrl->type) {
1017 case V4L2_CTRL_TYPE_STRING:
1018 /* strings are always 0-terminated */
1019 strcpy(ctrl->string, ctrl->cur.string);
1020 break;
1021 case V4L2_CTRL_TYPE_INTEGER64:
1022 ctrl->val64 = ctrl->cur.val64;
1023 break;
1024 default:
1025 ctrl->val = ctrl->cur.val;
1026 break;
1027 }
1028 }
1029
1030 /* Return non-zero if one or more of the controls in the cluster has a new
1031 value that differs from the current value. */
cluster_changed(struct v4l2_ctrl * master)1032 static int cluster_changed(struct v4l2_ctrl *master)
1033 {
1034 int diff = 0;
1035 int i;
1036
1037 for (i = 0; !diff && i < master->ncontrols; i++) {
1038 struct v4l2_ctrl *ctrl = master->cluster[i];
1039
1040 if (ctrl == NULL)
1041 continue;
1042 switch (ctrl->type) {
1043 case V4L2_CTRL_TYPE_BUTTON:
1044 /* Button controls are always 'different' */
1045 return 1;
1046 case V4L2_CTRL_TYPE_STRING:
1047 /* strings are always 0-terminated */
1048 diff = strcmp(ctrl->string, ctrl->cur.string);
1049 break;
1050 case V4L2_CTRL_TYPE_INTEGER64:
1051 diff = ctrl->val64 != ctrl->cur.val64;
1052 break;
1053 default:
1054 diff = ctrl->val != ctrl->cur.val;
1055 break;
1056 }
1057 }
1058 return diff;
1059 }
1060
1061 /* Validate integer-type control */
validate_new_int(const struct v4l2_ctrl * ctrl,s32 * pval)1062 static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
1063 {
1064 s32 val = *pval;
1065 u32 offset;
1066
1067 switch (ctrl->type) {
1068 case V4L2_CTRL_TYPE_INTEGER:
1069 /* Round towards the closest legal value */
1070 val += ctrl->step / 2;
1071 if (val < ctrl->minimum)
1072 val = ctrl->minimum;
1073 if (val > ctrl->maximum)
1074 val = ctrl->maximum;
1075 offset = val - ctrl->minimum;
1076 offset = ctrl->step * (offset / ctrl->step);
1077 val = ctrl->minimum + offset;
1078 *pval = val;
1079 return 0;
1080
1081 case V4L2_CTRL_TYPE_BOOLEAN:
1082 *pval = !!val;
1083 return 0;
1084
1085 case V4L2_CTRL_TYPE_MENU:
1086 if (val < ctrl->minimum || val > ctrl->maximum)
1087 return -ERANGE;
1088 if (ctrl->qmenu[val][0] == '\0' ||
1089 (ctrl->menu_skip_mask & (1 << val)))
1090 return -EINVAL;
1091 return 0;
1092
1093 case V4L2_CTRL_TYPE_BITMASK:
1094 *pval &= ctrl->maximum;
1095 return 0;
1096
1097 case V4L2_CTRL_TYPE_BUTTON:
1098 case V4L2_CTRL_TYPE_CTRL_CLASS:
1099 *pval = 0;
1100 return 0;
1101
1102 default:
1103 return -EINVAL;
1104 }
1105 }
1106
1107 /* Validate a new control */
validate_new(const struct v4l2_ctrl * ctrl,struct v4l2_ext_control * c)1108 static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1109 {
1110 char *s = c->string;
1111 size_t len;
1112
1113 switch (ctrl->type) {
1114 case V4L2_CTRL_TYPE_INTEGER:
1115 case V4L2_CTRL_TYPE_BOOLEAN:
1116 case V4L2_CTRL_TYPE_MENU:
1117 case V4L2_CTRL_TYPE_BITMASK:
1118 case V4L2_CTRL_TYPE_BUTTON:
1119 case V4L2_CTRL_TYPE_CTRL_CLASS:
1120 return validate_new_int(ctrl, &c->value);
1121
1122 case V4L2_CTRL_TYPE_INTEGER64:
1123 return 0;
1124
1125 case V4L2_CTRL_TYPE_STRING:
1126 len = strlen(s);
1127 if (len < ctrl->minimum)
1128 return -ERANGE;
1129 if ((len - ctrl->minimum) % ctrl->step)
1130 return -ERANGE;
1131 return 0;
1132
1133 default:
1134 return -EINVAL;
1135 }
1136 }
1137
node2id(struct list_head * node)1138 static inline u32 node2id(struct list_head *node)
1139 {
1140 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1141 }
1142
1143 /* Set the handler's error code if it wasn't set earlier already */
handler_set_err(struct v4l2_ctrl_handler * hdl,int err)1144 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1145 {
1146 if (hdl->error == 0)
1147 hdl->error = err;
1148 return err;
1149 }
1150
1151 /* Initialize the handler */
v4l2_ctrl_handler_init(struct v4l2_ctrl_handler * hdl,unsigned nr_of_controls_hint)1152 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1153 unsigned nr_of_controls_hint)
1154 {
1155 mutex_init(&hdl->lock);
1156 INIT_LIST_HEAD(&hdl->ctrls);
1157 INIT_LIST_HEAD(&hdl->ctrl_refs);
1158 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1159 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1160 GFP_KERNEL);
1161 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1162 return hdl->error;
1163 }
1164 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1165
1166 /* Free all controls and control refs */
v4l2_ctrl_handler_free(struct v4l2_ctrl_handler * hdl)1167 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1168 {
1169 struct v4l2_ctrl_ref *ref, *next_ref;
1170 struct v4l2_ctrl *ctrl, *next_ctrl;
1171 struct v4l2_subscribed_event *sev, *next_sev;
1172
1173 if (hdl == NULL || hdl->buckets == NULL)
1174 return;
1175
1176 mutex_lock(&hdl->lock);
1177 /* Free all nodes */
1178 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1179 list_del(&ref->node);
1180 kfree(ref);
1181 }
1182 /* Free all controls owned by the handler */
1183 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1184 list_del(&ctrl->node);
1185 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1186 list_del(&sev->node);
1187 kfree(ctrl);
1188 }
1189 kfree(hdl->buckets);
1190 hdl->buckets = NULL;
1191 hdl->cached = NULL;
1192 hdl->error = 0;
1193 mutex_unlock(&hdl->lock);
1194 }
1195 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1196
1197 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1198 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1199 with applications that do not use the NEXT_CTRL flag.
1200
1201 We just find the n-th private user control. It's O(N), but that should not
1202 be an issue in this particular case. */
find_private_ref(struct v4l2_ctrl_handler * hdl,u32 id)1203 static struct v4l2_ctrl_ref *find_private_ref(
1204 struct v4l2_ctrl_handler *hdl, u32 id)
1205 {
1206 struct v4l2_ctrl_ref *ref;
1207
1208 id -= V4L2_CID_PRIVATE_BASE;
1209 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1210 /* Search for private user controls that are compatible with
1211 VIDIOC_G/S_CTRL. */
1212 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1213 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1214 if (!type_is_int(ref->ctrl))
1215 continue;
1216 if (id == 0)
1217 return ref;
1218 id--;
1219 }
1220 }
1221 return NULL;
1222 }
1223
1224 /* Find a control with the given ID. */
find_ref(struct v4l2_ctrl_handler * hdl,u32 id)1225 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1226 {
1227 struct v4l2_ctrl_ref *ref;
1228 int bucket;
1229
1230 id &= V4L2_CTRL_ID_MASK;
1231
1232 /* Old-style private controls need special handling */
1233 if (id >= V4L2_CID_PRIVATE_BASE)
1234 return find_private_ref(hdl, id);
1235 bucket = id % hdl->nr_of_buckets;
1236
1237 /* Simple optimization: cache the last control found */
1238 if (hdl->cached && hdl->cached->ctrl->id == id)
1239 return hdl->cached;
1240
1241 /* Not in cache, search the hash */
1242 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1243 while (ref && ref->ctrl->id != id)
1244 ref = ref->next;
1245
1246 if (ref)
1247 hdl->cached = ref; /* cache it! */
1248 return ref;
1249 }
1250
1251 /* Find a control with the given ID. Take the handler's lock first. */
find_ref_lock(struct v4l2_ctrl_handler * hdl,u32 id)1252 static struct v4l2_ctrl_ref *find_ref_lock(
1253 struct v4l2_ctrl_handler *hdl, u32 id)
1254 {
1255 struct v4l2_ctrl_ref *ref = NULL;
1256
1257 if (hdl) {
1258 mutex_lock(&hdl->lock);
1259 ref = find_ref(hdl, id);
1260 mutex_unlock(&hdl->lock);
1261 }
1262 return ref;
1263 }
1264
1265 /* Find a control with the given ID. */
v4l2_ctrl_find(struct v4l2_ctrl_handler * hdl,u32 id)1266 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1267 {
1268 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1269
1270 return ref ? ref->ctrl : NULL;
1271 }
1272 EXPORT_SYMBOL(v4l2_ctrl_find);
1273
1274 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
handler_new_ref(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl * ctrl)1275 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1276 struct v4l2_ctrl *ctrl)
1277 {
1278 struct v4l2_ctrl_ref *ref;
1279 struct v4l2_ctrl_ref *new_ref;
1280 u32 id = ctrl->id;
1281 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1282 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1283
1284 /* Automatically add the control class if it is not yet present. */
1285 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1286 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1287 return hdl->error;
1288
1289 if (hdl->error)
1290 return hdl->error;
1291
1292 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1293 if (!new_ref)
1294 return handler_set_err(hdl, -ENOMEM);
1295 new_ref->ctrl = ctrl;
1296 if (ctrl->handler == hdl) {
1297 /* By default each control starts in a cluster of its own.
1298 new_ref->ctrl is basically a cluster array with one
1299 element, so that's perfect to use as the cluster pointer.
1300 But only do this for the handler that owns the control. */
1301 ctrl->cluster = &new_ref->ctrl;
1302 ctrl->ncontrols = 1;
1303 }
1304
1305 INIT_LIST_HEAD(&new_ref->node);
1306
1307 mutex_lock(&hdl->lock);
1308
1309 /* Add immediately at the end of the list if the list is empty, or if
1310 the last element in the list has a lower ID.
1311 This ensures that when elements are added in ascending order the
1312 insertion is an O(1) operation. */
1313 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1314 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1315 goto insert_in_hash;
1316 }
1317
1318 /* Find insert position in sorted list */
1319 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1320 if (ref->ctrl->id < id)
1321 continue;
1322 /* Don't add duplicates */
1323 if (ref->ctrl->id == id) {
1324 kfree(new_ref);
1325 goto unlock;
1326 }
1327 list_add(&new_ref->node, ref->node.prev);
1328 break;
1329 }
1330
1331 insert_in_hash:
1332 /* Insert the control node in the hash */
1333 new_ref->next = hdl->buckets[bucket];
1334 hdl->buckets[bucket] = new_ref;
1335
1336 unlock:
1337 mutex_unlock(&hdl->lock);
1338 return 0;
1339 }
1340
1341 /* Add a new control */
v4l2_ctrl_new(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,const char * name,enum v4l2_ctrl_type type,s32 min,s32 max,u32 step,s32 def,u32 flags,const char * const * qmenu,void * priv)1342 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1343 const struct v4l2_ctrl_ops *ops,
1344 u32 id, const char *name, enum v4l2_ctrl_type type,
1345 s32 min, s32 max, u32 step, s32 def,
1346 u32 flags, const char * const *qmenu, void *priv)
1347 {
1348 struct v4l2_ctrl *ctrl;
1349 unsigned sz_extra = 0;
1350
1351 if (hdl->error)
1352 return NULL;
1353
1354 /* Sanity checks */
1355 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1356 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1357 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
1358 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1359 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1360 handler_set_err(hdl, -ERANGE);
1361 return NULL;
1362 }
1363 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1364 handler_set_err(hdl, -ERANGE);
1365 return NULL;
1366 }
1367 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1368 type == V4L2_CTRL_TYPE_MENU ||
1369 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1370 (def < min || def > max)) {
1371 handler_set_err(hdl, -ERANGE);
1372 return NULL;
1373 }
1374 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1375 handler_set_err(hdl, -ERANGE);
1376 return NULL;
1377 }
1378
1379 if (type == V4L2_CTRL_TYPE_BUTTON)
1380 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1381 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1382 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1383 else if (type == V4L2_CTRL_TYPE_STRING)
1384 sz_extra += 2 * (max + 1);
1385
1386 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1387 if (ctrl == NULL) {
1388 handler_set_err(hdl, -ENOMEM);
1389 return NULL;
1390 }
1391
1392 INIT_LIST_HEAD(&ctrl->node);
1393 INIT_LIST_HEAD(&ctrl->ev_subs);
1394 ctrl->handler = hdl;
1395 ctrl->ops = ops;
1396 ctrl->id = id;
1397 ctrl->name = name;
1398 ctrl->type = type;
1399 ctrl->flags = flags;
1400 ctrl->minimum = min;
1401 ctrl->maximum = max;
1402 ctrl->step = step;
1403 ctrl->qmenu = qmenu;
1404 ctrl->priv = priv;
1405 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1406
1407 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1408 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1409 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1410 if (ctrl->minimum)
1411 memset(ctrl->cur.string, ' ', ctrl->minimum);
1412 }
1413 if (handler_new_ref(hdl, ctrl)) {
1414 kfree(ctrl);
1415 return NULL;
1416 }
1417 mutex_lock(&hdl->lock);
1418 list_add_tail(&ctrl->node, &hdl->ctrls);
1419 mutex_unlock(&hdl->lock);
1420 return ctrl;
1421 }
1422
v4l2_ctrl_new_custom(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_config * cfg,void * priv)1423 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1424 const struct v4l2_ctrl_config *cfg, void *priv)
1425 {
1426 bool is_menu;
1427 struct v4l2_ctrl *ctrl;
1428 const char *name = cfg->name;
1429 const char * const *qmenu = cfg->qmenu;
1430 enum v4l2_ctrl_type type = cfg->type;
1431 u32 flags = cfg->flags;
1432 s32 min = cfg->min;
1433 s32 max = cfg->max;
1434 u32 step = cfg->step;
1435 s32 def = cfg->def;
1436
1437 if (name == NULL)
1438 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1439 &def, &flags);
1440
1441 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU);
1442 if (is_menu)
1443 WARN_ON(step);
1444 else
1445 WARN_ON(cfg->menu_skip_mask);
1446 if (is_menu && qmenu == NULL)
1447 qmenu = v4l2_ctrl_get_menu(cfg->id);
1448
1449 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1450 type, min, max,
1451 is_menu ? cfg->menu_skip_mask : step,
1452 def, flags, qmenu, priv);
1453 if (ctrl)
1454 ctrl->is_private = cfg->is_private;
1455 return ctrl;
1456 }
1457 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1458
1459 /* Helper function for standard non-menu controls */
v4l2_ctrl_new_std(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,s32 min,s32 max,u32 step,s32 def)1460 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1461 const struct v4l2_ctrl_ops *ops,
1462 u32 id, s32 min, s32 max, u32 step, s32 def)
1463 {
1464 const char *name;
1465 enum v4l2_ctrl_type type;
1466 u32 flags;
1467
1468 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1469 if (type == V4L2_CTRL_TYPE_MENU) {
1470 handler_set_err(hdl, -EINVAL);
1471 return NULL;
1472 }
1473 return v4l2_ctrl_new(hdl, ops, id, name, type,
1474 min, max, step, def, flags, NULL, NULL);
1475 }
1476 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1477
1478 /* Helper function for standard menu controls */
v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,s32 max,s32 mask,s32 def)1479 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1480 const struct v4l2_ctrl_ops *ops,
1481 u32 id, s32 max, s32 mask, s32 def)
1482 {
1483 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1484 const char *name;
1485 enum v4l2_ctrl_type type;
1486 s32 min;
1487 s32 step;
1488 u32 flags;
1489
1490 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1491 if (type != V4L2_CTRL_TYPE_MENU) {
1492 handler_set_err(hdl, -EINVAL);
1493 return NULL;
1494 }
1495 return v4l2_ctrl_new(hdl, ops, id, name, type,
1496 0, max, mask, def, flags, qmenu, NULL);
1497 }
1498 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1499
1500 /* Add a control from another handler to this handler */
v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl * ctrl)1501 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1502 struct v4l2_ctrl *ctrl)
1503 {
1504 if (hdl == NULL || hdl->error)
1505 return NULL;
1506 if (ctrl == NULL) {
1507 handler_set_err(hdl, -EINVAL);
1508 return NULL;
1509 }
1510 if (ctrl->handler == hdl)
1511 return ctrl;
1512 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1513 }
1514 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1515
1516 /* Add the controls from another handler to our own. */
v4l2_ctrl_add_handler(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl_handler * add)1517 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1518 struct v4l2_ctrl_handler *add)
1519 {
1520 struct v4l2_ctrl_ref *ref;
1521 int ret = 0;
1522
1523 /* Do nothing if either handler is NULL or if they are the same */
1524 if (!hdl || !add || hdl == add)
1525 return 0;
1526 if (hdl->error)
1527 return hdl->error;
1528 mutex_lock(&add->lock);
1529 list_for_each_entry(ref, &add->ctrl_refs, node) {
1530 struct v4l2_ctrl *ctrl = ref->ctrl;
1531
1532 /* Skip handler-private controls. */
1533 if (ctrl->is_private)
1534 continue;
1535 /* And control classes */
1536 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1537 continue;
1538 ret = handler_new_ref(hdl, ctrl);
1539 if (ret)
1540 break;
1541 }
1542 mutex_unlock(&add->lock);
1543 return ret;
1544 }
1545 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1546
1547 /* Cluster controls */
v4l2_ctrl_cluster(unsigned ncontrols,struct v4l2_ctrl ** controls)1548 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1549 {
1550 bool has_volatiles = false;
1551 int i;
1552
1553 /* The first control is the master control and it must not be NULL */
1554 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1555
1556 for (i = 0; i < ncontrols; i++) {
1557 if (controls[i]) {
1558 controls[i]->cluster = controls;
1559 controls[i]->ncontrols = ncontrols;
1560 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1561 has_volatiles = true;
1562 }
1563 }
1564 controls[0]->has_volatiles = has_volatiles;
1565 }
1566 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1567
v4l2_ctrl_auto_cluster(unsigned ncontrols,struct v4l2_ctrl ** controls,u8 manual_val,bool set_volatile)1568 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1569 u8 manual_val, bool set_volatile)
1570 {
1571 struct v4l2_ctrl *master = controls[0];
1572 u32 flag = 0;
1573 int i;
1574
1575 v4l2_ctrl_cluster(ncontrols, controls);
1576 WARN_ON(ncontrols <= 1);
1577 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1578 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1579 master->is_auto = true;
1580 master->has_volatiles = set_volatile;
1581 master->manual_mode_value = manual_val;
1582 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1583
1584 if (!is_cur_manual(master))
1585 flag = V4L2_CTRL_FLAG_INACTIVE |
1586 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1587
1588 for (i = 1; i < ncontrols; i++)
1589 if (controls[i])
1590 controls[i]->flags |= flag;
1591 }
1592 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1593
1594 /* Activate/deactivate a control. */
v4l2_ctrl_activate(struct v4l2_ctrl * ctrl,bool active)1595 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1596 {
1597 /* invert since the actual flag is called 'inactive' */
1598 bool inactive = !active;
1599 bool old;
1600
1601 if (ctrl == NULL)
1602 return;
1603
1604 if (inactive)
1605 /* set V4L2_CTRL_FLAG_INACTIVE */
1606 old = test_and_set_bit(4, &ctrl->flags);
1607 else
1608 /* clear V4L2_CTRL_FLAG_INACTIVE */
1609 old = test_and_clear_bit(4, &ctrl->flags);
1610 if (old != inactive)
1611 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1612 }
1613 EXPORT_SYMBOL(v4l2_ctrl_activate);
1614
1615 /* Grab/ungrab a control.
1616 Typically used when streaming starts and you want to grab controls,
1617 preventing the user from changing them.
1618
1619 Just call this and the framework will block any attempts to change
1620 these controls. */
v4l2_ctrl_grab(struct v4l2_ctrl * ctrl,bool grabbed)1621 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1622 {
1623 bool old;
1624
1625 if (ctrl == NULL)
1626 return;
1627
1628 v4l2_ctrl_lock(ctrl);
1629 if (grabbed)
1630 /* set V4L2_CTRL_FLAG_GRABBED */
1631 old = test_and_set_bit(1, &ctrl->flags);
1632 else
1633 /* clear V4L2_CTRL_FLAG_GRABBED */
1634 old = test_and_clear_bit(1, &ctrl->flags);
1635 if (old != grabbed)
1636 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1637 v4l2_ctrl_unlock(ctrl);
1638 }
1639 EXPORT_SYMBOL(v4l2_ctrl_grab);
1640
1641 /* Log the control name and value */
log_ctrl(const struct v4l2_ctrl * ctrl,const char * prefix,const char * colon)1642 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1643 const char *prefix, const char *colon)
1644 {
1645 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1646 return;
1647 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1648 return;
1649
1650 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1651
1652 switch (ctrl->type) {
1653 case V4L2_CTRL_TYPE_INTEGER:
1654 printk(KERN_CONT "%d", ctrl->cur.val);
1655 break;
1656 case V4L2_CTRL_TYPE_BOOLEAN:
1657 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1658 break;
1659 case V4L2_CTRL_TYPE_MENU:
1660 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1661 break;
1662 case V4L2_CTRL_TYPE_BITMASK:
1663 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1664 break;
1665 case V4L2_CTRL_TYPE_INTEGER64:
1666 printk(KERN_CONT "%lld", ctrl->cur.val64);
1667 break;
1668 case V4L2_CTRL_TYPE_STRING:
1669 printk(KERN_CONT "%s", ctrl->cur.string);
1670 break;
1671 default:
1672 printk(KERN_CONT "unknown type %d", ctrl->type);
1673 break;
1674 }
1675 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1676 V4L2_CTRL_FLAG_GRABBED |
1677 V4L2_CTRL_FLAG_VOLATILE)) {
1678 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1679 printk(KERN_CONT " inactive");
1680 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1681 printk(KERN_CONT " grabbed");
1682 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1683 printk(KERN_CONT " volatile");
1684 }
1685 printk(KERN_CONT "\n");
1686 }
1687
1688 /* Log all controls owned by the handler */
v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler * hdl,const char * prefix)1689 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1690 const char *prefix)
1691 {
1692 struct v4l2_ctrl *ctrl;
1693 const char *colon = "";
1694 int len;
1695
1696 if (hdl == NULL)
1697 return;
1698 if (prefix == NULL)
1699 prefix = "";
1700 len = strlen(prefix);
1701 if (len && prefix[len - 1] != ' ')
1702 colon = ": ";
1703 mutex_lock(&hdl->lock);
1704 list_for_each_entry(ctrl, &hdl->ctrls, node)
1705 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1706 log_ctrl(ctrl, prefix, colon);
1707 mutex_unlock(&hdl->lock);
1708 }
1709 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1710
1711 /* Call s_ctrl for all controls owned by the handler */
v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler * hdl)1712 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1713 {
1714 struct v4l2_ctrl *ctrl;
1715 int ret = 0;
1716
1717 if (hdl == NULL)
1718 return 0;
1719 mutex_lock(&hdl->lock);
1720 list_for_each_entry(ctrl, &hdl->ctrls, node)
1721 ctrl->done = false;
1722
1723 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1724 struct v4l2_ctrl *master = ctrl->cluster[0];
1725 int i;
1726
1727 /* Skip if this control was already handled by a cluster. */
1728 /* Skip button controls and read-only controls. */
1729 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1730 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1731 continue;
1732
1733 for (i = 0; i < master->ncontrols; i++) {
1734 if (master->cluster[i]) {
1735 cur_to_new(master->cluster[i]);
1736 master->cluster[i]->is_new = 1;
1737 master->cluster[i]->done = true;
1738 }
1739 }
1740 ret = call_op(master, s_ctrl);
1741 if (ret)
1742 break;
1743 }
1744 mutex_unlock(&hdl->lock);
1745 return ret;
1746 }
1747 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1748
1749 /* Implement VIDIOC_QUERYCTRL */
v4l2_queryctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_queryctrl * qc)1750 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1751 {
1752 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1753 struct v4l2_ctrl_ref *ref;
1754 struct v4l2_ctrl *ctrl;
1755
1756 if (hdl == NULL)
1757 return -EINVAL;
1758
1759 mutex_lock(&hdl->lock);
1760
1761 /* Try to find it */
1762 ref = find_ref(hdl, id);
1763
1764 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1765 /* Find the next control with ID > qc->id */
1766
1767 /* Did we reach the end of the control list? */
1768 if (id >= node2id(hdl->ctrl_refs.prev)) {
1769 ref = NULL; /* Yes, so there is no next control */
1770 } else if (ref) {
1771 /* We found a control with the given ID, so just get
1772 the next one in the list. */
1773 ref = list_entry(ref->node.next, typeof(*ref), node);
1774 } else {
1775 /* No control with the given ID exists, so start
1776 searching for the next largest ID. We know there
1777 is one, otherwise the first 'if' above would have
1778 been true. */
1779 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1780 if (id < ref->ctrl->id)
1781 break;
1782 }
1783 }
1784 mutex_unlock(&hdl->lock);
1785 if (!ref)
1786 return -EINVAL;
1787
1788 ctrl = ref->ctrl;
1789 memset(qc, 0, sizeof(*qc));
1790 if (id >= V4L2_CID_PRIVATE_BASE)
1791 qc->id = id;
1792 else
1793 qc->id = ctrl->id;
1794 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1795 qc->minimum = ctrl->minimum;
1796 qc->maximum = ctrl->maximum;
1797 qc->default_value = ctrl->default_value;
1798 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
1799 qc->step = 1;
1800 else
1801 qc->step = ctrl->step;
1802 qc->flags = ctrl->flags;
1803 qc->type = ctrl->type;
1804 return 0;
1805 }
1806 EXPORT_SYMBOL(v4l2_queryctrl);
1807
v4l2_subdev_queryctrl(struct v4l2_subdev * sd,struct v4l2_queryctrl * qc)1808 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1809 {
1810 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1811 return -EINVAL;
1812 return v4l2_queryctrl(sd->ctrl_handler, qc);
1813 }
1814 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1815
1816 /* Implement VIDIOC_QUERYMENU */
v4l2_querymenu(struct v4l2_ctrl_handler * hdl,struct v4l2_querymenu * qm)1817 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1818 {
1819 struct v4l2_ctrl *ctrl;
1820 u32 i = qm->index;
1821
1822 ctrl = v4l2_ctrl_find(hdl, qm->id);
1823 if (!ctrl)
1824 return -EINVAL;
1825
1826 qm->reserved = 0;
1827 /* Sanity checks */
1828 if (ctrl->qmenu == NULL ||
1829 i < ctrl->minimum || i > ctrl->maximum)
1830 return -EINVAL;
1831 /* Use mask to see if this menu item should be skipped */
1832 if (ctrl->menu_skip_mask & (1 << i))
1833 return -EINVAL;
1834 /* Empty menu items should also be skipped */
1835 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1836 return -EINVAL;
1837 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1838 return 0;
1839 }
1840 EXPORT_SYMBOL(v4l2_querymenu);
1841
v4l2_subdev_querymenu(struct v4l2_subdev * sd,struct v4l2_querymenu * qm)1842 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1843 {
1844 return v4l2_querymenu(sd->ctrl_handler, qm);
1845 }
1846 EXPORT_SYMBOL(v4l2_subdev_querymenu);
1847
1848
1849
1850 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1851
1852 It is not a fully atomic operation, just best-effort only. After all, if
1853 multiple controls have to be set through multiple i2c writes (for example)
1854 then some initial writes may succeed while others fail. Thus leaving the
1855 system in an inconsistent state. The question is how much effort you are
1856 willing to spend on trying to make something atomic that really isn't.
1857
1858 From the point of view of an application the main requirement is that
1859 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1860 error should be returned without actually affecting any controls.
1861
1862 If all the values are correct, then it is acceptable to just give up
1863 in case of low-level errors.
1864
1865 It is important though that the application can tell when only a partial
1866 configuration was done. The way we do that is through the error_idx field
1867 of struct v4l2_ext_controls: if that is equal to the count field then no
1868 controls were affected. Otherwise all controls before that index were
1869 successful in performing their 'get' or 'set' operation, the control at
1870 the given index failed, and you don't know what happened with the controls
1871 after the failed one. Since if they were part of a control cluster they
1872 could have been successfully processed (if a cluster member was encountered
1873 at index < error_idx), they could have failed (if a cluster member was at
1874 error_idx), or they may not have been processed yet (if the first cluster
1875 member appeared after error_idx).
1876
1877 It is all fairly theoretical, though. In practice all you can do is to
1878 bail out. If error_idx == count, then it is an application bug. If
1879 error_idx < count then it is only an application bug if the error code was
1880 EBUSY. That usually means that something started streaming just when you
1881 tried to set the controls. In all other cases it is a driver/hardware
1882 problem and all you can do is to retry or bail out.
1883
1884 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1885 never modifies controls the error_idx is just set to whatever control
1886 has an invalid value.
1887 */
1888
1889 /* Prepare for the extended g/s/try functions.
1890 Find the controls in the control array and do some basic checks. */
prepare_ext_ctrls(struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs,struct v4l2_ctrl_helper * helpers)1891 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1892 struct v4l2_ext_controls *cs,
1893 struct v4l2_ctrl_helper *helpers)
1894 {
1895 struct v4l2_ctrl_helper *h;
1896 bool have_clusters = false;
1897 u32 i;
1898
1899 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1900 struct v4l2_ext_control *c = &cs->controls[i];
1901 struct v4l2_ctrl_ref *ref;
1902 struct v4l2_ctrl *ctrl;
1903 u32 id = c->id & V4L2_CTRL_ID_MASK;
1904
1905 cs->error_idx = i;
1906
1907 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1908 return -EINVAL;
1909
1910 /* Old-style private controls are not allowed for
1911 extended controls */
1912 if (id >= V4L2_CID_PRIVATE_BASE)
1913 return -EINVAL;
1914 ref = find_ref_lock(hdl, id);
1915 if (ref == NULL)
1916 return -EINVAL;
1917 ctrl = ref->ctrl;
1918 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1919 return -EINVAL;
1920
1921 if (ctrl->cluster[0]->ncontrols > 1)
1922 have_clusters = true;
1923 if (ctrl->cluster[0] != ctrl)
1924 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1925 /* Store the ref to the master control of the cluster */
1926 h->mref = ref;
1927 h->ctrl = ctrl;
1928 /* Initially set next to 0, meaning that there is no other
1929 control in this helper array belonging to the same
1930 cluster */
1931 h->next = 0;
1932 }
1933
1934 /* We are done if there were no controls that belong to a multi-
1935 control cluster. */
1936 if (!have_clusters)
1937 return 0;
1938
1939 /* The code below figures out in O(n) time which controls in the list
1940 belong to the same cluster. */
1941
1942 /* This has to be done with the handler lock taken. */
1943 mutex_lock(&hdl->lock);
1944
1945 /* First zero the helper field in the master control references */
1946 for (i = 0; i < cs->count; i++)
1947 helpers[i].mref->helper = 0;
1948 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1949 struct v4l2_ctrl_ref *mref = h->mref;
1950
1951 /* If the mref->helper is set, then it points to an earlier
1952 helper that belongs to the same cluster. */
1953 if (mref->helper) {
1954 /* Set the next field of mref->helper to the current
1955 index: this means that that earlier helper now
1956 points to the next helper in the same cluster. */
1957 mref->helper->next = i;
1958 /* mref should be set only for the first helper in the
1959 cluster, clear the others. */
1960 h->mref = NULL;
1961 }
1962 /* Point the mref helper to the current helper struct. */
1963 mref->helper = h;
1964 }
1965 mutex_unlock(&hdl->lock);
1966 return 0;
1967 }
1968
1969 /* Handles the corner case where cs->count == 0. It checks whether the
1970 specified control class exists. If that class ID is 0, then it checks
1971 whether there are any controls at all. */
class_check(struct v4l2_ctrl_handler * hdl,u32 ctrl_class)1972 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
1973 {
1974 if (ctrl_class == 0)
1975 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
1976 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
1977 }
1978
1979
1980
1981 /* Get extended controls. Allocates the helpers array if needed. */
v4l2_g_ext_ctrls(struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)1982 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1983 {
1984 struct v4l2_ctrl_helper helper[4];
1985 struct v4l2_ctrl_helper *helpers = helper;
1986 int ret;
1987 int i, j;
1988
1989 cs->error_idx = cs->count;
1990 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1991
1992 if (hdl == NULL)
1993 return -EINVAL;
1994
1995 if (cs->count == 0)
1996 return class_check(hdl, cs->ctrl_class);
1997
1998 if (cs->count > ARRAY_SIZE(helper)) {
1999 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
2000 if (helpers == NULL)
2001 return -ENOMEM;
2002 }
2003
2004 ret = prepare_ext_ctrls(hdl, cs, helpers);
2005 cs->error_idx = cs->count;
2006
2007 for (i = 0; !ret && i < cs->count; i++)
2008 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2009 ret = -EACCES;
2010
2011 for (i = 0; !ret && i < cs->count; i++) {
2012 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2013 struct v4l2_ctrl *ctrl) = cur_to_user;
2014 struct v4l2_ctrl *master;
2015
2016 if (helpers[i].mref == NULL)
2017 continue;
2018
2019 master = helpers[i].mref->ctrl;
2020 cs->error_idx = i;
2021
2022 v4l2_ctrl_lock(master);
2023
2024 /* g_volatile_ctrl will update the new control values */
2025 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2026 (master->has_volatiles && !is_cur_manual(master))) {
2027 for (j = 0; j < master->ncontrols; j++)
2028 cur_to_new(master->cluster[j]);
2029 ret = call_op(master, g_volatile_ctrl);
2030 ctrl_to_user = new_to_user;
2031 }
2032 /* If OK, then copy the current (for non-volatile controls)
2033 or the new (for volatile controls) control values to the
2034 caller */
2035 if (!ret) {
2036 u32 idx = i;
2037
2038 do {
2039 ret = ctrl_to_user(cs->controls + idx,
2040 helpers[idx].ctrl);
2041 idx = helpers[idx].next;
2042 } while (!ret && idx);
2043 }
2044 v4l2_ctrl_unlock(master);
2045 }
2046
2047 if (cs->count > ARRAY_SIZE(helper))
2048 kfree(helpers);
2049 return ret;
2050 }
2051 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2052
v4l2_subdev_g_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)2053 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2054 {
2055 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2056 }
2057 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2058
2059 /* Helper function to get a single control */
get_ctrl(struct v4l2_ctrl * ctrl,s32 * val)2060 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2061 {
2062 struct v4l2_ctrl *master = ctrl->cluster[0];
2063 int ret = 0;
2064 int i;
2065
2066 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2067 return -EACCES;
2068
2069 v4l2_ctrl_lock(master);
2070 /* g_volatile_ctrl will update the current control values */
2071 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2072 for (i = 0; i < master->ncontrols; i++)
2073 cur_to_new(master->cluster[i]);
2074 ret = call_op(master, g_volatile_ctrl);
2075 *val = ctrl->val;
2076 } else {
2077 *val = ctrl->cur.val;
2078 }
2079 v4l2_ctrl_unlock(master);
2080 return ret;
2081 }
2082
v4l2_g_ctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_control * control)2083 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2084 {
2085 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2086
2087 if (ctrl == NULL || !type_is_int(ctrl))
2088 return -EINVAL;
2089 return get_ctrl(ctrl, &control->value);
2090 }
2091 EXPORT_SYMBOL(v4l2_g_ctrl);
2092
v4l2_subdev_g_ctrl(struct v4l2_subdev * sd,struct v4l2_control * control)2093 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2094 {
2095 return v4l2_g_ctrl(sd->ctrl_handler, control);
2096 }
2097 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2098
v4l2_ctrl_g_ctrl(struct v4l2_ctrl * ctrl)2099 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2100 {
2101 s32 val = 0;
2102
2103 /* It's a driver bug if this happens. */
2104 WARN_ON(!type_is_int(ctrl));
2105 get_ctrl(ctrl, &val);
2106 return val;
2107 }
2108 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2109
2110
2111 /* Core function that calls try/s_ctrl and ensures that the new value is
2112 copied to the current value on a set.
2113 Must be called with ctrl->handler->lock held. */
try_or_set_cluster(struct v4l2_fh * fh,struct v4l2_ctrl * master,bool set)2114 static int try_or_set_cluster(struct v4l2_fh *fh,
2115 struct v4l2_ctrl *master, bool set)
2116 {
2117 bool update_flag;
2118 int ret;
2119 int i;
2120
2121 /* Go through the cluster and either validate the new value or
2122 (if no new value was set), copy the current value to the new
2123 value, ensuring a consistent view for the control ops when
2124 called. */
2125 for (i = 0; i < master->ncontrols; i++) {
2126 struct v4l2_ctrl *ctrl = master->cluster[i];
2127
2128 if (ctrl == NULL)
2129 continue;
2130
2131 if (!ctrl->is_new) {
2132 cur_to_new(ctrl);
2133 continue;
2134 }
2135 /* Check again: it may have changed since the
2136 previous check in try_or_set_ext_ctrls(). */
2137 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2138 return -EBUSY;
2139 }
2140
2141 ret = call_op(master, try_ctrl);
2142
2143 /* Don't set if there is no change */
2144 if (ret || !set || !cluster_changed(master))
2145 return ret;
2146 ret = call_op(master, s_ctrl);
2147 if (ret)
2148 return ret;
2149
2150 /* If OK, then make the new values permanent. */
2151 update_flag = is_cur_manual(master) != is_new_manual(master);
2152 for (i = 0; i < master->ncontrols; i++)
2153 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
2154 return 0;
2155 }
2156
2157 /* Validate controls. */
validate_ctrls(struct v4l2_ext_controls * cs,struct v4l2_ctrl_helper * helpers,bool set)2158 static int validate_ctrls(struct v4l2_ext_controls *cs,
2159 struct v4l2_ctrl_helper *helpers, bool set)
2160 {
2161 unsigned i;
2162 int ret = 0;
2163
2164 cs->error_idx = cs->count;
2165 for (i = 0; i < cs->count; i++) {
2166 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2167
2168 cs->error_idx = i;
2169
2170 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2171 return -EACCES;
2172 /* This test is also done in try_set_control_cluster() which
2173 is called in atomic context, so that has the final say,
2174 but it makes sense to do an up-front check as well. Once
2175 an error occurs in try_set_control_cluster() some other
2176 controls may have been set already and we want to do a
2177 best-effort to avoid that. */
2178 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2179 return -EBUSY;
2180 ret = validate_new(ctrl, &cs->controls[i]);
2181 if (ret)
2182 return ret;
2183 }
2184 return 0;
2185 }
2186
2187 /* Obtain the current volatile values of an autocluster and mark them
2188 as new. */
update_from_auto_cluster(struct v4l2_ctrl * master)2189 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2190 {
2191 int i;
2192
2193 for (i = 0; i < master->ncontrols; i++)
2194 cur_to_new(master->cluster[i]);
2195 if (!call_op(master, g_volatile_ctrl))
2196 for (i = 1; i < master->ncontrols; i++)
2197 if (master->cluster[i])
2198 master->cluster[i]->is_new = 1;
2199 }
2200
2201 /* Try or try-and-set controls */
try_set_ext_ctrls(struct v4l2_fh * fh,struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs,bool set)2202 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2203 struct v4l2_ext_controls *cs,
2204 bool set)
2205 {
2206 struct v4l2_ctrl_helper helper[4];
2207 struct v4l2_ctrl_helper *helpers = helper;
2208 unsigned i, j;
2209 int ret;
2210
2211 cs->error_idx = cs->count;
2212 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2213
2214 if (hdl == NULL)
2215 return -EINVAL;
2216
2217 if (cs->count == 0)
2218 return class_check(hdl, cs->ctrl_class);
2219
2220 if (cs->count > ARRAY_SIZE(helper)) {
2221 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
2222 if (!helpers)
2223 return -ENOMEM;
2224 }
2225 ret = prepare_ext_ctrls(hdl, cs, helpers);
2226 if (!ret)
2227 ret = validate_ctrls(cs, helpers, set);
2228 if (ret && set)
2229 cs->error_idx = cs->count;
2230 for (i = 0; !ret && i < cs->count; i++) {
2231 struct v4l2_ctrl *master;
2232 u32 idx = i;
2233
2234 if (helpers[i].mref == NULL)
2235 continue;
2236
2237 cs->error_idx = i;
2238 master = helpers[i].mref->ctrl;
2239 v4l2_ctrl_lock(master);
2240
2241 /* Reset the 'is_new' flags of the cluster */
2242 for (j = 0; j < master->ncontrols; j++)
2243 if (master->cluster[j])
2244 master->cluster[j]->is_new = 0;
2245
2246 /* For volatile autoclusters that are currently in auto mode
2247 we need to discover if it will be set to manual mode.
2248 If so, then we have to copy the current volatile values
2249 first since those will become the new manual values (which
2250 may be overwritten by explicit new values from this set
2251 of controls). */
2252 if (master->is_auto && master->has_volatiles &&
2253 !is_cur_manual(master)) {
2254 /* Pick an initial non-manual value */
2255 s32 new_auto_val = master->manual_mode_value + 1;
2256 u32 tmp_idx = idx;
2257
2258 do {
2259 /* Check if the auto control is part of the
2260 list, and remember the new value. */
2261 if (helpers[tmp_idx].ctrl == master)
2262 new_auto_val = cs->controls[tmp_idx].value;
2263 tmp_idx = helpers[tmp_idx].next;
2264 } while (tmp_idx);
2265 /* If the new value == the manual value, then copy
2266 the current volatile values. */
2267 if (new_auto_val == master->manual_mode_value)
2268 update_from_auto_cluster(master);
2269 }
2270
2271 /* Copy the new caller-supplied control values.
2272 user_to_new() sets 'is_new' to 1. */
2273 do {
2274 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2275 idx = helpers[idx].next;
2276 } while (!ret && idx);
2277
2278 if (!ret)
2279 ret = try_or_set_cluster(fh, master, set);
2280
2281 /* Copy the new values back to userspace. */
2282 if (!ret) {
2283 idx = i;
2284 do {
2285 ret = new_to_user(cs->controls + idx,
2286 helpers[idx].ctrl);
2287 idx = helpers[idx].next;
2288 } while (!ret && idx);
2289 }
2290 v4l2_ctrl_unlock(master);
2291 }
2292
2293 if (cs->count > ARRAY_SIZE(helper))
2294 kfree(helpers);
2295 return ret;
2296 }
2297
v4l2_try_ext_ctrls(struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)2298 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2299 {
2300 return try_set_ext_ctrls(NULL, hdl, cs, false);
2301 }
2302 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2303
v4l2_s_ext_ctrls(struct v4l2_fh * fh,struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)2304 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2305 struct v4l2_ext_controls *cs)
2306 {
2307 return try_set_ext_ctrls(fh, hdl, cs, true);
2308 }
2309 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2310
v4l2_subdev_try_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)2311 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2312 {
2313 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2314 }
2315 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2316
v4l2_subdev_s_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)2317 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2318 {
2319 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2320 }
2321 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2322
2323 /* Helper function for VIDIOC_S_CTRL compatibility */
set_ctrl(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,s32 * val)2324 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
2325 {
2326 struct v4l2_ctrl *master = ctrl->cluster[0];
2327 int ret;
2328 int i;
2329
2330 ret = validate_new_int(ctrl, val);
2331 if (ret)
2332 return ret;
2333
2334 v4l2_ctrl_lock(ctrl);
2335
2336 /* Reset the 'is_new' flags of the cluster */
2337 for (i = 0; i < master->ncontrols; i++)
2338 if (master->cluster[i])
2339 master->cluster[i]->is_new = 0;
2340
2341 /* For autoclusters with volatiles that are switched from auto to
2342 manual mode we have to update the current volatile values since
2343 those will become the initial manual values after such a switch. */
2344 if (master->is_auto && master->has_volatiles && ctrl == master &&
2345 !is_cur_manual(master) && *val == master->manual_mode_value)
2346 update_from_auto_cluster(master);
2347 ctrl->val = *val;
2348 ctrl->is_new = 1;
2349 ret = try_or_set_cluster(fh, master, true);
2350 *val = ctrl->cur.val;
2351 v4l2_ctrl_unlock(ctrl);
2352 return ret;
2353 }
2354
v4l2_s_ctrl(struct v4l2_fh * fh,struct v4l2_ctrl_handler * hdl,struct v4l2_control * control)2355 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2356 struct v4l2_control *control)
2357 {
2358 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2359
2360 if (ctrl == NULL || !type_is_int(ctrl))
2361 return -EINVAL;
2362
2363 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2364 return -EACCES;
2365
2366 return set_ctrl(fh, ctrl, &control->value);
2367 }
2368 EXPORT_SYMBOL(v4l2_s_ctrl);
2369
v4l2_subdev_s_ctrl(struct v4l2_subdev * sd,struct v4l2_control * control)2370 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2371 {
2372 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2373 }
2374 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2375
v4l2_ctrl_s_ctrl(struct v4l2_ctrl * ctrl,s32 val)2376 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2377 {
2378 /* It's a driver bug if this happens. */
2379 WARN_ON(!type_is_int(ctrl));
2380 return set_ctrl(NULL, ctrl, &val);
2381 }
2382 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2383
v4l2_ctrl_add_event(struct v4l2_ctrl * ctrl,struct v4l2_subscribed_event * sev)2384 void v4l2_ctrl_add_event(struct v4l2_ctrl *ctrl,
2385 struct v4l2_subscribed_event *sev)
2386 {
2387 v4l2_ctrl_lock(ctrl);
2388 list_add_tail(&sev->node, &ctrl->ev_subs);
2389 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2390 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2391 struct v4l2_event ev;
2392 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2393
2394 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2395 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2396 fill_event(&ev, ctrl, changes);
2397 v4l2_event_queue_fh(sev->fh, &ev);
2398 }
2399 v4l2_ctrl_unlock(ctrl);
2400 }
2401 EXPORT_SYMBOL(v4l2_ctrl_add_event);
2402
v4l2_ctrl_del_event(struct v4l2_ctrl * ctrl,struct v4l2_subscribed_event * sev)2403 void v4l2_ctrl_del_event(struct v4l2_ctrl *ctrl,
2404 struct v4l2_subscribed_event *sev)
2405 {
2406 v4l2_ctrl_lock(ctrl);
2407 list_del(&sev->node);
2408 v4l2_ctrl_unlock(ctrl);
2409 }
2410 EXPORT_SYMBOL(v4l2_ctrl_del_event);
2411
v4l2_ctrl_log_status(struct file * file,void * fh)2412 int v4l2_ctrl_log_status(struct file *file, void *fh)
2413 {
2414 struct video_device *vfd = video_devdata(file);
2415 struct v4l2_fh *vfh = file->private_data;
2416
2417 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2418 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2419 vfd->v4l2_dev->name);
2420 return 0;
2421 }
2422 EXPORT_SYMBOL(v4l2_ctrl_log_status);
2423
v4l2_ctrl_subscribe_event(struct v4l2_fh * fh,struct v4l2_event_subscription * sub)2424 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2425 struct v4l2_event_subscription *sub)
2426 {
2427 if (sub->type == V4L2_EVENT_CTRL)
2428 return v4l2_event_subscribe(fh, sub, 0);
2429 return -EINVAL;
2430 }
2431 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2432
v4l2_ctrl_poll(struct file * file,struct poll_table_struct * wait)2433 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2434 {
2435 struct v4l2_fh *fh = file->private_data;
2436
2437 if (v4l2_event_pending(fh))
2438 return POLLPRI;
2439 poll_wait(file, &fh->wait, wait);
2440 return 0;
2441 }
2442 EXPORT_SYMBOL(v4l2_ctrl_poll);
2443