Pileus Git - ~andy/linux/blob - drivers/media/v4l2-core/v4l2-ctrls.c

   1 /*
   2     V4L2 controls framework implementation.
   3
   4     Copyright (C) 2010  Hans Verkuil <hverkuil@xs4all.nl>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include <linux/ctype.h>
  22 #include <linux/slab.h>
  23 #include <linux/export.h>
  24 #include <media/v4l2-ioctl.h>
  25 #include <media/v4l2-device.h>
  26 #include <media/v4l2-ctrls.h>
  27 #include <media/v4l2-event.h>
  28 #include <media/v4l2-dev.h>
  29
  30 #define has_op(master, op) \
  31         (master->ops && master->ops->op)
  32 #define call_op(master, op) \
  33         (has_op(master, op) ? master->ops->op(master) : 0)
  34
  35 /* Internal temporary helper struct, one for each v4l2_ext_control */
  36 struct v4l2_ctrl_helper {
  37         /* Pointer to the control reference of the master control */
  38         struct v4l2_ctrl_ref *mref;
  39         /* The control corresponding to the v4l2_ext_control ID field. */
  40         struct v4l2_ctrl *ctrl;
  41         /* v4l2_ext_control index of the next control belonging to the
  42            same cluster, or 0 if there isn't any. */
  43         u32 next;
  44 };
  45
  46 /* Small helper function to determine if the autocluster is set to manual
  47    mode. */
  48 static bool is_cur_manual(const struct v4l2_ctrl *master)
  49 {
  50         return master->is_auto && master->cur.val == master->manual_mode_value;
  51 }
  52
  53 /* Same as above, but this checks the against the new value instead of the
  54    current value. */
  55 static bool is_new_manual(const struct v4l2_ctrl *master)
  56 {
  57         return master->is_auto && master->val == master->manual_mode_value;
  58 }
  59
  60 /* Returns NULL or a character pointer array containing the menu for
  61    the given control ID. The pointer array ends with a NULL pointer.
  62    An empty string signifies a menu entry that is invalid. This allows
  63    drivers to disable certain options if it is not supported. */
  64 const char * const *v4l2_ctrl_get_menu(u32 id)
  65 {
  66         static const char * const mpeg_audio_sampling_freq[] = {
  67                 "44.1 kHz",
  68                 "48 kHz",
  69                 "32 kHz",
  70                 NULL
  71         };
  72         static const char * const mpeg_audio_encoding[] = {
  73                 "MPEG-1/2 Layer I",
  74                 "MPEG-1/2 Layer II",
  75                 "MPEG-1/2 Layer III",
  76                 "MPEG-2/4 AAC",
  77                 "AC-3",
  78                 NULL
  79         };
  80         static const char * const mpeg_audio_l1_bitrate[] = {
  81                 "32 kbps",
  82                 "64 kbps",
  83                 "96 kbps",
  84                 "128 kbps",
  85                 "160 kbps",
  86                 "192 kbps",
  87                 "224 kbps",
  88                 "256 kbps",
  89                 "288 kbps",
  90                 "320 kbps",
  91                 "352 kbps",
  92                 "384 kbps",
  93                 "416 kbps",
  94                 "448 kbps",
  95                 NULL
  96         };
  97         static const char * const mpeg_audio_l2_bitrate[] = {
  98                 "32 kbps",
  99                 "48 kbps",
 100                 "56 kbps",
 101                 "64 kbps",
 102                 "80 kbps",
 103                 "96 kbps",
 104                 "112 kbps",
 105                 "128 kbps",
 106                 "160 kbps",
 107                 "192 kbps",
 108                 "224 kbps",
 109                 "256 kbps",
 110                 "320 kbps",
 111                 "384 kbps",
 112                 NULL
 113         };
 114         static const char * const mpeg_audio_l3_bitrate[] = {
 115                 "32 kbps",
 116                 "40 kbps",
 117                 "48 kbps",
 118                 "56 kbps",
 119                 "64 kbps",
 120                 "80 kbps",
 121                 "96 kbps",
 122                 "112 kbps",
 123                 "128 kbps",
 124                 "160 kbps",
 125                 "192 kbps",
 126                 "224 kbps",
 127                 "256 kbps",
 128                 "320 kbps",
 129                 NULL
 130         };
 131         static const char * const mpeg_audio_ac3_bitrate[] = {
 132                 "32 kbps",
 133                 "40 kbps",
 134                 "48 kbps",
 135                 "56 kbps",
 136                 "64 kbps",
 137                 "80 kbps",
 138                 "96 kbps",
 139                 "112 kbps",
 140                 "128 kbps",
 141                 "160 kbps",
 142                 "192 kbps",
 143                 "224 kbps",
 144                 "256 kbps",
 145                 "320 kbps",
 146                 "384 kbps",
 147                 "448 kbps",
 148                 "512 kbps",
 149                 "576 kbps",
 150                 "640 kbps",
 151                 NULL
 152         };
 153         static const char * const mpeg_audio_mode[] = {
 154                 "Stereo",
 155                 "Joint Stereo",
 156                 "Dual",
 157                 "Mono",
 158                 NULL
 159         };
 160         static const char * const mpeg_audio_mode_extension[] = {
 161                 "Bound 4",
 162                 "Bound 8",
 163                 "Bound 12",
 164                 "Bound 16",
 165                 NULL
 166         };
 167         static const char * const mpeg_audio_emphasis[] = {
 168                 "No Emphasis",
 169                 "50/15 us",
 170                 "CCITT J17",
 171                 NULL
 172         };
 173         static const char * const mpeg_audio_crc[] = {
 174                 "No CRC",
 175                 "16-bit CRC",
 176                 NULL
 177         };
 178         static const char * const mpeg_audio_dec_playback[] = {
 179                 "Auto",
 180                 "Stereo",
 181                 "Left",
 182                 "Right",
 183                 "Mono",
 184                 "Swapped Stereo",
 185                 NULL
 186         };
 187         static const char * const mpeg_video_encoding[] = {
 188                 "MPEG-1",
 189                 "MPEG-2",
 190                 "MPEG-4 AVC",
 191                 NULL
 192         };
 193         static const char * const mpeg_video_aspect[] = {
 194                 "1x1",
 195                 "4x3",
 196                 "16x9",
 197                 "2.21x1",
 198                 NULL
 199         };
 200         static const char * const mpeg_video_bitrate_mode[] = {
 201                 "Variable Bitrate",
 202                 "Constant Bitrate",
 203                 NULL
 204         };
 205         static const char * const mpeg_stream_type[] = {
 206                 "MPEG-2 Program Stream",
 207                 "MPEG-2 Transport Stream",
 208                 "MPEG-1 System Stream",
 209                 "MPEG-2 DVD-compatible Stream",
 210                 "MPEG-1 VCD-compatible Stream",
 211                 "MPEG-2 SVCD-compatible Stream",
 212                 NULL
 213         };
 214         static const char * const mpeg_stream_vbi_fmt[] = {
 215                 "No VBI",
 216                 "Private Packet, IVTV Format",
 217                 NULL
 218         };
 219         static const char * const camera_power_line_frequency[] = {
 220                 "Disabled",
 221                 "50 Hz",
 222                 "60 Hz",
 223                 "Auto",
 224                 NULL
 225         };
 226         static const char * const camera_exposure_auto[] = {
 227                 "Auto Mode",
 228                 "Manual Mode",
 229                 "Shutter Priority Mode",
 230                 "Aperture Priority Mode",
 231                 NULL
 232         };
 233         static const char * const camera_exposure_metering[] = {
 234                 "Average",
 235                 "Center Weighted",
 236                 "Spot",
 237                 "Matrix",
 238                 NULL
 239         };
 240         static const char * const camera_auto_focus_range[] = {
 241                 "Auto",
 242                 "Normal",
 243                 "Macro",
 244                 "Infinity",
 245                 NULL
 246         };
 247         static const char * const colorfx[] = {
 248                 "None",
 249                 "Black & White",
 250                 "Sepia",
 251                 "Negative",
 252                 "Emboss",
 253                 "Sketch",
 254                 "Sky Blue",
 255                 "Grass Green",
 256                 "Skin Whiten",
 257                 "Vivid",
 258                 "Aqua",
 259                 "Art Freeze",
 260                 "Silhouette",
 261                 "Solarization",
 262                 "Antique",
 263                 "Set Cb/Cr",
 264                 NULL
 265         };
 266         static const char * const auto_n_preset_white_balance[] = {
 267                 "Manual",
 268                 "Auto",
 269                 "Incandescent",
 270                 "Fluorescent",
 271                 "Fluorescent H",
 272                 "Horizon",
 273                 "Daylight",
 274                 "Flash",
 275                 "Cloudy",
 276                 "Shade",
 277                 NULL,
 278         };
 279         static const char * const camera_iso_sensitivity_auto[] = {
 280                 "Manual",
 281                 "Auto",
 282                 NULL
 283         };
 284         static const char * const scene_mode[] = {
 285                 "None",
 286                 "Backlight",
 287                 "Beach/Snow",
 288                 "Candle Light",
 289                 "Dusk/Dawn",
 290                 "Fall Colors",
 291                 "Fireworks",
 292                 "Landscape",
 293                 "Night",
 294                 "Party/Indoor",
 295                 "Portrait",
 296                 "Sports",
 297                 "Sunset",
 298                 "Text",
 299                 NULL
 300         };
 301         static const char * const tune_emphasis[] = {
 302                 "None",
 303                 "50 Microseconds",
 304                 "75 Microseconds",
 305                 NULL,
 306         };
 307         static const char * const header_mode[] = {
 308                 "Separate Buffer",
 309                 "Joined With 1st Frame",
 310                 NULL,
 311         };
 312         static const char * const multi_slice[] = {
 313                 "Single",
 314                 "Max Macroblocks",
 315                 "Max Bytes",
 316                 NULL,
 317         };
 318         static const char * const entropy_mode[] = {
 319                 "CAVLC",
 320                 "CABAC",
 321                 NULL,
 322         };
 323         static const char * const mpeg_h264_level[] = {
 324                 "1",
 325                 "1b",
 326                 "1.1",
 327                 "1.2",
 328                 "1.3",
 329                 "2",
 330                 "2.1",
 331                 "2.2",
 332                 "3",
 333                 "3.1",
 334                 "3.2",
 335                 "4",
 336                 "4.1",
 337                 "4.2",
 338                 "5",
 339                 "5.1",
 340                 NULL,
 341         };
 342         static const char * const h264_loop_filter[] = {
 343                 "Enabled",
 344                 "Disabled",
 345                 "Disabled at Slice Boundary",
 346                 NULL,
 347         };
 348         static const char * const h264_profile[] = {
 349                 "Baseline",
 350                 "Constrained Baseline",
 351                 "Main",
 352                 "Extended",
 353                 "High",
 354                 "High 10",
 355                 "High 422",
 356                 "High 444 Predictive",
 357                 "High 10 Intra",
 358                 "High 422 Intra",
 359                 "High 444 Intra",
 360                 "CAVLC 444 Intra",
 361                 "Scalable Baseline",
 362                 "Scalable High",
 363                 "Scalable High Intra",
 364                 "Multiview High",
 365                 NULL,
 366         };
 367         static const char * const vui_sar_idc[] = {
 368                 "Unspecified",
 369                 "1:1",
 370                 "12:11",
 371                 "10:11",
 372                 "16:11",
 373                 "40:33",
 374                 "24:11",
 375                 "20:11",
 376                 "32:11",
 377                 "80:33",
 378                 "18:11",
 379                 "15:11",
 380                 "64:33",
 381                 "160:99",
 382                 "4:3",
 383                 "3:2",
 384                 "2:1",
 385                 "Extended SAR",
 386                 NULL,
 387         };
 388         static const char * const h264_fp_arrangement_type[] = {
 389                 "Checkerboard",
 390                 "Column",
 391                 "Row",
 392                 "Side by Side",
 393                 "Top Bottom",
 394                 "Temporal",
 395                 NULL,
 396         };
 397         static const char * const h264_fmo_map_type[] = {
 398                 "Interleaved Slices",
 399                 "Scattered Slices",
 400                 "Foreground with Leftover",
 401                 "Box Out",
 402                 "Raster Scan",
 403                 "Wipe Scan",
 404                 "Explicit",
 405                 NULL,
 406         };
 407         static const char * const mpeg_mpeg4_level[] = {
 408                 "0",
 409                 "0b",
 410                 "1",
 411                 "2",
 412                 "3",
 413                 "3b",
 414                 "4",
 415                 "5",
 416                 NULL,
 417         };
 418         static const char * const mpeg4_profile[] = {
 419                 "Simple",
 420                 "Advanced Simple",
 421                 "Core",
 422                 "Simple Scalable",
 423                 "Advanced Coding Efficiency",
 424                 NULL,
 425         };
 426
 427         static const char * const vpx_golden_frame_sel[] = {
 428                 "Use Previous Frame",
 429                 "Use Previous Specific Frame",
 430                 NULL,
 431         };
 432
 433         static const char * const flash_led_mode[] = {
 434                 "Off",
 435                 "Flash",
 436                 "Torch",
 437                 NULL,
 438         };
 439         static const char * const flash_strobe_source[] = {
 440                 "Software",
 441                 "External",
 442                 NULL,
 443         };
 444
 445         static const char * const jpeg_chroma_subsampling[] = {
 446                 "4:4:4",
 447                 "4:2:2",
 448                 "4:2:0",
 449                 "4:1:1",
 450                 "4:1:0",
 451                 "Gray",
 452                 NULL,
 453         };
 454         static const char * const dv_tx_mode[] = {
 455                 "DVI-D",
 456                 "HDMI",
 457                 NULL,
 458         };
 459         static const char * const dv_rgb_range[] = {
 460                 "Automatic",
 461                 "RGB limited range (16-235)",
 462                 "RGB full range (0-255)",
 463                 NULL,
 464         };
 465
 466
 467         switch (id) {
 468         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
 469                 return mpeg_audio_sampling_freq;
 470         case V4L2_CID_MPEG_AUDIO_ENCODING:
 471                 return mpeg_audio_encoding;
 472         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
 473                 return mpeg_audio_l1_bitrate;
 474         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
 475                 return mpeg_audio_l2_bitrate;
 476         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
 477                 return mpeg_audio_l3_bitrate;
 478         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
 479                 return mpeg_audio_ac3_bitrate;
 480         case V4L2_CID_MPEG_AUDIO_MODE:
 481                 return mpeg_audio_mode;
 482         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
 483                 return mpeg_audio_mode_extension;
 484         case V4L2_CID_MPEG_AUDIO_EMPHASIS:
 485                 return mpeg_audio_emphasis;
 486         case V4L2_CID_MPEG_AUDIO_CRC:
 487                 return mpeg_audio_crc;
 488         case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
 489         case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
 490                 return mpeg_audio_dec_playback;
 491         case V4L2_CID_MPEG_VIDEO_ENCODING:
 492                 return mpeg_video_encoding;
 493         case V4L2_CID_MPEG_VIDEO_ASPECT:
 494                 return mpeg_video_aspect;
 495         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 496                 return mpeg_video_bitrate_mode;
 497         case V4L2_CID_MPEG_STREAM_TYPE:
 498                 return mpeg_stream_type;
 499         case V4L2_CID_MPEG_STREAM_VBI_FMT:
 500                 return mpeg_stream_vbi_fmt;
 501         case V4L2_CID_POWER_LINE_FREQUENCY:
 502                 return camera_power_line_frequency;
 503         case V4L2_CID_EXPOSURE_AUTO:
 504                 return camera_exposure_auto;
 505         case V4L2_CID_EXPOSURE_METERING:
 506                 return camera_exposure_metering;
 507         case V4L2_CID_AUTO_FOCUS_RANGE:
 508                 return camera_auto_focus_range;
 509         case V4L2_CID_COLORFX:
 510                 return colorfx;
 511         case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
 512                 return auto_n_preset_white_balance;
 513         case V4L2_CID_ISO_SENSITIVITY_AUTO:
 514                 return camera_iso_sensitivity_auto;
 515         case V4L2_CID_SCENE_MODE:
 516                 return scene_mode;
 517         case V4L2_CID_TUNE_PREEMPHASIS:
 518                 return tune_emphasis;
 519         case V4L2_CID_TUNE_DEEMPHASIS:
 520                 return tune_emphasis;
 521         case V4L2_CID_FLASH_LED_MODE:
 522                 return flash_led_mode;
 523         case V4L2_CID_FLASH_STROBE_SOURCE:
 524                 return flash_strobe_source;
 525         case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
 526                 return header_mode;
 527         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
 528                 return multi_slice;
 529         case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
 530                 return entropy_mode;
 531         case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
 532                 return mpeg_h264_level;
 533         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
 534                 return h264_loop_filter;
 535         case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
 536                 return h264_profile;
 537         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
 538                 return vui_sar_idc;
 539         case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
 540                 return h264_fp_arrangement_type;
 541         case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
 542                 return h264_fmo_map_type;
 543         case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
 544                 return mpeg_mpeg4_level;
 545         case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
 546                 return mpeg4_profile;
 547         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
 548                 return vpx_golden_frame_sel;
 549         case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
 550                 return jpeg_chroma_subsampling;
 551         case V4L2_CID_DV_TX_MODE:
 552                 return dv_tx_mode;
 553         case V4L2_CID_DV_TX_RGB_RANGE:
 554         case V4L2_CID_DV_RX_RGB_RANGE:
 555                 return dv_rgb_range;
 556
 557         default:
 558                 return NULL;
 559         }
 560 }
 561 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
 562
 563 #define __v4l2_qmenu_int_len(arr, len) ({ *(len) = ARRAY_SIZE(arr); arr; })
 564 /*
 565  * Returns NULL or an s64 type array containing the menu for given
 566  * control ID. The total number of the menu items is returned in @len.
 567  */
 568 const s64 *v4l2_ctrl_get_int_menu(u32 id, u32 *len)
 569 {
 570         static const s64 qmenu_int_vpx_num_partitions[] = {
 571                 1, 2, 4, 8,
 572         };
 573
 574         static const s64 qmenu_int_vpx_num_ref_frames[] = {
 575                 1, 2, 3,
 576         };
 577
 578         switch (id) {
 579         case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
 580                 return __v4l2_qmenu_int_len(qmenu_int_vpx_num_partitions, len);
 581         case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
 582                 return __v4l2_qmenu_int_len(qmenu_int_vpx_num_ref_frames, len);
 583         default:
 584                 *len = 0;
 585                 return NULL;
 586         }
 587 }
 588 EXPORT_SYMBOL(v4l2_ctrl_get_int_menu);
 589
 590 /* Return the control name. */
 591 const char *v4l2_ctrl_get_name(u32 id)
 592 {
 593         switch (id) {
 594         /* USER controls */
 595         /* Keep the order of the 'case's the same as in videodev2.h! */
 596         case V4L2_CID_USER_CLASS:               return "User Controls";
 597         case V4L2_CID_BRIGHTNESS:               return "Brightness";
 598         case V4L2_CID_CONTRAST:                 return "Contrast";
 599         case V4L2_CID_SATURATION:               return "Saturation";
 600         case V4L2_CID_HUE:                      return "Hue";
 601         case V4L2_CID_AUDIO_VOLUME:             return "Volume";
 602         case V4L2_CID_AUDIO_BALANCE:            return "Balance";
 603         case V4L2_CID_AUDIO_BASS:               return "Bass";
 604         case V4L2_CID_AUDIO_TREBLE:             return "Treble";
 605         case V4L2_CID_AUDIO_MUTE:               return "Mute";
 606         case V4L2_CID_AUDIO_LOUDNESS:           return "Loudness";
 607         case V4L2_CID_BLACK_LEVEL:              return "Black Level";
 608         case V4L2_CID_AUTO_WHITE_BALANCE:       return "White Balance, Automatic";
 609         case V4L2_CID_DO_WHITE_BALANCE:         return "Do White Balance";
 610         case V4L2_CID_RED_BALANCE:              return "Red Balance";
 611         case V4L2_CID_BLUE_BALANCE:             return "Blue Balance";
 612         case V4L2_CID_GAMMA:                    return "Gamma";
 613         case V4L2_CID_EXPOSURE:                 return "Exposure";
 614         case V4L2_CID_AUTOGAIN:                 return "Gain, Automatic";
 615         case V4L2_CID_GAIN:                     return "Gain";
 616         case V4L2_CID_HFLIP:                    return "Horizontal Flip";
 617         case V4L2_CID_VFLIP:                    return "Vertical Flip";
 618         case V4L2_CID_POWER_LINE_FREQUENCY:     return "Power Line Frequency";
 619         case V4L2_CID_HUE_AUTO:                 return "Hue, Automatic";
 620         case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
 621         case V4L2_CID_SHARPNESS:                return "Sharpness";
 622         case V4L2_CID_BACKLIGHT_COMPENSATION:   return "Backlight Compensation";
 623         case V4L2_CID_CHROMA_AGC:               return "Chroma AGC";
 624         case V4L2_CID_COLOR_KILLER:             return "Color Killer";
 625         case V4L2_CID_COLORFX:                  return "Color Effects";
 626         case V4L2_CID_AUTOBRIGHTNESS:           return "Brightness, Automatic";
 627         case V4L2_CID_BAND_STOP_FILTER:         return "Band-Stop Filter";
 628         case V4L2_CID_ROTATE:                   return "Rotate";
 629         case V4L2_CID_BG_COLOR:                 return "Background Color";
 630         case V4L2_CID_CHROMA_GAIN:              return "Chroma Gain";
 631         case V4L2_CID_ILLUMINATORS_1:           return "Illuminator 1";
 632         case V4L2_CID_ILLUMINATORS_2:           return "Illuminator 2";
 633         case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:  return "Min Number of Capture Buffers";
 634         case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:   return "Min Number of Output Buffers";
 635         case V4L2_CID_ALPHA_COMPONENT:          return "Alpha Component";
 636         case V4L2_CID_COLORFX_CBCR:             return "Color Effects, CbCr";
 637
 638         /* Codec controls */
 639         /* The MPEG controls are applicable to all codec controls
 640          * and the 'MPEG' part of the define is historical */
 641         /* Keep the order of the 'case's the same as in videodev2.h! */
 642         case V4L2_CID_MPEG_CLASS:               return "Codec Controls";
 643         case V4L2_CID_MPEG_STREAM_TYPE:         return "Stream Type";
 644         case V4L2_CID_MPEG_STREAM_PID_PMT:      return "Stream PMT Program ID";
 645         case V4L2_CID_MPEG_STREAM_PID_AUDIO:    return "Stream Audio Program ID";
 646         case V4L2_CID_MPEG_STREAM_PID_VIDEO:    return "Stream Video Program ID";
 647         case V4L2_CID_MPEG_STREAM_PID_PCR:      return "Stream PCR Program ID";
 648         case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
 649         case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
 650         case V4L2_CID_MPEG_STREAM_VBI_FMT:      return "Stream VBI Format";
 651         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
 652         case V4L2_CID_MPEG_AUDIO_ENCODING:      return "Audio Encoding";
 653         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:    return "Audio Layer I Bitrate";
 654         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:    return "Audio Layer II Bitrate";
 655         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:    return "Audio Layer III Bitrate";
 656         case V4L2_CID_MPEG_AUDIO_MODE:          return "Audio Stereo Mode";
 657         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
 658         case V4L2_CID_MPEG_AUDIO_EMPHASIS:      return "Audio Emphasis";
 659         case V4L2_CID_MPEG_AUDIO_CRC:           return "Audio CRC";
 660         case V4L2_CID_MPEG_AUDIO_MUTE:          return "Audio Mute";
 661         case V4L2_CID_MPEG_AUDIO_AAC_BITRATE:   return "Audio AAC Bitrate";
 662         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:   return "Audio AC-3 Bitrate";
 663         case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:  return "Audio Playback";
 664         case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
 665         case V4L2_CID_MPEG_VIDEO_ENCODING:      return "Video Encoding";
 666         case V4L2_CID_MPEG_VIDEO_ASPECT:        return "Video Aspect";
 667         case V4L2_CID_MPEG_VIDEO_B_FRAMES:      return "Video B Frames";
 668         case V4L2_CID_MPEG_VIDEO_GOP_SIZE:      return "Video GOP Size";
 669         case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:   return "Video GOP Closure";
 670         case V4L2_CID_MPEG_VIDEO_PULLDOWN:      return "Video Pulldown";
 671         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:  return "Video Bitrate Mode";
 672         case V4L2_CID_MPEG_VIDEO_BITRATE:       return "Video Bitrate";
 673         case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK:  return "Video Peak Bitrate";
 674         case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
 675         case V4L2_CID_MPEG_VIDEO_MUTE:          return "Video Mute";
 676         case V4L2_CID_MPEG_VIDEO_MUTE_YUV:      return "Video Mute YUV";
 677         case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:       return "Decoder Slice Interface";
 678         case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:  return "MPEG4 Loop Filter Enable";
 679         case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB:       return "Number of Intra Refresh MBs";
 680         case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:               return "Frame Level Rate Control Enable";
 681         case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:                  return "H264 MB Level Rate Control";
 682         case V4L2_CID_MPEG_VIDEO_HEADER_MODE:                   return "Sequence Header Mode";
 683         case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC:                   return "Max Number of Reference Pics";
 684         case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP:               return "H263 I-Frame QP Value";
 685         case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP:               return "H263 P-Frame QP Value";
 686         case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP:               return "H263 B-Frame QP Value";
 687         case V4L2_CID_MPEG_VIDEO_H263_MIN_QP:                   return "H263 Minimum QP Value";
 688         case V4L2_CID_MPEG_VIDEO_H263_MAX_QP:                   return "H263 Maximum QP Value";
 689         case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP:               return "H264 I-Frame QP Value";
 690         case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP:               return "H264 P-Frame QP Value";
 691         case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP:               return "H264 B-Frame QP Value";
 692         case V4L2_CID_MPEG_VIDEO_H264_MAX_QP:                   return "H264 Maximum QP Value";
 693         case V4L2_CID_MPEG_VIDEO_H264_MIN_QP:                   return "H264 Minimum QP Value";
 694         case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:            return "H264 8x8 Transform Enable";
 695         case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE:                 return "H264 CPB Buffer Size";
 696         case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:             return "H264 Entropy Mode";
 697         case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD:                 return "H264 I-Frame Period";
 698         case V4L2_CID_MPEG_VIDEO_H264_LEVEL:                    return "H264 Level";
 699         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA:        return "H264 Loop Filter Alpha Offset";
 700         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA:         return "H264 Loop Filter Beta Offset";
 701         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:         return "H264 Loop Filter Mode";
 702         case V4L2_CID_MPEG_VIDEO_H264_PROFILE:                  return "H264 Profile";
 703         case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT:       return "Vertical Size of SAR";
 704         case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH:        return "Horizontal Size of SAR";
 705         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:           return "Aspect Ratio VUI Enable";
 706         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:              return "VUI Aspect Ratio IDC";
 707         case V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING:        return "H264 Enable Frame Packing SEI";
 708         case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0:   return "H264 Set Curr. Frame as Frame0";
 709         case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:  return "H264 FP Arrangement Type";
 710         case V4L2_CID_MPEG_VIDEO_H264_FMO:                      return "H264 Flexible MB Ordering";
 711         case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:             return "H264 Map Type for FMO";
 712         case V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP:          return "H264 FMO Number of Slice Groups";
 713         case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION:     return "H264 FMO Direction of Change";
 714         case V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE:          return "H264 FMO Size of 1st Slice Grp";
 715         case V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH:           return "H264 FMO No. of Consecutive MBs";
 716         case V4L2_CID_MPEG_VIDEO_H264_ASO:                      return "H264 Arbitrary Slice Ordering";
 717         case V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER:          return "H264 ASO Slice Order";
 718         case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING:      return "Enable H264 Hierarchical Coding";
 719         case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE: return "H264 Hierarchical Coding Type";
 720         case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER:return "H264 Number of HC Layers";
 721         case V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP:
 722                                                                 return "H264 Set QP Value for HC Layers";
 723         case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP:              return "MPEG4 I-Frame QP Value";
 724         case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP:              return "MPEG4 P-Frame QP Value";
 725         case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP:              return "MPEG4 B-Frame QP Value";
 726         case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP:                  return "MPEG4 Minimum QP Value";
 727         case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP:                  return "MPEG4 Maximum QP Value";
 728         case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:                   return "MPEG4 Level";
 729         case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:                 return "MPEG4 Profile";
 730         case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:                    return "Quarter Pixel Search Enable";
 731         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES:         return "Maximum Bytes in a Slice";
 732         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB:            return "Number of MBs in a Slice";
 733         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:              return "Slice Partitioning Method";
 734         case V4L2_CID_MPEG_VIDEO_VBV_SIZE:                      return "VBV Buffer Size";
 735         case V4L2_CID_MPEG_VIDEO_DEC_PTS:                       return "Video Decoder PTS";
 736         case V4L2_CID_MPEG_VIDEO_DEC_FRAME:                     return "Video Decoder Frame Count";
 737         case V4L2_CID_MPEG_VIDEO_VBV_DELAY:                     return "Initial Delay for VBV Control";
 738         case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:             return "Repeat Sequence Header";
 739
 740         /* VPX controls */
 741         case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:            return "VPX Number of Partitions";
 742         case V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4:           return "VPX Intra Mode Decision Disable";
 743         case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:            return "VPX No. of Refs for P Frame";
 744         case V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL:              return "VPX Loop Filter Level Range";
 745         case V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS:          return "VPX Deblocking Effect Control";
 746         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD:   return "VPX Golden Frame Refresh Period";
 747         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:          return "VPX Golden Frame Indicator";
 748         case V4L2_CID_MPEG_VIDEO_VPX_MIN_QP:                    return "VPX Minimum QP Value";
 749         case V4L2_CID_MPEG_VIDEO_VPX_MAX_QP:                    return "VPX Maximum QP Value";
 750         case V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP:                return "VPX I-Frame QP Value";
 751         case V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP:                return "VPX P-Frame QP Value";
 752         case V4L2_CID_MPEG_VIDEO_VPX_PROFILE:                   return "VPX Profile";
 753
 754         /* CAMERA controls */
 755         /* Keep the order of the 'case's the same as in videodev2.h! */
 756         case V4L2_CID_CAMERA_CLASS:             return "Camera Controls";
 757         case V4L2_CID_EXPOSURE_AUTO:            return "Auto Exposure";
 758         case V4L2_CID_EXPOSURE_ABSOLUTE:        return "Exposure Time, Absolute";
 759         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:   return "Exposure, Dynamic Framerate";
 760         case V4L2_CID_PAN_RELATIVE:             return "Pan, Relative";
 761         case V4L2_CID_TILT_RELATIVE:            return "Tilt, Relative";
 762         case V4L2_CID_PAN_RESET:                return "Pan, Reset";
 763         case V4L2_CID_TILT_RESET:               return "Tilt, Reset";
 764         case V4L2_CID_PAN_ABSOLUTE:             return "Pan, Absolute";
 765         case V4L2_CID_TILT_ABSOLUTE:            return "Tilt, Absolute";
 766         case V4L2_CID_FOCUS_ABSOLUTE:           return "Focus, Absolute";
 767         case V4L2_CID_FOCUS_RELATIVE:           return "Focus, Relative";
 768         case V4L2_CID_FOCUS_AUTO:               return "Focus, Automatic Continuous";
 769         case V4L2_CID_ZOOM_ABSOLUTE:            return "Zoom, Absolute";
 770         case V4L2_CID_ZOOM_RELATIVE:            return "Zoom, Relative";
 771         case V4L2_CID_ZOOM_CONTINUOUS:          return "Zoom, Continuous";
 772         case V4L2_CID_PRIVACY:                  return "Privacy";
 773         case V4L2_CID_IRIS_ABSOLUTE:            return "Iris, Absolute";
 774         case V4L2_CID_IRIS_RELATIVE:            return "Iris, Relative";
 775         case V4L2_CID_AUTO_EXPOSURE_BIAS:       return "Auto Exposure, Bias";
 776         case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
 777         case V4L2_CID_WIDE_DYNAMIC_RANGE:       return "Wide Dynamic Range";
 778         case V4L2_CID_IMAGE_STABILIZATION:      return "Image Stabilization";
 779         case V4L2_CID_ISO_SENSITIVITY:          return "ISO Sensitivity";
 780         case V4L2_CID_ISO_SENSITIVITY_AUTO:     return "ISO Sensitivity, Auto";
 781         case V4L2_CID_EXPOSURE_METERING:        return "Exposure, Metering Mode";
 782         case V4L2_CID_SCENE_MODE:               return "Scene Mode";
 783         case V4L2_CID_3A_LOCK:                  return "3A Lock";
 784         case V4L2_CID_AUTO_FOCUS_START:         return "Auto Focus, Start";
 785         case V4L2_CID_AUTO_FOCUS_STOP:          return "Auto Focus, Stop";
 786         case V4L2_CID_AUTO_FOCUS_STATUS:        return "Auto Focus, Status";
 787         case V4L2_CID_AUTO_FOCUS_RANGE:         return "Auto Focus, Range";
 788
 789         /* FM Radio Modulator control */
 790         /* Keep the order of the 'case's the same as in videodev2.h! */
 791         case V4L2_CID_FM_TX_CLASS:              return "FM Radio Modulator Controls";
 792         case V4L2_CID_RDS_TX_DEVIATION:         return "RDS Signal Deviation";
 793         case V4L2_CID_RDS_TX_PI:                return "RDS Program ID";
 794         case V4L2_CID_RDS_TX_PTY:               return "RDS Program Type";
 795         case V4L2_CID_RDS_TX_PS_NAME:           return "RDS PS Name";
 796         case V4L2_CID_RDS_TX_RADIO_TEXT:        return "RDS Radio Text";
 797         case V4L2_CID_AUDIO_LIMITER_ENABLED:    return "Audio Limiter Feature Enabled";
 798         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
 799         case V4L2_CID_AUDIO_LIMITER_DEVIATION:  return "Audio Limiter Deviation";
 800         case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
 801         case V4L2_CID_AUDIO_COMPRESSION_GAIN:   return "Audio Compression Gain";
 802         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
 803         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
 804         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
 805         case V4L2_CID_PILOT_TONE_ENABLED:       return "Pilot Tone Feature Enabled";
 806         case V4L2_CID_PILOT_TONE_DEVIATION:     return "Pilot Tone Deviation";
 807         case V4L2_CID_PILOT_TONE_FREQUENCY:     return "Pilot Tone Frequency";
 808         case V4L2_CID_TUNE_PREEMPHASIS:         return "Pre-Emphasis";
 809         case V4L2_CID_TUNE_POWER_LEVEL:         return "Tune Power Level";
 810         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:   return "Tune Antenna Capacitor";
 811
 812         /* Flash controls */
 813         case V4L2_CID_FLASH_CLASS:              return "Flash Controls";
 814         case V4L2_CID_FLASH_LED_MODE:           return "LED Mode";
 815         case V4L2_CID_FLASH_STROBE_SOURCE:      return "Strobe Source";
 816         case V4L2_CID_FLASH_STROBE:             return "Strobe";
 817         case V4L2_CID_FLASH_STROBE_STOP:        return "Stop Strobe";
 818         case V4L2_CID_FLASH_STROBE_STATUS:      return "Strobe Status";
 819         case V4L2_CID_FLASH_TIMEOUT:            return "Strobe Timeout";
 820         case V4L2_CID_FLASH_INTENSITY:          return "Intensity, Flash Mode";
 821         case V4L2_CID_FLASH_TORCH_INTENSITY:    return "Intensity, Torch Mode";
 822         case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
 823         case V4L2_CID_FLASH_FAULT:              return "Faults";
 824         case V4L2_CID_FLASH_CHARGE:             return "Charge";
 825         case V4L2_CID_FLASH_READY:              return "Ready to Strobe";
 826
 827         /* JPEG encoder controls */
 828         /* Keep the order of the 'case's the same as in videodev2.h! */
 829         case V4L2_CID_JPEG_CLASS:               return "JPEG Compression Controls";
 830         case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:  return "Chroma Subsampling";
 831         case V4L2_CID_JPEG_RESTART_INTERVAL:    return "Restart Interval";
 832         case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
 833         case V4L2_CID_JPEG_ACTIVE_MARKER:       return "Active Markers";
 834
 835         /* Image source controls */
 836         case V4L2_CID_IMAGE_SOURCE_CLASS:       return "Image Source Controls";
 837         case V4L2_CID_VBLANK:                   return "Vertical Blanking";
 838         case V4L2_CID_HBLANK:                   return "Horizontal Blanking";
 839         case V4L2_CID_ANALOGUE_GAIN:            return "Analogue Gain";
 840
 841         /* Image processing controls */
 842         case V4L2_CID_IMAGE_PROC_CLASS:         return "Image Processing Controls";
 843         case V4L2_CID_LINK_FREQ:                return "Link Frequency";
 844         case V4L2_CID_PIXEL_RATE:               return "Pixel Rate";
 845         case V4L2_CID_TEST_PATTERN:             return "Test Pattern";
 846
 847         /* DV controls */
 848         case V4L2_CID_DV_CLASS:                 return "Digital Video Controls";
 849         case V4L2_CID_DV_TX_HOTPLUG:            return "Hotplug Present";
 850         case V4L2_CID_DV_TX_RXSENSE:            return "RxSense Present";
 851         case V4L2_CID_DV_TX_EDID_PRESENT:       return "EDID Present";
 852         case V4L2_CID_DV_TX_MODE:               return "Transmit Mode";
 853         case V4L2_CID_DV_TX_RGB_RANGE:          return "Tx RGB Quantization Range";
 854         case V4L2_CID_DV_RX_POWER_PRESENT:      return "Power Present";
 855         case V4L2_CID_DV_RX_RGB_RANGE:          return "Rx RGB Quantization Range";
 856
 857         case V4L2_CID_FM_RX_CLASS:              return "FM Radio Receiver Controls";
 858         case V4L2_CID_TUNE_DEEMPHASIS:          return "De-Emphasis";
 859         case V4L2_CID_RDS_RECEPTION:            return "RDS Reception";
 860         default:
 861                 return NULL;
 862         }
 863 }
 864 EXPORT_SYMBOL(v4l2_ctrl_get_name);
 865
 866 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
 867                     s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
 868 {
 869         *name = v4l2_ctrl_get_name(id);
 870         *flags = 0;
 871
 872         switch (id) {
 873         case V4L2_CID_AUDIO_MUTE:
 874         case V4L2_CID_AUDIO_LOUDNESS:
 875         case V4L2_CID_AUTO_WHITE_BALANCE:
 876         case V4L2_CID_AUTOGAIN:
 877         case V4L2_CID_HFLIP:
 878         case V4L2_CID_VFLIP:
 879         case V4L2_CID_HUE_AUTO:
 880         case V4L2_CID_CHROMA_AGC:
 881         case V4L2_CID_COLOR_KILLER:
 882         case V4L2_CID_AUTOBRIGHTNESS:
 883         case V4L2_CID_MPEG_AUDIO_MUTE:
 884         case V4L2_CID_MPEG_VIDEO_MUTE:
 885         case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
 886         case V4L2_CID_MPEG_VIDEO_PULLDOWN:
 887         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
 888         case V4L2_CID_FOCUS_AUTO:
 889         case V4L2_CID_PRIVACY:
 890         case V4L2_CID_AUDIO_LIMITER_ENABLED:
 891         case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
 892         case V4L2_CID_PILOT_TONE_ENABLED:
 893         case V4L2_CID_ILLUMINATORS_1:
 894         case V4L2_CID_ILLUMINATORS_2:
 895         case V4L2_CID_FLASH_STROBE_STATUS:
 896         case V4L2_CID_FLASH_CHARGE:
 897         case V4L2_CID_FLASH_READY:
 898         case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
 899         case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
 900         case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
 901         case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
 902         case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
 903         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
 904         case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
 905         case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:
 906         case V4L2_CID_WIDE_DYNAMIC_RANGE:
 907         case V4L2_CID_IMAGE_STABILIZATION:
 908         case V4L2_CID_RDS_RECEPTION:
 909                 *type = V4L2_CTRL_TYPE_BOOLEAN;
 910                 *min = 0;
 911                 *max = *step = 1;
 912                 break;
 913         case V4L2_CID_PAN_RESET:
 914         case V4L2_CID_TILT_RESET:
 915         case V4L2_CID_FLASH_STROBE:
 916         case V4L2_CID_FLASH_STROBE_STOP:
 917         case V4L2_CID_AUTO_FOCUS_START:
 918         case V4L2_CID_AUTO_FOCUS_STOP:
 919                 *type = V4L2_CTRL_TYPE_BUTTON;
 920                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
 921                 *min = *max = *step = *def = 0;
 922                 break;
 923         case V4L2_CID_POWER_LINE_FREQUENCY:
 924         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
 925         case V4L2_CID_MPEG_AUDIO_ENCODING:
 926         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
 927         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
 928         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
 929         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
 930         case V4L2_CID_MPEG_AUDIO_MODE:
 931         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
 932         case V4L2_CID_MPEG_AUDIO_EMPHASIS:
 933         case V4L2_CID_MPEG_AUDIO_CRC:
 934         case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
 935         case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
 936         case V4L2_CID_MPEG_VIDEO_ENCODING:
 937         case V4L2_CID_MPEG_VIDEO_ASPECT:
 938         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 939         case V4L2_CID_MPEG_STREAM_TYPE:
 940         case V4L2_CID_MPEG_STREAM_VBI_FMT:
 941         case V4L2_CID_EXPOSURE_AUTO:
 942         case V4L2_CID_AUTO_FOCUS_RANGE:
 943         case V4L2_CID_COLORFX:
 944         case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
 945         case V4L2_CID_TUNE_PREEMPHASIS:
 946         case V4L2_CID_FLASH_LED_MODE:
 947         case V4L2_CID_FLASH_STROBE_SOURCE:
 948         case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
 949         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
 950         case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
 951         case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
 952         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
 953         case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
 954         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
 955         case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
 956         case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
 957         case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
 958         case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
 959         case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
 960         case V4L2_CID_ISO_SENSITIVITY_AUTO:
 961         case V4L2_CID_EXPOSURE_METERING:
 962         case V4L2_CID_SCENE_MODE:
 963         case V4L2_CID_DV_TX_MODE:
 964         case V4L2_CID_DV_TX_RGB_RANGE:
 965         case V4L2_CID_DV_RX_RGB_RANGE:
 966         case V4L2_CID_TEST_PATTERN:
 967         case V4L2_CID_TUNE_DEEMPHASIS:
 968         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
 969                 *type = V4L2_CTRL_TYPE_MENU;
 970                 break;
 971         case V4L2_CID_LINK_FREQ:
 972                 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
 973                 break;
 974         case V4L2_CID_RDS_TX_PS_NAME:
 975         case V4L2_CID_RDS_TX_RADIO_TEXT:
 976                 *type = V4L2_CTRL_TYPE_STRING;
 977                 break;
 978         case V4L2_CID_ISO_SENSITIVITY:
 979         case V4L2_CID_AUTO_EXPOSURE_BIAS:
 980         case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
 981         case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
 982                 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
 983                 break;
 984         case V4L2_CID_USER_CLASS:
 985         case V4L2_CID_CAMERA_CLASS:
 986         case V4L2_CID_MPEG_CLASS:
 987         case V4L2_CID_FM_TX_CLASS:
 988         case V4L2_CID_FLASH_CLASS:
 989         case V4L2_CID_JPEG_CLASS:
 990         case V4L2_CID_IMAGE_SOURCE_CLASS:
 991         case V4L2_CID_IMAGE_PROC_CLASS:
 992         case V4L2_CID_DV_CLASS:
 993         case V4L2_CID_FM_RX_CLASS:
 994                 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
 995                 /* You can neither read not write these */
 996                 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
 997                 *min = *max = *step = *def = 0;
 998                 break;
 999         case V4L2_CID_BG_COLOR:
1000                 *type = V4L2_CTRL_TYPE_INTEGER;
1001                 *step = 1;
1002                 *min = 0;
1003                 /* Max is calculated as RGB888 that is 2^24 */
1004                 *max = 0xFFFFFF;
1005                 break;
1006         case V4L2_CID_FLASH_FAULT:
1007         case V4L2_CID_JPEG_ACTIVE_MARKER:
1008         case V4L2_CID_3A_LOCK:
1009         case V4L2_CID_AUTO_FOCUS_STATUS:
1010         case V4L2_CID_DV_TX_HOTPLUG:
1011         case V4L2_CID_DV_TX_RXSENSE:
1012         case V4L2_CID_DV_TX_EDID_PRESENT:
1013         case V4L2_CID_DV_RX_POWER_PRESENT:
1014                 *type = V4L2_CTRL_TYPE_BITMASK;
1015                 break;
1016         case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
1017         case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
1018                 *type = V4L2_CTRL_TYPE_INTEGER;
1019                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1020                 break;
1021         case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
1022         case V4L2_CID_MPEG_VIDEO_DEC_PTS:
1023                 *flags |= V4L2_CTRL_FLAG_VOLATILE;
1024                 /* Fall through */
1025         case V4L2_CID_PIXEL_RATE:
1026                 *type = V4L2_CTRL_TYPE_INTEGER64;
1027                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1028                 *min = *max = *step = *def = 0;
1029                 break;
1030         default:
1031                 *type = V4L2_CTRL_TYPE_INTEGER;
1032                 break;
1033         }
1034         switch (id) {
1035         case V4L2_CID_MPEG_AUDIO_ENCODING:
1036         case V4L2_CID_MPEG_AUDIO_MODE:
1037         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1038         case V4L2_CID_MPEG_VIDEO_B_FRAMES:
1039         case V4L2_CID_MPEG_STREAM_TYPE:
1040                 *flags |= V4L2_CTRL_FLAG_UPDATE;
1041                 break;
1042         case V4L2_CID_AUDIO_VOLUME:
1043         case V4L2_CID_AUDIO_BALANCE:
1044         case V4L2_CID_AUDIO_BASS:
1045         case V4L2_CID_AUDIO_TREBLE:
1046         case V4L2_CID_BRIGHTNESS:
1047         case V4L2_CID_CONTRAST:
1048         case V4L2_CID_SATURATION:
1049         case V4L2_CID_HUE:
1050         case V4L2_CID_RED_BALANCE:
1051         case V4L2_CID_BLUE_BALANCE:
1052         case V4L2_CID_GAMMA:
1053         case V4L2_CID_SHARPNESS:
1054         case V4L2_CID_CHROMA_GAIN:
1055         case V4L2_CID_RDS_TX_DEVIATION:
1056         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
1057         case V4L2_CID_AUDIO_LIMITER_DEVIATION:
1058         case V4L2_CID_AUDIO_COMPRESSION_GAIN:
1059         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
1060         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
1061         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
1062         case V4L2_CID_PILOT_TONE_DEVIATION:
1063         case V4L2_CID_PILOT_TONE_FREQUENCY:
1064         case V4L2_CID_TUNE_POWER_LEVEL:
1065         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
1066                 *flags |= V4L2_CTRL_FLAG_SLIDER;
1067                 break;
1068         case V4L2_CID_PAN_RELATIVE:
1069         case V4L2_CID_TILT_RELATIVE:
1070         case V4L2_CID_FOCUS_RELATIVE:
1071         case V4L2_CID_IRIS_RELATIVE:
1072         case V4L2_CID_ZOOM_RELATIVE:
1073                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1074                 break;
1075         case V4L2_CID_FLASH_STROBE_STATUS:
1076         case V4L2_CID_AUTO_FOCUS_STATUS:
1077         case V4L2_CID_FLASH_READY:
1078         case V4L2_CID_DV_TX_HOTPLUG:
1079         case V4L2_CID_DV_TX_RXSENSE:
1080         case V4L2_CID_DV_TX_EDID_PRESENT:
1081         case V4L2_CID_DV_RX_POWER_PRESENT:
1082                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1083                 break;
1084         }
1085 }
1086 EXPORT_SYMBOL(v4l2_ctrl_fill);
1087
1088 /* Helper function to determine whether the control type is compatible with
1089    VIDIOC_G/S_CTRL. */
1090 static bool type_is_int(const struct v4l2_ctrl *ctrl)
1091 {
1092         switch (ctrl->type) {
1093         case V4L2_CTRL_TYPE_INTEGER64:
1094         case V4L2_CTRL_TYPE_STRING:
1095                 /* Nope, these need v4l2_ext_control */
1096                 return false;
1097         default:
1098                 return true;
1099         }
1100 }
1101
1102 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
1103 {
1104         memset(ev->reserved, 0, sizeof(ev->reserved));
1105         ev->type = V4L2_EVENT_CTRL;
1106         ev->id = ctrl->id;
1107         ev->u.ctrl.changes = changes;
1108         ev->u.ctrl.type = ctrl->type;
1109         ev->u.ctrl.flags = ctrl->flags;
1110         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
1111                 ev->u.ctrl.value64 = 0;
1112         else
1113                 ev->u.ctrl.value64 = ctrl->cur.val64;
1114         ev->u.ctrl.minimum = ctrl->minimum;
1115         ev->u.ctrl.maximum = ctrl->maximum;
1116         if (ctrl->type == V4L2_CTRL_TYPE_MENU
1117             || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1118                 ev->u.ctrl.step = 1;
1119         else
1120                 ev->u.ctrl.step = ctrl->step;
1121         ev->u.ctrl.default_value = ctrl->default_value;
1122 }
1123
1124 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1125 {
1126         struct v4l2_event ev;
1127         struct v4l2_subscribed_event *sev;
1128
1129         if (list_empty(&ctrl->ev_subs))
1130                 return;
1131         fill_event(&ev, ctrl, changes);
1132
1133         list_for_each_entry(sev, &ctrl->ev_subs, node)
1134                 if (sev->fh != fh ||
1135                     (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
1136                         v4l2_event_queue_fh(sev->fh, &ev);
1137 }
1138
1139 /* Helper function: copy the current control value back to the caller */
1140 static int cur_to_user(struct v4l2_ext_control *c,
1141                        struct v4l2_ctrl *ctrl)
1142 {
1143         u32 len;
1144
1145         switch (ctrl->type) {
1146         case V4L2_CTRL_TYPE_STRING:
1147                 len = strlen(ctrl->cur.string);
1148                 if (c->size < len + 1) {
1149                         c->size = len + 1;
1150                         return -ENOSPC;
1151                 }
1152                 return copy_to_user(c->string, ctrl->cur.string,
1153                                                 len + 1) ? -EFAULT : 0;
1154         case V4L2_CTRL_TYPE_INTEGER64:
1155                 c->value64 = ctrl->cur.val64;
1156                 break;
1157         default:
1158                 c->value = ctrl->cur.val;
1159                 break;
1160         }
1161         return 0;
1162 }
1163
1164 /* Helper function: copy the caller-provider value as the new control value */
1165 static int user_to_new(struct v4l2_ext_control *c,
1166                        struct v4l2_ctrl *ctrl)
1167 {
1168         int ret;
1169         u32 size;
1170
1171         ctrl->is_new = 1;
1172         switch (ctrl->type) {
1173         case V4L2_CTRL_TYPE_INTEGER64:
1174                 ctrl->val64 = c->value64;
1175                 break;
1176         case V4L2_CTRL_TYPE_STRING:
1177                 size = c->size;
1178                 if (size == 0)
1179                         return -ERANGE;
1180                 if (size > ctrl->maximum + 1)
1181                         size = ctrl->maximum + 1;
1182                 ret = copy_from_user(ctrl->string, c->string, size);
1183                 if (!ret) {
1184                         char last = ctrl->string[size - 1];
1185
1186                         ctrl->string[size - 1] = 0;
1187                         /* If the string was longer than ctrl->maximum,
1188                            then return an error. */
1189                         if (strlen(ctrl->string) == ctrl->maximum && last)
1190                                 return -ERANGE;
1191                 }
1192                 return ret ? -EFAULT : 0;
1193         default:
1194                 ctrl->val = c->value;
1195                 break;
1196         }
1197         return 0;
1198 }
1199
1200 /* Helper function: copy the new control value back to the caller */
1201 static int new_to_user(struct v4l2_ext_control *c,
1202                        struct v4l2_ctrl *ctrl)
1203 {
1204         u32 len;
1205
1206         switch (ctrl->type) {
1207         case V4L2_CTRL_TYPE_STRING:
1208                 len = strlen(ctrl->string);
1209                 if (c->size < len + 1) {
1210                         c->size = ctrl->maximum + 1;
1211                         return -ENOSPC;
1212                 }
1213                 return copy_to_user(c->string, ctrl->string,
1214                                                 len + 1) ? -EFAULT : 0;
1215         case V4L2_CTRL_TYPE_INTEGER64:
1216                 c->value64 = ctrl->val64;
1217                 break;
1218         default:
1219                 c->value = ctrl->val;
1220                 break;
1221         }
1222         return 0;
1223 }
1224
1225 /* Copy the new value to the current value. */
1226 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
1227 {
1228         bool changed = false;
1229
1230         if (ctrl == NULL)
1231                 return;
1232         switch (ctrl->type) {
1233         case V4L2_CTRL_TYPE_BUTTON:
1234                 changed = true;
1235                 break;
1236         case V4L2_CTRL_TYPE_STRING:
1237                 /* strings are always 0-terminated */
1238                 changed = strcmp(ctrl->string, ctrl->cur.string);
1239                 strcpy(ctrl->cur.string, ctrl->string);
1240                 break;
1241         case V4L2_CTRL_TYPE_INTEGER64:
1242                 changed = ctrl->val64 != ctrl->cur.val64;
1243                 ctrl->cur.val64 = ctrl->val64;
1244                 break;
1245         default:
1246                 changed = ctrl->val != ctrl->cur.val;
1247                 ctrl->cur.val = ctrl->val;
1248                 break;
1249         }
1250         if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1251                 /* Note: CH_FLAGS is only set for auto clusters. */
1252                 ctrl->flags &=
1253                         ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1254                 if (!is_cur_manual(ctrl->cluster[0])) {
1255                         ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1256                         if (ctrl->cluster[0]->has_volatiles)
1257                                 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1258                 }
1259                 fh = NULL;
1260         }
1261         if (changed || ch_flags) {
1262                 /* If a control was changed that was not one of the controls
1263                    modified by the application, then send the event to all. */
1264                 if (!ctrl->is_new)
1265                         fh = NULL;
1266                 send_event(fh, ctrl,
1267                         (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
1268                 if (ctrl->call_notify && changed && ctrl->handler->notify)
1269                         ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
1270         }
1271 }
1272
1273 /* Copy the current value to the new value */
1274 static void cur_to_new(struct v4l2_ctrl *ctrl)
1275 {
1276         if (ctrl == NULL)
1277                 return;
1278         switch (ctrl->type) {
1279         case V4L2_CTRL_TYPE_STRING:
1280                 /* strings are always 0-terminated */
1281                 strcpy(ctrl->string, ctrl->cur.string);
1282                 break;
1283         case V4L2_CTRL_TYPE_INTEGER64:
1284                 ctrl->val64 = ctrl->cur.val64;
1285                 break;
1286         default:
1287                 ctrl->val = ctrl->cur.val;
1288                 break;
1289         }
1290 }
1291
1292 /* Return non-zero if one or more of the controls in the cluster has a new
1293    value that differs from the current value. */
1294 static int cluster_changed(struct v4l2_ctrl *master)
1295 {
1296         int diff = 0;
1297         int i;
1298
1299         for (i = 0; !diff && i < master->ncontrols; i++) {
1300                 struct v4l2_ctrl *ctrl = master->cluster[i];
1301
1302                 if (ctrl == NULL)
1303                         continue;
1304                 switch (ctrl->type) {
1305                 case V4L2_CTRL_TYPE_BUTTON:
1306                         /* Button controls are always 'different' */
1307                         return 1;
1308                 case V4L2_CTRL_TYPE_STRING:
1309                         /* strings are always 0-terminated */
1310                         diff = strcmp(ctrl->string, ctrl->cur.string);
1311                         break;
1312                 case V4L2_CTRL_TYPE_INTEGER64:
1313                         diff = ctrl->val64 != ctrl->cur.val64;
1314                         break;
1315                 default:
1316                         diff = ctrl->val != ctrl->cur.val;
1317                         break;
1318                 }
1319         }
1320         return diff;
1321 }
1322
1323 /* Control range checking */
1324 static int check_range(enum v4l2_ctrl_type type,
1325                 s32 min, s32 max, u32 step, s32 def)
1326 {
1327         switch (type) {
1328         case V4L2_CTRL_TYPE_BOOLEAN:
1329                 if (step != 1 || max > 1 || min < 0)
1330                         return -ERANGE;
1331                 /* fall through */
1332         case V4L2_CTRL_TYPE_INTEGER:
1333                 if (step <= 0 || min > max || def < min || def > max)
1334                         return -ERANGE;
1335                 return 0;
1336         case V4L2_CTRL_TYPE_BITMASK:
1337                 if (step || min || !max || (def & ~max))
1338                         return -ERANGE;
1339                 return 0;
1340         case V4L2_CTRL_TYPE_MENU:
1341         case V4L2_CTRL_TYPE_INTEGER_MENU:
1342                 if (min > max || def < min || def > max)
1343                         return -ERANGE;
1344                 /* Note: step == menu_skip_mask for menu controls.
1345                    So here we check if the default value is masked out. */
1346                 if (step && ((1 << def) & step))
1347                         return -EINVAL;
1348                 return 0;
1349         case V4L2_CTRL_TYPE_STRING:
1350                 if (min > max || min < 0 || step < 1 || def)
1351                         return -ERANGE;
1352                 return 0;
1353         default:
1354                 return 0;
1355         }
1356 }
1357
1358 /* Validate a new control */
1359 static int validate_new(const struct v4l2_ctrl *ctrl,
1360                         struct v4l2_ext_control *c)
1361 {
1362         size_t len;
1363         u32 offset;
1364         s32 val;
1365
1366         switch (ctrl->type) {
1367         case V4L2_CTRL_TYPE_INTEGER:
1368                 /* Round towards the closest legal value */
1369                 val = c->value + ctrl->step / 2;
1370                 val = clamp(val, ctrl->minimum, ctrl->maximum);
1371                 offset = val - ctrl->minimum;
1372                 offset = ctrl->step * (offset / ctrl->step);
1373                 c->value = ctrl->minimum + offset;
1374                 return 0;
1375
1376         case V4L2_CTRL_TYPE_BOOLEAN:
1377                 c->value = !!c->value;
1378                 return 0;
1379
1380         case V4L2_CTRL_TYPE_MENU:
1381         case V4L2_CTRL_TYPE_INTEGER_MENU:
1382                 if (c->value < ctrl->minimum || c->value > ctrl->maximum)
1383                         return -ERANGE;
1384                 if (ctrl->menu_skip_mask & (1 << c->value))
1385                         return -EINVAL;
1386                 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1387                     ctrl->qmenu[c->value][0] == '\0')
1388                         return -EINVAL;
1389                 return 0;
1390
1391         case V4L2_CTRL_TYPE_BITMASK:
1392                 c->value &= ctrl->maximum;
1393                 return 0;
1394
1395         case V4L2_CTRL_TYPE_BUTTON:
1396         case V4L2_CTRL_TYPE_CTRL_CLASS:
1397                 c->value = 0;
1398                 return 0;
1399
1400         case V4L2_CTRL_TYPE_INTEGER64:
1401                 return 0;
1402
1403         case V4L2_CTRL_TYPE_STRING:
1404                 len = strlen(c->string);
1405                 if (len < ctrl->minimum)
1406                         return -ERANGE;
1407                 if ((len - ctrl->minimum) % ctrl->step)
1408                         return -ERANGE;
1409                 return 0;
1410
1411         default:
1412                 return -EINVAL;
1413         }
1414 }
1415
1416 static inline u32 node2id(struct list_head *node)
1417 {
1418         return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1419 }
1420
1421 /* Set the handler's error code if it wasn't set earlier already */
1422 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1423 {
1424         if (hdl->error == 0)
1425                 hdl->error = err;
1426         return err;
1427 }
1428
1429 /* Initialize the handler */
1430 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1431                                  unsigned nr_of_controls_hint,
1432                                  struct lock_class_key *key, const char *name)
1433 {
1434         hdl->lock = &hdl->_lock;
1435         mutex_init(hdl->lock);
1436         lockdep_set_class_and_name(hdl->lock, key, name);
1437         INIT_LIST_HEAD(&hdl->ctrls);
1438         INIT_LIST_HEAD(&hdl->ctrl_refs);
1439         hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1440         hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1441                                GFP_KERNEL);
1442         hdl->error = hdl->buckets ? 0 : -ENOMEM;
1443         return hdl->error;
1444 }
1445 EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
1446
1447 /* Free all controls and control refs */
1448 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1449 {
1450         struct v4l2_ctrl_ref *ref, *next_ref;
1451         struct v4l2_ctrl *ctrl, *next_ctrl;
1452         struct v4l2_subscribed_event *sev, *next_sev;
1453
1454         if (hdl == NULL || hdl->buckets == NULL)
1455                 return;
1456
1457         mutex_lock(hdl->lock);
1458         /* Free all nodes */
1459         list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1460                 list_del(&ref->node);
1461                 kfree(ref);
1462         }
1463         /* Free all controls owned by the handler */
1464         list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1465                 list_del(&ctrl->node);
1466                 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1467                         list_del(&sev->node);
1468                 kfree(ctrl);
1469         }
1470         kfree(hdl->buckets);
1471         hdl->buckets = NULL;
1472         hdl->cached = NULL;
1473         hdl->error = 0;
1474         mutex_unlock(hdl->lock);
1475 }
1476 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1477
1478 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1479    be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1480    with applications that do not use the NEXT_CTRL flag.
1481
1482    We just find the n-th private user control. It's O(N), but that should not
1483    be an issue in this particular case. */
1484 static struct v4l2_ctrl_ref *find_private_ref(
1485                 struct v4l2_ctrl_handler *hdl, u32 id)
1486 {
1487         struct v4l2_ctrl_ref *ref;
1488
1489         id -= V4L2_CID_PRIVATE_BASE;
1490         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1491                 /* Search for private user controls that are compatible with
1492                    VIDIOC_G/S_CTRL. */
1493                 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1494                     V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1495                         if (!type_is_int(ref->ctrl))
1496                                 continue;
1497                         if (id == 0)
1498                                 return ref;
1499                         id--;
1500                 }
1501         }
1502         return NULL;
1503 }
1504
1505 /* Find a control with the given ID. */
1506 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1507 {
1508         struct v4l2_ctrl_ref *ref;
1509         int bucket;
1510
1511         id &= V4L2_CTRL_ID_MASK;
1512
1513         /* Old-style private controls need special handling */
1514         if (id >= V4L2_CID_PRIVATE_BASE)
1515                 return find_private_ref(hdl, id);
1516         bucket = id % hdl->nr_of_buckets;
1517
1518         /* Simple optimization: cache the last control found */
1519         if (hdl->cached && hdl->cached->ctrl->id == id)
1520                 return hdl->cached;
1521
1522         /* Not in cache, search the hash */
1523         ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1524         while (ref && ref->ctrl->id != id)
1525                 ref = ref->next;
1526
1527         if (ref)
1528                 hdl->cached = ref; /* cache it! */
1529         return ref;
1530 }
1531
1532 /* Find a control with the given ID. Take the handler's lock first. */
1533 static struct v4l2_ctrl_ref *find_ref_lock(
1534                 struct v4l2_ctrl_handler *hdl, u32 id)
1535 {
1536         struct v4l2_ctrl_ref *ref = NULL;
1537
1538         if (hdl) {
1539                 mutex_lock(hdl->lock);
1540                 ref = find_ref(hdl, id);
1541                 mutex_unlock(hdl->lock);
1542         }
1543         return ref;
1544 }
1545
1546 /* Find a control with the given ID. */
1547 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1548 {
1549         struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1550
1551         return ref ? ref->ctrl : NULL;
1552 }
1553 EXPORT_SYMBOL(v4l2_ctrl_find);
1554
1555 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1556 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1557                            struct v4l2_ctrl *ctrl)
1558 {
1559         struct v4l2_ctrl_ref *ref;
1560         struct v4l2_ctrl_ref *new_ref;
1561         u32 id = ctrl->id;
1562         u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1563         int bucket = id % hdl->nr_of_buckets;   /* which bucket to use */
1564
1565         /* Automatically add the control class if it is not yet present. */
1566         if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1567                 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1568                         return hdl->error;
1569
1570         if (hdl->error)
1571                 return hdl->error;
1572
1573         new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1574         if (!new_ref)
1575                 return handler_set_err(hdl, -ENOMEM);
1576         new_ref->ctrl = ctrl;
1577         if (ctrl->handler == hdl) {
1578                 /* By default each control starts in a cluster of its own.
1579                    new_ref->ctrl is basically a cluster array with one
1580                    element, so that's perfect to use as the cluster pointer.
1581                    But only do this for the handler that owns the control. */
1582                 ctrl->cluster = &new_ref->ctrl;
1583                 ctrl->ncontrols = 1;
1584         }
1585
1586         INIT_LIST_HEAD(&new_ref->node);
1587
1588         mutex_lock(hdl->lock);
1589
1590         /* Add immediately at the end of the list if the list is empty, or if
1591            the last element in the list has a lower ID.
1592            This ensures that when elements are added in ascending order the
1593            insertion is an O(1) operation. */
1594         if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1595                 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1596                 goto insert_in_hash;
1597         }
1598
1599         /* Find insert position in sorted list */
1600         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1601                 if (ref->ctrl->id < id)
1602                         continue;
1603                 /* Don't add duplicates */
1604                 if (ref->ctrl->id == id) {
1605                         kfree(new_ref);
1606                         goto unlock;
1607                 }
1608                 list_add(&new_ref->node, ref->node.prev);
1609                 break;
1610         }
1611
1612 insert_in_hash:
1613         /* Insert the control node in the hash */
1614         new_ref->next = hdl->buckets[bucket];
1615         hdl->buckets[bucket] = new_ref;
1616
1617 unlock:
1618         mutex_unlock(hdl->lock);
1619         return 0;
1620 }
1621
1622 /* Add a new control */
1623 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1624                         const struct v4l2_ctrl_ops *ops,
1625                         u32 id, const char *name, enum v4l2_ctrl_type type,
1626                         s32 min, s32 max, u32 step, s32 def,
1627                         u32 flags, const char * const *qmenu,
1628                         const s64 *qmenu_int, void *priv)
1629 {
1630         struct v4l2_ctrl *ctrl;
1631         unsigned sz_extra = 0;
1632         int err;
1633
1634         if (hdl->error)
1635                 return NULL;
1636
1637         /* Sanity checks */
1638         if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1639             (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1640             (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
1641                 handler_set_err(hdl, -ERANGE);
1642                 return NULL;
1643         }
1644         err = check_range(type, min, max, step, def);
1645         if (err) {
1646                 handler_set_err(hdl, err);
1647                 return NULL;
1648         }
1649         if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1650                 handler_set_err(hdl, -ERANGE);
1651                 return NULL;
1652         }
1653
1654         if (type == V4L2_CTRL_TYPE_BUTTON)
1655                 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1656         else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1657                 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1658         else if (type == V4L2_CTRL_TYPE_STRING)
1659                 sz_extra += 2 * (max + 1);
1660
1661         ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1662         if (ctrl == NULL) {
1663                 handler_set_err(hdl, -ENOMEM);
1664                 return NULL;
1665         }
1666
1667         INIT_LIST_HEAD(&ctrl->node);
1668         INIT_LIST_HEAD(&ctrl->ev_subs);
1669         ctrl->handler = hdl;
1670         ctrl->ops = ops;
1671         ctrl->id = id;
1672         ctrl->name = name;
1673         ctrl->type = type;
1674         ctrl->flags = flags;
1675         ctrl->minimum = min;
1676         ctrl->maximum = max;
1677         ctrl->step = step;
1678         if (type == V4L2_CTRL_TYPE_MENU)
1679                 ctrl->qmenu = qmenu;
1680         else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1681                 ctrl->qmenu_int = qmenu_int;
1682         ctrl->priv = priv;
1683         ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1684
1685         if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1686                 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1687                 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1688                 if (ctrl->minimum)
1689                         memset(ctrl->cur.string, ' ', ctrl->minimum);
1690         }
1691         if (handler_new_ref(hdl, ctrl)) {
1692                 kfree(ctrl);
1693                 return NULL;
1694         }
1695         mutex_lock(hdl->lock);
1696         list_add_tail(&ctrl->node, &hdl->ctrls);
1697         mutex_unlock(hdl->lock);
1698         return ctrl;
1699 }
1700
1701 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1702                         const struct v4l2_ctrl_config *cfg, void *priv)
1703 {
1704         bool is_menu;
1705         struct v4l2_ctrl *ctrl;
1706         const char *name = cfg->name;
1707         const char * const *qmenu = cfg->qmenu;
1708         const s64 *qmenu_int = cfg->qmenu_int;
1709         enum v4l2_ctrl_type type = cfg->type;
1710         u32 flags = cfg->flags;
1711         s32 min = cfg->min;
1712         s32 max = cfg->max;
1713         u32 step = cfg->step;
1714         s32 def = cfg->def;
1715
1716         if (name == NULL)
1717                 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1718                                                                 &def, &flags);
1719
1720         is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1721                    cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
1722         if (is_menu)
1723                 WARN_ON(step);
1724         else
1725                 WARN_ON(cfg->menu_skip_mask);
1726         if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
1727                 qmenu = v4l2_ctrl_get_menu(cfg->id);
1728         else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1729                  qmenu_int == NULL) {
1730                 handler_set_err(hdl, -EINVAL);
1731                 return NULL;
1732         }
1733
1734         ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1735                         type, min, max,
1736                         is_menu ? cfg->menu_skip_mask : step,
1737                         def, flags, qmenu, qmenu_int, priv);
1738         if (ctrl)
1739                 ctrl->is_private = cfg->is_private;
1740         return ctrl;
1741 }
1742 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1743
1744 /* Helper function for standard non-menu controls */
1745 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1746                         const struct v4l2_ctrl_ops *ops,
1747                         u32 id, s32 min, s32 max, u32 step, s32 def)
1748 {
1749         const char *name;
1750         enum v4l2_ctrl_type type;
1751         u32 flags;
1752
1753         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1754         if (type == V4L2_CTRL_TYPE_MENU
1755             || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
1756                 handler_set_err(hdl, -EINVAL);
1757                 return NULL;
1758         }
1759         return v4l2_ctrl_new(hdl, ops, id, name, type,
1760                              min, max, step, def, flags, NULL, NULL, NULL);
1761 }
1762 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1763
1764 /* Helper function for standard menu controls */
1765 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1766                         const struct v4l2_ctrl_ops *ops,
1767                         u32 id, s32 max, s32 mask, s32 def)
1768 {
1769         const char * const *qmenu = NULL;
1770         const s64 *qmenu_int = NULL;
1771         unsigned int qmenu_int_len = 0;
1772         const char *name;
1773         enum v4l2_ctrl_type type;
1774         s32 min;
1775         s32 step;
1776         u32 flags;
1777
1778         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1779
1780         if (type == V4L2_CTRL_TYPE_MENU)
1781                 qmenu = v4l2_ctrl_get_menu(id);
1782         else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1783                 qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
1784
1785         if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
1786                 handler_set_err(hdl, -EINVAL);
1787                 return NULL;
1788         }
1789         return v4l2_ctrl_new(hdl, ops, id, name, type,
1790                              0, max, mask, def, flags, qmenu, qmenu_int, NULL);
1791 }
1792 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1793
1794 /* Helper function for standard menu controls with driver defined menu */
1795 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
1796                         const struct v4l2_ctrl_ops *ops, u32 id, s32 max,
1797                         s32 mask, s32 def, const char * const *qmenu)
1798 {
1799         enum v4l2_ctrl_type type;
1800         const char *name;
1801         u32 flags;
1802         s32 step;
1803         s32 min;
1804
1805         /* v4l2_ctrl_new_std_menu_items() should only be called for
1806          * standard controls without a standard menu.
1807          */
1808         if (v4l2_ctrl_get_menu(id)) {
1809                 handler_set_err(hdl, -EINVAL);
1810                 return NULL;
1811         }
1812
1813         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1814         if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
1815                 handler_set_err(hdl, -EINVAL);
1816                 return NULL;
1817         }
1818         return v4l2_ctrl_new(hdl, ops, id, name, type, 0, max, mask, def,
1819                              flags, qmenu, NULL, NULL);
1820
1821 }
1822 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
1823
1824 /* Helper function for standard integer menu controls */
1825 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
1826                         const struct v4l2_ctrl_ops *ops,
1827                         u32 id, s32 max, s32 def, const s64 *qmenu_int)
1828 {
1829         const char *name;
1830         enum v4l2_ctrl_type type;
1831         s32 min;
1832         s32 step;
1833         u32 flags;
1834
1835         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1836         if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
1837                 handler_set_err(hdl, -EINVAL);
1838                 return NULL;
1839         }
1840         return v4l2_ctrl_new(hdl, ops, id, name, type,
1841                              0, max, 0, def, flags, NULL, qmenu_int, NULL);
1842 }
1843 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
1844
1845 /* Add a control from another handler to this handler */
1846 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1847                                           struct v4l2_ctrl *ctrl)
1848 {
1849         if (hdl == NULL || hdl->error)
1850                 return NULL;
1851         if (ctrl == NULL) {
1852                 handler_set_err(hdl, -EINVAL);
1853                 return NULL;
1854         }
1855         if (ctrl->handler == hdl)
1856                 return ctrl;
1857         return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1858 }
1859 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1860
1861 /* Add the controls from another handler to our own. */
1862 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1863                           struct v4l2_ctrl_handler *add,
1864                           bool (*filter)(const struct v4l2_ctrl *ctrl))
1865 {
1866         struct v4l2_ctrl_ref *ref;
1867         int ret = 0;
1868
1869         /* Do nothing if either handler is NULL or if they are the same */
1870         if (!hdl || !add || hdl == add)
1871                 return 0;
1872         if (hdl->error)
1873                 return hdl->error;
1874         mutex_lock(add->lock);
1875         list_for_each_entry(ref, &add->ctrl_refs, node) {
1876                 struct v4l2_ctrl *ctrl = ref->ctrl;
1877
1878                 /* Skip handler-private controls. */
1879                 if (ctrl->is_private)
1880                         continue;
1881                 /* And control classes */
1882                 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1883                         continue;
1884                 /* Filter any unwanted controls */
1885                 if (filter && !filter(ctrl))
1886                         continue;
1887                 ret = handler_new_ref(hdl, ctrl);
1888                 if (ret)
1889                         break;
1890         }
1891         mutex_unlock(add->lock);
1892         return ret;
1893 }
1894 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1895
1896 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
1897 {
1898         if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
1899                 return true;
1900         if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
1901                 return true;
1902         switch (ctrl->id) {
1903         case V4L2_CID_AUDIO_MUTE:
1904         case V4L2_CID_AUDIO_VOLUME:
1905         case V4L2_CID_AUDIO_BALANCE:
1906         case V4L2_CID_AUDIO_BASS:
1907         case V4L2_CID_AUDIO_TREBLE:
1908         case V4L2_CID_AUDIO_LOUDNESS:
1909                 return true;
1910         default:
1911                 break;
1912         }
1913         return false;
1914 }
1915 EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
1916
1917 /* Cluster controls */
1918 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1919 {
1920         bool has_volatiles = false;
1921         int i;
1922
1923         /* The first control is the master control and it must not be NULL */
1924         BUG_ON(ncontrols == 0 || controls[0] == NULL);
1925
1926         for (i = 0; i < ncontrols; i++) {
1927                 if (controls[i]) {
1928                         controls[i]->cluster = controls;
1929                         controls[i]->ncontrols = ncontrols;
1930                         if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1931                                 has_volatiles = true;
1932                 }
1933         }
1934         controls[0]->has_volatiles = has_volatiles;
1935 }
1936 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1937
1938 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1939                             u8 manual_val, bool set_volatile)
1940 {
1941         struct v4l2_ctrl *master = controls[0];
1942         u32 flag = 0;
1943         int i;
1944
1945         v4l2_ctrl_cluster(ncontrols, controls);
1946         WARN_ON(ncontrols <= 1);
1947         WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1948         WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1949         master->is_auto = true;
1950         master->has_volatiles = set_volatile;
1951         master->manual_mode_value = manual_val;
1952         master->flags |= V4L2_CTRL_FLAG_UPDATE;
1953
1954         if (!is_cur_manual(master))
1955                 flag = V4L2_CTRL_FLAG_INACTIVE |
1956                         (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1957
1958         for (i = 1; i < ncontrols; i++)
1959                 if (controls[i])
1960                         controls[i]->flags |= flag;
1961 }
1962 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1963
1964 /* Activate/deactivate a control. */
1965 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1966 {
1967         /* invert since the actual flag is called 'inactive' */
1968         bool inactive = !active;
1969         bool old;
1970
1971         if (ctrl == NULL)
1972                 return;
1973
1974         if (inactive)
1975                 /* set V4L2_CTRL_FLAG_INACTIVE */
1976                 old = test_and_set_bit(4, &ctrl->flags);
1977         else
1978                 /* clear V4L2_CTRL_FLAG_INACTIVE */
1979                 old = test_and_clear_bit(4, &ctrl->flags);
1980         if (old != inactive)
1981                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1982 }
1983 EXPORT_SYMBOL(v4l2_ctrl_activate);
1984
1985 /* Grab/ungrab a control.
1986    Typically used when streaming starts and you want to grab controls,
1987    preventing the user from changing them.
1988
1989    Just call this and the framework will block any attempts to change
1990    these controls. */
1991 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1992 {
1993         bool old;
1994
1995         if (ctrl == NULL)
1996                 return;
1997
1998         v4l2_ctrl_lock(ctrl);
1999         if (grabbed)
2000                 /* set V4L2_CTRL_FLAG_GRABBED */
2001                 old = test_and_set_bit(1, &ctrl->flags);
2002         else
2003                 /* clear V4L2_CTRL_FLAG_GRABBED */
2004                 old = test_and_clear_bit(1, &ctrl->flags);
2005         if (old != grabbed)
2006                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2007         v4l2_ctrl_unlock(ctrl);
2008 }
2009 EXPORT_SYMBOL(v4l2_ctrl_grab);
2010
2011 /* Log the control name and value */
2012 static void log_ctrl(const struct v4l2_ctrl *ctrl,
2013                      const char *prefix, const char *colon)
2014 {
2015         if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2016                 return;
2017         if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2018                 return;
2019
2020         printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
2021
2022         switch (ctrl->type) {
2023         case V4L2_CTRL_TYPE_INTEGER:
2024                 printk(KERN_CONT "%d", ctrl->cur.val);
2025                 break;
2026         case V4L2_CTRL_TYPE_BOOLEAN:
2027                 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
2028                 break;
2029         case V4L2_CTRL_TYPE_MENU:
2030                 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
2031                 break;
2032         case V4L2_CTRL_TYPE_INTEGER_MENU:
2033                 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
2034                 break;
2035         case V4L2_CTRL_TYPE_BITMASK:
2036                 printk(KERN_CONT "0x%08x", ctrl->cur.val);
2037                 break;
2038         case V4L2_CTRL_TYPE_INTEGER64:
2039                 printk(KERN_CONT "%lld", ctrl->cur.val64);
2040                 break;
2041         case V4L2_CTRL_TYPE_STRING:
2042                 printk(KERN_CONT "%s", ctrl->cur.string);
2043                 break;
2044         default:
2045                 printk(KERN_CONT "unknown type %d", ctrl->type);
2046                 break;
2047         }
2048         if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2049                            V4L2_CTRL_FLAG_GRABBED |
2050                            V4L2_CTRL_FLAG_VOLATILE)) {
2051                 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
2052                         printk(KERN_CONT " inactive");
2053                 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
2054                         printk(KERN_CONT " grabbed");
2055                 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
2056                         printk(KERN_CONT " volatile");
2057         }
2058         printk(KERN_CONT "\n");
2059 }
2060
2061 /* Log all controls owned by the handler */
2062 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2063                                   const char *prefix)
2064 {
2065         struct v4l2_ctrl *ctrl;
2066         const char *colon = "";
2067         int len;
2068
2069         if (hdl == NULL)
2070                 return;
2071         if (prefix == NULL)
2072                 prefix = "";
2073         len = strlen(prefix);
2074         if (len && prefix[len - 1] != ' ')
2075                 colon = ": ";
2076         mutex_lock(hdl->lock);
2077         list_for_each_entry(ctrl, &hdl->ctrls, node)
2078                 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2079                         log_ctrl(ctrl, prefix, colon);
2080         mutex_unlock(hdl->lock);
2081 }
2082 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2083
2084 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2085 {
2086         v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2087         return 0;
2088 }
2089 EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2090
2091 /* Call s_ctrl for all controls owned by the handler */
2092 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2093 {
2094         struct v4l2_ctrl *ctrl;
2095         int ret = 0;
2096
2097         if (hdl == NULL)
2098                 return 0;
2099         mutex_lock(hdl->lock);
2100         list_for_each_entry(ctrl, &hdl->ctrls, node)
2101                 ctrl->done = false;
2102
2103         list_for_each_entry(ctrl, &hdl->ctrls, node) {
2104                 struct v4l2_ctrl *master = ctrl->cluster[0];
2105                 int i;
2106
2107                 /* Skip if this control was already handled by a cluster. */
2108                 /* Skip button controls and read-only controls. */
2109                 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2110                     (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
2111                         continue;
2112
2113                 for (i = 0; i < master->ncontrols; i++) {
2114                         if (master->cluster[i]) {
2115                                 cur_to_new(master->cluster[i]);
2116                                 master->cluster[i]->is_new = 1;
2117                                 master->cluster[i]->done = true;
2118                         }
2119                 }
2120                 ret = call_op(master, s_ctrl);
2121                 if (ret)
2122                         break;
2123         }
2124         mutex_unlock(hdl->lock);
2125         return ret;
2126 }
2127 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2128
2129 /* Implement VIDIOC_QUERYCTRL */
2130 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2131 {
2132         u32 id = qc->id & V4L2_CTRL_ID_MASK;
2133         struct v4l2_ctrl_ref *ref;
2134         struct v4l2_ctrl *ctrl;
2135
2136         if (hdl == NULL)
2137                 return -EINVAL;
2138
2139         mutex_lock(hdl->lock);
2140
2141         /* Try to find it */
2142         ref = find_ref(hdl, id);
2143
2144         if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
2145                 /* Find the next control with ID > qc->id */
2146
2147                 /* Did we reach the end of the control list? */
2148                 if (id >= node2id(hdl->ctrl_refs.prev)) {
2149                         ref = NULL; /* Yes, so there is no next control */
2150                 } else if (ref) {
2151                         /* We found a control with the given ID, so just get
2152                            the next one in the list. */
2153                         ref = list_entry(ref->node.next, typeof(*ref), node);
2154                 } else {
2155                         /* No control with the given ID exists, so start
2156                            searching for the next largest ID. We know there
2157                            is one, otherwise the first 'if' above would have
2158                            been true. */
2159                         list_for_each_entry(ref, &hdl->ctrl_refs, node)
2160                                 if (id < ref->ctrl->id)
2161                                         break;
2162                 }
2163         }
2164         mutex_unlock(hdl->lock);
2165         if (!ref)
2166                 return -EINVAL;
2167
2168         ctrl = ref->ctrl;
2169         memset(qc, 0, sizeof(*qc));
2170         if (id >= V4L2_CID_PRIVATE_BASE)
2171                 qc->id = id;
2172         else
2173                 qc->id = ctrl->id;
2174         strlcpy(qc->name, ctrl->name, sizeof(qc->name));
2175         qc->minimum = ctrl->minimum;
2176         qc->maximum = ctrl->maximum;
2177         qc->default_value = ctrl->default_value;
2178         if (ctrl->type == V4L2_CTRL_TYPE_MENU
2179             || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
2180                 qc->step = 1;
2181         else
2182                 qc->step = ctrl->step;
2183         qc->flags = ctrl->flags;
2184         qc->type = ctrl->type;
2185         return 0;
2186 }
2187 EXPORT_SYMBOL(v4l2_queryctrl);
2188
2189 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2190 {
2191         if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
2192                 return -EINVAL;
2193         return v4l2_queryctrl(sd->ctrl_handler, qc);
2194 }
2195 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2196
2197 /* Implement VIDIOC_QUERYMENU */
2198 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2199 {
2200         struct v4l2_ctrl *ctrl;
2201         u32 i = qm->index;
2202
2203         ctrl = v4l2_ctrl_find(hdl, qm->id);
2204         if (!ctrl)
2205                 return -EINVAL;
2206
2207         qm->reserved = 0;
2208         /* Sanity checks */
2209         switch (ctrl->type) {
2210         case V4L2_CTRL_TYPE_MENU:
2211                 if (ctrl->qmenu == NULL)
2212                         return -EINVAL;
2213                 break;
2214         case V4L2_CTRL_TYPE_INTEGER_MENU:
2215                 if (ctrl->qmenu_int == NULL)
2216                         return -EINVAL;
2217                 break;
2218         default:
2219                 return -EINVAL;
2220         }
2221
2222         if (i < ctrl->minimum || i > ctrl->maximum)
2223                 return -EINVAL;
2224
2225         /* Use mask to see if this menu item should be skipped */
2226         if (ctrl->menu_skip_mask & (1 << i))
2227                 return -EINVAL;
2228         /* Empty menu items should also be skipped */
2229         if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2230                 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2231                         return -EINVAL;
2232                 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2233         } else {
2234                 qm->value = ctrl->qmenu_int[i];
2235         }
2236         return 0;
2237 }
2238 EXPORT_SYMBOL(v4l2_querymenu);
2239
2240 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2241 {
2242         return v4l2_querymenu(sd->ctrl_handler, qm);
2243 }
2244 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2245
2246
2247
2248 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2249
2250    It is not a fully atomic operation, just best-effort only. After all, if
2251    multiple controls have to be set through multiple i2c writes (for example)
2252    then some initial writes may succeed while others fail. Thus leaving the
2253    system in an inconsistent state. The question is how much effort you are
2254    willing to spend on trying to make something atomic that really isn't.
2255
2256    From the point of view of an application the main requirement is that
2257    when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2258    error should be returned without actually affecting any controls.
2259
2260    If all the values are correct, then it is acceptable to just give up
2261    in case of low-level errors.
2262
2263    It is important though that the application can tell when only a partial
2264    configuration was done. The way we do that is through the error_idx field
2265    of struct v4l2_ext_controls: if that is equal to the count field then no
2266    controls were affected. Otherwise all controls before that index were
2267    successful in performing their 'get' or 'set' operation, the control at
2268    the given index failed, and you don't know what happened with the controls
2269    after the failed one. Since if they were part of a control cluster they
2270    could have been successfully processed (if a cluster member was encountered
2271    at index < error_idx), they could have failed (if a cluster member was at
2272    error_idx), or they may not have been processed yet (if the first cluster
2273    member appeared after error_idx).
2274
2275    It is all fairly theoretical, though. In practice all you can do is to
2276    bail out. If error_idx == count, then it is an application bug. If
2277    error_idx < count then it is only an application bug if the error code was
2278    EBUSY. That usually means that something started streaming just when you
2279    tried to set the controls. In all other cases it is a driver/hardware
2280    problem and all you can do is to retry or bail out.
2281
2282    Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2283    never modifies controls the error_idx is just set to whatever control
2284    has an invalid value.
2285  */
2286
2287 /* Prepare for the extended g/s/try functions.
2288    Find the controls in the control array and do some basic checks. */
2289 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2290                              struct v4l2_ext_controls *cs,
2291                              struct v4l2_ctrl_helper *helpers)
2292 {
2293         struct v4l2_ctrl_helper *h;
2294         bool have_clusters = false;
2295         u32 i;
2296
2297         for (i = 0, h = helpers; i < cs->count; i++, h++) {
2298                 struct v4l2_ext_control *c = &cs->controls[i];
2299                 struct v4l2_ctrl_ref *ref;
2300                 struct v4l2_ctrl *ctrl;
2301                 u32 id = c->id & V4L2_CTRL_ID_MASK;
2302
2303                 cs->error_idx = i;
2304
2305                 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2306                         return -EINVAL;
2307
2308                 /* Old-style private controls are not allowed for
2309                    extended controls */
2310                 if (id >= V4L2_CID_PRIVATE_BASE)
2311                         return -EINVAL;
2312                 ref = find_ref_lock(hdl, id);
2313                 if (ref == NULL)
2314                         return -EINVAL;
2315                 ctrl = ref->ctrl;
2316                 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2317                         return -EINVAL;
2318
2319                 if (ctrl->cluster[0]->ncontrols > 1)
2320                         have_clusters = true;
2321                 if (ctrl->cluster[0] != ctrl)
2322                         ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2323                 /* Store the ref to the master control of the cluster */
2324                 h->mref = ref;
2325                 h->ctrl = ctrl;
2326                 /* Initially set next to 0, meaning that there is no other
2327                    control in this helper array belonging to the same
2328                    cluster */
2329                 h->next = 0;
2330         }
2331
2332         /* We are done if there were no controls that belong to a multi-
2333            control cluster. */
2334         if (!have_clusters)
2335                 return 0;
2336
2337         /* The code below figures out in O(n) time which controls in the list
2338            belong to the same cluster. */
2339
2340         /* This has to be done with the handler lock taken. */
2341         mutex_lock(hdl->lock);
2342
2343         /* First zero the helper field in the master control references */
2344         for (i = 0; i < cs->count; i++)
2345                 helpers[i].mref->helper = NULL;
2346         for (i = 0, h = helpers; i < cs->count; i++, h++) {
2347                 struct v4l2_ctrl_ref *mref = h->mref;
2348
2349                 /* If the mref->helper is set, then it points to an earlier
2350                    helper that belongs to the same cluster. */
2351                 if (mref->helper) {
2352                         /* Set the next field of mref->helper to the current
2353                            index: this means that that earlier helper now
2354                            points to the next helper in the same cluster. */
2355                         mref->helper->next = i;
2356                         /* mref should be set only for the first helper in the
2357                            cluster, clear the others. */
2358                         h->mref = NULL;
2359                 }
2360                 /* Point the mref helper to the current helper struct. */
2361                 mref->helper = h;
2362         }
2363         mutex_unlock(hdl->lock);
2364         return 0;
2365 }
2366
2367 /* Handles the corner case where cs->count == 0. It checks whether the
2368    specified control class exists. If that class ID is 0, then it checks
2369    whether there are any controls at all. */
2370 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2371 {
2372         if (ctrl_class == 0)
2373                 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2374         return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2375 }
2376
2377
2378
2379 /* Get extended controls. Allocates the helpers array if needed. */
2380 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2381 {
2382         struct v4l2_ctrl_helper helper[4];
2383         struct v4l2_ctrl_helper *helpers = helper;
2384         int ret;
2385         int i, j;
2386
2387         cs->error_idx = cs->count;
2388         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2389
2390         if (hdl == NULL)
2391                 return -EINVAL;
2392
2393         if (cs->count == 0)
2394                 return class_check(hdl, cs->ctrl_class);
2395
2396         if (cs->count > ARRAY_SIZE(helper)) {
2397                 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2398                                         GFP_KERNEL);
2399                 if (helpers == NULL)
2400                         return -ENOMEM;
2401         }
2402
2403         ret = prepare_ext_ctrls(hdl, cs, helpers);
2404         cs->error_idx = cs->count;
2405
2406         for (i = 0; !ret && i < cs->count; i++)
2407                 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2408                         ret = -EACCES;
2409
2410         for (i = 0; !ret && i < cs->count; i++) {
2411                 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2412                                     struct v4l2_ctrl *ctrl) = cur_to_user;
2413                 struct v4l2_ctrl *master;
2414
2415                 if (helpers[i].mref == NULL)
2416                         continue;
2417
2418                 master = helpers[i].mref->ctrl;
2419                 cs->error_idx = i;
2420
2421                 v4l2_ctrl_lock(master);
2422
2423                 /* g_volatile_ctrl will update the new control values */
2424                 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2425                         (master->has_volatiles && !is_cur_manual(master))) {
2426                         for (j = 0; j < master->ncontrols; j++)
2427                                 cur_to_new(master->cluster[j]);
2428                         ret = call_op(master, g_volatile_ctrl);
2429                         ctrl_to_user = new_to_user;
2430                 }
2431                 /* If OK, then copy the current (for non-volatile controls)
2432                    or the new (for volatile controls) control values to the
2433                    caller */
2434                 if (!ret) {
2435                         u32 idx = i;
2436
2437                         do {
2438                                 ret = ctrl_to_user(cs->controls + idx,
2439                                                    helpers[idx].ctrl);
2440                                 idx = helpers[idx].next;
2441                         } while (!ret && idx);
2442                 }
2443                 v4l2_ctrl_unlock(master);
2444         }
2445
2446         if (cs->count > ARRAY_SIZE(helper))
2447                 kfree(helpers);
2448         return ret;
2449 }
2450 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2451
2452 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2453 {
2454         return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2455 }
2456 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2457
2458 /* Helper function to get a single control */
2459 static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
2460 {
2461         struct v4l2_ctrl *master = ctrl->cluster[0];
2462         int ret = 0;
2463         int i;
2464
2465         /* String controls are not supported. The new_to_user() and
2466          * cur_to_user() calls below would need to be modified not to access
2467          * userspace memory when called from get_ctrl().
2468          */
2469         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
2470                 return -EINVAL;
2471
2472         if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2473                 return -EACCES;
2474
2475         v4l2_ctrl_lock(master);
2476         /* g_volatile_ctrl will update the current control values */
2477         if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2478                 for (i = 0; i < master->ncontrols; i++)
2479                         cur_to_new(master->cluster[i]);
2480                 ret = call_op(master, g_volatile_ctrl);
2481                 new_to_user(c, ctrl);
2482         } else {
2483                 cur_to_user(c, ctrl);
2484         }
2485         v4l2_ctrl_unlock(master);
2486         return ret;
2487 }
2488
2489 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2490 {
2491         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2492         struct v4l2_ext_control c;
2493         int ret;
2494
2495         if (ctrl == NULL || !type_is_int(ctrl))
2496                 return -EINVAL;
2497         ret = get_ctrl(ctrl, &c);
2498         control->value = c.value;
2499         return ret;
2500 }
2501 EXPORT_SYMBOL(v4l2_g_ctrl);
2502
2503 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2504 {
2505         return v4l2_g_ctrl(sd->ctrl_handler, control);
2506 }
2507 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2508
2509 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2510 {
2511         struct v4l2_ext_control c;
2512
2513         /* It's a driver bug if this happens. */
2514         WARN_ON(!type_is_int(ctrl));
2515         c.value = 0;
2516         get_ctrl(ctrl, &c);
2517         return c.value;
2518 }
2519 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2520
2521 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
2522 {
2523         struct v4l2_ext_control c;
2524
2525         /* It's a driver bug if this happens. */
2526         WARN_ON(ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2527         c.value = 0;
2528         get_ctrl(ctrl, &c);
2529         return c.value;
2530 }
2531 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
2532
2533
2534 /* Core function that calls try/s_ctrl and ensures that the new value is
2535    copied to the current value on a set.
2536    Must be called with ctrl->handler->lock held. */
2537 static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
2538                               bool set, u32 ch_flags)
2539 {
2540         bool update_flag;
2541         int ret;
2542         int i;
2543
2544         /* Go through the cluster and either validate the new value or
2545            (if no new value was set), copy the current value to the new
2546            value, ensuring a consistent view for the control ops when
2547            called. */
2548         for (i = 0; i < master->ncontrols; i++) {
2549                 struct v4l2_ctrl *ctrl = master->cluster[i];
2550
2551                 if (ctrl == NULL)
2552                         continue;
2553
2554                 if (!ctrl->is_new) {
2555                         cur_to_new(ctrl);
2556                         continue;
2557                 }
2558                 /* Check again: it may have changed since the
2559                    previous check in try_or_set_ext_ctrls(). */
2560                 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2561                         return -EBUSY;
2562         }
2563
2564         ret = call_op(master, try_ctrl);
2565
2566         /* Don't set if there is no change */
2567         if (ret || !set || !cluster_changed(master))
2568                 return ret;
2569         ret = call_op(master, s_ctrl);
2570         if (ret)
2571                 return ret;
2572
2573         /* If OK, then make the new values permanent. */
2574         update_flag = is_cur_manual(master) != is_new_manual(master);
2575         for (i = 0; i < master->ncontrols; i++)
2576                 new_to_cur(fh, master->cluster[i], ch_flags |
2577                         ((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
2578         return 0;
2579 }
2580
2581 /* Validate controls. */
2582 static int validate_ctrls(struct v4l2_ext_controls *cs,
2583                           struct v4l2_ctrl_helper *helpers, bool set)
2584 {
2585         unsigned i;
2586         int ret = 0;
2587
2588         cs->error_idx = cs->count;
2589         for (i = 0; i < cs->count; i++) {
2590                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2591
2592                 cs->error_idx = i;
2593
2594                 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2595                         return -EACCES;
2596                 /* This test is also done in try_set_control_cluster() which
2597                    is called in atomic context, so that has the final say,
2598                    but it makes sense to do an up-front check as well. Once
2599                    an error occurs in try_set_control_cluster() some other
2600                    controls may have been set already and we want to do a
2601                    best-effort to avoid that. */
2602                 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2603                         return -EBUSY;
2604                 ret = validate_new(ctrl, &cs->controls[i]);
2605                 if (ret)
2606                         return ret;
2607         }
2608         return 0;
2609 }
2610
2611 /* Obtain the current volatile values of an autocluster and mark them
2612    as new. */
2613 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2614 {
2615         int i;
2616
2617         for (i = 0; i < master->ncontrols; i++)
2618                 cur_to_new(master->cluster[i]);
2619         if (!call_op(master, g_volatile_ctrl))
2620                 for (i = 1; i < master->ncontrols; i++)
2621                         if (master->cluster[i])
2622                                 master->cluster[i]->is_new = 1;
2623 }
2624
2625 /* Try or try-and-set controls */
2626 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2627                              struct v4l2_ext_controls *cs,
2628                              bool set)
2629 {
2630         struct v4l2_ctrl_helper helper[4];
2631         struct v4l2_ctrl_helper *helpers = helper;
2632         unsigned i, j;
2633         int ret;
2634
2635         cs->error_idx = cs->count;
2636         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2637
2638         if (hdl == NULL)
2639                 return -EINVAL;
2640
2641         if (cs->count == 0)
2642                 return class_check(hdl, cs->ctrl_class);
2643
2644         if (cs->count > ARRAY_SIZE(helper)) {
2645                 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2646                                         GFP_KERNEL);
2647                 if (!helpers)
2648                         return -ENOMEM;
2649         }
2650         ret = prepare_ext_ctrls(hdl, cs, helpers);
2651         if (!ret)
2652                 ret = validate_ctrls(cs, helpers, set);
2653         if (ret && set)
2654                 cs->error_idx = cs->count;
2655         for (i = 0; !ret && i < cs->count; i++) {
2656                 struct v4l2_ctrl *master;
2657                 u32 idx = i;
2658
2659                 if (helpers[i].mref == NULL)
2660                         continue;
2661
2662                 cs->error_idx = i;
2663                 master = helpers[i].mref->ctrl;
2664                 v4l2_ctrl_lock(master);
2665
2666                 /* Reset the 'is_new' flags of the cluster */
2667                 for (j = 0; j < master->ncontrols; j++)
2668                         if (master->cluster[j])
2669                                 master->cluster[j]->is_new = 0;
2670
2671                 /* For volatile autoclusters that are currently in auto mode
2672                    we need to discover if it will be set to manual mode.
2673                    If so, then we have to copy the current volatile values
2674                    first since those will become the new manual values (which
2675                    may be overwritten by explicit new values from this set
2676                    of controls). */
2677                 if (master->is_auto && master->has_volatiles &&
2678                                                 !is_cur_manual(master)) {
2679                         /* Pick an initial non-manual value */
2680                         s32 new_auto_val = master->manual_mode_value + 1;
2681                         u32 tmp_idx = idx;
2682
2683                         do {
2684                                 /* Check if the auto control is part of the
2685                                    list, and remember the new value. */
2686                                 if (helpers[tmp_idx].ctrl == master)
2687                                         new_auto_val = cs->controls[tmp_idx].value;
2688                                 tmp_idx = helpers[tmp_idx].next;
2689                         } while (tmp_idx);
2690                         /* If the new value == the manual value, then copy
2691                            the current volatile values. */
2692                         if (new_auto_val == master->manual_mode_value)
2693                                 update_from_auto_cluster(master);
2694                 }
2695
2696                 /* Copy the new caller-supplied control values.
2697                    user_to_new() sets 'is_new' to 1. */
2698                 do {
2699                         ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2700                         idx = helpers[idx].next;
2701                 } while (!ret && idx);
2702
2703                 if (!ret)
2704                         ret = try_or_set_cluster(fh, master, set, 0);
2705
2706                 /* Copy the new values back to userspace. */
2707                 if (!ret) {
2708                         idx = i;
2709                         do {
2710                                 ret = new_to_user(cs->controls + idx,
2711                                                 helpers[idx].ctrl);
2712                                 idx = helpers[idx].next;
2713                         } while (!ret && idx);
2714                 }
2715                 v4l2_ctrl_unlock(master);
2716         }
2717
2718         if (cs->count > ARRAY_SIZE(helper))
2719                 kfree(helpers);
2720         return ret;
2721 }
2722
2723 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2724 {
2725         return try_set_ext_ctrls(NULL, hdl, cs, false);
2726 }
2727 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2728
2729 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2730                                         struct v4l2_ext_controls *cs)
2731 {
2732         return try_set_ext_ctrls(fh, hdl, cs, true);
2733 }
2734 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2735
2736 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2737 {
2738         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2739 }
2740 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2741
2742 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2743 {
2744         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2745 }
2746 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2747
2748 /* Helper function for VIDIOC_S_CTRL compatibility */
2749 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
2750                     struct v4l2_ext_control *c, u32 ch_flags)
2751 {
2752         struct v4l2_ctrl *master = ctrl->cluster[0];
2753         int i;
2754
2755         /* String controls are not supported. The user_to_new() and
2756          * cur_to_user() calls below would need to be modified not to access
2757          * userspace memory when called from set_ctrl().
2758          */
2759         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
2760                 return -EINVAL;
2761
2762         /* Reset the 'is_new' flags of the cluster */
2763         for (i = 0; i < master->ncontrols; i++)
2764                 if (master->cluster[i])
2765                         master->cluster[i]->is_new = 0;
2766
2767         /* For autoclusters with volatiles that are switched from auto to
2768            manual mode we have to update the current volatile values since
2769            those will become the initial manual values after such a switch. */
2770         if (master->is_auto && master->has_volatiles && ctrl == master &&
2771             !is_cur_manual(master) && c->value == master->manual_mode_value)
2772                 update_from_auto_cluster(master);
2773
2774         user_to_new(c, ctrl);
2775         return try_or_set_cluster(fh, master, true, ch_flags);
2776 }
2777
2778 /* Helper function for VIDIOC_S_CTRL compatibility */
2779 static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
2780                          struct v4l2_ext_control *c)
2781 {
2782         int ret = validate_new(ctrl, c);
2783
2784         if (!ret) {
2785                 v4l2_ctrl_lock(ctrl);
2786                 ret = set_ctrl(fh, ctrl, c, 0);
2787                 if (!ret)
2788                         cur_to_user(c, ctrl);
2789                 v4l2_ctrl_unlock(ctrl);
2790         }
2791         return ret;
2792 }
2793
2794 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2795                                         struct v4l2_control *control)
2796 {
2797         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2798         struct v4l2_ext_control c;
2799         int ret;
2800
2801         if (ctrl == NULL || !type_is_int(ctrl))
2802                 return -EINVAL;
2803
2804         if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2805                 return -EACCES;
2806
2807         c.value = control->value;
2808         ret = set_ctrl_lock(fh, ctrl, &c);
2809         control->value = c.value;
2810         return ret;
2811 }
2812 EXPORT_SYMBOL(v4l2_s_ctrl);
2813
2814 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2815 {
2816         return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2817 }
2818 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2819
2820 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2821 {
2822         struct v4l2_ext_control c;
2823
2824         /* It's a driver bug if this happens. */
2825         WARN_ON(!type_is_int(ctrl));
2826         c.value = val;
2827         return set_ctrl_lock(NULL, ctrl, &c);
2828 }
2829 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2830
2831 int v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
2832 {
2833         struct v4l2_ext_control c;
2834
2835         /* It's a driver bug if this happens. */
2836         WARN_ON(ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2837         c.value64 = val;
2838         return set_ctrl_lock(NULL, ctrl, &c);
2839 }
2840 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl_int64);
2841
2842 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
2843 {
2844         if (ctrl == NULL)
2845                 return;
2846         if (notify == NULL) {
2847                 ctrl->call_notify = 0;
2848                 return;
2849         }
2850         if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
2851                 return;
2852         ctrl->handler->notify = notify;
2853         ctrl->handler->notify_priv = priv;
2854         ctrl->call_notify = 1;
2855 }
2856 EXPORT_SYMBOL(v4l2_ctrl_notify);
2857
2858 int v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
2859                         s32 min, s32 max, u32 step, s32 def)
2860 {
2861         int ret = check_range(ctrl->type, min, max, step, def);
2862         struct v4l2_ext_control c;
2863
2864         switch (ctrl->type) {
2865         case V4L2_CTRL_TYPE_INTEGER:
2866         case V4L2_CTRL_TYPE_BOOLEAN:
2867         case V4L2_CTRL_TYPE_MENU:
2868         case V4L2_CTRL_TYPE_INTEGER_MENU:
2869         case V4L2_CTRL_TYPE_BITMASK:
2870                 if (ret)
2871                         return ret;
2872                 break;
2873         default:
2874                 return -EINVAL;
2875         }
2876         v4l2_ctrl_lock(ctrl);
2877         ctrl->minimum = min;
2878         ctrl->maximum = max;
2879         ctrl->step = step;
2880         ctrl->default_value = def;
2881         c.value = ctrl->cur.val;
2882         if (validate_new(ctrl, &c))
2883                 c.value = def;
2884         if (c.value != ctrl->cur.val)
2885                 ret = set_ctrl(NULL, ctrl, &c, V4L2_EVENT_CTRL_CH_RANGE);
2886         else
2887                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
2888         v4l2_ctrl_unlock(ctrl);
2889         return ret;
2890 }
2891 EXPORT_SYMBOL(v4l2_ctrl_modify_range);
2892
2893 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
2894 {
2895         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2896
2897         if (ctrl == NULL)
2898                 return -EINVAL;
2899
2900         v4l2_ctrl_lock(ctrl);
2901         list_add_tail(&sev->node, &ctrl->ev_subs);
2902         if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2903             (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2904                 struct v4l2_event ev;
2905                 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2906
2907                 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2908                         changes |= V4L2_EVENT_CTRL_CH_VALUE;
2909                 fill_event(&ev, ctrl, changes);
2910                 /* Mark the queue as active, allowing this initial
2911                    event to be accepted. */
2912                 sev->elems = elems;
2913                 v4l2_event_queue_fh(sev->fh, &ev);
2914         }
2915         v4l2_ctrl_unlock(ctrl);
2916         return 0;
2917 }
2918
2919 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
2920 {
2921         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2922
2923         v4l2_ctrl_lock(ctrl);
2924         list_del(&sev->node);
2925         v4l2_ctrl_unlock(ctrl);
2926 }
2927
2928 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2929 {
2930         u32 old_changes = old->u.ctrl.changes;
2931
2932         old->u.ctrl = new->u.ctrl;
2933         old->u.ctrl.changes |= old_changes;
2934 }
2935 EXPORT_SYMBOL(v4l2_ctrl_replace);
2936
2937 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2938 {
2939         new->u.ctrl.changes |= old->u.ctrl.changes;
2940 }
2941 EXPORT_SYMBOL(v4l2_ctrl_merge);
2942
2943 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2944         .add = v4l2_ctrl_add_event,
2945         .del = v4l2_ctrl_del_event,
2946         .replace = v4l2_ctrl_replace,
2947         .merge = v4l2_ctrl_merge,
2948 };
2949 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
2950
2951 int v4l2_ctrl_log_status(struct file *file, void *fh)
2952 {
2953         struct video_device *vfd = video_devdata(file);
2954         struct v4l2_fh *vfh = file->private_data;
2955
2956         if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2957                 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2958                         vfd->v4l2_dev->name);
2959         return 0;
2960 }
2961 EXPORT_SYMBOL(v4l2_ctrl_log_status);
2962
2963 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2964                                 const struct v4l2_event_subscription *sub)
2965 {
2966         if (sub->type == V4L2_EVENT_CTRL)
2967                 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
2968         return -EINVAL;
2969 }
2970 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2971
2972 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
2973                                      struct v4l2_event_subscription *sub)
2974 {
2975         if (!sd->ctrl_handler)
2976                 return -EINVAL;
2977         return v4l2_ctrl_subscribe_event(fh, sub);
2978 }
2979 EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
2980
2981 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2982 {
2983         struct v4l2_fh *fh = file->private_data;
2984
2985         if (v4l2_event_pending(fh))
2986                 return POLLPRI;
2987         poll_wait(file, &fh->wait, wait);
2988         return 0;
2989 }
2990 EXPORT_SYMBOL(v4l2_ctrl_poll);