1/* 2 * uvc_ctrl.c -- USB Video Class driver - Controls 3 * 4 * Copyright (C) 2005-2010 5 * Laurent Pinchart (laurent.pinchart@ideasonboard.com) 6 * 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. 11 * 12 */ 13 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 25#include "uvcvideo.h" 26 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 34 35/* ------------------------------------------------------------------------ 36 * Controls 37 */ 38 39static struct uvc_control_info uvc_ctrls[] = { 40 { 41 .entity = UVC_GUID_UVC_PROCESSING, 42 .selector = UVC_PU_BRIGHTNESS_CONTROL, 43 .index = 0, 44 .size = 2, 45 .flags = UVC_CTRL_FLAG_SET_CUR 46 | UVC_CTRL_FLAG_GET_RANGE 47 | UVC_CTRL_FLAG_RESTORE, 48 }, 49 { 50 .entity = UVC_GUID_UVC_PROCESSING, 51 .selector = UVC_PU_CONTRAST_CONTROL, 52 .index = 1, 53 .size = 2, 54 .flags = UVC_CTRL_FLAG_SET_CUR 55 | UVC_CTRL_FLAG_GET_RANGE 56 | UVC_CTRL_FLAG_RESTORE, 57 }, 58 { 59 .entity = UVC_GUID_UVC_PROCESSING, 60 .selector = UVC_PU_HUE_CONTROL, 61 .index = 2, 62 .size = 2, 63 .flags = UVC_CTRL_FLAG_SET_CUR 64 | UVC_CTRL_FLAG_GET_RANGE 65 | UVC_CTRL_FLAG_RESTORE 66 | UVC_CTRL_FLAG_AUTO_UPDATE, 67 }, 68 { 69 .entity = UVC_GUID_UVC_PROCESSING, 70 .selector = UVC_PU_SATURATION_CONTROL, 71 .index = 3, 72 .size = 2, 73 .flags = UVC_CTRL_FLAG_SET_CUR 74 | UVC_CTRL_FLAG_GET_RANGE 75 | UVC_CTRL_FLAG_RESTORE, 76 }, 77 { 78 .entity = UVC_GUID_UVC_PROCESSING, 79 .selector = UVC_PU_SHARPNESS_CONTROL, 80 .index = 4, 81 .size = 2, 82 .flags = UVC_CTRL_FLAG_SET_CUR 83 | UVC_CTRL_FLAG_GET_RANGE 84 | UVC_CTRL_FLAG_RESTORE, 85 }, 86 { 87 .entity = UVC_GUID_UVC_PROCESSING, 88 .selector = UVC_PU_GAMMA_CONTROL, 89 .index = 5, 90 .size = 2, 91 .flags = UVC_CTRL_FLAG_SET_CUR 92 | UVC_CTRL_FLAG_GET_RANGE 93 | UVC_CTRL_FLAG_RESTORE, 94 }, 95 { 96 .entity = UVC_GUID_UVC_PROCESSING, 97 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL, 98 .index = 6, 99 .size = 2, 100 .flags = UVC_CTRL_FLAG_SET_CUR 101 | UVC_CTRL_FLAG_GET_RANGE 102 | UVC_CTRL_FLAG_RESTORE 103 | UVC_CTRL_FLAG_AUTO_UPDATE, 104 }, 105 { 106 .entity = UVC_GUID_UVC_PROCESSING, 107 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL, 108 .index = 7, 109 .size = 4, 110 .flags = UVC_CTRL_FLAG_SET_CUR 111 | UVC_CTRL_FLAG_GET_RANGE 112 | UVC_CTRL_FLAG_RESTORE 113 | UVC_CTRL_FLAG_AUTO_UPDATE, 114 }, 115 { 116 .entity = UVC_GUID_UVC_PROCESSING, 117 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL, 118 .index = 8, 119 .size = 2, 120 .flags = UVC_CTRL_FLAG_SET_CUR 121 | UVC_CTRL_FLAG_GET_RANGE 122 | UVC_CTRL_FLAG_RESTORE, 123 }, 124 { 125 .entity = UVC_GUID_UVC_PROCESSING, 126 .selector = UVC_PU_GAIN_CONTROL, 127 .index = 9, 128 .size = 2, 129 .flags = UVC_CTRL_FLAG_SET_CUR 130 | UVC_CTRL_FLAG_GET_RANGE 131 | UVC_CTRL_FLAG_RESTORE, 132 }, 133 { 134 .entity = UVC_GUID_UVC_PROCESSING, 135 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL, 136 .index = 10, 137 .size = 1, 138 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 139 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE, 140 }, 141 { 142 .entity = UVC_GUID_UVC_PROCESSING, 143 .selector = UVC_PU_HUE_AUTO_CONTROL, 144 .index = 11, 145 .size = 1, 146 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 147 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE, 148 }, 149 { 150 .entity = UVC_GUID_UVC_PROCESSING, 151 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL, 152 .index = 12, 153 .size = 1, 154 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 155 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE, 156 }, 157 { 158 .entity = UVC_GUID_UVC_PROCESSING, 159 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL, 160 .index = 13, 161 .size = 1, 162 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 163 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE, 164 }, 165 { 166 .entity = UVC_GUID_UVC_PROCESSING, 167 .selector = UVC_PU_DIGITAL_MULTIPLIER_CONTROL, 168 .index = 14, 169 .size = 2, 170 .flags = UVC_CTRL_FLAG_SET_CUR 171 | UVC_CTRL_FLAG_GET_RANGE 172 | UVC_CTRL_FLAG_RESTORE, 173 }, 174 { 175 .entity = UVC_GUID_UVC_PROCESSING, 176 .selector = UVC_PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL, 177 .index = 15, 178 .size = 2, 179 .flags = UVC_CTRL_FLAG_SET_CUR 180 | UVC_CTRL_FLAG_GET_RANGE 181 | UVC_CTRL_FLAG_RESTORE, 182 }, 183 { 184 .entity = UVC_GUID_UVC_PROCESSING, 185 .selector = UVC_PU_ANALOG_VIDEO_STANDARD_CONTROL, 186 .index = 16, 187 .size = 1, 188 .flags = UVC_CTRL_FLAG_GET_CUR, 189 }, 190 { 191 .entity = UVC_GUID_UVC_PROCESSING, 192 .selector = UVC_PU_ANALOG_LOCK_STATUS_CONTROL, 193 .index = 17, 194 .size = 1, 195 .flags = UVC_CTRL_FLAG_GET_CUR, 196 }, 197 { 198 .entity = UVC_GUID_UVC_CAMERA, 199 .selector = UVC_CT_SCANNING_MODE_CONTROL, 200 .index = 0, 201 .size = 1, 202 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 203 | UVC_CTRL_FLAG_RESTORE, 204 }, 205 { 206 .entity = UVC_GUID_UVC_CAMERA, 207 .selector = UVC_CT_AE_MODE_CONTROL, 208 .index = 1, 209 .size = 1, 210 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 211 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_GET_RES 212 | UVC_CTRL_FLAG_RESTORE, 213 }, 214 { 215 .entity = UVC_GUID_UVC_CAMERA, 216 .selector = UVC_CT_AE_PRIORITY_CONTROL, 217 .index = 2, 218 .size = 1, 219 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 220 | UVC_CTRL_FLAG_RESTORE, 221 }, 222 { 223 .entity = UVC_GUID_UVC_CAMERA, 224 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL, 225 .index = 3, 226 .size = 4, 227 .flags = UVC_CTRL_FLAG_SET_CUR 228 | UVC_CTRL_FLAG_GET_RANGE 229 | UVC_CTRL_FLAG_RESTORE, 230 }, 231 { 232 .entity = UVC_GUID_UVC_CAMERA, 233 .selector = UVC_CT_EXPOSURE_TIME_RELATIVE_CONTROL, 234 .index = 4, 235 .size = 1, 236 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_RESTORE, 237 }, 238 { 239 .entity = UVC_GUID_UVC_CAMERA, 240 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL, 241 .index = 5, 242 .size = 2, 243 .flags = UVC_CTRL_FLAG_SET_CUR 244 | UVC_CTRL_FLAG_GET_RANGE 245 | UVC_CTRL_FLAG_RESTORE 246 | UVC_CTRL_FLAG_AUTO_UPDATE, 247 }, 248 { 249 .entity = UVC_GUID_UVC_CAMERA, 250 .selector = UVC_CT_FOCUS_RELATIVE_CONTROL, 251 .index = 6, 252 .size = 2, 253 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN 254 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES 255 | UVC_CTRL_FLAG_GET_DEF 256 | UVC_CTRL_FLAG_AUTO_UPDATE, 257 }, 258 { 259 .entity = UVC_GUID_UVC_CAMERA, 260 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL, 261 .index = 7, 262 .size = 2, 263 .flags = UVC_CTRL_FLAG_SET_CUR 264 | UVC_CTRL_FLAG_GET_RANGE 265 | UVC_CTRL_FLAG_RESTORE 266 | UVC_CTRL_FLAG_AUTO_UPDATE, 267 }, 268 { 269 .entity = UVC_GUID_UVC_CAMERA, 270 .selector = UVC_CT_IRIS_RELATIVE_CONTROL, 271 .index = 8, 272 .size = 1, 273 .flags = UVC_CTRL_FLAG_SET_CUR 274 | UVC_CTRL_FLAG_AUTO_UPDATE, 275 }, 276 { 277 .entity = UVC_GUID_UVC_CAMERA, 278 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL, 279 .index = 9, 280 .size = 2, 281 .flags = UVC_CTRL_FLAG_SET_CUR 282 | UVC_CTRL_FLAG_GET_RANGE 283 | UVC_CTRL_FLAG_RESTORE 284 | UVC_CTRL_FLAG_AUTO_UPDATE, 285 }, 286 { 287 .entity = UVC_GUID_UVC_CAMERA, 288 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL, 289 .index = 10, 290 .size = 3, 291 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN 292 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES 293 | UVC_CTRL_FLAG_GET_DEF 294 | UVC_CTRL_FLAG_AUTO_UPDATE, 295 }, 296 { 297 .entity = UVC_GUID_UVC_CAMERA, 298 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL, 299 .index = 11, 300 .size = 8, 301 .flags = UVC_CTRL_FLAG_SET_CUR 302 | UVC_CTRL_FLAG_GET_RANGE 303 | UVC_CTRL_FLAG_RESTORE 304 | UVC_CTRL_FLAG_AUTO_UPDATE, 305 }, 306 { 307 .entity = UVC_GUID_UVC_CAMERA, 308 .selector = UVC_CT_PANTILT_RELATIVE_CONTROL, 309 .index = 12, 310 .size = 4, 311 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN 312 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES 313 | UVC_CTRL_FLAG_GET_DEF 314 | UVC_CTRL_FLAG_AUTO_UPDATE, 315 }, 316 { 317 .entity = UVC_GUID_UVC_CAMERA, 318 .selector = UVC_CT_ROLL_ABSOLUTE_CONTROL, 319 .index = 13, 320 .size = 2, 321 .flags = UVC_CTRL_FLAG_SET_CUR 322 | UVC_CTRL_FLAG_GET_RANGE 323 | UVC_CTRL_FLAG_RESTORE 324 | UVC_CTRL_FLAG_AUTO_UPDATE, 325 }, 326 { 327 .entity = UVC_GUID_UVC_CAMERA, 328 .selector = UVC_CT_ROLL_RELATIVE_CONTROL, 329 .index = 14, 330 .size = 2, 331 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_MIN 332 | UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES 333 | UVC_CTRL_FLAG_GET_DEF 334 | UVC_CTRL_FLAG_AUTO_UPDATE, 335 }, 336 { 337 .entity = UVC_GUID_UVC_CAMERA, 338 .selector = UVC_CT_FOCUS_AUTO_CONTROL, 339 .index = 17, 340 .size = 1, 341 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 342 | UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_RESTORE, 343 }, 344 { 345 .entity = UVC_GUID_UVC_CAMERA, 346 .selector = UVC_CT_PRIVACY_CONTROL, 347 .index = 18, 348 .size = 1, 349 .flags = UVC_CTRL_FLAG_SET_CUR | UVC_CTRL_FLAG_GET_CUR 350 | UVC_CTRL_FLAG_RESTORE 351 | UVC_CTRL_FLAG_AUTO_UPDATE, 352 }, 353}; 354 355static struct uvc_menu_info power_line_frequency_controls[] = { 356 { 0, "Disabled" }, 357 { 1, "50 Hz" }, 358 { 2, "60 Hz" }, 359}; 360 361static struct uvc_menu_info exposure_auto_controls[] = { 362 { 2, "Auto Mode" }, 363 { 1, "Manual Mode" }, 364 { 4, "Shutter Priority Mode" }, 365 { 8, "Aperture Priority Mode" }, 366}; 367 368static __s32 uvc_ctrl_get_zoom(struct uvc_control_mapping *mapping, 369 __u8 query, const __u8 *data) 370{ 371 __s8 zoom = (__s8)data[0]; 372 373 switch (query) { 374 case UVC_GET_CUR: 375 return (zoom == 0) ? 0 : (zoom > 0 ? data[2] : -data[2]); 376 377 case UVC_GET_MIN: 378 case UVC_GET_MAX: 379 case UVC_GET_RES: 380 case UVC_GET_DEF: 381 default: 382 return data[2]; 383 } 384} 385 386static void uvc_ctrl_set_zoom(struct uvc_control_mapping *mapping, 387 __s32 value, __u8 *data) 388{ 389 data[0] = value == 0 ? 0 : (value > 0) ? 1 : 0xff; 390 data[2] = min((int)abs(value), 0xff); 391} 392 393static struct uvc_control_mapping uvc_ctrl_mappings[] = { 394 { 395 .id = V4L2_CID_BRIGHTNESS, 396 .name = "Brightness", 397 .entity = UVC_GUID_UVC_PROCESSING, 398 .selector = UVC_PU_BRIGHTNESS_CONTROL, 399 .size = 16, 400 .offset = 0, 401 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 402 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 403 }, 404 { 405 .id = V4L2_CID_CONTRAST, 406 .name = "Contrast", 407 .entity = UVC_GUID_UVC_PROCESSING, 408 .selector = UVC_PU_CONTRAST_CONTROL, 409 .size = 16, 410 .offset = 0, 411 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 412 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 413 }, 414 { 415 .id = V4L2_CID_HUE, 416 .name = "Hue", 417 .entity = UVC_GUID_UVC_PROCESSING, 418 .selector = UVC_PU_HUE_CONTROL, 419 .size = 16, 420 .offset = 0, 421 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 422 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 423 }, 424 { 425 .id = V4L2_CID_SATURATION, 426 .name = "Saturation", 427 .entity = UVC_GUID_UVC_PROCESSING, 428 .selector = UVC_PU_SATURATION_CONTROL, 429 .size = 16, 430 .offset = 0, 431 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 432 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 433 }, 434 { 435 .id = V4L2_CID_SHARPNESS, 436 .name = "Sharpness", 437 .entity = UVC_GUID_UVC_PROCESSING, 438 .selector = UVC_PU_SHARPNESS_CONTROL, 439 .size = 16, 440 .offset = 0, 441 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 442 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 443 }, 444 { 445 .id = V4L2_CID_GAMMA, 446 .name = "Gamma", 447 .entity = UVC_GUID_UVC_PROCESSING, 448 .selector = UVC_PU_GAMMA_CONTROL, 449 .size = 16, 450 .offset = 0, 451 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 452 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 453 }, 454 { 455 .id = V4L2_CID_BACKLIGHT_COMPENSATION, 456 .name = "Backlight Compensation", 457 .entity = UVC_GUID_UVC_PROCESSING, 458 .selector = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL, 459 .size = 16, 460 .offset = 0, 461 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 462 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 463 }, 464 { 465 .id = V4L2_CID_GAIN, 466 .name = "Gain", 467 .entity = UVC_GUID_UVC_PROCESSING, 468 .selector = UVC_PU_GAIN_CONTROL, 469 .size = 16, 470 .offset = 0, 471 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 472 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 473 }, 474 { 475 .id = V4L2_CID_POWER_LINE_FREQUENCY, 476 .name = "Power Line Frequency", 477 .entity = UVC_GUID_UVC_PROCESSING, 478 .selector = UVC_PU_POWER_LINE_FREQUENCY_CONTROL, 479 .size = 2, 480 .offset = 0, 481 .v4l2_type = V4L2_CTRL_TYPE_MENU, 482 .data_type = UVC_CTRL_DATA_TYPE_ENUM, 483 .menu_info = power_line_frequency_controls, 484 .menu_count = ARRAY_SIZE(power_line_frequency_controls), 485 }, 486 { 487 .id = V4L2_CID_HUE_AUTO, 488 .name = "Hue, Auto", 489 .entity = UVC_GUID_UVC_PROCESSING, 490 .selector = UVC_PU_HUE_AUTO_CONTROL, 491 .size = 1, 492 .offset = 0, 493 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 494 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 495 }, 496 { 497 .id = V4L2_CID_EXPOSURE_AUTO, 498 .name = "Exposure, Auto", 499 .entity = UVC_GUID_UVC_CAMERA, 500 .selector = UVC_CT_AE_MODE_CONTROL, 501 .size = 4, 502 .offset = 0, 503 .v4l2_type = V4L2_CTRL_TYPE_MENU, 504 .data_type = UVC_CTRL_DATA_TYPE_BITMASK, 505 .menu_info = exposure_auto_controls, 506 .menu_count = ARRAY_SIZE(exposure_auto_controls), 507 }, 508 { 509 .id = V4L2_CID_EXPOSURE_AUTO_PRIORITY, 510 .name = "Exposure, Auto Priority", 511 .entity = UVC_GUID_UVC_CAMERA, 512 .selector = UVC_CT_AE_PRIORITY_CONTROL, 513 .size = 1, 514 .offset = 0, 515 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 516 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 517 }, 518 { 519 .id = V4L2_CID_EXPOSURE_ABSOLUTE, 520 .name = "Exposure (Absolute)", 521 .entity = UVC_GUID_UVC_CAMERA, 522 .selector = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL, 523 .size = 32, 524 .offset = 0, 525 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 526 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 527 }, 528 { 529 .id = V4L2_CID_AUTO_WHITE_BALANCE, 530 .name = "White Balance Temperature, Auto", 531 .entity = UVC_GUID_UVC_PROCESSING, 532 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL, 533 .size = 1, 534 .offset = 0, 535 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 536 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 537 }, 538 { 539 .id = V4L2_CID_WHITE_BALANCE_TEMPERATURE, 540 .name = "White Balance Temperature", 541 .entity = UVC_GUID_UVC_PROCESSING, 542 .selector = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL, 543 .size = 16, 544 .offset = 0, 545 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 546 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 547 }, 548 { 549 .id = V4L2_CID_AUTO_WHITE_BALANCE, 550 .name = "White Balance Component, Auto", 551 .entity = UVC_GUID_UVC_PROCESSING, 552 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL, 553 .size = 1, 554 .offset = 0, 555 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 556 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 557 }, 558 { 559 .id = V4L2_CID_BLUE_BALANCE, 560 .name = "White Balance Blue Component", 561 .entity = UVC_GUID_UVC_PROCESSING, 562 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL, 563 .size = 16, 564 .offset = 0, 565 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 566 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 567 }, 568 { 569 .id = V4L2_CID_RED_BALANCE, 570 .name = "White Balance Red Component", 571 .entity = UVC_GUID_UVC_PROCESSING, 572 .selector = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL, 573 .size = 16, 574 .offset = 16, 575 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 576 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 577 }, 578 { 579 .id = V4L2_CID_FOCUS_ABSOLUTE, 580 .name = "Focus (absolute)", 581 .entity = UVC_GUID_UVC_CAMERA, 582 .selector = UVC_CT_FOCUS_ABSOLUTE_CONTROL, 583 .size = 16, 584 .offset = 0, 585 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 586 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 587 }, 588 { 589 .id = V4L2_CID_FOCUS_AUTO, 590 .name = "Focus, Auto", 591 .entity = UVC_GUID_UVC_CAMERA, 592 .selector = UVC_CT_FOCUS_AUTO_CONTROL, 593 .size = 1, 594 .offset = 0, 595 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 596 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 597 }, 598 { 599 .id = V4L2_CID_IRIS_ABSOLUTE, 600 .name = "Iris, Absolute", 601 .entity = UVC_GUID_UVC_CAMERA, 602 .selector = UVC_CT_IRIS_ABSOLUTE_CONTROL, 603 .size = 16, 604 .offset = 0, 605 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 606 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 607 }, 608 { 609 .id = V4L2_CID_IRIS_RELATIVE, 610 .name = "Iris, Relative", 611 .entity = UVC_GUID_UVC_CAMERA, 612 .selector = UVC_CT_IRIS_RELATIVE_CONTROL, 613 .size = 8, 614 .offset = 0, 615 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 616 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 617 }, 618 { 619 .id = V4L2_CID_ZOOM_ABSOLUTE, 620 .name = "Zoom, Absolute", 621 .entity = UVC_GUID_UVC_CAMERA, 622 .selector = UVC_CT_ZOOM_ABSOLUTE_CONTROL, 623 .size = 16, 624 .offset = 0, 625 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 626 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 627 }, 628 { 629 .id = V4L2_CID_ZOOM_CONTINUOUS, 630 .name = "Zoom, Continuous", 631 .entity = UVC_GUID_UVC_CAMERA, 632 .selector = UVC_CT_ZOOM_RELATIVE_CONTROL, 633 .size = 0, 634 .offset = 0, 635 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 636 .data_type = UVC_CTRL_DATA_TYPE_SIGNED, 637 .get = uvc_ctrl_get_zoom, 638 .set = uvc_ctrl_set_zoom, 639 }, 640 { 641 .id = V4L2_CID_PAN_ABSOLUTE, 642 .name = "Pan (Absolute)", 643 .entity = UVC_GUID_UVC_CAMERA, 644 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL, 645 .size = 32, 646 .offset = 0, 647 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 648 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 649 }, 650 { 651 .id = V4L2_CID_TILT_ABSOLUTE, 652 .name = "Tilt (Absolute)", 653 .entity = UVC_GUID_UVC_CAMERA, 654 .selector = UVC_CT_PANTILT_ABSOLUTE_CONTROL, 655 .size = 32, 656 .offset = 32, 657 .v4l2_type = V4L2_CTRL_TYPE_INTEGER, 658 .data_type = UVC_CTRL_DATA_TYPE_UNSIGNED, 659 }, 660 { 661 .id = V4L2_CID_PRIVACY, 662 .name = "Privacy", 663 .entity = UVC_GUID_UVC_CAMERA, 664 .selector = UVC_CT_PRIVACY_CONTROL, 665 .size = 1, 666 .offset = 0, 667 .v4l2_type = V4L2_CTRL_TYPE_BOOLEAN, 668 .data_type = UVC_CTRL_DATA_TYPE_BOOLEAN, 669 }, 670}; 671 672/* ------------------------------------------------------------------------ 673 * Utility functions 674 */ 675 676static inline __u8 *uvc_ctrl_data(struct uvc_control *ctrl, int id) 677{ 678 return ctrl->uvc_data + id * ctrl->info.size; 679} 680 681static inline int uvc_test_bit(const __u8 *data, int bit) 682{ 683 return (data[bit >> 3] >> (bit & 7)) & 1; 684} 685 686static inline void uvc_clear_bit(__u8 *data, int bit) 687{ 688 data[bit >> 3] &= ~(1 << (bit & 7)); 689} 690 691/* Extract the bit string specified by mapping->offset and mapping->size 692 * from the little-endian data stored at 'data' and return the result as 693 * a signed 32bit integer. Sign extension will be performed if the mapping 694 * references a signed data type. 695 */ 696static __s32 uvc_get_le_value(struct uvc_control_mapping *mapping, 697 __u8 query, const __u8 *data) 698{ 699 int bits = mapping->size; 700 int offset = mapping->offset; 701 __s32 value = 0; 702 __u8 mask; 703 704 data += offset / 8; 705 offset &= 7; 706 mask = ((1LL << bits) - 1) << offset; 707 708 for (; bits > 0; data++) { 709 __u8 byte = *data & mask; 710 value |= offset > 0 ? (byte >> offset) : (byte << (-offset)); 711 bits -= 8 - (offset > 0 ? offset : 0); 712 offset -= 8; 713 mask = (1 << bits) - 1; 714 } 715 716 /* Sign-extend the value if needed. */ 717 if (mapping->data_type == UVC_CTRL_DATA_TYPE_SIGNED) 718 value |= -(value & (1 << (mapping->size - 1))); 719 720 return value; 721} 722 723/* Set the bit string specified by mapping->offset and mapping->size 724 * in the little-endian data stored at 'data' to the value 'value'. 725 */ 726static void uvc_set_le_value(struct uvc_control_mapping *mapping, 727 __s32 value, __u8 *data) 728{ 729 int bits = mapping->size; 730 int offset = mapping->offset; 731 __u8 mask; 732 733 /* According to the v4l2 spec, writing any value to a button control 734 * should result in the action belonging to the button control being 735 * triggered. UVC devices however want to see a 1 written -> override 736 * value. 737 */ 738 if (mapping->v4l2_type == V4L2_CTRL_TYPE_BUTTON) 739 value = -1; 740 741 data += offset / 8; 742 offset &= 7; 743 744 for (; bits > 0; data++) { 745 mask = ((1LL << bits) - 1) << offset; 746 *data = (*data & ~mask) | ((value << offset) & mask); 747 value >>= offset ? offset : 8; 748 bits -= 8 - offset; 749 offset = 0; 750 } 751} 752 753/* ------------------------------------------------------------------------ 754 * Terminal and unit management 755 */ 756 757static const __u8 uvc_processing_guid[16] = UVC_GUID_UVC_PROCESSING; 758static const __u8 uvc_camera_guid[16] = UVC_GUID_UVC_CAMERA; 759static const __u8 uvc_media_transport_input_guid[16] = 760 UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT; 761 762static int uvc_entity_match_guid(const struct uvc_entity *entity, 763 const __u8 guid[16]) 764{ 765 switch (UVC_ENTITY_TYPE(entity)) { 766 case UVC_ITT_CAMERA: 767 return memcmp(uvc_camera_guid, guid, 16) == 0; 768 769 case UVC_ITT_MEDIA_TRANSPORT_INPUT: 770 return memcmp(uvc_media_transport_input_guid, guid, 16) == 0; 771 772 case UVC_VC_PROCESSING_UNIT: 773 return memcmp(uvc_processing_guid, guid, 16) == 0; 774 775 case UVC_VC_EXTENSION_UNIT: 776 return memcmp(entity->extension.guidExtensionCode, 777 guid, 16) == 0; 778 779 default: 780 return 0; 781 } 782} 783 784/* ------------------------------------------------------------------------ 785 * UVC Controls 786 */ 787 788static void __uvc_find_control(struct uvc_entity *entity, __u32 v4l2_id, 789 struct uvc_control_mapping **mapping, struct uvc_control **control, 790 int next) 791{ 792 struct uvc_control *ctrl; 793 struct uvc_control_mapping *map; 794 unsigned int i; 795 796 if (entity == NULL) 797 return; 798 799 for (i = 0; i < entity->ncontrols; ++i) { 800 ctrl = &entity->controls[i]; 801 if (!ctrl->initialized) 802 continue; 803 804 list_for_each_entry(map, &ctrl->info.mappings, list) { 805 if ((map->id == v4l2_id) && !next) { 806 *control = ctrl; 807 *mapping = map; 808 return; 809 } 810 811 if ((*mapping == NULL || (*mapping)->id > map->id) && 812 (map->id > v4l2_id) && next) { 813 *control = ctrl; 814 *mapping = map; 815 } 816 } 817 } 818} 819 820static struct uvc_control *uvc_find_control(struct uvc_video_chain *chain, 821 __u32 v4l2_id, struct uvc_control_mapping **mapping) 822{ 823 struct uvc_control *ctrl = NULL; 824 struct uvc_entity *entity; 825 int next = v4l2_id & V4L2_CTRL_FLAG_NEXT_CTRL; 826 827 *mapping = NULL; 828 829 /* Mask the query flags. */ 830 v4l2_id &= V4L2_CTRL_ID_MASK; 831 832 /* Find the control. */ 833 list_for_each_entry(entity, &chain->entities, chain) { 834 __uvc_find_control(entity, v4l2_id, mapping, &ctrl, next); 835 if (ctrl && !next) 836 return ctrl; 837 } 838 839 if (ctrl == NULL && !next) 840 uvc_trace(UVC_TRACE_CONTROL, "Control 0x%08x not found.\n", 841 v4l2_id); 842 843 return ctrl; 844} 845 846static int uvc_ctrl_populate_cache(struct uvc_video_chain *chain, 847 struct uvc_control *ctrl) 848{ 849 int ret; 850 851 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_DEF) { 852 ret = uvc_query_ctrl(chain->dev, UVC_GET_DEF, ctrl->entity->id, 853 chain->dev->intfnum, ctrl->info.selector, 854 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF), 855 ctrl->info.size); 856 if (ret < 0) 857 return ret; 858 } 859 860 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MIN) { 861 ret = uvc_query_ctrl(chain->dev, UVC_GET_MIN, ctrl->entity->id, 862 chain->dev->intfnum, ctrl->info.selector, 863 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN), 864 ctrl->info.size); 865 if (ret < 0) 866 return ret; 867 } 868 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MAX) { 869 ret = uvc_query_ctrl(chain->dev, UVC_GET_MAX, ctrl->entity->id, 870 chain->dev->intfnum, ctrl->info.selector, 871 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX), 872 ctrl->info.size); 873 if (ret < 0) 874 return ret; 875 } 876 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES) { 877 ret = uvc_query_ctrl(chain->dev, UVC_GET_RES, ctrl->entity->id, 878 chain->dev->intfnum, ctrl->info.selector, 879 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES), 880 ctrl->info.size); 881 if (ret < 0) { 882 if (UVC_ENTITY_TYPE(ctrl->entity) != 883 UVC_VC_EXTENSION_UNIT) 884 return ret; 885 886 /* GET_RES is mandatory for XU controls, but some 887 * cameras still choke on it. Ignore errors and set the 888 * resolution value to zero. 889 */ 890 uvc_warn_once(chain->dev, UVC_WARN_XU_GET_RES, 891 "UVC non compliance - GET_RES failed on " 892 "an XU control. Enabling workaround.\n"); 893 memset(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES), 0, 894 ctrl->info.size); 895 } 896 } 897 898 ctrl->cached = 1; 899 return 0; 900} 901 902int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain, 903 struct v4l2_queryctrl *v4l2_ctrl) 904{ 905 struct uvc_control *ctrl; 906 struct uvc_control_mapping *mapping; 907 struct uvc_menu_info *menu; 908 unsigned int i; 909 int ret; 910 911 ret = mutex_lock_interruptible(&chain->ctrl_mutex); 912 if (ret < 0) 913 return -ERESTARTSYS; 914 915 ctrl = uvc_find_control(chain, v4l2_ctrl->id, &mapping); 916 if (ctrl == NULL) { 917 ret = -EINVAL; 918 goto done; 919 } 920 921 memset(v4l2_ctrl, 0, sizeof *v4l2_ctrl); 922 v4l2_ctrl->id = mapping->id; 923 v4l2_ctrl->type = mapping->v4l2_type; 924 strlcpy(v4l2_ctrl->name, mapping->name, sizeof v4l2_ctrl->name); 925 v4l2_ctrl->flags = 0; 926 927 if (!(ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR)) 928 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_WRITE_ONLY; 929 if (!(ctrl->info.flags & UVC_CTRL_FLAG_SET_CUR)) 930 v4l2_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY; 931 932 if (!ctrl->cached) { 933 ret = uvc_ctrl_populate_cache(chain, ctrl); 934 if (ret < 0) 935 goto done; 936 } 937 938 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_DEF) { 939 v4l2_ctrl->default_value = mapping->get(mapping, UVC_GET_DEF, 940 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_DEF)); 941 } 942 943 switch (mapping->v4l2_type) { 944 case V4L2_CTRL_TYPE_MENU: 945 v4l2_ctrl->minimum = 0; 946 v4l2_ctrl->maximum = mapping->menu_count - 1; 947 v4l2_ctrl->step = 1; 948 949 menu = mapping->menu_info; 950 for (i = 0; i < mapping->menu_count; ++i, ++menu) { 951 if (menu->value == v4l2_ctrl->default_value) { 952 v4l2_ctrl->default_value = i; 953 break; 954 } 955 } 956 957 goto done; 958 959 case V4L2_CTRL_TYPE_BOOLEAN: 960 v4l2_ctrl->minimum = 0; 961 v4l2_ctrl->maximum = 1; 962 v4l2_ctrl->step = 1; 963 goto done; 964 965 case V4L2_CTRL_TYPE_BUTTON: 966 v4l2_ctrl->minimum = 0; 967 v4l2_ctrl->maximum = 0; 968 v4l2_ctrl->step = 0; 969 goto done; 970 971 default: 972 break; 973 } 974 975 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MIN) 976 v4l2_ctrl->minimum = mapping->get(mapping, UVC_GET_MIN, 977 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN)); 978 979 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_MAX) 980 v4l2_ctrl->maximum = mapping->get(mapping, UVC_GET_MAX, 981 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX)); 982 983 if (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES) 984 v4l2_ctrl->step = mapping->get(mapping, UVC_GET_RES, 985 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES)); 986 987done: 988 mutex_unlock(&chain->ctrl_mutex); 989 return ret; 990} 991 992/* 993 * Mapping V4L2 controls to UVC controls can be straighforward if done well. 994 * Most of the UVC controls exist in V4L2, and can be mapped directly. Some 995 * must be grouped (for instance the Red Balance, Blue Balance and Do White 996 * Balance V4L2 controls use the White Balance Component UVC control) or 997 * otherwise translated. The approach we take here is to use a translation 998 * table for the controls that can be mapped directly, and handle the others 999 * manually. 1000 */ 1001int uvc_query_v4l2_menu(struct uvc_video_chain *chain, 1002 struct v4l2_querymenu *query_menu) 1003{ 1004 struct uvc_menu_info *menu_info; 1005 struct uvc_control_mapping *mapping; 1006 struct uvc_control *ctrl; 1007 u32 index = query_menu->index; 1008 u32 id = query_menu->id; 1009 int ret; 1010 1011 memset(query_menu, 0, sizeof(*query_menu)); 1012 query_menu->id = id; 1013 query_menu->index = index; 1014 1015 ret = mutex_lock_interruptible(&chain->ctrl_mutex); 1016 if (ret < 0) 1017 return -ERESTARTSYS; 1018 1019 ctrl = uvc_find_control(chain, query_menu->id, &mapping); 1020 if (ctrl == NULL || mapping->v4l2_type != V4L2_CTRL_TYPE_MENU) { 1021 ret = -EINVAL; 1022 goto done; 1023 } 1024 1025 if (query_menu->index >= mapping->menu_count) { 1026 ret = -EINVAL; 1027 goto done; 1028 } 1029 1030 menu_info = &mapping->menu_info[query_menu->index]; 1031 1032 if (mapping->data_type == UVC_CTRL_DATA_TYPE_BITMASK && 1033 (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES)) { 1034 s32 bitmap; 1035 1036 if (!ctrl->cached) { 1037 ret = uvc_ctrl_populate_cache(chain, ctrl); 1038 if (ret < 0) 1039 goto done; 1040 } 1041 1042 bitmap = mapping->get(mapping, UVC_GET_RES, 1043 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES)); 1044 if (!(bitmap & menu_info->value)) { 1045 ret = -EINVAL; 1046 goto done; 1047 } 1048 } 1049 1050 strlcpy(query_menu->name, menu_info->name, sizeof query_menu->name); 1051 1052done: 1053 mutex_unlock(&chain->ctrl_mutex); 1054 return ret; 1055} 1056 1057 1058/* -------------------------------------------------------------------------- 1059 * Control transactions 1060 * 1061 * To make extended set operations as atomic as the hardware allows, controls 1062 * are handled using begin/commit/rollback operations. 1063 * 1064 * At the beginning of a set request, uvc_ctrl_begin should be called to 1065 * initialize the request. This function acquires the control lock. 1066 * 1067 * When setting a control, the new value is stored in the control data field 1068 * at position UVC_CTRL_DATA_CURRENT. The control is then marked as dirty for 1069 * later processing. If the UVC and V4L2 control sizes differ, the current 1070 * value is loaded from the hardware before storing the new value in the data 1071 * field. 1072 * 1073 * After processing all controls in the transaction, uvc_ctrl_commit or 1074 * uvc_ctrl_rollback must be called to apply the pending changes to the 1075 * hardware or revert them. When applying changes, all controls marked as 1076 * dirty will be modified in the UVC device, and the dirty flag will be 1077 * cleared. When reverting controls, the control data field 1078 * UVC_CTRL_DATA_CURRENT is reverted to its previous value 1079 * (UVC_CTRL_DATA_BACKUP) for all dirty controls. Both functions release the 1080 * control lock. 1081 */ 1082int uvc_ctrl_begin(struct uvc_video_chain *chain) 1083{ 1084 return mutex_lock_interruptible(&chain->ctrl_mutex) ? -ERESTARTSYS : 0; 1085} 1086 1087static int uvc_ctrl_commit_entity(struct uvc_device *dev, 1088 struct uvc_entity *entity, int rollback) 1089{ 1090 struct uvc_control *ctrl; 1091 unsigned int i; 1092 int ret; 1093 1094 if (entity == NULL) 1095 return 0; 1096 1097 for (i = 0; i < entity->ncontrols; ++i) { 1098 ctrl = &entity->controls[i]; 1099 if (!ctrl->initialized) 1100 continue; 1101 1102 /* Reset the loaded flag for auto-update controls that were 1103 * marked as loaded in uvc_ctrl_get/uvc_ctrl_set to prevent 1104 * uvc_ctrl_get from using the cached value. 1105 */ 1106 if (ctrl->info.flags & UVC_CTRL_FLAG_AUTO_UPDATE) 1107 ctrl->loaded = 0; 1108 1109 if (!ctrl->dirty) 1110 continue; 1111 1112 if (!rollback) 1113 ret = uvc_query_ctrl(dev, UVC_SET_CUR, ctrl->entity->id, 1114 dev->intfnum, ctrl->info.selector, 1115 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1116 ctrl->info.size); 1117 else 1118 ret = 0; 1119 1120 if (rollback || ret < 0) 1121 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1122 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP), 1123 ctrl->info.size); 1124 1125 ctrl->dirty = 0; 1126 1127 if (ret < 0) 1128 return ret; 1129 } 1130 1131 return 0; 1132} 1133 1134int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback) 1135{ 1136 struct uvc_entity *entity; 1137 int ret = 0; 1138 1139 /* Find the control. */ 1140 list_for_each_entry(entity, &chain->entities, chain) { 1141 ret = uvc_ctrl_commit_entity(chain->dev, entity, rollback); 1142 if (ret < 0) 1143 goto done; 1144 } 1145 1146done: 1147 mutex_unlock(&chain->ctrl_mutex); 1148 return ret; 1149} 1150 1151int uvc_ctrl_get(struct uvc_video_chain *chain, 1152 struct v4l2_ext_control *xctrl) 1153{ 1154 struct uvc_control *ctrl; 1155 struct uvc_control_mapping *mapping; 1156 struct uvc_menu_info *menu; 1157 unsigned int i; 1158 int ret; 1159 1160 ctrl = uvc_find_control(chain, xctrl->id, &mapping); 1161 if (ctrl == NULL || (ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR) == 0) 1162 return -EINVAL; 1163 1164 if (!ctrl->loaded) { 1165 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, ctrl->entity->id, 1166 chain->dev->intfnum, ctrl->info.selector, 1167 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1168 ctrl->info.size); 1169 if (ret < 0) 1170 return ret; 1171 1172 ctrl->loaded = 1; 1173 } 1174 1175 xctrl->value = mapping->get(mapping, UVC_GET_CUR, 1176 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT)); 1177 1178 if (mapping->v4l2_type == V4L2_CTRL_TYPE_MENU) { 1179 menu = mapping->menu_info; 1180 for (i = 0; i < mapping->menu_count; ++i, ++menu) { 1181 if (menu->value == xctrl->value) { 1182 xctrl->value = i; 1183 break; 1184 } 1185 } 1186 } 1187 1188 return 0; 1189} 1190 1191int uvc_ctrl_set(struct uvc_video_chain *chain, 1192 struct v4l2_ext_control *xctrl) 1193{ 1194 struct uvc_control *ctrl; 1195 struct uvc_control_mapping *mapping; 1196 s32 value; 1197 u32 step; 1198 s32 min; 1199 s32 max; 1200 int ret; 1201 1202 ctrl = uvc_find_control(chain, xctrl->id, &mapping); 1203 if (ctrl == NULL || (ctrl->info.flags & UVC_CTRL_FLAG_SET_CUR) == 0) 1204 return -EINVAL; 1205 1206 /* Clamp out of range values. */ 1207 switch (mapping->v4l2_type) { 1208 case V4L2_CTRL_TYPE_INTEGER: 1209 if (!ctrl->cached) { 1210 ret = uvc_ctrl_populate_cache(chain, ctrl); 1211 if (ret < 0) 1212 return ret; 1213 } 1214 1215 min = mapping->get(mapping, UVC_GET_MIN, 1216 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MIN)); 1217 max = mapping->get(mapping, UVC_GET_MAX, 1218 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_MAX)); 1219 step = mapping->get(mapping, UVC_GET_RES, 1220 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES)); 1221 if (step == 0) 1222 step = 1; 1223 1224 xctrl->value = min + (xctrl->value - min + step/2) / step * step; 1225 xctrl->value = clamp(xctrl->value, min, max); 1226 value = xctrl->value; 1227 break; 1228 1229 case V4L2_CTRL_TYPE_BOOLEAN: 1230 xctrl->value = clamp(xctrl->value, 0, 1); 1231 value = xctrl->value; 1232 break; 1233 1234 case V4L2_CTRL_TYPE_MENU: 1235 if (xctrl->value < 0 || xctrl->value >= mapping->menu_count) 1236 return -ERANGE; 1237 value = mapping->menu_info[xctrl->value].value; 1238 1239 /* Valid menu indices are reported by the GET_RES request for 1240 * UVC controls that support it. 1241 */ 1242 if (mapping->data_type == UVC_CTRL_DATA_TYPE_BITMASK && 1243 (ctrl->info.flags & UVC_CTRL_FLAG_GET_RES)) { 1244 if (!ctrl->cached) { 1245 ret = uvc_ctrl_populate_cache(chain, ctrl); 1246 if (ret < 0) 1247 return ret; 1248 } 1249 1250 step = mapping->get(mapping, UVC_GET_RES, 1251 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_RES)); 1252 if (!(step & value)) 1253 return -ERANGE; 1254 } 1255 1256 break; 1257 1258 default: 1259 value = xctrl->value; 1260 break; 1261 } 1262 1263 /* If the mapping doesn't span the whole UVC control, the current value 1264 * needs to be loaded from the device to perform the read-modify-write 1265 * operation. 1266 */ 1267 if (!ctrl->loaded && (ctrl->info.size * 8) != mapping->size) { 1268 if ((ctrl->info.flags & UVC_CTRL_FLAG_GET_CUR) == 0) { 1269 memset(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1270 0, ctrl->info.size); 1271 } else { 1272 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, 1273 ctrl->entity->id, chain->dev->intfnum, 1274 ctrl->info.selector, 1275 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1276 ctrl->info.size); 1277 if (ret < 0) 1278 return ret; 1279 } 1280 1281 ctrl->loaded = 1; 1282 } 1283 1284 /* Backup the current value in case we need to rollback later. */ 1285 if (!ctrl->dirty) { 1286 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP), 1287 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT), 1288 ctrl->info.size); 1289 } 1290 1291 mapping->set(mapping, value, 1292 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT)); 1293 1294 ctrl->dirty = 1; 1295 ctrl->modified = 1; 1296 return 0; 1297} 1298 1299/* -------------------------------------------------------------------------- 1300 * Dynamic controls 1301 */ 1302 1303static void uvc_ctrl_fixup_xu_info(struct uvc_device *dev, 1304 const struct uvc_control *ctrl, struct uvc_control_info *info) 1305{ 1306 struct uvc_ctrl_fixup { 1307 struct usb_device_id id; 1308 u8 entity; 1309 u8 selector; 1310 u8 flags; 1311 }; 1312 1313 static const struct uvc_ctrl_fixup fixups[] = { 1314 { { USB_DEVICE(0x046d, 0x08c2) }, 9, 1, 1315 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX | 1316 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR | 1317 UVC_CTRL_FLAG_AUTO_UPDATE }, 1318 { { USB_DEVICE(0x046d, 0x08cc) }, 9, 1, 1319 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX | 1320 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR | 1321 UVC_CTRL_FLAG_AUTO_UPDATE }, 1322 { { USB_DEVICE(0x046d, 0x0994) }, 9, 1, 1323 UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX | 1324 UVC_CTRL_FLAG_GET_DEF | UVC_CTRL_FLAG_SET_CUR | 1325 UVC_CTRL_FLAG_AUTO_UPDATE }, 1326 }; 1327 1328 unsigned int i; 1329 1330 for (i = 0; i < ARRAY_SIZE(fixups); ++i) { 1331 if (!usb_match_one_id(dev->intf, &fixups[i].id)) 1332 continue; 1333 1334 if (fixups[i].entity == ctrl->entity->id && 1335 fixups[i].selector == info->selector) { 1336 info->flags = fixups[i].flags; 1337 return; 1338 } 1339 } 1340} 1341 1342/* 1343 * Query control information (size and flags) for XU controls. 1344 */ 1345static int uvc_ctrl_fill_xu_info(struct uvc_device *dev, 1346 const struct uvc_control *ctrl, struct uvc_control_info *info) 1347{ 1348 u8 *data; 1349 int ret; 1350 1351 data = kmalloc(2, GFP_KERNEL); 1352 if (data == NULL) 1353 return -ENOMEM; 1354 1355 memcpy(info->entity, ctrl->entity->extension.guidExtensionCode, 1356 sizeof(info->entity)); 1357 info->index = ctrl->index; 1358 info->selector = ctrl->index + 1; 1359 1360 /* Query and verify the control length (GET_LEN) */ 1361 ret = uvc_query_ctrl(dev, UVC_GET_LEN, ctrl->entity->id, dev->intfnum, 1362 info->selector, data, 2); 1363 if (ret < 0) { 1364 uvc_trace(UVC_TRACE_CONTROL, 1365 "GET_LEN failed on control %pUl/%u (%d).\n", 1366 info->entity, info->selector, ret); 1367 goto done; 1368 } 1369 1370 info->size = le16_to_cpup((__le16 *)data); 1371 1372 /* Query the control information (GET_INFO) */ 1373 ret = uvc_query_ctrl(dev, UVC_GET_INFO, ctrl->entity->id, dev->intfnum, 1374 info->selector, data, 1); 1375 if (ret < 0) { 1376 uvc_trace(UVC_TRACE_CONTROL, 1377 "GET_INFO failed on control %pUl/%u (%d).\n", 1378 info->entity, info->selector, ret); 1379 goto done; 1380 } 1381 1382 info->flags = UVC_CTRL_FLAG_GET_MIN | UVC_CTRL_FLAG_GET_MAX 1383 | UVC_CTRL_FLAG_GET_RES | UVC_CTRL_FLAG_GET_DEF 1384 | (data[0] & UVC_CONTROL_CAP_GET ? 1385 UVC_CTRL_FLAG_GET_CUR : 0) 1386 | (data[0] & UVC_CONTROL_CAP_SET ? 1387 UVC_CTRL_FLAG_SET_CUR : 0) 1388 | (data[0] & UVC_CONTROL_CAP_AUTOUPDATE ? 1389 UVC_CTRL_FLAG_AUTO_UPDATE : 0); 1390 1391 uvc_ctrl_fixup_xu_info(dev, ctrl, info); 1392 1393 uvc_trace(UVC_TRACE_CONTROL, "XU control %pUl/%u queried: len %u, " 1394 "flags { get %u set %u auto %u }.\n", 1395 info->entity, info->selector, info->size, 1396 (info->flags & UVC_CTRL_FLAG_GET_CUR) ? 1 : 0, 1397 (info->flags & UVC_CTRL_FLAG_SET_CUR) ? 1 : 0, 1398 (info->flags & UVC_CTRL_FLAG_AUTO_UPDATE) ? 1 : 0); 1399 1400done: 1401 kfree(data); 1402 return ret; 1403} 1404 1405static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl, 1406 const struct uvc_control_info *info); 1407 1408static int uvc_ctrl_init_xu_ctrl(struct uvc_device *dev, 1409 struct uvc_control *ctrl) 1410{ 1411 struct uvc_control_info info; 1412 int ret; 1413 1414 if (ctrl->initialized) 1415 return 0; 1416 1417 ret = uvc_ctrl_fill_xu_info(dev, ctrl, &info); 1418 if (ret < 0) 1419 return ret; 1420 1421 ret = uvc_ctrl_add_info(dev, ctrl, &info); 1422 if (ret < 0) 1423 uvc_trace(UVC_TRACE_CONTROL, "Failed to initialize control " 1424 "%pUl/%u on device %s entity %u\n", info.entity, 1425 info.selector, dev->udev->devpath, ctrl->entity->id); 1426 1427 return ret; 1428} 1429 1430int uvc_xu_ctrl_query(struct uvc_video_chain *chain, 1431 struct uvc_xu_control_query *xqry) 1432{ 1433 struct uvc_entity *entity; 1434 struct uvc_control *ctrl; 1435 unsigned int i, found = 0; 1436 __u32 reqflags; 1437 __u16 size; 1438 __u8 *data = NULL; 1439 int ret; 1440 1441 /* Find the extension unit. */ 1442 list_for_each_entry(entity, &chain->entities, chain) { 1443 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT && 1444 entity->id == xqry->unit) 1445 break; 1446 } 1447 1448 if (entity->id != xqry->unit) { 1449 uvc_trace(UVC_TRACE_CONTROL, "Extension unit %u not found.\n", 1450 xqry->unit); 1451 return -ENOENT; 1452 } 1453 1454 /* Find the control and perform delayed initialization if needed. */ 1455 for (i = 0; i < entity->ncontrols; ++i) { 1456 ctrl = &entity->controls[i]; 1457 if (ctrl->index == xqry->selector - 1) { 1458 found = 1; 1459 break; 1460 } 1461 } 1462 1463 if (!found) { 1464 uvc_trace(UVC_TRACE_CONTROL, "Control %pUl/%u not found.\n", 1465 entity->extension.guidExtensionCode, xqry->selector); 1466 return -ENOENT; 1467 } 1468 1469 if (mutex_lock_interruptible(&chain->ctrl_mutex)) 1470 return -ERESTARTSYS; 1471 1472 ret = uvc_ctrl_init_xu_ctrl(chain->dev, ctrl); 1473 if (ret < 0) { 1474 ret = -ENOENT; 1475 goto done; 1476 } 1477 1478 /* Validate the required buffer size and flags for the request */ 1479 reqflags = 0; 1480 size = ctrl->info.size; 1481 1482 switch (xqry->query) { 1483 case UVC_GET_CUR: 1484 reqflags = UVC_CTRL_FLAG_GET_CUR; 1485 break; 1486 case UVC_GET_MIN: 1487 reqflags = UVC_CTRL_FLAG_GET_MIN; 1488 break; 1489 case UVC_GET_MAX: 1490 reqflags = UVC_CTRL_FLAG_GET_MAX; 1491 break; 1492 case UVC_GET_DEF: 1493 reqflags = UVC_CTRL_FLAG_GET_DEF; 1494 break; 1495 case UVC_GET_RES: 1496 reqflags = UVC_CTRL_FLAG_GET_RES; 1497 break; 1498 case UVC_SET_CUR: 1499 reqflags = UVC_CTRL_FLAG_SET_CUR; 1500 break; 1501 case UVC_GET_LEN: 1502 size = 2; 1503 break; 1504 case UVC_GET_INFO: 1505 size = 1; 1506 break; 1507 default: 1508 ret = -EINVAL; 1509 goto done; 1510 } 1511 1512 if (size != xqry->size) { 1513 ret = -ENOBUFS; 1514 goto done; 1515 } 1516 1517 if (reqflags && !(ctrl->info.flags & reqflags)) { 1518 ret = -EBADRQC; 1519 goto done; 1520 } 1521 1522 data = kmalloc(size, GFP_KERNEL); 1523 if (data == NULL) { 1524 ret = -ENOMEM; 1525 goto done; 1526 } 1527 1528 if (xqry->query == UVC_SET_CUR && 1529 copy_from_user(data, xqry->data, size)) { 1530 ret = -EFAULT; 1531 goto done; 1532 } 1533 1534 ret = uvc_query_ctrl(chain->dev, xqry->query, xqry->unit, 1535 chain->dev->intfnum, xqry->selector, data, size); 1536 if (ret < 0) 1537 goto done; 1538 1539 if (xqry->query != UVC_SET_CUR && 1540 copy_to_user(xqry->data, data, size)) 1541 ret = -EFAULT; 1542done: 1543 kfree(data); 1544 mutex_unlock(&chain->ctrl_mutex); 1545 return ret; 1546} 1547 1548/* -------------------------------------------------------------------------- 1549 * Suspend/resume 1550 */ 1551 1552/* 1553 * Restore control values after resume, skipping controls that haven't been 1554 * changed. 1555 * 1556 * TODO 1557 * - Don't restore modified controls that are back to their default value. 1558 * - Handle restore order (Auto-Exposure Mode should be restored before 1559 * Exposure Time). 1560 */ 1561int uvc_ctrl_resume_device(struct uvc_device *dev) 1562{ 1563 struct uvc_control *ctrl; 1564 struct uvc_entity *entity; 1565 unsigned int i; 1566 int ret; 1567 1568 /* Walk the entities list and restore controls when possible. */ 1569 list_for_each_entry(entity, &dev->entities, list) { 1570 1571 for (i = 0; i < entity->ncontrols; ++i) { 1572 ctrl = &entity->controls[i]; 1573 1574 if (!ctrl->initialized || !ctrl->modified || 1575 (ctrl->info.flags & UVC_CTRL_FLAG_RESTORE) == 0) 1576 continue; 1577 1578 printk(KERN_INFO "restoring control %pUl/%u/%u\n", 1579 ctrl->info.entity, ctrl->info.index, 1580 ctrl->info.selector); 1581 ctrl->dirty = 1; 1582 } 1583 1584 ret = uvc_ctrl_commit_entity(dev, entity, 0); 1585 if (ret < 0) 1586 return ret; 1587 } 1588 1589 return 0; 1590} 1591 1592/* -------------------------------------------------------------------------- 1593 * Control and mapping handling 1594 */ 1595 1596/* 1597 * Add control information to a given control. 1598 */ 1599static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl, 1600 const struct uvc_control_info *info) 1601{ 1602 int ret = 0; 1603 1604 memcpy(&ctrl->info, info, sizeof(*info)); 1605 INIT_LIST_HEAD(&ctrl->info.mappings); 1606 1607 /* Allocate an array to save control values (cur, def, max, etc.) */ 1608 ctrl->uvc_data = kzalloc(ctrl->info.size * UVC_CTRL_DATA_LAST + 1, 1609 GFP_KERNEL); 1610 if (ctrl->uvc_data == NULL) { 1611 ret = -ENOMEM; 1612 goto done; 1613 } 1614 1615 ctrl->initialized = 1; 1616 1617 uvc_trace(UVC_TRACE_CONTROL, "Added control %pUl/%u to device %s " 1618 "entity %u\n", ctrl->info.entity, ctrl->info.selector, 1619 dev->udev->devpath, ctrl->entity->id); 1620 1621done: 1622 if (ret < 0) 1623 kfree(ctrl->uvc_data); 1624 return ret; 1625} 1626 1627/* 1628 * Add a control mapping to a given control. 1629 */ 1630static int __uvc_ctrl_add_mapping(struct uvc_device *dev, 1631 struct uvc_control *ctrl, const struct uvc_control_mapping *mapping) 1632{ 1633 struct uvc_control_mapping *map; 1634 unsigned int size; 1635 1636 /* Most mappings come from static kernel data and need to be duplicated. 1637 * Mappings that come from userspace will be unnecessarily duplicated, 1638 * this could be optimized. 1639 */ 1640 map = kmemdup(mapping, sizeof(*mapping), GFP_KERNEL); 1641 if (map == NULL) 1642 return -ENOMEM; 1643 1644 size = sizeof(*mapping->menu_info) * mapping->menu_count; 1645 map->menu_info = kmemdup(mapping->menu_info, size, GFP_KERNEL); 1646 if (map->menu_info == NULL) { 1647 kfree(map); 1648 return -ENOMEM; 1649 } 1650 1651 if (map->get == NULL) 1652 map->get = uvc_get_le_value; 1653 if (map->set == NULL) 1654 map->set = uvc_set_le_value; 1655 1656 map->ctrl = &ctrl->info; 1657 list_add_tail(&map->list, &ctrl->info.mappings); 1658 uvc_trace(UVC_TRACE_CONTROL, 1659 "Adding mapping '%s' to control %pUl/%u.\n", 1660 map->name, ctrl->info.entity, ctrl->info.selector); 1661 1662 return 0; 1663} 1664 1665int uvc_ctrl_add_mapping(struct uvc_video_chain *chain, 1666 const struct uvc_control_mapping *mapping) 1667{ 1668 struct uvc_device *dev = chain->dev; 1669 struct uvc_control_mapping *map; 1670 struct uvc_entity *entity; 1671 struct uvc_control *ctrl; 1672 int found = 0; 1673 int ret; 1674 1675 if (mapping->id & ~V4L2_CTRL_ID_MASK) { 1676 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', control " 1677 "id 0x%08x is invalid.\n", mapping->name, 1678 mapping->id); 1679 return -EINVAL; 1680 } 1681 1682 /* Search for the matching (GUID/CS) control on the current chain */ 1683 list_for_each_entry(entity, &chain->entities, chain) { 1684 unsigned int i; 1685 1686 if (UVC_ENTITY_TYPE(entity) != UVC_VC_EXTENSION_UNIT || 1687 !uvc_entity_match_guid(entity, mapping->entity)) 1688 continue; 1689 1690 for (i = 0; i < entity->ncontrols; ++i) { 1691 ctrl = &entity->controls[i]; 1692 if (ctrl->index == mapping->selector - 1) { 1693 found = 1; 1694 break; 1695 } 1696 } 1697 1698 if (found) 1699 break; 1700 } 1701 if (!found) 1702 return -ENOENT; 1703 1704 if (mutex_lock_interruptible(&chain->ctrl_mutex)) 1705 return -ERESTARTSYS; 1706 1707 /* Perform delayed initialization of XU controls */ 1708 ret = uvc_ctrl_init_xu_ctrl(dev, ctrl); 1709 if (ret < 0) { 1710 ret = -ENOENT; 1711 goto done; 1712 } 1713 1714 list_for_each_entry(map, &ctrl->info.mappings, list) { 1715 if (mapping->id == map->id) { 1716 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', " 1717 "control id 0x%08x already exists.\n", 1718 mapping->name, mapping->id); 1719 ret = -EEXIST; 1720 goto done; 1721 } 1722 } 1723 1724 /* Prevent excess memory consumption */ 1725 if (atomic_inc_return(&dev->nmappings) > UVC_MAX_CONTROL_MAPPINGS) { 1726 atomic_dec(&dev->nmappings); 1727 uvc_trace(UVC_TRACE_CONTROL, "Can't add mapping '%s', maximum " 1728 "mappings count (%u) exceeded.\n", mapping->name, 1729 UVC_MAX_CONTROL_MAPPINGS); 1730 ret = -ENOMEM; 1731 goto done; 1732 } 1733 1734 ret = __uvc_ctrl_add_mapping(dev, ctrl, mapping); 1735 if (ret < 0) 1736 atomic_dec(&dev->nmappings); 1737 1738done: 1739 mutex_unlock(&chain->ctrl_mutex); 1740 return ret; 1741} 1742 1743/* 1744 * Prune an entity of its bogus controls using a blacklist. Bogus controls 1745 * are currently the ones that crash the camera or unconditionally return an 1746 * error when queried. 1747 */ 1748static void uvc_ctrl_prune_entity(struct uvc_device *dev, 1749 struct uvc_entity *entity) 1750{ 1751 struct uvc_ctrl_blacklist { 1752 struct usb_device_id id; 1753 u8 index; 1754 }; 1755 1756 static const struct uvc_ctrl_blacklist processing_blacklist[] = { 1757 { { USB_DEVICE(0x13d3, 0x509b) }, 9 }, /* Gain */ 1758 { { USB_DEVICE(0x1c4f, 0x3000) }, 6 }, /* WB Temperature */ 1759 { { USB_DEVICE(0x5986, 0x0241) }, 2 }, /* Hue */ 1760 }; 1761 static const struct uvc_ctrl_blacklist camera_blacklist[] = { 1762 { { USB_DEVICE(0x06f8, 0x3005) }, 9 }, /* Zoom, Absolute */ 1763 }; 1764 1765 const struct uvc_ctrl_blacklist *blacklist; 1766 unsigned int size; 1767 unsigned int count; 1768 unsigned int i; 1769 u8 *controls; 1770 1771 switch (UVC_ENTITY_TYPE(entity)) { 1772 case UVC_VC_PROCESSING_UNIT: 1773 blacklist = processing_blacklist; 1774 count = ARRAY_SIZE(processing_blacklist); 1775 controls = entity->processing.bmControls; 1776 size = entity->processing.bControlSize; 1777 break; 1778 1779 case UVC_ITT_CAMERA: 1780 blacklist = camera_blacklist; 1781 count = ARRAY_SIZE(camera_blacklist); 1782 controls = entity->camera.bmControls; 1783 size = entity->camera.bControlSize; 1784 break; 1785 1786 default: 1787 return; 1788 } 1789 1790 for (i = 0; i < count; ++i) { 1791 if (!usb_match_one_id(dev->intf, &blacklist[i].id)) 1792 continue; 1793 1794 if (blacklist[i].index >= 8 * size || 1795 !uvc_test_bit(controls, blacklist[i].index)) 1796 continue; 1797 1798 uvc_trace(UVC_TRACE_CONTROL, "%u/%u control is black listed, " 1799 "removing it.\n", entity->id, blacklist[i].index); 1800 1801 uvc_clear_bit(controls, blacklist[i].index); 1802 } 1803} 1804 1805/* 1806 * Add control information and hardcoded stock control mappings to the given 1807 * device. 1808 */ 1809static void uvc_ctrl_init_ctrl(struct uvc_device *dev, struct uvc_control *ctrl) 1810{ 1811 const struct uvc_control_info *info = uvc_ctrls; 1812 const struct uvc_control_info *iend = info + ARRAY_SIZE(uvc_ctrls); 1813 const struct uvc_control_mapping *mapping = uvc_ctrl_mappings; 1814 const struct uvc_control_mapping *mend = 1815 mapping + ARRAY_SIZE(uvc_ctrl_mappings); 1816 1817 /* XU controls initialization requires querying the device for control 1818 * information. As some buggy UVC devices will crash when queried 1819 * repeatedly in a tight loop, delay XU controls initialization until 1820 * first use. 1821 */ 1822 if (UVC_ENTITY_TYPE(ctrl->entity) == UVC_VC_EXTENSION_UNIT) 1823 return; 1824 1825 for (; info < iend; ++info) { 1826 if (uvc_entity_match_guid(ctrl->entity, info->entity) && 1827 ctrl->index == info->index) { 1828 uvc_ctrl_add_info(dev, ctrl, info); 1829 break; 1830 } 1831 } 1832 1833 if (!ctrl->initialized) 1834 return; 1835 1836 for (; mapping < mend; ++mapping) { 1837 if (uvc_entity_match_guid(ctrl->entity, mapping->entity) && 1838 ctrl->info.selector == mapping->selector) 1839 __uvc_ctrl_add_mapping(dev, ctrl, mapping); 1840 } 1841} 1842 1843/* 1844 * Initialize device controls. 1845 */ 1846int uvc_ctrl_init_device(struct uvc_device *dev) 1847{ 1848 struct uvc_entity *entity; 1849 unsigned int i; 1850 1851 /* Walk the entities list and instantiate controls */ 1852 list_for_each_entry(entity, &dev->entities, list) { 1853 struct uvc_control *ctrl; 1854 unsigned int bControlSize = 0, ncontrols = 0; 1855 __u8 *bmControls = NULL; 1856 1857 if (UVC_ENTITY_TYPE(entity) == UVC_VC_EXTENSION_UNIT) { 1858 bmControls = entity->extension.bmControls; 1859 bControlSize = entity->extension.bControlSize; 1860 } else if (UVC_ENTITY_TYPE(entity) == UVC_VC_PROCESSING_UNIT) { 1861 bmControls = entity->processing.bmControls; 1862 bControlSize = entity->processing.bControlSize; 1863 } else if (UVC_ENTITY_TYPE(entity) == UVC_ITT_CAMERA) { 1864 bmControls = entity->camera.bmControls; 1865 bControlSize = entity->camera.bControlSize; 1866 } 1867 1868 /* Remove bogus/blacklisted controls */ 1869 uvc_ctrl_prune_entity(dev, entity); 1870 1871 /* Count supported controls and allocate the controls array */ 1872 for (i = 0; i < bControlSize; ++i) 1873 ncontrols += hweight8(bmControls[i]); 1874 if (ncontrols == 0) 1875 continue; 1876 1877 entity->controls = kcalloc(ncontrols, sizeof(*ctrl), 1878 GFP_KERNEL); 1879 if (entity->controls == NULL) 1880 return -ENOMEM; 1881 entity->ncontrols = ncontrols; 1882 1883 /* Initialize all supported controls */ 1884 ctrl = entity->controls; 1885 for (i = 0; i < bControlSize * 8; ++i) { 1886 if (uvc_test_bit(bmControls, i) == 0) 1887 continue; 1888 1889 ctrl->entity = entity; 1890 ctrl->index = i; 1891 1892 uvc_ctrl_init_ctrl(dev, ctrl); 1893 ctrl++; 1894 } 1895 } 1896 1897 return 0; 1898} 1899 1900/* 1901 * Cleanup device controls. 1902 */ 1903static void uvc_ctrl_cleanup_mappings(struct uvc_device *dev, 1904 struct uvc_control *ctrl) 1905{ 1906 struct uvc_control_mapping *mapping, *nm; 1907 1908 list_for_each_entry_safe(mapping, nm, &ctrl->info.mappings, list) { 1909 list_del(&mapping->list); 1910 kfree(mapping->menu_info); 1911 kfree(mapping); 1912 } 1913} 1914 1915void uvc_ctrl_cleanup_device(struct uvc_device *dev) 1916{ 1917 struct uvc_entity *entity; 1918 unsigned int i; 1919 1920 /* Free controls and control mappings for all entities. */ 1921 list_for_each_entry(entity, &dev->entities, list) { 1922 for (i = 0; i < entity->ncontrols; ++i) { 1923 struct uvc_control *ctrl = &entity->controls[i]; 1924 1925 if (!ctrl->initialized) 1926 continue; 1927 1928 uvc_ctrl_cleanup_mappings(dev, ctrl); 1929 kfree(ctrl->uvc_data); 1930 } 1931 1932 kfree(entity->controls); 1933 } 1934} 1935