drivers/media/video/uvc/uvc_ctrl.c

   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 <asm/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
  39 static 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_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  46                                 | UVC_CONTROL_RESTORE,
  47         },
  48         {
  49                 .entity         = UVC_GUID_UVC_PROCESSING,
  50                 .selector       = UVC_PU_CONTRAST_CONTROL,
  51                 .index          = 1,
  52                 .size           = 2,
  53                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  54                                 | UVC_CONTROL_RESTORE,
  55         },
  56         {
  57                 .entity         = UVC_GUID_UVC_PROCESSING,
  58                 .selector       = UVC_PU_HUE_CONTROL,
  59                 .index          = 2,
  60                 .size           = 2,
  61                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  62                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
  63         },
  64         {
  65                 .entity         = UVC_GUID_UVC_PROCESSING,
  66                 .selector       = UVC_PU_SATURATION_CONTROL,
  67                 .index          = 3,
  68                 .size           = 2,
  69                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  70                                 | UVC_CONTROL_RESTORE,
  71         },
  72         {
  73                 .entity         = UVC_GUID_UVC_PROCESSING,
  74                 .selector       = UVC_PU_SHARPNESS_CONTROL,
  75                 .index          = 4,
  76                 .size           = 2,
  77                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  78                                 | UVC_CONTROL_RESTORE,
  79         },
  80         {
  81                 .entity         = UVC_GUID_UVC_PROCESSING,
  82                 .selector       = UVC_PU_GAMMA_CONTROL,
  83                 .index          = 5,
  84                 .size           = 2,
  85                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  86                                 | UVC_CONTROL_RESTORE,
  87         },
  88         {
  89                 .entity         = UVC_GUID_UVC_PROCESSING,
  90                 .selector       = UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL,
  91                 .index          = 6,
  92                 .size           = 2,
  93                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
  94                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
  95         },
  96         {
  97                 .entity         = UVC_GUID_UVC_PROCESSING,
  98                 .selector       = UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL,
  99                 .index          = 7,
 100                 .size           = 4,
 101                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 102                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 103         },
 104         {
 105                 .entity         = UVC_GUID_UVC_PROCESSING,
 106                 .selector       = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
 107                 .index          = 8,
 108                 .size           = 2,
 109                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 110                                 | UVC_CONTROL_RESTORE,
 111         },
 112         {
 113                 .entity         = UVC_GUID_UVC_PROCESSING,
 114                 .selector       = UVC_PU_GAIN_CONTROL,
 115                 .index          = 9,
 116                 .size           = 2,
 117                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 118                                 | UVC_CONTROL_RESTORE,
 119         },
 120         {
 121                 .entity         = UVC_GUID_UVC_PROCESSING,
 122                 .selector       = UVC_PU_POWER_LINE_FREQUENCY_CONTROL,
 123                 .index          = 10,
 124                 .size           = 1,
 125                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 126                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
 127         },
 128         {
 129                 .entity         = UVC_GUID_UVC_PROCESSING,
 130                 .selector       = UVC_PU_HUE_AUTO_CONTROL,
 131                 .index          = 11,
 132                 .size           = 1,
 133                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 134                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
 135         },
 136         {
 137                 .entity         = UVC_GUID_UVC_PROCESSING,
 138                 .selector       = UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL,
 139                 .index          = 12,
 140                 .size           = 1,
 141                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 142                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
 143         },
 144         {
 145                 .entity         = UVC_GUID_UVC_PROCESSING,
 146                 .selector       = UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL,
 147                 .index          = 13,
 148                 .size           = 1,
 149                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 150                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
 151         },
 152         {
 153                 .entity         = UVC_GUID_UVC_PROCESSING,
 154                 .selector       = UVC_PU_DIGITAL_MULTIPLIER_CONTROL,
 155                 .index          = 14,
 156                 .size           = 2,
 157                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 158                                 | UVC_CONTROL_RESTORE,
 159         },
 160         {
 161                 .entity         = UVC_GUID_UVC_PROCESSING,
 162                 .selector       = UVC_PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL,
 163                 .index          = 15,
 164                 .size           = 2,
 165                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 166                                 | UVC_CONTROL_RESTORE,
 167         },
 168         {
 169                 .entity         = UVC_GUID_UVC_PROCESSING,
 170                 .selector       = UVC_PU_ANALOG_VIDEO_STANDARD_CONTROL,
 171                 .index          = 16,
 172                 .size           = 1,
 173                 .flags          = UVC_CONTROL_GET_CUR,
 174         },
 175         {
 176                 .entity         = UVC_GUID_UVC_PROCESSING,
 177                 .selector       = UVC_PU_ANALOG_LOCK_STATUS_CONTROL,
 178                 .index          = 17,
 179                 .size           = 1,
 180                 .flags          = UVC_CONTROL_GET_CUR,
 181         },
 182         {
 183                 .entity         = UVC_GUID_UVC_CAMERA,
 184                 .selector       = UVC_CT_SCANNING_MODE_CONTROL,
 185                 .index          = 0,
 186                 .size           = 1,
 187                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 188                                 | UVC_CONTROL_RESTORE,
 189         },
 190         {
 191                 .entity         = UVC_GUID_UVC_CAMERA,
 192                 .selector       = UVC_CT_AE_MODE_CONTROL,
 193                 .index          = 1,
 194                 .size           = 1,
 195                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 196                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_GET_RES
 197                                 | UVC_CONTROL_RESTORE,
 198         },
 199         {
 200                 .entity         = UVC_GUID_UVC_CAMERA,
 201                 .selector       = UVC_CT_AE_PRIORITY_CONTROL,
 202                 .index          = 2,
 203                 .size           = 1,
 204                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 205                                 | UVC_CONTROL_RESTORE,
 206         },
 207         {
 208                 .entity         = UVC_GUID_UVC_CAMERA,
 209                 .selector       = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
 210                 .index          = 3,
 211                 .size           = 4,
 212                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 213                                 | UVC_CONTROL_RESTORE,
 214         },
 215         {
 216                 .entity         = UVC_GUID_UVC_CAMERA,
 217                 .selector       = UVC_CT_EXPOSURE_TIME_RELATIVE_CONTROL,
 218                 .index          = 4,
 219                 .size           = 1,
 220                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_RESTORE,
 221         },
 222         {
 223                 .entity         = UVC_GUID_UVC_CAMERA,
 224                 .selector       = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
 225                 .index          = 5,
 226                 .size           = 2,
 227                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 228                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 229         },
 230         {
 231                 .entity         = UVC_GUID_UVC_CAMERA,
 232                 .selector       = UVC_CT_FOCUS_RELATIVE_CONTROL,
 233                 .index          = 6,
 234                 .size           = 2,
 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,
 238         },
 239         {
 240                 .entity         = UVC_GUID_UVC_CAMERA,
 241                 .selector       = UVC_CT_IRIS_ABSOLUTE_CONTROL,
 242                 .index          = 7,
 243                 .size           = 2,
 244                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 245                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 246         },
 247         {
 248                 .entity         = UVC_GUID_UVC_CAMERA,
 249                 .selector       = UVC_CT_IRIS_RELATIVE_CONTROL,
 250                 .index          = 8,
 251                 .size           = 1,
 252                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_AUTO_UPDATE,
 253         },
 254         {
 255                 .entity         = UVC_GUID_UVC_CAMERA,
 256                 .selector       = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
 257                 .index          = 9,
 258                 .size           = 2,
 259                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 260                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 261         },
 262         {
 263                 .entity         = UVC_GUID_UVC_CAMERA,
 264                 .selector       = UVC_CT_ZOOM_RELATIVE_CONTROL,
 265                 .index          = 10,
 266                 .size           = 3,
 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,
 270         },
 271         {
 272                 .entity         = UVC_GUID_UVC_CAMERA,
 273                 .selector       = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
 274                 .index          = 11,
 275                 .size           = 8,
 276                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 277                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 278         },
 279         {
 280                 .entity         = UVC_GUID_UVC_CAMERA,
 281                 .selector       = UVC_CT_PANTILT_RELATIVE_CONTROL,
 282                 .index          = 12,
 283                 .size           = 4,
 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,
 287         },
 288         {
 289                 .entity         = UVC_GUID_UVC_CAMERA,
 290                 .selector       = UVC_CT_ROLL_ABSOLUTE_CONTROL,
 291                 .index          = 13,
 292                 .size           = 2,
 293                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_RANGE
 294                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 295         },
 296         {
 297                 .entity         = UVC_GUID_UVC_CAMERA,
 298                 .selector       = UVC_CT_ROLL_RELATIVE_CONTROL,
 299                 .index          = 14,
 300                 .size           = 2,
 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,
 304         },
 305         {
 306                 .entity         = UVC_GUID_UVC_CAMERA,
 307                 .selector       = UVC_CT_FOCUS_AUTO_CONTROL,
 308                 .index          = 17,
 309                 .size           = 1,
 310                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 311                                 | UVC_CONTROL_GET_DEF | UVC_CONTROL_RESTORE,
 312         },
 313         {
 314                 .entity         = UVC_GUID_UVC_CAMERA,
 315                 .selector       = UVC_CT_PRIVACY_CONTROL,
 316                 .index          = 18,
 317                 .size           = 1,
 318                 .flags          = UVC_CONTROL_SET_CUR | UVC_CONTROL_GET_CUR
 319                                 | UVC_CONTROL_RESTORE | UVC_CONTROL_AUTO_UPDATE,
 320         },
 321 };
 322
 323 static struct uvc_menu_info power_line_frequency_controls[] = {
 324         { 0, "Disabled" },
 325         { 1, "50 Hz" },
 326         { 2, "60 Hz" },
 327 };
 328
 329 static struct uvc_menu_info exposure_auto_controls[] = {
 330         { 2, "Auto Mode" },
 331         { 1, "Manual Mode" },
 332         { 4, "Shutter Priority Mode" },
 333         { 8, "Aperture Priority Mode" },
 334 };
 335
 336 static __s32 uvc_ctrl_get_zoom(struct uvc_control_mapping *mapping,
 337         __u8 query, const __u8 *data)
 338 {
 339         __s8 zoom = (__s8)data[0];
 340
 341         switch (query) {
 342         case UVC_GET_CUR:
 343                 return (zoom == 0) ? 0 : (zoom > 0 ? data[2] : -data[2]);
 344
 345         case UVC_GET_MIN:
 346         case UVC_GET_MAX:
 347         case UVC_GET_RES:
 348         case UVC_GET_DEF:
 349         default:
 350                 return data[2];
 351         }
 352 }
 353
 354 static void uvc_ctrl_set_zoom(struct uvc_control_mapping *mapping,
 355         __s32 value, __u8 *data)
 356 {
 357         data[0] = value == 0 ? 0 : (value > 0) ? 1 : 0xff;
 358         data[2] = min((int)abs(value), 0xff);
 359 }
 360
 361 static struct uvc_control_mapping uvc_ctrl_mappings[] = {
 362         {
 363                 .id             = V4L2_CID_BRIGHTNESS,
 364                 .name           = "Brightness",
 365                 .entity         = UVC_GUID_UVC_PROCESSING,
 366                 .selector       = UVC_PU_BRIGHTNESS_CONTROL,
 367                 .size           = 16,
 368                 .offset         = 0,
 369                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 370                 .data_type      = UVC_CTRL_DATA_TYPE_SIGNED,
 371         },
 372         {
 373                 .id             = V4L2_CID_CONTRAST,
 374                 .name           = "Contrast",
 375                 .entity         = UVC_GUID_UVC_PROCESSING,
 376                 .selector       = UVC_PU_CONTRAST_CONTROL,
 377                 .size           = 16,
 378                 .offset         = 0,
 379                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 380                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 381         },
 382         {
 383                 .id             = V4L2_CID_HUE,
 384                 .name           = "Hue",
 385                 .entity         = UVC_GUID_UVC_PROCESSING,
 386                 .selector       = UVC_PU_HUE_CONTROL,
 387                 .size           = 16,
 388                 .offset         = 0,
 389                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 390                 .data_type      = UVC_CTRL_DATA_TYPE_SIGNED,
 391         },
 392         {
 393                 .id             = V4L2_CID_SATURATION,
 394                 .name           = "Saturation",
 395                 .entity         = UVC_GUID_UVC_PROCESSING,
 396                 .selector       = UVC_PU_SATURATION_CONTROL,
 397                 .size           = 16,
 398                 .offset         = 0,
 399                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 400                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 401         },
 402         {
 403                 .id             = V4L2_CID_SHARPNESS,
 404                 .name           = "Sharpness",
 405                 .entity         = UVC_GUID_UVC_PROCESSING,
 406                 .selector       = UVC_PU_SHARPNESS_CONTROL,
 407                 .size           = 16,
 408                 .offset         = 0,
 409                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 410                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 411         },
 412         {
 413                 .id             = V4L2_CID_GAMMA,
 414                 .name           = "Gamma",
 415                 .entity         = UVC_GUID_UVC_PROCESSING,
 416                 .selector       = UVC_PU_GAMMA_CONTROL,
 417                 .size           = 16,
 418                 .offset         = 0,
 419                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 420                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 421         },
 422         {
 423                 .id             = V4L2_CID_BACKLIGHT_COMPENSATION,
 424                 .name           = "Backlight Compensation",
 425                 .entity         = UVC_GUID_UVC_PROCESSING,
 426                 .selector       = UVC_PU_BACKLIGHT_COMPENSATION_CONTROL,
 427                 .size           = 16,
 428                 .offset         = 0,
 429                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 430                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 431         },
 432         {
 433                 .id             = V4L2_CID_GAIN,
 434                 .name           = "Gain",
 435                 .entity         = UVC_GUID_UVC_PROCESSING,
 436                 .selector       = UVC_PU_GAIN_CONTROL,
 437                 .size           = 16,
 438                 .offset         = 0,
 439                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 440                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 441         },
 442         {
 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,
 447                 .size           = 2,
 448                 .offset         = 0,
 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),
 453         },
 454         {
 455                 .id             = V4L2_CID_HUE_AUTO,
 456                 .name           = "Hue, Auto",
 457                 .entity         = UVC_GUID_UVC_PROCESSING,
 458                 .selector       = UVC_PU_HUE_AUTO_CONTROL,
 459                 .size           = 1,
 460                 .offset         = 0,
 461                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 462                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 463         },
 464         {
 465                 .id             = V4L2_CID_EXPOSURE_AUTO,
 466                 .name           = "Exposure, Auto",
 467                 .entity         = UVC_GUID_UVC_CAMERA,
 468                 .selector       = UVC_CT_AE_MODE_CONTROL,
 469                 .size           = 4,
 470                 .offset         = 0,
 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),
 475         },
 476         {
 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,
 481                 .size           = 1,
 482                 .offset         = 0,
 483                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 484                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 485         },
 486         {
 487                 .id             = V4L2_CID_EXPOSURE_ABSOLUTE,
 488                 .name           = "Exposure (Absolute)",
 489                 .entity         = UVC_GUID_UVC_CAMERA,
 490                 .selector       = UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL,
 491                 .size           = 32,
 492                 .offset         = 0,
 493                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 494                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 495         },
 496         {
 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,
 501                 .size           = 1,
 502                 .offset         = 0,
 503                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 504                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 505         },
 506         {
 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,
 511                 .size           = 16,
 512                 .offset         = 0,
 513                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 514                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 515         },
 516         {
 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,
 521                 .size           = 1,
 522                 .offset         = 0,
 523                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 524                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 525         },
 526         {
 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,
 531                 .size           = 16,
 532                 .offset         = 0,
 533                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 534                 .data_type      = UVC_CTRL_DATA_TYPE_SIGNED,
 535         },
 536         {
 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,
 541                 .size           = 16,
 542                 .offset         = 16,
 543                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 544                 .data_type      = UVC_CTRL_DATA_TYPE_SIGNED,
 545         },
 546         {
 547                 .id             = V4L2_CID_FOCUS_ABSOLUTE,
 548                 .name           = "Focus (absolute)",
 549                 .entity         = UVC_GUID_UVC_CAMERA,
 550                 .selector       = UVC_CT_FOCUS_ABSOLUTE_CONTROL,
 551                 .size           = 16,
 552                 .offset         = 0,
 553                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 554                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 555         },
 556         {
 557                 .id             = V4L2_CID_FOCUS_AUTO,
 558                 .name           = "Focus, Auto",
 559                 .entity         = UVC_GUID_UVC_CAMERA,
 560                 .selector       = UVC_CT_FOCUS_AUTO_CONTROL,
 561                 .size           = 1,
 562                 .offset         = 0,
 563                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 564                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 565         },
 566         {
 567                 .id             = V4L2_CID_IRIS_ABSOLUTE,
 568                 .name           = "Iris, Absolute",
 569                 .entity         = UVC_GUID_UVC_CAMERA,
 570                 .selector       = UVC_CT_IRIS_ABSOLUTE_CONTROL,
 571                 .size           = 16,
 572                 .offset         = 0,
 573                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 574                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 575         },
 576         {
 577                 .id             = V4L2_CID_IRIS_RELATIVE,
 578                 .name           = "Iris, Relative",
 579                 .entity         = UVC_GUID_UVC_CAMERA,
 580                 .selector       = UVC_CT_IRIS_RELATIVE_CONTROL,
 581                 .size           = 8,
 582                 .offset         = 0,
 583                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 584                 .data_type      = UVC_CTRL_DATA_TYPE_SIGNED,
 585         },
 586         {
 587                 .id             = V4L2_CID_ZOOM_ABSOLUTE,
 588                 .name           = "Zoom, Absolute",
 589                 .entity         = UVC_GUID_UVC_CAMERA,
 590                 .selector       = UVC_CT_ZOOM_ABSOLUTE_CONTROL,
 591                 .size           = 16,
 592                 .offset         = 0,
 593                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 594                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 595         },
 596         {
 597                 .id             = V4L2_CID_ZOOM_CONTINUOUS,
 598                 .name           = "Zoom, Continuous",
 599                 .entity         = UVC_GUID_UVC_CAMERA,
 600                 .selector       = UVC_CT_ZOOM_RELATIVE_CONTROL,
 601                 .size           = 0,
 602                 .offset         = 0,
 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,
 607         },
 608         {
 609                 .id             = V4L2_CID_PAN_ABSOLUTE,
 610                 .name           = "Pan (Absolute)",
 611                 .entity         = UVC_GUID_UVC_CAMERA,
 612                 .selector       = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
 613                 .size           = 32,
 614                 .offset         = 0,
 615                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 616                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 617         },
 618         {
 619                 .id             = V4L2_CID_TILT_ABSOLUTE,
 620                 .name           = "Tilt (Absolute)",
 621                 .entity         = UVC_GUID_UVC_CAMERA,
 622                 .selector       = UVC_CT_PANTILT_ABSOLUTE_CONTROL,
 623                 .size           = 32,
 624                 .offset         = 32,
 625                 .v4l2_type      = V4L2_CTRL_TYPE_INTEGER,
 626                 .data_type      = UVC_CTRL_DATA_TYPE_UNSIGNED,
 627         },
 628         {
 629                 .id             = V4L2_CID_PRIVACY,
 630                 .name           = "Privacy",
 631                 .entity         = UVC_GUID_UVC_CAMERA,
 632                 .selector       = UVC_CT_PRIVACY_CONTROL,
 633                 .size           = 1,
 634                 .offset         = 0,
 635                 .v4l2_type      = V4L2_CTRL_TYPE_BOOLEAN,
 636                 .data_type      = UVC_CTRL_DATA_TYPE_BOOLEAN,
 637         },
 638 };
 639
 640 /* ------------------------------------------------------------------------
 641  * Utility functions
 642  */
 643
 644 static inline __u8 *uvc_ctrl_data(struct uvc_control *ctrl, int id)
 645 {
 646         return ctrl->uvc_data + id * ctrl->info.size;
 647 }
 648
 649 static inline int uvc_test_bit(const __u8 *data, int bit)
 650 {
 651         return (data[bit >> 3] >> (bit & 7)) & 1;
 652 }
 653
 654 static inline void uvc_clear_bit(__u8 *data, int bit)
 655 {
 656         data[bit >> 3] &= ~(1 << (bit & 7));
 657 }
 658
 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.
 663  */
 664 static __s32 uvc_get_le_value(struct uvc_control_mapping *mapping,
 665         __u8 query, const __u8 *data)
 666 {
 667         int bits = mapping->size;
 668         int offset = mapping->offset;
 669         __s32 value = 0;
 670         __u8 mask;
 671
 672         data += offset / 8;
 673         offset &= 7;
 674         mask = ((1LL << bits) - 1) << offset;
 675
 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);
 680                 offset -= 8;
 681                 mask = (1 << bits) - 1;
 682         }
 683
 684         /* Sign-extend the value if needed. */
 685         if (mapping->data_type == UVC_CTRL_DATA_TYPE_SIGNED)
 686                 value |= -(value & (1 << (mapping->size - 1)));
 687
 688         return value;
 689 }
 690
 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'.
 693  */
 694 static void uvc_set_le_value(struct uvc_control_mapping *mapping,
 695         __s32 value, __u8 *data)
 696 {
 697         int bits = mapping->size;
 698         int offset = mapping->offset;
 699         __u8 mask;
 700
 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
 704          * value.
 705          */
 706         if (mapping->v4l2_type == V4L2_CTRL_TYPE_BUTTON)
 707                 value = -1;
 708
 709         data += offset / 8;
 710         offset &= 7;
 711
 712         for (; bits > 0; data++) {
 713                 mask = ((1LL << bits) - 1) << offset;
 714                 *data = (*data & ~mask) | ((value << offset) & mask);
 715                 value >>= offset ? offset : 8;
 716                 bits -= 8 - offset;
 717                 offset = 0;
 718         }
 719 }
 720
 721 /* ------------------------------------------------------------------------
 722  * Terminal and unit management
 723  */
 724
 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;
 729
 730 static int uvc_entity_match_guid(const struct uvc_entity *entity,
 731         const __u8 guid[16])
 732 {
 733         switch (UVC_ENTITY_TYPE(entity)) {
 734         case UVC_ITT_CAMERA:
 735                 return memcmp(uvc_camera_guid, guid, 16) == 0;
 736
 737         case UVC_ITT_MEDIA_TRANSPORT_INPUT:
 738                 return memcmp(uvc_media_transport_input_guid, guid, 16) == 0;
 739
 740         case UVC_VC_PROCESSING_UNIT:
 741                 return memcmp(uvc_processing_guid, guid, 16) == 0;
 742
 743         case UVC_VC_EXTENSION_UNIT:
 744                 return memcmp(entity->extension.guidExtensionCode,
 745                               guid, 16) == 0;
 746
 747         default:
 748                 return 0;
 749         }
 750 }
 751
 752 /* ------------------------------------------------------------------------
 753  * UVC Controls
 754  */
 755
 756 static void __uvc_find_control(struct uvc_entity *entity, __u32 v4l2_id,
 757         struct uvc_control_mapping **mapping, struct uvc_control **control,
 758         int next)
 759 {
 760         struct uvc_control *ctrl;
 761         struct uvc_control_mapping *map;
 762         unsigned int i;
 763
 764         if (entity == NULL)
 765                 return;
 766
 767         for (i = 0; i < entity->ncontrols; ++i) {
 768                 ctrl = &entity->controls[i];
 769                 if (!ctrl->initialized)
 770                         continue;
 771
 772                 list_for_each_entry(map, &ctrl->info.mappings, list) {
 773                         if ((map->id == v4l2_id) && !next) {
 774                                 *control = ctrl;
 775                                 *mapping = map;
 776                                 return;
 777                         }
 778
 779                         if ((*mapping == NULL || (*mapping)->id > map->id) &&
 780                             (map->id > v4l2_id) && next) {
 781                                 *control = ctrl;
 782                                 *mapping = map;
 783                         }
 784                 }
 785         }
 786 }
 787
 788 static struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
 789         __u32 v4l2_id, struct uvc_control_mapping **mapping)
 790 {
 791         struct uvc_control *ctrl = NULL;
 792         struct uvc_entity *entity;
 793         int next = v4l2_id & V4L2_CTRL_FLAG_NEXT_CTRL;
 794
 795         *mapping = NULL;
 796
 797         /* Mask the query flags. */
 798         v4l2_id &= V4L2_CTRL_ID_MASK;
 799
 800         /* Find the control. */
 801         list_for_each_entry(entity, &chain->entities, chain) {
 802                 __uvc_find_control(entity, v4l2_id, mapping, &ctrl, next);
 803                 if (ctrl && !next)
 804                         return ctrl;
 805         }
 806
 807         if (ctrl == NULL && !next)
 808                 uvc_trace(UVC_TRACE_CONTROL, "Control 0x%08x not found.\n",
 809                                 v4l2_id);
 810
 811         return ctrl;
 812 }
 813
 814 static int uvc_ctrl_populate_cache(struct uvc_video_chain *chain,
 815         struct uvc_control *ctrl)
 816 {
 817         int ret;
 818
 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),
 823                                      ctrl->info.size);
 824                 if (ret < 0)
 825                         return ret;
 826         }
 827
 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),
 832                                      ctrl->info.size);
 833                 if (ret < 0)
 834                         return ret;
 835         }
 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),
 840                                      ctrl->info.size);
 841                 if (ret < 0)
 842                         return ret;
 843         }
 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),
 848                                      ctrl->info.size);
 849                 if (ret < 0)
 850                         return ret;
 851         }
 852
 853         ctrl->cached = 1;
 854         return 0;
 855 }
 856
 857 int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
 858         struct v4l2_queryctrl *v4l2_ctrl)
 859 {
 860         struct uvc_control *ctrl;
 861         struct uvc_control_mapping *mapping;
 862         struct uvc_menu_info *menu;
 863         unsigned int i;
 864         int ret;
 865
 866         ret = mutex_lock_interruptible(&chain->ctrl_mutex);
 867         if (ret < 0)
 868                 return -ERESTARTSYS;
 869
 870         ctrl = uvc_find_control(chain, v4l2_ctrl->id, &mapping);
 871         if (ctrl == NULL) {
 872                 ret = -EINVAL;
 873                 goto done;
 874         }
 875
 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;
 881
 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;
 886
 887         if (!ctrl->cached) {
 888                 ret = uvc_ctrl_populate_cache(chain, ctrl);
 889                 if (ret < 0)
 890                         goto done;
 891         }
 892
 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));
 896         }
 897
 898         switch (mapping->v4l2_type) {
 899         case V4L2_CTRL_TYPE_MENU:
 900                 v4l2_ctrl->minimum = 0;
 901                 v4l2_ctrl->maximum = mapping->menu_count - 1;
 902                 v4l2_ctrl->step = 1;
 903
 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;
 908                                 break;
 909                         }
 910                 }
 911
 912                 goto done;
 913
 914         case V4L2_CTRL_TYPE_BOOLEAN:
 915                 v4l2_ctrl->minimum = 0;
 916                 v4l2_ctrl->maximum = 1;
 917                 v4l2_ctrl->step = 1;
 918                 goto done;
 919
 920         case V4L2_CTRL_TYPE_BUTTON:
 921                 v4l2_ctrl->minimum = 0;
 922                 v4l2_ctrl->maximum = 0;
 923                 v4l2_ctrl->step = 0;
 924                 goto done;
 925
 926         default:
 927                 break;
 928         }
 929
 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));
 933
 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));
 937
 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));
 941
 942 done:
 943         mutex_unlock(&chain->ctrl_mutex);
 944         return ret;
 945 }
 946
 947 /*
 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
 954  * manually.
 955  */
 956 int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
 957         struct v4l2_querymenu *query_menu)
 958 {
 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;
 964         int ret;
 965
 966         memset(query_menu, 0, sizeof(*query_menu));
 967         query_menu->id = id;
 968         query_menu->index = index;
 969
 970         ret = mutex_lock_interruptible(&chain->ctrl_mutex);
 971         if (ret < 0)
 972                 return -ERESTARTSYS;
 973
 974         ctrl = uvc_find_control(chain, query_menu->id, &mapping);
 975         if (ctrl == NULL || mapping->v4l2_type != V4L2_CTRL_TYPE_MENU) {
 976                 ret = -EINVAL;
 977                 goto done;
 978         }
 979
 980         if (query_menu->index >= mapping->menu_count) {
 981                 ret = -EINVAL;
 982                 goto done;
 983         }
 984
 985         menu_info = &mapping->menu_info[query_menu->index];
 986         strlcpy(query_menu->name, menu_info->name, sizeof query_menu->name);
 987
 988 done:
 989         mutex_unlock(&chain->ctrl_mutex);
 990         return ret;
 991 }
 992
 993
 994 /* --------------------------------------------------------------------------
 995  * Control transactions
 996  *
 997  * To make extended set operations as atomic as the hardware allows, controls
 998  * are handled using begin/commit/rollback operations.
 999  *
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.
1002  *
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
1007  * field.
1008  *
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
1016  * control lock.
1017  */
1018 int uvc_ctrl_begin(struct uvc_video_chain *chain)
1019 {
1020         return mutex_lock_interruptible(&chain->ctrl_mutex) ? -ERESTARTSYS : 0;
1021 }
1022
1023 static int uvc_ctrl_commit_entity(struct uvc_device *dev,
1024         struct uvc_entity *entity, int rollback)
1025 {
1026         struct uvc_control *ctrl;
1027         unsigned int i;
1028         int ret;
1029
1030         if (entity == NULL)
1031                 return 0;
1032
1033         for (i = 0; i < entity->ncontrols; ++i) {
1034                 ctrl = &entity->controls[i];
1035                 if (!ctrl->initialized)
1036                         continue;
1037
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.
1041                  */
1042                 if (ctrl->info.flags & UVC_CONTROL_AUTO_UPDATE)
1043                         ctrl->loaded = 0;
1044
1045                 if (!ctrl->dirty)
1046                         continue;
1047
1048                 if (!rollback)
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),
1052                                 ctrl->info.size);
1053                 else
1054                         ret = 0;
1055
1056                 if (rollback || ret < 0)
1057                         memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1058                                uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1059                                ctrl->info.size);
1060
1061                 ctrl->dirty = 0;
1062
1063                 if (ret < 0)
1064                         return ret;
1065         }
1066
1067         return 0;
1068 }
1069
1070 int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback)
1071 {
1072         struct uvc_entity *entity;
1073         int ret = 0;
1074
1075         /* Find the control. */
1076         list_for_each_entry(entity, &chain->entities, chain) {
1077                 ret = uvc_ctrl_commit_entity(chain->dev, entity, rollback);
1078                 if (ret < 0)
1079                         goto done;
1080         }
1081
1082 done:
1083         mutex_unlock(&chain->ctrl_mutex);
1084         return ret;
1085 }
1086
1087 int uvc_ctrl_get(struct uvc_video_chain *chain,
1088         struct v4l2_ext_control *xctrl)
1089 {
1090         struct uvc_control *ctrl;
1091         struct uvc_control_mapping *mapping;
1092         struct uvc_menu_info *menu;
1093         unsigned int i;
1094         int ret;
1095
1096         ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1097         if (ctrl == NULL || (ctrl->info.flags & UVC_CONTROL_GET_CUR) == 0)
1098                 return -EINVAL;
1099
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),
1104                                 ctrl->info.size);
1105                 if (ret < 0)
1106                         return ret;
1107
1108                 ctrl->loaded = 1;
1109         }
1110
1111         xctrl->value = mapping->get(mapping, UVC_GET_CUR,
1112                 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
1113
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) {
1118                                 xctrl->value = i;
1119                                 break;
1120                         }
1121                 }
1122         }
1123
1124         return 0;
1125 }
1126
1127 int uvc_ctrl_set(struct uvc_video_chain *chain,
1128         struct v4l2_ext_control *xctrl)
1129 {
1130         struct uvc_control *ctrl;
1131         struct uvc_control_mapping *mapping;
1132         s32 value;
1133         u32 step;
1134         s32 min;
1135         s32 max;
1136         int ret;
1137
1138         ctrl = uvc_find_control(chain, xctrl->id, &mapping);
1139         if (ctrl == NULL || (ctrl->info.flags & UVC_CONTROL_SET_CUR) == 0)
1140                 return -EINVAL;
1141
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);
1147                         if (ret < 0)
1148                                 return ret;
1149                 }
1150
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));
1157                 if (step == 0)
1158                         step = 1;
1159
1160                 xctrl->value = min + (xctrl->value - min + step/2) / step * step;
1161                 xctrl->value = clamp(xctrl->value, min, max);
1162                 value = xctrl->value;
1163                 break;
1164
1165         case V4L2_CTRL_TYPE_BOOLEAN:
1166                 xctrl->value = clamp(xctrl->value, 0, 1);
1167                 value = xctrl->value;
1168                 break;
1169
1170         case V4L2_CTRL_TYPE_MENU:
1171                 if (xctrl->value < 0 || xctrl->value >= mapping->menu_count)
1172                         return -ERANGE;
1173                 value = mapping->menu_info[xctrl->value].value;
1174                 break;
1175
1176         default:
1177                 value = xctrl->value;
1178                 break;
1179         }
1180
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
1183          * operation.
1184          */
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);
1189                 } else {
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),
1194                                 ctrl->info.size);
1195                         if (ret < 0)
1196                                 return ret;
1197                 }
1198
1199                 ctrl->loaded = 1;
1200         }
1201
1202         /* Backup the current value in case we need to rollback later. */
1203         if (!ctrl->dirty) {
1204                 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1205                        uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1206                        ctrl->info.size);
1207         }
1208
1209         mapping->set(mapping, value,
1210                 uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT));
1211
1212         ctrl->dirty = 1;
1213         ctrl->modified = 1;
1214         return 0;
1215 }
1216
1217 /* --------------------------------------------------------------------------
1218  * Dynamic controls
1219  */
1220
1221 static void uvc_ctrl_fixup_xu_info(struct uvc_device *dev,
1222         const struct uvc_control *ctrl, struct uvc_control_info *info)
1223 {
1224         struct uvc_ctrl_fixup {
1225                 struct usb_device_id id;
1226                 u8 entity;
1227                 u8 selector;
1228                 u8 flags;
1229         };
1230
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 },
1244         };
1245
1246         unsigned int i;
1247
1248         for (i = 0; i < ARRAY_SIZE(fixups); ++i) {
1249                 if (!usb_match_one_id(dev->intf, &fixups[i].id))
1250                         continue;
1251
1252                 if (fixups[i].entity == ctrl->entity->id &&
1253                     fixups[i].selector == info->selector) {
1254                         info->flags = fixups[i].flags;
1255                         return;
1256                 }
1257         }
1258 }
1259
1260 /*
1261  * Query control information (size and flags) for XU controls.
1262  */
1263 static int uvc_ctrl_fill_xu_info(struct uvc_device *dev,
1264         const struct uvc_control *ctrl, struct uvc_control_info *info)
1265 {
1266         u8 *data;
1267         int ret;
1268
1269         data = kmalloc(2, GFP_KERNEL);
1270         if (data == NULL)
1271                 return -ENOMEM;
1272
1273         memcpy(info->entity, ctrl->entity->extension.guidExtensionCode,
1274                sizeof(info->entity));
1275         info->index = ctrl->index;
1276         info->selector = ctrl->index + 1;
1277
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);
1281         if (ret < 0) {
1282                 uvc_trace(UVC_TRACE_CONTROL,
1283                           "GET_LEN failed on control %pUl/%u (%d).\n",
1284                            info->entity, info->selector, ret);
1285                 goto done;
1286         }
1287
1288         info->size = le16_to_cpup((__le16 *)data);
1289
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);
1293         if (ret < 0) {
1294                 uvc_trace(UVC_TRACE_CONTROL,
1295                           "GET_INFO failed on control %pUl/%u (%d).\n",
1296                           info->entity, info->selector, ret);
1297                 goto done;
1298         }
1299
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);
1306
1307         uvc_ctrl_fixup_xu_info(dev, ctrl, info);
1308
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);
1315
1316 done:
1317         kfree(data);
1318         return ret;
1319 }
1320
1321 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1322         const struct uvc_control_info *info);
1323
1324 static int uvc_ctrl_init_xu_ctrl(struct uvc_device *dev,
1325         struct uvc_control *ctrl)
1326 {
1327         struct uvc_control_info info;
1328         int ret;
1329
1330         if (ctrl->initialized)
1331                 return 0;
1332
1333         ret = uvc_ctrl_fill_xu_info(dev, ctrl, &info);
1334         if (ret < 0)
1335                 return ret;
1336
1337         ret = uvc_ctrl_add_info(dev, ctrl, &info);
1338         if (ret < 0)
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);
1342
1343         return ret;
1344 }
1345
1346 int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
1347         struct uvc_xu_control *xctrl, int set)
1348 {
1349         struct uvc_entity *entity;
1350         struct uvc_control *ctrl = NULL;
1351         unsigned int i, found = 0;
1352         int restore = 0;
1353         __u8 *data;
1354         int ret;
1355
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)
1360                         break;
1361         }
1362
1363         if (entity->id != xctrl->unit) {
1364                 uvc_trace(UVC_TRACE_CONTROL, "Extension unit %u not found.\n",
1365                         xctrl->unit);
1366                 return -EINVAL;
1367         }
1368
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) {
1373                         found = 1;
1374                         break;
1375                 }
1376         }
1377
1378         if (!found) {
1379                 uvc_trace(UVC_TRACE_CONTROL, "Control %pUl/%u not found.\n",
1380                         entity->extension.guidExtensionCode, xctrl->selector);
1381                 return -EINVAL;
1382         }
1383
1384         if (mutex_lock_interruptible(&chain->ctrl_mutex))
1385                 return -ERESTARTSYS;
1386
1387         ret = uvc_ctrl_init_xu_ctrl(chain->dev, ctrl);
1388         if (ret < 0) {
1389                 ret = -ENOENT;
1390                 goto done;
1391         }
1392
1393         /* Validate control data size. */
1394         if (ctrl->info.size != xctrl->size) {
1395                 ret = -EINVAL;
1396                 goto done;
1397         }
1398
1399         if ((set && !(ctrl->info.flags & UVC_CONTROL_SET_CUR)) ||
1400             (!set && !(ctrl->info.flags & UVC_CONTROL_GET_CUR))) {
1401                 ret = -EINVAL;
1402                 goto done;
1403         }
1404
1405         memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1406                uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1407                ctrl->info.size);
1408         data = uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT);
1409         restore = set;
1410
1411         if (set && copy_from_user(data, xctrl->data, xctrl->size)) {
1412                 ret = -EFAULT;
1413                 goto done;
1414         }
1415
1416         ret = uvc_query_ctrl(chain->dev, set ? UVC_SET_CUR : UVC_GET_CUR,
1417                              xctrl->unit, chain->dev->intfnum, xctrl->selector,
1418                              data, xctrl->size);
1419         if (ret < 0)
1420                 goto done;
1421
1422         if (!set && copy_to_user(xctrl->data, data, xctrl->size))
1423                 ret = -EFAULT;
1424 done:
1425         if (ret && restore)
1426                 memcpy(uvc_ctrl_data(ctrl, UVC_CTRL_DATA_CURRENT),
1427                        uvc_ctrl_data(ctrl, UVC_CTRL_DATA_BACKUP),
1428                        xctrl->size);
1429
1430         mutex_unlock(&chain->ctrl_mutex);
1431         return ret;
1432 }
1433
1434 /* --------------------------------------------------------------------------
1435  * Suspend/resume
1436  */
1437
1438 /*
1439  * Restore control values after resume, skipping controls that haven't been
1440  * changed.
1441  *
1442  * TODO
1443  * - Don't restore modified controls that are back to their default value.
1444  * - Handle restore order (Auto-Exposure Mode should be restored before
1445  *   Exposure Time).
1446  */
1447 int uvc_ctrl_resume_device(struct uvc_device *dev)
1448 {
1449         struct uvc_control *ctrl;
1450         struct uvc_entity *entity;
1451         unsigned int i;
1452         int ret;
1453
1454         /* Walk the entities list and restore controls when possible. */
1455         list_for_each_entry(entity, &dev->entities, list) {
1456
1457                 for (i = 0; i < entity->ncontrols; ++i) {
1458                         ctrl = &entity->controls[i];
1459
1460                         if (!ctrl->initialized || !ctrl->modified ||
1461                             (ctrl->info.flags & UVC_CONTROL_RESTORE) == 0)
1462                                 continue;
1463
1464                         printk(KERN_INFO "restoring control %pUl/%u/%u\n",
1465                                 ctrl->info.entity, ctrl->info.index,
1466                                 ctrl->info.selector);
1467                         ctrl->dirty = 1;
1468                 }
1469
1470                 ret = uvc_ctrl_commit_entity(dev, entity, 0);
1471                 if (ret < 0)
1472                         return ret;
1473         }
1474
1475         return 0;
1476 }
1477
1478 /* --------------------------------------------------------------------------
1479  * Control and mapping handling
1480  */
1481
1482 /*
1483  * Add control information to a given control.
1484  */
1485 static int uvc_ctrl_add_info(struct uvc_device *dev, struct uvc_control *ctrl,
1486         const struct uvc_control_info *info)
1487 {
1488         int ret = 0;
1489
1490         memcpy(&ctrl->info, info, sizeof(*info));
1491         INIT_LIST_HEAD(&ctrl->info.mappings);
1492
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,
1495                                  GFP_KERNEL);
1496         if (ctrl->uvc_data == NULL) {
1497                 ret = -ENOMEM;
1498                 goto done;
1499         }
1500
1501         ctrl->initialized = 1;
1502
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);
1506
1507 done:
1508         if (ret < 0)
1509                 kfree(ctrl->uvc_data);
1510         return ret;
1511 }
1512
1513 /*
1514  * Add a control mapping to a given control.
1515  */
1516 static int __uvc_ctrl_add_mapping(struct uvc_device *dev,
1517         struct uvc_control *ctrl, const struct uvc_control_mapping *mapping)
1518 {
1519         struct uvc_control_mapping *map;
1520         unsigned int size;
1521
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.
1525          */
1526         map = kmemdup(mapping, sizeof(*mapping), GFP_KERNEL);
1527         if (map == NULL)
1528                 return -ENOMEM;
1529
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) {
1533                 kfree(map);
1534                 return -ENOMEM;
1535         }
1536
1537         if (map->get == NULL)
1538                 map->get = uvc_get_le_value;
1539         if (map->set == NULL)
1540                 map->set = uvc_set_le_value;
1541
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);
1547
1548         return 0;
1549 }
1550
1551 int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
1552         const struct uvc_control_mapping *mapping)
1553 {
1554         struct uvc_device *dev = chain->dev;
1555         struct uvc_control_mapping *map;
1556         struct uvc_entity *entity;
1557         struct uvc_control *ctrl;
1558         int found = 0;
1559         int ret;
1560
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,
1564                         mapping->id);
1565                 return -EINVAL;
1566         }
1567
1568         /* Search for the matching (GUID/CS) control in the given device */
1569         list_for_each_entry(entity, &dev->entities, list) {
1570                 unsigned int i;
1571
1572                 if (UVC_ENTITY_TYPE(entity) != UVC_VC_EXTENSION_UNIT ||
1573                     !uvc_entity_match_guid(entity, mapping->entity))
1574                         continue;
1575
1576                 for (i = 0; i < entity->ncontrols; ++i) {
1577                         ctrl = &entity->controls[i];
1578                         if (ctrl->index == mapping->selector - 1) {
1579                                 found = 1;
1580                                 break;
1581                         }
1582                 }
1583
1584                 if (found)
1585                         break;
1586         }
1587         if (!found)
1588                 return -ENOENT;
1589
1590         if (mutex_lock_interruptible(&chain->ctrl_mutex))
1591                 return -ERESTARTSYS;
1592
1593         /* Perform delayed initialization of XU controls */
1594         ret = uvc_ctrl_init_xu_ctrl(dev, ctrl);
1595         if (ret < 0) {
1596                 ret = -ENOENT;
1597                 goto done;
1598         }
1599
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);
1605                         ret = -EEXIST;
1606                         goto done;
1607                 }
1608         }
1609
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);
1616                 ret = -ENOMEM;
1617                 goto done;
1618         }
1619
1620         ret = __uvc_ctrl_add_mapping(dev, ctrl, mapping);
1621         if (ret < 0)
1622                 atomic_dec(&dev->nmappings);
1623
1624 done:
1625         mutex_unlock(&chain->ctrl_mutex);
1626         return ret;
1627 }
1628
1629 /*
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.
1633  */
1634 static void uvc_ctrl_prune_entity(struct uvc_device *dev,
1635         struct uvc_entity *entity)
1636 {
1637         struct uvc_ctrl_blacklist {
1638                 struct usb_device_id id;
1639                 u8 index;
1640         };
1641
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 */
1646         };
1647         static const struct uvc_ctrl_blacklist camera_blacklist[] = {
1648                 { { USB_DEVICE(0x06f8, 0x3005) }, 9 }, /* Zoom, Absolute */
1649         };
1650
1651         const struct uvc_ctrl_blacklist *blacklist;
1652         unsigned int size;
1653         unsigned int count;
1654         unsigned int i;
1655         u8 *controls;
1656
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;
1663                 break;
1664
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;
1670                 break;
1671
1672         default:
1673                 return;
1674         }
1675
1676         for (i = 0; i < count; ++i) {
1677                 if (!usb_match_one_id(dev->intf, &blacklist[i].id))
1678                         continue;
1679
1680                 if (blacklist[i].index >= 8 * size ||
1681                     !uvc_test_bit(controls, blacklist[i].index))
1682                         continue;
1683
1684                 uvc_trace(UVC_TRACE_CONTROL, "%u/%u control is black listed, "
1685                         "removing it.\n", entity->id, blacklist[i].index);
1686
1687                 uvc_clear_bit(controls, blacklist[i].index);
1688         }
1689 }
1690
1691 /*
1692  * Add control information and hardcoded stock control mappings to the given
1693  * device.
1694  */
1695 static void uvc_ctrl_init_ctrl(struct uvc_device *dev, struct uvc_control *ctrl)
1696 {
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);
1702
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
1706          * first use.
1707          */
1708         if (UVC_ENTITY_TYPE(ctrl->entity) == UVC_VC_EXTENSION_UNIT)
1709                 return;
1710
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);
1715                         break;
1716                  }
1717         }
1718
1719         if (!ctrl->initialized)
1720                 return;
1721
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);
1726         }
1727 }
1728
1729 /*
1730  * Initialize device controls.
1731  */
1732 int uvc_ctrl_init_device(struct uvc_device *dev)
1733 {
1734         struct uvc_entity *entity;
1735         unsigned int i;
1736
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;
1742
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;
1752                 }
1753
1754                 /* Remove bogus/blacklisted controls */
1755                 uvc_ctrl_prune_entity(dev, entity);
1756
1757                 /* Count supported controls and allocate the controls array */
1758                 for (i = 0; i < bControlSize; ++i)
1759                         ncontrols += hweight8(bmControls[i]);
1760                 if (ncontrols == 0)
1761                         continue;
1762
1763                 entity->controls = kzalloc(ncontrols * sizeof(*ctrl),
1764                                            GFP_KERNEL);
1765                 if (entity->controls == NULL)
1766                         return -ENOMEM;
1767                 entity->ncontrols = ncontrols;
1768
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)
1773                                 continue;
1774
1775                         ctrl->entity = entity;
1776                         ctrl->index = i;
1777
1778                         uvc_ctrl_init_ctrl(dev, ctrl);
1779                         ctrl++;
1780                 }
1781         }
1782
1783         return 0;
1784 }
1785
1786 /*
1787  * Cleanup device controls.
1788  */
1789 static void uvc_ctrl_cleanup_mappings(struct uvc_device *dev,
1790         struct uvc_control *ctrl)
1791 {
1792         struct uvc_control_mapping *mapping, *nm;
1793
1794         list_for_each_entry_safe(mapping, nm, &ctrl->info.mappings, list) {
1795                 list_del(&mapping->list);
1796                 kfree(mapping->menu_info);
1797                 kfree(mapping);
1798         }
1799 }
1800
1801 void uvc_ctrl_cleanup_device(struct uvc_device *dev)
1802 {
1803         struct uvc_entity *entity;
1804         unsigned int i;
1805
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];
1810
1811                         if (!ctrl->initialized)
1812                                 continue;
1813
1814                         uvc_ctrl_cleanup_mappings(dev, ctrl);
1815                         kfree(ctrl->uvc_data);
1816                 }
1817
1818                 kfree(entity->controls);
1819         }
1820 }