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 <asm/atomic.h>
27 #define UVC_CTRL_DATA_CURRENT 0
28 #define UVC_CTRL_DATA_BACKUP 1
29 #define UVC_CTRL_DATA_MIN 2
30 #define UVC_CTRL_DATA_MAX 3
31 #define UVC_CTRL_DATA_RES 4
32 #define UVC_CTRL_DATA_DEF 5
33 #define UVC_CTRL_DATA_LAST 6
35 /* ------------------------------------------------------------------------
39 static struct uvc_control_info uvc_ctrls[] = {
41 .entity = UVC_GUID_UVC_PROCESSING,
42 .selector = UVC_PU_BRIGHTNESS_CONTROL,
45 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
46 | UVC_CONTROL_RESTORE,
49 .entity = UVC_GUID_UVC_PROCESSING,
50 .selector = UVC_PU_CONTRAST_CONTROL,
53 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
54 | UVC_CONTROL_RESTORE,
57 .entity = UVC_GUID_UVC_PROCESSING,
58 .selector = UVC_PU_HUE_CONTROL,
61 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
62 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
65 .entity = UVC_GUID_UVC_PROCESSING,
66 .selector = UVC_PU_SATURATION_CONTROL,
69 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
70 | UVC_CONTROL_RESTORE,
73 .entity = UVC_GUID_UVC_PROCESSING,
74 .selector = UVC_PU_SHARPNESS_CONTROL,
77 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
78 | UVC_CONTROL_RESTORE,
81 .entity = UVC_GUID_UVC_PROCESSING,
82 .selector = UVC_PU_GAMMA_CONTROL,
85 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
86 | UVC_CONTROL_RESTORE,
89 .entity = UVC_GUID_UVC_PROCESSING,
90 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL,
93 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
94 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
97 .entity = UVC_GUID_UVC_PROCESSING,
98 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
101 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
102 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
105 .entity = UVC_GUID_UVC_PROCESSING,
106 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
109 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
110 | UVC_CONTROL_RESTORE,
113 .entity = UVC_GUID_UVC_PROCESSING,
114 .selector = UVC_PU_GAIN_CONTROL,
117 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
118 | UVC_CONTROL_RESTORE,
121 .entity = UVC_GUID_UVC_PROCESSING,
122 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL,
125 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
126 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
129 .entity = UVC_GUID_UVC_PROCESSING,
130 .selector = UVC_PU_HUE_AUTO_CONTROL,
133 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
134 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
137 .entity = UVC_GUID_UVC_PROCESSING,
138 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL,
141 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
142 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
145 .entity = UVC_GUID_UVC_PROCESSING,
146 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL,
149 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
150 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
153 .entity = UVC_GUID_UVC_PROCESSING,
154 .selector = UVC_PU_DIGITAL_MULTIPLIER_CONTROL,
157 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
158 | UVC_CONTROL_RESTORE,
161 .entity = UVC_GUID_UVC_PROCESSING,
162 .selector = UVC_PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL,
165 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
166 | UVC_CONTROL_RESTORE,
169 .entity = UVC_GUID_UVC_PROCESSING,
170 .selector = UVC_PU_ANALOG_VIDEO_STANDARD_CONTROL,
173 .flags = UVC_CONTROL_GET_CUR,
176 .entity = UVC_GUID_UVC_PROCESSING,
177 .selector = UVC_PU_ANALOG_LOCK_STATUS_CONTROL,
180 .flags = UVC_CONTROL_GET_CUR,
183 .entity = UVC_GUID_UVC_CAMERA,
184 .selector = UVC_CT_SCANNING_MODE_CONTROL,
187 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
188 | UVC_CONTROL_RESTORE,
191 .entity = UVC_GUID_UVC_CAMERA,
192 .selector = UVC_CT_AE_MODE_CONTROL,
195 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
196 | UVC_CONTROL_GET_DEF | UVC_CONTROL_GET_RES
197 | UVC_CONTROL_RESTORE,
200 .entity = UVC_GUID_UVC_CAMERA,
201 .selector = UVC_CT_AE_PRIORITY_CONTROL,
204 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
205 | UVC_CONTROL_RESTORE,
208 .entity = UVC_GUID_UVC_CAMERA,
209 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
212 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
213 | UVC_CONTROL_RESTORE,
216 .entity = UVC_GUID_UVC_CAMERA,
217 .selector = UVC_CT_EXPOSURE_TIME_RELATIVE_CONTROL,
220 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_RESTORE,
223 .entity = UVC_GUID_UVC_CAMERA,
224 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
227 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
228 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
231 .entity = UVC_GUID_UVC_CAMERA,
232 .selector = UVC_CT_FOCUS_RELATIVE_CONTROL,
235 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_MIN
236 | UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES
237 | UVC_CONTROL_GET_DEF | UVC_CONTROL_AUTO_UPDATE,
240 .entity = UVC_GUID_UVC_CAMERA,
241 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL,
244 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
245 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
248 .entity = UVC_GUID_UVC_CAMERA,
249 .selector = UVC_CT_IRIS_RELATIVE_CONTROL,
252 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_AUTO_UPDATE,
255 .entity = UVC_GUID_UVC_CAMERA,
256 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
259 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
260 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
263 .entity = UVC_GUID_UVC_CAMERA,
264 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL,
267 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_MIN
268 | UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES
269 | UVC_CONTROL_GET_DEF | UVC_CONTROL_AUTO_UPDATE,
272 .entity = UVC_GUID_UVC_CAMERA,
273 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
276 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
277 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
280 .entity = UVC_GUID_UVC_CAMERA,
281 .selector = UVC_CT_PANTILT_RELATIVE_CONTROL,
284 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_MIN
285 | UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES
286 | UVC_CONTROL_GET_DEF | UVC_CONTROL_AUTO_UPDATE,
289 .entity = UVC_GUID_UVC_CAMERA,
290 .selector = UVC_CT_ROLL_ABSOLUTE_CONTROL,
293 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
294 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
297 .entity = UVC_GUID_UVC_CAMERA,
298 .selector = UVC_CT_ROLL_RELATIVE_CONTROL,
301 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_MIN
302 | UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES
303 | UVC_CONTROL_GET_DEF | UVC_CONTROL_AUTO_UPDATE,
306 .entity = UVC_GUID_UVC_CAMERA,
307 .selector = UVC_CT_FOCUS_AUTO_CONTROL,
310 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
311 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
314 .entity = UVC_GUID_UVC_CAMERA,
315 .selector = UVC_CT_PRIVACY_CONTROL,
318 .flags = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
319 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
323 static struct uvc_menu_info power_line_frequency_controls[] = {
329 static struct uvc_menu_info exposure_auto_controls[] = {
331 { 1, "Manual Mode" },
332 { 4, "Shutter Priority Mode" },
333 { 8, "Aperture Priority Mode" },
336 static __s32 uvc_ctrl_get_zoom(struct uvc_control_mapping *mapping,
337 __u8 query, const __u8 *data)
339 __s8 zoom = (__s8)data[0];
343 return (zoom == 0) ? 0 : (zoom > 0 ? data[2] : -data[2]);
354 static void uvc_ctrl_set_zoom(struct uvc_control_mapping *mapping,
355 __s32 value, __u8 *data)
357 data[0] = value == 0 ? 0 : (value > 0) ? 1 : 0xff;
358 data[2] = min((int)abs(value), 0xff);
361 static struct uvc_control_mapping uvc_ctrl_mappings[] = {
363 .id = V4L2_CID_BRIGHTNESS,
364 .name = "Brightness",
365 .entity = UVC_GUID_UVC_PROCESSING,
366 .selector = UVC_PU_BRIGHTNESS_CONTROL,
369 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
370 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
373 .id = V4L2_CID_CONTRAST,
375 .entity = UVC_GUID_UVC_PROCESSING,
376 .selector = UVC_PU_CONTRAST_CONTROL,
379 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
380 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
385 .entity = UVC_GUID_UVC_PROCESSING,
386 .selector = UVC_PU_HUE_CONTROL,
389 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
390 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
393 .id = V4L2_CID_SATURATION,
394 .name = "Saturation",
395 .entity = UVC_GUID_UVC_PROCESSING,
396 .selector = UVC_PU_SATURATION_CONTROL,
399 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
400 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
403 .id = V4L2_CID_SHARPNESS,
405 .entity = UVC_GUID_UVC_PROCESSING,
406 .selector = UVC_PU_SHARPNESS_CONTROL,
409 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
410 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
413 .id = V4L2_CID_GAMMA,
415 .entity = UVC_GUID_UVC_PROCESSING,
416 .selector = UVC_PU_GAMMA_CONTROL,
419 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
420 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
423 .id = V4L2_CID_BACKLIGHT_COMPENSATION,
424 .name = "Backlight Compensation",
425 .entity = UVC_GUID_UVC_PROCESSING,
426 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
429 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
430 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
435 .entity = UVC_GUID_UVC_PROCESSING,
436 .selector = UVC_PU_GAIN_CONTROL,
439 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
440 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
443 .id = V4L2_CID_POWER_LINE_FREQUENCY,
444 .name = "Power Line Frequency",
445 .entity = UVC_GUID_UVC_PROCESSING,
446 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL,
449 .v4l2_type = V4L2_CTRL_TYPE_MENU,
450 .data_type = UVC_CTRL_DATA_TYPE_ENUM,
451 .menu_info = power_line_frequency_controls,
452 .menu_count = ARRAY_SIZE(power_line_frequency_controls),
455 .id = V4L2_CID_HUE_AUTO,
457 .entity = UVC_GUID_UVC_PROCESSING,
458 .selector = UVC_PU_HUE_AUTO_CONTROL,
461 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
462 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
465 .id = V4L2_CID_EXPOSURE_AUTO,
466 .name = "Exposure, Auto",
467 .entity = UVC_GUID_UVC_CAMERA,
468 .selector = UVC_CT_AE_MODE_CONTROL,
471 .v4l2_type = V4L2_CTRL_TYPE_MENU,
472 .data_type = UVC_CTRL_DATA_TYPE_BITMASK,
473 .menu_info = exposure_auto_controls,
474 .menu_count = ARRAY_SIZE(exposure_auto_controls),
477 .id = V4L2_CID_EXPOSURE_AUTO_PRIORITY,
478 .name = "Exposure, Auto Priority",
479 .entity = UVC_GUID_UVC_CAMERA,
480 .selector = UVC_CT_AE_PRIORITY_CONTROL,
483 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
484 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
487 .id = V4L2_CID_EXPOSURE_ABSOLUTE,
488 .name = "Exposure (Absolute)",
489 .entity = UVC_GUID_UVC_CAMERA,
490 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
493 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
494 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
497 .id = V4L2_CID_AUTO_WHITE_BALANCE,
498 .name = "White Balance Temperature, Auto",
499 .entity = UVC_GUID_UVC_PROCESSING,
500 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL,
503 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
504 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
507 .id = V4L2_CID_WHITE_BALANCE_TEMPERATURE,
508 .name = "White Balance Temperature",
509 .entity = UVC_GUID_UVC_PROCESSING,
510 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL,
513 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
514 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
517 .id = V4L2_CID_AUTO_WHITE_BALANCE,
518 .name = "White Balance Component, Auto",
519 .entity = UVC_GUID_UVC_PROCESSING,
520 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL,
523 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
524 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
527 .id = V4L2_CID_BLUE_BALANCE,
528 .name = "White Balance Blue Component",
529 .entity = UVC_GUID_UVC_PROCESSING,
530 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
533 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
534 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
537 .id = V4L2_CID_RED_BALANCE,
538 .name = "White Balance Red Component",
539 .entity = UVC_GUID_UVC_PROCESSING,
540 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
543 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
544 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
547 .id = V4L2_CID_FOCUS_ABSOLUTE,
548 .name = "Focus (absolute)",
549 .entity = UVC_GUID_UVC_CAMERA,
550 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
553 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
554 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
557 .id = V4L2_CID_FOCUS_AUTO,
558 .name = "Focus, Auto",
559 .entity = UVC_GUID_UVC_CAMERA,
560 .selector = UVC_CT_FOCUS_AUTO_CONTROL,
563 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
564 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
567 .id = V4L2_CID_IRIS_ABSOLUTE,
568 .name = "Iris, Absolute",
569 .entity = UVC_GUID_UVC_CAMERA,
570 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL,
573 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
574 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
577 .id = V4L2_CID_IRIS_RELATIVE,
578 .name = "Iris, Relative",
579 .entity = UVC_GUID_UVC_CAMERA,
580 .selector = UVC_CT_IRIS_RELATIVE_CONTROL,
583 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
584 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
587 .id = V4L2_CID_ZOOM_ABSOLUTE,
588 .name = "Zoom, Absolute",
589 .entity = UVC_GUID_UVC_CAMERA,
590 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
593 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
594 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
597 .id = V4L2_CID_ZOOM_CONTINUOUS,
598 .name = "Zoom, Continuous",
599 .entity = UVC_GUID_UVC_CAMERA,
600 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL,
603 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
604 .data_type = UVC_CTRL_DATA_TYPE_SIGNED,
605 .get = uvc_ctrl_get_zoom,
606 .set = uvc_ctrl_set_zoom,
609 .id = V4L2_CID_PAN_ABSOLUTE,
610 .name = "Pan (Absolute)",
611 .entity = UVC_GUID_UVC_CAMERA,
612 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
615 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
616 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
619 .id = V4L2_CID_TILT_ABSOLUTE,
620 .name = "Tilt (Absolute)",
621 .entity = UVC_GUID_UVC_CAMERA,
622 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
625 .v4l2_type = V4L2_CTRL_TYPE_INTEGER,
626 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED,
629 .id = V4L2_CID_PRIVACY,
631 .entity = UVC_GUID_UVC_CAMERA,
632 .selector = UVC_CT_PRIVACY_CONTROL,
635 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN,
636 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN,
640 /* ------------------------------------------------------------------------
644 static inline __u8 *uvc_ctrl_data(struct uvc_control *ctrl, int id)
646 return ctrl->uvc_data + id * ctrl->info.size;
649 static inline int uvc_test_bit(const __u8 *data, int bit)
651 return (data[bit >> 3] >> (bit & 7)) & 1;
654 static inline void uvc_clear_bit(__u8 *data, int bit)
656 data[bit >> 3] &= ~(1 << (bit & 7));
659 /* Extract the bit string specified by mapping->offset and mapping->size
660 * from the little-endian data stored at 'data' and return the result as
661 * a signed 32bit integer. Sign extension will be performed if the mapping
662 * references a signed data type.
664 static __s32 uvc_get_le_value(struct uvc_control_mapping *mapping,
665 __u8 query, const __u8 *data)
667 int bits = mapping->size;
668 int offset = mapping->offset;
674 mask = ((1LL << bits) - 1) << offset;
676 for (; bits > 0; data++) {
677 __u8 byte = *data & mask;
678 value |= offset > 0 ? (byte >> offset) : (byte << (-offset));
679 bits -= 8 - (offset > 0 ? offset : 0);
681 mask = (1 << bits) - 1;
684 /* Sign-extend the value if needed. */
685 if (mapping->data_type == UVC_CTRL_DATA_TYPE_SIGNED)
686 value |= -(value & (1 << (mapping->size - 1)));
691 /* Set the bit string specified by mapping->offset and mapping->size
692 * in the little-endian data stored at 'data' to the value 'value'.
694 static void uvc_set_le_value(struct uvc_control_mapping *mapping,
695 __s32 value, __u8 *data)
697 int bits = mapping->size;
698 int offset = mapping->offset;
701 /* According to the v4l2 spec, writing any value to a button control
702 * should result in the action belonging to the button control being
703 * triggered. UVC devices however want to see a 1 written -> override
706 if (mapping->v4l2_type == V4L2_CTRL_TYPE_BUTTON)
712 for (; bits > 0; data++) {
713 mask = ((1LL << bits) - 1) << offset;
714 *data = (*data & ~mask) | ((value << offset) & mask);
715 value >>= offset ? offset : 8;
721 /* ------------------------------------------------------------------------
722 * Terminal and unit management
725 static const __u8 uvc_processing_guid[16] = UVC_GUID_UVC_PROCESSING;
726 static const __u8 uvc_camera_guid[16] = UVC_GUID_UVC_CAMERA;
727 static const __u8 uvc_media_transport_input_guid[16] =
728 UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT;
730 static int uvc_entity_match_guid(const struct uvc_entity *entity,
733 switch (UVC_ENTITY_TYPE(entity)) {
735 return memcmp(uvc_camera_guid, guid, 16) == 0;
737 case UVC_ITT_MEDIA_TRANSPORT_INPUT:
738 return memcmp(uvc_media_transport_input_guid, guid, 16) == 0;
740 case UVC_VC_PROCESSING_UNIT:
741 return memcmp(uvc_processing_guid, guid, 16) == 0;
743 case UVC_VC_EXTENSION_UNIT:
744 return memcmp(entity->extension.guidExtensionCode,
752 /* ------------------------------------------------------------------------
756 static void __uvc_find_control(struct uvc_entity *entity, __u32 v4l2_id,
757 struct uvc_control_mapping **mapping, struct uvc_control **control,
760 struct uvc_control *ctrl;
761 struct uvc_control_mapping *map;
767 for (i = 0; i < entity->ncontrols; ++i) {
768 ctrl = &entity->controls[i];
769 if (!ctrl->initialized)
772 list_for_each_entry(map, &ctrl->info.mappings, list) {
773 if ((map->id == v4l2_id) && !next) {
779 if ((*mapping == NULL || (*mapping)->id > map->id) &&
780 (map->id > v4l2_id) && next) {
788 struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
789 __u32 v4l2_id, struct uvc_control_mapping **mapping)
791 struct uvc_control *ctrl = NULL;
792 struct uvc_entity *entity;
793 int next = v4l2_id & V4L2_CTRL_FLAG_NEXT_CTRL;
797 /* Mask the query flags. */
798 v4l2_id &= V4L2_CTRL_ID_MASK;
800 /* Find the control. */
801 list_for_each_entry(entity, &chain->entities, chain) {
802 __uvc_find_control(entity, v4l2_id, mapping, &ctrl, next);
807 if (ctrl == NULL && !next)
808 uvc_trace(UVC_TRACE_CONTROL, "Control 0x%08x not found.\n",
814 static int uvc_ctrl_populate_cache(struct uvc_video_chain *chain,
815 struct uvc_control *ctrl)
819 if (ctrl->info.flags & UVC_CONTROL_GET_DEF) {
820 ret = uvc_query_ctrl(chain->dev, UVC_GET_DEF, ctrl->entity->id,
821 chain->dev->intfnum, ctrl->info.selector,
822 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF),
828 if (ctrl->info.flags & UVC_CONTROL_GET_MIN) {
829 ret = uvc_query_ctrl(chain->dev, UVC_GET_MIN, ctrl->entity->id,
830 chain->dev->intfnum, ctrl->info.selector,
831 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN),
836 if (ctrl->info.flags & UVC_CONTROL_GET_MAX) {
837 ret = uvc_query_ctrl(chain->dev, UVC_GET_MAX, ctrl->entity->id,
838 chain->dev->intfnum, ctrl->info.selector,
839 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX),
844 if (ctrl->info.flags & UVC_CONTROL_GET_RES) {
845 ret = uvc_query_ctrl(chain->dev, UVC_GET_RES, ctrl->entity->id,
846 chain->dev->intfnum, ctrl->info.selector,
847 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES),
857 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
858 struct v4l2_queryctrl *v4l2_ctrl)
860 struct uvc_control *ctrl;
861 struct uvc_control_mapping *mapping;
862 struct uvc_menu_info *menu;
866 ret = mutex_lock_interruptible(&chain->ctrl_mutex);
870 ctrl = uvc_find_control(chain, v4l2_ctrl->id, &mapping);
876 memset(v4l2_ctrl, 0, sizeof *v4l2_ctrl);
877 v4l2_ctrl->id = mapping->id;
878 v4l2_ctrl->type = mapping->v4l2_type;
879 strlcpy(v4l2_ctrl->name, mapping->name, sizeof v4l2_ctrl->name);
880 v4l2_ctrl->flags = 0;
882 if (!(ctrl->info.flags & UVC_CONTROL_GET_CUR))
883 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
884 if (!(ctrl->info.flags & UVC_CONTROL_SET_CUR))
885 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
888 ret = uvc_ctrl_populate_cache(chain, ctrl);
893 if (ctrl->info.flags & UVC_CONTROL_GET_DEF) {
894 v4l2_ctrl->default_value = mapping->get(mapping, UVC_GET_DEF,
895 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF));
898 switch (mapping->v4l2_type) {
899 case V4L2_CTRL_TYPE_MENU:
900 v4l2_ctrl->minimum = 0;
901 v4l2_ctrl->maximum = mapping->menu_count - 1;
904 menu = mapping->menu_info;
905 for (i = 0; i < mapping->menu_count; ++i, ++menu) {
906 if (menu->value == v4l2_ctrl->default_value) {
907 v4l2_ctrl->default_value = i;
914 case V4L2_CTRL_TYPE_BOOLEAN:
915 v4l2_ctrl->minimum = 0;
916 v4l2_ctrl->maximum = 1;
920 case V4L2_CTRL_TYPE_BUTTON:
921 v4l2_ctrl->minimum = 0;
922 v4l2_ctrl->maximum = 0;
930 if (ctrl->info.flags & UVC_CONTROL_GET_MIN)
931 v4l2_ctrl->minimum = mapping->get(mapping, UVC_GET_MIN,
932 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN));
934 if (ctrl->info.flags & UVC_CONTROL_GET_MAX)
935 v4l2_ctrl->maximum = mapping->get(mapping, UVC_GET_MAX,
936 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX));
938 if (ctrl->info.flags & UVC_CONTROL_GET_RES)
939 v4l2_ctrl->step = mapping->get(mapping, UVC_GET_RES,
940 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
943 mutex_unlock(&chain->ctrl_mutex);
948 /* --------------------------------------------------------------------------
949 * Control transactions
951 * To make extended set operations as atomic as the hardware allows, controls
952 * are handled using begin/commit/rollback operations.
954 * At the beginning of a set request, uvc_ctrl_begin should be called to
955 * initialize the request. This function acquires the control lock.
957 * When setting a control, the new value is stored in the control data field
958 * at position UVC_CTRL_DATA_CURRENT. The control is then marked as dirty for
959 * later processing. If the UVC and V4L2 control sizes differ, the current
960 * value is loaded from the hardware before storing the new value in the data
963 * After processing all controls in the transaction, uvc_ctrl_commit or
964 * uvc_ctrl_rollback must be called to apply the pending changes to the
965 * hardware or revert them. When applying changes, all controls marked as
966 * dirty will be modified in the UVC device, and the dirty flag will be
967 * cleared. When reverting controls, the control data field
968 * UVC_CTRL_DATA_CURRENT is reverted to its previous value
969 * (UVC_CTRL_DATA_BACKUP) for all dirty controls. Both functions release the
972 int uvc_ctrl_begin(struct uvc_video_chain *chain)
974 return mutex_lock_interruptible(&chain->ctrl_mutex) ? -ERESTARTSYS : 0;
977 static int uvc_ctrl_commit_entity(struct uvc_device *dev,
978 struct uvc_entity *entity, int rollback)
980 struct uvc_control *ctrl;
987 for (i = 0; i < entity->ncontrols; ++i) {
988 ctrl = &entity->controls[i];
989 if (!ctrl->initialized)
992 /* Reset the loaded flag for auto-update controls that were
993 * marked as loaded in uvc_ctrl_get/uvc_ctrl_set to prevent
994 * uvc_ctrl_get from using the cached value.
996 if (ctrl->info.flags & UVC_CONTROL_AUTO_UPDATE)
1003 ret = uvc_query_ctrl(dev, UVC_SET_CUR, ctrl->entity->id,
1004 dev->intfnum, ctrl->info.selector,
1005 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1010 if (rollback || ret < 0)
1011 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1012 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1024 int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback)
1026 struct uvc_entity *entity;
1029 /* Find the control. */
1030 list_for_each_entry(entity, &chain->entities, chain) {
1031 ret = uvc_ctrl_commit_entity(chain->dev, entity, rollback);
1037 mutex_unlock(&chain->ctrl_mutex);
1041 int uvc_ctrl_get(struct uvc_video_chain *chain,
1042 struct v4l2_ext_control *xctrl)
1044 struct uvc_control *ctrl;
1045 struct uvc_control_mapping *mapping;
1046 struct uvc_menu_info *menu;
1050 ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1051 if (ctrl == NULL || (ctrl->info.flags & UVC_CONTROL_GET_CUR) == 0)
1054 if (!ctrl->loaded) {
1055 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, ctrl->entity->id,
1056 chain->dev->intfnum, ctrl->info.selector,
1057 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1065 xctrl->value = mapping->get(mapping, UVC_GET_CUR,
1066 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
1068 if (mapping->v4l2_type == V4L2_CTRL_TYPE_MENU) {
1069 menu = mapping->menu_info;
1070 for (i = 0; i < mapping->menu_count; ++i, ++menu) {
1071 if (menu->value == xctrl->value) {
1081 int uvc_ctrl_set(struct uvc_video_chain *chain,
1082 struct v4l2_ext_control *xctrl)
1084 struct uvc_control *ctrl;
1085 struct uvc_control_mapping *mapping;
1092 ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1093 if (ctrl == NULL || (ctrl->info.flags & UVC_CONTROL_SET_CUR) == 0)
1096 /* Clamp out of range values. */
1097 switch (mapping->v4l2_type) {
1098 case V4L2_CTRL_TYPE_INTEGER:
1099 if (!ctrl->cached) {
1100 ret = uvc_ctrl_populate_cache(chain, ctrl);
1105 min = mapping->get(mapping, UVC_GET_MIN,
1106 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN));
1107 max = mapping->get(mapping, UVC_GET_MAX,
1108 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX));
1109 step = mapping->get(mapping, UVC_GET_RES,
1110 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES));
1114 xctrl->value = min + (xctrl->value - min + step/2) / step * step;
1115 xctrl->value = clamp(xctrl->value, min, max);
1116 value = xctrl->value;
1119 case V4L2_CTRL_TYPE_BOOLEAN:
1120 xctrl->value = clamp(xctrl->value, 0, 1);
1121 value = xctrl->value;
1124 case V4L2_CTRL_TYPE_MENU:
1125 if (xctrl->value < 0 || xctrl->value >= mapping->menu_count)
1127 value = mapping->menu_info[xctrl->value].value;
1131 value = xctrl->value;
1135 /* If the mapping doesn't span the whole UVC control, the current value
1136 * needs to be loaded from the device to perform the read-modify-write
1139 if (!ctrl->loaded && (ctrl->info.size * 8) != mapping->size) {
1140 if ((ctrl->info.flags & UVC_CONTROL_GET_CUR) == 0) {
1141 memset(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1142 0, ctrl->info.size);
1144 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR,
1145 ctrl->entity->id, chain->dev->intfnum,
1146 ctrl->info.selector,
1147 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1156 /* Backup the current value in case we need to rollback later. */
1158 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1159 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1163 mapping->set(mapping, value,
1164 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
1171 /* --------------------------------------------------------------------------
1175 static void uvc_ctrl_fixup_xu_info(struct uvc_device *dev,
1176 const struct uvc_control *ctrl, struct uvc_control_info *info)
1178 struct uvc_ctrl_fixup {
1179 struct usb_device_id id;
1185 static const struct uvc_ctrl_fixup fixups[] = {
1186 { { USB_DEVICE(0x046d, 0x08c2) }, 9, 1,
1187 UVC_CONTROL_GET_MIN | UVC_CONTROL_GET_MAX |
1188 UVC_CONTROL_GET_DEF | UVC_CONTROL_SET_CUR |
1189 UVC_CONTROL_AUTO_UPDATE },
1190 { { USB_DEVICE(0x046d, 0x08cc) }, 9, 1,
1191 UVC_CONTROL_GET_MIN | UVC_CONTROL_GET_MAX |
1192 UVC_CONTROL_GET_DEF | UVC_CONTROL_SET_CUR |
1193 UVC_CONTROL_AUTO_UPDATE },
1194 { { USB_DEVICE(0x046d, 0x0994) }, 9, 1,
1195 UVC_CONTROL_GET_MIN | UVC_CONTROL_GET_MAX |
1196 UVC_CONTROL_GET_DEF | UVC_CONTROL_SET_CUR |
1197 UVC_CONTROL_AUTO_UPDATE },
1202 for (i = 0; i < ARRAY_SIZE(fixups); ++i) {
1203 if (!usb_match_one_id(dev->intf, &fixups[i].id))
1206 if (fixups[i].entity == ctrl->entity->id &&
1207 fixups[i].selector == info->selector) {
1208 info->flags = fixups[i].flags;
1215 * Query control information (size and flags) for XU controls.
1217 static int uvc_ctrl_fill_xu_info(struct uvc_device *dev,
1218 const struct uvc_control *ctrl, struct uvc_control_info *info)
1223 data = kmalloc(2, GFP_KERNEL);
1227 memcpy(info->entity, ctrl->entity->extension.guidExtensionCode,
1228 sizeof(info->entity));
1229 info->index = ctrl->index;
1230 info->selector = ctrl->index + 1;
1232 /* Query and verify the control length (GET_LEN) */
1233 ret = uvc_query_ctrl(dev, UVC_GET_LEN, ctrl->entity->id, dev->intfnum,
1234 info->selector, data, 2);
1236 uvc_trace(UVC_TRACE_CONTROL,
1237 "GET_LEN failed on control %pUl/%u (%d).\n",
1238 info->entity, info->selector, ret);
1242 info->size = le16_to_cpup((__le16 *)data);
1244 /* Query the control information (GET_INFO) */
1245 ret = uvc_query_ctrl(dev, UVC_GET_INFO, ctrl->entity->id, dev->intfnum,
1246 info->selector, data, 1);
1248 uvc_trace(UVC_TRACE_CONTROL,
1249 "GET_INFO failed on control %pUl/%u (%d).\n",
1250 info->entity, info->selector, ret);
1254 info->flags = UVC_CONTROL_GET_MIN | UVC_CONTROL_GET_MAX
1255 | UVC_CONTROL_GET_RES | UVC_CONTROL_GET_DEF
1256 | (data[0] & UVC_CONTROL_CAP_GET ? UVC_CONTROL_GET_CUR : 0)
1257 | (data[0] & UVC_CONTROL_CAP_SET ? UVC_CONTROL_SET_CUR : 0)
1258 | (data[0] & UVC_CONTROL_CAP_AUTOUPDATE ?
1259 UVC_CONTROL_AUTO_UPDATE : 0);
1261 uvc_ctrl_fixup_xu_info(dev, ctrl, info);
1263 uvc_trace(UVC_TRACE_CONTROL, "XU control %pUl/%u queried: len %u, "
1264 "flags { get %u set %u auto %u }.\n",
1265 info->entity, info->selector, info->size,
1266 (info->flags & UVC_CONTROL_GET_CUR) ? 1 : 0,
1267 (info->flags & UVC_CONTROL_SET_CUR) ? 1 : 0,
1268 (info->flags & UVC_CONTROL_AUTO_UPDATE) ? 1 : 0);
1275 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1276 const struct uvc_control_info *info);
1278 static int uvc_ctrl_init_xu_ctrl(struct uvc_device *dev,
1279 struct uvc_control *ctrl)
1281 struct uvc_control_info info;
1284 if (ctrl->initialized)
1287 ret = uvc_ctrl_fill_xu_info(dev, ctrl, &info);
1291 ret = uvc_ctrl_add_info(dev, ctrl, &info);
1293 uvc_trace(UVC_TRACE_CONTROL, "Failed to initialize control "
1294 "%pUl/%u on device %s entity %u\n", info.entity,
1295 info.selector, dev->udev->devpath, ctrl->entity->id);
1300 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
1301 struct uvc_xu_control *xctrl, int set)
1303 struct uvc_entity *entity;
1304 struct uvc_control *ctrl = NULL;
1305 unsigned int i, found = 0;
1310 /* Find the extension unit. */
1311 list_for_each_entry(entity, &chain->entities, chain) {
1312 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT &&
1313 entity->id == xctrl->unit)
1317 if (entity->id != xctrl->unit) {
1318 uvc_trace(UVC_TRACE_CONTROL, "Extension unit %u not found.\n",
1323 /* Find the control and perform delayed initialization if needed. */
1324 for (i = 0; i < entity->ncontrols; ++i) {
1325 ctrl = &entity->controls[i];
1326 if (ctrl->index == xctrl->selector - 1) {
1333 uvc_trace(UVC_TRACE_CONTROL, "Control %pUl/%u not found.\n",
1334 entity->extension.guidExtensionCode, xctrl->selector);
1338 if (mutex_lock_interruptible(&chain->ctrl_mutex))
1339 return -ERESTARTSYS;
1341 ret = uvc_ctrl_init_xu_ctrl(chain->dev, ctrl);
1347 /* Validate control data size. */
1348 if (ctrl->info.size != xctrl->size) {
1353 if ((set && !(ctrl->info.flags & UVC_CONTROL_SET_CUR)) ||
1354 (!set && !(ctrl->info.flags & UVC_CONTROL_GET_CUR))) {
1359 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1360 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1362 data = uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT);
1365 if (set && copy_from_user(data, xctrl->data, xctrl->size)) {
1370 ret = uvc_query_ctrl(chain->dev, set ? UVC_SET_CUR : UVC_GET_CUR,
1371 xctrl->unit, chain->dev->intfnum, xctrl->selector,
1376 if (!set && copy_to_user(xctrl->data, data, xctrl->size))
1380 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1381 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1384 mutex_unlock(&chain->ctrl_mutex);
1388 /* --------------------------------------------------------------------------
1393 * Restore control values after resume, skipping controls that haven't been
1397 * - Don't restore modified controls that are back to their default value.
1398 * - Handle restore order (Auto-Exposure Mode should be restored before
1401 int uvc_ctrl_resume_device(struct uvc_device *dev)
1403 struct uvc_control *ctrl;
1404 struct uvc_entity *entity;
1408 /* Walk the entities list and restore controls when possible. */
1409 list_for_each_entry(entity, &dev->entities, list) {
1411 for (i = 0; i < entity->ncontrols; ++i) {
1412 ctrl = &entity->controls[i];
1414 if (!ctrl->initialized || !ctrl->modified ||
1415 (ctrl->info.flags & UVC_CONTROL_RESTORE) == 0)
1418 printk(KERN_INFO "restoring control %pUl/%u/%u\n",
1419 ctrl->info.entity, ctrl->info.index,
1420 ctrl->info.selector);
1424 ret = uvc_ctrl_commit_entity(dev, entity, 0);
1432 /* --------------------------------------------------------------------------
1433 * Control and mapping handling
1437 * Add control information to a given control.
1439 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1440 const struct uvc_control_info *info)
1444 memcpy(&ctrl->info, info, sizeof(*info));
1445 INIT_LIST_HEAD(&ctrl->info.mappings);
1447 /* Allocate an array to save control values (cur, def, max, etc.) */
1448 ctrl->uvc_data = kzalloc(ctrl->info.size * UVC_CTRL_DATA_LAST + 1,
1450 if (ctrl->uvc_data == NULL) {
1455 ctrl->initialized = 1;
1457 uvc_trace(UVC_TRACE_CONTROL, "Added control %pUl/%u to device %s "
1458 "entity %u\n", ctrl->info.entity, ctrl->info.selector,
1459 dev->udev->devpath, ctrl->entity->id);
1463 kfree(ctrl->uvc_data);
1468 * Add a control mapping to a given control.
1470 static int __uvc_ctrl_add_mapping(struct uvc_device *dev,
1471 struct uvc_control *ctrl, const struct uvc_control_mapping *mapping)
1473 struct uvc_control_mapping *map;
1476 /* Most mappings come from static kernel data and need to be duplicated.
1477 * Mappings that come from userspace will be unnecessarily duplicated,
1478 * this could be optimized.
1480 map = kmemdup(mapping, sizeof(*mapping), GFP_KERNEL);
1484 size = sizeof(*mapping->menu_info) * mapping->menu_count;
1485 map->menu_info = kmemdup(mapping->menu_info, size, GFP_KERNEL);
1486 if (map->menu_info == NULL) {
1491 if (map->get == NULL)
1492 map->get = uvc_get_le_value;
1493 if (map->set == NULL)
1494 map->set = uvc_set_le_value;
1496 map->ctrl = &ctrl->info;
1497 list_add_tail(&map->list, &ctrl->info.mappings);
1498 uvc_trace(UVC_TRACE_CONTROL,
1499 "Adding mapping '%s' to control %pUl/%u.\n",
1500 map->name, ctrl->info.entity, ctrl->info.selector);
1505 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
1506 const struct uvc_control_mapping *mapping)
1508 struct uvc_device *dev = chain->dev;
1509 struct uvc_control_mapping *map;
1510 struct uvc_entity *entity;
1511 struct uvc_control *ctrl;
1515 if (mapping->id & ~V4L2_CTRL_ID_MASK) {
1516 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', control "
1517 "id 0x%08x is invalid.\n", mapping->name,
1522 /* Search for the matching (GUID/CS) control in the given device */
1523 list_for_each_entry(entity, &dev->entities, list) {
1526 if (UVC_ENTITY_TYPE(entity) != UVC_VC_EXTENSION_UNIT ||
1527 !uvc_entity_match_guid(entity, mapping->entity))
1530 for (i = 0; i < entity->ncontrols; ++i) {
1531 ctrl = &entity->controls[i];
1532 if (ctrl->index == mapping->selector - 1) {
1544 if (mutex_lock_interruptible(&chain->ctrl_mutex))
1545 return -ERESTARTSYS;
1547 /* Perform delayed initialization of XU controls */
1548 ret = uvc_ctrl_init_xu_ctrl(dev, ctrl);
1554 list_for_each_entry(map, &ctrl->info.mappings, list) {
1555 if (mapping->id == map->id) {
1556 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', "
1557 "control id 0x%08x already exists.\n",
1558 mapping->name, mapping->id);
1564 /* Prevent excess memory consumption */
1565 if (atomic_inc_return(&dev->nmappings) > UVC_MAX_CONTROL_MAPPINGS) {
1566 atomic_dec(&dev->nmappings);
1567 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', maximum "
1568 "mappings count (%u) exceeded.\n", mapping->name,
1569 UVC_MAX_CONTROL_MAPPINGS);
1574 ret = __uvc_ctrl_add_mapping(dev, ctrl, mapping);
1576 atomic_dec(&dev->nmappings);
1579 mutex_unlock(&chain->ctrl_mutex);
1584 * Prune an entity of its bogus controls using a blacklist. Bogus controls
1585 * are currently the ones that crash the camera or unconditionally return an
1586 * error when queried.
1588 static void uvc_ctrl_prune_entity(struct uvc_device *dev,
1589 struct uvc_entity *entity)
1591 struct uvc_ctrl_blacklist {
1592 struct usb_device_id id;
1596 static const struct uvc_ctrl_blacklist processing_blacklist[] = {
1597 { { USB_DEVICE(0x13d3, 0x509b) }, 9 }, /* Gain */
1598 { { USB_DEVICE(0x1c4f, 0x3000) }, 6 }, /* WB Temperature */
1599 { { USB_DEVICE(0x5986, 0x0241) }, 2 }, /* Hue */
1601 static const struct uvc_ctrl_blacklist camera_blacklist[] = {
1602 { { USB_DEVICE(0x06f8, 0x3005) }, 9 }, /* Zoom, Absolute */
1605 const struct uvc_ctrl_blacklist *blacklist;
1611 switch (UVC_ENTITY_TYPE(entity)) {
1612 case UVC_VC_PROCESSING_UNIT:
1613 blacklist = processing_blacklist;
1614 count = ARRAY_SIZE(processing_blacklist);
1615 controls = entity->processing.bmControls;
1616 size = entity->processing.bControlSize;
1619 case UVC_ITT_CAMERA:
1620 blacklist = camera_blacklist;
1621 count = ARRAY_SIZE(camera_blacklist);
1622 controls = entity->camera.bmControls;
1623 size = entity->camera.bControlSize;
1630 for (i = 0; i < count; ++i) {
1631 if (!usb_match_one_id(dev->intf, &blacklist[i].id))
1634 if (blacklist[i].index >= 8 * size ||
1635 !uvc_test_bit(controls, blacklist[i].index))
1638 uvc_trace(UVC_TRACE_CONTROL, "%u/%u control is black listed, "
1639 "removing it.\n", entity->id, blacklist[i].index);
1641 uvc_clear_bit(controls, blacklist[i].index);
1646 * Add control information and hardcoded stock control mappings to the given
1649 static void uvc_ctrl_init_ctrl(struct uvc_device *dev, struct uvc_control *ctrl)
1651 const struct uvc_control_info *info = uvc_ctrls;
1652 const struct uvc_control_info *iend = info + ARRAY_SIZE(uvc_ctrls);
1653 const struct uvc_control_mapping *mapping = uvc_ctrl_mappings;
1654 const struct uvc_control_mapping *mend =
1655 mapping + ARRAY_SIZE(uvc_ctrl_mappings);
1657 /* XU controls initialization requires querying the device for control
1658 * information. As some buggy UVC devices will crash when queried
1659 * repeatedly in a tight loop, delay XU controls initialization until
1662 if (UVC_ENTITY_TYPE(ctrl->entity) == UVC_VC_EXTENSION_UNIT)
1665 for (; info < iend; ++info) {
1666 if (uvc_entity_match_guid(ctrl->entity, info->entity) &&
1667 ctrl->index == info->index) {
1668 uvc_ctrl_add_info(dev, ctrl, info);
1673 if (!ctrl->initialized)
1676 for (; mapping < mend; ++mapping) {
1677 if (uvc_entity_match_guid(ctrl->entity, mapping->entity) &&
1678 ctrl->info.selector == mapping->selector)
1679 __uvc_ctrl_add_mapping(dev, ctrl, mapping);
1684 * Initialize device controls.
1686 int uvc_ctrl_init_device(struct uvc_device *dev)
1688 struct uvc_entity *entity;
1691 /* Walk the entities list and instantiate controls */
1692 list_for_each_entry(entity, &dev->entities, list) {
1693 struct uvc_control *ctrl;
1694 unsigned int bControlSize = 0, ncontrols = 0;
1695 __u8 *bmControls = NULL;
1697 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT) {
1698 bmControls = entity->extension.bmControls;
1699 bControlSize = entity->extension.bControlSize;
1700 } else if (UVC_ENTITY_TYPE(entity) == UVC_VC_PROCESSING_UNIT) {
1701 bmControls = entity->processing.bmControls;
1702 bControlSize = entity->processing.bControlSize;
1703 } else if (UVC_ENTITY_TYPE(entity) == UVC_ITT_CAMERA) {
1704 bmControls = entity->camera.bmControls;
1705 bControlSize = entity->camera.bControlSize;
1708 /* Remove bogus/blacklisted controls */
1709 uvc_ctrl_prune_entity(dev, entity);
1711 /* Count supported controls and allocate the controls array */
1712 for (i = 0; i < bControlSize; ++i)
1713 ncontrols += hweight8(bmControls[i]);
1717 entity->controls = kzalloc(ncontrols * sizeof(*ctrl),
1719 if (entity->controls == NULL)
1721 entity->ncontrols = ncontrols;
1723 /* Initialize all supported controls */
1724 ctrl = entity->controls;
1725 for (i = 0; i < bControlSize * 8; ++i) {
1726 if (uvc_test_bit(bmControls, i) == 0)
1729 ctrl->entity = entity;
1732 uvc_ctrl_init_ctrl(dev, ctrl);
1741 * Cleanup device controls.
1743 static void uvc_ctrl_cleanup_mappings(struct uvc_device *dev,
1744 struct uvc_control *ctrl)
1746 struct uvc_control_mapping *mapping, *nm;
1748 list_for_each_entry_safe(mapping, nm, &ctrl->info.mappings, list) {
1749 list_del(&mapping->list);
1750 kfree(mapping->menu_info);
1755 void uvc_ctrl_cleanup_device(struct uvc_device *dev)
1757 struct uvc_entity *entity;
1760 /* Free controls and control mappings for all entities. */
1761 list_for_each_entry(entity, &dev->entities, list) {
1762 for (i = 0; i < entity->ncontrols; ++i) {
1763 struct uvc_control *ctrl = &entity->controls[i];
1765 if (!ctrl->initialized)
1768 uvc_ctrl_cleanup_mappings(dev, ctrl);
1769 kfree(ctrl->uvc_data);
1772 kfree(entity->controls);