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 camera_exposure_metering[] = {
234 		"Average",
235 		"Center Weighted",
236 		"Spot",
237 		"Matrix",
238 		NULL
239 	};
240 	static const char * const camera_auto_focus_range[] = {
241 		"Auto",
242 		"Normal",
243 		"Macro",
244 		"Infinity",
245 		NULL
246 	};
247 	static const char * const colorfx[] = {
248 		"None",
249 		"Black & White",
250 		"Sepia",
251 		"Negative",
252 		"Emboss",
253 		"Sketch",
254 		"Sky Blue",
255 		"Grass Green",
256 		"Skin Whiten",
257 		"Vivid",
258 		"Aqua",
259 		"Art Freeze",
260 		"Silhouette",
261 		"Solarization",
262 		"Antique",
263 		"Set Cb/Cr",
264 		NULL
265 	};
266 	static const char * const auto_n_preset_white_balance[] = {
267 		"Manual",
268 		"Auto",
269 		"Incandescent",
270 		"Fluorescent",
271 		"Fluorescent H",
272 		"Horizon",
273 		"Daylight",
274 		"Flash",
275 		"Cloudy",
276 		"Shade",
277 		NULL,
278 	};
279 	static const char * const camera_iso_sensitivity_auto[] = {
280 		"Manual",
281 		"Auto",
282 		NULL
283 	};
284 	static const char * const scene_mode[] = {
285 		"None",
286 		"Backlight",
287 		"Beach/Snow",
288 		"Candle Light",
289 		"Dusk/Dawn",
290 		"Fall Colors",
291 		"Fireworks",
292 		"Landscape",
293 		"Night",
294 		"Party/Indoor",
295 		"Portrait",
296 		"Sports",
297 		"Sunset",
298 		"Text",
299 		NULL
300 	};
301 	static const char * const tune_emphasis[] = {
302 		"None",
303 		"50 Microseconds",
304 		"75 Microseconds",
305 		NULL,
306 	};
307 	static const char * const header_mode[] = {
308 		"Separate Buffer",
309 		"Joined With 1st Frame",
310 		NULL,
311 	};
312 	static const char * const multi_slice[] = {
313 		"Single",
314 		"Max Macroblocks",
315 		"Max Bytes",
316 		NULL,
317 	};
318 	static const char * const entropy_mode[] = {
319 		"CAVLC",
320 		"CABAC",
321 		NULL,
322 	};
323 	static const char * const mpeg_h264_level[] = {
324 		"1",
325 		"1b",
326 		"1.1",
327 		"1.2",
328 		"1.3",
329 		"2",
330 		"2.1",
331 		"2.2",
332 		"3",
333 		"3.1",
334 		"3.2",
335 		"4",
336 		"4.1",
337 		"4.2",
338 		"5",
339 		"5.1",
340 		NULL,
341 	};
342 	static const char * const h264_loop_filter[] = {
343 		"Enabled",
344 		"Disabled",
345 		"Disabled at Slice Boundary",
346 		NULL,
347 	};
348 	static const char * const h264_profile[] = {
349 		"Baseline",
350 		"Constrained Baseline",
351 		"Main",
352 		"Extended",
353 		"High",
354 		"High 10",
355 		"High 422",
356 		"High 444 Predictive",
357 		"High 10 Intra",
358 		"High 422 Intra",
359 		"High 444 Intra",
360 		"CAVLC 444 Intra",
361 		"Scalable Baseline",
362 		"Scalable High",
363 		"Scalable High Intra",
364 		"Multiview High",
365 		NULL,
366 	};
367 	static const char * const vui_sar_idc[] = {
368 		"Unspecified",
369 		"1:1",
370 		"12:11",
371 		"10:11",
372 		"16:11",
373 		"40:33",
374 		"24:11",
375 		"20:11",
376 		"32:11",
377 		"80:33",
378 		"18:11",
379 		"15:11",
380 		"64:33",
381 		"160:99",
382 		"4:3",
383 		"3:2",
384 		"2:1",
385 		"Extended SAR",
386 		NULL,
387 	};
388 	static const char * const h264_fp_arrangement_type[] = {
389 		"Checkerboard",
390 		"Column",
391 		"Row",
392 		"Side by Side",
393 		"Top Bottom",
394 		"Temporal",
395 		NULL,
396 	};
397 	static const char * const h264_fmo_map_type[] = {
398 		"Interleaved Slices",
399 		"Scattered Slices",
400 		"Foreground with Leftover",
401 		"Box Out",
402 		"Raster Scan",
403 		"Wipe Scan",
404 		"Explicit",
405 		NULL,
406 	};
407 	static const char * const mpeg_mpeg4_level[] = {
408 		"0",
409 		"0b",
410 		"1",
411 		"2",
412 		"3",
413 		"3b",
414 		"4",
415 		"5",
416 		NULL,
417 	};
418 	static const char * const mpeg4_profile[] = {
419 		"Simple",
420 		"Advanced Simple",
421 		"Core",
422 		"Simple Scalable",
423 		"Advanced Coding Efficiency",
424 		NULL,
425 	};
426 
427 	static const char * const vpx_golden_frame_sel[] = {
428 		"Use Previous Frame",
429 		"Use Previous Specific Frame",
430 		NULL,
431 	};
432 
433 	static const char * const flash_led_mode[] = {
434 		"Off",
435 		"Flash",
436 		"Torch",
437 		NULL,
438 	};
439 	static const char * const flash_strobe_source[] = {
440 		"Software",
441 		"External",
442 		NULL,
443 	};
444 
445 	static const char * const jpeg_chroma_subsampling[] = {
446 		"4:4:4",
447 		"4:2:2",
448 		"4:2:0",
449 		"4:1:1",
450 		"4:1:0",
451 		"Gray",
452 		NULL,
453 	};
454 	static const char * const dv_tx_mode[] = {
455 		"DVI-D",
456 		"HDMI",
457 		NULL,
458 	};
459 	static const char * const dv_rgb_range[] = {
460 		"Automatic",
461 		"RGB limited range (16-235)",
462 		"RGB full range (0-255)",
463 		NULL,
464 	};
465 	static const char * const detect_md_mode[] = {
466 		"Disabled",
467 		"Global",
468 		"Threshold Grid",
469 		"Region Grid",
470 		NULL,
471 	};
472 
473 
474 	switch (id) {
475 	case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
476 		return mpeg_audio_sampling_freq;
477 	case V4L2_CID_MPEG_AUDIO_ENCODING:
478 		return mpeg_audio_encoding;
479 	case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
480 		return mpeg_audio_l1_bitrate;
481 	case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
482 		return mpeg_audio_l2_bitrate;
483 	case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
484 		return mpeg_audio_l3_bitrate;
485 	case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
486 		return mpeg_audio_ac3_bitrate;
487 	case V4L2_CID_MPEG_AUDIO_MODE:
488 		return mpeg_audio_mode;
489 	case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
490 		return mpeg_audio_mode_extension;
491 	case V4L2_CID_MPEG_AUDIO_EMPHASIS:
492 		return mpeg_audio_emphasis;
493 	case V4L2_CID_MPEG_AUDIO_CRC:
494 		return mpeg_audio_crc;
495 	case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
496 	case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
497 		return mpeg_audio_dec_playback;
498 	case V4L2_CID_MPEG_VIDEO_ENCODING:
499 		return mpeg_video_encoding;
500 	case V4L2_CID_MPEG_VIDEO_ASPECT:
501 		return mpeg_video_aspect;
502 	case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
503 		return mpeg_video_bitrate_mode;
504 	case V4L2_CID_MPEG_STREAM_TYPE:
505 		return mpeg_stream_type;
506 	case V4L2_CID_MPEG_STREAM_VBI_FMT:
507 		return mpeg_stream_vbi_fmt;
508 	case V4L2_CID_POWER_LINE_FREQUENCY:
509 		return camera_power_line_frequency;
510 	case V4L2_CID_EXPOSURE_AUTO:
511 		return camera_exposure_auto;
512 	case V4L2_CID_EXPOSURE_METERING:
513 		return camera_exposure_metering;
514 	case V4L2_CID_AUTO_FOCUS_RANGE:
515 		return camera_auto_focus_range;
516 	case V4L2_CID_COLORFX:
517 		return colorfx;
518 	case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
519 		return auto_n_preset_white_balance;
520 	case V4L2_CID_ISO_SENSITIVITY_AUTO:
521 		return camera_iso_sensitivity_auto;
522 	case V4L2_CID_SCENE_MODE:
523 		return scene_mode;
524 	case V4L2_CID_TUNE_PREEMPHASIS:
525 		return tune_emphasis;
526 	case V4L2_CID_TUNE_DEEMPHASIS:
527 		return tune_emphasis;
528 	case V4L2_CID_FLASH_LED_MODE:
529 		return flash_led_mode;
530 	case V4L2_CID_FLASH_STROBE_SOURCE:
531 		return flash_strobe_source;
532 	case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
533 		return header_mode;
534 	case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
535 		return multi_slice;
536 	case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
537 		return entropy_mode;
538 	case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
539 		return mpeg_h264_level;
540 	case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
541 		return h264_loop_filter;
542 	case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
543 		return h264_profile;
544 	case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
545 		return vui_sar_idc;
546 	case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
547 		return h264_fp_arrangement_type;
548 	case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
549 		return h264_fmo_map_type;
550 	case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
551 		return mpeg_mpeg4_level;
552 	case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
553 		return mpeg4_profile;
554 	case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
555 		return vpx_golden_frame_sel;
556 	case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
557 		return jpeg_chroma_subsampling;
558 	case V4L2_CID_DV_TX_MODE:
559 		return dv_tx_mode;
560 	case V4L2_CID_DV_TX_RGB_RANGE:
561 	case V4L2_CID_DV_RX_RGB_RANGE:
562 		return dv_rgb_range;
563 	case V4L2_CID_DETECT_MD_MODE:
564 		return detect_md_mode;
565 
566 	default:
567 		return NULL;
568 	}
569 }
570 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
571 
572 #define __v4l2_qmenu_int_len(arr, len) ({ *(len) = ARRAY_SIZE(arr); arr; })
573 /*
574  * Returns NULL or an s64 type array containing the menu for given
575  * control ID. The total number of the menu items is returned in @len.
576  */
v4l2_ctrl_get_int_menu(u32 id,u32 * len)577 const s64 *v4l2_ctrl_get_int_menu(u32 id, u32 *len)
578 {
579 	static const s64 qmenu_int_vpx_num_partitions[] = {
580 		1, 2, 4, 8,
581 	};
582 
583 	static const s64 qmenu_int_vpx_num_ref_frames[] = {
584 		1, 2, 3,
585 	};
586 
587 	switch (id) {
588 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
589 		return __v4l2_qmenu_int_len(qmenu_int_vpx_num_partitions, len);
590 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
591 		return __v4l2_qmenu_int_len(qmenu_int_vpx_num_ref_frames, len);
592 	default:
593 		*len = 0;
594 		return NULL;
595 	}
596 }
597 EXPORT_SYMBOL(v4l2_ctrl_get_int_menu);
598 
599 /* Return the control name. */
v4l2_ctrl_get_name(u32 id)600 const char *v4l2_ctrl_get_name(u32 id)
601 {
602 	switch (id) {
603 	/* USER controls */
604 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
605 	case V4L2_CID_USER_CLASS:		return "User Controls";
606 	case V4L2_CID_BRIGHTNESS:		return "Brightness";
607 	case V4L2_CID_CONTRAST:			return "Contrast";
608 	case V4L2_CID_SATURATION:		return "Saturation";
609 	case V4L2_CID_HUE:			return "Hue";
610 	case V4L2_CID_AUDIO_VOLUME:		return "Volume";
611 	case V4L2_CID_AUDIO_BALANCE:		return "Balance";
612 	case V4L2_CID_AUDIO_BASS:		return "Bass";
613 	case V4L2_CID_AUDIO_TREBLE:		return "Treble";
614 	case V4L2_CID_AUDIO_MUTE:		return "Mute";
615 	case V4L2_CID_AUDIO_LOUDNESS:		return "Loudness";
616 	case V4L2_CID_BLACK_LEVEL:		return "Black Level";
617 	case V4L2_CID_AUTO_WHITE_BALANCE:	return "White Balance, Automatic";
618 	case V4L2_CID_DO_WHITE_BALANCE:		return "Do White Balance";
619 	case V4L2_CID_RED_BALANCE:		return "Red Balance";
620 	case V4L2_CID_BLUE_BALANCE:		return "Blue Balance";
621 	case V4L2_CID_GAMMA:			return "Gamma";
622 	case V4L2_CID_EXPOSURE:			return "Exposure";
623 	case V4L2_CID_AUTOGAIN:			return "Gain, Automatic";
624 	case V4L2_CID_GAIN:			return "Gain";
625 	case V4L2_CID_HFLIP:			return "Horizontal Flip";
626 	case V4L2_CID_VFLIP:			return "Vertical Flip";
627 	case V4L2_CID_POWER_LINE_FREQUENCY:	return "Power Line Frequency";
628 	case V4L2_CID_HUE_AUTO:			return "Hue, Automatic";
629 	case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
630 	case V4L2_CID_SHARPNESS:		return "Sharpness";
631 	case V4L2_CID_BACKLIGHT_COMPENSATION:	return "Backlight Compensation";
632 	case V4L2_CID_CHROMA_AGC:		return "Chroma AGC";
633 	case V4L2_CID_COLOR_KILLER:		return "Color Killer";
634 	case V4L2_CID_COLORFX:			return "Color Effects";
635 	case V4L2_CID_AUTOBRIGHTNESS:		return "Brightness, Automatic";
636 	case V4L2_CID_BAND_STOP_FILTER:		return "Band-Stop Filter";
637 	case V4L2_CID_ROTATE:			return "Rotate";
638 	case V4L2_CID_BG_COLOR:			return "Background Color";
639 	case V4L2_CID_CHROMA_GAIN:		return "Chroma Gain";
640 	case V4L2_CID_ILLUMINATORS_1:		return "Illuminator 1";
641 	case V4L2_CID_ILLUMINATORS_2:		return "Illuminator 2";
642 	case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:	return "Min Number of Capture Buffers";
643 	case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:	return "Min Number of Output Buffers";
644 	case V4L2_CID_ALPHA_COMPONENT:		return "Alpha Component";
645 	case V4L2_CID_COLORFX_CBCR:		return "Color Effects, CbCr";
646 
647 	/* Codec controls */
648 	/* The MPEG controls are applicable to all codec controls
649 	 * and the 'MPEG' part of the define is historical */
650 	/* Keep the order of the 'case's the same as in videodev2.h! */
651 	case V4L2_CID_MPEG_CLASS:		return "Codec Controls";
652 	case V4L2_CID_MPEG_STREAM_TYPE:		return "Stream Type";
653 	case V4L2_CID_MPEG_STREAM_PID_PMT:	return "Stream PMT Program ID";
654 	case V4L2_CID_MPEG_STREAM_PID_AUDIO:	return "Stream Audio Program ID";
655 	case V4L2_CID_MPEG_STREAM_PID_VIDEO:	return "Stream Video Program ID";
656 	case V4L2_CID_MPEG_STREAM_PID_PCR:	return "Stream PCR Program ID";
657 	case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
658 	case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
659 	case V4L2_CID_MPEG_STREAM_VBI_FMT:	return "Stream VBI Format";
660 	case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
661 	case V4L2_CID_MPEG_AUDIO_ENCODING:	return "Audio Encoding";
662 	case V4L2_CID_MPEG_AUDIO_L1_BITRATE:	return "Audio Layer I Bitrate";
663 	case V4L2_CID_MPEG_AUDIO_L2_BITRATE:	return "Audio Layer II Bitrate";
664 	case V4L2_CID_MPEG_AUDIO_L3_BITRATE:	return "Audio Layer III Bitrate";
665 	case V4L2_CID_MPEG_AUDIO_MODE:		return "Audio Stereo Mode";
666 	case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
667 	case V4L2_CID_MPEG_AUDIO_EMPHASIS:	return "Audio Emphasis";
668 	case V4L2_CID_MPEG_AUDIO_CRC:		return "Audio CRC";
669 	case V4L2_CID_MPEG_AUDIO_MUTE:		return "Audio Mute";
670 	case V4L2_CID_MPEG_AUDIO_AAC_BITRATE:	return "Audio AAC Bitrate";
671 	case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:	return "Audio AC-3 Bitrate";
672 	case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:	return "Audio Playback";
673 	case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
674 	case V4L2_CID_MPEG_VIDEO_ENCODING:	return "Video Encoding";
675 	case V4L2_CID_MPEG_VIDEO_ASPECT:	return "Video Aspect";
676 	case V4L2_CID_MPEG_VIDEO_B_FRAMES:	return "Video B Frames";
677 	case V4L2_CID_MPEG_VIDEO_GOP_SIZE:	return "Video GOP Size";
678 	case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:	return "Video GOP Closure";
679 	case V4L2_CID_MPEG_VIDEO_PULLDOWN:	return "Video Pulldown";
680 	case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:	return "Video Bitrate Mode";
681 	case V4L2_CID_MPEG_VIDEO_BITRATE:	return "Video Bitrate";
682 	case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK:	return "Video Peak Bitrate";
683 	case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
684 	case V4L2_CID_MPEG_VIDEO_MUTE:		return "Video Mute";
685 	case V4L2_CID_MPEG_VIDEO_MUTE_YUV:	return "Video Mute YUV";
686 	case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:	return "Decoder Slice Interface";
687 	case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:	return "MPEG4 Loop Filter Enable";
688 	case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB:	return "Number of Intra Refresh MBs";
689 	case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:		return "Frame Level Rate Control Enable";
690 	case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:			return "H264 MB Level Rate Control";
691 	case V4L2_CID_MPEG_VIDEO_HEADER_MODE:			return "Sequence Header Mode";
692 	case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC:			return "Max Number of Reference Pics";
693 	case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP:		return "H263 I-Frame QP Value";
694 	case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP:		return "H263 P-Frame QP Value";
695 	case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP:		return "H263 B-Frame QP Value";
696 	case V4L2_CID_MPEG_VIDEO_H263_MIN_QP:			return "H263 Minimum QP Value";
697 	case V4L2_CID_MPEG_VIDEO_H263_MAX_QP:			return "H263 Maximum QP Value";
698 	case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP:		return "H264 I-Frame QP Value";
699 	case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP:		return "H264 P-Frame QP Value";
700 	case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP:		return "H264 B-Frame QP Value";
701 	case V4L2_CID_MPEG_VIDEO_H264_MAX_QP:			return "H264 Maximum QP Value";
702 	case V4L2_CID_MPEG_VIDEO_H264_MIN_QP:			return "H264 Minimum QP Value";
703 	case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:		return "H264 8x8 Transform Enable";
704 	case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE:			return "H264 CPB Buffer Size";
705 	case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:		return "H264 Entropy Mode";
706 	case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD:			return "H264 I-Frame Period";
707 	case V4L2_CID_MPEG_VIDEO_H264_LEVEL:			return "H264 Level";
708 	case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA:	return "H264 Loop Filter Alpha Offset";
709 	case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA:		return "H264 Loop Filter Beta Offset";
710 	case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:		return "H264 Loop Filter Mode";
711 	case V4L2_CID_MPEG_VIDEO_H264_PROFILE:			return "H264 Profile";
712 	case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT:	return "Vertical Size of SAR";
713 	case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH:	return "Horizontal Size of SAR";
714 	case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:		return "Aspect Ratio VUI Enable";
715 	case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:		return "VUI Aspect Ratio IDC";
716 	case V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING:	return "H264 Enable Frame Packing SEI";
717 	case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0:	return "H264 Set Curr. Frame as Frame0";
718 	case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:	return "H264 FP Arrangement Type";
719 	case V4L2_CID_MPEG_VIDEO_H264_FMO:			return "H264 Flexible MB Ordering";
720 	case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:		return "H264 Map Type for FMO";
721 	case V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP:		return "H264 FMO Number of Slice Groups";
722 	case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION:	return "H264 FMO Direction of Change";
723 	case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE:		return "H264 FMO Size of 1st Slice Grp";
724 	case V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH:		return "H264 FMO No. of Consecutive MBs";
725 	case V4L2_CID_MPEG_VIDEO_H264_ASO:			return "H264 Arbitrary Slice Ordering";
726 	case V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER:		return "H264 ASO Slice Order";
727 	case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING:	return "Enable H264 Hierarchical Coding";
728 	case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE:	return "H264 Hierarchical Coding Type";
729 	case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER:return "H264 Number of HC Layers";
730 	case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP:
731 								return "H264 Set QP Value for HC Layers";
732 	case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP:		return "MPEG4 I-Frame QP Value";
733 	case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP:		return "MPEG4 P-Frame QP Value";
734 	case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP:		return "MPEG4 B-Frame QP Value";
735 	case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP:			return "MPEG4 Minimum QP Value";
736 	case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP:			return "MPEG4 Maximum QP Value";
737 	case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:			return "MPEG4 Level";
738 	case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:			return "MPEG4 Profile";
739 	case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:			return "Quarter Pixel Search Enable";
740 	case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES:		return "Maximum Bytes in a Slice";
741 	case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB:		return "Number of MBs in a Slice";
742 	case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:		return "Slice Partitioning Method";
743 	case V4L2_CID_MPEG_VIDEO_VBV_SIZE:			return "VBV Buffer Size";
744 	case V4L2_CID_MPEG_VIDEO_DEC_PTS:			return "Video Decoder PTS";
745 	case V4L2_CID_MPEG_VIDEO_DEC_FRAME:			return "Video Decoder Frame Count";
746 	case V4L2_CID_MPEG_VIDEO_VBV_DELAY:			return "Initial Delay for VBV Control";
747 	case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE:		return "Horizontal MV Search Range";
748 	case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:		return "Vertical MV Search Range";
749 	case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:		return "Repeat Sequence Header";
750 
751 	/* VPX controls */
752 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:		return "VPX Number of Partitions";
753 	case V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4:		return "VPX Intra Mode Decision Disable";
754 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:		return "VPX No. of Refs for P Frame";
755 	case V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL:		return "VPX Loop Filter Level Range";
756 	case V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS:		return "VPX Deblocking Effect Control";
757 	case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD:	return "VPX Golden Frame Refresh Period";
758 	case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:		return "VPX Golden Frame Indicator";
759 	case V4L2_CID_MPEG_VIDEO_VPX_MIN_QP:			return "VPX Minimum QP Value";
760 	case V4L2_CID_MPEG_VIDEO_VPX_MAX_QP:			return "VPX Maximum QP Value";
761 	case V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP:		return "VPX I-Frame QP Value";
762 	case V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP:		return "VPX P-Frame QP Value";
763 	case V4L2_CID_MPEG_VIDEO_VPX_PROFILE:			return "VPX Profile";
764 
765 	/* CAMERA controls */
766 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
767 	case V4L2_CID_CAMERA_CLASS:		return "Camera Controls";
768 	case V4L2_CID_EXPOSURE_AUTO:		return "Auto Exposure";
769 	case V4L2_CID_EXPOSURE_ABSOLUTE:	return "Exposure Time, Absolute";
770 	case V4L2_CID_EXPOSURE_AUTO_PRIORITY:	return "Exposure, Dynamic Framerate";
771 	case V4L2_CID_PAN_RELATIVE:		return "Pan, Relative";
772 	case V4L2_CID_TILT_RELATIVE:		return "Tilt, Relative";
773 	case V4L2_CID_PAN_RESET:		return "Pan, Reset";
774 	case V4L2_CID_TILT_RESET:		return "Tilt, Reset";
775 	case V4L2_CID_PAN_ABSOLUTE:		return "Pan, Absolute";
776 	case V4L2_CID_TILT_ABSOLUTE:		return "Tilt, Absolute";
777 	case V4L2_CID_FOCUS_ABSOLUTE:		return "Focus, Absolute";
778 	case V4L2_CID_FOCUS_RELATIVE:		return "Focus, Relative";
779 	case V4L2_CID_FOCUS_AUTO:		return "Focus, Automatic Continuous";
780 	case V4L2_CID_ZOOM_ABSOLUTE:		return "Zoom, Absolute";
781 	case V4L2_CID_ZOOM_RELATIVE:		return "Zoom, Relative";
782 	case V4L2_CID_ZOOM_CONTINUOUS:		return "Zoom, Continuous";
783 	case V4L2_CID_PRIVACY:			return "Privacy";
784 	case V4L2_CID_IRIS_ABSOLUTE:		return "Iris, Absolute";
785 	case V4L2_CID_IRIS_RELATIVE:		return "Iris, Relative";
786 	case V4L2_CID_AUTO_EXPOSURE_BIAS:	return "Auto Exposure, Bias";
787 	case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
788 	case V4L2_CID_WIDE_DYNAMIC_RANGE:	return "Wide Dynamic Range";
789 	case V4L2_CID_IMAGE_STABILIZATION:	return "Image Stabilization";
790 	case V4L2_CID_ISO_SENSITIVITY:		return "ISO Sensitivity";
791 	case V4L2_CID_ISO_SENSITIVITY_AUTO:	return "ISO Sensitivity, Auto";
792 	case V4L2_CID_EXPOSURE_METERING:	return "Exposure, Metering Mode";
793 	case V4L2_CID_SCENE_MODE:		return "Scene Mode";
794 	case V4L2_CID_3A_LOCK:			return "3A Lock";
795 	case V4L2_CID_AUTO_FOCUS_START:		return "Auto Focus, Start";
796 	case V4L2_CID_AUTO_FOCUS_STOP:		return "Auto Focus, Stop";
797 	case V4L2_CID_AUTO_FOCUS_STATUS:	return "Auto Focus, Status";
798 	case V4L2_CID_AUTO_FOCUS_RANGE:		return "Auto Focus, Range";
799 	case V4L2_CID_PAN_SPEED:		return "Pan, Speed";
800 	case V4L2_CID_TILT_SPEED:		return "Tilt, Speed";
801 
802 	/* FM Radio Modulator controls */
803 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
804 	case V4L2_CID_FM_TX_CLASS:		return "FM Radio Modulator Controls";
805 	case V4L2_CID_RDS_TX_DEVIATION:		return "RDS Signal Deviation";
806 	case V4L2_CID_RDS_TX_PI:		return "RDS Program ID";
807 	case V4L2_CID_RDS_TX_PTY:		return "RDS Program Type";
808 	case V4L2_CID_RDS_TX_PS_NAME:		return "RDS PS Name";
809 	case V4L2_CID_RDS_TX_RADIO_TEXT:	return "RDS Radio Text";
810 	case V4L2_CID_RDS_TX_MONO_STEREO:	return "RDS Stereo";
811 	case V4L2_CID_RDS_TX_ARTIFICIAL_HEAD:	return "RDS Artificial Head";
812 	case V4L2_CID_RDS_TX_COMPRESSED:	return "RDS Compressed";
813 	case V4L2_CID_RDS_TX_DYNAMIC_PTY:	return "RDS Dynamic PTY";
814 	case V4L2_CID_RDS_TX_TRAFFIC_ANNOUNCEMENT: return "RDS Traffic Announcement";
815 	case V4L2_CID_RDS_TX_TRAFFIC_PROGRAM:	return "RDS Traffic Program";
816 	case V4L2_CID_RDS_TX_MUSIC_SPEECH:	return "RDS Music";
817 	case V4L2_CID_RDS_TX_ALT_FREQS_ENABLE:	return "RDS Enable Alt Frequencies";
818 	case V4L2_CID_RDS_TX_ALT_FREQS:		return "RDS Alternate Frequencies";
819 	case V4L2_CID_AUDIO_LIMITER_ENABLED:	return "Audio Limiter Feature Enabled";
820 	case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
821 	case V4L2_CID_AUDIO_LIMITER_DEVIATION:	return "Audio Limiter Deviation";
822 	case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
823 	case V4L2_CID_AUDIO_COMPRESSION_GAIN:	return "Audio Compression Gain";
824 	case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
825 	case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
826 	case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
827 	case V4L2_CID_PILOT_TONE_ENABLED:	return "Pilot Tone Feature Enabled";
828 	case V4L2_CID_PILOT_TONE_DEVIATION:	return "Pilot Tone Deviation";
829 	case V4L2_CID_PILOT_TONE_FREQUENCY:	return "Pilot Tone Frequency";
830 	case V4L2_CID_TUNE_PREEMPHASIS:		return "Pre-Emphasis";
831 	case V4L2_CID_TUNE_POWER_LEVEL:		return "Tune Power Level";
832 	case V4L2_CID_TUNE_ANTENNA_CAPACITOR:	return "Tune Antenna Capacitor";
833 
834 	/* Flash controls */
835 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
836 	case V4L2_CID_FLASH_CLASS:		return "Flash Controls";
837 	case V4L2_CID_FLASH_LED_MODE:		return "LED Mode";
838 	case V4L2_CID_FLASH_STROBE_SOURCE:	return "Strobe Source";
839 	case V4L2_CID_FLASH_STROBE:		return "Strobe";
840 	case V4L2_CID_FLASH_STROBE_STOP:	return "Stop Strobe";
841 	case V4L2_CID_FLASH_STROBE_STATUS:	return "Strobe Status";
842 	case V4L2_CID_FLASH_TIMEOUT:		return "Strobe Timeout";
843 	case V4L2_CID_FLASH_INTENSITY:		return "Intensity, Flash Mode";
844 	case V4L2_CID_FLASH_TORCH_INTENSITY:	return "Intensity, Torch Mode";
845 	case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
846 	case V4L2_CID_FLASH_FAULT:		return "Faults";
847 	case V4L2_CID_FLASH_CHARGE:		return "Charge";
848 	case V4L2_CID_FLASH_READY:		return "Ready to Strobe";
849 
850 	/* JPEG encoder controls */
851 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
852 	case V4L2_CID_JPEG_CLASS:		return "JPEG Compression Controls";
853 	case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:	return "Chroma Subsampling";
854 	case V4L2_CID_JPEG_RESTART_INTERVAL:	return "Restart Interval";
855 	case V4L2_CID_JPEG_COMPRESSION_QUALITY:	return "Compression Quality";
856 	case V4L2_CID_JPEG_ACTIVE_MARKER:	return "Active Markers";
857 
858 	/* Image source controls */
859 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
860 	case V4L2_CID_IMAGE_SOURCE_CLASS:	return "Image Source Controls";
861 	case V4L2_CID_VBLANK:			return "Vertical Blanking";
862 	case V4L2_CID_HBLANK:			return "Horizontal Blanking";
863 	case V4L2_CID_ANALOGUE_GAIN:		return "Analogue Gain";
864 	case V4L2_CID_TEST_PATTERN_RED:		return "Red Pixel Value";
865 	case V4L2_CID_TEST_PATTERN_GREENR:	return "Green (Red) Pixel Value";
866 	case V4L2_CID_TEST_PATTERN_BLUE:	return "Blue Pixel Value";
867 	case V4L2_CID_TEST_PATTERN_GREENB:	return "Green (Blue) Pixel Value";
868 
869 	/* Image processing controls */
870 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
871 	case V4L2_CID_IMAGE_PROC_CLASS:		return "Image Processing Controls";
872 	case V4L2_CID_LINK_FREQ:		return "Link Frequency";
873 	case V4L2_CID_PIXEL_RATE:		return "Pixel Rate";
874 	case V4L2_CID_TEST_PATTERN:		return "Test Pattern";
875 
876 	/* DV controls */
877 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
878 	case V4L2_CID_DV_CLASS:			return "Digital Video Controls";
879 	case V4L2_CID_DV_TX_HOTPLUG:		return "Hotplug Present";
880 	case V4L2_CID_DV_TX_RXSENSE:		return "RxSense Present";
881 	case V4L2_CID_DV_TX_EDID_PRESENT:	return "EDID Present";
882 	case V4L2_CID_DV_TX_MODE:		return "Transmit Mode";
883 	case V4L2_CID_DV_TX_RGB_RANGE:		return "Tx RGB Quantization Range";
884 	case V4L2_CID_DV_RX_POWER_PRESENT:	return "Power Present";
885 	case V4L2_CID_DV_RX_RGB_RANGE:		return "Rx RGB Quantization Range";
886 
887 	case V4L2_CID_FM_RX_CLASS:		return "FM Radio Receiver Controls";
888 	case V4L2_CID_TUNE_DEEMPHASIS:		return "De-Emphasis";
889 	case V4L2_CID_RDS_RECEPTION:		return "RDS Reception";
890 	case V4L2_CID_RF_TUNER_CLASS:		return "RF Tuner Controls";
891 	case V4L2_CID_RF_TUNER_RF_GAIN:		return "RF Gain";
892 	case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:	return "LNA Gain, Auto";
893 	case V4L2_CID_RF_TUNER_LNA_GAIN:	return "LNA Gain";
894 	case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO:	return "Mixer Gain, Auto";
895 	case V4L2_CID_RF_TUNER_MIXER_GAIN:	return "Mixer Gain";
896 	case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:	return "IF Gain, Auto";
897 	case V4L2_CID_RF_TUNER_IF_GAIN:		return "IF Gain";
898 	case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:	return "Bandwidth, Auto";
899 	case V4L2_CID_RF_TUNER_BANDWIDTH:	return "Bandwidth";
900 	case V4L2_CID_RF_TUNER_PLL_LOCK:	return "PLL Lock";
901 	case V4L2_CID_RDS_RX_PTY:		return "RDS Program Type";
902 	case V4L2_CID_RDS_RX_PS_NAME:		return "RDS PS Name";
903 	case V4L2_CID_RDS_RX_RADIO_TEXT:	return "RDS Radio Text";
904 	case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT: return "RDS Traffic Announcement";
905 	case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM:	return "RDS Traffic Program";
906 	case V4L2_CID_RDS_RX_MUSIC_SPEECH:	return "RDS Music";
907 
908 	/* Detection controls */
909 	/* Keep the order of the 'case's the same as in v4l2-controls.h! */
910 	case V4L2_CID_DETECT_CLASS:		return "Detection Controls";
911 	case V4L2_CID_DETECT_MD_MODE:		return "Motion Detection Mode";
912 	case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD: return "MD Global Threshold";
913 	case V4L2_CID_DETECT_MD_THRESHOLD_GRID:	return "MD Threshold Grid";
914 	case V4L2_CID_DETECT_MD_REGION_GRID:	return "MD Region Grid";
915 	default:
916 		return NULL;
917 	}
918 }
919 EXPORT_SYMBOL(v4l2_ctrl_get_name);
920 
v4l2_ctrl_fill(u32 id,const char ** name,enum v4l2_ctrl_type * type,s64 * min,s64 * max,u64 * step,s64 * def,u32 * flags)921 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
922 		    s64 *min, s64 *max, u64 *step, s64 *def, u32 *flags)
923 {
924 	*name = v4l2_ctrl_get_name(id);
925 	*flags = 0;
926 
927 	switch (id) {
928 	case V4L2_CID_AUDIO_MUTE:
929 	case V4L2_CID_AUDIO_LOUDNESS:
930 	case V4L2_CID_AUTO_WHITE_BALANCE:
931 	case V4L2_CID_AUTOGAIN:
932 	case V4L2_CID_HFLIP:
933 	case V4L2_CID_VFLIP:
934 	case V4L2_CID_HUE_AUTO:
935 	case V4L2_CID_CHROMA_AGC:
936 	case V4L2_CID_COLOR_KILLER:
937 	case V4L2_CID_AUTOBRIGHTNESS:
938 	case V4L2_CID_MPEG_AUDIO_MUTE:
939 	case V4L2_CID_MPEG_VIDEO_MUTE:
940 	case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
941 	case V4L2_CID_MPEG_VIDEO_PULLDOWN:
942 	case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
943 	case V4L2_CID_FOCUS_AUTO:
944 	case V4L2_CID_PRIVACY:
945 	case V4L2_CID_AUDIO_LIMITER_ENABLED:
946 	case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
947 	case V4L2_CID_PILOT_TONE_ENABLED:
948 	case V4L2_CID_ILLUMINATORS_1:
949 	case V4L2_CID_ILLUMINATORS_2:
950 	case V4L2_CID_FLASH_STROBE_STATUS:
951 	case V4L2_CID_FLASH_CHARGE:
952 	case V4L2_CID_FLASH_READY:
953 	case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
954 	case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
955 	case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
956 	case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
957 	case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
958 	case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
959 	case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
960 	case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:
961 	case V4L2_CID_WIDE_DYNAMIC_RANGE:
962 	case V4L2_CID_IMAGE_STABILIZATION:
963 	case V4L2_CID_RDS_RECEPTION:
964 	case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:
965 	case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO:
966 	case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:
967 	case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:
968 	case V4L2_CID_RF_TUNER_PLL_LOCK:
969 	case V4L2_CID_RDS_TX_MONO_STEREO:
970 	case V4L2_CID_RDS_TX_ARTIFICIAL_HEAD:
971 	case V4L2_CID_RDS_TX_COMPRESSED:
972 	case V4L2_CID_RDS_TX_DYNAMIC_PTY:
973 	case V4L2_CID_RDS_TX_TRAFFIC_ANNOUNCEMENT:
974 	case V4L2_CID_RDS_TX_TRAFFIC_PROGRAM:
975 	case V4L2_CID_RDS_TX_MUSIC_SPEECH:
976 	case V4L2_CID_RDS_TX_ALT_FREQS_ENABLE:
977 	case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT:
978 	case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM:
979 	case V4L2_CID_RDS_RX_MUSIC_SPEECH:
980 		*type = V4L2_CTRL_TYPE_BOOLEAN;
981 		*min = 0;
982 		*max = *step = 1;
983 		break;
984 	case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE:
985 	case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:
986 		*type = V4L2_CTRL_TYPE_INTEGER;
987 		break;
988 	case V4L2_CID_PAN_RESET:
989 	case V4L2_CID_TILT_RESET:
990 	case V4L2_CID_FLASH_STROBE:
991 	case V4L2_CID_FLASH_STROBE_STOP:
992 	case V4L2_CID_AUTO_FOCUS_START:
993 	case V4L2_CID_AUTO_FOCUS_STOP:
994 		*type = V4L2_CTRL_TYPE_BUTTON;
995 		*flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
996 			  V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
997 		*min = *max = *step = *def = 0;
998 		break;
999 	case V4L2_CID_POWER_LINE_FREQUENCY:
1000 	case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
1001 	case V4L2_CID_MPEG_AUDIO_ENCODING:
1002 	case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
1003 	case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
1004 	case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
1005 	case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
1006 	case V4L2_CID_MPEG_AUDIO_MODE:
1007 	case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
1008 	case V4L2_CID_MPEG_AUDIO_EMPHASIS:
1009 	case V4L2_CID_MPEG_AUDIO_CRC:
1010 	case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
1011 	case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
1012 	case V4L2_CID_MPEG_VIDEO_ENCODING:
1013 	case V4L2_CID_MPEG_VIDEO_ASPECT:
1014 	case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1015 	case V4L2_CID_MPEG_STREAM_TYPE:
1016 	case V4L2_CID_MPEG_STREAM_VBI_FMT:
1017 	case V4L2_CID_EXPOSURE_AUTO:
1018 	case V4L2_CID_AUTO_FOCUS_RANGE:
1019 	case V4L2_CID_COLORFX:
1020 	case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
1021 	case V4L2_CID_TUNE_PREEMPHASIS:
1022 	case V4L2_CID_FLASH_LED_MODE:
1023 	case V4L2_CID_FLASH_STROBE_SOURCE:
1024 	case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
1025 	case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
1026 	case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
1027 	case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
1028 	case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
1029 	case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
1030 	case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
1031 	case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
1032 	case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
1033 	case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
1034 	case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
1035 	case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
1036 	case V4L2_CID_ISO_SENSITIVITY_AUTO:
1037 	case V4L2_CID_EXPOSURE_METERING:
1038 	case V4L2_CID_SCENE_MODE:
1039 	case V4L2_CID_DV_TX_MODE:
1040 	case V4L2_CID_DV_TX_RGB_RANGE:
1041 	case V4L2_CID_DV_RX_RGB_RANGE:
1042 	case V4L2_CID_TEST_PATTERN:
1043 	case V4L2_CID_TUNE_DEEMPHASIS:
1044 	case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
1045 	case V4L2_CID_DETECT_MD_MODE:
1046 		*type = V4L2_CTRL_TYPE_MENU;
1047 		break;
1048 	case V4L2_CID_LINK_FREQ:
1049 		*type = V4L2_CTRL_TYPE_INTEGER_MENU;
1050 		break;
1051 	case V4L2_CID_RDS_TX_PS_NAME:
1052 	case V4L2_CID_RDS_TX_RADIO_TEXT:
1053 	case V4L2_CID_RDS_RX_PS_NAME:
1054 	case V4L2_CID_RDS_RX_RADIO_TEXT:
1055 		*type = V4L2_CTRL_TYPE_STRING;
1056 		break;
1057 	case V4L2_CID_ISO_SENSITIVITY:
1058 	case V4L2_CID_AUTO_EXPOSURE_BIAS:
1059 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
1060 	case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
1061 		*type = V4L2_CTRL_TYPE_INTEGER_MENU;
1062 		break;
1063 	case V4L2_CID_USER_CLASS:
1064 	case V4L2_CID_CAMERA_CLASS:
1065 	case V4L2_CID_MPEG_CLASS:
1066 	case V4L2_CID_FM_TX_CLASS:
1067 	case V4L2_CID_FLASH_CLASS:
1068 	case V4L2_CID_JPEG_CLASS:
1069 	case V4L2_CID_IMAGE_SOURCE_CLASS:
1070 	case V4L2_CID_IMAGE_PROC_CLASS:
1071 	case V4L2_CID_DV_CLASS:
1072 	case V4L2_CID_FM_RX_CLASS:
1073 	case V4L2_CID_RF_TUNER_CLASS:
1074 	case V4L2_CID_DETECT_CLASS:
1075 		*type = V4L2_CTRL_TYPE_CTRL_CLASS;
1076 		/* You can neither read not write these */
1077 		*flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
1078 		*min = *max = *step = *def = 0;
1079 		break;
1080 	case V4L2_CID_BG_COLOR:
1081 		*type = V4L2_CTRL_TYPE_INTEGER;
1082 		*step = 1;
1083 		*min = 0;
1084 		/* Max is calculated as RGB888 that is 2^24 */
1085 		*max = 0xFFFFFF;
1086 		break;
1087 	case V4L2_CID_FLASH_FAULT:
1088 	case V4L2_CID_JPEG_ACTIVE_MARKER:
1089 	case V4L2_CID_3A_LOCK:
1090 	case V4L2_CID_AUTO_FOCUS_STATUS:
1091 	case V4L2_CID_DV_TX_HOTPLUG:
1092 	case V4L2_CID_DV_TX_RXSENSE:
1093 	case V4L2_CID_DV_TX_EDID_PRESENT:
1094 	case V4L2_CID_DV_RX_POWER_PRESENT:
1095 		*type = V4L2_CTRL_TYPE_BITMASK;
1096 		break;
1097 	case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
1098 	case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
1099 		*type = V4L2_CTRL_TYPE_INTEGER;
1100 		*flags |= V4L2_CTRL_FLAG_READ_ONLY;
1101 		break;
1102 	case V4L2_CID_MPEG_VIDEO_DEC_PTS:
1103 		*type = V4L2_CTRL_TYPE_INTEGER64;
1104 		*flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1105 		*min = *def = 0;
1106 		*max = 0x1ffffffffLL;
1107 		*step = 1;
1108 		break;
1109 	case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
1110 		*type = V4L2_CTRL_TYPE_INTEGER64;
1111 		*flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1112 		*min = *def = 0;
1113 		*max = 0x7fffffffffffffffLL;
1114 		*step = 1;
1115 		break;
1116 	case V4L2_CID_PIXEL_RATE:
1117 		*type = V4L2_CTRL_TYPE_INTEGER64;
1118 		*flags |= V4L2_CTRL_FLAG_READ_ONLY;
1119 		break;
1120 	case V4L2_CID_DETECT_MD_REGION_GRID:
1121 		*type = V4L2_CTRL_TYPE_U8;
1122 		break;
1123 	case V4L2_CID_DETECT_MD_THRESHOLD_GRID:
1124 		*type = V4L2_CTRL_TYPE_U16;
1125 		break;
1126 	case V4L2_CID_RDS_TX_ALT_FREQS:
1127 		*type = V4L2_CTRL_TYPE_U32;
1128 		break;
1129 	default:
1130 		*type = V4L2_CTRL_TYPE_INTEGER;
1131 		break;
1132 	}
1133 	switch (id) {
1134 	case V4L2_CID_MPEG_AUDIO_ENCODING:
1135 	case V4L2_CID_MPEG_AUDIO_MODE:
1136 	case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1137 	case V4L2_CID_MPEG_VIDEO_B_FRAMES:
1138 	case V4L2_CID_MPEG_STREAM_TYPE:
1139 		*flags |= V4L2_CTRL_FLAG_UPDATE;
1140 		break;
1141 	case V4L2_CID_AUDIO_VOLUME:
1142 	case V4L2_CID_AUDIO_BALANCE:
1143 	case V4L2_CID_AUDIO_BASS:
1144 	case V4L2_CID_AUDIO_TREBLE:
1145 	case V4L2_CID_BRIGHTNESS:
1146 	case V4L2_CID_CONTRAST:
1147 	case V4L2_CID_SATURATION:
1148 	case V4L2_CID_HUE:
1149 	case V4L2_CID_RED_BALANCE:
1150 	case V4L2_CID_BLUE_BALANCE:
1151 	case V4L2_CID_GAMMA:
1152 	case V4L2_CID_SHARPNESS:
1153 	case V4L2_CID_CHROMA_GAIN:
1154 	case V4L2_CID_RDS_TX_DEVIATION:
1155 	case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
1156 	case V4L2_CID_AUDIO_LIMITER_DEVIATION:
1157 	case V4L2_CID_AUDIO_COMPRESSION_GAIN:
1158 	case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
1159 	case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
1160 	case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
1161 	case V4L2_CID_PILOT_TONE_DEVIATION:
1162 	case V4L2_CID_PILOT_TONE_FREQUENCY:
1163 	case V4L2_CID_TUNE_POWER_LEVEL:
1164 	case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
1165 	case V4L2_CID_RF_TUNER_RF_GAIN:
1166 	case V4L2_CID_RF_TUNER_LNA_GAIN:
1167 	case V4L2_CID_RF_TUNER_MIXER_GAIN:
1168 	case V4L2_CID_RF_TUNER_IF_GAIN:
1169 	case V4L2_CID_RF_TUNER_BANDWIDTH:
1170 	case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD:
1171 		*flags |= V4L2_CTRL_FLAG_SLIDER;
1172 		break;
1173 	case V4L2_CID_PAN_RELATIVE:
1174 	case V4L2_CID_TILT_RELATIVE:
1175 	case V4L2_CID_FOCUS_RELATIVE:
1176 	case V4L2_CID_IRIS_RELATIVE:
1177 	case V4L2_CID_ZOOM_RELATIVE:
1178 		*flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
1179 			  V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
1180 		break;
1181 	case V4L2_CID_FLASH_STROBE_STATUS:
1182 	case V4L2_CID_AUTO_FOCUS_STATUS:
1183 	case V4L2_CID_FLASH_READY:
1184 	case V4L2_CID_DV_TX_HOTPLUG:
1185 	case V4L2_CID_DV_TX_RXSENSE:
1186 	case V4L2_CID_DV_TX_EDID_PRESENT:
1187 	case V4L2_CID_DV_RX_POWER_PRESENT:
1188 	case V4L2_CID_RDS_RX_PTY:
1189 	case V4L2_CID_RDS_RX_PS_NAME:
1190 	case V4L2_CID_RDS_RX_RADIO_TEXT:
1191 	case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT:
1192 	case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM:
1193 	case V4L2_CID_RDS_RX_MUSIC_SPEECH:
1194 		*flags |= V4L2_CTRL_FLAG_READ_ONLY;
1195 		break;
1196 	case V4L2_CID_RF_TUNER_PLL_LOCK:
1197 		*flags |= V4L2_CTRL_FLAG_VOLATILE;
1198 		break;
1199 	}
1200 }
1201 EXPORT_SYMBOL(v4l2_ctrl_fill);
1202 
fill_event(struct v4l2_event * ev,struct v4l2_ctrl * ctrl,u32 changes)1203 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
1204 {
1205 	memset(ev->reserved, 0, sizeof(ev->reserved));
1206 	ev->type = V4L2_EVENT_CTRL;
1207 	ev->id = ctrl->id;
1208 	ev->u.ctrl.changes = changes;
1209 	ev->u.ctrl.type = ctrl->type;
1210 	ev->u.ctrl.flags = ctrl->flags;
1211 	if (ctrl->is_ptr)
1212 		ev->u.ctrl.value64 = 0;
1213 	else
1214 		ev->u.ctrl.value64 = *ctrl->p_cur.p_s64;
1215 	ev->u.ctrl.minimum = ctrl->minimum;
1216 	ev->u.ctrl.maximum = ctrl->maximum;
1217 	if (ctrl->type == V4L2_CTRL_TYPE_MENU
1218 	    || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1219 		ev->u.ctrl.step = 1;
1220 	else
1221 		ev->u.ctrl.step = ctrl->step;
1222 	ev->u.ctrl.default_value = ctrl->default_value;
1223 }
1224 
send_event(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,u32 changes)1225 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1226 {
1227 	struct v4l2_event ev;
1228 	struct v4l2_subscribed_event *sev;
1229 
1230 	if (list_empty(&ctrl->ev_subs))
1231 		return;
1232 	fill_event(&ev, ctrl, changes);
1233 
1234 	list_for_each_entry(sev, &ctrl->ev_subs, node)
1235 		if (sev->fh != fh ||
1236 		    (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
1237 			v4l2_event_queue_fh(sev->fh, &ev);
1238 }
1239 
std_equal(const struct v4l2_ctrl * ctrl,u32 idx,union v4l2_ctrl_ptr ptr1,union v4l2_ctrl_ptr ptr2)1240 static bool std_equal(const struct v4l2_ctrl *ctrl, u32 idx,
1241 		      union v4l2_ctrl_ptr ptr1,
1242 		      union v4l2_ctrl_ptr ptr2)
1243 {
1244 	switch (ctrl->type) {
1245 	case V4L2_CTRL_TYPE_BUTTON:
1246 		return false;
1247 	case V4L2_CTRL_TYPE_STRING:
1248 		idx *= ctrl->elem_size;
1249 		/* strings are always 0-terminated */
1250 		return !strcmp(ptr1.p_char + idx, ptr2.p_char + idx);
1251 	case V4L2_CTRL_TYPE_INTEGER64:
1252 		return ptr1.p_s64[idx] == ptr2.p_s64[idx];
1253 	case V4L2_CTRL_TYPE_U8:
1254 		return ptr1.p_u8[idx] == ptr2.p_u8[idx];
1255 	case V4L2_CTRL_TYPE_U16:
1256 		return ptr1.p_u16[idx] == ptr2.p_u16[idx];
1257 	case V4L2_CTRL_TYPE_U32:
1258 		return ptr1.p_u32[idx] == ptr2.p_u32[idx];
1259 	default:
1260 		if (ctrl->is_int)
1261 			return ptr1.p_s32[idx] == ptr2.p_s32[idx];
1262 		idx *= ctrl->elem_size;
1263 		return !memcmp(ptr1.p + idx, ptr2.p + idx, ctrl->elem_size);
1264 	}
1265 }
1266 
std_init(const struct v4l2_ctrl * ctrl,u32 idx,union v4l2_ctrl_ptr ptr)1267 static void std_init(const struct v4l2_ctrl *ctrl, u32 idx,
1268 		     union v4l2_ctrl_ptr ptr)
1269 {
1270 	switch (ctrl->type) {
1271 	case V4L2_CTRL_TYPE_STRING:
1272 		idx *= ctrl->elem_size;
1273 		memset(ptr.p_char + idx, ' ', ctrl->minimum);
1274 		ptr.p_char[idx + ctrl->minimum] = '\0';
1275 		break;
1276 	case V4L2_CTRL_TYPE_INTEGER64:
1277 		ptr.p_s64[idx] = ctrl->default_value;
1278 		break;
1279 	case V4L2_CTRL_TYPE_INTEGER:
1280 	case V4L2_CTRL_TYPE_INTEGER_MENU:
1281 	case V4L2_CTRL_TYPE_MENU:
1282 	case V4L2_CTRL_TYPE_BITMASK:
1283 	case V4L2_CTRL_TYPE_BOOLEAN:
1284 		ptr.p_s32[idx] = ctrl->default_value;
1285 		break;
1286 	case V4L2_CTRL_TYPE_U8:
1287 		ptr.p_u8[idx] = ctrl->default_value;
1288 		break;
1289 	case V4L2_CTRL_TYPE_U16:
1290 		ptr.p_u16[idx] = ctrl->default_value;
1291 		break;
1292 	case V4L2_CTRL_TYPE_U32:
1293 		ptr.p_u32[idx] = ctrl->default_value;
1294 		break;
1295 	default:
1296 		idx *= ctrl->elem_size;
1297 		memset(ptr.p + idx, 0, ctrl->elem_size);
1298 		break;
1299 	}
1300 }
1301 
std_log(const struct v4l2_ctrl * ctrl)1302 static void std_log(const struct v4l2_ctrl *ctrl)
1303 {
1304 	union v4l2_ctrl_ptr ptr = ctrl->p_cur;
1305 
1306 	if (ctrl->is_array) {
1307 		unsigned i;
1308 
1309 		for (i = 0; i < ctrl->nr_of_dims; i++)
1310 			pr_cont("[%u]", ctrl->dims[i]);
1311 		pr_cont(" ");
1312 	}
1313 
1314 	switch (ctrl->type) {
1315 	case V4L2_CTRL_TYPE_INTEGER:
1316 		pr_cont("%d", *ptr.p_s32);
1317 		break;
1318 	case V4L2_CTRL_TYPE_BOOLEAN:
1319 		pr_cont("%s", *ptr.p_s32 ? "true" : "false");
1320 		break;
1321 	case V4L2_CTRL_TYPE_MENU:
1322 		pr_cont("%s", ctrl->qmenu[*ptr.p_s32]);
1323 		break;
1324 	case V4L2_CTRL_TYPE_INTEGER_MENU:
1325 		pr_cont("%lld", ctrl->qmenu_int[*ptr.p_s32]);
1326 		break;
1327 	case V4L2_CTRL_TYPE_BITMASK:
1328 		pr_cont("0x%08x", *ptr.p_s32);
1329 		break;
1330 	case V4L2_CTRL_TYPE_INTEGER64:
1331 		pr_cont("%lld", *ptr.p_s64);
1332 		break;
1333 	case V4L2_CTRL_TYPE_STRING:
1334 		pr_cont("%s", ptr.p_char);
1335 		break;
1336 	case V4L2_CTRL_TYPE_U8:
1337 		pr_cont("%u", (unsigned)*ptr.p_u8);
1338 		break;
1339 	case V4L2_CTRL_TYPE_U16:
1340 		pr_cont("%u", (unsigned)*ptr.p_u16);
1341 		break;
1342 	case V4L2_CTRL_TYPE_U32:
1343 		pr_cont("%u", (unsigned)*ptr.p_u32);
1344 		break;
1345 	default:
1346 		pr_cont("unknown type %d", ctrl->type);
1347 		break;
1348 	}
1349 }
1350 
1351 /*
1352  * Round towards the closest legal value. Be careful when we are
1353  * close to the maximum range of the control type to prevent
1354  * wrap-arounds.
1355  */
1356 #define ROUND_TO_RANGE(val, offset_type, ctrl)			\
1357 ({								\
1358 	offset_type offset;					\
1359 	if ((ctrl)->maximum >= 0 &&				\
1360 	    val >= (ctrl)->maximum - (s32)((ctrl)->step / 2))	\
1361 		val = (ctrl)->maximum;				\
1362 	else							\
1363 		val += (s32)((ctrl)->step / 2);			\
1364 	val = clamp_t(typeof(val), val,				\
1365 		      (ctrl)->minimum, (ctrl)->maximum);	\
1366 	offset = (val) - (ctrl)->minimum;			\
1367 	offset = (ctrl)->step * (offset / (u32)(ctrl)->step);	\
1368 	val = (ctrl)->minimum + offset;				\
1369 	0;							\
1370 })
1371 
1372 /* Validate a new control */
std_validate(const struct v4l2_ctrl * ctrl,u32 idx,union v4l2_ctrl_ptr ptr)1373 static int std_validate(const struct v4l2_ctrl *ctrl, u32 idx,
1374 			union v4l2_ctrl_ptr ptr)
1375 {
1376 	size_t len;
1377 	u64 offset;
1378 	s64 val;
1379 
1380 	switch (ctrl->type) {
1381 	case V4L2_CTRL_TYPE_INTEGER:
1382 		return ROUND_TO_RANGE(ptr.p_s32[idx], u32, ctrl);
1383 	case V4L2_CTRL_TYPE_INTEGER64:
1384 		/*
1385 		 * We can't use the ROUND_TO_RANGE define here due to
1386 		 * the u64 divide that needs special care.
1387 		 */
1388 		val = ptr.p_s64[idx];
1389 		if (ctrl->maximum >= 0 && val >= ctrl->maximum - (s64)(ctrl->step / 2))
1390 			val = ctrl->maximum;
1391 		else
1392 			val += (s64)(ctrl->step / 2);
1393 		val = clamp_t(s64, val, ctrl->minimum, ctrl->maximum);
1394 		offset = val - ctrl->minimum;
1395 		do_div(offset, ctrl->step);
1396 		ptr.p_s64[idx] = ctrl->minimum + offset * ctrl->step;
1397 		return 0;
1398 	case V4L2_CTRL_TYPE_U8:
1399 		return ROUND_TO_RANGE(ptr.p_u8[idx], u8, ctrl);
1400 	case V4L2_CTRL_TYPE_U16:
1401 		return ROUND_TO_RANGE(ptr.p_u16[idx], u16, ctrl);
1402 	case V4L2_CTRL_TYPE_U32:
1403 		return ROUND_TO_RANGE(ptr.p_u32[idx], u32, ctrl);
1404 
1405 	case V4L2_CTRL_TYPE_BOOLEAN:
1406 		ptr.p_s32[idx] = !!ptr.p_s32[idx];
1407 		return 0;
1408 
1409 	case V4L2_CTRL_TYPE_MENU:
1410 	case V4L2_CTRL_TYPE_INTEGER_MENU:
1411 		if (ptr.p_s32[idx] < ctrl->minimum || ptr.p_s32[idx] > ctrl->maximum)
1412 			return -ERANGE;
1413 		if (ctrl->menu_skip_mask & (1 << ptr.p_s32[idx]))
1414 			return -EINVAL;
1415 		if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1416 		    ctrl->qmenu[ptr.p_s32[idx]][0] == '\0')
1417 			return -EINVAL;
1418 		return 0;
1419 
1420 	case V4L2_CTRL_TYPE_BITMASK:
1421 		ptr.p_s32[idx] &= ctrl->maximum;
1422 		return 0;
1423 
1424 	case V4L2_CTRL_TYPE_BUTTON:
1425 	case V4L2_CTRL_TYPE_CTRL_CLASS:
1426 		ptr.p_s32[idx] = 0;
1427 		return 0;
1428 
1429 	case V4L2_CTRL_TYPE_STRING:
1430 		idx *= ctrl->elem_size;
1431 		len = strlen(ptr.p_char + idx);
1432 		if (len < ctrl->minimum)
1433 			return -ERANGE;
1434 		if ((len - (u32)ctrl->minimum) % (u32)ctrl->step)
1435 			return -ERANGE;
1436 		return 0;
1437 
1438 	default:
1439 		return -EINVAL;
1440 	}
1441 }
1442 
1443 static const struct v4l2_ctrl_type_ops std_type_ops = {
1444 	.equal = std_equal,
1445 	.init = std_init,
1446 	.log = std_log,
1447 	.validate = std_validate,
1448 };
1449 
1450 /* Helper function: copy the given control value back to the caller */
ptr_to_user(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl,union v4l2_ctrl_ptr ptr)1451 static int ptr_to_user(struct v4l2_ext_control *c,
1452 		       struct v4l2_ctrl *ctrl,
1453 		       union v4l2_ctrl_ptr ptr)
1454 {
1455 	u32 len;
1456 
1457 	if (ctrl->is_ptr && !ctrl->is_string)
1458 		return copy_to_user(c->ptr, ptr.p, c->size) ?
1459 		       -EFAULT : 0;
1460 
1461 	switch (ctrl->type) {
1462 	case V4L2_CTRL_TYPE_STRING:
1463 		len = strlen(ptr.p_char);
1464 		if (c->size < len + 1) {
1465 			c->size = ctrl->elem_size;
1466 			return -ENOSPC;
1467 		}
1468 		return copy_to_user(c->string, ptr.p_char, len + 1) ?
1469 		       -EFAULT : 0;
1470 	case V4L2_CTRL_TYPE_INTEGER64:
1471 		c->value64 = *ptr.p_s64;
1472 		break;
1473 	default:
1474 		c->value = *ptr.p_s32;
1475 		break;
1476 	}
1477 	return 0;
1478 }
1479 
1480 /* Helper function: copy the current control value back to the caller */
cur_to_user(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)1481 static int cur_to_user(struct v4l2_ext_control *c,
1482 		       struct v4l2_ctrl *ctrl)
1483 {
1484 	return ptr_to_user(c, ctrl, ctrl->p_cur);
1485 }
1486 
1487 /* Helper function: copy the new control value back to the caller */
new_to_user(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)1488 static int new_to_user(struct v4l2_ext_control *c,
1489 		       struct v4l2_ctrl *ctrl)
1490 {
1491 	return ptr_to_user(c, ctrl, ctrl->p_new);
1492 }
1493 
1494 /* Helper function: copy the caller-provider value to the given control value */
user_to_ptr(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl,union v4l2_ctrl_ptr ptr)1495 static int user_to_ptr(struct v4l2_ext_control *c,
1496 		       struct v4l2_ctrl *ctrl,
1497 		       union v4l2_ctrl_ptr ptr)
1498 {
1499 	int ret;
1500 	u32 size;
1501 
1502 	ctrl->is_new = 1;
1503 	if (ctrl->is_ptr && !ctrl->is_string) {
1504 		unsigned idx;
1505 
1506 		ret = copy_from_user(ptr.p, c->ptr, c->size) ? -EFAULT : 0;
1507 		if (ret || !ctrl->is_array)
1508 			return ret;
1509 		for (idx = c->size / ctrl->elem_size; idx < ctrl->elems; idx++)
1510 			ctrl->type_ops->init(ctrl, idx, ptr);
1511 		return 0;
1512 	}
1513 
1514 	switch (ctrl->type) {
1515 	case V4L2_CTRL_TYPE_INTEGER64:
1516 		*ptr.p_s64 = c->value64;
1517 		break;
1518 	case V4L2_CTRL_TYPE_STRING:
1519 		size = c->size;
1520 		if (size == 0)
1521 			return -ERANGE;
1522 		if (size > ctrl->maximum + 1)
1523 			size = ctrl->maximum + 1;
1524 		ret = copy_from_user(ptr.p_char, c->string, size) ? -EFAULT : 0;
1525 		if (!ret) {
1526 			char last = ptr.p_char[size - 1];
1527 
1528 			ptr.p_char[size - 1] = 0;
1529 			/* If the string was longer than ctrl->maximum,
1530 			   then return an error. */
1531 			if (strlen(ptr.p_char) == ctrl->maximum && last)
1532 				return -ERANGE;
1533 		}
1534 		return ret;
1535 	default:
1536 		*ptr.p_s32 = c->value;
1537 		break;
1538 	}
1539 	return 0;
1540 }
1541 
1542 /* Helper function: copy the caller-provider value as the new control value */
user_to_new(struct v4l2_ext_control * c,struct v4l2_ctrl * ctrl)1543 static int user_to_new(struct v4l2_ext_control *c,
1544 		       struct v4l2_ctrl *ctrl)
1545 {
1546 	return user_to_ptr(c, ctrl, ctrl->p_new);
1547 }
1548 
1549 /* Copy the one value to another. */
ptr_to_ptr(struct v4l2_ctrl * ctrl,union v4l2_ctrl_ptr from,union v4l2_ctrl_ptr to)1550 static void ptr_to_ptr(struct v4l2_ctrl *ctrl,
1551 		       union v4l2_ctrl_ptr from, union v4l2_ctrl_ptr to)
1552 {
1553 	if (ctrl == NULL)
1554 		return;
1555 	memcpy(to.p, from.p, ctrl->elems * ctrl->elem_size);
1556 }
1557 
1558 /* Copy the new value to the current value. */
new_to_cur(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,u32 ch_flags)1559 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
1560 {
1561 	bool changed;
1562 
1563 	if (ctrl == NULL)
1564 		return;
1565 
1566 	/* has_changed is set by cluster_changed */
1567 	changed = ctrl->has_changed;
1568 	if (changed)
1569 		ptr_to_ptr(ctrl, ctrl->p_new, ctrl->p_cur);
1570 
1571 	if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1572 		/* Note: CH_FLAGS is only set for auto clusters. */
1573 		ctrl->flags &=
1574 			~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1575 		if (!is_cur_manual(ctrl->cluster[0])) {
1576 			ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1577 			if (ctrl->cluster[0]->has_volatiles)
1578 				ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1579 		}
1580 		fh = NULL;
1581 	}
1582 	if (changed || ch_flags) {
1583 		/* If a control was changed that was not one of the controls
1584 		   modified by the application, then send the event to all. */
1585 		if (!ctrl->is_new)
1586 			fh = NULL;
1587 		send_event(fh, ctrl,
1588 			(changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
1589 		if (ctrl->call_notify && changed && ctrl->handler->notify)
1590 			ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
1591 	}
1592 }
1593 
1594 /* Copy the current value to the new value */
cur_to_new(struct v4l2_ctrl * ctrl)1595 static void cur_to_new(struct v4l2_ctrl *ctrl)
1596 {
1597 	if (ctrl == NULL)
1598 		return;
1599 	ptr_to_ptr(ctrl, ctrl->p_cur, ctrl->p_new);
1600 }
1601 
1602 /* Return non-zero if one or more of the controls in the cluster has a new
1603    value that differs from the current value. */
cluster_changed(struct v4l2_ctrl * master)1604 static int cluster_changed(struct v4l2_ctrl *master)
1605 {
1606 	bool changed = false;
1607 	unsigned idx;
1608 	int i;
1609 
1610 	for (i = 0; i < master->ncontrols; i++) {
1611 		struct v4l2_ctrl *ctrl = master->cluster[i];
1612 		bool ctrl_changed = false;
1613 
1614 		if (ctrl == NULL)
1615 			continue;
1616 
1617 		if (ctrl->flags & V4L2_CTRL_FLAG_EXECUTE_ON_WRITE)
1618 			changed = ctrl_changed = true;
1619 
1620 		/*
1621 		 * Set has_changed to false to avoid generating
1622 		 * the event V4L2_EVENT_CTRL_CH_VALUE
1623 		 */
1624 		if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
1625 			ctrl->has_changed = false;
1626 			continue;
1627 		}
1628 
1629 		for (idx = 0; !ctrl_changed && idx < ctrl->elems; idx++)
1630 			ctrl_changed = !ctrl->type_ops->equal(ctrl, idx,
1631 				ctrl->p_cur, ctrl->p_new);
1632 		ctrl->has_changed = ctrl_changed;
1633 		changed |= ctrl->has_changed;
1634 	}
1635 	return changed;
1636 }
1637 
1638 /* Control range checking */
check_range(enum v4l2_ctrl_type type,s64 min,s64 max,u64 step,s64 def)1639 static int check_range(enum v4l2_ctrl_type type,
1640 		s64 min, s64 max, u64 step, s64 def)
1641 {
1642 	switch (type) {
1643 	case V4L2_CTRL_TYPE_BOOLEAN:
1644 		if (step != 1 || max > 1 || min < 0)
1645 			return -ERANGE;
1646 		/* fall through */
1647 	case V4L2_CTRL_TYPE_U8:
1648 	case V4L2_CTRL_TYPE_U16:
1649 	case V4L2_CTRL_TYPE_U32:
1650 	case V4L2_CTRL_TYPE_INTEGER:
1651 	case V4L2_CTRL_TYPE_INTEGER64:
1652 		if (step == 0 || min > max || def < min || def > max)
1653 			return -ERANGE;
1654 		return 0;
1655 	case V4L2_CTRL_TYPE_BITMASK:
1656 		if (step || min || !max || (def & ~max))
1657 			return -ERANGE;
1658 		return 0;
1659 	case V4L2_CTRL_TYPE_MENU:
1660 	case V4L2_CTRL_TYPE_INTEGER_MENU:
1661 		if (min > max || def < min || def > max)
1662 			return -ERANGE;
1663 		/* Note: step == menu_skip_mask for menu controls.
1664 		   So here we check if the default value is masked out. */
1665 		if (step && ((1 << def) & step))
1666 			return -EINVAL;
1667 		return 0;
1668 	case V4L2_CTRL_TYPE_STRING:
1669 		if (min > max || min < 0 || step < 1 || def)
1670 			return -ERANGE;
1671 		return 0;
1672 	default:
1673 		return 0;
1674 	}
1675 }
1676 
1677 /* Validate a new control */
validate_new(const struct v4l2_ctrl * ctrl,union v4l2_ctrl_ptr p_new)1678 static int validate_new(const struct v4l2_ctrl *ctrl, union v4l2_ctrl_ptr p_new)
1679 {
1680 	unsigned idx;
1681 	int err = 0;
1682 
1683 	for (idx = 0; !err && idx < ctrl->elems; idx++)
1684 		err = ctrl->type_ops->validate(ctrl, idx, p_new);
1685 	return err;
1686 }
1687 
node2id(struct list_head * node)1688 static inline u32 node2id(struct list_head *node)
1689 {
1690 	return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1691 }
1692 
1693 /* Set the handler's error code if it wasn't set earlier already */
handler_set_err(struct v4l2_ctrl_handler * hdl,int err)1694 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1695 {
1696 	if (hdl->error == 0)
1697 		hdl->error = err;
1698 	return err;
1699 }
1700 
1701 /* Initialize the handler */
v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler * hdl,unsigned nr_of_controls_hint,struct lock_class_key * key,const char * name)1702 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1703 				 unsigned nr_of_controls_hint,
1704 				 struct lock_class_key *key, const char *name)
1705 {
1706 	hdl->lock = &hdl->_lock;
1707 	mutex_init(hdl->lock);
1708 	lockdep_set_class_and_name(hdl->lock, key, name);
1709 	INIT_LIST_HEAD(&hdl->ctrls);
1710 	INIT_LIST_HEAD(&hdl->ctrl_refs);
1711 	hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1712 	hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1713 			       GFP_KERNEL);
1714 	hdl->error = hdl->buckets ? 0 : -ENOMEM;
1715 	return hdl->error;
1716 }
1717 EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
1718 
1719 /* Free all controls and control refs */
v4l2_ctrl_handler_free(struct v4l2_ctrl_handler * hdl)1720 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1721 {
1722 	struct v4l2_ctrl_ref *ref, *next_ref;
1723 	struct v4l2_ctrl *ctrl, *next_ctrl;
1724 	struct v4l2_subscribed_event *sev, *next_sev;
1725 
1726 	if (hdl == NULL || hdl->buckets == NULL)
1727 		return;
1728 
1729 	mutex_lock(hdl->lock);
1730 	/* Free all nodes */
1731 	list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1732 		list_del(&ref->node);
1733 		kfree(ref);
1734 	}
1735 	/* Free all controls owned by the handler */
1736 	list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1737 		list_del(&ctrl->node);
1738 		list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1739 			list_del(&sev->node);
1740 		kfree(ctrl);
1741 	}
1742 	kfree(hdl->buckets);
1743 	hdl->buckets = NULL;
1744 	hdl->cached = NULL;
1745 	hdl->error = 0;
1746 	mutex_unlock(hdl->lock);
1747 }
1748 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1749 
1750 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1751    be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1752    with applications that do not use the NEXT_CTRL flag.
1753 
1754    We just find the n-th private user control. It's O(N), but that should not
1755    be an issue in this particular case. */
find_private_ref(struct v4l2_ctrl_handler * hdl,u32 id)1756 static struct v4l2_ctrl_ref *find_private_ref(
1757 		struct v4l2_ctrl_handler *hdl, u32 id)
1758 {
1759 	struct v4l2_ctrl_ref *ref;
1760 
1761 	id -= V4L2_CID_PRIVATE_BASE;
1762 	list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1763 		/* Search for private user controls that are compatible with
1764 		   VIDIOC_G/S_CTRL. */
1765 		if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1766 		    V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1767 			if (!ref->ctrl->is_int)
1768 				continue;
1769 			if (id == 0)
1770 				return ref;
1771 			id--;
1772 		}
1773 	}
1774 	return NULL;
1775 }
1776 
1777 /* Find a control with the given ID. */
find_ref(struct v4l2_ctrl_handler * hdl,u32 id)1778 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1779 {
1780 	struct v4l2_ctrl_ref *ref;
1781 	int bucket;
1782 
1783 	id &= V4L2_CTRL_ID_MASK;
1784 
1785 	/* Old-style private controls need special handling */
1786 	if (id >= V4L2_CID_PRIVATE_BASE)
1787 		return find_private_ref(hdl, id);
1788 	bucket = id % hdl->nr_of_buckets;
1789 
1790 	/* Simple optimization: cache the last control found */
1791 	if (hdl->cached && hdl->cached->ctrl->id == id)
1792 		return hdl->cached;
1793 
1794 	/* Not in cache, search the hash */
1795 	ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1796 	while (ref && ref->ctrl->id != id)
1797 		ref = ref->next;
1798 
1799 	if (ref)
1800 		hdl->cached = ref; /* cache it! */
1801 	return ref;
1802 }
1803 
1804 /* Find a control with the given ID. Take the handler's lock first. */
find_ref_lock(struct v4l2_ctrl_handler * hdl,u32 id)1805 static struct v4l2_ctrl_ref *find_ref_lock(
1806 		struct v4l2_ctrl_handler *hdl, u32 id)
1807 {
1808 	struct v4l2_ctrl_ref *ref = NULL;
1809 
1810 	if (hdl) {
1811 		mutex_lock(hdl->lock);
1812 		ref = find_ref(hdl, id);
1813 		mutex_unlock(hdl->lock);
1814 	}
1815 	return ref;
1816 }
1817 
1818 /* Find a control with the given ID. */
v4l2_ctrl_find(struct v4l2_ctrl_handler * hdl,u32 id)1819 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1820 {
1821 	struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1822 
1823 	return ref ? ref->ctrl : NULL;
1824 }
1825 EXPORT_SYMBOL(v4l2_ctrl_find);
1826 
1827 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
handler_new_ref(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl * ctrl)1828 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1829 			   struct v4l2_ctrl *ctrl)
1830 {
1831 	struct v4l2_ctrl_ref *ref;
1832 	struct v4l2_ctrl_ref *new_ref;
1833 	u32 id = ctrl->id;
1834 	u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1835 	int bucket = id % hdl->nr_of_buckets;	/* which bucket to use */
1836 
1837 	/*
1838 	 * Automatically add the control class if it is not yet present and
1839 	 * the new control is not a compound control.
1840 	 */
1841 	if (ctrl->type < V4L2_CTRL_COMPOUND_TYPES &&
1842 	    id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1843 		if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1844 			return hdl->error;
1845 
1846 	if (hdl->error)
1847 		return hdl->error;
1848 
1849 	new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1850 	if (!new_ref)
1851 		return handler_set_err(hdl, -ENOMEM);
1852 	new_ref->ctrl = ctrl;
1853 	if (ctrl->handler == hdl) {
1854 		/* By default each control starts in a cluster of its own.
1855 		   new_ref->ctrl is basically a cluster array with one
1856 		   element, so that's perfect to use as the cluster pointer.
1857 		   But only do this for the handler that owns the control. */
1858 		ctrl->cluster = &new_ref->ctrl;
1859 		ctrl->ncontrols = 1;
1860 	}
1861 
1862 	INIT_LIST_HEAD(&new_ref->node);
1863 
1864 	mutex_lock(hdl->lock);
1865 
1866 	/* Add immediately at the end of the list if the list is empty, or if
1867 	   the last element in the list has a lower ID.
1868 	   This ensures that when elements are added in ascending order the
1869 	   insertion is an O(1) operation. */
1870 	if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1871 		list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1872 		goto insert_in_hash;
1873 	}
1874 
1875 	/* Find insert position in sorted list */
1876 	list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1877 		if (ref->ctrl->id < id)
1878 			continue;
1879 		/* Don't add duplicates */
1880 		if (ref->ctrl->id == id) {
1881 			kfree(new_ref);
1882 			goto unlock;
1883 		}
1884 		list_add(&new_ref->node, ref->node.prev);
1885 		break;
1886 	}
1887 
1888 insert_in_hash:
1889 	/* Insert the control node in the hash */
1890 	new_ref->next = hdl->buckets[bucket];
1891 	hdl->buckets[bucket] = new_ref;
1892 
1893 unlock:
1894 	mutex_unlock(hdl->lock);
1895 	return 0;
1896 }
1897 
1898 /* Add a new control */
v4l2_ctrl_new(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,const struct v4l2_ctrl_type_ops * type_ops,u32 id,const char * name,enum v4l2_ctrl_type type,s64 min,s64 max,u64 step,s64 def,const u32 dims[V4L2_CTRL_MAX_DIMS],u32 elem_size,u32 flags,const char * const * qmenu,const s64 * qmenu_int,void * priv)1899 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1900 			const struct v4l2_ctrl_ops *ops,
1901 			const struct v4l2_ctrl_type_ops *type_ops,
1902 			u32 id, const char *name, enum v4l2_ctrl_type type,
1903 			s64 min, s64 max, u64 step, s64 def,
1904 			const u32 dims[V4L2_CTRL_MAX_DIMS], u32 elem_size,
1905 			u32 flags, const char * const *qmenu,
1906 			const s64 *qmenu_int, void *priv)
1907 {
1908 	struct v4l2_ctrl *ctrl;
1909 	unsigned sz_extra;
1910 	unsigned nr_of_dims = 0;
1911 	unsigned elems = 1;
1912 	bool is_array;
1913 	unsigned tot_ctrl_size;
1914 	unsigned idx;
1915 	void *data;
1916 	int err;
1917 
1918 	if (hdl->error)
1919 		return NULL;
1920 
1921 	while (dims && dims[nr_of_dims]) {
1922 		elems *= dims[nr_of_dims];
1923 		nr_of_dims++;
1924 		if (nr_of_dims == V4L2_CTRL_MAX_DIMS)
1925 			break;
1926 	}
1927 	is_array = nr_of_dims > 0;
1928 
1929 	/* Prefill elem_size for all types handled by std_type_ops */
1930 	switch (type) {
1931 	case V4L2_CTRL_TYPE_INTEGER64:
1932 		elem_size = sizeof(s64);
1933 		break;
1934 	case V4L2_CTRL_TYPE_STRING:
1935 		elem_size = max + 1;
1936 		break;
1937 	case V4L2_CTRL_TYPE_U8:
1938 		elem_size = sizeof(u8);
1939 		break;
1940 	case V4L2_CTRL_TYPE_U16:
1941 		elem_size = sizeof(u16);
1942 		break;
1943 	case V4L2_CTRL_TYPE_U32:
1944 		elem_size = sizeof(u32);
1945 		break;
1946 	default:
1947 		if (type < V4L2_CTRL_COMPOUND_TYPES)
1948 			elem_size = sizeof(s32);
1949 		break;
1950 	}
1951 	tot_ctrl_size = elem_size * elems;
1952 
1953 	/* Sanity checks */
1954 	if (id == 0 || name == NULL || !elem_size ||
1955 	    id >= V4L2_CID_PRIVATE_BASE ||
1956 	    (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1957 	    (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
1958 		handler_set_err(hdl, -ERANGE);
1959 		return NULL;
1960 	}
1961 	err = check_range(type, min, max, step, def);
1962 	if (err) {
1963 		handler_set_err(hdl, err);
1964 		return NULL;
1965 	}
1966 	if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1967 		handler_set_err(hdl, -ERANGE);
1968 		return NULL;
1969 	}
1970 	if (is_array &&
1971 	    (type == V4L2_CTRL_TYPE_BUTTON ||
1972 	     type == V4L2_CTRL_TYPE_CTRL_CLASS)) {
1973 		handler_set_err(hdl, -EINVAL);
1974 		return NULL;
1975 	}
1976 
1977 	sz_extra = 0;
1978 	if (type == V4L2_CTRL_TYPE_BUTTON)
1979 		flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
1980 			V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
1981 	else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1982 		flags |= V4L2_CTRL_FLAG_READ_ONLY;
1983 	else if (type == V4L2_CTRL_TYPE_INTEGER64 ||
1984 		 type == V4L2_CTRL_TYPE_STRING ||
1985 		 type >= V4L2_CTRL_COMPOUND_TYPES ||
1986 		 is_array)
1987 		sz_extra += 2 * tot_ctrl_size;
1988 
1989 	ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1990 	if (ctrl == NULL) {
1991 		handler_set_err(hdl, -ENOMEM);
1992 		return NULL;
1993 	}
1994 
1995 	INIT_LIST_HEAD(&ctrl->node);
1996 	INIT_LIST_HEAD(&ctrl->ev_subs);
1997 	ctrl->handler = hdl;
1998 	ctrl->ops = ops;
1999 	ctrl->type_ops = type_ops ? type_ops : &std_type_ops;
2000 	ctrl->id = id;
2001 	ctrl->name = name;
2002 	ctrl->type = type;
2003 	ctrl->flags = flags;
2004 	ctrl->minimum = min;
2005 	ctrl->maximum = max;
2006 	ctrl->step = step;
2007 	ctrl->default_value = def;
2008 	ctrl->is_string = !is_array && type == V4L2_CTRL_TYPE_STRING;
2009 	ctrl->is_ptr = is_array || type >= V4L2_CTRL_COMPOUND_TYPES || ctrl->is_string;
2010 	ctrl->is_int = !ctrl->is_ptr && type != V4L2_CTRL_TYPE_INTEGER64;
2011 	ctrl->is_array = is_array;
2012 	ctrl->elems = elems;
2013 	ctrl->nr_of_dims = nr_of_dims;
2014 	if (nr_of_dims)
2015 		memcpy(ctrl->dims, dims, nr_of_dims * sizeof(dims[0]));
2016 	ctrl->elem_size = elem_size;
2017 	if (type == V4L2_CTRL_TYPE_MENU)
2018 		ctrl->qmenu = qmenu;
2019 	else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2020 		ctrl->qmenu_int = qmenu_int;
2021 	ctrl->priv = priv;
2022 	ctrl->cur.val = ctrl->val = def;
2023 	data = &ctrl[1];
2024 
2025 	if (!ctrl->is_int) {
2026 		ctrl->p_new.p = data;
2027 		ctrl->p_cur.p = data + tot_ctrl_size;
2028 	} else {
2029 		ctrl->p_new.p = &ctrl->val;
2030 		ctrl->p_cur.p = &ctrl->cur.val;
2031 	}
2032 	for (idx = 0; idx < elems; idx++) {
2033 		ctrl->type_ops->init(ctrl, idx, ctrl->p_cur);
2034 		ctrl->type_ops->init(ctrl, idx, ctrl->p_new);
2035 	}
2036 
2037 	if (handler_new_ref(hdl, ctrl)) {
2038 		kfree(ctrl);
2039 		return NULL;
2040 	}
2041 	mutex_lock(hdl->lock);
2042 	list_add_tail(&ctrl->node, &hdl->ctrls);
2043 	mutex_unlock(hdl->lock);
2044 	return ctrl;
2045 }
2046 
v4l2_ctrl_new_custom(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_config * cfg,void * priv)2047 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
2048 			const struct v4l2_ctrl_config *cfg, void *priv)
2049 {
2050 	bool is_menu;
2051 	struct v4l2_ctrl *ctrl;
2052 	const char *name = cfg->name;
2053 	const char * const *qmenu = cfg->qmenu;
2054 	const s64 *qmenu_int = cfg->qmenu_int;
2055 	enum v4l2_ctrl_type type = cfg->type;
2056 	u32 flags = cfg->flags;
2057 	s64 min = cfg->min;
2058 	s64 max = cfg->max;
2059 	u64 step = cfg->step;
2060 	s64 def = cfg->def;
2061 
2062 	if (name == NULL)
2063 		v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
2064 								&def, &flags);
2065 
2066 	is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
2067 		   cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
2068 	if (is_menu)
2069 		WARN_ON(step);
2070 	else
2071 		WARN_ON(cfg->menu_skip_mask);
2072 	if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
2073 		qmenu = v4l2_ctrl_get_menu(cfg->id);
2074 	else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
2075 		 qmenu_int == NULL) {
2076 		handler_set_err(hdl, -EINVAL);
2077 		return NULL;
2078 	}
2079 
2080 	ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->type_ops, cfg->id, name,
2081 			type, min, max,
2082 			is_menu ? cfg->menu_skip_mask : step, def,
2083 			cfg->dims, cfg->elem_size,
2084 			flags, qmenu, qmenu_int, priv);
2085 	if (ctrl)
2086 		ctrl->is_private = cfg->is_private;
2087 	return ctrl;
2088 }
2089 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
2090 
2091 /* Helper function for standard non-menu controls */
v4l2_ctrl_new_std(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,s64 min,s64 max,u64 step,s64 def)2092 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
2093 			const struct v4l2_ctrl_ops *ops,
2094 			u32 id, s64 min, s64 max, u64 step, s64 def)
2095 {
2096 	const char *name;
2097 	enum v4l2_ctrl_type type;
2098 	u32 flags;
2099 
2100 	v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2101 	if (type == V4L2_CTRL_TYPE_MENU ||
2102 	    type == V4L2_CTRL_TYPE_INTEGER_MENU ||
2103 	    type >= V4L2_CTRL_COMPOUND_TYPES) {
2104 		handler_set_err(hdl, -EINVAL);
2105 		return NULL;
2106 	}
2107 	return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2108 			     min, max, step, def, NULL, 0,
2109 			     flags, NULL, NULL, NULL);
2110 }
2111 EXPORT_SYMBOL(v4l2_ctrl_new_std);
2112 
2113 /* Helper function for standard menu controls */
v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,u8 _max,u64 mask,u8 _def)2114 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
2115 			const struct v4l2_ctrl_ops *ops,
2116 			u32 id, u8 _max, u64 mask, u8 _def)
2117 {
2118 	const char * const *qmenu = NULL;
2119 	const s64 *qmenu_int = NULL;
2120 	unsigned int qmenu_int_len = 0;
2121 	const char *name;
2122 	enum v4l2_ctrl_type type;
2123 	s64 min;
2124 	s64 max = _max;
2125 	s64 def = _def;
2126 	u64 step;
2127 	u32 flags;
2128 
2129 	v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2130 
2131 	if (type == V4L2_CTRL_TYPE_MENU)
2132 		qmenu = v4l2_ctrl_get_menu(id);
2133 	else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2134 		qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
2135 
2136 	if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
2137 		handler_set_err(hdl, -EINVAL);
2138 		return NULL;
2139 	}
2140 	return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2141 			     0, max, mask, def, NULL, 0,
2142 			     flags, qmenu, qmenu_int, NULL);
2143 }
2144 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
2145 
2146 /* Helper function for standard menu controls with driver defined menu */
v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,u8 _max,u64 mask,u8 _def,const char * const * qmenu)2147 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
2148 			const struct v4l2_ctrl_ops *ops, u32 id, u8 _max,
2149 			u64 mask, u8 _def, const char * const *qmenu)
2150 {
2151 	enum v4l2_ctrl_type type;
2152 	const char *name;
2153 	u32 flags;
2154 	u64 step;
2155 	s64 min;
2156 	s64 max = _max;
2157 	s64 def = _def;
2158 
2159 	/* v4l2_ctrl_new_std_menu_items() should only be called for
2160 	 * standard controls without a standard menu.
2161 	 */
2162 	if (v4l2_ctrl_get_menu(id)) {
2163 		handler_set_err(hdl, -EINVAL);
2164 		return NULL;
2165 	}
2166 
2167 	v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2168 	if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
2169 		handler_set_err(hdl, -EINVAL);
2170 		return NULL;
2171 	}
2172 	return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2173 			     0, max, mask, def, NULL, 0,
2174 			     flags, qmenu, NULL, NULL);
2175 
2176 }
2177 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
2178 
2179 /* Helper function for standard integer menu controls */
v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler * hdl,const struct v4l2_ctrl_ops * ops,u32 id,u8 _max,u8 _def,const s64 * qmenu_int)2180 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
2181 			const struct v4l2_ctrl_ops *ops,
2182 			u32 id, u8 _max, u8 _def, const s64 *qmenu_int)
2183 {
2184 	const char *name;
2185 	enum v4l2_ctrl_type type;
2186 	s64 min;
2187 	u64 step;
2188 	s64 max = _max;
2189 	s64 def = _def;
2190 	u32 flags;
2191 
2192 	v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2193 	if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
2194 		handler_set_err(hdl, -EINVAL);
2195 		return NULL;
2196 	}
2197 	return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2198 			     0, max, 0, def, NULL, 0,
2199 			     flags, NULL, qmenu_int, NULL);
2200 }
2201 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
2202 
2203 /* Add a control from another handler to this handler */
v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl * ctrl)2204 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
2205 					  struct v4l2_ctrl *ctrl)
2206 {
2207 	if (hdl == NULL || hdl->error)
2208 		return NULL;
2209 	if (ctrl == NULL) {
2210 		handler_set_err(hdl, -EINVAL);
2211 		return NULL;
2212 	}
2213 	if (ctrl->handler == hdl)
2214 		return ctrl;
2215 	return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
2216 }
2217 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
2218 
2219 /* Add the controls from another handler to our own. */
v4l2_ctrl_add_handler(struct v4l2_ctrl_handler * hdl,struct v4l2_ctrl_handler * add,bool (* filter)(const struct v4l2_ctrl * ctrl))2220 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
2221 			  struct v4l2_ctrl_handler *add,
2222 			  bool (*filter)(const struct v4l2_ctrl *ctrl))
2223 {
2224 	struct v4l2_ctrl_ref *ref;
2225 	int ret = 0;
2226 
2227 	/* Do nothing if either handler is NULL or if they are the same */
2228 	if (!hdl || !add || hdl == add)
2229 		return 0;
2230 	if (hdl->error)
2231 		return hdl->error;
2232 	mutex_lock(add->lock);
2233 	list_for_each_entry(ref, &add->ctrl_refs, node) {
2234 		struct v4l2_ctrl *ctrl = ref->ctrl;
2235 
2236 		/* Skip handler-private controls. */
2237 		if (ctrl->is_private)
2238 			continue;
2239 		/* And control classes */
2240 		if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2241 			continue;
2242 		/* Filter any unwanted controls */
2243 		if (filter && !filter(ctrl))
2244 			continue;
2245 		ret = handler_new_ref(hdl, ctrl);
2246 		if (ret)
2247 			break;
2248 	}
2249 	mutex_unlock(add->lock);
2250 	return ret;
2251 }
2252 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
2253 
v4l2_ctrl_radio_filter(const struct v4l2_ctrl * ctrl)2254 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
2255 {
2256 	if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
2257 		return true;
2258 	if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
2259 		return true;
2260 	switch (ctrl->id) {
2261 	case V4L2_CID_AUDIO_MUTE:
2262 	case V4L2_CID_AUDIO_VOLUME:
2263 	case V4L2_CID_AUDIO_BALANCE:
2264 	case V4L2_CID_AUDIO_BASS:
2265 	case V4L2_CID_AUDIO_TREBLE:
2266 	case V4L2_CID_AUDIO_LOUDNESS:
2267 		return true;
2268 	default:
2269 		break;
2270 	}
2271 	return false;
2272 }
2273 EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
2274 
2275 /* Cluster controls */
v4l2_ctrl_cluster(unsigned ncontrols,struct v4l2_ctrl ** controls)2276 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
2277 {
2278 	bool has_volatiles = false;
2279 	int i;
2280 
2281 	/* The first control is the master control and it must not be NULL */
2282 	if (WARN_ON(ncontrols == 0 || controls[0] == NULL))
2283 		return;
2284 
2285 	for (i = 0; i < ncontrols; i++) {
2286 		if (controls[i]) {
2287 			controls[i]->cluster = controls;
2288 			controls[i]->ncontrols = ncontrols;
2289 			if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
2290 				has_volatiles = true;
2291 		}
2292 	}
2293 	controls[0]->has_volatiles = has_volatiles;
2294 }
2295 EXPORT_SYMBOL(v4l2_ctrl_cluster);
2296 
v4l2_ctrl_auto_cluster(unsigned ncontrols,struct v4l2_ctrl ** controls,u8 manual_val,bool set_volatile)2297 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
2298 			    u8 manual_val, bool set_volatile)
2299 {
2300 	struct v4l2_ctrl *master = controls[0];
2301 	u32 flag = 0;
2302 	int i;
2303 
2304 	v4l2_ctrl_cluster(ncontrols, controls);
2305 	WARN_ON(ncontrols <= 1);
2306 	WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
2307 	WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
2308 	master->is_auto = true;
2309 	master->has_volatiles = set_volatile;
2310 	master->manual_mode_value = manual_val;
2311 	master->flags |= V4L2_CTRL_FLAG_UPDATE;
2312 
2313 	if (!is_cur_manual(master))
2314 		flag = V4L2_CTRL_FLAG_INACTIVE |
2315 			(set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
2316 
2317 	for (i = 1; i < ncontrols; i++)
2318 		if (controls[i])
2319 			controls[i]->flags |= flag;
2320 }
2321 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
2322 
2323 /* Activate/deactivate a control. */
v4l2_ctrl_activate(struct v4l2_ctrl * ctrl,bool active)2324 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
2325 {
2326 	/* invert since the actual flag is called 'inactive' */
2327 	bool inactive = !active;
2328 	bool old;
2329 
2330 	if (ctrl == NULL)
2331 		return;
2332 
2333 	if (inactive)
2334 		/* set V4L2_CTRL_FLAG_INACTIVE */
2335 		old = test_and_set_bit(4, &ctrl->flags);
2336 	else
2337 		/* clear V4L2_CTRL_FLAG_INACTIVE */
2338 		old = test_and_clear_bit(4, &ctrl->flags);
2339 	if (old != inactive)
2340 		send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2341 }
2342 EXPORT_SYMBOL(v4l2_ctrl_activate);
2343 
2344 /* Grab/ungrab a control.
2345    Typically used when streaming starts and you want to grab controls,
2346    preventing the user from changing them.
2347 
2348    Just call this and the framework will block any attempts to change
2349    these controls. */
v4l2_ctrl_grab(struct v4l2_ctrl * ctrl,bool grabbed)2350 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
2351 {
2352 	bool old;
2353 
2354 	if (ctrl == NULL)
2355 		return;
2356 
2357 	v4l2_ctrl_lock(ctrl);
2358 	if (grabbed)
2359 		/* set V4L2_CTRL_FLAG_GRABBED */
2360 		old = test_and_set_bit(1, &ctrl->flags);
2361 	else
2362 		/* clear V4L2_CTRL_FLAG_GRABBED */
2363 		old = test_and_clear_bit(1, &ctrl->flags);
2364 	if (old != grabbed)
2365 		send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2366 	v4l2_ctrl_unlock(ctrl);
2367 }
2368 EXPORT_SYMBOL(v4l2_ctrl_grab);
2369 
2370 /* Log the control name and value */
log_ctrl(const struct v4l2_ctrl * ctrl,const char * prefix,const char * colon)2371 static void log_ctrl(const struct v4l2_ctrl *ctrl,
2372 		     const char *prefix, const char *colon)
2373 {
2374 	if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2375 		return;
2376 	if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2377 		return;
2378 
2379 	pr_info("%s%s%s: ", prefix, colon, ctrl->name);
2380 
2381 	ctrl->type_ops->log(ctrl);
2382 
2383 	if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2384 			   V4L2_CTRL_FLAG_GRABBED |
2385 			   V4L2_CTRL_FLAG_VOLATILE)) {
2386 		if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
2387 			pr_cont(" inactive");
2388 		if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
2389 			pr_cont(" grabbed");
2390 		if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
2391 			pr_cont(" volatile");
2392 	}
2393 	pr_cont("\n");
2394 }
2395 
2396 /* Log all controls owned by the handler */
v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler * hdl,const char * prefix)2397 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2398 				  const char *prefix)
2399 {
2400 	struct v4l2_ctrl *ctrl;
2401 	const char *colon = "";
2402 	int len;
2403 
2404 	if (hdl == NULL)
2405 		return;
2406 	if (prefix == NULL)
2407 		prefix = "";
2408 	len = strlen(prefix);
2409 	if (len && prefix[len - 1] != ' ')
2410 		colon = ": ";
2411 	mutex_lock(hdl->lock);
2412 	list_for_each_entry(ctrl, &hdl->ctrls, node)
2413 		if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2414 			log_ctrl(ctrl, prefix, colon);
2415 	mutex_unlock(hdl->lock);
2416 }
2417 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2418 
v4l2_ctrl_subdev_log_status(struct v4l2_subdev * sd)2419 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2420 {
2421 	v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2422 	return 0;
2423 }
2424 EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2425 
2426 /* Call s_ctrl for all controls owned by the handler */
v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler * hdl)2427 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2428 {
2429 	struct v4l2_ctrl *ctrl;
2430 	int ret = 0;
2431 
2432 	if (hdl == NULL)
2433 		return 0;
2434 	mutex_lock(hdl->lock);
2435 	list_for_each_entry(ctrl, &hdl->ctrls, node)
2436 		ctrl->done = false;
2437 
2438 	list_for_each_entry(ctrl, &hdl->ctrls, node) {
2439 		struct v4l2_ctrl *master = ctrl->cluster[0];
2440 		int i;
2441 
2442 		/* Skip if this control was already handled by a cluster. */
2443 		/* Skip button controls and read-only controls. */
2444 		if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2445 		    (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
2446 			continue;
2447 
2448 		for (i = 0; i < master->ncontrols; i++) {
2449 			if (master->cluster[i]) {
2450 				cur_to_new(master->cluster[i]);
2451 				master->cluster[i]->is_new = 1;
2452 				master->cluster[i]->done = true;
2453 			}
2454 		}
2455 		ret = call_op(master, s_ctrl);
2456 		if (ret)
2457 			break;
2458 	}
2459 	mutex_unlock(hdl->lock);
2460 	return ret;
2461 }
2462 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2463 
2464 /* Implement VIDIOC_QUERY_EXT_CTRL */
v4l2_query_ext_ctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_query_ext_ctrl * qc)2465 int v4l2_query_ext_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_query_ext_ctrl *qc)
2466 {
2467 	const unsigned next_flags = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND;
2468 	u32 id = qc->id & V4L2_CTRL_ID_MASK;
2469 	struct v4l2_ctrl_ref *ref;
2470 	struct v4l2_ctrl *ctrl;
2471 
2472 	if (hdl == NULL)
2473 		return -EINVAL;
2474 
2475 	mutex_lock(hdl->lock);
2476 
2477 	/* Try to find it */
2478 	ref = find_ref(hdl, id);
2479 
2480 	if ((qc->id & next_flags) && !list_empty(&hdl->ctrl_refs)) {
2481 		bool is_compound;
2482 		/* Match any control that is not hidden */
2483 		unsigned mask = 1;
2484 		bool match = false;
2485 
2486 		if ((qc->id & next_flags) == V4L2_CTRL_FLAG_NEXT_COMPOUND) {
2487 			/* Match any hidden control */
2488 			match = true;
2489 		} else if ((qc->id & next_flags) == next_flags) {
2490 			/* Match any control, compound or not */
2491 			mask = 0;
2492 		}
2493 
2494 		/* Find the next control with ID > qc->id */
2495 
2496 		/* Did we reach the end of the control list? */
2497 		if (id >= node2id(hdl->ctrl_refs.prev)) {
2498 			ref = NULL; /* Yes, so there is no next control */
2499 		} else if (ref) {
2500 			/* We found a control with the given ID, so just get
2501 			   the next valid one in the list. */
2502 			list_for_each_entry_continue(ref, &hdl->ctrl_refs, node) {
2503 				is_compound = ref->ctrl->is_array ||
2504 					ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2505 				if (id < ref->ctrl->id &&
2506 				    (is_compound & mask) == match)
2507 					break;
2508 			}
2509 			if (&ref->node == &hdl->ctrl_refs)
2510 				ref = NULL;
2511 		} else {
2512 			/* No control with the given ID exists, so start
2513 			   searching for the next largest ID. We know there
2514 			   is one, otherwise the first 'if' above would have
2515 			   been true. */
2516 			list_for_each_entry(ref, &hdl->ctrl_refs, node) {
2517 				is_compound = ref->ctrl->is_array ||
2518 					ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2519 				if (id < ref->ctrl->id &&
2520 				    (is_compound & mask) == match)
2521 					break;
2522 			}
2523 			if (&ref->node == &hdl->ctrl_refs)
2524 				ref = NULL;
2525 		}
2526 	}
2527 	mutex_unlock(hdl->lock);
2528 
2529 	if (!ref)
2530 		return -EINVAL;
2531 
2532 	ctrl = ref->ctrl;
2533 	memset(qc, 0, sizeof(*qc));
2534 	if (id >= V4L2_CID_PRIVATE_BASE)
2535 		qc->id = id;
2536 	else
2537 		qc->id = ctrl->id;
2538 	strlcpy(qc->name, ctrl->name, sizeof(qc->name));
2539 	qc->flags = ctrl->flags;
2540 	qc->type = ctrl->type;
2541 	if (ctrl->is_ptr)
2542 		qc->flags |= V4L2_CTRL_FLAG_HAS_PAYLOAD;
2543 	qc->elem_size = ctrl->elem_size;
2544 	qc->elems = ctrl->elems;
2545 	qc->nr_of_dims = ctrl->nr_of_dims;
2546 	memcpy(qc->dims, ctrl->dims, qc->nr_of_dims * sizeof(qc->dims[0]));
2547 	qc->minimum = ctrl->minimum;
2548 	qc->maximum = ctrl->maximum;
2549 	qc->default_value = ctrl->default_value;
2550 	if (ctrl->type == V4L2_CTRL_TYPE_MENU
2551 	    || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
2552 		qc->step = 1;
2553 	else
2554 		qc->step = ctrl->step;
2555 	return 0;
2556 }
2557 EXPORT_SYMBOL(v4l2_query_ext_ctrl);
2558 
2559 /* Implement VIDIOC_QUERYCTRL */
v4l2_queryctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_queryctrl * qc)2560 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2561 {
2562 	struct v4l2_query_ext_ctrl qec = { qc->id };
2563 	int rc;
2564 
2565 	rc = v4l2_query_ext_ctrl(hdl, &qec);
2566 	if (rc)
2567 		return rc;
2568 
2569 	qc->id = qec.id;
2570 	qc->type = qec.type;
2571 	qc->flags = qec.flags;
2572 	strlcpy(qc->name, qec.name, sizeof(qc->name));
2573 	switch (qc->type) {
2574 	case V4L2_CTRL_TYPE_INTEGER:
2575 	case V4L2_CTRL_TYPE_BOOLEAN:
2576 	case V4L2_CTRL_TYPE_MENU:
2577 	case V4L2_CTRL_TYPE_INTEGER_MENU:
2578 	case V4L2_CTRL_TYPE_STRING:
2579 	case V4L2_CTRL_TYPE_BITMASK:
2580 		qc->minimum = qec.minimum;
2581 		qc->maximum = qec.maximum;
2582 		qc->step = qec.step;
2583 		qc->default_value = qec.default_value;
2584 		break;
2585 	default:
2586 		qc->minimum = 0;
2587 		qc->maximum = 0;
2588 		qc->step = 0;
2589 		qc->default_value = 0;
2590 		break;
2591 	}
2592 	return 0;
2593 }
2594 EXPORT_SYMBOL(v4l2_queryctrl);
2595 
v4l2_subdev_queryctrl(struct v4l2_subdev * sd,struct v4l2_queryctrl * qc)2596 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2597 {
2598 	if (qc->id & (V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND))
2599 		return -EINVAL;
2600 	return v4l2_queryctrl(sd->ctrl_handler, qc);
2601 }
2602 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2603 
2604 /* Implement VIDIOC_QUERYMENU */
v4l2_querymenu(struct v4l2_ctrl_handler * hdl,struct v4l2_querymenu * qm)2605 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2606 {
2607 	struct v4l2_ctrl *ctrl;
2608 	u32 i = qm->index;
2609 
2610 	ctrl = v4l2_ctrl_find(hdl, qm->id);
2611 	if (!ctrl)
2612 		return -EINVAL;
2613 
2614 	qm->reserved = 0;
2615 	/* Sanity checks */
2616 	switch (ctrl->type) {
2617 	case V4L2_CTRL_TYPE_MENU:
2618 		if (ctrl->qmenu == NULL)
2619 			return -EINVAL;
2620 		break;
2621 	case V4L2_CTRL_TYPE_INTEGER_MENU:
2622 		if (ctrl->qmenu_int == NULL)
2623 			return -EINVAL;
2624 		break;
2625 	default:
2626 		return -EINVAL;
2627 	}
2628 
2629 	if (i < ctrl->minimum || i > ctrl->maximum)
2630 		return -EINVAL;
2631 
2632 	/* Use mask to see if this menu item should be skipped */
2633 	if (ctrl->menu_skip_mask & (1 << i))
2634 		return -EINVAL;
2635 	/* Empty menu items should also be skipped */
2636 	if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2637 		if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2638 			return -EINVAL;
2639 		strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2640 	} else {
2641 		qm->value = ctrl->qmenu_int[i];
2642 	}
2643 	return 0;
2644 }
2645 EXPORT_SYMBOL(v4l2_querymenu);
2646 
v4l2_subdev_querymenu(struct v4l2_subdev * sd,struct v4l2_querymenu * qm)2647 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2648 {
2649 	return v4l2_querymenu(sd->ctrl_handler, qm);
2650 }
2651 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2652 
2653 
2654 
2655 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2656 
2657    It is not a fully atomic operation, just best-effort only. After all, if
2658    multiple controls have to be set through multiple i2c writes (for example)
2659    then some initial writes may succeed while others fail. Thus leaving the
2660    system in an inconsistent state. The question is how much effort you are
2661    willing to spend on trying to make something atomic that really isn't.
2662 
2663    From the point of view of an application the main requirement is that
2664    when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2665    error should be returned without actually affecting any controls.
2666 
2667    If all the values are correct, then it is acceptable to just give up
2668    in case of low-level errors.
2669 
2670    It is important though that the application can tell when only a partial
2671    configuration was done. The way we do that is through the error_idx field
2672    of struct v4l2_ext_controls: if that is equal to the count field then no
2673    controls were affected. Otherwise all controls before that index were
2674    successful in performing their 'get' or 'set' operation, the control at
2675    the given index failed, and you don't know what happened with the controls
2676    after the failed one. Since if they were part of a control cluster they
2677    could have been successfully processed (if a cluster member was encountered
2678    at index < error_idx), they could have failed (if a cluster member was at
2679    error_idx), or they may not have been processed yet (if the first cluster
2680    member appeared after error_idx).
2681 
2682    It is all fairly theoretical, though. In practice all you can do is to
2683    bail out. If error_idx == count, then it is an application bug. If
2684    error_idx < count then it is only an application bug if the error code was
2685    EBUSY. That usually means that something started streaming just when you
2686    tried to set the controls. In all other cases it is a driver/hardware
2687    problem and all you can do is to retry or bail out.
2688 
2689    Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2690    never modifies controls the error_idx is just set to whatever control
2691    has an invalid value.
2692  */
2693 
2694 /* Prepare for the extended g/s/try functions.
2695    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,bool get)2696 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2697 			     struct v4l2_ext_controls *cs,
2698 			     struct v4l2_ctrl_helper *helpers,
2699 			     bool get)
2700 {
2701 	struct v4l2_ctrl_helper *h;
2702 	bool have_clusters = false;
2703 	u32 i;
2704 
2705 	for (i = 0, h = helpers; i < cs->count; i++, h++) {
2706 		struct v4l2_ext_control *c = &cs->controls[i];
2707 		struct v4l2_ctrl_ref *ref;
2708 		struct v4l2_ctrl *ctrl;
2709 		u32 id = c->id & V4L2_CTRL_ID_MASK;
2710 
2711 		cs->error_idx = i;
2712 
2713 		if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2714 			return -EINVAL;
2715 
2716 		/* Old-style private controls are not allowed for
2717 		   extended controls */
2718 		if (id >= V4L2_CID_PRIVATE_BASE)
2719 			return -EINVAL;
2720 		ref = find_ref_lock(hdl, id);
2721 		if (ref == NULL)
2722 			return -EINVAL;
2723 		ctrl = ref->ctrl;
2724 		if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2725 			return -EINVAL;
2726 
2727 		if (ctrl->cluster[0]->ncontrols > 1)
2728 			have_clusters = true;
2729 		if (ctrl->cluster[0] != ctrl)
2730 			ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2731 		if (ctrl->is_ptr && !ctrl->is_string) {
2732 			unsigned tot_size = ctrl->elems * ctrl->elem_size;
2733 
2734 			if (c->size < tot_size) {
2735 				if (get) {
2736 					c->size = tot_size;
2737 					return -ENOSPC;
2738 				}
2739 				return -EFAULT;
2740 			}
2741 			c->size = tot_size;
2742 		}
2743 		/* Store the ref to the master control of the cluster */
2744 		h->mref = ref;
2745 		h->ctrl = ctrl;
2746 		/* Initially set next to 0, meaning that there is no other
2747 		   control in this helper array belonging to the same
2748 		   cluster */
2749 		h->next = 0;
2750 	}
2751 
2752 	/* We are done if there were no controls that belong to a multi-
2753 	   control cluster. */
2754 	if (!have_clusters)
2755 		return 0;
2756 
2757 	/* The code below figures out in O(n) time which controls in the list
2758 	   belong to the same cluster. */
2759 
2760 	/* This has to be done with the handler lock taken. */
2761 	mutex_lock(hdl->lock);
2762 
2763 	/* First zero the helper field in the master control references */
2764 	for (i = 0; i < cs->count; i++)
2765 		helpers[i].mref->helper = NULL;
2766 	for (i = 0, h = helpers; i < cs->count; i++, h++) {
2767 		struct v4l2_ctrl_ref *mref = h->mref;
2768 
2769 		/* If the mref->helper is set, then it points to an earlier
2770 		   helper that belongs to the same cluster. */
2771 		if (mref->helper) {
2772 			/* Set the next field of mref->helper to the current
2773 			   index: this means that that earlier helper now
2774 			   points to the next helper in the same cluster. */
2775 			mref->helper->next = i;
2776 			/* mref should be set only for the first helper in the
2777 			   cluster, clear the others. */
2778 			h->mref = NULL;
2779 		}
2780 		/* Point the mref helper to the current helper struct. */
2781 		mref->helper = h;
2782 	}
2783 	mutex_unlock(hdl->lock);
2784 	return 0;
2785 }
2786 
2787 /* Handles the corner case where cs->count == 0. It checks whether the
2788    specified control class exists. If that class ID is 0, then it checks
2789    whether there are any controls at all. */
class_check(struct v4l2_ctrl_handler * hdl,u32 ctrl_class)2790 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2791 {
2792 	if (ctrl_class == 0)
2793 		return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2794 	return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2795 }
2796 
2797 
2798 
2799 /* Get extended controls. Allocates the helpers array if needed. */
v4l2_g_ext_ctrls(struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)2800 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2801 {
2802 	struct v4l2_ctrl_helper helper[4];
2803 	struct v4l2_ctrl_helper *helpers = helper;
2804 	int ret;
2805 	int i, j;
2806 
2807 	cs->error_idx = cs->count;
2808 	cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2809 
2810 	if (hdl == NULL)
2811 		return -EINVAL;
2812 
2813 	if (cs->count == 0)
2814 		return class_check(hdl, cs->ctrl_class);
2815 
2816 	if (cs->count > ARRAY_SIZE(helper)) {
2817 		helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2818 					GFP_KERNEL);
2819 		if (helpers == NULL)
2820 			return -ENOMEM;
2821 	}
2822 
2823 	ret = prepare_ext_ctrls(hdl, cs, helpers, true);
2824 	cs->error_idx = cs->count;
2825 
2826 	for (i = 0; !ret && i < cs->count; i++)
2827 		if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2828 			ret = -EACCES;
2829 
2830 	for (i = 0; !ret && i < cs->count; i++) {
2831 		int (*ctrl_to_user)(struct v4l2_ext_control *c,
2832 				    struct v4l2_ctrl *ctrl) = cur_to_user;
2833 		struct v4l2_ctrl *master;
2834 
2835 		if (helpers[i].mref == NULL)
2836 			continue;
2837 
2838 		master = helpers[i].mref->ctrl;
2839 		cs->error_idx = i;
2840 
2841 		v4l2_ctrl_lock(master);
2842 
2843 		/* g_volatile_ctrl will update the new control values */
2844 		if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2845 			(master->has_volatiles && !is_cur_manual(master))) {
2846 			for (j = 0; j < master->ncontrols; j++)
2847 				cur_to_new(master->cluster[j]);
2848 			ret = call_op(master, g_volatile_ctrl);
2849 			ctrl_to_user = new_to_user;
2850 		}
2851 		/* If OK, then copy the current (for non-volatile controls)
2852 		   or the new (for volatile controls) control values to the
2853 		   caller */
2854 		if (!ret) {
2855 			u32 idx = i;
2856 
2857 			do {
2858 				ret = ctrl_to_user(cs->controls + idx,
2859 						   helpers[idx].ctrl);
2860 				idx = helpers[idx].next;
2861 			} while (!ret && idx);
2862 		}
2863 		v4l2_ctrl_unlock(master);
2864 	}
2865 
2866 	if (cs->count > ARRAY_SIZE(helper))
2867 		kfree(helpers);
2868 	return ret;
2869 }
2870 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2871 
v4l2_subdev_g_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)2872 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2873 {
2874 	return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2875 }
2876 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2877 
2878 /* Helper function to get a single control */
get_ctrl(struct v4l2_ctrl * ctrl,struct v4l2_ext_control * c)2879 static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
2880 {
2881 	struct v4l2_ctrl *master = ctrl->cluster[0];
2882 	int ret = 0;
2883 	int i;
2884 
2885 	/* Compound controls are not supported. The new_to_user() and
2886 	 * cur_to_user() calls below would need to be modified not to access
2887 	 * userspace memory when called from get_ctrl().
2888 	 */
2889 	if (!ctrl->is_int && ctrl->type != V4L2_CTRL_TYPE_INTEGER64)
2890 		return -EINVAL;
2891 
2892 	if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2893 		return -EACCES;
2894 
2895 	v4l2_ctrl_lock(master);
2896 	/* g_volatile_ctrl will update the current control values */
2897 	if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2898 		for (i = 0; i < master->ncontrols; i++)
2899 			cur_to_new(master->cluster[i]);
2900 		ret = call_op(master, g_volatile_ctrl);
2901 		new_to_user(c, ctrl);
2902 	} else {
2903 		cur_to_user(c, ctrl);
2904 	}
2905 	v4l2_ctrl_unlock(master);
2906 	return ret;
2907 }
2908 
v4l2_g_ctrl(struct v4l2_ctrl_handler * hdl,struct v4l2_control * control)2909 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2910 {
2911 	struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2912 	struct v4l2_ext_control c;
2913 	int ret;
2914 
2915 	if (ctrl == NULL || !ctrl->is_int)
2916 		return -EINVAL;
2917 	ret = get_ctrl(ctrl, &c);
2918 	control->value = c.value;
2919 	return ret;
2920 }
2921 EXPORT_SYMBOL(v4l2_g_ctrl);
2922 
v4l2_subdev_g_ctrl(struct v4l2_subdev * sd,struct v4l2_control * control)2923 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2924 {
2925 	return v4l2_g_ctrl(sd->ctrl_handler, control);
2926 }
2927 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2928 
v4l2_ctrl_g_ctrl(struct v4l2_ctrl * ctrl)2929 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2930 {
2931 	struct v4l2_ext_control c;
2932 
2933 	/* It's a driver bug if this happens. */
2934 	WARN_ON(!ctrl->is_int);
2935 	c.value = 0;
2936 	get_ctrl(ctrl, &c);
2937 	return c.value;
2938 }
2939 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2940 
v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl * ctrl)2941 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
2942 {
2943 	struct v4l2_ext_control c;
2944 
2945 	/* It's a driver bug if this happens. */
2946 	WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2947 	c.value64 = 0;
2948 	get_ctrl(ctrl, &c);
2949 	return c.value64;
2950 }
2951 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
2952 
2953 
2954 /* Core function that calls try/s_ctrl and ensures that the new value is
2955    copied to the current value on a set.
2956    Must be called with ctrl->handler->lock held. */
try_or_set_cluster(struct v4l2_fh * fh,struct v4l2_ctrl * master,bool set,u32 ch_flags)2957 static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
2958 			      bool set, u32 ch_flags)
2959 {
2960 	bool update_flag;
2961 	int ret;
2962 	int i;
2963 
2964 	/* Go through the cluster and either validate the new value or
2965 	   (if no new value was set), copy the current value to the new
2966 	   value, ensuring a consistent view for the control ops when
2967 	   called. */
2968 	for (i = 0; i < master->ncontrols; i++) {
2969 		struct v4l2_ctrl *ctrl = master->cluster[i];
2970 
2971 		if (ctrl == NULL)
2972 			continue;
2973 
2974 		if (!ctrl->is_new) {
2975 			cur_to_new(ctrl);
2976 			continue;
2977 		}
2978 		/* Check again: it may have changed since the
2979 		   previous check in try_or_set_ext_ctrls(). */
2980 		if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2981 			return -EBUSY;
2982 	}
2983 
2984 	ret = call_op(master, try_ctrl);
2985 
2986 	/* Don't set if there is no change */
2987 	if (ret || !set || !cluster_changed(master))
2988 		return ret;
2989 	ret = call_op(master, s_ctrl);
2990 	if (ret)
2991 		return ret;
2992 
2993 	/* If OK, then make the new values permanent. */
2994 	update_flag = is_cur_manual(master) != is_new_manual(master);
2995 	for (i = 0; i < master->ncontrols; i++)
2996 		new_to_cur(fh, master->cluster[i], ch_flags |
2997 			((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
2998 	return 0;
2999 }
3000 
3001 /* Validate controls. */
validate_ctrls(struct v4l2_ext_controls * cs,struct v4l2_ctrl_helper * helpers,bool set)3002 static int validate_ctrls(struct v4l2_ext_controls *cs,
3003 			  struct v4l2_ctrl_helper *helpers, bool set)
3004 {
3005 	unsigned i;
3006 	int ret = 0;
3007 
3008 	cs->error_idx = cs->count;
3009 	for (i = 0; i < cs->count; i++) {
3010 		struct v4l2_ctrl *ctrl = helpers[i].ctrl;
3011 		union v4l2_ctrl_ptr p_new;
3012 
3013 		cs->error_idx = i;
3014 
3015 		if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3016 			return -EACCES;
3017 		/* This test is also done in try_set_control_cluster() which
3018 		   is called in atomic context, so that has the final say,
3019 		   but it makes sense to do an up-front check as well. Once
3020 		   an error occurs in try_set_control_cluster() some other
3021 		   controls may have been set already and we want to do a
3022 		   best-effort to avoid that. */
3023 		if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
3024 			return -EBUSY;
3025 		/*
3026 		 * Skip validation for now if the payload needs to be copied
3027 		 * from userspace into kernelspace. We'll validate those later.
3028 		 */
3029 		if (ctrl->is_ptr)
3030 			continue;
3031 		if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3032 			p_new.p_s64 = &cs->controls[i].value64;
3033 		else
3034 			p_new.p_s32 = &cs->controls[i].value;
3035 		ret = validate_new(ctrl, p_new);
3036 		if (ret)
3037 			return ret;
3038 	}
3039 	return 0;
3040 }
3041 
3042 /* Obtain the current volatile values of an autocluster and mark them
3043    as new. */
update_from_auto_cluster(struct v4l2_ctrl * master)3044 static void update_from_auto_cluster(struct v4l2_ctrl *master)
3045 {
3046 	int i;
3047 
3048 	for (i = 1; i < master->ncontrols; i++)
3049 		cur_to_new(master->cluster[i]);
3050 	if (!call_op(master, g_volatile_ctrl))
3051 		for (i = 1; i < master->ncontrols; i++)
3052 			if (master->cluster[i])
3053 				master->cluster[i]->is_new = 1;
3054 }
3055 
3056 /* 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)3057 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3058 			     struct v4l2_ext_controls *cs,
3059 			     bool set)
3060 {
3061 	struct v4l2_ctrl_helper helper[4];
3062 	struct v4l2_ctrl_helper *helpers = helper;
3063 	unsigned i, j;
3064 	int ret;
3065 
3066 	cs->error_idx = cs->count;
3067 	cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
3068 
3069 	if (hdl == NULL)
3070 		return -EINVAL;
3071 
3072 	if (cs->count == 0)
3073 		return class_check(hdl, cs->ctrl_class);
3074 
3075 	if (cs->count > ARRAY_SIZE(helper)) {
3076 		helpers = kmalloc_array(cs->count, sizeof(helper[0]),
3077 					GFP_KERNEL);
3078 		if (!helpers)
3079 			return -ENOMEM;
3080 	}
3081 	ret = prepare_ext_ctrls(hdl, cs, helpers, false);
3082 	if (!ret)
3083 		ret = validate_ctrls(cs, helpers, set);
3084 	if (ret && set)
3085 		cs->error_idx = cs->count;
3086 	for (i = 0; !ret && i < cs->count; i++) {
3087 		struct v4l2_ctrl *master;
3088 		u32 idx = i;
3089 
3090 		if (helpers[i].mref == NULL)
3091 			continue;
3092 
3093 		cs->error_idx = i;
3094 		master = helpers[i].mref->ctrl;
3095 		v4l2_ctrl_lock(master);
3096 
3097 		/* Reset the 'is_new' flags of the cluster */
3098 		for (j = 0; j < master->ncontrols; j++)
3099 			if (master->cluster[j])
3100 				master->cluster[j]->is_new = 0;
3101 
3102 		/* For volatile autoclusters that are currently in auto mode
3103 		   we need to discover if it will be set to manual mode.
3104 		   If so, then we have to copy the current volatile values
3105 		   first since those will become the new manual values (which
3106 		   may be overwritten by explicit new values from this set
3107 		   of controls). */
3108 		if (master->is_auto && master->has_volatiles &&
3109 						!is_cur_manual(master)) {
3110 			/* Pick an initial non-manual value */
3111 			s32 new_auto_val = master->manual_mode_value + 1;
3112 			u32 tmp_idx = idx;
3113 
3114 			do {
3115 				/* Check if the auto control is part of the
3116 				   list, and remember the new value. */
3117 				if (helpers[tmp_idx].ctrl == master)
3118 					new_auto_val = cs->controls[tmp_idx].value;
3119 				tmp_idx = helpers[tmp_idx].next;
3120 			} while (tmp_idx);
3121 			/* If the new value == the manual value, then copy
3122 			   the current volatile values. */
3123 			if (new_auto_val == master->manual_mode_value)
3124 				update_from_auto_cluster(master);
3125 		}
3126 
3127 		/* Copy the new caller-supplied control values.
3128 		   user_to_new() sets 'is_new' to 1. */
3129 		do {
3130 			struct v4l2_ctrl *ctrl = helpers[idx].ctrl;
3131 
3132 			ret = user_to_new(cs->controls + idx, ctrl);
3133 			if (!ret && ctrl->is_ptr)
3134 				ret = validate_new(ctrl, ctrl->p_new);
3135 			idx = helpers[idx].next;
3136 		} while (!ret && idx);
3137 
3138 		if (!ret)
3139 			ret = try_or_set_cluster(fh, master, set, 0);
3140 
3141 		/* Copy the new values back to userspace. */
3142 		if (!ret) {
3143 			idx = i;
3144 			do {
3145 				ret = new_to_user(cs->controls + idx,
3146 						helpers[idx].ctrl);
3147 				idx = helpers[idx].next;
3148 			} while (!ret && idx);
3149 		}
3150 		v4l2_ctrl_unlock(master);
3151 	}
3152 
3153 	if (cs->count > ARRAY_SIZE(helper))
3154 		kfree(helpers);
3155 	return ret;
3156 }
3157 
v4l2_try_ext_ctrls(struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)3158 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
3159 {
3160 	return try_set_ext_ctrls(NULL, hdl, cs, false);
3161 }
3162 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
3163 
v4l2_s_ext_ctrls(struct v4l2_fh * fh,struct v4l2_ctrl_handler * hdl,struct v4l2_ext_controls * cs)3164 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3165 					struct v4l2_ext_controls *cs)
3166 {
3167 	return try_set_ext_ctrls(fh, hdl, cs, true);
3168 }
3169 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
3170 
v4l2_subdev_try_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)3171 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3172 {
3173 	return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
3174 }
3175 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
3176 
v4l2_subdev_s_ext_ctrls(struct v4l2_subdev * sd,struct v4l2_ext_controls * cs)3177 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3178 {
3179 	return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
3180 }
3181 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
3182 
3183 /* Helper function for VIDIOC_S_CTRL compatibility */
set_ctrl(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,u32 ch_flags)3184 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
3185 {
3186 	struct v4l2_ctrl *master = ctrl->cluster[0];
3187 	int ret;
3188 	int i;
3189 
3190 	/* Reset the 'is_new' flags of the cluster */
3191 	for (i = 0; i < master->ncontrols; i++)
3192 		if (master->cluster[i])
3193 			master->cluster[i]->is_new = 0;
3194 
3195 	ret = validate_new(ctrl, ctrl->p_new);
3196 	if (ret)
3197 		return ret;
3198 
3199 	/* For autoclusters with volatiles that are switched from auto to
3200 	   manual mode we have to update the current volatile values since
3201 	   those will become the initial manual values after such a switch. */
3202 	if (master->is_auto && master->has_volatiles && ctrl == master &&
3203 	    !is_cur_manual(master) && ctrl->val == master->manual_mode_value)
3204 		update_from_auto_cluster(master);
3205 
3206 	ctrl->is_new = 1;
3207 	return try_or_set_cluster(fh, master, true, ch_flags);
3208 }
3209 
3210 /* Helper function for VIDIOC_S_CTRL compatibility */
set_ctrl_lock(struct v4l2_fh * fh,struct v4l2_ctrl * ctrl,struct v4l2_ext_control * c)3211 static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
3212 			 struct v4l2_ext_control *c)
3213 {
3214 	int ret;
3215 
3216 	v4l2_ctrl_lock(ctrl);
3217 	user_to_new(c, ctrl);
3218 	ret = set_ctrl(fh, ctrl, 0);
3219 	if (!ret)
3220 		cur_to_user(c, ctrl);
3221 	v4l2_ctrl_unlock(ctrl);
3222 	return ret;
3223 }
3224 
v4l2_s_ctrl(struct v4l2_fh * fh,struct v4l2_ctrl_handler * hdl,struct v4l2_control * control)3225 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3226 					struct v4l2_control *control)
3227 {
3228 	struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
3229 	struct v4l2_ext_control c = { control->id };
3230 	int ret;
3231 
3232 	if (ctrl == NULL || !ctrl->is_int)
3233 		return -EINVAL;
3234 
3235 	if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3236 		return -EACCES;
3237 
3238 	c.value = control->value;
3239 	ret = set_ctrl_lock(fh, ctrl, &c);
3240 	control->value = c.value;
3241 	return ret;
3242 }
3243 EXPORT_SYMBOL(v4l2_s_ctrl);
3244 
v4l2_subdev_s_ctrl(struct v4l2_subdev * sd,struct v4l2_control * control)3245 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
3246 {
3247 	return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
3248 }
3249 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
3250 
__v4l2_ctrl_s_ctrl(struct v4l2_ctrl * ctrl,s32 val)3251 int __v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
3252 {
3253 	lockdep_assert_held(ctrl->handler->lock);
3254 
3255 	/* It's a driver bug if this happens. */
3256 	WARN_ON(!ctrl->is_int);
3257 	ctrl->val = val;
3258 	return set_ctrl(NULL, ctrl, 0);
3259 }
3260 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl);
3261 
__v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl * ctrl,s64 val)3262 int __v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
3263 {
3264 	lockdep_assert_held(ctrl->handler->lock);
3265 
3266 	/* It's a driver bug if this happens. */
3267 	WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
3268 	*ctrl->p_new.p_s64 = val;
3269 	return set_ctrl(NULL, ctrl, 0);
3270 }
3271 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_int64);
3272 
__v4l2_ctrl_s_ctrl_string(struct v4l2_ctrl * ctrl,const char * s)3273 int __v4l2_ctrl_s_ctrl_string(struct v4l2_ctrl *ctrl, const char *s)
3274 {
3275 	lockdep_assert_held(ctrl->handler->lock);
3276 
3277 	/* It's a driver bug if this happens. */
3278 	WARN_ON(ctrl->type != V4L2_CTRL_TYPE_STRING);
3279 	strlcpy(ctrl->p_new.p_char, s, ctrl->maximum + 1);
3280 	return set_ctrl(NULL, ctrl, 0);
3281 }
3282 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_string);
3283 
v4l2_ctrl_notify(struct v4l2_ctrl * ctrl,v4l2_ctrl_notify_fnc notify,void * priv)3284 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
3285 {
3286 	if (ctrl == NULL)
3287 		return;
3288 	if (notify == NULL) {
3289 		ctrl->call_notify = 0;
3290 		return;
3291 	}
3292 	if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
3293 		return;
3294 	ctrl->handler->notify = notify;
3295 	ctrl->handler->notify_priv = priv;
3296 	ctrl->call_notify = 1;
3297 }
3298 EXPORT_SYMBOL(v4l2_ctrl_notify);
3299 
__v4l2_ctrl_modify_range(struct v4l2_ctrl * ctrl,s64 min,s64 max,u64 step,s64 def)3300 int __v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
3301 			s64 min, s64 max, u64 step, s64 def)
3302 {
3303 	bool changed;
3304 	int ret;
3305 
3306 	lockdep_assert_held(ctrl->handler->lock);
3307 
3308 	switch (ctrl->type) {
3309 	case V4L2_CTRL_TYPE_INTEGER:
3310 	case V4L2_CTRL_TYPE_INTEGER64:
3311 	case V4L2_CTRL_TYPE_BOOLEAN:
3312 	case V4L2_CTRL_TYPE_MENU:
3313 	case V4L2_CTRL_TYPE_INTEGER_MENU:
3314 	case V4L2_CTRL_TYPE_BITMASK:
3315 	case V4L2_CTRL_TYPE_U8:
3316 	case V4L2_CTRL_TYPE_U16:
3317 	case V4L2_CTRL_TYPE_U32:
3318 		if (ctrl->is_array)
3319 			return -EINVAL;
3320 		ret = check_range(ctrl->type, min, max, step, def);
3321 		if (ret)
3322 			return ret;
3323 		break;
3324 	default:
3325 		return -EINVAL;
3326 	}
3327 	ctrl->minimum = min;
3328 	ctrl->maximum = max;
3329 	ctrl->step = step;
3330 	ctrl->default_value = def;
3331 	cur_to_new(ctrl);
3332 	if (validate_new(ctrl, ctrl->p_new)) {
3333 		if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3334 			*ctrl->p_new.p_s64 = def;
3335 		else
3336 			*ctrl->p_new.p_s32 = def;
3337 	}
3338 
3339 	if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3340 		changed = *ctrl->p_new.p_s64 != *ctrl->p_cur.p_s64;
3341 	else
3342 		changed = *ctrl->p_new.p_s32 != *ctrl->p_cur.p_s32;
3343 	if (changed)
3344 		ret = set_ctrl(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3345 	else
3346 		send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3347 	return ret;
3348 }
3349 EXPORT_SYMBOL(__v4l2_ctrl_modify_range);
3350 
v4l2_ctrl_add_event(struct v4l2_subscribed_event * sev,unsigned elems)3351 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
3352 {
3353 	struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3354 
3355 	if (ctrl == NULL)
3356 		return -EINVAL;
3357 
3358 	v4l2_ctrl_lock(ctrl);
3359 	list_add_tail(&sev->node, &ctrl->ev_subs);
3360 	if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
3361 	    (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
3362 		struct v4l2_event ev;
3363 		u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
3364 
3365 		if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
3366 			changes |= V4L2_EVENT_CTRL_CH_VALUE;
3367 		fill_event(&ev, ctrl, changes);
3368 		/* Mark the queue as active, allowing this initial
3369 		   event to be accepted. */
3370 		sev->elems = elems;
3371 		v4l2_event_queue_fh(sev->fh, &ev);
3372 	}
3373 	v4l2_ctrl_unlock(ctrl);
3374 	return 0;
3375 }
3376 
v4l2_ctrl_del_event(struct v4l2_subscribed_event * sev)3377 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
3378 {
3379 	struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3380 
3381 	v4l2_ctrl_lock(ctrl);
3382 	list_del(&sev->node);
3383 	v4l2_ctrl_unlock(ctrl);
3384 }
3385 
v4l2_ctrl_replace(struct v4l2_event * old,const struct v4l2_event * new)3386 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
3387 {
3388 	u32 old_changes = old->u.ctrl.changes;
3389 
3390 	old->u.ctrl = new->u.ctrl;
3391 	old->u.ctrl.changes |= old_changes;
3392 }
3393 EXPORT_SYMBOL(v4l2_ctrl_replace);
3394 
v4l2_ctrl_merge(const struct v4l2_event * old,struct v4l2_event * new)3395 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
3396 {
3397 	new->u.ctrl.changes |= old->u.ctrl.changes;
3398 }
3399 EXPORT_SYMBOL(v4l2_ctrl_merge);
3400 
3401 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
3402 	.add = v4l2_ctrl_add_event,
3403 	.del = v4l2_ctrl_del_event,
3404 	.replace = v4l2_ctrl_replace,
3405 	.merge = v4l2_ctrl_merge,
3406 };
3407 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
3408 
v4l2_ctrl_log_status(struct file * file,void * fh)3409 int v4l2_ctrl_log_status(struct file *file, void *fh)
3410 {
3411 	struct video_device *vfd = video_devdata(file);
3412 	struct v4l2_fh *vfh = file->private_data;
3413 
3414 	if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
3415 		v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
3416 			vfd->v4l2_dev->name);
3417 	return 0;
3418 }
3419 EXPORT_SYMBOL(v4l2_ctrl_log_status);
3420 
v4l2_ctrl_subscribe_event(struct v4l2_fh * fh,const struct v4l2_event_subscription * sub)3421 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
3422 				const struct v4l2_event_subscription *sub)
3423 {
3424 	if (sub->type == V4L2_EVENT_CTRL)
3425 		return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
3426 	return -EINVAL;
3427 }
3428 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
3429 
v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev * sd,struct v4l2_fh * fh,struct v4l2_event_subscription * sub)3430 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
3431 				     struct v4l2_event_subscription *sub)
3432 {
3433 	if (!sd->ctrl_handler)
3434 		return -EINVAL;
3435 	return v4l2_ctrl_subscribe_event(fh, sub);
3436 }
3437 EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
3438 
v4l2_ctrl_poll(struct file * file,struct poll_table_struct * wait)3439 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
3440 {
3441 	struct v4l2_fh *fh = file->private_data;
3442 
3443 	if (v4l2_event_pending(fh))
3444 		return POLLPRI;
3445 	poll_wait(file, &fh->wait, wait);
3446 	return 0;
3447 }
3448 EXPORT_SYMBOL(v4l2_ctrl_poll);
3449