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 */
36 /* The control corresponding to the v4l2_ext_control ID field. */
37 struct v4l2_ctrl *ctrl;
38 /* Used internally to mark whether this control was already
43 /* Small helper function to determine if the autocluster is set to manual
44 mode. In that case the is_volatile flag should be ignored. */
45 static bool is_cur_manual(const struct v4l2_ctrl *master)
47 return master->is_auto && master->cur.val == master->manual_mode_value;
50 /* Same as above, but this checks the against the new value instead of the
52 static bool is_new_manual(const struct v4l2_ctrl *master)
54 return master->is_auto && master->val == master->manual_mode_value;
57 /* Returns NULL or a character pointer array containing the menu for
58 the given control ID. The pointer array ends with a NULL pointer.
59 An empty string signifies a menu entry that is invalid. This allows
60 drivers to disable certain options if it is not supported. */
61 const char * const *v4l2_ctrl_get_menu(u32 id)
63 static const char * const mpeg_audio_sampling_freq[] = {
69 static const char * const mpeg_audio_encoding[] = {
77 static const char * const mpeg_audio_l1_bitrate[] = {
94 static const char * const mpeg_audio_l2_bitrate[] = {
111 static const char * const mpeg_audio_l3_bitrate[] = {
128 static const char * const mpeg_audio_ac3_bitrate[] = {
150 static const char * const mpeg_audio_mode[] = {
157 static const char * const mpeg_audio_mode_extension[] = {
164 static const char * const mpeg_audio_emphasis[] = {
170 static const char * const mpeg_audio_crc[] = {
175 static const char * const mpeg_video_encoding[] = {
181 static const char * const mpeg_video_aspect[] = {
188 static const char * const mpeg_video_bitrate_mode[] = {
193 static const char * const mpeg_stream_type[] = {
194 "MPEG-2 Program Stream",
195 "MPEG-2 Transport Stream",
196 "MPEG-1 System Stream",
197 "MPEG-2 DVD-compatible Stream",
198 "MPEG-1 VCD-compatible Stream",
199 "MPEG-2 SVCD-compatible Stream",
202 static const char * const mpeg_stream_vbi_fmt[] = {
204 "Private packet, IVTV format",
207 static const char * const camera_power_line_frequency[] = {
213 static const char * const camera_exposure_auto[] = {
216 "Shutter Priority Mode",
217 "Aperture Priority Mode",
220 static const char * const colorfx[] = {
233 static const char * const tune_preemphasis[] = {
241 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
242 return mpeg_audio_sampling_freq;
243 case V4L2_CID_MPEG_AUDIO_ENCODING:
244 return mpeg_audio_encoding;
245 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
246 return mpeg_audio_l1_bitrate;
247 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
248 return mpeg_audio_l2_bitrate;
249 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
250 return mpeg_audio_l3_bitrate;
251 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
252 return mpeg_audio_ac3_bitrate;
253 case V4L2_CID_MPEG_AUDIO_MODE:
254 return mpeg_audio_mode;
255 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
256 return mpeg_audio_mode_extension;
257 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
258 return mpeg_audio_emphasis;
259 case V4L2_CID_MPEG_AUDIO_CRC:
260 return mpeg_audio_crc;
261 case V4L2_CID_MPEG_VIDEO_ENCODING:
262 return mpeg_video_encoding;
263 case V4L2_CID_MPEG_VIDEO_ASPECT:
264 return mpeg_video_aspect;
265 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
266 return mpeg_video_bitrate_mode;
267 case V4L2_CID_MPEG_STREAM_TYPE:
268 return mpeg_stream_type;
269 case V4L2_CID_MPEG_STREAM_VBI_FMT:
270 return mpeg_stream_vbi_fmt;
271 case V4L2_CID_POWER_LINE_FREQUENCY:
272 return camera_power_line_frequency;
273 case V4L2_CID_EXPOSURE_AUTO:
274 return camera_exposure_auto;
275 case V4L2_CID_COLORFX:
277 case V4L2_CID_TUNE_PREEMPHASIS:
278 return tune_preemphasis;
283 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
285 /* Return the control name. */
286 const char *v4l2_ctrl_get_name(u32 id)
290 /* Keep the order of the 'case's the same as in videodev2.h! */
291 case V4L2_CID_USER_CLASS: return "User Controls";
292 case V4L2_CID_BRIGHTNESS: return "Brightness";
293 case V4L2_CID_CONTRAST: return "Contrast";
294 case V4L2_CID_SATURATION: return "Saturation";
295 case V4L2_CID_HUE: return "Hue";
296 case V4L2_CID_AUDIO_VOLUME: return "Volume";
297 case V4L2_CID_AUDIO_BALANCE: return "Balance";
298 case V4L2_CID_AUDIO_BASS: return "Bass";
299 case V4L2_CID_AUDIO_TREBLE: return "Treble";
300 case V4L2_CID_AUDIO_MUTE: return "Mute";
301 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
302 case V4L2_CID_BLACK_LEVEL: return "Black Level";
303 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
304 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
305 case V4L2_CID_RED_BALANCE: return "Red Balance";
306 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
307 case V4L2_CID_GAMMA: return "Gamma";
308 case V4L2_CID_EXPOSURE: return "Exposure";
309 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
310 case V4L2_CID_GAIN: return "Gain";
311 case V4L2_CID_HFLIP: return "Horizontal Flip";
312 case V4L2_CID_VFLIP: return "Vertical Flip";
313 case V4L2_CID_HCENTER: return "Horizontal Center";
314 case V4L2_CID_VCENTER: return "Vertical Center";
315 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
316 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
317 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
318 case V4L2_CID_SHARPNESS: return "Sharpness";
319 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
320 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
321 case V4L2_CID_COLOR_KILLER: return "Color Killer";
322 case V4L2_CID_COLORFX: return "Color Effects";
323 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
324 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
325 case V4L2_CID_ROTATE: return "Rotate";
326 case V4L2_CID_BG_COLOR: return "Background Color";
327 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
328 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
329 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
332 /* Keep the order of the 'case's the same as in videodev2.h! */
333 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
334 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
335 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
336 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
337 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
338 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
339 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
340 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
341 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
342 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
343 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
344 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
345 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
346 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
347 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
348 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
349 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
350 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
351 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
352 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
353 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
354 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
355 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
356 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
357 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
358 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
359 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
360 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
361 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
362 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
363 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
364 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
365 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
367 /* CAMERA controls */
368 /* Keep the order of the 'case's the same as in videodev2.h! */
369 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
370 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
371 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
372 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
373 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
374 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
375 case V4L2_CID_PAN_RESET: return "Pan, Reset";
376 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
377 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
378 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
379 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
380 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
381 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
382 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
383 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
384 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
385 case V4L2_CID_PRIVACY: return "Privacy";
386 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
387 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
389 /* FM Radio Modulator control */
390 /* Keep the order of the 'case's the same as in videodev2.h! */
391 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
392 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
393 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
394 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
395 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
396 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
397 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
398 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
399 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
400 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Feature Enabled";
401 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
402 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
403 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
404 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
405 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
406 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
407 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
408 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-emphasis settings";
409 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
410 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
416 EXPORT_SYMBOL(v4l2_ctrl_get_name);
418 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
419 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
421 *name = v4l2_ctrl_get_name(id);
425 case V4L2_CID_AUDIO_MUTE:
426 case V4L2_CID_AUDIO_LOUDNESS:
427 case V4L2_CID_AUTO_WHITE_BALANCE:
428 case V4L2_CID_AUTOGAIN:
431 case V4L2_CID_HUE_AUTO:
432 case V4L2_CID_CHROMA_AGC:
433 case V4L2_CID_COLOR_KILLER:
434 case V4L2_CID_MPEG_AUDIO_MUTE:
435 case V4L2_CID_MPEG_VIDEO_MUTE:
436 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
437 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
438 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
439 case V4L2_CID_FOCUS_AUTO:
440 case V4L2_CID_PRIVACY:
441 case V4L2_CID_AUDIO_LIMITER_ENABLED:
442 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
443 case V4L2_CID_PILOT_TONE_ENABLED:
444 case V4L2_CID_ILLUMINATORS_1:
445 case V4L2_CID_ILLUMINATORS_2:
446 *type = V4L2_CTRL_TYPE_BOOLEAN;
450 case V4L2_CID_PAN_RESET:
451 case V4L2_CID_TILT_RESET:
452 *type = V4L2_CTRL_TYPE_BUTTON;
453 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
454 *min = *max = *step = *def = 0;
456 case V4L2_CID_POWER_LINE_FREQUENCY:
457 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
458 case V4L2_CID_MPEG_AUDIO_ENCODING:
459 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
460 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
461 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
462 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
463 case V4L2_CID_MPEG_AUDIO_MODE:
464 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
465 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
466 case V4L2_CID_MPEG_AUDIO_CRC:
467 case V4L2_CID_MPEG_VIDEO_ENCODING:
468 case V4L2_CID_MPEG_VIDEO_ASPECT:
469 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
470 case V4L2_CID_MPEG_STREAM_TYPE:
471 case V4L2_CID_MPEG_STREAM_VBI_FMT:
472 case V4L2_CID_EXPOSURE_AUTO:
473 case V4L2_CID_COLORFX:
474 case V4L2_CID_TUNE_PREEMPHASIS:
475 *type = V4L2_CTRL_TYPE_MENU;
477 case V4L2_CID_RDS_TX_PS_NAME:
478 case V4L2_CID_RDS_TX_RADIO_TEXT:
479 *type = V4L2_CTRL_TYPE_STRING;
481 case V4L2_CID_USER_CLASS:
482 case V4L2_CID_CAMERA_CLASS:
483 case V4L2_CID_MPEG_CLASS:
484 case V4L2_CID_FM_TX_CLASS:
485 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
486 /* You can neither read not write these */
487 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
488 *min = *max = *step = *def = 0;
490 case V4L2_CID_BG_COLOR:
491 *type = V4L2_CTRL_TYPE_INTEGER;
494 /* Max is calculated as RGB888 that is 2^24 */
498 *type = V4L2_CTRL_TYPE_INTEGER;
502 case V4L2_CID_MPEG_AUDIO_ENCODING:
503 case V4L2_CID_MPEG_AUDIO_MODE:
504 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
505 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
506 case V4L2_CID_MPEG_STREAM_TYPE:
507 *flags |= V4L2_CTRL_FLAG_UPDATE;
509 case V4L2_CID_AUDIO_VOLUME:
510 case V4L2_CID_AUDIO_BALANCE:
511 case V4L2_CID_AUDIO_BASS:
512 case V4L2_CID_AUDIO_TREBLE:
513 case V4L2_CID_BRIGHTNESS:
514 case V4L2_CID_CONTRAST:
515 case V4L2_CID_SATURATION:
517 case V4L2_CID_RED_BALANCE:
518 case V4L2_CID_BLUE_BALANCE:
520 case V4L2_CID_SHARPNESS:
521 case V4L2_CID_CHROMA_GAIN:
522 case V4L2_CID_RDS_TX_DEVIATION:
523 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
524 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
525 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
526 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
527 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
528 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
529 case V4L2_CID_PILOT_TONE_DEVIATION:
530 case V4L2_CID_PILOT_TONE_FREQUENCY:
531 case V4L2_CID_TUNE_POWER_LEVEL:
532 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
533 *flags |= V4L2_CTRL_FLAG_SLIDER;
535 case V4L2_CID_PAN_RELATIVE:
536 case V4L2_CID_TILT_RELATIVE:
537 case V4L2_CID_FOCUS_RELATIVE:
538 case V4L2_CID_IRIS_RELATIVE:
539 case V4L2_CID_ZOOM_RELATIVE:
540 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
544 EXPORT_SYMBOL(v4l2_ctrl_fill);
546 /* Helper function to determine whether the control type is compatible with
548 static bool type_is_int(const struct v4l2_ctrl *ctrl)
550 switch (ctrl->type) {
551 case V4L2_CTRL_TYPE_INTEGER64:
552 case V4L2_CTRL_TYPE_STRING:
553 /* Nope, these need v4l2_ext_control */
560 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
562 memset(ev->reserved, 0, sizeof(ev->reserved));
563 ev->type = V4L2_EVENT_CTRL;
565 ev->u.ctrl.changes = changes;
566 ev->u.ctrl.type = ctrl->type;
567 ev->u.ctrl.flags = ctrl->flags;
568 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
569 ev->u.ctrl.value64 = 0;
571 ev->u.ctrl.value64 = ctrl->cur.val64;
572 ev->u.ctrl.minimum = ctrl->minimum;
573 ev->u.ctrl.maximum = ctrl->maximum;
574 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
577 ev->u.ctrl.step = ctrl->step;
578 ev->u.ctrl.default_value = ctrl->default_value;
581 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
583 struct v4l2_event ev;
584 struct v4l2_ctrl_fh *pos;
586 if (list_empty(&ctrl->fhs))
588 fill_event(&ev, ctrl, changes);
590 list_for_each_entry(pos, &ctrl->fhs, node)
592 v4l2_event_queue_fh(pos->fh, &ev);
595 /* Helper function: copy the current control value back to the caller */
596 static int cur_to_user(struct v4l2_ext_control *c,
597 struct v4l2_ctrl *ctrl)
601 switch (ctrl->type) {
602 case V4L2_CTRL_TYPE_STRING:
603 len = strlen(ctrl->cur.string);
604 if (c->size < len + 1) {
608 return copy_to_user(c->string, ctrl->cur.string,
609 len + 1) ? -EFAULT : 0;
610 case V4L2_CTRL_TYPE_INTEGER64:
611 c->value64 = ctrl->cur.val64;
614 c->value = ctrl->cur.val;
620 /* Helper function: copy the caller-provider value as the new control value */
621 static int user_to_new(struct v4l2_ext_control *c,
622 struct v4l2_ctrl *ctrl)
628 switch (ctrl->type) {
629 case V4L2_CTRL_TYPE_INTEGER64:
630 ctrl->val64 = c->value64;
632 case V4L2_CTRL_TYPE_STRING:
636 if (size > ctrl->maximum + 1)
637 size = ctrl->maximum + 1;
638 ret = copy_from_user(ctrl->string, c->string, size);
640 char last = ctrl->string[size - 1];
642 ctrl->string[size - 1] = 0;
643 /* If the string was longer than ctrl->maximum,
644 then return an error. */
645 if (strlen(ctrl->string) == ctrl->maximum && last)
648 return ret ? -EFAULT : 0;
650 ctrl->val = c->value;
656 /* Helper function: copy the new control value back to the caller */
657 static int new_to_user(struct v4l2_ext_control *c,
658 struct v4l2_ctrl *ctrl)
662 switch (ctrl->type) {
663 case V4L2_CTRL_TYPE_STRING:
664 len = strlen(ctrl->string);
665 if (c->size < len + 1) {
666 c->size = ctrl->maximum + 1;
669 return copy_to_user(c->string, ctrl->string,
670 len + 1) ? -EFAULT : 0;
671 case V4L2_CTRL_TYPE_INTEGER64:
672 c->value64 = ctrl->val64;
675 c->value = ctrl->val;
681 static int ctrl_to_user(struct v4l2_ext_control *c,
682 struct v4l2_ctrl *ctrl)
684 if (ctrl->is_volatile)
685 return new_to_user(c, ctrl);
686 return cur_to_user(c, ctrl);
689 static int ctrl_is_volatile(struct v4l2_ext_control *c,
690 struct v4l2_ctrl *ctrl)
692 return ctrl->is_volatile;
695 /* Copy the new value to the current value. */
696 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
697 bool update_inactive)
699 bool changed = false;
703 switch (ctrl->type) {
704 case V4L2_CTRL_TYPE_BUTTON:
707 case V4L2_CTRL_TYPE_STRING:
708 /* strings are always 0-terminated */
709 changed = strcmp(ctrl->string, ctrl->cur.string);
710 strcpy(ctrl->cur.string, ctrl->string);
712 case V4L2_CTRL_TYPE_INTEGER64:
713 changed = ctrl->val64 != ctrl->cur.val64;
714 ctrl->cur.val64 = ctrl->val64;
717 changed = ctrl->val != ctrl->cur.val;
718 ctrl->cur.val = ctrl->val;
721 if (update_inactive) {
722 ctrl->flags &= ~V4L2_CTRL_FLAG_INACTIVE;
723 if (!is_cur_manual(ctrl->cluster[0]))
724 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
726 if (changed || update_inactive)
728 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
729 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
732 /* Copy the current value to the new value */
733 static void cur_to_new(struct v4l2_ctrl *ctrl)
737 switch (ctrl->type) {
738 case V4L2_CTRL_TYPE_STRING:
739 /* strings are always 0-terminated */
740 strcpy(ctrl->string, ctrl->cur.string);
742 case V4L2_CTRL_TYPE_INTEGER64:
743 ctrl->val64 = ctrl->cur.val64;
746 ctrl->val = ctrl->cur.val;
751 /* Return non-zero if one or more of the controls in the cluster has a new
752 value that differs from the current value. */
753 static int cluster_changed(struct v4l2_ctrl *master)
758 for (i = 0; !diff && i < master->ncontrols; i++) {
759 struct v4l2_ctrl *ctrl = master->cluster[i];
763 switch (ctrl->type) {
764 case V4L2_CTRL_TYPE_BUTTON:
765 /* Button controls are always 'different' */
767 case V4L2_CTRL_TYPE_STRING:
768 /* strings are always 0-terminated */
769 diff = strcmp(ctrl->string, ctrl->cur.string);
771 case V4L2_CTRL_TYPE_INTEGER64:
772 diff = ctrl->val64 != ctrl->cur.val64;
775 diff = ctrl->val != ctrl->cur.val;
782 /* Validate a new control */
783 static int validate_new(struct v4l2_ctrl *ctrl)
786 char *s = ctrl->string;
790 switch (ctrl->type) {
791 case V4L2_CTRL_TYPE_INTEGER:
792 /* Round towards the closest legal value */
793 val += ctrl->step / 2;
794 if (val < ctrl->minimum)
796 if (val > ctrl->maximum)
798 offset = val - ctrl->minimum;
799 offset = ctrl->step * (offset / ctrl->step);
800 val = ctrl->minimum + offset;
804 case V4L2_CTRL_TYPE_BOOLEAN:
805 ctrl->val = !!ctrl->val;
808 case V4L2_CTRL_TYPE_MENU:
809 if (val < ctrl->minimum || val > ctrl->maximum)
811 if (ctrl->qmenu[val][0] == '\0' ||
812 (ctrl->menu_skip_mask & (1 << val)))
816 case V4L2_CTRL_TYPE_BUTTON:
817 case V4L2_CTRL_TYPE_CTRL_CLASS:
821 case V4L2_CTRL_TYPE_INTEGER64:
824 case V4L2_CTRL_TYPE_STRING:
826 if (len < ctrl->minimum)
828 if ((len - ctrl->minimum) % ctrl->step)
837 static inline u32 node2id(struct list_head *node)
839 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
842 /* Set the handler's error code if it wasn't set earlier already */
843 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
850 /* Initialize the handler */
851 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
852 unsigned nr_of_controls_hint)
854 mutex_init(&hdl->lock);
855 INIT_LIST_HEAD(&hdl->ctrls);
856 INIT_LIST_HEAD(&hdl->ctrl_refs);
857 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
858 hdl->buckets = kzalloc(sizeof(hdl->buckets[0]) * hdl->nr_of_buckets,
860 hdl->error = hdl->buckets ? 0 : -ENOMEM;
863 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
865 /* Free all controls and control refs */
866 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
868 struct v4l2_ctrl_ref *ref, *next_ref;
869 struct v4l2_ctrl *ctrl, *next_ctrl;
870 struct v4l2_ctrl_fh *ctrl_fh, *next_ctrl_fh;
872 if (hdl == NULL || hdl->buckets == NULL)
875 mutex_lock(&hdl->lock);
877 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
878 list_del(&ref->node);
881 /* Free all controls owned by the handler */
882 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
883 list_del(&ctrl->node);
884 list_for_each_entry_safe(ctrl_fh, next_ctrl_fh, &ctrl->fhs, node) {
885 list_del(&ctrl_fh->node);
894 mutex_unlock(&hdl->lock);
896 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
898 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
899 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
900 with applications that do not use the NEXT_CTRL flag.
902 We just find the n-th private user control. It's O(N), but that should not
903 be an issue in this particular case. */
904 static struct v4l2_ctrl_ref *find_private_ref(
905 struct v4l2_ctrl_handler *hdl, u32 id)
907 struct v4l2_ctrl_ref *ref;
909 id -= V4L2_CID_PRIVATE_BASE;
910 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
911 /* Search for private user controls that are compatible with
913 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
914 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
915 if (!type_is_int(ref->ctrl))
925 /* Find a control with the given ID. */
926 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
928 struct v4l2_ctrl_ref *ref;
931 id &= V4L2_CTRL_ID_MASK;
933 /* Old-style private controls need special handling */
934 if (id >= V4L2_CID_PRIVATE_BASE)
935 return find_private_ref(hdl, id);
936 bucket = id % hdl->nr_of_buckets;
938 /* Simple optimization: cache the last control found */
939 if (hdl->cached && hdl->cached->ctrl->id == id)
942 /* Not in cache, search the hash */
943 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
944 while (ref && ref->ctrl->id != id)
948 hdl->cached = ref; /* cache it! */
952 /* Find a control with the given ID. Take the handler's lock first. */
953 static struct v4l2_ctrl_ref *find_ref_lock(
954 struct v4l2_ctrl_handler *hdl, u32 id)
956 struct v4l2_ctrl_ref *ref = NULL;
959 mutex_lock(&hdl->lock);
960 ref = find_ref(hdl, id);
961 mutex_unlock(&hdl->lock);
966 /* Find a control with the given ID. */
967 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
969 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
971 return ref ? ref->ctrl : NULL;
973 EXPORT_SYMBOL(v4l2_ctrl_find);
975 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
976 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
977 struct v4l2_ctrl *ctrl)
979 struct v4l2_ctrl_ref *ref;
980 struct v4l2_ctrl_ref *new_ref;
982 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
983 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
985 /* Automatically add the control class if it is not yet present. */
986 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
987 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
993 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
995 return handler_set_err(hdl, -ENOMEM);
996 new_ref->ctrl = ctrl;
997 if (ctrl->handler == hdl) {
998 /* By default each control starts in a cluster of its own.
999 new_ref->ctrl is basically a cluster array with one
1000 element, so that's perfect to use as the cluster pointer.
1001 But only do this for the handler that owns the control. */
1002 ctrl->cluster = &new_ref->ctrl;
1003 ctrl->ncontrols = 1;
1006 INIT_LIST_HEAD(&new_ref->node);
1008 mutex_lock(&hdl->lock);
1010 /* Add immediately at the end of the list if the list is empty, or if
1011 the last element in the list has a lower ID.
1012 This ensures that when elements are added in ascending order the
1013 insertion is an O(1) operation. */
1014 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1015 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1017 goto insert_in_hash;
1020 /* Find insert position in sorted list */
1021 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1022 if (ref->ctrl->id < id)
1024 /* Don't add duplicates */
1025 if (ref->ctrl->id == id) {
1029 list_add(&new_ref->node, ref->node.prev);
1034 /* Insert the control node in the hash */
1035 new_ref->next = hdl->buckets[bucket];
1036 hdl->buckets[bucket] = new_ref;
1039 mutex_unlock(&hdl->lock);
1043 /* Add a new control */
1044 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1045 const struct v4l2_ctrl_ops *ops,
1046 u32 id, const char *name, enum v4l2_ctrl_type type,
1047 s32 min, s32 max, u32 step, s32 def,
1048 u32 flags, const char * const *qmenu, void *priv)
1050 struct v4l2_ctrl *ctrl;
1051 unsigned sz_extra = 0;
1057 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1059 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1060 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1061 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1062 handler_set_err(hdl, -ERANGE);
1065 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1066 type == V4L2_CTRL_TYPE_MENU ||
1067 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1068 (def < min || def > max)) {
1069 handler_set_err(hdl, -ERANGE);
1073 if (type == V4L2_CTRL_TYPE_BUTTON)
1074 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1075 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1076 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1077 else if (type == V4L2_CTRL_TYPE_STRING)
1078 sz_extra += 2 * (max + 1);
1080 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1082 handler_set_err(hdl, -ENOMEM);
1086 INIT_LIST_HEAD(&ctrl->node);
1087 INIT_LIST_HEAD(&ctrl->fhs);
1088 ctrl->handler = hdl;
1093 ctrl->flags = flags;
1094 ctrl->minimum = min;
1095 ctrl->maximum = max;
1097 ctrl->qmenu = qmenu;
1099 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1101 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1102 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1103 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1105 memset(ctrl->cur.string, ' ', ctrl->minimum);
1107 if (handler_new_ref(hdl, ctrl)) {
1111 mutex_lock(&hdl->lock);
1112 list_add_tail(&ctrl->node, &hdl->ctrls);
1113 mutex_unlock(&hdl->lock);
1117 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1118 const struct v4l2_ctrl_config *cfg, void *priv)
1121 struct v4l2_ctrl *ctrl;
1122 const char *name = cfg->name;
1123 const char * const *qmenu = cfg->qmenu;
1124 enum v4l2_ctrl_type type = cfg->type;
1125 u32 flags = cfg->flags;
1128 u32 step = cfg->step;
1132 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1135 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU);
1139 WARN_ON(cfg->menu_skip_mask);
1140 if (is_menu && qmenu == NULL)
1141 qmenu = v4l2_ctrl_get_menu(cfg->id);
1143 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1145 is_menu ? cfg->menu_skip_mask : step,
1146 def, flags, qmenu, priv);
1148 ctrl->is_private = cfg->is_private;
1149 ctrl->is_volatile = cfg->is_volatile;
1153 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1155 /* Helper function for standard non-menu controls */
1156 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1157 const struct v4l2_ctrl_ops *ops,
1158 u32 id, s32 min, s32 max, u32 step, s32 def)
1161 enum v4l2_ctrl_type type;
1164 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1165 if (type == V4L2_CTRL_TYPE_MENU) {
1166 handler_set_err(hdl, -EINVAL);
1169 return v4l2_ctrl_new(hdl, ops, id, name, type,
1170 min, max, step, def, flags, NULL, NULL);
1172 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1174 /* Helper function for standard menu controls */
1175 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1176 const struct v4l2_ctrl_ops *ops,
1177 u32 id, s32 max, s32 mask, s32 def)
1179 const char * const *qmenu = v4l2_ctrl_get_menu(id);
1181 enum v4l2_ctrl_type type;
1186 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1187 if (type != V4L2_CTRL_TYPE_MENU) {
1188 handler_set_err(hdl, -EINVAL);
1191 return v4l2_ctrl_new(hdl, ops, id, name, type,
1192 0, max, mask, def, flags, qmenu, NULL);
1194 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1196 /* Add a control from another handler to this handler */
1197 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1198 struct v4l2_ctrl *ctrl)
1200 if (hdl == NULL || hdl->error)
1203 handler_set_err(hdl, -EINVAL);
1206 if (ctrl->handler == hdl)
1208 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1210 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1212 /* Add the controls from another handler to our own. */
1213 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1214 struct v4l2_ctrl_handler *add)
1216 struct v4l2_ctrl *ctrl;
1219 /* Do nothing if either handler is NULL or if they are the same */
1220 if (!hdl || !add || hdl == add)
1224 mutex_lock(&add->lock);
1225 list_for_each_entry(ctrl, &add->ctrls, node) {
1226 /* Skip handler-private controls. */
1227 if (ctrl->is_private)
1229 /* And control classes */
1230 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1232 ret = handler_new_ref(hdl, ctrl);
1236 mutex_unlock(&add->lock);
1239 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1241 /* Cluster controls */
1242 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1246 /* The first control is the master control and it must not be NULL */
1247 BUG_ON(ncontrols == 0 || controls[0] == NULL);
1249 for (i = 0; i < ncontrols; i++) {
1251 controls[i]->cluster = controls;
1252 controls[i]->ncontrols = ncontrols;
1256 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1258 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1259 u8 manual_val, bool set_volatile)
1261 struct v4l2_ctrl *master = controls[0];
1265 v4l2_ctrl_cluster(ncontrols, controls);
1266 WARN_ON(ncontrols <= 1);
1267 master->is_auto = true;
1268 master->manual_mode_value = manual_val;
1269 master->flags |= V4L2_CTRL_FLAG_UPDATE;
1270 flag = is_cur_manual(master) ? 0 : V4L2_CTRL_FLAG_INACTIVE;
1272 for (i = 1; i < ncontrols; i++)
1274 controls[i]->is_volatile = set_volatile;
1275 controls[i]->flags |= flag;
1278 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1280 /* Activate/deactivate a control. */
1281 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1283 /* invert since the actual flag is called 'inactive' */
1284 bool inactive = !active;
1291 /* set V4L2_CTRL_FLAG_INACTIVE */
1292 old = test_and_set_bit(4, &ctrl->flags);
1294 /* clear V4L2_CTRL_FLAG_INACTIVE */
1295 old = test_and_clear_bit(4, &ctrl->flags);
1296 if (old != inactive)
1297 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1299 EXPORT_SYMBOL(v4l2_ctrl_activate);
1301 /* Grab/ungrab a control.
1302 Typically used when streaming starts and you want to grab controls,
1303 preventing the user from changing them.
1305 Just call this and the framework will block any attempts to change
1307 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1314 v4l2_ctrl_lock(ctrl);
1316 /* set V4L2_CTRL_FLAG_GRABBED */
1317 old = test_and_set_bit(1, &ctrl->flags);
1319 /* clear V4L2_CTRL_FLAG_GRABBED */
1320 old = test_and_clear_bit(1, &ctrl->flags);
1322 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1323 v4l2_ctrl_unlock(ctrl);
1325 EXPORT_SYMBOL(v4l2_ctrl_grab);
1327 /* Log the control name and value */
1328 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1329 const char *prefix, const char *colon)
1331 int fl_inact = ctrl->flags & V4L2_CTRL_FLAG_INACTIVE;
1332 int fl_grabbed = ctrl->flags & V4L2_CTRL_FLAG_GRABBED;
1334 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1336 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1339 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1341 switch (ctrl->type) {
1342 case V4L2_CTRL_TYPE_INTEGER:
1343 printk(KERN_CONT "%d", ctrl->cur.val);
1345 case V4L2_CTRL_TYPE_BOOLEAN:
1346 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1348 case V4L2_CTRL_TYPE_MENU:
1349 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1351 case V4L2_CTRL_TYPE_INTEGER64:
1352 printk(KERN_CONT "%lld", ctrl->cur.val64);
1354 case V4L2_CTRL_TYPE_STRING:
1355 printk(KERN_CONT "%s", ctrl->cur.string);
1358 printk(KERN_CONT "unknown type %d", ctrl->type);
1361 if (fl_inact && fl_grabbed)
1362 printk(KERN_CONT " (inactive, grabbed)\n");
1364 printk(KERN_CONT " (inactive)\n");
1365 else if (fl_grabbed)
1366 printk(KERN_CONT " (grabbed)\n");
1368 printk(KERN_CONT "\n");
1371 /* Log all controls owned by the handler */
1372 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1375 struct v4l2_ctrl *ctrl;
1376 const char *colon = "";
1383 len = strlen(prefix);
1384 if (len && prefix[len - 1] != ' ')
1386 mutex_lock(&hdl->lock);
1387 list_for_each_entry(ctrl, &hdl->ctrls, node)
1388 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1389 log_ctrl(ctrl, prefix, colon);
1390 mutex_unlock(&hdl->lock);
1392 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1394 /* Call s_ctrl for all controls owned by the handler */
1395 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1397 struct v4l2_ctrl *ctrl;
1402 mutex_lock(&hdl->lock);
1403 list_for_each_entry(ctrl, &hdl->ctrls, node)
1406 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1407 struct v4l2_ctrl *master = ctrl->cluster[0];
1410 /* Skip if this control was already handled by a cluster. */
1414 for (i = 0; i < master->ncontrols; i++) {
1415 if (master->cluster[i]) {
1416 cur_to_new(master->cluster[i]);
1417 master->cluster[i]->is_new = 1;
1421 /* Skip button controls and read-only controls. */
1422 if (ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1423 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1425 ret = call_op(master, s_ctrl);
1428 for (i = 0; i < master->ncontrols; i++)
1429 if (master->cluster[i])
1430 master->cluster[i]->done = true;
1432 mutex_unlock(&hdl->lock);
1435 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1437 /* Implement VIDIOC_QUERYCTRL */
1438 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1440 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1441 struct v4l2_ctrl_ref *ref;
1442 struct v4l2_ctrl *ctrl;
1447 mutex_lock(&hdl->lock);
1449 /* Try to find it */
1450 ref = find_ref(hdl, id);
1452 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1453 /* Find the next control with ID > qc->id */
1455 /* Did we reach the end of the control list? */
1456 if (id >= node2id(hdl->ctrl_refs.prev)) {
1457 ref = NULL; /* Yes, so there is no next control */
1459 /* We found a control with the given ID, so just get
1460 the next one in the list. */
1461 ref = list_entry(ref->node.next, typeof(*ref), node);
1463 /* No control with the given ID exists, so start
1464 searching for the next largest ID. We know there
1465 is one, otherwise the first 'if' above would have
1467 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1468 if (id < ref->ctrl->id)
1472 mutex_unlock(&hdl->lock);
1477 memset(qc, 0, sizeof(*qc));
1478 if (id >= V4L2_CID_PRIVATE_BASE)
1482 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1483 qc->minimum = ctrl->minimum;
1484 qc->maximum = ctrl->maximum;
1485 qc->default_value = ctrl->default_value;
1486 if (ctrl->type == V4L2_CTRL_TYPE_MENU)
1489 qc->step = ctrl->step;
1490 qc->flags = ctrl->flags;
1491 qc->type = ctrl->type;
1494 EXPORT_SYMBOL(v4l2_queryctrl);
1496 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1498 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1500 return v4l2_queryctrl(sd->ctrl_handler, qc);
1502 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1504 /* Implement VIDIOC_QUERYMENU */
1505 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1507 struct v4l2_ctrl *ctrl;
1510 ctrl = v4l2_ctrl_find(hdl, qm->id);
1516 if (ctrl->qmenu == NULL ||
1517 i < ctrl->minimum || i > ctrl->maximum)
1519 /* Use mask to see if this menu item should be skipped */
1520 if (ctrl->menu_skip_mask & (1 << i))
1522 /* Empty menu items should also be skipped */
1523 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1525 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1528 EXPORT_SYMBOL(v4l2_querymenu);
1530 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1532 return v4l2_querymenu(sd->ctrl_handler, qm);
1534 EXPORT_SYMBOL(v4l2_subdev_querymenu);
1538 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1540 It is not a fully atomic operation, just best-effort only. After all, if
1541 multiple controls have to be set through multiple i2c writes (for example)
1542 then some initial writes may succeed while others fail. Thus leaving the
1543 system in an inconsistent state. The question is how much effort you are
1544 willing to spend on trying to make something atomic that really isn't.
1546 From the point of view of an application the main requirement is that
1547 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1548 error should be returned without actually affecting any controls.
1550 If all the values are correct, then it is acceptable to just give up
1551 in case of low-level errors.
1553 It is important though that the application can tell when only a partial
1554 configuration was done. The way we do that is through the error_idx field
1555 of struct v4l2_ext_controls: if that is equal to the count field then no
1556 controls were affected. Otherwise all controls before that index were
1557 successful in performing their 'get' or 'set' operation, the control at
1558 the given index failed, and you don't know what happened with the controls
1559 after the failed one. Since if they were part of a control cluster they
1560 could have been successfully processed (if a cluster member was encountered
1561 at index < error_idx), they could have failed (if a cluster member was at
1562 error_idx), or they may not have been processed yet (if the first cluster
1563 member appeared after error_idx).
1565 It is all fairly theoretical, though. In practice all you can do is to
1566 bail out. If error_idx == count, then it is an application bug. If
1567 error_idx < count then it is only an application bug if the error code was
1568 EBUSY. That usually means that something started streaming just when you
1569 tried to set the controls. In all other cases it is a driver/hardware
1570 problem and all you can do is to retry or bail out.
1572 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1573 never modifies controls the error_idx is just set to whatever control
1574 has an invalid value.
1577 /* Prepare for the extended g/s/try functions.
1578 Find the controls in the control array and do some basic checks. */
1579 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1580 struct v4l2_ext_controls *cs,
1581 struct ctrl_helper *helpers)
1585 for (i = 0; i < cs->count; i++) {
1586 struct v4l2_ext_control *c = &cs->controls[i];
1587 struct v4l2_ctrl *ctrl;
1588 u32 id = c->id & V4L2_CTRL_ID_MASK;
1592 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1595 /* Old-style private controls are not allowed for
1596 extended controls */
1597 if (id >= V4L2_CID_PRIVATE_BASE)
1599 ctrl = v4l2_ctrl_find(hdl, id);
1602 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1605 helpers[i].ctrl = ctrl;
1606 helpers[i].handled = false;
1611 typedef int (*cluster_func)(struct v4l2_ext_control *c,
1612 struct v4l2_ctrl *ctrl);
1614 /* Walk over all controls in v4l2_ext_controls belonging to the same cluster
1615 and call the provided function. */
1616 static int cluster_walk(unsigned from,
1617 struct v4l2_ext_controls *cs,
1618 struct ctrl_helper *helpers,
1621 struct v4l2_ctrl **cluster = helpers[from].ctrl->cluster;
1625 /* Find any controls from the same cluster and call the function */
1626 for (i = from; !ret && i < cs->count; i++) {
1627 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1629 if (!helpers[i].handled && ctrl->cluster == cluster)
1630 ret = f(&cs->controls[i], ctrl);
1635 static void cluster_done(unsigned from,
1636 struct v4l2_ext_controls *cs,
1637 struct ctrl_helper *helpers)
1639 struct v4l2_ctrl **cluster = helpers[from].ctrl->cluster;
1642 /* Find any controls from the same cluster and mark them as handled */
1643 for (i = from; i < cs->count; i++)
1644 if (helpers[i].ctrl->cluster == cluster)
1645 helpers[i].handled = true;
1648 /* Handles the corner case where cs->count == 0. It checks whether the
1649 specified control class exists. If that class ID is 0, then it checks
1650 whether there are any controls at all. */
1651 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
1653 if (ctrl_class == 0)
1654 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
1655 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
1660 /* Get extended controls. Allocates the helpers array if needed. */
1661 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1663 struct ctrl_helper helper[4];
1664 struct ctrl_helper *helpers = helper;
1668 cs->error_idx = cs->count;
1669 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1675 return class_check(hdl, cs->ctrl_class);
1677 if (cs->count > ARRAY_SIZE(helper)) {
1678 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1679 if (helpers == NULL)
1683 ret = prepare_ext_ctrls(hdl, cs, helpers);
1684 cs->error_idx = cs->count;
1686 for (i = 0; !ret && i < cs->count; i++)
1687 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1690 for (i = 0; !ret && i < cs->count; i++) {
1691 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1692 struct v4l2_ctrl *master = ctrl->cluster[0];
1695 if (helpers[i].handled)
1700 /* Any volatile controls requested from this cluster? */
1701 has_volatiles = ctrl->is_volatile;
1702 if (!has_volatiles && has_op(master, g_volatile_ctrl) &&
1703 master->ncontrols > 1)
1704 has_volatiles = cluster_walk(i, cs, helpers,
1707 v4l2_ctrl_lock(master);
1709 /* g_volatile_ctrl will update the new control values */
1710 if (has_volatiles && !is_cur_manual(master)) {
1711 for (j = 0; j < master->ncontrols; j++)
1712 cur_to_new(master->cluster[j]);
1713 ret = call_op(master, g_volatile_ctrl);
1715 /* If OK, then copy the current (for non-volatile controls)
1716 or the new (for volatile controls) control values to the
1719 ret = cluster_walk(i, cs, helpers, ctrl_to_user);
1720 v4l2_ctrl_unlock(master);
1721 cluster_done(i, cs, helpers);
1724 if (cs->count > ARRAY_SIZE(helper))
1728 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
1730 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1732 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
1734 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
1736 /* Helper function to get a single control */
1737 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
1739 struct v4l2_ctrl *master = ctrl->cluster[0];
1743 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1746 v4l2_ctrl_lock(master);
1747 /* g_volatile_ctrl will update the current control values */
1748 if (ctrl->is_volatile && !is_cur_manual(master)) {
1749 for (i = 0; i < master->ncontrols; i++)
1750 cur_to_new(master->cluster[i]);
1751 ret = call_op(master, g_volatile_ctrl);
1754 *val = ctrl->cur.val;
1756 v4l2_ctrl_unlock(master);
1760 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
1762 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
1764 if (ctrl == NULL || !type_is_int(ctrl))
1766 return get_ctrl(ctrl, &control->value);
1768 EXPORT_SYMBOL(v4l2_g_ctrl);
1770 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
1772 return v4l2_g_ctrl(sd->ctrl_handler, control);
1774 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
1776 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
1780 /* It's a driver bug if this happens. */
1781 WARN_ON(!type_is_int(ctrl));
1782 get_ctrl(ctrl, &val);
1785 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
1788 /* Core function that calls try/s_ctrl and ensures that the new value is
1789 copied to the current value on a set.
1790 Must be called with ctrl->handler->lock held. */
1791 static int try_or_set_control_cluster(struct v4l2_fh *fh,
1792 struct v4l2_ctrl *master, bool set)
1799 /* Go through the cluster and either validate the new value or
1800 (if no new value was set), copy the current value to the new
1801 value, ensuring a consistent view for the control ops when
1803 for (i = 0; !ret && i < master->ncontrols; i++) {
1804 struct v4l2_ctrl *ctrl = master->cluster[i];
1810 /* Double check this: it may have changed since the
1811 last check in try_or_set_ext_ctrls(). */
1812 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
1815 /* Validate if required */
1817 ret = validate_new(ctrl);
1820 /* No new value was set, so copy the current and force
1821 a call to try_ctrl later, since the values for the cluster
1822 may now have changed and the end result might be invalid. */
1827 /* For larger clusters you have to call try_ctrl again to
1828 verify that the controls are still valid after the
1829 'cur_to_new' above. */
1831 ret = call_op(master, try_ctrl);
1833 /* Don't set if there is no change */
1834 if (ret || !set || !cluster_changed(master))
1836 ret = call_op(master, s_ctrl);
1837 /* If OK, then make the new values permanent. */
1841 update_flag = is_cur_manual(master) != is_new_manual(master);
1842 for (i = 0; i < master->ncontrols; i++)
1843 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
1847 /* Try or set controls. */
1848 static int try_or_set_ext_ctrls(struct v4l2_fh *fh,
1849 struct v4l2_ctrl_handler *hdl,
1850 struct v4l2_ext_controls *cs,
1851 struct ctrl_helper *helpers,
1857 for (i = 0; i < cs->count; i++) {
1858 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1862 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
1864 /* This test is also done in try_set_control_cluster() which
1865 is called in atomic context, so that has the final say,
1866 but it makes sense to do an up-front check as well. Once
1867 an error occurs in try_set_control_cluster() some other
1868 controls may have been set already and we want to do a
1869 best-effort to avoid that. */
1870 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
1874 for (i = 0; !ret && i < cs->count; i++) {
1875 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1876 struct v4l2_ctrl *master = ctrl->cluster[0];
1878 if (helpers[i].handled)
1882 v4l2_ctrl_lock(ctrl);
1884 /* Reset the 'is_new' flags of the cluster */
1885 for (j = 0; j < master->ncontrols; j++)
1886 if (master->cluster[j])
1887 master->cluster[j]->is_new = 0;
1889 /* Copy the new caller-supplied control values.
1890 user_to_new() sets 'is_new' to 1. */
1891 ret = cluster_walk(i, cs, helpers, user_to_new);
1894 ret = try_or_set_control_cluster(fh, master, set);
1896 /* Copy the new values back to userspace. */
1898 ret = cluster_walk(i, cs, helpers, new_to_user);
1900 v4l2_ctrl_unlock(ctrl);
1901 cluster_done(i, cs, helpers);
1906 /* Try or try-and-set controls */
1907 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
1908 struct v4l2_ext_controls *cs,
1911 struct ctrl_helper helper[4];
1912 struct ctrl_helper *helpers = helper;
1916 cs->error_idx = cs->count;
1917 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1923 return class_check(hdl, cs->ctrl_class);
1925 if (cs->count > ARRAY_SIZE(helper)) {
1926 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1930 ret = prepare_ext_ctrls(hdl, cs, helpers);
1932 /* First 'try' all controls and abort on error */
1934 ret = try_or_set_ext_ctrls(NULL, hdl, cs, helpers, false);
1935 /* If this is a 'set' operation and the initial 'try' failed,
1936 then set error_idx to count to tell the application that no
1937 controls changed value yet. */
1939 cs->error_idx = cs->count;
1941 /* Reset 'handled' state */
1942 for (i = 0; i < cs->count; i++)
1943 helpers[i].handled = false;
1944 ret = try_or_set_ext_ctrls(fh, hdl, cs, helpers, true);
1947 if (cs->count > ARRAY_SIZE(helper))
1952 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1954 return try_set_ext_ctrls(NULL, hdl, cs, false);
1956 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
1958 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
1959 struct v4l2_ext_controls *cs)
1961 return try_set_ext_ctrls(fh, hdl, cs, true);
1963 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
1965 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1967 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
1969 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
1971 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1973 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
1975 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
1977 /* Helper function for VIDIOC_S_CTRL compatibility */
1978 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
1980 struct v4l2_ctrl *master = ctrl->cluster[0];
1984 v4l2_ctrl_lock(ctrl);
1986 /* Reset the 'is_new' flags of the cluster */
1987 for (i = 0; i < master->ncontrols; i++)
1988 if (master->cluster[i])
1989 master->cluster[i]->is_new = 0;
1993 ret = try_or_set_control_cluster(NULL, master, false);
1995 ret = try_or_set_control_cluster(fh, master, true);
1996 *val = ctrl->cur.val;
1997 v4l2_ctrl_unlock(ctrl);
2001 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2002 struct v4l2_control *control)
2004 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2006 if (ctrl == NULL || !type_is_int(ctrl))
2009 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2012 return set_ctrl(fh, ctrl, &control->value);
2014 EXPORT_SYMBOL(v4l2_s_ctrl);
2016 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2018 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2020 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2022 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2024 /* It's a driver bug if this happens. */
2025 WARN_ON(!type_is_int(ctrl));
2026 return set_ctrl(NULL, ctrl, &val);
2028 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2030 void v4l2_ctrl_add_fh(struct v4l2_ctrl_handler *hdl,
2031 struct v4l2_ctrl_fh *ctrl_fh,
2032 struct v4l2_event_subscription *sub)
2034 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, sub->id);
2036 v4l2_ctrl_lock(ctrl);
2037 list_add_tail(&ctrl_fh->node, &ctrl->fhs);
2038 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2039 (sub->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2040 struct v4l2_event ev;
2042 fill_event(&ev, ctrl, V4L2_EVENT_CTRL_CH_VALUE |
2043 V4L2_EVENT_CTRL_CH_FLAGS);
2044 v4l2_event_queue_fh(ctrl_fh->fh, &ev);
2046 v4l2_ctrl_unlock(ctrl);
2048 EXPORT_SYMBOL(v4l2_ctrl_add_fh);
2050 void v4l2_ctrl_del_fh(struct v4l2_ctrl *ctrl, struct v4l2_fh *fh)
2052 struct v4l2_ctrl_fh *pos;
2054 v4l2_ctrl_lock(ctrl);
2055 list_for_each_entry(pos, &ctrl->fhs, node) {
2056 if (pos->fh == fh) {
2057 list_del(&pos->node);
2062 v4l2_ctrl_unlock(ctrl);
2064 EXPORT_SYMBOL(v4l2_ctrl_del_fh);
2066 int v4l2_ctrl_subscribe_fh(struct v4l2_fh *fh,
2067 struct v4l2_event_subscription *sub, unsigned n)
2069 struct v4l2_ctrl_handler *hdl = fh->ctrl_handler;
2073 ret = v4l2_event_init(fh);
2075 if (hdl->nr_of_refs * 2 > n)
2076 n = hdl->nr_of_refs * 2;
2077 ret = v4l2_event_alloc(fh, n);
2080 ret = v4l2_event_subscribe(fh, sub);
2083 EXPORT_SYMBOL(v4l2_ctrl_subscribe_fh);