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