blob: edb2a6a066ca3ec6751d049d30c0abf6f13ad9ec [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 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300233 static const char * const colorfx[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300234 "None",
235 "Black & White",
236 "Sepia",
237 "Negative",
238 "Emboss",
239 "Sketch",
Kamil Debski064f5092011-06-14 10:46:22 -0300240 "Sky Blue",
241 "Grass Green",
242 "Skin Whiten",
Hans Verkuil09965172010-08-01 14:32:42 -0300243 "Vivid",
244 NULL
245 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300246 static const char * const tune_preemphasis[] = {
Kamil Debski064f5092011-06-14 10:46:22 -0300247 "No Preemphasis",
Hans Verkuilf769c262012-03-02 04:20:19 -0300248 "50 Microseconds",
249 "75 Microseconds",
Hans Verkuil09965172010-08-01 14:32:42 -0300250 NULL,
251 };
Kamil Debski064f5092011-06-14 10:46:22 -0300252 static const char * const header_mode[] = {
253 "Separate Buffer",
254 "Joined With 1st Frame",
255 NULL,
256 };
257 static const char * const multi_slice[] = {
258 "Single",
259 "Max Macroblocks",
260 "Max Bytes",
261 NULL,
262 };
263 static const char * const entropy_mode[] = {
264 "CAVLC",
265 "CABAC",
266 NULL,
267 };
268 static const char * const mpeg_h264_level[] = {
269 "1",
270 "1b",
271 "1.1",
272 "1.2",
273 "1.3",
274 "2",
275 "2.1",
276 "2.2",
277 "3",
278 "3.1",
279 "3.2",
280 "4",
281 "4.1",
282 "4.2",
283 "5",
284 "5.1",
285 NULL,
286 };
287 static const char * const h264_loop_filter[] = {
288 "Enabled",
289 "Disabled",
290 "Disabled at Slice Boundary",
291 NULL,
292 };
293 static const char * const h264_profile[] = {
294 "Baseline",
295 "Constrained Baseline",
296 "Main",
297 "Extended",
298 "High",
299 "High 10",
300 "High 422",
301 "High 444 Predictive",
302 "High 10 Intra",
303 "High 422 Intra",
304 "High 444 Intra",
305 "CAVLC 444 Intra",
306 "Scalable Baseline",
307 "Scalable High",
308 "Scalable High Intra",
309 "Multiview High",
310 NULL,
311 };
312 static const char * const vui_sar_idc[] = {
313 "Unspecified",
314 "1:1",
315 "12:11",
316 "10:11",
317 "16:11",
318 "40:33",
319 "24:11",
320 "20:11",
321 "32:11",
322 "80:33",
323 "18:11",
324 "15:11",
325 "64:33",
326 "160:99",
327 "4:3",
328 "3:2",
329 "2:1",
330 "Extended SAR",
331 NULL,
332 };
333 static const char * const mpeg_mpeg4_level[] = {
334 "0",
335 "0b",
336 "1",
337 "2",
338 "3",
339 "3b",
340 "4",
341 "5",
342 NULL,
343 };
344 static const char * const mpeg4_profile[] = {
345 "Simple",
Hans Verkuilf769c262012-03-02 04:20:19 -0300346 "Advanced Simple",
Kamil Debski064f5092011-06-14 10:46:22 -0300347 "Core",
348 "Simple Scalable",
349 "Advanced Coding Efficency",
350 NULL,
351 };
352
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300353 static const char * const flash_led_mode[] = {
354 "Off",
355 "Flash",
356 "Torch",
357 NULL,
358 };
359 static const char * const flash_strobe_source[] = {
360 "Software",
361 "External",
362 NULL,
363 };
Hans Verkuil09965172010-08-01 14:32:42 -0300364
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300365 static const char * const jpeg_chroma_subsampling[] = {
366 "4:4:4",
367 "4:2:2",
368 "4:2:0",
369 "4:1:1",
370 "4:1:0",
371 "Gray",
372 NULL,
373 };
374
Hans Verkuil09965172010-08-01 14:32:42 -0300375 switch (id) {
376 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
377 return mpeg_audio_sampling_freq;
378 case V4L2_CID_MPEG_AUDIO_ENCODING:
379 return mpeg_audio_encoding;
380 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
381 return mpeg_audio_l1_bitrate;
382 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
383 return mpeg_audio_l2_bitrate;
384 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
385 return mpeg_audio_l3_bitrate;
386 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
387 return mpeg_audio_ac3_bitrate;
388 case V4L2_CID_MPEG_AUDIO_MODE:
389 return mpeg_audio_mode;
390 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
391 return mpeg_audio_mode_extension;
392 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
393 return mpeg_audio_emphasis;
394 case V4L2_CID_MPEG_AUDIO_CRC:
395 return mpeg_audio_crc;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300396 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
397 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
398 return mpeg_audio_dec_playback;
Hans Verkuil09965172010-08-01 14:32:42 -0300399 case V4L2_CID_MPEG_VIDEO_ENCODING:
400 return mpeg_video_encoding;
401 case V4L2_CID_MPEG_VIDEO_ASPECT:
402 return mpeg_video_aspect;
403 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
404 return mpeg_video_bitrate_mode;
405 case V4L2_CID_MPEG_STREAM_TYPE:
406 return mpeg_stream_type;
407 case V4L2_CID_MPEG_STREAM_VBI_FMT:
408 return mpeg_stream_vbi_fmt;
409 case V4L2_CID_POWER_LINE_FREQUENCY:
410 return camera_power_line_frequency;
411 case V4L2_CID_EXPOSURE_AUTO:
412 return camera_exposure_auto;
413 case V4L2_CID_COLORFX:
414 return colorfx;
415 case V4L2_CID_TUNE_PREEMPHASIS:
416 return tune_preemphasis;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300417 case V4L2_CID_FLASH_LED_MODE:
418 return flash_led_mode;
419 case V4L2_CID_FLASH_STROBE_SOURCE:
420 return flash_strobe_source;
Kamil Debski064f5092011-06-14 10:46:22 -0300421 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
422 return header_mode;
423 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
424 return multi_slice;
425 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
426 return entropy_mode;
427 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
428 return mpeg_h264_level;
429 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
430 return h264_loop_filter;
431 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
432 return h264_profile;
433 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
434 return vui_sar_idc;
435 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
436 return mpeg_mpeg4_level;
437 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
438 return mpeg4_profile;
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300439 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
440 return jpeg_chroma_subsampling;
441
Hans Verkuil09965172010-08-01 14:32:42 -0300442 default:
443 return NULL;
444 }
445}
446EXPORT_SYMBOL(v4l2_ctrl_get_menu);
447
448/* Return the control name. */
449const char *v4l2_ctrl_get_name(u32 id)
450{
451 switch (id) {
452 /* USER controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300453 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300454 case V4L2_CID_USER_CLASS: return "User Controls";
455 case V4L2_CID_BRIGHTNESS: return "Brightness";
456 case V4L2_CID_CONTRAST: return "Contrast";
457 case V4L2_CID_SATURATION: return "Saturation";
458 case V4L2_CID_HUE: return "Hue";
459 case V4L2_CID_AUDIO_VOLUME: return "Volume";
460 case V4L2_CID_AUDIO_BALANCE: return "Balance";
461 case V4L2_CID_AUDIO_BASS: return "Bass";
462 case V4L2_CID_AUDIO_TREBLE: return "Treble";
463 case V4L2_CID_AUDIO_MUTE: return "Mute";
464 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
Hans Verkuil09965172010-08-01 14:32:42 -0300465 case V4L2_CID_BLACK_LEVEL: return "Black Level";
466 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
467 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
468 case V4L2_CID_RED_BALANCE: return "Red Balance";
469 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
470 case V4L2_CID_GAMMA: return "Gamma";
471 case V4L2_CID_EXPOSURE: return "Exposure";
472 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
473 case V4L2_CID_GAIN: return "Gain";
474 case V4L2_CID_HFLIP: return "Horizontal Flip";
475 case V4L2_CID_VFLIP: return "Vertical Flip";
476 case V4L2_CID_HCENTER: return "Horizontal Center";
477 case V4L2_CID_VCENTER: return "Vertical Center";
478 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
479 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
480 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
481 case V4L2_CID_SHARPNESS: return "Sharpness";
482 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
483 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
Hans Verkuil09965172010-08-01 14:32:42 -0300484 case V4L2_CID_COLOR_KILLER: return "Color Killer";
485 case V4L2_CID_COLORFX: return "Color Effects";
486 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
487 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
488 case V4L2_CID_ROTATE: return "Rotate";
489 case V4L2_CID_BG_COLOR: return "Background Color";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300490 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
Jean-François Moine008d35f2010-09-13 07:04:49 -0300491 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
492 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300493 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
494 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
Sylwester Nawrockicc1d3272011-11-14 08:48:18 -0300495 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
Hans Verkuil09965172010-08-01 14:32:42 -0300496
497 /* MPEG controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300498 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300499 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
500 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
501 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
502 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
503 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
504 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300505 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
506 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
507 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
Hans Verkuil09965172010-08-01 14:32:42 -0300508 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300509 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
510 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
511 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
512 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
513 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
Hans Verkuil09965172010-08-01 14:32:42 -0300514 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300515 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
516 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
517 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
518 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
519 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300520 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
521 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300522 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
523 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
524 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
525 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
526 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
527 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
528 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
529 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
530 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
Hans Verkuil09965172010-08-01 14:32:42 -0300531 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300532 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
Hans Verkuil09965172010-08-01 14:32:42 -0300533 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
Kamil Debski064f5092011-06-14 10:46:22 -0300534 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
535 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300536 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
Kamil Debski064f5092011-06-14 10:46:22 -0300537 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
538 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
539 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300540 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
Kamil Debski064f5092011-06-14 10:46:22 -0300541 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300542 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
543 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300544 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
545 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
546 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300547 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
548 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300549 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
550 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
551 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
552 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300553 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
554 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
Kamil Debski064f5092011-06-14 10:46:22 -0300555 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
556 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
557 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
558 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
559 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
560 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
561 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
562 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
563 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
564 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300565 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
566 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300567 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
568 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
569 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
570 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
571 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300572 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
573 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
574 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
Kamil Debski064f5092011-06-14 10:46:22 -0300575 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300576 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
577 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
Hans Verkuil09965172010-08-01 14:32:42 -0300578
579 /* CAMERA controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300580 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300581 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
582 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
583 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
584 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
585 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
586 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
587 case V4L2_CID_PAN_RESET: return "Pan, Reset";
588 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
589 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
590 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
591 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
592 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
593 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
Hans Verkuil09965172010-08-01 14:32:42 -0300594 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
595 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
596 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
597 case V4L2_CID_PRIVACY: return "Privacy";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300598 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
599 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
Hans Verkuil09965172010-08-01 14:32:42 -0300600
601 /* FM Radio Modulator control */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300602 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300603 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
604 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
605 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
606 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
607 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
608 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
609 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
610 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
611 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300612 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
Hans Verkuil09965172010-08-01 14:32:42 -0300613 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
614 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
615 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
616 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
617 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
618 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
619 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300620 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
Hans Verkuil09965172010-08-01 14:32:42 -0300621 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
622 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
623
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300624 /* Flash controls */
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300625 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
626 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
627 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300628 case V4L2_CID_FLASH_STROBE: return "Strobe";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300629 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
630 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
631 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
632 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
633 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
634 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300635 case V4L2_CID_FLASH_FAULT: return "Faults";
636 case V4L2_CID_FLASH_CHARGE: return "Charge";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300637 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300638
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300639 /* JPEG encoder controls */
640 /* Keep the order of the 'case's the same as in videodev2.h! */
641 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
642 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
643 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
644 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
645 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
646
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300647 /* Image source controls */
648 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
649 case V4L2_CID_VBLANK: return "Vertical Blanking";
650 case V4L2_CID_HBLANK: return "Horizontal Blanking";
651 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
652
Sakari Ailusc643ee12012-02-02 20:17:54 -0300653 /* Image processing controls */
654 case V4L2_CID_IMAGE_PROC_CLASS: return "Image Processing Controls";
655 case V4L2_CID_LINK_FREQ: return "Link Frequency";
656 case V4L2_CID_PIXEL_RATE: return "Pixel Rate";
657
Hans Verkuil09965172010-08-01 14:32:42 -0300658 default:
659 return NULL;
660 }
661}
662EXPORT_SYMBOL(v4l2_ctrl_get_name);
663
664void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
665 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
666{
667 *name = v4l2_ctrl_get_name(id);
668 *flags = 0;
669
670 switch (id) {
671 case V4L2_CID_AUDIO_MUTE:
672 case V4L2_CID_AUDIO_LOUDNESS:
673 case V4L2_CID_AUTO_WHITE_BALANCE:
674 case V4L2_CID_AUTOGAIN:
675 case V4L2_CID_HFLIP:
676 case V4L2_CID_VFLIP:
677 case V4L2_CID_HUE_AUTO:
678 case V4L2_CID_CHROMA_AGC:
679 case V4L2_CID_COLOR_KILLER:
680 case V4L2_CID_MPEG_AUDIO_MUTE:
681 case V4L2_CID_MPEG_VIDEO_MUTE:
682 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
683 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
684 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
685 case V4L2_CID_FOCUS_AUTO:
686 case V4L2_CID_PRIVACY:
687 case V4L2_CID_AUDIO_LIMITER_ENABLED:
688 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
689 case V4L2_CID_PILOT_TONE_ENABLED:
Jean-François Moine008d35f2010-09-13 07:04:49 -0300690 case V4L2_CID_ILLUMINATORS_1:
691 case V4L2_CID_ILLUMINATORS_2:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300692 case V4L2_CID_FLASH_STROBE_STATUS:
693 case V4L2_CID_FLASH_CHARGE:
694 case V4L2_CID_FLASH_READY:
Kamil Debski064f5092011-06-14 10:46:22 -0300695 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
696 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
697 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
698 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
699 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
700 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
701 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
Hans Verkuil09965172010-08-01 14:32:42 -0300702 *type = V4L2_CTRL_TYPE_BOOLEAN;
703 *min = 0;
704 *max = *step = 1;
705 break;
706 case V4L2_CID_PAN_RESET:
707 case V4L2_CID_TILT_RESET:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300708 case V4L2_CID_FLASH_STROBE:
709 case V4L2_CID_FLASH_STROBE_STOP:
Hans Verkuil09965172010-08-01 14:32:42 -0300710 *type = V4L2_CTRL_TYPE_BUTTON;
711 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
712 *min = *max = *step = *def = 0;
713 break;
714 case V4L2_CID_POWER_LINE_FREQUENCY:
715 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
716 case V4L2_CID_MPEG_AUDIO_ENCODING:
717 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
718 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
719 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
720 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
721 case V4L2_CID_MPEG_AUDIO_MODE:
722 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
723 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
724 case V4L2_CID_MPEG_AUDIO_CRC:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300725 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
726 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
Hans Verkuil09965172010-08-01 14:32:42 -0300727 case V4L2_CID_MPEG_VIDEO_ENCODING:
728 case V4L2_CID_MPEG_VIDEO_ASPECT:
729 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
730 case V4L2_CID_MPEG_STREAM_TYPE:
731 case V4L2_CID_MPEG_STREAM_VBI_FMT:
732 case V4L2_CID_EXPOSURE_AUTO:
733 case V4L2_CID_COLORFX:
734 case V4L2_CID_TUNE_PREEMPHASIS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300735 case V4L2_CID_FLASH_LED_MODE:
736 case V4L2_CID_FLASH_STROBE_SOURCE:
Kamil Debski064f5092011-06-14 10:46:22 -0300737 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
738 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
739 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
740 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
741 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
742 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
743 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
744 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
745 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300746 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
Hans Verkuil09965172010-08-01 14:32:42 -0300747 *type = V4L2_CTRL_TYPE_MENU;
748 break;
Sakari Ailusc643ee12012-02-02 20:17:54 -0300749 case V4L2_CID_LINK_FREQ:
750 *type = V4L2_CTRL_TYPE_INTEGER_MENU;
751 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300752 case V4L2_CID_RDS_TX_PS_NAME:
753 case V4L2_CID_RDS_TX_RADIO_TEXT:
754 *type = V4L2_CTRL_TYPE_STRING;
755 break;
756 case V4L2_CID_USER_CLASS:
757 case V4L2_CID_CAMERA_CLASS:
758 case V4L2_CID_MPEG_CLASS:
759 case V4L2_CID_FM_TX_CLASS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300760 case V4L2_CID_FLASH_CLASS:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300761 case V4L2_CID_JPEG_CLASS:
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300762 case V4L2_CID_IMAGE_SOURCE_CLASS:
Sakari Ailusc643ee12012-02-02 20:17:54 -0300763 case V4L2_CID_IMAGE_PROC_CLASS:
Hans Verkuil09965172010-08-01 14:32:42 -0300764 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
765 /* You can neither read not write these */
766 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
767 *min = *max = *step = *def = 0;
768 break;
769 case V4L2_CID_BG_COLOR:
770 *type = V4L2_CTRL_TYPE_INTEGER;
771 *step = 1;
772 *min = 0;
773 /* Max is calculated as RGB888 that is 2^24 */
774 *max = 0xFFFFFF;
775 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300776 case V4L2_CID_FLASH_FAULT:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300777 case V4L2_CID_JPEG_ACTIVE_MARKER:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300778 *type = V4L2_CTRL_TYPE_BITMASK;
779 break;
Kamil Debski064f5092011-06-14 10:46:22 -0300780 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
781 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
782 *type = V4L2_CTRL_TYPE_INTEGER;
783 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
784 break;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300785 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
786 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
Sakari Ailusc643ee12012-02-02 20:17:54 -0300787 *flags |= V4L2_CTRL_FLAG_VOLATILE;
788 /* Fall through */
789 case V4L2_CID_PIXEL_RATE:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300790 *type = V4L2_CTRL_TYPE_INTEGER64;
Sakari Ailusc643ee12012-02-02 20:17:54 -0300791 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
Hans Verkuilca576812012-04-19 12:37:18 -0300792 *min = *max = *step = *def = 0;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300793 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300794 default:
795 *type = V4L2_CTRL_TYPE_INTEGER;
796 break;
797 }
798 switch (id) {
799 case V4L2_CID_MPEG_AUDIO_ENCODING:
800 case V4L2_CID_MPEG_AUDIO_MODE:
801 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
802 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
803 case V4L2_CID_MPEG_STREAM_TYPE:
804 *flags |= V4L2_CTRL_FLAG_UPDATE;
805 break;
806 case V4L2_CID_AUDIO_VOLUME:
807 case V4L2_CID_AUDIO_BALANCE:
808 case V4L2_CID_AUDIO_BASS:
809 case V4L2_CID_AUDIO_TREBLE:
810 case V4L2_CID_BRIGHTNESS:
811 case V4L2_CID_CONTRAST:
812 case V4L2_CID_SATURATION:
813 case V4L2_CID_HUE:
814 case V4L2_CID_RED_BALANCE:
815 case V4L2_CID_BLUE_BALANCE:
816 case V4L2_CID_GAMMA:
817 case V4L2_CID_SHARPNESS:
818 case V4L2_CID_CHROMA_GAIN:
819 case V4L2_CID_RDS_TX_DEVIATION:
820 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
821 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
822 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
823 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
824 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
825 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
826 case V4L2_CID_PILOT_TONE_DEVIATION:
827 case V4L2_CID_PILOT_TONE_FREQUENCY:
828 case V4L2_CID_TUNE_POWER_LEVEL:
829 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
830 *flags |= V4L2_CTRL_FLAG_SLIDER;
831 break;
832 case V4L2_CID_PAN_RELATIVE:
833 case V4L2_CID_TILT_RELATIVE:
834 case V4L2_CID_FOCUS_RELATIVE:
835 case V4L2_CID_IRIS_RELATIVE:
836 case V4L2_CID_ZOOM_RELATIVE:
837 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
838 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300839 case V4L2_CID_FLASH_STROBE_STATUS:
840 case V4L2_CID_FLASH_READY:
841 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
842 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300843 }
844}
845EXPORT_SYMBOL(v4l2_ctrl_fill);
846
847/* Helper function to determine whether the control type is compatible with
848 VIDIOC_G/S_CTRL. */
849static bool type_is_int(const struct v4l2_ctrl *ctrl)
850{
851 switch (ctrl->type) {
852 case V4L2_CTRL_TYPE_INTEGER64:
853 case V4L2_CTRL_TYPE_STRING:
854 /* Nope, these need v4l2_ext_control */
855 return false;
856 default:
857 return true;
858 }
859}
860
Hans Verkuil6e239392011-06-07 11:13:44 -0300861static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
862{
863 memset(ev->reserved, 0, sizeof(ev->reserved));
864 ev->type = V4L2_EVENT_CTRL;
865 ev->id = ctrl->id;
866 ev->u.ctrl.changes = changes;
867 ev->u.ctrl.type = ctrl->type;
868 ev->u.ctrl.flags = ctrl->flags;
869 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
870 ev->u.ctrl.value64 = 0;
871 else
872 ev->u.ctrl.value64 = ctrl->cur.val64;
873 ev->u.ctrl.minimum = ctrl->minimum;
874 ev->u.ctrl.maximum = ctrl->maximum;
Sakari Ailusce580fe2011-08-04 13:51:11 -0300875 if (ctrl->type == V4L2_CTRL_TYPE_MENU
876 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil6e239392011-06-07 11:13:44 -0300877 ev->u.ctrl.step = 1;
878 else
879 ev->u.ctrl.step = ctrl->step;
880 ev->u.ctrl.default_value = ctrl->default_value;
881}
882
883static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
884{
885 struct v4l2_event ev;
Hans Verkuil77068d32011-06-13 18:55:58 -0300886 struct v4l2_subscribed_event *sev;
Hans Verkuil6e239392011-06-07 11:13:44 -0300887
Hans Verkuil77068d32011-06-13 18:55:58 -0300888 if (list_empty(&ctrl->ev_subs))
Hans Verkuil3f66f0e2011-06-20 11:56:24 -0300889 return;
Hans Verkuil6e239392011-06-07 11:13:44 -0300890 fill_event(&ev, ctrl, changes);
891
Hans Verkuil77068d32011-06-13 18:55:58 -0300892 list_for_each_entry(sev, &ctrl->ev_subs, node)
Hans de Goedee3e72f392011-10-26 05:52:47 -0300893 if (sev->fh != fh ||
894 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
Hans Verkuil77068d32011-06-13 18:55:58 -0300895 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -0300896}
897
Hans Verkuil09965172010-08-01 14:32:42 -0300898/* Helper function: copy the current control value back to the caller */
899static int cur_to_user(struct v4l2_ext_control *c,
900 struct v4l2_ctrl *ctrl)
901{
902 u32 len;
903
904 switch (ctrl->type) {
905 case V4L2_CTRL_TYPE_STRING:
906 len = strlen(ctrl->cur.string);
907 if (c->size < len + 1) {
908 c->size = len + 1;
909 return -ENOSPC;
910 }
911 return copy_to_user(c->string, ctrl->cur.string,
912 len + 1) ? -EFAULT : 0;
913 case V4L2_CTRL_TYPE_INTEGER64:
914 c->value64 = ctrl->cur.val64;
915 break;
916 default:
917 c->value = ctrl->cur.val;
918 break;
919 }
920 return 0;
921}
922
923/* Helper function: copy the caller-provider value as the new control value */
924static int user_to_new(struct v4l2_ext_control *c,
925 struct v4l2_ctrl *ctrl)
926{
927 int ret;
928 u32 size;
929
Hans Verkuil2a863792011-01-11 14:45:03 -0300930 ctrl->is_new = 1;
Hans Verkuil09965172010-08-01 14:32:42 -0300931 switch (ctrl->type) {
932 case V4L2_CTRL_TYPE_INTEGER64:
933 ctrl->val64 = c->value64;
934 break;
935 case V4L2_CTRL_TYPE_STRING:
936 size = c->size;
937 if (size == 0)
938 return -ERANGE;
939 if (size > ctrl->maximum + 1)
940 size = ctrl->maximum + 1;
941 ret = copy_from_user(ctrl->string, c->string, size);
942 if (!ret) {
943 char last = ctrl->string[size - 1];
944
945 ctrl->string[size - 1] = 0;
946 /* If the string was longer than ctrl->maximum,
947 then return an error. */
948 if (strlen(ctrl->string) == ctrl->maximum && last)
949 return -ERANGE;
950 }
951 return ret ? -EFAULT : 0;
952 default:
953 ctrl->val = c->value;
954 break;
955 }
956 return 0;
957}
958
959/* Helper function: copy the new control value back to the caller */
960static int new_to_user(struct v4l2_ext_control *c,
961 struct v4l2_ctrl *ctrl)
962{
963 u32 len;
964
965 switch (ctrl->type) {
966 case V4L2_CTRL_TYPE_STRING:
967 len = strlen(ctrl->string);
968 if (c->size < len + 1) {
969 c->size = ctrl->maximum + 1;
970 return -ENOSPC;
971 }
972 return copy_to_user(c->string, ctrl->string,
973 len + 1) ? -EFAULT : 0;
974 case V4L2_CTRL_TYPE_INTEGER64:
975 c->value64 = ctrl->val64;
976 break;
977 default:
978 c->value = ctrl->val;
979 break;
980 }
981 return 0;
982}
983
984/* Copy the new value to the current value. */
Hans Verkuilab892ba2011-06-07 06:47:18 -0300985static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
986 bool update_inactive)
Hans Verkuil09965172010-08-01 14:32:42 -0300987{
Hans Verkuil6e239392011-06-07 11:13:44 -0300988 bool changed = false;
989
Hans Verkuil09965172010-08-01 14:32:42 -0300990 if (ctrl == NULL)
991 return;
992 switch (ctrl->type) {
Hans Verkuil6e239392011-06-07 11:13:44 -0300993 case V4L2_CTRL_TYPE_BUTTON:
994 changed = true;
995 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300996 case V4L2_CTRL_TYPE_STRING:
997 /* strings are always 0-terminated */
Hans Verkuil6e239392011-06-07 11:13:44 -0300998 changed = strcmp(ctrl->string, ctrl->cur.string);
Hans Verkuil09965172010-08-01 14:32:42 -0300999 strcpy(ctrl->cur.string, ctrl->string);
1000 break;
1001 case V4L2_CTRL_TYPE_INTEGER64:
Hans Verkuil6e239392011-06-07 11:13:44 -03001002 changed = ctrl->val64 != ctrl->cur.val64;
Hans Verkuil09965172010-08-01 14:32:42 -03001003 ctrl->cur.val64 = ctrl->val64;
1004 break;
1005 default:
Hans Verkuil6e239392011-06-07 11:13:44 -03001006 changed = ctrl->val != ctrl->cur.val;
Hans Verkuil09965172010-08-01 14:32:42 -03001007 ctrl->cur.val = ctrl->val;
1008 break;
1009 }
Hans Verkuil72d877c2011-06-10 05:44:36 -03001010 if (update_inactive) {
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001011 /* Note: update_inactive can only be true for auto clusters. */
1012 ctrl->flags &=
1013 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1014 if (!is_cur_manual(ctrl->cluster[0])) {
Hans Verkuil72d877c2011-06-10 05:44:36 -03001015 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001016 if (ctrl->cluster[0]->has_volatiles)
1017 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1018 }
Hans de Goede1249a3a2011-10-31 11:16:44 -03001019 fh = NULL;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001020 }
Hans Verkuil639884a2011-07-05 07:09:26 -03001021 if (changed || update_inactive) {
1022 /* If a control was changed that was not one of the controls
1023 modified by the application, then send the event to all. */
1024 if (!ctrl->is_new)
1025 fh = NULL;
Hans Verkuil6e239392011-06-07 11:13:44 -03001026 send_event(fh, ctrl,
1027 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1028 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
Hans Verkuil639884a2011-07-05 07:09:26 -03001029 }
Hans Verkuil09965172010-08-01 14:32:42 -03001030}
1031
1032/* Copy the current value to the new value */
1033static void cur_to_new(struct v4l2_ctrl *ctrl)
1034{
1035 if (ctrl == NULL)
1036 return;
1037 switch (ctrl->type) {
1038 case V4L2_CTRL_TYPE_STRING:
1039 /* strings are always 0-terminated */
1040 strcpy(ctrl->string, ctrl->cur.string);
1041 break;
1042 case V4L2_CTRL_TYPE_INTEGER64:
1043 ctrl->val64 = ctrl->cur.val64;
1044 break;
1045 default:
1046 ctrl->val = ctrl->cur.val;
1047 break;
1048 }
1049}
1050
1051/* Return non-zero if one or more of the controls in the cluster has a new
1052 value that differs from the current value. */
1053static int cluster_changed(struct v4l2_ctrl *master)
1054{
1055 int diff = 0;
1056 int i;
1057
1058 for (i = 0; !diff && i < master->ncontrols; i++) {
1059 struct v4l2_ctrl *ctrl = master->cluster[i];
1060
1061 if (ctrl == NULL)
1062 continue;
1063 switch (ctrl->type) {
1064 case V4L2_CTRL_TYPE_BUTTON:
1065 /* Button controls are always 'different' */
1066 return 1;
1067 case V4L2_CTRL_TYPE_STRING:
1068 /* strings are always 0-terminated */
1069 diff = strcmp(ctrl->string, ctrl->cur.string);
1070 break;
1071 case V4L2_CTRL_TYPE_INTEGER64:
1072 diff = ctrl->val64 != ctrl->cur.val64;
1073 break;
1074 default:
1075 diff = ctrl->val != ctrl->cur.val;
1076 break;
1077 }
1078 }
1079 return diff;
1080}
1081
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001082/* Validate integer-type control */
1083static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
Hans Verkuil09965172010-08-01 14:32:42 -03001084{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001085 s32 val = *pval;
Hans Verkuil09965172010-08-01 14:32:42 -03001086 u32 offset;
Hans Verkuil09965172010-08-01 14:32:42 -03001087
1088 switch (ctrl->type) {
1089 case V4L2_CTRL_TYPE_INTEGER:
1090 /* Round towards the closest legal value */
1091 val += ctrl->step / 2;
1092 if (val < ctrl->minimum)
1093 val = ctrl->minimum;
1094 if (val > ctrl->maximum)
1095 val = ctrl->maximum;
1096 offset = val - ctrl->minimum;
1097 offset = ctrl->step * (offset / ctrl->step);
1098 val = ctrl->minimum + offset;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001099 *pval = val;
Hans Verkuil09965172010-08-01 14:32:42 -03001100 return 0;
1101
1102 case V4L2_CTRL_TYPE_BOOLEAN:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001103 *pval = !!val;
Hans Verkuil09965172010-08-01 14:32:42 -03001104 return 0;
1105
1106 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001107 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuil09965172010-08-01 14:32:42 -03001108 if (val < ctrl->minimum || val > ctrl->maximum)
1109 return -ERANGE;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001110 if (ctrl->menu_skip_mask & (1 << val))
1111 return -EINVAL;
1112 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1113 ctrl->qmenu[val][0] == '\0')
Hans Verkuil09965172010-08-01 14:32:42 -03001114 return -EINVAL;
1115 return 0;
1116
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001117 case V4L2_CTRL_TYPE_BITMASK:
1118 *pval &= ctrl->maximum;
1119 return 0;
1120
Hans Verkuil09965172010-08-01 14:32:42 -03001121 case V4L2_CTRL_TYPE_BUTTON:
1122 case V4L2_CTRL_TYPE_CTRL_CLASS:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001123 *pval = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001124 return 0;
1125
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001126 default:
1127 return -EINVAL;
1128 }
1129}
1130
1131/* Validate a new control */
1132static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1133{
1134 char *s = c->string;
1135 size_t len;
1136
1137 switch (ctrl->type) {
1138 case V4L2_CTRL_TYPE_INTEGER:
1139 case V4L2_CTRL_TYPE_BOOLEAN:
1140 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001141 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001142 case V4L2_CTRL_TYPE_BITMASK:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001143 case V4L2_CTRL_TYPE_BUTTON:
1144 case V4L2_CTRL_TYPE_CTRL_CLASS:
1145 return validate_new_int(ctrl, &c->value);
1146
Hans Verkuil09965172010-08-01 14:32:42 -03001147 case V4L2_CTRL_TYPE_INTEGER64:
1148 return 0;
1149
1150 case V4L2_CTRL_TYPE_STRING:
1151 len = strlen(s);
1152 if (len < ctrl->minimum)
1153 return -ERANGE;
1154 if ((len - ctrl->minimum) % ctrl->step)
1155 return -ERANGE;
1156 return 0;
1157
1158 default:
1159 return -EINVAL;
1160 }
1161}
1162
1163static inline u32 node2id(struct list_head *node)
1164{
1165 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1166}
1167
1168/* Set the handler's error code if it wasn't set earlier already */
1169static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1170{
1171 if (hdl->error == 0)
1172 hdl->error = err;
1173 return err;
1174}
1175
1176/* Initialize the handler */
1177int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1178 unsigned nr_of_controls_hint)
1179{
1180 mutex_init(&hdl->lock);
1181 INIT_LIST_HEAD(&hdl->ctrls);
1182 INIT_LIST_HEAD(&hdl->ctrl_refs);
1183 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
Thomas Meyer9884d7b2011-11-29 17:08:00 -03001184 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1185 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03001186 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1187 return hdl->error;
1188}
1189EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1190
1191/* Free all controls and control refs */
1192void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1193{
1194 struct v4l2_ctrl_ref *ref, *next_ref;
1195 struct v4l2_ctrl *ctrl, *next_ctrl;
Hans Verkuil77068d32011-06-13 18:55:58 -03001196 struct v4l2_subscribed_event *sev, *next_sev;
Hans Verkuil09965172010-08-01 14:32:42 -03001197
1198 if (hdl == NULL || hdl->buckets == NULL)
1199 return;
1200
1201 mutex_lock(&hdl->lock);
1202 /* Free all nodes */
1203 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1204 list_del(&ref->node);
1205 kfree(ref);
1206 }
1207 /* Free all controls owned by the handler */
1208 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1209 list_del(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001210 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1211 list_del(&sev->node);
Hans Verkuil09965172010-08-01 14:32:42 -03001212 kfree(ctrl);
1213 }
1214 kfree(hdl->buckets);
1215 hdl->buckets = NULL;
1216 hdl->cached = NULL;
1217 hdl->error = 0;
1218 mutex_unlock(&hdl->lock);
1219}
1220EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1221
1222/* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1223 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1224 with applications that do not use the NEXT_CTRL flag.
1225
1226 We just find the n-th private user control. It's O(N), but that should not
1227 be an issue in this particular case. */
1228static struct v4l2_ctrl_ref *find_private_ref(
1229 struct v4l2_ctrl_handler *hdl, u32 id)
1230{
1231 struct v4l2_ctrl_ref *ref;
1232
1233 id -= V4L2_CID_PRIVATE_BASE;
1234 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1235 /* Search for private user controls that are compatible with
1236 VIDIOC_G/S_CTRL. */
1237 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1238 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1239 if (!type_is_int(ref->ctrl))
1240 continue;
1241 if (id == 0)
1242 return ref;
1243 id--;
1244 }
1245 }
1246 return NULL;
1247}
1248
1249/* Find a control with the given ID. */
1250static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1251{
1252 struct v4l2_ctrl_ref *ref;
1253 int bucket;
1254
1255 id &= V4L2_CTRL_ID_MASK;
1256
1257 /* Old-style private controls need special handling */
1258 if (id >= V4L2_CID_PRIVATE_BASE)
1259 return find_private_ref(hdl, id);
1260 bucket = id % hdl->nr_of_buckets;
1261
1262 /* Simple optimization: cache the last control found */
1263 if (hdl->cached && hdl->cached->ctrl->id == id)
1264 return hdl->cached;
1265
1266 /* Not in cache, search the hash */
1267 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1268 while (ref && ref->ctrl->id != id)
1269 ref = ref->next;
1270
1271 if (ref)
1272 hdl->cached = ref; /* cache it! */
1273 return ref;
1274}
1275
1276/* Find a control with the given ID. Take the handler's lock first. */
1277static struct v4l2_ctrl_ref *find_ref_lock(
1278 struct v4l2_ctrl_handler *hdl, u32 id)
1279{
1280 struct v4l2_ctrl_ref *ref = NULL;
1281
1282 if (hdl) {
1283 mutex_lock(&hdl->lock);
1284 ref = find_ref(hdl, id);
1285 mutex_unlock(&hdl->lock);
1286 }
1287 return ref;
1288}
1289
1290/* Find a control with the given ID. */
1291struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1292{
1293 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1294
1295 return ref ? ref->ctrl : NULL;
1296}
1297EXPORT_SYMBOL(v4l2_ctrl_find);
1298
1299/* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1300static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1301 struct v4l2_ctrl *ctrl)
1302{
1303 struct v4l2_ctrl_ref *ref;
1304 struct v4l2_ctrl_ref *new_ref;
1305 u32 id = ctrl->id;
1306 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1307 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1308
1309 /* Automatically add the control class if it is not yet present. */
1310 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1311 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1312 return hdl->error;
1313
1314 if (hdl->error)
1315 return hdl->error;
1316
1317 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1318 if (!new_ref)
1319 return handler_set_err(hdl, -ENOMEM);
1320 new_ref->ctrl = ctrl;
1321 if (ctrl->handler == hdl) {
1322 /* By default each control starts in a cluster of its own.
1323 new_ref->ctrl is basically a cluster array with one
1324 element, so that's perfect to use as the cluster pointer.
1325 But only do this for the handler that owns the control. */
1326 ctrl->cluster = &new_ref->ctrl;
1327 ctrl->ncontrols = 1;
1328 }
1329
1330 INIT_LIST_HEAD(&new_ref->node);
1331
1332 mutex_lock(&hdl->lock);
1333
1334 /* Add immediately at the end of the list if the list is empty, or if
1335 the last element in the list has a lower ID.
1336 This ensures that when elements are added in ascending order the
1337 insertion is an O(1) operation. */
1338 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1339 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1340 goto insert_in_hash;
1341 }
1342
1343 /* Find insert position in sorted list */
1344 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1345 if (ref->ctrl->id < id)
1346 continue;
1347 /* Don't add duplicates */
1348 if (ref->ctrl->id == id) {
1349 kfree(new_ref);
1350 goto unlock;
1351 }
1352 list_add(&new_ref->node, ref->node.prev);
1353 break;
1354 }
1355
1356insert_in_hash:
1357 /* Insert the control node in the hash */
1358 new_ref->next = hdl->buckets[bucket];
1359 hdl->buckets[bucket] = new_ref;
1360
1361unlock:
1362 mutex_unlock(&hdl->lock);
1363 return 0;
1364}
1365
1366/* Add a new control */
1367static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1368 const struct v4l2_ctrl_ops *ops,
1369 u32 id, const char *name, enum v4l2_ctrl_type type,
1370 s32 min, s32 max, u32 step, s32 def,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001371 u32 flags, const char * const *qmenu,
1372 const s64 *qmenu_int, void *priv)
Hans Verkuil09965172010-08-01 14:32:42 -03001373{
1374 struct v4l2_ctrl *ctrl;
1375 unsigned sz_extra = 0;
1376
1377 if (hdl->error)
1378 return NULL;
1379
1380 /* Sanity checks */
1381 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
Hans Verkuil09965172010-08-01 14:32:42 -03001382 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001383 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001384 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001385 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001386 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1387 handler_set_err(hdl, -ERANGE);
1388 return NULL;
1389 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001390 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1391 handler_set_err(hdl, -ERANGE);
1392 return NULL;
1393 }
Hans Verkuil02ac0482010-12-29 14:27:05 -03001394 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1395 type == V4L2_CTRL_TYPE_MENU ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001396 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
Hans Verkuil02ac0482010-12-29 14:27:05 -03001397 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1398 (def < min || def > max)) {
1399 handler_set_err(hdl, -ERANGE);
1400 return NULL;
1401 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001402 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1403 handler_set_err(hdl, -ERANGE);
1404 return NULL;
1405 }
Hans Verkuil09965172010-08-01 14:32:42 -03001406
1407 if (type == V4L2_CTRL_TYPE_BUTTON)
1408 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1409 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1410 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1411 else if (type == V4L2_CTRL_TYPE_STRING)
1412 sz_extra += 2 * (max + 1);
1413
1414 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1415 if (ctrl == NULL) {
1416 handler_set_err(hdl, -ENOMEM);
1417 return NULL;
1418 }
1419
1420 INIT_LIST_HEAD(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001421 INIT_LIST_HEAD(&ctrl->ev_subs);
Hans Verkuil09965172010-08-01 14:32:42 -03001422 ctrl->handler = hdl;
1423 ctrl->ops = ops;
1424 ctrl->id = id;
1425 ctrl->name = name;
1426 ctrl->type = type;
1427 ctrl->flags = flags;
1428 ctrl->minimum = min;
1429 ctrl->maximum = max;
1430 ctrl->step = step;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001431 if (type == V4L2_CTRL_TYPE_MENU)
1432 ctrl->qmenu = qmenu;
1433 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1434 ctrl->qmenu_int = qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001435 ctrl->priv = priv;
1436 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1437
1438 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1439 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1440 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1441 if (ctrl->minimum)
1442 memset(ctrl->cur.string, ' ', ctrl->minimum);
1443 }
1444 if (handler_new_ref(hdl, ctrl)) {
1445 kfree(ctrl);
1446 return NULL;
1447 }
1448 mutex_lock(&hdl->lock);
1449 list_add_tail(&ctrl->node, &hdl->ctrls);
1450 mutex_unlock(&hdl->lock);
1451 return ctrl;
1452}
1453
1454struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1455 const struct v4l2_ctrl_config *cfg, void *priv)
1456{
1457 bool is_menu;
1458 struct v4l2_ctrl *ctrl;
1459 const char *name = cfg->name;
Hans Verkuil513521e2010-12-29 14:25:52 -03001460 const char * const *qmenu = cfg->qmenu;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001461 const s64 *qmenu_int = cfg->qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001462 enum v4l2_ctrl_type type = cfg->type;
1463 u32 flags = cfg->flags;
1464 s32 min = cfg->min;
1465 s32 max = cfg->max;
1466 u32 step = cfg->step;
1467 s32 def = cfg->def;
1468
1469 if (name == NULL)
1470 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1471 &def, &flags);
1472
Sakari Ailusce580fe2011-08-04 13:51:11 -03001473 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1474 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
Hans Verkuil09965172010-08-01 14:32:42 -03001475 if (is_menu)
1476 WARN_ON(step);
1477 else
1478 WARN_ON(cfg->menu_skip_mask);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001479 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001480 qmenu = v4l2_ctrl_get_menu(cfg->id);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001481 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1482 qmenu_int == NULL) {
1483 handler_set_err(hdl, -EINVAL);
1484 return NULL;
1485 }
Hans Verkuil09965172010-08-01 14:32:42 -03001486
1487 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1488 type, min, max,
1489 is_menu ? cfg->menu_skip_mask : step,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001490 def, flags, qmenu, qmenu_int, priv);
Hans Verkuil88365102011-08-26 07:35:14 -03001491 if (ctrl)
Hans Verkuil09965172010-08-01 14:32:42 -03001492 ctrl->is_private = cfg->is_private;
Hans Verkuil09965172010-08-01 14:32:42 -03001493 return ctrl;
1494}
1495EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1496
1497/* Helper function for standard non-menu controls */
1498struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1499 const struct v4l2_ctrl_ops *ops,
1500 u32 id, s32 min, s32 max, u32 step, s32 def)
1501{
1502 const char *name;
1503 enum v4l2_ctrl_type type;
1504 u32 flags;
1505
1506 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001507 if (type == V4L2_CTRL_TYPE_MENU
1508 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
Hans Verkuil09965172010-08-01 14:32:42 -03001509 handler_set_err(hdl, -EINVAL);
1510 return NULL;
1511 }
1512 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001513 min, max, step, def, flags, NULL, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001514}
1515EXPORT_SYMBOL(v4l2_ctrl_new_std);
1516
1517/* Helper function for standard menu controls */
1518struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1519 const struct v4l2_ctrl_ops *ops,
1520 u32 id, s32 max, s32 mask, s32 def)
1521{
Hans Verkuil513521e2010-12-29 14:25:52 -03001522 const char * const *qmenu = v4l2_ctrl_get_menu(id);
Hans Verkuil09965172010-08-01 14:32:42 -03001523 const char *name;
1524 enum v4l2_ctrl_type type;
1525 s32 min;
1526 s32 step;
1527 u32 flags;
1528
1529 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1530 if (type != V4L2_CTRL_TYPE_MENU) {
1531 handler_set_err(hdl, -EINVAL);
1532 return NULL;
1533 }
1534 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001535 0, max, mask, def, flags, qmenu, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001536}
1537EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1538
1539/* Add a control from another handler to this handler */
1540struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1541 struct v4l2_ctrl *ctrl)
1542{
1543 if (hdl == NULL || hdl->error)
1544 return NULL;
1545 if (ctrl == NULL) {
1546 handler_set_err(hdl, -EINVAL);
1547 return NULL;
1548 }
1549 if (ctrl->handler == hdl)
1550 return ctrl;
1551 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1552}
1553EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1554
1555/* Add the controls from another handler to our own. */
1556int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1557 struct v4l2_ctrl_handler *add)
1558{
Hans Verkuil072e6602012-03-02 12:41:25 -03001559 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001560 int ret = 0;
1561
1562 /* Do nothing if either handler is NULL or if they are the same */
1563 if (!hdl || !add || hdl == add)
1564 return 0;
1565 if (hdl->error)
1566 return hdl->error;
1567 mutex_lock(&add->lock);
Hans Verkuil072e6602012-03-02 12:41:25 -03001568 list_for_each_entry(ref, &add->ctrl_refs, node) {
1569 struct v4l2_ctrl *ctrl = ref->ctrl;
1570
Hans Verkuil09965172010-08-01 14:32:42 -03001571 /* Skip handler-private controls. */
1572 if (ctrl->is_private)
1573 continue;
Hans Verkuil6e239392011-06-07 11:13:44 -03001574 /* And control classes */
1575 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1576 continue;
Hans Verkuil09965172010-08-01 14:32:42 -03001577 ret = handler_new_ref(hdl, ctrl);
1578 if (ret)
1579 break;
1580 }
1581 mutex_unlock(&add->lock);
1582 return ret;
1583}
1584EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1585
1586/* Cluster controls */
1587void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1588{
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001589 bool has_volatiles = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001590 int i;
1591
1592 /* The first control is the master control and it must not be NULL */
Hans Verkuil72d877c2011-06-10 05:44:36 -03001593 BUG_ON(ncontrols == 0 || controls[0] == NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001594
1595 for (i = 0; i < ncontrols; i++) {
1596 if (controls[i]) {
1597 controls[i]->cluster = controls;
1598 controls[i]->ncontrols = ncontrols;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001599 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1600 has_volatiles = true;
Hans Verkuil09965172010-08-01 14:32:42 -03001601 }
1602 }
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001603 controls[0]->has_volatiles = has_volatiles;
Hans Verkuil09965172010-08-01 14:32:42 -03001604}
1605EXPORT_SYMBOL(v4l2_ctrl_cluster);
1606
Hans Verkuil72d877c2011-06-10 05:44:36 -03001607void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1608 u8 manual_val, bool set_volatile)
1609{
1610 struct v4l2_ctrl *master = controls[0];
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001611 u32 flag = 0;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001612 int i;
1613
1614 v4l2_ctrl_cluster(ncontrols, controls);
1615 WARN_ON(ncontrols <= 1);
Hans Verkuil82a7c042011-06-28 10:43:13 -03001616 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001617 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
Hans Verkuil72d877c2011-06-10 05:44:36 -03001618 master->is_auto = true;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001619 master->has_volatiles = set_volatile;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001620 master->manual_mode_value = manual_val;
1621 master->flags |= V4L2_CTRL_FLAG_UPDATE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001622
1623 if (!is_cur_manual(master))
1624 flag = V4L2_CTRL_FLAG_INACTIVE |
1625 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03001626
1627 for (i = 1; i < ncontrols; i++)
Hans Verkuil88365102011-08-26 07:35:14 -03001628 if (controls[i])
Hans Verkuil72d877c2011-06-10 05:44:36 -03001629 controls[i]->flags |= flag;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001630}
1631EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1632
Hans Verkuil09965172010-08-01 14:32:42 -03001633/* Activate/deactivate a control. */
1634void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1635{
Hans Verkuil6e239392011-06-07 11:13:44 -03001636 /* invert since the actual flag is called 'inactive' */
1637 bool inactive = !active;
1638 bool old;
1639
Hans Verkuil09965172010-08-01 14:32:42 -03001640 if (ctrl == NULL)
1641 return;
1642
Hans Verkuil6e239392011-06-07 11:13:44 -03001643 if (inactive)
Hans Verkuil09965172010-08-01 14:32:42 -03001644 /* set V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001645 old = test_and_set_bit(4, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001646 else
1647 /* clear V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001648 old = test_and_clear_bit(4, &ctrl->flags);
1649 if (old != inactive)
1650 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
Hans Verkuil09965172010-08-01 14:32:42 -03001651}
1652EXPORT_SYMBOL(v4l2_ctrl_activate);
1653
1654/* Grab/ungrab a control.
1655 Typically used when streaming starts and you want to grab controls,
1656 preventing the user from changing them.
1657
1658 Just call this and the framework will block any attempts to change
1659 these controls. */
1660void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1661{
Hans Verkuil6e239392011-06-07 11:13:44 -03001662 bool old;
1663
Hans Verkuil09965172010-08-01 14:32:42 -03001664 if (ctrl == NULL)
1665 return;
1666
Hans Verkuil6e239392011-06-07 11:13:44 -03001667 v4l2_ctrl_lock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001668 if (grabbed)
1669 /* set V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001670 old = test_and_set_bit(1, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001671 else
1672 /* clear V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001673 old = test_and_clear_bit(1, &ctrl->flags);
1674 if (old != grabbed)
1675 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1676 v4l2_ctrl_unlock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001677}
1678EXPORT_SYMBOL(v4l2_ctrl_grab);
1679
1680/* Log the control name and value */
1681static void log_ctrl(const struct v4l2_ctrl *ctrl,
1682 const char *prefix, const char *colon)
1683{
Hans Verkuil09965172010-08-01 14:32:42 -03001684 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1685 return;
1686 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1687 return;
1688
1689 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1690
1691 switch (ctrl->type) {
1692 case V4L2_CTRL_TYPE_INTEGER:
1693 printk(KERN_CONT "%d", ctrl->cur.val);
1694 break;
1695 case V4L2_CTRL_TYPE_BOOLEAN:
1696 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1697 break;
1698 case V4L2_CTRL_TYPE_MENU:
1699 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1700 break;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001701 case V4L2_CTRL_TYPE_INTEGER_MENU:
1702 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1703 break;
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001704 case V4L2_CTRL_TYPE_BITMASK:
1705 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1706 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001707 case V4L2_CTRL_TYPE_INTEGER64:
1708 printk(KERN_CONT "%lld", ctrl->cur.val64);
1709 break;
1710 case V4L2_CTRL_TYPE_STRING:
1711 printk(KERN_CONT "%s", ctrl->cur.string);
1712 break;
1713 default:
1714 printk(KERN_CONT "unknown type %d", ctrl->type);
1715 break;
1716 }
Hans Verkuil88365102011-08-26 07:35:14 -03001717 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1718 V4L2_CTRL_FLAG_GRABBED |
1719 V4L2_CTRL_FLAG_VOLATILE)) {
1720 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1721 printk(KERN_CONT " inactive");
1722 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1723 printk(KERN_CONT " grabbed");
1724 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1725 printk(KERN_CONT " volatile");
1726 }
1727 printk(KERN_CONT "\n");
Hans Verkuil09965172010-08-01 14:32:42 -03001728}
1729
1730/* Log all controls owned by the handler */
1731void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1732 const char *prefix)
1733{
1734 struct v4l2_ctrl *ctrl;
1735 const char *colon = "";
1736 int len;
1737
1738 if (hdl == NULL)
1739 return;
1740 if (prefix == NULL)
1741 prefix = "";
1742 len = strlen(prefix);
1743 if (len && prefix[len - 1] != ' ')
1744 colon = ": ";
1745 mutex_lock(&hdl->lock);
1746 list_for_each_entry(ctrl, &hdl->ctrls, node)
1747 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1748 log_ctrl(ctrl, prefix, colon);
1749 mutex_unlock(&hdl->lock);
1750}
1751EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1752
1753/* Call s_ctrl for all controls owned by the handler */
1754int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1755{
1756 struct v4l2_ctrl *ctrl;
1757 int ret = 0;
1758
1759 if (hdl == NULL)
1760 return 0;
1761 mutex_lock(&hdl->lock);
1762 list_for_each_entry(ctrl, &hdl->ctrls, node)
1763 ctrl->done = false;
1764
1765 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1766 struct v4l2_ctrl *master = ctrl->cluster[0];
1767 int i;
1768
1769 /* Skip if this control was already handled by a cluster. */
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001770 /* Skip button controls and read-only controls. */
1771 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1772 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
Hans Verkuil09965172010-08-01 14:32:42 -03001773 continue;
1774
Hans Verkuil2a863792011-01-11 14:45:03 -03001775 for (i = 0; i < master->ncontrols; i++) {
1776 if (master->cluster[i]) {
1777 cur_to_new(master->cluster[i]);
1778 master->cluster[i]->is_new = 1;
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001779 master->cluster[i]->done = true;
Hans Verkuil2a863792011-01-11 14:45:03 -03001780 }
1781 }
Hans Verkuil54c911e2011-05-25 06:04:58 -03001782 ret = call_op(master, s_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001783 if (ret)
1784 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001785 }
1786 mutex_unlock(&hdl->lock);
1787 return ret;
1788}
1789EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1790
1791/* Implement VIDIOC_QUERYCTRL */
1792int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1793{
1794 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1795 struct v4l2_ctrl_ref *ref;
1796 struct v4l2_ctrl *ctrl;
1797
1798 if (hdl == NULL)
1799 return -EINVAL;
1800
1801 mutex_lock(&hdl->lock);
1802
1803 /* Try to find it */
1804 ref = find_ref(hdl, id);
1805
1806 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1807 /* Find the next control with ID > qc->id */
1808
1809 /* Did we reach the end of the control list? */
1810 if (id >= node2id(hdl->ctrl_refs.prev)) {
1811 ref = NULL; /* Yes, so there is no next control */
1812 } else if (ref) {
1813 /* We found a control with the given ID, so just get
1814 the next one in the list. */
1815 ref = list_entry(ref->node.next, typeof(*ref), node);
1816 } else {
1817 /* No control with the given ID exists, so start
1818 searching for the next largest ID. We know there
1819 is one, otherwise the first 'if' above would have
1820 been true. */
1821 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1822 if (id < ref->ctrl->id)
1823 break;
1824 }
1825 }
1826 mutex_unlock(&hdl->lock);
1827 if (!ref)
1828 return -EINVAL;
1829
1830 ctrl = ref->ctrl;
1831 memset(qc, 0, sizeof(*qc));
Hans Verkuil829fb2d2011-01-16 11:21:40 -03001832 if (id >= V4L2_CID_PRIVATE_BASE)
1833 qc->id = id;
1834 else
1835 qc->id = ctrl->id;
Hans Verkuil09965172010-08-01 14:32:42 -03001836 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1837 qc->minimum = ctrl->minimum;
1838 qc->maximum = ctrl->maximum;
1839 qc->default_value = ctrl->default_value;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001840 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1841 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil09965172010-08-01 14:32:42 -03001842 qc->step = 1;
1843 else
1844 qc->step = ctrl->step;
1845 qc->flags = ctrl->flags;
1846 qc->type = ctrl->type;
1847 return 0;
1848}
1849EXPORT_SYMBOL(v4l2_queryctrl);
1850
1851int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1852{
Hans Verkuil87a0c942011-02-22 12:31:07 -03001853 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1854 return -EINVAL;
Hans Verkuil09965172010-08-01 14:32:42 -03001855 return v4l2_queryctrl(sd->ctrl_handler, qc);
1856}
1857EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1858
1859/* Implement VIDIOC_QUERYMENU */
1860int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1861{
1862 struct v4l2_ctrl *ctrl;
1863 u32 i = qm->index;
1864
1865 ctrl = v4l2_ctrl_find(hdl, qm->id);
1866 if (!ctrl)
1867 return -EINVAL;
1868
1869 qm->reserved = 0;
1870 /* Sanity checks */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001871 switch (ctrl->type) {
1872 case V4L2_CTRL_TYPE_MENU:
1873 if (ctrl->qmenu == NULL)
1874 return -EINVAL;
1875 break;
1876 case V4L2_CTRL_TYPE_INTEGER_MENU:
1877 if (ctrl->qmenu_int == NULL)
1878 return -EINVAL;
1879 break;
1880 default:
Hans Verkuil09965172010-08-01 14:32:42 -03001881 return -EINVAL;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001882 }
1883
1884 if (i < ctrl->minimum || i > ctrl->maximum)
1885 return -EINVAL;
1886
Hans Verkuil09965172010-08-01 14:32:42 -03001887 /* Use mask to see if this menu item should be skipped */
1888 if (ctrl->menu_skip_mask & (1 << i))
1889 return -EINVAL;
1890 /* Empty menu items should also be skipped */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001891 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
1892 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1893 return -EINVAL;
1894 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1895 } else {
1896 qm->value = ctrl->qmenu_int[i];
1897 }
Hans Verkuil09965172010-08-01 14:32:42 -03001898 return 0;
1899}
1900EXPORT_SYMBOL(v4l2_querymenu);
1901
1902int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1903{
1904 return v4l2_querymenu(sd->ctrl_handler, qm);
1905}
1906EXPORT_SYMBOL(v4l2_subdev_querymenu);
1907
1908
1909
1910/* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1911
1912 It is not a fully atomic operation, just best-effort only. After all, if
1913 multiple controls have to be set through multiple i2c writes (for example)
1914 then some initial writes may succeed while others fail. Thus leaving the
1915 system in an inconsistent state. The question is how much effort you are
1916 willing to spend on trying to make something atomic that really isn't.
1917
1918 From the point of view of an application the main requirement is that
1919 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1920 error should be returned without actually affecting any controls.
1921
1922 If all the values are correct, then it is acceptable to just give up
1923 in case of low-level errors.
1924
1925 It is important though that the application can tell when only a partial
1926 configuration was done. The way we do that is through the error_idx field
1927 of struct v4l2_ext_controls: if that is equal to the count field then no
1928 controls were affected. Otherwise all controls before that index were
1929 successful in performing their 'get' or 'set' operation, the control at
1930 the given index failed, and you don't know what happened with the controls
1931 after the failed one. Since if they were part of a control cluster they
1932 could have been successfully processed (if a cluster member was encountered
1933 at index < error_idx), they could have failed (if a cluster member was at
1934 error_idx), or they may not have been processed yet (if the first cluster
1935 member appeared after error_idx).
1936
1937 It is all fairly theoretical, though. In practice all you can do is to
1938 bail out. If error_idx == count, then it is an application bug. If
1939 error_idx < count then it is only an application bug if the error code was
1940 EBUSY. That usually means that something started streaming just when you
1941 tried to set the controls. In all other cases it is a driver/hardware
1942 problem and all you can do is to retry or bail out.
1943
1944 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1945 never modifies controls the error_idx is just set to whatever control
1946 has an invalid value.
1947 */
1948
1949/* Prepare for the extended g/s/try functions.
1950 Find the controls in the control array and do some basic checks. */
1951static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1952 struct v4l2_ext_controls *cs,
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001953 struct v4l2_ctrl_helper *helpers)
Hans Verkuil09965172010-08-01 14:32:42 -03001954{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001955 struct v4l2_ctrl_helper *h;
1956 bool have_clusters = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001957 u32 i;
1958
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001959 for (i = 0, h = helpers; i < cs->count; i++, h++) {
Hans Verkuil09965172010-08-01 14:32:42 -03001960 struct v4l2_ext_control *c = &cs->controls[i];
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001961 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001962 struct v4l2_ctrl *ctrl;
1963 u32 id = c->id & V4L2_CTRL_ID_MASK;
1964
Hans Verkuil37cd3b72011-06-07 04:40:04 -03001965 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03001966
1967 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1968 return -EINVAL;
1969
1970 /* Old-style private controls are not allowed for
1971 extended controls */
1972 if (id >= V4L2_CID_PRIVATE_BASE)
1973 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001974 ref = find_ref_lock(hdl, id);
1975 if (ref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001976 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001977 ctrl = ref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03001978 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1979 return -EINVAL;
1980
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001981 if (ctrl->cluster[0]->ncontrols > 1)
1982 have_clusters = true;
1983 if (ctrl->cluster[0] != ctrl)
1984 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1985 /* Store the ref to the master control of the cluster */
1986 h->mref = ref;
1987 h->ctrl = ctrl;
1988 /* Initially set next to 0, meaning that there is no other
1989 control in this helper array belonging to the same
1990 cluster */
1991 h->next = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001992 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001993
1994 /* We are done if there were no controls that belong to a multi-
1995 control cluster. */
1996 if (!have_clusters)
1997 return 0;
1998
1999 /* The code below figures out in O(n) time which controls in the list
2000 belong to the same cluster. */
2001
2002 /* This has to be done with the handler lock taken. */
2003 mutex_lock(&hdl->lock);
2004
2005 /* First zero the helper field in the master control references */
2006 for (i = 0; i < cs->count; i++)
2007 helpers[i].mref->helper = 0;
2008 for (i = 0, h = helpers; i < cs->count; i++, h++) {
2009 struct v4l2_ctrl_ref *mref = h->mref;
2010
2011 /* If the mref->helper is set, then it points to an earlier
2012 helper that belongs to the same cluster. */
2013 if (mref->helper) {
2014 /* Set the next field of mref->helper to the current
2015 index: this means that that earlier helper now
2016 points to the next helper in the same cluster. */
2017 mref->helper->next = i;
2018 /* mref should be set only for the first helper in the
2019 cluster, clear the others. */
2020 h->mref = NULL;
2021 }
2022 /* Point the mref helper to the current helper struct. */
2023 mref->helper = h;
2024 }
2025 mutex_unlock(&hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03002026 return 0;
2027}
2028
Hans Verkuil09965172010-08-01 14:32:42 -03002029/* Handles the corner case where cs->count == 0. It checks whether the
2030 specified control class exists. If that class ID is 0, then it checks
2031 whether there are any controls at all. */
2032static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2033{
2034 if (ctrl_class == 0)
2035 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2036 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2037}
2038
2039
2040
2041/* Get extended controls. Allocates the helpers array if needed. */
2042int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2043{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002044 struct v4l2_ctrl_helper helper[4];
2045 struct v4l2_ctrl_helper *helpers = helper;
Hans Verkuil09965172010-08-01 14:32:42 -03002046 int ret;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002047 int i, j;
Hans Verkuil09965172010-08-01 14:32:42 -03002048
2049 cs->error_idx = cs->count;
2050 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2051
2052 if (hdl == NULL)
2053 return -EINVAL;
2054
2055 if (cs->count == 0)
2056 return class_check(hdl, cs->ctrl_class);
2057
2058 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang5f0049b2012-04-06 09:32:36 -03002059 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2060 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03002061 if (helpers == NULL)
2062 return -ENOMEM;
2063 }
2064
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002065 ret = prepare_ext_ctrls(hdl, cs, helpers);
2066 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002067
2068 for (i = 0; !ret && i < cs->count; i++)
2069 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2070 ret = -EACCES;
2071
2072 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002073 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2074 struct v4l2_ctrl *ctrl) = cur_to_user;
2075 struct v4l2_ctrl *master;
Hans Verkuil09965172010-08-01 14:32:42 -03002076
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002077 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002078 continue;
2079
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002080 master = helpers[i].mref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03002081 cs->error_idx = i;
2082
2083 v4l2_ctrl_lock(master);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002084
2085 /* g_volatile_ctrl will update the new control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002086 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2087 (master->has_volatiles && !is_cur_manual(master))) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002088 for (j = 0; j < master->ncontrols; j++)
2089 cur_to_new(master->cluster[j]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002090 ret = call_op(master, g_volatile_ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002091 ctrl_to_user = new_to_user;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002092 }
2093 /* If OK, then copy the current (for non-volatile controls)
2094 or the new (for volatile controls) control values to the
2095 caller */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002096 if (!ret) {
2097 u32 idx = i;
2098
2099 do {
2100 ret = ctrl_to_user(cs->controls + idx,
2101 helpers[idx].ctrl);
2102 idx = helpers[idx].next;
2103 } while (!ret && idx);
2104 }
Hans Verkuil09965172010-08-01 14:32:42 -03002105 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002106 }
2107
2108 if (cs->count > ARRAY_SIZE(helper))
2109 kfree(helpers);
2110 return ret;
2111}
2112EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2113
2114int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2115{
2116 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2117}
2118EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2119
2120/* Helper function to get a single control */
2121static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2122{
2123 struct v4l2_ctrl *master = ctrl->cluster[0];
2124 int ret = 0;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002125 int i;
Hans Verkuil09965172010-08-01 14:32:42 -03002126
2127 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2128 return -EACCES;
2129
2130 v4l2_ctrl_lock(master);
2131 /* g_volatile_ctrl will update the current control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002132 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002133 for (i = 0; i < master->ncontrols; i++)
2134 cur_to_new(master->cluster[i]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002135 ret = call_op(master, g_volatile_ctrl);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002136 *val = ctrl->val;
2137 } else {
2138 *val = ctrl->cur.val;
2139 }
Hans Verkuil09965172010-08-01 14:32:42 -03002140 v4l2_ctrl_unlock(master);
2141 return ret;
2142}
2143
2144int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2145{
2146 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2147
2148 if (ctrl == NULL || !type_is_int(ctrl))
2149 return -EINVAL;
2150 return get_ctrl(ctrl, &control->value);
2151}
2152EXPORT_SYMBOL(v4l2_g_ctrl);
2153
2154int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2155{
2156 return v4l2_g_ctrl(sd->ctrl_handler, control);
2157}
2158EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2159
2160s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2161{
2162 s32 val = 0;
2163
2164 /* It's a driver bug if this happens. */
2165 WARN_ON(!type_is_int(ctrl));
2166 get_ctrl(ctrl, &val);
2167 return val;
2168}
2169EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2170
2171
2172/* Core function that calls try/s_ctrl and ensures that the new value is
2173 copied to the current value on a set.
2174 Must be called with ctrl->handler->lock held. */
Hans Verkuile6402582011-06-14 10:56:42 -03002175static int try_or_set_cluster(struct v4l2_fh *fh,
2176 struct v4l2_ctrl *master, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002177{
Hans Verkuil72d877c2011-06-10 05:44:36 -03002178 bool update_flag;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002179 int ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002180 int i;
2181
2182 /* Go through the cluster and either validate the new value or
2183 (if no new value was set), copy the current value to the new
2184 value, ensuring a consistent view for the control ops when
2185 called. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002186 for (i = 0; i < master->ncontrols; i++) {
Hans Verkuil09965172010-08-01 14:32:42 -03002187 struct v4l2_ctrl *ctrl = master->cluster[i];
2188
2189 if (ctrl == NULL)
2190 continue;
2191
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002192 if (!ctrl->is_new) {
2193 cur_to_new(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002194 continue;
2195 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002196 /* Check again: it may have changed since the
2197 previous check in try_or_set_ext_ctrls(). */
2198 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2199 return -EBUSY;
Hans Verkuil09965172010-08-01 14:32:42 -03002200 }
2201
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002202 ret = call_op(master, try_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002203
2204 /* Don't set if there is no change */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002205 if (ret || !set || !cluster_changed(master))
2206 return ret;
2207 ret = call_op(master, s_ctrl);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002208 if (ret)
2209 return ret;
2210
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002211 /* If OK, then make the new values permanent. */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002212 update_flag = is_cur_manual(master) != is_new_manual(master);
2213 for (i = 0; i < master->ncontrols; i++)
Hans Verkuilab892ba2011-06-07 06:47:18 -03002214 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002215 return 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002216}
2217
Hans Verkuile6402582011-06-14 10:56:42 -03002218/* Validate controls. */
2219static int validate_ctrls(struct v4l2_ext_controls *cs,
2220 struct v4l2_ctrl_helper *helpers, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002221{
Hans Verkuile6402582011-06-14 10:56:42 -03002222 unsigned i;
Hans Verkuil09965172010-08-01 14:32:42 -03002223 int ret = 0;
2224
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002225 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002226 for (i = 0; i < cs->count; i++) {
2227 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2228
Hans Verkuile6402582011-06-14 10:56:42 -03002229 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002230
2231 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2232 return -EACCES;
2233 /* This test is also done in try_set_control_cluster() which
2234 is called in atomic context, so that has the final say,
2235 but it makes sense to do an up-front check as well. Once
2236 an error occurs in try_set_control_cluster() some other
2237 controls may have been set already and we want to do a
2238 best-effort to avoid that. */
2239 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2240 return -EBUSY;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002241 ret = validate_new(ctrl, &cs->controls[i]);
2242 if (ret)
2243 return ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002244 }
Hans Verkuile6402582011-06-14 10:56:42 -03002245 return 0;
2246}
Hans Verkuil09965172010-08-01 14:32:42 -03002247
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002248/* Obtain the current volatile values of an autocluster and mark them
2249 as new. */
2250static void update_from_auto_cluster(struct v4l2_ctrl *master)
2251{
2252 int i;
2253
2254 for (i = 0; i < master->ncontrols; i++)
2255 cur_to_new(master->cluster[i]);
2256 if (!call_op(master, g_volatile_ctrl))
2257 for (i = 1; i < master->ncontrols; i++)
2258 if (master->cluster[i])
2259 master->cluster[i]->is_new = 1;
2260}
2261
Hans Verkuile6402582011-06-14 10:56:42 -03002262/* Try or try-and-set controls */
2263static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2264 struct v4l2_ext_controls *cs,
2265 bool set)
2266{
2267 struct v4l2_ctrl_helper helper[4];
2268 struct v4l2_ctrl_helper *helpers = helper;
2269 unsigned i, j;
2270 int ret;
2271
2272 cs->error_idx = cs->count;
2273 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2274
2275 if (hdl == NULL)
2276 return -EINVAL;
2277
2278 if (cs->count == 0)
2279 return class_check(hdl, cs->ctrl_class);
2280
2281 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang0a3475e2012-04-06 09:32:37 -03002282 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2283 GFP_KERNEL);
Hans Verkuile6402582011-06-14 10:56:42 -03002284 if (!helpers)
2285 return -ENOMEM;
2286 }
2287 ret = prepare_ext_ctrls(hdl, cs, helpers);
2288 if (!ret)
2289 ret = validate_ctrls(cs, helpers, set);
2290 if (ret && set)
2291 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002292 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002293 struct v4l2_ctrl *master;
2294 u32 idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002295
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002296 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002297 continue;
2298
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002299 cs->error_idx = i;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002300 master = helpers[i].mref->ctrl;
2301 v4l2_ctrl_lock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002302
Hans Verkuil2a863792011-01-11 14:45:03 -03002303 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002304 for (j = 0; j < master->ncontrols; j++)
2305 if (master->cluster[j])
Hans Verkuil2a863792011-01-11 14:45:03 -03002306 master->cluster[j]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002307
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002308 /* For volatile autoclusters that are currently in auto mode
2309 we need to discover if it will be set to manual mode.
2310 If so, then we have to copy the current volatile values
2311 first since those will become the new manual values (which
2312 may be overwritten by explicit new values from this set
2313 of controls). */
2314 if (master->is_auto && master->has_volatiles &&
2315 !is_cur_manual(master)) {
2316 /* Pick an initial non-manual value */
2317 s32 new_auto_val = master->manual_mode_value + 1;
2318 u32 tmp_idx = idx;
2319
2320 do {
2321 /* Check if the auto control is part of the
2322 list, and remember the new value. */
2323 if (helpers[tmp_idx].ctrl == master)
2324 new_auto_val = cs->controls[tmp_idx].value;
2325 tmp_idx = helpers[tmp_idx].next;
2326 } while (tmp_idx);
2327 /* If the new value == the manual value, then copy
2328 the current volatile values. */
2329 if (new_auto_val == master->manual_mode_value)
2330 update_from_auto_cluster(master);
2331 }
2332
Hans Verkuil09965172010-08-01 14:32:42 -03002333 /* Copy the new caller-supplied control values.
Hans Verkuil2a863792011-01-11 14:45:03 -03002334 user_to_new() sets 'is_new' to 1. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002335 do {
2336 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2337 idx = helpers[idx].next;
2338 } while (!ret && idx);
Hans Verkuil09965172010-08-01 14:32:42 -03002339
2340 if (!ret)
Hans Verkuile6402582011-06-14 10:56:42 -03002341 ret = try_or_set_cluster(fh, master, set);
Hans Verkuil09965172010-08-01 14:32:42 -03002342
2343 /* Copy the new values back to userspace. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002344 if (!ret) {
2345 idx = i;
2346 do {
Hans Verkuiladf41b92011-07-05 06:56:37 -03002347 ret = new_to_user(cs->controls + idx,
Hans Verkuile6402582011-06-14 10:56:42 -03002348 helpers[idx].ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002349 idx = helpers[idx].next;
2350 } while (!ret && idx);
2351 }
2352 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002353 }
Hans Verkuil09965172010-08-01 14:32:42 -03002354
Hans Verkuil09965172010-08-01 14:32:42 -03002355 if (cs->count > ARRAY_SIZE(helper))
2356 kfree(helpers);
2357 return ret;
2358}
2359
2360int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2361{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002362 return try_set_ext_ctrls(NULL, hdl, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002363}
2364EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2365
Hans Verkuilab892ba2011-06-07 06:47:18 -03002366int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2367 struct v4l2_ext_controls *cs)
Hans Verkuil09965172010-08-01 14:32:42 -03002368{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002369 return try_set_ext_ctrls(fh, hdl, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002370}
2371EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2372
2373int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2374{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002375 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002376}
2377EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2378
2379int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2380{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002381 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002382}
2383EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2384
2385/* Helper function for VIDIOC_S_CTRL compatibility */
Hans Verkuilab892ba2011-06-07 06:47:18 -03002386static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
Hans Verkuil09965172010-08-01 14:32:42 -03002387{
2388 struct v4l2_ctrl *master = ctrl->cluster[0];
2389 int ret;
2390 int i;
2391
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002392 ret = validate_new_int(ctrl, val);
2393 if (ret)
2394 return ret;
2395
Hans Verkuil09965172010-08-01 14:32:42 -03002396 v4l2_ctrl_lock(ctrl);
2397
Hans Verkuil2a863792011-01-11 14:45:03 -03002398 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002399 for (i = 0; i < master->ncontrols; i++)
2400 if (master->cluster[i])
Hans Verkuil2a863792011-01-11 14:45:03 -03002401 master->cluster[i]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002402
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002403 /* For autoclusters with volatiles that are switched from auto to
2404 manual mode we have to update the current volatile values since
2405 those will become the initial manual values after such a switch. */
2406 if (master->is_auto && master->has_volatiles && ctrl == master &&
2407 !is_cur_manual(master) && *val == master->manual_mode_value)
2408 update_from_auto_cluster(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002409 ctrl->val = *val;
Hans Verkuil2a863792011-01-11 14:45:03 -03002410 ctrl->is_new = 1;
Hans Verkuile6402582011-06-14 10:56:42 -03002411 ret = try_or_set_cluster(fh, master, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002412 *val = ctrl->cur.val;
2413 v4l2_ctrl_unlock(ctrl);
2414 return ret;
2415}
2416
Hans Verkuilab892ba2011-06-07 06:47:18 -03002417int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2418 struct v4l2_control *control)
Hans Verkuil09965172010-08-01 14:32:42 -03002419{
2420 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2421
2422 if (ctrl == NULL || !type_is_int(ctrl))
2423 return -EINVAL;
2424
Hans Verkuil7ebbc392011-06-07 04:50:31 -03002425 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2426 return -EACCES;
2427
Hans Verkuilab892ba2011-06-07 06:47:18 -03002428 return set_ctrl(fh, ctrl, &control->value);
Hans Verkuil09965172010-08-01 14:32:42 -03002429}
2430EXPORT_SYMBOL(v4l2_s_ctrl);
2431
2432int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2433{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002434 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
Hans Verkuil09965172010-08-01 14:32:42 -03002435}
2436EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2437
2438int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2439{
2440 /* It's a driver bug if this happens. */
2441 WARN_ON(!type_is_int(ctrl));
Hans Verkuilab892ba2011-06-07 06:47:18 -03002442 return set_ctrl(NULL, ctrl, &val);
Hans Verkuil09965172010-08-01 14:32:42 -03002443}
2444EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
Hans Verkuil6e239392011-06-07 11:13:44 -03002445
Hans de Goede3e3661492012-04-08 12:59:47 -03002446static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002447{
Hans de Goede3e3661492012-04-08 12:59:47 -03002448 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2449
2450 if (ctrl == NULL)
2451 return -EINVAL;
2452
Hans Verkuil6e239392011-06-07 11:13:44 -03002453 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002454 list_add_tail(&sev->node, &ctrl->ev_subs);
Hans Verkuil6e239392011-06-07 11:13:44 -03002455 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
Hans Verkuil77068d32011-06-13 18:55:58 -03002456 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
Hans Verkuil6e239392011-06-07 11:13:44 -03002457 struct v4l2_event ev;
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002458 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
Hans Verkuil6e239392011-06-07 11:13:44 -03002459
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002460 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2461 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2462 fill_event(&ev, ctrl, changes);
Hans Verkuil77068d32011-06-13 18:55:58 -03002463 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -03002464 }
2465 v4l2_ctrl_unlock(ctrl);
Hans de Goede3e3661492012-04-08 12:59:47 -03002466 return 0;
Hans Verkuil6e239392011-06-07 11:13:44 -03002467}
Hans Verkuil6e239392011-06-07 11:13:44 -03002468
Hans de Goede3e3661492012-04-08 12:59:47 -03002469static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002470{
Hans de Goede3e3661492012-04-08 12:59:47 -03002471 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2472
Hans Verkuil6e239392011-06-07 11:13:44 -03002473 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002474 list_del(&sev->node);
Hans Verkuil6e239392011-06-07 11:13:44 -03002475 v4l2_ctrl_unlock(ctrl);
2476}
Hans de Goede3e3661492012-04-08 12:59:47 -03002477
2478void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2479{
2480 u32 old_changes = old->u.ctrl.changes;
2481
2482 old->u.ctrl = new->u.ctrl;
2483 old->u.ctrl.changes |= old_changes;
2484}
2485EXPORT_SYMBOL(v4l2_ctrl_replace);
2486
2487void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2488{
2489 new->u.ctrl.changes |= old->u.ctrl.changes;
2490}
2491EXPORT_SYMBOL(v4l2_ctrl_merge);
2492
2493const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2494 .add = v4l2_ctrl_add_event,
2495 .del = v4l2_ctrl_del_event,
2496 .replace = v4l2_ctrl_replace,
2497 .merge = v4l2_ctrl_merge,
2498};
2499EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
Hans Verkuile2ecb252012-02-02 08:20:53 -03002500
2501int v4l2_ctrl_log_status(struct file *file, void *fh)
2502{
2503 struct video_device *vfd = video_devdata(file);
2504 struct v4l2_fh *vfh = file->private_data;
2505
2506 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2507 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2508 vfd->v4l2_dev->name);
2509 return 0;
2510}
2511EXPORT_SYMBOL(v4l2_ctrl_log_status);
Hans Verkuila26243b2012-01-27 16:18:42 -03002512
2513int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2514 struct v4l2_event_subscription *sub)
2515{
2516 if (sub->type == V4L2_EVENT_CTRL)
Hans de Goede3e3661492012-04-08 12:59:47 -03002517 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
Hans Verkuila26243b2012-01-27 16:18:42 -03002518 return -EINVAL;
2519}
2520EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2521
2522unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2523{
2524 struct v4l2_fh *fh = file->private_data;
2525
2526 if (v4l2_event_pending(fh))
2527 return POLLPRI;
2528 poll_wait(file, &fh->wait, wait);
2529 return 0;
2530}
2531EXPORT_SYMBOL(v4l2_ctrl_poll);