blob: 6a34c30fff5b8334049d5aa790106497bf35b69e [file] [log] [blame]
Hans Verkuil09965172010-08-01 14:32:42 -03001/*
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>
Randy Dunlap2b801632010-08-09 14:56:35 -030022#include <linux/slab.h>
Paul Gortmaker35a24632011-08-01 15:26:38 -040023#include <linux/export.h>
Hans Verkuil09965172010-08-01 14:32:42 -030024#include <media/v4l2-ioctl.h>
25#include <media/v4l2-device.h>
26#include <media/v4l2-ctrls.h>
Hans Verkuil6e239392011-06-07 11:13:44 -030027#include <media/v4l2-event.h>
Hans Verkuil09965172010-08-01 14:32:42 -030028#include <media/v4l2-dev.h>
29
Hans Verkuilddac5c12011-06-10 05:43:34 -030030#define has_op(master, op) \
31 (master->ops && master->ops->op)
Hans Verkuil54c911e2011-05-25 06:04:58 -030032#define call_op(master, op) \
Hans Verkuilddac5c12011-06-10 05:43:34 -030033 (has_op(master, op) ? master->ops->op(master) : 0)
Hans Verkuil54c911e2011-05-25 06:04:58 -030034
Hans Verkuil09965172010-08-01 14:32:42 -030035/* Internal temporary helper struct, one for each v4l2_ext_control */
Hans Verkuileb5b16e2011-06-14 10:04:06 -030036struct v4l2_ctrl_helper {
37 /* Pointer to the control reference of the master control */
38 struct v4l2_ctrl_ref *mref;
Hans Verkuil09965172010-08-01 14:32:42 -030039 /* The control corresponding to the v4l2_ext_control ID field. */
40 struct v4l2_ctrl *ctrl;
Hans Verkuileb5b16e2011-06-14 10:04:06 -030041 /* v4l2_ext_control index of the next control belonging to the
42 same cluster, or 0 if there isn't any. */
43 u32 next;
Hans Verkuil09965172010-08-01 14:32:42 -030044};
45
Hans Verkuil72d877c2011-06-10 05:44:36 -030046/* Small helper function to determine if the autocluster is set to manual
Hans Verkuil88365102011-08-26 07:35:14 -030047 mode. */
Hans Verkuil72d877c2011-06-10 05:44:36 -030048static 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
Hans Verkuil09965172010-08-01 14:32:42 -030060/* 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. */
Hans Verkuil513521e2010-12-29 14:25:52 -030064const char * const *v4l2_ctrl_get_menu(u32 id)
Hans Verkuil09965172010-08-01 14:32:42 -030065{
Hans Verkuil513521e2010-12-29 14:25:52 -030066 static const char * const mpeg_audio_sampling_freq[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030067 "44.1 kHz",
68 "48 kHz",
69 "32 kHz",
70 NULL
71 };
Hans Verkuil513521e2010-12-29 14:25:52 -030072 static const char * const mpeg_audio_encoding[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030073 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -030080 static const char * const mpeg_audio_l1_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030081 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -030097 static const char * const mpeg_audio_l2_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030098 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300114 static const char * const mpeg_audio_l3_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300115 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300131 static const char * const mpeg_audio_ac3_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300132 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300153 static const char * const mpeg_audio_mode[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300154 "Stereo",
155 "Joint Stereo",
156 "Dual",
157 "Mono",
158 NULL
159 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300160 static const char * const mpeg_audio_mode_extension[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300161 "Bound 4",
162 "Bound 8",
163 "Bound 12",
164 "Bound 16",
165 NULL
166 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300167 static const char * const mpeg_audio_emphasis[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300168 "No Emphasis",
169 "50/15 us",
170 "CCITT J17",
171 NULL
172 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300173 static const char * const mpeg_audio_crc[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300174 "No CRC",
175 "16-bit CRC",
176 NULL
177 };
Hans Verkuil24c19a22011-12-15 10:46:16 -0300178 static const char * const mpeg_audio_dec_playback[] = {
179 "Auto",
180 "Stereo",
181 "Left",
182 "Right",
183 "Mono",
184 "Swapped Stereo",
185 NULL
186 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300187 static const char * const mpeg_video_encoding[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300188 "MPEG-1",
189 "MPEG-2",
190 "MPEG-4 AVC",
191 NULL
192 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300193 static const char * const mpeg_video_aspect[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300194 "1x1",
195 "4x3",
196 "16x9",
197 "2.21x1",
198 NULL
199 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300200 static const char * const mpeg_video_bitrate_mode[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300201 "Variable Bitrate",
202 "Constant Bitrate",
203 NULL
204 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300205 static const char * const mpeg_stream_type[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300206 "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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300214 static const char * const mpeg_stream_vbi_fmt[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300215 "No VBI",
Kamil Debski064f5092011-06-14 10:46:22 -0300216 "Private Packet, IVTV Format",
Hans Verkuil09965172010-08-01 14:32:42 -0300217 NULL
218 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300219 static const char * const camera_power_line_frequency[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300220 "Disabled",
221 "50 Hz",
222 "60 Hz",
Sylwester Nawrockid26a6632011-09-04 19:08:54 -0300223 "Auto",
Hans Verkuil09965172010-08-01 14:32:42 -0300224 NULL
225 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300226 static const char * const camera_exposure_auto[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300227 "Auto Mode",
228 "Manual Mode",
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
231 NULL
232 };
Sylwester Nawrockicf072132012-04-30 04:34:10 -0300233 static const char * const camera_exposure_metering[] = {
234 "Average",
235 "Center Weighted",
236 "Spot",
237 NULL
238 };
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300239 static const char * const camera_auto_focus_range[] = {
240 "Auto",
241 "Normal",
242 "Macro",
243 "Infinity",
244 NULL
245 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300246 static const char * const colorfx[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300247 "None",
248 "Black & White",
249 "Sepia",
250 "Negative",
251 "Emboss",
252 "Sketch",
Kamil Debski064f5092011-06-14 10:46:22 -0300253 "Sky Blue",
254 "Grass Green",
255 "Skin Whiten",
Hans Verkuil09965172010-08-01 14:32:42 -0300256 "Vivid",
Sylwester Nawrocki6491d1a2012-04-02 06:40:19 -0300257 "Aqua",
258 "Art Freeze",
259 "Silhouette",
260 "Solarization",
261 "Antique",
262 "Set Cb/Cr",
Hans Verkuil09965172010-08-01 14:32:42 -0300263 NULL
264 };
Sylwester Nawrockie40a0572012-03-06 07:04:26 -0300265 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 };
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -0300278 static const char * const camera_iso_sensitivity_auto[] = {
279 "Manual",
280 "Auto",
281 NULL
282 };
Sylwester Nawrocki0bf6b7d2012-04-16 10:45:44 -0300283 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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300300 static const char * const tune_preemphasis[] = {
Kamil Debski064f5092011-06-14 10:46:22 -0300301 "No Preemphasis",
Hans Verkuilf769c262012-03-02 04:20:19 -0300302 "50 Microseconds",
303 "75 Microseconds",
Hans Verkuil09965172010-08-01 14:32:42 -0300304 NULL,
305 };
Kamil Debski064f5092011-06-14 10:46:22 -0300306 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",
Hans Verkuilf769c262012-03-02 04:20:19 -0300400 "Advanced Simple",
Kamil Debski064f5092011-06-14 10:46:22 -0300401 "Core",
402 "Simple Scalable",
403 "Advanced Coding Efficency",
404 NULL,
405 };
406
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300407 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 };
Hans Verkuil09965172010-08-01 14:32:42 -0300418
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300419 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 };
Hans Verkuil977ebec2012-07-03 06:14:37 -0300428 static const char * const dv_tx_mode[] = {
429 "DVI-D",
430 "HDMI",
431 NULL,
432 };
433 static const char * const dv_rgb_range[] = {
434 "Automatic",
435 "RGB limited range (16-235)",
436 "RGB full range (0-255)",
437 NULL,
438 };
439
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300440
Hans Verkuil09965172010-08-01 14:32:42 -0300441 switch (id) {
442 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
443 return mpeg_audio_sampling_freq;
444 case V4L2_CID_MPEG_AUDIO_ENCODING:
445 return mpeg_audio_encoding;
446 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
447 return mpeg_audio_l1_bitrate;
448 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
449 return mpeg_audio_l2_bitrate;
450 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
451 return mpeg_audio_l3_bitrate;
452 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
453 return mpeg_audio_ac3_bitrate;
454 case V4L2_CID_MPEG_AUDIO_MODE:
455 return mpeg_audio_mode;
456 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
457 return mpeg_audio_mode_extension;
458 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
459 return mpeg_audio_emphasis;
460 case V4L2_CID_MPEG_AUDIO_CRC:
461 return mpeg_audio_crc;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300462 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
463 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
464 return mpeg_audio_dec_playback;
Hans Verkuil09965172010-08-01 14:32:42 -0300465 case V4L2_CID_MPEG_VIDEO_ENCODING:
466 return mpeg_video_encoding;
467 case V4L2_CID_MPEG_VIDEO_ASPECT:
468 return mpeg_video_aspect;
469 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
470 return mpeg_video_bitrate_mode;
471 case V4L2_CID_MPEG_STREAM_TYPE:
472 return mpeg_stream_type;
473 case V4L2_CID_MPEG_STREAM_VBI_FMT:
474 return mpeg_stream_vbi_fmt;
475 case V4L2_CID_POWER_LINE_FREQUENCY:
476 return camera_power_line_frequency;
477 case V4L2_CID_EXPOSURE_AUTO:
478 return camera_exposure_auto;
Sylwester Nawrockicf072132012-04-30 04:34:10 -0300479 case V4L2_CID_EXPOSURE_METERING:
480 return camera_exposure_metering;
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300481 case V4L2_CID_AUTO_FOCUS_RANGE:
482 return camera_auto_focus_range;
Hans Verkuil09965172010-08-01 14:32:42 -0300483 case V4L2_CID_COLORFX:
484 return colorfx;
Sylwester Nawrockie40a0572012-03-06 07:04:26 -0300485 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
486 return auto_n_preset_white_balance;
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -0300487 case V4L2_CID_ISO_SENSITIVITY_AUTO:
488 return camera_iso_sensitivity_auto;
Sylwester Nawrocki0bf6b7d2012-04-16 10:45:44 -0300489 case V4L2_CID_SCENE_MODE:
490 return scene_mode;
Hans Verkuil09965172010-08-01 14:32:42 -0300491 case V4L2_CID_TUNE_PREEMPHASIS:
492 return tune_preemphasis;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300493 case V4L2_CID_FLASH_LED_MODE:
494 return flash_led_mode;
495 case V4L2_CID_FLASH_STROBE_SOURCE:
496 return flash_strobe_source;
Kamil Debski064f5092011-06-14 10:46:22 -0300497 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
498 return header_mode;
499 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
500 return multi_slice;
501 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
502 return entropy_mode;
503 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
504 return mpeg_h264_level;
505 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
506 return h264_loop_filter;
507 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
508 return h264_profile;
509 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
510 return vui_sar_idc;
511 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
512 return mpeg_mpeg4_level;
513 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
514 return mpeg4_profile;
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300515 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
516 return jpeg_chroma_subsampling;
Hans Verkuil977ebec2012-07-03 06:14:37 -0300517 case V4L2_CID_DV_TX_MODE:
518 return dv_tx_mode;
519 case V4L2_CID_DV_TX_RGB_RANGE:
520 case V4L2_CID_DV_RX_RGB_RANGE:
521 return dv_rgb_range;
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300522
Hans Verkuil09965172010-08-01 14:32:42 -0300523 default:
524 return NULL;
525 }
526}
527EXPORT_SYMBOL(v4l2_ctrl_get_menu);
528
529/* Return the control name. */
530const char *v4l2_ctrl_get_name(u32 id)
531{
532 switch (id) {
533 /* USER controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300534 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300535 case V4L2_CID_USER_CLASS: return "User Controls";
536 case V4L2_CID_BRIGHTNESS: return "Brightness";
537 case V4L2_CID_CONTRAST: return "Contrast";
538 case V4L2_CID_SATURATION: return "Saturation";
539 case V4L2_CID_HUE: return "Hue";
540 case V4L2_CID_AUDIO_VOLUME: return "Volume";
541 case V4L2_CID_AUDIO_BALANCE: return "Balance";
542 case V4L2_CID_AUDIO_BASS: return "Bass";
543 case V4L2_CID_AUDIO_TREBLE: return "Treble";
544 case V4L2_CID_AUDIO_MUTE: return "Mute";
545 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
Hans Verkuil09965172010-08-01 14:32:42 -0300546 case V4L2_CID_BLACK_LEVEL: return "Black Level";
547 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
548 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
549 case V4L2_CID_RED_BALANCE: return "Red Balance";
550 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
551 case V4L2_CID_GAMMA: return "Gamma";
552 case V4L2_CID_EXPOSURE: return "Exposure";
553 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
554 case V4L2_CID_GAIN: return "Gain";
555 case V4L2_CID_HFLIP: return "Horizontal Flip";
556 case V4L2_CID_VFLIP: return "Vertical Flip";
557 case V4L2_CID_HCENTER: return "Horizontal Center";
558 case V4L2_CID_VCENTER: return "Vertical Center";
559 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
560 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
561 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
562 case V4L2_CID_SHARPNESS: return "Sharpness";
563 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
564 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
Hans Verkuil09965172010-08-01 14:32:42 -0300565 case V4L2_CID_COLOR_KILLER: return "Color Killer";
566 case V4L2_CID_COLORFX: return "Color Effects";
567 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
568 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
569 case V4L2_CID_ROTATE: return "Rotate";
570 case V4L2_CID_BG_COLOR: return "Background Color";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300571 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
Jean-François Moine008d35f2010-09-13 07:04:49 -0300572 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
573 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300574 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
575 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
Sylwester Nawrockicc1d3272011-11-14 08:48:18 -0300576 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
Sylwester Nawrocki6491d1a2012-04-02 06:40:19 -0300577 case V4L2_CID_COLORFX_CBCR: return "Color Effects, CbCr";
Hans Verkuil09965172010-08-01 14:32:42 -0300578
579 /* MPEG controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300580 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300581 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
582 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
583 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
584 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
585 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
586 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300587 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
588 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
589 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
Hans Verkuil09965172010-08-01 14:32:42 -0300590 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300591 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
592 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
593 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
594 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
595 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
Hans Verkuil09965172010-08-01 14:32:42 -0300596 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300597 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
598 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
599 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
600 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
601 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300602 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
603 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300604 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
605 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
606 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
607 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
608 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
609 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
610 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
611 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
612 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
Hans Verkuil09965172010-08-01 14:32:42 -0300613 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300614 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
Hans Verkuil09965172010-08-01 14:32:42 -0300615 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
Kamil Debski064f5092011-06-14 10:46:22 -0300616 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
617 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300618 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
Kamil Debski064f5092011-06-14 10:46:22 -0300619 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
620 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
621 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300622 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
Kamil Debski064f5092011-06-14 10:46:22 -0300623 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300624 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
625 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300626 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
627 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
628 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300629 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
630 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300631 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
632 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
633 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
634 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300635 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
636 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
Kamil Debski064f5092011-06-14 10:46:22 -0300637 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
638 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
639 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
640 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
641 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
642 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
643 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
644 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
645 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
646 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300647 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
648 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300649 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
650 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
651 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
652 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
653 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300654 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
655 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
656 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
Kamil Debski064f5092011-06-14 10:46:22 -0300657 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300658 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
659 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
Hans Verkuil09965172010-08-01 14:32:42 -0300660
661 /* CAMERA controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300662 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300663 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
664 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
665 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
666 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
667 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
668 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
669 case V4L2_CID_PAN_RESET: return "Pan, Reset";
670 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
671 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
672 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
673 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
674 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300675 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic Continuous";
Hans Verkuil09965172010-08-01 14:32:42 -0300676 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
677 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
678 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
679 case V4L2_CID_PRIVACY: return "Privacy";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300680 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
681 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
Sylwester Nawrockid58083c2012-03-06 07:06:55 -0300682 case V4L2_CID_AUTO_EXPOSURE_BIAS: return "Auto Exposure, Bias";
Sylwester Nawrockie40a0572012-03-06 07:04:26 -0300683 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE: return "White Balance, Auto & Preset";
Sylwester Nawrocki44d44a12012-03-06 07:05:45 -0300684 case V4L2_CID_WIDE_DYNAMIC_RANGE: return "Wide Dynamic Range";
Sylwester Nawrocki82b30562012-05-01 17:38:09 -0300685 case V4L2_CID_IMAGE_STABILIZATION: return "Image Stabilization";
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -0300686 case V4L2_CID_ISO_SENSITIVITY: return "ISO Sensitivity";
687 case V4L2_CID_ISO_SENSITIVITY_AUTO: return "ISO Sensitivity, Auto";
Sylwester Nawrockicf072132012-04-30 04:34:10 -0300688 case V4L2_CID_EXPOSURE_METERING: return "Exposure, Metering Mode";
Sylwester Nawrocki0bf6b7d2012-04-16 10:45:44 -0300689 case V4L2_CID_SCENE_MODE: return "Scene Mode";
Sylwester Nawrockifc162a02012-05-02 06:24:33 -0300690 case V4L2_CID_3A_LOCK: return "3A Lock";
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300691 case V4L2_CID_AUTO_FOCUS_START: return "Auto Focus, Start";
692 case V4L2_CID_AUTO_FOCUS_STOP: return "Auto Focus, Stop";
693 case V4L2_CID_AUTO_FOCUS_STATUS: return "Auto Focus, Status";
694 case V4L2_CID_AUTO_FOCUS_RANGE: return "Auto Focus, Range";
Hans Verkuil09965172010-08-01 14:32:42 -0300695
696 /* FM Radio Modulator control */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300697 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300698 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
699 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
700 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
701 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
702 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
703 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
704 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
705 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
706 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300707 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
Hans Verkuil09965172010-08-01 14:32:42 -0300708 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
709 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
710 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
711 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
712 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
713 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
714 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300715 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
Hans Verkuil09965172010-08-01 14:32:42 -0300716 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
717 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
718
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300719 /* Flash controls */
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300720 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
721 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
722 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300723 case V4L2_CID_FLASH_STROBE: return "Strobe";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300724 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
725 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
726 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
727 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
728 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
729 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300730 case V4L2_CID_FLASH_FAULT: return "Faults";
731 case V4L2_CID_FLASH_CHARGE: return "Charge";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300732 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300733
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300734 /* JPEG encoder controls */
735 /* Keep the order of the 'case's the same as in videodev2.h! */
736 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
737 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
738 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
739 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
740 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
741
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300742 /* Image source controls */
743 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
744 case V4L2_CID_VBLANK: return "Vertical Blanking";
745 case V4L2_CID_HBLANK: return "Horizontal Blanking";
746 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
747
Sakari Ailusc643ee12012-02-02 20:17:54 -0300748 /* Image processing controls */
749 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
750 case V4L2_CID_LINK_FREQ: return "Link Frequency";
751 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
752
Hans Verkuil977ebec2012-07-03 06:14:37 -0300753 /* DV controls */
754 case V4L2_CID_DV_CLASS: return "Digital Video Controls";
755 case V4L2_CID_DV_TX_HOTPLUG: return "Hotplug Present";
756 case V4L2_CID_DV_TX_RXSENSE: return "RxSense Present";
757 case V4L2_CID_DV_TX_EDID_PRESENT: return "EDID Present";
758 case V4L2_CID_DV_TX_MODE: return "Transmit Mode";
759 case V4L2_CID_DV_TX_RGB_RANGE: return "Tx RGB Quantization Range";
760 case V4L2_CID_DV_RX_POWER_PRESENT: return "Power Present";
761 case V4L2_CID_DV_RX_RGB_RANGE: return "Rx RGB Quantization Range";
762
Hans Verkuil09965172010-08-01 14:32:42 -0300763 default:
764 return NULL;
765 }
766}
767EXPORT_SYMBOL(v4l2_ctrl_get_name);
768
769void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
770 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
771{
772 *name = v4l2_ctrl_get_name(id);
773 *flags = 0;
774
775 switch (id) {
776 case V4L2_CID_AUDIO_MUTE:
777 case V4L2_CID_AUDIO_LOUDNESS:
778 case V4L2_CID_AUTO_WHITE_BALANCE:
779 case V4L2_CID_AUTOGAIN:
780 case V4L2_CID_HFLIP:
781 case V4L2_CID_VFLIP:
782 case V4L2_CID_HUE_AUTO:
783 case V4L2_CID_CHROMA_AGC:
784 case V4L2_CID_COLOR_KILLER:
Hans de Goedea2f8b842012-07-01 11:26:13 -0300785 case V4L2_CID_AUTOBRIGHTNESS:
Hans Verkuil09965172010-08-01 14:32:42 -0300786 case V4L2_CID_MPEG_AUDIO_MUTE:
787 case V4L2_CID_MPEG_VIDEO_MUTE:
788 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
789 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
790 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
791 case V4L2_CID_FOCUS_AUTO:
792 case V4L2_CID_PRIVACY:
793 case V4L2_CID_AUDIO_LIMITER_ENABLED:
794 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
795 case V4L2_CID_PILOT_TONE_ENABLED:
Jean-François Moine008d35f2010-09-13 07:04:49 -0300796 case V4L2_CID_ILLUMINATORS_1:
797 case V4L2_CID_ILLUMINATORS_2:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300798 case V4L2_CID_FLASH_STROBE_STATUS:
799 case V4L2_CID_FLASH_CHARGE:
800 case V4L2_CID_FLASH_READY:
Kamil Debski064f5092011-06-14 10:46:22 -0300801 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
802 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
803 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
804 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
805 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
806 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
807 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
Sylwester Nawrocki44d44a12012-03-06 07:05:45 -0300808 case V4L2_CID_WIDE_DYNAMIC_RANGE:
Sylwester Nawrocki82b30562012-05-01 17:38:09 -0300809 case V4L2_CID_IMAGE_STABILIZATION:
Hans Verkuil09965172010-08-01 14:32:42 -0300810 *type = V4L2_CTRL_TYPE_BOOLEAN;
811 *min = 0;
812 *max = *step = 1;
813 break;
814 case V4L2_CID_PAN_RESET:
815 case V4L2_CID_TILT_RESET:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300816 case V4L2_CID_FLASH_STROBE:
817 case V4L2_CID_FLASH_STROBE_STOP:
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300818 case V4L2_CID_AUTO_FOCUS_START:
819 case V4L2_CID_AUTO_FOCUS_STOP:
Hans Verkuil09965172010-08-01 14:32:42 -0300820 *type = V4L2_CTRL_TYPE_BUTTON;
821 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
822 *min = *max = *step = *def = 0;
823 break;
824 case V4L2_CID_POWER_LINE_FREQUENCY:
825 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
826 case V4L2_CID_MPEG_AUDIO_ENCODING:
827 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
828 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
829 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
830 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
831 case V4L2_CID_MPEG_AUDIO_MODE:
832 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
833 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
834 case V4L2_CID_MPEG_AUDIO_CRC:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300835 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
836 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
Hans Verkuil09965172010-08-01 14:32:42 -0300837 case V4L2_CID_MPEG_VIDEO_ENCODING:
838 case V4L2_CID_MPEG_VIDEO_ASPECT:
839 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
840 case V4L2_CID_MPEG_STREAM_TYPE:
841 case V4L2_CID_MPEG_STREAM_VBI_FMT:
842 case V4L2_CID_EXPOSURE_AUTO:
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300843 case V4L2_CID_AUTO_FOCUS_RANGE:
Hans Verkuil09965172010-08-01 14:32:42 -0300844 case V4L2_CID_COLORFX:
Sylwester Nawrockie40a0572012-03-06 07:04:26 -0300845 case V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE:
Hans Verkuil09965172010-08-01 14:32:42 -0300846 case V4L2_CID_TUNE_PREEMPHASIS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300847 case V4L2_CID_FLASH_LED_MODE:
848 case V4L2_CID_FLASH_STROBE_SOURCE:
Kamil Debski064f5092011-06-14 10:46:22 -0300849 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
850 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
851 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
852 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
853 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
854 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
855 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
856 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
857 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300858 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -0300859 case V4L2_CID_ISO_SENSITIVITY_AUTO:
Sylwester Nawrockicf072132012-04-30 04:34:10 -0300860 case V4L2_CID_EXPOSURE_METERING:
Sylwester Nawrocki0bf6b7d2012-04-16 10:45:44 -0300861 case V4L2_CID_SCENE_MODE:
Hans Verkuil977ebec2012-07-03 06:14:37 -0300862 case V4L2_CID_DV_TX_MODE:
863 case V4L2_CID_DV_TX_RGB_RANGE:
864 case V4L2_CID_DV_RX_RGB_RANGE:
Hans Verkuil09965172010-08-01 14:32:42 -0300865 *type = V4L2_CTRL_TYPE_MENU;
866 break;
Sakari Ailusc643ee12012-02-02 20:17:54 -0300867 case V4L2_CID_LINK_FREQ:
868 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
869 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300870 case V4L2_CID_RDS_TX_PS_NAME:
871 case V4L2_CID_RDS_TX_RADIO_TEXT:
872 *type = V4L2_CTRL_TYPE_STRING;
873 break;
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -0300874 case V4L2_CID_ISO_SENSITIVITY:
Sylwester Nawrockid58083c2012-03-06 07:06:55 -0300875 case V4L2_CID_AUTO_EXPOSURE_BIAS:
876 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
877 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300878 case V4L2_CID_USER_CLASS:
879 case V4L2_CID_CAMERA_CLASS:
880 case V4L2_CID_MPEG_CLASS:
881 case V4L2_CID_FM_TX_CLASS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300882 case V4L2_CID_FLASH_CLASS:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300883 case V4L2_CID_JPEG_CLASS:
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300884 case V4L2_CID_IMAGE_SOURCE_CLASS:
Sakari Ailusc643ee12012-02-02 20:17:54 -0300885 case V4L2_CID_IMAGE_PROC_CLASS:
Hans Verkuil977ebec2012-07-03 06:14:37 -0300886 case V4L2_CID_DV_CLASS:
Hans Verkuil09965172010-08-01 14:32:42 -0300887 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
888 /* You can neither read not write these */
889 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
890 *min = *max = *step = *def = 0;
891 break;
892 case V4L2_CID_BG_COLOR:
893 *type = V4L2_CTRL_TYPE_INTEGER;
894 *step = 1;
895 *min = 0;
896 /* Max is calculated as RGB888 that is 2^24 */
897 *max = 0xFFFFFF;
898 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300899 case V4L2_CID_FLASH_FAULT:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300900 case V4L2_CID_JPEG_ACTIVE_MARKER:
Sylwester Nawrockifc162a02012-05-02 06:24:33 -0300901 case V4L2_CID_3A_LOCK:
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300902 case V4L2_CID_AUTO_FOCUS_STATUS:
Hans Verkuil977ebec2012-07-03 06:14:37 -0300903 case V4L2_CID_DV_TX_HOTPLUG:
904 case V4L2_CID_DV_TX_RXSENSE:
905 case V4L2_CID_DV_TX_EDID_PRESENT:
906 case V4L2_CID_DV_RX_POWER_PRESENT:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300907 *type = V4L2_CTRL_TYPE_BITMASK;
908 break;
Kamil Debski064f5092011-06-14 10:46:22 -0300909 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
910 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
911 *type = V4L2_CTRL_TYPE_INTEGER;
912 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
913 break;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300914 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
915 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
Sakari Ailusc643ee12012-02-02 20:17:54 -0300916 *flags |= V4L2_CTRL_FLAG_VOLATILE;
917 /* Fall through */
918 case V4L2_CID_PIXEL_RATE:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300919 *type = V4L2_CTRL_TYPE_INTEGER64;
Sakari Ailusc643ee12012-02-02 20:17:54 -0300920 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
Hans Verkuilca576812012-04-19 12:37:18 -0300921 *min = *max = *step = *def = 0;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300922 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300923 default:
924 *type = V4L2_CTRL_TYPE_INTEGER;
925 break;
926 }
927 switch (id) {
928 case V4L2_CID_MPEG_AUDIO_ENCODING:
929 case V4L2_CID_MPEG_AUDIO_MODE:
930 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
931 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
932 case V4L2_CID_MPEG_STREAM_TYPE:
933 *flags |= V4L2_CTRL_FLAG_UPDATE;
934 break;
935 case V4L2_CID_AUDIO_VOLUME:
936 case V4L2_CID_AUDIO_BALANCE:
937 case V4L2_CID_AUDIO_BASS:
938 case V4L2_CID_AUDIO_TREBLE:
939 case V4L2_CID_BRIGHTNESS:
940 case V4L2_CID_CONTRAST:
941 case V4L2_CID_SATURATION:
942 case V4L2_CID_HUE:
943 case V4L2_CID_RED_BALANCE:
944 case V4L2_CID_BLUE_BALANCE:
945 case V4L2_CID_GAMMA:
946 case V4L2_CID_SHARPNESS:
947 case V4L2_CID_CHROMA_GAIN:
948 case V4L2_CID_RDS_TX_DEVIATION:
949 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
950 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
951 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
952 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
953 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
954 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
955 case V4L2_CID_PILOT_TONE_DEVIATION:
956 case V4L2_CID_PILOT_TONE_FREQUENCY:
957 case V4L2_CID_TUNE_POWER_LEVEL:
958 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
959 *flags |= V4L2_CTRL_FLAG_SLIDER;
960 break;
961 case V4L2_CID_PAN_RELATIVE:
962 case V4L2_CID_TILT_RELATIVE:
963 case V4L2_CID_FOCUS_RELATIVE:
964 case V4L2_CID_IRIS_RELATIVE:
965 case V4L2_CID_ZOOM_RELATIVE:
966 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
967 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300968 case V4L2_CID_FLASH_STROBE_STATUS:
Sylwester Nawrocki2272ab62012-05-11 06:37:03 -0300969 case V4L2_CID_AUTO_FOCUS_STATUS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300970 case V4L2_CID_FLASH_READY:
Hans Verkuil977ebec2012-07-03 06:14:37 -0300971 case V4L2_CID_DV_TX_HOTPLUG:
972 case V4L2_CID_DV_TX_RXSENSE:
973 case V4L2_CID_DV_TX_EDID_PRESENT:
974 case V4L2_CID_DV_RX_POWER_PRESENT:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300975 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
976 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300977 }
978}
979EXPORT_SYMBOL(v4l2_ctrl_fill);
980
981/* Helper function to determine whether the control type is compatible with
982 VIDIOC_G/S_CTRL. */
983static bool type_is_int(const struct v4l2_ctrl *ctrl)
984{
985 switch (ctrl->type) {
986 case V4L2_CTRL_TYPE_INTEGER64:
987 case V4L2_CTRL_TYPE_STRING:
988 /* Nope, these need v4l2_ext_control */
989 return false;
990 default:
991 return true;
992 }
993}
994
Hans Verkuil6e239392011-06-07 11:13:44 -0300995static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
996{
997 memset(ev->reserved, 0, sizeof(ev->reserved));
998 ev->type = V4L2_EVENT_CTRL;
999 ev->id = ctrl->id;
1000 ev->u.ctrl.changes = changes;
1001 ev->u.ctrl.type = ctrl->type;
1002 ev->u.ctrl.flags = ctrl->flags;
1003 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
1004 ev->u.ctrl.value64 = 0;
1005 else
1006 ev->u.ctrl.value64 = ctrl->cur.val64;
1007 ev->u.ctrl.minimum = ctrl->minimum;
1008 ev->u.ctrl.maximum = ctrl->maximum;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001009 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1010 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil6e239392011-06-07 11:13:44 -03001011 ev->u.ctrl.step = 1;
1012 else
1013 ev->u.ctrl.step = ctrl->step;
1014 ev->u.ctrl.default_value = ctrl->default_value;
1015}
1016
1017static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
1018{
1019 struct v4l2_event ev;
Hans Verkuil77068d32011-06-13 18:55:58 -03001020 struct v4l2_subscribed_event *sev;
Hans Verkuil6e239392011-06-07 11:13:44 -03001021
Hans Verkuil77068d32011-06-13 18:55:58 -03001022 if (list_empty(&ctrl->ev_subs))
Hans Verkuil3f66f0e2011-06-20 11:56:24 -03001023 return;
Hans Verkuil6e239392011-06-07 11:13:44 -03001024 fill_event(&ev, ctrl, changes);
1025
Hans Verkuil77068d32011-06-13 18:55:58 -03001026 list_for_each_entry(sev, &ctrl->ev_subs, node)
Hans de Goedee3e72f392011-10-26 05:52:47 -03001027 if (sev->fh != fh ||
1028 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
Hans Verkuil77068d32011-06-13 18:55:58 -03001029 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -03001030}
1031
Hans Verkuil09965172010-08-01 14:32:42 -03001032/* Helper function: copy the current control value back to the caller */
1033static int cur_to_user(struct v4l2_ext_control *c,
1034 struct v4l2_ctrl *ctrl)
1035{
1036 u32 len;
1037
1038 switch (ctrl->type) {
1039 case V4L2_CTRL_TYPE_STRING:
1040 len = strlen(ctrl->cur.string);
1041 if (c->size < len + 1) {
1042 c->size = len + 1;
1043 return -ENOSPC;
1044 }
1045 return copy_to_user(c->string, ctrl->cur.string,
1046 len + 1) ? -EFAULT : 0;
1047 case V4L2_CTRL_TYPE_INTEGER64:
1048 c->value64 = ctrl->cur.val64;
1049 break;
1050 default:
1051 c->value = ctrl->cur.val;
1052 break;
1053 }
1054 return 0;
1055}
1056
1057/* Helper function: copy the caller-provider value as the new control value */
1058static int user_to_new(struct v4l2_ext_control *c,
1059 struct v4l2_ctrl *ctrl)
1060{
1061 int ret;
1062 u32 size;
1063
Hans Verkuil2a863792011-01-11 14:45:03 -03001064 ctrl->is_new = 1;
Hans Verkuil09965172010-08-01 14:32:42 -03001065 switch (ctrl->type) {
1066 case V4L2_CTRL_TYPE_INTEGER64:
1067 ctrl->val64 = c->value64;
1068 break;
1069 case V4L2_CTRL_TYPE_STRING:
1070 size = c->size;
1071 if (size == 0)
1072 return -ERANGE;
1073 if (size > ctrl->maximum + 1)
1074 size = ctrl->maximum + 1;
1075 ret = copy_from_user(ctrl->string, c->string, size);
1076 if (!ret) {
1077 char last = ctrl->string[size - 1];
1078
1079 ctrl->string[size - 1] = 0;
1080 /* If the string was longer than ctrl->maximum,
1081 then return an error. */
1082 if (strlen(ctrl->string) == ctrl->maximum && last)
1083 return -ERANGE;
1084 }
1085 return ret ? -EFAULT : 0;
1086 default:
1087 ctrl->val = c->value;
1088 break;
1089 }
1090 return 0;
1091}
1092
1093/* Helper function: copy the new control value back to the caller */
1094static int new_to_user(struct v4l2_ext_control *c,
1095 struct v4l2_ctrl *ctrl)
1096{
1097 u32 len;
1098
1099 switch (ctrl->type) {
1100 case V4L2_CTRL_TYPE_STRING:
1101 len = strlen(ctrl->string);
1102 if (c->size < len + 1) {
1103 c->size = ctrl->maximum + 1;
1104 return -ENOSPC;
1105 }
1106 return copy_to_user(c->string, ctrl->string,
1107 len + 1) ? -EFAULT : 0;
1108 case V4L2_CTRL_TYPE_INTEGER64:
1109 c->value64 = ctrl->val64;
1110 break;
1111 default:
1112 c->value = ctrl->val;
1113 break;
1114 }
1115 return 0;
1116}
1117
1118/* Copy the new value to the current value. */
Hans Verkuilab892ba2011-06-07 06:47:18 -03001119static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
1120 bool update_inactive)
Hans Verkuil09965172010-08-01 14:32:42 -03001121{
Hans Verkuil6e239392011-06-07 11:13:44 -03001122 bool changed = false;
1123
Hans Verkuil09965172010-08-01 14:32:42 -03001124 if (ctrl == NULL)
1125 return;
1126 switch (ctrl->type) {
Hans Verkuil6e239392011-06-07 11:13:44 -03001127 case V4L2_CTRL_TYPE_BUTTON:
1128 changed = true;
1129 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001130 case V4L2_CTRL_TYPE_STRING:
1131 /* strings are always 0-terminated */
Hans Verkuil6e239392011-06-07 11:13:44 -03001132 changed = strcmp(ctrl->string, ctrl->cur.string);
Hans Verkuil09965172010-08-01 14:32:42 -03001133 strcpy(ctrl->cur.string, ctrl->string);
1134 break;
1135 case V4L2_CTRL_TYPE_INTEGER64:
Hans Verkuil6e239392011-06-07 11:13:44 -03001136 changed = ctrl->val64 != ctrl->cur.val64;
Hans Verkuil09965172010-08-01 14:32:42 -03001137 ctrl->cur.val64 = ctrl->val64;
1138 break;
1139 default:
Hans Verkuil6e239392011-06-07 11:13:44 -03001140 changed = ctrl->val != ctrl->cur.val;
Hans Verkuil09965172010-08-01 14:32:42 -03001141 ctrl->cur.val = ctrl->val;
1142 break;
1143 }
Hans Verkuil72d877c2011-06-10 05:44:36 -03001144 if (update_inactive) {
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001145 /* Note: update_inactive can only be true for auto clusters. */
1146 ctrl->flags &=
1147 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1148 if (!is_cur_manual(ctrl->cluster[0])) {
Hans Verkuil72d877c2011-06-10 05:44:36 -03001149 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001150 if (ctrl->cluster[0]->has_volatiles)
1151 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1152 }
Hans de Goede1249a3a2011-10-31 11:16:44 -03001153 fh = NULL;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001154 }
Hans Verkuil639884a2011-07-05 07:09:26 -03001155 if (changed || update_inactive) {
1156 /* If a control was changed that was not one of the controls
1157 modified by the application, then send the event to all. */
1158 if (!ctrl->is_new)
1159 fh = NULL;
Hans Verkuil6e239392011-06-07 11:13:44 -03001160 send_event(fh, ctrl,
1161 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1162 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
Hans Verkuil639884a2011-07-05 07:09:26 -03001163 }
Hans Verkuil09965172010-08-01 14:32:42 -03001164}
1165
1166/* Copy the current value to the new value */
1167static void cur_to_new(struct v4l2_ctrl *ctrl)
1168{
1169 if (ctrl == NULL)
1170 return;
1171 switch (ctrl->type) {
1172 case V4L2_CTRL_TYPE_STRING:
1173 /* strings are always 0-terminated */
1174 strcpy(ctrl->string, ctrl->cur.string);
1175 break;
1176 case V4L2_CTRL_TYPE_INTEGER64:
1177 ctrl->val64 = ctrl->cur.val64;
1178 break;
1179 default:
1180 ctrl->val = ctrl->cur.val;
1181 break;
1182 }
1183}
1184
1185/* Return non-zero if one or more of the controls in the cluster has a new
1186 value that differs from the current value. */
1187static int cluster_changed(struct v4l2_ctrl *master)
1188{
1189 int diff = 0;
1190 int i;
1191
1192 for (i = 0; !diff && i < master->ncontrols; i++) {
1193 struct v4l2_ctrl *ctrl = master->cluster[i];
1194
1195 if (ctrl == NULL)
1196 continue;
1197 switch (ctrl->type) {
1198 case V4L2_CTRL_TYPE_BUTTON:
1199 /* Button controls are always 'different' */
1200 return 1;
1201 case V4L2_CTRL_TYPE_STRING:
1202 /* strings are always 0-terminated */
1203 diff = strcmp(ctrl->string, ctrl->cur.string);
1204 break;
1205 case V4L2_CTRL_TYPE_INTEGER64:
1206 diff = ctrl->val64 != ctrl->cur.val64;
1207 break;
1208 default:
1209 diff = ctrl->val != ctrl->cur.val;
1210 break;
1211 }
1212 }
1213 return diff;
1214}
1215
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001216/* Validate integer-type control */
1217static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
Hans Verkuil09965172010-08-01 14:32:42 -03001218{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001219 s32 val = *pval;
Hans Verkuil09965172010-08-01 14:32:42 -03001220 u32 offset;
Hans Verkuil09965172010-08-01 14:32:42 -03001221
1222 switch (ctrl->type) {
1223 case V4L2_CTRL_TYPE_INTEGER:
1224 /* Round towards the closest legal value */
1225 val += ctrl->step / 2;
1226 if (val < ctrl->minimum)
1227 val = ctrl->minimum;
1228 if (val > ctrl->maximum)
1229 val = ctrl->maximum;
1230 offset = val - ctrl->minimum;
1231 offset = ctrl->step * (offset / ctrl->step);
1232 val = ctrl->minimum + offset;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001233 *pval = val;
Hans Verkuil09965172010-08-01 14:32:42 -03001234 return 0;
1235
1236 case V4L2_CTRL_TYPE_BOOLEAN:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001237 *pval = !!val;
Hans Verkuil09965172010-08-01 14:32:42 -03001238 return 0;
1239
1240 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001241 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuil09965172010-08-01 14:32:42 -03001242 if (val < ctrl->minimum || val > ctrl->maximum)
1243 return -ERANGE;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001244 if (ctrl->menu_skip_mask & (1 << val))
1245 return -EINVAL;
1246 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1247 ctrl->qmenu[val][0] == '\0')
Hans Verkuil09965172010-08-01 14:32:42 -03001248 return -EINVAL;
1249 return 0;
1250
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001251 case V4L2_CTRL_TYPE_BITMASK:
1252 *pval &= ctrl->maximum;
1253 return 0;
1254
Hans Verkuil09965172010-08-01 14:32:42 -03001255 case V4L2_CTRL_TYPE_BUTTON:
1256 case V4L2_CTRL_TYPE_CTRL_CLASS:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001257 *pval = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001258 return 0;
1259
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001260 default:
1261 return -EINVAL;
1262 }
1263}
1264
1265/* Validate a new control */
1266static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1267{
1268 char *s = c->string;
1269 size_t len;
1270
1271 switch (ctrl->type) {
1272 case V4L2_CTRL_TYPE_INTEGER:
1273 case V4L2_CTRL_TYPE_BOOLEAN:
1274 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001275 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001276 case V4L2_CTRL_TYPE_BITMASK:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001277 case V4L2_CTRL_TYPE_BUTTON:
1278 case V4L2_CTRL_TYPE_CTRL_CLASS:
1279 return validate_new_int(ctrl, &c->value);
1280
Hans Verkuil09965172010-08-01 14:32:42 -03001281 case V4L2_CTRL_TYPE_INTEGER64:
1282 return 0;
1283
1284 case V4L2_CTRL_TYPE_STRING:
1285 len = strlen(s);
1286 if (len < ctrl->minimum)
1287 return -ERANGE;
1288 if ((len - ctrl->minimum) % ctrl->step)
1289 return -ERANGE;
1290 return 0;
1291
1292 default:
1293 return -EINVAL;
1294 }
1295}
1296
1297static inline u32 node2id(struct list_head *node)
1298{
1299 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1300}
1301
1302/* Set the handler's error code if it wasn't set earlier already */
1303static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1304{
1305 if (hdl->error == 0)
1306 hdl->error = err;
1307 return err;
1308}
1309
1310/* Initialize the handler */
1311int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1312 unsigned nr_of_controls_hint)
1313{
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001314 hdl->lock = &hdl->_lock;
1315 mutex_init(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001316 INIT_LIST_HEAD(&hdl->ctrls);
1317 INIT_LIST_HEAD(&hdl->ctrl_refs);
1318 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
Thomas Meyer9884d7b2011-11-29 17:08:00 -03001319 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1320 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03001321 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1322 return hdl->error;
1323}
1324EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1325
1326/* Free all controls and control refs */
1327void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1328{
1329 struct v4l2_ctrl_ref *ref, *next_ref;
1330 struct v4l2_ctrl *ctrl, *next_ctrl;
Hans Verkuil77068d32011-06-13 18:55:58 -03001331 struct v4l2_subscribed_event *sev, *next_sev;
Hans Verkuil09965172010-08-01 14:32:42 -03001332
1333 if (hdl == NULL || hdl->buckets == NULL)
1334 return;
1335
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001336 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001337 /* Free all nodes */
1338 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1339 list_del(&ref->node);
1340 kfree(ref);
1341 }
1342 /* Free all controls owned by the handler */
1343 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1344 list_del(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001345 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1346 list_del(&sev->node);
Hans Verkuil09965172010-08-01 14:32:42 -03001347 kfree(ctrl);
1348 }
1349 kfree(hdl->buckets);
1350 hdl->buckets = NULL;
1351 hdl->cached = NULL;
1352 hdl->error = 0;
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001353 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001354}
1355EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1356
1357/* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1358 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1359 with applications that do not use the NEXT_CTRL flag.
1360
1361 We just find the n-th private user control. It's O(N), but that should not
1362 be an issue in this particular case. */
1363static struct v4l2_ctrl_ref *find_private_ref(
1364 struct v4l2_ctrl_handler *hdl, u32 id)
1365{
1366 struct v4l2_ctrl_ref *ref;
1367
1368 id -= V4L2_CID_PRIVATE_BASE;
1369 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1370 /* Search for private user controls that are compatible with
1371 VIDIOC_G/S_CTRL. */
1372 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1373 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1374 if (!type_is_int(ref->ctrl))
1375 continue;
1376 if (id == 0)
1377 return ref;
1378 id--;
1379 }
1380 }
1381 return NULL;
1382}
1383
1384/* Find a control with the given ID. */
1385static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1386{
1387 struct v4l2_ctrl_ref *ref;
1388 int bucket;
1389
1390 id &= V4L2_CTRL_ID_MASK;
1391
1392 /* Old-style private controls need special handling */
1393 if (id >= V4L2_CID_PRIVATE_BASE)
1394 return find_private_ref(hdl, id);
1395 bucket = id % hdl->nr_of_buckets;
1396
1397 /* Simple optimization: cache the last control found */
1398 if (hdl->cached && hdl->cached->ctrl->id == id)
1399 return hdl->cached;
1400
1401 /* Not in cache, search the hash */
1402 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1403 while (ref && ref->ctrl->id != id)
1404 ref = ref->next;
1405
1406 if (ref)
1407 hdl->cached = ref; /* cache it! */
1408 return ref;
1409}
1410
1411/* Find a control with the given ID. Take the handler's lock first. */
1412static struct v4l2_ctrl_ref *find_ref_lock(
1413 struct v4l2_ctrl_handler *hdl, u32 id)
1414{
1415 struct v4l2_ctrl_ref *ref = NULL;
1416
1417 if (hdl) {
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001418 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001419 ref = find_ref(hdl, id);
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001420 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001421 }
1422 return ref;
1423}
1424
1425/* Find a control with the given ID. */
1426struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1427{
1428 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1429
1430 return ref ? ref->ctrl : NULL;
1431}
1432EXPORT_SYMBOL(v4l2_ctrl_find);
1433
1434/* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1435static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1436 struct v4l2_ctrl *ctrl)
1437{
1438 struct v4l2_ctrl_ref *ref;
1439 struct v4l2_ctrl_ref *new_ref;
1440 u32 id = ctrl->id;
1441 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1442 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1443
1444 /* Automatically add the control class if it is not yet present. */
1445 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1446 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1447 return hdl->error;
1448
1449 if (hdl->error)
1450 return hdl->error;
1451
1452 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1453 if (!new_ref)
1454 return handler_set_err(hdl, -ENOMEM);
1455 new_ref->ctrl = ctrl;
1456 if (ctrl->handler == hdl) {
1457 /* By default each control starts in a cluster of its own.
1458 new_ref->ctrl is basically a cluster array with one
1459 element, so that's perfect to use as the cluster pointer.
1460 But only do this for the handler that owns the control. */
1461 ctrl->cluster = &new_ref->ctrl;
1462 ctrl->ncontrols = 1;
1463 }
1464
1465 INIT_LIST_HEAD(&new_ref->node);
1466
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001467 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001468
1469 /* Add immediately at the end of the list if the list is empty, or if
1470 the last element in the list has a lower ID.
1471 This ensures that when elements are added in ascending order the
1472 insertion is an O(1) operation. */
1473 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1474 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1475 goto insert_in_hash;
1476 }
1477
1478 /* Find insert position in sorted list */
1479 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1480 if (ref->ctrl->id < id)
1481 continue;
1482 /* Don't add duplicates */
1483 if (ref->ctrl->id == id) {
1484 kfree(new_ref);
1485 goto unlock;
1486 }
1487 list_add(&new_ref->node, ref->node.prev);
1488 break;
1489 }
1490
1491insert_in_hash:
1492 /* Insert the control node in the hash */
1493 new_ref->next = hdl->buckets[bucket];
1494 hdl->buckets[bucket] = new_ref;
1495
1496unlock:
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001497 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001498 return 0;
1499}
1500
1501/* Add a new control */
1502static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1503 const struct v4l2_ctrl_ops *ops,
1504 u32 id, const char *name, enum v4l2_ctrl_type type,
1505 s32 min, s32 max, u32 step, s32 def,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001506 u32 flags, const char * const *qmenu,
1507 const s64 *qmenu_int, void *priv)
Hans Verkuil09965172010-08-01 14:32:42 -03001508{
1509 struct v4l2_ctrl *ctrl;
1510 unsigned sz_extra = 0;
1511
1512 if (hdl->error)
1513 return NULL;
1514
1515 /* Sanity checks */
1516 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
Hans Verkuil09965172010-08-01 14:32:42 -03001517 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001518 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001519 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001520 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001521 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1522 handler_set_err(hdl, -ERANGE);
1523 return NULL;
1524 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001525 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1526 handler_set_err(hdl, -ERANGE);
1527 return NULL;
1528 }
Hans Verkuil02ac0482010-12-29 14:27:05 -03001529 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1530 type == V4L2_CTRL_TYPE_MENU ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001531 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
Hans Verkuil02ac0482010-12-29 14:27:05 -03001532 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1533 (def < min || def > max)) {
1534 handler_set_err(hdl, -ERANGE);
1535 return NULL;
1536 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001537 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1538 handler_set_err(hdl, -ERANGE);
1539 return NULL;
1540 }
Hans Verkuil09965172010-08-01 14:32:42 -03001541
1542 if (type == V4L2_CTRL_TYPE_BUTTON)
1543 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1544 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1545 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1546 else if (type == V4L2_CTRL_TYPE_STRING)
1547 sz_extra += 2 * (max + 1);
1548
1549 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1550 if (ctrl == NULL) {
1551 handler_set_err(hdl, -ENOMEM);
1552 return NULL;
1553 }
1554
1555 INIT_LIST_HEAD(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001556 INIT_LIST_HEAD(&ctrl->ev_subs);
Hans Verkuil09965172010-08-01 14:32:42 -03001557 ctrl->handler = hdl;
1558 ctrl->ops = ops;
1559 ctrl->id = id;
1560 ctrl->name = name;
1561 ctrl->type = type;
1562 ctrl->flags = flags;
1563 ctrl->minimum = min;
1564 ctrl->maximum = max;
1565 ctrl->step = step;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001566 if (type == V4L2_CTRL_TYPE_MENU)
1567 ctrl->qmenu = qmenu;
1568 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1569 ctrl->qmenu_int = qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001570 ctrl->priv = priv;
1571 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1572
1573 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1574 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1575 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1576 if (ctrl->minimum)
1577 memset(ctrl->cur.string, ' ', ctrl->minimum);
1578 }
1579 if (handler_new_ref(hdl, ctrl)) {
1580 kfree(ctrl);
1581 return NULL;
1582 }
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001583 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001584 list_add_tail(&ctrl->node, &hdl->ctrls);
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001585 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001586 return ctrl;
1587}
1588
1589struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1590 const struct v4l2_ctrl_config *cfg, void *priv)
1591{
1592 bool is_menu;
1593 struct v4l2_ctrl *ctrl;
1594 const char *name = cfg->name;
Hans Verkuil513521e2010-12-29 14:25:52 -03001595 const char * const *qmenu = cfg->qmenu;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001596 const s64 *qmenu_int = cfg->qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001597 enum v4l2_ctrl_type type = cfg->type;
1598 u32 flags = cfg->flags;
1599 s32 min = cfg->min;
1600 s32 max = cfg->max;
1601 u32 step = cfg->step;
1602 s32 def = cfg->def;
1603
1604 if (name == NULL)
1605 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1606 &def, &flags);
1607
Sakari Ailusce580fe2011-08-04 13:51:11 -03001608 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1609 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
Hans Verkuil09965172010-08-01 14:32:42 -03001610 if (is_menu)
1611 WARN_ON(step);
1612 else
1613 WARN_ON(cfg->menu_skip_mask);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001614 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001615 qmenu = v4l2_ctrl_get_menu(cfg->id);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001616 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1617 qmenu_int == NULL) {
1618 handler_set_err(hdl, -EINVAL);
1619 return NULL;
1620 }
Hans Verkuil09965172010-08-01 14:32:42 -03001621
1622 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1623 type, min, max,
1624 is_menu ? cfg->menu_skip_mask : step,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001625 def, flags, qmenu, qmenu_int, priv);
Hans Verkuil88365102011-08-26 07:35:14 -03001626 if (ctrl)
Hans Verkuil09965172010-08-01 14:32:42 -03001627 ctrl->is_private = cfg->is_private;
Hans Verkuil09965172010-08-01 14:32:42 -03001628 return ctrl;
1629}
1630EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1631
1632/* Helper function for standard non-menu controls */
1633struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1634 const struct v4l2_ctrl_ops *ops,
1635 u32 id, s32 min, s32 max, u32 step, s32 def)
1636{
1637 const char *name;
1638 enum v4l2_ctrl_type type;
1639 u32 flags;
1640
1641 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001642 if (type == V4L2_CTRL_TYPE_MENU
1643 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
Hans Verkuil09965172010-08-01 14:32:42 -03001644 handler_set_err(hdl, -EINVAL);
1645 return NULL;
1646 }
1647 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001648 min, max, step, def, flags, NULL, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001649}
1650EXPORT_SYMBOL(v4l2_ctrl_new_std);
1651
1652/* Helper function for standard menu controls */
1653struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1654 const struct v4l2_ctrl_ops *ops,
1655 u32 id, s32 max, s32 mask, s32 def)
1656{
Hans Verkuil513521e2010-12-29 14:25:52 -03001657 const char * const *qmenu = v4l2_ctrl_get_menu(id);
Hans Verkuil09965172010-08-01 14:32:42 -03001658 const char *name;
1659 enum v4l2_ctrl_type type;
1660 s32 min;
1661 s32 step;
1662 u32 flags;
1663
1664 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1665 if (type != V4L2_CTRL_TYPE_MENU) {
1666 handler_set_err(hdl, -EINVAL);
1667 return NULL;
1668 }
1669 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001670 0, max, mask, def, flags, qmenu, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001671}
1672EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1673
Sylwester Nawrocki515f3282012-05-06 15:30:44 -03001674/* Helper function for standard integer menu controls */
1675struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
1676 const struct v4l2_ctrl_ops *ops,
1677 u32 id, s32 max, s32 def, const s64 *qmenu_int)
1678{
1679 const char *name;
1680 enum v4l2_ctrl_type type;
1681 s32 min;
1682 s32 step;
1683 u32 flags;
1684
1685 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1686 if (type != V4L2_CTRL_TYPE_INTEGER_MENU) {
1687 handler_set_err(hdl, -EINVAL);
1688 return NULL;
1689 }
1690 return v4l2_ctrl_new(hdl, ops, id, name, type,
1691 0, max, 0, def, flags, NULL, qmenu_int, NULL);
1692}
1693EXPORT_SYMBOL(v4l2_ctrl_new_int_menu);
1694
Hans Verkuil09965172010-08-01 14:32:42 -03001695/* Add a control from another handler to this handler */
1696struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1697 struct v4l2_ctrl *ctrl)
1698{
1699 if (hdl == NULL || hdl->error)
1700 return NULL;
1701 if (ctrl == NULL) {
1702 handler_set_err(hdl, -EINVAL);
1703 return NULL;
1704 }
1705 if (ctrl->handler == hdl)
1706 return ctrl;
1707 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1708}
1709EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1710
1711/* Add the controls from another handler to our own. */
1712int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1713 struct v4l2_ctrl_handler *add)
1714{
Hans Verkuil072e6602012-03-02 12:41:25 -03001715 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001716 int ret = 0;
1717
1718 /* Do nothing if either handler is NULL or if they are the same */
1719 if (!hdl || !add || hdl == add)
1720 return 0;
1721 if (hdl->error)
1722 return hdl->error;
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001723 mutex_lock(add->lock);
Hans Verkuil072e6602012-03-02 12:41:25 -03001724 list_for_each_entry(ref, &add->ctrl_refs, node) {
1725 struct v4l2_ctrl *ctrl = ref->ctrl;
1726
Hans Verkuil09965172010-08-01 14:32:42 -03001727 /* Skip handler-private controls. */
1728 if (ctrl->is_private)
1729 continue;
Hans Verkuil6e239392011-06-07 11:13:44 -03001730 /* And control classes */
1731 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1732 continue;
Hans Verkuil09965172010-08-01 14:32:42 -03001733 ret = handler_new_ref(hdl, ctrl);
1734 if (ret)
1735 break;
1736 }
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001737 mutex_unlock(add->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001738 return ret;
1739}
1740EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1741
1742/* Cluster controls */
1743void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1744{
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001745 bool has_volatiles = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001746 int i;
1747
1748 /* The first control is the master control and it must not be NULL */
Hans Verkuil72d877c2011-06-10 05:44:36 -03001749 BUG_ON(ncontrols == 0 || controls[0] == NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001750
1751 for (i = 0; i < ncontrols; i++) {
1752 if (controls[i]) {
1753 controls[i]->cluster = controls;
1754 controls[i]->ncontrols = ncontrols;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001755 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1756 has_volatiles = true;
Hans Verkuil09965172010-08-01 14:32:42 -03001757 }
1758 }
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001759 controls[0]->has_volatiles = has_volatiles;
Hans Verkuil09965172010-08-01 14:32:42 -03001760}
1761EXPORT_SYMBOL(v4l2_ctrl_cluster);
1762
Hans Verkuil72d877c2011-06-10 05:44:36 -03001763void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1764 u8 manual_val, bool set_volatile)
1765{
1766 struct v4l2_ctrl *master = controls[0];
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001767 u32 flag = 0;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001768 int i;
1769
1770 v4l2_ctrl_cluster(ncontrols, controls);
1771 WARN_ON(ncontrols <= 1);
Hans Verkuil82a7c042011-06-28 10:43:13 -03001772 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001773 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
Hans Verkuil72d877c2011-06-10 05:44:36 -03001774 master->is_auto = true;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001775 master->has_volatiles = set_volatile;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001776 master->manual_mode_value = manual_val;
1777 master->flags |= V4L2_CTRL_FLAG_UPDATE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001778
1779 if (!is_cur_manual(master))
1780 flag = V4L2_CTRL_FLAG_INACTIVE |
1781 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03001782
1783 for (i = 1; i < ncontrols; i++)
Hans Verkuil88365102011-08-26 07:35:14 -03001784 if (controls[i])
Hans Verkuil72d877c2011-06-10 05:44:36 -03001785 controls[i]->flags |= flag;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001786}
1787EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1788
Hans Verkuil09965172010-08-01 14:32:42 -03001789/* Activate/deactivate a control. */
1790void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1791{
Hans Verkuil6e239392011-06-07 11:13:44 -03001792 /* invert since the actual flag is called 'inactive' */
1793 bool inactive = !active;
1794 bool old;
1795
Hans Verkuil09965172010-08-01 14:32:42 -03001796 if (ctrl == NULL)
1797 return;
1798
Hans Verkuil6e239392011-06-07 11:13:44 -03001799 if (inactive)
Hans Verkuil09965172010-08-01 14:32:42 -03001800 /* set V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001801 old = test_and_set_bit(4, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001802 else
1803 /* clear V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001804 old = test_and_clear_bit(4, &ctrl->flags);
1805 if (old != inactive)
1806 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
Hans Verkuil09965172010-08-01 14:32:42 -03001807}
1808EXPORT_SYMBOL(v4l2_ctrl_activate);
1809
1810/* Grab/ungrab a control.
1811 Typically used when streaming starts and you want to grab controls,
1812 preventing the user from changing them.
1813
1814 Just call this and the framework will block any attempts to change
1815 these controls. */
1816void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1817{
Hans Verkuil6e239392011-06-07 11:13:44 -03001818 bool old;
1819
Hans Verkuil09965172010-08-01 14:32:42 -03001820 if (ctrl == NULL)
1821 return;
1822
Hans Verkuil6e239392011-06-07 11:13:44 -03001823 v4l2_ctrl_lock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001824 if (grabbed)
1825 /* set V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001826 old = test_and_set_bit(1, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001827 else
1828 /* clear V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001829 old = test_and_clear_bit(1, &ctrl->flags);
1830 if (old != grabbed)
1831 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1832 v4l2_ctrl_unlock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001833}
1834EXPORT_SYMBOL(v4l2_ctrl_grab);
1835
1836/* Log the control name and value */
1837static void log_ctrl(const struct v4l2_ctrl *ctrl,
1838 const char *prefix, const char *colon)
1839{
Hans Verkuil09965172010-08-01 14:32:42 -03001840 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1841 return;
1842 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1843 return;
1844
1845 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1846
1847 switch (ctrl->type) {
1848 case V4L2_CTRL_TYPE_INTEGER:
1849 printk(KERN_CONT "%d", ctrl->cur.val);
1850 break;
1851 case V4L2_CTRL_TYPE_BOOLEAN:
1852 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1853 break;
1854 case V4L2_CTRL_TYPE_MENU:
1855 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1856 break;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001857 case V4L2_CTRL_TYPE_INTEGER_MENU:
1858 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1859 break;
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001860 case V4L2_CTRL_TYPE_BITMASK:
1861 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1862 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001863 case V4L2_CTRL_TYPE_INTEGER64:
1864 printk(KERN_CONT "%lld", ctrl->cur.val64);
1865 break;
1866 case V4L2_CTRL_TYPE_STRING:
1867 printk(KERN_CONT "%s", ctrl->cur.string);
1868 break;
1869 default:
1870 printk(KERN_CONT "unknown type %d", ctrl->type);
1871 break;
1872 }
Hans Verkuil88365102011-08-26 07:35:14 -03001873 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1874 V4L2_CTRL_FLAG_GRABBED |
1875 V4L2_CTRL_FLAG_VOLATILE)) {
1876 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1877 printk(KERN_CONT " inactive");
1878 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1879 printk(KERN_CONT " grabbed");
1880 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1881 printk(KERN_CONT " volatile");
1882 }
1883 printk(KERN_CONT "\n");
Hans Verkuil09965172010-08-01 14:32:42 -03001884}
1885
1886/* Log all controls owned by the handler */
1887void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1888 const char *prefix)
1889{
1890 struct v4l2_ctrl *ctrl;
1891 const char *colon = "";
1892 int len;
1893
1894 if (hdl == NULL)
1895 return;
1896 if (prefix == NULL)
1897 prefix = "";
1898 len = strlen(prefix);
1899 if (len && prefix[len - 1] != ' ')
1900 colon = ": ";
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001901 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001902 list_for_each_entry(ctrl, &hdl->ctrls, node)
1903 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1904 log_ctrl(ctrl, prefix, colon);
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001905 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001906}
1907EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1908
1909/* Call s_ctrl for all controls owned by the handler */
1910int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1911{
1912 struct v4l2_ctrl *ctrl;
1913 int ret = 0;
1914
1915 if (hdl == NULL)
1916 return 0;
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001917 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001918 list_for_each_entry(ctrl, &hdl->ctrls, node)
1919 ctrl->done = false;
1920
1921 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1922 struct v4l2_ctrl *master = ctrl->cluster[0];
1923 int i;
1924
1925 /* Skip if this control was already handled by a cluster. */
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001926 /* Skip button controls and read-only controls. */
1927 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1928 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
Hans Verkuil09965172010-08-01 14:32:42 -03001929 continue;
1930
Hans Verkuil2a863792011-01-11 14:45:03 -03001931 for (i = 0; i < master->ncontrols; i++) {
1932 if (master->cluster[i]) {
1933 cur_to_new(master->cluster[i]);
1934 master->cluster[i]->is_new = 1;
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001935 master->cluster[i]->done = true;
Hans Verkuil2a863792011-01-11 14:45:03 -03001936 }
1937 }
Hans Verkuil54c911e2011-05-25 06:04:58 -03001938 ret = call_op(master, s_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001939 if (ret)
1940 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001941 }
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001942 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001943 return ret;
1944}
1945EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1946
1947/* Implement VIDIOC_QUERYCTRL */
1948int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1949{
1950 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1951 struct v4l2_ctrl_ref *ref;
1952 struct v4l2_ctrl *ctrl;
1953
1954 if (hdl == NULL)
1955 return -EINVAL;
1956
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001957 mutex_lock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001958
1959 /* Try to find it */
1960 ref = find_ref(hdl, id);
1961
1962 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1963 /* Find the next control with ID > qc->id */
1964
1965 /* Did we reach the end of the control list? */
1966 if (id >= node2id(hdl->ctrl_refs.prev)) {
1967 ref = NULL; /* Yes, so there is no next control */
1968 } else if (ref) {
1969 /* We found a control with the given ID, so just get
1970 the next one in the list. */
1971 ref = list_entry(ref->node.next, typeof(*ref), node);
1972 } else {
1973 /* No control with the given ID exists, so start
1974 searching for the next largest ID. We know there
1975 is one, otherwise the first 'if' above would have
1976 been true. */
1977 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1978 if (id < ref->ctrl->id)
1979 break;
1980 }
1981 }
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03001982 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03001983 if (!ref)
1984 return -EINVAL;
1985
1986 ctrl = ref->ctrl;
1987 memset(qc, 0, sizeof(*qc));
Hans Verkuil829fb2d2011-01-16 11:21:40 -03001988 if (id >= V4L2_CID_PRIVATE_BASE)
1989 qc->id = id;
1990 else
1991 qc->id = ctrl->id;
Hans Verkuil09965172010-08-01 14:32:42 -03001992 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1993 qc->minimum = ctrl->minimum;
1994 qc->maximum = ctrl->maximum;
1995 qc->default_value = ctrl->default_value;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001996 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1997 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil09965172010-08-01 14:32:42 -03001998 qc->step = 1;
1999 else
2000 qc->step = ctrl->step;
2001 qc->flags = ctrl->flags;
2002 qc->type = ctrl->type;
2003 return 0;
2004}
2005EXPORT_SYMBOL(v4l2_queryctrl);
2006
2007int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
2008{
Hans Verkuil87a0c942011-02-22 12:31:07 -03002009 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
2010 return -EINVAL;
Hans Verkuil09965172010-08-01 14:32:42 -03002011 return v4l2_queryctrl(sd->ctrl_handler, qc);
2012}
2013EXPORT_SYMBOL(v4l2_subdev_queryctrl);
2014
2015/* Implement VIDIOC_QUERYMENU */
2016int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
2017{
2018 struct v4l2_ctrl *ctrl;
2019 u32 i = qm->index;
2020
2021 ctrl = v4l2_ctrl_find(hdl, qm->id);
2022 if (!ctrl)
2023 return -EINVAL;
2024
2025 qm->reserved = 0;
2026 /* Sanity checks */
Sakari Ailusce580fe2011-08-04 13:51:11 -03002027 switch (ctrl->type) {
2028 case V4L2_CTRL_TYPE_MENU:
2029 if (ctrl->qmenu == NULL)
2030 return -EINVAL;
2031 break;
2032 case V4L2_CTRL_TYPE_INTEGER_MENU:
2033 if (ctrl->qmenu_int == NULL)
2034 return -EINVAL;
2035 break;
2036 default:
Hans Verkuil09965172010-08-01 14:32:42 -03002037 return -EINVAL;
Sakari Ailusce580fe2011-08-04 13:51:11 -03002038 }
2039
2040 if (i < ctrl->minimum || i > ctrl->maximum)
2041 return -EINVAL;
2042
Hans Verkuil09965172010-08-01 14:32:42 -03002043 /* Use mask to see if this menu item should be skipped */
2044 if (ctrl->menu_skip_mask & (1 << i))
2045 return -EINVAL;
2046 /* Empty menu items should also be skipped */
Sakari Ailusce580fe2011-08-04 13:51:11 -03002047 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
2048 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
2049 return -EINVAL;
2050 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
2051 } else {
2052 qm->value = ctrl->qmenu_int[i];
2053 }
Hans Verkuil09965172010-08-01 14:32:42 -03002054 return 0;
2055}
2056EXPORT_SYMBOL(v4l2_querymenu);
2057
2058int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
2059{
2060 return v4l2_querymenu(sd->ctrl_handler, qm);
2061}
2062EXPORT_SYMBOL(v4l2_subdev_querymenu);
2063
2064
2065
2066/* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
2067
2068 It is not a fully atomic operation, just best-effort only. After all, if
2069 multiple controls have to be set through multiple i2c writes (for example)
2070 then some initial writes may succeed while others fail. Thus leaving the
2071 system in an inconsistent state. The question is how much effort you are
2072 willing to spend on trying to make something atomic that really isn't.
2073
2074 From the point of view of an application the main requirement is that
2075 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
2076 error should be returned without actually affecting any controls.
2077
2078 If all the values are correct, then it is acceptable to just give up
2079 in case of low-level errors.
2080
2081 It is important though that the application can tell when only a partial
2082 configuration was done. The way we do that is through the error_idx field
2083 of struct v4l2_ext_controls: if that is equal to the count field then no
2084 controls were affected. Otherwise all controls before that index were
2085 successful in performing their 'get' or 'set' operation, the control at
2086 the given index failed, and you don't know what happened with the controls
2087 after the failed one. Since if they were part of a control cluster they
2088 could have been successfully processed (if a cluster member was encountered
2089 at index < error_idx), they could have failed (if a cluster member was at
2090 error_idx), or they may not have been processed yet (if the first cluster
2091 member appeared after error_idx).
2092
2093 It is all fairly theoretical, though. In practice all you can do is to
2094 bail out. If error_idx == count, then it is an application bug. If
2095 error_idx < count then it is only an application bug if the error code was
2096 EBUSY. That usually means that something started streaming just when you
2097 tried to set the controls. In all other cases it is a driver/hardware
2098 problem and all you can do is to retry or bail out.
2099
2100 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
2101 never modifies controls the error_idx is just set to whatever control
2102 has an invalid value.
2103 */
2104
2105/* Prepare for the extended g/s/try functions.
2106 Find the controls in the control array and do some basic checks. */
2107static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
2108 struct v4l2_ext_controls *cs,
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002109 struct v4l2_ctrl_helper *helpers)
Hans Verkuil09965172010-08-01 14:32:42 -03002110{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002111 struct v4l2_ctrl_helper *h;
2112 bool have_clusters = false;
Hans Verkuil09965172010-08-01 14:32:42 -03002113 u32 i;
2114
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002115 for (i = 0, h = helpers; i < cs->count; i++, h++) {
Hans Verkuil09965172010-08-01 14:32:42 -03002116 struct v4l2_ext_control *c = &cs->controls[i];
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002117 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03002118 struct v4l2_ctrl *ctrl;
2119 u32 id = c->id & V4L2_CTRL_ID_MASK;
2120
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002121 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002122
2123 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
2124 return -EINVAL;
2125
2126 /* Old-style private controls are not allowed for
2127 extended controls */
2128 if (id >= V4L2_CID_PRIVATE_BASE)
2129 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002130 ref = find_ref_lock(hdl, id);
2131 if (ref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002132 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002133 ctrl = ref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03002134 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
2135 return -EINVAL;
2136
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002137 if (ctrl->cluster[0]->ncontrols > 1)
2138 have_clusters = true;
2139 if (ctrl->cluster[0] != ctrl)
2140 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
2141 /* Store the ref to the master control of the cluster */
2142 h->mref = ref;
2143 h->ctrl = ctrl;
2144 /* Initially set next to 0, meaning that there is no other
2145 control in this helper array belonging to the same
2146 cluster */
2147 h->next = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002148 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002149
2150 /* We are done if there were no controls that belong to a multi-
2151 control cluster. */
2152 if (!have_clusters)
2153 return 0;
2154
2155 /* The code below figures out in O(n) time which controls in the list
2156 belong to the same cluster. */
2157
2158 /* This has to be done with the handler lock taken. */
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03002159 mutex_lock(hdl->lock);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002160
2161 /* First zero the helper field in the master control references */
2162 for (i = 0; i < cs->count; i++)
Sachin Kamatc0822662012-07-10 07:14:46 -03002163 helpers[i].mref->helper = NULL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002164 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2165 struct v4l2_ctrl_ref *mref = h->mref;
2166
2167 /* If the mref->helper is set, then it points to an earlier
2168 helper that belongs to the same cluster. */
2169 if (mref->helper) {
2170 /* Set the next field of mref->helper to the current
2171 index: this means that that earlier helper now
2172 points to the next helper in the same cluster. */
2173 mref->helper->next = i;
2174 /* mref should be set only for the first helper in the
2175 cluster, clear the others. */
2176 h->mref = NULL;
2177 }
2178 /* Point the mref helper to the current helper struct. */
2179 mref->helper = h;
2180 }
Sakari Ailus77e7c4e2012-01-24 21:05:34 -03002181 mutex_unlock(hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03002182 return 0;
2183}
2184
Hans Verkuil09965172010-08-01 14:32:42 -03002185/* Handles the corner case where cs->count == 0. It checks whether the
2186 specified control class exists. If that class ID is 0, then it checks
2187 whether there are any controls at all. */
2188static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2189{
2190 if (ctrl_class == 0)
2191 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2192 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2193}
2194
2195
2196
2197/* Get extended controls. Allocates the helpers array if needed. */
2198int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2199{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002200 struct v4l2_ctrl_helper helper[4];
2201 struct v4l2_ctrl_helper *helpers = helper;
Hans Verkuil09965172010-08-01 14:32:42 -03002202 int ret;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002203 int i, j;
Hans Verkuil09965172010-08-01 14:32:42 -03002204
2205 cs->error_idx = cs->count;
2206 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2207
2208 if (hdl == NULL)
2209 return -EINVAL;
2210
2211 if (cs->count == 0)
2212 return class_check(hdl, cs->ctrl_class);
2213
2214 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang5f0049b2012-04-06 09:32:36 -03002215 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2216 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03002217 if (helpers == NULL)
2218 return -ENOMEM;
2219 }
2220
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002221 ret = prepare_ext_ctrls(hdl, cs, helpers);
2222 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002223
2224 for (i = 0; !ret && i < cs->count; i++)
2225 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2226 ret = -EACCES;
2227
2228 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002229 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2230 struct v4l2_ctrl *ctrl) = cur_to_user;
2231 struct v4l2_ctrl *master;
Hans Verkuil09965172010-08-01 14:32:42 -03002232
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002233 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002234 continue;
2235
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002236 master = helpers[i].mref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03002237 cs->error_idx = i;
2238
2239 v4l2_ctrl_lock(master);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002240
2241 /* g_volatile_ctrl will update the new control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002242 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2243 (master->has_volatiles && !is_cur_manual(master))) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002244 for (j = 0; j < master->ncontrols; j++)
2245 cur_to_new(master->cluster[j]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002246 ret = call_op(master, g_volatile_ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002247 ctrl_to_user = new_to_user;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002248 }
2249 /* If OK, then copy the current (for non-volatile controls)
2250 or the new (for volatile controls) control values to the
2251 caller */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002252 if (!ret) {
2253 u32 idx = i;
2254
2255 do {
2256 ret = ctrl_to_user(cs->controls + idx,
2257 helpers[idx].ctrl);
2258 idx = helpers[idx].next;
2259 } while (!ret && idx);
2260 }
Hans Verkuil09965172010-08-01 14:32:42 -03002261 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002262 }
2263
2264 if (cs->count > ARRAY_SIZE(helper))
2265 kfree(helpers);
2266 return ret;
2267}
2268EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2269
2270int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2271{
2272 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2273}
2274EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2275
2276/* Helper function to get a single control */
2277static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2278{
2279 struct v4l2_ctrl *master = ctrl->cluster[0];
2280 int ret = 0;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002281 int i;
Hans Verkuil09965172010-08-01 14:32:42 -03002282
2283 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2284 return -EACCES;
2285
2286 v4l2_ctrl_lock(master);
2287 /* g_volatile_ctrl will update the current control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002288 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002289 for (i = 0; i < master->ncontrols; i++)
2290 cur_to_new(master->cluster[i]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002291 ret = call_op(master, g_volatile_ctrl);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002292 *val = ctrl->val;
2293 } else {
2294 *val = ctrl->cur.val;
2295 }
Hans Verkuil09965172010-08-01 14:32:42 -03002296 v4l2_ctrl_unlock(master);
2297 return ret;
2298}
2299
2300int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2301{
2302 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2303
2304 if (ctrl == NULL || !type_is_int(ctrl))
2305 return -EINVAL;
2306 return get_ctrl(ctrl, &control->value);
2307}
2308EXPORT_SYMBOL(v4l2_g_ctrl);
2309
2310int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2311{
2312 return v4l2_g_ctrl(sd->ctrl_handler, control);
2313}
2314EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2315
2316s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2317{
2318 s32 val = 0;
2319
2320 /* It's a driver bug if this happens. */
2321 WARN_ON(!type_is_int(ctrl));
2322 get_ctrl(ctrl, &val);
2323 return val;
2324}
2325EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2326
2327
2328/* Core function that calls try/s_ctrl and ensures that the new value is
2329 copied to the current value on a set.
2330 Must be called with ctrl->handler->lock held. */
Hans Verkuile6402582011-06-14 10:56:42 -03002331static int try_or_set_cluster(struct v4l2_fh *fh,
2332 struct v4l2_ctrl *master, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002333{
Hans Verkuil72d877c2011-06-10 05:44:36 -03002334 bool update_flag;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002335 int ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002336 int i;
2337
2338 /* Go through the cluster and either validate the new value or
2339 (if no new value was set), copy the current value to the new
2340 value, ensuring a consistent view for the control ops when
2341 called. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002342 for (i = 0; i < master->ncontrols; i++) {
Hans Verkuil09965172010-08-01 14:32:42 -03002343 struct v4l2_ctrl *ctrl = master->cluster[i];
2344
2345 if (ctrl == NULL)
2346 continue;
2347
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002348 if (!ctrl->is_new) {
2349 cur_to_new(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002350 continue;
2351 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002352 /* Check again: it may have changed since the
2353 previous check in try_or_set_ext_ctrls(). */
2354 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2355 return -EBUSY;
Hans Verkuil09965172010-08-01 14:32:42 -03002356 }
2357
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002358 ret = call_op(master, try_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002359
2360 /* Don't set if there is no change */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002361 if (ret || !set || !cluster_changed(master))
2362 return ret;
2363 ret = call_op(master, s_ctrl);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002364 if (ret)
2365 return ret;
2366
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002367 /* If OK, then make the new values permanent. */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002368 update_flag = is_cur_manual(master) != is_new_manual(master);
2369 for (i = 0; i < master->ncontrols; i++)
Hans Verkuilab892ba2011-06-07 06:47:18 -03002370 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002371 return 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002372}
2373
Hans Verkuile6402582011-06-14 10:56:42 -03002374/* Validate controls. */
2375static int validate_ctrls(struct v4l2_ext_controls *cs,
2376 struct v4l2_ctrl_helper *helpers, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002377{
Hans Verkuile6402582011-06-14 10:56:42 -03002378 unsigned i;
Hans Verkuil09965172010-08-01 14:32:42 -03002379 int ret = 0;
2380
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002381 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002382 for (i = 0; i < cs->count; i++) {
2383 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2384
Hans Verkuile6402582011-06-14 10:56:42 -03002385 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002386
2387 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2388 return -EACCES;
2389 /* This test is also done in try_set_control_cluster() which
2390 is called in atomic context, so that has the final say,
2391 but it makes sense to do an up-front check as well. Once
2392 an error occurs in try_set_control_cluster() some other
2393 controls may have been set already and we want to do a
2394 best-effort to avoid that. */
2395 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2396 return -EBUSY;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002397 ret = validate_new(ctrl, &cs->controls[i]);
2398 if (ret)
2399 return ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002400 }
Hans Verkuile6402582011-06-14 10:56:42 -03002401 return 0;
2402}
Hans Verkuil09965172010-08-01 14:32:42 -03002403
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002404/* Obtain the current volatile values of an autocluster and mark them
2405 as new. */
2406static void update_from_auto_cluster(struct v4l2_ctrl *master)
2407{
2408 int i;
2409
2410 for (i = 0; i < master->ncontrols; i++)
2411 cur_to_new(master->cluster[i]);
2412 if (!call_op(master, g_volatile_ctrl))
2413 for (i = 1; i < master->ncontrols; i++)
2414 if (master->cluster[i])
2415 master->cluster[i]->is_new = 1;
2416}
2417
Hans Verkuile6402582011-06-14 10:56:42 -03002418/* Try or try-and-set controls */
2419static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2420 struct v4l2_ext_controls *cs,
2421 bool set)
2422{
2423 struct v4l2_ctrl_helper helper[4];
2424 struct v4l2_ctrl_helper *helpers = helper;
2425 unsigned i, j;
2426 int ret;
2427
2428 cs->error_idx = cs->count;
2429 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2430
2431 if (hdl == NULL)
2432 return -EINVAL;
2433
2434 if (cs->count == 0)
2435 return class_check(hdl, cs->ctrl_class);
2436
2437 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang0a3475e2012-04-06 09:32:37 -03002438 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2439 GFP_KERNEL);
Hans Verkuile6402582011-06-14 10:56:42 -03002440 if (!helpers)
2441 return -ENOMEM;
2442 }
2443 ret = prepare_ext_ctrls(hdl, cs, helpers);
2444 if (!ret)
2445 ret = validate_ctrls(cs, helpers, set);
2446 if (ret && set)
2447 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002448 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002449 struct v4l2_ctrl *master;
2450 u32 idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002451
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002452 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002453 continue;
2454
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002455 cs->error_idx = i;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002456 master = helpers[i].mref->ctrl;
2457 v4l2_ctrl_lock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002458
Hans Verkuil2a863792011-01-11 14:45:03 -03002459 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002460 for (j = 0; j < master->ncontrols; j++)
2461 if (master->cluster[j])
Hans Verkuil2a863792011-01-11 14:45:03 -03002462 master->cluster[j]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002463
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002464 /* For volatile autoclusters that are currently in auto mode
2465 we need to discover if it will be set to manual mode.
2466 If so, then we have to copy the current volatile values
2467 first since those will become the new manual values (which
2468 may be overwritten by explicit new values from this set
2469 of controls). */
2470 if (master->is_auto && master->has_volatiles &&
2471 !is_cur_manual(master)) {
2472 /* Pick an initial non-manual value */
2473 s32 new_auto_val = master->manual_mode_value + 1;
2474 u32 tmp_idx = idx;
2475
2476 do {
2477 /* Check if the auto control is part of the
2478 list, and remember the new value. */
2479 if (helpers[tmp_idx].ctrl == master)
2480 new_auto_val = cs->controls[tmp_idx].value;
2481 tmp_idx = helpers[tmp_idx].next;
2482 } while (tmp_idx);
2483 /* If the new value == the manual value, then copy
2484 the current volatile values. */
2485 if (new_auto_val == master->manual_mode_value)
2486 update_from_auto_cluster(master);
2487 }
2488
Hans Verkuil09965172010-08-01 14:32:42 -03002489 /* Copy the new caller-supplied control values.
Hans Verkuil2a863792011-01-11 14:45:03 -03002490 user_to_new() sets 'is_new' to 1. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002491 do {
2492 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2493 idx = helpers[idx].next;
2494 } while (!ret && idx);
Hans Verkuil09965172010-08-01 14:32:42 -03002495
2496 if (!ret)
Hans Verkuile6402582011-06-14 10:56:42 -03002497 ret = try_or_set_cluster(fh, master, set);
Hans Verkuil09965172010-08-01 14:32:42 -03002498
2499 /* Copy the new values back to userspace. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002500 if (!ret) {
2501 idx = i;
2502 do {
Hans Verkuiladf41b92011-07-05 06:56:37 -03002503 ret = new_to_user(cs->controls + idx,
Hans Verkuile6402582011-06-14 10:56:42 -03002504 helpers[idx].ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002505 idx = helpers[idx].next;
2506 } while (!ret && idx);
2507 }
2508 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002509 }
Hans Verkuil09965172010-08-01 14:32:42 -03002510
Hans Verkuil09965172010-08-01 14:32:42 -03002511 if (cs->count > ARRAY_SIZE(helper))
2512 kfree(helpers);
2513 return ret;
2514}
2515
2516int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2517{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002518 return try_set_ext_ctrls(NULL, hdl, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002519}
2520EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2521
Hans Verkuilab892ba2011-06-07 06:47:18 -03002522int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2523 struct v4l2_ext_controls *cs)
Hans Verkuil09965172010-08-01 14:32:42 -03002524{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002525 return try_set_ext_ctrls(fh, hdl, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002526}
2527EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2528
2529int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2530{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002531 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002532}
2533EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2534
2535int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2536{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002537 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002538}
2539EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2540
2541/* Helper function for VIDIOC_S_CTRL compatibility */
Hans Verkuilab892ba2011-06-07 06:47:18 -03002542static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
Hans Verkuil09965172010-08-01 14:32:42 -03002543{
2544 struct v4l2_ctrl *master = ctrl->cluster[0];
2545 int ret;
2546 int i;
2547
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002548 ret = validate_new_int(ctrl, val);
2549 if (ret)
2550 return ret;
2551
Hans Verkuil09965172010-08-01 14:32:42 -03002552 v4l2_ctrl_lock(ctrl);
2553
Hans Verkuil2a863792011-01-11 14:45:03 -03002554 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002555 for (i = 0; i < master->ncontrols; i++)
2556 if (master->cluster[i])
Hans Verkuil2a863792011-01-11 14:45:03 -03002557 master->cluster[i]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002558
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002559 /* For autoclusters with volatiles that are switched from auto to
2560 manual mode we have to update the current volatile values since
2561 those will become the initial manual values after such a switch. */
2562 if (master->is_auto && master->has_volatiles && ctrl == master &&
2563 !is_cur_manual(master) && *val == master->manual_mode_value)
2564 update_from_auto_cluster(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002565 ctrl->val = *val;
Hans Verkuil2a863792011-01-11 14:45:03 -03002566 ctrl->is_new = 1;
Hans Verkuile6402582011-06-14 10:56:42 -03002567 ret = try_or_set_cluster(fh, master, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002568 *val = ctrl->cur.val;
2569 v4l2_ctrl_unlock(ctrl);
2570 return ret;
2571}
2572
Hans Verkuilab892ba2011-06-07 06:47:18 -03002573int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2574 struct v4l2_control *control)
Hans Verkuil09965172010-08-01 14:32:42 -03002575{
2576 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2577
2578 if (ctrl == NULL || !type_is_int(ctrl))
2579 return -EINVAL;
2580
Hans Verkuil7ebbc392011-06-07 04:50:31 -03002581 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2582 return -EACCES;
2583
Hans Verkuilab892ba2011-06-07 06:47:18 -03002584 return set_ctrl(fh, ctrl, &control->value);
Hans Verkuil09965172010-08-01 14:32:42 -03002585}
2586EXPORT_SYMBOL(v4l2_s_ctrl);
2587
2588int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2589{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002590 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
Hans Verkuil09965172010-08-01 14:32:42 -03002591}
2592EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2593
2594int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2595{
2596 /* It's a driver bug if this happens. */
2597 WARN_ON(!type_is_int(ctrl));
Hans Verkuilab892ba2011-06-07 06:47:18 -03002598 return set_ctrl(NULL, ctrl, &val);
Hans Verkuil09965172010-08-01 14:32:42 -03002599}
2600EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
Hans Verkuil6e239392011-06-07 11:13:44 -03002601
Hans Verkuil6e6d76c2012-05-07 16:53:20 -03002602static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev, unsigned elems)
Hans Verkuil6e239392011-06-07 11:13:44 -03002603{
Hans de Goede3e3661492012-04-08 12:59:47 -03002604 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2605
2606 if (ctrl == NULL)
2607 return -EINVAL;
2608
Hans Verkuil6e239392011-06-07 11:13:44 -03002609 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002610 list_add_tail(&sev->node, &ctrl->ev_subs);
Hans Verkuil6e239392011-06-07 11:13:44 -03002611 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
Hans Verkuil77068d32011-06-13 18:55:58 -03002612 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
Hans Verkuil6e239392011-06-07 11:13:44 -03002613 struct v4l2_event ev;
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002614 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
Hans Verkuil6e239392011-06-07 11:13:44 -03002615
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002616 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2617 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2618 fill_event(&ev, ctrl, changes);
Hans Verkuil6e6d76c2012-05-07 16:53:20 -03002619 /* Mark the queue as active, allowing this initial
2620 event to be accepted. */
2621 sev->elems = elems;
Hans Verkuil77068d32011-06-13 18:55:58 -03002622 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -03002623 }
2624 v4l2_ctrl_unlock(ctrl);
Hans de Goede3e3661492012-04-08 12:59:47 -03002625 return 0;
Hans Verkuil6e239392011-06-07 11:13:44 -03002626}
Hans Verkuil6e239392011-06-07 11:13:44 -03002627
Hans de Goede3e3661492012-04-08 12:59:47 -03002628static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002629{
Hans de Goede3e3661492012-04-08 12:59:47 -03002630 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2631
Hans Verkuil6e239392011-06-07 11:13:44 -03002632 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002633 list_del(&sev->node);
Hans Verkuil6e239392011-06-07 11:13:44 -03002634 v4l2_ctrl_unlock(ctrl);
2635}
Hans de Goede3e3661492012-04-08 12:59:47 -03002636
2637void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2638{
2639 u32 old_changes = old->u.ctrl.changes;
2640
2641 old->u.ctrl = new->u.ctrl;
2642 old->u.ctrl.changes |= old_changes;
2643}
2644EXPORT_SYMBOL(v4l2_ctrl_replace);
2645
2646void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2647{
2648 new->u.ctrl.changes |= old->u.ctrl.changes;
2649}
2650EXPORT_SYMBOL(v4l2_ctrl_merge);
2651
2652const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2653 .add = v4l2_ctrl_add_event,
2654 .del = v4l2_ctrl_del_event,
2655 .replace = v4l2_ctrl_replace,
2656 .merge = v4l2_ctrl_merge,
2657};
2658EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
Hans Verkuile2ecb252012-02-02 08:20:53 -03002659
2660int v4l2_ctrl_log_status(struct file *file, void *fh)
2661{
2662 struct video_device *vfd = video_devdata(file);
2663 struct v4l2_fh *vfh = file->private_data;
2664
2665 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2666 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2667 vfd->v4l2_dev->name);
2668 return 0;
2669}
2670EXPORT_SYMBOL(v4l2_ctrl_log_status);
Hans Verkuila26243b2012-01-27 16:18:42 -03002671
2672int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2673 struct v4l2_event_subscription *sub)
2674{
2675 if (sub->type == V4L2_EVENT_CTRL)
Hans de Goede3e3661492012-04-08 12:59:47 -03002676 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
Hans Verkuila26243b2012-01-27 16:18:42 -03002677 return -EINVAL;
2678}
2679EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2680
2681unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2682{
2683 struct v4l2_fh *fh = file->private_data;
2684
2685 if (v4l2_event_pending(fh))
2686 return POLLPRI;
2687 poll_wait(file, &fh->wait, wait);
2688 return 0;
2689}
2690EXPORT_SYMBOL(v4l2_ctrl_poll);