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 static 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 * Mapping V4L2 controls to UVC controls can be straighforward if done well.
949 * Most of the UVC controls exist in V4L2, and can be mapped directly. Some
950 * must be grouped (for instance the Red Balance, Blue Balance and Do White
951 * Balance V4L2 controls use the White Balance Component UVC control) or
952 * otherwise translated. The approach we take here is to use a translation
953 * table for the controls that can be mapped directly, and handle the others
956 int uvc_query_v4l2_menu(struct uvc_video_chain
*chain
,
957 struct v4l2_querymenu
*query_menu
)
959 struct uvc_menu_info
*menu_info
;
960 struct uvc_control_mapping
*mapping
;
961 struct uvc_control
*ctrl
;
962 u32 index
= query_menu
->index
;
963 u32 id
= query_menu
->id
;
966 memset(query_menu
, 0, sizeof(*query_menu
));
968 query_menu
->index
= index
;
970 ret
= mutex_lock_interruptible(&chain
->ctrl_mutex
);
974 ctrl
= uvc_find_control(chain
, query_menu
->id
, &mapping
);
975 if (ctrl
== NULL
|| mapping
->v4l2_type
!= V4L2_CTRL_TYPE_MENU
) {
980 if (query_menu
->index
>= mapping
->menu_count
) {
985 menu_info
= &mapping
->menu_info
[query_menu
->index
];
986 strlcpy(query_menu
->name
, menu_info
->name
, sizeof query_menu
->name
);
989 mutex_unlock(&chain
->ctrl_mutex
);
994 /* --------------------------------------------------------------------------
995 * Control transactions
997 * To make extended set operations as atomic as the hardware allows, controls
998 * are handled using begin/commit/rollback operations.
1000 * At the beginning of a set request, uvc_ctrl_begin should be called to
1001 * initialize the request. This function acquires the control lock.
1003 * When setting a control, the new value is stored in the control data field
1004 * at position UVC_CTRL_DATA_CURRENT. The control is then marked as dirty for
1005 * later processing. If the UVC and V4L2 control sizes differ, the current
1006 * value is loaded from the hardware before storing the new value in the data
1009 * After processing all controls in the transaction, uvc_ctrl_commit or
1010 * uvc_ctrl_rollback must be called to apply the pending changes to the
1011 * hardware or revert them. When applying changes, all controls marked as
1012 * dirty will be modified in the UVC device, and the dirty flag will be
1013 * cleared. When reverting controls, the control data field
1014 * UVC_CTRL_DATA_CURRENT is reverted to its previous value
1015 * (UVC_CTRL_DATA_BACKUP) for all dirty controls. Both functions release the
1018 int uvc_ctrl_begin(struct uvc_video_chain
*chain
)
1020 return mutex_lock_interruptible(&chain
->ctrl_mutex
) ? -ERESTARTSYS
: 0;
1023 static int uvc_ctrl_commit_entity(struct uvc_device
*dev
,
1024 struct uvc_entity
*entity
, int rollback
)
1026 struct uvc_control
*ctrl
;
1033 for (i
= 0; i
< entity
->ncontrols
; ++i
) {
1034 ctrl
= &entity
->controls
[i
];
1035 if (!ctrl
->initialized
)
1038 /* Reset the loaded flag for auto-update controls that were
1039 * marked as loaded in uvc_ctrl_get/uvc_ctrl_set to prevent
1040 * uvc_ctrl_get from using the cached value.
1042 if (ctrl
->info
.flags
& UVC_CONTROL_AUTO_UPDATE
)
1049 ret
= uvc_query_ctrl(dev
, UVC_SET_CUR
, ctrl
->entity
->id
,
1050 dev
->intfnum
, ctrl
->info
.selector
,
1051 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1056 if (rollback
|| ret
< 0)
1057 memcpy(uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1058 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_BACKUP
),
1070 int __uvc_ctrl_commit(struct uvc_video_chain
*chain
, int rollback
)
1072 struct uvc_entity
*entity
;
1075 /* Find the control. */
1076 list_for_each_entry(entity
, &chain
->entities
, chain
) {
1077 ret
= uvc_ctrl_commit_entity(chain
->dev
, entity
, rollback
);
1083 mutex_unlock(&chain
->ctrl_mutex
);
1087 int uvc_ctrl_get(struct uvc_video_chain
*chain
,
1088 struct v4l2_ext_control
*xctrl
)
1090 struct uvc_control
*ctrl
;
1091 struct uvc_control_mapping
*mapping
;
1092 struct uvc_menu_info
*menu
;
1096 ctrl
= uvc_find_control(chain
, xctrl
->id
, &mapping
);
1097 if (ctrl
== NULL
|| (ctrl
->info
.flags
& UVC_CONTROL_GET_CUR
) == 0)
1100 if (!ctrl
->loaded
) {
1101 ret
= uvc_query_ctrl(chain
->dev
, UVC_GET_CUR
, ctrl
->entity
->id
,
1102 chain
->dev
->intfnum
, ctrl
->info
.selector
,
1103 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1111 xctrl
->value
= mapping
->get(mapping
, UVC_GET_CUR
,
1112 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
));
1114 if (mapping
->v4l2_type
== V4L2_CTRL_TYPE_MENU
) {
1115 menu
= mapping
->menu_info
;
1116 for (i
= 0; i
< mapping
->menu_count
; ++i
, ++menu
) {
1117 if (menu
->value
== xctrl
->value
) {
1127 int uvc_ctrl_set(struct uvc_video_chain
*chain
,
1128 struct v4l2_ext_control
*xctrl
)
1130 struct uvc_control
*ctrl
;
1131 struct uvc_control_mapping
*mapping
;
1138 ctrl
= uvc_find_control(chain
, xctrl
->id
, &mapping
);
1139 if (ctrl
== NULL
|| (ctrl
->info
.flags
& UVC_CONTROL_SET_CUR
) == 0)
1142 /* Clamp out of range values. */
1143 switch (mapping
->v4l2_type
) {
1144 case V4L2_CTRL_TYPE_INTEGER
:
1145 if (!ctrl
->cached
) {
1146 ret
= uvc_ctrl_populate_cache(chain
, ctrl
);
1151 min
= mapping
->get(mapping
, UVC_GET_MIN
,
1152 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_MIN
));
1153 max
= mapping
->get(mapping
, UVC_GET_MAX
,
1154 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_MAX
));
1155 step
= mapping
->get(mapping
, UVC_GET_RES
,
1156 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_RES
));
1160 xctrl
->value
= min
+ (xctrl
->value
- min
+ step
/2) / step
* step
;
1161 xctrl
->value
= clamp(xctrl
->value
, min
, max
);
1162 value
= xctrl
->value
;
1165 case V4L2_CTRL_TYPE_BOOLEAN
:
1166 xctrl
->value
= clamp(xctrl
->value
, 0, 1);
1167 value
= xctrl
->value
;
1170 case V4L2_CTRL_TYPE_MENU
:
1171 if (xctrl
->value
< 0 || xctrl
->value
>= mapping
->menu_count
)
1173 value
= mapping
->menu_info
[xctrl
->value
].value
;
1177 value
= xctrl
->value
;
1181 /* If the mapping doesn't span the whole UVC control, the current value
1182 * needs to be loaded from the device to perform the read-modify-write
1185 if (!ctrl
->loaded
&& (ctrl
->info
.size
* 8) != mapping
->size
) {
1186 if ((ctrl
->info
.flags
& UVC_CONTROL_GET_CUR
) == 0) {
1187 memset(uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1188 0, ctrl
->info
.size
);
1190 ret
= uvc_query_ctrl(chain
->dev
, UVC_GET_CUR
,
1191 ctrl
->entity
->id
, chain
->dev
->intfnum
,
1192 ctrl
->info
.selector
,
1193 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1202 /* Backup the current value in case we need to rollback later. */
1204 memcpy(uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_BACKUP
),
1205 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1209 mapping
->set(mapping
, value
,
1210 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
));
1217 /* --------------------------------------------------------------------------
1221 static void uvc_ctrl_fixup_xu_info(struct uvc_device
*dev
,
1222 const struct uvc_control
*ctrl
, struct uvc_control_info
*info
)
1224 struct uvc_ctrl_fixup
{
1225 struct usb_device_id id
;
1231 static const struct uvc_ctrl_fixup fixups
[] = {
1232 { { USB_DEVICE(0x046d, 0x08c2) }, 9, 1,
1233 UVC_CONTROL_GET_MIN
| UVC_CONTROL_GET_MAX
|
1234 UVC_CONTROL_GET_DEF
| UVC_CONTROL_SET_CUR
|
1235 UVC_CONTROL_AUTO_UPDATE
},
1236 { { USB_DEVICE(0x046d, 0x08cc) }, 9, 1,
1237 UVC_CONTROL_GET_MIN
| UVC_CONTROL_GET_MAX
|
1238 UVC_CONTROL_GET_DEF
| UVC_CONTROL_SET_CUR
|
1239 UVC_CONTROL_AUTO_UPDATE
},
1240 { { USB_DEVICE(0x046d, 0x0994) }, 9, 1,
1241 UVC_CONTROL_GET_MIN
| UVC_CONTROL_GET_MAX
|
1242 UVC_CONTROL_GET_DEF
| UVC_CONTROL_SET_CUR
|
1243 UVC_CONTROL_AUTO_UPDATE
},
1248 for (i
= 0; i
< ARRAY_SIZE(fixups
); ++i
) {
1249 if (!usb_match_one_id(dev
->intf
, &fixups
[i
].id
))
1252 if (fixups
[i
].entity
== ctrl
->entity
->id
&&
1253 fixups
[i
].selector
== info
->selector
) {
1254 info
->flags
= fixups
[i
].flags
;
1261 * Query control information (size and flags) for XU controls.
1263 static int uvc_ctrl_fill_xu_info(struct uvc_device
*dev
,
1264 const struct uvc_control
*ctrl
, struct uvc_control_info
*info
)
1269 data
= kmalloc(2, GFP_KERNEL
);
1273 memcpy(info
->entity
, ctrl
->entity
->extension
.guidExtensionCode
,
1274 sizeof(info
->entity
));
1275 info
->index
= ctrl
->index
;
1276 info
->selector
= ctrl
->index
+ 1;
1278 /* Query and verify the control length (GET_LEN) */
1279 ret
= uvc_query_ctrl(dev
, UVC_GET_LEN
, ctrl
->entity
->id
, dev
->intfnum
,
1280 info
->selector
, data
, 2);
1282 uvc_trace(UVC_TRACE_CONTROL
,
1283 "GET_LEN failed on control %pUl/%u (%d).\n",
1284 info
->entity
, info
->selector
, ret
);
1288 info
->size
= le16_to_cpup((__le16
*)data
);
1290 /* Query the control information (GET_INFO) */
1291 ret
= uvc_query_ctrl(dev
, UVC_GET_INFO
, ctrl
->entity
->id
, dev
->intfnum
,
1292 info
->selector
, data
, 1);
1294 uvc_trace(UVC_TRACE_CONTROL
,
1295 "GET_INFO failed on control %pUl/%u (%d).\n",
1296 info
->entity
, info
->selector
, ret
);
1300 info
->flags
= UVC_CONTROL_GET_MIN
| UVC_CONTROL_GET_MAX
1301 | UVC_CONTROL_GET_RES
| UVC_CONTROL_GET_DEF
1302 | (data
[0] & UVC_CONTROL_CAP_GET
? UVC_CONTROL_GET_CUR
: 0)
1303 | (data
[0] & UVC_CONTROL_CAP_SET
? UVC_CONTROL_SET_CUR
: 0)
1304 | (data
[0] & UVC_CONTROL_CAP_AUTOUPDATE
?
1305 UVC_CONTROL_AUTO_UPDATE
: 0);
1307 uvc_ctrl_fixup_xu_info(dev
, ctrl
, info
);
1309 uvc_trace(UVC_TRACE_CONTROL
, "XU control %pUl/%u queried: len %u, "
1310 "flags { get %u set %u auto %u }.\n",
1311 info
->entity
, info
->selector
, info
->size
,
1312 (info
->flags
& UVC_CONTROL_GET_CUR
) ? 1 : 0,
1313 (info
->flags
& UVC_CONTROL_SET_CUR
) ? 1 : 0,
1314 (info
->flags
& UVC_CONTROL_AUTO_UPDATE
) ? 1 : 0);
1321 static int uvc_ctrl_add_info(struct uvc_device
*dev
, struct uvc_control
*ctrl
,
1322 const struct uvc_control_info
*info
);
1324 static int uvc_ctrl_init_xu_ctrl(struct uvc_device
*dev
,
1325 struct uvc_control
*ctrl
)
1327 struct uvc_control_info info
;
1330 if (ctrl
->initialized
)
1333 ret
= uvc_ctrl_fill_xu_info(dev
, ctrl
, &info
);
1337 ret
= uvc_ctrl_add_info(dev
, ctrl
, &info
);
1339 uvc_trace(UVC_TRACE_CONTROL
, "Failed to initialize control "
1340 "%pUl/%u on device %s entity %u\n", info
.entity
,
1341 info
.selector
, dev
->udev
->devpath
, ctrl
->entity
->id
);
1346 int uvc_xu_ctrl_query(struct uvc_video_chain
*chain
,
1347 struct uvc_xu_control
*xctrl
, int set
)
1349 struct uvc_entity
*entity
;
1350 struct uvc_control
*ctrl
= NULL
;
1351 unsigned int i
, found
= 0;
1356 /* Find the extension unit. */
1357 list_for_each_entry(entity
, &chain
->entities
, chain
) {
1358 if (UVC_ENTITY_TYPE(entity
) == UVC_VC_EXTENSION_UNIT
&&
1359 entity
->id
== xctrl
->unit
)
1363 if (entity
->id
!= xctrl
->unit
) {
1364 uvc_trace(UVC_TRACE_CONTROL
, "Extension unit %u not found.\n",
1369 /* Find the control and perform delayed initialization if needed. */
1370 for (i
= 0; i
< entity
->ncontrols
; ++i
) {
1371 ctrl
= &entity
->controls
[i
];
1372 if (ctrl
->index
== xctrl
->selector
- 1) {
1379 uvc_trace(UVC_TRACE_CONTROL
, "Control %pUl/%u not found.\n",
1380 entity
->extension
.guidExtensionCode
, xctrl
->selector
);
1384 if (mutex_lock_interruptible(&chain
->ctrl_mutex
))
1385 return -ERESTARTSYS
;
1387 ret
= uvc_ctrl_init_xu_ctrl(chain
->dev
, ctrl
);
1393 /* Validate control data size. */
1394 if (ctrl
->info
.size
!= xctrl
->size
) {
1399 if ((set
&& !(ctrl
->info
.flags
& UVC_CONTROL_SET_CUR
)) ||
1400 (!set
&& !(ctrl
->info
.flags
& UVC_CONTROL_GET_CUR
))) {
1405 memcpy(uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_BACKUP
),
1406 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1408 data
= uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
);
1411 if (set
&& copy_from_user(data
, xctrl
->data
, xctrl
->size
)) {
1416 ret
= uvc_query_ctrl(chain
->dev
, set
? UVC_SET_CUR
: UVC_GET_CUR
,
1417 xctrl
->unit
, chain
->dev
->intfnum
, xctrl
->selector
,
1422 if (!set
&& copy_to_user(xctrl
->data
, data
, xctrl
->size
))
1426 memcpy(uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_CURRENT
),
1427 uvc_ctrl_data(ctrl
, UVC_CTRL_DATA_BACKUP
),
1430 mutex_unlock(&chain
->ctrl_mutex
);
1434 /* --------------------------------------------------------------------------
1439 * Restore control values after resume, skipping controls that haven't been
1443 * - Don't restore modified controls that are back to their default value.
1444 * - Handle restore order (Auto-Exposure Mode should be restored before
1447 int uvc_ctrl_resume_device(struct uvc_device
*dev
)
1449 struct uvc_control
*ctrl
;
1450 struct uvc_entity
*entity
;
1454 /* Walk the entities list and restore controls when possible. */
1455 list_for_each_entry(entity
, &dev
->entities
, list
) {
1457 for (i
= 0; i
< entity
->ncontrols
; ++i
) {
1458 ctrl
= &entity
->controls
[i
];
1460 if (!ctrl
->initialized
|| !ctrl
->modified
||
1461 (ctrl
->info
.flags
& UVC_CONTROL_RESTORE
) == 0)
1464 printk(KERN_INFO
"restoring control %pUl/%u/%u\n",
1465 ctrl
->info
.entity
, ctrl
->info
.index
,
1466 ctrl
->info
.selector
);
1470 ret
= uvc_ctrl_commit_entity(dev
, entity
, 0);
1478 /* --------------------------------------------------------------------------
1479 * Control and mapping handling
1483 * Add control information to a given control.
1485 static int uvc_ctrl_add_info(struct uvc_device
*dev
, struct uvc_control
*ctrl
,
1486 const struct uvc_control_info
*info
)
1490 memcpy(&ctrl
->info
, info
, sizeof(*info
));
1491 INIT_LIST_HEAD(&ctrl
->info
.mappings
);
1493 /* Allocate an array to save control values (cur, def, max, etc.) */
1494 ctrl
->uvc_data
= kzalloc(ctrl
->info
.size
* UVC_CTRL_DATA_LAST
+ 1,
1496 if (ctrl
->uvc_data
== NULL
) {
1501 ctrl
->initialized
= 1;
1503 uvc_trace(UVC_TRACE_CONTROL
, "Added control %pUl/%u to device %s "
1504 "entity %u\n", ctrl
->info
.entity
, ctrl
->info
.selector
,
1505 dev
->udev
->devpath
, ctrl
->entity
->id
);
1509 kfree(ctrl
->uvc_data
);
1514 * Add a control mapping to a given control.
1516 static int __uvc_ctrl_add_mapping(struct uvc_device
*dev
,
1517 struct uvc_control
*ctrl
, const struct uvc_control_mapping
*mapping
)
1519 struct uvc_control_mapping
*map
;
1522 /* Most mappings come from static kernel data and need to be duplicated.
1523 * Mappings that come from userspace will be unnecessarily duplicated,
1524 * this could be optimized.
1526 map
= kmemdup(mapping
, sizeof(*mapping
), GFP_KERNEL
);
1530 size
= sizeof(*mapping
->menu_info
) * mapping
->menu_count
;
1531 map
->menu_info
= kmemdup(mapping
->menu_info
, size
, GFP_KERNEL
);
1532 if (map
->menu_info
== NULL
) {
1537 if (map
->get
== NULL
)
1538 map
->get
= uvc_get_le_value
;
1539 if (map
->set
== NULL
)
1540 map
->set
= uvc_set_le_value
;
1542 map
->ctrl
= &ctrl
->info
;
1543 list_add_tail(&map
->list
, &ctrl
->info
.mappings
);
1544 uvc_trace(UVC_TRACE_CONTROL
,
1545 "Adding mapping '%s' to control %pUl/%u.\n",
1546 map
->name
, ctrl
->info
.entity
, ctrl
->info
.selector
);
1551 int uvc_ctrl_add_mapping(struct uvc_video_chain
*chain
,
1552 const struct uvc_control_mapping
*mapping
)
1554 struct uvc_device
*dev
= chain
->dev
;
1555 struct uvc_control_mapping
*map
;
1556 struct uvc_entity
*entity
;
1557 struct uvc_control
*ctrl
;
1561 if (mapping
->id
& ~V4L2_CTRL_ID_MASK
) {
1562 uvc_trace(UVC_TRACE_CONTROL
, "Can't add mapping '%s', control "
1563 "id 0x%08x is invalid.\n", mapping
->name
,
1568 /* Search for the matching (GUID/CS) control in the given device */
1569 list_for_each_entry(entity
, &dev
->entities
, list
) {
1572 if (UVC_ENTITY_TYPE(entity
) != UVC_VC_EXTENSION_UNIT
||
1573 !uvc_entity_match_guid(entity
, mapping
->entity
))
1576 for (i
= 0; i
< entity
->ncontrols
; ++i
) {
1577 ctrl
= &entity
->controls
[i
];
1578 if (ctrl
->index
== mapping
->selector
- 1) {
1590 if (mutex_lock_interruptible(&chain
->ctrl_mutex
))
1591 return -ERESTARTSYS
;
1593 /* Perform delayed initialization of XU controls */
1594 ret
= uvc_ctrl_init_xu_ctrl(dev
, ctrl
);
1600 list_for_each_entry(map
, &ctrl
->info
.mappings
, list
) {
1601 if (mapping
->id
== map
->id
) {
1602 uvc_trace(UVC_TRACE_CONTROL
, "Can't add mapping '%s', "
1603 "control id 0x%08x already exists.\n",
1604 mapping
->name
, mapping
->id
);
1610 /* Prevent excess memory consumption */
1611 if (atomic_inc_return(&dev
->nmappings
) > UVC_MAX_CONTROL_MAPPINGS
) {
1612 atomic_dec(&dev
->nmappings
);
1613 uvc_trace(UVC_TRACE_CONTROL
, "Can't add mapping '%s', maximum "
1614 "mappings count (%u) exceeded.\n", mapping
->name
,
1615 UVC_MAX_CONTROL_MAPPINGS
);
1620 ret
= __uvc_ctrl_add_mapping(dev
, ctrl
, mapping
);
1622 atomic_dec(&dev
->nmappings
);
1625 mutex_unlock(&chain
->ctrl_mutex
);
1630 * Prune an entity of its bogus controls using a blacklist. Bogus controls
1631 * are currently the ones that crash the camera or unconditionally return an
1632 * error when queried.
1634 static void uvc_ctrl_prune_entity(struct uvc_device
*dev
,
1635 struct uvc_entity
*entity
)
1637 struct uvc_ctrl_blacklist
{
1638 struct usb_device_id id
;
1642 static const struct uvc_ctrl_blacklist processing_blacklist
[] = {
1643 { { USB_DEVICE(0x13d3, 0x509b) }, 9 }, /* Gain */
1644 { { USB_DEVICE(0x1c4f, 0x3000) }, 6 }, /* WB Temperature */
1645 { { USB_DEVICE(0x5986, 0x0241) }, 2 }, /* Hue */
1647 static const struct uvc_ctrl_blacklist camera_blacklist
[] = {
1648 { { USB_DEVICE(0x06f8, 0x3005) }, 9 }, /* Zoom, Absolute */
1651 const struct uvc_ctrl_blacklist
*blacklist
;
1657 switch (UVC_ENTITY_TYPE(entity
)) {
1658 case UVC_VC_PROCESSING_UNIT
:
1659 blacklist
= processing_blacklist
;
1660 count
= ARRAY_SIZE(processing_blacklist
);
1661 controls
= entity
->processing
.bmControls
;
1662 size
= entity
->processing
.bControlSize
;
1665 case UVC_ITT_CAMERA
:
1666 blacklist
= camera_blacklist
;
1667 count
= ARRAY_SIZE(camera_blacklist
);
1668 controls
= entity
->camera
.bmControls
;
1669 size
= entity
->camera
.bControlSize
;
1676 for (i
= 0; i
< count
; ++i
) {
1677 if (!usb_match_one_id(dev
->intf
, &blacklist
[i
].id
))
1680 if (blacklist
[i
].index
>= 8 * size
||
1681 !uvc_test_bit(controls
, blacklist
[i
].index
))
1684 uvc_trace(UVC_TRACE_CONTROL
, "%u/%u control is black listed, "
1685 "removing it.\n", entity
->id
, blacklist
[i
].index
);
1687 uvc_clear_bit(controls
, blacklist
[i
].index
);
1692 * Add control information and hardcoded stock control mappings to the given
1695 static void uvc_ctrl_init_ctrl(struct uvc_device
*dev
, struct uvc_control
*ctrl
)
1697 const struct uvc_control_info
*info
= uvc_ctrls
;
1698 const struct uvc_control_info
*iend
= info
+ ARRAY_SIZE(uvc_ctrls
);
1699 const struct uvc_control_mapping
*mapping
= uvc_ctrl_mappings
;
1700 const struct uvc_control_mapping
*mend
=
1701 mapping
+ ARRAY_SIZE(uvc_ctrl_mappings
);
1703 /* XU controls initialization requires querying the device for control
1704 * information. As some buggy UVC devices will crash when queried
1705 * repeatedly in a tight loop, delay XU controls initialization until
1708 if (UVC_ENTITY_TYPE(ctrl
->entity
) == UVC_VC_EXTENSION_UNIT
)
1711 for (; info
< iend
; ++info
) {
1712 if (uvc_entity_match_guid(ctrl
->entity
, info
->entity
) &&
1713 ctrl
->index
== info
->index
) {
1714 uvc_ctrl_add_info(dev
, ctrl
, info
);
1719 if (!ctrl
->initialized
)
1722 for (; mapping
< mend
; ++mapping
) {
1723 if (uvc_entity_match_guid(ctrl
->entity
, mapping
->entity
) &&
1724 ctrl
->info
.selector
== mapping
->selector
)
1725 __uvc_ctrl_add_mapping(dev
, ctrl
, mapping
);
1730 * Initialize device controls.
1732 int uvc_ctrl_init_device(struct uvc_device
*dev
)
1734 struct uvc_entity
*entity
;
1737 /* Walk the entities list and instantiate controls */
1738 list_for_each_entry(entity
, &dev
->entities
, list
) {
1739 struct uvc_control
*ctrl
;
1740 unsigned int bControlSize
= 0, ncontrols
= 0;
1741 __u8
*bmControls
= NULL
;
1743 if (UVC_ENTITY_TYPE(entity
) == UVC_VC_EXTENSION_UNIT
) {
1744 bmControls
= entity
->extension
.bmControls
;
1745 bControlSize
= entity
->extension
.bControlSize
;
1746 } else if (UVC_ENTITY_TYPE(entity
) == UVC_VC_PROCESSING_UNIT
) {
1747 bmControls
= entity
->processing
.bmControls
;
1748 bControlSize
= entity
->processing
.bControlSize
;
1749 } else if (UVC_ENTITY_TYPE(entity
) == UVC_ITT_CAMERA
) {
1750 bmControls
= entity
->camera
.bmControls
;
1751 bControlSize
= entity
->camera
.bControlSize
;
1754 /* Remove bogus/blacklisted controls */
1755 uvc_ctrl_prune_entity(dev
, entity
);
1757 /* Count supported controls and allocate the controls array */
1758 for (i
= 0; i
< bControlSize
; ++i
)
1759 ncontrols
+= hweight8(bmControls
[i
]);
1763 entity
->controls
= kzalloc(ncontrols
* sizeof(*ctrl
),
1765 if (entity
->controls
== NULL
)
1767 entity
->ncontrols
= ncontrols
;
1769 /* Initialize all supported controls */
1770 ctrl
= entity
->controls
;
1771 for (i
= 0; i
< bControlSize
* 8; ++i
) {
1772 if (uvc_test_bit(bmControls
, i
) == 0)
1775 ctrl
->entity
= entity
;
1778 uvc_ctrl_init_ctrl(dev
, ctrl
);
1787 * Cleanup device controls.
1789 static void uvc_ctrl_cleanup_mappings(struct uvc_device
*dev
,
1790 struct uvc_control
*ctrl
)
1792 struct uvc_control_mapping
*mapping
, *nm
;
1794 list_for_each_entry_safe(mapping
, nm
, &ctrl
->info
.mappings
, list
) {
1795 list_del(&mapping
->list
);
1796 kfree(mapping
->menu_info
);
1801 void uvc_ctrl_cleanup_device(struct uvc_device
*dev
)
1803 struct uvc_entity
*entity
;
1806 /* Free controls and control mappings for all entities. */
1807 list_for_each_entry(entity
, &dev
->entities
, list
) {
1808 for (i
= 0; i
< entity
->ncontrols
; ++i
) {
1809 struct uvc_control
*ctrl
= &entity
->controls
[i
];
1811 if (!ctrl
->initialized
)
1814 uvc_ctrl_cleanup_mappings(dev
, ctrl
);
1815 kfree(ctrl
->uvc_data
);
1818 kfree(entity
->controls
);