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