2 * uvc_ctrl.c -- USB Video Class driver - Controls
4 * Copyright (C) 2005-2010
5 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/uaccess.h>
19 #include <linux/usb.h>
20 #include <linux/videodev2.h>
21 #include <linux/vmalloc.h>
22 #include <linux/wait.h>
23 #include <linux/atomic.h>
24 #include <media/v4l2-ctrls.h>
28 #define UVC_CTRL_DATA_CURRENT 0
29 #define UVC_CTRL_DATA_BACKUP 1
30 #define UVC_CTRL_DATA_MIN 2
31 #define UVC_CTRL_DATA_MAX 3
32 #define UVC_CTRL_DATA_RES 4
33 #define UVC_CTRL_DATA_DEF 5
34 #define UVC_CTRL_DATA_LAST 6
36 /* ------------------------------------------------------------------------
40 static struct uvc_control_info uvc_ctrls[] = {
42 .entity = UVC_GUID_UVC_PROCESSING,
43 .selector = UVC_PU_BRIGHTNESS_CONTROL,
46 .flags = UVC_CTRL_FLAG_SET_CUR
47 | UVC_CTRL_FLAG_GET_RANGE
48 | UVC_CTRL_FLAG_RESTORE,
51 .entity = UVC_GUID_UVC_PROCESSING,
52 .selector = UVC_PU_CONTRAST_CONTROL,
55 .flags = UVC_CTRL_FLAG_SET_CUR
56 | UVC_CTRL_FLAG_GET_RANGE
57 | UVC_CTRL_FLAG_RESTORE,
60 .entity = UVC_GUID_UVC_PROCESSING,
61 .selector = UVC_PU_HUE_CONTROL,
64 .flags = UVC_CTRL_FLAG_SET_CUR
65 | UVC_CTRL_FLAG_GET_RANGE
66 | UVC_CTRL_FLAG_RESTORE
67 | UVC_CTRL_FLAG_AUTO_UPDATE,
70 .entity = UVC_GUID_UVC_PROCESSING,
71 .selector = UVC_PU_SATURATION_CONTROL,
74 .flags = UVC_CTRL_FLAG_SET_CUR
75 | UVC_CTRL_FLAG_GET_RANGE
76 | UVC_CTRL_FLAG_RESTORE,
79 .entity = UVC_GUID_UVC_PROCESSING,
80 .selector = UVC_PU_SHARPNESS_CONTROL,
83 .flags = UVC_CTRL_FLAG_SET_CUR
84 | UVC_CTRL_FLAG_GET_RANGE
85 | UVC_CTRL_FLAG_RESTORE,
88 .entity = UVC_GUID_UVC_PROCESSING,
89 .selector = UVC_PU_GAMMA_CONTROL,
92 .flags = UVC_CTRL_FLAG_SET_CUR
93 | UVC_CTRL_FLAG_GET_RANGE
94 | UVC_CTRL_FLAG_RESTORE,
97 .entity = UVC_GUID_UVC_PROCESSING,
98 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL,
101 .flags = UVC_CTRL_FLAG_SET_CUR
102 | UVC_CTRL_FLAG_GET_RANGE
103 | UVC_CTRL_FLAG_RESTORE
104 | UVC_CTRL_FLAG_AUTO_UPDATE,
107 .entity = UVC_GUID_UVC_PROCESSING,
108 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
111 .flags = UVC_CTRL_FLAG_SET_CUR
112 | UVC_CTRL_FLAG_GET_RANGE
113 | UVC_CTRL_FLAG_RESTORE
114 | UVC_CTRL_FLAG_AUTO_UPDATE,
117 .entity = UVC_GUID_UVC_PROCESSING,
118 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
121 .flags = UVC_CTRL_FLAG_SET_CUR
122 | UVC_CTRL_FLAG_GET_RANGE
123 | UVC_CTRL_FLAG_RESTORE,
126 .entity = UVC_GUID_UVC_PROCESSING,
127 .selector = UVC_PU_GAIN_CONTROL,
130 .flags = UVC_CTRL_FLAG_SET_CUR
131 | UVC_CTRL_FLAG_GET_RANGE
132 | UVC_CTRL_FLAG_RESTORE,
135 .entity = UVC_GUID_UVC_PROCESSING,
136 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL,
139 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
140 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE,
143 .entity = UVC_GUID_UVC_PROCESSING,
144 .selector = UVC_PU_HUE_AUTO_CONTROL,
147 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
148 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE,
151 .entity = UVC_GUID_UVC_PROCESSING,
152 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL,
155 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
156 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE,
159 .entity = UVC_GUID_UVC_PROCESSING,
160 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL,
163 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
164 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE,
167 .entity = UVC_GUID_UVC_PROCESSING,
168 .selector = UVC_PU_DIGITAL_MULTIPLIER_CONTROL,
171 .flags = UVC_CTRL_FLAG_SET_CUR
172 | UVC_CTRL_FLAG_GET_RANGE
173 | UVC_CTRL_FLAG_RESTORE,
176 .entity = UVC_GUID_UVC_PROCESSING,
177 .selector = UVC_PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL,
180 .flags = UVC_CTRL_FLAG_SET_CUR
181 | UVC_CTRL_FLAG_GET_RANGE
182 | UVC_CTRL_FLAG_RESTORE,
185 .entity = UVC_GUID_UVC_PROCESSING,
186 .selector = UVC_PU_ANALOG_VIDEO_STANDARD_CONTROL,
189 .flags = UVC_CTRL_FLAG_GET_CUR,
192 .entity = UVC_GUID_UVC_PROCESSING,
193 .selector = UVC_PU_ANALOG_LOCK_STATUS_CONTROL,
196 .flags = UVC_CTRL_FLAG_GET_CUR,
199 .entity = UVC_GUID_UVC_CAMERA,
200 .selector = UVC_CT_SCANNING_MODE_CONTROL,
203 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
204 | UVC_CTRL_FLAG_RESTORE,
207 .entity = UVC_GUID_UVC_CAMERA,
208 .selector = UVC_CT_AE_MODE_CONTROL,
211 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
212 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_GET_RES
213 | UVC_CTRL_FLAG_RESTORE,
216 .entity = UVC_GUID_UVC_CAMERA,
217 .selector = UVC_CT_AE_PRIORITY_CONTROL,
220 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
221 | UVC_CTRL_FLAG_RESTORE,
224 .entity = UVC_GUID_UVC_CAMERA,
225 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
228 .flags = UVC_CTRL_FLAG_SET_CUR
229 | UVC_CTRL_FLAG_GET_RANGE
230 | UVC_CTRL_FLAG_RESTORE,
233 .entity = UVC_GUID_UVC_CAMERA,
234 .selector = UVC_CT_EXPOSURE_TIME_RELATIVE_CONTROL,
237 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_RESTORE,
240 .entity = UVC_GUID_UVC_CAMERA,
241 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
244 .flags = UVC_CTRL_FLAG_SET_CUR
245 | UVC_CTRL_FLAG_GET_RANGE
246 | UVC_CTRL_FLAG_RESTORE
247 | UVC_CTRL_FLAG_AUTO_UPDATE,
250 .entity = UVC_GUID_UVC_CAMERA,
251 .selector = UVC_CT_FOCUS_RELATIVE_CONTROL,
254 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN
255 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES
256 | UVC_CTRL_FLAG_GET_DEF
257 | UVC_CTRL_FLAG_AUTO_UPDATE,
260 .entity = UVC_GUID_UVC_CAMERA,
261 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL,
264 .flags = UVC_CTRL_FLAG_SET_CUR
265 | UVC_CTRL_FLAG_GET_RANGE
266 | UVC_CTRL_FLAG_RESTORE
267 | UVC_CTRL_FLAG_AUTO_UPDATE,
270 .entity = UVC_GUID_UVC_CAMERA,
271 .selector = UVC_CT_IRIS_RELATIVE_CONTROL,
274 .flags = UVC_CTRL_FLAG_SET_CUR
275 | UVC_CTRL_FLAG_AUTO_UPDATE,
278 .entity = UVC_GUID_UVC_CAMERA,
279 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
282 .flags = UVC_CTRL_FLAG_SET_CUR
283 | UVC_CTRL_FLAG_GET_RANGE
284 | UVC_CTRL_FLAG_RESTORE
285 | UVC_CTRL_FLAG_AUTO_UPDATE,
288 .entity = UVC_GUID_UVC_CAMERA,
289 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL,
292 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN
293 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES
294 | UVC_CTRL_FLAG_GET_DEF
295 | UVC_CTRL_FLAG_AUTO_UPDATE,
298 .entity = UVC_GUID_UVC_CAMERA,
299 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
302 .flags = UVC_CTRL_FLAG_SET_CUR
303 | UVC_CTRL_FLAG_GET_RANGE
304 | UVC_CTRL_FLAG_RESTORE
305 | UVC_CTRL_FLAG_AUTO_UPDATE,
308 .entity = UVC_GUID_UVC_CAMERA,
309 .selector = UVC_CT_PANTILT_RELATIVE_CONTROL,
312 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN
313 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES
314 | UVC_CTRL_FLAG_GET_DEF
315 | UVC_CTRL_FLAG_AUTO_UPDATE,
318 .entity = UVC_GUID_UVC_CAMERA,
319 .selector = UVC_CT_ROLL_ABSOLUTE_CONTROL,
322 .flags = UVC_CTRL_FLAG_SET_CUR
323 | UVC_CTRL_FLAG_GET_RANGE
324 | UVC_CTRL_FLAG_RESTORE
325 | UVC_CTRL_FLAG_AUTO_UPDATE,
328 .entity = UVC_GUID_UVC_CAMERA,
329 .selector = UVC_CT_ROLL_RELATIVE_CONTROL,
332 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN
333 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES
334 | UVC_CTRL_FLAG_GET_DEF
335 | UVC_CTRL_FLAG_AUTO_UPDATE,
338 .entity = UVC_GUID_UVC_CAMERA,
339 .selector = UVC_CT_FOCUS_AUTO_CONTROL,
342 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
343 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE,
346 .entity = UVC_GUID_UVC_CAMERA,
347 .selector = UVC_CT_PRIVACY_CONTROL,
350 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR
351 | UVC_CTRL_FLAG_RESTORE
352 | UVC_CTRL_FLAG_AUTO_UPDATE,
356 static struct uvc_menu_info power_line_frequency_controls[] = {
362 static struct uvc_menu_info exposure_auto_controls[] = {
364 { 1, "Manual Mode" },
365 { 4, "Shutter Priority Mode" },
366 { 8, "Aperture Priority Mode" },
369 static __s32 uvc_ctrl_get_zoom(struct uvc_control_mapping *mapping,
370 __u8 query, const __u8 *data)
372 __s8 zoom = (__s8)data[0];
376 return (zoom == 0) ? 0 : (zoom > 0 ? data[2] : -data[2]);
387 static void uvc_ctrl_set_zoom(struct uvc_control_mapping *mapping,
388 __s32 value, __u8 *data)
390 data[0] = value == 0 ? 0 : (value > 0) ? 1 : 0xff;
391 data[2] = min((int)abs(value), 0xff);
394 static struct uvc_control_mapping uvc_ctrl_mappings[] = {
396 .id = V4L2_CID_BRIGHTNESS,
397 .name = "Brightness",
398 .entity = UVC_GUID_UVC_PROCESSING,
399 .selector = UVC_PU_BRIGHTNESS_CONTROL,
402 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
403 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
406 .id = V4L2_CID_CONTRAST,
408 .entity = UVC_GUID_UVC_PROCESSING,
409 .selector = UVC_PU_CONTRAST_CONTROL,
412 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
413 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
418 .entity = UVC_GUID_UVC_PROCESSING,
419 .selector = UVC_PU_HUE_CONTROL,
422 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
423 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
424 .master_id = V4L2_CID_HUE_AUTO,
428 .id = V4L2_CID_SATURATION,
429 .name = "Saturation",
430 .entity = UVC_GUID_UVC_PROCESSING,
431 .selector = UVC_PU_SATURATION_CONTROL,
434 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
435 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
438 .id = V4L2_CID_SHARPNESS,
440 .entity = UVC_GUID_UVC_PROCESSING,
441 .selector = UVC_PU_SHARPNESS_CONTROL,
444 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
445 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
448 .id = V4L2_CID_GAMMA,
450 .entity = UVC_GUID_UVC_PROCESSING,
451 .selector = UVC_PU_GAMMA_CONTROL,
454 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
455 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
458 .id = V4L2_CID_BACKLIGHT_COMPENSATION,
459 .name = "Backlight Compensation",
460 .entity = UVC_GUID_UVC_PROCESSING,
461 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
464 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
465 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
470 .entity = UVC_GUID_UVC_PROCESSING,
471 .selector = UVC_PU_GAIN_CONTROL,
474 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
475 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
478 .id = V4L2_CID_POWER_LINE_FREQUENCY,
479 .name = "Power Line Frequency",
480 .entity = UVC_GUID_UVC_PROCESSING,
481 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL,
484 .v4l2_type = V4L2_CTRL_TYPE_MENU,
485 .data_type = UVC_CTRL_DATA_TYPE_ENUM,
486 .menu_info = power_line_frequency_controls,
487 .menu_count = ARRAY_SIZE(power_line_frequency_controls),
490 .id = V4L2_CID_HUE_AUTO,
492 .entity = UVC_GUID_UVC_PROCESSING,
493 .selector = UVC_PU_HUE_AUTO_CONTROL,
496 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
497 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
498 .slave_ids = { V4L2_CID_HUE, },
501 .id = V4L2_CID_EXPOSURE_AUTO,
502 .name = "Exposure, Auto",
503 .entity = UVC_GUID_UVC_CAMERA,
504 .selector = UVC_CT_AE_MODE_CONTROL,
507 .v4l2_type = V4L2_CTRL_TYPE_MENU,
508 .data_type = UVC_CTRL_DATA_TYPE_BITMASK,
509 .menu_info = exposure_auto_controls,
510 .menu_count = ARRAY_SIZE(exposure_auto_controls),
511 .slave_ids = { V4L2_CID_EXPOSURE_ABSOLUTE, },
514 .id = V4L2_CID_EXPOSURE_AUTO_PRIORITY,
515 .name = "Exposure, Auto Priority",
516 .entity = UVC_GUID_UVC_CAMERA,
517 .selector = UVC_CT_AE_PRIORITY_CONTROL,
520 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
521 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
524 .id = V4L2_CID_EXPOSURE_ABSOLUTE,
525 .name = "Exposure (Absolute)",
526 .entity = UVC_GUID_UVC_CAMERA,
527 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
530 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
531 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
532 .master_id = V4L2_CID_EXPOSURE_AUTO,
533 .master_manual = V4L2_EXPOSURE_MANUAL,
536 .id = V4L2_CID_AUTO_WHITE_BALANCE,
537 .name = "White Balance Temperature, Auto",
538 .entity = UVC_GUID_UVC_PROCESSING,
539 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL,
542 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
543 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
544 .slave_ids = { V4L2_CID_WHITE_BALANCE_TEMPERATURE, },
547 .id = V4L2_CID_WHITE_BALANCE_TEMPERATURE,
548 .name = "White Balance Temperature",
549 .entity = UVC_GUID_UVC_PROCESSING,
550 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL,
553 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
554 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
555 .master_id = V4L2_CID_AUTO_WHITE_BALANCE,
559 .id = V4L2_CID_AUTO_WHITE_BALANCE,
560 .name = "White Balance Component, Auto",
561 .entity = UVC_GUID_UVC_PROCESSING,
562 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL,
565 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
566 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
567 .slave_ids = { V4L2_CID_BLUE_BALANCE,
568 V4L2_CID_RED_BALANCE },
571 .id = V4L2_CID_BLUE_BALANCE,
572 .name = "White Balance Blue Component",
573 .entity = UVC_GUID_UVC_PROCESSING,
574 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
577 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
578 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
579 .master_id = V4L2_CID_AUTO_WHITE_BALANCE,
583 .id = V4L2_CID_RED_BALANCE,
584 .name = "White Balance Red Component",
585 .entity = UVC_GUID_UVC_PROCESSING,
586 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
589 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
590 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
591 .master_id = V4L2_CID_AUTO_WHITE_BALANCE,
595 .id = V4L2_CID_FOCUS_ABSOLUTE,
596 .name = "Focus (absolute)",
597 .entity = UVC_GUID_UVC_CAMERA,
598 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
601 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
602 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
603 .master_id = V4L2_CID_FOCUS_AUTO,
607 .id = V4L2_CID_FOCUS_AUTO,
608 .name = "Focus, Auto",
609 .entity = UVC_GUID_UVC_CAMERA,
610 .selector = UVC_CT_FOCUS_AUTO_CONTROL,
613 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
614 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
615 .slave_ids = { V4L2_CID_FOCUS_ABSOLUTE, },
618 .id = V4L2_CID_IRIS_ABSOLUTE,
619 .name = "Iris, Absolute",
620 .entity = UVC_GUID_UVC_CAMERA,
621 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL,
624 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
625 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
628 .id = V4L2_CID_IRIS_RELATIVE,
629 .name = "Iris, Relative",
630 .entity = UVC_GUID_UVC_CAMERA,
631 .selector = UVC_CT_IRIS_RELATIVE_CONTROL,
634 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
635 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
638 .id = V4L2_CID_ZOOM_ABSOLUTE,
639 .name = "Zoom, Absolute",
640 .entity = UVC_GUID_UVC_CAMERA,
641 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
644 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
645 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
648 .id = V4L2_CID_ZOOM_CONTINUOUS,
649 .name = "Zoom, Continuous",
650 .entity = UVC_GUID_UVC_CAMERA,
651 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL,
654 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
655 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
656 .get = uvc_ctrl_get_zoom,
657 .set = uvc_ctrl_set_zoom,
660 .id = V4L2_CID_PAN_ABSOLUTE,
661 .name = "Pan (Absolute)",
662 .entity = UVC_GUID_UVC_CAMERA,
663 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
666 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
667 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
670 .id = V4L2_CID_TILT_ABSOLUTE,
671 .name = "Tilt (Absolute)",
672 .entity = UVC_GUID_UVC_CAMERA,
673 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
676 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
677 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
680 .id = V4L2_CID_PRIVACY,
682 .entity = UVC_GUID_UVC_CAMERA,
683 .selector = UVC_CT_PRIVACY_CONTROL,
686 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
687 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
691 /* ------------------------------------------------------------------------
695 static inline __u8 *uvc_ctrl_data(struct uvc_control *ctrl, int id)
697 return ctrl->uvc_data + id * ctrl->info.size;
700 static inline int uvc_test_bit(const __u8 *data, int bit)
702 return (data[bit >> 3] >> (bit & 7)) & 1;
705 static inline void uvc_clear_bit(__u8 *data, int bit)
707 data[bit >> 3] &= ~(1 << (bit & 7));
710 /* Extract the bit string specified by mapping->offset and mapping->size
711 * from the little-endian data stored at 'data' and return the result as
712 * a signed 32bit integer. Sign extension will be performed if the mapping
713 * references a signed data type.
715 static __s32 uvc_get_le_value(struct uvc_control_mapping *mapping,
716 __u8 query, const __u8 *data)
718 int bits = mapping->size;
719 int offset = mapping->offset;
725 mask = ((1LL << bits) - 1) << offset;
727 for (; bits > 0; data++) {
728 __u8 byte = *data & mask;
729 value |= offset > 0 ? (byte >> offset) : (byte << (-offset));
730 bits -= 8 - (offset > 0 ? offset : 0);
732 mask = (1 << bits) - 1;
735 /* Sign-extend the value if needed. */
736 if (mapping->data_type == UVC_CTRL_DATA_TYPE_SIGNED)
737 value |= -(value & (1 << (mapping->size - 1)));
742 /* Set the bit string specified by mapping->offset and mapping->size
743 * in the little-endian data stored at 'data' to the value 'value'.
745 static void uvc_set_le_value(struct uvc_control_mapping *mapping,
746 __s32 value, __u8 *data)
748 int bits = mapping->size;
749 int offset = mapping->offset;
752 /* According to the v4l2 spec, writing any value to a button control
753 * should result in the action belonging to the button control being
754 * triggered. UVC devices however want to see a 1 written -> override
757 if (mapping->v4l2_type == V4L2_CTRL_TYPE_BUTTON)
763 for (; bits > 0; data++) {
764 mask = ((1LL << bits) - 1) << offset;
765 *data = (*data & ~mask) | ((value << offset) & mask);
766 value >>= offset ? offset : 8;
772 /* ------------------------------------------------------------------------
773 * Terminal and unit management
776 static const __u8 uvc_processing_guid[16] = UVC_GUID_UVC_PROCESSING;
777 static const __u8 uvc_camera_guid[16] = UVC_GUID_UVC_CAMERA;
778 static const __u8 uvc_media_transport_input_guid[16] =
779 UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT;
781 static int uvc_entity_match_guid(const struct uvc_entity *entity,
784 switch (UVC_ENTITY_TYPE(entity)) {
786 return memcmp(uvc_camera_guid, guid, 16) == 0;
788 case UVC_ITT_MEDIA_TRANSPORT_INPUT:
789 return memcmp(uvc_media_transport_input_guid, guid, 16) == 0;
791 case UVC_VC_PROCESSING_UNIT:
792 return memcmp(uvc_processing_guid, guid, 16) == 0;
794 case UVC_VC_EXTENSION_UNIT:
795 return memcmp(entity->extension.guidExtensionCode,
803 /* ------------------------------------------------------------------------
807 static void __uvc_find_control(struct uvc_entity *entity, __u32 v4l2_id,
808 struct uvc_control_mapping **mapping, struct uvc_control **control,
811 struct uvc_control *ctrl;
812 struct uvc_control_mapping *map;
818 for (i = 0; i < entity->ncontrols; ++i) {
819 ctrl = &entity->controls[i];
820 if (!ctrl->initialized)
823 list_for_each_entry(map, &ctrl->info.mappings, list) {
824 if ((map->id == v4l2_id) && !next) {
830 if ((*mapping == NULL || (*mapping)->id > map->id) &&
831 (map->id > v4l2_id) && next) {
839 static struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
840 __u32 v4l2_id, struct uvc_control_mapping **mapping)
842 struct uvc_control *ctrl = NULL;
843 struct uvc_entity *entity;
844 int next = v4l2_id & V4L2_CTRL_FLAG_NEXT_CTRL;
848 /* Mask the query flags. */
849 v4l2_id &= V4L2_CTRL_ID_MASK;
851 /* Find the control. */
852 list_for_each_entry(entity, &chain->entities, chain) {
853 __uvc_find_control(entity, v4l2_id, mapping, &ctrl, next);
858 if (ctrl == NULL && !next)
859 uvc_trace(UVC_TRACE_CONTROL, "Control 0x%08x not found.\n",
865 static int uvc_ctrl_populate_cache(struct uvc_video_chain *chain,
866 struct uvc_control *ctrl)
870 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_DEF) {
871 ret = uvc_query_ctrl(chain->dev, UVC_GET_DEF, ctrl->entity->id,
872 chain->dev->intfnum, ctrl->info.selector,
873 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF),
879 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MIN) {
880 ret = uvc_query_ctrl(chain->dev, UVC_GET_MIN, ctrl->entity->id,
881 chain->dev->intfnum, ctrl->info.selector,
882 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN),
887 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MAX) {
888 ret = uvc_query_ctrl(chain->dev, UVC_GET_MAX, ctrl->entity->id,
889 chain->dev->intfnum, ctrl->info.selector,
890 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX),
895 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES) {
896 ret = uvc_query_ctrl(chain->dev, UVC_GET_RES, ctrl->entity->id,
897 chain->dev->intfnum, ctrl->info.selector,
898 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES),
901 if (UVC_ENTITY_TYPE(ctrl->entity) !=
902 UVC_VC_EXTENSION_UNIT)
905 /* GET_RES is mandatory for XU controls, but some
906 * cameras still choke on it. Ignore errors and set the
907 * resolution value to zero.
909 uvc_warn_once(chain->dev, UVC_WARN_XU_GET_RES,
910 "UVC non compliance - GET_RES failed on "
911 "an XU control. Enabling workaround.\n");
912 memset(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES), 0,
921 static int __uvc_ctrl_get(struct uvc_video_chain *chain,
922 struct uvc_control *ctrl, struct uvc_control_mapping *mapping,
925 struct uvc_menu_info *menu;
929 if ((ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR) == 0)
933 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, ctrl->entity->id,
934 chain->dev->intfnum, ctrl->info.selector,
935 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
943 *value = mapping->get(mapping, UVC_GET_CUR,
944 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
946 if (mapping->v4l2_type == V4L2_CTRL_TYPE_MENU) {
947 menu = mapping->menu_info;
948 for (i = 0; i < mapping->menu_count; ++i, ++menu) {
949 if (menu->value == *value) {
959 static int __uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
960 struct uvc_control *ctrl,
961 struct uvc_control_mapping *mapping,
962 struct v4l2_queryctrl *v4l2_ctrl)
964 struct uvc_control_mapping *master_map = NULL;
965 struct uvc_control *master_ctrl = NULL;
966 struct uvc_menu_info *menu;
969 memset(v4l2_ctrl, 0, sizeof *v4l2_ctrl);
970 v4l2_ctrl->id = mapping->id;
971 v4l2_ctrl->type = mapping->v4l2_type;
972 strlcpy(v4l2_ctrl->name, mapping->name, sizeof v4l2_ctrl->name);
973 v4l2_ctrl->flags = 0;
975 if (!(ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR))
976 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
977 if (!(ctrl->info.flags & UVC_CTRL_FLAG_SET_CUR))
978 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
980 if (mapping->master_id)
981 __uvc_find_control(ctrl->entity, mapping->master_id,
982 &master_map, &master_ctrl, 0);
983 if (master_ctrl && (master_ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR)) {
985 int ret = __uvc_ctrl_get(chain, master_ctrl, master_map, &val);
989 if (val != mapping->master_manual)
990 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
994 int ret = uvc_ctrl_populate_cache(chain, ctrl);
999 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_DEF) {
1000 v4l2_ctrl->default_value = mapping->get(mapping, UVC_GET_DEF,
1001 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF));
1004 switch (mapping->v4l2_type) {
1005 case V4L2_CTRL_TYPE_MENU:
1006 v4l2_ctrl->minimum = 0;
1007 v4l2_ctrl->maximum = mapping->menu_count - 1;
1008 v4l2_ctrl->step = 1;
1010 menu = mapping->menu_info;
1011 for (i = 0; i < mapping->menu_count; ++i, ++menu) {
1012 if (menu->value == v4l2_ctrl->default_value) {
1013 v4l2_ctrl->default_value = i;
1020 case V4L2_CTRL_TYPE_BOOLEAN:
1021 v4l2_ctrl->minimum = 0;
1022 v4l2_ctrl->maximum = 1;
1023 v4l2_ctrl->step = 1;
1026 case V4L2_CTRL_TYPE_BUTTON:
1027 v4l2_ctrl->minimum = 0;
1028 v4l2_ctrl->maximum = 0;
1029 v4l2_ctrl->step = 0;
1036 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MIN)
1037 v4l2_ctrl->minimum = mapping->get(mapping, UVC_GET_MIN,
1038 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN));
1040 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MAX)
1041 v4l2_ctrl->maximum = mapping->get(mapping, UVC_GET_MAX,
1042 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX));
1044 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES)
1045 v4l2_ctrl->step = mapping->get(mapping, UVC_GET_RES,
1046 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
1051 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
1052 struct v4l2_queryctrl *v4l2_ctrl)
1054 struct uvc_control *ctrl;
1055 struct uvc_control_mapping *mapping;
1058 ret = mutex_lock_interruptible(&chain->ctrl_mutex);
1060 return -ERESTARTSYS;
1062 ctrl = uvc_find_control(chain, v4l2_ctrl->id, &mapping);
1068 ret = __uvc_query_v4l2_ctrl(chain, ctrl, mapping, v4l2_ctrl);
1070 mutex_unlock(&chain->ctrl_mutex);
1075 * Mapping V4L2 controls to UVC controls can be straighforward if done well.
1076 * Most of the UVC controls exist in V4L2, and can be mapped directly. Some
1077 * must be grouped (for instance the Red Balance, Blue Balance and Do White
1078 * Balance V4L2 controls use the White Balance Component UVC control) or
1079 * otherwise translated. The approach we take here is to use a translation
1080 * table for the controls that can be mapped directly, and handle the others
1083 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
1084 struct v4l2_querymenu *query_menu)
1086 struct uvc_menu_info *menu_info;
1087 struct uvc_control_mapping *mapping;
1088 struct uvc_control *ctrl;
1089 u32 index = query_menu->index;
1090 u32 id = query_menu->id;
1093 memset(query_menu, 0, sizeof(*query_menu));
1094 query_menu->id = id;
1095 query_menu->index = index;
1097 ret = mutex_lock_interruptible(&chain->ctrl_mutex);
1099 return -ERESTARTSYS;
1101 ctrl = uvc_find_control(chain, query_menu->id, &mapping);
1107 if (mapping->v4l2_type != V4L2_CTRL_TYPE_MENU ||
1108 query_menu->index >= mapping->menu_count) {
1113 menu_info = &mapping->menu_info[query_menu->index];
1115 if (mapping->data_type == UVC_CTRL_DATA_TYPE_BITMASK &&
1116 (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES)) {
1119 if (!ctrl->cached) {
1120 ret = uvc_ctrl_populate_cache(chain, ctrl);
1125 bitmap = mapping->get(mapping, UVC_GET_RES,
1126 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
1127 if (!(bitmap & menu_info->value)) {
1133 strlcpy(query_menu->name, menu_info->name, sizeof query_menu->name);
1136 mutex_unlock(&chain->ctrl_mutex);
1140 /* --------------------------------------------------------------------------
1141 * Ctrl event handling
1144 static void uvc_ctrl_fill_event(struct uvc_video_chain *chain,
1145 struct v4l2_event *ev,
1146 struct uvc_control *ctrl,
1147 struct uvc_control_mapping *mapping,
1148 s32 value, u32 changes)
1150 struct v4l2_queryctrl v4l2_ctrl;
1152 __uvc_query_v4l2_ctrl(chain, ctrl, mapping, &v4l2_ctrl);
1154 memset(ev->reserved, 0, sizeof(ev->reserved));
1155 ev->type = V4L2_EVENT_CTRL;
1156 ev->id = v4l2_ctrl.id;
1157 ev->u.ctrl.value = value;
1158 ev->u.ctrl.changes = changes;
1159 ev->u.ctrl.type = v4l2_ctrl.type;
1160 ev->u.ctrl.flags = v4l2_ctrl.flags;
1161 ev->u.ctrl.minimum = v4l2_ctrl.minimum;
1162 ev->u.ctrl.maximum = v4l2_ctrl.maximum;
1163 ev->u.ctrl.step = v4l2_ctrl.step;
1164 ev->u.ctrl.default_value = v4l2_ctrl.default_value;
1167 static void uvc_ctrl_send_event(struct uvc_fh *handle,
1168 struct uvc_control *ctrl, struct uvc_control_mapping *mapping,
1169 s32 value, u32 changes)
1171 struct v4l2_subscribed_event *sev;
1172 struct v4l2_event ev;
1174 if (list_empty(&mapping->ev_subs))
1177 uvc_ctrl_fill_event(handle->chain, &ev, ctrl, mapping, value, changes);
1179 list_for_each_entry(sev, &mapping->ev_subs, node) {
1180 if (sev->fh && (sev->fh != &handle->vfh ||
1181 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK) ||
1182 (changes & V4L2_EVENT_CTRL_CH_FLAGS)))
1183 v4l2_event_queue_fh(sev->fh, &ev);
1187 static void uvc_ctrl_send_slave_event(struct uvc_fh *handle,
1188 struct uvc_control *master, u32 slave_id,
1189 const struct v4l2_ext_control *xctrls, unsigned int xctrls_count)
1191 struct uvc_control_mapping *mapping = NULL;
1192 struct uvc_control *ctrl = NULL;
1193 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
1198 * We can skip sending an event for the slave if the slave
1199 * is being modified in the same transaction.
1201 for (i = 0; i < xctrls_count; i++) {
1202 if (xctrls[i].id == slave_id)
1206 __uvc_find_control(master->entity, slave_id, &mapping, &ctrl, 0);
1210 if (__uvc_ctrl_get(handle->chain, ctrl, mapping, &val) == 0)
1211 changes |= V4L2_EVENT_CTRL_CH_VALUE;
1213 uvc_ctrl_send_event(handle, ctrl, mapping, val, changes);
1216 static void uvc_ctrl_send_events(struct uvc_fh *handle,
1217 const struct v4l2_ext_control *xctrls, unsigned int xctrls_count)
1219 struct uvc_control_mapping *mapping;
1220 struct uvc_control *ctrl;
1221 u32 changes = V4L2_EVENT_CTRL_CH_VALUE;
1225 for (i = 0; i < xctrls_count; ++i) {
1226 ctrl = uvc_find_control(handle->chain, xctrls[i].id, &mapping);
1228 for (j = 0; j < ARRAY_SIZE(mapping->slave_ids); ++j) {
1229 if (!mapping->slave_ids[j])
1231 uvc_ctrl_send_slave_event(handle, ctrl,
1232 mapping->slave_ids[j],
1233 xctrls, xctrls_count);
1237 * If the master is being modified in the same transaction
1238 * flags may change too.
1240 if (mapping->master_id) {
1241 for (j = 0; j < xctrls_count; j++) {
1242 if (xctrls[j].id == mapping->master_id) {
1243 changes |= V4L2_EVENT_CTRL_CH_FLAGS;
1249 uvc_ctrl_send_event(handle, ctrl, mapping, xctrls[i].value,
1254 static int uvc_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
1256 struct uvc_fh *handle = container_of(sev->fh, struct uvc_fh, vfh);
1257 struct uvc_control_mapping *mapping;
1258 struct uvc_control *ctrl;
1261 ret = mutex_lock_interruptible(&handle->chain->ctrl_mutex);
1263 return -ERESTARTSYS;
1265 ctrl = uvc_find_control(handle->chain, sev->id, &mapping);
1271 list_add_tail(&sev->node, &mapping->ev_subs);
1272 if (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL) {
1273 struct v4l2_event ev;
1274 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
1277 if (__uvc_ctrl_get(handle->chain, ctrl, mapping, &val) == 0)
1278 changes |= V4L2_EVENT_CTRL_CH_VALUE;
1280 uvc_ctrl_fill_event(handle->chain, &ev, ctrl, mapping, val,
1282 /* Mark the queue as active, allowing this initial
1283 event to be accepted. */
1285 v4l2_event_queue_fh(sev->fh, &ev);
1289 mutex_unlock(&handle->chain->ctrl_mutex);
1293 static void uvc_ctrl_del_event(struct v4l2_subscribed_event *sev)
1295 struct uvc_fh *handle = container_of(sev->fh, struct uvc_fh, vfh);
1297 mutex_lock(&handle->chain->ctrl_mutex);
1298 list_del(&sev->node);
1299 mutex_unlock(&handle->chain->ctrl_mutex);
1302 const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops = {
1303 .add = uvc_ctrl_add_event,
1304 .del = uvc_ctrl_del_event,
1305 .replace = v4l2_ctrl_replace,
1306 .merge = v4l2_ctrl_merge,
1309 /* --------------------------------------------------------------------------
1310 * Control transactions
1312 * To make extended set operations as atomic as the hardware allows, controls
1313 * are handled using begin/commit/rollback operations.
1315 * At the beginning of a set request, uvc_ctrl_begin should be called to
1316 * initialize the request. This function acquires the control lock.
1318 * When setting a control, the new value is stored in the control data field
1319 * at position UVC_CTRL_DATA_CURRENT. The control is then marked as dirty for
1320 * later processing. If the UVC and V4L2 control sizes differ, the current
1321 * value is loaded from the hardware before storing the new value in the data
1324 * After processing all controls in the transaction, uvc_ctrl_commit or
1325 * uvc_ctrl_rollback must be called to apply the pending changes to the
1326 * hardware or revert them. When applying changes, all controls marked as
1327 * dirty will be modified in the UVC device, and the dirty flag will be
1328 * cleared. When reverting controls, the control data field
1329 * UVC_CTRL_DATA_CURRENT is reverted to its previous value
1330 * (UVC_CTRL_DATA_BACKUP) for all dirty controls. Both functions release the
1333 int uvc_ctrl_begin(struct uvc_video_chain *chain)
1335 return mutex_lock_interruptible(&chain->ctrl_mutex) ? -ERESTARTSYS : 0;
1338 static int uvc_ctrl_commit_entity(struct uvc_device *dev,
1339 struct uvc_entity *entity, int rollback)
1341 struct uvc_control *ctrl;
1348 for (i = 0; i < entity->ncontrols; ++i) {
1349 ctrl = &entity->controls[i];
1350 if (!ctrl->initialized)
1353 /* Reset the loaded flag for auto-update controls that were
1354 * marked as loaded in uvc_ctrl_get/uvc_ctrl_set to prevent
1355 * uvc_ctrl_get from using the cached value, and for write-only
1356 * controls to prevent uvc_ctrl_set from setting bits not
1357 * explicitly set by the user.
1359 if (ctrl->info.flags & UVC_CTRL_FLAG_AUTO_UPDATE ||
1360 !(ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR))
1367 ret = uvc_query_ctrl(dev, UVC_SET_CUR, ctrl->entity->id,
1368 dev->intfnum, ctrl->info.selector,
1369 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1374 if (rollback || ret < 0)
1375 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1376 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1388 int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
1389 const struct v4l2_ext_control *xctrls,
1390 unsigned int xctrls_count)
1392 struct uvc_video_chain *chain = handle->chain;
1393 struct uvc_entity *entity;
1396 /* Find the control. */
1397 list_for_each_entry(entity, &chain->entities, chain) {
1398 ret = uvc_ctrl_commit_entity(chain->dev, entity, rollback);
1404 uvc_ctrl_send_events(handle, xctrls, xctrls_count);
1406 mutex_unlock(&chain->ctrl_mutex);
1410 int uvc_ctrl_get(struct uvc_video_chain *chain,
1411 struct v4l2_ext_control *xctrl)
1413 struct uvc_control *ctrl;
1414 struct uvc_control_mapping *mapping;
1416 ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1420 return __uvc_ctrl_get(chain, ctrl, mapping, &xctrl->value);
1423 int uvc_ctrl_set(struct uvc_video_chain *chain,
1424 struct v4l2_ext_control *xctrl)
1426 struct uvc_control *ctrl;
1427 struct uvc_control_mapping *mapping;
1434 ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1437 if (!(ctrl->info.flags & UVC_CTRL_FLAG_SET_CUR))
1440 /* Clamp out of range values. */
1441 switch (mapping->v4l2_type) {
1442 case V4L2_CTRL_TYPE_INTEGER:
1443 if (!ctrl->cached) {
1444 ret = uvc_ctrl_populate_cache(chain, ctrl);
1449 min = mapping->get(mapping, UVC_GET_MIN,
1450 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN));
1451 max = mapping->get(mapping, UVC_GET_MAX,
1452 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX));
1453 step = mapping->get(mapping, UVC_GET_RES,
1454 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
1458 xctrl->value = min + ((u32)(xctrl->value - min) + step / 2)
1460 if (mapping->data_type == UVC_CTRL_DATA_TYPE_SIGNED)
1461 xctrl->value = clamp(xctrl->value, min, max);
1463 xctrl->value = clamp_t(u32, xctrl->value, min, max);
1464 value = xctrl->value;
1467 case V4L2_CTRL_TYPE_BOOLEAN:
1468 xctrl->value = clamp(xctrl->value, 0, 1);
1469 value = xctrl->value;
1472 case V4L2_CTRL_TYPE_MENU:
1473 if (xctrl->value < 0 || xctrl->value >= mapping->menu_count)
1475 value = mapping->menu_info[xctrl->value].value;
1477 /* Valid menu indices are reported by the GET_RES request for
1478 * UVC controls that support it.
1480 if (mapping->data_type == UVC_CTRL_DATA_TYPE_BITMASK &&
1481 (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES)) {
1482 if (!ctrl->cached) {
1483 ret = uvc_ctrl_populate_cache(chain, ctrl);
1488 step = mapping->get(mapping, UVC_GET_RES,
1489 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
1490 if (!(step & value))
1497 value = xctrl->value;
1501 /* If the mapping doesn't span the whole UVC control, the current value
1502 * needs to be loaded from the device to perform the read-modify-write
1505 if (!ctrl->loaded && (ctrl->info.size * 8) != mapping->size) {
1506 if ((ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR) == 0) {
1507 memset(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1508 0, ctrl->info.size);
1510 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR,
1511 ctrl->entity->id, chain->dev->intfnum,
1512 ctrl->info.selector,
1513 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1522 /* Backup the current value in case we need to rollback later. */
1524 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1525 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1529 mapping->set(mapping, value,
1530 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
1537 /* --------------------------------------------------------------------------
1541 static void uvc_ctrl_fixup_xu_info(struct uvc_device *dev,
1542 const struct uvc_control *ctrl, struct uvc_control_info *info)
1544 struct uvc_ctrl_fixup {
1545 struct usb_device_id id;
1551 static const struct uvc_ctrl_fixup fixups[] = {
1552 { { USB_DEVICE(0x046d, 0x08c2) }, 9, 1,
1553 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX |
1554 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR |
1555 UVC_CTRL_FLAG_AUTO_UPDATE },
1556 { { USB_DEVICE(0x046d, 0x08cc) }, 9, 1,
1557 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX |
1558 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR |
1559 UVC_CTRL_FLAG_AUTO_UPDATE },
1560 { { USB_DEVICE(0x046d, 0x0994) }, 9, 1,
1561 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX |
1562 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR |
1563 UVC_CTRL_FLAG_AUTO_UPDATE },
1568 for (i = 0; i < ARRAY_SIZE(fixups); ++i) {
1569 if (!usb_match_one_id(dev->intf, &fixups[i].id))
1572 if (fixups[i].entity == ctrl->entity->id &&
1573 fixups[i].selector == info->selector) {
1574 info->flags = fixups[i].flags;
1581 * Query control information (size and flags) for XU controls.
1583 static int uvc_ctrl_fill_xu_info(struct uvc_device *dev,
1584 const struct uvc_control *ctrl, struct uvc_control_info *info)
1589 data = kmalloc(2, GFP_KERNEL);
1593 memcpy(info->entity, ctrl->entity->extension.guidExtensionCode,
1594 sizeof(info->entity));
1595 info->index = ctrl->index;
1596 info->selector = ctrl->index + 1;
1598 /* Query and verify the control length (GET_LEN) */
1599 ret = uvc_query_ctrl(dev, UVC_GET_LEN, ctrl->entity->id, dev->intfnum,
1600 info->selector, data, 2);
1602 uvc_trace(UVC_TRACE_CONTROL,
1603 "GET_LEN failed on control %pUl/%u (%d).\n",
1604 info->entity, info->selector, ret);
1608 info->size = le16_to_cpup((__le16 *)data);
1610 /* Query the control information (GET_INFO) */
1611 ret = uvc_query_ctrl(dev, UVC_GET_INFO, ctrl->entity->id, dev->intfnum,
1612 info->selector, data, 1);
1614 uvc_trace(UVC_TRACE_CONTROL,
1615 "GET_INFO failed on control %pUl/%u (%d).\n",
1616 info->entity, info->selector, ret);
1620 info->flags = UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX
1621 | UVC_CTRL_FLAG_GET_RES | UVC_CTRL_FLAG_GET_DEF
1622 | (data[0] & UVC_CONTROL_CAP_GET ?
1623 UVC_CTRL_FLAG_GET_CUR : 0)
1624 | (data[0] & UVC_CONTROL_CAP_SET ?
1625 UVC_CTRL_FLAG_SET_CUR : 0)
1626 | (data[0] & UVC_CONTROL_CAP_AUTOUPDATE ?
1627 UVC_CTRL_FLAG_AUTO_UPDATE : 0);
1629 uvc_ctrl_fixup_xu_info(dev, ctrl, info);
1631 uvc_trace(UVC_TRACE_CONTROL, "XU control %pUl/%u queried: len %u, "
1632 "flags { get %u set %u auto %u }.\n",
1633 info->entity, info->selector, info->size,
1634 (info->flags & UVC_CTRL_FLAG_GET_CUR) ? 1 : 0,
1635 (info->flags & UVC_CTRL_FLAG_SET_CUR) ? 1 : 0,
1636 (info->flags & UVC_CTRL_FLAG_AUTO_UPDATE) ? 1 : 0);
1643 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1644 const struct uvc_control_info *info);
1646 static int uvc_ctrl_init_xu_ctrl(struct uvc_device *dev,
1647 struct uvc_control *ctrl)
1649 struct uvc_control_info info;
1652 if (ctrl->initialized)
1655 ret = uvc_ctrl_fill_xu_info(dev, ctrl, &info);
1659 ret = uvc_ctrl_add_info(dev, ctrl, &info);
1661 uvc_trace(UVC_TRACE_CONTROL, "Failed to initialize control "
1662 "%pUl/%u on device %s entity %u\n", info.entity,
1663 info.selector, dev->udev->devpath, ctrl->entity->id);
1668 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
1669 struct uvc_xu_control_query *xqry)
1671 struct uvc_entity *entity;
1672 struct uvc_control *ctrl;
1673 unsigned int i, found = 0;
1679 /* Find the extension unit. */
1680 list_for_each_entry(entity, &chain->entities, chain) {
1681 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT &&
1682 entity->id == xqry->unit)
1686 if (entity->id != xqry->unit) {
1687 uvc_trace(UVC_TRACE_CONTROL, "Extension unit %u not found.\n",
1692 /* Find the control and perform delayed initialization if needed. */
1693 for (i = 0; i < entity->ncontrols; ++i) {
1694 ctrl = &entity->controls[i];
1695 if (ctrl->index == xqry->selector - 1) {
1702 uvc_trace(UVC_TRACE_CONTROL, "Control %pUl/%u not found.\n",
1703 entity->extension.guidExtensionCode, xqry->selector);
1707 if (mutex_lock_interruptible(&chain->ctrl_mutex))
1708 return -ERESTARTSYS;
1710 ret = uvc_ctrl_init_xu_ctrl(chain->dev, ctrl);
1716 /* Validate the required buffer size and flags for the request */
1718 size = ctrl->info.size;
1720 switch (xqry->query) {
1722 reqflags = UVC_CTRL_FLAG_GET_CUR;
1725 reqflags = UVC_CTRL_FLAG_GET_MIN;
1728 reqflags = UVC_CTRL_FLAG_GET_MAX;
1731 reqflags = UVC_CTRL_FLAG_GET_DEF;
1734 reqflags = UVC_CTRL_FLAG_GET_RES;
1737 reqflags = UVC_CTRL_FLAG_SET_CUR;
1750 if (size != xqry->size) {
1755 if (reqflags && !(ctrl->info.flags & reqflags)) {
1760 data = kmalloc(size, GFP_KERNEL);
1766 if (xqry->query == UVC_SET_CUR &&
1767 copy_from_user(data, xqry->data, size)) {
1772 ret = uvc_query_ctrl(chain->dev, xqry->query, xqry->unit,
1773 chain->dev->intfnum, xqry->selector, data, size);
1777 if (xqry->query != UVC_SET_CUR &&
1778 copy_to_user(xqry->data, data, size))
1782 mutex_unlock(&chain->ctrl_mutex);
1786 /* --------------------------------------------------------------------------
1791 * Restore control values after resume, skipping controls that haven't been
1795 * - Don't restore modified controls that are back to their default value.
1796 * - Handle restore order (Auto-Exposure Mode should be restored before
1799 int uvc_ctrl_resume_device(struct uvc_device *dev)
1801 struct uvc_control *ctrl;
1802 struct uvc_entity *entity;
1806 /* Walk the entities list and restore controls when possible. */
1807 list_for_each_entry(entity, &dev->entities, list) {
1809 for (i = 0; i < entity->ncontrols; ++i) {
1810 ctrl = &entity->controls[i];
1812 if (!ctrl->initialized || !ctrl->modified ||
1813 (ctrl->info.flags & UVC_CTRL_FLAG_RESTORE) == 0)
1816 printk(KERN_INFO "restoring control %pUl/%u/%u\n",
1817 ctrl->info.entity, ctrl->info.index,
1818 ctrl->info.selector);
1822 ret = uvc_ctrl_commit_entity(dev, entity, 0);
1830 /* --------------------------------------------------------------------------
1831 * Control and mapping handling
1835 * Add control information to a given control.
1837 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1838 const struct uvc_control_info *info)
1842 memcpy(&ctrl->info, info, sizeof(*info));
1843 INIT_LIST_HEAD(&ctrl->info.mappings);
1845 /* Allocate an array to save control values (cur, def, max, etc.) */
1846 ctrl->uvc_data = kzalloc(ctrl->info.size * UVC_CTRL_DATA_LAST + 1,
1848 if (ctrl->uvc_data == NULL) {
1853 ctrl->initialized = 1;
1855 uvc_trace(UVC_TRACE_CONTROL, "Added control %pUl/%u to device %s "
1856 "entity %u\n", ctrl->info.entity, ctrl->info.selector,
1857 dev->udev->devpath, ctrl->entity->id);
1861 kfree(ctrl->uvc_data);
1866 * Add a control mapping to a given control.
1868 static int __uvc_ctrl_add_mapping(struct uvc_device *dev,
1869 struct uvc_control *ctrl, const struct uvc_control_mapping *mapping)
1871 struct uvc_control_mapping *map;
1874 /* Most mappings come from static kernel data and need to be duplicated.
1875 * Mappings that come from userspace will be unnecessarily duplicated,
1876 * this could be optimized.
1878 map = kmemdup(mapping, sizeof(*mapping), GFP_KERNEL);
1882 INIT_LIST_HEAD(&map->ev_subs);
1884 size = sizeof(*mapping->menu_info) * mapping->menu_count;
1885 map->menu_info = kmemdup(mapping->menu_info, size, GFP_KERNEL);
1886 if (map->menu_info == NULL) {
1891 if (map->get == NULL)
1892 map->get = uvc_get_le_value;
1893 if (map->set == NULL)
1894 map->set = uvc_set_le_value;
1896 list_add_tail(&map->list, &ctrl->info.mappings);
1897 uvc_trace(UVC_TRACE_CONTROL,
1898 "Adding mapping '%s' to control %pUl/%u.\n",
1899 map->name, ctrl->info.entity, ctrl->info.selector);
1904 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
1905 const struct uvc_control_mapping *mapping)
1907 struct uvc_device *dev = chain->dev;
1908 struct uvc_control_mapping *map;
1909 struct uvc_entity *entity;
1910 struct uvc_control *ctrl;
1914 if (mapping->id & ~V4L2_CTRL_ID_MASK) {
1915 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', control "
1916 "id 0x%08x is invalid.\n", mapping->name,
1921 /* Search for the matching (GUID/CS) control on the current chain */
1922 list_for_each_entry(entity, &chain->entities, chain) {
1925 if (UVC_ENTITY_TYPE(entity) != UVC_VC_EXTENSION_UNIT ||
1926 !uvc_entity_match_guid(entity, mapping->entity))
1929 for (i = 0; i < entity->ncontrols; ++i) {
1930 ctrl = &entity->controls[i];
1931 if (ctrl->index == mapping->selector - 1) {
1943 if (mutex_lock_interruptible(&chain->ctrl_mutex))
1944 return -ERESTARTSYS;
1946 /* Perform delayed initialization of XU controls */
1947 ret = uvc_ctrl_init_xu_ctrl(dev, ctrl);
1953 list_for_each_entry(map, &ctrl->info.mappings, list) {
1954 if (mapping->id == map->id) {
1955 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', "
1956 "control id 0x%08x already exists.\n",
1957 mapping->name, mapping->id);
1963 /* Prevent excess memory consumption */
1964 if (atomic_inc_return(&dev->nmappings) > UVC_MAX_CONTROL_MAPPINGS) {
1965 atomic_dec(&dev->nmappings);
1966 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', maximum "
1967 "mappings count (%u) exceeded.\n", mapping->name,
1968 UVC_MAX_CONTROL_MAPPINGS);
1973 ret = __uvc_ctrl_add_mapping(dev, ctrl, mapping);
1975 atomic_dec(&dev->nmappings);
1978 mutex_unlock(&chain->ctrl_mutex);
1983 * Prune an entity of its bogus controls using a blacklist. Bogus controls
1984 * are currently the ones that crash the camera or unconditionally return an
1985 * error when queried.
1987 static void uvc_ctrl_prune_entity(struct uvc_device *dev,
1988 struct uvc_entity *entity)
1990 struct uvc_ctrl_blacklist {
1991 struct usb_device_id id;
1995 static const struct uvc_ctrl_blacklist processing_blacklist[] = {
1996 { { USB_DEVICE(0x13d3, 0x509b) }, 9 }, /* Gain */
1997 { { USB_DEVICE(0x1c4f, 0x3000) }, 6 }, /* WB Temperature */
1998 { { USB_DEVICE(0x5986, 0x0241) }, 2 }, /* Hue */
2000 static const struct uvc_ctrl_blacklist camera_blacklist[] = {
2001 { { USB_DEVICE(0x06f8, 0x3005) }, 9 }, /* Zoom, Absolute */
2004 const struct uvc_ctrl_blacklist *blacklist;
2010 switch (UVC_ENTITY_TYPE(entity)) {
2011 case UVC_VC_PROCESSING_UNIT:
2012 blacklist = processing_blacklist;
2013 count = ARRAY_SIZE(processing_blacklist);
2014 controls = entity->processing.bmControls;
2015 size = entity->processing.bControlSize;
2018 case UVC_ITT_CAMERA:
2019 blacklist = camera_blacklist;
2020 count = ARRAY_SIZE(camera_blacklist);
2021 controls = entity->camera.bmControls;
2022 size = entity->camera.bControlSize;
2029 for (i = 0; i < count; ++i) {
2030 if (!usb_match_one_id(dev->intf, &blacklist[i].id))
2033 if (blacklist[i].index >= 8 * size ||
2034 !uvc_test_bit(controls, blacklist[i].index))
2037 uvc_trace(UVC_TRACE_CONTROL, "%u/%u control is black listed, "
2038 "removing it.\n", entity->id, blacklist[i].index);
2040 uvc_clear_bit(controls, blacklist[i].index);
2045 * Add control information and hardcoded stock control mappings to the given
2048 static void uvc_ctrl_init_ctrl(struct uvc_device *dev, struct uvc_control *ctrl)
2050 const struct uvc_control_info *info = uvc_ctrls;
2051 const struct uvc_control_info *iend = info + ARRAY_SIZE(uvc_ctrls);
2052 const struct uvc_control_mapping *mapping = uvc_ctrl_mappings;
2053 const struct uvc_control_mapping *mend =
2054 mapping + ARRAY_SIZE(uvc_ctrl_mappings);
2056 /* XU controls initialization requires querying the device for control
2057 * information. As some buggy UVC devices will crash when queried
2058 * repeatedly in a tight loop, delay XU controls initialization until
2061 if (UVC_ENTITY_TYPE(ctrl->entity) == UVC_VC_EXTENSION_UNIT)
2064 for (; info < iend; ++info) {
2065 if (uvc_entity_match_guid(ctrl->entity, info->entity) &&
2066 ctrl->index == info->index) {
2067 uvc_ctrl_add_info(dev, ctrl, info);
2072 if (!ctrl->initialized)
2075 for (; mapping < mend; ++mapping) {
2076 if (uvc_entity_match_guid(ctrl->entity, mapping->entity) &&
2077 ctrl->info.selector == mapping->selector)
2078 __uvc_ctrl_add_mapping(dev, ctrl, mapping);
2083 * Initialize device controls.
2085 int uvc_ctrl_init_device(struct uvc_device *dev)
2087 struct uvc_entity *entity;
2090 /* Walk the entities list and instantiate controls */
2091 list_for_each_entry(entity, &dev->entities, list) {
2092 struct uvc_control *ctrl;
2093 unsigned int bControlSize = 0, ncontrols;
2094 __u8 *bmControls = NULL;
2096 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT) {
2097 bmControls = entity->extension.bmControls;
2098 bControlSize = entity->extension.bControlSize;
2099 } else if (UVC_ENTITY_TYPE(entity) == UVC_VC_PROCESSING_UNIT) {
2100 bmControls = entity->processing.bmControls;
2101 bControlSize = entity->processing.bControlSize;
2102 } else if (UVC_ENTITY_TYPE(entity) == UVC_ITT_CAMERA) {
2103 bmControls = entity->camera.bmControls;
2104 bControlSize = entity->camera.bControlSize;
2107 /* Remove bogus/blacklisted controls */
2108 uvc_ctrl_prune_entity(dev, entity);
2110 /* Count supported controls and allocate the controls array */
2111 ncontrols = memweight(bmControls, bControlSize);
2115 entity->controls = kcalloc(ncontrols, sizeof(*ctrl),
2117 if (entity->controls == NULL)
2119 entity->ncontrols = ncontrols;
2121 /* Initialize all supported controls */
2122 ctrl = entity->controls;
2123 for (i = 0; i < bControlSize * 8; ++i) {
2124 if (uvc_test_bit(bmControls, i) == 0)
2127 ctrl->entity = entity;
2130 uvc_ctrl_init_ctrl(dev, ctrl);
2139 * Cleanup device controls.
2141 static void uvc_ctrl_cleanup_mappings(struct uvc_device *dev,
2142 struct uvc_control *ctrl)
2144 struct uvc_control_mapping *mapping, *nm;
2146 list_for_each_entry_safe(mapping, nm, &ctrl->info.mappings, list) {
2147 list_del(&mapping->list);
2148 kfree(mapping->menu_info);
2153 void uvc_ctrl_cleanup_device(struct uvc_device *dev)
2155 struct uvc_entity *entity;
2158 /* Free controls and control mappings for all entities. */
2159 list_for_each_entry(entity, &dev->entities, list) {
2160 for (i = 0; i < entity->ncontrols; ++i) {
2161 struct uvc_control *ctrl = &entity->controls[i];
2163 if (!ctrl->initialized)
2166 uvc_ctrl_cleanup_mappings(dev, ctrl);
2167 kfree(ctrl->uvc_data);
2170 kfree(entity->controls);