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_audio_dec_playback[] = {
187 static const char * const mpeg_video_encoding[] = {
193 static const char * const mpeg_video_aspect[] = {
200 static const char * const mpeg_video_bitrate_mode[] = {
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",
214 static const char * const mpeg_stream_vbi_fmt[] = {
216 "Private Packet, IVTV Format",
219 static const char * const camera_power_line_frequency[] = {
226 static const char * const camera_exposure_auto[] = {
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
233 static const char * const camera_exposure_metering[] = {
239 static const char * const camera_auto_focus_range[] = {
246 static const char * const colorfx[] = {
265 static const char * const auto_n_preset_white_balance[] = {
278 static const char * const camera_iso_sensitivity_auto[] = {
283 static const char * const scene_mode[] = {
300 static const char * const tune_preemphasis[] = {
306 static const char * const header_mode[] = {
308 "Joined With 1st Frame",
311 static const char * const multi_slice[] = {
317 static const char * const entropy_mode[] = {
322 static const char * const mpeg_h264_level[] = {
341 static const char * const h264_loop_filter[] = {
344 "Disabled at Slice Boundary",
347 static const char * const h264_profile[] = {
349 "Constrained Baseline",
355 "High 444 Predictive",
362 "Scalable High Intra",
366 static const char * const vui_sar_idc[] = {
387 static const char * const mpeg_mpeg4_level[] = {
398 static const char * const mpeg4_profile[] = {
403 "Advanced Coding Efficency",
407 static const char * const flash_led_mode[] = {
413 static const char * const flash_strobe_source[] = {
419 static const char * const jpeg_chroma_subsampling[] = {
430 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
431 return mpeg_audio_sampling_freq;
432 case V4L2_CID_MPEG_AUDIO_ENCODING:
433 return mpeg_audio_encoding;
434 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
435 return mpeg_audio_l1_bitrate;
436 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
437 return mpeg_audio_l2_bitrate;
438 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
439 return mpeg_audio_l3_bitrate;
440 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
441 return mpeg_audio_ac3_bitrate;
442 case V4L2_CID_MPEG_AUDIO_MODE:
443 return mpeg_audio_mode;
444 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
445 return mpeg_audio_mode_extension;
446 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
447 return mpeg_audio_emphasis;
448 case V4L2_CID_MPEG_AUDIO_CRC:
449 return mpeg_audio_crc;
450 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
451 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
452 return mpeg_audio_dec_playback;
453 case V4L2_CID_MPEG_VIDEO_ENCODING:
454 return mpeg_video_encoding;
455 case V4L2_CID_MPEG_VIDEO_ASPECT:
456 return mpeg_video_aspect;
457 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
458 return mpeg_video_bitrate_mode;
459 case V4L2_CID_MPEG_STREAM_TYPE:
460 return mpeg_stream_type;
461 case V4L2_CID_MPEG_STREAM_VBI_FMT:
462 return mpeg_stream_vbi_fmt;
463 case V4L2_CID_POWER_LINE_FREQUENCY:
464 return camera_power_line_frequency;
465 case V4L2_CID_EXPOSURE_AUTO:
466 return camera_exposure_auto;
467 case V4L2_CID_EXPOSURE_METERING:
468 return camera_exposure_metering;
469 case V4L2_CID_AUTO_FOCUS_RANGE:
470 return camera_auto_focus_range;
471 case V4L2_CID_COLORFX:
473 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
474 return auto_n_preset_white_balance;
475 case V4L2_CID_ISO_SENSITIVITY_AUTO:
476 return camera_iso_sensitivity_auto;
477 case V4L2_CID_SCENE_MODE:
479 case V4L2_CID_TUNE_PREEMPHASIS:
480 return tune_preemphasis;
481 case V4L2_CID_FLASH_LED_MODE:
482 return flash_led_mode;
483 case V4L2_CID_FLASH_STROBE_SOURCE:
484 return flash_strobe_source;
485 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
487 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
489 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
491 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
492 return mpeg_h264_level;
493 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
494 return h264_loop_filter;
495 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
497 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
499 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
500 return mpeg_mpeg4_level;
501 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
502 return mpeg4_profile;
503 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
504 return jpeg_chroma_subsampling;
510 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
512 /* Return the control name. */
513 const char *v4l2_ctrl_get_name(u32 id)
517 /* Keep the order of the 'case's the same as in videodev2.h! */
518 case V4L2_CID_USER_CLASS: return "User Controls";
519 case V4L2_CID_BRIGHTNESS: return "Brightness";
520 case V4L2_CID_CONTRAST: return "Contrast";
521 case V4L2_CID_SATURATION: return "Saturation";
522 case V4L2_CID_HUE: return "Hue";
523 case V4L2_CID_AUDIO_VOLUME: return "Volume";
524 case V4L2_CID_AUDIO_BALANCE: return "Balance";
525 case V4L2_CID_AUDIO_BASS: return "Bass";
526 case V4L2_CID_AUDIO_TREBLE: return "Treble";
527 case V4L2_CID_AUDIO_MUTE: return "Mute";
528 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
529 case V4L2_CID_BLACK_LEVEL: return "Black Level";
530 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
531 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
532 case V4L2_CID_RED_BALANCE: return "Red Balance";
533 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
534 case V4L2_CID_GAMMA: return "Gamma";
535 case V4L2_CID_EXPOSURE: return "Exposure";
536 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
537 case V4L2_CID_GAIN: return "Gain";
538 case V4L2_CID_HFLIP: return "Horizontal Flip";
539 case V4L2_CID_VFLIP: return "Vertical Flip";
540 case V4L2_CID_HCENTER: return "Horizontal Center";
541 case V4L2_CID_VCENTER: return "Vertical Center";
542 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
543 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
544 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
545 case V4L2_CID_SHARPNESS: return "Sharpness";
546 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
547 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
548 case V4L2_CID_COLOR_KILLER: return "Color Killer";
549 case V4L2_CID_COLORFX: return "Color Effects";
550 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
551 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
552 case V4L2_CID_ROTATE: return "Rotate";
553 case V4L2_CID_BG_COLOR: return "Background Color";
554 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
555 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
556 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
557 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
558 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
559 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
560 case V4L2_CID_COLORFX_CBCR: return "Color Effects, CbCr";
563 /* Keep the order of the 'case's the same as in videodev2.h! */
564 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
565 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
566 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
567 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
568 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
569 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
570 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
571 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
572 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
573 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
574 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
575 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
576 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
577 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
578 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
579 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
580 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
581 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
582 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
583 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
584 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
585 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
586 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
587 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
588 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
589 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
590 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
591 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
592 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
593 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
594 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
595 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
596 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
597 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
598 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
599 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
600 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
601 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
602 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
603 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
604 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
605 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
606 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
607 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
608 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
609 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
610 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
611 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
612 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
613 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
614 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
615 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
616 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
617 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
618 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
619 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
620 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
621 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
622 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
623 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
624 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
625 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
626 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
627 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
628 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
629 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
630 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
631 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
632 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
633 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
634 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
635 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
636 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
637 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
638 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
639 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
640 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
641 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
642 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
644 /* CAMERA controls */
645 /* Keep the order of the 'case's the same as in videodev2.h! */
646 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
647 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
648 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
649 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
650 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
651 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
652 case V4L2_CID_PAN_RESET: return "Pan, Reset";
653 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
654 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
655 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
656 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
657 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
658 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic Continuous";
659 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
660 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
661 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
662 case V4L2_CID_PRIVACY: return "Privacy";
663 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
664 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
665 case V4L2_CID_AUTO_EXPOSURE_BIAS: return "Auto Exposure, Bias";
666 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
667 case V4L2_CID_WIDE_DYNAMIC_RANGE: return "Wide Dynamic Range";
668 case V4L2_CID_IMAGE_STABILIZATION: return "Image Stabilization";
669 case V4L2_CID_ISO_SENSITIVITY: return "ISO Sensitivity";
670 case V4L2_CID_ISO_SENSITIVITY_AUTO: return "ISO Sensitivity, Auto";
671 case V4L2_CID_EXPOSURE_METERING: return "Exposure, Metering Mode";
672 case V4L2_CID_SCENE_MODE: return "Scene Mode";
673 case V4L2_CID_3A_LOCK: return "3A Lock";
674 case V4L2_CID_AUTO_FOCUS_START: return "Auto Focus, Start";
675 case V4L2_CID_AUTO_FOCUS_STOP: return "Auto Focus, Stop";
676 case V4L2_CID_AUTO_FOCUS_STATUS: return "Auto Focus, Status";
677 case V4L2_CID_AUTO_FOCUS_RANGE: return "Auto Focus, Range";
679 /* FM Radio Modulator control */
680 /* Keep the order of the 'case's the same as in videodev2.h! */
681 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
682 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
683 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
684 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
685 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
686 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
687 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
688 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
689 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
690 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
691 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
692 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
693 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
694 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
695 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
696 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
697 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
698 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
699 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
700 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
703 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
704 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
705 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
706 case V4L2_CID_FLASH_STROBE: return "Strobe";
707 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
708 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
709 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
710 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
711 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
712 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
713 case V4L2_CID_FLASH_FAULT: return "Faults";
714 case V4L2_CID_FLASH_CHARGE: return "Charge";
715 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
717 /* JPEG encoder controls */
718 /* Keep the order of the 'case's the same as in videodev2.h! */
719 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
720 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
721 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
722 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
723 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
725 /* Image source controls */
726 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
727 case V4L2_CID_VBLANK: return "Vertical Blanking";
728 case V4L2_CID_HBLANK: return "Horizontal Blanking";
729 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
731 /* Image processing controls */
732 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
733 case V4L2_CID_LINK_FREQ: return "Link Frequency";
734 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
740 EXPORT_SYMBOL(v4l2_ctrl_get_name);
742 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
743 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
745 *name = v4l2_ctrl_get_name(id);
749 case V4L2_CID_AUDIO_MUTE:
750 case V4L2_CID_AUDIO_LOUDNESS:
751 case V4L2_CID_AUTO_WHITE_BALANCE:
752 case V4L2_CID_AUTOGAIN:
755 case V4L2_CID_HUE_AUTO:
756 case V4L2_CID_CHROMA_AGC:
757 case V4L2_CID_COLOR_KILLER:
758 case V4L2_CID_AUTOBRIGHTNESS:
759 case V4L2_CID_MPEG_AUDIO_MUTE:
760 case V4L2_CID_MPEG_VIDEO_MUTE:
761 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
762 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
763 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
764 case V4L2_CID_FOCUS_AUTO:
765 case V4L2_CID_PRIVACY:
766 case V4L2_CID_AUDIO_LIMITER_ENABLED:
767 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
768 case V4L2_CID_PILOT_TONE_ENABLED:
769 case V4L2_CID_ILLUMINATORS_1:
770 case V4L2_CID_ILLUMINATORS_2:
771 case V4L2_CID_FLASH_STROBE_STATUS:
772 case V4L2_CID_FLASH_CHARGE:
773 case V4L2_CID_FLASH_READY:
774 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
775 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
776 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
777 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
778 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
779 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
780 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
781 case V4L2_CID_WIDE_DYNAMIC_RANGE:
782 case V4L2_CID_IMAGE_STABILIZATION:
783 *type = V4L2_CTRL_TYPE_BOOLEAN;
787 case V4L2_CID_PAN_RESET:
788 case V4L2_CID_TILT_RESET:
789 case V4L2_CID_FLASH_STROBE:
790 case V4L2_CID_FLASH_STROBE_STOP:
791 case V4L2_CID_AUTO_FOCUS_START:
792 case V4L2_CID_AUTO_FOCUS_STOP:
793 *type = V4L2_CTRL_TYPE_BUTTON;
794 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
795 *min = *max = *step = *def = 0;
797 case V4L2_CID_POWER_LINE_FREQUENCY:
798 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
799 case V4L2_CID_MPEG_AUDIO_ENCODING:
800 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
801 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
802 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
803 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
804 case V4L2_CID_MPEG_AUDIO_MODE:
805 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
806 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
807 case V4L2_CID_MPEG_AUDIO_CRC:
808 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
809 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
810 case V4L2_CID_MPEG_VIDEO_ENCODING:
811 case V4L2_CID_MPEG_VIDEO_ASPECT:
812 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
813 case V4L2_CID_MPEG_STREAM_TYPE:
814 case V4L2_CID_MPEG_STREAM_VBI_FMT:
815 case V4L2_CID_EXPOSURE_AUTO:
816 case V4L2_CID_AUTO_FOCUS_RANGE:
817 case V4L2_CID_COLORFX:
818 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
819 case V4L2_CID_TUNE_PREEMPHASIS:
820 case V4L2_CID_FLASH_LED_MODE:
821 case V4L2_CID_FLASH_STROBE_SOURCE:
822 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
823 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
824 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
825 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
826 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
827 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
828 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
829 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
830 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
831 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
832 case V4L2_CID_ISO_SENSITIVITY_AUTO:
833 case V4L2_CID_EXPOSURE_METERING:
834 case V4L2_CID_SCENE_MODE:
835 *type = V4L2_CTRL_TYPE_MENU;
837 case V4L2_CID_LINK_FREQ:
838 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
840 case V4L2_CID_RDS_TX_PS_NAME:
841 case V4L2_CID_RDS_TX_RADIO_TEXT:
842 *type = V4L2_CTRL_TYPE_STRING;
844 case V4L2_CID_ISO_SENSITIVITY:
845 case V4L2_CID_AUTO_EXPOSURE_BIAS:
846 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
848 case V4L2_CID_USER_CLASS:
849 case V4L2_CID_CAMERA_CLASS:
850 case V4L2_CID_MPEG_CLASS:
851 case V4L2_CID_FM_TX_CLASS:
852 case V4L2_CID_FLASH_CLASS:
853 case V4L2_CID_JPEG_CLASS:
854 case V4L2_CID_IMAGE_SOURCE_CLASS:
855 case V4L2_CID_IMAGE_PROC_CLASS:
856 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
857 /* You can neither read not write these */
858 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
859 *min = *max = *step = *def = 0;
861 case V4L2_CID_BG_COLOR:
862 *type = V4L2_CTRL_TYPE_INTEGER;
865 /* Max is calculated as RGB888 that is 2^24 */
868 case V4L2_CID_FLASH_FAULT:
869 case V4L2_CID_JPEG_ACTIVE_MARKER:
870 case V4L2_CID_3A_LOCK:
871 case V4L2_CID_AUTO_FOCUS_STATUS:
872 *type = V4L2_CTRL_TYPE_BITMASK;
874 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
875 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
876 *type = V4L2_CTRL_TYPE_INTEGER;
877 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
879 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
880 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
881 *flags |= V4L2_CTRL_FLAG_VOLATILE;
883 case V4L2_CID_PIXEL_RATE:
884 *type = V4L2_CTRL_TYPE_INTEGER64;
885 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
886 *min = *max = *step = *def = 0;
889 *type = V4L2_CTRL_TYPE_INTEGER;
893 case V4L2_CID_MPEG_AUDIO_ENCODING:
894 case V4L2_CID_MPEG_AUDIO_MODE:
895 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
896 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
897 case V4L2_CID_MPEG_STREAM_TYPE:
898 *flags |= V4L2_CTRL_FLAG_UPDATE;
900 case V4L2_CID_AUDIO_VOLUME:
901 case V4L2_CID_AUDIO_BALANCE:
902 case V4L2_CID_AUDIO_BASS:
903 case V4L2_CID_AUDIO_TREBLE:
904 case V4L2_CID_BRIGHTNESS:
905 case V4L2_CID_CONTRAST:
906 case V4L2_CID_SATURATION:
908 case V4L2_CID_RED_BALANCE:
909 case V4L2_CID_BLUE_BALANCE:
911 case V4L2_CID_SHARPNESS:
912 case V4L2_CID_CHROMA_GAIN:
913 case V4L2_CID_RDS_TX_DEVIATION:
914 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
915 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
916 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
917 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
918 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
919 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
920 case V4L2_CID_PILOT_TONE_DEVIATION:
921 case V4L2_CID_PILOT_TONE_FREQUENCY:
922 case V4L2_CID_TUNE_POWER_LEVEL:
923 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
924 *flags |= V4L2_CTRL_FLAG_SLIDER;
926 case V4L2_CID_PAN_RELATIVE:
927 case V4L2_CID_TILT_RELATIVE:
928 case V4L2_CID_FOCUS_RELATIVE:
929 case V4L2_CID_IRIS_RELATIVE:
930 case V4L2_CID_ZOOM_RELATIVE:
931 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
933 case V4L2_CID_FLASH_STROBE_STATUS:
934 case V4L2_CID_AUTO_FOCUS_STATUS:
935 case V4L2_CID_FLASH_READY:
936 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
940 EXPORT_SYMBOL(v4l2_ctrl_fill);
942 /* Helper function to determine whether the control type is compatible with
944 static bool type_is_int(const struct v4l2_ctrl *ctrl)
946 switch (ctrl->type) {
947 case V4L2_CTRL_TYPE_INTEGER64:
948 case V4L2_CTRL_TYPE_STRING:
949 /* Nope, these need v4l2_ext_control */
956 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
958 memset(ev->reserved, 0, sizeof(ev->reserved));
959 ev->type = V4L2_EVENT_CTRL;
961 ev->u.ctrl.changes = changes;
962 ev->u.ctrl.type = ctrl->type;
963 ev->u.ctrl.flags = ctrl->flags;
964 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
965 ev->u.ctrl.value64 = 0;
967 ev->u.ctrl.value64 = ctrl->cur.val64;
968 ev->u.ctrl.minimum = ctrl->minimum;
969 ev->u.ctrl.maximum = ctrl->maximum;
970 if (ctrl->type == V4L2_CTRL_TYPE_MENU
971 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
974 ev->u.ctrl.step = ctrl->step;
975 ev->u.ctrl.default_value = ctrl->default_value;
978 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
980 struct v4l2_event ev;
981 struct v4l2_subscribed_event *sev;
983 if (list_empty(&ctrl->ev_subs))
985 fill_event(&ev, ctrl, changes);
987 list_for_each_entry(sev, &ctrl->ev_subs, node)
989 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
990 v4l2_event_queue_fh(sev->fh, &ev);
993 /* Helper function: copy the current control value back to the caller */
994 static int cur_to_user(struct v4l2_ext_control *c,
995 struct v4l2_ctrl *ctrl)
999 switch (ctrl->type) {
1000 case V4L2_CTRL_TYPE_STRING:
1001 len = strlen(ctrl->cur.string);
1002 if (c->size < len + 1) {
1006 return copy_to_user(c->string, ctrl->cur.string,
1007 len + 1) ? -EFAULT : 0;
1008 case V4L2_CTRL_TYPE_INTEGER64:
1009 c->value64 = ctrl->cur.val64;
1012 c->value = ctrl->cur.val;
1018 /* Helper function: copy the caller-provider value as the new control value */
1019 static int user_to_new(struct v4l2_ext_control *c,
1020 struct v4l2_ctrl *ctrl)
1026 switch (ctrl->type) {
1027 case V4L2_CTRL_TYPE_INTEGER64:
1028 ctrl->val64 = c->value64;
1030 case V4L2_CTRL_TYPE_STRING:
1034 if (size > ctrl->maximum + 1)
1035 size = ctrl->maximum + 1;
1036 ret = copy_from_user(ctrl->string, c->string, size);
1038 char last = ctrl->string[size - 1];
1040 ctrl->string[size - 1] = 0;
1041 /* If the string was longer than ctrl->maximum,
1042 then return an error. */
1043 if (strlen(ctrl->string) == ctrl->maximum && last)
1046 return ret ? -EFAULT : 0;
1048 ctrl->val = c->value;
1054 /* Helper function: copy the new control value back to the caller */
1055 static int new_to_user(struct v4l2_ext_control *c,
1056 struct v4l2_ctrl *ctrl)
1060 switch (ctrl->type) {
1061 case V4L2_CTRL_TYPE_STRING:
1062 len = strlen(ctrl->string);
1063 if (c->size < len + 1) {
1064 c->size = ctrl->maximum + 1;
1067 return copy_to_user(c->string, ctrl->string,
1068 len + 1) ? -EFAULT : 0;
1069 case V4L2_CTRL_TYPE_INTEGER64:
1070 c->value64 = ctrl->val64;
1073 c->value = ctrl->val;
1079 /* Copy the new value to the current value. */
1080 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
1081 bool update_inactive)
1083 bool changed = false;
1087 switch (ctrl->type) {
1088 case V4L2_CTRL_TYPE_BUTTON:
1091 case V4L2_CTRL_TYPE_STRING:
1092 /* strings are always 0-terminated */
1093 changed = strcmp(ctrl->string, ctrl->cur.string);
1094 strcpy(ctrl->cur.string, ctrl->string);
1096 case V4L2_CTRL_TYPE_INTEGER64:
1097 changed = ctrl->val64 != ctrl->cur.val64;
1098 ctrl->cur.val64 = ctrl->val64;
1101 changed = ctrl->val != ctrl->cur.val;
1102 ctrl->cur.val = ctrl->val;
1105 if (update_inactive) {
1106 /* Note: update_inactive can only be true for auto clusters. */
1108 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1109 if (!is_cur_manual(ctrl->cluster[0])) {
1110 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1111 if (ctrl->cluster[0]->has_volatiles)
1112 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1116 if (changed || update_inactive) {
1117 /* If a control was changed that was not one of the controls
1118 modified by the application, then send the event to all. */
1121 send_event(fh, ctrl,
1122 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1123 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
1127 /* Copy the current value to the new value */
1128 static void cur_to_new(struct v4l2_ctrl *ctrl)
1132 switch (ctrl->type) {
1133 case V4L2_CTRL_TYPE_STRING:
1134 /* strings are always 0-terminated */
1135 strcpy(ctrl->string, ctrl->cur.string);
1137 case V4L2_CTRL_TYPE_INTEGER64:
1138 ctrl->val64 = ctrl->cur.val64;
1141 ctrl->val = ctrl->cur.val;
1146 /* Return non-zero if one or more of the controls in the cluster has a new
1147 value that differs from the current value. */
1148 static int cluster_changed(struct v4l2_ctrl *master)
1153 for (i = 0; !diff && i < master->ncontrols; i++) {
1154 struct v4l2_ctrl *ctrl = master->cluster[i];
1158 switch (ctrl->type) {
1159 case V4L2_CTRL_TYPE_BUTTON:
1160 /* Button controls are always 'different' */
1162 case V4L2_CTRL_TYPE_STRING:
1163 /* strings are always 0-terminated */
1164 diff = strcmp(ctrl->string, ctrl->cur.string);
1166 case V4L2_CTRL_TYPE_INTEGER64:
1167 diff = ctrl->val64 != ctrl->cur.val64;
1170 diff = ctrl->val != ctrl->cur.val;
1177 /* Validate integer-type control */
1178 static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
1183 switch (ctrl->type) {
1184 case V4L2_CTRL_TYPE_INTEGER:
1185 /* Round towards the closest legal value */
1186 val += ctrl->step / 2;
1187 if (val < ctrl->minimum)
1188 val = ctrl->minimum;
1189 if (val > ctrl->maximum)
1190 val = ctrl->maximum;
1191 offset = val - ctrl->minimum;
1192 offset = ctrl->step * (offset / ctrl->step);
1193 val = ctrl->minimum + offset;
1197 case V4L2_CTRL_TYPE_BOOLEAN:
1201 case V4L2_CTRL_TYPE_MENU:
1202 case V4L2_CTRL_TYPE_INTEGER_MENU:
1203 if (val < ctrl->minimum || val > ctrl->maximum)
1205 if (ctrl->menu_skip_mask & (1 << val))
1207 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1208 ctrl->qmenu[val][0] == '\0')
1212 case V4L2_CTRL_TYPE_BITMASK:
1213 *pval &= ctrl->maximum;
1216 case V4L2_CTRL_TYPE_BUTTON:
1217 case V4L2_CTRL_TYPE_CTRL_CLASS:
1226 /* Validate a new control */
1227 static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1229 char *s = c->string;
1232 switch (ctrl->type) {
1233 case V4L2_CTRL_TYPE_INTEGER:
1234 case V4L2_CTRL_TYPE_BOOLEAN:
1235 case V4L2_CTRL_TYPE_MENU:
1236 case V4L2_CTRL_TYPE_INTEGER_MENU:
1237 case V4L2_CTRL_TYPE_BITMASK:
1238 case V4L2_CTRL_TYPE_BUTTON:
1239 case V4L2_CTRL_TYPE_CTRL_CLASS:
1240 return validate_new_int(ctrl, &c->value);
1242 case V4L2_CTRL_TYPE_INTEGER64:
1245 case V4L2_CTRL_TYPE_STRING:
1247 if (len < ctrl->minimum)
1249 if ((len - ctrl->minimum) % ctrl->step)
1258 static inline u32 node2id(struct list_head *node)
1260 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1263 /* Set the handler's error code if it wasn't set earlier already */
1264 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1266 if (hdl->error == 0)
1271 /* Initialize the handler */
1272 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1273 unsigned nr_of_controls_hint)
1275 hdl->lock = &hdl->_lock;
1276 mutex_init(hdl->lock);
1277 INIT_LIST_HEAD(&hdl->ctrls);
1278 INIT_LIST_HEAD(&hdl->ctrl_refs);
1279 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1280 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1282 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1285 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1287 /* Free all controls and control refs */
1288 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1290 struct v4l2_ctrl_ref *ref, *next_ref;
1291 struct v4l2_ctrl *ctrl, *next_ctrl;
1292 struct v4l2_subscribed_event *sev, *next_sev;
1294 if (hdl == NULL || hdl->buckets == NULL)
1297 mutex_lock(hdl->lock);
1298 /* Free all nodes */
1299 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1300 list_del(&ref->node);
1303 /* Free all controls owned by the handler */
1304 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1305 list_del(&ctrl->node);
1306 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1307 list_del(&sev->node);
1310 kfree(hdl->buckets);
1311 hdl->buckets = NULL;
1314 mutex_unlock(hdl->lock);
1316 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1318 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1319 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1320 with applications that do not use the NEXT_CTRL flag.
1322 We just find the n-th private user control. It's O(N), but that should not
1323 be an issue in this particular case. */
1324 static struct v4l2_ctrl_ref *find_private_ref(
1325 struct v4l2_ctrl_handler *hdl, u32 id)
1327 struct v4l2_ctrl_ref *ref;
1329 id -= V4L2_CID_PRIVATE_BASE;
1330 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1331 /* Search for private user controls that are compatible with
1333 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1334 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1335 if (!type_is_int(ref->ctrl))
1345 /* Find a control with the given ID. */
1346 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1348 struct v4l2_ctrl_ref *ref;
1351 id &= V4L2_CTRL_ID_MASK;
1353 /* Old-style private controls need special handling */
1354 if (id >= V4L2_CID_PRIVATE_BASE)
1355 return find_private_ref(hdl, id);
1356 bucket = id % hdl->nr_of_buckets;
1358 /* Simple optimization: cache the last control found */
1359 if (hdl->cached && hdl->cached->ctrl->id == id)
1362 /* Not in cache, search the hash */
1363 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1364 while (ref && ref->ctrl->id != id)
1368 hdl->cached = ref; /* cache it! */
1372 /* Find a control with the given ID. Take the handler's lock first. */
1373 static struct v4l2_ctrl_ref *find_ref_lock(
1374 struct v4l2_ctrl_handler *hdl, u32 id)
1376 struct v4l2_ctrl_ref *ref = NULL;
1379 mutex_lock(hdl->lock);
1380 ref = find_ref(hdl, id);
1381 mutex_unlock(hdl->lock);
1386 /* Find a control with the given ID. */
1387 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1389 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1391 return ref ? ref->ctrl : NULL;
1393 EXPORT_SYMBOL(v4l2_ctrl_find);
1395 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1396 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1397 struct v4l2_ctrl *ctrl)
1399 struct v4l2_ctrl_ref *ref;
1400 struct v4l2_ctrl_ref *new_ref;
1402 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1403 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1405 /* Automatically add the control class if it is not yet present. */
1406 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1407 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1413 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1415 return handler_set_err(hdl, -ENOMEM);
1416 new_ref->ctrl = ctrl;
1417 if (ctrl->handler == hdl) {
1418 /* By default each control starts in a cluster of its own.
1419 new_ref->ctrl is basically a cluster array with one
1420 element, so that's perfect to use as the cluster pointer.
1421 But only do this for the handler that owns the control. */
1422 ctrl->cluster = &new_ref->ctrl;
1423 ctrl->ncontrols = 1;
1426 INIT_LIST_HEAD(&new_ref->node);
1428 mutex_lock(hdl->lock);
1430 /* Add immediately at the end of the list if the list is empty, or if
1431 the last element in the list has a lower ID.
1432 This ensures that when elements are added in ascending order the
1433 insertion is an O(1) operation. */
1434 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1435 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1436 goto insert_in_hash;
1439 /* Find insert position in sorted list */
1440 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1441 if (ref->ctrl->id < id)
1443 /* Don't add duplicates */
1444 if (ref->ctrl->id == id) {
1448 list_add(&new_ref->node, ref->node.prev);
1453 /* Insert the control node in the hash */
1454 new_ref->next = hdl->buckets[bucket];
1455 hdl->buckets[bucket] = new_ref;
1458 mutex_unlock(hdl->lock);
1462 /* Add a new control */
1463 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1464 const struct v4l2_ctrl_ops *ops,
1465 u32 id, const char *name, enum v4l2_ctrl_type type,
1466 s32 min, s32 max, u32 step, s32 def,
1467 u32 flags, const char * const *qmenu,
1468 const s64 *qmenu_int, void *priv)
1470 struct v4l2_ctrl *ctrl;
1471 unsigned sz_extra = 0;
1477 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1478 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1479 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
1480 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1481 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
1482 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1483 handler_set_err(hdl, -ERANGE);
1486 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1487 handler_set_err(hdl, -ERANGE);
1490 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1491 type == V4L2_CTRL_TYPE_MENU ||
1492 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
1493 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1494 (def < min || def > max)) {
1495 handler_set_err(hdl, -ERANGE);
1498 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1499 handler_set_err(hdl, -ERANGE);
1503 if (type == V4L2_CTRL_TYPE_BUTTON)
1504 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1505 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1506 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1507 else if (type == V4L2_CTRL_TYPE_STRING)
1508 sz_extra += 2 * (max + 1);
1510 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1512 handler_set_err(hdl, -ENOMEM);
1516 INIT_LIST_HEAD(&ctrl->node);
1517 INIT_LIST_HEAD(&ctrl->ev_subs);
1518 ctrl->handler = hdl;
1523 ctrl->flags = flags;
1524 ctrl->minimum = min;
1525 ctrl->maximum = max;
1527 if (type == V4L2_CTRL_TYPE_MENU)
1528 ctrl->qmenu = qmenu;
1529 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1530 ctrl->qmenu_int = qmenu_int;
1532 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1534 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1535 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1536 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1538 memset(ctrl->cur.string, ' ', ctrl->minimum);
1540 if (handler_new_ref(hdl, ctrl)) {
1544 mutex_lock(hdl->lock);
1545 list_add_tail(&ctrl->node, &hdl->ctrls);
1546 mutex_unlock(hdl->lock);
1550 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1551 const struct v4l2_ctrl_config *cfg, void *priv)
1554 struct v4l2_ctrl *ctrl;
1555 const char *name = cfg->name;
1556 const char * const *qmenu = cfg->qmenu;
1557 const s64 *qmenu_int = cfg->qmenu_int;
1558 enum v4l2_ctrl_type type = cfg->type;
1559 u32 flags = cfg->flags;
1562 u32 step = cfg->step;
1566 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1569 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1570 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
1574 WARN_ON(cfg->menu_skip_mask);
1575 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
1576 qmenu = v4l2_ctrl_get_menu(cfg->id);
1577 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1578 qmenu_int == NULL) {
1579 handler_set_err(hdl, -EINVAL);
1583 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1585 is_menu ? cfg->menu_skip_mask : step,
1586 def, flags, qmenu, qmenu_int, priv);
1588 ctrl->is_private = cfg->is_private;
1591 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1593 /* Helper function for standard non-menu controls */
1594 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1595 const struct v4l2_ctrl_ops *ops,
1596 u32 id, s32 min, s32 max, u32 step, s32 def)
1599 enum v4l2_ctrl_type type;
1602 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1603 if (type == V4L2_CTRL_TYPE_MENU
1604 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
1605 handler_set_err(hdl, -EINVAL);
1608 return v4l2_ctrl_new(hdl, ops, id, name, type,
1609 min, max, step, def, flags, NULL, NULL, NULL);
1611 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1613 /* Helper function for standard menu controls */
1614 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1615 const struct v4l2_ctrl_ops *ops,
1616 u32 id, s32 max, s32 mask, s32 def)
1618 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1620 enum v4l2_ctrl_type type;
1625 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1626 if (type != V4L2_CTRL_TYPE_MENU) {
1627 handler_set_err(hdl, -EINVAL);
1630 return v4l2_ctrl_new(hdl, ops, id, name, type,
1631 0, max, mask, def, flags, qmenu, NULL, NULL);
1633 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1635 /* Helper function for standard integer menu controls */
1636 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
1637 const struct v4l2_ctrl_ops *ops,
1638 u32 id, s32 max, s32 def, const s64 *qmenu_int)
1641 enum v4l2_ctrl_type type;
1646 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1647 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
1648 handler_set_err(hdl, -EINVAL);
1651 return v4l2_ctrl_new(hdl, ops, id, name, type,
1652 0, max, 0, def, flags, NULL, qmenu_int, NULL);
1654 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
1656 /* Add a control from another handler to this handler */
1657 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1658 struct v4l2_ctrl *ctrl)
1660 if (hdl == NULL || hdl->error)
1663 handler_set_err(hdl, -EINVAL);
1666 if (ctrl->handler == hdl)
1668 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1670 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1672 /* Add the controls from another handler to our own. */
1673 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1674 struct v4l2_ctrl_handler *add)
1676 struct v4l2_ctrl_ref *ref;
1679 /* Do nothing if either handler is NULL or if they are the same */
1680 if (!hdl || !add || hdl == add)
1684 mutex_lock(add->lock);
1685 list_for_each_entry(ref, &add->ctrl_refs, node) {
1686 struct v4l2_ctrl *ctrl = ref->ctrl;
1688 /* Skip handler-private controls. */
1689 if (ctrl->is_private)
1691 /* And control classes */
1692 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1694 ret = handler_new_ref(hdl, ctrl);
1698 mutex_unlock(add->lock);
1701 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1703 /* Cluster controls */
1704 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1706 bool has_volatiles = false;
1709 /* The first control is the master control and it must not be NULL */
1710 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1712 for (i = 0; i < ncontrols; i++) {
1714 controls[i]->cluster = controls;
1715 controls[i]->ncontrols = ncontrols;
1716 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1717 has_volatiles = true;
1720 controls[0]->has_volatiles = has_volatiles;
1722 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1724 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1725 u8 manual_val, bool set_volatile)
1727 struct v4l2_ctrl *master = controls[0];
1731 v4l2_ctrl_cluster(ncontrols, controls);
1732 WARN_ON(ncontrols <= 1);
1733 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1734 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1735 master->is_auto = true;
1736 master->has_volatiles = set_volatile;
1737 master->manual_mode_value = manual_val;
1738 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1740 if (!is_cur_manual(master))
1741 flag = V4L2_CTRL_FLAG_INACTIVE |
1742 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1744 for (i = 1; i < ncontrols; i++)
1746 controls[i]->flags |= flag;
1748 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1750 /* Activate/deactivate a control. */
1751 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1753 /* invert since the actual flag is called 'inactive' */
1754 bool inactive = !active;
1761 /* set V4L2_CTRL_FLAG_INACTIVE */
1762 old = test_and_set_bit(4, &ctrl->flags);
1764 /* clear V4L2_CTRL_FLAG_INACTIVE */
1765 old = test_and_clear_bit(4, &ctrl->flags);
1766 if (old != inactive)
1767 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1769 EXPORT_SYMBOL(v4l2_ctrl_activate);
1771 /* Grab/ungrab a control.
1772 Typically used when streaming starts and you want to grab controls,
1773 preventing the user from changing them.
1775 Just call this and the framework will block any attempts to change
1777 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1784 v4l2_ctrl_lock(ctrl);
1786 /* set V4L2_CTRL_FLAG_GRABBED */
1787 old = test_and_set_bit(1, &ctrl->flags);
1789 /* clear V4L2_CTRL_FLAG_GRABBED */
1790 old = test_and_clear_bit(1, &ctrl->flags);
1792 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1793 v4l2_ctrl_unlock(ctrl);
1795 EXPORT_SYMBOL(v4l2_ctrl_grab);
1797 /* Log the control name and value */
1798 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1799 const char *prefix, const char *colon)
1801 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1803 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1806 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1808 switch (ctrl->type) {
1809 case V4L2_CTRL_TYPE_INTEGER:
1810 printk(KERN_CONT "%d", ctrl->cur.val);
1812 case V4L2_CTRL_TYPE_BOOLEAN:
1813 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1815 case V4L2_CTRL_TYPE_MENU:
1816 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1818 case V4L2_CTRL_TYPE_INTEGER_MENU:
1819 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1821 case V4L2_CTRL_TYPE_BITMASK:
1822 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1824 case V4L2_CTRL_TYPE_INTEGER64:
1825 printk(KERN_CONT "%lld", ctrl->cur.val64);
1827 case V4L2_CTRL_TYPE_STRING:
1828 printk(KERN_CONT "%s", ctrl->cur.string);
1831 printk(KERN_CONT "unknown type %d", ctrl->type);
1834 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1835 V4L2_CTRL_FLAG_GRABBED |
1836 V4L2_CTRL_FLAG_VOLATILE)) {
1837 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1838 printk(KERN_CONT " inactive");
1839 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1840 printk(KERN_CONT " grabbed");
1841 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1842 printk(KERN_CONT " volatile");
1844 printk(KERN_CONT "\n");
1847 /* Log all controls owned by the handler */
1848 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1851 struct v4l2_ctrl *ctrl;
1852 const char *colon = "";
1859 len = strlen(prefix);
1860 if (len && prefix[len - 1] != ' ')
1862 mutex_lock(hdl->lock);
1863 list_for_each_entry(ctrl, &hdl->ctrls, node)
1864 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1865 log_ctrl(ctrl, prefix, colon);
1866 mutex_unlock(hdl->lock);
1868 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1870 /* Call s_ctrl for all controls owned by the handler */
1871 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1873 struct v4l2_ctrl *ctrl;
1878 mutex_lock(hdl->lock);
1879 list_for_each_entry(ctrl, &hdl->ctrls, node)
1882 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1883 struct v4l2_ctrl *master = ctrl->cluster[0];
1886 /* Skip if this control was already handled by a cluster. */
1887 /* Skip button controls and read-only controls. */
1888 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1889 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1892 for (i = 0; i < master->ncontrols; i++) {
1893 if (master->cluster[i]) {
1894 cur_to_new(master->cluster[i]);
1895 master->cluster[i]->is_new = 1;
1896 master->cluster[i]->done = true;
1899 ret = call_op(master, s_ctrl);
1903 mutex_unlock(hdl->lock);
1906 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1908 /* Implement VIDIOC_QUERYCTRL */
1909 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1911 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1912 struct v4l2_ctrl_ref *ref;
1913 struct v4l2_ctrl *ctrl;
1918 mutex_lock(hdl->lock);
1920 /* Try to find it */
1921 ref = find_ref(hdl, id);
1923 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1924 /* Find the next control with ID > qc->id */
1926 /* Did we reach the end of the control list? */
1927 if (id >= node2id(hdl->ctrl_refs.prev)) {
1928 ref = NULL; /* Yes, so there is no next control */
1930 /* We found a control with the given ID, so just get
1931 the next one in the list. */
1932 ref = list_entry(ref->node.next, typeof(*ref), node);
1934 /* No control with the given ID exists, so start
1935 searching for the next largest ID. We know there
1936 is one, otherwise the first 'if' above would have
1938 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1939 if (id < ref->ctrl->id)
1943 mutex_unlock(hdl->lock);
1948 memset(qc, 0, sizeof(*qc));
1949 if (id >= V4L2_CID_PRIVATE_BASE)
1953 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1954 qc->minimum = ctrl->minimum;
1955 qc->maximum = ctrl->maximum;
1956 qc->default_value = ctrl->default_value;
1957 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1958 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1961 qc->step = ctrl->step;
1962 qc->flags = ctrl->flags;
1963 qc->type = ctrl->type;
1966 EXPORT_SYMBOL(v4l2_queryctrl);
1968 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1970 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1972 return v4l2_queryctrl(sd->ctrl_handler, qc);
1974 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1976 /* Implement VIDIOC_QUERYMENU */
1977 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1979 struct v4l2_ctrl *ctrl;
1982 ctrl = v4l2_ctrl_find(hdl, qm->id);
1988 switch (ctrl->type) {
1989 case V4L2_CTRL_TYPE_MENU:
1990 if (ctrl->qmenu == NULL)
1993 case V4L2_CTRL_TYPE_INTEGER_MENU:
1994 if (ctrl->qmenu_int == NULL)
2001 if (i < ctrl->minimum || i > ctrl->maximum)
2004 /* Use mask to see if this menu item should be skipped */
2005 if (ctrl->menu_skip_mask & (1 << i))
2007 /* Empty menu items should also be skipped */
2008 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2009 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2011 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2013 qm->value = ctrl->qmenu_int[i];
2017 EXPORT_SYMBOL(v4l2_querymenu);
2019 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2021 return v4l2_querymenu(sd->ctrl_handler, qm);
2023 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2027 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2029 It is not a fully atomic operation, just best-effort only. After all, if
2030 multiple controls have to be set through multiple i2c writes (for example)
2031 then some initial writes may succeed while others fail. Thus leaving the
2032 system in an inconsistent state. The question is how much effort you are
2033 willing to spend on trying to make something atomic that really isn't.
2035 From the point of view of an application the main requirement is that
2036 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2037 error should be returned without actually affecting any controls.
2039 If all the values are correct, then it is acceptable to just give up
2040 in case of low-level errors.
2042 It is important though that the application can tell when only a partial
2043 configuration was done. The way we do that is through the error_idx field
2044 of struct v4l2_ext_controls: if that is equal to the count field then no
2045 controls were affected. Otherwise all controls before that index were
2046 successful in performing their 'get' or 'set' operation, the control at
2047 the given index failed, and you don't know what happened with the controls
2048 after the failed one. Since if they were part of a control cluster they
2049 could have been successfully processed (if a cluster member was encountered
2050 at index < error_idx), they could have failed (if a cluster member was at
2051 error_idx), or they may not have been processed yet (if the first cluster
2052 member appeared after error_idx).
2054 It is all fairly theoretical, though. In practice all you can do is to
2055 bail out. If error_idx == count, then it is an application bug. If
2056 error_idx < count then it is only an application bug if the error code was
2057 EBUSY. That usually means that something started streaming just when you
2058 tried to set the controls. In all other cases it is a driver/hardware
2059 problem and all you can do is to retry or bail out.
2061 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2062 never modifies controls the error_idx is just set to whatever control
2063 has an invalid value.
2066 /* Prepare for the extended g/s/try functions.
2067 Find the controls in the control array and do some basic checks. */
2068 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2069 struct v4l2_ext_controls *cs,
2070 struct v4l2_ctrl_helper *helpers)
2072 struct v4l2_ctrl_helper *h;
2073 bool have_clusters = false;
2076 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2077 struct v4l2_ext_control *c = &cs->controls[i];
2078 struct v4l2_ctrl_ref *ref;
2079 struct v4l2_ctrl *ctrl;
2080 u32 id = c->id & V4L2_CTRL_ID_MASK;
2084 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2087 /* Old-style private controls are not allowed for
2088 extended controls */
2089 if (id >= V4L2_CID_PRIVATE_BASE)
2091 ref = find_ref_lock(hdl, id);
2095 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2098 if (ctrl->cluster[0]->ncontrols > 1)
2099 have_clusters = true;
2100 if (ctrl->cluster[0] != ctrl)
2101 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2102 /* Store the ref to the master control of the cluster */
2105 /* Initially set next to 0, meaning that there is no other
2106 control in this helper array belonging to the same
2111 /* We are done if there were no controls that belong to a multi-
2116 /* The code below figures out in O(n) time which controls in the list
2117 belong to the same cluster. */
2119 /* This has to be done with the handler lock taken. */
2120 mutex_lock(hdl->lock);
2122 /* First zero the helper field in the master control references */
2123 for (i = 0; i < cs->count; i++)
2124 helpers[i].mref->helper = 0;
2125 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2126 struct v4l2_ctrl_ref *mref = h->mref;
2128 /* If the mref->helper is set, then it points to an earlier
2129 helper that belongs to the same cluster. */
2131 /* Set the next field of mref->helper to the current
2132 index: this means that that earlier helper now
2133 points to the next helper in the same cluster. */
2134 mref->helper->next = i;
2135 /* mref should be set only for the first helper in the
2136 cluster, clear the others. */
2139 /* Point the mref helper to the current helper struct. */
2142 mutex_unlock(hdl->lock);
2146 /* Handles the corner case where cs->count == 0. It checks whether the
2147 specified control class exists. If that class ID is 0, then it checks
2148 whether there are any controls at all. */
2149 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2151 if (ctrl_class == 0)
2152 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2153 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2158 /* Get extended controls. Allocates the helpers array if needed. */
2159 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2161 struct v4l2_ctrl_helper helper[4];
2162 struct v4l2_ctrl_helper *helpers = helper;
2166 cs->error_idx = cs->count;
2167 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2173 return class_check(hdl, cs->ctrl_class);
2175 if (cs->count > ARRAY_SIZE(helper)) {
2176 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2178 if (helpers == NULL)
2182 ret = prepare_ext_ctrls(hdl, cs, helpers);
2183 cs->error_idx = cs->count;
2185 for (i = 0; !ret && i < cs->count; i++)
2186 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2189 for (i = 0; !ret && i < cs->count; i++) {
2190 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2191 struct v4l2_ctrl *ctrl) = cur_to_user;
2192 struct v4l2_ctrl *master;
2194 if (helpers[i].mref == NULL)
2197 master = helpers[i].mref->ctrl;
2200 v4l2_ctrl_lock(master);
2202 /* g_volatile_ctrl will update the new control values */
2203 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2204 (master->has_volatiles && !is_cur_manual(master))) {
2205 for (j = 0; j < master->ncontrols; j++)
2206 cur_to_new(master->cluster[j]);
2207 ret = call_op(master, g_volatile_ctrl);
2208 ctrl_to_user = new_to_user;
2210 /* If OK, then copy the current (for non-volatile controls)
2211 or the new (for volatile controls) control values to the
2217 ret = ctrl_to_user(cs->controls + idx,
2219 idx = helpers[idx].next;
2220 } while (!ret && idx);
2222 v4l2_ctrl_unlock(master);
2225 if (cs->count > ARRAY_SIZE(helper))
2229 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2231 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2233 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2235 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2237 /* Helper function to get a single control */
2238 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2240 struct v4l2_ctrl *master = ctrl->cluster[0];
2244 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2247 v4l2_ctrl_lock(master);
2248 /* g_volatile_ctrl will update the current control values */
2249 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2250 for (i = 0; i < master->ncontrols; i++)
2251 cur_to_new(master->cluster[i]);
2252 ret = call_op(master, g_volatile_ctrl);
2255 *val = ctrl->cur.val;
2257 v4l2_ctrl_unlock(master);
2261 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2263 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2265 if (ctrl == NULL || !type_is_int(ctrl))
2267 return get_ctrl(ctrl, &control->value);
2269 EXPORT_SYMBOL(v4l2_g_ctrl);
2271 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2273 return v4l2_g_ctrl(sd->ctrl_handler, control);
2275 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2277 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2281 /* It's a driver bug if this happens. */
2282 WARN_ON(!type_is_int(ctrl));
2283 get_ctrl(ctrl, &val);
2286 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2289 /* Core function that calls try/s_ctrl and ensures that the new value is
2290 copied to the current value on a set.
2291 Must be called with ctrl->handler->lock held. */
2292 static int try_or_set_cluster(struct v4l2_fh *fh,
2293 struct v4l2_ctrl *master, bool set)
2299 /* Go through the cluster and either validate the new value or
2300 (if no new value was set), copy the current value to the new
2301 value, ensuring a consistent view for the control ops when
2303 for (i = 0; i < master->ncontrols; i++) {
2304 struct v4l2_ctrl *ctrl = master->cluster[i];
2309 if (!ctrl->is_new) {
2313 /* Check again: it may have changed since the
2314 previous check in try_or_set_ext_ctrls(). */
2315 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2319 ret = call_op(master, try_ctrl);
2321 /* Don't set if there is no change */
2322 if (ret || !set || !cluster_changed(master))
2324 ret = call_op(master, s_ctrl);
2328 /* If OK, then make the new values permanent. */
2329 update_flag = is_cur_manual(master) != is_new_manual(master);
2330 for (i = 0; i < master->ncontrols; i++)
2331 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
2335 /* Validate controls. */
2336 static int validate_ctrls(struct v4l2_ext_controls *cs,
2337 struct v4l2_ctrl_helper *helpers, bool set)
2342 cs->error_idx = cs->count;
2343 for (i = 0; i < cs->count; i++) {
2344 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2348 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2350 /* This test is also done in try_set_control_cluster() which
2351 is called in atomic context, so that has the final say,
2352 but it makes sense to do an up-front check as well. Once
2353 an error occurs in try_set_control_cluster() some other
2354 controls may have been set already and we want to do a
2355 best-effort to avoid that. */
2356 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2358 ret = validate_new(ctrl, &cs->controls[i]);
2365 /* Obtain the current volatile values of an autocluster and mark them
2367 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2371 for (i = 0; i < master->ncontrols; i++)
2372 cur_to_new(master->cluster[i]);
2373 if (!call_op(master, g_volatile_ctrl))
2374 for (i = 1; i < master->ncontrols; i++)
2375 if (master->cluster[i])
2376 master->cluster[i]->is_new = 1;
2379 /* Try or try-and-set controls */
2380 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2381 struct v4l2_ext_controls *cs,
2384 struct v4l2_ctrl_helper helper[4];
2385 struct v4l2_ctrl_helper *helpers = helper;
2389 cs->error_idx = cs->count;
2390 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2396 return class_check(hdl, cs->ctrl_class);
2398 if (cs->count > ARRAY_SIZE(helper)) {
2399 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2404 ret = prepare_ext_ctrls(hdl, cs, helpers);
2406 ret = validate_ctrls(cs, helpers, set);
2408 cs->error_idx = cs->count;
2409 for (i = 0; !ret && i < cs->count; i++) {
2410 struct v4l2_ctrl *master;
2413 if (helpers[i].mref == NULL)
2417 master = helpers[i].mref->ctrl;
2418 v4l2_ctrl_lock(master);
2420 /* Reset the 'is_new' flags of the cluster */
2421 for (j = 0; j < master->ncontrols; j++)
2422 if (master->cluster[j])
2423 master->cluster[j]->is_new = 0;
2425 /* For volatile autoclusters that are currently in auto mode
2426 we need to discover if it will be set to manual mode.
2427 If so, then we have to copy the current volatile values
2428 first since those will become the new manual values (which
2429 may be overwritten by explicit new values from this set
2431 if (master->is_auto && master->has_volatiles &&
2432 !is_cur_manual(master)) {
2433 /* Pick an initial non-manual value */
2434 s32 new_auto_val = master->manual_mode_value + 1;
2438 /* Check if the auto control is part of the
2439 list, and remember the new value. */
2440 if (helpers[tmp_idx].ctrl == master)
2441 new_auto_val = cs->controls[tmp_idx].value;
2442 tmp_idx = helpers[tmp_idx].next;
2444 /* If the new value == the manual value, then copy
2445 the current volatile values. */
2446 if (new_auto_val == master->manual_mode_value)
2447 update_from_auto_cluster(master);
2450 /* Copy the new caller-supplied control values.
2451 user_to_new() sets 'is_new' to 1. */
2453 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2454 idx = helpers[idx].next;
2455 } while (!ret && idx);
2458 ret = try_or_set_cluster(fh, master, set);
2460 /* Copy the new values back to userspace. */
2464 ret = new_to_user(cs->controls + idx,
2466 idx = helpers[idx].next;
2467 } while (!ret && idx);
2469 v4l2_ctrl_unlock(master);
2472 if (cs->count > ARRAY_SIZE(helper))
2477 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2479 return try_set_ext_ctrls(NULL, hdl, cs, false);
2481 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2483 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2484 struct v4l2_ext_controls *cs)
2486 return try_set_ext_ctrls(fh, hdl, cs, true);
2488 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2490 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2492 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2494 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2496 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2498 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2500 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2502 /* Helper function for VIDIOC_S_CTRL compatibility */
2503 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
2505 struct v4l2_ctrl *master = ctrl->cluster[0];
2509 ret = validate_new_int(ctrl, val);
2513 v4l2_ctrl_lock(ctrl);
2515 /* Reset the 'is_new' flags of the cluster */
2516 for (i = 0; i < master->ncontrols; i++)
2517 if (master->cluster[i])
2518 master->cluster[i]->is_new = 0;
2520 /* For autoclusters with volatiles that are switched from auto to
2521 manual mode we have to update the current volatile values since
2522 those will become the initial manual values after such a switch. */
2523 if (master->is_auto && master->has_volatiles && ctrl == master &&
2524 !is_cur_manual(master) && *val == master->manual_mode_value)
2525 update_from_auto_cluster(master);
2528 ret = try_or_set_cluster(fh, master, true);
2529 *val = ctrl->cur.val;
2530 v4l2_ctrl_unlock(ctrl);
2534 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2535 struct v4l2_control *control)
2537 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2539 if (ctrl == NULL || !type_is_int(ctrl))
2542 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2545 return set_ctrl(fh, ctrl, &control->value);
2547 EXPORT_SYMBOL(v4l2_s_ctrl);
2549 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2551 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2553 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2555 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2557 /* It's a driver bug if this happens. */
2558 WARN_ON(!type_is_int(ctrl));
2559 return set_ctrl(NULL, ctrl, &val);
2561 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2563 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
2565 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2570 v4l2_ctrl_lock(ctrl);
2571 list_add_tail(&sev->node, &ctrl->ev_subs);
2572 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2573 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2574 struct v4l2_event ev;
2575 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2577 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2578 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2579 fill_event(&ev, ctrl, changes);
2580 /* Mark the queue as active, allowing this initial
2581 event to be accepted. */
2583 v4l2_event_queue_fh(sev->fh, &ev);
2585 v4l2_ctrl_unlock(ctrl);
2589 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
2591 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2593 v4l2_ctrl_lock(ctrl);
2594 list_del(&sev->node);
2595 v4l2_ctrl_unlock(ctrl);
2598 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2600 u32 old_changes = old->u.ctrl.changes;
2602 old->u.ctrl = new->u.ctrl;
2603 old->u.ctrl.changes |= old_changes;
2605 EXPORT_SYMBOL(v4l2_ctrl_replace);
2607 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2609 new->u.ctrl.changes |= old->u.ctrl.changes;
2611 EXPORT_SYMBOL(v4l2_ctrl_merge);
2613 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2614 .add = v4l2_ctrl_add_event,
2615 .del = v4l2_ctrl_del_event,
2616 .replace = v4l2_ctrl_replace,
2617 .merge = v4l2_ctrl_merge,
2619 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
2621 int v4l2_ctrl_log_status(struct file *file, void *fh)
2623 struct video_device *vfd = video_devdata(file);
2624 struct v4l2_fh *vfh = file->private_data;
2626 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2627 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2628 vfd->v4l2_dev->name);
2631 EXPORT_SYMBOL(v4l2_ctrl_log_status);
2633 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2634 struct v4l2_event_subscription *sub)
2636 if (sub->type == V4L2_EVENT_CTRL)
2637 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
2640 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2642 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2644 struct v4l2_fh *fh = file->private_data;
2646 if (v4l2_event_pending(fh))
2648 poll_wait(file, &fh->wait, wait);
2651 EXPORT_SYMBOL(v4l2_ctrl_poll);