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_video_encoding
[] = {
184 static const char * const mpeg_video_aspect
[] = {
191 static const char * const mpeg_video_bitrate_mode
[] = {
196 static const char * const mpeg_stream_type
[] = {
197 "MPEG-2 Program Stream",
198 "MPEG-2 Transport Stream",
199 "MPEG-1 System Stream",
200 "MPEG-2 DVD-compatible Stream",
201 "MPEG-1 VCD-compatible Stream",
202 "MPEG-2 SVCD-compatible Stream",
205 static const char * const mpeg_stream_vbi_fmt
[] = {
207 "Private Packet, IVTV Format",
210 static const char * const camera_power_line_frequency
[] = {
217 static const char * const camera_exposure_auto
[] = {
220 "Shutter Priority Mode",
221 "Aperture Priority Mode",
224 static const char * const colorfx
[] = {
237 static const char * const tune_preemphasis
[] = {
243 static const char * const header_mode
[] = {
245 "Joined With 1st Frame",
248 static const char * const multi_slice
[] = {
254 static const char * const entropy_mode
[] = {
259 static const char * const mpeg_h264_level
[] = {
278 static const char * const h264_loop_filter
[] = {
281 "Disabled at Slice Boundary",
284 static const char * const h264_profile
[] = {
286 "Constrained Baseline",
292 "High 444 Predictive",
299 "Scalable High Intra",
303 static const char * const vui_sar_idc
[] = {
324 static const char * const mpeg_mpeg4_level
[] = {
335 static const char * const mpeg4_profile
[] = {
340 "Advanced Coding Efficency",
344 static const char * const flash_led_mode
[] = {
350 static const char * const flash_strobe_source
[] = {
357 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ
:
358 return mpeg_audio_sampling_freq
;
359 case V4L2_CID_MPEG_AUDIO_ENCODING
:
360 return mpeg_audio_encoding
;
361 case V4L2_CID_MPEG_AUDIO_L1_BITRATE
:
362 return mpeg_audio_l1_bitrate
;
363 case V4L2_CID_MPEG_AUDIO_L2_BITRATE
:
364 return mpeg_audio_l2_bitrate
;
365 case V4L2_CID_MPEG_AUDIO_L3_BITRATE
:
366 return mpeg_audio_l3_bitrate
;
367 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE
:
368 return mpeg_audio_ac3_bitrate
;
369 case V4L2_CID_MPEG_AUDIO_MODE
:
370 return mpeg_audio_mode
;
371 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION
:
372 return mpeg_audio_mode_extension
;
373 case V4L2_CID_MPEG_AUDIO_EMPHASIS
:
374 return mpeg_audio_emphasis
;
375 case V4L2_CID_MPEG_AUDIO_CRC
:
376 return mpeg_audio_crc
;
377 case V4L2_CID_MPEG_VIDEO_ENCODING
:
378 return mpeg_video_encoding
;
379 case V4L2_CID_MPEG_VIDEO_ASPECT
:
380 return mpeg_video_aspect
;
381 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE
:
382 return mpeg_video_bitrate_mode
;
383 case V4L2_CID_MPEG_STREAM_TYPE
:
384 return mpeg_stream_type
;
385 case V4L2_CID_MPEG_STREAM_VBI_FMT
:
386 return mpeg_stream_vbi_fmt
;
387 case V4L2_CID_POWER_LINE_FREQUENCY
:
388 return camera_power_line_frequency
;
389 case V4L2_CID_EXPOSURE_AUTO
:
390 return camera_exposure_auto
;
391 case V4L2_CID_COLORFX
:
393 case V4L2_CID_TUNE_PREEMPHASIS
:
394 return tune_preemphasis
;
395 case V4L2_CID_FLASH_LED_MODE
:
396 return flash_led_mode
;
397 case V4L2_CID_FLASH_STROBE_SOURCE
:
398 return flash_strobe_source
;
399 case V4L2_CID_MPEG_VIDEO_HEADER_MODE
:
401 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE
:
403 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE
:
405 case V4L2_CID_MPEG_VIDEO_H264_LEVEL
:
406 return mpeg_h264_level
;
407 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE
:
408 return h264_loop_filter
;
409 case V4L2_CID_MPEG_VIDEO_H264_PROFILE
:
411 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC
:
413 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL
:
414 return mpeg_mpeg4_level
;
415 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE
:
416 return mpeg4_profile
;
421 EXPORT_SYMBOL(v4l2_ctrl_get_menu
);
423 /* Return the control name. */
424 const char *v4l2_ctrl_get_name(u32 id
)
428 /* Keep the order of the 'case's the same as in videodev2.h! */
429 case V4L2_CID_USER_CLASS
: return "User Controls";
430 case V4L2_CID_BRIGHTNESS
: return "Brightness";
431 case V4L2_CID_CONTRAST
: return "Contrast";
432 case V4L2_CID_SATURATION
: return "Saturation";
433 case V4L2_CID_HUE
: return "Hue";
434 case V4L2_CID_AUDIO_VOLUME
: return "Volume";
435 case V4L2_CID_AUDIO_BALANCE
: return "Balance";
436 case V4L2_CID_AUDIO_BASS
: return "Bass";
437 case V4L2_CID_AUDIO_TREBLE
: return "Treble";
438 case V4L2_CID_AUDIO_MUTE
: return "Mute";
439 case V4L2_CID_AUDIO_LOUDNESS
: return "Loudness";
440 case V4L2_CID_BLACK_LEVEL
: return "Black Level";
441 case V4L2_CID_AUTO_WHITE_BALANCE
: return "White Balance, Automatic";
442 case V4L2_CID_DO_WHITE_BALANCE
: return "Do White Balance";
443 case V4L2_CID_RED_BALANCE
: return "Red Balance";
444 case V4L2_CID_BLUE_BALANCE
: return "Blue Balance";
445 case V4L2_CID_GAMMA
: return "Gamma";
446 case V4L2_CID_EXPOSURE
: return "Exposure";
447 case V4L2_CID_AUTOGAIN
: return "Gain, Automatic";
448 case V4L2_CID_GAIN
: return "Gain";
449 case V4L2_CID_HFLIP
: return "Horizontal Flip";
450 case V4L2_CID_VFLIP
: return "Vertical Flip";
451 case V4L2_CID_HCENTER
: return "Horizontal Center";
452 case V4L2_CID_VCENTER
: return "Vertical Center";
453 case V4L2_CID_POWER_LINE_FREQUENCY
: return "Power Line Frequency";
454 case V4L2_CID_HUE_AUTO
: return "Hue, Automatic";
455 case V4L2_CID_WHITE_BALANCE_TEMPERATURE
: return "White Balance Temperature";
456 case V4L2_CID_SHARPNESS
: return "Sharpness";
457 case V4L2_CID_BACKLIGHT_COMPENSATION
: return "Backlight Compensation";
458 case V4L2_CID_CHROMA_AGC
: return "Chroma AGC";
459 case V4L2_CID_COLOR_KILLER
: return "Color Killer";
460 case V4L2_CID_COLORFX
: return "Color Effects";
461 case V4L2_CID_AUTOBRIGHTNESS
: return "Brightness, Automatic";
462 case V4L2_CID_BAND_STOP_FILTER
: return "Band-Stop Filter";
463 case V4L2_CID_ROTATE
: return "Rotate";
464 case V4L2_CID_BG_COLOR
: return "Background Color";
465 case V4L2_CID_CHROMA_GAIN
: return "Chroma Gain";
466 case V4L2_CID_ILLUMINATORS_1
: return "Illuminator 1";
467 case V4L2_CID_ILLUMINATORS_2
: return "Illuminator 2";
468 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE
: return "Min Number of Capture Buffers";
469 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT
: return "Min Number of Output Buffers";
470 case V4L2_CID_ALPHA_COMPONENT
: return "Alpha Component";
473 /* Keep the order of the 'case's the same as in videodev2.h! */
474 case V4L2_CID_MPEG_CLASS
: return "MPEG Encoder Controls";
475 case V4L2_CID_MPEG_STREAM_TYPE
: return "Stream Type";
476 case V4L2_CID_MPEG_STREAM_PID_PMT
: return "Stream PMT Program ID";
477 case V4L2_CID_MPEG_STREAM_PID_AUDIO
: return "Stream Audio Program ID";
478 case V4L2_CID_MPEG_STREAM_PID_VIDEO
: return "Stream Video Program ID";
479 case V4L2_CID_MPEG_STREAM_PID_PCR
: return "Stream PCR Program ID";
480 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO
: return "Stream PES Audio ID";
481 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO
: return "Stream PES Video ID";
482 case V4L2_CID_MPEG_STREAM_VBI_FMT
: return "Stream VBI Format";
483 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ
: return "Audio Sampling Frequency";
484 case V4L2_CID_MPEG_AUDIO_ENCODING
: return "Audio Encoding";
485 case V4L2_CID_MPEG_AUDIO_L1_BITRATE
: return "Audio Layer I Bitrate";
486 case V4L2_CID_MPEG_AUDIO_L2_BITRATE
: return "Audio Layer II Bitrate";
487 case V4L2_CID_MPEG_AUDIO_L3_BITRATE
: return "Audio Layer III Bitrate";
488 case V4L2_CID_MPEG_AUDIO_MODE
: return "Audio Stereo Mode";
489 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION
: return "Audio Stereo Mode Extension";
490 case V4L2_CID_MPEG_AUDIO_EMPHASIS
: return "Audio Emphasis";
491 case V4L2_CID_MPEG_AUDIO_CRC
: return "Audio CRC";
492 case V4L2_CID_MPEG_AUDIO_MUTE
: return "Audio Mute";
493 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE
: return "Audio AAC Bitrate";
494 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE
: return "Audio AC-3 Bitrate";
495 case V4L2_CID_MPEG_VIDEO_ENCODING
: return "Video Encoding";
496 case V4L2_CID_MPEG_VIDEO_ASPECT
: return "Video Aspect";
497 case V4L2_CID_MPEG_VIDEO_B_FRAMES
: return "Video B Frames";
498 case V4L2_CID_MPEG_VIDEO_GOP_SIZE
: return "Video GOP Size";
499 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE
: return "Video GOP Closure";
500 case V4L2_CID_MPEG_VIDEO_PULLDOWN
: return "Video Pulldown";
501 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE
: return "Video Bitrate Mode";
502 case V4L2_CID_MPEG_VIDEO_BITRATE
: return "Video Bitrate";
503 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK
: return "Video Peak Bitrate";
504 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION
: return "Video Temporal Decimation";
505 case V4L2_CID_MPEG_VIDEO_MUTE
: return "Video Mute";
506 case V4L2_CID_MPEG_VIDEO_MUTE_YUV
: return "Video Mute YUV";
507 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE
: return "Decoder Slice Interface";
508 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER
: return "MPEG4 Loop Filter Enable";
509 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB
: return "Number of Intra Refresh MBs";
510 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE
: return "Frame Level Rate Control Enable";
511 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE
: return "H264 MB Level Rate Control";
512 case V4L2_CID_MPEG_VIDEO_HEADER_MODE
: return "Sequence Header Mode";
513 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC
: return "Max Number of Reference Pics";
514 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP
: return "H263 I-Frame QP Value";
515 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP
: return "H263 P-Frame QP Value";
516 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP
: return "H263 B-Frame QP Value";
517 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP
: return "H263 Minimum QP Value";
518 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP
: return "H263 Maximum QP Value";
519 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP
: return "H264 I-Frame QP Value";
520 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP
: return "H264 P-Frame QP Value";
521 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP
: return "H264 B-Frame QP Value";
522 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP
: return "H264 Maximum QP Value";
523 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP
: return "H264 Minimum QP Value";
524 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM
: return "H264 8x8 Transform Enable";
525 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE
: return "H264 CPB Buffer Size";
526 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE
: return "H264 Entropy Mode";
527 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD
: return "H264 I-Frame Period";
528 case V4L2_CID_MPEG_VIDEO_H264_LEVEL
: return "H264 Level";
529 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA
: return "H264 Loop Filter Alpha Offset";
530 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA
: return "H264 Loop Filter Beta Offset";
531 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE
: return "H264 Loop Filter Mode";
532 case V4L2_CID_MPEG_VIDEO_H264_PROFILE
: return "H264 Profile";
533 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT
: return "Vertical Size of SAR";
534 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH
: return "Horizontal Size of SAR";
535 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE
: return "Aspect Ratio VUI Enable";
536 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC
: return "VUI Aspect Ratio IDC";
537 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP
: return "MPEG4 I-Frame QP Value";
538 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP
: return "MPEG4 P-Frame QP Value";
539 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP
: return "MPEG4 B-Frame QP Value";
540 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP
: return "MPEG4 Minimum QP Value";
541 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP
: return "MPEG4 Maximum QP Value";
542 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL
: return "MPEG4 Level";
543 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE
: return "MPEG4 Profile";
544 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL
: return "Quarter Pixel Search Enable";
545 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES
: return "Maximum Bytes in a Slice";
546 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB
: return "Number of MBs in a Slice";
547 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE
: return "Slice Partitioning Method";
548 case V4L2_CID_MPEG_VIDEO_VBV_SIZE
: return "VBV Buffer Size";
550 /* CAMERA controls */
551 /* Keep the order of the 'case's the same as in videodev2.h! */
552 case V4L2_CID_CAMERA_CLASS
: return "Camera Controls";
553 case V4L2_CID_EXPOSURE_AUTO
: return "Auto Exposure";
554 case V4L2_CID_EXPOSURE_ABSOLUTE
: return "Exposure Time, Absolute";
555 case V4L2_CID_EXPOSURE_AUTO_PRIORITY
: return "Exposure, Dynamic Framerate";
556 case V4L2_CID_PAN_RELATIVE
: return "Pan, Relative";
557 case V4L2_CID_TILT_RELATIVE
: return "Tilt, Relative";
558 case V4L2_CID_PAN_RESET
: return "Pan, Reset";
559 case V4L2_CID_TILT_RESET
: return "Tilt, Reset";
560 case V4L2_CID_PAN_ABSOLUTE
: return "Pan, Absolute";
561 case V4L2_CID_TILT_ABSOLUTE
: return "Tilt, Absolute";
562 case V4L2_CID_FOCUS_ABSOLUTE
: return "Focus, Absolute";
563 case V4L2_CID_FOCUS_RELATIVE
: return "Focus, Relative";
564 case V4L2_CID_FOCUS_AUTO
: return "Focus, Automatic";
565 case V4L2_CID_ZOOM_ABSOLUTE
: return "Zoom, Absolute";
566 case V4L2_CID_ZOOM_RELATIVE
: return "Zoom, Relative";
567 case V4L2_CID_ZOOM_CONTINUOUS
: return "Zoom, Continuous";
568 case V4L2_CID_PRIVACY
: return "Privacy";
569 case V4L2_CID_IRIS_ABSOLUTE
: return "Iris, Absolute";
570 case V4L2_CID_IRIS_RELATIVE
: return "Iris, Relative";
572 /* FM Radio Modulator control */
573 /* Keep the order of the 'case's the same as in videodev2.h! */
574 case V4L2_CID_FM_TX_CLASS
: return "FM Radio Modulator Controls";
575 case V4L2_CID_RDS_TX_DEVIATION
: return "RDS Signal Deviation";
576 case V4L2_CID_RDS_TX_PI
: return "RDS Program ID";
577 case V4L2_CID_RDS_TX_PTY
: return "RDS Program Type";
578 case V4L2_CID_RDS_TX_PS_NAME
: return "RDS PS Name";
579 case V4L2_CID_RDS_TX_RADIO_TEXT
: return "RDS Radio Text";
580 case V4L2_CID_AUDIO_LIMITER_ENABLED
: return "Audio Limiter Feature Enabled";
581 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME
: return "Audio Limiter Release Time";
582 case V4L2_CID_AUDIO_LIMITER_DEVIATION
: return "Audio Limiter Deviation";
583 case V4L2_CID_AUDIO_COMPRESSION_ENABLED
: return "Audio Compression Enabled";
584 case V4L2_CID_AUDIO_COMPRESSION_GAIN
: return "Audio Compression Gain";
585 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD
: return "Audio Compression Threshold";
586 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME
: return "Audio Compression Attack Time";
587 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME
: return "Audio Compression Release Time";
588 case V4L2_CID_PILOT_TONE_ENABLED
: return "Pilot Tone Feature Enabled";
589 case V4L2_CID_PILOT_TONE_DEVIATION
: return "Pilot Tone Deviation";
590 case V4L2_CID_PILOT_TONE_FREQUENCY
: return "Pilot Tone Frequency";
591 case V4L2_CID_TUNE_PREEMPHASIS
: return "Pre-Emphasis";
592 case V4L2_CID_TUNE_POWER_LEVEL
: return "Tune Power Level";
593 case V4L2_CID_TUNE_ANTENNA_CAPACITOR
: return "Tune Antenna Capacitor";
596 case V4L2_CID_FLASH_CLASS
: return "Flash Controls";
597 case V4L2_CID_FLASH_LED_MODE
: return "LED Mode";
598 case V4L2_CID_FLASH_STROBE_SOURCE
: return "Strobe Source";
599 case V4L2_CID_FLASH_STROBE
: return "Strobe";
600 case V4L2_CID_FLASH_STROBE_STOP
: return "Stop Strobe";
601 case V4L2_CID_FLASH_STROBE_STATUS
: return "Strobe Status";
602 case V4L2_CID_FLASH_TIMEOUT
: return "Strobe Timeout";
603 case V4L2_CID_FLASH_INTENSITY
: return "Intensity, Flash Mode";
604 case V4L2_CID_FLASH_TORCH_INTENSITY
: return "Intensity, Torch Mode";
605 case V4L2_CID_FLASH_INDICATOR_INTENSITY
: return "Intensity, Indicator";
606 case V4L2_CID_FLASH_FAULT
: return "Faults";
607 case V4L2_CID_FLASH_CHARGE
: return "Charge";
608 case V4L2_CID_FLASH_READY
: return "Ready to Strobe";
614 EXPORT_SYMBOL(v4l2_ctrl_get_name
);
616 void v4l2_ctrl_fill(u32 id
, const char **name
, enum v4l2_ctrl_type
*type
,
617 s32
*min
, s32
*max
, s32
*step
, s32
*def
, u32
*flags
)
619 *name
= v4l2_ctrl_get_name(id
);
623 case V4L2_CID_AUDIO_MUTE
:
624 case V4L2_CID_AUDIO_LOUDNESS
:
625 case V4L2_CID_AUTO_WHITE_BALANCE
:
626 case V4L2_CID_AUTOGAIN
:
629 case V4L2_CID_HUE_AUTO
:
630 case V4L2_CID_CHROMA_AGC
:
631 case V4L2_CID_COLOR_KILLER
:
632 case V4L2_CID_MPEG_AUDIO_MUTE
:
633 case V4L2_CID_MPEG_VIDEO_MUTE
:
634 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE
:
635 case V4L2_CID_MPEG_VIDEO_PULLDOWN
:
636 case V4L2_CID_EXPOSURE_AUTO_PRIORITY
:
637 case V4L2_CID_FOCUS_AUTO
:
638 case V4L2_CID_PRIVACY
:
639 case V4L2_CID_AUDIO_LIMITER_ENABLED
:
640 case V4L2_CID_AUDIO_COMPRESSION_ENABLED
:
641 case V4L2_CID_PILOT_TONE_ENABLED
:
642 case V4L2_CID_ILLUMINATORS_1
:
643 case V4L2_CID_ILLUMINATORS_2
:
644 case V4L2_CID_FLASH_STROBE_STATUS
:
645 case V4L2_CID_FLASH_CHARGE
:
646 case V4L2_CID_FLASH_READY
:
647 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER
:
648 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE
:
649 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE
:
650 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE
:
651 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM
:
652 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE
:
653 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL
:
654 *type
= V4L2_CTRL_TYPE_BOOLEAN
;
658 case V4L2_CID_PAN_RESET
:
659 case V4L2_CID_TILT_RESET
:
660 case V4L2_CID_FLASH_STROBE
:
661 case V4L2_CID_FLASH_STROBE_STOP
:
662 *type
= V4L2_CTRL_TYPE_BUTTON
;
663 *flags
|= V4L2_CTRL_FLAG_WRITE_ONLY
;
664 *min
= *max
= *step
= *def
= 0;
666 case V4L2_CID_POWER_LINE_FREQUENCY
:
667 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ
:
668 case V4L2_CID_MPEG_AUDIO_ENCODING
:
669 case V4L2_CID_MPEG_AUDIO_L1_BITRATE
:
670 case V4L2_CID_MPEG_AUDIO_L2_BITRATE
:
671 case V4L2_CID_MPEG_AUDIO_L3_BITRATE
:
672 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE
:
673 case V4L2_CID_MPEG_AUDIO_MODE
:
674 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION
:
675 case V4L2_CID_MPEG_AUDIO_EMPHASIS
:
676 case V4L2_CID_MPEG_AUDIO_CRC
:
677 case V4L2_CID_MPEG_VIDEO_ENCODING
:
678 case V4L2_CID_MPEG_VIDEO_ASPECT
:
679 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE
:
680 case V4L2_CID_MPEG_STREAM_TYPE
:
681 case V4L2_CID_MPEG_STREAM_VBI_FMT
:
682 case V4L2_CID_EXPOSURE_AUTO
:
683 case V4L2_CID_COLORFX
:
684 case V4L2_CID_TUNE_PREEMPHASIS
:
685 case V4L2_CID_FLASH_LED_MODE
:
686 case V4L2_CID_FLASH_STROBE_SOURCE
:
687 case V4L2_CID_MPEG_VIDEO_HEADER_MODE
:
688 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE
:
689 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE
:
690 case V4L2_CID_MPEG_VIDEO_H264_LEVEL
:
691 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE
:
692 case V4L2_CID_MPEG_VIDEO_H264_PROFILE
:
693 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC
:
694 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL
:
695 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE
:
696 *type
= V4L2_CTRL_TYPE_MENU
;
698 case V4L2_CID_RDS_TX_PS_NAME
:
699 case V4L2_CID_RDS_TX_RADIO_TEXT
:
700 *type
= V4L2_CTRL_TYPE_STRING
;
702 case V4L2_CID_USER_CLASS
:
703 case V4L2_CID_CAMERA_CLASS
:
704 case V4L2_CID_MPEG_CLASS
:
705 case V4L2_CID_FM_TX_CLASS
:
706 case V4L2_CID_FLASH_CLASS
:
707 *type
= V4L2_CTRL_TYPE_CTRL_CLASS
;
708 /* You can neither read not write these */
709 *flags
|= V4L2_CTRL_FLAG_READ_ONLY
| V4L2_CTRL_FLAG_WRITE_ONLY
;
710 *min
= *max
= *step
= *def
= 0;
712 case V4L2_CID_BG_COLOR
:
713 *type
= V4L2_CTRL_TYPE_INTEGER
;
716 /* Max is calculated as RGB888 that is 2^24 */
719 case V4L2_CID_FLASH_FAULT
:
720 *type
= V4L2_CTRL_TYPE_BITMASK
;
722 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE
:
723 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT
:
724 *type
= V4L2_CTRL_TYPE_INTEGER
;
725 *flags
|= V4L2_CTRL_FLAG_READ_ONLY
;
728 *type
= V4L2_CTRL_TYPE_INTEGER
;
732 case V4L2_CID_MPEG_AUDIO_ENCODING
:
733 case V4L2_CID_MPEG_AUDIO_MODE
:
734 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE
:
735 case V4L2_CID_MPEG_VIDEO_B_FRAMES
:
736 case V4L2_CID_MPEG_STREAM_TYPE
:
737 *flags
|= V4L2_CTRL_FLAG_UPDATE
;
739 case V4L2_CID_AUDIO_VOLUME
:
740 case V4L2_CID_AUDIO_BALANCE
:
741 case V4L2_CID_AUDIO_BASS
:
742 case V4L2_CID_AUDIO_TREBLE
:
743 case V4L2_CID_BRIGHTNESS
:
744 case V4L2_CID_CONTRAST
:
745 case V4L2_CID_SATURATION
:
747 case V4L2_CID_RED_BALANCE
:
748 case V4L2_CID_BLUE_BALANCE
:
750 case V4L2_CID_SHARPNESS
:
751 case V4L2_CID_CHROMA_GAIN
:
752 case V4L2_CID_RDS_TX_DEVIATION
:
753 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME
:
754 case V4L2_CID_AUDIO_LIMITER_DEVIATION
:
755 case V4L2_CID_AUDIO_COMPRESSION_GAIN
:
756 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD
:
757 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME
:
758 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME
:
759 case V4L2_CID_PILOT_TONE_DEVIATION
:
760 case V4L2_CID_PILOT_TONE_FREQUENCY
:
761 case V4L2_CID_TUNE_POWER_LEVEL
:
762 case V4L2_CID_TUNE_ANTENNA_CAPACITOR
:
763 *flags
|= V4L2_CTRL_FLAG_SLIDER
;
765 case V4L2_CID_PAN_RELATIVE
:
766 case V4L2_CID_TILT_RELATIVE
:
767 case V4L2_CID_FOCUS_RELATIVE
:
768 case V4L2_CID_IRIS_RELATIVE
:
769 case V4L2_CID_ZOOM_RELATIVE
:
770 *flags
|= V4L2_CTRL_FLAG_WRITE_ONLY
;
772 case V4L2_CID_FLASH_STROBE_STATUS
:
773 case V4L2_CID_FLASH_READY
:
774 *flags
|= V4L2_CTRL_FLAG_READ_ONLY
;
778 EXPORT_SYMBOL(v4l2_ctrl_fill
);
780 /* Helper function to determine whether the control type is compatible with
782 static bool type_is_int(const struct v4l2_ctrl
*ctrl
)
784 switch (ctrl
->type
) {
785 case V4L2_CTRL_TYPE_INTEGER64
:
786 case V4L2_CTRL_TYPE_STRING
:
787 /* Nope, these need v4l2_ext_control */
794 static void fill_event(struct v4l2_event
*ev
, struct v4l2_ctrl
*ctrl
, u32 changes
)
796 memset(ev
->reserved
, 0, sizeof(ev
->reserved
));
797 ev
->type
= V4L2_EVENT_CTRL
;
799 ev
->u
.ctrl
.changes
= changes
;
800 ev
->u
.ctrl
.type
= ctrl
->type
;
801 ev
->u
.ctrl
.flags
= ctrl
->flags
;
802 if (ctrl
->type
== V4L2_CTRL_TYPE_STRING
)
803 ev
->u
.ctrl
.value64
= 0;
805 ev
->u
.ctrl
.value64
= ctrl
->cur
.val64
;
806 ev
->u
.ctrl
.minimum
= ctrl
->minimum
;
807 ev
->u
.ctrl
.maximum
= ctrl
->maximum
;
808 if (ctrl
->type
== V4L2_CTRL_TYPE_MENU
)
811 ev
->u
.ctrl
.step
= ctrl
->step
;
812 ev
->u
.ctrl
.default_value
= ctrl
->default_value
;
815 static void send_event(struct v4l2_fh
*fh
, struct v4l2_ctrl
*ctrl
, u32 changes
)
817 struct v4l2_event ev
;
818 struct v4l2_subscribed_event
*sev
;
820 if (list_empty(&ctrl
->ev_subs
))
822 fill_event(&ev
, ctrl
, changes
);
824 list_for_each_entry(sev
, &ctrl
->ev_subs
, node
)
826 (sev
->flags
& V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK
))
827 v4l2_event_queue_fh(sev
->fh
, &ev
);
830 /* Helper function: copy the current control value back to the caller */
831 static int cur_to_user(struct v4l2_ext_control
*c
,
832 struct v4l2_ctrl
*ctrl
)
836 switch (ctrl
->type
) {
837 case V4L2_CTRL_TYPE_STRING
:
838 len
= strlen(ctrl
->cur
.string
);
839 if (c
->size
< len
+ 1) {
843 return copy_to_user(c
->string
, ctrl
->cur
.string
,
844 len
+ 1) ? -EFAULT
: 0;
845 case V4L2_CTRL_TYPE_INTEGER64
:
846 c
->value64
= ctrl
->cur
.val64
;
849 c
->value
= ctrl
->cur
.val
;
855 /* Helper function: copy the caller-provider value as the new control value */
856 static int user_to_new(struct v4l2_ext_control
*c
,
857 struct v4l2_ctrl
*ctrl
)
863 switch (ctrl
->type
) {
864 case V4L2_CTRL_TYPE_INTEGER64
:
865 ctrl
->val64
= c
->value64
;
867 case V4L2_CTRL_TYPE_STRING
:
871 if (size
> ctrl
->maximum
+ 1)
872 size
= ctrl
->maximum
+ 1;
873 ret
= copy_from_user(ctrl
->string
, c
->string
, size
);
875 char last
= ctrl
->string
[size
- 1];
877 ctrl
->string
[size
- 1] = 0;
878 /* If the string was longer than ctrl->maximum,
879 then return an error. */
880 if (strlen(ctrl
->string
) == ctrl
->maximum
&& last
)
883 return ret
? -EFAULT
: 0;
885 ctrl
->val
= c
->value
;
891 /* Helper function: copy the new control value back to the caller */
892 static int new_to_user(struct v4l2_ext_control
*c
,
893 struct v4l2_ctrl
*ctrl
)
897 switch (ctrl
->type
) {
898 case V4L2_CTRL_TYPE_STRING
:
899 len
= strlen(ctrl
->string
);
900 if (c
->size
< len
+ 1) {
901 c
->size
= ctrl
->maximum
+ 1;
904 return copy_to_user(c
->string
, ctrl
->string
,
905 len
+ 1) ? -EFAULT
: 0;
906 case V4L2_CTRL_TYPE_INTEGER64
:
907 c
->value64
= ctrl
->val64
;
910 c
->value
= ctrl
->val
;
916 /* Copy the new value to the current value. */
917 static void new_to_cur(struct v4l2_fh
*fh
, struct v4l2_ctrl
*ctrl
,
918 bool update_inactive
)
920 bool changed
= false;
924 switch (ctrl
->type
) {
925 case V4L2_CTRL_TYPE_BUTTON
:
928 case V4L2_CTRL_TYPE_STRING
:
929 /* strings are always 0-terminated */
930 changed
= strcmp(ctrl
->string
, ctrl
->cur
.string
);
931 strcpy(ctrl
->cur
.string
, ctrl
->string
);
933 case V4L2_CTRL_TYPE_INTEGER64
:
934 changed
= ctrl
->val64
!= ctrl
->cur
.val64
;
935 ctrl
->cur
.val64
= ctrl
->val64
;
938 changed
= ctrl
->val
!= ctrl
->cur
.val
;
939 ctrl
->cur
.val
= ctrl
->val
;
942 if (update_inactive
) {
943 /* Note: update_inactive can only be true for auto clusters. */
945 ~(V4L2_CTRL_FLAG_INACTIVE
| V4L2_CTRL_FLAG_VOLATILE
);
946 if (!is_cur_manual(ctrl
->cluster
[0])) {
947 ctrl
->flags
|= V4L2_CTRL_FLAG_INACTIVE
;
948 if (ctrl
->cluster
[0]->has_volatiles
)
949 ctrl
->flags
|= V4L2_CTRL_FLAG_VOLATILE
;
953 if (changed
|| update_inactive
) {
954 /* If a control was changed that was not one of the controls
955 modified by the application, then send the event to all. */
959 (changed
? V4L2_EVENT_CTRL_CH_VALUE
: 0) |
960 (update_inactive
? V4L2_EVENT_CTRL_CH_FLAGS
: 0));
964 /* Copy the current value to the new value */
965 static void cur_to_new(struct v4l2_ctrl
*ctrl
)
969 switch (ctrl
->type
) {
970 case V4L2_CTRL_TYPE_STRING
:
971 /* strings are always 0-terminated */
972 strcpy(ctrl
->string
, ctrl
->cur
.string
);
974 case V4L2_CTRL_TYPE_INTEGER64
:
975 ctrl
->val64
= ctrl
->cur
.val64
;
978 ctrl
->val
= ctrl
->cur
.val
;
983 /* Return non-zero if one or more of the controls in the cluster has a new
984 value that differs from the current value. */
985 static int cluster_changed(struct v4l2_ctrl
*master
)
990 for (i
= 0; !diff
&& i
< master
->ncontrols
; i
++) {
991 struct v4l2_ctrl
*ctrl
= master
->cluster
[i
];
995 switch (ctrl
->type
) {
996 case V4L2_CTRL_TYPE_BUTTON
:
997 /* Button controls are always 'different' */
999 case V4L2_CTRL_TYPE_STRING
:
1000 /* strings are always 0-terminated */
1001 diff
= strcmp(ctrl
->string
, ctrl
->cur
.string
);
1003 case V4L2_CTRL_TYPE_INTEGER64
:
1004 diff
= ctrl
->val64
!= ctrl
->cur
.val64
;
1007 diff
= ctrl
->val
!= ctrl
->cur
.val
;
1014 /* Validate integer-type control */
1015 static int validate_new_int(const struct v4l2_ctrl
*ctrl
, s32
*pval
)
1020 switch (ctrl
->type
) {
1021 case V4L2_CTRL_TYPE_INTEGER
:
1022 /* Round towards the closest legal value */
1023 val
+= ctrl
->step
/ 2;
1024 if (val
< ctrl
->minimum
)
1025 val
= ctrl
->minimum
;
1026 if (val
> ctrl
->maximum
)
1027 val
= ctrl
->maximum
;
1028 offset
= val
- ctrl
->minimum
;
1029 offset
= ctrl
->step
* (offset
/ ctrl
->step
);
1030 val
= ctrl
->minimum
+ offset
;
1034 case V4L2_CTRL_TYPE_BOOLEAN
:
1038 case V4L2_CTRL_TYPE_MENU
:
1039 if (val
< ctrl
->minimum
|| val
> ctrl
->maximum
)
1041 if (ctrl
->qmenu
[val
][0] == '\0' ||
1042 (ctrl
->menu_skip_mask
& (1 << val
)))
1046 case V4L2_CTRL_TYPE_BITMASK
:
1047 *pval
&= ctrl
->maximum
;
1050 case V4L2_CTRL_TYPE_BUTTON
:
1051 case V4L2_CTRL_TYPE_CTRL_CLASS
:
1060 /* Validate a new control */
1061 static int validate_new(const struct v4l2_ctrl
*ctrl
, struct v4l2_ext_control
*c
)
1063 char *s
= c
->string
;
1066 switch (ctrl
->type
) {
1067 case V4L2_CTRL_TYPE_INTEGER
:
1068 case V4L2_CTRL_TYPE_BOOLEAN
:
1069 case V4L2_CTRL_TYPE_MENU
:
1070 case V4L2_CTRL_TYPE_BITMASK
:
1071 case V4L2_CTRL_TYPE_BUTTON
:
1072 case V4L2_CTRL_TYPE_CTRL_CLASS
:
1073 return validate_new_int(ctrl
, &c
->value
);
1075 case V4L2_CTRL_TYPE_INTEGER64
:
1078 case V4L2_CTRL_TYPE_STRING
:
1080 if (len
< ctrl
->minimum
)
1082 if ((len
- ctrl
->minimum
) % ctrl
->step
)
1091 static inline u32
node2id(struct list_head
*node
)
1093 return list_entry(node
, struct v4l2_ctrl_ref
, node
)->ctrl
->id
;
1096 /* Set the handler's error code if it wasn't set earlier already */
1097 static inline int handler_set_err(struct v4l2_ctrl_handler
*hdl
, int err
)
1099 if (hdl
->error
== 0)
1104 /* Initialize the handler */
1105 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler
*hdl
,
1106 unsigned nr_of_controls_hint
)
1108 mutex_init(&hdl
->lock
);
1109 INIT_LIST_HEAD(&hdl
->ctrls
);
1110 INIT_LIST_HEAD(&hdl
->ctrl_refs
);
1111 hdl
->nr_of_buckets
= 1 + nr_of_controls_hint
/ 8;
1112 hdl
->buckets
= kcalloc(hdl
->nr_of_buckets
, sizeof(hdl
->buckets
[0]),
1114 hdl
->error
= hdl
->buckets
? 0 : -ENOMEM
;
1117 EXPORT_SYMBOL(v4l2_ctrl_handler_init
);
1119 /* Free all controls and control refs */
1120 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler
*hdl
)
1122 struct v4l2_ctrl_ref
*ref
, *next_ref
;
1123 struct v4l2_ctrl
*ctrl
, *next_ctrl
;
1124 struct v4l2_subscribed_event
*sev
, *next_sev
;
1126 if (hdl
== NULL
|| hdl
->buckets
== NULL
)
1129 mutex_lock(&hdl
->lock
);
1130 /* Free all nodes */
1131 list_for_each_entry_safe(ref
, next_ref
, &hdl
->ctrl_refs
, node
) {
1132 list_del(&ref
->node
);
1135 /* Free all controls owned by the handler */
1136 list_for_each_entry_safe(ctrl
, next_ctrl
, &hdl
->ctrls
, node
) {
1137 list_del(&ctrl
->node
);
1138 list_for_each_entry_safe(sev
, next_sev
, &ctrl
->ev_subs
, node
)
1139 list_del(&sev
->node
);
1142 kfree(hdl
->buckets
);
1143 hdl
->buckets
= NULL
;
1146 mutex_unlock(&hdl
->lock
);
1148 EXPORT_SYMBOL(v4l2_ctrl_handler_free
);
1150 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1151 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1152 with applications that do not use the NEXT_CTRL flag.
1154 We just find the n-th private user control. It's O(N), but that should not
1155 be an issue in this particular case. */
1156 static struct v4l2_ctrl_ref
*find_private_ref(
1157 struct v4l2_ctrl_handler
*hdl
, u32 id
)
1159 struct v4l2_ctrl_ref
*ref
;
1161 id
-= V4L2_CID_PRIVATE_BASE
;
1162 list_for_each_entry(ref
, &hdl
->ctrl_refs
, node
) {
1163 /* Search for private user controls that are compatible with
1165 if (V4L2_CTRL_ID2CLASS(ref
->ctrl
->id
) == V4L2_CTRL_CLASS_USER
&&
1166 V4L2_CTRL_DRIVER_PRIV(ref
->ctrl
->id
)) {
1167 if (!type_is_int(ref
->ctrl
))
1177 /* Find a control with the given ID. */
1178 static struct v4l2_ctrl_ref
*find_ref(struct v4l2_ctrl_handler
*hdl
, u32 id
)
1180 struct v4l2_ctrl_ref
*ref
;
1183 id
&= V4L2_CTRL_ID_MASK
;
1185 /* Old-style private controls need special handling */
1186 if (id
>= V4L2_CID_PRIVATE_BASE
)
1187 return find_private_ref(hdl
, id
);
1188 bucket
= id
% hdl
->nr_of_buckets
;
1190 /* Simple optimization: cache the last control found */
1191 if (hdl
->cached
&& hdl
->cached
->ctrl
->id
== id
)
1194 /* Not in cache, search the hash */
1195 ref
= hdl
->buckets
? hdl
->buckets
[bucket
] : NULL
;
1196 while (ref
&& ref
->ctrl
->id
!= id
)
1200 hdl
->cached
= ref
; /* cache it! */
1204 /* Find a control with the given ID. Take the handler's lock first. */
1205 static struct v4l2_ctrl_ref
*find_ref_lock(
1206 struct v4l2_ctrl_handler
*hdl
, u32 id
)
1208 struct v4l2_ctrl_ref
*ref
= NULL
;
1211 mutex_lock(&hdl
->lock
);
1212 ref
= find_ref(hdl
, id
);
1213 mutex_unlock(&hdl
->lock
);
1218 /* Find a control with the given ID. */
1219 struct v4l2_ctrl
*v4l2_ctrl_find(struct v4l2_ctrl_handler
*hdl
, u32 id
)
1221 struct v4l2_ctrl_ref
*ref
= find_ref_lock(hdl
, id
);
1223 return ref
? ref
->ctrl
: NULL
;
1225 EXPORT_SYMBOL(v4l2_ctrl_find
);
1227 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1228 static int handler_new_ref(struct v4l2_ctrl_handler
*hdl
,
1229 struct v4l2_ctrl
*ctrl
)
1231 struct v4l2_ctrl_ref
*ref
;
1232 struct v4l2_ctrl_ref
*new_ref
;
1234 u32 class_ctrl
= V4L2_CTRL_ID2CLASS(id
) | 1;
1235 int bucket
= id
% hdl
->nr_of_buckets
; /* which bucket to use */
1237 /* Automatically add the control class if it is not yet present. */
1238 if (id
!= class_ctrl
&& find_ref_lock(hdl
, class_ctrl
) == NULL
)
1239 if (!v4l2_ctrl_new_std(hdl
, NULL
, class_ctrl
, 0, 0, 0, 0))
1245 new_ref
= kzalloc(sizeof(*new_ref
), GFP_KERNEL
);
1247 return handler_set_err(hdl
, -ENOMEM
);
1248 new_ref
->ctrl
= ctrl
;
1249 if (ctrl
->handler
== hdl
) {
1250 /* By default each control starts in a cluster of its own.
1251 new_ref->ctrl is basically a cluster array with one
1252 element, so that's perfect to use as the cluster pointer.
1253 But only do this for the handler that owns the control. */
1254 ctrl
->cluster
= &new_ref
->ctrl
;
1255 ctrl
->ncontrols
= 1;
1258 INIT_LIST_HEAD(&new_ref
->node
);
1260 mutex_lock(&hdl
->lock
);
1262 /* Add immediately at the end of the list if the list is empty, or if
1263 the last element in the list has a lower ID.
1264 This ensures that when elements are added in ascending order the
1265 insertion is an O(1) operation. */
1266 if (list_empty(&hdl
->ctrl_refs
) || id
> node2id(hdl
->ctrl_refs
.prev
)) {
1267 list_add_tail(&new_ref
->node
, &hdl
->ctrl_refs
);
1268 goto insert_in_hash
;
1271 /* Find insert position in sorted list */
1272 list_for_each_entry(ref
, &hdl
->ctrl_refs
, node
) {
1273 if (ref
->ctrl
->id
< id
)
1275 /* Don't add duplicates */
1276 if (ref
->ctrl
->id
== id
) {
1280 list_add(&new_ref
->node
, ref
->node
.prev
);
1285 /* Insert the control node in the hash */
1286 new_ref
->next
= hdl
->buckets
[bucket
];
1287 hdl
->buckets
[bucket
] = new_ref
;
1290 mutex_unlock(&hdl
->lock
);
1294 /* Add a new control */
1295 static struct v4l2_ctrl
*v4l2_ctrl_new(struct v4l2_ctrl_handler
*hdl
,
1296 const struct v4l2_ctrl_ops
*ops
,
1297 u32 id
, const char *name
, enum v4l2_ctrl_type type
,
1298 s32 min
, s32 max
, u32 step
, s32 def
,
1299 u32 flags
, const char * const *qmenu
, void *priv
)
1301 struct v4l2_ctrl
*ctrl
;
1302 unsigned sz_extra
= 0;
1308 if (id
== 0 || name
== NULL
|| id
>= V4L2_CID_PRIVATE_BASE
||
1309 (type
== V4L2_CTRL_TYPE_INTEGER
&& step
== 0) ||
1310 (type
== V4L2_CTRL_TYPE_BITMASK
&& max
== 0) ||
1311 (type
== V4L2_CTRL_TYPE_MENU
&& qmenu
== NULL
) ||
1312 (type
== V4L2_CTRL_TYPE_STRING
&& max
== 0)) {
1313 handler_set_err(hdl
, -ERANGE
);
1316 if (type
!= V4L2_CTRL_TYPE_BITMASK
&& max
< min
) {
1317 handler_set_err(hdl
, -ERANGE
);
1320 if ((type
== V4L2_CTRL_TYPE_INTEGER
||
1321 type
== V4L2_CTRL_TYPE_MENU
||
1322 type
== V4L2_CTRL_TYPE_BOOLEAN
) &&
1323 (def
< min
|| def
> max
)) {
1324 handler_set_err(hdl
, -ERANGE
);
1327 if (type
== V4L2_CTRL_TYPE_BITMASK
&& ((def
& ~max
) || min
|| step
)) {
1328 handler_set_err(hdl
, -ERANGE
);
1332 if (type
== V4L2_CTRL_TYPE_BUTTON
)
1333 flags
|= V4L2_CTRL_FLAG_WRITE_ONLY
;
1334 else if (type
== V4L2_CTRL_TYPE_CTRL_CLASS
)
1335 flags
|= V4L2_CTRL_FLAG_READ_ONLY
;
1336 else if (type
== V4L2_CTRL_TYPE_STRING
)
1337 sz_extra
+= 2 * (max
+ 1);
1339 ctrl
= kzalloc(sizeof(*ctrl
) + sz_extra
, GFP_KERNEL
);
1341 handler_set_err(hdl
, -ENOMEM
);
1345 INIT_LIST_HEAD(&ctrl
->node
);
1346 INIT_LIST_HEAD(&ctrl
->ev_subs
);
1347 ctrl
->handler
= hdl
;
1352 ctrl
->flags
= flags
;
1353 ctrl
->minimum
= min
;
1354 ctrl
->maximum
= max
;
1356 ctrl
->qmenu
= qmenu
;
1358 ctrl
->cur
.val
= ctrl
->val
= ctrl
->default_value
= def
;
1360 if (ctrl
->type
== V4L2_CTRL_TYPE_STRING
) {
1361 ctrl
->cur
.string
= (char *)&ctrl
[1] + sz_extra
- (max
+ 1);
1362 ctrl
->string
= (char *)&ctrl
[1] + sz_extra
- 2 * (max
+ 1);
1364 memset(ctrl
->cur
.string
, ' ', ctrl
->minimum
);
1366 if (handler_new_ref(hdl
, ctrl
)) {
1370 mutex_lock(&hdl
->lock
);
1371 list_add_tail(&ctrl
->node
, &hdl
->ctrls
);
1372 mutex_unlock(&hdl
->lock
);
1376 struct v4l2_ctrl
*v4l2_ctrl_new_custom(struct v4l2_ctrl_handler
*hdl
,
1377 const struct v4l2_ctrl_config
*cfg
, void *priv
)
1380 struct v4l2_ctrl
*ctrl
;
1381 const char *name
= cfg
->name
;
1382 const char * const *qmenu
= cfg
->qmenu
;
1383 enum v4l2_ctrl_type type
= cfg
->type
;
1384 u32 flags
= cfg
->flags
;
1387 u32 step
= cfg
->step
;
1391 v4l2_ctrl_fill(cfg
->id
, &name
, &type
, &min
, &max
, &step
,
1394 is_menu
= (cfg
->type
== V4L2_CTRL_TYPE_MENU
);
1398 WARN_ON(cfg
->menu_skip_mask
);
1399 if (is_menu
&& qmenu
== NULL
)
1400 qmenu
= v4l2_ctrl_get_menu(cfg
->id
);
1402 ctrl
= v4l2_ctrl_new(hdl
, cfg
->ops
, cfg
->id
, name
,
1404 is_menu
? cfg
->menu_skip_mask
: step
,
1405 def
, flags
, qmenu
, priv
);
1407 ctrl
->is_private
= cfg
->is_private
;
1410 EXPORT_SYMBOL(v4l2_ctrl_new_custom
);
1412 /* Helper function for standard non-menu controls */
1413 struct v4l2_ctrl
*v4l2_ctrl_new_std(struct v4l2_ctrl_handler
*hdl
,
1414 const struct v4l2_ctrl_ops
*ops
,
1415 u32 id
, s32 min
, s32 max
, u32 step
, s32 def
)
1418 enum v4l2_ctrl_type type
;
1421 v4l2_ctrl_fill(id
, &name
, &type
, &min
, &max
, &step
, &def
, &flags
);
1422 if (type
== V4L2_CTRL_TYPE_MENU
) {
1423 handler_set_err(hdl
, -EINVAL
);
1426 return v4l2_ctrl_new(hdl
, ops
, id
, name
, type
,
1427 min
, max
, step
, def
, flags
, NULL
, NULL
);
1429 EXPORT_SYMBOL(v4l2_ctrl_new_std
);
1431 /* Helper function for standard menu controls */
1432 struct v4l2_ctrl
*v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler
*hdl
,
1433 const struct v4l2_ctrl_ops
*ops
,
1434 u32 id
, s32 max
, s32 mask
, s32 def
)
1436 const char * const *qmenu
= v4l2_ctrl_get_menu(id
);
1438 enum v4l2_ctrl_type type
;
1443 v4l2_ctrl_fill(id
, &name
, &type
, &min
, &max
, &step
, &def
, &flags
);
1444 if (type
!= V4L2_CTRL_TYPE_MENU
) {
1445 handler_set_err(hdl
, -EINVAL
);
1448 return v4l2_ctrl_new(hdl
, ops
, id
, name
, type
,
1449 0, max
, mask
, def
, flags
, qmenu
, NULL
);
1451 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu
);
1453 /* Add a control from another handler to this handler */
1454 struct v4l2_ctrl
*v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler
*hdl
,
1455 struct v4l2_ctrl
*ctrl
)
1457 if (hdl
== NULL
|| hdl
->error
)
1460 handler_set_err(hdl
, -EINVAL
);
1463 if (ctrl
->handler
== hdl
)
1465 return handler_new_ref(hdl
, ctrl
) ? NULL
: ctrl
;
1467 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl
);
1469 /* Add the controls from another handler to our own. */
1470 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler
*hdl
,
1471 struct v4l2_ctrl_handler
*add
)
1473 struct v4l2_ctrl
*ctrl
;
1476 /* Do nothing if either handler is NULL or if they are the same */
1477 if (!hdl
|| !add
|| hdl
== add
)
1481 mutex_lock(&add
->lock
);
1482 list_for_each_entry(ctrl
, &add
->ctrls
, node
) {
1483 /* Skip handler-private controls. */
1484 if (ctrl
->is_private
)
1486 /* And control classes */
1487 if (ctrl
->type
== V4L2_CTRL_TYPE_CTRL_CLASS
)
1489 ret
= handler_new_ref(hdl
, ctrl
);
1493 mutex_unlock(&add
->lock
);
1496 EXPORT_SYMBOL(v4l2_ctrl_add_handler
);
1498 /* Cluster controls */
1499 void v4l2_ctrl_cluster(unsigned ncontrols
, struct v4l2_ctrl
**controls
)
1501 bool has_volatiles
= false;
1504 /* The first control is the master control and it must not be NULL */
1505 BUG_ON(ncontrols
== 0 || controls
[0] == NULL
);
1507 for (i
= 0; i
< ncontrols
; i
++) {
1509 controls
[i
]->cluster
= controls
;
1510 controls
[i
]->ncontrols
= ncontrols
;
1511 if (controls
[i
]->flags
& V4L2_CTRL_FLAG_VOLATILE
)
1512 has_volatiles
= true;
1515 controls
[0]->has_volatiles
= has_volatiles
;
1517 EXPORT_SYMBOL(v4l2_ctrl_cluster
);
1519 void v4l2_ctrl_auto_cluster(unsigned ncontrols
, struct v4l2_ctrl
**controls
,
1520 u8 manual_val
, bool set_volatile
)
1522 struct v4l2_ctrl
*master
= controls
[0];
1526 v4l2_ctrl_cluster(ncontrols
, controls
);
1527 WARN_ON(ncontrols
<= 1);
1528 WARN_ON(manual_val
< master
->minimum
|| manual_val
> master
->maximum
);
1529 WARN_ON(set_volatile
&& !has_op(master
, g_volatile_ctrl
));
1530 master
->is_auto
= true;
1531 master
->has_volatiles
= set_volatile
;
1532 master
->manual_mode_value
= manual_val
;
1533 master
->flags
|= V4L2_CTRL_FLAG_UPDATE
;
1535 if (!is_cur_manual(master
))
1536 flag
= V4L2_CTRL_FLAG_INACTIVE
|
1537 (set_volatile
? V4L2_CTRL_FLAG_VOLATILE
: 0);
1539 for (i
= 1; i
< ncontrols
; i
++)
1541 controls
[i
]->flags
|= flag
;
1543 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster
);
1545 /* Activate/deactivate a control. */
1546 void v4l2_ctrl_activate(struct v4l2_ctrl
*ctrl
, bool active
)
1548 /* invert since the actual flag is called 'inactive' */
1549 bool inactive
= !active
;
1556 /* set V4L2_CTRL_FLAG_INACTIVE */
1557 old
= test_and_set_bit(4, &ctrl
->flags
);
1559 /* clear V4L2_CTRL_FLAG_INACTIVE */
1560 old
= test_and_clear_bit(4, &ctrl
->flags
);
1561 if (old
!= inactive
)
1562 send_event(NULL
, ctrl
, V4L2_EVENT_CTRL_CH_FLAGS
);
1564 EXPORT_SYMBOL(v4l2_ctrl_activate
);
1566 /* Grab/ungrab a control.
1567 Typically used when streaming starts and you want to grab controls,
1568 preventing the user from changing them.
1570 Just call this and the framework will block any attempts to change
1572 void v4l2_ctrl_grab(struct v4l2_ctrl
*ctrl
, bool grabbed
)
1579 v4l2_ctrl_lock(ctrl
);
1581 /* set V4L2_CTRL_FLAG_GRABBED */
1582 old
= test_and_set_bit(1, &ctrl
->flags
);
1584 /* clear V4L2_CTRL_FLAG_GRABBED */
1585 old
= test_and_clear_bit(1, &ctrl
->flags
);
1587 send_event(NULL
, ctrl
, V4L2_EVENT_CTRL_CH_FLAGS
);
1588 v4l2_ctrl_unlock(ctrl
);
1590 EXPORT_SYMBOL(v4l2_ctrl_grab
);
1592 /* Log the control name and value */
1593 static void log_ctrl(const struct v4l2_ctrl
*ctrl
,
1594 const char *prefix
, const char *colon
)
1596 if (ctrl
->flags
& (V4L2_CTRL_FLAG_DISABLED
| V4L2_CTRL_FLAG_WRITE_ONLY
))
1598 if (ctrl
->type
== V4L2_CTRL_TYPE_CTRL_CLASS
)
1601 printk(KERN_INFO
"%s%s%s: ", prefix
, colon
, ctrl
->name
);
1603 switch (ctrl
->type
) {
1604 case V4L2_CTRL_TYPE_INTEGER
:
1605 printk(KERN_CONT
"%d", ctrl
->cur
.val
);
1607 case V4L2_CTRL_TYPE_BOOLEAN
:
1608 printk(KERN_CONT
"%s", ctrl
->cur
.val
? "true" : "false");
1610 case V4L2_CTRL_TYPE_MENU
:
1611 printk(KERN_CONT
"%s", ctrl
->qmenu
[ctrl
->cur
.val
]);
1613 case V4L2_CTRL_TYPE_BITMASK
:
1614 printk(KERN_CONT
"0x%08x", ctrl
->cur
.val
);
1616 case V4L2_CTRL_TYPE_INTEGER64
:
1617 printk(KERN_CONT
"%lld", ctrl
->cur
.val64
);
1619 case V4L2_CTRL_TYPE_STRING
:
1620 printk(KERN_CONT
"%s", ctrl
->cur
.string
);
1623 printk(KERN_CONT
"unknown type %d", ctrl
->type
);
1626 if (ctrl
->flags
& (V4L2_CTRL_FLAG_INACTIVE
|
1627 V4L2_CTRL_FLAG_GRABBED
|
1628 V4L2_CTRL_FLAG_VOLATILE
)) {
1629 if (ctrl
->flags
& V4L2_CTRL_FLAG_INACTIVE
)
1630 printk(KERN_CONT
" inactive");
1631 if (ctrl
->flags
& V4L2_CTRL_FLAG_GRABBED
)
1632 printk(KERN_CONT
" grabbed");
1633 if (ctrl
->flags
& V4L2_CTRL_FLAG_VOLATILE
)
1634 printk(KERN_CONT
" volatile");
1636 printk(KERN_CONT
"\n");
1639 /* Log all controls owned by the handler */
1640 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler
*hdl
,
1643 struct v4l2_ctrl
*ctrl
;
1644 const char *colon
= "";
1651 len
= strlen(prefix
);
1652 if (len
&& prefix
[len
- 1] != ' ')
1654 mutex_lock(&hdl
->lock
);
1655 list_for_each_entry(ctrl
, &hdl
->ctrls
, node
)
1656 if (!(ctrl
->flags
& V4L2_CTRL_FLAG_DISABLED
))
1657 log_ctrl(ctrl
, prefix
, colon
);
1658 mutex_unlock(&hdl
->lock
);
1660 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status
);
1662 /* Call s_ctrl for all controls owned by the handler */
1663 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler
*hdl
)
1665 struct v4l2_ctrl
*ctrl
;
1670 mutex_lock(&hdl
->lock
);
1671 list_for_each_entry(ctrl
, &hdl
->ctrls
, node
)
1674 list_for_each_entry(ctrl
, &hdl
->ctrls
, node
) {
1675 struct v4l2_ctrl
*master
= ctrl
->cluster
[0];
1678 /* Skip if this control was already handled by a cluster. */
1679 /* Skip button controls and read-only controls. */
1680 if (ctrl
->done
|| ctrl
->type
== V4L2_CTRL_TYPE_BUTTON
||
1681 (ctrl
->flags
& V4L2_CTRL_FLAG_READ_ONLY
))
1684 for (i
= 0; i
< master
->ncontrols
; i
++) {
1685 if (master
->cluster
[i
]) {
1686 cur_to_new(master
->cluster
[i
]);
1687 master
->cluster
[i
]->is_new
= 1;
1688 master
->cluster
[i
]->done
= true;
1691 ret
= call_op(master
, s_ctrl
);
1695 mutex_unlock(&hdl
->lock
);
1698 EXPORT_SYMBOL(v4l2_ctrl_handler_setup
);
1700 /* Implement VIDIOC_QUERYCTRL */
1701 int v4l2_queryctrl(struct v4l2_ctrl_handler
*hdl
, struct v4l2_queryctrl
*qc
)
1703 u32 id
= qc
->id
& V4L2_CTRL_ID_MASK
;
1704 struct v4l2_ctrl_ref
*ref
;
1705 struct v4l2_ctrl
*ctrl
;
1710 mutex_lock(&hdl
->lock
);
1712 /* Try to find it */
1713 ref
= find_ref(hdl
, id
);
1715 if ((qc
->id
& V4L2_CTRL_FLAG_NEXT_CTRL
) && !list_empty(&hdl
->ctrl_refs
)) {
1716 /* Find the next control with ID > qc->id */
1718 /* Did we reach the end of the control list? */
1719 if (id
>= node2id(hdl
->ctrl_refs
.prev
)) {
1720 ref
= NULL
; /* Yes, so there is no next control */
1722 /* We found a control with the given ID, so just get
1723 the next one in the list. */
1724 ref
= list_entry(ref
->node
.next
, typeof(*ref
), node
);
1726 /* No control with the given ID exists, so start
1727 searching for the next largest ID. We know there
1728 is one, otherwise the first 'if' above would have
1730 list_for_each_entry(ref
, &hdl
->ctrl_refs
, node
)
1731 if (id
< ref
->ctrl
->id
)
1735 mutex_unlock(&hdl
->lock
);
1740 memset(qc
, 0, sizeof(*qc
));
1741 if (id
>= V4L2_CID_PRIVATE_BASE
)
1745 strlcpy(qc
->name
, ctrl
->name
, sizeof(qc
->name
));
1746 qc
->minimum
= ctrl
->minimum
;
1747 qc
->maximum
= ctrl
->maximum
;
1748 qc
->default_value
= ctrl
->default_value
;
1749 if (ctrl
->type
== V4L2_CTRL_TYPE_MENU
)
1752 qc
->step
= ctrl
->step
;
1753 qc
->flags
= ctrl
->flags
;
1754 qc
->type
= ctrl
->type
;
1757 EXPORT_SYMBOL(v4l2_queryctrl
);
1759 int v4l2_subdev_queryctrl(struct v4l2_subdev
*sd
, struct v4l2_queryctrl
*qc
)
1761 if (qc
->id
& V4L2_CTRL_FLAG_NEXT_CTRL
)
1763 return v4l2_queryctrl(sd
->ctrl_handler
, qc
);
1765 EXPORT_SYMBOL(v4l2_subdev_queryctrl
);
1767 /* Implement VIDIOC_QUERYMENU */
1768 int v4l2_querymenu(struct v4l2_ctrl_handler
*hdl
, struct v4l2_querymenu
*qm
)
1770 struct v4l2_ctrl
*ctrl
;
1773 ctrl
= v4l2_ctrl_find(hdl
, qm
->id
);
1779 if (ctrl
->qmenu
== NULL
||
1780 i
< ctrl
->minimum
|| i
> ctrl
->maximum
)
1782 /* Use mask to see if this menu item should be skipped */
1783 if (ctrl
->menu_skip_mask
& (1 << i
))
1785 /* Empty menu items should also be skipped */
1786 if (ctrl
->qmenu
[i
] == NULL
|| ctrl
->qmenu
[i
][0] == '\0')
1788 strlcpy(qm
->name
, ctrl
->qmenu
[i
], sizeof(qm
->name
));
1791 EXPORT_SYMBOL(v4l2_querymenu
);
1793 int v4l2_subdev_querymenu(struct v4l2_subdev
*sd
, struct v4l2_querymenu
*qm
)
1795 return v4l2_querymenu(sd
->ctrl_handler
, qm
);
1797 EXPORT_SYMBOL(v4l2_subdev_querymenu
);
1801 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1803 It is not a fully atomic operation, just best-effort only. After all, if
1804 multiple controls have to be set through multiple i2c writes (for example)
1805 then some initial writes may succeed while others fail. Thus leaving the
1806 system in an inconsistent state. The question is how much effort you are
1807 willing to spend on trying to make something atomic that really isn't.
1809 From the point of view of an application the main requirement is that
1810 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1811 error should be returned without actually affecting any controls.
1813 If all the values are correct, then it is acceptable to just give up
1814 in case of low-level errors.
1816 It is important though that the application can tell when only a partial
1817 configuration was done. The way we do that is through the error_idx field
1818 of struct v4l2_ext_controls: if that is equal to the count field then no
1819 controls were affected. Otherwise all controls before that index were
1820 successful in performing their 'get' or 'set' operation, the control at
1821 the given index failed, and you don't know what happened with the controls
1822 after the failed one. Since if they were part of a control cluster they
1823 could have been successfully processed (if a cluster member was encountered
1824 at index < error_idx), they could have failed (if a cluster member was at
1825 error_idx), or they may not have been processed yet (if the first cluster
1826 member appeared after error_idx).
1828 It is all fairly theoretical, though. In practice all you can do is to
1829 bail out. If error_idx == count, then it is an application bug. If
1830 error_idx < count then it is only an application bug if the error code was
1831 EBUSY. That usually means that something started streaming just when you
1832 tried to set the controls. In all other cases it is a driver/hardware
1833 problem and all you can do is to retry or bail out.
1835 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1836 never modifies controls the error_idx is just set to whatever control
1837 has an invalid value.
1840 /* Prepare for the extended g/s/try functions.
1841 Find the controls in the control array and do some basic checks. */
1842 static int prepare_ext_ctrls(struct v4l2_ctrl_handler
*hdl
,
1843 struct v4l2_ext_controls
*cs
,
1844 struct v4l2_ctrl_helper
*helpers
)
1846 struct v4l2_ctrl_helper
*h
;
1847 bool have_clusters
= false;
1850 for (i
= 0, h
= helpers
; i
< cs
->count
; i
++, h
++) {
1851 struct v4l2_ext_control
*c
= &cs
->controls
[i
];
1852 struct v4l2_ctrl_ref
*ref
;
1853 struct v4l2_ctrl
*ctrl
;
1854 u32 id
= c
->id
& V4L2_CTRL_ID_MASK
;
1858 if (cs
->ctrl_class
&& V4L2_CTRL_ID2CLASS(id
) != cs
->ctrl_class
)
1861 /* Old-style private controls are not allowed for
1862 extended controls */
1863 if (id
>= V4L2_CID_PRIVATE_BASE
)
1865 ref
= find_ref_lock(hdl
, id
);
1869 if (ctrl
->flags
& V4L2_CTRL_FLAG_DISABLED
)
1872 if (ctrl
->cluster
[0]->ncontrols
> 1)
1873 have_clusters
= true;
1874 if (ctrl
->cluster
[0] != ctrl
)
1875 ref
= find_ref_lock(hdl
, ctrl
->cluster
[0]->id
);
1876 /* Store the ref to the master control of the cluster */
1879 /* Initially set next to 0, meaning that there is no other
1880 control in this helper array belonging to the same
1885 /* We are done if there were no controls that belong to a multi-
1890 /* The code below figures out in O(n) time which controls in the list
1891 belong to the same cluster. */
1893 /* This has to be done with the handler lock taken. */
1894 mutex_lock(&hdl
->lock
);
1896 /* First zero the helper field in the master control references */
1897 for (i
= 0; i
< cs
->count
; i
++)
1898 helpers
[i
].mref
->helper
= 0;
1899 for (i
= 0, h
= helpers
; i
< cs
->count
; i
++, h
++) {
1900 struct v4l2_ctrl_ref
*mref
= h
->mref
;
1902 /* If the mref->helper is set, then it points to an earlier
1903 helper that belongs to the same cluster. */
1905 /* Set the next field of mref->helper to the current
1906 index: this means that that earlier helper now
1907 points to the next helper in the same cluster. */
1908 mref
->helper
->next
= i
;
1909 /* mref should be set only for the first helper in the
1910 cluster, clear the others. */
1913 /* Point the mref helper to the current helper struct. */
1916 mutex_unlock(&hdl
->lock
);
1920 /* Handles the corner case where cs->count == 0. It checks whether the
1921 specified control class exists. If that class ID is 0, then it checks
1922 whether there are any controls at all. */
1923 static int class_check(struct v4l2_ctrl_handler
*hdl
, u32 ctrl_class
)
1925 if (ctrl_class
== 0)
1926 return list_empty(&hdl
->ctrl_refs
) ? -EINVAL
: 0;
1927 return find_ref_lock(hdl
, ctrl_class
| 1) ? 0 : -EINVAL
;
1932 /* Get extended controls. Allocates the helpers array if needed. */
1933 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler
*hdl
, struct v4l2_ext_controls
*cs
)
1935 struct v4l2_ctrl_helper helper
[4];
1936 struct v4l2_ctrl_helper
*helpers
= helper
;
1940 cs
->error_idx
= cs
->count
;
1941 cs
->ctrl_class
= V4L2_CTRL_ID2CLASS(cs
->ctrl_class
);
1947 return class_check(hdl
, cs
->ctrl_class
);
1949 if (cs
->count
> ARRAY_SIZE(helper
)) {
1950 helpers
= kmalloc(sizeof(helper
[0]) * cs
->count
, GFP_KERNEL
);
1951 if (helpers
== NULL
)
1955 ret
= prepare_ext_ctrls(hdl
, cs
, helpers
);
1956 cs
->error_idx
= cs
->count
;
1958 for (i
= 0; !ret
&& i
< cs
->count
; i
++)
1959 if (helpers
[i
].ctrl
->flags
& V4L2_CTRL_FLAG_WRITE_ONLY
)
1962 for (i
= 0; !ret
&& i
< cs
->count
; i
++) {
1963 int (*ctrl_to_user
)(struct v4l2_ext_control
*c
,
1964 struct v4l2_ctrl
*ctrl
) = cur_to_user
;
1965 struct v4l2_ctrl
*master
;
1967 if (helpers
[i
].mref
== NULL
)
1970 master
= helpers
[i
].mref
->ctrl
;
1973 v4l2_ctrl_lock(master
);
1975 /* g_volatile_ctrl will update the new control values */
1976 if ((master
->flags
& V4L2_CTRL_FLAG_VOLATILE
) ||
1977 (master
->has_volatiles
&& !is_cur_manual(master
))) {
1978 for (j
= 0; j
< master
->ncontrols
; j
++)
1979 cur_to_new(master
->cluster
[j
]);
1980 ret
= call_op(master
, g_volatile_ctrl
);
1981 ctrl_to_user
= new_to_user
;
1983 /* If OK, then copy the current (for non-volatile controls)
1984 or the new (for volatile controls) control values to the
1990 ret
= ctrl_to_user(cs
->controls
+ idx
,
1992 idx
= helpers
[idx
].next
;
1993 } while (!ret
&& idx
);
1995 v4l2_ctrl_unlock(master
);
1998 if (cs
->count
> ARRAY_SIZE(helper
))
2002 EXPORT_SYMBOL(v4l2_g_ext_ctrls
);
2004 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev
*sd
, struct v4l2_ext_controls
*cs
)
2006 return v4l2_g_ext_ctrls(sd
->ctrl_handler
, cs
);
2008 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls
);
2010 /* Helper function to get a single control */
2011 static int get_ctrl(struct v4l2_ctrl
*ctrl
, s32
*val
)
2013 struct v4l2_ctrl
*master
= ctrl
->cluster
[0];
2017 if (ctrl
->flags
& V4L2_CTRL_FLAG_WRITE_ONLY
)
2020 v4l2_ctrl_lock(master
);
2021 /* g_volatile_ctrl will update the current control values */
2022 if (ctrl
->flags
& V4L2_CTRL_FLAG_VOLATILE
) {
2023 for (i
= 0; i
< master
->ncontrols
; i
++)
2024 cur_to_new(master
->cluster
[i
]);
2025 ret
= call_op(master
, g_volatile_ctrl
);
2028 *val
= ctrl
->cur
.val
;
2030 v4l2_ctrl_unlock(master
);
2034 int v4l2_g_ctrl(struct v4l2_ctrl_handler
*hdl
, struct v4l2_control
*control
)
2036 struct v4l2_ctrl
*ctrl
= v4l2_ctrl_find(hdl
, control
->id
);
2038 if (ctrl
== NULL
|| !type_is_int(ctrl
))
2040 return get_ctrl(ctrl
, &control
->value
);
2042 EXPORT_SYMBOL(v4l2_g_ctrl
);
2044 int v4l2_subdev_g_ctrl(struct v4l2_subdev
*sd
, struct v4l2_control
*control
)
2046 return v4l2_g_ctrl(sd
->ctrl_handler
, control
);
2048 EXPORT_SYMBOL(v4l2_subdev_g_ctrl
);
2050 s32
v4l2_ctrl_g_ctrl(struct v4l2_ctrl
*ctrl
)
2054 /* It's a driver bug if this happens. */
2055 WARN_ON(!type_is_int(ctrl
));
2056 get_ctrl(ctrl
, &val
);
2059 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl
);
2062 /* Core function that calls try/s_ctrl and ensures that the new value is
2063 copied to the current value on a set.
2064 Must be called with ctrl->handler->lock held. */
2065 static int try_or_set_cluster(struct v4l2_fh
*fh
,
2066 struct v4l2_ctrl
*master
, bool set
)
2072 /* Go through the cluster and either validate the new value or
2073 (if no new value was set), copy the current value to the new
2074 value, ensuring a consistent view for the control ops when
2076 for (i
= 0; i
< master
->ncontrols
; i
++) {
2077 struct v4l2_ctrl
*ctrl
= master
->cluster
[i
];
2082 if (!ctrl
->is_new
) {
2086 /* Check again: it may have changed since the
2087 previous check in try_or_set_ext_ctrls(). */
2088 if (set
&& (ctrl
->flags
& V4L2_CTRL_FLAG_GRABBED
))
2092 ret
= call_op(master
, try_ctrl
);
2094 /* Don't set if there is no change */
2095 if (ret
|| !set
|| !cluster_changed(master
))
2097 ret
= call_op(master
, s_ctrl
);
2101 /* If OK, then make the new values permanent. */
2102 update_flag
= is_cur_manual(master
) != is_new_manual(master
);
2103 for (i
= 0; i
< master
->ncontrols
; i
++)
2104 new_to_cur(fh
, master
->cluster
[i
], update_flag
&& i
> 0);
2108 /* Validate controls. */
2109 static int validate_ctrls(struct v4l2_ext_controls
*cs
,
2110 struct v4l2_ctrl_helper
*helpers
, bool set
)
2115 cs
->error_idx
= cs
->count
;
2116 for (i
= 0; i
< cs
->count
; i
++) {
2117 struct v4l2_ctrl
*ctrl
= helpers
[i
].ctrl
;
2121 if (ctrl
->flags
& V4L2_CTRL_FLAG_READ_ONLY
)
2123 /* This test is also done in try_set_control_cluster() which
2124 is called in atomic context, so that has the final say,
2125 but it makes sense to do an up-front check as well. Once
2126 an error occurs in try_set_control_cluster() some other
2127 controls may have been set already and we want to do a
2128 best-effort to avoid that. */
2129 if (set
&& (ctrl
->flags
& V4L2_CTRL_FLAG_GRABBED
))
2131 ret
= validate_new(ctrl
, &cs
->controls
[i
]);
2138 /* Obtain the current volatile values of an autocluster and mark them
2140 static void update_from_auto_cluster(struct v4l2_ctrl
*master
)
2144 for (i
= 0; i
< master
->ncontrols
; i
++)
2145 cur_to_new(master
->cluster
[i
]);
2146 if (!call_op(master
, g_volatile_ctrl
))
2147 for (i
= 1; i
< master
->ncontrols
; i
++)
2148 if (master
->cluster
[i
])
2149 master
->cluster
[i
]->is_new
= 1;
2152 /* Try or try-and-set controls */
2153 static int try_set_ext_ctrls(struct v4l2_fh
*fh
, struct v4l2_ctrl_handler
*hdl
,
2154 struct v4l2_ext_controls
*cs
,
2157 struct v4l2_ctrl_helper helper
[4];
2158 struct v4l2_ctrl_helper
*helpers
= helper
;
2162 cs
->error_idx
= cs
->count
;
2163 cs
->ctrl_class
= V4L2_CTRL_ID2CLASS(cs
->ctrl_class
);
2169 return class_check(hdl
, cs
->ctrl_class
);
2171 if (cs
->count
> ARRAY_SIZE(helper
)) {
2172 helpers
= kmalloc(sizeof(helper
[0]) * cs
->count
, GFP_KERNEL
);
2176 ret
= prepare_ext_ctrls(hdl
, cs
, helpers
);
2178 ret
= validate_ctrls(cs
, helpers
, set
);
2180 cs
->error_idx
= cs
->count
;
2181 for (i
= 0; !ret
&& i
< cs
->count
; i
++) {
2182 struct v4l2_ctrl
*master
;
2185 if (helpers
[i
].mref
== NULL
)
2189 master
= helpers
[i
].mref
->ctrl
;
2190 v4l2_ctrl_lock(master
);
2192 /* Reset the 'is_new' flags of the cluster */
2193 for (j
= 0; j
< master
->ncontrols
; j
++)
2194 if (master
->cluster
[j
])
2195 master
->cluster
[j
]->is_new
= 0;
2197 /* For volatile autoclusters that are currently in auto mode
2198 we need to discover if it will be set to manual mode.
2199 If so, then we have to copy the current volatile values
2200 first since those will become the new manual values (which
2201 may be overwritten by explicit new values from this set
2203 if (master
->is_auto
&& master
->has_volatiles
&&
2204 !is_cur_manual(master
)) {
2205 /* Pick an initial non-manual value */
2206 s32 new_auto_val
= master
->manual_mode_value
+ 1;
2210 /* Check if the auto control is part of the
2211 list, and remember the new value. */
2212 if (helpers
[tmp_idx
].ctrl
== master
)
2213 new_auto_val
= cs
->controls
[tmp_idx
].value
;
2214 tmp_idx
= helpers
[tmp_idx
].next
;
2216 /* If the new value == the manual value, then copy
2217 the current volatile values. */
2218 if (new_auto_val
== master
->manual_mode_value
)
2219 update_from_auto_cluster(master
);
2222 /* Copy the new caller-supplied control values.
2223 user_to_new() sets 'is_new' to 1. */
2225 ret
= user_to_new(cs
->controls
+ idx
, helpers
[idx
].ctrl
);
2226 idx
= helpers
[idx
].next
;
2227 } while (!ret
&& idx
);
2230 ret
= try_or_set_cluster(fh
, master
, set
);
2232 /* Copy the new values back to userspace. */
2236 ret
= new_to_user(cs
->controls
+ idx
,
2238 idx
= helpers
[idx
].next
;
2239 } while (!ret
&& idx
);
2241 v4l2_ctrl_unlock(master
);
2244 if (cs
->count
> ARRAY_SIZE(helper
))
2249 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler
*hdl
, struct v4l2_ext_controls
*cs
)
2251 return try_set_ext_ctrls(NULL
, hdl
, cs
, false);
2253 EXPORT_SYMBOL(v4l2_try_ext_ctrls
);
2255 int v4l2_s_ext_ctrls(struct v4l2_fh
*fh
, struct v4l2_ctrl_handler
*hdl
,
2256 struct v4l2_ext_controls
*cs
)
2258 return try_set_ext_ctrls(fh
, hdl
, cs
, true);
2260 EXPORT_SYMBOL(v4l2_s_ext_ctrls
);
2262 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev
*sd
, struct v4l2_ext_controls
*cs
)
2264 return try_set_ext_ctrls(NULL
, sd
->ctrl_handler
, cs
, false);
2266 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls
);
2268 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev
*sd
, struct v4l2_ext_controls
*cs
)
2270 return try_set_ext_ctrls(NULL
, sd
->ctrl_handler
, cs
, true);
2272 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls
);
2274 /* Helper function for VIDIOC_S_CTRL compatibility */
2275 static int set_ctrl(struct v4l2_fh
*fh
, struct v4l2_ctrl
*ctrl
, s32
*val
)
2277 struct v4l2_ctrl
*master
= ctrl
->cluster
[0];
2281 ret
= validate_new_int(ctrl
, val
);
2285 v4l2_ctrl_lock(ctrl
);
2287 /* Reset the 'is_new' flags of the cluster */
2288 for (i
= 0; i
< master
->ncontrols
; i
++)
2289 if (master
->cluster
[i
])
2290 master
->cluster
[i
]->is_new
= 0;
2292 /* For autoclusters with volatiles that are switched from auto to
2293 manual mode we have to update the current volatile values since
2294 those will become the initial manual values after such a switch. */
2295 if (master
->is_auto
&& master
->has_volatiles
&& ctrl
== master
&&
2296 !is_cur_manual(master
) && *val
== master
->manual_mode_value
)
2297 update_from_auto_cluster(master
);
2300 ret
= try_or_set_cluster(fh
, master
, true);
2301 *val
= ctrl
->cur
.val
;
2302 v4l2_ctrl_unlock(ctrl
);
2306 int v4l2_s_ctrl(struct v4l2_fh
*fh
, struct v4l2_ctrl_handler
*hdl
,
2307 struct v4l2_control
*control
)
2309 struct v4l2_ctrl
*ctrl
= v4l2_ctrl_find(hdl
, control
->id
);
2311 if (ctrl
== NULL
|| !type_is_int(ctrl
))
2314 if (ctrl
->flags
& V4L2_CTRL_FLAG_READ_ONLY
)
2317 return set_ctrl(fh
, ctrl
, &control
->value
);
2319 EXPORT_SYMBOL(v4l2_s_ctrl
);
2321 int v4l2_subdev_s_ctrl(struct v4l2_subdev
*sd
, struct v4l2_control
*control
)
2323 return v4l2_s_ctrl(NULL
, sd
->ctrl_handler
, control
);
2325 EXPORT_SYMBOL(v4l2_subdev_s_ctrl
);
2327 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl
*ctrl
, s32 val
)
2329 /* It's a driver bug if this happens. */
2330 WARN_ON(!type_is_int(ctrl
));
2331 return set_ctrl(NULL
, ctrl
, &val
);
2333 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl
);
2335 void v4l2_ctrl_add_event(struct v4l2_ctrl
*ctrl
,
2336 struct v4l2_subscribed_event
*sev
)
2338 v4l2_ctrl_lock(ctrl
);
2339 list_add_tail(&sev
->node
, &ctrl
->ev_subs
);
2340 if (ctrl
->type
!= V4L2_CTRL_TYPE_CTRL_CLASS
&&
2341 (sev
->flags
& V4L2_EVENT_SUB_FL_SEND_INITIAL
)) {
2342 struct v4l2_event ev
;
2343 u32 changes
= V4L2_EVENT_CTRL_CH_FLAGS
;
2345 if (!(ctrl
->flags
& V4L2_CTRL_FLAG_WRITE_ONLY
))
2346 changes
|= V4L2_EVENT_CTRL_CH_VALUE
;
2347 fill_event(&ev
, ctrl
, changes
);
2348 v4l2_event_queue_fh(sev
->fh
, &ev
);
2350 v4l2_ctrl_unlock(ctrl
);
2352 EXPORT_SYMBOL(v4l2_ctrl_add_event
);
2354 void v4l2_ctrl_del_event(struct v4l2_ctrl
*ctrl
,
2355 struct v4l2_subscribed_event
*sev
)
2357 v4l2_ctrl_lock(ctrl
);
2358 list_del(&sev
->node
);
2359 v4l2_ctrl_unlock(ctrl
);
2361 EXPORT_SYMBOL(v4l2_ctrl_del_event
);