drivers/media/video/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 <media/v4l2-ioctl.h>
  24 #include <media/v4l2-device.h>
  25 #include <media/v4l2-ctrls.h>
  26 #include <media/v4l2-event.h>
  27 #include <media/v4l2-dev.h>
  28
  29 #define has_op(master, op) \
  30         (master->ops && master->ops->op)
  31 #define call_op(master, op) \
  32         (has_op(master, op) ? master->ops->op(master) : 0)
  33
  34 /* Internal temporary helper struct, one for each v4l2_ext_control */
  35 struct ctrl_helper {
  36         /* The control corresponding to the v4l2_ext_control ID field. */
  37         struct v4l2_ctrl *ctrl;
  38         /* Used internally to mark whether this control was already
  39            processed. */
  40         bool handled;
  41 };
  42
  43 /* Small helper function to determine if the autocluster is set to manual
  44    mode. In that case the is_volatile flag should be ignored. */
  45 static bool is_cur_manual(const struct v4l2_ctrl *master)
  46 {
  47         return master->is_auto && master->cur.val == master->manual_mode_value;
  48 }
  49
  50 /* Same as above, but this checks the against the new value instead of the
  51    current value. */
  52 static bool is_new_manual(const struct v4l2_ctrl *master)
  53 {
  54         return master->is_auto && master->val == master->manual_mode_value;
  55 }
  56
  57 /* Returns NULL or a character pointer array containing the menu for
  58    the given control ID. The pointer array ends with a NULL pointer.
  59    An empty string signifies a menu entry that is invalid. This allows
  60    drivers to disable certain options if it is not supported. */
  61 const char * const *v4l2_ctrl_get_menu(u32 id)
  62 {
  63         static const char * const mpeg_audio_sampling_freq[] = {
  64                 "44.1 kHz",
  65                 "48 kHz",
  66                 "32 kHz",
  67                 NULL
  68         };
  69         static const char * const mpeg_audio_encoding[] = {
  70                 "MPEG-1/2 Layer I",
  71                 "MPEG-1/2 Layer II",
  72                 "MPEG-1/2 Layer III",
  73                 "MPEG-2/4 AAC",
  74                 "AC-3",
  75                 NULL
  76         };
  77         static const char * const mpeg_audio_l1_bitrate[] = {
  78                 "32 kbps",
  79                 "64 kbps",
  80                 "96 kbps",
  81                 "128 kbps",
  82                 "160 kbps",
  83                 "192 kbps",
  84                 "224 kbps",
  85                 "256 kbps",
  86                 "288 kbps",
  87                 "320 kbps",
  88                 "352 kbps",
  89                 "384 kbps",
  90                 "416 kbps",
  91                 "448 kbps",
  92                 NULL
  93         };
  94         static const char * const mpeg_audio_l2_bitrate[] = {
  95                 "32 kbps",
  96                 "48 kbps",
  97                 "56 kbps",
  98                 "64 kbps",
  99                 "80 kbps",
 100                 "96 kbps",
 101                 "112 kbps",
 102                 "128 kbps",
 103                 "160 kbps",
 104                 "192 kbps",
 105                 "224 kbps",
 106                 "256 kbps",
 107                 "320 kbps",
 108                 "384 kbps",
 109                 NULL
 110         };
 111         static const char * const mpeg_audio_l3_bitrate[] = {
 112                 "32 kbps",
 113                 "40 kbps",
 114                 "48 kbps",
 115                 "56 kbps",
 116                 "64 kbps",
 117                 "80 kbps",
 118                 "96 kbps",
 119                 "112 kbps",
 120                 "128 kbps",
 121                 "160 kbps",
 122                 "192 kbps",
 123                 "224 kbps",
 124                 "256 kbps",
 125                 "320 kbps",
 126                 NULL
 127         };
 128         static const char * const mpeg_audio_ac3_bitrate[] = {
 129                 "32 kbps",
 130                 "40 kbps",
 131                 "48 kbps",
 132                 "56 kbps",
 133                 "64 kbps",
 134                 "80 kbps",
 135                 "96 kbps",
 136                 "112 kbps",
 137                 "128 kbps",
 138                 "160 kbps",
 139                 "192 kbps",
 140                 "224 kbps",
 141                 "256 kbps",
 142                 "320 kbps",
 143                 "384 kbps",
 144                 "448 kbps",
 145                 "512 kbps",
 146                 "576 kbps",
 147                 "640 kbps",
 148                 NULL
 149         };
 150         static const char * const mpeg_audio_mode[] = {
 151                 "Stereo",
 152                 "Joint Stereo",
 153                 "Dual",
 154                 "Mono",
 155                 NULL
 156         };
 157         static const char * const mpeg_audio_mode_extension[] = {
 158                 "Bound 4",
 159                 "Bound 8",
 160                 "Bound 12",
 161                 "Bound 16",
 162                 NULL
 163         };
 164         static const char * const mpeg_audio_emphasis[] = {
 165                 "No Emphasis",
 166                 "50/15 us",
 167                 "CCITT J17",
 168                 NULL
 169         };
 170         static const char * const mpeg_audio_crc[] = {
 171                 "No CRC",
 172                 "16-bit CRC",
 173                 NULL
 174         };
 175         static const char * const mpeg_video_encoding[] = {
 176                 "MPEG-1",
 177                 "MPEG-2",
 178                 "MPEG-4 AVC",
 179                 NULL
 180         };
 181         static const char * const mpeg_video_aspect[] = {
 182                 "1x1",
 183                 "4x3",
 184                 "16x9",
 185                 "2.21x1",
 186                 NULL
 187         };
 188         static const char * const mpeg_video_bitrate_mode[] = {
 189                 "Variable Bitrate",
 190                 "Constant Bitrate",
 191                 NULL
 192         };
 193         static const char * const mpeg_stream_type[] = {
 194                 "MPEG-2 Program Stream",
 195                 "MPEG-2 Transport Stream",
 196                 "MPEG-1 System Stream",
 197                 "MPEG-2 DVD-compatible Stream",
 198                 "MPEG-1 VCD-compatible Stream",
 199                 "MPEG-2 SVCD-compatible Stream",
 200                 NULL
 201         };
 202         static const char * const mpeg_stream_vbi_fmt[] = {
 203                 "No VBI",
 204                 "Private packet, IVTV format",
 205                 NULL
 206         };
 207         static const char * const camera_power_line_frequency[] = {
 208                 "Disabled",
 209                 "50 Hz",
 210                 "60 Hz",
 211                 NULL
 212         };
 213         static const char * const camera_exposure_auto[] = {
 214                 "Auto Mode",
 215                 "Manual Mode",
 216                 "Shutter Priority Mode",
 217                 "Aperture Priority Mode",
 218                 NULL
 219         };
 220         static const char * const colorfx[] = {
 221                 "None",
 222                 "Black & White",
 223                 "Sepia",
 224                 "Negative",
 225                 "Emboss",
 226                 "Sketch",
 227                 "Sky blue",
 228                 "Grass green",
 229                 "Skin whiten",
 230                 "Vivid",
 231                 NULL
 232         };
 233         static const char * const tune_preemphasis[] = {
 234                 "No preemphasis",
 235                 "50 useconds",
 236                 "75 useconds",
 237                 NULL,
 238         };
 239
 240         switch (id) {
 241         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
 242                 return mpeg_audio_sampling_freq;
 243         case V4L2_CID_MPEG_AUDIO_ENCODING:
 244                 return mpeg_audio_encoding;
 245         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
 246                 return mpeg_audio_l1_bitrate;
 247         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
 248                 return mpeg_audio_l2_bitrate;
 249         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
 250                 return mpeg_audio_l3_bitrate;
 251         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
 252                 return mpeg_audio_ac3_bitrate;
 253         case V4L2_CID_MPEG_AUDIO_MODE:
 254                 return mpeg_audio_mode;
 255         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
 256                 return mpeg_audio_mode_extension;
 257         case V4L2_CID_MPEG_AUDIO_EMPHASIS:
 258                 return mpeg_audio_emphasis;
 259         case V4L2_CID_MPEG_AUDIO_CRC:
 260                 return mpeg_audio_crc;
 261         case V4L2_CID_MPEG_VIDEO_ENCODING:
 262                 return mpeg_video_encoding;
 263         case V4L2_CID_MPEG_VIDEO_ASPECT:
 264                 return mpeg_video_aspect;
 265         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 266                 return mpeg_video_bitrate_mode;
 267         case V4L2_CID_MPEG_STREAM_TYPE:
 268                 return mpeg_stream_type;
 269         case V4L2_CID_MPEG_STREAM_VBI_FMT:
 270                 return mpeg_stream_vbi_fmt;
 271         case V4L2_CID_POWER_LINE_FREQUENCY:
 272                 return camera_power_line_frequency;
 273         case V4L2_CID_EXPOSURE_AUTO:
 274                 return camera_exposure_auto;
 275         case V4L2_CID_COLORFX:
 276                 return colorfx;
 277         case V4L2_CID_TUNE_PREEMPHASIS:
 278                 return tune_preemphasis;
 279         default:
 280                 return NULL;
 281         }
 282 }
 283 EXPORT_SYMBOL(v4l2_ctrl_get_menu);
 284
 285 /* Return the control name. */
 286 const char *v4l2_ctrl_get_name(u32 id)
 287 {
 288         switch (id) {
 289         /* USER controls */
 290         /* Keep the order of the 'case's the same as in videodev2.h! */
 291         case V4L2_CID_USER_CLASS:               return "User Controls";
 292         case V4L2_CID_BRIGHTNESS:               return "Brightness";
 293         case V4L2_CID_CONTRAST:                 return "Contrast";
 294         case V4L2_CID_SATURATION:               return "Saturation";
 295         case V4L2_CID_HUE:                      return "Hue";
 296         case V4L2_CID_AUDIO_VOLUME:             return "Volume";
 297         case V4L2_CID_AUDIO_BALANCE:            return "Balance";
 298         case V4L2_CID_AUDIO_BASS:               return "Bass";
 299         case V4L2_CID_AUDIO_TREBLE:             return "Treble";
 300         case V4L2_CID_AUDIO_MUTE:               return "Mute";
 301         case V4L2_CID_AUDIO_LOUDNESS:           return "Loudness";
 302         case V4L2_CID_BLACK_LEVEL:              return "Black Level";
 303         case V4L2_CID_AUTO_WHITE_BALANCE:       return "White Balance, Automatic";
 304         case V4L2_CID_DO_WHITE_BALANCE:         return "Do White Balance";
 305         case V4L2_CID_RED_BALANCE:              return "Red Balance";
 306         case V4L2_CID_BLUE_BALANCE:             return "Blue Balance";
 307         case V4L2_CID_GAMMA:                    return "Gamma";
 308         case V4L2_CID_EXPOSURE:                 return "Exposure";
 309         case V4L2_CID_AUTOGAIN:                 return "Gain, Automatic";
 310         case V4L2_CID_GAIN:                     return "Gain";
 311         case V4L2_CID_HFLIP:                    return "Horizontal Flip";
 312         case V4L2_CID_VFLIP:                    return "Vertical Flip";
 313         case V4L2_CID_HCENTER:                  return "Horizontal Center";
 314         case V4L2_CID_VCENTER:                  return "Vertical Center";
 315         case V4L2_CID_POWER_LINE_FREQUENCY:     return "Power Line Frequency";
 316         case V4L2_CID_HUE_AUTO:                 return "Hue, Automatic";
 317         case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
 318         case V4L2_CID_SHARPNESS:                return "Sharpness";
 319         case V4L2_CID_BACKLIGHT_COMPENSATION:   return "Backlight Compensation";
 320         case V4L2_CID_CHROMA_AGC:               return "Chroma AGC";
 321         case V4L2_CID_COLOR_KILLER:             return "Color Killer";
 322         case V4L2_CID_COLORFX:                  return "Color Effects";
 323         case V4L2_CID_AUTOBRIGHTNESS:           return "Brightness, Automatic";
 324         case V4L2_CID_BAND_STOP_FILTER:         return "Band-Stop Filter";
 325         case V4L2_CID_ROTATE:                   return "Rotate";
 326         case V4L2_CID_BG_COLOR:                 return "Background Color";
 327         case V4L2_CID_CHROMA_GAIN:              return "Chroma Gain";
 328         case V4L2_CID_ILLUMINATORS_1:           return "Illuminator 1";
 329         case V4L2_CID_ILLUMINATORS_2:           return "Illuminator 2";
 330
 331         /* MPEG controls */
 332         /* Keep the order of the 'case's the same as in videodev2.h! */
 333         case V4L2_CID_MPEG_CLASS:               return "MPEG Encoder Controls";
 334         case V4L2_CID_MPEG_STREAM_TYPE:         return "Stream Type";
 335         case V4L2_CID_MPEG_STREAM_PID_PMT:      return "Stream PMT Program ID";
 336         case V4L2_CID_MPEG_STREAM_PID_AUDIO:    return "Stream Audio Program ID";
 337         case V4L2_CID_MPEG_STREAM_PID_VIDEO:    return "Stream Video Program ID";
 338         case V4L2_CID_MPEG_STREAM_PID_PCR:      return "Stream PCR Program ID";
 339         case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
 340         case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
 341         case V4L2_CID_MPEG_STREAM_VBI_FMT:      return "Stream VBI Format";
 342         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
 343         case V4L2_CID_MPEG_AUDIO_ENCODING:      return "Audio Encoding";
 344         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:    return "Audio Layer I Bitrate";
 345         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:    return "Audio Layer II Bitrate";
 346         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:    return "Audio Layer III Bitrate";
 347         case V4L2_CID_MPEG_AUDIO_MODE:          return "Audio Stereo Mode";
 348         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
 349         case V4L2_CID_MPEG_AUDIO_EMPHASIS:      return "Audio Emphasis";
 350         case V4L2_CID_MPEG_AUDIO_CRC:           return "Audio CRC";
 351         case V4L2_CID_MPEG_AUDIO_MUTE:          return "Audio Mute";
 352         case V4L2_CID_MPEG_AUDIO_AAC_BITRATE:   return "Audio AAC Bitrate";
 353         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:   return "Audio AC-3 Bitrate";
 354         case V4L2_CID_MPEG_VIDEO_ENCODING:      return "Video Encoding";
 355         case V4L2_CID_MPEG_VIDEO_ASPECT:        return "Video Aspect";
 356         case V4L2_CID_MPEG_VIDEO_B_FRAMES:      return "Video B Frames";
 357         case V4L2_CID_MPEG_VIDEO_GOP_SIZE:      return "Video GOP Size";
 358         case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:   return "Video GOP Closure";
 359         case V4L2_CID_MPEG_VIDEO_PULLDOWN:      return "Video Pulldown";
 360         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:  return "Video Bitrate Mode";
 361         case V4L2_CID_MPEG_VIDEO_BITRATE:       return "Video Bitrate";
 362         case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK:  return "Video Peak Bitrate";
 363         case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
 364         case V4L2_CID_MPEG_VIDEO_MUTE:          return "Video Mute";
 365         case V4L2_CID_MPEG_VIDEO_MUTE_YUV:      return "Video Mute YUV";
 366
 367         /* CAMERA controls */
 368         /* Keep the order of the 'case's the same as in videodev2.h! */
 369         case V4L2_CID_CAMERA_CLASS:             return "Camera Controls";
 370         case V4L2_CID_EXPOSURE_AUTO:            return "Auto Exposure";
 371         case V4L2_CID_EXPOSURE_ABSOLUTE:        return "Exposure Time, Absolute";
 372         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:   return "Exposure, Dynamic Framerate";
 373         case V4L2_CID_PAN_RELATIVE:             return "Pan, Relative";
 374         case V4L2_CID_TILT_RELATIVE:            return "Tilt, Relative";
 375         case V4L2_CID_PAN_RESET:                return "Pan, Reset";
 376         case V4L2_CID_TILT_RESET:               return "Tilt, Reset";
 377         case V4L2_CID_PAN_ABSOLUTE:             return "Pan, Absolute";
 378         case V4L2_CID_TILT_ABSOLUTE:            return "Tilt, Absolute";
 379         case V4L2_CID_FOCUS_ABSOLUTE:           return "Focus, Absolute";
 380         case V4L2_CID_FOCUS_RELATIVE:           return "Focus, Relative";
 381         case V4L2_CID_FOCUS_AUTO:               return "Focus, Automatic";
 382         case V4L2_CID_ZOOM_ABSOLUTE:            return "Zoom, Absolute";
 383         case V4L2_CID_ZOOM_RELATIVE:            return "Zoom, Relative";
 384         case V4L2_CID_ZOOM_CONTINUOUS:          return "Zoom, Continuous";
 385         case V4L2_CID_PRIVACY:                  return "Privacy";
 386         case V4L2_CID_IRIS_ABSOLUTE:            return "Iris, Absolute";
 387         case V4L2_CID_IRIS_RELATIVE:            return "Iris, Relative";
 388
 389         /* FM Radio Modulator control */
 390         /* Keep the order of the 'case's the same as in videodev2.h! */
 391         case V4L2_CID_FM_TX_CLASS:              return "FM Radio Modulator Controls";
 392         case V4L2_CID_RDS_TX_DEVIATION:         return "RDS Signal Deviation";
 393         case V4L2_CID_RDS_TX_PI:                return "RDS Program ID";
 394         case V4L2_CID_RDS_TX_PTY:               return "RDS Program Type";
 395         case V4L2_CID_RDS_TX_PS_NAME:           return "RDS PS Name";
 396         case V4L2_CID_RDS_TX_RADIO_TEXT:        return "RDS Radio Text";
 397         case V4L2_CID_AUDIO_LIMITER_ENABLED:    return "Audio Limiter Feature Enabled";
 398         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
 399         case V4L2_CID_AUDIO_LIMITER_DEVIATION:  return "Audio Limiter Deviation";
 400         case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Feature Enabled";
 401         case V4L2_CID_AUDIO_COMPRESSION_GAIN:   return "Audio Compression Gain";
 402         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
 403         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
 404         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
 405         case V4L2_CID_PILOT_TONE_ENABLED:       return "Pilot Tone Feature Enabled";
 406         case V4L2_CID_PILOT_TONE_DEVIATION:     return "Pilot Tone Deviation";
 407         case V4L2_CID_PILOT_TONE_FREQUENCY:     return "Pilot Tone Frequency";
 408         case V4L2_CID_TUNE_PREEMPHASIS:         return "Pre-emphasis settings";
 409         case V4L2_CID_TUNE_POWER_LEVEL:         return "Tune Power Level";
 410         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:   return "Tune Antenna Capacitor";
 411
 412         default:
 413                 return NULL;
 414         }
 415 }
 416 EXPORT_SYMBOL(v4l2_ctrl_get_name);
 417
 418 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
 419                     s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
 420 {
 421         *name = v4l2_ctrl_get_name(id);
 422         *flags = 0;
 423
 424         switch (id) {
 425         case V4L2_CID_AUDIO_MUTE:
 426         case V4L2_CID_AUDIO_LOUDNESS:
 427         case V4L2_CID_AUTO_WHITE_BALANCE:
 428         case V4L2_CID_AUTOGAIN:
 429         case V4L2_CID_HFLIP:
 430         case V4L2_CID_VFLIP:
 431         case V4L2_CID_HUE_AUTO:
 432         case V4L2_CID_CHROMA_AGC:
 433         case V4L2_CID_COLOR_KILLER:
 434         case V4L2_CID_MPEG_AUDIO_MUTE:
 435         case V4L2_CID_MPEG_VIDEO_MUTE:
 436         case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
 437         case V4L2_CID_MPEG_VIDEO_PULLDOWN:
 438         case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
 439         case V4L2_CID_FOCUS_AUTO:
 440         case V4L2_CID_PRIVACY:
 441         case V4L2_CID_AUDIO_LIMITER_ENABLED:
 442         case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
 443         case V4L2_CID_PILOT_TONE_ENABLED:
 444         case V4L2_CID_ILLUMINATORS_1:
 445         case V4L2_CID_ILLUMINATORS_2:
 446                 *type = V4L2_CTRL_TYPE_BOOLEAN;
 447                 *min = 0;
 448                 *max = *step = 1;
 449                 break;
 450         case V4L2_CID_PAN_RESET:
 451         case V4L2_CID_TILT_RESET:
 452                 *type = V4L2_CTRL_TYPE_BUTTON;
 453                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
 454                 *min = *max = *step = *def = 0;
 455                 break;
 456         case V4L2_CID_POWER_LINE_FREQUENCY:
 457         case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
 458         case V4L2_CID_MPEG_AUDIO_ENCODING:
 459         case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
 460         case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
 461         case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
 462         case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
 463         case V4L2_CID_MPEG_AUDIO_MODE:
 464         case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
 465         case V4L2_CID_MPEG_AUDIO_EMPHASIS:
 466         case V4L2_CID_MPEG_AUDIO_CRC:
 467         case V4L2_CID_MPEG_VIDEO_ENCODING:
 468         case V4L2_CID_MPEG_VIDEO_ASPECT:
 469         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 470         case V4L2_CID_MPEG_STREAM_TYPE:
 471         case V4L2_CID_MPEG_STREAM_VBI_FMT:
 472         case V4L2_CID_EXPOSURE_AUTO:
 473         case V4L2_CID_COLORFX:
 474         case V4L2_CID_TUNE_PREEMPHASIS:
 475                 *type = V4L2_CTRL_TYPE_MENU;
 476                 break;
 477         case V4L2_CID_RDS_TX_PS_NAME:
 478         case V4L2_CID_RDS_TX_RADIO_TEXT:
 479                 *type = V4L2_CTRL_TYPE_STRING;
 480                 break;
 481         case V4L2_CID_USER_CLASS:
 482         case V4L2_CID_CAMERA_CLASS:
 483         case V4L2_CID_MPEG_CLASS:
 484         case V4L2_CID_FM_TX_CLASS:
 485                 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
 486                 /* You can neither read not write these */
 487                 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
 488                 *min = *max = *step = *def = 0;
 489                 break;
 490         case V4L2_CID_BG_COLOR:
 491                 *type = V4L2_CTRL_TYPE_INTEGER;
 492                 *step = 1;
 493                 *min = 0;
 494                 /* Max is calculated as RGB888 that is 2^24 */
 495                 *max = 0xFFFFFF;
 496                 break;
 497         default:
 498                 *type = V4L2_CTRL_TYPE_INTEGER;
 499                 break;
 500         }
 501         switch (id) {
 502         case V4L2_CID_MPEG_AUDIO_ENCODING:
 503         case V4L2_CID_MPEG_AUDIO_MODE:
 504         case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
 505         case V4L2_CID_MPEG_VIDEO_B_FRAMES:
 506         case V4L2_CID_MPEG_STREAM_TYPE:
 507                 *flags |= V4L2_CTRL_FLAG_UPDATE;
 508                 break;
 509         case V4L2_CID_AUDIO_VOLUME:
 510         case V4L2_CID_AUDIO_BALANCE:
 511         case V4L2_CID_AUDIO_BASS:
 512         case V4L2_CID_AUDIO_TREBLE:
 513         case V4L2_CID_BRIGHTNESS:
 514         case V4L2_CID_CONTRAST:
 515         case V4L2_CID_SATURATION:
 516         case V4L2_CID_HUE:
 517         case V4L2_CID_RED_BALANCE:
 518         case V4L2_CID_BLUE_BALANCE:
 519         case V4L2_CID_GAMMA:
 520         case V4L2_CID_SHARPNESS:
 521         case V4L2_CID_CHROMA_GAIN:
 522         case V4L2_CID_RDS_TX_DEVIATION:
 523         case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
 524         case V4L2_CID_AUDIO_LIMITER_DEVIATION:
 525         case V4L2_CID_AUDIO_COMPRESSION_GAIN:
 526         case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
 527         case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
 528         case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
 529         case V4L2_CID_PILOT_TONE_DEVIATION:
 530         case V4L2_CID_PILOT_TONE_FREQUENCY:
 531         case V4L2_CID_TUNE_POWER_LEVEL:
 532         case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
 533                 *flags |= V4L2_CTRL_FLAG_SLIDER;
 534                 break;
 535         case V4L2_CID_PAN_RELATIVE:
 536         case V4L2_CID_TILT_RELATIVE:
 537         case V4L2_CID_FOCUS_RELATIVE:
 538         case V4L2_CID_IRIS_RELATIVE:
 539         case V4L2_CID_ZOOM_RELATIVE:
 540                 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
 541                 break;
 542         }
 543 }
 544 EXPORT_SYMBOL(v4l2_ctrl_fill);
 545
 546 /* Helper function to determine whether the control type is compatible with
 547    VIDIOC_G/S_CTRL. */
 548 static bool type_is_int(const struct v4l2_ctrl *ctrl)
 549 {
 550         switch (ctrl->type) {
 551         case V4L2_CTRL_TYPE_INTEGER64:
 552         case V4L2_CTRL_TYPE_STRING:
 553                 /* Nope, these need v4l2_ext_control */
 554                 return false;
 555         default:
 556                 return true;
 557         }
 558 }
 559
 560 static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
 561 {
 562         memset(ev->reserved, 0, sizeof(ev->reserved));
 563         ev->type = V4L2_EVENT_CTRL;
 564         ev->id = ctrl->id;
 565         ev->u.ctrl.changes = changes;
 566         ev->u.ctrl.type = ctrl->type;
 567         ev->u.ctrl.flags = ctrl->flags;
 568         if (ctrl->type == V4L2_CTRL_TYPE_STRING)
 569                 ev->u.ctrl.value64 = 0;
 570         else
 571                 ev->u.ctrl.value64 = ctrl->cur.val64;
 572         ev->u.ctrl.minimum = ctrl->minimum;
 573         ev->u.ctrl.maximum = ctrl->maximum;
 574         if (ctrl->type == V4L2_CTRL_TYPE_MENU)
 575                 ev->u.ctrl.step = 1;
 576         else
 577                 ev->u.ctrl.step = ctrl->step;
 578         ev->u.ctrl.default_value = ctrl->default_value;
 579 }
 580
 581 static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
 582 {
 583         struct v4l2_event ev;
 584         struct v4l2_subscribed_event *sev;
 585
 586         if (list_empty(&ctrl->ev_subs))
 587                         return;
 588         fill_event(&ev, ctrl, changes);
 589
 590         list_for_each_entry(sev, &ctrl->ev_subs, node)
 591                 if (sev->fh && sev->fh != fh)
 592                         v4l2_event_queue_fh(sev->fh, &ev);
 593 }
 594
 595 /* Helper function: copy the current control value back to the caller */
 596 static int cur_to_user(struct v4l2_ext_control *c,
 597                        struct v4l2_ctrl *ctrl)
 598 {
 599         u32 len;
 600
 601         switch (ctrl->type) {
 602         case V4L2_CTRL_TYPE_STRING:
 603                 len = strlen(ctrl->cur.string);
 604                 if (c->size < len + 1) {
 605                         c->size = len + 1;
 606                         return -ENOSPC;
 607                 }
 608                 return copy_to_user(c->string, ctrl->cur.string,
 609                                                 len + 1) ? -EFAULT : 0;
 610         case V4L2_CTRL_TYPE_INTEGER64:
 611                 c->value64 = ctrl->cur.val64;
 612                 break;
 613         default:
 614                 c->value = ctrl->cur.val;
 615                 break;
 616         }
 617         return 0;
 618 }
 619
 620 /* Helper function: copy the caller-provider value as the new control value */
 621 static int user_to_new(struct v4l2_ext_control *c,
 622                        struct v4l2_ctrl *ctrl)
 623 {
 624         int ret;
 625         u32 size;
 626
 627         ctrl->is_new = 1;
 628         switch (ctrl->type) {
 629         case V4L2_CTRL_TYPE_INTEGER64:
 630                 ctrl->val64 = c->value64;
 631                 break;
 632         case V4L2_CTRL_TYPE_STRING:
 633                 size = c->size;
 634                 if (size == 0)
 635                         return -ERANGE;
 636                 if (size > ctrl->maximum + 1)
 637                         size = ctrl->maximum + 1;
 638                 ret = copy_from_user(ctrl->string, c->string, size);
 639                 if (!ret) {
 640                         char last = ctrl->string[size - 1];
 641
 642                         ctrl->string[size - 1] = 0;
 643                         /* If the string was longer than ctrl->maximum,
 644                            then return an error. */
 645                         if (strlen(ctrl->string) == ctrl->maximum && last)
 646                                 return -ERANGE;
 647                 }
 648                 return ret ? -EFAULT : 0;
 649         default:
 650                 ctrl->val = c->value;
 651                 break;
 652         }
 653         return 0;
 654 }
 655
 656 /* Helper function: copy the new control value back to the caller */
 657 static int new_to_user(struct v4l2_ext_control *c,
 658                        struct v4l2_ctrl *ctrl)
 659 {
 660         u32 len;
 661
 662         switch (ctrl->type) {
 663         case V4L2_CTRL_TYPE_STRING:
 664                 len = strlen(ctrl->string);
 665                 if (c->size < len + 1) {
 666                         c->size = ctrl->maximum + 1;
 667                         return -ENOSPC;
 668                 }
 669                 return copy_to_user(c->string, ctrl->string,
 670                                                 len + 1) ? -EFAULT : 0;
 671         case V4L2_CTRL_TYPE_INTEGER64:
 672                 c->value64 = ctrl->val64;
 673                 break;
 674         default:
 675                 c->value = ctrl->val;
 676                 break;
 677         }
 678         return 0;
 679 }
 680
 681 static int ctrl_to_user(struct v4l2_ext_control *c,
 682                        struct v4l2_ctrl *ctrl)
 683 {
 684         if (ctrl->is_volatile)
 685                 return new_to_user(c, ctrl);
 686         return cur_to_user(c, ctrl);
 687 }
 688
 689 static int ctrl_is_volatile(struct v4l2_ext_control *c,
 690                        struct v4l2_ctrl *ctrl)
 691 {
 692         return ctrl->is_volatile;
 693 }
 694
 695 /* Copy the new value to the current value. */
 696 static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
 697                                                 bool update_inactive)
 698 {
 699         bool changed = false;
 700
 701         if (ctrl == NULL)
 702                 return;
 703         switch (ctrl->type) {
 704         case V4L2_CTRL_TYPE_BUTTON:
 705                 changed = true;
 706                 break;
 707         case V4L2_CTRL_TYPE_STRING:
 708                 /* strings are always 0-terminated */
 709                 changed = strcmp(ctrl->string, ctrl->cur.string);
 710                 strcpy(ctrl->cur.string, ctrl->string);
 711                 break;
 712         case V4L2_CTRL_TYPE_INTEGER64:
 713                 changed = ctrl->val64 != ctrl->cur.val64;
 714                 ctrl->cur.val64 = ctrl->val64;
 715                 break;
 716         default:
 717                 changed = ctrl->val != ctrl->cur.val;
 718                 ctrl->cur.val = ctrl->val;
 719                 break;
 720         }
 721         if (update_inactive) {
 722                 ctrl->flags &= ~V4L2_CTRL_FLAG_INACTIVE;
 723                 if (!is_cur_manual(ctrl->cluster[0]))
 724                         ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
 725         }
 726         if (changed || update_inactive)
 727                 send_event(fh, ctrl,
 728                         (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
 729                         (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
 730 }
 731
 732 /* Copy the current value to the new value */
 733 static void cur_to_new(struct v4l2_ctrl *ctrl)
 734 {
 735         if (ctrl == NULL)
 736                 return;
 737         switch (ctrl->type) {
 738         case V4L2_CTRL_TYPE_STRING:
 739                 /* strings are always 0-terminated */
 740                 strcpy(ctrl->string, ctrl->cur.string);
 741                 break;
 742         case V4L2_CTRL_TYPE_INTEGER64:
 743                 ctrl->val64 = ctrl->cur.val64;
 744                 break;
 745         default:
 746                 ctrl->val = ctrl->cur.val;
 747                 break;
 748         }
 749 }
 750
 751 /* Return non-zero if one or more of the controls in the cluster has a new
 752    value that differs from the current value. */
 753 static int cluster_changed(struct v4l2_ctrl *master)
 754 {
 755         int diff = 0;
 756         int i;
 757
 758         for (i = 0; !diff && i < master->ncontrols; i++) {
 759                 struct v4l2_ctrl *ctrl = master->cluster[i];
 760
 761                 if (ctrl == NULL)
 762                         continue;
 763                 switch (ctrl->type) {
 764                 case V4L2_CTRL_TYPE_BUTTON:
 765                         /* Button controls are always 'different' */
 766                         return 1;
 767                 case V4L2_CTRL_TYPE_STRING:
 768                         /* strings are always 0-terminated */
 769                         diff = strcmp(ctrl->string, ctrl->cur.string);
 770                         break;
 771                 case V4L2_CTRL_TYPE_INTEGER64:
 772                         diff = ctrl->val64 != ctrl->cur.val64;
 773                         break;
 774                 default:
 775                         diff = ctrl->val != ctrl->cur.val;
 776                         break;
 777                 }
 778         }
 779         return diff;
 780 }
 781
 782 /* Validate a new control */
 783 static int validate_new(struct v4l2_ctrl *ctrl)
 784 {
 785         s32 val = ctrl->val;
 786         char *s = ctrl->string;
 787         u32 offset;
 788         size_t len;
 789
 790         switch (ctrl->type) {
 791         case V4L2_CTRL_TYPE_INTEGER:
 792                 /* Round towards the closest legal value */
 793                 val += ctrl->step / 2;
 794                 if (val < ctrl->minimum)
 795                         val = ctrl->minimum;
 796                 if (val > ctrl->maximum)
 797                         val = ctrl->maximum;
 798                 offset = val - ctrl->minimum;
 799                 offset = ctrl->step * (offset / ctrl->step);
 800                 val = ctrl->minimum + offset;
 801                 ctrl->val = val;
 802                 return 0;
 803
 804         case V4L2_CTRL_TYPE_BOOLEAN:
 805                 ctrl->val = !!ctrl->val;
 806                 return 0;
 807
 808         case V4L2_CTRL_TYPE_MENU:
 809                 if (val < ctrl->minimum || val > ctrl->maximum)
 810                         return -ERANGE;
 811                 if (ctrl->qmenu[val][0] == '\0' ||
 812                     (ctrl->menu_skip_mask & (1 << val)))
 813                         return -EINVAL;
 814                 return 0;
 815
 816         case V4L2_CTRL_TYPE_BUTTON:
 817         case V4L2_CTRL_TYPE_CTRL_CLASS:
 818                 ctrl->val64 = 0;
 819                 return 0;
 820
 821         case V4L2_CTRL_TYPE_INTEGER64:
 822                 return 0;
 823
 824         case V4L2_CTRL_TYPE_STRING:
 825                 len = strlen(s);
 826                 if (len < ctrl->minimum)
 827                         return -ERANGE;
 828                 if ((len - ctrl->minimum) % ctrl->step)
 829                         return -ERANGE;
 830                 return 0;
 831
 832         default:
 833                 return -EINVAL;
 834         }
 835 }
 836
 837 static inline u32 node2id(struct list_head *node)
 838 {
 839         return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
 840 }
 841
 842 /* Set the handler's error code if it wasn't set earlier already */
 843 static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
 844 {
 845         if (hdl->error == 0)
 846                 hdl->error = err;
 847         return err;
 848 }
 849
 850 /* Initialize the handler */
 851 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
 852                            unsigned nr_of_controls_hint)
 853 {
 854         mutex_init(&hdl->lock);
 855         INIT_LIST_HEAD(&hdl->ctrls);
 856         INIT_LIST_HEAD(&hdl->ctrl_refs);
 857         hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
 858         hdl->buckets = kzalloc(sizeof(hdl->buckets[0]) * hdl->nr_of_buckets,
 859                                                                 GFP_KERNEL);
 860         hdl->error = hdl->buckets ? 0 : -ENOMEM;
 861         return hdl->error;
 862 }
 863 EXPORT_SYMBOL(v4l2_ctrl_handler_init);
 864
 865 /* Free all controls and control refs */
 866 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
 867 {
 868         struct v4l2_ctrl_ref *ref, *next_ref;
 869         struct v4l2_ctrl *ctrl, *next_ctrl;
 870         struct v4l2_subscribed_event *sev, *next_sev;
 871
 872         if (hdl == NULL || hdl->buckets == NULL)
 873                 return;
 874
 875         mutex_lock(&hdl->lock);
 876         /* Free all nodes */
 877         list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
 878                 list_del(&ref->node);
 879                 kfree(ref);
 880         }
 881         /* Free all controls owned by the handler */
 882         list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
 883                 list_del(&ctrl->node);
 884                 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
 885                         list_del(&sev->node);
 886                 kfree(ctrl);
 887         }
 888         kfree(hdl->buckets);
 889         hdl->buckets = NULL;
 890         hdl->cached = NULL;
 891         hdl->error = 0;
 892         mutex_unlock(&hdl->lock);
 893 }
 894 EXPORT_SYMBOL(v4l2_ctrl_handler_free);
 895
 896 /* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
 897    be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
 898    with applications that do not use the NEXT_CTRL flag.
 899
 900    We just find the n-th private user control. It's O(N), but that should not
 901    be an issue in this particular case. */
 902 static struct v4l2_ctrl_ref *find_private_ref(
 903                 struct v4l2_ctrl_handler *hdl, u32 id)
 904 {
 905         struct v4l2_ctrl_ref *ref;
 906
 907         id -= V4L2_CID_PRIVATE_BASE;
 908         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
 909                 /* Search for private user controls that are compatible with
 910                    VIDIOC_G/S_CTRL. */
 911                 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
 912                     V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
 913                         if (!type_is_int(ref->ctrl))
 914                                 continue;
 915                         if (id == 0)
 916                                 return ref;
 917                         id--;
 918                 }
 919         }
 920         return NULL;
 921 }
 922
 923 /* Find a control with the given ID. */
 924 static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
 925 {
 926         struct v4l2_ctrl_ref *ref;
 927         int bucket;
 928
 929         id &= V4L2_CTRL_ID_MASK;
 930
 931         /* Old-style private controls need special handling */
 932         if (id >= V4L2_CID_PRIVATE_BASE)
 933                 return find_private_ref(hdl, id);
 934         bucket = id % hdl->nr_of_buckets;
 935
 936         /* Simple optimization: cache the last control found */
 937         if (hdl->cached && hdl->cached->ctrl->id == id)
 938                 return hdl->cached;
 939
 940         /* Not in cache, search the hash */
 941         ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
 942         while (ref && ref->ctrl->id != id)
 943                 ref = ref->next;
 944
 945         if (ref)
 946                 hdl->cached = ref; /* cache it! */
 947         return ref;
 948 }
 949
 950 /* Find a control with the given ID. Take the handler's lock first. */
 951 static struct v4l2_ctrl_ref *find_ref_lock(
 952                 struct v4l2_ctrl_handler *hdl, u32 id)
 953 {
 954         struct v4l2_ctrl_ref *ref = NULL;
 955
 956         if (hdl) {
 957                 mutex_lock(&hdl->lock);
 958                 ref = find_ref(hdl, id);
 959                 mutex_unlock(&hdl->lock);
 960         }
 961         return ref;
 962 }
 963
 964 /* Find a control with the given ID. */
 965 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
 966 {
 967         struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
 968
 969         return ref ? ref->ctrl : NULL;
 970 }
 971 EXPORT_SYMBOL(v4l2_ctrl_find);
 972
 973 /* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
 974 static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
 975                            struct v4l2_ctrl *ctrl)
 976 {
 977         struct v4l2_ctrl_ref *ref;
 978         struct v4l2_ctrl_ref *new_ref;
 979         u32 id = ctrl->id;
 980         u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
 981         int bucket = id % hdl->nr_of_buckets;   /* which bucket to use */
 982
 983         /* Automatically add the control class if it is not yet present. */
 984         if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
 985                 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
 986                         return hdl->error;
 987
 988         if (hdl->error)
 989                 return hdl->error;
 990
 991         new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
 992         if (!new_ref)
 993                 return handler_set_err(hdl, -ENOMEM);
 994         new_ref->ctrl = ctrl;
 995         if (ctrl->handler == hdl) {
 996                 /* By default each control starts in a cluster of its own.
 997                    new_ref->ctrl is basically a cluster array with one
 998                    element, so that's perfect to use as the cluster pointer.
 999                    But only do this for the handler that owns the control. */
1000                 ctrl->cluster = &new_ref->ctrl;
1001                 ctrl->ncontrols = 1;
1002         }
1003
1004         INIT_LIST_HEAD(&new_ref->node);
1005
1006         mutex_lock(&hdl->lock);
1007
1008         /* Add immediately at the end of the list if the list is empty, or if
1009            the last element in the list has a lower ID.
1010            This ensures that when elements are added in ascending order the
1011            insertion is an O(1) operation. */
1012         if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1013                 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1014                 hdl->nr_of_refs++;
1015                 goto insert_in_hash;
1016         }
1017
1018         /* Find insert position in sorted list */
1019         list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1020                 if (ref->ctrl->id < id)
1021                         continue;
1022                 /* Don't add duplicates */
1023                 if (ref->ctrl->id == id) {
1024                         kfree(new_ref);
1025                         goto unlock;
1026                 }
1027                 list_add(&new_ref->node, ref->node.prev);
1028                 break;
1029         }
1030
1031 insert_in_hash:
1032         /* Insert the control node in the hash */
1033         new_ref->next = hdl->buckets[bucket];
1034         hdl->buckets[bucket] = new_ref;
1035
1036 unlock:
1037         mutex_unlock(&hdl->lock);
1038         return 0;
1039 }
1040
1041 /* Add a new control */
1042 static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1043                         const struct v4l2_ctrl_ops *ops,
1044                         u32 id, const char *name, enum v4l2_ctrl_type type,
1045                         s32 min, s32 max, u32 step, s32 def,
1046                         u32 flags, const char * const *qmenu, void *priv)
1047 {
1048         struct v4l2_ctrl *ctrl;
1049         unsigned sz_extra = 0;
1050
1051         if (hdl->error)
1052                 return NULL;
1053
1054         /* Sanity checks */
1055         if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
1056             max < min ||
1057             (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
1058             (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
1059             (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1060                 handler_set_err(hdl, -ERANGE);
1061                 return NULL;
1062         }
1063         if ((type == V4L2_CTRL_TYPE_INTEGER ||
1064              type == V4L2_CTRL_TYPE_MENU ||
1065              type == V4L2_CTRL_TYPE_BOOLEAN) &&
1066             (def < min || def > max)) {
1067                 handler_set_err(hdl, -ERANGE);
1068                 return NULL;
1069         }
1070
1071         if (type == V4L2_CTRL_TYPE_BUTTON)
1072                 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1073         else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1074                 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1075         else if (type == V4L2_CTRL_TYPE_STRING)
1076                 sz_extra += 2 * (max + 1);
1077
1078         ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1079         if (ctrl == NULL) {
1080                 handler_set_err(hdl, -ENOMEM);
1081                 return NULL;
1082         }
1083
1084         INIT_LIST_HEAD(&ctrl->node);
1085         INIT_LIST_HEAD(&ctrl->ev_subs);
1086         ctrl->handler = hdl;
1087         ctrl->ops = ops;
1088         ctrl->id = id;
1089         ctrl->name = name;
1090         ctrl->type = type;
1091         ctrl->flags = flags;
1092         ctrl->minimum = min;
1093         ctrl->maximum = max;
1094         ctrl->step = step;
1095         ctrl->qmenu = qmenu;
1096         ctrl->priv = priv;
1097         ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1098
1099         if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1100                 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1101                 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1102                 if (ctrl->minimum)
1103                         memset(ctrl->cur.string, ' ', ctrl->minimum);
1104         }
1105         if (handler_new_ref(hdl, ctrl)) {
1106                 kfree(ctrl);
1107                 return NULL;
1108         }
1109         mutex_lock(&hdl->lock);
1110         list_add_tail(&ctrl->node, &hdl->ctrls);
1111         mutex_unlock(&hdl->lock);
1112         return ctrl;
1113 }
1114
1115 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1116                         const struct v4l2_ctrl_config *cfg, void *priv)
1117 {
1118         bool is_menu;
1119         struct v4l2_ctrl *ctrl;
1120         const char *name = cfg->name;
1121         const char * const *qmenu = cfg->qmenu;
1122         enum v4l2_ctrl_type type = cfg->type;
1123         u32 flags = cfg->flags;
1124         s32 min = cfg->min;
1125         s32 max = cfg->max;
1126         u32 step = cfg->step;
1127         s32 def = cfg->def;
1128
1129         if (name == NULL)
1130                 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1131                                                                 &def, &flags);
1132
1133         is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU);
1134         if (is_menu)
1135                 WARN_ON(step);
1136         else
1137                 WARN_ON(cfg->menu_skip_mask);
1138         if (is_menu && qmenu == NULL)
1139                 qmenu = v4l2_ctrl_get_menu(cfg->id);
1140
1141         ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1142                         type, min, max,
1143                         is_menu ? cfg->menu_skip_mask : step,
1144                         def, flags, qmenu, priv);
1145         if (ctrl) {
1146                 ctrl->is_private = cfg->is_private;
1147                 ctrl->is_volatile = cfg->is_volatile;
1148         }
1149         return ctrl;
1150 }
1151 EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1152
1153 /* Helper function for standard non-menu controls */
1154 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1155                         const struct v4l2_ctrl_ops *ops,
1156                         u32 id, s32 min, s32 max, u32 step, s32 def)
1157 {
1158         const char *name;
1159         enum v4l2_ctrl_type type;
1160         u32 flags;
1161
1162         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1163         if (type == V4L2_CTRL_TYPE_MENU) {
1164                 handler_set_err(hdl, -EINVAL);
1165                 return NULL;
1166         }
1167         return v4l2_ctrl_new(hdl, ops, id, name, type,
1168                                     min, max, step, def, flags, NULL, NULL);
1169 }
1170 EXPORT_SYMBOL(v4l2_ctrl_new_std);
1171
1172 /* Helper function for standard menu controls */
1173 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1174                         const struct v4l2_ctrl_ops *ops,
1175                         u32 id, s32 max, s32 mask, s32 def)
1176 {
1177         const char * const *qmenu = v4l2_ctrl_get_menu(id);
1178         const char *name;
1179         enum v4l2_ctrl_type type;
1180         s32 min;
1181         s32 step;
1182         u32 flags;
1183
1184         v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1185         if (type != V4L2_CTRL_TYPE_MENU) {
1186                 handler_set_err(hdl, -EINVAL);
1187                 return NULL;
1188         }
1189         return v4l2_ctrl_new(hdl, ops, id, name, type,
1190                                     0, max, mask, def, flags, qmenu, NULL);
1191 }
1192 EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1193
1194 /* Add a control from another handler to this handler */
1195 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1196                                           struct v4l2_ctrl *ctrl)
1197 {
1198         if (hdl == NULL || hdl->error)
1199                 return NULL;
1200         if (ctrl == NULL) {
1201                 handler_set_err(hdl, -EINVAL);
1202                 return NULL;
1203         }
1204         if (ctrl->handler == hdl)
1205                 return ctrl;
1206         return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1207 }
1208 EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1209
1210 /* Add the controls from another handler to our own. */
1211 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1212                           struct v4l2_ctrl_handler *add)
1213 {
1214         struct v4l2_ctrl *ctrl;
1215         int ret = 0;
1216
1217         /* Do nothing if either handler is NULL or if they are the same */
1218         if (!hdl || !add || hdl == add)
1219                 return 0;
1220         if (hdl->error)
1221                 return hdl->error;
1222         mutex_lock(&add->lock);
1223         list_for_each_entry(ctrl, &add->ctrls, node) {
1224                 /* Skip handler-private controls. */
1225                 if (ctrl->is_private)
1226                         continue;
1227                 /* And control classes */
1228                 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1229                         continue;
1230                 ret = handler_new_ref(hdl, ctrl);
1231                 if (ret)
1232                         break;
1233         }
1234         mutex_unlock(&add->lock);
1235         return ret;
1236 }
1237 EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1238
1239 /* Cluster controls */
1240 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1241 {
1242         int i;
1243
1244         /* The first control is the master control and it must not be NULL */
1245         BUG_ON(ncontrols == 0 || controls[0] == NULL);
1246
1247         for (i = 0; i < ncontrols; i++) {
1248                 if (controls[i]) {
1249                         controls[i]->cluster = controls;
1250                         controls[i]->ncontrols = ncontrols;
1251                 }
1252         }
1253 }
1254 EXPORT_SYMBOL(v4l2_ctrl_cluster);
1255
1256 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1257                             u8 manual_val, bool set_volatile)
1258 {
1259         struct v4l2_ctrl *master = controls[0];
1260         u32 flag;
1261         int i;
1262
1263         v4l2_ctrl_cluster(ncontrols, controls);
1264         WARN_ON(ncontrols <= 1);
1265         WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
1266         master->is_auto = true;
1267         master->manual_mode_value = manual_val;
1268         master->flags |= V4L2_CTRL_FLAG_UPDATE;
1269         flag = is_cur_manual(master) ? 0 : V4L2_CTRL_FLAG_INACTIVE;
1270
1271         for (i = 1; i < ncontrols; i++)
1272                 if (controls[i]) {
1273                         controls[i]->is_volatile = set_volatile;
1274                         controls[i]->flags |= flag;
1275                 }
1276 }
1277 EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1278
1279 /* Activate/deactivate a control. */
1280 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1281 {
1282         /* invert since the actual flag is called 'inactive' */
1283         bool inactive = !active;
1284         bool old;
1285
1286         if (ctrl == NULL)
1287                 return;
1288
1289         if (inactive)
1290                 /* set V4L2_CTRL_FLAG_INACTIVE */
1291                 old = test_and_set_bit(4, &ctrl->flags);
1292         else
1293                 /* clear V4L2_CTRL_FLAG_INACTIVE */
1294                 old = test_and_clear_bit(4, &ctrl->flags);
1295         if (old != inactive)
1296                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1297 }
1298 EXPORT_SYMBOL(v4l2_ctrl_activate);
1299
1300 /* Grab/ungrab a control.
1301    Typically used when streaming starts and you want to grab controls,
1302    preventing the user from changing them.
1303
1304    Just call this and the framework will block any attempts to change
1305    these controls. */
1306 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1307 {
1308         bool old;
1309
1310         if (ctrl == NULL)
1311                 return;
1312
1313         v4l2_ctrl_lock(ctrl);
1314         if (grabbed)
1315                 /* set V4L2_CTRL_FLAG_GRABBED */
1316                 old = test_and_set_bit(1, &ctrl->flags);
1317         else
1318                 /* clear V4L2_CTRL_FLAG_GRABBED */
1319                 old = test_and_clear_bit(1, &ctrl->flags);
1320         if (old != grabbed)
1321                 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1322         v4l2_ctrl_unlock(ctrl);
1323 }
1324 EXPORT_SYMBOL(v4l2_ctrl_grab);
1325
1326 /* Log the control name and value */
1327 static void log_ctrl(const struct v4l2_ctrl *ctrl,
1328                      const char *prefix, const char *colon)
1329 {
1330         int fl_inact = ctrl->flags & V4L2_CTRL_FLAG_INACTIVE;
1331         int fl_grabbed = ctrl->flags & V4L2_CTRL_FLAG_GRABBED;
1332
1333         if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1334                 return;
1335         if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1336                 return;
1337
1338         printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1339
1340         switch (ctrl->type) {
1341         case V4L2_CTRL_TYPE_INTEGER:
1342                 printk(KERN_CONT "%d", ctrl->cur.val);
1343                 break;
1344         case V4L2_CTRL_TYPE_BOOLEAN:
1345                 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1346                 break;
1347         case V4L2_CTRL_TYPE_MENU:
1348                 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1349                 break;
1350         case V4L2_CTRL_TYPE_INTEGER64:
1351                 printk(KERN_CONT "%lld", ctrl->cur.val64);
1352                 break;
1353         case V4L2_CTRL_TYPE_STRING:
1354                 printk(KERN_CONT "%s", ctrl->cur.string);
1355                 break;
1356         default:
1357                 printk(KERN_CONT "unknown type %d", ctrl->type);
1358                 break;
1359         }
1360         if (fl_inact && fl_grabbed)
1361                 printk(KERN_CONT " (inactive, grabbed)\n");
1362         else if (fl_inact)
1363                 printk(KERN_CONT " (inactive)\n");
1364         else if (fl_grabbed)
1365                 printk(KERN_CONT " (grabbed)\n");
1366         else
1367                 printk(KERN_CONT "\n");
1368 }
1369
1370 /* Log all controls owned by the handler */
1371 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1372                                   const char *prefix)
1373 {
1374         struct v4l2_ctrl *ctrl;
1375         const char *colon = "";
1376         int len;
1377
1378         if (hdl == NULL)
1379                 return;
1380         if (prefix == NULL)
1381                 prefix = "";
1382         len = strlen(prefix);
1383         if (len && prefix[len - 1] != ' ')
1384                 colon = ": ";
1385         mutex_lock(&hdl->lock);
1386         list_for_each_entry(ctrl, &hdl->ctrls, node)
1387                 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1388                         log_ctrl(ctrl, prefix, colon);
1389         mutex_unlock(&hdl->lock);
1390 }
1391 EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1392
1393 /* Call s_ctrl for all controls owned by the handler */
1394 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1395 {
1396         struct v4l2_ctrl *ctrl;
1397         int ret = 0;
1398
1399         if (hdl == NULL)
1400                 return 0;
1401         mutex_lock(&hdl->lock);
1402         list_for_each_entry(ctrl, &hdl->ctrls, node)
1403                 ctrl->done = false;
1404
1405         list_for_each_entry(ctrl, &hdl->ctrls, node) {
1406                 struct v4l2_ctrl *master = ctrl->cluster[0];
1407                 int i;
1408
1409                 /* Skip if this control was already handled by a cluster. */
1410                 if (ctrl->done)
1411                         continue;
1412
1413                 for (i = 0; i < master->ncontrols; i++) {
1414                         if (master->cluster[i]) {
1415                                 cur_to_new(master->cluster[i]);
1416                                 master->cluster[i]->is_new = 1;
1417                         }
1418                 }
1419
1420                 /* Skip button controls and read-only controls. */
1421                 if (ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1422                     (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
1423                         continue;
1424                 ret = call_op(master, s_ctrl);
1425                 if (ret)
1426                         break;
1427                 for (i = 0; i < master->ncontrols; i++)
1428                         if (master->cluster[i])
1429                                 master->cluster[i]->done = true;
1430         }
1431         mutex_unlock(&hdl->lock);
1432         return ret;
1433 }
1434 EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1435
1436 /* Implement VIDIOC_QUERYCTRL */
1437 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1438 {
1439         u32 id = qc->id & V4L2_CTRL_ID_MASK;
1440         struct v4l2_ctrl_ref *ref;
1441         struct v4l2_ctrl *ctrl;
1442
1443         if (hdl == NULL)
1444                 return -EINVAL;
1445
1446         mutex_lock(&hdl->lock);
1447
1448         /* Try to find it */
1449         ref = find_ref(hdl, id);
1450
1451         if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1452                 /* Find the next control with ID > qc->id */
1453
1454                 /* Did we reach the end of the control list? */
1455                 if (id >= node2id(hdl->ctrl_refs.prev)) {
1456                         ref = NULL; /* Yes, so there is no next control */
1457                 } else if (ref) {
1458                         /* We found a control with the given ID, so just get
1459                            the next one in the list. */
1460                         ref = list_entry(ref->node.next, typeof(*ref), node);
1461                 } else {
1462                         /* No control with the given ID exists, so start
1463                            searching for the next largest ID. We know there
1464                            is one, otherwise the first 'if' above would have
1465                            been true. */
1466                         list_for_each_entry(ref, &hdl->ctrl_refs, node)
1467                                 if (id < ref->ctrl->id)
1468                                         break;
1469                 }
1470         }
1471         mutex_unlock(&hdl->lock);
1472         if (!ref)
1473                 return -EINVAL;
1474
1475         ctrl = ref->ctrl;
1476         memset(qc, 0, sizeof(*qc));
1477         if (id >= V4L2_CID_PRIVATE_BASE)
1478                 qc->id = id;
1479         else
1480                 qc->id = ctrl->id;
1481         strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1482         qc->minimum = ctrl->minimum;
1483         qc->maximum = ctrl->maximum;
1484         qc->default_value = ctrl->default_value;
1485         if (ctrl->type == V4L2_CTRL_TYPE_MENU)
1486                 qc->step = 1;
1487         else
1488                 qc->step = ctrl->step;
1489         qc->flags = ctrl->flags;
1490         qc->type = ctrl->type;
1491         return 0;
1492 }
1493 EXPORT_SYMBOL(v4l2_queryctrl);
1494
1495 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1496 {
1497         if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1498                 return -EINVAL;
1499         return v4l2_queryctrl(sd->ctrl_handler, qc);
1500 }
1501 EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1502
1503 /* Implement VIDIOC_QUERYMENU */
1504 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1505 {
1506         struct v4l2_ctrl *ctrl;
1507         u32 i = qm->index;
1508
1509         ctrl = v4l2_ctrl_find(hdl, qm->id);
1510         if (!ctrl)
1511                 return -EINVAL;
1512
1513         qm->reserved = 0;
1514         /* Sanity checks */
1515         if (ctrl->qmenu == NULL ||
1516             i < ctrl->minimum || i > ctrl->maximum)
1517                 return -EINVAL;
1518         /* Use mask to see if this menu item should be skipped */
1519         if (ctrl->menu_skip_mask & (1 << i))
1520                 return -EINVAL;
1521         /* Empty menu items should also be skipped */
1522         if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1523                 return -EINVAL;
1524         strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1525         return 0;
1526 }
1527 EXPORT_SYMBOL(v4l2_querymenu);
1528
1529 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1530 {
1531         return v4l2_querymenu(sd->ctrl_handler, qm);
1532 }
1533 EXPORT_SYMBOL(v4l2_subdev_querymenu);
1534
1535
1536
1537 /* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1538
1539    It is not a fully atomic operation, just best-effort only. After all, if
1540    multiple controls have to be set through multiple i2c writes (for example)
1541    then some initial writes may succeed while others fail. Thus leaving the
1542    system in an inconsistent state. The question is how much effort you are
1543    willing to spend on trying to make something atomic that really isn't.
1544
1545    From the point of view of an application the main requirement is that
1546    when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1547    error should be returned without actually affecting any controls.
1548
1549    If all the values are correct, then it is acceptable to just give up
1550    in case of low-level errors.
1551
1552    It is important though that the application can tell when only a partial
1553    configuration was done. The way we do that is through the error_idx field
1554    of struct v4l2_ext_controls: if that is equal to the count field then no
1555    controls were affected. Otherwise all controls before that index were
1556    successful in performing their 'get' or 'set' operation, the control at
1557    the given index failed, and you don't know what happened with the controls
1558    after the failed one. Since if they were part of a control cluster they
1559    could have been successfully processed (if a cluster member was encountered
1560    at index < error_idx), they could have failed (if a cluster member was at
1561    error_idx), or they may not have been processed yet (if the first cluster
1562    member appeared after error_idx).
1563
1564    It is all fairly theoretical, though. In practice all you can do is to
1565    bail out. If error_idx == count, then it is an application bug. If
1566    error_idx < count then it is only an application bug if the error code was
1567    EBUSY. That usually means that something started streaming just when you
1568    tried to set the controls. In all other cases it is a driver/hardware
1569    problem and all you can do is to retry or bail out.
1570
1571    Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1572    never modifies controls the error_idx is just set to whatever control
1573    has an invalid value.
1574  */
1575
1576 /* Prepare for the extended g/s/try functions.
1577    Find the controls in the control array and do some basic checks. */
1578 static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1579                              struct v4l2_ext_controls *cs,
1580                              struct ctrl_helper *helpers)
1581 {
1582         u32 i;
1583
1584         for (i = 0; i < cs->count; i++) {
1585                 struct v4l2_ext_control *c = &cs->controls[i];
1586                 struct v4l2_ctrl *ctrl;
1587                 u32 id = c->id & V4L2_CTRL_ID_MASK;
1588
1589                 cs->error_idx = i;
1590
1591                 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1592                         return -EINVAL;
1593
1594                 /* Old-style private controls are not allowed for
1595                    extended controls */
1596                 if (id >= V4L2_CID_PRIVATE_BASE)
1597                         return -EINVAL;
1598                 ctrl = v4l2_ctrl_find(hdl, id);
1599                 if (ctrl == NULL)
1600                         return -EINVAL;
1601                 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1602                         return -EINVAL;
1603
1604                 helpers[i].ctrl = ctrl;
1605                 helpers[i].handled = false;
1606         }
1607         return 0;
1608 }
1609
1610 typedef int (*cluster_func)(struct v4l2_ext_control *c,
1611                             struct v4l2_ctrl *ctrl);
1612
1613 /* Walk over all controls in v4l2_ext_controls belonging to the same cluster
1614    and call the provided function. */
1615 static int cluster_walk(unsigned from,
1616                         struct v4l2_ext_controls *cs,
1617                         struct ctrl_helper *helpers,
1618                         cluster_func f)
1619 {
1620         struct v4l2_ctrl **cluster = helpers[from].ctrl->cluster;
1621         int ret = 0;
1622         int i;
1623
1624         /* Find any controls from the same cluster and call the function */
1625         for (i = from; !ret && i < cs->count; i++) {
1626                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1627
1628                 if (!helpers[i].handled && ctrl->cluster == cluster)
1629                         ret = f(&cs->controls[i], ctrl);
1630         }
1631         return ret;
1632 }
1633
1634 static void cluster_done(unsigned from,
1635                          struct v4l2_ext_controls *cs,
1636                          struct ctrl_helper *helpers)
1637 {
1638         struct v4l2_ctrl **cluster = helpers[from].ctrl->cluster;
1639         int i;
1640
1641         /* Find any controls from the same cluster and mark them as handled */
1642         for (i = from; i < cs->count; i++)
1643                 if (helpers[i].ctrl->cluster == cluster)
1644                         helpers[i].handled = true;
1645 }
1646
1647 /* Handles the corner case where cs->count == 0. It checks whether the
1648    specified control class exists. If that class ID is 0, then it checks
1649    whether there are any controls at all. */
1650 static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
1651 {
1652         if (ctrl_class == 0)
1653                 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
1654         return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
1655 }
1656
1657
1658
1659 /* Get extended controls. Allocates the helpers array if needed. */
1660 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1661 {
1662         struct ctrl_helper helper[4];
1663         struct ctrl_helper *helpers = helper;
1664         int ret;
1665         int i, j;
1666
1667         cs->error_idx = cs->count;
1668         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1669
1670         if (hdl == NULL)
1671                 return -EINVAL;
1672
1673         if (cs->count == 0)
1674                 return class_check(hdl, cs->ctrl_class);
1675
1676         if (cs->count > ARRAY_SIZE(helper)) {
1677                 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1678                 if (helpers == NULL)
1679                         return -ENOMEM;
1680         }
1681
1682         ret = prepare_ext_ctrls(hdl, cs, helpers);
1683         cs->error_idx = cs->count;
1684
1685         for (i = 0; !ret && i < cs->count; i++)
1686                 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1687                         ret = -EACCES;
1688
1689         for (i = 0; !ret && i < cs->count; i++) {
1690                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1691                 struct v4l2_ctrl *master = ctrl->cluster[0];
1692                 bool has_volatiles;
1693
1694                 if (helpers[i].handled)
1695                         continue;
1696
1697                 cs->error_idx = i;
1698
1699                 /* Any volatile controls requested from this cluster? */
1700                 has_volatiles = ctrl->is_volatile;
1701                 if (!has_volatiles && has_op(master, g_volatile_ctrl) &&
1702                                 master->ncontrols > 1)
1703                         has_volatiles = cluster_walk(i, cs, helpers,
1704                                                 ctrl_is_volatile);
1705
1706                 v4l2_ctrl_lock(master);
1707
1708                 /* g_volatile_ctrl will update the new control values */
1709                 if (has_volatiles && !is_cur_manual(master)) {
1710                         for (j = 0; j < master->ncontrols; j++)
1711                                 cur_to_new(master->cluster[j]);
1712                         ret = call_op(master, g_volatile_ctrl);
1713                 }
1714                 /* If OK, then copy the current (for non-volatile controls)
1715                    or the new (for volatile controls) control values to the
1716                    caller */
1717                 if (!ret)
1718                         ret = cluster_walk(i, cs, helpers, ctrl_to_user);
1719                 v4l2_ctrl_unlock(master);
1720                 cluster_done(i, cs, helpers);
1721         }
1722
1723         if (cs->count > ARRAY_SIZE(helper))
1724                 kfree(helpers);
1725         return ret;
1726 }
1727 EXPORT_SYMBOL(v4l2_g_ext_ctrls);
1728
1729 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1730 {
1731         return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
1732 }
1733 EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
1734
1735 /* Helper function to get a single control */
1736 static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
1737 {
1738         struct v4l2_ctrl *master = ctrl->cluster[0];
1739         int ret = 0;
1740         int i;
1741
1742         if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
1743                 return -EACCES;
1744
1745         v4l2_ctrl_lock(master);
1746         /* g_volatile_ctrl will update the current control values */
1747         if (ctrl->is_volatile && !is_cur_manual(master)) {
1748                 for (i = 0; i < master->ncontrols; i++)
1749                         cur_to_new(master->cluster[i]);
1750                 ret = call_op(master, g_volatile_ctrl);
1751                 *val = ctrl->val;
1752         } else {
1753                 *val = ctrl->cur.val;
1754         }
1755         v4l2_ctrl_unlock(master);
1756         return ret;
1757 }
1758
1759 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
1760 {
1761         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
1762
1763         if (ctrl == NULL || !type_is_int(ctrl))
1764                 return -EINVAL;
1765         return get_ctrl(ctrl, &control->value);
1766 }
1767 EXPORT_SYMBOL(v4l2_g_ctrl);
1768
1769 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
1770 {
1771         return v4l2_g_ctrl(sd->ctrl_handler, control);
1772 }
1773 EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
1774
1775 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
1776 {
1777         s32 val = 0;
1778
1779         /* It's a driver bug if this happens. */
1780         WARN_ON(!type_is_int(ctrl));
1781         get_ctrl(ctrl, &val);
1782         return val;
1783 }
1784 EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
1785
1786
1787 /* Core function that calls try/s_ctrl and ensures that the new value is
1788    copied to the current value on a set.
1789    Must be called with ctrl->handler->lock held. */
1790 static int try_or_set_control_cluster(struct v4l2_fh *fh,
1791                                         struct v4l2_ctrl *master, bool set)
1792 {
1793         bool update_flag;
1794         bool try = !set;
1795         int ret = 0;
1796         int i;
1797
1798         /* Go through the cluster and either validate the new value or
1799            (if no new value was set), copy the current value to the new
1800            value, ensuring a consistent view for the control ops when
1801            called. */
1802         for (i = 0; !ret && i < master->ncontrols; i++) {
1803                 struct v4l2_ctrl *ctrl = master->cluster[i];
1804
1805                 if (ctrl == NULL)
1806                         continue;
1807
1808                 if (ctrl->is_new) {
1809                         /* Double check this: it may have changed since the
1810                            last check in try_or_set_ext_ctrls(). */
1811                         if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
1812                                 return -EBUSY;
1813
1814                         /* Validate if required */
1815                         if (!set)
1816                                 ret = validate_new(ctrl);
1817                         continue;
1818                 }
1819                 /* No new value was set, so copy the current and force
1820                    a call to try_ctrl later, since the values for the cluster
1821                    may now have changed and the end result might be invalid. */
1822                 try = true;
1823                 cur_to_new(ctrl);
1824         }
1825
1826         /* For larger clusters you have to call try_ctrl again to
1827            verify that the controls are still valid after the
1828            'cur_to_new' above. */
1829         if (!ret && try)
1830                 ret = call_op(master, try_ctrl);
1831
1832         /* Don't set if there is no change */
1833         if (ret || !set || !cluster_changed(master))
1834                 return ret;
1835         ret = call_op(master, s_ctrl);
1836         /* If OK, then make the new values permanent. */
1837         if (ret)
1838                 return ret;
1839
1840         update_flag = is_cur_manual(master) != is_new_manual(master);
1841         for (i = 0; i < master->ncontrols; i++)
1842                 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
1843         return 0;
1844 }
1845
1846 /* Try or set controls. */
1847 static int try_or_set_ext_ctrls(struct v4l2_fh *fh,
1848                                 struct v4l2_ctrl_handler *hdl,
1849                                 struct v4l2_ext_controls *cs,
1850                                 struct ctrl_helper *helpers,
1851                                 bool set)
1852 {
1853         unsigned i, j;
1854         int ret = 0;
1855
1856         for (i = 0; i < cs->count; i++) {
1857                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1858
1859                 cs->error_idx = i;
1860
1861                 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
1862                         return -EACCES;
1863                 /* This test is also done in try_set_control_cluster() which
1864                    is called in atomic context, so that has the final say,
1865                    but it makes sense to do an up-front check as well. Once
1866                    an error occurs in try_set_control_cluster() some other
1867                    controls may have been set already and we want to do a
1868                    best-effort to avoid that. */
1869                 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
1870                         return -EBUSY;
1871         }
1872
1873         for (i = 0; !ret && i < cs->count; i++) {
1874                 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
1875                 struct v4l2_ctrl *master = ctrl->cluster[0];
1876
1877                 if (helpers[i].handled)
1878                         continue;
1879
1880                 cs->error_idx = i;
1881                 v4l2_ctrl_lock(ctrl);
1882
1883                 /* Reset the 'is_new' flags of the cluster */
1884                 for (j = 0; j < master->ncontrols; j++)
1885                         if (master->cluster[j])
1886                                 master->cluster[j]->is_new = 0;
1887
1888                 /* Copy the new caller-supplied control values.
1889                    user_to_new() sets 'is_new' to 1. */
1890                 ret = cluster_walk(i, cs, helpers, user_to_new);
1891
1892                 if (!ret)
1893                         ret = try_or_set_control_cluster(fh, master, set);
1894
1895                 /* Copy the new values back to userspace. */
1896                 if (!ret)
1897                         ret = cluster_walk(i, cs, helpers, new_to_user);
1898
1899                 v4l2_ctrl_unlock(ctrl);
1900                 cluster_done(i, cs, helpers);
1901         }
1902         return ret;
1903 }
1904
1905 /* Try or try-and-set controls */
1906 static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
1907                              struct v4l2_ext_controls *cs,
1908                              bool set)
1909 {
1910         struct ctrl_helper helper[4];
1911         struct ctrl_helper *helpers = helper;
1912         int ret;
1913         int i;
1914
1915         cs->error_idx = cs->count;
1916         cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
1917
1918         if (hdl == NULL)
1919                 return -EINVAL;
1920
1921         if (cs->count == 0)
1922                 return class_check(hdl, cs->ctrl_class);
1923
1924         if (cs->count > ARRAY_SIZE(helper)) {
1925                 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
1926                 if (!helpers)
1927                         return -ENOMEM;
1928         }
1929         ret = prepare_ext_ctrls(hdl, cs, helpers);
1930
1931         /* First 'try' all controls and abort on error */
1932         if (!ret)
1933                 ret = try_or_set_ext_ctrls(NULL, hdl, cs, helpers, false);
1934         /* If this is a 'set' operation and the initial 'try' failed,
1935            then set error_idx to count to tell the application that no
1936            controls changed value yet. */
1937         if (set)
1938                 cs->error_idx = cs->count;
1939         if (!ret && set) {
1940                 /* Reset 'handled' state */
1941                 for (i = 0; i < cs->count; i++)
1942                         helpers[i].handled = false;
1943                 ret = try_or_set_ext_ctrls(fh, hdl, cs, helpers, true);
1944         }
1945
1946         if (cs->count > ARRAY_SIZE(helper))
1947                 kfree(helpers);
1948         return ret;
1949 }
1950
1951 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
1952 {
1953         return try_set_ext_ctrls(NULL, hdl, cs, false);
1954 }
1955 EXPORT_SYMBOL(v4l2_try_ext_ctrls);
1956
1957 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
1958                                         struct v4l2_ext_controls *cs)
1959 {
1960         return try_set_ext_ctrls(fh, hdl, cs, true);
1961 }
1962 EXPORT_SYMBOL(v4l2_s_ext_ctrls);
1963
1964 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1965 {
1966         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
1967 }
1968 EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
1969
1970 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
1971 {
1972         return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
1973 }
1974 EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
1975
1976 /* Helper function for VIDIOC_S_CTRL compatibility */
1977 static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
1978 {
1979         struct v4l2_ctrl *master = ctrl->cluster[0];
1980         int ret;
1981         int i;
1982
1983         v4l2_ctrl_lock(ctrl);
1984
1985         /* Reset the 'is_new' flags of the cluster */
1986         for (i = 0; i < master->ncontrols; i++)
1987                 if (master->cluster[i])
1988                         master->cluster[i]->is_new = 0;
1989
1990         ctrl->val = *val;
1991         ctrl->is_new = 1;
1992         ret = try_or_set_control_cluster(NULL, master, false);
1993         if (!ret)
1994                 ret = try_or_set_control_cluster(fh, master, true);
1995         *val = ctrl->cur.val;
1996         v4l2_ctrl_unlock(ctrl);
1997         return ret;
1998 }
1999
2000 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2001                                         struct v4l2_control *control)
2002 {
2003         struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2004
2005         if (ctrl == NULL || !type_is_int(ctrl))
2006                 return -EINVAL;
2007
2008         if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2009                 return -EACCES;
2010
2011         return set_ctrl(fh, ctrl, &control->value);
2012 }
2013 EXPORT_SYMBOL(v4l2_s_ctrl);
2014
2015 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2016 {
2017         return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
2018 }
2019 EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2020
2021 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2022 {
2023         /* It's a driver bug if this happens. */
2024         WARN_ON(!type_is_int(ctrl));
2025         return set_ctrl(NULL, ctrl, &val);
2026 }
2027 EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
2028
2029 void v4l2_ctrl_add_event(struct v4l2_ctrl *ctrl,
2030                                 struct v4l2_subscribed_event *sev)
2031 {
2032         v4l2_ctrl_lock(ctrl);
2033         list_add_tail(&sev->node, &ctrl->ev_subs);
2034         if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
2035             (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
2036                 struct v4l2_event ev;
2037
2038                 fill_event(&ev, ctrl, V4L2_EVENT_CTRL_CH_VALUE |
2039                         V4L2_EVENT_CTRL_CH_FLAGS);
2040                 v4l2_event_queue_fh(sev->fh, &ev);
2041         }
2042         v4l2_ctrl_unlock(ctrl);
2043 }
2044 EXPORT_SYMBOL(v4l2_ctrl_add_event);
2045
2046 void v4l2_ctrl_del_event(struct v4l2_ctrl *ctrl,
2047                                 struct v4l2_subscribed_event *sev)
2048 {
2049         v4l2_ctrl_lock(ctrl);
2050         list_del(&sev->node);
2051         v4l2_ctrl_unlock(ctrl);
2052 }
2053 EXPORT_SYMBOL(v4l2_ctrl_del_event);
2054
2055 int v4l2_ctrl_subscribe_fh(struct v4l2_fh *fh,
2056                         struct v4l2_event_subscription *sub, unsigned n)
2057 {
2058         struct v4l2_ctrl_handler *hdl = fh->ctrl_handler;
2059         int ret = 0;
2060
2061         if (!ret) {
2062                 if (hdl->nr_of_refs * 2 > n)
2063                         n = hdl->nr_of_refs * 2;
2064                 ret = v4l2_event_alloc(fh, n);
2065         }
2066         if (!ret)
2067                 ret = v4l2_event_subscribe(fh, sub);
2068         return ret;
2069 }
2070 EXPORT_SYMBOL(v4l2_ctrl_subscribe_fh);