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 <media/v4l2-ioctl.h>
24 #include <media/v4l2-device.h>
25 #include <media/v4l2-ctrls.h>
26 #include <media/v4l2-event.h>
27 #include <media/v4l2-dev.h>
29 #define has_op(master, op) \
30 (master->ops && master->ops->op)
31 #define call_op(master, op) \
32 (has_op(master, op) ? master->ops->op(master) : 0)
34 /* Internal temporary helper struct, one for each v4l2_ext_control */
35 struct v4l2_ctrl_helper {
36 /* Pointer to the control reference of the master control */
37 struct v4l2_ctrl_ref *mref;
38 /* The control corresponding to the v4l2_ext_control ID field. */
39 struct v4l2_ctrl *ctrl;
40 /* v4l2_ext_control index of the next control belonging to the
41 same cluster, or 0 if there isn't any. */
45 /* Small helper function to determine if the autocluster is set to manual
47 static bool is_cur_manual(const struct v4l2_ctrl *master)
49 return master->is_auto && master->cur.val == master->manual_mode_value;
52 /* Same as above, but this checks the against the new value instead of the
54 static bool is_new_manual(const struct v4l2_ctrl *master)
56 return master->is_auto && master->val == master->manual_mode_value;
59 /* Returns NULL or a character pointer array containing the menu for
60 the given control ID. The pointer array ends with a NULL pointer.
61 An empty string signifies a menu entry that is invalid. This allows
62 drivers to disable certain options if it is not supported. */
63 const char * const *v4l2_ctrl_get_menu(u32 id)
65 static const char * const mpeg_audio_sampling_freq[] = {
71 static const char * const mpeg_audio_encoding[] = {
79 static const char * const mpeg_audio_l1_bitrate[] = {
96 static const char * const mpeg_audio_l2_bitrate[] = {
113 static const char * const mpeg_audio_l3_bitrate[] = {
130 static const char * const mpeg_audio_ac3_bitrate[] = {
152 static const char * const mpeg_audio_mode[] = {
159 static const char * const mpeg_audio_mode_extension[] = {
166 static const char * const mpeg_audio_emphasis[] = {
172 static const char * const mpeg_audio_crc[] = {
177 static const char * const mpeg_video_encoding[] = {
183 static const char * const mpeg_video_aspect[] = {
190 static const char * const mpeg_video_bitrate_mode[] = {
195 static const char * const mpeg_stream_type[] = {
196 "MPEG-2 Program Stream",
197 "MPEG-2 Transport Stream",
198 "MPEG-1 System Stream",
199 "MPEG-2 DVD-compatible Stream",
200 "MPEG-1 VCD-compatible Stream",
201 "MPEG-2 SVCD-compatible Stream",
204 static const char * const mpeg_stream_vbi_fmt[] = {
206 "Private Packet, IVTV Format",
209 static const char * const camera_power_line_frequency[] = {
216 static const char * const camera_exposure_auto[] = {
219 "Shutter Priority Mode",
220 "Aperture Priority Mode",
223 static const char * const colorfx[] = {
236 static const char * const tune_preemphasis[] = {
242 static const char * const header_mode[] = {
244 "Joined With 1st Frame",
247 static const char * const multi_slice[] = {
253 static const char * const entropy_mode[] = {
258 static const char * const mpeg_h264_level[] = {
277 static const char * const h264_loop_filter[] = {
280 "Disabled at Slice Boundary",
283 static const char * const h264_profile[] = {
285 "Constrained Baseline",
291 "High 444 Predictive",
298 "Scalable High Intra",
302 static const char * const vui_sar_idc[] = {
323 static const char * const mpeg_mpeg4_level[] = {
334 static const char * const mpeg4_profile[] = {
339 "Advanced Coding Efficency",
343 static const char * const flash_led_mode[] = {
349 static const char * const flash_strobe_source[] = {
356 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
357 return mpeg_audio_sampling_freq;
358 case V4L2_CID_MPEG_AUDIO_ENCODING:
359 return mpeg_audio_encoding;
360 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
361 return mpeg_audio_l1_bitrate;
362 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
363 return mpeg_audio_l2_bitrate;
364 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
365 return mpeg_audio_l3_bitrate;
366 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
367 return mpeg_audio_ac3_bitrate;
368 case V4L2_CID_MPEG_AUDIO_MODE:
369 return mpeg_audio_mode;
370 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
371 return mpeg_audio_mode_extension;
372 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
373 return mpeg_audio_emphasis;
374 case V4L2_CID_MPEG_AUDIO_CRC:
375 return mpeg_audio_crc;
376 case V4L2_CID_MPEG_VIDEO_ENCODING:
377 return mpeg_video_encoding;
378 case V4L2_CID_MPEG_VIDEO_ASPECT:
379 return mpeg_video_aspect;
380 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
381 return mpeg_video_bitrate_mode;
382 case V4L2_CID_MPEG_STREAM_TYPE:
383 return mpeg_stream_type;
384 case V4L2_CID_MPEG_STREAM_VBI_FMT:
385 return mpeg_stream_vbi_fmt;
386 case V4L2_CID_POWER_LINE_FREQUENCY:
387 return camera_power_line_frequency;
388 case V4L2_CID_EXPOSURE_AUTO:
389 return camera_exposure_auto;
390 case V4L2_CID_COLORFX:
392 case V4L2_CID_TUNE_PREEMPHASIS:
393 return tune_preemphasis;
394 case V4L2_CID_FLASH_LED_MODE:
395 return flash_led_mode;
396 case V4L2_CID_FLASH_STROBE_SOURCE:
397 return flash_strobe_source;
398 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
400 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
402 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
404 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
405 return mpeg_h264_level;
406 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
407 return h264_loop_filter;
408 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
410 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
412 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
413 return mpeg_mpeg4_level;
414 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
415 return mpeg4_profile;
420 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
422 /* Return the control name. */
423 const char *v4l2_ctrl_get_name(u32 id)
427 /* Keep the order of the 'case's the same as in videodev2.h! */
428 case V4L2_CID_USER_CLASS: return "User Controls";
429 case V4L2_CID_BRIGHTNESS: return "Brightness";
430 case V4L2_CID_CONTRAST: return "Contrast";
431 case V4L2_CID_SATURATION: return "Saturation";
432 case V4L2_CID_HUE: return "Hue";
433 case V4L2_CID_AUDIO_VOLUME: return "Volume";
434 case V4L2_CID_AUDIO_BALANCE: return "Balance";
435 case V4L2_CID_AUDIO_BASS: return "Bass";
436 case V4L2_CID_AUDIO_TREBLE: return "Treble";
437 case V4L2_CID_AUDIO_MUTE: return "Mute";
438 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
439 case V4L2_CID_BLACK_LEVEL: return "Black Level";
440 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
441 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
442 case V4L2_CID_RED_BALANCE: return "Red Balance";
443 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
444 case V4L2_CID_GAMMA: return "Gamma";
445 case V4L2_CID_EXPOSURE: return "Exposure";
446 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
447 case V4L2_CID_GAIN: return "Gain";
448 case V4L2_CID_HFLIP: return "Horizontal Flip";
449 case V4L2_CID_VFLIP: return "Vertical Flip";
450 case V4L2_CID_HCENTER: return "Horizontal Center";
451 case V4L2_CID_VCENTER: return "Vertical Center";
452 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
453 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
454 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
455 case V4L2_CID_SHARPNESS: return "Sharpness";
456 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
457 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
458 case V4L2_CID_COLOR_KILLER: return "Color Killer";
459 case V4L2_CID_COLORFX: return "Color Effects";
460 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
461 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
462 case V4L2_CID_ROTATE: return "Rotate";
463 case V4L2_CID_BG_COLOR: return "Background Color";
464 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
465 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
466 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
467 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Minimum Number of Capture Buffers";
468 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Minimum Number of Output Buffers";
471 /* Keep the order of the 'case's the same as in videodev2.h! */
472 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
473 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
474 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
475 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
476 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
477 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
478 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
479 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
480 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
481 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
482 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
483 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
484 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
485 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
486 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
487 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
488 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
489 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
490 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
491 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
492 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
493 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
494 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
495 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
496 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
497 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
498 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
499 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
500 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
501 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
502 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
503 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
504 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
505 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
506 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
507 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "The Number of Intra Refresh MBs";
508 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
509 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
510 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
511 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "The Max Number of Reference Picture";
512 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
513 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P frame QP Value";
514 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B frame QP Value";
515 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
516 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
517 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
518 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P frame QP Value";
519 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B frame QP Value";
520 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
521 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
522 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
523 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
524 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entorpy Mode";
525 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I Period";
526 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
527 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
528 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
529 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
530 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
531 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
532 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
533 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
534 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
535 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
536 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P frame QP Value";
537 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B frame QP Value";
538 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
539 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
540 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
541 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
542 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
543 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "The Maximum Bytes Per Slice";
544 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "The Number of MB in a Slice";
545 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "The Slice Partitioning Method";
546 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
548 /* CAMERA controls */
549 /* Keep the order of the 'case's the same as in videodev2.h! */
550 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
551 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
552 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
553 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
554 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
555 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
556 case V4L2_CID_PAN_RESET: return "Pan, Reset";
557 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
558 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
559 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
560 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
561 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
562 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
563 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
564 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
565 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
566 case V4L2_CID_PRIVACY: return "Privacy";
567 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
568 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
570 /* FM Radio Modulator control */
571 /* Keep the order of the 'case's the same as in videodev2.h! */
572 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
573 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
574 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
575 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
576 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
577 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
578 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
579 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
580 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
581 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Feature Enabled";
582 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
583 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
584 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
585 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
586 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
587 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
588 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
589 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-emphasis settings";
590 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
591 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
594 case V4L2_CID_FLASH_CLASS: return "Flash controls";
595 case V4L2_CID_FLASH_LED_MODE: return "LED mode";
596 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe source";
597 case V4L2_CID_FLASH_STROBE: return "Strobe";
598 case V4L2_CID_FLASH_STROBE_STOP: return "Stop strobe";
599 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe status";
600 case V4L2_CID_FLASH_TIMEOUT: return "Strobe timeout";
601 case V4L2_CID_FLASH_INTENSITY: return "Intensity, flash mode";
602 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, torch mode";
603 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, indicator";
604 case V4L2_CID_FLASH_FAULT: return "Faults";
605 case V4L2_CID_FLASH_CHARGE: return "Charge";
606 case V4L2_CID_FLASH_READY: return "Ready to strobe";
612 EXPORT_SYMBOL(v4l2_ctrl_get_name);
614 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
615 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
617 *name = v4l2_ctrl_get_name(id);
621 case V4L2_CID_AUDIO_MUTE:
622 case V4L2_CID_AUDIO_LOUDNESS:
623 case V4L2_CID_AUTO_WHITE_BALANCE:
624 case V4L2_CID_AUTOGAIN:
627 case V4L2_CID_HUE_AUTO:
628 case V4L2_CID_CHROMA_AGC:
629 case V4L2_CID_COLOR_KILLER:
630 case V4L2_CID_MPEG_AUDIO_MUTE:
631 case V4L2_CID_MPEG_VIDEO_MUTE:
632 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
633 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
634 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
635 case V4L2_CID_FOCUS_AUTO:
636 case V4L2_CID_PRIVACY:
637 case V4L2_CID_AUDIO_LIMITER_ENABLED:
638 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
639 case V4L2_CID_PILOT_TONE_ENABLED:
640 case V4L2_CID_ILLUMINATORS_1:
641 case V4L2_CID_ILLUMINATORS_2:
642 case V4L2_CID_FLASH_STROBE_STATUS:
643 case V4L2_CID_FLASH_CHARGE:
644 case V4L2_CID_FLASH_READY:
645 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
646 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
647 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
648 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
649 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
650 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
651 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
652 *type = V4L2_CTRL_TYPE_BOOLEAN;
656 case V4L2_CID_PAN_RESET:
657 case V4L2_CID_TILT_RESET:
658 case V4L2_CID_FLASH_STROBE:
659 case V4L2_CID_FLASH_STROBE_STOP:
660 *type = V4L2_CTRL_TYPE_BUTTON;
661 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
662 *min = *max = *step = *def = 0;
664 case V4L2_CID_POWER_LINE_FREQUENCY:
665 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
666 case V4L2_CID_MPEG_AUDIO_ENCODING:
667 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
668 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
669 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
670 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
671 case V4L2_CID_MPEG_AUDIO_MODE:
672 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
673 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
674 case V4L2_CID_MPEG_AUDIO_CRC:
675 case V4L2_CID_MPEG_VIDEO_ENCODING:
676 case V4L2_CID_MPEG_VIDEO_ASPECT:
677 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
678 case V4L2_CID_MPEG_STREAM_TYPE:
679 case V4L2_CID_MPEG_STREAM_VBI_FMT:
680 case V4L2_CID_EXPOSURE_AUTO:
681 case V4L2_CID_COLORFX:
682 case V4L2_CID_TUNE_PREEMPHASIS:
683 case V4L2_CID_FLASH_LED_MODE:
684 case V4L2_CID_FLASH_STROBE_SOURCE:
685 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
686 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
687 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
688 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
689 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
690 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
691 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
692 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
693 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
694 *type = V4L2_CTRL_TYPE_MENU;
696 case V4L2_CID_RDS_TX_PS_NAME:
697 case V4L2_CID_RDS_TX_RADIO_TEXT:
698 *type = V4L2_CTRL_TYPE_STRING;
700 case V4L2_CID_USER_CLASS:
701 case V4L2_CID_CAMERA_CLASS:
702 case V4L2_CID_MPEG_CLASS:
703 case V4L2_CID_FM_TX_CLASS:
704 case V4L2_CID_FLASH_CLASS:
705 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
706 /* You can neither read not write these */
707 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
708 *min = *max = *step = *def = 0;
710 case V4L2_CID_BG_COLOR:
711 *type = V4L2_CTRL_TYPE_INTEGER;
714 /* Max is calculated as RGB888 that is 2^24 */
717 case V4L2_CID_FLASH_FAULT:
718 *type = V4L2_CTRL_TYPE_BITMASK;
720 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
721 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
722 *type = V4L2_CTRL_TYPE_INTEGER;
723 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
726 *type = V4L2_CTRL_TYPE_INTEGER;
730 case V4L2_CID_MPEG_AUDIO_ENCODING:
731 case V4L2_CID_MPEG_AUDIO_MODE:
732 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
733 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
734 case V4L2_CID_MPEG_STREAM_TYPE:
735 *flags |= V4L2_CTRL_FLAG_UPDATE;
737 case V4L2_CID_AUDIO_VOLUME:
738 case V4L2_CID_AUDIO_BALANCE:
739 case V4L2_CID_AUDIO_BASS:
740 case V4L2_CID_AUDIO_TREBLE:
741 case V4L2_CID_BRIGHTNESS:
742 case V4L2_CID_CONTRAST:
743 case V4L2_CID_SATURATION:
745 case V4L2_CID_RED_BALANCE:
746 case V4L2_CID_BLUE_BALANCE:
748 case V4L2_CID_SHARPNESS:
749 case V4L2_CID_CHROMA_GAIN:
750 case V4L2_CID_RDS_TX_DEVIATION:
751 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
752 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
753 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
754 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
755 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
756 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
757 case V4L2_CID_PILOT_TONE_DEVIATION:
758 case V4L2_CID_PILOT_TONE_FREQUENCY:
759 case V4L2_CID_TUNE_POWER_LEVEL:
760 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
761 *flags |= V4L2_CTRL_FLAG_SLIDER;
763 case V4L2_CID_PAN_RELATIVE:
764 case V4L2_CID_TILT_RELATIVE:
765 case V4L2_CID_FOCUS_RELATIVE:
766 case V4L2_CID_IRIS_RELATIVE:
767 case V4L2_CID_ZOOM_RELATIVE:
768 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
770 case V4L2_CID_FLASH_STROBE_STATUS:
771 case V4L2_CID_FLASH_READY:
772 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
776 EXPORT_SYMBOL(v4l2_ctrl_fill);
778 /* Helper function to determine whether the control type is compatible with
780 static bool type_is_int(const struct v4l2_ctrl *ctrl)
782 switch (ctrl->type) {
783 case V4L2_CTRL_TYPE_INTEGER64:
784 case V4L2_CTRL_TYPE_STRING:
785 /* Nope, these need v4l2_ext_control */
792 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
794 memset(ev->reserved, 0, sizeof(ev->reserved));
795 ev->type = V4L2_EVENT_CTRL;
797 ev->u.ctrl.changes = changes;
798 ev->u.ctrl.type = ctrl->type;
799 ev->u.ctrl.flags = ctrl->flags;
800 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
801 ev->u.ctrl.value64 = 0;
803 ev->u.ctrl.value64 = ctrl->cur.val64;
804 ev->u.ctrl.minimum = ctrl->minimum;
805 ev->u.ctrl.maximum = ctrl->maximum;
806 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
809 ev->u.ctrl.step = ctrl->step;
810 ev->u.ctrl.default_value = ctrl->default_value;
813 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
815 struct v4l2_event ev;
816 struct v4l2_subscribed_event *sev;
818 if (list_empty(&ctrl->ev_subs))
820 fill_event(&ev, ctrl, changes);
822 list_for_each_entry(sev, &ctrl->ev_subs, node)
824 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
825 v4l2_event_queue_fh(sev->fh, &ev);
828 /* Helper function: copy the current control value back to the caller */
829 static int cur_to_user(struct v4l2_ext_control *c,
830 struct v4l2_ctrl *ctrl)
834 switch (ctrl->type) {
835 case V4L2_CTRL_TYPE_STRING:
836 len = strlen(ctrl->cur.string);
837 if (c->size < len + 1) {
841 return copy_to_user(c->string, ctrl->cur.string,
842 len + 1) ? -EFAULT : 0;
843 case V4L2_CTRL_TYPE_INTEGER64:
844 c->value64 = ctrl->cur.val64;
847 c->value = ctrl->cur.val;
853 /* Helper function: copy the caller-provider value as the new control value */
854 static int user_to_new(struct v4l2_ext_control *c,
855 struct v4l2_ctrl *ctrl)
861 switch (ctrl->type) {
862 case V4L2_CTRL_TYPE_INTEGER64:
863 ctrl->val64 = c->value64;
865 case V4L2_CTRL_TYPE_STRING:
869 if (size > ctrl->maximum + 1)
870 size = ctrl->maximum + 1;
871 ret = copy_from_user(ctrl->string, c->string, size);
873 char last = ctrl->string[size - 1];
875 ctrl->string[size - 1] = 0;
876 /* If the string was longer than ctrl->maximum,
877 then return an error. */
878 if (strlen(ctrl->string) == ctrl->maximum && last)
881 return ret ? -EFAULT : 0;
883 ctrl->val = c->value;
889 /* Helper function: copy the new control value back to the caller */
890 static int new_to_user(struct v4l2_ext_control *c,
891 struct v4l2_ctrl *ctrl)
895 switch (ctrl->type) {
896 case V4L2_CTRL_TYPE_STRING:
897 len = strlen(ctrl->string);
898 if (c->size < len + 1) {
899 c->size = ctrl->maximum + 1;
902 return copy_to_user(c->string, ctrl->string,
903 len + 1) ? -EFAULT : 0;
904 case V4L2_CTRL_TYPE_INTEGER64:
905 c->value64 = ctrl->val64;
908 c->value = ctrl->val;
914 /* Copy the new value to the current value. */
915 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
916 bool update_inactive)
918 bool changed = false;
922 switch (ctrl->type) {
923 case V4L2_CTRL_TYPE_BUTTON:
926 case V4L2_CTRL_TYPE_STRING:
927 /* strings are always 0-terminated */
928 changed = strcmp(ctrl->string, ctrl->cur.string);
929 strcpy(ctrl->cur.string, ctrl->string);
931 case V4L2_CTRL_TYPE_INTEGER64:
932 changed = ctrl->val64 != ctrl->cur.val64;
933 ctrl->cur.val64 = ctrl->val64;
936 changed = ctrl->val != ctrl->cur.val;
937 ctrl->cur.val = ctrl->val;
940 if (update_inactive) {
941 /* Note: update_inactive can only be true for auto clusters. */
943 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
944 if (!is_cur_manual(ctrl->cluster[0])) {
945 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
946 if (ctrl->cluster[0]->has_volatiles)
947 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
950 if (changed || update_inactive) {
951 /* If a control was changed that was not one of the controls
952 modified by the application, then send the event to all. */
956 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
957 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
961 /* Copy the current value to the new value */
962 static void cur_to_new(struct v4l2_ctrl *ctrl)
966 switch (ctrl->type) {
967 case V4L2_CTRL_TYPE_STRING:
968 /* strings are always 0-terminated */
969 strcpy(ctrl->string, ctrl->cur.string);
971 case V4L2_CTRL_TYPE_INTEGER64:
972 ctrl->val64 = ctrl->cur.val64;
975 ctrl->val = ctrl->cur.val;
980 /* Return non-zero if one or more of the controls in the cluster has a new
981 value that differs from the current value. */
982 static int cluster_changed(struct v4l2_ctrl *master)
987 for (i = 0; !diff && i < master->ncontrols; i++) {
988 struct v4l2_ctrl *ctrl = master->cluster[i];
992 switch (ctrl->type) {
993 case V4L2_CTRL_TYPE_BUTTON:
994 /* Button controls are always 'different' */
996 case V4L2_CTRL_TYPE_STRING:
997 /* strings are always 0-terminated */
998 diff = strcmp(ctrl->string, ctrl->cur.string);
1000 case V4L2_CTRL_TYPE_INTEGER64:
1001 diff = ctrl->val64 != ctrl->cur.val64;
1004 diff = ctrl->val != ctrl->cur.val;
1011 /* Validate integer-type control */
1012 static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
1017 switch (ctrl->type) {
1018 case V4L2_CTRL_TYPE_INTEGER:
1019 /* Round towards the closest legal value */
1020 val += ctrl->step / 2;
1021 if (val < ctrl->minimum)
1022 val = ctrl->minimum;
1023 if (val > ctrl->maximum)
1024 val = ctrl->maximum;
1025 offset = val - ctrl->minimum;
1026 offset = ctrl->step * (offset / ctrl->step);
1027 val = ctrl->minimum + offset;
1031 case V4L2_CTRL_TYPE_BOOLEAN:
1035 case V4L2_CTRL_TYPE_MENU:
1036 if (val < ctrl->minimum || val > ctrl->maximum)
1038 if (ctrl->qmenu[val][0] == '\0' ||
1039 (ctrl->menu_skip_mask & (1 << val)))
1043 case V4L2_CTRL_TYPE_BITMASK:
1044 *pval &= ctrl->maximum;
1047 case V4L2_CTRL_TYPE_BUTTON:
1048 case V4L2_CTRL_TYPE_CTRL_CLASS:
1057 /* Validate a new control */
1058 static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1060 char *s = c->string;
1063 switch (ctrl->type) {
1064 case V4L2_CTRL_TYPE_INTEGER:
1065 case V4L2_CTRL_TYPE_BOOLEAN:
1066 case V4L2_CTRL_TYPE_MENU:
1067 case V4L2_CTRL_TYPE_BITMASK:
1068 case V4L2_CTRL_TYPE_BUTTON:
1069 case V4L2_CTRL_TYPE_CTRL_CLASS:
1070 return validate_new_int(ctrl, &c->value);
1072 case V4L2_CTRL_TYPE_INTEGER64:
1075 case V4L2_CTRL_TYPE_STRING:
1077 if (len < ctrl->minimum)
1079 if ((len - ctrl->minimum) % ctrl->step)
1088 static inline u32 node2id(struct list_head *node)
1090 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1093 /* Set the handler's error code if it wasn't set earlier already */
1094 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1096 if (hdl->error == 0)
1101 /* Initialize the handler */
1102 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1103 unsigned nr_of_controls_hint)
1105 mutex_init(&hdl->lock);
1106 INIT_LIST_HEAD(&hdl->ctrls);
1107 INIT_LIST_HEAD(&hdl->ctrl_refs);
1108 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1109 hdl->buckets = kzalloc(sizeof(hdl->buckets[0]) * hdl->nr_of_buckets,
1111 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1114 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1116 /* Free all controls and control refs */
1117 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1119 struct v4l2_ctrl_ref *ref, *next_ref;
1120 struct v4l2_ctrl *ctrl, *next_ctrl;
1121 struct v4l2_subscribed_event *sev, *next_sev;
1123 if (hdl == NULL || hdl->buckets == NULL)
1126 mutex_lock(&hdl->lock);
1127 /* Free all nodes */
1128 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1129 list_del(&ref->node);
1132 /* Free all controls owned by the handler */
1133 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1134 list_del(&ctrl->node);
1135 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1136 list_del(&sev->node);
1139 kfree(hdl->buckets);
1140 hdl->buckets = NULL;
1143 mutex_unlock(&hdl->lock);
1145 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1147 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1148 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1149 with applications that do not use the NEXT_CTRL flag.
1151 We just find the n-th private user control. It's O(N), but that should not
1152 be an issue in this particular case. */
1153 static struct v4l2_ctrl_ref *find_private_ref(
1154 struct v4l2_ctrl_handler *hdl, u32 id)
1156 struct v4l2_ctrl_ref *ref;
1158 id -= V4L2_CID_PRIVATE_BASE;
1159 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1160 /* Search for private user controls that are compatible with
1162 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1163 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1164 if (!type_is_int(ref->ctrl))
1174 /* Find a control with the given ID. */
1175 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1177 struct v4l2_ctrl_ref *ref;
1180 id &= V4L2_CTRL_ID_MASK;
1182 /* Old-style private controls need special handling */
1183 if (id >= V4L2_CID_PRIVATE_BASE)
1184 return find_private_ref(hdl, id);
1185 bucket = id % hdl->nr_of_buckets;
1187 /* Simple optimization: cache the last control found */
1188 if (hdl->cached && hdl->cached->ctrl->id == id)
1191 /* Not in cache, search the hash */
1192 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1193 while (ref && ref->ctrl->id != id)
1197 hdl->cached = ref; /* cache it! */
1201 /* Find a control with the given ID. Take the handler's lock first. */
1202 static struct v4l2_ctrl_ref *find_ref_lock(
1203 struct v4l2_ctrl_handler *hdl, u32 id)
1205 struct v4l2_ctrl_ref *ref = NULL;
1208 mutex_lock(&hdl->lock);
1209 ref = find_ref(hdl, id);
1210 mutex_unlock(&hdl->lock);
1215 /* Find a control with the given ID. */
1216 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1218 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1220 return ref ? ref->ctrl : NULL;
1222 EXPORT_SYMBOL(v4l2_ctrl_find);
1224 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1225 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1226 struct v4l2_ctrl *ctrl)
1228 struct v4l2_ctrl_ref *ref;
1229 struct v4l2_ctrl_ref *new_ref;
1231 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1232 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1234 /* Automatically add the control class if it is not yet present. */
1235 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1236 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1242 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1244 return handler_set_err(hdl, -ENOMEM);
1245 new_ref->ctrl = ctrl;
1246 if (ctrl->handler == hdl) {
1247 /* By default each control starts in a cluster of its own.
1248 new_ref->ctrl is basically a cluster array with one
1249 element, so that's perfect to use as the cluster pointer.
1250 But only do this for the handler that owns the control. */
1251 ctrl->cluster = &new_ref->ctrl;
1252 ctrl->ncontrols = 1;
1255 INIT_LIST_HEAD(&new_ref->node);
1257 mutex_lock(&hdl->lock);
1259 /* Add immediately at the end of the list if the list is empty, or if
1260 the last element in the list has a lower ID.
1261 This ensures that when elements are added in ascending order the
1262 insertion is an O(1) operation. */
1263 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1264 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1265 goto insert_in_hash;
1268 /* Find insert position in sorted list */
1269 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1270 if (ref->ctrl->id < id)
1272 /* Don't add duplicates */
1273 if (ref->ctrl->id == id) {
1277 list_add(&new_ref->node, ref->node.prev);
1282 /* Insert the control node in the hash */
1283 new_ref->next = hdl->buckets[bucket];
1284 hdl->buckets[bucket] = new_ref;
1287 mutex_unlock(&hdl->lock);
1291 /* Add a new control */
1292 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1293 const struct v4l2_ctrl_ops *ops,
1294 u32 id, const char *name, enum v4l2_ctrl_type type,
1295 s32 min, s32 max, u32 step, s32 def,
1296 u32 flags, const char * const *qmenu, void *priv)
1298 struct v4l2_ctrl *ctrl;
1299 unsigned sz_extra = 0;
1305 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1306 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1307 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
1308 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1309 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1310 handler_set_err(hdl, -ERANGE);
1313 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1314 handler_set_err(hdl, -ERANGE);
1317 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1318 type == V4L2_CTRL_TYPE_MENU ||
1319 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1320 (def < min || def > max)) {
1321 handler_set_err(hdl, -ERANGE);
1324 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1325 handler_set_err(hdl, -ERANGE);
1329 if (type == V4L2_CTRL_TYPE_BUTTON)
1330 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1331 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1332 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1333 else if (type == V4L2_CTRL_TYPE_STRING)
1334 sz_extra += 2 * (max + 1);
1336 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1338 handler_set_err(hdl, -ENOMEM);
1342 INIT_LIST_HEAD(&ctrl->node);
1343 INIT_LIST_HEAD(&ctrl->ev_subs);
1344 ctrl->handler = hdl;
1349 ctrl->flags = flags;
1350 ctrl->minimum = min;
1351 ctrl->maximum = max;
1353 ctrl->qmenu = qmenu;
1355 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1357 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1358 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1359 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1361 memset(ctrl->cur.string, ' ', ctrl->minimum);
1363 if (handler_new_ref(hdl, ctrl)) {
1367 mutex_lock(&hdl->lock);
1368 list_add_tail(&ctrl->node, &hdl->ctrls);
1369 mutex_unlock(&hdl->lock);
1373 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1374 const struct v4l2_ctrl_config *cfg, void *priv)
1377 struct v4l2_ctrl *ctrl;
1378 const char *name = cfg->name;
1379 const char * const *qmenu = cfg->qmenu;
1380 enum v4l2_ctrl_type type = cfg->type;
1381 u32 flags = cfg->flags;
1384 u32 step = cfg->step;
1388 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1391 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU);
1395 WARN_ON(cfg->menu_skip_mask);
1396 if (is_menu && qmenu == NULL)
1397 qmenu = v4l2_ctrl_get_menu(cfg->id);
1399 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1401 is_menu ? cfg->menu_skip_mask : step,
1402 def, flags, qmenu, priv);
1404 ctrl->is_private = cfg->is_private;
1407 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1409 /* Helper function for standard non-menu controls */
1410 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1411 const struct v4l2_ctrl_ops *ops,
1412 u32 id, s32 min, s32 max, u32 step, s32 def)
1415 enum v4l2_ctrl_type type;
1418 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1419 if (type == V4L2_CTRL_TYPE_MENU) {
1420 handler_set_err(hdl, -EINVAL);
1423 return v4l2_ctrl_new(hdl, ops, id, name, type,
1424 min, max, step, def, flags, NULL, NULL);
1426 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1428 /* Helper function for standard menu controls */
1429 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1430 const struct v4l2_ctrl_ops *ops,
1431 u32 id, s32 max, s32 mask, s32 def)
1433 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1435 enum v4l2_ctrl_type type;
1440 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1441 if (type != V4L2_CTRL_TYPE_MENU) {
1442 handler_set_err(hdl, -EINVAL);
1445 return v4l2_ctrl_new(hdl, ops, id, name, type,
1446 0, max, mask, def, flags, qmenu, NULL);
1448 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1450 /* Add a control from another handler to this handler */
1451 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1452 struct v4l2_ctrl *ctrl)
1454 if (hdl == NULL || hdl->error)
1457 handler_set_err(hdl, -EINVAL);
1460 if (ctrl->handler == hdl)
1462 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1464 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1466 /* Add the controls from another handler to our own. */
1467 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1468 struct v4l2_ctrl_handler *add)
1470 struct v4l2_ctrl *ctrl;
1473 /* Do nothing if either handler is NULL or if they are the same */
1474 if (!hdl || !add || hdl == add)
1478 mutex_lock(&add->lock);
1479 list_for_each_entry(ctrl, &add->ctrls, node) {
1480 /* Skip handler-private controls. */
1481 if (ctrl->is_private)
1483 /* And control classes */
1484 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1486 ret = handler_new_ref(hdl, ctrl);
1490 mutex_unlock(&add->lock);
1493 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1495 /* Cluster controls */
1496 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1498 bool has_volatiles = false;
1501 /* The first control is the master control and it must not be NULL */
1502 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1504 for (i = 0; i < ncontrols; i++) {
1506 controls[i]->cluster = controls;
1507 controls[i]->ncontrols = ncontrols;
1508 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1509 has_volatiles = true;
1512 controls[0]->has_volatiles = has_volatiles;
1514 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1516 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1517 u8 manual_val, bool set_volatile)
1519 struct v4l2_ctrl *master = controls[0];
1523 v4l2_ctrl_cluster(ncontrols, controls);
1524 WARN_ON(ncontrols <= 1);
1525 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1526 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1527 master->is_auto = true;
1528 master->has_volatiles = set_volatile;
1529 master->manual_mode_value = manual_val;
1530 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1532 if (!is_cur_manual(master))
1533 flag = V4L2_CTRL_FLAG_INACTIVE |
1534 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1536 for (i = 1; i < ncontrols; i++)
1538 controls[i]->flags |= flag;
1540 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1542 /* Activate/deactivate a control. */
1543 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1545 /* invert since the actual flag is called 'inactive' */
1546 bool inactive = !active;
1553 /* set V4L2_CTRL_FLAG_INACTIVE */
1554 old = test_and_set_bit(4, &ctrl->flags);
1556 /* clear V4L2_CTRL_FLAG_INACTIVE */
1557 old = test_and_clear_bit(4, &ctrl->flags);
1558 if (old != inactive)
1559 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1561 EXPORT_SYMBOL(v4l2_ctrl_activate);
1563 /* Grab/ungrab a control.
1564 Typically used when streaming starts and you want to grab controls,
1565 preventing the user from changing them.
1567 Just call this and the framework will block any attempts to change
1569 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1576 v4l2_ctrl_lock(ctrl);
1578 /* set V4L2_CTRL_FLAG_GRABBED */
1579 old = test_and_set_bit(1, &ctrl->flags);
1581 /* clear V4L2_CTRL_FLAG_GRABBED */
1582 old = test_and_clear_bit(1, &ctrl->flags);
1584 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1585 v4l2_ctrl_unlock(ctrl);
1587 EXPORT_SYMBOL(v4l2_ctrl_grab);
1589 /* Log the control name and value */
1590 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1591 const char *prefix, const char *colon)
1593 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1595 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1598 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1600 switch (ctrl->type) {
1601 case V4L2_CTRL_TYPE_INTEGER:
1602 printk(KERN_CONT "%d", ctrl->cur.val);
1604 case V4L2_CTRL_TYPE_BOOLEAN:
1605 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1607 case V4L2_CTRL_TYPE_MENU:
1608 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1610 case V4L2_CTRL_TYPE_BITMASK:
1611 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1613 case V4L2_CTRL_TYPE_INTEGER64:
1614 printk(KERN_CONT "%lld", ctrl->cur.val64);
1616 case V4L2_CTRL_TYPE_STRING:
1617 printk(KERN_CONT "%s", ctrl->cur.string);
1620 printk(KERN_CONT "unknown type %d", ctrl->type);
1623 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1624 V4L2_CTRL_FLAG_GRABBED |
1625 V4L2_CTRL_FLAG_VOLATILE)) {
1626 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1627 printk(KERN_CONT " inactive");
1628 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1629 printk(KERN_CONT " grabbed");
1630 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1631 printk(KERN_CONT " volatile");
1633 printk(KERN_CONT "\n");
1636 /* Log all controls owned by the handler */
1637 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1640 struct v4l2_ctrl *ctrl;
1641 const char *colon = "";
1648 len = strlen(prefix);
1649 if (len && prefix[len - 1] != ' ')
1651 mutex_lock(&hdl->lock);
1652 list_for_each_entry(ctrl, &hdl->ctrls, node)
1653 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1654 log_ctrl(ctrl, prefix, colon);
1655 mutex_unlock(&hdl->lock);
1657 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1659 /* Call s_ctrl for all controls owned by the handler */
1660 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1662 struct v4l2_ctrl *ctrl;
1667 mutex_lock(&hdl->lock);
1668 list_for_each_entry(ctrl, &hdl->ctrls, node)
1671 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1672 struct v4l2_ctrl *master = ctrl->cluster[0];
1675 /* Skip if this control was already handled by a cluster. */
1676 /* Skip button controls and read-only controls. */
1677 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1678 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1681 for (i = 0; i < master->ncontrols; i++) {
1682 if (master->cluster[i]) {
1683 cur_to_new(master->cluster[i]);
1684 master->cluster[i]->is_new = 1;
1685 master->cluster[i]->done = true;
1688 ret = call_op(master, s_ctrl);
1692 mutex_unlock(&hdl->lock);
1695 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1697 /* Implement VIDIOC_QUERYCTRL */
1698 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1700 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1701 struct v4l2_ctrl_ref *ref;
1702 struct v4l2_ctrl *ctrl;
1707 mutex_lock(&hdl->lock);
1709 /* Try to find it */
1710 ref = find_ref(hdl, id);
1712 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1713 /* Find the next control with ID > qc->id */
1715 /* Did we reach the end of the control list? */
1716 if (id >= node2id(hdl->ctrl_refs.prev)) {
1717 ref = NULL; /* Yes, so there is no next control */
1719 /* We found a control with the given ID, so just get
1720 the next one in the list. */
1721 ref = list_entry(ref->node.next, typeof(*ref), node);
1723 /* No control with the given ID exists, so start
1724 searching for the next largest ID. We know there
1725 is one, otherwise the first 'if' above would have
1727 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1728 if (id < ref->ctrl->id)
1732 mutex_unlock(&hdl->lock);
1737 memset(qc, 0, sizeof(*qc));
1738 if (id >= V4L2_CID_PRIVATE_BASE)
1742 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1743 qc->minimum = ctrl->minimum;
1744 qc->maximum = ctrl->maximum;
1745 qc->default_value = ctrl->default_value;
1746 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
1749 qc->step = ctrl->step;
1750 qc->flags = ctrl->flags;
1751 qc->type = ctrl->type;
1754 EXPORT_SYMBOL(v4l2_queryctrl);
1756 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1758 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1760 return v4l2_queryctrl(sd->ctrl_handler, qc);
1762 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1764 /* Implement VIDIOC_QUERYMENU */
1765 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1767 struct v4l2_ctrl *ctrl;
1770 ctrl = v4l2_ctrl_find(hdl, qm->id);
1776 if (ctrl->qmenu == NULL ||
1777 i < ctrl->minimum || i > ctrl->maximum)
1779 /* Use mask to see if this menu item should be skipped */
1780 if (ctrl->menu_skip_mask & (1 << i))
1782 /* Empty menu items should also be skipped */
1783 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1785 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1788 EXPORT_SYMBOL(v4l2_querymenu);
1790 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1792 return v4l2_querymenu(sd->ctrl_handler, qm);
1794 EXPORT_SYMBOL(v4l2_subdev_querymenu);
1798 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1800 It is not a fully atomic operation, just best-effort only. After all, if
1801 multiple controls have to be set through multiple i2c writes (for example)
1802 then some initial writes may succeed while others fail. Thus leaving the
1803 system in an inconsistent state. The question is how much effort you are
1804 willing to spend on trying to make something atomic that really isn't.
1806 From the point of view of an application the main requirement is that
1807 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1808 error should be returned without actually affecting any controls.
1810 If all the values are correct, then it is acceptable to just give up
1811 in case of low-level errors.
1813 It is important though that the application can tell when only a partial
1814 configuration was done. The way we do that is through the error_idx field
1815 of struct v4l2_ext_controls: if that is equal to the count field then no
1816 controls were affected. Otherwise all controls before that index were
1817 successful in performing their 'get' or 'set' operation, the control at
1818 the given index failed, and you don't know what happened with the controls
1819 after the failed one. Since if they were part of a control cluster they
1820 could have been successfully processed (if a cluster member was encountered
1821 at index < error_idx), they could have failed (if a cluster member was at
1822 error_idx), or they may not have been processed yet (if the first cluster
1823 member appeared after error_idx).
1825 It is all fairly theoretical, though. In practice all you can do is to
1826 bail out. If error_idx == count, then it is an application bug. If
1827 error_idx < count then it is only an application bug if the error code was
1828 EBUSY. That usually means that something started streaming just when you
1829 tried to set the controls. In all other cases it is a driver/hardware
1830 problem and all you can do is to retry or bail out.
1832 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1833 never modifies controls the error_idx is just set to whatever control
1834 has an invalid value.
1837 /* Prepare for the extended g/s/try functions.
1838 Find the controls in the control array and do some basic checks. */
1839 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1840 struct v4l2_ext_controls *cs,
1841 struct v4l2_ctrl_helper *helpers)
1843 struct v4l2_ctrl_helper *h;
1844 bool have_clusters = false;
1847 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1848 struct v4l2_ext_control *c = &cs->controls[i];
1849 struct v4l2_ctrl_ref *ref;
1850 struct v4l2_ctrl *ctrl;
1851 u32 id = c->id & V4L2_CTRL_ID_MASK;
1855 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1858 /* Old-style private controls are not allowed for
1859 extended controls */
1860 if (id >= V4L2_CID_PRIVATE_BASE)
1862 ref = find_ref_lock(hdl, id);
1866 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1869 if (ctrl->cluster[0]->ncontrols > 1)
1870 have_clusters = true;
1871 if (ctrl->cluster[0] != ctrl)
1872 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1873 /* Store the ref to the master control of the cluster */
1876 /* Initially set next to 0, meaning that there is no other
1877 control in this helper array belonging to the same
1882 /* We are done if there were no controls that belong to a multi-
1887 /* The code below figures out in O(n) time which controls in the list
1888 belong to the same cluster. */
1890 /* This has to be done with the handler lock taken. */
1891 mutex_lock(&hdl->lock);
1893 /* First zero the helper field in the master control references */
1894 for (i = 0; i < cs->count; i++)
1895 helpers[i].mref->helper = 0;
1896 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1897 struct v4l2_ctrl_ref *mref = h->mref;
1899 /* If the mref->helper is set, then it points to an earlier
1900 helper that belongs to the same cluster. */
1902 /* Set the next field of mref->helper to the current
1903 index: this means that that earlier helper now
1904 points to the next helper in the same cluster. */
1905 mref->helper->next = i;
1906 /* mref should be set only for the first helper in the
1907 cluster, clear the others. */
1910 /* Point the mref helper to the current helper struct. */
1913 mutex_unlock(&hdl->lock);
1917 /* Handles the corner case where cs->count == 0. It checks whether the
1918 specified control class exists. If that class ID is 0, then it checks
1919 whether there are any controls at all. */
1920 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
1922 if (ctrl_class == 0)
1923 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
1924 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
1929 /* Get extended controls. Allocates the helpers array if needed. */
1930 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1932 struct v4l2_ctrl_helper helper[4];
1933 struct v4l2_ctrl_helper *helpers = helper;
1937 cs->error_idx = cs->count;
1938 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1944 return class_check(hdl, cs->ctrl_class);
1946 if (cs->count > ARRAY_SIZE(helper)) {
1947 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1948 if (helpers == NULL)
1952 ret = prepare_ext_ctrls(hdl, cs, helpers);
1953 cs->error_idx = cs->count;
1955 for (i = 0; !ret && i < cs->count; i++)
1956 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1959 for (i = 0; !ret && i < cs->count; i++) {
1960 int (*ctrl_to_user)(struct v4l2_ext_control *c,
1961 struct v4l2_ctrl *ctrl) = cur_to_user;
1962 struct v4l2_ctrl *master;
1964 if (helpers[i].mref == NULL)
1967 master = helpers[i].mref->ctrl;
1970 v4l2_ctrl_lock(master);
1972 /* g_volatile_ctrl will update the new control values */
1973 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
1974 (master->has_volatiles && !is_cur_manual(master))) {
1975 for (j = 0; j < master->ncontrols; j++)
1976 cur_to_new(master->cluster[j]);
1977 ret = call_op(master, g_volatile_ctrl);
1978 ctrl_to_user = new_to_user;
1980 /* If OK, then copy the current (for non-volatile controls)
1981 or the new (for volatile controls) control values to the
1987 ret = ctrl_to_user(cs->controls + idx,
1989 idx = helpers[idx].next;
1990 } while (!ret && idx);
1992 v4l2_ctrl_unlock(master);
1995 if (cs->count > ARRAY_SIZE(helper))
1999 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2001 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2003 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2005 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2007 /* Helper function to get a single control */
2008 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2010 struct v4l2_ctrl *master = ctrl->cluster[0];
2014 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2017 v4l2_ctrl_lock(master);
2018 /* g_volatile_ctrl will update the current control values */
2019 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2020 for (i = 0; i < master->ncontrols; i++)
2021 cur_to_new(master->cluster[i]);
2022 ret = call_op(master, g_volatile_ctrl);
2025 *val = ctrl->cur.val;
2027 v4l2_ctrl_unlock(master);
2031 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2033 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2035 if (ctrl == NULL || !type_is_int(ctrl))
2037 return get_ctrl(ctrl, &control->value);
2039 EXPORT_SYMBOL(v4l2_g_ctrl);
2041 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2043 return v4l2_g_ctrl(sd->ctrl_handler, control);
2045 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2047 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2051 /* It's a driver bug if this happens. */
2052 WARN_ON(!type_is_int(ctrl));
2053 get_ctrl(ctrl, &val);
2056 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2059 /* Core function that calls try/s_ctrl and ensures that the new value is
2060 copied to the current value on a set.
2061 Must be called with ctrl->handler->lock held. */
2062 static int try_or_set_cluster(struct v4l2_fh *fh,
2063 struct v4l2_ctrl *master, bool set)
2069 /* Go through the cluster and either validate the new value or
2070 (if no new value was set), copy the current value to the new
2071 value, ensuring a consistent view for the control ops when
2073 for (i = 0; i < master->ncontrols; i++) {
2074 struct v4l2_ctrl *ctrl = master->cluster[i];
2079 if (!ctrl->is_new) {
2083 /* Check again: it may have changed since the
2084 previous check in try_or_set_ext_ctrls(). */
2085 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2089 ret = call_op(master, try_ctrl);
2091 /* Don't set if there is no change */
2092 if (ret || !set || !cluster_changed(master))
2094 ret = call_op(master, s_ctrl);
2098 /* If OK, then make the new values permanent. */
2099 update_flag = is_cur_manual(master) != is_new_manual(master);
2100 for (i = 0; i < master->ncontrols; i++)
2101 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
2105 /* Validate controls. */
2106 static int validate_ctrls(struct v4l2_ext_controls *cs,
2107 struct v4l2_ctrl_helper *helpers, bool set)
2112 cs->error_idx = cs->count;
2113 for (i = 0; i < cs->count; i++) {
2114 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2118 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2120 /* This test is also done in try_set_control_cluster() which
2121 is called in atomic context, so that has the final say,
2122 but it makes sense to do an up-front check as well. Once
2123 an error occurs in try_set_control_cluster() some other
2124 controls may have been set already and we want to do a
2125 best-effort to avoid that. */
2126 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2128 ret = validate_new(ctrl, &cs->controls[i]);
2135 /* Obtain the current volatile values of an autocluster and mark them
2137 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2141 for (i = 0; i < master->ncontrols; i++)
2142 cur_to_new(master->cluster[i]);
2143 if (!call_op(master, g_volatile_ctrl))
2144 for (i = 1; i < master->ncontrols; i++)
2145 if (master->cluster[i])
2146 master->cluster[i]->is_new = 1;
2149 /* Try or try-and-set controls */
2150 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2151 struct v4l2_ext_controls *cs,
2154 struct v4l2_ctrl_helper helper[4];
2155 struct v4l2_ctrl_helper *helpers = helper;
2159 cs->error_idx = cs->count;
2160 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2166 return class_check(hdl, cs->ctrl_class);
2168 if (cs->count > ARRAY_SIZE(helper)) {
2169 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
2173 ret = prepare_ext_ctrls(hdl, cs, helpers);
2175 ret = validate_ctrls(cs, helpers, set);
2177 cs->error_idx = cs->count;
2178 for (i = 0; !ret && i < cs->count; i++) {
2179 struct v4l2_ctrl *master;
2182 if (helpers[i].mref == NULL)
2186 master = helpers[i].mref->ctrl;
2187 v4l2_ctrl_lock(master);
2189 /* Reset the 'is_new' flags of the cluster */
2190 for (j = 0; j < master->ncontrols; j++)
2191 if (master->cluster[j])
2192 master->cluster[j]->is_new = 0;
2194 /* For volatile autoclusters that are currently in auto mode
2195 we need to discover if it will be set to manual mode.
2196 If so, then we have to copy the current volatile values
2197 first since those will become the new manual values (which
2198 may be overwritten by explicit new values from this set
2200 if (master->is_auto && master->has_volatiles &&
2201 !is_cur_manual(master)) {
2202 /* Pick an initial non-manual value */
2203 s32 new_auto_val = master->manual_mode_value + 1;
2207 /* Check if the auto control is part of the
2208 list, and remember the new value. */
2209 if (helpers[tmp_idx].ctrl == master)
2210 new_auto_val = cs->controls[tmp_idx].value;
2211 tmp_idx = helpers[tmp_idx].next;
2213 /* If the new value == the manual value, then copy
2214 the current volatile values. */
2215 if (new_auto_val == master->manual_mode_value)
2216 update_from_auto_cluster(master);
2219 /* Copy the new caller-supplied control values.
2220 user_to_new() sets 'is_new' to 1. */
2222 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2223 idx = helpers[idx].next;
2224 } while (!ret && idx);
2227 ret = try_or_set_cluster(fh, master, set);
2229 /* Copy the new values back to userspace. */
2233 ret = new_to_user(cs->controls + idx,
2235 idx = helpers[idx].next;
2236 } while (!ret && idx);
2238 v4l2_ctrl_unlock(master);
2241 if (cs->count > ARRAY_SIZE(helper))
2246 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2248 return try_set_ext_ctrls(NULL, hdl, cs, false);
2250 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2252 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2253 struct v4l2_ext_controls *cs)
2255 return try_set_ext_ctrls(fh, hdl, cs, true);
2257 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2259 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2261 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2263 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2265 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2267 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2269 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2271 /* Helper function for VIDIOC_S_CTRL compatibility */
2272 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
2274 struct v4l2_ctrl *master = ctrl->cluster[0];
2278 ret = validate_new_int(ctrl, val);
2282 v4l2_ctrl_lock(ctrl);
2284 /* Reset the 'is_new' flags of the cluster */
2285 for (i = 0; i < master->ncontrols; i++)
2286 if (master->cluster[i])
2287 master->cluster[i]->is_new = 0;
2289 /* For autoclusters with volatiles that are switched from auto to
2290 manual mode we have to update the current volatile values since
2291 those will become the initial manual values after such a switch. */
2292 if (master->is_auto && master->has_volatiles && ctrl == master &&
2293 !is_cur_manual(master) && *val == master->manual_mode_value)
2294 update_from_auto_cluster(master);
2297 ret = try_or_set_cluster(fh, master, true);
2298 *val = ctrl->cur.val;
2299 v4l2_ctrl_unlock(ctrl);
2303 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2304 struct v4l2_control *control)
2306 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2308 if (ctrl == NULL || !type_is_int(ctrl))
2311 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2314 return set_ctrl(fh, ctrl, &control->value);
2316 EXPORT_SYMBOL(v4l2_s_ctrl);
2318 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2320 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2322 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2324 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2326 /* It's a driver bug if this happens. */
2327 WARN_ON(!type_is_int(ctrl));
2328 return set_ctrl(NULL, ctrl, &val);
2330 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2332 void v4l2_ctrl_add_event(struct v4l2_ctrl *ctrl,
2333 struct v4l2_subscribed_event *sev)
2335 v4l2_ctrl_lock(ctrl);
2336 list_add_tail(&sev->node, &ctrl->ev_subs);
2337 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2338 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2339 struct v4l2_event ev;
2340 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2342 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2343 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2344 fill_event(&ev, ctrl, changes);
2345 v4l2_event_queue_fh(sev->fh, &ev);
2347 v4l2_ctrl_unlock(ctrl);
2349 EXPORT_SYMBOL(v4l2_ctrl_add_event);
2351 void v4l2_ctrl_del_event(struct v4l2_ctrl *ctrl,
2352 struct v4l2_subscribed_event *sev)
2354 v4l2_ctrl_lock(ctrl);
2355 list_del(&sev->node);
2356 v4l2_ctrl_unlock(ctrl);
2358 EXPORT_SYMBOL(v4l2_ctrl_del_event);