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