2 V4L2 controls framework implementation.
4 Copyright (C) 2010 Hans Verkuil <hverkuil@xs4all.nl>
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.
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.
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
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>
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)
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. */
46 /* Small helper function to determine if the autocluster is set to manual
48 static bool is_cur_manual(const struct v4l2_ctrl *master)
50 return master->is_auto && master->cur.val == master->manual_mode_value;
53 /* Same as above, but this checks the against the new value instead of the
55 static bool is_new_manual(const struct v4l2_ctrl *master)
57 return master->is_auto && master->val == master->manual_mode_value;
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)
66 static const char * const mpeg_audio_sampling_freq[] = {
72 static const char * const mpeg_audio_encoding[] = {
80 static const char * const mpeg_audio_l1_bitrate[] = {
97 static const char * const mpeg_audio_l2_bitrate[] = {
114 static const char * const mpeg_audio_l3_bitrate[] = {
131 static const char * const mpeg_audio_ac3_bitrate[] = {
153 static const char * const mpeg_audio_mode[] = {
160 static const char * const mpeg_audio_mode_extension[] = {
167 static const char * const mpeg_audio_emphasis[] = {
173 static const char * const mpeg_audio_crc[] = {
178 static const char * const mpeg_video_encoding[] = {
184 static const char * const mpeg_video_aspect[] = {
191 static const char * const mpeg_video_bitrate_mode[] = {
196 static const char * const mpeg_stream_type[] = {
197 "MPEG-2 Program Stream",
198 "MPEG-2 Transport Stream",
199 "MPEG-1 System Stream",
200 "MPEG-2 DVD-compatible Stream",
201 "MPEG-1 VCD-compatible Stream",
202 "MPEG-2 SVCD-compatible Stream",
205 static const char * const mpeg_stream_vbi_fmt[] = {
207 "Private Packet, IVTV Format",
210 static const char * const camera_power_line_frequency[] = {
217 static const char * const camera_exposure_auto[] = {
220 "Shutter Priority Mode",
221 "Aperture Priority Mode",
224 static const char * const colorfx[] = {
237 static const char * const tune_preemphasis[] = {
243 static const char * const header_mode[] = {
245 "Joined With 1st Frame",
248 static const char * const multi_slice[] = {
254 static const char * const entropy_mode[] = {
259 static const char * const mpeg_h264_level[] = {
278 static const char * const h264_loop_filter[] = {
281 "Disabled at Slice Boundary",
284 static const char * const h264_profile[] = {
286 "Constrained Baseline",
292 "High 444 Predictive",
299 "Scalable High Intra",
303 static const char * const vui_sar_idc[] = {
324 static const char * const mpeg_mpeg4_level[] = {
335 static const char * const mpeg4_profile[] = {
340 "Advanced Coding Efficency",
344 static const char * const flash_led_mode[] = {
350 static const char * const flash_strobe_source[] = {
357 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
358 return mpeg_audio_sampling_freq;
359 case V4L2_CID_MPEG_AUDIO_ENCODING:
360 return mpeg_audio_encoding;
361 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
362 return mpeg_audio_l1_bitrate;
363 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
364 return mpeg_audio_l2_bitrate;
365 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
366 return mpeg_audio_l3_bitrate;
367 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
368 return mpeg_audio_ac3_bitrate;
369 case V4L2_CID_MPEG_AUDIO_MODE:
370 return mpeg_audio_mode;
371 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
372 return mpeg_audio_mode_extension;
373 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
374 return mpeg_audio_emphasis;
375 case V4L2_CID_MPEG_AUDIO_CRC:
376 return mpeg_audio_crc;
377 case V4L2_CID_MPEG_VIDEO_ENCODING:
378 return mpeg_video_encoding;
379 case V4L2_CID_MPEG_VIDEO_ASPECT:
380 return mpeg_video_aspect;
381 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
382 return mpeg_video_bitrate_mode;
383 case V4L2_CID_MPEG_STREAM_TYPE:
384 return mpeg_stream_type;
385 case V4L2_CID_MPEG_STREAM_VBI_FMT:
386 return mpeg_stream_vbi_fmt;
387 case V4L2_CID_POWER_LINE_FREQUENCY:
388 return camera_power_line_frequency;
389 case V4L2_CID_EXPOSURE_AUTO:
390 return camera_exposure_auto;
391 case V4L2_CID_COLORFX:
393 case V4L2_CID_TUNE_PREEMPHASIS:
394 return tune_preemphasis;
395 case V4L2_CID_FLASH_LED_MODE:
396 return flash_led_mode;
397 case V4L2_CID_FLASH_STROBE_SOURCE:
398 return flash_strobe_source;
399 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
401 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
403 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
405 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
406 return mpeg_h264_level;
407 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
408 return h264_loop_filter;
409 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
411 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
413 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
414 return mpeg_mpeg4_level;
415 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
416 return mpeg4_profile;
421 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
423 /* Return the control name. */
424 const char *v4l2_ctrl_get_name(u32 id)
428 /* Keep the order of the 'case's the same as in videodev2.h! */
429 case V4L2_CID_USER_CLASS: return "User Controls";
430 case V4L2_CID_BRIGHTNESS: return "Brightness";
431 case V4L2_CID_CONTRAST: return "Contrast";
432 case V4L2_CID_SATURATION: return "Saturation";
433 case V4L2_CID_HUE: return "Hue";
434 case V4L2_CID_AUDIO_VOLUME: return "Volume";
435 case V4L2_CID_AUDIO_BALANCE: return "Balance";
436 case V4L2_CID_AUDIO_BASS: return "Bass";
437 case V4L2_CID_AUDIO_TREBLE: return "Treble";
438 case V4L2_CID_AUDIO_MUTE: return "Mute";
439 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
440 case V4L2_CID_BLACK_LEVEL: return "Black Level";
441 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
442 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
443 case V4L2_CID_RED_BALANCE: return "Red Balance";
444 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
445 case V4L2_CID_GAMMA: return "Gamma";
446 case V4L2_CID_EXPOSURE: return "Exposure";
447 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
448 case V4L2_CID_GAIN: return "Gain";
449 case V4L2_CID_HFLIP: return "Horizontal Flip";
450 case V4L2_CID_VFLIP: return "Vertical Flip";
451 case V4L2_CID_HCENTER: return "Horizontal Center";
452 case V4L2_CID_VCENTER: return "Vertical Center";
453 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
454 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
455 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
456 case V4L2_CID_SHARPNESS: return "Sharpness";
457 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
458 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
459 case V4L2_CID_COLOR_KILLER: return "Color Killer";
460 case V4L2_CID_COLORFX: return "Color Effects";
461 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
462 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
463 case V4L2_CID_ROTATE: return "Rotate";
464 case V4L2_CID_BG_COLOR: return "Background Color";
465 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
466 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
467 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
468 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Minimum Number of Capture Buffers";
469 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Minimum Number of Output Buffers";
472 /* Keep the order of the 'case's the same as in videodev2.h! */
473 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
474 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
475 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
476 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
477 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
478 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
479 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
480 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
481 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
482 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
483 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
484 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
485 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
486 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
487 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
488 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
489 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
490 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
491 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
492 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
493 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
494 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
495 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
496 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
497 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
498 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
499 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
500 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
501 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
502 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
503 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
504 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
505 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
506 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
507 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
508 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "The Number of Intra Refresh MBs";
509 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
510 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
511 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
512 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "The Max Number of Reference Picture";
513 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
514 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P frame QP Value";
515 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B frame QP Value";
516 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
517 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
518 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
519 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P frame QP Value";
520 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B frame QP Value";
521 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
522 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
523 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
524 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
525 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entorpy Mode";
526 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I Period";
527 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
528 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
529 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
530 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
531 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
532 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
533 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
534 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
535 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
536 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
537 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P frame QP Value";
538 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B frame QP Value";
539 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
540 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
541 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
542 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
543 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
544 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "The Maximum Bytes Per Slice";
545 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "The Number of MB in a Slice";
546 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "The Slice Partitioning Method";
547 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
549 /* CAMERA controls */
550 /* Keep the order of the 'case's the same as in videodev2.h! */
551 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
552 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
553 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
554 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
555 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
556 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
557 case V4L2_CID_PAN_RESET: return "Pan, Reset";
558 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
559 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
560 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
561 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
562 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
563 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
564 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
565 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
566 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
567 case V4L2_CID_PRIVACY: return "Privacy";
568 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
569 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
571 /* FM Radio Modulator control */
572 /* Keep the order of the 'case's the same as in videodev2.h! */
573 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
574 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
575 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
576 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
577 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
578 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
579 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
580 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
581 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
582 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Feature Enabled";
583 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
584 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
585 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
586 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
587 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
588 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
589 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
590 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-emphasis settings";
591 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
592 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
595 case V4L2_CID_FLASH_CLASS: return "Flash controls";
596 case V4L2_CID_FLASH_LED_MODE: return "LED mode";
597 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe source";
598 case V4L2_CID_FLASH_STROBE: return "Strobe";
599 case V4L2_CID_FLASH_STROBE_STOP: return "Stop strobe";
600 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe status";
601 case V4L2_CID_FLASH_TIMEOUT: return "Strobe timeout";
602 case V4L2_CID_FLASH_INTENSITY: return "Intensity, flash mode";
603 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, torch mode";
604 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, indicator";
605 case V4L2_CID_FLASH_FAULT: return "Faults";
606 case V4L2_CID_FLASH_CHARGE: return "Charge";
607 case V4L2_CID_FLASH_READY: return "Ready to strobe";
613 EXPORT_SYMBOL(v4l2_ctrl_get_name);
615 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
616 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
618 *name = v4l2_ctrl_get_name(id);
622 case V4L2_CID_AUDIO_MUTE:
623 case V4L2_CID_AUDIO_LOUDNESS:
624 case V4L2_CID_AUTO_WHITE_BALANCE:
625 case V4L2_CID_AUTOGAIN:
628 case V4L2_CID_HUE_AUTO:
629 case V4L2_CID_CHROMA_AGC:
630 case V4L2_CID_COLOR_KILLER:
631 case V4L2_CID_MPEG_AUDIO_MUTE:
632 case V4L2_CID_MPEG_VIDEO_MUTE:
633 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
634 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
635 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
636 case V4L2_CID_FOCUS_AUTO:
637 case V4L2_CID_PRIVACY:
638 case V4L2_CID_AUDIO_LIMITER_ENABLED:
639 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
640 case V4L2_CID_PILOT_TONE_ENABLED:
641 case V4L2_CID_ILLUMINATORS_1:
642 case V4L2_CID_ILLUMINATORS_2:
643 case V4L2_CID_FLASH_STROBE_STATUS:
644 case V4L2_CID_FLASH_CHARGE:
645 case V4L2_CID_FLASH_READY:
646 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
647 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
648 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
649 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
650 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
651 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
652 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
653 *type = V4L2_CTRL_TYPE_BOOLEAN;
657 case V4L2_CID_PAN_RESET:
658 case V4L2_CID_TILT_RESET:
659 case V4L2_CID_FLASH_STROBE:
660 case V4L2_CID_FLASH_STROBE_STOP:
661 *type = V4L2_CTRL_TYPE_BUTTON;
662 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
663 *min = *max = *step = *def = 0;
665 case V4L2_CID_POWER_LINE_FREQUENCY:
666 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
667 case V4L2_CID_MPEG_AUDIO_ENCODING:
668 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
669 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
670 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
671 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
672 case V4L2_CID_MPEG_AUDIO_MODE:
673 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
674 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
675 case V4L2_CID_MPEG_AUDIO_CRC:
676 case V4L2_CID_MPEG_VIDEO_ENCODING:
677 case V4L2_CID_MPEG_VIDEO_ASPECT:
678 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
679 case V4L2_CID_MPEG_STREAM_TYPE:
680 case V4L2_CID_MPEG_STREAM_VBI_FMT:
681 case V4L2_CID_EXPOSURE_AUTO:
682 case V4L2_CID_COLORFX:
683 case V4L2_CID_TUNE_PREEMPHASIS:
684 case V4L2_CID_FLASH_LED_MODE:
685 case V4L2_CID_FLASH_STROBE_SOURCE:
686 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
687 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
688 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
689 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
690 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
691 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
692 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
693 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
694 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
695 *type = V4L2_CTRL_TYPE_MENU;
697 case V4L2_CID_RDS_TX_PS_NAME:
698 case V4L2_CID_RDS_TX_RADIO_TEXT:
699 *type = V4L2_CTRL_TYPE_STRING;
701 case V4L2_CID_USER_CLASS:
702 case V4L2_CID_CAMERA_CLASS:
703 case V4L2_CID_MPEG_CLASS:
704 case V4L2_CID_FM_TX_CLASS:
705 case V4L2_CID_FLASH_CLASS:
706 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
707 /* You can neither read not write these */
708 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
709 *min = *max = *step = *def = 0;
711 case V4L2_CID_BG_COLOR:
712 *type = V4L2_CTRL_TYPE_INTEGER;
715 /* Max is calculated as RGB888 that is 2^24 */
718 case V4L2_CID_FLASH_FAULT:
719 *type = V4L2_CTRL_TYPE_BITMASK;
721 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
722 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
723 *type = V4L2_CTRL_TYPE_INTEGER;
724 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
727 *type = V4L2_CTRL_TYPE_INTEGER;
731 case V4L2_CID_MPEG_AUDIO_ENCODING:
732 case V4L2_CID_MPEG_AUDIO_MODE:
733 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
734 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
735 case V4L2_CID_MPEG_STREAM_TYPE:
736 *flags |= V4L2_CTRL_FLAG_UPDATE;
738 case V4L2_CID_AUDIO_VOLUME:
739 case V4L2_CID_AUDIO_BALANCE:
740 case V4L2_CID_AUDIO_BASS:
741 case V4L2_CID_AUDIO_TREBLE:
742 case V4L2_CID_BRIGHTNESS:
743 case V4L2_CID_CONTRAST:
744 case V4L2_CID_SATURATION:
746 case V4L2_CID_RED_BALANCE:
747 case V4L2_CID_BLUE_BALANCE:
749 case V4L2_CID_SHARPNESS:
750 case V4L2_CID_CHROMA_GAIN:
751 case V4L2_CID_RDS_TX_DEVIATION:
752 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
753 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
754 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
755 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
756 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
757 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
758 case V4L2_CID_PILOT_TONE_DEVIATION:
759 case V4L2_CID_PILOT_TONE_FREQUENCY:
760 case V4L2_CID_TUNE_POWER_LEVEL:
761 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
762 *flags |= V4L2_CTRL_FLAG_SLIDER;
764 case V4L2_CID_PAN_RELATIVE:
765 case V4L2_CID_TILT_RELATIVE:
766 case V4L2_CID_FOCUS_RELATIVE:
767 case V4L2_CID_IRIS_RELATIVE:
768 case V4L2_CID_ZOOM_RELATIVE:
769 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
771 case V4L2_CID_FLASH_STROBE_STATUS:
772 case V4L2_CID_FLASH_READY:
773 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
777 EXPORT_SYMBOL(v4l2_ctrl_fill);
779 /* Helper function to determine whether the control type is compatible with
781 static bool type_is_int(const struct v4l2_ctrl *ctrl)
783 switch (ctrl->type) {
784 case V4L2_CTRL_TYPE_INTEGER64:
785 case V4L2_CTRL_TYPE_STRING:
786 /* Nope, these need v4l2_ext_control */
793 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
795 memset(ev->reserved, 0, sizeof(ev->reserved));
796 ev->type = V4L2_EVENT_CTRL;
798 ev->u.ctrl.changes = changes;
799 ev->u.ctrl.type = ctrl->type;
800 ev->u.ctrl.flags = ctrl->flags;
801 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
802 ev->u.ctrl.value64 = 0;
804 ev->u.ctrl.value64 = ctrl->cur.val64;
805 ev->u.ctrl.minimum = ctrl->minimum;
806 ev->u.ctrl.maximum = ctrl->maximum;
807 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
810 ev->u.ctrl.step = ctrl->step;
811 ev->u.ctrl.default_value = ctrl->default_value;
814 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
816 struct v4l2_event ev;
817 struct v4l2_subscribed_event *sev;
819 if (list_empty(&ctrl->ev_subs))
821 fill_event(&ev, ctrl, changes);
823 list_for_each_entry(sev, &ctrl->ev_subs, node)
825 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
826 v4l2_event_queue_fh(sev->fh, &ev);
829 /* Helper function: copy the current control value back to the caller */
830 static int cur_to_user(struct v4l2_ext_control *c,
831 struct v4l2_ctrl *ctrl)
835 switch (ctrl->type) {
836 case V4L2_CTRL_TYPE_STRING:
837 len = strlen(ctrl->cur.string);
838 if (c->size < len + 1) {
842 return copy_to_user(c->string, ctrl->cur.string,
843 len + 1) ? -EFAULT : 0;
844 case V4L2_CTRL_TYPE_INTEGER64:
845 c->value64 = ctrl->cur.val64;
848 c->value = ctrl->cur.val;
854 /* Helper function: copy the caller-provider value as the new control value */
855 static int user_to_new(struct v4l2_ext_control *c,
856 struct v4l2_ctrl *ctrl)
862 switch (ctrl->type) {
863 case V4L2_CTRL_TYPE_INTEGER64:
864 ctrl->val64 = c->value64;
866 case V4L2_CTRL_TYPE_STRING:
870 if (size > ctrl->maximum + 1)
871 size = ctrl->maximum + 1;
872 ret = copy_from_user(ctrl->string, c->string, size);
874 char last = ctrl->string[size - 1];
876 ctrl->string[size - 1] = 0;
877 /* If the string was longer than ctrl->maximum,
878 then return an error. */
879 if (strlen(ctrl->string) == ctrl->maximum && last)
882 return ret ? -EFAULT : 0;
884 ctrl->val = c->value;
890 /* Helper function: copy the new control value back to the caller */
891 static int new_to_user(struct v4l2_ext_control *c,
892 struct v4l2_ctrl *ctrl)
896 switch (ctrl->type) {
897 case V4L2_CTRL_TYPE_STRING:
898 len = strlen(ctrl->string);
899 if (c->size < len + 1) {
900 c->size = ctrl->maximum + 1;
903 return copy_to_user(c->string, ctrl->string,
904 len + 1) ? -EFAULT : 0;
905 case V4L2_CTRL_TYPE_INTEGER64:
906 c->value64 = ctrl->val64;
909 c->value = ctrl->val;
915 /* Copy the new value to the current value. */
916 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
917 bool update_inactive)
919 bool changed = false;
923 switch (ctrl->type) {
924 case V4L2_CTRL_TYPE_BUTTON:
927 case V4L2_CTRL_TYPE_STRING:
928 /* strings are always 0-terminated */
929 changed = strcmp(ctrl->string, ctrl->cur.string);
930 strcpy(ctrl->cur.string, ctrl->string);
932 case V4L2_CTRL_TYPE_INTEGER64:
933 changed = ctrl->val64 != ctrl->cur.val64;
934 ctrl->cur.val64 = ctrl->val64;
937 changed = ctrl->val != ctrl->cur.val;
938 ctrl->cur.val = ctrl->val;
941 if (update_inactive) {
942 /* Note: update_inactive can only be true for auto clusters. */
944 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
945 if (!is_cur_manual(ctrl->cluster[0])) {
946 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
947 if (ctrl->cluster[0]->has_volatiles)
948 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
952 if (changed || update_inactive) {
953 /* If a control was changed that was not one of the controls
954 modified by the application, then send the event to all. */
958 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
959 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
963 /* Copy the current value to the new value */
964 static void cur_to_new(struct v4l2_ctrl *ctrl)
968 switch (ctrl->type) {
969 case V4L2_CTRL_TYPE_STRING:
970 /* strings are always 0-terminated */
971 strcpy(ctrl->string, ctrl->cur.string);
973 case V4L2_CTRL_TYPE_INTEGER64:
974 ctrl->val64 = ctrl->cur.val64;
977 ctrl->val = ctrl->cur.val;
982 /* Return non-zero if one or more of the controls in the cluster has a new
983 value that differs from the current value. */
984 static int cluster_changed(struct v4l2_ctrl *master)
989 for (i = 0; !diff && i < master->ncontrols; i++) {
990 struct v4l2_ctrl *ctrl = master->cluster[i];
994 switch (ctrl->type) {
995 case V4L2_CTRL_TYPE_BUTTON:
996 /* Button controls are always 'different' */
998 case V4L2_CTRL_TYPE_STRING:
999 /* strings are always 0-terminated */
1000 diff = strcmp(ctrl->string, ctrl->cur.string);
1002 case V4L2_CTRL_TYPE_INTEGER64:
1003 diff = ctrl->val64 != ctrl->cur.val64;
1006 diff = ctrl->val != ctrl->cur.val;
1013 /* Validate integer-type control */
1014 static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
1019 switch (ctrl->type) {
1020 case V4L2_CTRL_TYPE_INTEGER:
1021 /* Round towards the closest legal value */
1022 val += ctrl->step / 2;
1023 if (val < ctrl->minimum)
1024 val = ctrl->minimum;
1025 if (val > ctrl->maximum)
1026 val = ctrl->maximum;
1027 offset = val - ctrl->minimum;
1028 offset = ctrl->step * (offset / ctrl->step);
1029 val = ctrl->minimum + offset;
1033 case V4L2_CTRL_TYPE_BOOLEAN:
1037 case V4L2_CTRL_TYPE_MENU:
1038 if (val < ctrl->minimum || val > ctrl->maximum)
1040 if (ctrl->qmenu[val][0] == '\0' ||
1041 (ctrl->menu_skip_mask & (1 << val)))
1045 case V4L2_CTRL_TYPE_BITMASK:
1046 *pval &= ctrl->maximum;
1049 case V4L2_CTRL_TYPE_BUTTON:
1050 case V4L2_CTRL_TYPE_CTRL_CLASS:
1059 /* Validate a new control */
1060 static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1062 char *s = c->string;
1065 switch (ctrl->type) {
1066 case V4L2_CTRL_TYPE_INTEGER:
1067 case V4L2_CTRL_TYPE_BOOLEAN:
1068 case V4L2_CTRL_TYPE_MENU:
1069 case V4L2_CTRL_TYPE_BITMASK:
1070 case V4L2_CTRL_TYPE_BUTTON:
1071 case V4L2_CTRL_TYPE_CTRL_CLASS:
1072 return validate_new_int(ctrl, &c->value);
1074 case V4L2_CTRL_TYPE_INTEGER64:
1077 case V4L2_CTRL_TYPE_STRING:
1079 if (len < ctrl->minimum)
1081 if ((len - ctrl->minimum) % ctrl->step)
1090 static inline u32 node2id(struct list_head *node)
1092 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1095 /* Set the handler's error code if it wasn't set earlier already */
1096 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1098 if (hdl->error == 0)
1103 /* Initialize the handler */
1104 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1105 unsigned nr_of_controls_hint)
1107 mutex_init(&hdl->lock);
1108 INIT_LIST_HEAD(&hdl->ctrls);
1109 INIT_LIST_HEAD(&hdl->ctrl_refs);
1110 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1111 hdl->buckets = kzalloc(sizeof(hdl->buckets[0]) * hdl->nr_of_buckets,
1113 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1116 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1118 /* Free all controls and control refs */
1119 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1121 struct v4l2_ctrl_ref *ref, *next_ref;
1122 struct v4l2_ctrl *ctrl, *next_ctrl;
1123 struct v4l2_subscribed_event *sev, *next_sev;
1125 if (hdl == NULL || hdl->buckets == NULL)
1128 mutex_lock(&hdl->lock);
1129 /* Free all nodes */
1130 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1131 list_del(&ref->node);
1134 /* Free all controls owned by the handler */
1135 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1136 list_del(&ctrl->node);
1137 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1138 list_del(&sev->node);
1141 kfree(hdl->buckets);
1142 hdl->buckets = NULL;
1145 mutex_unlock(&hdl->lock);
1147 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1149 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1150 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1151 with applications that do not use the NEXT_CTRL flag.
1153 We just find the n-th private user control. It's O(N), but that should not
1154 be an issue in this particular case. */
1155 static struct v4l2_ctrl_ref *find_private_ref(
1156 struct v4l2_ctrl_handler *hdl, u32 id)
1158 struct v4l2_ctrl_ref *ref;
1160 id -= V4L2_CID_PRIVATE_BASE;
1161 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1162 /* Search for private user controls that are compatible with
1164 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1165 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1166 if (!type_is_int(ref->ctrl))
1176 /* Find a control with the given ID. */
1177 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1179 struct v4l2_ctrl_ref *ref;
1182 id &= V4L2_CTRL_ID_MASK;
1184 /* Old-style private controls need special handling */
1185 if (id >= V4L2_CID_PRIVATE_BASE)
1186 return find_private_ref(hdl, id);
1187 bucket = id % hdl->nr_of_buckets;
1189 /* Simple optimization: cache the last control found */
1190 if (hdl->cached && hdl->cached->ctrl->id == id)
1193 /* Not in cache, search the hash */
1194 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1195 while (ref && ref->ctrl->id != id)
1199 hdl->cached = ref; /* cache it! */
1203 /* Find a control with the given ID. Take the handler's lock first. */
1204 static struct v4l2_ctrl_ref *find_ref_lock(
1205 struct v4l2_ctrl_handler *hdl, u32 id)
1207 struct v4l2_ctrl_ref *ref = NULL;
1210 mutex_lock(&hdl->lock);
1211 ref = find_ref(hdl, id);
1212 mutex_unlock(&hdl->lock);
1217 /* Find a control with the given ID. */
1218 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1220 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1222 return ref ? ref->ctrl : NULL;
1224 EXPORT_SYMBOL(v4l2_ctrl_find);
1226 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1227 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1228 struct v4l2_ctrl *ctrl)
1230 struct v4l2_ctrl_ref *ref;
1231 struct v4l2_ctrl_ref *new_ref;
1233 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1234 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1236 /* Automatically add the control class if it is not yet present. */
1237 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1238 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1244 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1246 return handler_set_err(hdl, -ENOMEM);
1247 new_ref->ctrl = ctrl;
1248 if (ctrl->handler == hdl) {
1249 /* By default each control starts in a cluster of its own.
1250 new_ref->ctrl is basically a cluster array with one
1251 element, so that's perfect to use as the cluster pointer.
1252 But only do this for the handler that owns the control. */
1253 ctrl->cluster = &new_ref->ctrl;
1254 ctrl->ncontrols = 1;
1257 INIT_LIST_HEAD(&new_ref->node);
1259 mutex_lock(&hdl->lock);
1261 /* Add immediately at the end of the list if the list is empty, or if
1262 the last element in the list has a lower ID.
1263 This ensures that when elements are added in ascending order the
1264 insertion is an O(1) operation. */
1265 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1266 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1267 goto insert_in_hash;
1270 /* Find insert position in sorted list */
1271 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1272 if (ref->ctrl->id < id)
1274 /* Don't add duplicates */
1275 if (ref->ctrl->id == id) {
1279 list_add(&new_ref->node, ref->node.prev);
1284 /* Insert the control node in the hash */
1285 new_ref->next = hdl->buckets[bucket];
1286 hdl->buckets[bucket] = new_ref;
1289 mutex_unlock(&hdl->lock);
1293 /* Add a new control */
1294 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1295 const struct v4l2_ctrl_ops *ops,
1296 u32 id, const char *name, enum v4l2_ctrl_type type,
1297 s32 min, s32 max, u32 step, s32 def,
1298 u32 flags, const char * const *qmenu, void *priv)
1300 struct v4l2_ctrl *ctrl;
1301 unsigned sz_extra = 0;
1307 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1308 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1309 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
1310 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1311 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1312 handler_set_err(hdl, -ERANGE);
1315 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1316 handler_set_err(hdl, -ERANGE);
1319 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1320 type == V4L2_CTRL_TYPE_MENU ||
1321 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1322 (def < min || def > max)) {
1323 handler_set_err(hdl, -ERANGE);
1326 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1327 handler_set_err(hdl, -ERANGE);
1331 if (type == V4L2_CTRL_TYPE_BUTTON)
1332 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1333 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1334 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1335 else if (type == V4L2_CTRL_TYPE_STRING)
1336 sz_extra += 2 * (max + 1);
1338 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1340 handler_set_err(hdl, -ENOMEM);
1344 INIT_LIST_HEAD(&ctrl->node);
1345 INIT_LIST_HEAD(&ctrl->ev_subs);
1346 ctrl->handler = hdl;
1351 ctrl->flags = flags;
1352 ctrl->minimum = min;
1353 ctrl->maximum = max;
1355 ctrl->qmenu = qmenu;
1357 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1359 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1360 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1361 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1363 memset(ctrl->cur.string, ' ', ctrl->minimum);
1365 if (handler_new_ref(hdl, ctrl)) {
1369 mutex_lock(&hdl->lock);
1370 list_add_tail(&ctrl->node, &hdl->ctrls);
1371 mutex_unlock(&hdl->lock);
1375 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1376 const struct v4l2_ctrl_config *cfg, void *priv)
1379 struct v4l2_ctrl *ctrl;
1380 const char *name = cfg->name;
1381 const char * const *qmenu = cfg->qmenu;
1382 enum v4l2_ctrl_type type = cfg->type;
1383 u32 flags = cfg->flags;
1386 u32 step = cfg->step;
1390 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1393 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU);
1397 WARN_ON(cfg->menu_skip_mask);
1398 if (is_menu && qmenu == NULL)
1399 qmenu = v4l2_ctrl_get_menu(cfg->id);
1401 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1403 is_menu ? cfg->menu_skip_mask : step,
1404 def, flags, qmenu, priv);
1406 ctrl->is_private = cfg->is_private;
1409 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1411 /* Helper function for standard non-menu controls */
1412 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1413 const struct v4l2_ctrl_ops *ops,
1414 u32 id, s32 min, s32 max, u32 step, s32 def)
1417 enum v4l2_ctrl_type type;
1420 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1421 if (type == V4L2_CTRL_TYPE_MENU) {
1422 handler_set_err(hdl, -EINVAL);
1425 return v4l2_ctrl_new(hdl, ops, id, name, type,
1426 min, max, step, def, flags, NULL, NULL);
1428 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1430 /* Helper function for standard menu controls */
1431 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1432 const struct v4l2_ctrl_ops *ops,
1433 u32 id, s32 max, s32 mask, s32 def)
1435 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1437 enum v4l2_ctrl_type type;
1442 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1443 if (type != V4L2_CTRL_TYPE_MENU) {
1444 handler_set_err(hdl, -EINVAL);
1447 return v4l2_ctrl_new(hdl, ops, id, name, type,
1448 0, max, mask, def, flags, qmenu, NULL);
1450 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1452 /* Add a control from another handler to this handler */
1453 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1454 struct v4l2_ctrl *ctrl)
1456 if (hdl == NULL || hdl->error)
1459 handler_set_err(hdl, -EINVAL);
1462 if (ctrl->handler == hdl)
1464 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1466 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1468 /* Add the controls from another handler to our own. */
1469 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1470 struct v4l2_ctrl_handler *add)
1472 struct v4l2_ctrl *ctrl;
1475 /* Do nothing if either handler is NULL or if they are the same */
1476 if (!hdl || !add || hdl == add)
1480 mutex_lock(&add->lock);
1481 list_for_each_entry(ctrl, &add->ctrls, node) {
1482 /* Skip handler-private controls. */
1483 if (ctrl->is_private)
1485 /* And control classes */
1486 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1488 ret = handler_new_ref(hdl, ctrl);
1492 mutex_unlock(&add->lock);
1495 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1497 /* Cluster controls */
1498 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1500 bool has_volatiles = false;
1503 /* The first control is the master control and it must not be NULL */
1504 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1506 for (i = 0; i < ncontrols; i++) {
1508 controls[i]->cluster = controls;
1509 controls[i]->ncontrols = ncontrols;
1510 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1511 has_volatiles = true;
1514 controls[0]->has_volatiles = has_volatiles;
1516 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1518 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1519 u8 manual_val, bool set_volatile)
1521 struct v4l2_ctrl *master = controls[0];
1525 v4l2_ctrl_cluster(ncontrols, controls);
1526 WARN_ON(ncontrols <= 1);
1527 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1528 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1529 master->is_auto = true;
1530 master->has_volatiles = set_volatile;
1531 master->manual_mode_value = manual_val;
1532 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1534 if (!is_cur_manual(master))
1535 flag = V4L2_CTRL_FLAG_INACTIVE |
1536 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1538 for (i = 1; i < ncontrols; i++)
1540 controls[i]->flags |= flag;
1542 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1544 /* Activate/deactivate a control. */
1545 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1547 /* invert since the actual flag is called 'inactive' */
1548 bool inactive = !active;
1555 /* set V4L2_CTRL_FLAG_INACTIVE */
1556 old = test_and_set_bit(4, &ctrl->flags);
1558 /* clear V4L2_CTRL_FLAG_INACTIVE */
1559 old = test_and_clear_bit(4, &ctrl->flags);
1560 if (old != inactive)
1561 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1563 EXPORT_SYMBOL(v4l2_ctrl_activate);
1565 /* Grab/ungrab a control.
1566 Typically used when streaming starts and you want to grab controls,
1567 preventing the user from changing them.
1569 Just call this and the framework will block any attempts to change
1571 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1578 v4l2_ctrl_lock(ctrl);
1580 /* set V4L2_CTRL_FLAG_GRABBED */
1581 old = test_and_set_bit(1, &ctrl->flags);
1583 /* clear V4L2_CTRL_FLAG_GRABBED */
1584 old = test_and_clear_bit(1, &ctrl->flags);
1586 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1587 v4l2_ctrl_unlock(ctrl);
1589 EXPORT_SYMBOL(v4l2_ctrl_grab);
1591 /* Log the control name and value */
1592 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1593 const char *prefix, const char *colon)
1595 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1597 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1600 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1602 switch (ctrl->type) {
1603 case V4L2_CTRL_TYPE_INTEGER:
1604 printk(KERN_CONT "%d", ctrl->cur.val);
1606 case V4L2_CTRL_TYPE_BOOLEAN:
1607 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1609 case V4L2_CTRL_TYPE_MENU:
1610 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1612 case V4L2_CTRL_TYPE_BITMASK:
1613 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1615 case V4L2_CTRL_TYPE_INTEGER64:
1616 printk(KERN_CONT "%lld", ctrl->cur.val64);
1618 case V4L2_CTRL_TYPE_STRING:
1619 printk(KERN_CONT "%s", ctrl->cur.string);
1622 printk(KERN_CONT "unknown type %d", ctrl->type);
1625 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1626 V4L2_CTRL_FLAG_GRABBED |
1627 V4L2_CTRL_FLAG_VOLATILE)) {
1628 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1629 printk(KERN_CONT " inactive");
1630 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1631 printk(KERN_CONT " grabbed");
1632 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1633 printk(KERN_CONT " volatile");
1635 printk(KERN_CONT "\n");
1638 /* Log all controls owned by the handler */
1639 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1642 struct v4l2_ctrl *ctrl;
1643 const char *colon = "";
1650 len = strlen(prefix);
1651 if (len && prefix[len - 1] != ' ')
1653 mutex_lock(&hdl->lock);
1654 list_for_each_entry(ctrl, &hdl->ctrls, node)
1655 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1656 log_ctrl(ctrl, prefix, colon);
1657 mutex_unlock(&hdl->lock);
1659 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1661 /* Call s_ctrl for all controls owned by the handler */
1662 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1664 struct v4l2_ctrl *ctrl;
1669 mutex_lock(&hdl->lock);
1670 list_for_each_entry(ctrl, &hdl->ctrls, node)
1673 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1674 struct v4l2_ctrl *master = ctrl->cluster[0];
1677 /* Skip if this control was already handled by a cluster. */
1678 /* Skip button controls and read-only controls. */
1679 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1680 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1683 for (i = 0; i < master->ncontrols; i++) {
1684 if (master->cluster[i]) {
1685 cur_to_new(master->cluster[i]);
1686 master->cluster[i]->is_new = 1;
1687 master->cluster[i]->done = true;
1690 ret = call_op(master, s_ctrl);
1694 mutex_unlock(&hdl->lock);
1697 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1699 /* Implement VIDIOC_QUERYCTRL */
1700 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1702 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1703 struct v4l2_ctrl_ref *ref;
1704 struct v4l2_ctrl *ctrl;
1709 mutex_lock(&hdl->lock);
1711 /* Try to find it */
1712 ref = find_ref(hdl, id);
1714 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1715 /* Find the next control with ID > qc->id */
1717 /* Did we reach the end of the control list? */
1718 if (id >= node2id(hdl->ctrl_refs.prev)) {
1719 ref = NULL; /* Yes, so there is no next control */
1721 /* We found a control with the given ID, so just get
1722 the next one in the list. */
1723 ref = list_entry(ref->node.next, typeof(*ref), node);
1725 /* No control with the given ID exists, so start
1726 searching for the next largest ID. We know there
1727 is one, otherwise the first 'if' above would have
1729 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1730 if (id < ref->ctrl->id)
1734 mutex_unlock(&hdl->lock);
1739 memset(qc, 0, sizeof(*qc));
1740 if (id >= V4L2_CID_PRIVATE_BASE)
1744 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1745 qc->minimum = ctrl->minimum;
1746 qc->maximum = ctrl->maximum;
1747 qc->default_value = ctrl->default_value;
1748 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
1751 qc->step = ctrl->step;
1752 qc->flags = ctrl->flags;
1753 qc->type = ctrl->type;
1756 EXPORT_SYMBOL(v4l2_queryctrl);
1758 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1760 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1762 return v4l2_queryctrl(sd->ctrl_handler, qc);
1764 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1766 /* Implement VIDIOC_QUERYMENU */
1767 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1769 struct v4l2_ctrl *ctrl;
1772 ctrl = v4l2_ctrl_find(hdl, qm->id);
1778 if (ctrl->qmenu == NULL ||
1779 i < ctrl->minimum || i > ctrl->maximum)
1781 /* Use mask to see if this menu item should be skipped */
1782 if (ctrl->menu_skip_mask & (1 << i))
1784 /* Empty menu items should also be skipped */
1785 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1787 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1790 EXPORT_SYMBOL(v4l2_querymenu);
1792 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1794 return v4l2_querymenu(sd->ctrl_handler, qm);
1796 EXPORT_SYMBOL(v4l2_subdev_querymenu);
1800 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1802 It is not a fully atomic operation, just best-effort only. After all, if
1803 multiple controls have to be set through multiple i2c writes (for example)
1804 then some initial writes may succeed while others fail. Thus leaving the
1805 system in an inconsistent state. The question is how much effort you are
1806 willing to spend on trying to make something atomic that really isn't.
1808 From the point of view of an application the main requirement is that
1809 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1810 error should be returned without actually affecting any controls.
1812 If all the values are correct, then it is acceptable to just give up
1813 in case of low-level errors.
1815 It is important though that the application can tell when only a partial
1816 configuration was done. The way we do that is through the error_idx field
1817 of struct v4l2_ext_controls: if that is equal to the count field then no
1818 controls were affected. Otherwise all controls before that index were
1819 successful in performing their 'get' or 'set' operation, the control at
1820 the given index failed, and you don't know what happened with the controls
1821 after the failed one. Since if they were part of a control cluster they
1822 could have been successfully processed (if a cluster member was encountered
1823 at index < error_idx), they could have failed (if a cluster member was at
1824 error_idx), or they may not have been processed yet (if the first cluster
1825 member appeared after error_idx).
1827 It is all fairly theoretical, though. In practice all you can do is to
1828 bail out. If error_idx == count, then it is an application bug. If
1829 error_idx < count then it is only an application bug if the error code was
1830 EBUSY. That usually means that something started streaming just when you
1831 tried to set the controls. In all other cases it is a driver/hardware
1832 problem and all you can do is to retry or bail out.
1834 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1835 never modifies controls the error_idx is just set to whatever control
1836 has an invalid value.
1839 /* Prepare for the extended g/s/try functions.
1840 Find the controls in the control array and do some basic checks. */
1841 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1842 struct v4l2_ext_controls *cs,
1843 struct v4l2_ctrl_helper *helpers)
1845 struct v4l2_ctrl_helper *h;
1846 bool have_clusters = false;
1849 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1850 struct v4l2_ext_control *c = &cs->controls[i];
1851 struct v4l2_ctrl_ref *ref;
1852 struct v4l2_ctrl *ctrl;
1853 u32 id = c->id & V4L2_CTRL_ID_MASK;
1857 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1860 /* Old-style private controls are not allowed for
1861 extended controls */
1862 if (id >= V4L2_CID_PRIVATE_BASE)
1864 ref = find_ref_lock(hdl, id);
1868 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1871 if (ctrl->cluster[0]->ncontrols > 1)
1872 have_clusters = true;
1873 if (ctrl->cluster[0] != ctrl)
1874 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1875 /* Store the ref to the master control of the cluster */
1878 /* Initially set next to 0, meaning that there is no other
1879 control in this helper array belonging to the same
1884 /* We are done if there were no controls that belong to a multi-
1889 /* The code below figures out in O(n) time which controls in the list
1890 belong to the same cluster. */
1892 /* This has to be done with the handler lock taken. */
1893 mutex_lock(&hdl->lock);
1895 /* First zero the helper field in the master control references */
1896 for (i = 0; i < cs->count; i++)
1897 helpers[i].mref->helper = 0;
1898 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1899 struct v4l2_ctrl_ref *mref = h->mref;
1901 /* If the mref->helper is set, then it points to an earlier
1902 helper that belongs to the same cluster. */
1904 /* Set the next field of mref->helper to the current
1905 index: this means that that earlier helper now
1906 points to the next helper in the same cluster. */
1907 mref->helper->next = i;
1908 /* mref should be set only for the first helper in the
1909 cluster, clear the others. */
1912 /* Point the mref helper to the current helper struct. */
1915 mutex_unlock(&hdl->lock);
1919 /* Handles the corner case where cs->count == 0. It checks whether the
1920 specified control class exists. If that class ID is 0, then it checks
1921 whether there are any controls at all. */
1922 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
1924 if (ctrl_class == 0)
1925 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
1926 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
1931 /* Get extended controls. Allocates the helpers array if needed. */
1932 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1934 struct v4l2_ctrl_helper helper[4];
1935 struct v4l2_ctrl_helper *helpers = helper;
1939 cs->error_idx = cs->count;
1940 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1946 return class_check(hdl, cs->ctrl_class);
1948 if (cs->count > ARRAY_SIZE(helper)) {
1949 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1950 if (helpers == NULL)
1954 ret = prepare_ext_ctrls(hdl, cs, helpers);
1955 cs->error_idx = cs->count;
1957 for (i = 0; !ret && i < cs->count; i++)
1958 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1961 for (i = 0; !ret && i < cs->count; i++) {
1962 int (*ctrl_to_user)(struct v4l2_ext_control *c,
1963 struct v4l2_ctrl *ctrl) = cur_to_user;
1964 struct v4l2_ctrl *master;
1966 if (helpers[i].mref == NULL)
1969 master = helpers[i].mref->ctrl;
1972 v4l2_ctrl_lock(master);
1974 /* g_volatile_ctrl will update the new control values */
1975 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
1976 (master->has_volatiles && !is_cur_manual(master))) {
1977 for (j = 0; j < master->ncontrols; j++)
1978 cur_to_new(master->cluster[j]);
1979 ret = call_op(master, g_volatile_ctrl);
1980 ctrl_to_user = new_to_user;
1982 /* If OK, then copy the current (for non-volatile controls)
1983 or the new (for volatile controls) control values to the
1989 ret = ctrl_to_user(cs->controls + idx,
1991 idx = helpers[idx].next;
1992 } while (!ret && idx);
1994 v4l2_ctrl_unlock(master);
1997 if (cs->count > ARRAY_SIZE(helper))
2001 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2003 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2005 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2007 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2009 /* Helper function to get a single control */
2010 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2012 struct v4l2_ctrl *master = ctrl->cluster[0];
2016 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2019 v4l2_ctrl_lock(master);
2020 /* g_volatile_ctrl will update the current control values */
2021 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2022 for (i = 0; i < master->ncontrols; i++)
2023 cur_to_new(master->cluster[i]);
2024 ret = call_op(master, g_volatile_ctrl);
2027 *val = ctrl->cur.val;
2029 v4l2_ctrl_unlock(master);
2033 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2035 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2037 if (ctrl == NULL || !type_is_int(ctrl))
2039 return get_ctrl(ctrl, &control->value);
2041 EXPORT_SYMBOL(v4l2_g_ctrl);
2043 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2045 return v4l2_g_ctrl(sd->ctrl_handler, control);
2047 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2049 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2053 /* It's a driver bug if this happens. */
2054 WARN_ON(!type_is_int(ctrl));
2055 get_ctrl(ctrl, &val);
2058 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2061 /* Core function that calls try/s_ctrl and ensures that the new value is
2062 copied to the current value on a set.
2063 Must be called with ctrl->handler->lock held. */
2064 static int try_or_set_cluster(struct v4l2_fh *fh,
2065 struct v4l2_ctrl *master, bool set)
2071 /* Go through the cluster and either validate the new value or
2072 (if no new value was set), copy the current value to the new
2073 value, ensuring a consistent view for the control ops when
2075 for (i = 0; i < master->ncontrols; i++) {
2076 struct v4l2_ctrl *ctrl = master->cluster[i];
2081 if (!ctrl->is_new) {
2085 /* Check again: it may have changed since the
2086 previous check in try_or_set_ext_ctrls(). */
2087 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2091 ret = call_op(master, try_ctrl);
2093 /* Don't set if there is no change */
2094 if (ret || !set || !cluster_changed(master))
2096 ret = call_op(master, s_ctrl);
2100 /* If OK, then make the new values permanent. */
2101 update_flag = is_cur_manual(master) != is_new_manual(master);
2102 for (i = 0; i < master->ncontrols; i++)
2103 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
2107 /* Validate controls. */
2108 static int validate_ctrls(struct v4l2_ext_controls *cs,
2109 struct v4l2_ctrl_helper *helpers, bool set)
2114 cs->error_idx = cs->count;
2115 for (i = 0; i < cs->count; i++) {
2116 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2120 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2122 /* This test is also done in try_set_control_cluster() which
2123 is called in atomic context, so that has the final say,
2124 but it makes sense to do an up-front check as well. Once
2125 an error occurs in try_set_control_cluster() some other
2126 controls may have been set already and we want to do a
2127 best-effort to avoid that. */
2128 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2130 ret = validate_new(ctrl, &cs->controls[i]);
2137 /* Obtain the current volatile values of an autocluster and mark them
2139 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2143 for (i = 0; i < master->ncontrols; i++)
2144 cur_to_new(master->cluster[i]);
2145 if (!call_op(master, g_volatile_ctrl))
2146 for (i = 1; i < master->ncontrols; i++)
2147 if (master->cluster[i])
2148 master->cluster[i]->is_new = 1;
2151 /* Try or try-and-set controls */
2152 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2153 struct v4l2_ext_controls *cs,
2156 struct v4l2_ctrl_helper helper[4];
2157 struct v4l2_ctrl_helper *helpers = helper;
2161 cs->error_idx = cs->count;
2162 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2168 return class_check(hdl, cs->ctrl_class);
2170 if (cs->count > ARRAY_SIZE(helper)) {
2171 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
2175 ret = prepare_ext_ctrls(hdl, cs, helpers);
2177 ret = validate_ctrls(cs, helpers, set);
2179 cs->error_idx = cs->count;
2180 for (i = 0; !ret && i < cs->count; i++) {
2181 struct v4l2_ctrl *master;
2184 if (helpers[i].mref == NULL)
2188 master = helpers[i].mref->ctrl;
2189 v4l2_ctrl_lock(master);
2191 /* Reset the 'is_new' flags of the cluster */
2192 for (j = 0; j < master->ncontrols; j++)
2193 if (master->cluster[j])
2194 master->cluster[j]->is_new = 0;
2196 /* For volatile autoclusters that are currently in auto mode
2197 we need to discover if it will be set to manual mode.
2198 If so, then we have to copy the current volatile values
2199 first since those will become the new manual values (which
2200 may be overwritten by explicit new values from this set
2202 if (master->is_auto && master->has_volatiles &&
2203 !is_cur_manual(master)) {
2204 /* Pick an initial non-manual value */
2205 s32 new_auto_val = master->manual_mode_value + 1;
2209 /* Check if the auto control is part of the
2210 list, and remember the new value. */
2211 if (helpers[tmp_idx].ctrl == master)
2212 new_auto_val = cs->controls[tmp_idx].value;
2213 tmp_idx = helpers[tmp_idx].next;
2215 /* If the new value == the manual value, then copy
2216 the current volatile values. */
2217 if (new_auto_val == master->manual_mode_value)
2218 update_from_auto_cluster(master);
2221 /* Copy the new caller-supplied control values.
2222 user_to_new() sets 'is_new' to 1. */
2224 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2225 idx = helpers[idx].next;
2226 } while (!ret && idx);
2229 ret = try_or_set_cluster(fh, master, set);
2231 /* Copy the new values back to userspace. */
2235 ret = new_to_user(cs->controls + idx,
2237 idx = helpers[idx].next;
2238 } while (!ret && idx);
2240 v4l2_ctrl_unlock(master);
2243 if (cs->count > ARRAY_SIZE(helper))
2248 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2250 return try_set_ext_ctrls(NULL, hdl, cs, false);
2252 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2254 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2255 struct v4l2_ext_controls *cs)
2257 return try_set_ext_ctrls(fh, hdl, cs, true);
2259 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2261 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2263 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2265 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2267 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2269 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2271 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2273 /* Helper function for VIDIOC_S_CTRL compatibility */
2274 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
2276 struct v4l2_ctrl *master = ctrl->cluster[0];
2280 ret = validate_new_int(ctrl, val);
2284 v4l2_ctrl_lock(ctrl);
2286 /* Reset the 'is_new' flags of the cluster */
2287 for (i = 0; i < master->ncontrols; i++)
2288 if (master->cluster[i])
2289 master->cluster[i]->is_new = 0;
2291 /* For autoclusters with volatiles that are switched from auto to
2292 manual mode we have to update the current volatile values since
2293 those will become the initial manual values after such a switch. */
2294 if (master->is_auto && master->has_volatiles && ctrl == master &&
2295 !is_cur_manual(master) && *val == master->manual_mode_value)
2296 update_from_auto_cluster(master);
2299 ret = try_or_set_cluster(fh, master, true);
2300 *val = ctrl->cur.val;
2301 v4l2_ctrl_unlock(ctrl);
2305 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2306 struct v4l2_control *control)
2308 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2310 if (ctrl == NULL || !type_is_int(ctrl))
2313 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2316 return set_ctrl(fh, ctrl, &control->value);
2318 EXPORT_SYMBOL(v4l2_s_ctrl);
2320 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2322 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2324 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2326 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2328 /* It's a driver bug if this happens. */
2329 WARN_ON(!type_is_int(ctrl));
2330 return set_ctrl(NULL, ctrl, &val);
2332 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2334 void v4l2_ctrl_add_event(struct v4l2_ctrl *ctrl,
2335 struct v4l2_subscribed_event *sev)
2337 v4l2_ctrl_lock(ctrl);
2338 list_add_tail(&sev->node, &ctrl->ev_subs);
2339 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2340 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2341 struct v4l2_event ev;
2342 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2344 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2345 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2346 fill_event(&ev, ctrl, changes);
2347 v4l2_event_queue_fh(sev->fh, &ev);
2349 v4l2_ctrl_unlock(ctrl);
2351 EXPORT_SYMBOL(v4l2_ctrl_add_event);
2353 void v4l2_ctrl_del_event(struct v4l2_ctrl *ctrl,
2354 struct v4l2_subscribed_event *sev)
2356 v4l2_ctrl_lock(ctrl);
2357 list_del(&sev->node);
2358 v4l2_ctrl_unlock(ctrl);
2360 EXPORT_SYMBOL(v4l2_ctrl_del_event);