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_MV_H_SEARCH_RANGE:             return "Horizontal MV Search Range";
 739         case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:             return "Vertical MV Search Range";
 740         case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:             return "Repeat Sequence Header";
 741
 742         /* VPX controls */
 743         case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:            return "VPX Number of Partitions";
 744         case V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4:           return "VPX Intra Mode Decision Disable";
 745         case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:            return "VPX No. of Refs for P Frame";
 746         case V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL:              return "VPX Loop Filter Level Range";
 747         case V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS:          return "VPX Deblocking Effect Control";
 748         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD:   return "VPX Golden Frame Refresh Period";
 749         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:          return "VPX Golden Frame Indicator";
 750         case V4L2_CID_MPEG_VIDEO_VPX_MIN_QP:                    return "VPX Minimum QP Value";
 751         case V4L2_CID_MPEG_VIDEO_VPX_MAX_QP:                    return "VPX Maximum QP Value";
 752         case V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP:                return "VPX I-Frame QP Value";
 753         case V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP:                return "VPX P-Frame QP Value";
 754         case V4L2_CID_MPEG_VIDEO_VPX_PROFILE:                   return "VPX Profile";
 755
 756         /* CAMERA controls */
 757         /* Keep the order of the 'case's the same as in videodev2.h! */
 758         case V4L2_CID_CAMERA_CLASS:             return "Camera Controls";
 759         case V4L2_CID_EXPOSURE_AUTO:            return "Auto Exposure";
 760         case V4L2_CID_EXPOSURE_ABSOLUTE:        return "Exposure Time, Absolute";
 761         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:   return "Exposure, Dynamic Framerate";
 762         case V4L2_CID_PAN_RELATIVE:             return "Pan, Relative";
 763         case V4L2_CID_TILT_RELATIVE:            return "Tilt, Relative";
 764         case V4L2_CID_PAN_RESET:                return "Pan, Reset";
 765         case V4L2_CID_TILT_RESET:               return "Tilt, Reset";
 766         case V4L2_CID_PAN_ABSOLUTE:             return "Pan, Absolute";
 767         case V4L2_CID_TILT_ABSOLUTE:            return "Tilt, Absolute";
 768         case V4L2_CID_FOCUS_ABSOLUTE:           return "Focus, Absolute";
 769         case V4L2_CID_FOCUS_RELATIVE:           return "Focus, Relative";
 770         case V4L2_CID_FOCUS_AUTO:               return "Focus, Automatic Continuous";
 771         case V4L2_CID_ZOOM_ABSOLUTE:            return "Zoom, Absolute";
 772         case V4L2_CID_ZOOM_RELATIVE:            return "Zoom, Relative";
 773         case V4L2_CID_ZOOM_CONTINUOUS:          return "Zoom, Continuous";
 774         case V4L2_CID_PRIVACY:                  return "Privacy";
 775         case V4L2_CID_IRIS_ABSOLUTE:            return "Iris, Absolute";
 776         case V4L2_CID_IRIS_RELATIVE:            return "Iris, Relative";
 777         case V4L2_CID_AUTO_EXPOSURE_BIAS:       return "Auto Exposure, Bias";
 778         case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
 779         case V4L2_CID_WIDE_DYNAMIC_RANGE:       return "Wide Dynamic Range";
 780         case V4L2_CID_IMAGE_STABILIZATION:      return "Image Stabilization";
 781         case V4L2_CID_ISO_SENSITIVITY:          return "ISO Sensitivity";
 782         case V4L2_CID_ISO_SENSITIVITY_AUTO:     return "ISO Sensitivity, Auto";
 783         case V4L2_CID_EXPOSURE_METERING:        return "Exposure, Metering Mode";
 784         case V4L2_CID_SCENE_MODE:               return "Scene Mode";
 785         case V4L2_CID_3A_LOCK:                  return "3A Lock";
 786         case V4L2_CID_AUTO_FOCUS_START:         return "Auto Focus, Start";
 787         case V4L2_CID_AUTO_FOCUS_STOP:          return "Auto Focus, Stop";
 788         case V4L2_CID_AUTO_FOCUS_STATUS:        return "Auto Focus, Status";
 789         case V4L2_CID_AUTO_FOCUS_RANGE:         return "Auto Focus, Range";
 790
 791         /* FM Radio Modulator control */
 792         /* Keep the order of the 'case's the same as in videodev2.h! */
 793         case V4L2_CID_FM_TX_CLASS:              return "FM Radio Modulator Controls";
 794         case V4L2_CID_RDS_TX_DEVIATION:         return "RDS Signal Deviation";
 795         case V4L2_CID_RDS_TX_PI:                return "RDS Program ID";
 796         case V4L2_CID_RDS_TX_PTY:               return "RDS Program Type";
 797         case V4L2_CID_RDS_TX_PS_NAME:           return "RDS PS Name";
 798         case V4L2_CID_RDS_TX_RADIO_TEXT:        return "RDS Radio Text";
 799         case V4L2_CID_AUDIO_LIMITER_ENABLED:    return "Audio Limiter Feature Enabled";
 800         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
 801         case V4L2_CID_AUDIO_LIMITER_DEVIATION:  return "Audio Limiter Deviation";
 802         case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
 803         case V4L2_CID_AUDIO_COMPRESSION_GAIN:   return "Audio Compression Gain";
 804         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
 805         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
 806         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
 807         case V4L2_CID_PILOT_TONE_ENABLED:       return "Pilot Tone Feature Enabled";
 808         case V4L2_CID_PILOT_TONE_DEVIATION:     return "Pilot Tone Deviation";
 809         case V4L2_CID_PILOT_TONE_FREQUENCY:     return "Pilot Tone Frequency";
 810         case V4L2_CID_TUNE_PREEMPHASIS:         return "Pre-Emphasis";
 811         case V4L2_CID_TUNE_POWER_LEVEL:         return "Tune Power Level";
 812         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:   return "Tune Antenna Capacitor";
 813
 814         /* Flash controls */
 815         case V4L2_CID_FLASH_CLASS:              return "Flash Controls";
 816         case V4L2_CID_FLASH_LED_MODE:           return "LED Mode";
 817         case V4L2_CID_FLASH_STROBE_SOURCE:      return "Strobe Source";
 818         case V4L2_CID_FLASH_STROBE:             return "Strobe";
 819         case V4L2_CID_FLASH_STROBE_STOP:        return "Stop Strobe";
 820         case V4L2_CID_FLASH_STROBE_STATUS:      return "Strobe Status";
 821         case V4L2_CID_FLASH_TIMEOUT:            return "Strobe Timeout";
 822         case V4L2_CID_FLASH_INTENSITY:          return "Intensity, Flash Mode";
 823         case V4L2_CID_FLASH_TORCH_INTENSITY:    return "Intensity, Torch Mode";
 824         case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
 825         case V4L2_CID_FLASH_FAULT:              return "Faults";
 826         case V4L2_CID_FLASH_CHARGE:             return "Charge";
 827         case V4L2_CID_FLASH_READY:              return "Ready to Strobe";
 828
 829         /* JPEG encoder controls */
 830         /* Keep the order of the 'case's the same as in videodev2.h! */
 831         case V4L2_CID_JPEG_CLASS:               return "JPEG Compression Controls";
 832         case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:  return "Chroma Subsampling";
 833         case V4L2_CID_JPEG_RESTART_INTERVAL:    return "Restart Interval";
 834         case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
 835         case V4L2_CID_JPEG_ACTIVE_MARKER:       return "Active Markers";
 836
 837         /* Image source controls */
 838         case V4L2_CID_IMAGE_SOURCE_CLASS:       return "Image Source Controls";
 839         case V4L2_CID_VBLANK:                   return "Vertical Blanking";
 840         case V4L2_CID_HBLANK:                   return "Horizontal Blanking";
 841         case V4L2_CID_ANALOGUE_GAIN:            return "Analogue Gain";
 842
 843         /* Image processing controls */
 844         case V4L2_CID_IMAGE_PROC_CLASS:         return "Image Processing Controls";
 845         case V4L2_CID_LINK_FREQ:                return "Link Frequency";
 846         case V4L2_CID_PIXEL_RATE:               return "Pixel Rate";
 847         case V4L2_CID_TEST_PATTERN:             return "Test Pattern";
 848
 849         /* DV controls */
 850         case V4L2_CID_DV_CLASS:                 return "Digital Video Controls";
 851         case V4L2_CID_DV_TX_HOTPLUG:            return "Hotplug Present";
 852         case V4L2_CID_DV_TX_RXSENSE:            return "RxSense Present";
 853         case V4L2_CID_DV_TX_EDID_PRESENT:       return "EDID Present";
 854         case V4L2_CID_DV_TX_MODE:               return "Transmit Mode";
 855         case V4L2_CID_DV_TX_RGB_RANGE:          return "Tx RGB Quantization Range";
 856         case V4L2_CID_DV_RX_POWER_PRESENT:      return "Power Present";
 857         case V4L2_CID_DV_RX_RGB_RANGE:          return "Rx RGB Quantization Range";
 858
 859         case V4L2_CID_FM_RX_CLASS:              return "FM Radio Receiver Controls";
 860         case V4L2_CID_TUNE_DEEMPHASIS:          return "De-Emphasis";
 861         case V4L2_CID_RDS_RECEPTION:            return "RDS Reception";
 862
 863         case V4L2_CID_RF_TUNER_CLASS:           return "RF Tuner Controls";
 864         case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:   return "LNA Gain, Auto";
 865         case V4L2_CID_RF_TUNER_LNA_GAIN:        return "LNA Gain";
 866         case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO: return "Mixer Gain, Auto";
 867         case V4L2_CID_RF_TUNER_MIXER_GAIN:      return "Mixer Gain";
 868         case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:    return "IF Gain, Auto";
 869         case V4L2_CID_RF_TUNER_IF_GAIN:         return "IF Gain";
 870         case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:  return "Bandwidth, Auto";
 871         case V4L2_CID_RF_TUNER_BANDWIDTH:       return "Bandwidth";
 872         case V4L2_CID_RF_TUNER_PLL_LOCK:        return "PLL Lock";
 873         default:
 874                 return NULL;
 875         }
 876 }
 877 EXPORT_SYMBOL(v4l2_ctrl_get_name);
 878
 879 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
 880                     s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
 881 {
 882         *name = v4l2_ctrl_get_name(id);
 883         *flags = 0;
 884
 885         switch (id) {
 886         case V4L2_CID_AUDIO_MUTE:
 887         case V4L2_CID_AUDIO_LOUDNESS:
 888         case V4L2_CID_AUTO_WHITE_BALANCE:
 889         case V4L2_CID_AUTOGAIN:
 890         case V4L2_CID_HFLIP:
 891         case V4L2_CID_VFLIP:
 892         case V4L2_CID_HUE_AUTO:
 893         case V4L2_CID_CHROMA_AGC:
 894         case V4L2_CID_COLOR_KILLER:
 895         case V4L2_CID_AUTOBRIGHTNESS:
 896         case V4L2_CID_MPEG_AUDIO_MUTE:
 897         case V4L2_CID_MPEG_VIDEO_MUTE:
 898         case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
 899         case V4L2_CID_MPEG_VIDEO_PULLDOWN:
 900         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
 901         case V4L2_CID_FOCUS_AUTO:
 902         case V4L2_CID_PRIVACY:
 903         case V4L2_CID_AUDIO_LIMITER_ENABLED:
 904         case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
 905         case V4L2_CID_PILOT_TONE_ENABLED:
 906         case V4L2_CID_ILLUMINATORS_1:
 907         case V4L2_CID_ILLUMINATORS_2:
 908         case V4L2_CID_FLASH_STROBE_STATUS:
 909         case V4L2_CID_FLASH_CHARGE:
 910         case V4L2_CID_FLASH_READY:
 911         case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
 912         case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
 913         case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
 914         case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
 915         case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
 916         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
 917         case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
 918         case V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER:
 919         case V4L2_CID_WIDE_DYNAMIC_RANGE:
 920         case V4L2_CID_IMAGE_STABILIZATION:
 921         case V4L2_CID_RDS_RECEPTION:
 922         case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO:
 923         case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO:
 924         case V4L2_CID_RF_TUNER_IF_GAIN_AUTO:
 925         case V4L2_CID_RF_TUNER_BANDWIDTH_AUTO:
 926         case V4L2_CID_RF_TUNER_PLL_LOCK:
 927                 *type = V4L2_CTRL_TYPE_BOOLEAN;
 928                 *min = 0;
 929                 *max = *step = 1;
 930                 break;
 931         case V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE:
 932         case V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE:
 933                 *type = V4L2_CTRL_TYPE_INTEGER;
 934                 break;
 935         case V4L2_CID_PAN_RESET:
 936         case V4L2_CID_TILT_RESET:
 937         case V4L2_CID_FLASH_STROBE:
 938         case V4L2_CID_FLASH_STROBE_STOP:
 939         case V4L2_CID_AUTO_FOCUS_START:
 940         case V4L2_CID_AUTO_FOCUS_STOP:
 941                 *type = V4L2_CTRL_TYPE_BUTTON;
 942                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
 943                 *min = *max = *step = *def = 0;
 944                 break;
 945         case V4L2_CID_POWER_LINE_FREQUENCY:
 946         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
 947         case V4L2_CID_MPEG_AUDIO_ENCODING:
 948         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
 949         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
 950         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
 951         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
 952         case V4L2_CID_MPEG_AUDIO_MODE:
 953         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
 954         case V4L2_CID_MPEG_AUDIO_EMPHASIS:
 955         case V4L2_CID_MPEG_AUDIO_CRC:
 956         case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
 957         case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
 958         case V4L2_CID_MPEG_VIDEO_ENCODING:
 959         case V4L2_CID_MPEG_VIDEO_ASPECT:
 960         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 961         case V4L2_CID_MPEG_STREAM_TYPE:
 962         case V4L2_CID_MPEG_STREAM_VBI_FMT:
 963         case V4L2_CID_EXPOSURE_AUTO:
 964         case V4L2_CID_AUTO_FOCUS_RANGE:
 965         case V4L2_CID_COLORFX:
 966         case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
 967         case V4L2_CID_TUNE_PREEMPHASIS:
 968         case V4L2_CID_FLASH_LED_MODE:
 969         case V4L2_CID_FLASH_STROBE_SOURCE:
 970         case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
 971         case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
 972         case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
 973         case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
 974         case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
 975         case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
 976         case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
 977         case V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE:
 978         case V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE:
 979         case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
 980         case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
 981         case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
 982         case V4L2_CID_ISO_SENSITIVITY_AUTO:
 983         case V4L2_CID_EXPOSURE_METERING:
 984         case V4L2_CID_SCENE_MODE:
 985         case V4L2_CID_DV_TX_MODE:
 986         case V4L2_CID_DV_TX_RGB_RANGE:
 987         case V4L2_CID_DV_RX_RGB_RANGE:
 988         case V4L2_CID_TEST_PATTERN:
 989         case V4L2_CID_TUNE_DEEMPHASIS:
 990         case V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL:
 991                 *type = V4L2_CTRL_TYPE_MENU;
 992                 break;
 993         case V4L2_CID_LINK_FREQ:
 994                 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
 995                 break;
 996         case V4L2_CID_RDS_TX_PS_NAME:
 997         case V4L2_CID_RDS_TX_RADIO_TEXT:
 998                 *type = V4L2_CTRL_TYPE_STRING;
 999                 break;
1000         case V4L2_CID_ISO_SENSITIVITY:
1001         case V4L2_CID_AUTO_EXPOSURE_BIAS:
1002         case V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS:
1003         case V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES:
1004                 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
1005                 break;
1006         case V4L2_CID_USER_CLASS:
1007         case V4L2_CID_CAMERA_CLASS:
1008         case V4L2_CID_MPEG_CLASS:
1009         case V4L2_CID_FM_TX_CLASS:
1010         case V4L2_CID_FLASH_CLASS:
1011         case V4L2_CID_JPEG_CLASS:
1012         case V4L2_CID_IMAGE_SOURCE_CLASS:
1013         case V4L2_CID_IMAGE_PROC_CLASS:
1014         case V4L2_CID_DV_CLASS:
1015         case V4L2_CID_FM_RX_CLASS:
1016         case V4L2_CID_RF_TUNER_CLASS:
1017                 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
1018                 /* You can neither read not write these */
1019                 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
1020                 *min = *max = *step = *def = 0;
1021                 break;
1022         case V4L2_CID_BG_COLOR:
1023                 *type = V4L2_CTRL_TYPE_INTEGER;
1024                 *step = 1;
1025                 *min = 0;
1026                 /* Max is calculated as RGB888 that is 2^24 */
1027                 *max = 0xFFFFFF;
1028                 break;
1029         case V4L2_CID_FLASH_FAULT:
1030         case V4L2_CID_JPEG_ACTIVE_MARKER:
1031         case V4L2_CID_3A_LOCK:
1032         case V4L2_CID_AUTO_FOCUS_STATUS:
1033         case V4L2_CID_DV_TX_HOTPLUG:
1034         case V4L2_CID_DV_TX_RXSENSE:
1035         case V4L2_CID_DV_TX_EDID_PRESENT:
1036         case V4L2_CID_DV_RX_POWER_PRESENT:
1037                 *type = V4L2_CTRL_TYPE_BITMASK;
1038                 break;
1039         case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
1040         case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
1041                 *type = V4L2_CTRL_TYPE_INTEGER;
1042                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1043                 break;
1044         case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
1045         case V4L2_CID_MPEG_VIDEO_DEC_PTS:
1046                 *flags |= V4L2_CTRL_FLAG_VOLATILE;
1047                 /* Fall through */
1048         case V4L2_CID_PIXEL_RATE:
1049                 *type = V4L2_CTRL_TYPE_INTEGER64;
1050                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1051                 *min = *max = *step = *def = 0;
1052                 break;
1053         default:
1054                 *type = V4L2_CTRL_TYPE_INTEGER;
1055                 break;
1056         }
1057         switch (id) {
1058         case V4L2_CID_MPEG_AUDIO_ENCODING:
1059         case V4L2_CID_MPEG_AUDIO_MODE:
1060         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
1061         case V4L2_CID_MPEG_VIDEO_B_FRAMES:
1062         case V4L2_CID_MPEG_STREAM_TYPE:
1063                 *flags |= V4L2_CTRL_FLAG_UPDATE;
1064                 break;
1065         case V4L2_CID_AUDIO_VOLUME:
1066         case V4L2_CID_AUDIO_BALANCE:
1067         case V4L2_CID_AUDIO_BASS:
1068         case V4L2_CID_AUDIO_TREBLE:
1069         case V4L2_CID_BRIGHTNESS:
1070         case V4L2_CID_CONTRAST:
1071         case V4L2_CID_SATURATION:
1072         case V4L2_CID_HUE:
1073         case V4L2_CID_RED_BALANCE:
1074         case V4L2_CID_BLUE_BALANCE:
1075         case V4L2_CID_GAMMA:
1076         case V4L2_CID_SHARPNESS:
1077         case V4L2_CID_CHROMA_GAIN:
1078         case V4L2_CID_RDS_TX_DEVIATION:
1079         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
1080         case V4L2_CID_AUDIO_LIMITER_DEVIATION:
1081         case V4L2_CID_AUDIO_COMPRESSION_GAIN:
1082         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
1083         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
1084         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
1085         case V4L2_CID_PILOT_TONE_DEVIATION:
1086         case V4L2_CID_PILOT_TONE_FREQUENCY:
1087         case V4L2_CID_TUNE_POWER_LEVEL:
1088         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
1089         case V4L2_CID_RF_TUNER_LNA_GAIN:
1090         case V4L2_CID_RF_TUNER_MIXER_GAIN:
1091         case V4L2_CID_RF_TUNER_IF_GAIN:
1092         case V4L2_CID_RF_TUNER_BANDWIDTH:
1093                 *flags |= V4L2_CTRL_FLAG_SLIDER;
1094                 break;
1095         case V4L2_CID_PAN_RELATIVE:
1096         case V4L2_CID_TILT_RELATIVE:
1097         case V4L2_CID_FOCUS_RELATIVE:
1098         case V4L2_CID_IRIS_RELATIVE:
1099         case V4L2_CID_ZOOM_RELATIVE:
1100                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1101                 break;
1102         case V4L2_CID_FLASH_STROBE_STATUS:
1103         case V4L2_CID_AUTO_FOCUS_STATUS:
1104         case V4L2_CID_FLASH_READY:
1105         case V4L2_CID_DV_TX_HOTPLUG:
1106         case V4L2_CID_DV_TX_RXSENSE:
1107         case V4L2_CID_DV_TX_EDID_PRESENT:
1108         case V4L2_CID_DV_RX_POWER_PRESENT:
1109                 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
1110                 break;
1111         case V4L2_CID_RF_TUNER_PLL_LOCK:
1112                 *flags |= V4L2_CTRL_FLAG_VOLATILE;
1113                 break;
1114         }
1115 }
1116 EXPORT_SYMBOL(v4l2_ctrl_fill);
1117
1118 /* Helper function to determine whether the control type is compatible with
1119    VIDIOC_G/S_CTRL. */
1120 static bool type_is_int(const struct v4l2_ctrl *ctrl)
1121 {
1122         switch (ctrl->type) {
1123         case V4L2_CTRL_TYPE_INTEGER64:
1124         case V4L2_CTRL_TYPE_STRING:
1125                 /* Nope, these need v4l2_ext_control */
1126                 return false;
1127         default:
1128                 return true;
1129         }
1130 }
1131
1132 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
1133 {
1134         memset(ev->reserved, 0, sizeof(ev->reserved));
1135         ev->type = V4L2_EVENT_CTRL;
1136         ev->id = ctrl->id;
1137         ev->u.ctrl.changes = changes;
1138         ev->u.ctrl.type = ctrl->type;
1139         ev->u.ctrl.flags = ctrl->flags;
1140         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
1141                 ev->u.ctrl.value64 = 0;
1142         else
1143                 ev->u.ctrl.value64 = ctrl->cur.val64;
1144         ev->u.ctrl.minimum = ctrl->minimum;
1145         ev->u.ctrl.maximum = ctrl->maximum;
1146         if (ctrl->type == V4L2_CTRL_TYPE_MENU
1147             || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
1148                 ev->u.ctrl.step = 1;
1149         else
1150                 ev->u.ctrl.step = ctrl->step;
1151         ev->u.ctrl.default_value = ctrl->default_value;
1152 }
1153
1154 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1155 {
1156         struct v4l2_event ev;
1157         struct v4l2_subscribed_event *sev;
1158
1159         if (list_empty(&ctrl->ev_subs))
1160                 return;
1161         fill_event(&ev, ctrl, changes);
1162
1163         list_for_each_entry(sev, &ctrl->ev_subs, node)
1164                 if (sev->fh != fh ||
1165                     (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
1166                         v4l2_event_queue_fh(sev->fh, &ev);
1167 }
1168
1169 /* Helper function: copy the current control value back to the caller */
1170 static int cur_to_user(struct v4l2_ext_control *c,
1171                        struct v4l2_ctrl *ctrl)
1172 {
1173         u32 len;
1174
1175         switch (ctrl->type) {
1176         case V4L2_CTRL_TYPE_STRING:
1177                 len = strlen(ctrl->cur.string);
1178                 if (c->size < len + 1) {
1179                         c->size = len + 1;
1180                         return -ENOSPC;
1181                 }
1182                 return copy_to_user(c->string, ctrl->cur.string,
1183                                                 len + 1) ? -EFAULT : 0;
1184         case V4L2_CTRL_TYPE_INTEGER64:
1185                 c->value64 = ctrl->cur.val64;
1186                 break;
1187         default:
1188                 c->value = ctrl->cur.val;
1189                 break;
1190         }
1191         return 0;
1192 }
1193
1194 /* Helper function: copy the caller-provider value as the new control value */
1195 static int user_to_new(struct v4l2_ext_control *c,
1196                        struct v4l2_ctrl *ctrl)
1197 {
1198         int ret;
1199         u32 size;
1200
1201         ctrl->is_new = 1;
1202         switch (ctrl->type) {
1203         case V4L2_CTRL_TYPE_INTEGER64:
1204                 ctrl->val64 = c->value64;
1205                 break;
1206         case V4L2_CTRL_TYPE_STRING:
1207                 size = c->size;
1208                 if (size == 0)
1209                         return -ERANGE;
1210                 if (size > ctrl->maximum + 1)
1211                         size = ctrl->maximum + 1;
1212                 ret = copy_from_user(ctrl->string, c->string, size);
1213                 if (!ret) {
1214                         char last = ctrl->string[size - 1];
1215
1216                         ctrl->string[size - 1] = 0;
1217                         /* If the string was longer than ctrl->maximum,
1218                            then return an error. */
1219                         if (strlen(ctrl->string) == ctrl->maximum && last)
1220                                 return -ERANGE;
1221                 }
1222                 return ret ? -EFAULT : 0;
1223         default:
1224                 ctrl->val = c->value;
1225                 break;
1226         }
1227         return 0;
1228 }
1229
1230 /* Helper function: copy the new control value back to the caller */
1231 static int new_to_user(struct v4l2_ext_control *c,
1232                        struct v4l2_ctrl *ctrl)
1233 {
1234         u32 len;
1235
1236         switch (ctrl->type) {
1237         case V4L2_CTRL_TYPE_STRING:
1238                 len = strlen(ctrl->string);
1239                 if (c->size < len + 1) {
1240                         c->size = ctrl->maximum + 1;
1241                         return -ENOSPC;
1242                 }
1243                 return copy_to_user(c->string, ctrl->string,
1244                                                 len + 1) ? -EFAULT : 0;
1245         case V4L2_CTRL_TYPE_INTEGER64:
1246                 c->value64 = ctrl->val64;
1247                 break;
1248         default:
1249                 c->value = ctrl->val;
1250                 break;
1251         }
1252         return 0;
1253 }
1254
1255 /* Copy the new value to the current value. */
1256 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 ch_flags)
1257 {
1258         bool changed = false;
1259
1260         if (ctrl == NULL)
1261                 return;
1262         switch (ctrl->type) {
1263         case V4L2_CTRL_TYPE_BUTTON:
1264                 changed = true;
1265                 break;
1266         case V4L2_CTRL_TYPE_STRING:
1267                 /* strings are always 0-terminated */
1268                 changed = strcmp(ctrl->string, ctrl->cur.string);
1269                 strcpy(ctrl->cur.string, ctrl->string);
1270                 break;
1271         case V4L2_CTRL_TYPE_INTEGER64:
1272                 changed = ctrl->val64 != ctrl->cur.val64;
1273                 ctrl->cur.val64 = ctrl->val64;
1274                 break;
1275         default:
1276                 changed = ctrl->val != ctrl->cur.val;
1277                 ctrl->cur.val = ctrl->val;
1278                 break;
1279         }
1280         if (ch_flags & V4L2_EVENT_CTRL_CH_FLAGS) {
1281                 /* Note: CH_FLAGS is only set for auto clusters. */
1282                 ctrl->flags &=
1283                         ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1284                 if (!is_cur_manual(ctrl->cluster[0])) {
1285                         ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1286                         if (ctrl->cluster[0]->has_volatiles)
1287                                 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1288                 }
1289                 fh = NULL;
1290         }
1291         if (changed || ch_flags) {
1292                 /* If a control was changed that was not one of the controls
1293                    modified by the application, then send the event to all. */
1294                 if (!ctrl->is_new)
1295                         fh = NULL;
1296                 send_event(fh, ctrl,
1297                         (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) | ch_flags);
1298                 if (ctrl->call_notify && changed && ctrl->handler->notify)
1299                         ctrl->handler->notify(ctrl, ctrl->handler->notify_priv);
1300         }
1301 }
1302
1303 /* Copy the current value to the new value */
1304 static void cur_to_new(struct v4l2_ctrl *ctrl)
1305 {
1306         if (ctrl == NULL)
1307                 return;
1308         switch (ctrl->type) {
1309         case V4L2_CTRL_TYPE_STRING:
1310                 /* strings are always 0-terminated */
1311                 strcpy(ctrl->string, ctrl->cur.string);
1312                 break;
1313         case V4L2_CTRL_TYPE_INTEGER64:
1314                 ctrl->val64 = ctrl->cur.val64;
1315                 break;
1316         default:
1317                 ctrl->val = ctrl->cur.val;
1318                 break;
1319         }
1320 }
1321
1322 /* Return non-zero if one or more of the controls in the cluster has a new
1323    value that differs from the current value. */
1324 static int cluster_changed(struct v4l2_ctrl *master)
1325 {
1326         int diff = 0;
1327         int i;
1328
1329         for (i = 0; !diff && i < master->ncontrols; i++) {
1330                 struct v4l2_ctrl *ctrl = master->cluster[i];
1331
1332                 if (ctrl == NULL)
1333                         continue;
1334                 switch (ctrl->type) {
1335                 case V4L2_CTRL_TYPE_BUTTON:
1336                         /* Button controls are always 'different' */
1337                         return 1;
1338                 case V4L2_CTRL_TYPE_STRING:
1339                         /* strings are always 0-terminated */
1340                         diff = strcmp(ctrl->string, ctrl->cur.string);
1341                         break;
1342                 case V4L2_CTRL_TYPE_INTEGER64:
1343                         diff = ctrl->val64 != ctrl->cur.val64;
1344                         break;
1345                 default:
1346                         diff = ctrl->val != ctrl->cur.val;
1347                         break;
1348                 }
1349         }
1350         return diff;
1351 }
1352
1353 /* Control range checking */
1354 static int check_range(enum v4l2_ctrl_type type,
1355                 s32 min, s32 max, u32 step, s32 def)
1356 {
1357         switch (type) {
1358         case V4L2_CTRL_TYPE_BOOLEAN:
1359                 if (step != 1 || max > 1 || min < 0)
1360                         return -ERANGE;
1361                 /* fall through */
1362         case V4L2_CTRL_TYPE_INTEGER:
1363                 if (step <= 0 || min > max || def < min || def > max)
1364                         return -ERANGE;
1365                 return 0;
1366         case V4L2_CTRL_TYPE_BITMASK:
1367                 if (step || min || !max || (def & ~max))
1368                         return -ERANGE;
1369                 return 0;
1370         case V4L2_CTRL_TYPE_MENU:
1371         case V4L2_CTRL_TYPE_INTEGER_MENU:
1372                 if (min > max || def < min || def > max)
1373                         return -ERANGE;
1374                 /* Note: step == menu_skip_mask for menu controls.
1375                    So here we check if the default value is masked out. */
1376                 if (step && ((1 << def) & step))
1377                         return -EINVAL;
1378                 return 0;
1379         case V4L2_CTRL_TYPE_STRING:
1380                 if (min > max || min < 0 || step < 1 || def)
1381                         return -ERANGE;
1382                 return 0;
1383         default:
1384                 return 0;
1385         }
1386 }
1387
1388 /* Validate a new control */
1389 static int validate_new(const struct v4l2_ctrl *ctrl,
1390                         struct v4l2_ext_control *c)
1391 {
1392         size_t len;
1393         u32 offset;
1394         s32 val;
1395
1396         switch (ctrl->type) {
1397         case V4L2_CTRL_TYPE_INTEGER:
1398                 /* Round towards the closest legal value */
1399                 val = c->value + ctrl->step / 2;
1400                 val = clamp(val, ctrl->minimum, ctrl->maximum);
1401                 offset = val - ctrl->minimum;
1402                 offset = ctrl->step * (offset / ctrl->step);
1403                 c->value = ctrl->minimum + offset;
1404                 return 0;
1405
1406         case V4L2_CTRL_TYPE_BOOLEAN:
1407                 c->value = !!c->value;
1408                 return 0;
1409
1410         case V4L2_CTRL_TYPE_MENU:
1411         case V4L2_CTRL_TYPE_INTEGER_MENU:
1412                 if (c->value < ctrl->minimum || c->value > ctrl->maximum)
1413                         return -ERANGE;
1414                 if (ctrl->menu_skip_mask & (1 << c->value))
1415                         return -EINVAL;
1416                 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1417                     ctrl->qmenu[c->value][0] == '\0')
1418                         return -EINVAL;
1419                 return 0;
1420
1421         case V4L2_CTRL_TYPE_BITMASK:
1422                 c->value &= ctrl->maximum;
1423                 return 0;
1424
1425         case V4L2_CTRL_TYPE_BUTTON:
1426         case V4L2_CTRL_TYPE_CTRL_CLASS:
1427                 c->value = 0;
1428                 return 0;
1429
1430         case V4L2_CTRL_TYPE_INTEGER64:
1431                 return 0;
1432
1433         case V4L2_CTRL_TYPE_STRING:
1434                 len = strlen(c->string);
1435                 if (len < ctrl->minimum)
1436                         return -ERANGE;
1437                 if ((len - ctrl->minimum) % ctrl->step)
1438                         return -ERANGE;
1439                 return 0;
1440
1441         default:
1442                 return -EINVAL;
1443         }
1444 }
1445
1446 static inline u32 node2id(struct list_head *node)
1447 {
1448         return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1449 }
1450
1451 /* Set the handler's error code if it wasn't set earlier already */
1452 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1453 {
1454         if (hdl->error == 0)
1455                 hdl->error = err;
1456         return err;
1457 }
1458
1459 /* Initialize the handler */
1460 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
1461                                  unsigned nr_of_controls_hint,
1462                                  struct lock_class_key *key, const char *name)
1463 {
1464         hdl->lock = &hdl->_lock;
1465         mutex_init(hdl->lock);
1466         lockdep_set_class_and_name(hdl->lock, key, name);
1467         INIT_LIST_HEAD(&hdl->ctrls);
1468         INIT_LIST_HEAD(&hdl->ctrl_refs);
1469         hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
1470         hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1471                                GFP_KERNEL);
1472         hdl->error = hdl->buckets ? 0 : -ENOMEM;
1473         return hdl->error;
1474 }
1475 EXPORT_SYMBOL(v4l2_ctrl_handler_init_class);
1476
1477 /* Free all controls and control refs */
1478 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1479 {
1480         struct v4l2_ctrl_ref *ref, *next_ref;
1481         struct v4l2_ctrl *ctrl, *next_ctrl;
1482         struct v4l2_subscribed_event *sev, *next_sev;
1483
1484         if (hdl == NULL || hdl->buckets == NULL)
1485                 return;
1486
1487         mutex_lock(hdl->lock);
1488         /* Free all nodes */
1489         list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1490                 list_del(&ref->node);
1491                 kfree(ref);
1492         }
1493         /* Free all controls owned by the handler */
1494         list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1495                 list_del(&ctrl->node);
1496                 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1497                         list_del(&sev->node);
1498                 kfree(ctrl);
1499         }
1500         kfree(hdl->buckets);
1501         hdl->buckets = NULL;
1502         hdl->cached = NULL;
1503         hdl->error = 0;
1504         mutex_unlock(hdl->lock);
1505 }
1506 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1507
1508 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1509    be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1510    with applications that do not use the NEXT_CTRL flag.
1511
1512    We just find the n-th private user control. It's O(N), but that should not
1513    be an issue in this particular case. */
1514 static struct v4l2_ctrl_ref *find_private_ref(
1515                 struct v4l2_ctrl_handler *hdl, u32 id)
1516 {
1517         struct v4l2_ctrl_ref *ref;
1518
1519         id -= V4L2_CID_PRIVATE_BASE;
1520         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1521                 /* Search for private user controls that are compatible with
1522                    VIDIOC_G/S_CTRL. */
1523                 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1524                     V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1525                         if (!type_is_int(ref->ctrl))
1526                                 continue;
1527                         if (id == 0)
1528                                 return ref;
1529                         id--;
1530                 }
1531         }
1532         return NULL;
1533 }
1534
1535 /* Find a control with the given ID. */
1536 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1537 {
1538         struct v4l2_ctrl_ref *ref;
1539         int bucket;
1540
1541         id &= V4L2_CTRL_ID_MASK;
1542
1543         /* Old-style private controls need special handling */
1544         if (id >= V4L2_CID_PRIVATE_BASE)
1545                 return find_private_ref(hdl, id);
1546         bucket = id % hdl->nr_of_buckets;
1547
1548         /* Simple optimization: cache the last control found */
1549         if (hdl->cached && hdl->cached->ctrl->id == id)
1550                 return hdl->cached;
1551
1552         /* Not in cache, search the hash */
1553         ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1554         while (ref && ref->ctrl->id != id)
1555                 ref = ref->next;
1556
1557         if (ref)
1558                 hdl->cached = ref; /* cache it! */
1559         return ref;
1560 }
1561
1562 /* Find a control with the given ID. Take the handler's lock first. */
1563 static struct v4l2_ctrl_ref *find_ref_lock(
1564                 struct v4l2_ctrl_handler *hdl, u32 id)
1565 {
1566         struct v4l2_ctrl_ref *ref = NULL;
1567
1568         if (hdl) {
1569                 mutex_lock(hdl->lock);
1570                 ref = find_ref(hdl, id);
1571                 mutex_unlock(hdl->lock);
1572         }
1573         return ref;
1574 }
1575
1576 /* Find a control with the given ID. */
1577 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1578 {
1579         struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1580
1581         return ref ? ref->ctrl : NULL;
1582 }
1583 EXPORT_SYMBOL(v4l2_ctrl_find);
1584
1585 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1586 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1587                            struct v4l2_ctrl *ctrl)
1588 {
1589         struct v4l2_ctrl_ref *ref;
1590         struct v4l2_ctrl_ref *new_ref;
1591         u32 id = ctrl->id;
1592         u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1593         int bucket = id % hdl->nr_of_buckets;   /* which bucket to use */
1594
1595         /* Automatically add the control class if it is not yet present. */
1596         if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1597                 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1598                         return hdl->error;
1599
1600         if (hdl->error)
1601                 return hdl->error;
1602
1603         new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1604         if (!new_ref)
1605                 return handler_set_err(hdl, -ENOMEM);
1606         new_ref->ctrl = ctrl;
1607         if (ctrl->handler == hdl) {
1608                 /* By default each control starts in a cluster of its own.
1609                    new_ref->ctrl is basically a cluster array with one
1610                    element, so that's perfect to use as the cluster pointer.
1611                    But only do this for the handler that owns the control. */
1612                 ctrl->cluster = &new_ref->ctrl;
1613                 ctrl->ncontrols = 1;
1614         }
1615
1616         INIT_LIST_HEAD(&new_ref->node);
1617
1618         mutex_lock(hdl->lock);
1619
1620         /* Add immediately at the end of the list if the list is empty, or if
1621            the last element in the list has a lower ID.
1622            This ensures that when elements are added in ascending order the
1623            insertion is an O(1) operation. */
1624         if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1625                 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1626                 goto insert_in_hash;
1627         }
1628
1629         /* Find insert position in sorted list */
1630         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1631                 if (ref->ctrl->id < id)
1632                         continue;
1633                 /* Don't add duplicates */
1634                 if (ref->ctrl->id == id) {
1635                         kfree(new_ref);
1636                         goto unlock;
1637                 }
1638                 list_add(&new_ref->node, ref->node.prev);
1639                 break;
1640         }
1641
1642 insert_in_hash:
1643         /* Insert the control node in the hash */
1644         new_ref->next = hdl->buckets[bucket];
1645         hdl->buckets[bucket] = new_ref;
1646
1647 unlock:
1648         mutex_unlock(hdl->lock);
1649         return 0;
1650 }
1651
1652 /* Add a new control */
1653 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1654                         const struct v4l2_ctrl_ops *ops,
1655                         u32 id, const char *name, enum v4l2_ctrl_type type,
1656                         s32 min, s32 max, u32 step, s32 def,
1657                         u32 flags, const char * const *qmenu,
1658                         const s64 *qmenu_int, void *priv)
1659 {
1660         struct v4l2_ctrl *ctrl;
1661         unsigned sz_extra = 0;
1662         int err;
1663
1664         if (hdl->error)
1665                 return NULL;
1666
1667         /* Sanity checks */
1668         if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1669             (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1670             (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL)) {
1671                 handler_set_err(hdl, -ERANGE);
1672                 return NULL;
1673         }
1674         err = check_range(type, min, max, step, def);
1675         if (err) {
1676                 handler_set_err(hdl, err);
1677                 return NULL;
1678         }
1679         if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1680                 handler_set_err(hdl, -ERANGE);
1681                 return NULL;
1682         }
1683
1684         if (type == V4L2_CTRL_TYPE_BUTTON)
1685                 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1686         else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1687                 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1688         else if (type == V4L2_CTRL_TYPE_STRING)
1689                 sz_extra += 2 * (max + 1);
1690
1691         ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1692         if (ctrl == NULL) {
1693                 handler_set_err(hdl, -ENOMEM);
1694                 return NULL;
1695         }
1696
1697         INIT_LIST_HEAD(&ctrl->node);
1698         INIT_LIST_HEAD(&ctrl->ev_subs);
1699         ctrl->handler = hdl;
1700         ctrl->ops = ops;
1701         ctrl->id = id;
1702         ctrl->name = name;
1703         ctrl->type = type;
1704         ctrl->flags = flags;
1705         ctrl->minimum = min;
1706         ctrl->maximum = max;
1707         ctrl->step = step;
1708         if (type == V4L2_CTRL_TYPE_MENU)
1709                 ctrl->qmenu = qmenu;
1710         else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1711                 ctrl->qmenu_int = qmenu_int;
1712         ctrl->priv = priv;
1713         ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1714
1715         if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1716                 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1717                 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1718                 if (ctrl->minimum)
1719                         memset(ctrl->cur.string, ' ', ctrl->minimum);
1720         }
1721         if (handler_new_ref(hdl, ctrl)) {
1722                 kfree(ctrl);
1723                 return NULL;
1724         }
1725         mutex_lock(hdl->lock);
1726         list_add_tail(&ctrl->node, &hdl->ctrls);
1727         mutex_unlock(hdl->lock);
1728         return ctrl;
1729 }
1730
1731 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1732                         const struct v4l2_ctrl_config *cfg, void *priv)
1733 {
1734         bool is_menu;
1735         struct v4l2_ctrl *ctrl;
1736         const char *name = cfg->name;
1737         const char * const *qmenu = cfg->qmenu;
1738         const s64 *qmenu_int = cfg->qmenu_int;
1739         enum v4l2_ctrl_type type = cfg->type;
1740         u32 flags = cfg->flags;
1741         s32 min = cfg->min;
1742         s32 max = cfg->max;
1743         u32 step = cfg->step;
1744         s32 def = cfg->def;
1745
1746         if (name == NULL)
1747                 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1748                                                                 &def, &flags);
1749
1750         is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1751                    cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
1752         if (is_menu)
1753                 WARN_ON(step);
1754         else
1755                 WARN_ON(cfg->menu_skip_mask);
1756         if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
1757                 qmenu = v4l2_ctrl_get_menu(cfg->id);
1758         else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1759                  qmenu_int == NULL) {
1760                 handler_set_err(hdl, -EINVAL);
1761                 return NULL;
1762         }
1763
1764         ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1765                         type, min, max,
1766                         is_menu ? cfg->menu_skip_mask : step,
1767                         def, flags, qmenu, qmenu_int, priv);
1768         if (ctrl)
1769                 ctrl->is_private = cfg->is_private;
1770         return ctrl;
1771 }
1772 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1773
1774 /* Helper function for standard non-menu controls */
1775 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1776                         const struct v4l2_ctrl_ops *ops,
1777                         u32 id, s32 min, s32 max, u32 step, s32 def)
1778 {
1779         const char *name;
1780         enum v4l2_ctrl_type type;
1781         u32 flags;
1782
1783         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1784         if (type == V4L2_CTRL_TYPE_MENU
1785             || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
1786                 handler_set_err(hdl, -EINVAL);
1787                 return NULL;
1788         }
1789         return v4l2_ctrl_new(hdl, ops, id, name, type,
1790                              min, max, step, def, flags, NULL, NULL, NULL);
1791 }
1792 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1793
1794 /* Helper function for standard menu controls */
1795 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1796                         const struct v4l2_ctrl_ops *ops,
1797                         u32 id, s32 max, s32 mask, s32 def)
1798 {
1799         const char * const *qmenu = NULL;
1800         const s64 *qmenu_int = NULL;
1801         unsigned int qmenu_int_len = 0;
1802         const char *name;
1803         enum v4l2_ctrl_type type;
1804         s32 min;
1805         s32 step;
1806         u32 flags;
1807
1808         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1809
1810         if (type == V4L2_CTRL_TYPE_MENU)
1811                 qmenu = v4l2_ctrl_get_menu(id);
1812         else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1813                 qmenu_int = v4l2_ctrl_get_int_menu(id, &qmenu_int_len);
1814
1815         if ((!qmenu && !qmenu_int) || (qmenu_int && max > qmenu_int_len)) {
1816                 handler_set_err(hdl, -EINVAL);
1817                 return NULL;
1818         }
1819         return v4l2_ctrl_new(hdl, ops, id, name, type,
1820                              0, max, mask, def, flags, qmenu, qmenu_int, NULL);
1821 }
1822 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1823
1824 /* Helper function for standard menu controls with driver defined menu */
1825 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
1826                         const struct v4l2_ctrl_ops *ops, u32 id, s32 max,
1827                         s32 mask, s32 def, const char * const *qmenu)
1828 {
1829         enum v4l2_ctrl_type type;
1830         const char *name;
1831         u32 flags;
1832         s32 step;
1833         s32 min;
1834
1835         /* v4l2_ctrl_new_std_menu_items() should only be called for
1836          * standard controls without a standard menu.
1837          */
1838         if (v4l2_ctrl_get_menu(id)) {
1839                 handler_set_err(hdl, -EINVAL);
1840                 return NULL;
1841         }
1842
1843         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1844         if (type != V4L2_CTRL_TYPE_MENU || qmenu == NULL) {
1845                 handler_set_err(hdl, -EINVAL);
1846                 return NULL;
1847         }
1848         return v4l2_ctrl_new(hdl, ops, id, name, type, 0, max, mask, def,
1849                              flags, qmenu, NULL, NULL);
1850
1851 }
1852 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu_items);
1853
1854 /* Helper function for standard integer menu controls */
1855 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
1856                         const struct v4l2_ctrl_ops *ops,
1857                         u32 id, s32 max, s32 def, const s64 *qmenu_int)
1858 {
1859         const char *name;
1860         enum v4l2_ctrl_type type;
1861         s32 min;
1862         s32 step;
1863         u32 flags;
1864
1865         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1866         if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
1867                 handler_set_err(hdl, -EINVAL);
1868                 return NULL;
1869         }
1870         return v4l2_ctrl_new(hdl, ops, id, name, type,
1871                              0, max, 0, def, flags, NULL, qmenu_int, NULL);
1872 }
1873 EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
1874
1875 /* Add a control from another handler to this handler */
1876 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1877                                           struct v4l2_ctrl *ctrl)
1878 {
1879         if (hdl == NULL || hdl->error)
1880                 return NULL;
1881         if (ctrl == NULL) {
1882                 handler_set_err(hdl, -EINVAL);
1883                 return NULL;
1884         }
1885         if (ctrl->handler == hdl)
1886                 return ctrl;
1887         return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1888 }
1889 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1890
1891 /* Add the controls from another handler to our own. */
1892 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1893                           struct v4l2_ctrl_handler *add,
1894                           bool (*filter)(const struct v4l2_ctrl *ctrl))
1895 {
1896         struct v4l2_ctrl_ref *ref;
1897         int ret = 0;
1898
1899         /* Do nothing if either handler is NULL or if they are the same */
1900         if (!hdl || !add || hdl == add)
1901                 return 0;
1902         if (hdl->error)
1903                 return hdl->error;
1904         mutex_lock(add->lock);
1905         list_for_each_entry(ref, &add->ctrl_refs, node) {
1906                 struct v4l2_ctrl *ctrl = ref->ctrl;
1907
1908                 /* Skip handler-private controls. */
1909                 if (ctrl->is_private)
1910                         continue;
1911                 /* And control classes */
1912                 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1913                         continue;
1914                 /* Filter any unwanted controls */
1915                 if (filter && !filter(ctrl))
1916                         continue;
1917                 ret = handler_new_ref(hdl, ctrl);
1918                 if (ret)
1919                         break;
1920         }
1921         mutex_unlock(add->lock);
1922         return ret;
1923 }
1924 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1925
1926 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl)
1927 {
1928         if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_TX)
1929                 return true;
1930         if (V4L2_CTRL_ID2CLASS(ctrl->id) == V4L2_CTRL_CLASS_FM_RX)
1931                 return true;
1932         switch (ctrl->id) {
1933         case V4L2_CID_AUDIO_MUTE:
1934         case V4L2_CID_AUDIO_VOLUME:
1935         case V4L2_CID_AUDIO_BALANCE:
1936         case V4L2_CID_AUDIO_BASS:
1937         case V4L2_CID_AUDIO_TREBLE:
1938         case V4L2_CID_AUDIO_LOUDNESS:
1939                 return true;
1940         default:
1941                 break;
1942         }
1943         return false;
1944 }
1945 EXPORT_SYMBOL(v4l2_ctrl_radio_filter);
1946
1947 /* Cluster controls */
1948 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1949 {
1950         bool has_volatiles = false;
1951         int i;
1952
1953         /* The first control is the master control and it must not be NULL */
1954         if (WARN_ON(ncontrols == 0 || controls[0] == NULL))
1955                 return;
1956
1957         for (i = 0; i < ncontrols; i++) {
1958                 if (controls[i]) {
1959                         controls[i]->cluster = controls;
1960                         controls[i]->ncontrols = ncontrols;
1961                         if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1962                                 has_volatiles = true;
1963                 }
1964         }
1965         controls[0]->has_volatiles = has_volatiles;
1966 }
1967 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1968
1969 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1970                             u8 manual_val, bool set_volatile)
1971 {
1972         struct v4l2_ctrl *master = controls[0];
1973         u32 flag = 0;
1974         int i;
1975
1976         v4l2_ctrl_cluster(ncontrols, controls);
1977         WARN_ON(ncontrols <= 1);
1978         WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1979         WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
1980         master->is_auto = true;
1981         master->has_volatiles = set_volatile;
1982         master->manual_mode_value = manual_val;
1983         master->flags |= V4L2_CTRL_FLAG_UPDATE;
1984
1985         if (!is_cur_manual(master))
1986                 flag = V4L2_CTRL_FLAG_INACTIVE |
1987                         (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
1988
1989         for (i = 1; i < ncontrols; i++)
1990                 if (controls[i])
1991                         controls[i]->flags |= flag;
1992 }
1993 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1994
1995 /* Activate/deactivate a control. */
1996 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1997 {
1998         /* invert since the actual flag is called 'inactive' */
1999         bool inactive = !active;
2000         bool old;
2001
2002         if (ctrl == NULL)
2003                 return;
2004
2005         if (inactive)
2006                 /* set V4L2_CTRL_FLAG_INACTIVE */
2007                 old = test_and_set_bit(4, &ctrl->flags);
2008         else
2009                 /* clear V4L2_CTRL_FLAG_INACTIVE */
2010                 old = test_and_clear_bit(4, &ctrl->flags);
2011         if (old != inactive)
2012                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2013 }
2014 EXPORT_SYMBOL(v4l2_ctrl_activate);
2015
2016 /* Grab/ungrab a control.
2017    Typically used when streaming starts and you want to grab controls,
2018    preventing the user from changing them.
2019
2020    Just call this and the framework will block any attempts to change
2021    these controls. */
2022 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
2023 {
2024         bool old;
2025
2026         if (ctrl == NULL)
2027                 return;
2028
2029         v4l2_ctrl_lock(ctrl);
2030         if (grabbed)
2031                 /* set V4L2_CTRL_FLAG_GRABBED */
2032                 old = test_and_set_bit(1, &ctrl->flags);
2033         else
2034                 /* clear V4L2_CTRL_FLAG_GRABBED */
2035                 old = test_and_clear_bit(1, &ctrl->flags);
2036         if (old != grabbed)
2037                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
2038         v4l2_ctrl_unlock(ctrl);
2039 }
2040 EXPORT_SYMBOL(v4l2_ctrl_grab);
2041
2042 /* Log the control name and value */
2043 static void log_ctrl(const struct v4l2_ctrl *ctrl,
2044                      const char *prefix, const char *colon)
2045 {
2046         if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
2047                 return;
2048         if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
2049                 return;
2050
2051         printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
2052
2053         switch (ctrl->type) {
2054         case V4L2_CTRL_TYPE_INTEGER:
2055                 printk(KERN_CONT "%d", ctrl->cur.val);
2056                 break;
2057         case V4L2_CTRL_TYPE_BOOLEAN:
2058                 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
2059                 break;
2060         case V4L2_CTRL_TYPE_MENU:
2061                 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
2062                 break;
2063         case V4L2_CTRL_TYPE_INTEGER_MENU:
2064                 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
2065                 break;
2066         case V4L2_CTRL_TYPE_BITMASK:
2067                 printk(KERN_CONT "0x%08x", ctrl->cur.val);
2068                 break;
2069         case V4L2_CTRL_TYPE_INTEGER64:
2070                 printk(KERN_CONT "%lld", ctrl->cur.val64);
2071                 break;
2072         case V4L2_CTRL_TYPE_STRING:
2073                 printk(KERN_CONT "%s", ctrl->cur.string);
2074                 break;
2075         default:
2076                 printk(KERN_CONT "unknown type %d", ctrl->type);
2077                 break;
2078         }
2079         if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
2080                            V4L2_CTRL_FLAG_GRABBED |
2081                            V4L2_CTRL_FLAG_VOLATILE)) {
2082                 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
2083                         printk(KERN_CONT " inactive");
2084                 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
2085                         printk(KERN_CONT " grabbed");
2086                 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
2087                         printk(KERN_CONT " volatile");
2088         }
2089         printk(KERN_CONT "\n");
2090 }
2091
2092 /* Log all controls owned by the handler */
2093 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
2094                                   const char *prefix)
2095 {
2096         struct v4l2_ctrl *ctrl;
2097         const char *colon = "";
2098         int len;
2099
2100         if (hdl == NULL)
2101                 return;
2102         if (prefix == NULL)
2103                 prefix = "";
2104         len = strlen(prefix);
2105         if (len && prefix[len - 1] != ' ')
2106                 colon = ": ";
2107         mutex_lock(hdl->lock);
2108         list_for_each_entry(ctrl, &hdl->ctrls, node)
2109                 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
2110                         log_ctrl(ctrl, prefix, colon);
2111         mutex_unlock(hdl->lock);
2112 }
2113 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
2114
2115 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd)
2116 {
2117         v4l2_ctrl_handler_log_status(sd->ctrl_handler, sd->name);
2118         return 0;
2119 }
2120 EXPORT_SYMBOL(v4l2_ctrl_subdev_log_status);
2121
2122 /* Call s_ctrl for all controls owned by the handler */
2123 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
2124 {
2125         struct v4l2_ctrl *ctrl;
2126         int ret = 0;
2127
2128         if (hdl == NULL)
2129                 return 0;
2130         mutex_lock(hdl->lock);
2131         list_for_each_entry(ctrl, &hdl->ctrls, node)
2132                 ctrl->done = false;
2133
2134         list_for_each_entry(ctrl, &hdl->ctrls, node) {
2135                 struct v4l2_ctrl *master = ctrl->cluster[0];
2136                 int i;
2137
2138                 /* Skip if this control was already handled by a cluster. */
2139                 /* Skip button controls and read-only controls. */
2140                 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
2141                     (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
2142                         continue;
2143
2144                 for (i = 0; i < master->ncontrols; i++) {
2145                         if (master->cluster[i]) {
2146                                 cur_to_new(master->cluster[i]);
2147                                 master->cluster[i]->is_new = 1;
2148                                 master->cluster[i]->done = true;
2149                         }
2150                 }
2151                 ret = call_op(master, s_ctrl);
2152                 if (ret)
2153                         break;
2154         }
2155         mutex_unlock(hdl->lock);
2156         return ret;
2157 }
2158 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
2159
2160 /* Implement VIDIOC_QUERYCTRL */
2161 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
2162 {
2163         u32 id = qc->id & V4L2_CTRL_ID_MASK;
2164         struct v4l2_ctrl_ref *ref;
2165         struct v4l2_ctrl *ctrl;
2166
2167         if (hdl == NULL)
2168                 return -EINVAL;
2169
2170         mutex_lock(hdl->lock);
2171
2172         /* Try to find it */
2173         ref = find_ref(hdl, id);
2174
2175         if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
2176                 /* Find the next control with ID > qc->id */
2177
2178                 /* Did we reach the end of the control list? */
2179                 if (id >= node2id(hdl->ctrl_refs.prev)) {
2180                         ref = NULL; /* Yes, so there is no next control */
2181                 } else if (ref) {
2182                         /* We found a control with the given ID, so just get
2183                            the next one in the list. */
2184                         ref = list_entry(ref->node.next, typeof(*ref), node);
2185                 } else {
2186                         /* No control with the given ID exists, so start
2187                            searching for the next largest ID. We know there
2188                            is one, otherwise the first 'if' above would have
2189                            been true. */
2190                         list_for_each_entry(ref, &hdl->ctrl_refs, node)
2191                                 if (id < ref->ctrl->id)
2192                                         break;
2193                 }
2194         }
2195         mutex_unlock(hdl->lock);
2196         if (!ref)
2197                 return -EINVAL;
2198
2199         ctrl = ref->ctrl;
2200         memset(qc, 0, sizeof(*qc));
2201         if (id >= V4L2_CID_PRIVATE_BASE)
2202                 qc->id = id;
2203         else
2204                 qc->id = ctrl->id;
2205         strlcpy(qc->name, ctrl->name, sizeof(qc->name));
2206         qc->minimum = ctrl->minimum;
2207         qc->maximum = ctrl->maximum;
2208         qc->default_value = ctrl->default_value;
2209         if (ctrl->type == V4L2_CTRL_TYPE_MENU
2210             || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
2211                 qc->step = 1;
2212         else
2213                 qc->step = ctrl->step;
2214         qc->flags = ctrl->flags;
2215         qc->type = ctrl->type;
2216         return 0;
2217 }
2218 EXPORT_SYMBOL(v4l2_queryctrl);
2219
2220 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2221 {
2222         if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
2223                 return -EINVAL;
2224         return v4l2_queryctrl(sd->ctrl_handler, qc);
2225 }
2226 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2227
2228 /* Implement VIDIOC_QUERYMENU */
2229 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2230 {
2231         struct v4l2_ctrl *ctrl;
2232         u32 i = qm->index;
2233
2234         ctrl = v4l2_ctrl_find(hdl, qm->id);
2235         if (!ctrl)
2236                 return -EINVAL;
2237
2238         qm->reserved = 0;
2239         /* Sanity checks */
2240         switch (ctrl->type) {
2241         case V4L2_CTRL_TYPE_MENU:
2242                 if (ctrl->qmenu == NULL)
2243                         return -EINVAL;
2244                 break;
2245         case V4L2_CTRL_TYPE_INTEGER_MENU:
2246                 if (ctrl->qmenu_int == NULL)
2247                         return -EINVAL;
2248                 break;
2249         default:
2250                 return -EINVAL;
2251         }
2252
2253         if (i < ctrl->minimum || i > ctrl->maximum)
2254                 return -EINVAL;
2255
2256         /* Use mask to see if this menu item should be skipped */
2257         if (ctrl->menu_skip_mask & (1 << i))
2258                 return -EINVAL;
2259         /* Empty menu items should also be skipped */
2260         if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2261                 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2262                         return -EINVAL;
2263                 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2264         } else {
2265                 qm->value = ctrl->qmenu_int[i];
2266         }
2267         return 0;
2268 }
2269 EXPORT_SYMBOL(v4l2_querymenu);
2270
2271 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2272 {
2273         return v4l2_querymenu(sd->ctrl_handler, qm);
2274 }
2275 EXPORT_SYMBOL(v4l2_subdev_querymenu);
2276
2277
2278
2279 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2280
2281    It is not a fully atomic operation, just best-effort only. After all, if
2282    multiple controls have to be set through multiple i2c writes (for example)
2283    then some initial writes may succeed while others fail. Thus leaving the
2284    system in an inconsistent state. The question is how much effort you are
2285    willing to spend on trying to make something atomic that really isn't.
2286
2287    From the point of view of an application the main requirement is that
2288    when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2289    error should be returned without actually affecting any controls.
2290
2291    If all the values are correct, then it is acceptable to just give up
2292    in case of low-level errors.
2293
2294    It is important though that the application can tell when only a partial
2295    configuration was done. The way we do that is through the error_idx field
2296    of struct v4l2_ext_controls: if that is equal to the count field then no
2297    controls were affected. Otherwise all controls before that index were
2298    successful in performing their 'get' or 'set' operation, the control at
2299    the given index failed, and you don't know what happened with the controls
2300    after the failed one. Since if they were part of a control cluster they
2301    could have been successfully processed (if a cluster member was encountered
2302    at index < error_idx), they could have failed (if a cluster member was at
2303    error_idx), or they may not have been processed yet (if the first cluster
2304    member appeared after error_idx).
2305
2306    It is all fairly theoretical, though. In practice all you can do is to
2307    bail out. If error_idx == count, then it is an application bug. If
2308    error_idx < count then it is only an application bug if the error code was
2309    EBUSY. That usually means that something started streaming just when you
2310    tried to set the controls. In all other cases it is a driver/hardware
2311    problem and all you can do is to retry or bail out.
2312
2313    Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2314    never modifies controls the error_idx is just set to whatever control
2315    has an invalid value.
2316  */
2317
2318 /* Prepare for the extended g/s/try functions.
2319    Find the controls in the control array and do some basic checks. */
2320 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2321                              struct v4l2_ext_controls *cs,
2322                              struct v4l2_ctrl_helper *helpers)
2323 {
2324         struct v4l2_ctrl_helper *h;
2325         bool have_clusters = false;
2326         u32 i;
2327
2328         for (i = 0, h = helpers; i < cs->count; i++, h++) {
2329                 struct v4l2_ext_control *c = &cs->controls[i];
2330                 struct v4l2_ctrl_ref *ref;
2331                 struct v4l2_ctrl *ctrl;
2332                 u32 id = c->id & V4L2_CTRL_ID_MASK;
2333
2334                 cs->error_idx = i;
2335
2336                 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2337                         return -EINVAL;
2338
2339                 /* Old-style private controls are not allowed for
2340                    extended controls */
2341                 if (id >= V4L2_CID_PRIVATE_BASE)
2342                         return -EINVAL;
2343                 ref = find_ref_lock(hdl, id);
2344                 if (ref == NULL)
2345                         return -EINVAL;
2346                 ctrl = ref->ctrl;
2347                 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2348                         return -EINVAL;
2349
2350                 if (ctrl->cluster[0]->ncontrols > 1)
2351                         have_clusters = true;
2352                 if (ctrl->cluster[0] != ctrl)
2353                         ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2354                 /* Store the ref to the master control of the cluster */
2355                 h->mref = ref;
2356                 h->ctrl = ctrl;
2357                 /* Initially set next to 0, meaning that there is no other
2358                    control in this helper array belonging to the same
2359                    cluster */
2360                 h->next = 0;
2361         }
2362
2363         /* We are done if there were no controls that belong to a multi-
2364            control cluster. */
2365         if (!have_clusters)
2366                 return 0;
2367
2368         /* The code below figures out in O(n) time which controls in the list
2369            belong to the same cluster. */
2370
2371         /* This has to be done with the handler lock taken. */
2372         mutex_lock(hdl->lock);
2373
2374         /* First zero the helper field in the master control references */
2375         for (i = 0; i < cs->count; i++)
2376                 helpers[i].mref->helper = NULL;
2377         for (i = 0, h = helpers; i < cs->count; i++, h++) {
2378                 struct v4l2_ctrl_ref *mref = h->mref;
2379
2380                 /* If the mref->helper is set, then it points to an earlier
2381                    helper that belongs to the same cluster. */
2382                 if (mref->helper) {
2383                         /* Set the next field of mref->helper to the current
2384                            index: this means that that earlier helper now
2385                            points to the next helper in the same cluster. */
2386                         mref->helper->next = i;
2387                         /* mref should be set only for the first helper in the
2388                            cluster, clear the others. */
2389                         h->mref = NULL;
2390                 }
2391                 /* Point the mref helper to the current helper struct. */
2392                 mref->helper = h;
2393         }
2394         mutex_unlock(hdl->lock);
2395         return 0;
2396 }
2397
2398 /* Handles the corner case where cs->count == 0. It checks whether the
2399    specified control class exists. If that class ID is 0, then it checks
2400    whether there are any controls at all. */
2401 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2402 {
2403         if (ctrl_class == 0)
2404                 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2405         return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2406 }
2407
2408
2409
2410 /* Get extended controls. Allocates the helpers array if needed. */
2411 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2412 {
2413         struct v4l2_ctrl_helper helper[4];
2414         struct v4l2_ctrl_helper *helpers = helper;
2415         int ret;
2416         int i, j;
2417
2418         cs->error_idx = cs->count;
2419         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2420
2421         if (hdl == NULL)
2422                 return -EINVAL;
2423
2424         if (cs->count == 0)
2425                 return class_check(hdl, cs->ctrl_class);
2426
2427         if (cs->count > ARRAY_SIZE(helper)) {
2428                 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2429                                         GFP_KERNEL);
2430                 if (helpers == NULL)
2431                         return -ENOMEM;
2432         }
2433
2434         ret = prepare_ext_ctrls(hdl, cs, helpers);
2435         cs->error_idx = cs->count;
2436
2437         for (i = 0; !ret && i < cs->count; i++)
2438                 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2439                         ret = -EACCES;
2440
2441         for (i = 0; !ret && i < cs->count; i++) {
2442                 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2443                                     struct v4l2_ctrl *ctrl) = cur_to_user;
2444                 struct v4l2_ctrl *master;
2445
2446                 if (helpers[i].mref == NULL)
2447                         continue;
2448
2449                 master = helpers[i].mref->ctrl;
2450                 cs->error_idx = i;
2451
2452                 v4l2_ctrl_lock(master);
2453
2454                 /* g_volatile_ctrl will update the new control values */
2455                 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2456                         (master->has_volatiles && !is_cur_manual(master))) {
2457                         for (j = 0; j < master->ncontrols; j++)
2458                                 cur_to_new(master->cluster[j]);
2459                         ret = call_op(master, g_volatile_ctrl);
2460                         ctrl_to_user = new_to_user;
2461                 }
2462                 /* If OK, then copy the current (for non-volatile controls)
2463                    or the new (for volatile controls) control values to the
2464                    caller */
2465                 if (!ret) {
2466                         u32 idx = i;
2467
2468                         do {
2469                                 ret = ctrl_to_user(cs->controls + idx,
2470                                                    helpers[idx].ctrl);
2471                                 idx = helpers[idx].next;
2472                         } while (!ret && idx);
2473                 }
2474                 v4l2_ctrl_unlock(master);
2475         }
2476
2477         if (cs->count > ARRAY_SIZE(helper))
2478                 kfree(helpers);
2479         return ret;
2480 }
2481 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2482
2483 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2484 {
2485         return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2486 }
2487 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2488
2489 /* Helper function to get a single control */
2490 static int get_ctrl(struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
2491 {
2492         struct v4l2_ctrl *master = ctrl->cluster[0];
2493         int ret = 0;
2494         int i;
2495
2496         /* String controls are not supported. The new_to_user() and
2497          * cur_to_user() calls below would need to be modified not to access
2498          * userspace memory when called from get_ctrl().
2499          */
2500         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
2501                 return -EINVAL;
2502
2503         if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2504                 return -EACCES;
2505
2506         v4l2_ctrl_lock(master);
2507         /* g_volatile_ctrl will update the current control values */
2508         if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
2509                 for (i = 0; i < master->ncontrols; i++)
2510                         cur_to_new(master->cluster[i]);
2511                 ret = call_op(master, g_volatile_ctrl);
2512                 new_to_user(c, ctrl);
2513         } else {
2514                 cur_to_user(c, ctrl);
2515         }
2516         v4l2_ctrl_unlock(master);
2517         return ret;
2518 }
2519
2520 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2521 {
2522         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2523         struct v4l2_ext_control c;
2524         int ret;
2525
2526         if (ctrl == NULL || !type_is_int(ctrl))
2527                 return -EINVAL;
2528         ret = get_ctrl(ctrl, &c);
2529         control->value = c.value;
2530         return ret;
2531 }
2532 EXPORT_SYMBOL(v4l2_g_ctrl);
2533
2534 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2535 {
2536         return v4l2_g_ctrl(sd->ctrl_handler, control);
2537 }
2538 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2539
2540 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2541 {
2542         struct v4l2_ext_control c;
2543
2544         /* It's a driver bug if this happens. */
2545         WARN_ON(!type_is_int(ctrl));
2546         c.value = 0;
2547         get_ctrl(ctrl, &c);
2548         return c.value;
2549 }
2550 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2551
2552 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl)
2553 {
2554         struct v4l2_ext_control c;
2555
2556         /* It's a driver bug if this happens. */
2557         WARN_ON(ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2558         c.value = 0;
2559         get_ctrl(ctrl, &c);
2560         return c.value;
2561 }
2562 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl_int64);
2563
2564
2565 /* Core function that calls try/s_ctrl and ensures that the new value is
2566    copied to the current value on a set.
2567    Must be called with ctrl->handler->lock held. */
2568 static int try_or_set_cluster(struct v4l2_fh *fh, struct v4l2_ctrl *master,
2569                               bool set, u32 ch_flags)
2570 {
2571         bool update_flag;
2572         int ret;
2573         int i;
2574
2575         /* Go through the cluster and either validate the new value or
2576            (if no new value was set), copy the current value to the new
2577            value, ensuring a consistent view for the control ops when
2578            called. */
2579         for (i = 0; i < master->ncontrols; i++) {
2580                 struct v4l2_ctrl *ctrl = master->cluster[i];
2581
2582                 if (ctrl == NULL)
2583                         continue;
2584
2585                 if (!ctrl->is_new) {
2586                         cur_to_new(ctrl);
2587                         continue;
2588                 }
2589                 /* Check again: it may have changed since the
2590                    previous check in try_or_set_ext_ctrls(). */
2591                 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2592                         return -EBUSY;
2593         }
2594
2595         ret = call_op(master, try_ctrl);
2596
2597         /* Don't set if there is no change */
2598         if (ret || !set || !cluster_changed(master))
2599                 return ret;
2600         ret = call_op(master, s_ctrl);
2601         if (ret)
2602                 return ret;
2603
2604         /* If OK, then make the new values permanent. */
2605         update_flag = is_cur_manual(master) != is_new_manual(master);
2606         for (i = 0; i < master->ncontrols; i++)
2607                 new_to_cur(fh, master->cluster[i], ch_flags |
2608                         ((update_flag && i > 0) ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
2609         return 0;
2610 }
2611
2612 /* Validate controls. */
2613 static int validate_ctrls(struct v4l2_ext_controls *cs,
2614                           struct v4l2_ctrl_helper *helpers, bool set)
2615 {
2616         unsigned i;
2617         int ret = 0;
2618
2619         cs->error_idx = cs->count;
2620         for (i = 0; i < cs->count; i++) {
2621                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2622
2623                 cs->error_idx = i;
2624
2625                 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2626                         return -EACCES;
2627                 /* This test is also done in try_set_control_cluster() which
2628                    is called in atomic context, so that has the final say,
2629                    but it makes sense to do an up-front check as well. Once
2630                    an error occurs in try_set_control_cluster() some other
2631                    controls may have been set already and we want to do a
2632                    best-effort to avoid that. */
2633                 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2634                         return -EBUSY;
2635                 ret = validate_new(ctrl, &cs->controls[i]);
2636                 if (ret)
2637                         return ret;
2638         }
2639         return 0;
2640 }
2641
2642 /* Obtain the current volatile values of an autocluster and mark them
2643    as new. */
2644 static void update_from_auto_cluster(struct v4l2_ctrl *master)
2645 {
2646         int i;
2647
2648         for (i = 0; i < master->ncontrols; i++)
2649                 cur_to_new(master->cluster[i]);
2650         if (!call_op(master, g_volatile_ctrl))
2651                 for (i = 1; i < master->ncontrols; i++)
2652                         if (master->cluster[i])
2653                                 master->cluster[i]->is_new = 1;
2654 }
2655
2656 /* Try or try-and-set controls */
2657 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2658                              struct v4l2_ext_controls *cs,
2659                              bool set)
2660 {
2661         struct v4l2_ctrl_helper helper[4];
2662         struct v4l2_ctrl_helper *helpers = helper;
2663         unsigned i, j;
2664         int ret;
2665
2666         cs->error_idx = cs->count;
2667         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2668
2669         if (hdl == NULL)
2670                 return -EINVAL;
2671
2672         if (cs->count == 0)
2673                 return class_check(hdl, cs->ctrl_class);
2674
2675         if (cs->count > ARRAY_SIZE(helper)) {
2676                 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2677                                         GFP_KERNEL);
2678                 if (!helpers)
2679                         return -ENOMEM;
2680         }
2681         ret = prepare_ext_ctrls(hdl, cs, helpers);
2682         if (!ret)
2683                 ret = validate_ctrls(cs, helpers, set);
2684         if (ret && set)
2685                 cs->error_idx = cs->count;
2686         for (i = 0; !ret && i < cs->count; i++) {
2687                 struct v4l2_ctrl *master;
2688                 u32 idx = i;
2689
2690                 if (helpers[i].mref == NULL)
2691                         continue;
2692
2693                 cs->error_idx = i;
2694                 master = helpers[i].mref->ctrl;
2695                 v4l2_ctrl_lock(master);
2696
2697                 /* Reset the 'is_new' flags of the cluster */
2698                 for (j = 0; j < master->ncontrols; j++)
2699                         if (master->cluster[j])
2700                                 master->cluster[j]->is_new = 0;
2701
2702                 /* For volatile autoclusters that are currently in auto mode
2703                    we need to discover if it will be set to manual mode.
2704                    If so, then we have to copy the current volatile values
2705                    first since those will become the new manual values (which
2706                    may be overwritten by explicit new values from this set
2707                    of controls). */
2708                 if (master->is_auto && master->has_volatiles &&
2709                                                 !is_cur_manual(master)) {
2710                         /* Pick an initial non-manual value */
2711                         s32 new_auto_val = master->manual_mode_value + 1;
2712                         u32 tmp_idx = idx;
2713
2714                         do {
2715                                 /* Check if the auto control is part of the
2716                                    list, and remember the new value. */
2717                                 if (helpers[tmp_idx].ctrl == master)
2718                                         new_auto_val = cs->controls[tmp_idx].value;
2719                                 tmp_idx = helpers[tmp_idx].next;
2720                         } while (tmp_idx);
2721                         /* If the new value == the manual value, then copy
2722                            the current volatile values. */
2723                         if (new_auto_val == master->manual_mode_value)
2724                                 update_from_auto_cluster(master);
2725                 }
2726
2727                 /* Copy the new caller-supplied control values.
2728                    user_to_new() sets 'is_new' to 1. */
2729                 do {
2730                         ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2731                         idx = helpers[idx].next;
2732                 } while (!ret && idx);
2733
2734                 if (!ret)
2735                         ret = try_or_set_cluster(fh, master, set, 0);
2736
2737                 /* Copy the new values back to userspace. */
2738                 if (!ret) {
2739                         idx = i;
2740                         do {
2741                                 ret = new_to_user(cs->controls + idx,
2742                                                 helpers[idx].ctrl);
2743                                 idx = helpers[idx].next;
2744                         } while (!ret && idx);
2745                 }
2746                 v4l2_ctrl_unlock(master);
2747         }
2748
2749         if (cs->count > ARRAY_SIZE(helper))
2750                 kfree(helpers);
2751         return ret;
2752 }
2753
2754 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2755 {
2756         return try_set_ext_ctrls(NULL, hdl, cs, false);
2757 }
2758 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2759
2760 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2761                                         struct v4l2_ext_controls *cs)
2762 {
2763         return try_set_ext_ctrls(fh, hdl, cs, true);
2764 }
2765 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2766
2767 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2768 {
2769         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
2770 }
2771 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2772
2773 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2774 {
2775         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
2776 }
2777 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2778
2779 /* Helper function for VIDIOC_S_CTRL compatibility */
2780 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
2781                     struct v4l2_ext_control *c, u32 ch_flags)
2782 {
2783         struct v4l2_ctrl *master = ctrl->cluster[0];
2784         int i;
2785
2786         /* String controls are not supported. The user_to_new() and
2787          * cur_to_user() calls below would need to be modified not to access
2788          * userspace memory when called from set_ctrl().
2789          */
2790         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
2791                 return -EINVAL;
2792
2793         /* Reset the 'is_new' flags of the cluster */
2794         for (i = 0; i < master->ncontrols; i++)
2795                 if (master->cluster[i])
2796                         master->cluster[i]->is_new = 0;
2797
2798         /* For autoclusters with volatiles that are switched from auto to
2799            manual mode we have to update the current volatile values since
2800            those will become the initial manual values after such a switch. */
2801         if (master->is_auto && master->has_volatiles && ctrl == master &&
2802             !is_cur_manual(master) && c->value == master->manual_mode_value)
2803                 update_from_auto_cluster(master);
2804
2805         user_to_new(c, ctrl);
2806         return try_or_set_cluster(fh, master, true, ch_flags);
2807 }
2808
2809 /* Helper function for VIDIOC_S_CTRL compatibility */
2810 static int set_ctrl_lock(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
2811                          struct v4l2_ext_control *c)
2812 {
2813         int ret = validate_new(ctrl, c);
2814
2815         if (!ret) {
2816                 v4l2_ctrl_lock(ctrl);
2817                 ret = set_ctrl(fh, ctrl, c, 0);
2818                 if (!ret)
2819                         cur_to_user(c, ctrl);
2820                 v4l2_ctrl_unlock(ctrl);
2821         }
2822         return ret;
2823 }
2824
2825 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2826                                         struct v4l2_control *control)
2827 {
2828         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2829         struct v4l2_ext_control c;
2830         int ret;
2831
2832         if (ctrl == NULL || !type_is_int(ctrl))
2833                 return -EINVAL;
2834
2835         if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2836                 return -EACCES;
2837
2838         c.value = control->value;
2839         ret = set_ctrl_lock(fh, ctrl, &c);
2840         control->value = c.value;
2841         return ret;
2842 }
2843 EXPORT_SYMBOL(v4l2_s_ctrl);
2844
2845 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2846 {
2847         return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2848 }
2849 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2850
2851 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2852 {
2853         struct v4l2_ext_control c;
2854
2855         /* It's a driver bug if this happens. */
2856         WARN_ON(!type_is_int(ctrl));
2857         c.value = val;
2858         return set_ctrl_lock(NULL, ctrl, &c);
2859 }
2860 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2861
2862 int v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val)
2863 {
2864         struct v4l2_ext_control c;
2865
2866         /* It's a driver bug if this happens. */
2867         WARN_ON(ctrl->type != V4L2_CTRL_TYPE_INTEGER64);
2868         c.value64 = val;
2869         return set_ctrl_lock(NULL, ctrl, &c);
2870 }
2871 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl_int64);
2872
2873 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv)
2874 {
2875         if (ctrl == NULL)
2876                 return;
2877         if (notify == NULL) {
2878                 ctrl->call_notify = 0;
2879                 return;
2880         }
2881         if (WARN_ON(ctrl->handler->notify && ctrl->handler->notify != notify))
2882                 return;
2883         ctrl->handler->notify = notify;
2884         ctrl->handler->notify_priv = priv;
2885         ctrl->call_notify = 1;
2886 }
2887 EXPORT_SYMBOL(v4l2_ctrl_notify);
2888
2889 int v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
2890                         s32 min, s32 max, u32 step, s32 def)
2891 {
2892         int ret = check_range(ctrl->type, min, max, step, def);
2893         struct v4l2_ext_control c;
2894
2895         switch (ctrl->type) {
2896         case V4L2_CTRL_TYPE_INTEGER:
2897         case V4L2_CTRL_TYPE_BOOLEAN:
2898         case V4L2_CTRL_TYPE_MENU:
2899         case V4L2_CTRL_TYPE_INTEGER_MENU:
2900         case V4L2_CTRL_TYPE_BITMASK:
2901                 if (ret)
2902                         return ret;
2903                 break;
2904         default:
2905                 return -EINVAL;
2906         }
2907         v4l2_ctrl_lock(ctrl);
2908         ctrl->minimum = min;
2909         ctrl->maximum = max;
2910         ctrl->step = step;
2911         ctrl->default_value = def;
2912         c.value = ctrl->cur.val;
2913         if (validate_new(ctrl, &c))
2914                 c.value = def;
2915         if (c.value != ctrl->cur.val)
2916                 ret = set_ctrl(NULL, ctrl, &c, V4L2_EVENT_CTRL_CH_RANGE);
2917         else
2918                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_RANGE);
2919         v4l2_ctrl_unlock(ctrl);
2920         return ret;
2921 }
2922 EXPORT_SYMBOL(v4l2_ctrl_modify_range);
2923
2924 static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
2925 {
2926         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2927
2928         if (ctrl == NULL)
2929                 return -EINVAL;
2930
2931         v4l2_ctrl_lock(ctrl);
2932         list_add_tail(&sev->node, &ctrl->ev_subs);
2933         if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2934             (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2935                 struct v4l2_event ev;
2936                 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
2937
2938                 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2939                         changes |= V4L2_EVENT_CTRL_CH_VALUE;
2940                 fill_event(&ev, ctrl, changes);
2941                 /* Mark the queue as active, allowing this initial
2942                    event to be accepted. */
2943                 sev->elems = elems;
2944                 v4l2_event_queue_fh(sev->fh, &ev);
2945         }
2946         v4l2_ctrl_unlock(ctrl);
2947         return 0;
2948 }
2949
2950 static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
2951 {
2952         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2953
2954         v4l2_ctrl_lock(ctrl);
2955         list_del(&sev->node);
2956         v4l2_ctrl_unlock(ctrl);
2957 }
2958
2959 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2960 {
2961         u32 old_changes = old->u.ctrl.changes;
2962
2963         old->u.ctrl = new->u.ctrl;
2964         old->u.ctrl.changes |= old_changes;
2965 }
2966 EXPORT_SYMBOL(v4l2_ctrl_replace);
2967
2968 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2969 {
2970         new->u.ctrl.changes |= old->u.ctrl.changes;
2971 }
2972 EXPORT_SYMBOL(v4l2_ctrl_merge);
2973
2974 const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2975         .add = v4l2_ctrl_add_event,
2976         .del = v4l2_ctrl_del_event,
2977         .replace = v4l2_ctrl_replace,
2978         .merge = v4l2_ctrl_merge,
2979 };
2980 EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
2981
2982 int v4l2_ctrl_log_status(struct file *file, void *fh)
2983 {
2984         struct video_device *vfd = video_devdata(file);
2985         struct v4l2_fh *vfh = file->private_data;
2986
2987         if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2988                 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2989                         vfd->v4l2_dev->name);
2990         return 0;
2991 }
2992 EXPORT_SYMBOL(v4l2_ctrl_log_status);
2993
2994 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2995                                 const struct v4l2_event_subscription *sub)
2996 {
2997         if (sub->type == V4L2_EVENT_CTRL)
2998                 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
2999         return -EINVAL;
3000 }
3001 EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
3002
3003 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
3004                                      struct v4l2_event_subscription *sub)
3005 {
3006         if (!sd->ctrl_handler)
3007                 return -EINVAL;
3008         return v4l2_ctrl_subscribe_event(fh, sub);
3009 }
3010 EXPORT_SYMBOL(v4l2_ctrl_subdev_subscribe_event);
3011
3012 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
3013 {
3014         struct v4l2_fh *fh = file->private_data;
3015
3016         if (v4l2_event_pending(fh))
3017                 return POLLPRI;
3018         poll_wait(file, &fh->wait, wait);
3019         return 0;
3020 }
3021 EXPORT_SYMBOL(v4l2_ctrl_poll);