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