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[] = {
240 static const char * const camera_auto_focus_range[] = {
247 static const char * const colorfx[] = {
266 static const char * const auto_n_preset_white_balance[] = {
279 static const char * const camera_iso_sensitivity_auto[] = {
284 static const char * const scene_mode[] = {
301 static const char * const tune_emphasis[] = {
307 static const char * const header_mode[] = {
309 "Joined With 1st Frame",
312 static const char * const multi_slice[] = {
318 static const char * const entropy_mode[] = {
323 static const char * const mpeg_h264_level[] = {
342 static const char * const h264_loop_filter[] = {
345 "Disabled at Slice Boundary",
348 static const char * const h264_profile[] = {
350 "Constrained Baseline",
356 "High 444 Predictive",
363 "Scalable High Intra",
367 static const char * const vui_sar_idc[] = {
388 static const char * const h264_fp_arrangement_type[] = {
397 static const char * const h264_fmo_map_type[] = {
398 "Interleaved Slices",
400 "Foreground with Leftover",
407 static const char * const mpeg_mpeg4_level[] = {
418 static const char * const mpeg4_profile[] = {
423 "Advanced Coding Efficiency",
427 static const char * const vpx_golden_frame_sel[] = {
428 "Use Previous Frame",
429 "Use Previous Specific Frame",
433 static const char * const flash_led_mode[] = {
439 static const char * const flash_strobe_source[] = {
445 static const char * const jpeg_chroma_subsampling[] = {
454 static const char * const dv_tx_mode[] = {
459 static const char * const dv_rgb_range[] = {
461 "RGB limited range (16-235)",
462 "RGB full range (0-255)",
465 static const char * const detect_md_mode[] = {
475 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
476 return mpeg_audio_sampling_freq;
477 case V4L2_CID_MPEG_AUDIO_ENCODING:
478 return mpeg_audio_encoding;
479 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
480 return mpeg_audio_l1_bitrate;
481 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
482 return mpeg_audio_l2_bitrate;
483 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
484 return mpeg_audio_l3_bitrate;
485 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
486 return mpeg_audio_ac3_bitrate;
487 case V4L2_CID_MPEG_AUDIO_MODE:
488 return mpeg_audio_mode;
489 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
490 return mpeg_audio_mode_extension;
491 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
492 return mpeg_audio_emphasis;
493 case V4L2_CID_MPEG_AUDIO_CRC:
494 return mpeg_audio_crc;
495 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
496 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
497 return mpeg_audio_dec_playback;
498 case V4L2_CID_MPEG_VIDEO_ENCODING:
499 return mpeg_video_encoding;
500 case V4L2_CID_MPEG_VIDEO_ASPECT:
501 return mpeg_video_aspect;
502 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
503 return mpeg_video_bitrate_mode;
504 case V4L2_CID_MPEG_STREAM_TYPE:
505 return mpeg_stream_type;
506 case V4L2_CID_MPEG_STREAM_VBI_FMT:
507 return mpeg_stream_vbi_fmt;
508 case V4L2_CID_POWER_LINE_FREQUENCY:
509 return camera_power_line_frequency;
510 case V4L2_CID_EXPOSURE_AUTO:
511 return camera_exposure_auto;
512 case V4L2_CID_EXPOSURE_METERING:
513 return camera_exposure_metering;
514 case V4L2_CID_AUTO_FOCUS_RANGE:
515 return camera_auto_focus_range;
516 case V4L2_CID_COLORFX:
518 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
519 return auto_n_preset_white_balance;
520 case V4L2_CID_ISO_SENSITIVITY_AUTO:
521 return camera_iso_sensitivity_auto;
522 case V4L2_CID_SCENE_MODE:
524 case V4L2_CID_TUNE_PREEMPHASIS:
525 return tune_emphasis;
526 case V4L2_CID_TUNE_DEEMPHASIS:
527 return tune_emphasis;
528 case V4L2_CID_FLASH_LED_MODE:
529 return flash_led_mode;
530 case V4L2_CID_FLASH_STROBE_SOURCE:
531 return flash_strobe_source;
532 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
534 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
536 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
538 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
539 return mpeg_h264_level;
540 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
541 return h264_loop_filter;
542 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
544 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
546 case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
547 return h264_fp_arrangement_type;
548 case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
549 return h264_fmo_map_type;
550 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
551 return mpeg_mpeg4_level;
552 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
553 return mpeg4_profile;
554 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
555 return vpx_golden_frame_sel;
556 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
557 return jpeg_chroma_subsampling;
558 case V4L2_CID_DV_TX_MODE:
560 case V4L2_CID_DV_TX_RGB_RANGE:
561 case V4L2_CID_DV_RX_RGB_RANGE:
563 case V4L2_CID_DETECT_MD_MODE:
564 return detect_md_mode;
570 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
572 #define __v4l2_qmenu_int_len(arr, len) ({ *(len) = ARRAY_SIZE(arr); arr; })
574 * Returns NULL or an s64 type array containing the menu for given
575 * control ID. The total number of the menu items is returned in @len.
577 const s64 *v4l2_ctrl_get_int_menu(u32 id, u32 *len)
579 static const s64 qmenu_int_vpx_num_partitions[] = {
583 static const s64 qmenu_int_vpx_num_ref_frames[] = {
588 case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
589 return __v4l2_qmenu_int_len(qmenu_int_vpx_num_partitions, len);
590 case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
591 return __v4l2_qmenu_int_len(qmenu_int_vpx_num_ref_frames, len);
597 EXPORT_SYMBOL(v4l2_ctrl_get_int_menu);
599 /* Return the control name. */
600 const char *v4l2_ctrl_get_name(u32 id)
604 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
605 case V4L2_CID_USER_CLASS: return "User Controls";
606 case V4L2_CID_BRIGHTNESS: return "Brightness";
607 case V4L2_CID_CONTRAST: return "Contrast";
608 case V4L2_CID_SATURATION: return "Saturation";
609 case V4L2_CID_HUE: return "Hue";
610 case V4L2_CID_AUDIO_VOLUME: return "Volume";
611 case V4L2_CID_AUDIO_BALANCE: return "Balance";
612 case V4L2_CID_AUDIO_BASS: return "Bass";
613 case V4L2_CID_AUDIO_TREBLE: return "Treble";
614 case V4L2_CID_AUDIO_MUTE: return "Mute";
615 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
616 case V4L2_CID_BLACK_LEVEL: return "Black Level";
617 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
618 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
619 case V4L2_CID_RED_BALANCE: return "Red Balance";
620 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
621 case V4L2_CID_GAMMA: return "Gamma";
622 case V4L2_CID_EXPOSURE: return "Exposure";
623 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
624 case V4L2_CID_GAIN: return "Gain";
625 case V4L2_CID_HFLIP: return "Horizontal Flip";
626 case V4L2_CID_VFLIP: return "Vertical Flip";
627 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
628 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
629 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
630 case V4L2_CID_SHARPNESS: return "Sharpness";
631 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
632 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
633 case V4L2_CID_COLOR_KILLER: return "Color Killer";
634 case V4L2_CID_COLORFX: return "Color Effects";
635 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
636 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
637 case V4L2_CID_ROTATE: return "Rotate";
638 case V4L2_CID_BG_COLOR: return "Background Color";
639 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
640 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
641 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
642 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
643 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
644 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
645 case V4L2_CID_COLORFX_CBCR: return "Color Effects, CbCr";
648 /* The MPEG controls are applicable to all codec controls
649 * and the 'MPEG' part of the define is historical */
650 /* Keep the order of the 'case's the same as in videodev2.h! */
651 case V4L2_CID_MPEG_CLASS: return "Codec Controls";
652 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
653 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
654 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
655 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
656 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
657 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
658 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
659 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
660 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
661 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
662 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
663 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
664 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
665 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
666 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
667 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
668 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
669 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
670 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
671 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
672 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
673 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
674 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
675 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
676 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
677 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
678 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
679 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
680 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
681 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
682 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
683 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
684 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
685 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
686 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
687 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
688 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
689 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
690 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
691 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
692 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
693 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
694 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
695 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
696 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
697 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
698 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
699 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
700 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
701 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
702 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
703 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
704 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
705 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
706 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
707 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
708 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
709 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
710 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
711 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
712 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
713 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
714 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
715 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
716 case V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING: return "H264 Enable Frame Packing SEI";
717 case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0: return "H264 Set Curr. Frame as Frame0";
718 case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE: return "H264 FP Arrangement Type";
719 case V4L2_CID_MPEG_VIDEO_H264_FMO: return "H264 Flexible MB Ordering";
720 case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE: return "H264 Map Type for FMO";
721 case V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP: return "H264 FMO Number of Slice Groups";
722 case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION: return "H264 FMO Direction of Change";
723 case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE: return "H264 FMO Size of 1st Slice Grp";
724 case V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH: return "H264 FMO No. of Consecutive MBs";
725 case V4L2_CID_MPEG_VIDEO_H264_ASO: return "H264 Arbitrary Slice Ordering";
726 case V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER: return "H264 ASO Slice Order";
727 case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING: return "Enable H264 Hierarchical Coding";
728 case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE: return "H264 Hierarchical Coding Type";
729 case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER:return "H264 Number of HC Layers";
730 case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP:
731 return "H264 Set QP Value for HC Layers";
732 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
733 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
734 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
735 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
736 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
737 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
738 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
739 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
740 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
741 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
742 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
743 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
744 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
745 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
746 case V4L2_CID_MPEG_VIDEO_VBV_DELAY: return "Initial Delay for VBV Control";
747 case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE: return "Horizontal MV Search Range";
748 case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE: return "Vertical MV Search Range";
749 case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER: return "Repeat Sequence Header";
752 case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS: return "VPX Number of Partitions";
753 case V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4: return "VPX Intra Mode Decision Disable";
754 case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES: return "VPX No. of Refs for P Frame";
755 case V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL: return "VPX Loop Filter Level Range";
756 case V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS: return "VPX Deblocking Effect Control";
757 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD: return "VPX Golden Frame Refresh Period";
758 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL: return "VPX Golden Frame Indicator";
759 case V4L2_CID_MPEG_VIDEO_VPX_MIN_QP: return "VPX Minimum QP Value";
760 case V4L2_CID_MPEG_VIDEO_VPX_MAX_QP: return "VPX Maximum QP Value";
761 case V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP: return "VPX I-Frame QP Value";
762 case V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP: return "VPX P-Frame QP Value";
763 case V4L2_CID_MPEG_VIDEO_VPX_PROFILE: return "VPX Profile";
765 /* CAMERA controls */
766 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
767 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
768 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
769 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
770 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
771 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
772 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
773 case V4L2_CID_PAN_RESET: return "Pan, Reset";
774 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
775 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
776 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
777 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
778 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
779 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic Continuous";
780 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
781 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
782 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
783 case V4L2_CID_PRIVACY: return "Privacy";
784 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
785 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
786 case V4L2_CID_AUTO_EXPOSURE_BIAS: return "Auto Exposure, Bias";
787 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
788 case V4L2_CID_WIDE_DYNAMIC_RANGE: return "Wide Dynamic Range";
789 case V4L2_CID_IMAGE_STABILIZATION: return "Image Stabilization";
790 case V4L2_CID_ISO_SENSITIVITY: return "ISO Sensitivity";
791 case V4L2_CID_ISO_SENSITIVITY_AUTO: return "ISO Sensitivity, Auto";
792 case V4L2_CID_EXPOSURE_METERING: return "Exposure, Metering Mode";
793 case V4L2_CID_SCENE_MODE: return "Scene Mode";
794 case V4L2_CID_3A_LOCK: return "3A Lock";
795 case V4L2_CID_AUTO_FOCUS_START: return "Auto Focus, Start";
796 case V4L2_CID_AUTO_FOCUS_STOP: return "Auto Focus, Stop";
797 case V4L2_CID_AUTO_FOCUS_STATUS: return "Auto Focus, Status";
798 case V4L2_CID_AUTO_FOCUS_RANGE: return "Auto Focus, Range";
799 case V4L2_CID_PAN_SPEED: return "Pan, Speed";
800 case V4L2_CID_TILT_SPEED: return "Tilt, Speed";
802 /* FM Radio Modulator controls */
803 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
804 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
805 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
806 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
807 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
808 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
809 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
810 case V4L2_CID_RDS_TX_MONO_STEREO: return "RDS Stereo";
811 case V4L2_CID_RDS_TX_ARTIFICIAL_HEAD: return "RDS Artificial Head";
812 case V4L2_CID_RDS_TX_COMPRESSED: return "RDS Compressed";
813 case V4L2_CID_RDS_TX_DYNAMIC_PTY: return "RDS Dynamic PTY";
814 case V4L2_CID_RDS_TX_TRAFFIC_ANNOUNCEMENT: return "RDS Traffic Announcement";
815 case V4L2_CID_RDS_TX_TRAFFIC_PROGRAM: return "RDS Traffic Program";
816 case V4L2_CID_RDS_TX_MUSIC_SPEECH: return "RDS Music";
817 case V4L2_CID_RDS_TX_ALT_FREQS_ENABLE: return "RDS Enable Alt Frequencies";
818 case V4L2_CID_RDS_TX_ALT_FREQS: return "RDS Alternate Frequencies";
819 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
820 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
821 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
822 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
823 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
824 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
825 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
826 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
827 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
828 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
829 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
830 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
831 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
832 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
835 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
836 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
837 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
838 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
839 case V4L2_CID_FLASH_STROBE: return "Strobe";
840 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
841 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
842 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
843 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
844 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
845 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
846 case V4L2_CID_FLASH_FAULT: return "Faults";
847 case V4L2_CID_FLASH_CHARGE: return "Charge";
848 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
850 /* JPEG encoder controls */
851 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
852 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
853 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
854 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
855 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
856 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
858 /* Image source controls */
859 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
860 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
861 case V4L2_CID_VBLANK: return "Vertical Blanking";
862 case V4L2_CID_HBLANK: return "Horizontal Blanking";
863 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
864 case V4L2_CID_TEST_PATTERN_RED: return "Red Pixel Value";
865 case V4L2_CID_TEST_PATTERN_GREENR: return "Green (Red) Pixel Value";
866 case V4L2_CID_TEST_PATTERN_BLUE: return "Blue Pixel Value";
867 case V4L2_CID_TEST_PATTERN_GREENB: return "Green (Blue) Pixel Value";
869 /* Image processing controls */
870 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
871 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
872 case V4L2_CID_LINK_FREQ: return "Link Frequency";
873 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
874 case V4L2_CID_TEST_PATTERN: return "Test Pattern";
877 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
878 case V4L2_CID_DV_CLASS: return "Digital Video Controls";
879 case V4L2_CID_DV_TX_HOTPLUG: return "Hotplug Present";
880 case V4L2_CID_DV_TX_RXSENSE: return "RxSense Present";
881 case V4L2_CID_DV_TX_EDID_PRESENT: return "EDID Present";
882 case V4L2_CID_DV_TX_MODE: return "Transmit Mode";
883 case V4L2_CID_DV_TX_RGB_RANGE: return "Tx RGB Quantization Range";
884 case V4L2_CID_DV_RX_POWER_PRESENT: return "Power Present";
885 case V4L2_CID_DV_RX_RGB_RANGE: return "Rx RGB Quantization Range";
887 case V4L2_CID_FM_RX_CLASS: return "FM Radio Receiver Controls";
888 case V4L2_CID_TUNE_DEEMPHASIS: return "De-Emphasis";
889 case V4L2_CID_RDS_RECEPTION: return "RDS Reception";
890 case V4L2_CID_RF_TUNER_CLASS: return "RF Tuner Controls";
891 case V4L2_CID_RF_TUNER_RF_GAIN: return "RF Gain";
892 case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO: return "LNA Gain, Auto";
893 case V4L2_CID_RF_TUNER_LNA_GAIN: return "LNA Gain";
894 case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO: return "Mixer Gain, Auto";
895 case V4L2_CID_RF_TUNER_MIXER_GAIN: return "Mixer Gain";
896 case V4L2_CID_RF_TUNER_IF_GAIN_AUTO: return "IF Gain, Auto";
897 case V4L2_CID_RF_TUNER_IF_GAIN: return "IF Gain";
898 case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO: return "Bandwidth, Auto";
899 case V4L2_CID_RF_TUNER_BANDWIDTH: return "Bandwidth";
900 case V4L2_CID_RF_TUNER_PLL_LOCK: return "PLL Lock";
901 case V4L2_CID_RDS_RX_PTY: return "RDS Program Type";
902 case V4L2_CID_RDS_RX_PS_NAME: return "RDS PS Name";
903 case V4L2_CID_RDS_RX_RADIO_TEXT: return "RDS Radio Text";
904 case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT: return "RDS Traffic Announcement";
905 case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM: return "RDS Traffic Program";
906 case V4L2_CID_RDS_RX_MUSIC_SPEECH: return "RDS Music";
908 /* Detection controls */
909 /* Keep the order of the 'case's the same as in v4l2-controls.h! */
910 case V4L2_CID_DETECT_CLASS: return "Detection Controls";
911 case V4L2_CID_DETECT_MD_MODE: return "Motion Detection Mode";
912 case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD: return "MD Global Threshold";
913 case V4L2_CID_DETECT_MD_THRESHOLD_GRID: return "MD Threshold Grid";
914 case V4L2_CID_DETECT_MD_REGION_GRID: return "MD Region Grid";
919 EXPORT_SYMBOL(v4l2_ctrl_get_name);
921 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
922 s64 *min, s64 *max, u64 *step, s64 *def, u32 *flags)
924 *name = v4l2_ctrl_get_name(id);
928 case V4L2_CID_AUDIO_MUTE:
929 case V4L2_CID_AUDIO_LOUDNESS:
930 case V4L2_CID_AUTO_WHITE_BALANCE:
931 case V4L2_CID_AUTOGAIN:
934 case V4L2_CID_HUE_AUTO:
935 case V4L2_CID_CHROMA_AGC:
936 case V4L2_CID_COLOR_KILLER:
937 case V4L2_CID_AUTOBRIGHTNESS:
938 case V4L2_CID_MPEG_AUDIO_MUTE:
939 case V4L2_CID_MPEG_VIDEO_MUTE:
940 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
941 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
942 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
943 case V4L2_CID_FOCUS_AUTO:
944 case V4L2_CID_PRIVACY:
945 case V4L2_CID_AUDIO_LIMITER_ENABLED:
946 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
947 case V4L2_CID_PILOT_TONE_ENABLED:
948 case V4L2_CID_ILLUMINATORS_1:
949 case V4L2_CID_ILLUMINATORS_2:
950 case V4L2_CID_FLASH_STROBE_STATUS:
951 case V4L2_CID_FLASH_CHARGE:
952 case V4L2_CID_FLASH_READY:
953 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
954 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
955 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
956 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
957 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
958 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
959 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
960 case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:
961 case V4L2_CID_WIDE_DYNAMIC_RANGE:
962 case V4L2_CID_IMAGE_STABILIZATION:
963 case V4L2_CID_RDS_RECEPTION:
964 case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:
965 case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO:
966 case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:
967 case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:
968 case V4L2_CID_RF_TUNER_PLL_LOCK:
969 case V4L2_CID_RDS_TX_MONO_STEREO:
970 case V4L2_CID_RDS_TX_ARTIFICIAL_HEAD:
971 case V4L2_CID_RDS_TX_COMPRESSED:
972 case V4L2_CID_RDS_TX_DYNAMIC_PTY:
973 case V4L2_CID_RDS_TX_TRAFFIC_ANNOUNCEMENT:
974 case V4L2_CID_RDS_TX_TRAFFIC_PROGRAM:
975 case V4L2_CID_RDS_TX_MUSIC_SPEECH:
976 case V4L2_CID_RDS_TX_ALT_FREQS_ENABLE:
977 case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT:
978 case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM:
979 case V4L2_CID_RDS_RX_MUSIC_SPEECH:
980 *type = V4L2_CTRL_TYPE_BOOLEAN;
984 case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE:
985 case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:
986 *type = V4L2_CTRL_TYPE_INTEGER;
988 case V4L2_CID_PAN_RESET:
989 case V4L2_CID_TILT_RESET:
990 case V4L2_CID_FLASH_STROBE:
991 case V4L2_CID_FLASH_STROBE_STOP:
992 case V4L2_CID_AUTO_FOCUS_START:
993 case V4L2_CID_AUTO_FOCUS_STOP:
994 *type = V4L2_CTRL_TYPE_BUTTON;
995 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
996 V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
997 *min = *max = *step = *def = 0;
999 case V4L2_CID_POWER_LINE_FREQUENCY:
1000 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
1001 case V4L2_CID_MPEG_AUDIO_ENCODING:
1002 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
1003 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
1004 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
1005 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
1006 case V4L2_CID_MPEG_AUDIO_MODE:
1007 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
1008 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
1009 case V4L2_CID_MPEG_AUDIO_CRC:
1010 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
1011 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
1012 case V4L2_CID_MPEG_VIDEO_ENCODING:
1013 case V4L2_CID_MPEG_VIDEO_ASPECT:
1014 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1015 case V4L2_CID_MPEG_STREAM_TYPE:
1016 case V4L2_CID_MPEG_STREAM_VBI_FMT:
1017 case V4L2_CID_EXPOSURE_AUTO:
1018 case V4L2_CID_AUTO_FOCUS_RANGE:
1019 case V4L2_CID_COLORFX:
1020 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
1021 case V4L2_CID_TUNE_PREEMPHASIS:
1022 case V4L2_CID_FLASH_LED_MODE:
1023 case V4L2_CID_FLASH_STROBE_SOURCE:
1024 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
1025 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
1026 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
1027 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
1028 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
1029 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
1030 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
1031 case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
1032 case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
1033 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
1034 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
1035 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
1036 case V4L2_CID_ISO_SENSITIVITY_AUTO:
1037 case V4L2_CID_EXPOSURE_METERING:
1038 case V4L2_CID_SCENE_MODE:
1039 case V4L2_CID_DV_TX_MODE:
1040 case V4L2_CID_DV_TX_RGB_RANGE:
1041 case V4L2_CID_DV_RX_RGB_RANGE:
1042 case V4L2_CID_TEST_PATTERN:
1043 case V4L2_CID_TUNE_DEEMPHASIS:
1044 case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
1045 case V4L2_CID_DETECT_MD_MODE:
1046 *type = V4L2_CTRL_TYPE_MENU;
1048 case V4L2_CID_LINK_FREQ:
1049 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
1051 case V4L2_CID_RDS_TX_PS_NAME:
1052 case V4L2_CID_RDS_TX_RADIO_TEXT:
1053 case V4L2_CID_RDS_RX_PS_NAME:
1054 case V4L2_CID_RDS_RX_RADIO_TEXT:
1055 *type = V4L2_CTRL_TYPE_STRING;
1057 case V4L2_CID_ISO_SENSITIVITY:
1058 case V4L2_CID_AUTO_EXPOSURE_BIAS:
1059 case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
1060 case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
1061 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
1063 case V4L2_CID_USER_CLASS:
1064 case V4L2_CID_CAMERA_CLASS:
1065 case V4L2_CID_MPEG_CLASS:
1066 case V4L2_CID_FM_TX_CLASS:
1067 case V4L2_CID_FLASH_CLASS:
1068 case V4L2_CID_JPEG_CLASS:
1069 case V4L2_CID_IMAGE_SOURCE_CLASS:
1070 case V4L2_CID_IMAGE_PROC_CLASS:
1071 case V4L2_CID_DV_CLASS:
1072 case V4L2_CID_FM_RX_CLASS:
1073 case V4L2_CID_RF_TUNER_CLASS:
1074 case V4L2_CID_DETECT_CLASS:
1075 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
1076 /* You can neither read not write these */
1077 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
1078 *min = *max = *step = *def = 0;
1080 case V4L2_CID_BG_COLOR:
1081 *type = V4L2_CTRL_TYPE_INTEGER;
1084 /* Max is calculated as RGB888 that is 2^24 */
1087 case V4L2_CID_FLASH_FAULT:
1088 case V4L2_CID_JPEG_ACTIVE_MARKER:
1089 case V4L2_CID_3A_LOCK:
1090 case V4L2_CID_AUTO_FOCUS_STATUS:
1091 case V4L2_CID_DV_TX_HOTPLUG:
1092 case V4L2_CID_DV_TX_RXSENSE:
1093 case V4L2_CID_DV_TX_EDID_PRESENT:
1094 case V4L2_CID_DV_RX_POWER_PRESENT:
1095 *type = V4L2_CTRL_TYPE_BITMASK;
1097 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
1098 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
1099 *type = V4L2_CTRL_TYPE_INTEGER;
1100 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1102 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
1103 *type = V4L2_CTRL_TYPE_INTEGER64;
1104 *flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1106 *max = 0x1ffffffffLL;
1109 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
1110 *type = V4L2_CTRL_TYPE_INTEGER64;
1111 *flags |= V4L2_CTRL_FLAG_VOLATILE | V4L2_CTRL_FLAG_READ_ONLY;
1113 *max = 0x7fffffffffffffffLL;
1116 case V4L2_CID_PIXEL_RATE:
1117 *type = V4L2_CTRL_TYPE_INTEGER64;
1118 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1120 case V4L2_CID_DETECT_MD_REGION_GRID:
1121 *type = V4L2_CTRL_TYPE_U8;
1123 case V4L2_CID_DETECT_MD_THRESHOLD_GRID:
1124 *type = V4L2_CTRL_TYPE_U16;
1126 case V4L2_CID_RDS_TX_ALT_FREQS:
1127 *type = V4L2_CTRL_TYPE_U32;
1130 *type = V4L2_CTRL_TYPE_INTEGER;
1134 case V4L2_CID_MPEG_AUDIO_ENCODING:
1135 case V4L2_CID_MPEG_AUDIO_MODE:
1136 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1137 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
1138 case V4L2_CID_MPEG_STREAM_TYPE:
1139 *flags |= V4L2_CTRL_FLAG_UPDATE;
1141 case V4L2_CID_AUDIO_VOLUME:
1142 case V4L2_CID_AUDIO_BALANCE:
1143 case V4L2_CID_AUDIO_BASS:
1144 case V4L2_CID_AUDIO_TREBLE:
1145 case V4L2_CID_BRIGHTNESS:
1146 case V4L2_CID_CONTRAST:
1147 case V4L2_CID_SATURATION:
1149 case V4L2_CID_RED_BALANCE:
1150 case V4L2_CID_BLUE_BALANCE:
1151 case V4L2_CID_GAMMA:
1152 case V4L2_CID_SHARPNESS:
1153 case V4L2_CID_CHROMA_GAIN:
1154 case V4L2_CID_RDS_TX_DEVIATION:
1155 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
1156 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
1157 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
1158 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
1159 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
1160 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
1161 case V4L2_CID_PILOT_TONE_DEVIATION:
1162 case V4L2_CID_PILOT_TONE_FREQUENCY:
1163 case V4L2_CID_TUNE_POWER_LEVEL:
1164 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
1165 case V4L2_CID_RF_TUNER_RF_GAIN:
1166 case V4L2_CID_RF_TUNER_LNA_GAIN:
1167 case V4L2_CID_RF_TUNER_MIXER_GAIN:
1168 case V4L2_CID_RF_TUNER_IF_GAIN:
1169 case V4L2_CID_RF_TUNER_BANDWIDTH:
1170 case V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD:
1171 *flags |= V4L2_CTRL_FLAG_SLIDER;
1173 case V4L2_CID_PAN_RELATIVE:
1174 case V4L2_CID_TILT_RELATIVE:
1175 case V4L2_CID_FOCUS_RELATIVE:
1176 case V4L2_CID_IRIS_RELATIVE:
1177 case V4L2_CID_ZOOM_RELATIVE:
1178 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
1179 V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
1181 case V4L2_CID_FLASH_STROBE_STATUS:
1182 case V4L2_CID_AUTO_FOCUS_STATUS:
1183 case V4L2_CID_FLASH_READY:
1184 case V4L2_CID_DV_TX_HOTPLUG:
1185 case V4L2_CID_DV_TX_RXSENSE:
1186 case V4L2_CID_DV_TX_EDID_PRESENT:
1187 case V4L2_CID_DV_RX_POWER_PRESENT:
1188 case V4L2_CID_RDS_RX_PTY:
1189 case V4L2_CID_RDS_RX_PS_NAME:
1190 case V4L2_CID_RDS_RX_RADIO_TEXT:
1191 case V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT:
1192 case V4L2_CID_RDS_RX_TRAFFIC_PROGRAM:
1193 case V4L2_CID_RDS_RX_MUSIC_SPEECH:
1194 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1196 case V4L2_CID_RF_TUNER_PLL_LOCK:
1197 *flags |= V4L2_CTRL_FLAG_VOLATILE;
1201 EXPORT_SYMBOL(v4l2_ctrl_fill);
1203 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
1205 memset(ev->reserved, 0, sizeof(ev->reserved));
1206 ev->type = V4L2_EVENT_CTRL;
1208 ev->u.ctrl.changes = changes;
1209 ev->u.ctrl.type = ctrl->type;
1210 ev->u.ctrl.flags = ctrl->flags;
1212 ev->u.ctrl.value64 = 0;
1214 ev->u.ctrl.value64 = *ctrl->p_cur.p_s64;
1215 ev->u.ctrl.minimum = ctrl->minimum;
1216 ev->u.ctrl.maximum = ctrl->maximum;
1217 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1218 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1219 ev->u.ctrl.step = 1;
1221 ev->u.ctrl.step = ctrl->step;
1222 ev->u.ctrl.default_value = ctrl->default_value;
1225 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1227 struct v4l2_event ev;
1228 struct v4l2_subscribed_event *sev;
1230 if (list_empty(&ctrl->ev_subs))
1232 fill_event(&ev, ctrl, changes);
1234 list_for_each_entry(sev, &ctrl->ev_subs, node)
1235 if (sev->fh != fh ||
1236 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
1237 v4l2_event_queue_fh(sev->fh, &ev);
1240 static bool std_equal(const struct v4l2_ctrl *ctrl, u32 idx,
1241 union v4l2_ctrl_ptr ptr1,
1242 union v4l2_ctrl_ptr ptr2)
1244 switch (ctrl->type) {
1245 case V4L2_CTRL_TYPE_BUTTON:
1247 case V4L2_CTRL_TYPE_STRING:
1248 idx *= ctrl->elem_size;
1249 /* strings are always 0-terminated */
1250 return !strcmp(ptr1.p_char + idx, ptr2.p_char + idx);
1251 case V4L2_CTRL_TYPE_INTEGER64:
1252 return ptr1.p_s64[idx] == ptr2.p_s64[idx];
1253 case V4L2_CTRL_TYPE_U8:
1254 return ptr1.p_u8[idx] == ptr2.p_u8[idx];
1255 case V4L2_CTRL_TYPE_U16:
1256 return ptr1.p_u16[idx] == ptr2.p_u16[idx];
1257 case V4L2_CTRL_TYPE_U32:
1258 return ptr1.p_u32[idx] == ptr2.p_u32[idx];
1261 return ptr1.p_s32[idx] == ptr2.p_s32[idx];
1262 idx *= ctrl->elem_size;
1263 return !memcmp(ptr1.p + idx, ptr2.p + idx, ctrl->elem_size);
1267 static void std_init(const struct v4l2_ctrl *ctrl, u32 idx,
1268 union v4l2_ctrl_ptr ptr)
1270 switch (ctrl->type) {
1271 case V4L2_CTRL_TYPE_STRING:
1272 idx *= ctrl->elem_size;
1273 memset(ptr.p_char + idx, ' ', ctrl->minimum);
1274 ptr.p_char[idx + ctrl->minimum] = '\0';
1276 case V4L2_CTRL_TYPE_INTEGER64:
1277 ptr.p_s64[idx] = ctrl->default_value;
1279 case V4L2_CTRL_TYPE_INTEGER:
1280 case V4L2_CTRL_TYPE_INTEGER_MENU:
1281 case V4L2_CTRL_TYPE_MENU:
1282 case V4L2_CTRL_TYPE_BITMASK:
1283 case V4L2_CTRL_TYPE_BOOLEAN:
1284 ptr.p_s32[idx] = ctrl->default_value;
1286 case V4L2_CTRL_TYPE_U8:
1287 ptr.p_u8[idx] = ctrl->default_value;
1289 case V4L2_CTRL_TYPE_U16:
1290 ptr.p_u16[idx] = ctrl->default_value;
1292 case V4L2_CTRL_TYPE_U32:
1293 ptr.p_u32[idx] = ctrl->default_value;
1296 idx *= ctrl->elem_size;
1297 memset(ptr.p + idx, 0, ctrl->elem_size);
1302 static void std_log(const struct v4l2_ctrl *ctrl)
1304 union v4l2_ctrl_ptr ptr = ctrl->p_cur;
1306 if (ctrl->is_array) {
1309 for (i = 0; i < ctrl->nr_of_dims; i++)
1310 pr_cont("[%u]", ctrl->dims[i]);
1314 switch (ctrl->type) {
1315 case V4L2_CTRL_TYPE_INTEGER:
1316 pr_cont("%d", *ptr.p_s32);
1318 case V4L2_CTRL_TYPE_BOOLEAN:
1319 pr_cont("%s", *ptr.p_s32 ? "true" : "false");
1321 case V4L2_CTRL_TYPE_MENU:
1322 pr_cont("%s", ctrl->qmenu[*ptr.p_s32]);
1324 case V4L2_CTRL_TYPE_INTEGER_MENU:
1325 pr_cont("%lld", ctrl->qmenu_int[*ptr.p_s32]);
1327 case V4L2_CTRL_TYPE_BITMASK:
1328 pr_cont("0x%08x", *ptr.p_s32);
1330 case V4L2_CTRL_TYPE_INTEGER64:
1331 pr_cont("%lld", *ptr.p_s64);
1333 case V4L2_CTRL_TYPE_STRING:
1334 pr_cont("%s", ptr.p_char);
1336 case V4L2_CTRL_TYPE_U8:
1337 pr_cont("%u", (unsigned)*ptr.p_u8);
1339 case V4L2_CTRL_TYPE_U16:
1340 pr_cont("%u", (unsigned)*ptr.p_u16);
1342 case V4L2_CTRL_TYPE_U32:
1343 pr_cont("%u", (unsigned)*ptr.p_u32);
1346 pr_cont("unknown type %d", ctrl->type);
1352 * Round towards the closest legal value. Be careful when we are
1353 * close to the maximum range of the control type to prevent
1356 #define ROUND_TO_RANGE(val, offset_type, ctrl) \
1358 offset_type offset; \
1359 if ((ctrl)->maximum >= 0 && \
1360 val >= (ctrl)->maximum - (s32)((ctrl)->step / 2)) \
1361 val = (ctrl)->maximum; \
1363 val += (s32)((ctrl)->step / 2); \
1364 val = clamp_t(typeof(val), val, \
1365 (ctrl)->minimum, (ctrl)->maximum); \
1366 offset = (val) - (ctrl)->minimum; \
1367 offset = (ctrl)->step * (offset / (u32)(ctrl)->step); \
1368 val = (ctrl)->minimum + offset; \
1372 /* Validate a new control */
1373 static int std_validate(const struct v4l2_ctrl *ctrl, u32 idx,
1374 union v4l2_ctrl_ptr ptr)
1380 switch (ctrl->type) {
1381 case V4L2_CTRL_TYPE_INTEGER:
1382 return ROUND_TO_RANGE(ptr.p_s32[idx], u32, ctrl);
1383 case V4L2_CTRL_TYPE_INTEGER64:
1385 * We can't use the ROUND_TO_RANGE define here due to
1386 * the u64 divide that needs special care.
1388 val = ptr.p_s64[idx];
1389 if (ctrl->maximum >= 0 && val >= ctrl->maximum - (s64)(ctrl->step / 2))
1390 val = ctrl->maximum;
1392 val += (s64)(ctrl->step / 2);
1393 val = clamp_t(s64, val, ctrl->minimum, ctrl->maximum);
1394 offset = val - ctrl->minimum;
1395 do_div(offset, ctrl->step);
1396 ptr.p_s64[idx] = ctrl->minimum + offset * ctrl->step;
1398 case V4L2_CTRL_TYPE_U8:
1399 return ROUND_TO_RANGE(ptr.p_u8[idx], u8, ctrl);
1400 case V4L2_CTRL_TYPE_U16:
1401 return ROUND_TO_RANGE(ptr.p_u16[idx], u16, ctrl);
1402 case V4L2_CTRL_TYPE_U32:
1403 return ROUND_TO_RANGE(ptr.p_u32[idx], u32, ctrl);
1405 case V4L2_CTRL_TYPE_BOOLEAN:
1406 ptr.p_s32[idx] = !!ptr.p_s32[idx];
1409 case V4L2_CTRL_TYPE_MENU:
1410 case V4L2_CTRL_TYPE_INTEGER_MENU:
1411 if (ptr.p_s32[idx] < ctrl->minimum || ptr.p_s32[idx] > ctrl->maximum)
1413 if (ctrl->menu_skip_mask & (1 << ptr.p_s32[idx]))
1415 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1416 ctrl->qmenu[ptr.p_s32[idx]][0] == '\0')
1420 case V4L2_CTRL_TYPE_BITMASK:
1421 ptr.p_s32[idx] &= ctrl->maximum;
1424 case V4L2_CTRL_TYPE_BUTTON:
1425 case V4L2_CTRL_TYPE_CTRL_CLASS:
1429 case V4L2_CTRL_TYPE_STRING:
1430 idx *= ctrl->elem_size;
1431 len = strlen(ptr.p_char + idx);
1432 if (len < ctrl->minimum)
1434 if ((len - (u32)ctrl->minimum) % (u32)ctrl->step)
1443 static const struct v4l2_ctrl_type_ops std_type_ops = {
1447 .validate = std_validate,
1450 /* Helper function: copy the given control value back to the caller */
1451 static int ptr_to_user(struct v4l2_ext_control *c,
1452 struct v4l2_ctrl *ctrl,
1453 union v4l2_ctrl_ptr ptr)
1457 if (ctrl->is_ptr && !ctrl->is_string)
1458 return copy_to_user(c->ptr, ptr.p, c->size) ?
1461 switch (ctrl->type) {
1462 case V4L2_CTRL_TYPE_STRING:
1463 len = strlen(ptr.p_char);
1464 if (c->size < len + 1) {
1465 c->size = ctrl->elem_size;
1468 return copy_to_user(c->string, ptr.p_char, len + 1) ?
1470 case V4L2_CTRL_TYPE_INTEGER64:
1471 c->value64 = *ptr.p_s64;
1474 c->value = *ptr.p_s32;
1480 /* Helper function: copy the current control value back to the caller */
1481 static int cur_to_user(struct v4l2_ext_control *c,
1482 struct v4l2_ctrl *ctrl)
1484 return ptr_to_user(c, ctrl, ctrl->p_cur);
1487 /* Helper function: copy the store's control value back to the caller */
1488 static int store_to_user(struct v4l2_ext_control *c,
1489 struct v4l2_ctrl *ctrl, unsigned store)
1492 return ptr_to_user(c, ctrl, ctrl->p_new);
1493 return ptr_to_user(c, ctrl, ctrl->p_stores[store - 1]);
1496 /* Helper function: copy the new control value back to the caller */
1497 static int new_to_user(struct v4l2_ext_control *c,
1498 struct v4l2_ctrl *ctrl)
1500 return ptr_to_user(c, ctrl, ctrl->p_new);
1503 /* Helper function: copy the caller-provider value to the given control value */
1504 static int user_to_ptr(struct v4l2_ext_control *c,
1505 struct v4l2_ctrl *ctrl,
1506 union v4l2_ctrl_ptr ptr)
1512 if (ctrl->is_ptr && !ctrl->is_string) {
1515 ret = copy_from_user(ptr.p, c->ptr, c->size) ? -EFAULT : 0;
1516 if (ret || !ctrl->is_array)
1518 for (idx = c->size / ctrl->elem_size; idx < ctrl->elems; idx++)
1519 ctrl->type_ops->init(ctrl, idx, ptr);
1523 switch (ctrl->type) {
1524 case V4L2_CTRL_TYPE_INTEGER64:
1525 *ptr.p_s64 = c->value64;
1527 case V4L2_CTRL_TYPE_STRING:
1531 if (size > ctrl->maximum + 1)
1532 size = ctrl->maximum + 1;
1533 ret = copy_from_user(ptr.p_char, c->string, size) ? -EFAULT : 0;
1535 char last = ptr.p_char[size - 1];
1537 ptr.p_char[size - 1] = 0;
1538 /* If the string was longer than ctrl->maximum,
1539 then return an error. */
1540 if (strlen(ptr.p_char) == ctrl->maximum && last)
1545 *ptr.p_s32 = c->value;
1551 /* Helper function: copy the caller-provider value as the new control value */
1552 static int user_to_new(struct v4l2_ext_control *c,
1553 struct v4l2_ctrl *ctrl)
1555 return user_to_ptr(c, ctrl, ctrl->p_new);
1558 /* Copy the one value to another. */
1559 static void ptr_to_ptr(struct v4l2_ctrl *ctrl,
1560 union v4l2_ctrl_ptr from, union v4l2_ctrl_ptr to)
1564 memcpy(to.p, from.p, ctrl->elems * ctrl->elem_size);
1567 /* Copy the new value to the current value. */
1568 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
1575 /* has_changed is set by cluster_changed */
1576 changed = ctrl->has_changed;
1578 ptr_to_ptr(ctrl, ctrl->p_new, ctrl->p_cur);
1580 if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1581 /* Note: CH_FLAGS is only set for auto clusters. */
1583 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1584 if (!is_cur_manual(ctrl->cluster[0])) {
1585 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1586 if (ctrl->cluster[0]->has_volatiles)
1587 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1591 if (changed || ch_flags) {
1592 /* If a control was changed that was not one of the controls
1593 modified by the application, then send the event to all. */
1596 send_event(fh, ctrl,
1597 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
1598 if (ctrl->call_notify && changed && ctrl->handler->notify)
1599 ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
1603 /* Helper function: copy the new control value to the store */
1604 static void new_to_store(struct v4l2_ctrl *ctrl)
1606 /* has_changed is set by cluster_changed */
1607 if (ctrl && ctrl->has_changed)
1608 ptr_to_ptr(ctrl, ctrl->p_new, ctrl->p_stores[ctrl->store - 1]);
1611 /* Copy the current value to the new value */
1612 static void cur_to_new(struct v4l2_ctrl *ctrl)
1616 ptr_to_ptr(ctrl, ctrl->p_cur, ctrl->p_new);
1619 /* Return non-zero if one or more of the controls in the cluster has a new
1620 value that differs from the current value. */
1621 static int cluster_changed(struct v4l2_ctrl *master)
1623 bool changed = false;
1627 for (i = 0; i < master->ncontrols; i++) {
1628 struct v4l2_ctrl *ctrl = master->cluster[i];
1629 union v4l2_ctrl_ptr ptr;
1630 bool ctrl_changed = false;
1635 if (ctrl->flags & V4L2_CTRL_FLAG_EXECUTE_ON_WRITE)
1636 changed = ctrl_changed = true;
1639 * Set has_changed to false to avoid generating
1640 * the event V4L2_EVENT_CTRL_CH_VALUE
1642 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
1643 ctrl->has_changed = false;
1648 ptr = ctrl->p_stores[ctrl->store - 1];
1652 for (idx = 0; !ctrl_changed && idx < ctrl->elems; idx++)
1653 ctrl_changed = !ctrl->type_ops->equal(ctrl, idx,
1655 ctrl->has_changed = ctrl_changed;
1656 changed |= ctrl->has_changed;
1661 /* Control range checking */
1662 static int check_range(enum v4l2_ctrl_type type,
1663 s64 min, s64 max, u64 step, s64 def)
1666 case V4L2_CTRL_TYPE_BOOLEAN:
1667 if (step != 1 || max > 1 || min < 0)
1670 case V4L2_CTRL_TYPE_U8:
1671 case V4L2_CTRL_TYPE_U16:
1672 case V4L2_CTRL_TYPE_U32:
1673 case V4L2_CTRL_TYPE_INTEGER:
1674 case V4L2_CTRL_TYPE_INTEGER64:
1675 if (step == 0 || min > max || def < min || def > max)
1678 case V4L2_CTRL_TYPE_BITMASK:
1679 if (step || min || !max || (def & ~max))
1682 case V4L2_CTRL_TYPE_MENU:
1683 case V4L2_CTRL_TYPE_INTEGER_MENU:
1684 if (min > max || def < min || def > max)
1686 /* Note: step == menu_skip_mask for menu controls.
1687 So here we check if the default value is masked out. */
1688 if (step && ((1 << def) & step))
1691 case V4L2_CTRL_TYPE_STRING:
1692 if (min > max || min < 0 || step < 1 || def)
1700 /* Validate a new control */
1701 static int validate_new(const struct v4l2_ctrl *ctrl, union v4l2_ctrl_ptr p_new)
1706 for (idx = 0; !err && idx < ctrl->elems; idx++)
1707 err = ctrl->type_ops->validate(ctrl, idx, p_new);
1711 static inline u32 node2id(struct list_head *node)
1713 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1716 /* Set the handler's error code if it wasn't set earlier already */
1717 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1719 if (hdl->error == 0)
1724 /* Initialize the handler */
1725 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1726 unsigned nr_of_controls_hint,
1727 struct lock_class_key *key, const char *name)
1729 hdl->lock = &hdl->_lock;
1730 mutex_init(hdl->lock);
1731 lockdep_set_class_and_name(hdl->lock, key, name);
1732 INIT_LIST_HEAD(&hdl->ctrls);
1733 INIT_LIST_HEAD(&hdl->ctrl_refs);
1734 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1735 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1737 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1740 EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
1742 /* Free all controls and control refs */
1743 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1745 struct v4l2_ctrl_ref *ref, *next_ref;
1746 struct v4l2_ctrl *ctrl, *next_ctrl;
1747 struct v4l2_subscribed_event *sev, *next_sev;
1749 if (hdl == NULL || hdl->buckets == NULL)
1752 mutex_lock(hdl->lock);
1753 /* Free all nodes */
1754 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1755 list_del(&ref->node);
1758 /* Free all controls owned by the handler */
1759 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1760 list_del(&ctrl->node);
1761 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1762 list_del(&sev->node);
1763 if (ctrl->p_stores) {
1766 for (s = 0; s < ctrl->nr_of_stores; s++)
1767 kfree(ctrl->p_stores[s].p);
1769 kfree(ctrl->p_stores);
1772 kfree(hdl->buckets);
1773 hdl->buckets = NULL;
1776 mutex_unlock(hdl->lock);
1778 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1780 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1781 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1782 with applications that do not use the NEXT_CTRL flag.
1784 We just find the n-th private user control. It's O(N), but that should not
1785 be an issue in this particular case. */
1786 static struct v4l2_ctrl_ref *find_private_ref(
1787 struct v4l2_ctrl_handler *hdl, u32 id)
1789 struct v4l2_ctrl_ref *ref;
1791 id -= V4L2_CID_PRIVATE_BASE;
1792 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1793 /* Search for private user controls that are compatible with
1795 if (V4L2_CTRL_ID2WHICH(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1796 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1797 if (!ref->ctrl->is_int)
1807 /* Find a control with the given ID. */
1808 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1810 struct v4l2_ctrl_ref *ref;
1813 id &= V4L2_CTRL_ID_MASK;
1815 /* Old-style private controls need special handling */
1816 if (id >= V4L2_CID_PRIVATE_BASE)
1817 return find_private_ref(hdl, id);
1818 bucket = id % hdl->nr_of_buckets;
1820 /* Simple optimization: cache the last control found */
1821 if (hdl->cached && hdl->cached->ctrl->id == id)
1824 /* Not in cache, search the hash */
1825 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1826 while (ref && ref->ctrl->id != id)
1830 hdl->cached = ref; /* cache it! */
1834 /* Find a control with the given ID. Take the handler's lock first. */
1835 static struct v4l2_ctrl_ref *find_ref_lock(
1836 struct v4l2_ctrl_handler *hdl, u32 id)
1838 struct v4l2_ctrl_ref *ref = NULL;
1841 mutex_lock(hdl->lock);
1842 ref = find_ref(hdl, id);
1843 mutex_unlock(hdl->lock);
1848 /* Find a control with the given ID. */
1849 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1851 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1853 return ref ? ref->ctrl : NULL;
1855 EXPORT_SYMBOL(v4l2_ctrl_find);
1857 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1858 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1859 struct v4l2_ctrl *ctrl)
1861 struct v4l2_ctrl_ref *ref;
1862 struct v4l2_ctrl_ref *new_ref;
1864 u32 class_ctrl = V4L2_CTRL_ID2WHICH(id) | 1;
1865 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1868 * Automatically add the control class if it is not yet present and
1869 * the new control is not a compound control.
1871 if (ctrl->type < V4L2_CTRL_COMPOUND_TYPES &&
1872 id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1873 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1879 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1881 return handler_set_err(hdl, -ENOMEM);
1882 new_ref->ctrl = ctrl;
1883 if (ctrl->handler == hdl) {
1884 /* By default each control starts in a cluster of its own.
1885 new_ref->ctrl is basically a cluster array with one
1886 element, so that's perfect to use as the cluster pointer.
1887 But only do this for the handler that owns the control. */
1888 ctrl->cluster = &new_ref->ctrl;
1889 ctrl->ncontrols = 1;
1892 INIT_LIST_HEAD(&new_ref->node);
1894 mutex_lock(hdl->lock);
1896 /* Add immediately at the end of the list if the list is empty, or if
1897 the last element in the list has a lower ID.
1898 This ensures that when elements are added in ascending order the
1899 insertion is an O(1) operation. */
1900 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1901 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1902 goto insert_in_hash;
1905 /* Find insert position in sorted list */
1906 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1907 if (ref->ctrl->id < id)
1909 /* Don't add duplicates */
1910 if (ref->ctrl->id == id) {
1914 list_add(&new_ref->node, ref->node.prev);
1919 /* Insert the control node in the hash */
1920 new_ref->next = hdl->buckets[bucket];
1921 hdl->buckets[bucket] = new_ref;
1924 mutex_unlock(hdl->lock);
1928 /* Add a new control */
1929 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1930 const struct v4l2_ctrl_ops *ops,
1931 const struct v4l2_ctrl_type_ops *type_ops,
1932 u32 id, const char *name, enum v4l2_ctrl_type type,
1933 s64 min, s64 max, u64 step, s64 def,
1934 const u32 dims[V4L2_CTRL_MAX_DIMS], u32 elem_size,
1935 u32 flags, const char * const *qmenu,
1936 const s64 *qmenu_int, void *priv)
1938 struct v4l2_ctrl *ctrl;
1940 unsigned nr_of_dims = 0;
1943 unsigned tot_ctrl_size;
1951 while (dims && dims[nr_of_dims]) {
1952 elems *= dims[nr_of_dims];
1954 if (nr_of_dims == V4L2_CTRL_MAX_DIMS)
1957 is_array = nr_of_dims > 0;
1959 /* Prefill elem_size for all types handled by std_type_ops */
1961 case V4L2_CTRL_TYPE_INTEGER64:
1962 elem_size = sizeof(s64);
1964 case V4L2_CTRL_TYPE_STRING:
1965 elem_size = max + 1;
1967 case V4L2_CTRL_TYPE_U8:
1968 elem_size = sizeof(u8);
1970 case V4L2_CTRL_TYPE_U16:
1971 elem_size = sizeof(u16);
1973 case V4L2_CTRL_TYPE_U32:
1974 elem_size = sizeof(u32);
1977 if (type < V4L2_CTRL_COMPOUND_TYPES)
1978 elem_size = sizeof(s32);
1981 tot_ctrl_size = elem_size * elems;
1984 if (id == 0 || name == NULL || !elem_size ||
1985 id >= V4L2_CID_PRIVATE_BASE ||
1986 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1987 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
1988 handler_set_err(hdl, -ERANGE);
1991 err = check_range(type, min, max, step, def);
1993 handler_set_err(hdl, err);
1996 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1997 handler_set_err(hdl, -ERANGE);
2000 if ((is_array || (flags & V4L2_CTRL_FLAG_CAN_STORE)) &&
2001 (type == V4L2_CTRL_TYPE_BUTTON ||
2002 type == V4L2_CTRL_TYPE_CTRL_CLASS)) {
2003 handler_set_err(hdl, -EINVAL);
2008 if (type == V4L2_CTRL_TYPE_BUTTON)
2009 flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
2010 V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
2011 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
2012 flags |= V4L2_CTRL_FLAG_READ_ONLY;
2013 else if (type == V4L2_CTRL_TYPE_INTEGER64 ||
2014 type == V4L2_CTRL_TYPE_STRING ||
2015 type >= V4L2_CTRL_COMPOUND_TYPES ||
2017 sz_extra += 2 * tot_ctrl_size;
2019 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
2021 handler_set_err(hdl, -ENOMEM);
2025 INIT_LIST_HEAD(&ctrl->node);
2026 INIT_LIST_HEAD(&ctrl->ev_subs);
2027 ctrl->handler = hdl;
2029 ctrl->type_ops = type_ops ? type_ops : &std_type_ops;
2033 ctrl->flags = flags;
2034 ctrl->minimum = min;
2035 ctrl->maximum = max;
2037 ctrl->default_value = def;
2038 ctrl->is_string = !is_array && type == V4L2_CTRL_TYPE_STRING;
2039 ctrl->is_ptr = is_array || type >= V4L2_CTRL_COMPOUND_TYPES || ctrl->is_string;
2040 ctrl->is_int = !ctrl->is_ptr && type != V4L2_CTRL_TYPE_INTEGER64;
2041 ctrl->is_array = is_array;
2042 ctrl->elems = elems;
2043 ctrl->nr_of_dims = nr_of_dims;
2045 memcpy(ctrl->dims, dims, nr_of_dims * sizeof(dims[0]));
2046 ctrl->elem_size = elem_size;
2047 if (type == V4L2_CTRL_TYPE_MENU)
2048 ctrl->qmenu = qmenu;
2049 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2050 ctrl->qmenu_int = qmenu_int;
2052 ctrl->cur.val = ctrl->val = def;
2055 if (!ctrl->is_int) {
2056 ctrl->p_new.p = data;
2057 ctrl->p_cur.p = data + tot_ctrl_size;
2059 ctrl->p_new.p = &ctrl->val;
2060 ctrl->p_cur.p = &ctrl->cur.val;
2062 for (idx = 0; idx < elems; idx++) {
2063 ctrl->type_ops->init(ctrl, idx, ctrl->p_cur);
2064 ctrl->type_ops->init(ctrl, idx, ctrl->p_new);
2067 if (handler_new_ref(hdl, ctrl)) {
2071 mutex_lock(hdl->lock);
2072 list_add_tail(&ctrl->node, &hdl->ctrls);
2073 mutex_unlock(hdl->lock);
2077 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
2078 const struct v4l2_ctrl_config *cfg, void *priv)
2081 struct v4l2_ctrl *ctrl;
2082 const char *name = cfg->name;
2083 const char * const *qmenu = cfg->qmenu;
2084 const s64 *qmenu_int = cfg->qmenu_int;
2085 enum v4l2_ctrl_type type = cfg->type;
2086 u32 flags = cfg->flags;
2089 u64 step = cfg->step;
2093 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
2096 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
2097 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
2101 WARN_ON(cfg->menu_skip_mask);
2102 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
2103 qmenu = v4l2_ctrl_get_menu(cfg->id);
2104 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
2105 qmenu_int == NULL) {
2106 handler_set_err(hdl, -EINVAL);
2110 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->type_ops, cfg->id, name,
2112 is_menu ? cfg->menu_skip_mask : step, def,
2113 cfg->dims, cfg->elem_size,
2114 flags, qmenu, qmenu_int, priv);
2116 ctrl->is_private = cfg->is_private;
2117 v4l2_ctrl_set_max_stores(ctrl, cfg->max_stores);
2121 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
2123 /* Helper function for standard non-menu controls */
2124 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
2125 const struct v4l2_ctrl_ops *ops,
2126 u32 id, s64 min, s64 max, u64 step, s64 def)
2129 enum v4l2_ctrl_type type;
2132 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2133 if (type == V4L2_CTRL_TYPE_MENU ||
2134 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
2135 type >= V4L2_CTRL_COMPOUND_TYPES) {
2136 handler_set_err(hdl, -EINVAL);
2139 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2140 min, max, step, def, NULL, 0,
2141 flags, NULL, NULL, NULL);
2143 EXPORT_SYMBOL(v4l2_ctrl_new_std);
2145 /* Helper function for standard menu controls */
2146 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
2147 const struct v4l2_ctrl_ops *ops,
2148 u32 id, u8 _max, u64 mask, u8 _def)
2150 const char * const *qmenu = NULL;
2151 const s64 *qmenu_int = NULL;
2152 unsigned int qmenu_int_len = 0;
2154 enum v4l2_ctrl_type type;
2161 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2163 if (type == V4L2_CTRL_TYPE_MENU)
2164 qmenu = v4l2_ctrl_get_menu(id);
2165 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2166 qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
2168 if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
2169 handler_set_err(hdl, -EINVAL);
2172 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2173 0, max, mask, def, NULL, 0,
2174 flags, qmenu, qmenu_int, NULL);
2176 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
2178 /* Helper function for standard menu controls with driver defined menu */
2179 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
2180 const struct v4l2_ctrl_ops *ops, u32 id, u8 _max,
2181 u64 mask, u8 _def, const char * const *qmenu)
2183 enum v4l2_ctrl_type type;
2191 /* v4l2_ctrl_new_std_menu_items() should only be called for
2192 * standard controls without a standard menu.
2194 if (v4l2_ctrl_get_menu(id)) {
2195 handler_set_err(hdl, -EINVAL);
2199 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2200 if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
2201 handler_set_err(hdl, -EINVAL);
2204 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2205 0, max, mask, def, NULL, 0,
2206 flags, qmenu, NULL, NULL);
2209 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
2211 /* Helper function for standard integer menu controls */
2212 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
2213 const struct v4l2_ctrl_ops *ops,
2214 u32 id, u8 _max, u8 _def, const s64 *qmenu_int)
2217 enum v4l2_ctrl_type type;
2224 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2225 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
2226 handler_set_err(hdl, -EINVAL);
2229 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2230 0, max, 0, def, NULL, 0,
2231 flags, NULL, qmenu_int, NULL);
2233 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
2235 /* Add a control from another handler to this handler */
2236 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
2237 struct v4l2_ctrl *ctrl)
2239 if (hdl == NULL || hdl->error)
2242 handler_set_err(hdl, -EINVAL);
2245 if (ctrl->handler == hdl)
2247 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
2249 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
2251 /* Add the controls from another handler to our own. */
2252 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
2253 struct v4l2_ctrl_handler *add,
2254 bool (*filter)(const struct v4l2_ctrl *ctrl))
2256 struct v4l2_ctrl_ref *ref;
2259 /* Do nothing if either handler is NULL or if they are the same */
2260 if (!hdl || !add || hdl == add)
2264 mutex_lock(add->lock);
2265 list_for_each_entry(ref, &add->ctrl_refs, node) {
2266 struct v4l2_ctrl *ctrl = ref->ctrl;
2268 /* Skip handler-private controls. */
2269 if (ctrl->is_private)
2271 /* And control classes */
2272 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2274 /* Filter any unwanted controls */
2275 if (filter && !filter(ctrl))
2277 ret = handler_new_ref(hdl, ctrl);
2281 mutex_unlock(add->lock);
2284 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
2286 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
2288 if (V4L2_CTRL_ID2WHICH(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
2290 if (V4L2_CTRL_ID2WHICH(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
2293 case V4L2_CID_AUDIO_MUTE:
2294 case V4L2_CID_AUDIO_VOLUME:
2295 case V4L2_CID_AUDIO_BALANCE:
2296 case V4L2_CID_AUDIO_BASS:
2297 case V4L2_CID_AUDIO_TREBLE:
2298 case V4L2_CID_AUDIO_LOUDNESS:
2305 EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
2307 /* Cluster controls */
2308 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
2310 bool has_volatiles = false;
2313 /* The first control is the master control and it must not be NULL */
2314 if (WARN_ON(ncontrols == 0 || controls[0] == NULL))
2317 for (i = 0; i < ncontrols; i++) {
2319 controls[i]->cluster = controls;
2320 controls[i]->ncontrols = ncontrols;
2321 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
2322 has_volatiles = true;
2325 controls[0]->has_volatiles = has_volatiles;
2327 EXPORT_SYMBOL(v4l2_ctrl_cluster);
2329 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
2330 u8 manual_val, bool set_volatile)
2332 struct v4l2_ctrl *master = controls[0];
2336 v4l2_ctrl_cluster(ncontrols, controls);
2337 WARN_ON(ncontrols <= 1);
2338 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
2339 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
2340 master->is_auto = true;
2341 master->has_volatiles = set_volatile;
2342 master->manual_mode_value = manual_val;
2343 master->flags |= V4L2_CTRL_FLAG_UPDATE;
2345 if (!is_cur_manual(master))
2346 flag = V4L2_CTRL_FLAG_INACTIVE |
2347 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
2349 for (i = 1; i < ncontrols; i++)
2351 controls[i]->flags |= flag;
2353 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
2355 /* Activate/deactivate a control. */
2356 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
2358 /* invert since the actual flag is called 'inactive' */
2359 bool inactive = !active;
2366 /* set V4L2_CTRL_FLAG_INACTIVE */
2367 old = test_and_set_bit(4, &ctrl->flags);
2369 /* clear V4L2_CTRL_FLAG_INACTIVE */
2370 old = test_and_clear_bit(4, &ctrl->flags);
2371 if (old != inactive)
2372 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2374 EXPORT_SYMBOL(v4l2_ctrl_activate);
2376 /* Grab/ungrab a control.
2377 Typically used when streaming starts and you want to grab controls,
2378 preventing the user from changing them.
2380 Just call this and the framework will block any attempts to change
2382 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
2389 v4l2_ctrl_lock(ctrl);
2391 /* set V4L2_CTRL_FLAG_GRABBED */
2392 old = test_and_set_bit(1, &ctrl->flags);
2394 /* clear V4L2_CTRL_FLAG_GRABBED */
2395 old = test_and_clear_bit(1, &ctrl->flags);
2397 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2398 v4l2_ctrl_unlock(ctrl);
2400 EXPORT_SYMBOL(v4l2_ctrl_grab);
2402 /* Log the control name and value */
2403 static void log_ctrl(const struct v4l2_ctrl *ctrl,
2404 const char *prefix, const char *colon)
2406 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2408 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2411 pr_info("%s%s%s: ", prefix, colon, ctrl->name);
2413 ctrl->type_ops->log(ctrl);
2415 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2416 V4L2_CTRL_FLAG_GRABBED |
2417 V4L2_CTRL_FLAG_VOLATILE)) {
2418 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
2419 pr_cont(" inactive");
2420 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
2421 pr_cont(" grabbed");
2422 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
2423 pr_cont(" volatile");
2428 /* Log all controls owned by the handler */
2429 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2432 struct v4l2_ctrl *ctrl;
2433 const char *colon = "";
2440 len = strlen(prefix);
2441 if (len && prefix[len - 1] != ' ')
2443 mutex_lock(hdl->lock);
2444 list_for_each_entry(ctrl, &hdl->ctrls, node)
2445 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2446 log_ctrl(ctrl, prefix, colon);
2447 mutex_unlock(hdl->lock);
2449 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2451 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2453 v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2456 EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2458 /* Call s_ctrl for all controls owned by the handler */
2459 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2461 struct v4l2_ctrl *ctrl;
2466 mutex_lock(hdl->lock);
2467 list_for_each_entry(ctrl, &hdl->ctrls, node)
2470 list_for_each_entry(ctrl, &hdl->ctrls, node) {
2471 struct v4l2_ctrl *master = ctrl->cluster[0];
2474 /* Skip if this control was already handled by a cluster. */
2475 /* Skip button controls and read-only controls. */
2476 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2477 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
2480 for (i = 0; i < master->ncontrols; i++) {
2481 if (master->cluster[i]) {
2482 cur_to_new(master->cluster[i]);
2483 master->cluster[i]->is_new = 1;
2484 master->cluster[i]->done = true;
2485 master->cluster[i]->store = 0;
2488 ret = call_op(master, s_ctrl);
2492 mutex_unlock(hdl->lock);
2495 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2497 /* Implement VIDIOC_QUERY_EXT_CTRL */
2498 int v4l2_query_ext_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_query_ext_ctrl *qc)
2500 const unsigned next_flags = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND;
2501 u32 id = qc->id & V4L2_CTRL_ID_MASK;
2502 struct v4l2_ctrl_ref *ref;
2503 struct v4l2_ctrl *ctrl;
2508 mutex_lock(hdl->lock);
2510 /* Try to find it */
2511 ref = find_ref(hdl, id);
2513 if ((qc->id & next_flags) && !list_empty(&hdl->ctrl_refs)) {
2515 /* Match any control that is not hidden */
2519 if ((qc->id & next_flags) == V4L2_CTRL_FLAG_NEXT_COMPOUND) {
2520 /* Match any hidden control */
2522 } else if ((qc->id & next_flags) == next_flags) {
2523 /* Match any control, compound or not */
2527 /* Find the next control with ID > qc->id */
2529 /* Did we reach the end of the control list? */
2530 if (id >= node2id(hdl->ctrl_refs.prev)) {
2531 ref = NULL; /* Yes, so there is no next control */
2533 /* We found a control with the given ID, so just get
2534 the next valid one in the list. */
2535 list_for_each_entry_continue(ref, &hdl->ctrl_refs, node) {
2536 is_compound = ref->ctrl->is_array ||
2537 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2538 if (id < ref->ctrl->id &&
2539 (is_compound & mask) == match)
2542 if (&ref->node == &hdl->ctrl_refs)
2545 /* No control with the given ID exists, so start
2546 searching for the next largest ID. We know there
2547 is one, otherwise the first 'if' above would have
2549 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
2550 is_compound = ref->ctrl->is_array ||
2551 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2552 if (id < ref->ctrl->id &&
2553 (is_compound & mask) == match)
2556 if (&ref->node == &hdl->ctrl_refs)
2560 mutex_unlock(hdl->lock);
2566 memset(qc, 0, sizeof(*qc));
2567 if (id >= V4L2_CID_PRIVATE_BASE)
2571 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
2572 qc->flags = ctrl->flags;
2573 if (ctrl->max_stores)
2574 qc->flags |= V4L2_CTRL_FLAG_CAN_STORE;
2575 qc->type = ctrl->type;
2577 qc->flags |= V4L2_CTRL_FLAG_HAS_PAYLOAD;
2578 qc->elem_size = ctrl->elem_size;
2579 qc->elems = ctrl->elems;
2580 qc->nr_of_dims = ctrl->nr_of_dims;
2581 memcpy(qc->dims, ctrl->dims, qc->nr_of_dims * sizeof(qc->dims[0]));
2582 qc->minimum = ctrl->minimum;
2583 qc->maximum = ctrl->maximum;
2584 qc->default_value = ctrl->default_value;
2585 if (ctrl->type == V4L2_CTRL_TYPE_MENU
2586 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
2589 qc->step = ctrl->step;
2592 EXPORT_SYMBOL(v4l2_query_ext_ctrl);
2594 /* Implement VIDIOC_QUERYCTRL */
2595 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2597 struct v4l2_query_ext_ctrl qec = { qc->id };
2600 rc = v4l2_query_ext_ctrl(hdl, &qec);
2605 qc->type = qec.type;
2606 qc->flags = qec.flags;
2607 strlcpy(qc->name, qec.name, sizeof(qc->name));
2609 case V4L2_CTRL_TYPE_INTEGER:
2610 case V4L2_CTRL_TYPE_BOOLEAN:
2611 case V4L2_CTRL_TYPE_MENU:
2612 case V4L2_CTRL_TYPE_INTEGER_MENU:
2613 case V4L2_CTRL_TYPE_STRING:
2614 case V4L2_CTRL_TYPE_BITMASK:
2615 qc->minimum = qec.minimum;
2616 qc->maximum = qec.maximum;
2617 qc->step = qec.step;
2618 qc->default_value = qec.default_value;
2624 qc->default_value = 0;
2629 EXPORT_SYMBOL(v4l2_queryctrl);
2631 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2633 if (qc->id & (V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND))
2635 return v4l2_queryctrl(sd->ctrl_handler, qc);
2637 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2639 /* Implement VIDIOC_QUERYMENU */
2640 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2642 struct v4l2_ctrl *ctrl;
2645 ctrl = v4l2_ctrl_find(hdl, qm->id);
2651 switch (ctrl->type) {
2652 case V4L2_CTRL_TYPE_MENU:
2653 if (ctrl->qmenu == NULL)
2656 case V4L2_CTRL_TYPE_INTEGER_MENU:
2657 if (ctrl->qmenu_int == NULL)
2664 if (i < ctrl->minimum || i > ctrl->maximum)
2667 /* Use mask to see if this menu item should be skipped */
2668 if (ctrl->menu_skip_mask & (1 << i))
2670 /* Empty menu items should also be skipped */
2671 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2672 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2674 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2676 qm->value = ctrl->qmenu_int[i];
2680 EXPORT_SYMBOL(v4l2_querymenu);
2682 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2684 return v4l2_querymenu(sd->ctrl_handler, qm);
2686 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2690 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2692 It is not a fully atomic operation, just best-effort only. After all, if
2693 multiple controls have to be set through multiple i2c writes (for example)
2694 then some initial writes may succeed while others fail. Thus leaving the
2695 system in an inconsistent state. The question is how much effort you are
2696 willing to spend on trying to make something atomic that really isn't.
2698 From the point of view of an application the main requirement is that
2699 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2700 error should be returned without actually affecting any controls.
2702 If all the values are correct, then it is acceptable to just give up
2703 in case of low-level errors.
2705 It is important though that the application can tell when only a partial
2706 configuration was done. The way we do that is through the error_idx field
2707 of struct v4l2_ext_controls: if that is equal to the count field then no
2708 controls were affected. Otherwise all controls before that index were
2709 successful in performing their 'get' or 'set' operation, the control at
2710 the given index failed, and you don't know what happened with the controls
2711 after the failed one. Since if they were part of a control cluster they
2712 could have been successfully processed (if a cluster member was encountered
2713 at index < error_idx), they could have failed (if a cluster member was at
2714 error_idx), or they may not have been processed yet (if the first cluster
2715 member appeared after error_idx).
2717 It is all fairly theoretical, though. In practice all you can do is to
2718 bail out. If error_idx == count, then it is an application bug. If
2719 error_idx < count then it is only an application bug if the error code was
2720 EBUSY. That usually means that something started streaming just when you
2721 tried to set the controls. In all other cases it is a driver/hardware
2722 problem and all you can do is to retry or bail out.
2724 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2725 never modifies controls the error_idx is just set to whatever control
2726 has an invalid value.
2729 /* Prepare for the extended g/s/try functions.
2730 Find the controls in the control array and do some basic checks. */
2731 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2732 struct v4l2_ext_controls *cs,
2733 struct v4l2_ctrl_helper *helpers,
2736 unsigned store = cs->config_store & 0xffff;
2737 struct v4l2_ctrl_helper *h;
2738 bool have_clusters = false;
2741 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2742 struct v4l2_ext_control *c = &cs->controls[i];
2743 struct v4l2_ctrl_ref *ref;
2744 struct v4l2_ctrl *ctrl;
2745 u32 id = c->id & V4L2_CTRL_ID_MASK;
2749 if (cs->which && V4L2_CTRL_ID2WHICH(id) != cs->which)
2752 /* Old-style private controls are not allowed for
2753 extended controls */
2754 if (id >= V4L2_CID_PRIVATE_BASE)
2756 ref = find_ref_lock(hdl, id);
2760 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2762 if (store > ctrl->max_stores)
2765 if (ctrl->cluster[0]->ncontrols > 1)
2766 have_clusters = true;
2767 if (ctrl->cluster[0] != ctrl)
2768 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2769 if (ctrl->is_ptr && !ctrl->is_string) {
2770 unsigned tot_size = ctrl->elems * ctrl->elem_size;
2772 if (c->size < tot_size) {
2781 /* Store the ref to the master control of the cluster */
2784 /* Initially set next to 0, meaning that there is no other
2785 control in this helper array belonging to the same
2790 /* We are done if there were no controls that belong to a multi-
2795 /* The code below figures out in O(n) time which controls in the list
2796 belong to the same cluster. */
2798 /* This has to be done with the handler lock taken. */
2799 mutex_lock(hdl->lock);
2801 /* First zero the helper field in the master control references */
2802 for (i = 0; i < cs->count; i++)
2803 helpers[i].mref->helper = NULL;
2804 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2805 struct v4l2_ctrl_ref *mref = h->mref;
2807 /* If the mref->helper is set, then it points to an earlier
2808 helper that belongs to the same cluster. */
2810 /* Set the next field of mref->helper to the current
2811 index: this means that that earlier helper now
2812 points to the next helper in the same cluster. */
2813 mref->helper->next = i;
2814 /* mref should be set only for the first helper in the
2815 cluster, clear the others. */
2818 /* Point the mref helper to the current helper struct. */
2821 mutex_unlock(hdl->lock);
2825 /* Handles the corner case where cs->count == 0. It checks whether the
2826 specified control class exists. If that class ID is 0, then it checks
2827 whether there are any controls at all. */
2828 static int class_check(struct v4l2_ctrl_handler *hdl, u32 which)
2831 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2832 return find_ref_lock(hdl, which | 1) ? 0 : -EINVAL;
2835 static int extend_store(struct v4l2_ctrl *ctrl, unsigned stores)
2838 union v4l2_ctrl_ptr *p;
2840 p = kcalloc(stores, sizeof(union v4l2_ctrl_ptr), GFP_KERNEL);
2843 for (s = ctrl->nr_of_stores; s < stores; s++) {
2844 p[s].p = kcalloc(ctrl->elems, ctrl->elem_size, GFP_KERNEL);
2845 if (p[s].p == NULL) {
2846 while (s > ctrl->nr_of_stores)
2851 for (idx = 0; idx < ctrl->elems; idx++)
2852 ctrl->type_ops->init(ctrl, idx, p[s]);
2855 memcpy(p, ctrl->p_stores, ctrl->nr_of_stores * sizeof(union v4l2_ctrl_ptr));
2856 kfree(ctrl->p_stores);
2858 ctrl->nr_of_stores = stores;
2863 /* Get extended controls. Allocates the helpers array if needed. */
2864 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2866 struct v4l2_ctrl_helper helper[4];
2867 struct v4l2_ctrl_helper *helpers = helper;
2872 cs->error_idx = cs->count;
2873 if (V4L2_CTRL_ID2WHICH(cs->which))
2874 cs->which = V4L2_CTRL_ID2WHICH(cs->which);
2876 store = cs->config_store;
2882 return class_check(hdl, cs->which);
2884 if (cs->count > ARRAY_SIZE(helper)) {
2885 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2887 if (helpers == NULL)
2891 ret = prepare_ext_ctrls(hdl, cs, helpers, true);
2892 cs->error_idx = cs->count;
2894 for (i = 0; !ret && i < cs->count; i++)
2895 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2898 for (i = 0; !ret && i < cs->count; i++) {
2899 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2900 struct v4l2_ctrl *ctrl) = cur_to_user;
2901 struct v4l2_ctrl *master;
2903 if (helpers[i].mref == NULL)
2906 master = helpers[i].mref->ctrl;
2909 v4l2_ctrl_lock(master);
2911 /* g_volatile_ctrl will update the new control values */
2913 ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2914 (master->has_volatiles && !is_cur_manual(master)))) {
2915 for (j = 0; j < master->ncontrols; j++)
2916 cur_to_new(master->cluster[j]);
2917 ret = call_op(master, g_volatile_ctrl);
2918 ctrl_to_user = new_to_user;
2920 for (j = 0; j < master->ncontrols; j++)
2921 if (!ret && master->cluster[j] &&
2922 store > master->cluster[j]->nr_of_stores)
2923 ret = extend_store(master->cluster[j], store);
2925 /* If OK, then copy the current (for non-volatile controls)
2926 or the new (for volatile controls) control values to the
2933 ret = store_to_user(cs->controls + idx,
2934 helpers[idx].ctrl, store);
2936 ret = ctrl_to_user(cs->controls + idx,
2938 idx = helpers[idx].next;
2939 } while (!ret && idx);
2941 v4l2_ctrl_unlock(master);
2944 if (cs->count > ARRAY_SIZE(helper))
2948 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2950 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2952 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2954 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2956 /* Helper function to get a single control */
2957 static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
2959 struct v4l2_ctrl *master = ctrl->cluster[0];
2963 /* Compound controls are not supported. The new_to_user() and
2964 * cur_to_user() calls below would need to be modified not to access
2965 * userspace memory when called from get_ctrl().
2967 if (!ctrl->is_int && ctrl->type != V4L2_CTRL_TYPE_INTEGER64)
2970 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2973 v4l2_ctrl_lock(master);
2974 /* g_volatile_ctrl will update the current control values */
2975 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2976 for (i = 0; i < master->ncontrols; i++)
2977 cur_to_new(master->cluster[i]);
2978 ret = call_op(master, g_volatile_ctrl);
2979 new_to_user(c, ctrl);
2981 cur_to_user(c, ctrl);
2983 v4l2_ctrl_unlock(master);
2987 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2989 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2990 struct v4l2_ext_control c;
2993 if (ctrl == NULL || !ctrl->is_int)
2995 ret = get_ctrl(ctrl, &c);
2996 control->value = c.value;
2999 EXPORT_SYMBOL(v4l2_g_ctrl);
3001 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
3003 return v4l2_g_ctrl(sd->ctrl_handler, control);
3005 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
3007 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
3009 struct v4l2_ext_control c;
3011 /* It's a driver bug if this happens. */
3012 WARN_ON(!ctrl->is_int);
3017 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
3019 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
3021 struct v4l2_ext_control c;
3023 /* It's a driver bug if this happens. */
3024 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
3029 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
3031 /* Core function that calls try/s_ctrl and ensures that the new value is
3032 copied to the current value on a set.
3033 Must be called with ctrl->handler->lock held. */
3034 static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
3035 u16 store, bool set, u32 ch_flags)
3041 /* Go through the cluster and either validate the new value or
3042 (if no new value was set), copy the current value to the new
3043 value, ensuring a consistent view for the control ops when
3045 for (i = 0; i < master->ncontrols; i++) {
3046 struct v4l2_ctrl *ctrl = master->cluster[i];
3051 if (store > ctrl->max_stores)
3053 if (store > ctrl->nr_of_stores) {
3054 ret = extend_store(ctrl, store);
3058 ctrl->store = store;
3059 if (!ctrl->is_new) {
3063 /* Check again: it may have changed since the
3064 previous check in try_or_set_ext_ctrls(). */
3065 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
3069 ret = call_op(master, try_ctrl);
3071 /* Don't set if there is no change */
3072 if (ret || !set || !cluster_changed(master))
3074 ret = call_op(master, s_ctrl);
3078 /* If OK, then make the new values permanent. */
3079 update_flag = is_cur_manual(master) != is_new_manual(master);
3080 for (i = 0; i < master->ncontrols; i++) {
3082 new_to_store(master->cluster[i]);
3084 new_to_cur(fh, master->cluster[i], ch_flags |
3085 ((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
3090 /* Validate controls. */
3091 static int validate_ctrls(struct v4l2_ext_controls *cs,
3092 struct v4l2_ctrl_helper *helpers, bool set)
3097 cs->error_idx = cs->count;
3098 for (i = 0; i < cs->count; i++) {
3099 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
3100 union v4l2_ctrl_ptr p_new;
3104 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3106 /* This test is also done in try_set_control_cluster() which
3107 is called in atomic context, so that has the final say,
3108 but it makes sense to do an up-front check as well. Once
3109 an error occurs in try_set_control_cluster() some other
3110 controls may have been set already and we want to do a
3111 best-effort to avoid that. */
3112 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
3115 * Skip validation for now if the payload needs to be copied
3116 * from userspace into kernelspace. We'll validate those later.
3120 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3121 p_new.p_s64 = &cs->controls[i].value64;
3123 p_new.p_s32 = &cs->controls[i].value;
3124 ret = validate_new(ctrl, p_new);
3131 /* Obtain the current volatile values of an autocluster and mark them
3133 static void update_from_auto_cluster(struct v4l2_ctrl *master)
3137 for (i = 0; i < master->ncontrols; i++) {
3138 if (master->cluster[i] == NULL)
3140 cur_to_new(master->cluster[i]);
3141 master->cluster[i]->store = 0;
3143 if (!call_op(master, g_volatile_ctrl))
3144 for (i = 1; i < master->ncontrols; i++)
3145 if (master->cluster[i])
3146 master->cluster[i]->is_new = 1;
3149 /* Try or try-and-set controls */
3150 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3151 struct v4l2_ext_controls *cs,
3154 struct v4l2_ctrl_helper helper[4];
3155 struct v4l2_ctrl_helper *helpers = helper;
3160 cs->error_idx = cs->count;
3161 if (V4L2_CTRL_ID2WHICH(cs->which))
3162 cs->which = V4L2_CTRL_ID2WHICH(cs->which);
3164 store = cs->config_store;
3170 return class_check(hdl, cs->which);
3172 if (cs->count > ARRAY_SIZE(helper)) {
3173 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
3178 ret = prepare_ext_ctrls(hdl, cs, helpers, false);
3180 ret = validate_ctrls(cs, helpers, set);
3182 cs->error_idx = cs->count;
3183 for (i = 0; !ret && i < cs->count; i++) {
3184 struct v4l2_ctrl *master;
3187 if (helpers[i].mref == NULL)
3191 master = helpers[i].mref->ctrl;
3192 v4l2_ctrl_lock(master);
3194 /* Reset the 'is_new' flags of the cluster */
3195 for (j = 0; j < master->ncontrols; j++)
3196 if (master->cluster[j])
3197 master->cluster[j]->is_new = 0;
3199 /* For volatile autoclusters that are currently in auto mode
3200 we need to discover if it will be set to manual mode.
3201 If so, then we have to copy the current volatile values
3202 first since those will become the new manual values (which
3203 may be overwritten by explicit new values from this set
3205 if (!store && master->is_auto && master->has_volatiles &&
3206 !is_cur_manual(master)) {
3207 /* Pick an initial non-manual value */
3208 s32 new_auto_val = master->manual_mode_value + 1;
3212 /* Check if the auto control is part of the
3213 list, and remember the new value. */
3214 if (helpers[tmp_idx].ctrl == master)
3215 new_auto_val = cs->controls[tmp_idx].value;
3216 tmp_idx = helpers[tmp_idx].next;
3218 /* If the new value == the manual value, then copy
3219 the current volatile values. */
3220 if (new_auto_val == master->manual_mode_value)
3221 update_from_auto_cluster(master);
3224 /* Copy the new caller-supplied control values.
3225 user_to_new() sets 'is_new' to 1. */
3227 struct v4l2_ctrl *ctrl = helpers[idx].ctrl;
3229 ret = user_to_new(cs->controls + idx, ctrl);
3230 if (!ret && ctrl->is_ptr)
3231 ret = validate_new(ctrl, ctrl->p_new);
3232 idx = helpers[idx].next;
3233 } while (!ret && idx);
3236 ret = try_or_set_cluster(fh, master, store, set, 0);
3238 /* Copy the new values back to userspace. */
3242 ret = store_to_user(cs->controls + idx,
3243 helpers[idx].ctrl, store);
3244 idx = helpers[idx].next;
3245 } while (!ret && idx);
3247 v4l2_ctrl_unlock(master);
3250 if (cs->count > ARRAY_SIZE(helper))
3255 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
3257 return try_set_ext_ctrls(NULL, hdl, cs, false);
3259 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
3261 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3262 struct v4l2_ext_controls *cs)
3264 return try_set_ext_ctrls(fh, hdl, cs, true);
3266 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
3268 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3270 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
3272 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
3274 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3276 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
3278 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
3280 /* Helper function for VIDIOC_S_CTRL compatibility */
3281 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
3283 struct v4l2_ctrl *master = ctrl->cluster[0];
3287 /* Reset the 'is_new' flags of the cluster */
3288 for (i = 0; i < master->ncontrols; i++) {
3289 if (master->cluster[i] == NULL)
3291 master->cluster[i]->is_new = 0;
3292 master->cluster[i]->store = 0;
3295 ret = validate_new(ctrl, ctrl->p_new);
3299 /* For autoclusters with volatiles that are switched from auto to
3300 manual mode we have to update the current volatile values since
3301 those will become the initial manual values after such a switch. */
3302 if (master->is_auto && master->has_volatiles && ctrl == master &&
3303 !is_cur_manual(master) && ctrl->val == master->manual_mode_value)
3304 update_from_auto_cluster(master);
3307 return try_or_set_cluster(fh, master, 0, true, ch_flags);
3310 /* Helper function for VIDIOC_S_CTRL compatibility */
3311 static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
3312 struct v4l2_ext_control *c)
3316 v4l2_ctrl_lock(ctrl);
3317 user_to_new(c, ctrl);
3318 ret = set_ctrl(fh, ctrl, 0);
3320 cur_to_user(c, ctrl);
3321 v4l2_ctrl_unlock(ctrl);
3325 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3326 struct v4l2_control *control)
3328 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
3329 struct v4l2_ext_control c = { control->id };
3332 if (ctrl == NULL || !ctrl->is_int)
3335 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3338 c.value = control->value;
3339 ret = set_ctrl_lock(fh, ctrl, &c);
3340 control->value = c.value;
3343 EXPORT_SYMBOL(v4l2_s_ctrl);
3345 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
3347 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
3349 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
3351 int __v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
3353 lockdep_assert_held(ctrl->handler->lock);
3355 /* It's a driver bug if this happens. */
3356 WARN_ON(!ctrl->is_int);
3358 return set_ctrl(NULL, ctrl, 0);
3360 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl);
3362 int __v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
3364 lockdep_assert_held(ctrl->handler->lock);
3366 /* It's a driver bug if this happens. */
3367 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
3368 *ctrl->p_new.p_s64 = val;
3369 return set_ctrl(NULL, ctrl, 0);
3371 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_int64);
3373 int __v4l2_ctrl_s_ctrl_string(struct v4l2_ctrl *ctrl, const char *s)
3375 lockdep_assert_held(ctrl->handler->lock);
3377 /* It's a driver bug if this happens. */
3378 WARN_ON(ctrl->type != V4L2_CTRL_TYPE_STRING);
3379 strlcpy(ctrl->p_new.p_char, s, ctrl->maximum + 1);
3380 return set_ctrl(NULL, ctrl, 0);
3382 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_string);
3384 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
3388 if (notify == NULL) {
3389 ctrl->call_notify = 0;
3392 if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
3394 ctrl->handler->notify = notify;
3395 ctrl->handler->notify_priv = priv;
3396 ctrl->call_notify = 1;
3398 EXPORT_SYMBOL(v4l2_ctrl_notify);
3400 int __v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
3401 s64 min, s64 max, u64 step, s64 def)
3404 bool range_changed = false;
3407 lockdep_assert_held(ctrl->handler->lock);
3409 switch (ctrl->type) {
3410 case V4L2_CTRL_TYPE_INTEGER:
3411 case V4L2_CTRL_TYPE_INTEGER64:
3412 case V4L2_CTRL_TYPE_BOOLEAN:
3413 case V4L2_CTRL_TYPE_MENU:
3414 case V4L2_CTRL_TYPE_INTEGER_MENU:
3415 case V4L2_CTRL_TYPE_BITMASK:
3416 case V4L2_CTRL_TYPE_U8:
3417 case V4L2_CTRL_TYPE_U16:
3418 case V4L2_CTRL_TYPE_U32:
3421 ret = check_range(ctrl->type, min, max, step, def);
3428 if ((ctrl->minimum != min) || (ctrl->maximum != max) ||
3429 (ctrl->step != step) || ctrl->default_value != def) {
3430 range_changed = true;
3431 ctrl->minimum = min;
3432 ctrl->maximum = max;
3434 ctrl->default_value = def;
3437 if (validate_new(ctrl, ctrl->p_new)) {
3438 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3439 *ctrl->p_new.p_s64 = def;
3441 *ctrl->p_new.p_s32 = def;
3444 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3445 value_changed = *ctrl->p_new.p_s64 != *ctrl->p_cur.p_s64;
3447 value_changed = *ctrl->p_new.p_s32 != *ctrl->p_cur.p_s32;
3449 ret = set_ctrl(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3450 else if (range_changed)
3451 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3454 EXPORT_SYMBOL(__v4l2_ctrl_modify_range);
3456 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
3458 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3463 v4l2_ctrl_lock(ctrl);
3464 list_add_tail(&sev->node, &ctrl->ev_subs);
3465 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
3466 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
3467 struct v4l2_event ev;
3468 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
3470 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
3471 changes |= V4L2_EVENT_CTRL_CH_VALUE;
3472 fill_event(&ev, ctrl, changes);
3473 /* Mark the queue as active, allowing this initial
3474 event to be accepted. */
3476 v4l2_event_queue_fh(sev->fh, &ev);
3478 v4l2_ctrl_unlock(ctrl);
3482 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
3484 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3486 v4l2_ctrl_lock(ctrl);
3487 list_del(&sev->node);
3488 v4l2_ctrl_unlock(ctrl);
3491 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
3493 u32 old_changes = old->u.ctrl.changes;
3495 old->u.ctrl = new->u.ctrl;
3496 old->u.ctrl.changes |= old_changes;
3498 EXPORT_SYMBOL(v4l2_ctrl_replace);
3500 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
3502 new->u.ctrl.changes |= old->u.ctrl.changes;
3504 EXPORT_SYMBOL(v4l2_ctrl_merge);
3506 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
3507 .add = v4l2_ctrl_add_event,
3508 .del = v4l2_ctrl_del_event,
3509 .replace = v4l2_ctrl_replace,
3510 .merge = v4l2_ctrl_merge,
3512 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
3514 int v4l2_ctrl_log_status(struct file *file, void *fh)
3516 struct video_device *vfd = video_devdata(file);
3517 struct v4l2_fh *vfh = file->private_data;
3519 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
3520 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
3521 vfd->v4l2_dev->name);
3524 EXPORT_SYMBOL(v4l2_ctrl_log_status);
3526 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
3527 const struct v4l2_event_subscription *sub)
3529 if (sub->type == V4L2_EVENT_CTRL)
3530 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
3533 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
3535 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
3536 struct v4l2_event_subscription *sub)
3538 if (!sd->ctrl_handler)
3540 return v4l2_ctrl_subscribe_event(fh, sub);
3542 EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
3544 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
3546 struct v4l2_fh *fh = file->private_data;
3548 if (v4l2_event_pending(fh))
3550 poll_wait(file, &fh->wait, wait);
3553 EXPORT_SYMBOL(v4l2_ctrl_poll);