]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/media/v4l2-core/v4l2-ctrls.c
[media] DocBook media: document new VBI defines
[mirror_ubuntu-artful-kernel.git] / drivers / media / v4l2-core / v4l2-ctrls.c
CommitLineData
0996517c
HV
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>
2b80163c 22#include <linux/slab.h>
35a24636 23#include <linux/export.h>
0996517c
HV
24#include <media/v4l2-ioctl.h>
25#include <media/v4l2-device.h>
26#include <media/v4l2-ctrls.h>
6e239399 27#include <media/v4l2-event.h>
0996517c
HV
28#include <media/v4l2-dev.h>
29
ddac5c10
HV
30#define has_op(master, op) \
31 (master->ops && master->ops->op)
54c911eb 32#define call_op(master, op) \
ddac5c10 33 (has_op(master, op) ? master->ops->op(master) : 0)
54c911eb 34
0996517c 35/* Internal temporary helper struct, one for each v4l2_ext_control */
eb5b16ef
HV
36struct v4l2_ctrl_helper {
37 /* Pointer to the control reference of the master control */
38 struct v4l2_ctrl_ref *mref;
0996517c
HV
39 /* The control corresponding to the v4l2_ext_control ID field. */
40 struct v4l2_ctrl *ctrl;
eb5b16ef
HV
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;
0996517c
HV
44};
45
72d877ca 46/* Small helper function to determine if the autocluster is set to manual
88365105 47 mode. */
72d877ca
HV
48static 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. */
55static bool is_new_manual(const struct v4l2_ctrl *master)
56{
57 return master->is_auto && master->val == master->manual_mode_value;
58}
59
0996517c
HV
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. */
513521ea 64const char * const *v4l2_ctrl_get_menu(u32 id)
0996517c 65{
513521ea 66 static const char * const mpeg_audio_sampling_freq[] = {
0996517c
HV
67 "44.1 kHz",
68 "48 kHz",
69 "32 kHz",
70 NULL
71 };
513521ea 72 static const char * const mpeg_audio_encoding[] = {
0996517c
HV
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 };
513521ea 80 static const char * const mpeg_audio_l1_bitrate[] = {
0996517c
HV
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 };
513521ea 97 static const char * const mpeg_audio_l2_bitrate[] = {
0996517c
HV
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 };
513521ea 114 static const char * const mpeg_audio_l3_bitrate[] = {
0996517c
HV
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 };
513521ea 131 static const char * const mpeg_audio_ac3_bitrate[] = {
0996517c
HV
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 };
513521ea 153 static const char * const mpeg_audio_mode[] = {
0996517c
HV
154 "Stereo",
155 "Joint Stereo",
156 "Dual",
157 "Mono",
158 NULL
159 };
513521ea 160 static const char * const mpeg_audio_mode_extension[] = {
0996517c
HV
161 "Bound 4",
162 "Bound 8",
163 "Bound 12",
164 "Bound 16",
165 NULL
166 };
513521ea 167 static const char * const mpeg_audio_emphasis[] = {
0996517c
HV
168 "No Emphasis",
169 "50/15 us",
170 "CCITT J17",
171 NULL
172 };
513521ea 173 static const char * const mpeg_audio_crc[] = {
0996517c
HV
174 "No CRC",
175 "16-bit CRC",
176 NULL
177 };
24c19a21
HV
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 };
513521ea 187 static const char * const mpeg_video_encoding[] = {
0996517c
HV
188 "MPEG-1",
189 "MPEG-2",
190 "MPEG-4 AVC",
191 NULL
192 };
513521ea 193 static const char * const mpeg_video_aspect[] = {
0996517c
HV
194 "1x1",
195 "4x3",
196 "16x9",
197 "2.21x1",
198 NULL
199 };
513521ea 200 static const char * const mpeg_video_bitrate_mode[] = {
0996517c
HV
201 "Variable Bitrate",
202 "Constant Bitrate",
203 NULL
204 };
513521ea 205 static const char * const mpeg_stream_type[] = {
0996517c
HV
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 };
513521ea 214 static const char * const mpeg_stream_vbi_fmt[] = {
0996517c 215 "No VBI",
064f5096 216 "Private Packet, IVTV Format",
0996517c
HV
217 NULL
218 };
513521ea 219 static const char * const camera_power_line_frequency[] = {
0996517c
HV
220 "Disabled",
221 "50 Hz",
222 "60 Hz",
d26a6635 223 "Auto",
0996517c
HV
224 NULL
225 };
513521ea 226 static const char * const camera_exposure_auto[] = {
0996517c
HV
227 "Auto Mode",
228 "Manual Mode",
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
231 NULL
232 };
cf072139
SN
233 static const char * const camera_exposure_metering[] = {
234 "Average",
235 "Center Weighted",
236 "Spot",
fc39f46b 237 "Matrix",
cf072139
SN
238 NULL
239 };
2272ab65
SN
240 static const char * const camera_auto_focus_range[] = {
241 "Auto",
242 "Normal",
243 "Macro",
244 "Infinity",
245 NULL
246 };
513521ea 247 static const char * const colorfx[] = {
0996517c
HV
248 "None",
249 "Black & White",
250 "Sepia",
251 "Negative",
252 "Emboss",
253 "Sketch",
064f5096
KD
254 "Sky Blue",
255 "Grass Green",
256 "Skin Whiten",
0996517c 257 "Vivid",
6491d1ad
SN
258 "Aqua",
259 "Art Freeze",
260 "Silhouette",
261 "Solarization",
262 "Antique",
263 "Set Cb/Cr",
0996517c
HV
264 NULL
265 };
e40a0573
SN
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 };
7f84ad8b
SN
279 static const char * const camera_iso_sensitivity_auto[] = {
280 "Manual",
281 "Auto",
282 NULL
283 };
0bf6b7dc
SN
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 };
aec330a8
AS
301 static const char * const tune_emphasis[] = {
302 "None",
f769c260
HV
303 "50 Microseconds",
304 "75 Microseconds",
0996517c
HV
305 NULL,
306 };
064f5096
KD
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 };
2e81dde9
AK
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 };
064f5096
KD
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",
f769c260 420 "Advanced Simple",
064f5096
KD
421 "Core",
422 "Simple Scalable",
39c1cb2b 423 "Advanced Coding Efficiency",
064f5096
KD
424 NULL,
425 };
426
bc9028e1
AK
427 static const char * const vpx_golden_frame_sel[] = {
428 "Use Previous Frame",
429 "Use Previous Specific Frame",
430 NULL,
431 };
432
0b159acd
SA
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 };
0996517c 444
c7361ae1
SN
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 };
977ebec7
HV
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 };
a77b4fc0
HV
465 static const char * const detect_md_mode[] = {
466 "Disabled",
467 "Global",
468 "Threshold Grid",
469 "Region Grid",
470 NULL,
471 };
977ebec7 472
c7361ae1 473
0996517c
HV
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;
24c19a21
HV
495 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
496 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
497 return mpeg_audio_dec_playback;
0996517c
HV
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;
cf072139
SN
512 case V4L2_CID_EXPOSURE_METERING:
513 return camera_exposure_metering;
2272ab65
SN
514 case V4L2_CID_AUTO_FOCUS_RANGE:
515 return camera_auto_focus_range;
0996517c
HV
516 case V4L2_CID_COLORFX:
517 return colorfx;
e40a0573
SN
518 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
519 return auto_n_preset_white_balance;
7f84ad8b
SN
520 case V4L2_CID_ISO_SENSITIVITY_AUTO:
521 return camera_iso_sensitivity_auto;
0bf6b7dc
SN
522 case V4L2_CID_SCENE_MODE:
523 return scene_mode;
0996517c 524 case V4L2_CID_TUNE_PREEMPHASIS:
aec330a8
AS
525 return tune_emphasis;
526 case V4L2_CID_TUNE_DEEMPHASIS:
527 return tune_emphasis;
0b159acd
SA
528 case V4L2_CID_FLASH_LED_MODE:
529 return flash_led_mode;
530 case V4L2_CID_FLASH_STROBE_SOURCE:
531 return flash_strobe_source;
064f5096
KD
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;
2e81dde9
AK
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;
064f5096
KD
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;
bc9028e1
AK
554 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
555 return vpx_golden_frame_sel;
c7361ae1
SN
556 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
557 return jpeg_chroma_subsampling;
977ebec7
HV
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;
a77b4fc0
HV
563 case V4L2_CID_DETECT_MD_MODE:
564 return detect_md_mode;
c7361ae1 565
0996517c
HV
566 default:
567 return NULL;
568 }
569}
570EXPORT_SYMBOL(v4l2_ctrl_get_menu);
571
bc9028e1 572#define __v4l2_qmenu_int_len(arr, len) ({ *(len) = ARRAY_SIZE(arr); arr; })
d1e9b7c1
SN
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 */
4eed9b33 577const s64 *v4l2_ctrl_get_int_menu(u32 id, u32 *len)
d1e9b7c1 578{
4eed9b33 579 static const s64 qmenu_int_vpx_num_partitions[] = {
bc9028e1
AK
580 1, 2, 4, 8,
581 };
582
4eed9b33 583 static const s64 qmenu_int_vpx_num_ref_frames[] = {
bc9028e1
AK
584 1, 2, 3,
585 };
586
d1e9b7c1 587 switch (id) {
bc9028e1
AK
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);
d1e9b7c1
SN
592 default:
593 *len = 0;
594 return NULL;
2028c71d 595 }
d1e9b7c1
SN
596}
597EXPORT_SYMBOL(v4l2_ctrl_get_int_menu);
598
0996517c
HV
599/* Return the control name. */
600const char *v4l2_ctrl_get_name(u32 id)
601{
602 switch (id) {
603 /* USER controls */
59253f29 604 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
6dd5aff3
MCC
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";
0996517c
HV
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";
0996517c
HV
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";
0996517c
HV
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";
6c8d6111 639 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
008d35f2
JFM
640 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
641 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
f08aacf8
HV
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";
cc1d3272 644 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
6491d1ad 645 case V4L2_CID_COLORFX_CBCR: return "Color Effects, CbCr";
0996517c 646
bc9028e1
AK
647 /* Codec controls */
648 /* The MPEG controls are applicable to all codec controls
649 * and the 'MPEG' part of the define is historical */
6c8d6111 650 /* Keep the order of the 'case's the same as in videodev2.h! */
bc9028e1 651 case V4L2_CID_MPEG_CLASS: return "Codec Controls";
6dd5aff3
MCC
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";
6c8d6111
HV
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";
0996517c 660 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
6dd5aff3
MCC
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";
0996517c 666 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
6dd5aff3
MCC
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";
24c19a21
HV
672 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
673 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
6dd5aff3
MCC
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";
0996517c 683 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
6dd5aff3 684 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
0996517c 685 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
064f5096
KD
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";
f08aacf8 688 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
064f5096
KD
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";
f08aacf8 692 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
064f5096 693 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
f08aacf8
HV
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";
064f5096
KD
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";
f08aacf8
HV
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";
064f5096
KD
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";
f08aacf8
HV
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";
064f5096
KD
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";
2e81dde9
AK
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";
064f5096 732 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
f08aacf8
HV
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";
064f5096
KD
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";
f08aacf8
HV
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";
064f5096 743 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
24c19a21
HV
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";
2e81dde9 746 case V4L2_CID_MPEG_VIDEO_VBV_DELAY: return "Initial Delay for VBV Control";
bf0bedd3
AG
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";
9ca5470c 749 case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER: return "Repeat Sequence Header";
0996517c 750
bc9028e1
AK
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";
4773ab99
AK
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";
bbd8f3fe 763 case V4L2_CID_MPEG_VIDEO_VPX_PROFILE: return "VPX Profile";
bc9028e1 764
0996517c 765 /* CAMERA controls */
59253f29 766 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
0996517c
HV
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";
2272ab65 779 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic Continuous";
0996517c
HV
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";
6c8d6111
HV
784 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
785 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
d58083c9 786 case V4L2_CID_AUTO_EXPOSURE_BIAS: return "Auto Exposure, Bias";
e40a0573 787 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
44d44a1a 788 case V4L2_CID_WIDE_DYNAMIC_RANGE: return "Wide Dynamic Range";
82b3056c 789 case V4L2_CID_IMAGE_STABILIZATION: return "Image Stabilization";
7f84ad8b
SN
790 case V4L2_CID_ISO_SENSITIVITY: return "ISO Sensitivity";
791 case V4L2_CID_ISO_SENSITIVITY_AUTO: return "ISO Sensitivity, Auto";
cf072139 792 case V4L2_CID_EXPOSURE_METERING: return "Exposure, Metering Mode";
0bf6b7dc 793 case V4L2_CID_SCENE_MODE: return "Scene Mode";
fc162a09 794 case V4L2_CID_3A_LOCK: return "3A Lock";
2272ab65
SN
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";
0996517c 799
59253f29
HV
800 /* FM Radio Modulator controls */
801 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
0996517c
HV
802 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
803 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
804 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
805 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
806 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
807 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
808 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
809 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
810 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
f08aacf8 811 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
0996517c
HV
812 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
813 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
814 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
815 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
816 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
817 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
818 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
f08aacf8 819 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
0996517c
HV
820 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
821 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
822
0b159acd 823 /* Flash controls */
59253f29 824 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
f08aacf8
HV
825 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
826 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
827 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
0b159acd 828 case V4L2_CID_FLASH_STROBE: return "Strobe";
f08aacf8
HV
829 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
830 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
831 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
832 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
833 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
834 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
0b159acd
SA
835 case V4L2_CID_FLASH_FAULT: return "Faults";
836 case V4L2_CID_FLASH_CHARGE: return "Charge";
f08aacf8 837 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
0b159acd 838
c7361ae1 839 /* JPEG encoder controls */
59253f29 840 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
c7361ae1
SN
841 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
842 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
843 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
844 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
845 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
846
8c9d236e 847 /* Image source controls */
59253f29 848 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
8c9d236e
SA
849 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
850 case V4L2_CID_VBLANK: return "Vertical Blanking";
851 case V4L2_CID_HBLANK: return "Horizontal Blanking";
852 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
853
c643ee13 854 /* Image processing controls */
59253f29 855 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
c643ee13
SA
856 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
857 case V4L2_CID_LINK_FREQ: return "Link Frequency";
858 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
5ebef0fb 859 case V4L2_CID_TEST_PATTERN: return "Test Pattern";
c643ee13 860
977ebec7 861 /* DV controls */
59253f29 862 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
977ebec7
HV
863 case V4L2_CID_DV_CLASS: return "Digital Video Controls";
864 case V4L2_CID_DV_TX_HOTPLUG: return "Hotplug Present";
865 case V4L2_CID_DV_TX_RXSENSE: return "RxSense Present";
866 case V4L2_CID_DV_TX_EDID_PRESENT: return "EDID Present";
867 case V4L2_CID_DV_TX_MODE: return "Transmit Mode";
868 case V4L2_CID_DV_TX_RGB_RANGE: return "Tx RGB Quantization Range";
869 case V4L2_CID_DV_RX_POWER_PRESENT: return "Power Present";
870 case V4L2_CID_DV_RX_RGB_RANGE: return "Rx RGB Quantization Range";
871
aec330a8
AS
872 case V4L2_CID_FM_RX_CLASS: return "FM Radio Receiver Controls";
873 case V4L2_CID_TUNE_DEEMPHASIS: return "De-Emphasis";
874 case V4L2_CID_RDS_RECEPTION: return "RDS Reception";
80807fad
AP
875
876 case V4L2_CID_RF_TUNER_CLASS: return "RF Tuner Controls";
877 case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO: return "LNA Gain, Auto";
878 case V4L2_CID_RF_TUNER_LNA_GAIN: return "LNA Gain";
879 case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO: return "Mixer Gain, Auto";
880 case V4L2_CID_RF_TUNER_MIXER_GAIN: return "Mixer Gain";
881 case V4L2_CID_RF_TUNER_IF_GAIN_AUTO: return "IF Gain, Auto";
882 case V4L2_CID_RF_TUNER_IF_GAIN: return "IF Gain";
3ce569fd
AP
883 case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO: return "Bandwidth, Auto";
884 case V4L2_CID_RF_TUNER_BANDWIDTH: return "Bandwidth";
9aa4357e 885 case V4L2_CID_RF_TUNER_PLL_LOCK: return "PLL Lock";
a77b4fc0
HV
886
887 /* Detection controls */
888 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
889 case V4L2_CID_DETECT_CLASS: return "Detection Controls";
890 case V4L2_CID_DETECT_MD_MODE: return "Motion Detection Mode";
891 case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD: return "MD Global Threshold";
892 case V4L2_CID_DETECT_MD_THRESHOLD_GRID: return "MD Threshold Grid";
893 case V4L2_CID_DETECT_MD_REGION_GRID: return "MD Region Grid";
894
0996517c
HV
895 default:
896 return NULL;
897 }
898}
899EXPORT_SYMBOL(v4l2_ctrl_get_name);
900
901void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
0ba2aeb6 902 s64 *min, s64 *max, u64 *step, s64 *def, u32 *flags)
0996517c
HV
903{
904 *name = v4l2_ctrl_get_name(id);
905 *flags = 0;
906
907 switch (id) {
908 case V4L2_CID_AUDIO_MUTE:
909 case V4L2_CID_AUDIO_LOUDNESS:
910 case V4L2_CID_AUTO_WHITE_BALANCE:
911 case V4L2_CID_AUTOGAIN:
912 case V4L2_CID_HFLIP:
913 case V4L2_CID_VFLIP:
914 case V4L2_CID_HUE_AUTO:
915 case V4L2_CID_CHROMA_AGC:
916 case V4L2_CID_COLOR_KILLER:
a2f8b84f 917 case V4L2_CID_AUTOBRIGHTNESS:
0996517c
HV
918 case V4L2_CID_MPEG_AUDIO_MUTE:
919 case V4L2_CID_MPEG_VIDEO_MUTE:
920 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
921 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
922 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
923 case V4L2_CID_FOCUS_AUTO:
924 case V4L2_CID_PRIVACY:
925 case V4L2_CID_AUDIO_LIMITER_ENABLED:
926 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
927 case V4L2_CID_PILOT_TONE_ENABLED:
008d35f2
JFM
928 case V4L2_CID_ILLUMINATORS_1:
929 case V4L2_CID_ILLUMINATORS_2:
0b159acd
SA
930 case V4L2_CID_FLASH_STROBE_STATUS:
931 case V4L2_CID_FLASH_CHARGE:
932 case V4L2_CID_FLASH_READY:
064f5096
KD
933 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
934 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
935 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
936 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
937 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
938 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
939 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
9ca5470c 940 case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:
44d44a1a 941 case V4L2_CID_WIDE_DYNAMIC_RANGE:
82b3056c 942 case V4L2_CID_IMAGE_STABILIZATION:
aec330a8 943 case V4L2_CID_RDS_RECEPTION:
80807fad
AP
944 case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:
945 case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO:
946 case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:
3ce569fd 947 case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:
9aa4357e 948 case V4L2_CID_RF_TUNER_PLL_LOCK:
0996517c
HV
949 *type = V4L2_CTRL_TYPE_BOOLEAN;
950 *min = 0;
951 *max = *step = 1;
952 break;
bf0bedd3
AG
953 case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE:
954 case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:
955 *type = V4L2_CTRL_TYPE_INTEGER;
956 break;
0996517c
HV
957 case V4L2_CID_PAN_RESET:
958 case V4L2_CID_TILT_RESET:
0b159acd
SA
959 case V4L2_CID_FLASH_STROBE:
960 case V4L2_CID_FLASH_STROBE_STOP:
2272ab65
SN
961 case V4L2_CID_AUTO_FOCUS_START:
962 case V4L2_CID_AUTO_FOCUS_STOP:
0996517c
HV
963 *type = V4L2_CTRL_TYPE_BUTTON;
964 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
965 *min = *max = *step = *def = 0;
966 break;
967 case V4L2_CID_POWER_LINE_FREQUENCY:
968 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
969 case V4L2_CID_MPEG_AUDIO_ENCODING:
970 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
971 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
972 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
973 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
974 case V4L2_CID_MPEG_AUDIO_MODE:
975 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
976 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
977 case V4L2_CID_MPEG_AUDIO_CRC:
24c19a21
HV
978 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
979 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
0996517c
HV
980 case V4L2_CID_MPEG_VIDEO_ENCODING:
981 case V4L2_CID_MPEG_VIDEO_ASPECT:
982 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
983 case V4L2_CID_MPEG_STREAM_TYPE:
984 case V4L2_CID_MPEG_STREAM_VBI_FMT:
985 case V4L2_CID_EXPOSURE_AUTO:
2272ab65 986 case V4L2_CID_AUTO_FOCUS_RANGE:
0996517c 987 case V4L2_CID_COLORFX:
e40a0573 988 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
0996517c 989 case V4L2_CID_TUNE_PREEMPHASIS:
0b159acd
SA
990 case V4L2_CID_FLASH_LED_MODE:
991 case V4L2_CID_FLASH_STROBE_SOURCE:
064f5096
KD
992 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
993 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
994 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
995 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
996 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
997 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
998 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
2e81dde9
AK
999 case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
1000 case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
064f5096
KD
1001 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
1002 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
c7361ae1 1003 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
7f84ad8b 1004 case V4L2_CID_ISO_SENSITIVITY_AUTO:
cf072139 1005 case V4L2_CID_EXPOSURE_METERING:
0bf6b7dc 1006 case V4L2_CID_SCENE_MODE:
977ebec7
HV
1007 case V4L2_CID_DV_TX_MODE:
1008 case V4L2_CID_DV_TX_RGB_RANGE:
1009 case V4L2_CID_DV_RX_RGB_RANGE:
5ebef0fb 1010 case V4L2_CID_TEST_PATTERN:
aec330a8 1011 case V4L2_CID_TUNE_DEEMPHASIS:
bc9028e1 1012 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
a77b4fc0 1013 case V4L2_CID_DETECT_MD_MODE:
0996517c
HV
1014 *type = V4L2_CTRL_TYPE_MENU;
1015 break;
c643ee13
SA
1016 case V4L2_CID_LINK_FREQ:
1017 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
1018 break;
0996517c
HV
1019 case V4L2_CID_RDS_TX_PS_NAME:
1020 case V4L2_CID_RDS_TX_RADIO_TEXT:
1021 *type = V4L2_CTRL_TYPE_STRING;
1022 break;
7f84ad8b 1023 case V4L2_CID_ISO_SENSITIVITY:
d58083c9 1024 case V4L2_CID_AUTO_EXPOSURE_BIAS:
bc9028e1
AK
1025 case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
1026 case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
d58083c9
SN
1027 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
1028 break;
0996517c
HV
1029 case V4L2_CID_USER_CLASS:
1030 case V4L2_CID_CAMERA_CLASS:
1031 case V4L2_CID_MPEG_CLASS:
1032 case V4L2_CID_FM_TX_CLASS:
0b159acd 1033 case V4L2_CID_FLASH_CLASS:
c7361ae1 1034 case V4L2_CID_JPEG_CLASS:
8c9d236e 1035 case V4L2_CID_IMAGE_SOURCE_CLASS:
c643ee13 1036 case V4L2_CID_IMAGE_PROC_CLASS:
977ebec7 1037 case V4L2_CID_DV_CLASS:
aec330a8 1038 case V4L2_CID_FM_RX_CLASS:
80807fad 1039 case V4L2_CID_RF_TUNER_CLASS:
a77b4fc0 1040 case V4L2_CID_DETECT_CLASS:
0996517c
HV
1041 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
1042 /* You can neither read not write these */
1043 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
1044 *min = *max = *step = *def = 0;
1045 break;
1046 case V4L2_CID_BG_COLOR:
1047 *type = V4L2_CTRL_TYPE_INTEGER;
1048 *step = 1;
1049 *min = 0;
1050 /* Max is calculated as RGB888 that is 2^24 */
1051 *max = 0xFFFFFF;
1052 break;
0b159acd 1053 case V4L2_CID_FLASH_FAULT:
c7361ae1 1054 case V4L2_CID_JPEG_ACTIVE_MARKER:
fc162a09 1055 case V4L2_CID_3A_LOCK:
2272ab65 1056 case V4L2_CID_AUTO_FOCUS_STATUS:
977ebec7
HV
1057 case V4L2_CID_DV_TX_HOTPLUG:
1058 case V4L2_CID_DV_TX_RXSENSE:
1059 case V4L2_CID_DV_TX_EDID_PRESENT:
1060 case V4L2_CID_DV_RX_POWER_PRESENT:
0b159acd
SA
1061 *type = V4L2_CTRL_TYPE_BITMASK;
1062 break;
064f5096
KD
1063 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
1064 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
1065 *type = V4L2_CTRL_TYPE_INTEGER;
1066 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1067 break;
24c19a21 1068 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
0ba2aeb6
HV
1069 *type = V4L2_CTRL_TYPE_INTEGER64;
1070 *flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1071 *min = *def = 0;
1072 *max = 0x1ffffffffLL;
1073 *step = 1;
1074 break;
1075 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
1076 *type = V4L2_CTRL_TYPE_INTEGER64;
1077 *flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1078 *min = *def = 0;
1079 *max = 0x7fffffffffffffffLL;
1080 *step = 1;
1081 break;
c643ee13 1082 case V4L2_CID_PIXEL_RATE:
24c19a21 1083 *type = V4L2_CTRL_TYPE_INTEGER64;
c643ee13 1084 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
24c19a21 1085 break;
a77b4fc0
HV
1086 case V4L2_CID_DETECT_MD_REGION_GRID:
1087 *type = V4L2_CTRL_TYPE_U8;
1088 break;
1089 case V4L2_CID_DETECT_MD_THRESHOLD_GRID:
1090 *type = V4L2_CTRL_TYPE_U16;
1091 break;
0996517c
HV
1092 default:
1093 *type = V4L2_CTRL_TYPE_INTEGER;
1094 break;
1095 }
1096 switch (id) {
1097 case V4L2_CID_MPEG_AUDIO_ENCODING:
1098 case V4L2_CID_MPEG_AUDIO_MODE:
1099 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1100 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
1101 case V4L2_CID_MPEG_STREAM_TYPE:
1102 *flags |= V4L2_CTRL_FLAG_UPDATE;
1103 break;
1104 case V4L2_CID_AUDIO_VOLUME:
1105 case V4L2_CID_AUDIO_BALANCE:
1106 case V4L2_CID_AUDIO_BASS:
1107 case V4L2_CID_AUDIO_TREBLE:
1108 case V4L2_CID_BRIGHTNESS:
1109 case V4L2_CID_CONTRAST:
1110 case V4L2_CID_SATURATION:
1111 case V4L2_CID_HUE:
1112 case V4L2_CID_RED_BALANCE:
1113 case V4L2_CID_BLUE_BALANCE:
1114 case V4L2_CID_GAMMA:
1115 case V4L2_CID_SHARPNESS:
1116 case V4L2_CID_CHROMA_GAIN:
1117 case V4L2_CID_RDS_TX_DEVIATION:
1118 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
1119 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
1120 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
1121 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
1122 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
1123 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
1124 case V4L2_CID_PILOT_TONE_DEVIATION:
1125 case V4L2_CID_PILOT_TONE_FREQUENCY:
1126 case V4L2_CID_TUNE_POWER_LEVEL:
1127 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
80807fad
AP
1128 case V4L2_CID_RF_TUNER_LNA_GAIN:
1129 case V4L2_CID_RF_TUNER_MIXER_GAIN:
1130 case V4L2_CID_RF_TUNER_IF_GAIN:
3ce569fd 1131 case V4L2_CID_RF_TUNER_BANDWIDTH:
a77b4fc0 1132 case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD:
0996517c
HV
1133 *flags |= V4L2_CTRL_FLAG_SLIDER;
1134 break;
1135 case V4L2_CID_PAN_RELATIVE:
1136 case V4L2_CID_TILT_RELATIVE:
1137 case V4L2_CID_FOCUS_RELATIVE:
1138 case V4L2_CID_IRIS_RELATIVE:
1139 case V4L2_CID_ZOOM_RELATIVE:
1140 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1141 break;
0b159acd 1142 case V4L2_CID_FLASH_STROBE_STATUS:
2272ab65 1143 case V4L2_CID_AUTO_FOCUS_STATUS:
0b159acd 1144 case V4L2_CID_FLASH_READY:
977ebec7
HV
1145 case V4L2_CID_DV_TX_HOTPLUG:
1146 case V4L2_CID_DV_TX_RXSENSE:
1147 case V4L2_CID_DV_TX_EDID_PRESENT:
1148 case V4L2_CID_DV_RX_POWER_PRESENT:
0b159acd
SA
1149 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1150 break;
9aa4357e
AP
1151 case V4L2_CID_RF_TUNER_PLL_LOCK:
1152 *flags |= V4L2_CTRL_FLAG_VOLATILE;
1153 break;
0996517c
HV
1154 }
1155}
1156EXPORT_SYMBOL(v4l2_ctrl_fill);
1157
6e239399
HV
1158static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
1159{
1160 memset(ev->reserved, 0, sizeof(ev->reserved));
1161 ev->type = V4L2_EVENT_CTRL;
1162 ev->id = ctrl->id;
1163 ev->u.ctrl.changes = changes;
1164 ev->u.ctrl.type = ctrl->type;
1165 ev->u.ctrl.flags = ctrl->flags;
d9a25471 1166 if (ctrl->is_ptr)
6e239399
HV
1167 ev->u.ctrl.value64 = 0;
1168 else
2a9ec373 1169 ev->u.ctrl.value64 = *ctrl->p_cur.p_s64;
6e239399
HV
1170 ev->u.ctrl.minimum = ctrl->minimum;
1171 ev->u.ctrl.maximum = ctrl->maximum;
ce580fe5
SA
1172 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1173 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
6e239399
HV
1174 ev->u.ctrl.step = 1;
1175 else
1176 ev->u.ctrl.step = ctrl->step;
1177 ev->u.ctrl.default_value = ctrl->default_value;
1178}
1179
1180static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1181{
1182 struct v4l2_event ev;
77068d36 1183 struct v4l2_subscribed_event *sev;
6e239399 1184
77068d36 1185 if (list_empty(&ctrl->ev_subs))
3f66f0ed 1186 return;
6e239399
HV
1187 fill_event(&ev, ctrl, changes);
1188
77068d36 1189 list_for_each_entry(sev, &ctrl->ev_subs, node)
e3e72f39
HG
1190 if (sev->fh != fh ||
1191 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
77068d36 1192 v4l2_event_queue_fh(sev->fh, &ev);
6e239399
HV
1193}
1194
998e7659 1195static bool std_equal(const struct v4l2_ctrl *ctrl, u32 idx,
0176077a
HV
1196 union v4l2_ctrl_ptr ptr1,
1197 union v4l2_ctrl_ptr ptr2)
1198{
1199 switch (ctrl->type) {
1200 case V4L2_CTRL_TYPE_BUTTON:
1201 return false;
1202 case V4L2_CTRL_TYPE_STRING:
265c7f8a 1203 idx *= ctrl->elem_size;
0176077a 1204 /* strings are always 0-terminated */
265c7f8a 1205 return !strcmp(ptr1.p_char + idx, ptr2.p_char + idx);
0176077a 1206 case V4L2_CTRL_TYPE_INTEGER64:
265c7f8a 1207 return ptr1.p_s64[idx] == ptr2.p_s64[idx];
dda4a4d5
HV
1208 case V4L2_CTRL_TYPE_U8:
1209 return ptr1.p_u8[idx] == ptr2.p_u8[idx];
1210 case V4L2_CTRL_TYPE_U16:
1211 return ptr1.p_u16[idx] == ptr2.p_u16[idx];
0176077a 1212 default:
265c7f8a
HV
1213 if (ctrl->is_int)
1214 return ptr1.p_s32[idx] == ptr2.p_s32[idx];
1215 idx *= ctrl->elem_size;
1216 return !memcmp(ptr1.p + idx, ptr2.p + idx, ctrl->elem_size);
0176077a
HV
1217 }
1218}
1219
998e7659 1220static void std_init(const struct v4l2_ctrl *ctrl, u32 idx,
0176077a
HV
1221 union v4l2_ctrl_ptr ptr)
1222{
1223 switch (ctrl->type) {
1224 case V4L2_CTRL_TYPE_STRING:
265c7f8a
HV
1225 idx *= ctrl->elem_size;
1226 memset(ptr.p_char + idx, ' ', ctrl->minimum);
1227 ptr.p_char[idx + ctrl->minimum] = '\0';
0176077a
HV
1228 break;
1229 case V4L2_CTRL_TYPE_INTEGER64:
265c7f8a 1230 ptr.p_s64[idx] = ctrl->default_value;
0176077a
HV
1231 break;
1232 case V4L2_CTRL_TYPE_INTEGER:
1233 case V4L2_CTRL_TYPE_INTEGER_MENU:
1234 case V4L2_CTRL_TYPE_MENU:
1235 case V4L2_CTRL_TYPE_BITMASK:
1236 case V4L2_CTRL_TYPE_BOOLEAN:
265c7f8a 1237 ptr.p_s32[idx] = ctrl->default_value;
0176077a 1238 break;
dda4a4d5
HV
1239 case V4L2_CTRL_TYPE_U8:
1240 ptr.p_u8[idx] = ctrl->default_value;
1241 break;
1242 case V4L2_CTRL_TYPE_U16:
1243 ptr.p_u16[idx] = ctrl->default_value;
1244 break;
0176077a 1245 default:
302ab7ce
HV
1246 idx *= ctrl->elem_size;
1247 memset(ptr.p + idx, 0, ctrl->elem_size);
0176077a
HV
1248 break;
1249 }
1250}
1251
1252static void std_log(const struct v4l2_ctrl *ctrl)
1253{
1254 union v4l2_ctrl_ptr ptr = ctrl->p_cur;
1255
998e7659
HV
1256 if (ctrl->is_array) {
1257 unsigned i;
1258
1259 for (i = 0; i < ctrl->nr_of_dims; i++)
1260 pr_cont("[%u]", ctrl->dims[i]);
1261 pr_cont(" ");
1262 }
1263
0176077a
HV
1264 switch (ctrl->type) {
1265 case V4L2_CTRL_TYPE_INTEGER:
1266 pr_cont("%d", *ptr.p_s32);
1267 break;
1268 case V4L2_CTRL_TYPE_BOOLEAN:
1269 pr_cont("%s", *ptr.p_s32 ? "true" : "false");
1270 break;
1271 case V4L2_CTRL_TYPE_MENU:
1272 pr_cont("%s", ctrl->qmenu[*ptr.p_s32]);
1273 break;
1274 case V4L2_CTRL_TYPE_INTEGER_MENU:
1275 pr_cont("%lld", ctrl->qmenu_int[*ptr.p_s32]);
1276 break;
1277 case V4L2_CTRL_TYPE_BITMASK:
1278 pr_cont("0x%08x", *ptr.p_s32);
1279 break;
1280 case V4L2_CTRL_TYPE_INTEGER64:
1281 pr_cont("%lld", *ptr.p_s64);
1282 break;
1283 case V4L2_CTRL_TYPE_STRING:
1284 pr_cont("%s", ptr.p_char);
1285 break;
dda4a4d5
HV
1286 case V4L2_CTRL_TYPE_U8:
1287 pr_cont("%u", (unsigned)*ptr.p_u8);
1288 break;
1289 case V4L2_CTRL_TYPE_U16:
1290 pr_cont("%u", (unsigned)*ptr.p_u16);
1291 break;
0176077a
HV
1292 default:
1293 pr_cont("unknown type %d", ctrl->type);
1294 break;
1295 }
1296}
1297
1298/* Round towards the closest legal value */
1299#define ROUND_TO_RANGE(val, offset_type, ctrl) \
1300({ \
1301 offset_type offset; \
1302 val += (ctrl)->step / 2; \
1303 val = clamp_t(typeof(val), val, \
1304 (ctrl)->minimum, (ctrl)->maximum); \
1305 offset = (val) - (ctrl)->minimum; \
0d5e8c43 1306 offset = (ctrl)->step * (offset / (s32)(ctrl)->step); \
0176077a
HV
1307 val = (ctrl)->minimum + offset; \
1308 0; \
1309})
1310
1311/* Validate a new control */
998e7659 1312static int std_validate(const struct v4l2_ctrl *ctrl, u32 idx,
0176077a
HV
1313 union v4l2_ctrl_ptr ptr)
1314{
1315 size_t len;
0d5e8c43
HV
1316 u64 offset;
1317 s64 val;
0176077a
HV
1318
1319 switch (ctrl->type) {
1320 case V4L2_CTRL_TYPE_INTEGER:
265c7f8a 1321 return ROUND_TO_RANGE(ptr.p_s32[idx], u32, ctrl);
0176077a 1322 case V4L2_CTRL_TYPE_INTEGER64:
0d5e8c43
HV
1323 /*
1324 * We can't use the ROUND_TO_RANGE define here due to
1325 * the u64 divide that needs special care.
1326 */
1327 val = ptr.p_s64[idx];
1328 val += ctrl->step / 2;
1329 val = clamp_t(s64, val, ctrl->minimum, ctrl->maximum);
1330 offset = val - ctrl->minimum;
1331 do_div(offset, ctrl->step);
1332 ptr.p_s64[idx] = ctrl->minimum + offset * ctrl->step;
1333 return 0;
dda4a4d5
HV
1334 case V4L2_CTRL_TYPE_U8:
1335 return ROUND_TO_RANGE(ptr.p_u8[idx], u8, ctrl);
1336 case V4L2_CTRL_TYPE_U16:
1337 return ROUND_TO_RANGE(ptr.p_u16[idx], u16, ctrl);
0176077a
HV
1338
1339 case V4L2_CTRL_TYPE_BOOLEAN:
265c7f8a 1340 ptr.p_s32[idx] = !!ptr.p_s32[idx];
0176077a
HV
1341 return 0;
1342
1343 case V4L2_CTRL_TYPE_MENU:
1344 case V4L2_CTRL_TYPE_INTEGER_MENU:
265c7f8a 1345 if (ptr.p_s32[idx] < ctrl->minimum || ptr.p_s32[idx] > ctrl->maximum)
0176077a 1346 return -ERANGE;
265c7f8a 1347 if (ctrl->menu_skip_mask & (1 << ptr.p_s32[idx]))
0176077a
HV
1348 return -EINVAL;
1349 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
265c7f8a 1350 ctrl->qmenu[ptr.p_s32[idx]][0] == '\0')
0176077a
HV
1351 return -EINVAL;
1352 return 0;
1353
1354 case V4L2_CTRL_TYPE_BITMASK:
265c7f8a 1355 ptr.p_s32[idx] &= ctrl->maximum;
0176077a
HV
1356 return 0;
1357
1358 case V4L2_CTRL_TYPE_BUTTON:
1359 case V4L2_CTRL_TYPE_CTRL_CLASS:
265c7f8a 1360 ptr.p_s32[idx] = 0;
0176077a
HV
1361 return 0;
1362
1363 case V4L2_CTRL_TYPE_STRING:
265c7f8a
HV
1364 idx *= ctrl->elem_size;
1365 len = strlen(ptr.p_char + idx);
0176077a
HV
1366 if (len < ctrl->minimum)
1367 return -ERANGE;
0d5e8c43 1368 if ((len - (u32)ctrl->minimum) % (u32)ctrl->step)
0176077a
HV
1369 return -ERANGE;
1370 return 0;
1371
1372 default:
1373 return -EINVAL;
1374 }
1375}
1376
1377static const struct v4l2_ctrl_type_ops std_type_ops = {
1378 .equal = std_equal,
1379 .init = std_init,
1380 .log = std_log,
1381 .validate = std_validate,
1382};
1383
000e4f9a
HV
1384/* Helper function: copy the given control value back to the caller */
1385static int ptr_to_user(struct v4l2_ext_control *c,
1386 struct v4l2_ctrl *ctrl,
1387 union v4l2_ctrl_ptr ptr)
0996517c
HV
1388{
1389 u32 len;
1390
d9a25471 1391 if (ctrl->is_ptr && !ctrl->is_string)
40265bbe
HV
1392 return copy_to_user(c->ptr, ptr.p, c->size) ?
1393 -EFAULT : 0;
d9a25471 1394
0996517c
HV
1395 switch (ctrl->type) {
1396 case V4L2_CTRL_TYPE_STRING:
000e4f9a 1397 len = strlen(ptr.p_char);
0996517c 1398 if (c->size < len + 1) {
c336f75e 1399 c->size = ctrl->elem_size;
0996517c
HV
1400 return -ENOSPC;
1401 }
000e4f9a 1402 return copy_to_user(c->string, ptr.p_char, len + 1) ?
40265bbe 1403 -EFAULT : 0;
0996517c 1404 case V4L2_CTRL_TYPE_INTEGER64:
000e4f9a 1405 c->value64 = *ptr.p_s64;
0996517c
HV
1406 break;
1407 default:
000e4f9a 1408 c->value = *ptr.p_s32;
0996517c
HV
1409 break;
1410 }
1411 return 0;
1412}
1413
000e4f9a
HV
1414/* Helper function: copy the current control value back to the caller */
1415static int cur_to_user(struct v4l2_ext_control *c,
0996517c 1416 struct v4l2_ctrl *ctrl)
000e4f9a
HV
1417{
1418 return ptr_to_user(c, ctrl, ctrl->p_cur);
1419}
1420
1421/* Helper function: copy the new control value back to the caller */
1422static int new_to_user(struct v4l2_ext_control *c,
1423 struct v4l2_ctrl *ctrl)
1424{
1425 return ptr_to_user(c, ctrl, ctrl->p_new);
1426}
1427
1428/* Helper function: copy the caller-provider value to the given control value */
1429static int user_to_ptr(struct v4l2_ext_control *c,
1430 struct v4l2_ctrl *ctrl,
1431 union v4l2_ctrl_ptr ptr)
0996517c
HV
1432{
1433 int ret;
1434 u32 size;
1435
2a863793 1436 ctrl->is_new = 1;
302ab7ce
HV
1437 if (ctrl->is_ptr && !ctrl->is_string) {
1438 unsigned idx;
1439
40265bbe 1440 ret = copy_from_user(ptr.p, c->ptr, c->size) ? -EFAULT : 0;
302ab7ce
HV
1441 if (ret || !ctrl->is_array)
1442 return ret;
1443 for (idx = c->size / ctrl->elem_size; idx < ctrl->elems; idx++)
1444 ctrl->type_ops->init(ctrl, idx, ptr);
1445 return 0;
1446 }
d9a25471 1447
0996517c
HV
1448 switch (ctrl->type) {
1449 case V4L2_CTRL_TYPE_INTEGER64:
000e4f9a 1450 *ptr.p_s64 = c->value64;
0996517c
HV
1451 break;
1452 case V4L2_CTRL_TYPE_STRING:
1453 size = c->size;
1454 if (size == 0)
1455 return -ERANGE;
1456 if (size > ctrl->maximum + 1)
1457 size = ctrl->maximum + 1;
40265bbe 1458 ret = copy_from_user(ptr.p_char, c->string, size) ? -EFAULT : 0;
0996517c 1459 if (!ret) {
000e4f9a 1460 char last = ptr.p_char[size - 1];
0996517c 1461
000e4f9a 1462 ptr.p_char[size - 1] = 0;
0996517c
HV
1463 /* If the string was longer than ctrl->maximum,
1464 then return an error. */
000e4f9a 1465 if (strlen(ptr.p_char) == ctrl->maximum && last)
0996517c
HV
1466 return -ERANGE;
1467 }
40265bbe 1468 return ret;
0996517c 1469 default:
000e4f9a 1470 *ptr.p_s32 = c->value;
0996517c
HV
1471 break;
1472 }
1473 return 0;
1474}
1475
000e4f9a
HV
1476/* Helper function: copy the caller-provider value as the new control value */
1477static int user_to_new(struct v4l2_ext_control *c,
0996517c
HV
1478 struct v4l2_ctrl *ctrl)
1479{
000e4f9a
HV
1480 return user_to_ptr(c, ctrl, ctrl->p_new);
1481}
d9a25471 1482
000e4f9a
HV
1483/* Copy the one value to another. */
1484static void ptr_to_ptr(struct v4l2_ctrl *ctrl,
1485 union v4l2_ctrl_ptr from, union v4l2_ctrl_ptr to)
1486{
1487 if (ctrl == NULL)
1488 return;
302ab7ce 1489 memcpy(to.p, from.p, ctrl->elems * ctrl->elem_size);
0996517c
HV
1490}
1491
1492/* Copy the new value to the current value. */
2ccbe779 1493static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
0996517c 1494{
000e4f9a 1495 bool changed;
6e239399 1496
0996517c
HV
1497 if (ctrl == NULL)
1498 return;
9ea1b7a4
HV
1499
1500 /* has_changed is set by cluster_changed */
1501 changed = ctrl->has_changed;
1502 if (changed)
1503 ptr_to_ptr(ctrl, ctrl->p_new, ctrl->p_cur);
d9a25471 1504
2ccbe779
SN
1505 if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1506 /* Note: CH_FLAGS is only set for auto clusters. */
5626b8c7
HV
1507 ctrl->flags &=
1508 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1509 if (!is_cur_manual(ctrl->cluster[0])) {
72d877ca 1510 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
5626b8c7
HV
1511 if (ctrl->cluster[0]->has_volatiles)
1512 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1513 }
1249a3a8 1514 fh = NULL;
72d877ca 1515 }
2ccbe779 1516 if (changed || ch_flags) {
639884a6
HV
1517 /* If a control was changed that was not one of the controls
1518 modified by the application, then send the event to all. */
1519 if (!ctrl->is_new)
1520 fh = NULL;
6e239399 1521 send_event(fh, ctrl,
2ccbe779 1522 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
8ac7a949
HV
1523 if (ctrl->call_notify && changed && ctrl->handler->notify)
1524 ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
639884a6 1525 }
0996517c
HV
1526}
1527
1528/* Copy the current value to the new value */
1529static void cur_to_new(struct v4l2_ctrl *ctrl)
1530{
1531 if (ctrl == NULL)
1532 return;
000e4f9a 1533 ptr_to_ptr(ctrl, ctrl->p_cur, ctrl->p_new);
0996517c
HV
1534}
1535
1536/* Return non-zero if one or more of the controls in the cluster has a new
1537 value that differs from the current value. */
1538static int cluster_changed(struct v4l2_ctrl *master)
1539{
9ea1b7a4 1540 bool changed = false;
302ab7ce 1541 unsigned idx;
0996517c
HV
1542 int i;
1543
9ea1b7a4 1544 for (i = 0; i < master->ncontrols; i++) {
0996517c 1545 struct v4l2_ctrl *ctrl = master->cluster[i];
302ab7ce 1546 bool ctrl_changed = false;
0996517c
HV
1547
1548 if (ctrl == NULL)
1549 continue;
302ab7ce
HV
1550 for (idx = 0; !ctrl_changed && idx < ctrl->elems; idx++)
1551 ctrl_changed = !ctrl->type_ops->equal(ctrl, idx,
998e7659 1552 ctrl->p_cur, ctrl->p_new);
302ab7ce 1553 ctrl->has_changed = ctrl_changed;
9ea1b7a4 1554 changed |= ctrl->has_changed;
0996517c 1555 }
9ea1b7a4 1556 return changed;
0996517c
HV
1557}
1558
2ccbe779
SN
1559/* Control range checking */
1560static int check_range(enum v4l2_ctrl_type type,
0ba2aeb6 1561 s64 min, s64 max, u64 step, s64 def)
2ccbe779
SN
1562{
1563 switch (type) {
1564 case V4L2_CTRL_TYPE_BOOLEAN:
1565 if (step != 1 || max > 1 || min < 0)
1566 return -ERANGE;
1567 /* fall through */
dda4a4d5
HV
1568 case V4L2_CTRL_TYPE_U8:
1569 case V4L2_CTRL_TYPE_U16:
2ccbe779 1570 case V4L2_CTRL_TYPE_INTEGER:
0ba2aeb6
HV
1571 case V4L2_CTRL_TYPE_INTEGER64:
1572 if (step == 0 || min > max || def < min || def > max)
2ccbe779
SN
1573 return -ERANGE;
1574 return 0;
1575 case V4L2_CTRL_TYPE_BITMASK:
1576 if (step || min || !max || (def & ~max))
1577 return -ERANGE;
1578 return 0;
1579 case V4L2_CTRL_TYPE_MENU:
1580 case V4L2_CTRL_TYPE_INTEGER_MENU:
1581 if (min > max || def < min || def > max)
1582 return -ERANGE;
1583 /* Note: step == menu_skip_mask for menu controls.
1584 So here we check if the default value is masked out. */
1585 if (step && ((1 << def) & step))
1586 return -EINVAL;
1587 return 0;
1588 case V4L2_CTRL_TYPE_STRING:
1589 if (min > max || min < 0 || step < 1 || def)
1590 return -ERANGE;
1591 return 0;
1592 default:
1593 return 0;
1594 }
1595}
1596
03d5285b
LP
1597/* Validate a new control */
1598static int validate_new(const struct v4l2_ctrl *ctrl,
1599 struct v4l2_ext_control *c)
0996517c 1600{
0176077a 1601 union v4l2_ctrl_ptr ptr;
302ab7ce
HV
1602 unsigned idx;
1603 int err = 0;
1604
1605 if (!ctrl->is_ptr) {
1606 switch (ctrl->type) {
1607 case V4L2_CTRL_TYPE_INTEGER:
1608 case V4L2_CTRL_TYPE_INTEGER_MENU:
1609 case V4L2_CTRL_TYPE_MENU:
1610 case V4L2_CTRL_TYPE_BITMASK:
1611 case V4L2_CTRL_TYPE_BOOLEAN:
1612 case V4L2_CTRL_TYPE_BUTTON:
1613 case V4L2_CTRL_TYPE_CTRL_CLASS:
1614 ptr.p_s32 = &c->value;
1615 return ctrl->type_ops->validate(ctrl, 0, ptr);
1616
1617 case V4L2_CTRL_TYPE_INTEGER64:
1618 ptr.p_s64 = &c->value64;
1619 return ctrl->type_ops->validate(ctrl, 0, ptr);
1620 default:
1621 break;
1622 }
0996517c 1623 }
302ab7ce
HV
1624 ptr.p = c->ptr;
1625 for (idx = 0; !err && idx < c->size / ctrl->elem_size; idx++)
1626 err = ctrl->type_ops->validate(ctrl, idx, ptr);
1627 return err;
0996517c
HV
1628}
1629
1630static inline u32 node2id(struct list_head *node)
1631{
1632 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1633}
1634
1635/* Set the handler's error code if it wasn't set earlier already */
1636static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1637{
1638 if (hdl->error == 0)
1639 hdl->error = err;
1640 return err;
1641}
1642
1643/* Initialize the handler */
6cd247ef
AW
1644int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1645 unsigned nr_of_controls_hint,
1646 struct lock_class_key *key, const char *name)
0996517c 1647{
77e7c4e6
SA
1648 hdl->lock = &hdl->_lock;
1649 mutex_init(hdl->lock);
6cd247ef 1650 lockdep_set_class_and_name(hdl->lock, key, name);
0996517c
HV
1651 INIT_LIST_HEAD(&hdl->ctrls);
1652 INIT_LIST_HEAD(&hdl->ctrl_refs);
1653 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
9884d7be
TM
1654 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1655 GFP_KERNEL);
0996517c
HV
1656 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1657 return hdl->error;
1658}
6cd247ef 1659EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
0996517c
HV
1660
1661/* Free all controls and control refs */
1662void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1663{
1664 struct v4l2_ctrl_ref *ref, *next_ref;
1665 struct v4l2_ctrl *ctrl, *next_ctrl;
77068d36 1666 struct v4l2_subscribed_event *sev, *next_sev;
0996517c
HV
1667
1668 if (hdl == NULL || hdl->buckets == NULL)
1669 return;
1670
77e7c4e6 1671 mutex_lock(hdl->lock);
0996517c
HV
1672 /* Free all nodes */
1673 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1674 list_del(&ref->node);
1675 kfree(ref);
1676 }
1677 /* Free all controls owned by the handler */
1678 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1679 list_del(&ctrl->node);
77068d36
HV
1680 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1681 list_del(&sev->node);
0996517c
HV
1682 kfree(ctrl);
1683 }
1684 kfree(hdl->buckets);
1685 hdl->buckets = NULL;
1686 hdl->cached = NULL;
1687 hdl->error = 0;
77e7c4e6 1688 mutex_unlock(hdl->lock);
0996517c
HV
1689}
1690EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1691
1692/* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1693 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1694 with applications that do not use the NEXT_CTRL flag.
1695
1696 We just find the n-th private user control. It's O(N), but that should not
1697 be an issue in this particular case. */
1698static struct v4l2_ctrl_ref *find_private_ref(
1699 struct v4l2_ctrl_handler *hdl, u32 id)
1700{
1701 struct v4l2_ctrl_ref *ref;
1702
1703 id -= V4L2_CID_PRIVATE_BASE;
1704 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1705 /* Search for private user controls that are compatible with
1706 VIDIOC_G/S_CTRL. */
1707 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1708 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
d9a25471 1709 if (!ref->ctrl->is_int)
0996517c
HV
1710 continue;
1711 if (id == 0)
1712 return ref;
1713 id--;
1714 }
1715 }
1716 return NULL;
1717}
1718
1719/* Find a control with the given ID. */
1720static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1721{
1722 struct v4l2_ctrl_ref *ref;
1723 int bucket;
1724
1725 id &= V4L2_CTRL_ID_MASK;
1726
1727 /* Old-style private controls need special handling */
1728 if (id >= V4L2_CID_PRIVATE_BASE)
1729 return find_private_ref(hdl, id);
1730 bucket = id % hdl->nr_of_buckets;
1731
1732 /* Simple optimization: cache the last control found */
1733 if (hdl->cached && hdl->cached->ctrl->id == id)
1734 return hdl->cached;
1735
1736 /* Not in cache, search the hash */
1737 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1738 while (ref && ref->ctrl->id != id)
1739 ref = ref->next;
1740
1741 if (ref)
1742 hdl->cached = ref; /* cache it! */
1743 return ref;
1744}
1745
1746/* Find a control with the given ID. Take the handler's lock first. */
1747static struct v4l2_ctrl_ref *find_ref_lock(
1748 struct v4l2_ctrl_handler *hdl, u32 id)
1749{
1750 struct v4l2_ctrl_ref *ref = NULL;
1751
1752 if (hdl) {
77e7c4e6 1753 mutex_lock(hdl->lock);
0996517c 1754 ref = find_ref(hdl, id);
77e7c4e6 1755 mutex_unlock(hdl->lock);
0996517c
HV
1756 }
1757 return ref;
1758}
1759
1760/* Find a control with the given ID. */
1761struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1762{
1763 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1764
1765 return ref ? ref->ctrl : NULL;
1766}
1767EXPORT_SYMBOL(v4l2_ctrl_find);
1768
1769/* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1770static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1771 struct v4l2_ctrl *ctrl)
1772{
1773 struct v4l2_ctrl_ref *ref;
1774 struct v4l2_ctrl_ref *new_ref;
1775 u32 id = ctrl->id;
1776 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1777 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1778
d9a25471
HV
1779 /*
1780 * Automatically add the control class if it is not yet present and
1781 * the new control is not a compound control.
1782 */
1783 if (ctrl->type < V4L2_CTRL_COMPOUND_TYPES &&
1784 id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
0996517c
HV
1785 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1786 return hdl->error;
1787
1788 if (hdl->error)
1789 return hdl->error;
1790
1791 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1792 if (!new_ref)
1793 return handler_set_err(hdl, -ENOMEM);
1794 new_ref->ctrl = ctrl;
1795 if (ctrl->handler == hdl) {
1796 /* By default each control starts in a cluster of its own.
1797 new_ref->ctrl is basically a cluster array with one
1798 element, so that's perfect to use as the cluster pointer.
1799 But only do this for the handler that owns the control. */
1800 ctrl->cluster = &new_ref->ctrl;
1801 ctrl->ncontrols = 1;
1802 }
1803
1804 INIT_LIST_HEAD(&new_ref->node);
1805
77e7c4e6 1806 mutex_lock(hdl->lock);
0996517c
HV
1807
1808 /* Add immediately at the end of the list if the list is empty, or if
1809 the last element in the list has a lower ID.
1810 This ensures that when elements are added in ascending order the
1811 insertion is an O(1) operation. */
1812 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1813 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1814 goto insert_in_hash;
1815 }
1816
1817 /* Find insert position in sorted list */
1818 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1819 if (ref->ctrl->id < id)
1820 continue;
1821 /* Don't add duplicates */
1822 if (ref->ctrl->id == id) {
1823 kfree(new_ref);
1824 goto unlock;
1825 }
1826 list_add(&new_ref->node, ref->node.prev);
1827 break;
1828 }
1829
1830insert_in_hash:
1831 /* Insert the control node in the hash */
1832 new_ref->next = hdl->buckets[bucket];
1833 hdl->buckets[bucket] = new_ref;
1834
1835unlock:
77e7c4e6 1836 mutex_unlock(hdl->lock);
0996517c
HV
1837 return 0;
1838}
1839
1840/* Add a new control */
1841static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1842 const struct v4l2_ctrl_ops *ops,
0176077a 1843 const struct v4l2_ctrl_type_ops *type_ops,
0996517c 1844 u32 id, const char *name, enum v4l2_ctrl_type type,
0ba2aeb6 1845 s64 min, s64 max, u64 step, s64 def,
20d88eef 1846 const u32 dims[V4L2_CTRL_MAX_DIMS], u32 elem_size,
ce580fe5
SA
1847 u32 flags, const char * const *qmenu,
1848 const s64 *qmenu_int, void *priv)
0996517c
HV
1849{
1850 struct v4l2_ctrl *ctrl;
d9a25471 1851 unsigned sz_extra;
20d88eef
HV
1852 unsigned nr_of_dims = 0;
1853 unsigned elems = 1;
998e7659
HV
1854 bool is_array;
1855 unsigned tot_ctrl_size;
302ab7ce 1856 unsigned idx;
d9a25471 1857 void *data;
2ccbe779 1858 int err;
0996517c
HV
1859
1860 if (hdl->error)
1861 return NULL;
1862
20d88eef
HV
1863 while (dims && dims[nr_of_dims]) {
1864 elems *= dims[nr_of_dims];
1865 nr_of_dims++;
1866 if (nr_of_dims == V4L2_CTRL_MAX_DIMS)
1867 break;
1868 }
998e7659 1869 is_array = nr_of_dims > 0;
20d88eef 1870
dda4a4d5
HV
1871 /* Prefill elem_size for all types handled by std_type_ops */
1872 switch (type) {
1873 case V4L2_CTRL_TYPE_INTEGER64:
d9a25471 1874 elem_size = sizeof(s64);
dda4a4d5
HV
1875 break;
1876 case V4L2_CTRL_TYPE_STRING:
d9a25471 1877 elem_size = max + 1;
dda4a4d5
HV
1878 break;
1879 case V4L2_CTRL_TYPE_U8:
1880 elem_size = sizeof(u8);
1881 break;
1882 case V4L2_CTRL_TYPE_U16:
1883 elem_size = sizeof(u16);
1884 break;
1885 default:
1886 if (type < V4L2_CTRL_COMPOUND_TYPES)
1887 elem_size = sizeof(s32);
1888 break;
1889 }
998e7659 1890 tot_ctrl_size = elem_size * elems;
d9a25471 1891
0996517c 1892 /* Sanity checks */
998e7659
HV
1893 if (id == 0 || name == NULL || !elem_size ||
1894 id >= V4L2_CID_PRIVATE_BASE ||
0996517c 1895 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
2ccbe779 1896 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
fa4d7096
HV
1897 handler_set_err(hdl, -ERANGE);
1898 return NULL;
1899 }
2ccbe779
SN
1900 err = check_range(type, min, max, step, def);
1901 if (err) {
1902 handler_set_err(hdl, err);
02ac0480
HV
1903 return NULL;
1904 }
fa4d7096
HV
1905 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1906 handler_set_err(hdl, -ERANGE);
1907 return NULL;
1908 }
998e7659
HV
1909 if (is_array &&
1910 (type == V4L2_CTRL_TYPE_BUTTON ||
1911 type == V4L2_CTRL_TYPE_CTRL_CLASS)) {
1912 handler_set_err(hdl, -EINVAL);
1913 return NULL;
1914 }
0996517c 1915
d9a25471 1916 sz_extra = 0;
0996517c
HV
1917 if (type == V4L2_CTRL_TYPE_BUTTON)
1918 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1919 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1920 flags |= V4L2_CTRL_FLAG_READ_ONLY;
2a9ec373
HV
1921 else if (type == V4L2_CTRL_TYPE_INTEGER64 ||
1922 type == V4L2_CTRL_TYPE_STRING ||
998e7659
HV
1923 type >= V4L2_CTRL_COMPOUND_TYPES ||
1924 is_array)
1925 sz_extra += 2 * tot_ctrl_size;
0996517c
HV
1926
1927 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1928 if (ctrl == NULL) {
1929 handler_set_err(hdl, -ENOMEM);
1930 return NULL;
1931 }
1932
1933 INIT_LIST_HEAD(&ctrl->node);
77068d36 1934 INIT_LIST_HEAD(&ctrl->ev_subs);
0996517c
HV
1935 ctrl->handler = hdl;
1936 ctrl->ops = ops;
0176077a 1937 ctrl->type_ops = type_ops ? type_ops : &std_type_ops;
0996517c
HV
1938 ctrl->id = id;
1939 ctrl->name = name;
1940 ctrl->type = type;
1941 ctrl->flags = flags;
1942 ctrl->minimum = min;
1943 ctrl->maximum = max;
1944 ctrl->step = step;
d9a25471 1945 ctrl->default_value = def;
998e7659
HV
1946 ctrl->is_string = !is_array && type == V4L2_CTRL_TYPE_STRING;
1947 ctrl->is_ptr = is_array || type >= V4L2_CTRL_COMPOUND_TYPES || ctrl->is_string;
d9a25471 1948 ctrl->is_int = !ctrl->is_ptr && type != V4L2_CTRL_TYPE_INTEGER64;
998e7659 1949 ctrl->is_array = is_array;
20d88eef
HV
1950 ctrl->elems = elems;
1951 ctrl->nr_of_dims = nr_of_dims;
1952 if (nr_of_dims)
1953 memcpy(ctrl->dims, dims, nr_of_dims * sizeof(dims[0]));
d9a25471 1954 ctrl->elem_size = elem_size;
ce580fe5
SA
1955 if (type == V4L2_CTRL_TYPE_MENU)
1956 ctrl->qmenu = qmenu;
1957 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1958 ctrl->qmenu_int = qmenu_int;
0996517c 1959 ctrl->priv = priv;
d9a25471 1960 ctrl->cur.val = ctrl->val = def;
2a9ec373 1961 data = &ctrl[1];
d9a25471 1962
2a9ec373
HV
1963 if (!ctrl->is_int) {
1964 ctrl->p_new.p = data;
998e7659 1965 ctrl->p_cur.p = data + tot_ctrl_size;
0176077a
HV
1966 } else {
1967 ctrl->p_new.p = &ctrl->val;
1968 ctrl->p_cur.p = &ctrl->cur.val;
0996517c 1969 }
302ab7ce
HV
1970 for (idx = 0; idx < elems; idx++) {
1971 ctrl->type_ops->init(ctrl, idx, ctrl->p_cur);
1972 ctrl->type_ops->init(ctrl, idx, ctrl->p_new);
1973 }
0176077a 1974
0996517c
HV
1975 if (handler_new_ref(hdl, ctrl)) {
1976 kfree(ctrl);
1977 return NULL;
1978 }
77e7c4e6 1979 mutex_lock(hdl->lock);
0996517c 1980 list_add_tail(&ctrl->node, &hdl->ctrls);
77e7c4e6 1981 mutex_unlock(hdl->lock);
0996517c
HV
1982 return ctrl;
1983}
1984
1985struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1986 const struct v4l2_ctrl_config *cfg, void *priv)
1987{
1988 bool is_menu;
1989 struct v4l2_ctrl *ctrl;
1990 const char *name = cfg->name;
513521ea 1991 const char * const *qmenu = cfg->qmenu;
ce580fe5 1992 const s64 *qmenu_int = cfg->qmenu_int;
0996517c
HV
1993 enum v4l2_ctrl_type type = cfg->type;
1994 u32 flags = cfg->flags;
0ba2aeb6
HV
1995 s64 min = cfg->min;
1996 s64 max = cfg->max;
1997 u64 step = cfg->step;
1998 s64 def = cfg->def;
0996517c
HV
1999
2000 if (name == NULL)
2001 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
2002 &def, &flags);
2003
ce580fe5
SA
2004 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
2005 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
0996517c
HV
2006 if (is_menu)
2007 WARN_ON(step);
2008 else
2009 WARN_ON(cfg->menu_skip_mask);
ce580fe5 2010 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
0996517c 2011 qmenu = v4l2_ctrl_get_menu(cfg->id);
ce580fe5
SA
2012 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
2013 qmenu_int == NULL) {
2014 handler_set_err(hdl, -EINVAL);
2015 return NULL;
2016 }
0996517c 2017
0176077a 2018 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->type_ops, cfg->id, name,
0996517c 2019 type, min, max,
20d88eef
HV
2020 is_menu ? cfg->menu_skip_mask : step, def,
2021 cfg->dims, cfg->elem_size,
d9a25471 2022 flags, qmenu, qmenu_int, priv);
88365105 2023 if (ctrl)
0996517c 2024 ctrl->is_private = cfg->is_private;
0996517c
HV
2025 return ctrl;
2026}
2027EXPORT_SYMBOL(v4l2_ctrl_new_custom);
2028
2029/* Helper function for standard non-menu controls */
2030struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
2031 const struct v4l2_ctrl_ops *ops,
0ba2aeb6 2032 u32 id, s64 min, s64 max, u64 step, s64 def)
0996517c
HV
2033{
2034 const char *name;
2035 enum v4l2_ctrl_type type;
2036 u32 flags;
2037
2038 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
d9a25471
HV
2039 if (type == V4L2_CTRL_TYPE_MENU ||
2040 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
2041 type >= V4L2_CTRL_COMPOUND_TYPES) {
0996517c
HV
2042 handler_set_err(hdl, -EINVAL);
2043 return NULL;
2044 }
0176077a 2045 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
20d88eef 2046 min, max, step, def, NULL, 0,
d9a25471 2047 flags, NULL, NULL, NULL);
0996517c
HV
2048}
2049EXPORT_SYMBOL(v4l2_ctrl_new_std);
2050
2051/* Helper function for standard menu controls */
2052struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
2053 const struct v4l2_ctrl_ops *ops,
0ba2aeb6 2054 u32 id, u8 _max, u64 mask, u8 _def)
0996517c 2055{
d1e9b7c1
SN
2056 const char * const *qmenu = NULL;
2057 const s64 *qmenu_int = NULL;
fbbb29a6 2058 unsigned int qmenu_int_len = 0;
0996517c
HV
2059 const char *name;
2060 enum v4l2_ctrl_type type;
0ba2aeb6
HV
2061 s64 min;
2062 s64 max = _max;
2063 s64 def = _def;
2064 u64 step;
0996517c
HV
2065 u32 flags;
2066
2067 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
d1e9b7c1
SN
2068
2069 if (type == V4L2_CTRL_TYPE_MENU)
2070 qmenu = v4l2_ctrl_get_menu(id);
2071 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2072 qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
2073
2074 if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
0996517c
HV
2075 handler_set_err(hdl, -EINVAL);
2076 return NULL;
2077 }
0176077a 2078 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
20d88eef 2079 0, max, mask, def, NULL, 0,
d9a25471 2080 flags, qmenu, qmenu_int, NULL);
0996517c
HV
2081}
2082EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
2083
117a711a
LP
2084/* Helper function for standard menu controls with driver defined menu */
2085struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
0ba2aeb6
HV
2086 const struct v4l2_ctrl_ops *ops, u32 id, u8 _max,
2087 u64 mask, u8 _def, const char * const *qmenu)
117a711a
LP
2088{
2089 enum v4l2_ctrl_type type;
2090 const char *name;
2091 u32 flags;
0ba2aeb6
HV
2092 u64 step;
2093 s64 min;
2094 s64 max = _max;
2095 s64 def = _def;
117a711a
LP
2096
2097 /* v4l2_ctrl_new_std_menu_items() should only be called for
2098 * standard controls without a standard menu.
2099 */
2100 if (v4l2_ctrl_get_menu(id)) {
2101 handler_set_err(hdl, -EINVAL);
2102 return NULL;
2103 }
2104
2105 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2106 if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
2107 handler_set_err(hdl, -EINVAL);
2108 return NULL;
2109 }
0176077a 2110 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
20d88eef
HV
2111 0, max, mask, def, NULL, 0,
2112 flags, qmenu, NULL, NULL);
117a711a
LP
2113
2114}
2115EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
2116
515f3287
SN
2117/* Helper function for standard integer menu controls */
2118struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
2119 const struct v4l2_ctrl_ops *ops,
0ba2aeb6 2120 u32 id, u8 _max, u8 _def, const s64 *qmenu_int)
515f3287
SN
2121{
2122 const char *name;
2123 enum v4l2_ctrl_type type;
0ba2aeb6
HV
2124 s64 min;
2125 u64 step;
2126 s64 max = _max;
2127 s64 def = _def;
515f3287
SN
2128 u32 flags;
2129
2130 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2131 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
2132 handler_set_err(hdl, -EINVAL);
2133 return NULL;
2134 }
0176077a 2135 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
20d88eef 2136 0, max, 0, def, NULL, 0,
d9a25471 2137 flags, NULL, qmenu_int, NULL);
515f3287
SN
2138}
2139EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
2140
0996517c
HV
2141/* Add a control from another handler to this handler */
2142struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
2143 struct v4l2_ctrl *ctrl)
2144{
2145 if (hdl == NULL || hdl->error)
2146 return NULL;
2147 if (ctrl == NULL) {
2148 handler_set_err(hdl, -EINVAL);
2149 return NULL;
2150 }
2151 if (ctrl->handler == hdl)
2152 return ctrl;
2153 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
2154}
2155EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
2156
2157/* Add the controls from another handler to our own. */
2158int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
34a6b7d0
HV
2159 struct v4l2_ctrl_handler *add,
2160 bool (*filter)(const struct v4l2_ctrl *ctrl))
0996517c 2161{
072e6602 2162 struct v4l2_ctrl_ref *ref;
0996517c
HV
2163 int ret = 0;
2164
2165 /* Do nothing if either handler is NULL or if they are the same */
2166 if (!hdl || !add || hdl == add)
2167 return 0;
2168 if (hdl->error)
2169 return hdl->error;
77e7c4e6 2170 mutex_lock(add->lock);
072e6602
HV
2171 list_for_each_entry(ref, &add->ctrl_refs, node) {
2172 struct v4l2_ctrl *ctrl = ref->ctrl;
2173
0996517c
HV
2174 /* Skip handler-private controls. */
2175 if (ctrl->is_private)
2176 continue;
6e239399
HV
2177 /* And control classes */
2178 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2179 continue;
34a6b7d0
HV
2180 /* Filter any unwanted controls */
2181 if (filter && !filter(ctrl))
2182 continue;
0996517c
HV
2183 ret = handler_new_ref(hdl, ctrl);
2184 if (ret)
2185 break;
2186 }
77e7c4e6 2187 mutex_unlock(add->lock);
0996517c
HV
2188 return ret;
2189}
2190EXPORT_SYMBOL(v4l2_ctrl_add_handler);
2191
34a6b7d0
HV
2192bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
2193{
2194 if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
2195 return true;
3963d4fb
HV
2196 if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
2197 return true;
34a6b7d0
HV
2198 switch (ctrl->id) {
2199 case V4L2_CID_AUDIO_MUTE:
2200 case V4L2_CID_AUDIO_VOLUME:
2201 case V4L2_CID_AUDIO_BALANCE:
2202 case V4L2_CID_AUDIO_BASS:
2203 case V4L2_CID_AUDIO_TREBLE:
2204 case V4L2_CID_AUDIO_LOUDNESS:
2205 return true;
2206 default:
2207 break;
2208 }
2209 return false;
2210}
2211EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
2212
0996517c
HV
2213/* Cluster controls */
2214void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
2215{
5626b8c7 2216 bool has_volatiles = false;
0996517c
HV
2217 int i;
2218
2219 /* The first control is the master control and it must not be NULL */
c817d927
HV
2220 if (WARN_ON(ncontrols == 0 || controls[0] == NULL))
2221 return;
0996517c
HV
2222
2223 for (i = 0; i < ncontrols; i++) {
2224 if (controls[i]) {
2225 controls[i]->cluster = controls;
2226 controls[i]->ncontrols = ncontrols;
5626b8c7
HV
2227 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
2228 has_volatiles = true;
0996517c
HV
2229 }
2230 }
5626b8c7 2231 controls[0]->has_volatiles = has_volatiles;
0996517c
HV
2232}
2233EXPORT_SYMBOL(v4l2_ctrl_cluster);
2234
72d877ca
HV
2235void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
2236 u8 manual_val, bool set_volatile)
2237{
2238 struct v4l2_ctrl *master = controls[0];
5626b8c7 2239 u32 flag = 0;
72d877ca
HV
2240 int i;
2241
2242 v4l2_ctrl_cluster(ncontrols, controls);
2243 WARN_ON(ncontrols <= 1);
82a7c049 2244 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
5626b8c7 2245 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
72d877ca 2246 master->is_auto = true;
5626b8c7 2247 master->has_volatiles = set_volatile;
72d877ca
HV
2248 master->manual_mode_value = manual_val;
2249 master->flags |= V4L2_CTRL_FLAG_UPDATE;
5626b8c7
HV
2250
2251 if (!is_cur_manual(master))
2252 flag = V4L2_CTRL_FLAG_INACTIVE |
2253 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
72d877ca
HV
2254
2255 for (i = 1; i < ncontrols; i++)
88365105 2256 if (controls[i])
72d877ca 2257 controls[i]->flags |= flag;
72d877ca
HV
2258}
2259EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
2260
0996517c
HV
2261/* Activate/deactivate a control. */
2262void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
2263{
6e239399
HV
2264 /* invert since the actual flag is called 'inactive' */
2265 bool inactive = !active;
2266 bool old;
2267
0996517c
HV
2268 if (ctrl == NULL)
2269 return;
2270
6e239399 2271 if (inactive)
0996517c 2272 /* set V4L2_CTRL_FLAG_INACTIVE */
6e239399 2273 old = test_and_set_bit(4, &ctrl->flags);
0996517c
HV
2274 else
2275 /* clear V4L2_CTRL_FLAG_INACTIVE */
6e239399
HV
2276 old = test_and_clear_bit(4, &ctrl->flags);
2277 if (old != inactive)
2278 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
0996517c
HV
2279}
2280EXPORT_SYMBOL(v4l2_ctrl_activate);
2281
2282/* Grab/ungrab a control.
2283 Typically used when streaming starts and you want to grab controls,
2284 preventing the user from changing them.
2285
2286 Just call this and the framework will block any attempts to change
2287 these controls. */
2288void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
2289{
6e239399
HV
2290 bool old;
2291
0996517c
HV
2292 if (ctrl == NULL)
2293 return;
2294
6e239399 2295 v4l2_ctrl_lock(ctrl);
0996517c
HV
2296 if (grabbed)
2297 /* set V4L2_CTRL_FLAG_GRABBED */
6e239399 2298 old = test_and_set_bit(1, &ctrl->flags);
0996517c
HV
2299 else
2300 /* clear V4L2_CTRL_FLAG_GRABBED */
6e239399
HV
2301 old = test_and_clear_bit(1, &ctrl->flags);
2302 if (old != grabbed)
2303 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2304 v4l2_ctrl_unlock(ctrl);
0996517c
HV
2305}
2306EXPORT_SYMBOL(v4l2_ctrl_grab);
2307
2308/* Log the control name and value */
2309static void log_ctrl(const struct v4l2_ctrl *ctrl,
2310 const char *prefix, const char *colon)
2311{
0996517c
HV
2312 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2313 return;
2314 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2315 return;
2316
7eafbce9 2317 pr_info("%s%s%s: ", prefix, colon, ctrl->name);
0996517c 2318
0176077a
HV
2319 ctrl->type_ops->log(ctrl);
2320
88365105
HV
2321 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2322 V4L2_CTRL_FLAG_GRABBED |
2323 V4L2_CTRL_FLAG_VOLATILE)) {
2324 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
7eafbce9 2325 pr_cont(" inactive");
88365105 2326 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
7eafbce9 2327 pr_cont(" grabbed");
88365105 2328 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
7eafbce9 2329 pr_cont(" volatile");
88365105 2330 }
7eafbce9 2331 pr_cont("\n");
0996517c
HV
2332}
2333
2334/* Log all controls owned by the handler */
2335void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2336 const char *prefix)
2337{
2338 struct v4l2_ctrl *ctrl;
2339 const char *colon = "";
2340 int len;
2341
2342 if (hdl == NULL)
2343 return;
2344 if (prefix == NULL)
2345 prefix = "";
2346 len = strlen(prefix);
2347 if (len && prefix[len - 1] != ' ')
2348 colon = ": ";
77e7c4e6 2349 mutex_lock(hdl->lock);
0996517c
HV
2350 list_for_each_entry(ctrl, &hdl->ctrls, node)
2351 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2352 log_ctrl(ctrl, prefix, colon);
77e7c4e6 2353 mutex_unlock(hdl->lock);
0996517c
HV
2354}
2355EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2356
ffa9b9f0
SN
2357int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2358{
2359 v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2360 return 0;
2361}
2362EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2363
0996517c
HV
2364/* Call s_ctrl for all controls owned by the handler */
2365int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2366{
2367 struct v4l2_ctrl *ctrl;
2368 int ret = 0;
2369
2370 if (hdl == NULL)
2371 return 0;
77e7c4e6 2372 mutex_lock(hdl->lock);
0996517c
HV
2373 list_for_each_entry(ctrl, &hdl->ctrls, node)
2374 ctrl->done = false;
2375
2376 list_for_each_entry(ctrl, &hdl->ctrls, node) {
2377 struct v4l2_ctrl *master = ctrl->cluster[0];
2378 int i;
2379
2380 /* Skip if this control was already handled by a cluster. */
71c6c4c9
HV
2381 /* Skip button controls and read-only controls. */
2382 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2383 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
0996517c
HV
2384 continue;
2385
2a863793
HV
2386 for (i = 0; i < master->ncontrols; i++) {
2387 if (master->cluster[i]) {
2388 cur_to_new(master->cluster[i]);
2389 master->cluster[i]->is_new = 1;
71c6c4c9 2390 master->cluster[i]->done = true;
2a863793
HV
2391 }
2392 }
54c911eb 2393 ret = call_op(master, s_ctrl);
0996517c
HV
2394 if (ret)
2395 break;
0996517c 2396 }
77e7c4e6 2397 mutex_unlock(hdl->lock);
0996517c
HV
2398 return ret;
2399}
2400EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2401
d9a25471
HV
2402/* Implement VIDIOC_QUERY_EXT_CTRL */
2403int v4l2_query_ext_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_query_ext_ctrl *qc)
0996517c 2404{
d9a25471 2405 const unsigned next_flags = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND;
0996517c
HV
2406 u32 id = qc->id & V4L2_CTRL_ID_MASK;
2407 struct v4l2_ctrl_ref *ref;
2408 struct v4l2_ctrl *ctrl;
2409
2410 if (hdl == NULL)
2411 return -EINVAL;
2412
77e7c4e6 2413 mutex_lock(hdl->lock);
0996517c
HV
2414
2415 /* Try to find it */
2416 ref = find_ref(hdl, id);
2417
d9a25471
HV
2418 if ((qc->id & next_flags) && !list_empty(&hdl->ctrl_refs)) {
2419 bool is_compound;
2420 /* Match any control that is not hidden */
2421 unsigned mask = 1;
2422 bool match = false;
2423
2424 if ((qc->id & next_flags) == V4L2_CTRL_FLAG_NEXT_COMPOUND) {
2425 /* Match any hidden control */
2426 match = true;
2427 } else if ((qc->id & next_flags) == next_flags) {
2428 /* Match any control, compound or not */
2429 mask = 0;
2430 }
2431
0996517c
HV
2432 /* Find the next control with ID > qc->id */
2433
2434 /* Did we reach the end of the control list? */
2435 if (id >= node2id(hdl->ctrl_refs.prev)) {
2436 ref = NULL; /* Yes, so there is no next control */
2437 } else if (ref) {
2438 /* We found a control with the given ID, so just get
d9a25471
HV
2439 the next valid one in the list. */
2440 list_for_each_entry_continue(ref, &hdl->ctrl_refs, node) {
2441 is_compound =
2442 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2443 if (id < ref->ctrl->id &&
2444 (is_compound & mask) == match)
2445 break;
2446 }
2447 if (&ref->node == &hdl->ctrl_refs)
2448 ref = NULL;
0996517c
HV
2449 } else {
2450 /* No control with the given ID exists, so start
2451 searching for the next largest ID. We know there
2452 is one, otherwise the first 'if' above would have
2453 been true. */
d9a25471
HV
2454 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
2455 is_compound =
2456 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2457 if (id < ref->ctrl->id &&
2458 (is_compound & mask) == match)
0996517c 2459 break;
d9a25471
HV
2460 }
2461 if (&ref->node == &hdl->ctrl_refs)
2462 ref = NULL;
0996517c
HV
2463 }
2464 }
77e7c4e6 2465 mutex_unlock(hdl->lock);
d9a25471 2466
0996517c
HV
2467 if (!ref)
2468 return -EINVAL;
2469
2470 ctrl = ref->ctrl;
2471 memset(qc, 0, sizeof(*qc));
829fb2dc
HV
2472 if (id >= V4L2_CID_PRIVATE_BASE)
2473 qc->id = id;
2474 else
2475 qc->id = ctrl->id;
0996517c 2476 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
d9a25471
HV
2477 qc->flags = ctrl->flags;
2478 qc->type = ctrl->type;
2479 if (ctrl->is_ptr)
2480 qc->flags |= V4L2_CTRL_FLAG_HAS_PAYLOAD;
2481 qc->elem_size = ctrl->elem_size;
20d88eef
HV
2482 qc->elems = ctrl->elems;
2483 qc->nr_of_dims = ctrl->nr_of_dims;
2484 memcpy(qc->dims, ctrl->dims, qc->nr_of_dims * sizeof(qc->dims[0]));
0996517c
HV
2485 qc->minimum = ctrl->minimum;
2486 qc->maximum = ctrl->maximum;
2487 qc->default_value = ctrl->default_value;
ce580fe5
SA
2488 if (ctrl->type == V4L2_CTRL_TYPE_MENU
2489 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
0996517c
HV
2490 qc->step = 1;
2491 else
2492 qc->step = ctrl->step;
d9a25471
HV
2493 return 0;
2494}
2495EXPORT_SYMBOL(v4l2_query_ext_ctrl);
2496
2497/* Implement VIDIOC_QUERYCTRL */
2498int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2499{
2500 struct v4l2_query_ext_ctrl qec = { qc->id };
2501 int rc;
2502
2503 rc = v4l2_query_ext_ctrl(hdl, &qec);
2504 if (rc)
2505 return rc;
2506
2507 qc->id = qec.id;
2508 qc->type = qec.type;
2509 qc->flags = qec.flags;
2510 strlcpy(qc->name, qec.name, sizeof(qc->name));
2511 switch (qc->type) {
2512 case V4L2_CTRL_TYPE_INTEGER:
2513 case V4L2_CTRL_TYPE_BOOLEAN:
2514 case V4L2_CTRL_TYPE_MENU:
2515 case V4L2_CTRL_TYPE_INTEGER_MENU:
2516 case V4L2_CTRL_TYPE_STRING:
2517 case V4L2_CTRL_TYPE_BITMASK:
2518 qc->minimum = qec.minimum;
2519 qc->maximum = qec.maximum;
2520 qc->step = qec.step;
2521 qc->default_value = qec.default_value;
2522 break;
2523 default:
2524 qc->minimum = 0;
2525 qc->maximum = 0;
2526 qc->step = 0;
2527 qc->default_value = 0;
2528 break;
2529 }
0996517c
HV
2530 return 0;
2531}
2532EXPORT_SYMBOL(v4l2_queryctrl);
2533
2534int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2535{
d9a25471 2536 if (qc->id & (V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND))
87a0c94c 2537 return -EINVAL;
0996517c
HV
2538 return v4l2_queryctrl(sd->ctrl_handler, qc);
2539}
2540EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2541
2542/* Implement VIDIOC_QUERYMENU */
2543int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2544{
2545 struct v4l2_ctrl *ctrl;
2546 u32 i = qm->index;
2547
2548 ctrl = v4l2_ctrl_find(hdl, qm->id);
2549 if (!ctrl)
2550 return -EINVAL;
2551
2552 qm->reserved = 0;
2553 /* Sanity checks */
ce580fe5
SA
2554 switch (ctrl->type) {
2555 case V4L2_CTRL_TYPE_MENU:
2556 if (ctrl->qmenu == NULL)
2557 return -EINVAL;
2558 break;
2559 case V4L2_CTRL_TYPE_INTEGER_MENU:
2560 if (ctrl->qmenu_int == NULL)
2561 return -EINVAL;
2562 break;
2563 default:
2564 return -EINVAL;
2565 }
2566
2567 if (i < ctrl->minimum || i > ctrl->maximum)
0996517c 2568 return -EINVAL;
ce580fe5 2569
0996517c
HV
2570 /* Use mask to see if this menu item should be skipped */
2571 if (ctrl->menu_skip_mask & (1 << i))
2572 return -EINVAL;
2573 /* Empty menu items should also be skipped */
ce580fe5
SA
2574 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2575 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2576 return -EINVAL;
2577 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2578 } else {
2579 qm->value = ctrl->qmenu_int[i];
2580 }
0996517c
HV
2581 return 0;
2582}
2583EXPORT_SYMBOL(v4l2_querymenu);
2584
2585int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2586{
2587 return v4l2_querymenu(sd->ctrl_handler, qm);
2588}
2589EXPORT_SYMBOL(v4l2_subdev_querymenu);
2590
2591
2592
2593/* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2594
2595 It is not a fully atomic operation, just best-effort only. After all, if
2596 multiple controls have to be set through multiple i2c writes (for example)
2597 then some initial writes may succeed while others fail. Thus leaving the
2598 system in an inconsistent state. The question is how much effort you are
2599 willing to spend on trying to make something atomic that really isn't.
2600
2601 From the point of view of an application the main requirement is that
2602 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2603 error should be returned without actually affecting any controls.
2604
2605 If all the values are correct, then it is acceptable to just give up
2606 in case of low-level errors.
2607
2608 It is important though that the application can tell when only a partial
2609 configuration was done. The way we do that is through the error_idx field
2610 of struct v4l2_ext_controls: if that is equal to the count field then no
2611 controls were affected. Otherwise all controls before that index were
2612 successful in performing their 'get' or 'set' operation, the control at
2613 the given index failed, and you don't know what happened with the controls
2614 after the failed one. Since if they were part of a control cluster they
2615 could have been successfully processed (if a cluster member was encountered
2616 at index < error_idx), they could have failed (if a cluster member was at
2617 error_idx), or they may not have been processed yet (if the first cluster
2618 member appeared after error_idx).
2619
2620 It is all fairly theoretical, though. In practice all you can do is to
2621 bail out. If error_idx == count, then it is an application bug. If
2622 error_idx < count then it is only an application bug if the error code was
2623 EBUSY. That usually means that something started streaming just when you
2624 tried to set the controls. In all other cases it is a driver/hardware
2625 problem and all you can do is to retry or bail out.
2626
2627 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2628 never modifies controls the error_idx is just set to whatever control
2629 has an invalid value.
2630 */
2631
2632/* Prepare for the extended g/s/try functions.
2633 Find the controls in the control array and do some basic checks. */
2634static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2635 struct v4l2_ext_controls *cs,
d9a25471
HV
2636 struct v4l2_ctrl_helper *helpers,
2637 bool get)
0996517c 2638{
eb5b16ef
HV
2639 struct v4l2_ctrl_helper *h;
2640 bool have_clusters = false;
0996517c
HV
2641 u32 i;
2642
eb5b16ef 2643 for (i = 0, h = helpers; i < cs->count; i++, h++) {
0996517c 2644 struct v4l2_ext_control *c = &cs->controls[i];
eb5b16ef 2645 struct v4l2_ctrl_ref *ref;
0996517c
HV
2646 struct v4l2_ctrl *ctrl;
2647 u32 id = c->id & V4L2_CTRL_ID_MASK;
2648
37cd3b73 2649 cs->error_idx = i;
0996517c
HV
2650
2651 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2652 return -EINVAL;
2653
2654 /* Old-style private controls are not allowed for
2655 extended controls */
2656 if (id >= V4L2_CID_PRIVATE_BASE)
2657 return -EINVAL;
eb5b16ef
HV
2658 ref = find_ref_lock(hdl, id);
2659 if (ref == NULL)
0996517c 2660 return -EINVAL;
eb5b16ef 2661 ctrl = ref->ctrl;
0996517c
HV
2662 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2663 return -EINVAL;
2664
eb5b16ef
HV
2665 if (ctrl->cluster[0]->ncontrols > 1)
2666 have_clusters = true;
2667 if (ctrl->cluster[0] != ctrl)
2668 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
302ab7ce
HV
2669 if (ctrl->is_ptr && !ctrl->is_string) {
2670 unsigned tot_size = ctrl->elems * ctrl->elem_size;
2671
2672 if (c->size < tot_size) {
2673 if (get) {
2674 c->size = tot_size;
2675 return -ENOSPC;
2676 }
2677 return -EFAULT;
d9a25471 2678 }
302ab7ce 2679 c->size = tot_size;
d9a25471 2680 }
eb5b16ef
HV
2681 /* Store the ref to the master control of the cluster */
2682 h->mref = ref;
2683 h->ctrl = ctrl;
2684 /* Initially set next to 0, meaning that there is no other
2685 control in this helper array belonging to the same
2686 cluster */
2687 h->next = 0;
0996517c 2688 }
0996517c 2689
eb5b16ef
HV
2690 /* We are done if there were no controls that belong to a multi-
2691 control cluster. */
2692 if (!have_clusters)
2693 return 0;
0996517c 2694
eb5b16ef
HV
2695 /* The code below figures out in O(n) time which controls in the list
2696 belong to the same cluster. */
0996517c 2697
eb5b16ef 2698 /* This has to be done with the handler lock taken. */
77e7c4e6 2699 mutex_lock(hdl->lock);
0996517c 2700
eb5b16ef
HV
2701 /* First zero the helper field in the master control references */
2702 for (i = 0; i < cs->count; i++)
c082266f 2703 helpers[i].mref->helper = NULL;
eb5b16ef
HV
2704 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2705 struct v4l2_ctrl_ref *mref = h->mref;
2706
2707 /* If the mref->helper is set, then it points to an earlier
2708 helper that belongs to the same cluster. */
2709 if (mref->helper) {
2710 /* Set the next field of mref->helper to the current
2711 index: this means that that earlier helper now
2712 points to the next helper in the same cluster. */
2713 mref->helper->next = i;
2714 /* mref should be set only for the first helper in the
2715 cluster, clear the others. */
2716 h->mref = NULL;
2717 }
2718 /* Point the mref helper to the current helper struct. */
2719 mref->helper = h;
0996517c 2720 }
77e7c4e6 2721 mutex_unlock(hdl->lock);
eb5b16ef 2722 return 0;
0996517c
HV
2723}
2724
2725/* Handles the corner case where cs->count == 0. It checks whether the
2726 specified control class exists. If that class ID is 0, then it checks
2727 whether there are any controls at all. */
2728static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2729{
2730 if (ctrl_class == 0)
2731 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2732 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2733}
2734
2735
2736
2737/* Get extended controls. Allocates the helpers array if needed. */
2738int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2739{
eb5b16ef
HV
2740 struct v4l2_ctrl_helper helper[4];
2741 struct v4l2_ctrl_helper *helpers = helper;
0996517c 2742 int ret;
ddac5c10 2743 int i, j;
0996517c
HV
2744
2745 cs->error_idx = cs->count;
2746 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2747
2748 if (hdl == NULL)
2749 return -EINVAL;
2750
2751 if (cs->count == 0)
2752 return class_check(hdl, cs->ctrl_class);
2753
2754 if (cs->count > ARRAY_SIZE(helper)) {
5f0049bd
XW
2755 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2756 GFP_KERNEL);
0996517c
HV
2757 if (helpers == NULL)
2758 return -ENOMEM;
2759 }
2760
d9a25471 2761 ret = prepare_ext_ctrls(hdl, cs, helpers, true);
37cd3b73 2762 cs->error_idx = cs->count;
0996517c
HV
2763
2764 for (i = 0; !ret && i < cs->count; i++)
2765 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2766 ret = -EACCES;
2767
2768 for (i = 0; !ret && i < cs->count; i++) {
eb5b16ef
HV
2769 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2770 struct v4l2_ctrl *ctrl) = cur_to_user;
2771 struct v4l2_ctrl *master;
0996517c 2772
eb5b16ef 2773 if (helpers[i].mref == NULL)
0996517c
HV
2774 continue;
2775
eb5b16ef 2776 master = helpers[i].mref->ctrl;
0996517c
HV
2777 cs->error_idx = i;
2778
2779 v4l2_ctrl_lock(master);
ddac5c10
HV
2780
2781 /* g_volatile_ctrl will update the new control values */
5626b8c7
HV
2782 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2783 (master->has_volatiles && !is_cur_manual(master))) {
ddac5c10
HV
2784 for (j = 0; j < master->ncontrols; j++)
2785 cur_to_new(master->cluster[j]);
54c911eb 2786 ret = call_op(master, g_volatile_ctrl);
eb5b16ef 2787 ctrl_to_user = new_to_user;
ddac5c10
HV
2788 }
2789 /* If OK, then copy the current (for non-volatile controls)
2790 or the new (for volatile controls) control values to the
2791 caller */
eb5b16ef
HV
2792 if (!ret) {
2793 u32 idx = i;
2794
2795 do {
2796 ret = ctrl_to_user(cs->controls + idx,
2797 helpers[idx].ctrl);
2798 idx = helpers[idx].next;
2799 } while (!ret && idx);
2800 }
0996517c 2801 v4l2_ctrl_unlock(master);
0996517c
HV
2802 }
2803
2804 if (cs->count > ARRAY_SIZE(helper))
2805 kfree(helpers);
2806 return ret;
2807}
2808EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2809
2810int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2811{
2812 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2813}
2814EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2815
2816/* Helper function to get a single control */
03d5285b 2817static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
0996517c
HV
2818{
2819 struct v4l2_ctrl *master = ctrl->cluster[0];
2820 int ret = 0;
ddac5c10 2821 int i;
0996517c 2822
d9a25471 2823 /* Compound controls are not supported. The new_to_user() and
03d5285b
LP
2824 * cur_to_user() calls below would need to be modified not to access
2825 * userspace memory when called from get_ctrl().
2826 */
d9a25471 2827 if (!ctrl->is_int)
03d5285b
LP
2828 return -EINVAL;
2829
0996517c
HV
2830 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2831 return -EACCES;
2832
2833 v4l2_ctrl_lock(master);
2834 /* g_volatile_ctrl will update the current control values */
5626b8c7 2835 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
ddac5c10
HV
2836 for (i = 0; i < master->ncontrols; i++)
2837 cur_to_new(master->cluster[i]);
54c911eb 2838 ret = call_op(master, g_volatile_ctrl);
03d5285b 2839 new_to_user(c, ctrl);
ddac5c10 2840 } else {
03d5285b 2841 cur_to_user(c, ctrl);
ddac5c10 2842 }
0996517c
HV
2843 v4l2_ctrl_unlock(master);
2844 return ret;
2845}
2846
2847int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2848{
2849 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
03d5285b
LP
2850 struct v4l2_ext_control c;
2851 int ret;
0996517c 2852
d9a25471 2853 if (ctrl == NULL || !ctrl->is_int)
0996517c 2854 return -EINVAL;
03d5285b
LP
2855 ret = get_ctrl(ctrl, &c);
2856 control->value = c.value;
2857 return ret;
0996517c
HV
2858}
2859EXPORT_SYMBOL(v4l2_g_ctrl);
2860
2861int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2862{
2863 return v4l2_g_ctrl(sd->ctrl_handler, control);
2864}
2865EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2866
2867s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2868{
03d5285b 2869 struct v4l2_ext_control c;
0996517c
HV
2870
2871 /* It's a driver bug if this happens. */
d9a25471 2872 WARN_ON(!ctrl->is_int);
03d5285b
LP
2873 c.value = 0;
2874 get_ctrl(ctrl, &c);
2875 return c.value;
0996517c
HV
2876}
2877EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2878
03d5285b
LP
2879s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
2880{
2881 struct v4l2_ext_control c;
2882
2883 /* It's a driver bug if this happens. */
998e7659 2884 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
03d5285b
LP
2885 c.value = 0;
2886 get_ctrl(ctrl, &c);
2887 return c.value;
2888}
2889EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
2890
0996517c
HV
2891
2892/* Core function that calls try/s_ctrl and ensures that the new value is
2893 copied to the current value on a set.
2894 Must be called with ctrl->handler->lock held. */
2ccbe779
SN
2895static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
2896 bool set, u32 ch_flags)
0996517c 2897{
72d877ca 2898 bool update_flag;
eb5b16ef 2899 int ret;
0996517c
HV
2900 int i;
2901
2902 /* Go through the cluster and either validate the new value or
2903 (if no new value was set), copy the current value to the new
2904 value, ensuring a consistent view for the control ops when
2905 called. */
eb5b16ef 2906 for (i = 0; i < master->ncontrols; i++) {
0996517c
HV
2907 struct v4l2_ctrl *ctrl = master->cluster[i];
2908
2909 if (ctrl == NULL)
2910 continue;
2911
eb5b16ef
HV
2912 if (!ctrl->is_new) {
2913 cur_to_new(ctrl);
0996517c
HV
2914 continue;
2915 }
eb5b16ef
HV
2916 /* Check again: it may have changed since the
2917 previous check in try_or_set_ext_ctrls(). */
2918 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2919 return -EBUSY;
0996517c
HV
2920 }
2921
eb5b16ef 2922 ret = call_op(master, try_ctrl);
0996517c
HV
2923
2924 /* Don't set if there is no change */
72d877ca
HV
2925 if (ret || !set || !cluster_changed(master))
2926 return ret;
2927 ret = call_op(master, s_ctrl);
72d877ca
HV
2928 if (ret)
2929 return ret;
2930
eb5b16ef 2931 /* If OK, then make the new values permanent. */
72d877ca
HV
2932 update_flag = is_cur_manual(master) != is_new_manual(master);
2933 for (i = 0; i < master->ncontrols; i++)
2ccbe779
SN
2934 new_to_cur(fh, master->cluster[i], ch_flags |
2935 ((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
72d877ca 2936 return 0;
0996517c
HV
2937}
2938
e6402585
HV
2939/* Validate controls. */
2940static int validate_ctrls(struct v4l2_ext_controls *cs,
2941 struct v4l2_ctrl_helper *helpers, bool set)
0996517c 2942{
e6402585 2943 unsigned i;
0996517c
HV
2944 int ret = 0;
2945
eb5b16ef 2946 cs->error_idx = cs->count;
0996517c
HV
2947 for (i = 0; i < cs->count; i++) {
2948 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2949
e6402585 2950 cs->error_idx = i;
0996517c
HV
2951
2952 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2953 return -EACCES;
2954 /* This test is also done in try_set_control_cluster() which
2955 is called in atomic context, so that has the final say,
2956 but it makes sense to do an up-front check as well. Once
2957 an error occurs in try_set_control_cluster() some other
2958 controls may have been set already and we want to do a
2959 best-effort to avoid that. */
2960 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2961 return -EBUSY;
eb5b16ef
HV
2962 ret = validate_new(ctrl, &cs->controls[i]);
2963 if (ret)
2964 return ret;
0996517c 2965 }
e6402585
HV
2966 return 0;
2967}
2968
5626b8c7
HV
2969/* Obtain the current volatile values of an autocluster and mark them
2970 as new. */
2971static void update_from_auto_cluster(struct v4l2_ctrl *master)
2972{
2973 int i;
2974
2975 for (i = 0; i < master->ncontrols; i++)
2976 cur_to_new(master->cluster[i]);
2977 if (!call_op(master, g_volatile_ctrl))
2978 for (i = 1; i < master->ncontrols; i++)
2979 if (master->cluster[i])
2980 master->cluster[i]->is_new = 1;
2981}
2982
e6402585
HV
2983/* Try or try-and-set controls */
2984static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2985 struct v4l2_ext_controls *cs,
2986 bool set)
2987{
2988 struct v4l2_ctrl_helper helper[4];
2989 struct v4l2_ctrl_helper *helpers = helper;
2990 unsigned i, j;
2991 int ret;
2992
2993 cs->error_idx = cs->count;
2994 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2995
2996 if (hdl == NULL)
2997 return -EINVAL;
2998
2999 if (cs->count == 0)
3000 return class_check(hdl, cs->ctrl_class);
0996517c 3001
e6402585 3002 if (cs->count > ARRAY_SIZE(helper)) {
0a3475eb
XW
3003 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
3004 GFP_KERNEL);
e6402585
HV
3005 if (!helpers)
3006 return -ENOMEM;
3007 }
d9a25471 3008 ret = prepare_ext_ctrls(hdl, cs, helpers, false);
e6402585
HV
3009 if (!ret)
3010 ret = validate_ctrls(cs, helpers, set);
3011 if (ret && set)
3012 cs->error_idx = cs->count;
0996517c 3013 for (i = 0; !ret && i < cs->count; i++) {
eb5b16ef
HV
3014 struct v4l2_ctrl *master;
3015 u32 idx = i;
0996517c 3016
eb5b16ef 3017 if (helpers[i].mref == NULL)
0996517c
HV
3018 continue;
3019
37cd3b73 3020 cs->error_idx = i;
eb5b16ef
HV
3021 master = helpers[i].mref->ctrl;
3022 v4l2_ctrl_lock(master);
0996517c 3023
2a863793 3024 /* Reset the 'is_new' flags of the cluster */
0996517c
HV
3025 for (j = 0; j < master->ncontrols; j++)
3026 if (master->cluster[j])
2a863793 3027 master->cluster[j]->is_new = 0;
0996517c 3028
5626b8c7
HV
3029 /* For volatile autoclusters that are currently in auto mode
3030 we need to discover if it will be set to manual mode.
3031 If so, then we have to copy the current volatile values
3032 first since those will become the new manual values (which
3033 may be overwritten by explicit new values from this set
3034 of controls). */
3035 if (master->is_auto && master->has_volatiles &&
3036 !is_cur_manual(master)) {
3037 /* Pick an initial non-manual value */
3038 s32 new_auto_val = master->manual_mode_value + 1;
3039 u32 tmp_idx = idx;
3040
3041 do {
3042 /* Check if the auto control is part of the
3043 list, and remember the new value. */
3044 if (helpers[tmp_idx].ctrl == master)
3045 new_auto_val = cs->controls[tmp_idx].value;
3046 tmp_idx = helpers[tmp_idx].next;
3047 } while (tmp_idx);
3048 /* If the new value == the manual value, then copy
3049 the current volatile values. */
3050 if (new_auto_val == master->manual_mode_value)
3051 update_from_auto_cluster(master);
3052 }
3053
0996517c 3054 /* Copy the new caller-supplied control values.
2a863793 3055 user_to_new() sets 'is_new' to 1. */
eb5b16ef
HV
3056 do {
3057 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
3058 idx = helpers[idx].next;
3059 } while (!ret && idx);
0996517c
HV
3060
3061 if (!ret)
2ccbe779 3062 ret = try_or_set_cluster(fh, master, set, 0);
0996517c
HV
3063
3064 /* Copy the new values back to userspace. */
eb5b16ef
HV
3065 if (!ret) {
3066 idx = i;
3067 do {
adf41b9b 3068 ret = new_to_user(cs->controls + idx,
e6402585 3069 helpers[idx].ctrl);
eb5b16ef
HV
3070 idx = helpers[idx].next;
3071 } while (!ret && idx);
3072 }
3073 v4l2_ctrl_unlock(master);
0996517c 3074 }
0996517c 3075
0996517c
HV
3076 if (cs->count > ARRAY_SIZE(helper))
3077 kfree(helpers);
3078 return ret;
3079}
3080
3081int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
3082{
ab892bac 3083 return try_set_ext_ctrls(NULL, hdl, cs, false);
0996517c
HV
3084}
3085EXPORT_SYMBOL(v4l2_try_ext_ctrls);
3086
ab892bac
HV
3087int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3088 struct v4l2_ext_controls *cs)
0996517c 3089{
ab892bac 3090 return try_set_ext_ctrls(fh, hdl, cs, true);
0996517c
HV
3091}
3092EXPORT_SYMBOL(v4l2_s_ext_ctrls);
3093
3094int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3095{
ab892bac 3096 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
0996517c
HV
3097}
3098EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
3099
3100int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3101{
ab892bac 3102 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
0996517c
HV
3103}
3104EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
3105
3106/* Helper function for VIDIOC_S_CTRL compatibility */
03d5285b 3107static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
2ccbe779 3108 struct v4l2_ext_control *c, u32 ch_flags)
0996517c
HV
3109{
3110 struct v4l2_ctrl *master = ctrl->cluster[0];
0996517c
HV
3111 int i;
3112
d9a25471 3113 /* Compound controls are not supported. The user_to_new() and
03d5285b
LP
3114 * cur_to_user() calls below would need to be modified not to access
3115 * userspace memory when called from set_ctrl().
3116 */
d9a25471 3117 if (ctrl->is_ptr)
03d5285b
LP
3118 return -EINVAL;
3119
2a863793 3120 /* Reset the 'is_new' flags of the cluster */
0996517c
HV
3121 for (i = 0; i < master->ncontrols; i++)
3122 if (master->cluster[i])
2a863793 3123 master->cluster[i]->is_new = 0;
0996517c 3124
5626b8c7
HV
3125 /* For autoclusters with volatiles that are switched from auto to
3126 manual mode we have to update the current volatile values since
3127 those will become the initial manual values after such a switch. */
3128 if (master->is_auto && master->has_volatiles && ctrl == master &&
03d5285b 3129 !is_cur_manual(master) && c->value == master->manual_mode_value)
5626b8c7 3130 update_from_auto_cluster(master);
03d5285b
LP
3131
3132 user_to_new(c, ctrl);
2ccbe779
SN
3133 return try_or_set_cluster(fh, master, true, ch_flags);
3134}
03d5285b 3135
2ccbe779
SN
3136/* Helper function for VIDIOC_S_CTRL compatibility */
3137static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
3138 struct v4l2_ext_control *c)
3139{
3140 int ret = validate_new(ctrl, c);
3141
3142 if (!ret) {
3143 v4l2_ctrl_lock(ctrl);
3144 ret = set_ctrl(fh, ctrl, c, 0);
3145 if (!ret)
3146 cur_to_user(c, ctrl);
3147 v4l2_ctrl_unlock(ctrl);
3148 }
0996517c
HV
3149 return ret;
3150}
3151
ab892bac
HV
3152int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3153 struct v4l2_control *control)
0996517c
HV
3154{
3155 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
03d5285b
LP
3156 struct v4l2_ext_control c;
3157 int ret;
0996517c 3158
d9a25471 3159 if (ctrl == NULL || !ctrl->is_int)
0996517c
HV
3160 return -EINVAL;
3161
7ebbc39f
HV
3162 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3163 return -EACCES;
3164
03d5285b 3165 c.value = control->value;
2ccbe779 3166 ret = set_ctrl_lock(fh, ctrl, &c);
03d5285b
LP
3167 control->value = c.value;
3168 return ret;
0996517c
HV
3169}
3170EXPORT_SYMBOL(v4l2_s_ctrl);
3171
3172int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
3173{
ab892bac 3174 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
0996517c
HV
3175}
3176EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
3177
0c4348ad 3178int __v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
0996517c 3179{
03d5285b 3180 struct v4l2_ext_control c;
0c4348ad
SA
3181 int rval;
3182
3183 lockdep_assert_held(ctrl->handler->lock);
03d5285b 3184
0996517c 3185 /* It's a driver bug if this happens. */
d9a25471 3186 WARN_ON(!ctrl->is_int);
03d5285b 3187 c.value = val;
0c4348ad
SA
3188 rval = set_ctrl(NULL, ctrl, &c, 0);
3189 if (!rval)
3190 cur_to_user(&c, ctrl);
3191
3192 return rval;
0996517c 3193}
0c4348ad 3194EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl);
6e239399 3195
0c4348ad 3196int __v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
03d5285b
LP
3197{
3198 struct v4l2_ext_control c;
0c4348ad
SA
3199 int rval;
3200
3201 lockdep_assert_held(ctrl->handler->lock);
03d5285b
LP
3202
3203 /* It's a driver bug if this happens. */
998e7659 3204 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
03d5285b 3205 c.value64 = val;
0c4348ad
SA
3206 rval = set_ctrl(NULL, ctrl, &c, 0);
3207 if (!rval)
3208 cur_to_user(&c, ctrl);
3209
3210 return rval;
03d5285b 3211}
0c4348ad 3212EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_int64);
03d5285b 3213
8ac7a949
HV
3214void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
3215{
3216 if (ctrl == NULL)
3217 return;
3218 if (notify == NULL) {
3219 ctrl->call_notify = 0;
3220 return;
3221 }
3222 if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
3223 return;
3224 ctrl->handler->notify = notify;
3225 ctrl->handler->notify_priv = priv;
3226 ctrl->call_notify = 1;
3227}
3228EXPORT_SYMBOL(v4l2_ctrl_notify);
3229
5a573925 3230int __v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
0ba2aeb6 3231 s64 min, s64 max, u64 step, s64 def)
2ccbe779 3232{
302ab7ce 3233 int ret;
2ccbe779
SN
3234 struct v4l2_ext_control c;
3235
5a573925
SA
3236 lockdep_assert_held(ctrl->handler->lock);
3237
2ccbe779
SN
3238 switch (ctrl->type) {
3239 case V4L2_CTRL_TYPE_INTEGER:
0ba2aeb6 3240 case V4L2_CTRL_TYPE_INTEGER64:
2ccbe779
SN
3241 case V4L2_CTRL_TYPE_BOOLEAN:
3242 case V4L2_CTRL_TYPE_MENU:
3243 case V4L2_CTRL_TYPE_INTEGER_MENU:
3244 case V4L2_CTRL_TYPE_BITMASK:
dda4a4d5
HV
3245 case V4L2_CTRL_TYPE_U8:
3246 case V4L2_CTRL_TYPE_U16:
302ab7ce
HV
3247 if (ctrl->is_array)
3248 return -EINVAL;
3249 ret = check_range(ctrl->type, min, max, step, def);
2ccbe779
SN
3250 if (ret)
3251 return ret;
3252 break;
3253 default:
3254 return -EINVAL;
3255 }
2ccbe779
SN
3256 ctrl->minimum = min;
3257 ctrl->maximum = max;
3258 ctrl->step = step;
3259 ctrl->default_value = def;
2a9ec373 3260 c.value = *ctrl->p_cur.p_s32;
2ccbe779
SN
3261 if (validate_new(ctrl, &c))
3262 c.value = def;
2a9ec373 3263 if (c.value != *ctrl->p_cur.p_s32)
2ccbe779
SN
3264 ret = set_ctrl(NULL, ctrl, &c, V4L2_EVENT_CTRL_CH_RANGE);
3265 else
3266 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
2ccbe779
SN
3267 return ret;
3268}
5a573925 3269EXPORT_SYMBOL(__v4l2_ctrl_modify_range);
2ccbe779 3270
6e6d76cd 3271static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
6e239399 3272{
3e366149
HG
3273 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3274
3275 if (ctrl == NULL)
3276 return -EINVAL;
3277
6e239399 3278 v4l2_ctrl_lock(ctrl);
77068d36 3279 list_add_tail(&sev->node, &ctrl->ev_subs);
6e239399 3280 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
77068d36 3281 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
6e239399 3282 struct v4l2_event ev;
c12fcfd6 3283 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
6e239399 3284
c12fcfd6
HV
3285 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
3286 changes |= V4L2_EVENT_CTRL_CH_VALUE;
3287 fill_event(&ev, ctrl, changes);
6e6d76cd
HV
3288 /* Mark the queue as active, allowing this initial
3289 event to be accepted. */
3290 sev->elems = elems;
77068d36 3291 v4l2_event_queue_fh(sev->fh, &ev);
6e239399
HV
3292 }
3293 v4l2_ctrl_unlock(ctrl);
3e366149 3294 return 0;
6e239399 3295}
6e239399 3296
3e366149 3297static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
6e239399 3298{
3e366149
HG
3299 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3300
6e239399 3301 v4l2_ctrl_lock(ctrl);
77068d36 3302 list_del(&sev->node);
6e239399
HV
3303 v4l2_ctrl_unlock(ctrl);
3304}
3e366149
HG
3305
3306void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
3307{
3308 u32 old_changes = old->u.ctrl.changes;
3309
3310 old->u.ctrl = new->u.ctrl;
3311 old->u.ctrl.changes |= old_changes;
3312}
3313EXPORT_SYMBOL(v4l2_ctrl_replace);
3314
3315void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
3316{
3317 new->u.ctrl.changes |= old->u.ctrl.changes;
3318}
3319EXPORT_SYMBOL(v4l2_ctrl_merge);
3320
3321const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
3322 .add = v4l2_ctrl_add_event,
3323 .del = v4l2_ctrl_del_event,
3324 .replace = v4l2_ctrl_replace,
3325 .merge = v4l2_ctrl_merge,
3326};
3327EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
e2ecb257
HV
3328
3329int v4l2_ctrl_log_status(struct file *file, void *fh)
3330{
3331 struct video_device *vfd = video_devdata(file);
3332 struct v4l2_fh *vfh = file->private_data;
3333
3334 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
3335 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
3336 vfd->v4l2_dev->name);
3337 return 0;
3338}
3339EXPORT_SYMBOL(v4l2_ctrl_log_status);
a26243b0
HV
3340
3341int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
85f5fe39 3342 const struct v4l2_event_subscription *sub)
a26243b0
HV
3343{
3344 if (sub->type == V4L2_EVENT_CTRL)
3e366149 3345 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
a26243b0
HV
3346 return -EINVAL;
3347}
3348EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
3349
22fa4279
SN
3350int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
3351 struct v4l2_event_subscription *sub)
3352{
3353 if (!sd->ctrl_handler)
3354 return -EINVAL;
3355 return v4l2_ctrl_subscribe_event(fh, sub);
3356}
3357EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
3358
a26243b0
HV
3359unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
3360{
3361 struct v4l2_fh *fh = file->private_data;
3362
3363 if (v4l2_event_pending(fh))
3364 return POLLPRI;
3365 poll_wait(file, &fh->wait, wait);
3366 return 0;
3367}
3368EXPORT_SYMBOL(v4l2_ctrl_poll);