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