2 V4L2 controls framework implementation.
4 Copyright (C) 2010 Hans Verkuil <hverkuil@xs4all.nl>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/ctype.h>
22 #include <linux/slab.h>
23 #include <linux/export.h>
24 #include <media/v4l2-ioctl.h>
25 #include <media/v4l2-device.h>
26 #include <media/v4l2-ctrls.h>
27 #include <media/v4l2-event.h>
28 #include <media/v4l2-dev.h>
30 #define has_op(master, op) \
31 (master->ops && master->ops->op)
32 #define call_op(master, op) \
33 (has_op(master, op) ? master->ops->op(master) : 0)
35 /* Internal temporary helper struct, one for each v4l2_ext_control */
36 struct v4l2_ctrl_helper {
37 /* Pointer to the control reference of the master control */
38 struct v4l2_ctrl_ref *mref;
39 /* The control corresponding to the v4l2_ext_control ID field. */
40 struct v4l2_ctrl *ctrl;
41 /* v4l2_ext_control index of the next control belonging to the
42 same cluster, or 0 if there isn't any. */
46 /* Small helper function to determine if the autocluster is set to manual
48 static bool is_cur_manual(const struct v4l2_ctrl *master)
50 return master->is_auto && master->cur.val == master->manual_mode_value;
53 /* Same as above, but this checks the against the new value instead of the
55 static bool is_new_manual(const struct v4l2_ctrl *master)
57 return master->is_auto && master->val == master->manual_mode_value;
60 /* Returns NULL or a character pointer array containing the menu for
61 the given control ID. The pointer array ends with a NULL pointer.
62 An empty string signifies a menu entry that is invalid. This allows
63 drivers to disable certain options if it is not supported. */
64 const char * const *v4l2_ctrl_get_menu(u32 id)
66 static const char * const mpeg_audio_sampling_freq[] = {
72 static const char * const mpeg_audio_encoding[] = {
80 static const char * const mpeg_audio_l1_bitrate[] = {
97 static const char * const mpeg_audio_l2_bitrate[] = {
114 static const char * const mpeg_audio_l3_bitrate[] = {
131 static const char * const mpeg_audio_ac3_bitrate[] = {
153 static const char * const mpeg_audio_mode[] = {
160 static const char * const mpeg_audio_mode_extension[] = {
167 static const char * const mpeg_audio_emphasis[] = {
173 static const char * const mpeg_audio_crc[] = {
178 static const char * const mpeg_audio_dec_playback[] = {
187 static const char * const mpeg_video_encoding[] = {
193 static const char * const mpeg_video_aspect[] = {
200 static const char * const mpeg_video_bitrate_mode[] = {
205 static const char * const mpeg_stream_type[] = {
206 "MPEG-2 Program Stream",
207 "MPEG-2 Transport Stream",
208 "MPEG-1 System Stream",
209 "MPEG-2 DVD-compatible Stream",
210 "MPEG-1 VCD-compatible Stream",
211 "MPEG-2 SVCD-compatible Stream",
214 static const char * const mpeg_stream_vbi_fmt[] = {
216 "Private Packet, IVTV Format",
219 static const char * const camera_power_line_frequency[] = {
226 static const char * const camera_exposure_auto[] = {
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
233 static const char * const camera_exposure_metering[] = {
239 static const char * const camera_auto_focus_range[] = {
246 static const char * const colorfx[] = {
265 static const char * const auto_n_preset_white_balance[] = {
278 static const char * const camera_iso_sensitivity_auto[] = {
283 static const char * const scene_mode[] = {
300 static const char * const tune_preemphasis[] = {
306 static const char * const header_mode[] = {
308 "Joined With 1st Frame",
311 static const char * const multi_slice[] = {
317 static const char * const entropy_mode[] = {
322 static const char * const mpeg_h264_level[] = {
341 static const char * const h264_loop_filter[] = {
344 "Disabled at Slice Boundary",
347 static const char * const h264_profile[] = {
349 "Constrained Baseline",
355 "High 444 Predictive",
362 "Scalable High Intra",
366 static const char * const vui_sar_idc[] = {
387 static const char * const mpeg_mpeg4_level[] = {
398 static const char * const mpeg4_profile[] = {
403 "Advanced Coding Efficency",
407 static const char * const flash_led_mode[] = {
413 static const char * const flash_strobe_source[] = {
419 static const char * const jpeg_chroma_subsampling[] = {
430 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
431 return mpeg_audio_sampling_freq;
432 case V4L2_CID_MPEG_AUDIO_ENCODING:
433 return mpeg_audio_encoding;
434 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
435 return mpeg_audio_l1_bitrate;
436 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
437 return mpeg_audio_l2_bitrate;
438 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
439 return mpeg_audio_l3_bitrate;
440 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
441 return mpeg_audio_ac3_bitrate;
442 case V4L2_CID_MPEG_AUDIO_MODE:
443 return mpeg_audio_mode;
444 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
445 return mpeg_audio_mode_extension;
446 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
447 return mpeg_audio_emphasis;
448 case V4L2_CID_MPEG_AUDIO_CRC:
449 return mpeg_audio_crc;
450 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
451 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
452 return mpeg_audio_dec_playback;
453 case V4L2_CID_MPEG_VIDEO_ENCODING:
454 return mpeg_video_encoding;
455 case V4L2_CID_MPEG_VIDEO_ASPECT:
456 return mpeg_video_aspect;
457 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
458 return mpeg_video_bitrate_mode;
459 case V4L2_CID_MPEG_STREAM_TYPE:
460 return mpeg_stream_type;
461 case V4L2_CID_MPEG_STREAM_VBI_FMT:
462 return mpeg_stream_vbi_fmt;
463 case V4L2_CID_POWER_LINE_FREQUENCY:
464 return camera_power_line_frequency;
465 case V4L2_CID_EXPOSURE_AUTO:
466 return camera_exposure_auto;
467 case V4L2_CID_EXPOSURE_METERING:
468 return camera_exposure_metering;
469 case V4L2_CID_AUTO_FOCUS_RANGE:
470 return camera_auto_focus_range;
471 case V4L2_CID_COLORFX:
473 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
474 return auto_n_preset_white_balance;
475 case V4L2_CID_ISO_SENSITIVITY_AUTO:
476 return camera_iso_sensitivity_auto;
477 case V4L2_CID_SCENE_MODE:
479 case V4L2_CID_TUNE_PREEMPHASIS:
480 return tune_preemphasis;
481 case V4L2_CID_FLASH_LED_MODE:
482 return flash_led_mode;
483 case V4L2_CID_FLASH_STROBE_SOURCE:
484 return flash_strobe_source;
485 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
487 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
489 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
491 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
492 return mpeg_h264_level;
493 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
494 return h264_loop_filter;
495 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
497 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
499 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
500 return mpeg_mpeg4_level;
501 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
502 return mpeg4_profile;
503 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
504 return jpeg_chroma_subsampling;
510 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
512 /* Return the control name. */
513 const char *v4l2_ctrl_get_name(u32 id)
517 /* Keep the order of the 'case's the same as in videodev2.h! */
518 case V4L2_CID_USER_CLASS: return "User Controls";
519 case V4L2_CID_BRIGHTNESS: return "Brightness";
520 case V4L2_CID_CONTRAST: return "Contrast";
521 case V4L2_CID_SATURATION: return "Saturation";
522 case V4L2_CID_HUE: return "Hue";
523 case V4L2_CID_AUDIO_VOLUME: return "Volume";
524 case V4L2_CID_AUDIO_BALANCE: return "Balance";
525 case V4L2_CID_AUDIO_BASS: return "Bass";
526 case V4L2_CID_AUDIO_TREBLE: return "Treble";
527 case V4L2_CID_AUDIO_MUTE: return "Mute";
528 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
529 case V4L2_CID_BLACK_LEVEL: return "Black Level";
530 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
531 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
532 case V4L2_CID_RED_BALANCE: return "Red Balance";
533 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
534 case V4L2_CID_GAMMA: return "Gamma";
535 case V4L2_CID_EXPOSURE: return "Exposure";
536 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
537 case V4L2_CID_GAIN: return "Gain";
538 case V4L2_CID_HFLIP: return "Horizontal Flip";
539 case V4L2_CID_VFLIP: return "Vertical Flip";
540 case V4L2_CID_HCENTER: return "Horizontal Center";
541 case V4L2_CID_VCENTER: return "Vertical Center";
542 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
543 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
544 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
545 case V4L2_CID_SHARPNESS: return "Sharpness";
546 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
547 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
548 case V4L2_CID_COLOR_KILLER: return "Color Killer";
549 case V4L2_CID_COLORFX: return "Color Effects";
550 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
551 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
552 case V4L2_CID_ROTATE: return "Rotate";
553 case V4L2_CID_BG_COLOR: return "Background Color";
554 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
555 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
556 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
557 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
558 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
559 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
560 case V4L2_CID_COLORFX_CBCR: return "Color Effects, CbCr";
563 /* Keep the order of the 'case's the same as in videodev2.h! */
564 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
565 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
566 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
567 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
568 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
569 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
570 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
571 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
572 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
573 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
574 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
575 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
576 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
577 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
578 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
579 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
580 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
581 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
582 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
583 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
584 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
585 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
586 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
587 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
588 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
589 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
590 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
591 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
592 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
593 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
594 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
595 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
596 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
597 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
598 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
599 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
600 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
601 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
602 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
603 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
604 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
605 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
606 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
607 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
608 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
609 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
610 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
611 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
612 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
613 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
614 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
615 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
616 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
617 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
618 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
619 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
620 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
621 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
622 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
623 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
624 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
625 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
626 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
627 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
628 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
629 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
630 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
631 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
632 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
633 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
634 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
635 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
636 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
637 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
638 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
639 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
640 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
641 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
642 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
644 /* CAMERA controls */
645 /* Keep the order of the 'case's the same as in videodev2.h! */
646 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
647 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
648 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
649 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
650 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
651 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
652 case V4L2_CID_PAN_RESET: return "Pan, Reset";
653 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
654 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
655 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
656 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
657 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
658 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic Continuous";
659 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
660 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
661 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
662 case V4L2_CID_PRIVACY: return "Privacy";
663 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
664 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
665 case V4L2_CID_AUTO_EXPOSURE_BIAS: return "Auto Exposure, Bias";
666 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
667 case V4L2_CID_WIDE_DYNAMIC_RANGE: return "Wide Dynamic Range";
668 case V4L2_CID_IMAGE_STABILIZATION: return "Image Stabilization";
669 case V4L2_CID_ISO_SENSITIVITY: return "ISO Sensitivity";
670 case V4L2_CID_ISO_SENSITIVITY_AUTO: return "ISO Sensitivity, Auto";
671 case V4L2_CID_EXPOSURE_METERING: return "Exposure, Metering Mode";
672 case V4L2_CID_SCENE_MODE: return "Scene Mode";
673 case V4L2_CID_3A_LOCK: return "3A Lock";
674 case V4L2_CID_AUTO_FOCUS_START: return "Auto Focus, Start";
675 case V4L2_CID_AUTO_FOCUS_STOP: return "Auto Focus, Stop";
676 case V4L2_CID_AUTO_FOCUS_STATUS: return "Auto Focus, Status";
677 case V4L2_CID_AUTO_FOCUS_RANGE: return "Auto Focus, Range";
679 /* FM Radio Modulator control */
680 /* Keep the order of the 'case's the same as in videodev2.h! */
681 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
682 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
683 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
684 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
685 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
686 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
687 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
688 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
689 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
690 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
691 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
692 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
693 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
694 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
695 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
696 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
697 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
698 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
699 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
700 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
703 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
704 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
705 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
706 case V4L2_CID_FLASH_STROBE: return "Strobe";
707 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
708 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
709 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
710 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
711 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
712 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
713 case V4L2_CID_FLASH_FAULT: return "Faults";
714 case V4L2_CID_FLASH_CHARGE: return "Charge";
715 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
717 /* JPEG encoder controls */
718 /* Keep the order of the 'case's the same as in videodev2.h! */
719 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
720 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
721 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
722 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
723 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
725 /* Image source controls */
726 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
727 case V4L2_CID_VBLANK: return "Vertical Blanking";
728 case V4L2_CID_HBLANK: return "Horizontal Blanking";
729 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
731 /* Image processing controls */
732 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
733 case V4L2_CID_LINK_FREQ: return "Link Frequency";
734 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
740 EXPORT_SYMBOL(v4l2_ctrl_get_name);
742 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
743 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
745 *name = v4l2_ctrl_get_name(id);
749 case V4L2_CID_AUDIO_MUTE:
750 case V4L2_CID_AUDIO_LOUDNESS:
751 case V4L2_CID_AUTO_WHITE_BALANCE:
752 case V4L2_CID_AUTOGAIN:
755 case V4L2_CID_HUE_AUTO:
756 case V4L2_CID_CHROMA_AGC:
757 case V4L2_CID_COLOR_KILLER:
758 case V4L2_CID_MPEG_AUDIO_MUTE:
759 case V4L2_CID_MPEG_VIDEO_MUTE:
760 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
761 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
762 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
763 case V4L2_CID_FOCUS_AUTO:
764 case V4L2_CID_PRIVACY:
765 case V4L2_CID_AUDIO_LIMITER_ENABLED:
766 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
767 case V4L2_CID_PILOT_TONE_ENABLED:
768 case V4L2_CID_ILLUMINATORS_1:
769 case V4L2_CID_ILLUMINATORS_2:
770 case V4L2_CID_FLASH_STROBE_STATUS:
771 case V4L2_CID_FLASH_CHARGE:
772 case V4L2_CID_FLASH_READY:
773 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
774 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
775 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
776 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
777 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
778 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
779 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
780 case V4L2_CID_WIDE_DYNAMIC_RANGE:
781 case V4L2_CID_IMAGE_STABILIZATION:
782 *type = V4L2_CTRL_TYPE_BOOLEAN;
786 case V4L2_CID_PAN_RESET:
787 case V4L2_CID_TILT_RESET:
788 case V4L2_CID_FLASH_STROBE:
789 case V4L2_CID_FLASH_STROBE_STOP:
790 case V4L2_CID_AUTO_FOCUS_START:
791 case V4L2_CID_AUTO_FOCUS_STOP:
792 *type = V4L2_CTRL_TYPE_BUTTON;
793 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
794 *min = *max = *step = *def = 0;
796 case V4L2_CID_POWER_LINE_FREQUENCY:
797 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
798 case V4L2_CID_MPEG_AUDIO_ENCODING:
799 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
800 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
801 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
802 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
803 case V4L2_CID_MPEG_AUDIO_MODE:
804 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
805 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
806 case V4L2_CID_MPEG_AUDIO_CRC:
807 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
808 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
809 case V4L2_CID_MPEG_VIDEO_ENCODING:
810 case V4L2_CID_MPEG_VIDEO_ASPECT:
811 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
812 case V4L2_CID_MPEG_STREAM_TYPE:
813 case V4L2_CID_MPEG_STREAM_VBI_FMT:
814 case V4L2_CID_EXPOSURE_AUTO:
815 case V4L2_CID_AUTO_FOCUS_RANGE:
816 case V4L2_CID_COLORFX:
817 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
818 case V4L2_CID_TUNE_PREEMPHASIS:
819 case V4L2_CID_FLASH_LED_MODE:
820 case V4L2_CID_FLASH_STROBE_SOURCE:
821 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
822 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
823 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
824 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
825 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
826 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
827 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
828 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
829 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
830 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
831 case V4L2_CID_ISO_SENSITIVITY_AUTO:
832 case V4L2_CID_EXPOSURE_METERING:
833 case V4L2_CID_SCENE_MODE:
834 *type = V4L2_CTRL_TYPE_MENU;
836 case V4L2_CID_LINK_FREQ:
837 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
839 case V4L2_CID_RDS_TX_PS_NAME:
840 case V4L2_CID_RDS_TX_RADIO_TEXT:
841 *type = V4L2_CTRL_TYPE_STRING;
843 case V4L2_CID_ISO_SENSITIVITY:
844 case V4L2_CID_AUTO_EXPOSURE_BIAS:
845 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
847 case V4L2_CID_USER_CLASS:
848 case V4L2_CID_CAMERA_CLASS:
849 case V4L2_CID_MPEG_CLASS:
850 case V4L2_CID_FM_TX_CLASS:
851 case V4L2_CID_FLASH_CLASS:
852 case V4L2_CID_JPEG_CLASS:
853 case V4L2_CID_IMAGE_SOURCE_CLASS:
854 case V4L2_CID_IMAGE_PROC_CLASS:
855 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
856 /* You can neither read not write these */
857 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
858 *min = *max = *step = *def = 0;
860 case V4L2_CID_BG_COLOR:
861 *type = V4L2_CTRL_TYPE_INTEGER;
864 /* Max is calculated as RGB888 that is 2^24 */
867 case V4L2_CID_FLASH_FAULT:
868 case V4L2_CID_JPEG_ACTIVE_MARKER:
869 case V4L2_CID_3A_LOCK:
870 case V4L2_CID_AUTO_FOCUS_STATUS:
871 *type = V4L2_CTRL_TYPE_BITMASK;
873 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
874 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
875 *type = V4L2_CTRL_TYPE_INTEGER;
876 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
878 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
879 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
880 *flags |= V4L2_CTRL_FLAG_VOLATILE;
882 case V4L2_CID_PIXEL_RATE:
883 *type = V4L2_CTRL_TYPE_INTEGER64;
884 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
885 *min = *max = *step = *def = 0;
888 *type = V4L2_CTRL_TYPE_INTEGER;
892 case V4L2_CID_MPEG_AUDIO_ENCODING:
893 case V4L2_CID_MPEG_AUDIO_MODE:
894 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
895 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
896 case V4L2_CID_MPEG_STREAM_TYPE:
897 *flags |= V4L2_CTRL_FLAG_UPDATE;
899 case V4L2_CID_AUDIO_VOLUME:
900 case V4L2_CID_AUDIO_BALANCE:
901 case V4L2_CID_AUDIO_BASS:
902 case V4L2_CID_AUDIO_TREBLE:
903 case V4L2_CID_BRIGHTNESS:
904 case V4L2_CID_CONTRAST:
905 case V4L2_CID_SATURATION:
907 case V4L2_CID_RED_BALANCE:
908 case V4L2_CID_BLUE_BALANCE:
910 case V4L2_CID_SHARPNESS:
911 case V4L2_CID_CHROMA_GAIN:
912 case V4L2_CID_RDS_TX_DEVIATION:
913 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
914 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
915 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
916 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
917 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
918 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
919 case V4L2_CID_PILOT_TONE_DEVIATION:
920 case V4L2_CID_PILOT_TONE_FREQUENCY:
921 case V4L2_CID_TUNE_POWER_LEVEL:
922 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
923 *flags |= V4L2_CTRL_FLAG_SLIDER;
925 case V4L2_CID_PAN_RELATIVE:
926 case V4L2_CID_TILT_RELATIVE:
927 case V4L2_CID_FOCUS_RELATIVE:
928 case V4L2_CID_IRIS_RELATIVE:
929 case V4L2_CID_ZOOM_RELATIVE:
930 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
932 case V4L2_CID_FLASH_STROBE_STATUS:
933 case V4L2_CID_AUTO_FOCUS_STATUS:
934 case V4L2_CID_FLASH_READY:
935 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
939 EXPORT_SYMBOL(v4l2_ctrl_fill);
941 /* Helper function to determine whether the control type is compatible with
943 static bool type_is_int(const struct v4l2_ctrl *ctrl)
945 switch (ctrl->type) {
946 case V4L2_CTRL_TYPE_INTEGER64:
947 case V4L2_CTRL_TYPE_STRING:
948 /* Nope, these need v4l2_ext_control */
955 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
957 memset(ev->reserved, 0, sizeof(ev->reserved));
958 ev->type = V4L2_EVENT_CTRL;
960 ev->u.ctrl.changes = changes;
961 ev->u.ctrl.type = ctrl->type;
962 ev->u.ctrl.flags = ctrl->flags;
963 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
964 ev->u.ctrl.value64 = 0;
966 ev->u.ctrl.value64 = ctrl->cur.val64;
967 ev->u.ctrl.minimum = ctrl->minimum;
968 ev->u.ctrl.maximum = ctrl->maximum;
969 if (ctrl->type == V4L2_CTRL_TYPE_MENU
970 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
973 ev->u.ctrl.step = ctrl->step;
974 ev->u.ctrl.default_value = ctrl->default_value;
977 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
979 struct v4l2_event ev;
980 struct v4l2_subscribed_event *sev;
982 if (list_empty(&ctrl->ev_subs))
984 fill_event(&ev, ctrl, changes);
986 list_for_each_entry(sev, &ctrl->ev_subs, node)
988 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
989 v4l2_event_queue_fh(sev->fh, &ev);
992 /* Helper function: copy the current control value back to the caller */
993 static int cur_to_user(struct v4l2_ext_control *c,
994 struct v4l2_ctrl *ctrl)
998 switch (ctrl->type) {
999 case V4L2_CTRL_TYPE_STRING:
1000 len = strlen(ctrl->cur.string);
1001 if (c->size < len + 1) {
1005 return copy_to_user(c->string, ctrl->cur.string,
1006 len + 1) ? -EFAULT : 0;
1007 case V4L2_CTRL_TYPE_INTEGER64:
1008 c->value64 = ctrl->cur.val64;
1011 c->value = ctrl->cur.val;
1017 /* Helper function: copy the caller-provider value as the new control value */
1018 static int user_to_new(struct v4l2_ext_control *c,
1019 struct v4l2_ctrl *ctrl)
1025 switch (ctrl->type) {
1026 case V4L2_CTRL_TYPE_INTEGER64:
1027 ctrl->val64 = c->value64;
1029 case V4L2_CTRL_TYPE_STRING:
1033 if (size > ctrl->maximum + 1)
1034 size = ctrl->maximum + 1;
1035 ret = copy_from_user(ctrl->string, c->string, size);
1037 char last = ctrl->string[size - 1];
1039 ctrl->string[size - 1] = 0;
1040 /* If the string was longer than ctrl->maximum,
1041 then return an error. */
1042 if (strlen(ctrl->string) == ctrl->maximum && last)
1045 return ret ? -EFAULT : 0;
1047 ctrl->val = c->value;
1053 /* Helper function: copy the new control value back to the caller */
1054 static int new_to_user(struct v4l2_ext_control *c,
1055 struct v4l2_ctrl *ctrl)
1059 switch (ctrl->type) {
1060 case V4L2_CTRL_TYPE_STRING:
1061 len = strlen(ctrl->string);
1062 if (c->size < len + 1) {
1063 c->size = ctrl->maximum + 1;
1066 return copy_to_user(c->string, ctrl->string,
1067 len + 1) ? -EFAULT : 0;
1068 case V4L2_CTRL_TYPE_INTEGER64:
1069 c->value64 = ctrl->val64;
1072 c->value = ctrl->val;
1078 /* Copy the new value to the current value. */
1079 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
1080 bool update_inactive)
1082 bool changed = false;
1086 switch (ctrl->type) {
1087 case V4L2_CTRL_TYPE_BUTTON:
1090 case V4L2_CTRL_TYPE_STRING:
1091 /* strings are always 0-terminated */
1092 changed = strcmp(ctrl->string, ctrl->cur.string);
1093 strcpy(ctrl->cur.string, ctrl->string);
1095 case V4L2_CTRL_TYPE_INTEGER64:
1096 changed = ctrl->val64 != ctrl->cur.val64;
1097 ctrl->cur.val64 = ctrl->val64;
1100 changed = ctrl->val != ctrl->cur.val;
1101 ctrl->cur.val = ctrl->val;
1104 if (update_inactive) {
1105 /* Note: update_inactive can only be true for auto clusters. */
1107 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1108 if (!is_cur_manual(ctrl->cluster[0])) {
1109 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1110 if (ctrl->cluster[0]->has_volatiles)
1111 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1115 if (changed || update_inactive) {
1116 /* If a control was changed that was not one of the controls
1117 modified by the application, then send the event to all. */
1120 send_event(fh, ctrl,
1121 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1122 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
1126 /* Copy the current value to the new value */
1127 static void cur_to_new(struct v4l2_ctrl *ctrl)
1131 switch (ctrl->type) {
1132 case V4L2_CTRL_TYPE_STRING:
1133 /* strings are always 0-terminated */
1134 strcpy(ctrl->string, ctrl->cur.string);
1136 case V4L2_CTRL_TYPE_INTEGER64:
1137 ctrl->val64 = ctrl->cur.val64;
1140 ctrl->val = ctrl->cur.val;
1145 /* Return non-zero if one or more of the controls in the cluster has a new
1146 value that differs from the current value. */
1147 static int cluster_changed(struct v4l2_ctrl *master)
1152 for (i = 0; !diff && i < master->ncontrols; i++) {
1153 struct v4l2_ctrl *ctrl = master->cluster[i];
1157 switch (ctrl->type) {
1158 case V4L2_CTRL_TYPE_BUTTON:
1159 /* Button controls are always 'different' */
1161 case V4L2_CTRL_TYPE_STRING:
1162 /* strings are always 0-terminated */
1163 diff = strcmp(ctrl->string, ctrl->cur.string);
1165 case V4L2_CTRL_TYPE_INTEGER64:
1166 diff = ctrl->val64 != ctrl->cur.val64;
1169 diff = ctrl->val != ctrl->cur.val;
1176 /* Validate integer-type control */
1177 static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
1182 switch (ctrl->type) {
1183 case V4L2_CTRL_TYPE_INTEGER:
1184 /* Round towards the closest legal value */
1185 val += ctrl->step / 2;
1186 if (val < ctrl->minimum)
1187 val = ctrl->minimum;
1188 if (val > ctrl->maximum)
1189 val = ctrl->maximum;
1190 offset = val - ctrl->minimum;
1191 offset = ctrl->step * (offset / ctrl->step);
1192 val = ctrl->minimum + offset;
1196 case V4L2_CTRL_TYPE_BOOLEAN:
1200 case V4L2_CTRL_TYPE_MENU:
1201 case V4L2_CTRL_TYPE_INTEGER_MENU:
1202 if (val < ctrl->minimum || val > ctrl->maximum)
1204 if (ctrl->menu_skip_mask & (1 << val))
1206 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1207 ctrl->qmenu[val][0] == '\0')
1211 case V4L2_CTRL_TYPE_BITMASK:
1212 *pval &= ctrl->maximum;
1215 case V4L2_CTRL_TYPE_BUTTON:
1216 case V4L2_CTRL_TYPE_CTRL_CLASS:
1225 /* Validate a new control */
1226 static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1228 char *s = c->string;
1231 switch (ctrl->type) {
1232 case V4L2_CTRL_TYPE_INTEGER:
1233 case V4L2_CTRL_TYPE_BOOLEAN:
1234 case V4L2_CTRL_TYPE_MENU:
1235 case V4L2_CTRL_TYPE_INTEGER_MENU:
1236 case V4L2_CTRL_TYPE_BITMASK:
1237 case V4L2_CTRL_TYPE_BUTTON:
1238 case V4L2_CTRL_TYPE_CTRL_CLASS:
1239 return validate_new_int(ctrl, &c->value);
1241 case V4L2_CTRL_TYPE_INTEGER64:
1244 case V4L2_CTRL_TYPE_STRING:
1246 if (len < ctrl->minimum)
1248 if ((len - ctrl->minimum) % ctrl->step)
1257 static inline u32 node2id(struct list_head *node)
1259 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1262 /* Set the handler's error code if it wasn't set earlier already */
1263 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1265 if (hdl->error == 0)
1270 /* Initialize the handler */
1271 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1272 unsigned nr_of_controls_hint)
1274 hdl->lock = &hdl->_lock;
1275 mutex_init(hdl->lock);
1276 INIT_LIST_HEAD(&hdl->ctrls);
1277 INIT_LIST_HEAD(&hdl->ctrl_refs);
1278 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1279 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1281 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1284 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1286 /* Free all controls and control refs */
1287 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1289 struct v4l2_ctrl_ref *ref, *next_ref;
1290 struct v4l2_ctrl *ctrl, *next_ctrl;
1291 struct v4l2_subscribed_event *sev, *next_sev;
1293 if (hdl == NULL || hdl->buckets == NULL)
1296 mutex_lock(hdl->lock);
1297 /* Free all nodes */
1298 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1299 list_del(&ref->node);
1302 /* Free all controls owned by the handler */
1303 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1304 list_del(&ctrl->node);
1305 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1306 list_del(&sev->node);
1309 kfree(hdl->buckets);
1310 hdl->buckets = NULL;
1313 mutex_unlock(hdl->lock);
1315 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1317 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1318 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1319 with applications that do not use the NEXT_CTRL flag.
1321 We just find the n-th private user control. It's O(N), but that should not
1322 be an issue in this particular case. */
1323 static struct v4l2_ctrl_ref *find_private_ref(
1324 struct v4l2_ctrl_handler *hdl, u32 id)
1326 struct v4l2_ctrl_ref *ref;
1328 id -= V4L2_CID_PRIVATE_BASE;
1329 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1330 /* Search for private user controls that are compatible with
1332 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1333 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1334 if (!type_is_int(ref->ctrl))
1344 /* Find a control with the given ID. */
1345 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1347 struct v4l2_ctrl_ref *ref;
1350 id &= V4L2_CTRL_ID_MASK;
1352 /* Old-style private controls need special handling */
1353 if (id >= V4L2_CID_PRIVATE_BASE)
1354 return find_private_ref(hdl, id);
1355 bucket = id % hdl->nr_of_buckets;
1357 /* Simple optimization: cache the last control found */
1358 if (hdl->cached && hdl->cached->ctrl->id == id)
1361 /* Not in cache, search the hash */
1362 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1363 while (ref && ref->ctrl->id != id)
1367 hdl->cached = ref; /* cache it! */
1371 /* Find a control with the given ID. Take the handler's lock first. */
1372 static struct v4l2_ctrl_ref *find_ref_lock(
1373 struct v4l2_ctrl_handler *hdl, u32 id)
1375 struct v4l2_ctrl_ref *ref = NULL;
1378 mutex_lock(hdl->lock);
1379 ref = find_ref(hdl, id);
1380 mutex_unlock(hdl->lock);
1385 /* Find a control with the given ID. */
1386 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1388 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1390 return ref ? ref->ctrl : NULL;
1392 EXPORT_SYMBOL(v4l2_ctrl_find);
1394 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1395 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1396 struct v4l2_ctrl *ctrl)
1398 struct v4l2_ctrl_ref *ref;
1399 struct v4l2_ctrl_ref *new_ref;
1401 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1402 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1404 /* Automatically add the control class if it is not yet present. */
1405 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1406 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1412 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1414 return handler_set_err(hdl, -ENOMEM);
1415 new_ref->ctrl = ctrl;
1416 if (ctrl->handler == hdl) {
1417 /* By default each control starts in a cluster of its own.
1418 new_ref->ctrl is basically a cluster array with one
1419 element, so that's perfect to use as the cluster pointer.
1420 But only do this for the handler that owns the control. */
1421 ctrl->cluster = &new_ref->ctrl;
1422 ctrl->ncontrols = 1;
1425 INIT_LIST_HEAD(&new_ref->node);
1427 mutex_lock(hdl->lock);
1429 /* Add immediately at the end of the list if the list is empty, or if
1430 the last element in the list has a lower ID.
1431 This ensures that when elements are added in ascending order the
1432 insertion is an O(1) operation. */
1433 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1434 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1435 goto insert_in_hash;
1438 /* Find insert position in sorted list */
1439 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1440 if (ref->ctrl->id < id)
1442 /* Don't add duplicates */
1443 if (ref->ctrl->id == id) {
1447 list_add(&new_ref->node, ref->node.prev);
1452 /* Insert the control node in the hash */
1453 new_ref->next = hdl->buckets[bucket];
1454 hdl->buckets[bucket] = new_ref;
1457 mutex_unlock(hdl->lock);
1461 /* Add a new control */
1462 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1463 const struct v4l2_ctrl_ops *ops,
1464 u32 id, const char *name, enum v4l2_ctrl_type type,
1465 s32 min, s32 max, u32 step, s32 def,
1466 u32 flags, const char * const *qmenu,
1467 const s64 *qmenu_int, void *priv)
1469 struct v4l2_ctrl *ctrl;
1470 unsigned sz_extra = 0;
1476 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1477 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1478 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
1479 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1480 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
1481 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1482 handler_set_err(hdl, -ERANGE);
1485 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1486 handler_set_err(hdl, -ERANGE);
1489 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1490 type == V4L2_CTRL_TYPE_MENU ||
1491 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
1492 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1493 (def < min || def > max)) {
1494 handler_set_err(hdl, -ERANGE);
1497 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1498 handler_set_err(hdl, -ERANGE);
1502 if (type == V4L2_CTRL_TYPE_BUTTON)
1503 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1504 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1505 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1506 else if (type == V4L2_CTRL_TYPE_STRING)
1507 sz_extra += 2 * (max + 1);
1509 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1511 handler_set_err(hdl, -ENOMEM);
1515 INIT_LIST_HEAD(&ctrl->node);
1516 INIT_LIST_HEAD(&ctrl->ev_subs);
1517 ctrl->handler = hdl;
1522 ctrl->flags = flags;
1523 ctrl->minimum = min;
1524 ctrl->maximum = max;
1526 if (type == V4L2_CTRL_TYPE_MENU)
1527 ctrl->qmenu = qmenu;
1528 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1529 ctrl->qmenu_int = qmenu_int;
1531 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1533 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1534 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1535 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1537 memset(ctrl->cur.string, ' ', ctrl->minimum);
1539 if (handler_new_ref(hdl, ctrl)) {
1543 mutex_lock(hdl->lock);
1544 list_add_tail(&ctrl->node, &hdl->ctrls);
1545 mutex_unlock(hdl->lock);
1549 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1550 const struct v4l2_ctrl_config *cfg, void *priv)
1553 struct v4l2_ctrl *ctrl;
1554 const char *name = cfg->name;
1555 const char * const *qmenu = cfg->qmenu;
1556 const s64 *qmenu_int = cfg->qmenu_int;
1557 enum v4l2_ctrl_type type = cfg->type;
1558 u32 flags = cfg->flags;
1561 u32 step = cfg->step;
1565 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1568 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1569 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
1573 WARN_ON(cfg->menu_skip_mask);
1574 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
1575 qmenu = v4l2_ctrl_get_menu(cfg->id);
1576 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1577 qmenu_int == NULL) {
1578 handler_set_err(hdl, -EINVAL);
1582 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1584 is_menu ? cfg->menu_skip_mask : step,
1585 def, flags, qmenu, qmenu_int, priv);
1587 ctrl->is_private = cfg->is_private;
1590 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1592 /* Helper function for standard non-menu controls */
1593 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1594 const struct v4l2_ctrl_ops *ops,
1595 u32 id, s32 min, s32 max, u32 step, s32 def)
1598 enum v4l2_ctrl_type type;
1601 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1602 if (type == V4L2_CTRL_TYPE_MENU
1603 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
1604 handler_set_err(hdl, -EINVAL);
1607 return v4l2_ctrl_new(hdl, ops, id, name, type,
1608 min, max, step, def, flags, NULL, NULL, NULL);
1610 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1612 /* Helper function for standard menu controls */
1613 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1614 const struct v4l2_ctrl_ops *ops,
1615 u32 id, s32 max, s32 mask, s32 def)
1617 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1619 enum v4l2_ctrl_type type;
1624 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1625 if (type != V4L2_CTRL_TYPE_MENU) {
1626 handler_set_err(hdl, -EINVAL);
1629 return v4l2_ctrl_new(hdl, ops, id, name, type,
1630 0, max, mask, def, flags, qmenu, NULL, NULL);
1632 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1634 /* Helper function for standard integer menu controls */
1635 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
1636 const struct v4l2_ctrl_ops *ops,
1637 u32 id, s32 max, s32 def, const s64 *qmenu_int)
1640 enum v4l2_ctrl_type type;
1645 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1646 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
1647 handler_set_err(hdl, -EINVAL);
1650 return v4l2_ctrl_new(hdl, ops, id, name, type,
1651 0, max, 0, def, flags, NULL, qmenu_int, NULL);
1653 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
1655 /* Add a control from another handler to this handler */
1656 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1657 struct v4l2_ctrl *ctrl)
1659 if (hdl == NULL || hdl->error)
1662 handler_set_err(hdl, -EINVAL);
1665 if (ctrl->handler == hdl)
1667 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1669 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1671 /* Add the controls from another handler to our own. */
1672 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1673 struct v4l2_ctrl_handler *add)
1675 struct v4l2_ctrl_ref *ref;
1678 /* Do nothing if either handler is NULL or if they are the same */
1679 if (!hdl || !add || hdl == add)
1683 mutex_lock(add->lock);
1684 list_for_each_entry(ref, &add->ctrl_refs, node) {
1685 struct v4l2_ctrl *ctrl = ref->ctrl;
1687 /* Skip handler-private controls. */
1688 if (ctrl->is_private)
1690 /* And control classes */
1691 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1693 ret = handler_new_ref(hdl, ctrl);
1697 mutex_unlock(add->lock);
1700 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1702 /* Cluster controls */
1703 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1705 bool has_volatiles = false;
1708 /* The first control is the master control and it must not be NULL */
1709 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1711 for (i = 0; i < ncontrols; i++) {
1713 controls[i]->cluster = controls;
1714 controls[i]->ncontrols = ncontrols;
1715 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1716 has_volatiles = true;
1719 controls[0]->has_volatiles = has_volatiles;
1721 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1723 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1724 u8 manual_val, bool set_volatile)
1726 struct v4l2_ctrl *master = controls[0];
1730 v4l2_ctrl_cluster(ncontrols, controls);
1731 WARN_ON(ncontrols <= 1);
1732 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1733 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1734 master->is_auto = true;
1735 master->has_volatiles = set_volatile;
1736 master->manual_mode_value = manual_val;
1737 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1739 if (!is_cur_manual(master))
1740 flag = V4L2_CTRL_FLAG_INACTIVE |
1741 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1743 for (i = 1; i < ncontrols; i++)
1745 controls[i]->flags |= flag;
1747 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1749 /* Activate/deactivate a control. */
1750 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1752 /* invert since the actual flag is called 'inactive' */
1753 bool inactive = !active;
1760 /* set V4L2_CTRL_FLAG_INACTIVE */
1761 old = test_and_set_bit(4, &ctrl->flags);
1763 /* clear V4L2_CTRL_FLAG_INACTIVE */
1764 old = test_and_clear_bit(4, &ctrl->flags);
1765 if (old != inactive)
1766 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1768 EXPORT_SYMBOL(v4l2_ctrl_activate);
1770 /* Grab/ungrab a control.
1771 Typically used when streaming starts and you want to grab controls,
1772 preventing the user from changing them.
1774 Just call this and the framework will block any attempts to change
1776 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1783 v4l2_ctrl_lock(ctrl);
1785 /* set V4L2_CTRL_FLAG_GRABBED */
1786 old = test_and_set_bit(1, &ctrl->flags);
1788 /* clear V4L2_CTRL_FLAG_GRABBED */
1789 old = test_and_clear_bit(1, &ctrl->flags);
1791 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1792 v4l2_ctrl_unlock(ctrl);
1794 EXPORT_SYMBOL(v4l2_ctrl_grab);
1796 /* Log the control name and value */
1797 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1798 const char *prefix, const char *colon)
1800 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1802 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1805 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1807 switch (ctrl->type) {
1808 case V4L2_CTRL_TYPE_INTEGER:
1809 printk(KERN_CONT "%d", ctrl->cur.val);
1811 case V4L2_CTRL_TYPE_BOOLEAN:
1812 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1814 case V4L2_CTRL_TYPE_MENU:
1815 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1817 case V4L2_CTRL_TYPE_INTEGER_MENU:
1818 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1820 case V4L2_CTRL_TYPE_BITMASK:
1821 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1823 case V4L2_CTRL_TYPE_INTEGER64:
1824 printk(KERN_CONT "%lld", ctrl->cur.val64);
1826 case V4L2_CTRL_TYPE_STRING:
1827 printk(KERN_CONT "%s", ctrl->cur.string);
1830 printk(KERN_CONT "unknown type %d", ctrl->type);
1833 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1834 V4L2_CTRL_FLAG_GRABBED |
1835 V4L2_CTRL_FLAG_VOLATILE)) {
1836 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1837 printk(KERN_CONT " inactive");
1838 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1839 printk(KERN_CONT " grabbed");
1840 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1841 printk(KERN_CONT " volatile");
1843 printk(KERN_CONT "\n");
1846 /* Log all controls owned by the handler */
1847 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1850 struct v4l2_ctrl *ctrl;
1851 const char *colon = "";
1858 len = strlen(prefix);
1859 if (len && prefix[len - 1] != ' ')
1861 mutex_lock(hdl->lock);
1862 list_for_each_entry(ctrl, &hdl->ctrls, node)
1863 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1864 log_ctrl(ctrl, prefix, colon);
1865 mutex_unlock(hdl->lock);
1867 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1869 /* Call s_ctrl for all controls owned by the handler */
1870 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1872 struct v4l2_ctrl *ctrl;
1877 mutex_lock(hdl->lock);
1878 list_for_each_entry(ctrl, &hdl->ctrls, node)
1881 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1882 struct v4l2_ctrl *master = ctrl->cluster[0];
1885 /* Skip if this control was already handled by a cluster. */
1886 /* Skip button controls and read-only controls. */
1887 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1888 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1891 for (i = 0; i < master->ncontrols; i++) {
1892 if (master->cluster[i]) {
1893 cur_to_new(master->cluster[i]);
1894 master->cluster[i]->is_new = 1;
1895 master->cluster[i]->done = true;
1898 ret = call_op(master, s_ctrl);
1902 mutex_unlock(hdl->lock);
1905 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1907 /* Implement VIDIOC_QUERYCTRL */
1908 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1910 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1911 struct v4l2_ctrl_ref *ref;
1912 struct v4l2_ctrl *ctrl;
1917 mutex_lock(hdl->lock);
1919 /* Try to find it */
1920 ref = find_ref(hdl, id);
1922 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1923 /* Find the next control with ID > qc->id */
1925 /* Did we reach the end of the control list? */
1926 if (id >= node2id(hdl->ctrl_refs.prev)) {
1927 ref = NULL; /* Yes, so there is no next control */
1929 /* We found a control with the given ID, so just get
1930 the next one in the list. */
1931 ref = list_entry(ref->node.next, typeof(*ref), node);
1933 /* No control with the given ID exists, so start
1934 searching for the next largest ID. We know there
1935 is one, otherwise the first 'if' above would have
1937 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1938 if (id < ref->ctrl->id)
1942 mutex_unlock(hdl->lock);
1947 memset(qc, 0, sizeof(*qc));
1948 if (id >= V4L2_CID_PRIVATE_BASE)
1952 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1953 qc->minimum = ctrl->minimum;
1954 qc->maximum = ctrl->maximum;
1955 qc->default_value = ctrl->default_value;
1956 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1957 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1960 qc->step = ctrl->step;
1961 qc->flags = ctrl->flags;
1962 qc->type = ctrl->type;
1965 EXPORT_SYMBOL(v4l2_queryctrl);
1967 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1969 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1971 return v4l2_queryctrl(sd->ctrl_handler, qc);
1973 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1975 /* Implement VIDIOC_QUERYMENU */
1976 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1978 struct v4l2_ctrl *ctrl;
1981 ctrl = v4l2_ctrl_find(hdl, qm->id);
1987 switch (ctrl->type) {
1988 case V4L2_CTRL_TYPE_MENU:
1989 if (ctrl->qmenu == NULL)
1992 case V4L2_CTRL_TYPE_INTEGER_MENU:
1993 if (ctrl->qmenu_int == NULL)
2000 if (i < ctrl->minimum || i > ctrl->maximum)
2003 /* Use mask to see if this menu item should be skipped */
2004 if (ctrl->menu_skip_mask & (1 << i))
2006 /* Empty menu items should also be skipped */
2007 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2008 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2010 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2012 qm->value = ctrl->qmenu_int[i];
2016 EXPORT_SYMBOL(v4l2_querymenu);
2018 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2020 return v4l2_querymenu(sd->ctrl_handler, qm);
2022 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2026 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2028 It is not a fully atomic operation, just best-effort only. After all, if
2029 multiple controls have to be set through multiple i2c writes (for example)
2030 then some initial writes may succeed while others fail. Thus leaving the
2031 system in an inconsistent state. The question is how much effort you are
2032 willing to spend on trying to make something atomic that really isn't.
2034 From the point of view of an application the main requirement is that
2035 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2036 error should be returned without actually affecting any controls.
2038 If all the values are correct, then it is acceptable to just give up
2039 in case of low-level errors.
2041 It is important though that the application can tell when only a partial
2042 configuration was done. The way we do that is through the error_idx field
2043 of struct v4l2_ext_controls: if that is equal to the count field then no
2044 controls were affected. Otherwise all controls before that index were
2045 successful in performing their 'get' or 'set' operation, the control at
2046 the given index failed, and you don't know what happened with the controls
2047 after the failed one. Since if they were part of a control cluster they
2048 could have been successfully processed (if a cluster member was encountered
2049 at index < error_idx), they could have failed (if a cluster member was at
2050 error_idx), or they may not have been processed yet (if the first cluster
2051 member appeared after error_idx).
2053 It is all fairly theoretical, though. In practice all you can do is to
2054 bail out. If error_idx == count, then it is an application bug. If
2055 error_idx < count then it is only an application bug if the error code was
2056 EBUSY. That usually means that something started streaming just when you
2057 tried to set the controls. In all other cases it is a driver/hardware
2058 problem and all you can do is to retry or bail out.
2060 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2061 never modifies controls the error_idx is just set to whatever control
2062 has an invalid value.
2065 /* Prepare for the extended g/s/try functions.
2066 Find the controls in the control array and do some basic checks. */
2067 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2068 struct v4l2_ext_controls *cs,
2069 struct v4l2_ctrl_helper *helpers)
2071 struct v4l2_ctrl_helper *h;
2072 bool have_clusters = false;
2075 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2076 struct v4l2_ext_control *c = &cs->controls[i];
2077 struct v4l2_ctrl_ref *ref;
2078 struct v4l2_ctrl *ctrl;
2079 u32 id = c->id & V4L2_CTRL_ID_MASK;
2083 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2086 /* Old-style private controls are not allowed for
2087 extended controls */
2088 if (id >= V4L2_CID_PRIVATE_BASE)
2090 ref = find_ref_lock(hdl, id);
2094 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2097 if (ctrl->cluster[0]->ncontrols > 1)
2098 have_clusters = true;
2099 if (ctrl->cluster[0] != ctrl)
2100 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2101 /* Store the ref to the master control of the cluster */
2104 /* Initially set next to 0, meaning that there is no other
2105 control in this helper array belonging to the same
2110 /* We are done if there were no controls that belong to a multi-
2115 /* The code below figures out in O(n) time which controls in the list
2116 belong to the same cluster. */
2118 /* This has to be done with the handler lock taken. */
2119 mutex_lock(hdl->lock);
2121 /* First zero the helper field in the master control references */
2122 for (i = 0; i < cs->count; i++)
2123 helpers[i].mref->helper = 0;
2124 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2125 struct v4l2_ctrl_ref *mref = h->mref;
2127 /* If the mref->helper is set, then it points to an earlier
2128 helper that belongs to the same cluster. */
2130 /* Set the next field of mref->helper to the current
2131 index: this means that that earlier helper now
2132 points to the next helper in the same cluster. */
2133 mref->helper->next = i;
2134 /* mref should be set only for the first helper in the
2135 cluster, clear the others. */
2138 /* Point the mref helper to the current helper struct. */
2141 mutex_unlock(hdl->lock);
2145 /* Handles the corner case where cs->count == 0. It checks whether the
2146 specified control class exists. If that class ID is 0, then it checks
2147 whether there are any controls at all. */
2148 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2150 if (ctrl_class == 0)
2151 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2152 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2157 /* Get extended controls. Allocates the helpers array if needed. */
2158 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2160 struct v4l2_ctrl_helper helper[4];
2161 struct v4l2_ctrl_helper *helpers = helper;
2165 cs->error_idx = cs->count;
2166 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2172 return class_check(hdl, cs->ctrl_class);
2174 if (cs->count > ARRAY_SIZE(helper)) {
2175 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2177 if (helpers == NULL)
2181 ret = prepare_ext_ctrls(hdl, cs, helpers);
2182 cs->error_idx = cs->count;
2184 for (i = 0; !ret && i < cs->count; i++)
2185 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2188 for (i = 0; !ret && i < cs->count; i++) {
2189 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2190 struct v4l2_ctrl *ctrl) = cur_to_user;
2191 struct v4l2_ctrl *master;
2193 if (helpers[i].mref == NULL)
2196 master = helpers[i].mref->ctrl;
2199 v4l2_ctrl_lock(master);
2201 /* g_volatile_ctrl will update the new control values */
2202 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2203 (master->has_volatiles && !is_cur_manual(master))) {
2204 for (j = 0; j < master->ncontrols; j++)
2205 cur_to_new(master->cluster[j]);
2206 ret = call_op(master, g_volatile_ctrl);
2207 ctrl_to_user = new_to_user;
2209 /* If OK, then copy the current (for non-volatile controls)
2210 or the new (for volatile controls) control values to the
2216 ret = ctrl_to_user(cs->controls + idx,
2218 idx = helpers[idx].next;
2219 } while (!ret && idx);
2221 v4l2_ctrl_unlock(master);
2224 if (cs->count > ARRAY_SIZE(helper))
2228 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2230 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2232 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2234 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2236 /* Helper function to get a single control */
2237 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2239 struct v4l2_ctrl *master = ctrl->cluster[0];
2243 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2246 v4l2_ctrl_lock(master);
2247 /* g_volatile_ctrl will update the current control values */
2248 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2249 for (i = 0; i < master->ncontrols; i++)
2250 cur_to_new(master->cluster[i]);
2251 ret = call_op(master, g_volatile_ctrl);
2254 *val = ctrl->cur.val;
2256 v4l2_ctrl_unlock(master);
2260 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2262 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2264 if (ctrl == NULL || !type_is_int(ctrl))
2266 return get_ctrl(ctrl, &control->value);
2268 EXPORT_SYMBOL(v4l2_g_ctrl);
2270 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2272 return v4l2_g_ctrl(sd->ctrl_handler, control);
2274 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2276 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2280 /* It's a driver bug if this happens. */
2281 WARN_ON(!type_is_int(ctrl));
2282 get_ctrl(ctrl, &val);
2285 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2288 /* Core function that calls try/s_ctrl and ensures that the new value is
2289 copied to the current value on a set.
2290 Must be called with ctrl->handler->lock held. */
2291 static int try_or_set_cluster(struct v4l2_fh *fh,
2292 struct v4l2_ctrl *master, bool set)
2298 /* Go through the cluster and either validate the new value or
2299 (if no new value was set), copy the current value to the new
2300 value, ensuring a consistent view for the control ops when
2302 for (i = 0; i < master->ncontrols; i++) {
2303 struct v4l2_ctrl *ctrl = master->cluster[i];
2308 if (!ctrl->is_new) {
2312 /* Check again: it may have changed since the
2313 previous check in try_or_set_ext_ctrls(). */
2314 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2318 ret = call_op(master, try_ctrl);
2320 /* Don't set if there is no change */
2321 if (ret || !set || !cluster_changed(master))
2323 ret = call_op(master, s_ctrl);
2327 /* If OK, then make the new values permanent. */
2328 update_flag = is_cur_manual(master) != is_new_manual(master);
2329 for (i = 0; i < master->ncontrols; i++)
2330 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
2334 /* Validate controls. */
2335 static int validate_ctrls(struct v4l2_ext_controls *cs,
2336 struct v4l2_ctrl_helper *helpers, bool set)
2341 cs->error_idx = cs->count;
2342 for (i = 0; i < cs->count; i++) {
2343 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2347 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2349 /* This test is also done in try_set_control_cluster() which
2350 is called in atomic context, so that has the final say,
2351 but it makes sense to do an up-front check as well. Once
2352 an error occurs in try_set_control_cluster() some other
2353 controls may have been set already and we want to do a
2354 best-effort to avoid that. */
2355 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2357 ret = validate_new(ctrl, &cs->controls[i]);
2364 /* Obtain the current volatile values of an autocluster and mark them
2366 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2370 for (i = 0; i < master->ncontrols; i++)
2371 cur_to_new(master->cluster[i]);
2372 if (!call_op(master, g_volatile_ctrl))
2373 for (i = 1; i < master->ncontrols; i++)
2374 if (master->cluster[i])
2375 master->cluster[i]->is_new = 1;
2378 /* Try or try-and-set controls */
2379 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2380 struct v4l2_ext_controls *cs,
2383 struct v4l2_ctrl_helper helper[4];
2384 struct v4l2_ctrl_helper *helpers = helper;
2388 cs->error_idx = cs->count;
2389 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2395 return class_check(hdl, cs->ctrl_class);
2397 if (cs->count > ARRAY_SIZE(helper)) {
2398 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2403 ret = prepare_ext_ctrls(hdl, cs, helpers);
2405 ret = validate_ctrls(cs, helpers, set);
2407 cs->error_idx = cs->count;
2408 for (i = 0; !ret && i < cs->count; i++) {
2409 struct v4l2_ctrl *master;
2412 if (helpers[i].mref == NULL)
2416 master = helpers[i].mref->ctrl;
2417 v4l2_ctrl_lock(master);
2419 /* Reset the 'is_new' flags of the cluster */
2420 for (j = 0; j < master->ncontrols; j++)
2421 if (master->cluster[j])
2422 master->cluster[j]->is_new = 0;
2424 /* For volatile autoclusters that are currently in auto mode
2425 we need to discover if it will be set to manual mode.
2426 If so, then we have to copy the current volatile values
2427 first since those will become the new manual values (which
2428 may be overwritten by explicit new values from this set
2430 if (master->is_auto && master->has_volatiles &&
2431 !is_cur_manual(master)) {
2432 /* Pick an initial non-manual value */
2433 s32 new_auto_val = master->manual_mode_value + 1;
2437 /* Check if the auto control is part of the
2438 list, and remember the new value. */
2439 if (helpers[tmp_idx].ctrl == master)
2440 new_auto_val = cs->controls[tmp_idx].value;
2441 tmp_idx = helpers[tmp_idx].next;
2443 /* If the new value == the manual value, then copy
2444 the current volatile values. */
2445 if (new_auto_val == master->manual_mode_value)
2446 update_from_auto_cluster(master);
2449 /* Copy the new caller-supplied control values.
2450 user_to_new() sets 'is_new' to 1. */
2452 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2453 idx = helpers[idx].next;
2454 } while (!ret && idx);
2457 ret = try_or_set_cluster(fh, master, set);
2459 /* Copy the new values back to userspace. */
2463 ret = new_to_user(cs->controls + idx,
2465 idx = helpers[idx].next;
2466 } while (!ret && idx);
2468 v4l2_ctrl_unlock(master);
2471 if (cs->count > ARRAY_SIZE(helper))
2476 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2478 return try_set_ext_ctrls(NULL, hdl, cs, false);
2480 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2482 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2483 struct v4l2_ext_controls *cs)
2485 return try_set_ext_ctrls(fh, hdl, cs, true);
2487 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2489 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2491 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2493 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2495 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2497 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2499 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2501 /* Helper function for VIDIOC_S_CTRL compatibility */
2502 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
2504 struct v4l2_ctrl *master = ctrl->cluster[0];
2508 ret = validate_new_int(ctrl, val);
2512 v4l2_ctrl_lock(ctrl);
2514 /* Reset the 'is_new' flags of the cluster */
2515 for (i = 0; i < master->ncontrols; i++)
2516 if (master->cluster[i])
2517 master->cluster[i]->is_new = 0;
2519 /* For autoclusters with volatiles that are switched from auto to
2520 manual mode we have to update the current volatile values since
2521 those will become the initial manual values after such a switch. */
2522 if (master->is_auto && master->has_volatiles && ctrl == master &&
2523 !is_cur_manual(master) && *val == master->manual_mode_value)
2524 update_from_auto_cluster(master);
2527 ret = try_or_set_cluster(fh, master, true);
2528 *val = ctrl->cur.val;
2529 v4l2_ctrl_unlock(ctrl);
2533 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2534 struct v4l2_control *control)
2536 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2538 if (ctrl == NULL || !type_is_int(ctrl))
2541 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2544 return set_ctrl(fh, ctrl, &control->value);
2546 EXPORT_SYMBOL(v4l2_s_ctrl);
2548 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2550 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2552 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2554 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2556 /* It's a driver bug if this happens. */
2557 WARN_ON(!type_is_int(ctrl));
2558 return set_ctrl(NULL, ctrl, &val);
2560 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2562 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
2564 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2569 v4l2_ctrl_lock(ctrl);
2570 list_add_tail(&sev->node, &ctrl->ev_subs);
2571 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2572 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2573 struct v4l2_event ev;
2574 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2576 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2577 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2578 fill_event(&ev, ctrl, changes);
2579 /* Mark the queue as active, allowing this initial
2580 event to be accepted. */
2582 v4l2_event_queue_fh(sev->fh, &ev);
2584 v4l2_ctrl_unlock(ctrl);
2588 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
2590 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2592 v4l2_ctrl_lock(ctrl);
2593 list_del(&sev->node);
2594 v4l2_ctrl_unlock(ctrl);
2597 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2599 u32 old_changes = old->u.ctrl.changes;
2601 old->u.ctrl = new->u.ctrl;
2602 old->u.ctrl.changes |= old_changes;
2604 EXPORT_SYMBOL(v4l2_ctrl_replace);
2606 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2608 new->u.ctrl.changes |= old->u.ctrl.changes;
2610 EXPORT_SYMBOL(v4l2_ctrl_merge);
2612 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2613 .add = v4l2_ctrl_add_event,
2614 .del = v4l2_ctrl_del_event,
2615 .replace = v4l2_ctrl_replace,
2616 .merge = v4l2_ctrl_merge,
2618 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
2620 int v4l2_ctrl_log_status(struct file *file, void *fh)
2622 struct video_device *vfd = video_devdata(file);
2623 struct v4l2_fh *vfh = file->private_data;
2625 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2626 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2627 vfd->v4l2_dev->name);
2630 EXPORT_SYMBOL(v4l2_ctrl_log_status);
2632 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2633 struct v4l2_event_subscription *sub)
2635 if (sub->type == V4L2_EVENT_CTRL)
2636 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
2639 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2641 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2643 struct v4l2_fh *fh = file->private_data;
2645 if (v4l2_event_pending(fh))
2647 poll_wait(file, &fh->wait, wait);
2650 EXPORT_SYMBOL(v4l2_ctrl_poll);