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