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