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 new control value back to the caller */
1488 static int new_to_user(struct v4l2_ext_control *c,
1489 struct v4l2_ctrl *ctrl)
1491 return ptr_to_user(c, ctrl, ctrl->p_new);
1494 /* Helper function: copy the initial control value back to the caller */
1495 static int def_to_user(struct v4l2_ext_control *c, struct v4l2_ctrl *ctrl)
1499 for (idx = 0; idx < ctrl->elems; idx++)
1500 ctrl->type_ops->init(ctrl, idx, ctrl->p_new);
1502 return ptr_to_user(c, ctrl, ctrl->p_new);
1505 /* Helper function: copy the caller-provider value to the given control value */
1506 static int user_to_ptr(struct v4l2_ext_control *c,
1507 struct v4l2_ctrl *ctrl,
1508 union v4l2_ctrl_ptr ptr)
1514 if (ctrl->is_ptr && !ctrl->is_string) {
1517 ret = copy_from_user(ptr.p, c->ptr, c->size) ? -EFAULT : 0;
1518 if (ret || !ctrl->is_array)
1520 for (idx = c->size / ctrl->elem_size; idx < ctrl->elems; idx++)
1521 ctrl->type_ops->init(ctrl, idx, ptr);
1525 switch (ctrl->type) {
1526 case V4L2_CTRL_TYPE_INTEGER64:
1527 *ptr.p_s64 = c->value64;
1529 case V4L2_CTRL_TYPE_STRING:
1533 if (size > ctrl->maximum + 1)
1534 size = ctrl->maximum + 1;
1535 ret = copy_from_user(ptr.p_char, c->string, size) ? -EFAULT : 0;
1537 char last = ptr.p_char[size - 1];
1539 ptr.p_char[size - 1] = 0;
1540 /* If the string was longer than ctrl->maximum,
1541 then return an error. */
1542 if (strlen(ptr.p_char) == ctrl->maximum && last)
1547 *ptr.p_s32 = c->value;
1553 /* Helper function: copy the caller-provider value as the new control value */
1554 static int user_to_new(struct v4l2_ext_control *c,
1555 struct v4l2_ctrl *ctrl)
1557 return user_to_ptr(c, ctrl, ctrl->p_new);
1560 /* Copy the one value to another. */
1561 static void ptr_to_ptr(struct v4l2_ctrl *ctrl,
1562 union v4l2_ctrl_ptr from, union v4l2_ctrl_ptr to)
1566 memcpy(to.p, from.p, ctrl->elems * ctrl->elem_size);
1569 /* Copy the new value to the current value. */
1570 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
1577 /* has_changed is set by cluster_changed */
1578 changed = ctrl->has_changed;
1580 ptr_to_ptr(ctrl, ctrl->p_new, ctrl->p_cur);
1582 if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1583 /* Note: CH_FLAGS is only set for auto clusters. */
1585 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1586 if (!is_cur_manual(ctrl->cluster[0])) {
1587 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1588 if (ctrl->cluster[0]->has_volatiles)
1589 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1593 if (changed || ch_flags) {
1594 /* If a control was changed that was not one of the controls
1595 modified by the application, then send the event to all. */
1598 send_event(fh, ctrl,
1599 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
1600 if (ctrl->call_notify && changed && ctrl->handler->notify)
1601 ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
1605 /* Copy the current value to the new value */
1606 static void cur_to_new(struct v4l2_ctrl *ctrl)
1610 ptr_to_ptr(ctrl, ctrl->p_cur, ctrl->p_new);
1613 /* Return non-zero if one or more of the controls in the cluster has a new
1614 value that differs from the current value. */
1615 static int cluster_changed(struct v4l2_ctrl *master)
1617 bool changed = false;
1621 for (i = 0; i < master->ncontrols; i++) {
1622 struct v4l2_ctrl *ctrl = master->cluster[i];
1623 bool ctrl_changed = false;
1628 if (ctrl->flags & V4L2_CTRL_FLAG_EXECUTE_ON_WRITE)
1629 changed = ctrl_changed = true;
1632 * Set has_changed to false to avoid generating
1633 * the event V4L2_EVENT_CTRL_CH_VALUE
1635 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
1636 ctrl->has_changed = false;
1640 for (idx = 0; !ctrl_changed && idx < ctrl->elems; idx++)
1641 ctrl_changed = !ctrl->type_ops->equal(ctrl, idx,
1642 ctrl->p_cur, ctrl->p_new);
1643 ctrl->has_changed = ctrl_changed;
1644 changed |= ctrl->has_changed;
1649 /* Control range checking */
1650 static int check_range(enum v4l2_ctrl_type type,
1651 s64 min, s64 max, u64 step, s64 def)
1654 case V4L2_CTRL_TYPE_BOOLEAN:
1655 if (step != 1 || max > 1 || min < 0)
1658 case V4L2_CTRL_TYPE_U8:
1659 case V4L2_CTRL_TYPE_U16:
1660 case V4L2_CTRL_TYPE_U32:
1661 case V4L2_CTRL_TYPE_INTEGER:
1662 case V4L2_CTRL_TYPE_INTEGER64:
1663 if (step == 0 || min > max || def < min || def > max)
1666 case V4L2_CTRL_TYPE_BITMASK:
1667 if (step || min || !max || (def & ~max))
1670 case V4L2_CTRL_TYPE_MENU:
1671 case V4L2_CTRL_TYPE_INTEGER_MENU:
1672 if (min > max || def < min || def > max)
1674 /* Note: step == menu_skip_mask for menu controls.
1675 So here we check if the default value is masked out. */
1676 if (step && ((1 << def) & step))
1679 case V4L2_CTRL_TYPE_STRING:
1680 if (min > max || min < 0 || step < 1 || def)
1688 /* Validate a new control */
1689 static int validate_new(const struct v4l2_ctrl *ctrl, union v4l2_ctrl_ptr p_new)
1694 for (idx = 0; !err && idx < ctrl->elems; idx++)
1695 err = ctrl->type_ops->validate(ctrl, idx, p_new);
1699 static inline u32 node2id(struct list_head *node)
1701 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1704 /* Set the handler's error code if it wasn't set earlier already */
1705 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1707 if (hdl->error == 0)
1712 /* Initialize the handler */
1713 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1714 unsigned nr_of_controls_hint,
1715 struct lock_class_key *key, const char *name)
1717 hdl->lock = &hdl->_lock;
1718 mutex_init(hdl->lock);
1719 lockdep_set_class_and_name(hdl->lock, key, name);
1720 INIT_LIST_HEAD(&hdl->ctrls);
1721 INIT_LIST_HEAD(&hdl->ctrl_refs);
1722 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1723 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1725 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1728 EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
1730 /* Free all controls and control refs */
1731 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1733 struct v4l2_ctrl_ref *ref, *next_ref;
1734 struct v4l2_ctrl *ctrl, *next_ctrl;
1735 struct v4l2_subscribed_event *sev, *next_sev;
1737 if (hdl == NULL || hdl->buckets == NULL)
1740 mutex_lock(hdl->lock);
1741 /* Free all nodes */
1742 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1743 list_del(&ref->node);
1746 /* Free all controls owned by the handler */
1747 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1748 list_del(&ctrl->node);
1749 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1750 list_del(&sev->node);
1753 kfree(hdl->buckets);
1754 hdl->buckets = NULL;
1757 mutex_unlock(hdl->lock);
1759 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1761 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1762 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1763 with applications that do not use the NEXT_CTRL flag.
1765 We just find the n-th private user control. It's O(N), but that should not
1766 be an issue in this particular case. */
1767 static struct v4l2_ctrl_ref *find_private_ref(
1768 struct v4l2_ctrl_handler *hdl, u32 id)
1770 struct v4l2_ctrl_ref *ref;
1772 id -= V4L2_CID_PRIVATE_BASE;
1773 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1774 /* Search for private user controls that are compatible with
1776 if (V4L2_CTRL_ID2WHICH(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1777 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1778 if (!ref->ctrl->is_int)
1788 /* Find a control with the given ID. */
1789 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1791 struct v4l2_ctrl_ref *ref;
1794 id &= V4L2_CTRL_ID_MASK;
1796 /* Old-style private controls need special handling */
1797 if (id >= V4L2_CID_PRIVATE_BASE)
1798 return find_private_ref(hdl, id);
1799 bucket = id % hdl->nr_of_buckets;
1801 /* Simple optimization: cache the last control found */
1802 if (hdl->cached && hdl->cached->ctrl->id == id)
1805 /* Not in cache, search the hash */
1806 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1807 while (ref && ref->ctrl->id != id)
1811 hdl->cached = ref; /* cache it! */
1815 /* Find a control with the given ID. Take the handler's lock first. */
1816 static struct v4l2_ctrl_ref *find_ref_lock(
1817 struct v4l2_ctrl_handler *hdl, u32 id)
1819 struct v4l2_ctrl_ref *ref = NULL;
1822 mutex_lock(hdl->lock);
1823 ref = find_ref(hdl, id);
1824 mutex_unlock(hdl->lock);
1829 /* Find a control with the given ID. */
1830 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1832 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1834 return ref ? ref->ctrl : NULL;
1836 EXPORT_SYMBOL(v4l2_ctrl_find);
1838 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1839 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1840 struct v4l2_ctrl *ctrl)
1842 struct v4l2_ctrl_ref *ref;
1843 struct v4l2_ctrl_ref *new_ref;
1845 u32 class_ctrl = V4L2_CTRL_ID2WHICH(id) | 1;
1846 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1849 * Automatically add the control class if it is not yet present and
1850 * the new control is not a compound control.
1852 if (ctrl->type < V4L2_CTRL_COMPOUND_TYPES &&
1853 id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1854 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1860 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1862 return handler_set_err(hdl, -ENOMEM);
1863 new_ref->ctrl = ctrl;
1864 if (ctrl->handler == hdl) {
1865 /* By default each control starts in a cluster of its own.
1866 new_ref->ctrl is basically a cluster array with one
1867 element, so that's perfect to use as the cluster pointer.
1868 But only do this for the handler that owns the control. */
1869 ctrl->cluster = &new_ref->ctrl;
1870 ctrl->ncontrols = 1;
1873 INIT_LIST_HEAD(&new_ref->node);
1875 mutex_lock(hdl->lock);
1877 /* Add immediately at the end of the list if the list is empty, or if
1878 the last element in the list has a lower ID.
1879 This ensures that when elements are added in ascending order the
1880 insertion is an O(1) operation. */
1881 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1882 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1883 goto insert_in_hash;
1886 /* Find insert position in sorted list */
1887 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1888 if (ref->ctrl->id < id)
1890 /* Don't add duplicates */
1891 if (ref->ctrl->id == id) {
1895 list_add(&new_ref->node, ref->node.prev);
1900 /* Insert the control node in the hash */
1901 new_ref->next = hdl->buckets[bucket];
1902 hdl->buckets[bucket] = new_ref;
1905 mutex_unlock(hdl->lock);
1909 /* Add a new control */
1910 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1911 const struct v4l2_ctrl_ops *ops,
1912 const struct v4l2_ctrl_type_ops *type_ops,
1913 u32 id, const char *name, enum v4l2_ctrl_type type,
1914 s64 min, s64 max, u64 step, s64 def,
1915 const u32 dims[V4L2_CTRL_MAX_DIMS], u32 elem_size,
1916 u32 flags, const char * const *qmenu,
1917 const s64 *qmenu_int, void *priv)
1919 struct v4l2_ctrl *ctrl;
1921 unsigned nr_of_dims = 0;
1924 unsigned tot_ctrl_size;
1932 while (dims && dims[nr_of_dims]) {
1933 elems *= dims[nr_of_dims];
1935 if (nr_of_dims == V4L2_CTRL_MAX_DIMS)
1938 is_array = nr_of_dims > 0;
1940 /* Prefill elem_size for all types handled by std_type_ops */
1942 case V4L2_CTRL_TYPE_INTEGER64:
1943 elem_size = sizeof(s64);
1945 case V4L2_CTRL_TYPE_STRING:
1946 elem_size = max + 1;
1948 case V4L2_CTRL_TYPE_U8:
1949 elem_size = sizeof(u8);
1951 case V4L2_CTRL_TYPE_U16:
1952 elem_size = sizeof(u16);
1954 case V4L2_CTRL_TYPE_U32:
1955 elem_size = sizeof(u32);
1958 if (type < V4L2_CTRL_COMPOUND_TYPES)
1959 elem_size = sizeof(s32);
1962 tot_ctrl_size = elem_size * elems;
1965 if (id == 0 || name == NULL || !elem_size ||
1966 id >= V4L2_CID_PRIVATE_BASE ||
1967 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1968 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
1969 handler_set_err(hdl, -ERANGE);
1972 err = check_range(type, min, max, step, def);
1974 handler_set_err(hdl, err);
1977 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1978 handler_set_err(hdl, -ERANGE);
1982 (type == V4L2_CTRL_TYPE_BUTTON ||
1983 type == V4L2_CTRL_TYPE_CTRL_CLASS)) {
1984 handler_set_err(hdl, -EINVAL);
1989 if (type == V4L2_CTRL_TYPE_BUTTON)
1990 flags |= V4L2_CTRL_FLAG_WRITE_ONLY |
1991 V4L2_CTRL_FLAG_EXECUTE_ON_WRITE;
1992 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1993 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1994 else if (type == V4L2_CTRL_TYPE_INTEGER64 ||
1995 type == V4L2_CTRL_TYPE_STRING ||
1996 type >= V4L2_CTRL_COMPOUND_TYPES ||
1998 sz_extra += 2 * tot_ctrl_size;
2000 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
2002 handler_set_err(hdl, -ENOMEM);
2006 INIT_LIST_HEAD(&ctrl->node);
2007 INIT_LIST_HEAD(&ctrl->ev_subs);
2008 ctrl->handler = hdl;
2010 ctrl->type_ops = type_ops ? type_ops : &std_type_ops;
2014 ctrl->flags = flags;
2015 ctrl->minimum = min;
2016 ctrl->maximum = max;
2018 ctrl->default_value = def;
2019 ctrl->is_string = !is_array && type == V4L2_CTRL_TYPE_STRING;
2020 ctrl->is_ptr = is_array || type >= V4L2_CTRL_COMPOUND_TYPES || ctrl->is_string;
2021 ctrl->is_int = !ctrl->is_ptr && type != V4L2_CTRL_TYPE_INTEGER64;
2022 ctrl->is_array = is_array;
2023 ctrl->elems = elems;
2024 ctrl->nr_of_dims = nr_of_dims;
2026 memcpy(ctrl->dims, dims, nr_of_dims * sizeof(dims[0]));
2027 ctrl->elem_size = elem_size;
2028 if (type == V4L2_CTRL_TYPE_MENU)
2029 ctrl->qmenu = qmenu;
2030 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2031 ctrl->qmenu_int = qmenu_int;
2033 ctrl->cur.val = ctrl->val = def;
2036 if (!ctrl->is_int) {
2037 ctrl->p_new.p = data;
2038 ctrl->p_cur.p = data + tot_ctrl_size;
2040 ctrl->p_new.p = &ctrl->val;
2041 ctrl->p_cur.p = &ctrl->cur.val;
2043 for (idx = 0; idx < elems; idx++) {
2044 ctrl->type_ops->init(ctrl, idx, ctrl->p_cur);
2045 ctrl->type_ops->init(ctrl, idx, ctrl->p_new);
2048 if (handler_new_ref(hdl, ctrl)) {
2052 mutex_lock(hdl->lock);
2053 list_add_tail(&ctrl->node, &hdl->ctrls);
2054 mutex_unlock(hdl->lock);
2058 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
2059 const struct v4l2_ctrl_config *cfg, void *priv)
2062 struct v4l2_ctrl *ctrl;
2063 const char *name = cfg->name;
2064 const char * const *qmenu = cfg->qmenu;
2065 const s64 *qmenu_int = cfg->qmenu_int;
2066 enum v4l2_ctrl_type type = cfg->type;
2067 u32 flags = cfg->flags;
2070 u64 step = cfg->step;
2074 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
2077 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
2078 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
2082 WARN_ON(cfg->menu_skip_mask);
2083 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
2084 qmenu = v4l2_ctrl_get_menu(cfg->id);
2085 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
2086 qmenu_int == NULL) {
2087 handler_set_err(hdl, -EINVAL);
2091 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->type_ops, cfg->id, name,
2093 is_menu ? cfg->menu_skip_mask : step, def,
2094 cfg->dims, cfg->elem_size,
2095 flags, qmenu, qmenu_int, priv);
2097 ctrl->is_private = cfg->is_private;
2100 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
2102 /* Helper function for standard non-menu controls */
2103 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
2104 const struct v4l2_ctrl_ops *ops,
2105 u32 id, s64 min, s64 max, u64 step, s64 def)
2108 enum v4l2_ctrl_type type;
2111 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2112 if (type == V4L2_CTRL_TYPE_MENU ||
2113 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
2114 type >= V4L2_CTRL_COMPOUND_TYPES) {
2115 handler_set_err(hdl, -EINVAL);
2118 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2119 min, max, step, def, NULL, 0,
2120 flags, NULL, NULL, NULL);
2122 EXPORT_SYMBOL(v4l2_ctrl_new_std);
2124 /* Helper function for standard menu controls */
2125 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
2126 const struct v4l2_ctrl_ops *ops,
2127 u32 id, u8 _max, u64 mask, u8 _def)
2129 const char * const *qmenu = NULL;
2130 const s64 *qmenu_int = NULL;
2131 unsigned int qmenu_int_len = 0;
2133 enum v4l2_ctrl_type type;
2140 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2142 if (type == V4L2_CTRL_TYPE_MENU)
2143 qmenu = v4l2_ctrl_get_menu(id);
2144 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
2145 qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
2147 if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
2148 handler_set_err(hdl, -EINVAL);
2151 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2152 0, max, mask, def, NULL, 0,
2153 flags, qmenu, qmenu_int, NULL);
2155 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
2157 /* Helper function for standard menu controls with driver defined menu */
2158 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
2159 const struct v4l2_ctrl_ops *ops, u32 id, u8 _max,
2160 u64 mask, u8 _def, const char * const *qmenu)
2162 enum v4l2_ctrl_type type;
2170 /* v4l2_ctrl_new_std_menu_items() should only be called for
2171 * standard controls without a standard menu.
2173 if (v4l2_ctrl_get_menu(id)) {
2174 handler_set_err(hdl, -EINVAL);
2178 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2179 if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
2180 handler_set_err(hdl, -EINVAL);
2183 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2184 0, max, mask, def, NULL, 0,
2185 flags, qmenu, NULL, NULL);
2188 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
2190 /* Helper function for standard integer menu controls */
2191 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
2192 const struct v4l2_ctrl_ops *ops,
2193 u32 id, u8 _max, u8 _def, const s64 *qmenu_int)
2196 enum v4l2_ctrl_type type;
2203 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
2204 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
2205 handler_set_err(hdl, -EINVAL);
2208 return v4l2_ctrl_new(hdl, ops, NULL, id, name, type,
2209 0, max, 0, def, NULL, 0,
2210 flags, NULL, qmenu_int, NULL);
2212 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
2214 /* Add a control from another handler to this handler */
2215 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
2216 struct v4l2_ctrl *ctrl)
2218 if (hdl == NULL || hdl->error)
2221 handler_set_err(hdl, -EINVAL);
2224 if (ctrl->handler == hdl)
2226 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
2228 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
2230 /* Add the controls from another handler to our own. */
2231 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
2232 struct v4l2_ctrl_handler *add,
2233 bool (*filter)(const struct v4l2_ctrl *ctrl))
2235 struct v4l2_ctrl_ref *ref;
2238 /* Do nothing if either handler is NULL or if they are the same */
2239 if (!hdl || !add || hdl == add)
2243 mutex_lock(add->lock);
2244 list_for_each_entry(ref, &add->ctrl_refs, node) {
2245 struct v4l2_ctrl *ctrl = ref->ctrl;
2247 /* Skip handler-private controls. */
2248 if (ctrl->is_private)
2250 /* And control classes */
2251 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2253 /* Filter any unwanted controls */
2254 if (filter && !filter(ctrl))
2256 ret = handler_new_ref(hdl, ctrl);
2260 mutex_unlock(add->lock);
2263 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
2265 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
2267 if (V4L2_CTRL_ID2WHICH(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
2269 if (V4L2_CTRL_ID2WHICH(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
2272 case V4L2_CID_AUDIO_MUTE:
2273 case V4L2_CID_AUDIO_VOLUME:
2274 case V4L2_CID_AUDIO_BALANCE:
2275 case V4L2_CID_AUDIO_BASS:
2276 case V4L2_CID_AUDIO_TREBLE:
2277 case V4L2_CID_AUDIO_LOUDNESS:
2284 EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
2286 /* Cluster controls */
2287 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
2289 bool has_volatiles = false;
2292 /* The first control is the master control and it must not be NULL */
2293 if (WARN_ON(ncontrols == 0 || controls[0] == NULL))
2296 for (i = 0; i < ncontrols; i++) {
2298 controls[i]->cluster = controls;
2299 controls[i]->ncontrols = ncontrols;
2300 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
2301 has_volatiles = true;
2304 controls[0]->has_volatiles = has_volatiles;
2306 EXPORT_SYMBOL(v4l2_ctrl_cluster);
2308 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
2309 u8 manual_val, bool set_volatile)
2311 struct v4l2_ctrl *master = controls[0];
2315 v4l2_ctrl_cluster(ncontrols, controls);
2316 WARN_ON(ncontrols <= 1);
2317 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
2318 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
2319 master->is_auto = true;
2320 master->has_volatiles = set_volatile;
2321 master->manual_mode_value = manual_val;
2322 master->flags |= V4L2_CTRL_FLAG_UPDATE;
2324 if (!is_cur_manual(master))
2325 flag = V4L2_CTRL_FLAG_INACTIVE |
2326 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
2328 for (i = 1; i < ncontrols; i++)
2330 controls[i]->flags |= flag;
2332 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
2334 /* Activate/deactivate a control. */
2335 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
2337 /* invert since the actual flag is called 'inactive' */
2338 bool inactive = !active;
2345 /* set V4L2_CTRL_FLAG_INACTIVE */
2346 old = test_and_set_bit(4, &ctrl->flags);
2348 /* clear V4L2_CTRL_FLAG_INACTIVE */
2349 old = test_and_clear_bit(4, &ctrl->flags);
2350 if (old != inactive)
2351 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2353 EXPORT_SYMBOL(v4l2_ctrl_activate);
2355 /* Grab/ungrab a control.
2356 Typically used when streaming starts and you want to grab controls,
2357 preventing the user from changing them.
2359 Just call this and the framework will block any attempts to change
2361 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
2368 v4l2_ctrl_lock(ctrl);
2370 /* set V4L2_CTRL_FLAG_GRABBED */
2371 old = test_and_set_bit(1, &ctrl->flags);
2373 /* clear V4L2_CTRL_FLAG_GRABBED */
2374 old = test_and_clear_bit(1, &ctrl->flags);
2376 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2377 v4l2_ctrl_unlock(ctrl);
2379 EXPORT_SYMBOL(v4l2_ctrl_grab);
2381 /* Log the control name and value */
2382 static void log_ctrl(const struct v4l2_ctrl *ctrl,
2383 const char *prefix, const char *colon)
2385 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2387 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2390 pr_info("%s%s%s: ", prefix, colon, ctrl->name);
2392 ctrl->type_ops->log(ctrl);
2394 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2395 V4L2_CTRL_FLAG_GRABBED |
2396 V4L2_CTRL_FLAG_VOLATILE)) {
2397 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
2398 pr_cont(" inactive");
2399 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
2400 pr_cont(" grabbed");
2401 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
2402 pr_cont(" volatile");
2407 /* Log all controls owned by the handler */
2408 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2411 struct v4l2_ctrl *ctrl;
2412 const char *colon = "";
2419 len = strlen(prefix);
2420 if (len && prefix[len - 1] != ' ')
2422 mutex_lock(hdl->lock);
2423 list_for_each_entry(ctrl, &hdl->ctrls, node)
2424 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2425 log_ctrl(ctrl, prefix, colon);
2426 mutex_unlock(hdl->lock);
2428 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2430 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2432 v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2435 EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2437 /* Call s_ctrl for all controls owned by the handler */
2438 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2440 struct v4l2_ctrl *ctrl;
2445 mutex_lock(hdl->lock);
2446 list_for_each_entry(ctrl, &hdl->ctrls, node)
2449 list_for_each_entry(ctrl, &hdl->ctrls, node) {
2450 struct v4l2_ctrl *master = ctrl->cluster[0];
2453 /* Skip if this control was already handled by a cluster. */
2454 /* Skip button controls and read-only controls. */
2455 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2456 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
2459 for (i = 0; i < master->ncontrols; i++) {
2460 if (master->cluster[i]) {
2461 cur_to_new(master->cluster[i]);
2462 master->cluster[i]->is_new = 1;
2463 master->cluster[i]->done = true;
2466 ret = call_op(master, s_ctrl);
2470 mutex_unlock(hdl->lock);
2473 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2475 /* Implement VIDIOC_QUERY_EXT_CTRL */
2476 int v4l2_query_ext_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_query_ext_ctrl *qc)
2478 const unsigned next_flags = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND;
2479 u32 id = qc->id & V4L2_CTRL_ID_MASK;
2480 struct v4l2_ctrl_ref *ref;
2481 struct v4l2_ctrl *ctrl;
2486 mutex_lock(hdl->lock);
2488 /* Try to find it */
2489 ref = find_ref(hdl, id);
2491 if ((qc->id & next_flags) && !list_empty(&hdl->ctrl_refs)) {
2493 /* Match any control that is not hidden */
2497 if ((qc->id & next_flags) == V4L2_CTRL_FLAG_NEXT_COMPOUND) {
2498 /* Match any hidden control */
2500 } else if ((qc->id & next_flags) == next_flags) {
2501 /* Match any control, compound or not */
2505 /* Find the next control with ID > qc->id */
2507 /* Did we reach the end of the control list? */
2508 if (id >= node2id(hdl->ctrl_refs.prev)) {
2509 ref = NULL; /* Yes, so there is no next control */
2511 /* We found a control with the given ID, so just get
2512 the next valid one in the list. */
2513 list_for_each_entry_continue(ref, &hdl->ctrl_refs, node) {
2514 is_compound = ref->ctrl->is_array ||
2515 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2516 if (id < ref->ctrl->id &&
2517 (is_compound & mask) == match)
2520 if (&ref->node == &hdl->ctrl_refs)
2523 /* No control with the given ID exists, so start
2524 searching for the next largest ID. We know there
2525 is one, otherwise the first 'if' above would have
2527 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
2528 is_compound = ref->ctrl->is_array ||
2529 ref->ctrl->type >= V4L2_CTRL_COMPOUND_TYPES;
2530 if (id < ref->ctrl->id &&
2531 (is_compound & mask) == match)
2534 if (&ref->node == &hdl->ctrl_refs)
2538 mutex_unlock(hdl->lock);
2544 memset(qc, 0, sizeof(*qc));
2545 if (id >= V4L2_CID_PRIVATE_BASE)
2549 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
2550 qc->flags = ctrl->flags;
2551 qc->type = ctrl->type;
2553 qc->flags |= V4L2_CTRL_FLAG_HAS_PAYLOAD;
2554 qc->elem_size = ctrl->elem_size;
2555 qc->elems = ctrl->elems;
2556 qc->nr_of_dims = ctrl->nr_of_dims;
2557 memcpy(qc->dims, ctrl->dims, qc->nr_of_dims * sizeof(qc->dims[0]));
2558 qc->minimum = ctrl->minimum;
2559 qc->maximum = ctrl->maximum;
2560 qc->default_value = ctrl->default_value;
2561 if (ctrl->type == V4L2_CTRL_TYPE_MENU
2562 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
2565 qc->step = ctrl->step;
2568 EXPORT_SYMBOL(v4l2_query_ext_ctrl);
2570 /* Implement VIDIOC_QUERYCTRL */
2571 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2573 struct v4l2_query_ext_ctrl qec = { qc->id };
2576 rc = v4l2_query_ext_ctrl(hdl, &qec);
2581 qc->type = qec.type;
2582 qc->flags = qec.flags;
2583 strlcpy(qc->name, qec.name, sizeof(qc->name));
2585 case V4L2_CTRL_TYPE_INTEGER:
2586 case V4L2_CTRL_TYPE_BOOLEAN:
2587 case V4L2_CTRL_TYPE_MENU:
2588 case V4L2_CTRL_TYPE_INTEGER_MENU:
2589 case V4L2_CTRL_TYPE_STRING:
2590 case V4L2_CTRL_TYPE_BITMASK:
2591 qc->minimum = qec.minimum;
2592 qc->maximum = qec.maximum;
2593 qc->step = qec.step;
2594 qc->default_value = qec.default_value;
2600 qc->default_value = 0;
2605 EXPORT_SYMBOL(v4l2_queryctrl);
2607 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2609 if (qc->id & (V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND))
2611 return v4l2_queryctrl(sd->ctrl_handler, qc);
2613 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2615 /* Implement VIDIOC_QUERYMENU */
2616 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2618 struct v4l2_ctrl *ctrl;
2621 ctrl = v4l2_ctrl_find(hdl, qm->id);
2627 switch (ctrl->type) {
2628 case V4L2_CTRL_TYPE_MENU:
2629 if (ctrl->qmenu == NULL)
2632 case V4L2_CTRL_TYPE_INTEGER_MENU:
2633 if (ctrl->qmenu_int == NULL)
2640 if (i < ctrl->minimum || i > ctrl->maximum)
2643 /* Use mask to see if this menu item should be skipped */
2644 if (ctrl->menu_skip_mask & (1 << i))
2646 /* Empty menu items should also be skipped */
2647 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2648 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2650 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2652 qm->value = ctrl->qmenu_int[i];
2656 EXPORT_SYMBOL(v4l2_querymenu);
2658 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2660 return v4l2_querymenu(sd->ctrl_handler, qm);
2662 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2666 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2668 It is not a fully atomic operation, just best-effort only. After all, if
2669 multiple controls have to be set through multiple i2c writes (for example)
2670 then some initial writes may succeed while others fail. Thus leaving the
2671 system in an inconsistent state. The question is how much effort you are
2672 willing to spend on trying to make something atomic that really isn't.
2674 From the point of view of an application the main requirement is that
2675 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2676 error should be returned without actually affecting any controls.
2678 If all the values are correct, then it is acceptable to just give up
2679 in case of low-level errors.
2681 It is important though that the application can tell when only a partial
2682 configuration was done. The way we do that is through the error_idx field
2683 of struct v4l2_ext_controls: if that is equal to the count field then no
2684 controls were affected. Otherwise all controls before that index were
2685 successful in performing their 'get' or 'set' operation, the control at
2686 the given index failed, and you don't know what happened with the controls
2687 after the failed one. Since if they were part of a control cluster they
2688 could have been successfully processed (if a cluster member was encountered
2689 at index < error_idx), they could have failed (if a cluster member was at
2690 error_idx), or they may not have been processed yet (if the first cluster
2691 member appeared after error_idx).
2693 It is all fairly theoretical, though. In practice all you can do is to
2694 bail out. If error_idx == count, then it is an application bug. If
2695 error_idx < count then it is only an application bug if the error code was
2696 EBUSY. That usually means that something started streaming just when you
2697 tried to set the controls. In all other cases it is a driver/hardware
2698 problem and all you can do is to retry or bail out.
2700 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2701 never modifies controls the error_idx is just set to whatever control
2702 has an invalid value.
2705 /* Prepare for the extended g/s/try functions.
2706 Find the controls in the control array and do some basic checks. */
2707 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2708 struct v4l2_ext_controls *cs,
2709 struct v4l2_ctrl_helper *helpers,
2712 struct v4l2_ctrl_helper *h;
2713 bool have_clusters = false;
2716 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2717 struct v4l2_ext_control *c = &cs->controls[i];
2718 struct v4l2_ctrl_ref *ref;
2719 struct v4l2_ctrl *ctrl;
2720 u32 id = c->id & V4L2_CTRL_ID_MASK;
2725 cs->which != V4L2_CTRL_WHICH_DEF_VAL &&
2726 V4L2_CTRL_ID2WHICH(id) != cs->which)
2729 /* Old-style private controls are not allowed for
2730 extended controls */
2731 if (id >= V4L2_CID_PRIVATE_BASE)
2733 ref = find_ref_lock(hdl, id);
2737 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2740 if (ctrl->cluster[0]->ncontrols > 1)
2741 have_clusters = true;
2742 if (ctrl->cluster[0] != ctrl)
2743 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2744 if (ctrl->is_ptr && !ctrl->is_string) {
2745 unsigned tot_size = ctrl->elems * ctrl->elem_size;
2747 if (c->size < tot_size) {
2756 /* Store the ref to the master control of the cluster */
2759 /* Initially set next to 0, meaning that there is no other
2760 control in this helper array belonging to the same
2765 /* We are done if there were no controls that belong to a multi-
2770 /* The code below figures out in O(n) time which controls in the list
2771 belong to the same cluster. */
2773 /* This has to be done with the handler lock taken. */
2774 mutex_lock(hdl->lock);
2776 /* First zero the helper field in the master control references */
2777 for (i = 0; i < cs->count; i++)
2778 helpers[i].mref->helper = NULL;
2779 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2780 struct v4l2_ctrl_ref *mref = h->mref;
2782 /* If the mref->helper is set, then it points to an earlier
2783 helper that belongs to the same cluster. */
2785 /* Set the next field of mref->helper to the current
2786 index: this means that that earlier helper now
2787 points to the next helper in the same cluster. */
2788 mref->helper->next = i;
2789 /* mref should be set only for the first helper in the
2790 cluster, clear the others. */
2793 /* Point the mref helper to the current helper struct. */
2796 mutex_unlock(hdl->lock);
2800 /* Handles the corner case where cs->count == 0. It checks whether the
2801 specified control class exists. If that class ID is 0, then it checks
2802 whether there are any controls at all. */
2803 static int class_check(struct v4l2_ctrl_handler *hdl, u32 which)
2805 if (which == 0 || which == V4L2_CTRL_WHICH_DEF_VAL)
2806 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2807 return find_ref_lock(hdl, which | 1) ? 0 : -EINVAL;
2812 /* Get extended controls. Allocates the helpers array if needed. */
2813 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2815 struct v4l2_ctrl_helper helper[4];
2816 struct v4l2_ctrl_helper *helpers = helper;
2821 def_value = (cs->which == V4L2_CTRL_WHICH_DEF_VAL);
2823 cs->error_idx = cs->count;
2824 cs->which = V4L2_CTRL_ID2WHICH(cs->which);
2830 return class_check(hdl, cs->which);
2832 if (cs->count > ARRAY_SIZE(helper)) {
2833 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2835 if (helpers == NULL)
2839 ret = prepare_ext_ctrls(hdl, cs, helpers, true);
2840 cs->error_idx = cs->count;
2842 for (i = 0; !ret && i < cs->count; i++)
2843 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2846 for (i = 0; !ret && i < cs->count; i++) {
2847 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2848 struct v4l2_ctrl *ctrl);
2849 struct v4l2_ctrl *master;
2851 ctrl_to_user = def_value ? def_to_user : cur_to_user;
2853 if (helpers[i].mref == NULL)
2856 master = helpers[i].mref->ctrl;
2859 v4l2_ctrl_lock(master);
2861 /* g_volatile_ctrl will update the new control values */
2863 ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2864 (master->has_volatiles && !is_cur_manual(master)))) {
2865 for (j = 0; j < master->ncontrols; j++)
2866 cur_to_new(master->cluster[j]);
2867 ret = call_op(master, g_volatile_ctrl);
2868 ctrl_to_user = new_to_user;
2870 /* If OK, then copy the current (for non-volatile controls)
2871 or the new (for volatile controls) control values to the
2877 ret = ctrl_to_user(cs->controls + idx,
2879 idx = helpers[idx].next;
2880 } while (!ret && idx);
2882 v4l2_ctrl_unlock(master);
2885 if (cs->count > ARRAY_SIZE(helper))
2889 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2891 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2893 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2895 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2897 /* Helper function to get a single control */
2898 static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
2900 struct v4l2_ctrl *master = ctrl->cluster[0];
2904 /* Compound controls are not supported. The new_to_user() and
2905 * cur_to_user() calls below would need to be modified not to access
2906 * userspace memory when called from get_ctrl().
2908 if (!ctrl->is_int && ctrl->type != V4L2_CTRL_TYPE_INTEGER64)
2911 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2914 v4l2_ctrl_lock(master);
2915 /* g_volatile_ctrl will update the current control values */
2916 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2917 for (i = 0; i < master->ncontrols; i++)
2918 cur_to_new(master->cluster[i]);
2919 ret = call_op(master, g_volatile_ctrl);
2920 new_to_user(c, ctrl);
2922 cur_to_user(c, ctrl);
2924 v4l2_ctrl_unlock(master);
2928 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2930 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2931 struct v4l2_ext_control c;
2934 if (ctrl == NULL || !ctrl->is_int)
2936 ret = get_ctrl(ctrl, &c);
2937 control->value = c.value;
2940 EXPORT_SYMBOL(v4l2_g_ctrl);
2942 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2944 return v4l2_g_ctrl(sd->ctrl_handler, control);
2946 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2948 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2950 struct v4l2_ext_control c;
2952 /* It's a driver bug if this happens. */
2953 WARN_ON(!ctrl->is_int);
2958 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2960 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
2962 struct v4l2_ext_control c;
2964 /* It's a driver bug if this happens. */
2965 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2970 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
2973 /* Core function that calls try/s_ctrl and ensures that the new value is
2974 copied to the current value on a set.
2975 Must be called with ctrl->handler->lock held. */
2976 static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
2977 bool set, u32 ch_flags)
2983 /* Go through the cluster and either validate the new value or
2984 (if no new value was set), copy the current value to the new
2985 value, ensuring a consistent view for the control ops when
2987 for (i = 0; i < master->ncontrols; i++) {
2988 struct v4l2_ctrl *ctrl = master->cluster[i];
2993 if (!ctrl->is_new) {
2997 /* Check again: it may have changed since the
2998 previous check in try_or_set_ext_ctrls(). */
2999 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
3003 ret = call_op(master, try_ctrl);
3005 /* Don't set if there is no change */
3006 if (ret || !set || !cluster_changed(master))
3008 ret = call_op(master, s_ctrl);
3012 /* If OK, then make the new values permanent. */
3013 update_flag = is_cur_manual(master) != is_new_manual(master);
3014 for (i = 0; i < master->ncontrols; i++)
3015 new_to_cur(fh, master->cluster[i], ch_flags |
3016 ((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
3020 /* Validate controls. */
3021 static int validate_ctrls(struct v4l2_ext_controls *cs,
3022 struct v4l2_ctrl_helper *helpers, bool set)
3027 cs->error_idx = cs->count;
3028 for (i = 0; i < cs->count; i++) {
3029 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
3030 union v4l2_ctrl_ptr p_new;
3034 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3036 /* This test is also done in try_set_control_cluster() which
3037 is called in atomic context, so that has the final say,
3038 but it makes sense to do an up-front check as well. Once
3039 an error occurs in try_set_control_cluster() some other
3040 controls may have been set already and we want to do a
3041 best-effort to avoid that. */
3042 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
3045 * Skip validation for now if the payload needs to be copied
3046 * from userspace into kernelspace. We'll validate those later.
3050 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3051 p_new.p_s64 = &cs->controls[i].value64;
3053 p_new.p_s32 = &cs->controls[i].value;
3054 ret = validate_new(ctrl, p_new);
3061 /* Obtain the current volatile values of an autocluster and mark them
3063 static void update_from_auto_cluster(struct v4l2_ctrl *master)
3067 for (i = 1; i < master->ncontrols; i++)
3068 cur_to_new(master->cluster[i]);
3069 if (!call_op(master, g_volatile_ctrl))
3070 for (i = 1; i < master->ncontrols; i++)
3071 if (master->cluster[i])
3072 master->cluster[i]->is_new = 1;
3075 /* Try or try-and-set controls */
3076 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3077 struct v4l2_ext_controls *cs,
3080 struct v4l2_ctrl_helper helper[4];
3081 struct v4l2_ctrl_helper *helpers = helper;
3085 cs->error_idx = cs->count;
3087 /* Default value cannot be changed */
3088 if (cs->which == V4L2_CTRL_WHICH_DEF_VAL)
3091 cs->which = V4L2_CTRL_ID2WHICH(cs->which);
3097 return class_check(hdl, cs->which);
3099 if (cs->count > ARRAY_SIZE(helper)) {
3100 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
3105 ret = prepare_ext_ctrls(hdl, cs, helpers, false);
3107 ret = validate_ctrls(cs, helpers, set);
3109 cs->error_idx = cs->count;
3110 for (i = 0; !ret && i < cs->count; i++) {
3111 struct v4l2_ctrl *master;
3114 if (helpers[i].mref == NULL)
3118 master = helpers[i].mref->ctrl;
3119 v4l2_ctrl_lock(master);
3121 /* Reset the 'is_new' flags of the cluster */
3122 for (j = 0; j < master->ncontrols; j++)
3123 if (master->cluster[j])
3124 master->cluster[j]->is_new = 0;
3126 /* For volatile autoclusters that are currently in auto mode
3127 we need to discover if it will be set to manual mode.
3128 If so, then we have to copy the current volatile values
3129 first since those will become the new manual values (which
3130 may be overwritten by explicit new values from this set
3132 if (master->is_auto && master->has_volatiles &&
3133 !is_cur_manual(master)) {
3134 /* Pick an initial non-manual value */
3135 s32 new_auto_val = master->manual_mode_value + 1;
3139 /* Check if the auto control is part of the
3140 list, and remember the new value. */
3141 if (helpers[tmp_idx].ctrl == master)
3142 new_auto_val = cs->controls[tmp_idx].value;
3143 tmp_idx = helpers[tmp_idx].next;
3145 /* If the new value == the manual value, then copy
3146 the current volatile values. */
3147 if (new_auto_val == master->manual_mode_value)
3148 update_from_auto_cluster(master);
3151 /* Copy the new caller-supplied control values.
3152 user_to_new() sets 'is_new' to 1. */
3154 struct v4l2_ctrl *ctrl = helpers[idx].ctrl;
3156 ret = user_to_new(cs->controls + idx, ctrl);
3157 if (!ret && ctrl->is_ptr)
3158 ret = validate_new(ctrl, ctrl->p_new);
3159 idx = helpers[idx].next;
3160 } while (!ret && idx);
3163 ret = try_or_set_cluster(fh, master, set, 0);
3165 /* Copy the new values back to userspace. */
3169 ret = new_to_user(cs->controls + idx,
3171 idx = helpers[idx].next;
3172 } while (!ret && idx);
3174 v4l2_ctrl_unlock(master);
3177 if (cs->count > ARRAY_SIZE(helper))
3182 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
3184 return try_set_ext_ctrls(NULL, hdl, cs, false);
3186 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
3188 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3189 struct v4l2_ext_controls *cs)
3191 return try_set_ext_ctrls(fh, hdl, cs, true);
3193 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
3195 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3197 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
3199 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
3201 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
3203 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
3205 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
3207 /* Helper function for VIDIOC_S_CTRL compatibility */
3208 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
3210 struct v4l2_ctrl *master = ctrl->cluster[0];
3214 /* Reset the 'is_new' flags of the cluster */
3215 for (i = 0; i < master->ncontrols; i++)
3216 if (master->cluster[i])
3217 master->cluster[i]->is_new = 0;
3219 ret = validate_new(ctrl, ctrl->p_new);
3223 /* For autoclusters with volatiles that are switched from auto to
3224 manual mode we have to update the current volatile values since
3225 those will become the initial manual values after such a switch. */
3226 if (master->is_auto && master->has_volatiles && ctrl == master &&
3227 !is_cur_manual(master) && ctrl->val == master->manual_mode_value)
3228 update_from_auto_cluster(master);
3231 return try_or_set_cluster(fh, master, true, ch_flags);
3234 /* Helper function for VIDIOC_S_CTRL compatibility */
3235 static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
3236 struct v4l2_ext_control *c)
3240 v4l2_ctrl_lock(ctrl);
3241 user_to_new(c, ctrl);
3242 ret = set_ctrl(fh, ctrl, 0);
3244 cur_to_user(c, ctrl);
3245 v4l2_ctrl_unlock(ctrl);
3249 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
3250 struct v4l2_control *control)
3252 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
3253 struct v4l2_ext_control c = { control->id };
3256 if (ctrl == NULL || !ctrl->is_int)
3259 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
3262 c.value = control->value;
3263 ret = set_ctrl_lock(fh, ctrl, &c);
3264 control->value = c.value;
3267 EXPORT_SYMBOL(v4l2_s_ctrl);
3269 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
3271 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
3273 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
3275 int __v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
3277 lockdep_assert_held(ctrl->handler->lock);
3279 /* It's a driver bug if this happens. */
3280 WARN_ON(!ctrl->is_int);
3282 return set_ctrl(NULL, ctrl, 0);
3284 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl);
3286 int __v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
3288 lockdep_assert_held(ctrl->handler->lock);
3290 /* It's a driver bug if this happens. */
3291 WARN_ON(ctrl->is_ptr || ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
3292 *ctrl->p_new.p_s64 = val;
3293 return set_ctrl(NULL, ctrl, 0);
3295 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_int64);
3297 int __v4l2_ctrl_s_ctrl_string(struct v4l2_ctrl *ctrl, const char *s)
3299 lockdep_assert_held(ctrl->handler->lock);
3301 /* It's a driver bug if this happens. */
3302 WARN_ON(ctrl->type != V4L2_CTRL_TYPE_STRING);
3303 strlcpy(ctrl->p_new.p_char, s, ctrl->maximum + 1);
3304 return set_ctrl(NULL, ctrl, 0);
3306 EXPORT_SYMBOL(__v4l2_ctrl_s_ctrl_string);
3308 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
3312 if (notify == NULL) {
3313 ctrl->call_notify = 0;
3316 if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
3318 ctrl->handler->notify = notify;
3319 ctrl->handler->notify_priv = priv;
3320 ctrl->call_notify = 1;
3322 EXPORT_SYMBOL(v4l2_ctrl_notify);
3324 int __v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
3325 s64 min, s64 max, u64 step, s64 def)
3328 bool range_changed = false;
3331 lockdep_assert_held(ctrl->handler->lock);
3333 switch (ctrl->type) {
3334 case V4L2_CTRL_TYPE_INTEGER:
3335 case V4L2_CTRL_TYPE_INTEGER64:
3336 case V4L2_CTRL_TYPE_BOOLEAN:
3337 case V4L2_CTRL_TYPE_MENU:
3338 case V4L2_CTRL_TYPE_INTEGER_MENU:
3339 case V4L2_CTRL_TYPE_BITMASK:
3340 case V4L2_CTRL_TYPE_U8:
3341 case V4L2_CTRL_TYPE_U16:
3342 case V4L2_CTRL_TYPE_U32:
3345 ret = check_range(ctrl->type, min, max, step, def);
3352 if ((ctrl->minimum != min) || (ctrl->maximum != max) ||
3353 (ctrl->step != step) || ctrl->default_value != def) {
3354 range_changed = true;
3355 ctrl->minimum = min;
3356 ctrl->maximum = max;
3358 ctrl->default_value = def;
3361 if (validate_new(ctrl, ctrl->p_new)) {
3362 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3363 *ctrl->p_new.p_s64 = def;
3365 *ctrl->p_new.p_s32 = def;
3368 if (ctrl->type == V4L2_CTRL_TYPE_INTEGER64)
3369 value_changed = *ctrl->p_new.p_s64 != *ctrl->p_cur.p_s64;
3371 value_changed = *ctrl->p_new.p_s32 != *ctrl->p_cur.p_s32;
3373 ret = set_ctrl(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3374 else if (range_changed)
3375 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
3378 EXPORT_SYMBOL(__v4l2_ctrl_modify_range);
3380 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
3382 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3387 v4l2_ctrl_lock(ctrl);
3388 list_add_tail(&sev->node, &ctrl->ev_subs);
3389 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
3390 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
3391 struct v4l2_event ev;
3392 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
3394 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
3395 changes |= V4L2_EVENT_CTRL_CH_VALUE;
3396 fill_event(&ev, ctrl, changes);
3397 /* Mark the queue as active, allowing this initial
3398 event to be accepted. */
3400 v4l2_event_queue_fh(sev->fh, &ev);
3402 v4l2_ctrl_unlock(ctrl);
3406 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
3408 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
3410 v4l2_ctrl_lock(ctrl);
3411 list_del(&sev->node);
3412 v4l2_ctrl_unlock(ctrl);
3415 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
3417 u32 old_changes = old->u.ctrl.changes;
3419 old->u.ctrl = new->u.ctrl;
3420 old->u.ctrl.changes |= old_changes;
3422 EXPORT_SYMBOL(v4l2_ctrl_replace);
3424 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
3426 new->u.ctrl.changes |= old->u.ctrl.changes;
3428 EXPORT_SYMBOL(v4l2_ctrl_merge);
3430 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
3431 .add = v4l2_ctrl_add_event,
3432 .del = v4l2_ctrl_del_event,
3433 .replace = v4l2_ctrl_replace,
3434 .merge = v4l2_ctrl_merge,
3436 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
3438 int v4l2_ctrl_log_status(struct file *file, void *fh)
3440 struct video_device *vfd = video_devdata(file);
3441 struct v4l2_fh *vfh = file->private_data;
3443 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
3444 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
3445 vfd->v4l2_dev->name);
3448 EXPORT_SYMBOL(v4l2_ctrl_log_status);
3450 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
3451 const struct v4l2_event_subscription *sub)
3453 if (sub->type == V4L2_EVENT_CTRL)
3454 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
3457 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
3459 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
3460 struct v4l2_event_subscription *sub)
3462 if (!sd->ctrl_handler)
3464 return v4l2_ctrl_subscribe_event(fh, sub);
3466 EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
3468 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
3470 struct v4l2_fh *fh = file->private_data;
3472 if (v4l2_event_pending(fh))
3474 poll_wait(file, &fh->wait, wait);
3477 EXPORT_SYMBOL(v4l2_ctrl_poll);