blob: bf62b105b49d3098fdc233a4912d54d65d0a81a8 [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
Hans Verkuil09965172010-08-01 14:32:42 -0300647 default:
648 return NULL;
649 }
650}
651EXPORT_SYMBOL(v4l2_ctrl_get_name);
652
653void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
654 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
655{
656 *name = v4l2_ctrl_get_name(id);
657 *flags = 0;
658
659 switch (id) {
660 case V4L2_CID_AUDIO_MUTE:
661 case V4L2_CID_AUDIO_LOUDNESS:
662 case V4L2_CID_AUTO_WHITE_BALANCE:
663 case V4L2_CID_AUTOGAIN:
664 case V4L2_CID_HFLIP:
665 case V4L2_CID_VFLIP:
666 case V4L2_CID_HUE_AUTO:
667 case V4L2_CID_CHROMA_AGC:
668 case V4L2_CID_COLOR_KILLER:
669 case V4L2_CID_MPEG_AUDIO_MUTE:
670 case V4L2_CID_MPEG_VIDEO_MUTE:
671 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
672 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
673 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
674 case V4L2_CID_FOCUS_AUTO:
675 case V4L2_CID_PRIVACY:
676 case V4L2_CID_AUDIO_LIMITER_ENABLED:
677 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
678 case V4L2_CID_PILOT_TONE_ENABLED:
Jean-François Moine008d35f2010-09-13 07:04:49 -0300679 case V4L2_CID_ILLUMINATORS_1:
680 case V4L2_CID_ILLUMINATORS_2:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300681 case V4L2_CID_FLASH_STROBE_STATUS:
682 case V4L2_CID_FLASH_CHARGE:
683 case V4L2_CID_FLASH_READY:
Kamil Debski064f5092011-06-14 10:46:22 -0300684 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
685 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
686 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
687 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
688 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
689 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
690 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
Hans Verkuil09965172010-08-01 14:32:42 -0300691 *type = V4L2_CTRL_TYPE_BOOLEAN;
692 *min = 0;
693 *max = *step = 1;
694 break;
695 case V4L2_CID_PAN_RESET:
696 case V4L2_CID_TILT_RESET:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300697 case V4L2_CID_FLASH_STROBE:
698 case V4L2_CID_FLASH_STROBE_STOP:
Hans Verkuil09965172010-08-01 14:32:42 -0300699 *type = V4L2_CTRL_TYPE_BUTTON;
700 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
701 *min = *max = *step = *def = 0;
702 break;
703 case V4L2_CID_POWER_LINE_FREQUENCY:
704 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
705 case V4L2_CID_MPEG_AUDIO_ENCODING:
706 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
707 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
708 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
709 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
710 case V4L2_CID_MPEG_AUDIO_MODE:
711 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
712 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
713 case V4L2_CID_MPEG_AUDIO_CRC:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300714 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
715 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
Hans Verkuil09965172010-08-01 14:32:42 -0300716 case V4L2_CID_MPEG_VIDEO_ENCODING:
717 case V4L2_CID_MPEG_VIDEO_ASPECT:
718 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
719 case V4L2_CID_MPEG_STREAM_TYPE:
720 case V4L2_CID_MPEG_STREAM_VBI_FMT:
721 case V4L2_CID_EXPOSURE_AUTO:
722 case V4L2_CID_COLORFX:
723 case V4L2_CID_TUNE_PREEMPHASIS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300724 case V4L2_CID_FLASH_LED_MODE:
725 case V4L2_CID_FLASH_STROBE_SOURCE:
Kamil Debski064f5092011-06-14 10:46:22 -0300726 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
727 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
728 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
729 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
730 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
731 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
732 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
733 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
734 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300735 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
Hans Verkuil09965172010-08-01 14:32:42 -0300736 *type = V4L2_CTRL_TYPE_MENU;
737 break;
738 case V4L2_CID_RDS_TX_PS_NAME:
739 case V4L2_CID_RDS_TX_RADIO_TEXT:
740 *type = V4L2_CTRL_TYPE_STRING;
741 break;
742 case V4L2_CID_USER_CLASS:
743 case V4L2_CID_CAMERA_CLASS:
744 case V4L2_CID_MPEG_CLASS:
745 case V4L2_CID_FM_TX_CLASS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300746 case V4L2_CID_FLASH_CLASS:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300747 case V4L2_CID_JPEG_CLASS:
Hans Verkuil09965172010-08-01 14:32:42 -0300748 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
749 /* You can neither read not write these */
750 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
751 *min = *max = *step = *def = 0;
752 break;
753 case V4L2_CID_BG_COLOR:
754 *type = V4L2_CTRL_TYPE_INTEGER;
755 *step = 1;
756 *min = 0;
757 /* Max is calculated as RGB888 that is 2^24 */
758 *max = 0xFFFFFF;
759 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300760 case V4L2_CID_FLASH_FAULT:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300761 case V4L2_CID_JPEG_ACTIVE_MARKER:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300762 *type = V4L2_CTRL_TYPE_BITMASK;
763 break;
Kamil Debski064f5092011-06-14 10:46:22 -0300764 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
765 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
766 *type = V4L2_CTRL_TYPE_INTEGER;
767 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
768 break;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300769 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
770 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
771 *type = V4L2_CTRL_TYPE_INTEGER64;
772 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_VOLATILE;
773 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300774 default:
775 *type = V4L2_CTRL_TYPE_INTEGER;
776 break;
777 }
778 switch (id) {
779 case V4L2_CID_MPEG_AUDIO_ENCODING:
780 case V4L2_CID_MPEG_AUDIO_MODE:
781 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
782 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
783 case V4L2_CID_MPEG_STREAM_TYPE:
784 *flags |= V4L2_CTRL_FLAG_UPDATE;
785 break;
786 case V4L2_CID_AUDIO_VOLUME:
787 case V4L2_CID_AUDIO_BALANCE:
788 case V4L2_CID_AUDIO_BASS:
789 case V4L2_CID_AUDIO_TREBLE:
790 case V4L2_CID_BRIGHTNESS:
791 case V4L2_CID_CONTRAST:
792 case V4L2_CID_SATURATION:
793 case V4L2_CID_HUE:
794 case V4L2_CID_RED_BALANCE:
795 case V4L2_CID_BLUE_BALANCE:
796 case V4L2_CID_GAMMA:
797 case V4L2_CID_SHARPNESS:
798 case V4L2_CID_CHROMA_GAIN:
799 case V4L2_CID_RDS_TX_DEVIATION:
800 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
801 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
802 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
803 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
804 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
805 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
806 case V4L2_CID_PILOT_TONE_DEVIATION:
807 case V4L2_CID_PILOT_TONE_FREQUENCY:
808 case V4L2_CID_TUNE_POWER_LEVEL:
809 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
810 *flags |= V4L2_CTRL_FLAG_SLIDER;
811 break;
812 case V4L2_CID_PAN_RELATIVE:
813 case V4L2_CID_TILT_RELATIVE:
814 case V4L2_CID_FOCUS_RELATIVE:
815 case V4L2_CID_IRIS_RELATIVE:
816 case V4L2_CID_ZOOM_RELATIVE:
817 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
818 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300819 case V4L2_CID_FLASH_STROBE_STATUS:
820 case V4L2_CID_FLASH_READY:
821 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
822 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300823 }
824}
825EXPORT_SYMBOL(v4l2_ctrl_fill);
826
827/* Helper function to determine whether the control type is compatible with
828 VIDIOC_G/S_CTRL. */
829static bool type_is_int(const struct v4l2_ctrl *ctrl)
830{
831 switch (ctrl->type) {
832 case V4L2_CTRL_TYPE_INTEGER64:
833 case V4L2_CTRL_TYPE_STRING:
834 /* Nope, these need v4l2_ext_control */
835 return false;
836 default:
837 return true;
838 }
839}
840
Hans Verkuil6e239392011-06-07 11:13:44 -0300841static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
842{
843 memset(ev->reserved, 0, sizeof(ev->reserved));
844 ev->type = V4L2_EVENT_CTRL;
845 ev->id = ctrl->id;
846 ev->u.ctrl.changes = changes;
847 ev->u.ctrl.type = ctrl->type;
848 ev->u.ctrl.flags = ctrl->flags;
849 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
850 ev->u.ctrl.value64 = 0;
851 else
852 ev->u.ctrl.value64 = ctrl->cur.val64;
853 ev->u.ctrl.minimum = ctrl->minimum;
854 ev->u.ctrl.maximum = ctrl->maximum;
Sakari Ailusce580fe2011-08-04 13:51:11 -0300855 if (ctrl->type == V4L2_CTRL_TYPE_MENU
856 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil6e239392011-06-07 11:13:44 -0300857 ev->u.ctrl.step = 1;
858 else
859 ev->u.ctrl.step = ctrl->step;
860 ev->u.ctrl.default_value = ctrl->default_value;
861}
862
863static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
864{
865 struct v4l2_event ev;
Hans Verkuil77068d32011-06-13 18:55:58 -0300866 struct v4l2_subscribed_event *sev;
Hans Verkuil6e239392011-06-07 11:13:44 -0300867
Hans Verkuil77068d32011-06-13 18:55:58 -0300868 if (list_empty(&ctrl->ev_subs))
Hans Verkuil3f66f0e2011-06-20 11:56:24 -0300869 return;
Hans Verkuil6e239392011-06-07 11:13:44 -0300870 fill_event(&ev, ctrl, changes);
871
Hans Verkuil77068d32011-06-13 18:55:58 -0300872 list_for_each_entry(sev, &ctrl->ev_subs, node)
Hans de Goedee3e72f392011-10-26 05:52:47 -0300873 if (sev->fh != fh ||
874 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
Hans Verkuil77068d32011-06-13 18:55:58 -0300875 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -0300876}
877
Hans Verkuil09965172010-08-01 14:32:42 -0300878/* Helper function: copy the current control value back to the caller */
879static int cur_to_user(struct v4l2_ext_control *c,
880 struct v4l2_ctrl *ctrl)
881{
882 u32 len;
883
884 switch (ctrl->type) {
885 case V4L2_CTRL_TYPE_STRING:
886 len = strlen(ctrl->cur.string);
887 if (c->size < len + 1) {
888 c->size = len + 1;
889 return -ENOSPC;
890 }
891 return copy_to_user(c->string, ctrl->cur.string,
892 len + 1) ? -EFAULT : 0;
893 case V4L2_CTRL_TYPE_INTEGER64:
894 c->value64 = ctrl->cur.val64;
895 break;
896 default:
897 c->value = ctrl->cur.val;
898 break;
899 }
900 return 0;
901}
902
903/* Helper function: copy the caller-provider value as the new control value */
904static int user_to_new(struct v4l2_ext_control *c,
905 struct v4l2_ctrl *ctrl)
906{
907 int ret;
908 u32 size;
909
Hans Verkuil2a863792011-01-11 14:45:03 -0300910 ctrl->is_new = 1;
Hans Verkuil09965172010-08-01 14:32:42 -0300911 switch (ctrl->type) {
912 case V4L2_CTRL_TYPE_INTEGER64:
913 ctrl->val64 = c->value64;
914 break;
915 case V4L2_CTRL_TYPE_STRING:
916 size = c->size;
917 if (size == 0)
918 return -ERANGE;
919 if (size > ctrl->maximum + 1)
920 size = ctrl->maximum + 1;
921 ret = copy_from_user(ctrl->string, c->string, size);
922 if (!ret) {
923 char last = ctrl->string[size - 1];
924
925 ctrl->string[size - 1] = 0;
926 /* If the string was longer than ctrl->maximum,
927 then return an error. */
928 if (strlen(ctrl->string) == ctrl->maximum && last)
929 return -ERANGE;
930 }
931 return ret ? -EFAULT : 0;
932 default:
933 ctrl->val = c->value;
934 break;
935 }
936 return 0;
937}
938
939/* Helper function: copy the new control value back to the caller */
940static int new_to_user(struct v4l2_ext_control *c,
941 struct v4l2_ctrl *ctrl)
942{
943 u32 len;
944
945 switch (ctrl->type) {
946 case V4L2_CTRL_TYPE_STRING:
947 len = strlen(ctrl->string);
948 if (c->size < len + 1) {
949 c->size = ctrl->maximum + 1;
950 return -ENOSPC;
951 }
952 return copy_to_user(c->string, ctrl->string,
953 len + 1) ? -EFAULT : 0;
954 case V4L2_CTRL_TYPE_INTEGER64:
955 c->value64 = ctrl->val64;
956 break;
957 default:
958 c->value = ctrl->val;
959 break;
960 }
961 return 0;
962}
963
964/* Copy the new value to the current value. */
Hans Verkuilab892ba2011-06-07 06:47:18 -0300965static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
966 bool update_inactive)
Hans Verkuil09965172010-08-01 14:32:42 -0300967{
Hans Verkuil6e239392011-06-07 11:13:44 -0300968 bool changed = false;
969
Hans Verkuil09965172010-08-01 14:32:42 -0300970 if (ctrl == NULL)
971 return;
972 switch (ctrl->type) {
Hans Verkuil6e239392011-06-07 11:13:44 -0300973 case V4L2_CTRL_TYPE_BUTTON:
974 changed = true;
975 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300976 case V4L2_CTRL_TYPE_STRING:
977 /* strings are always 0-terminated */
Hans Verkuil6e239392011-06-07 11:13:44 -0300978 changed = strcmp(ctrl->string, ctrl->cur.string);
Hans Verkuil09965172010-08-01 14:32:42 -0300979 strcpy(ctrl->cur.string, ctrl->string);
980 break;
981 case V4L2_CTRL_TYPE_INTEGER64:
Hans Verkuil6e239392011-06-07 11:13:44 -0300982 changed = ctrl->val64 != ctrl->cur.val64;
Hans Verkuil09965172010-08-01 14:32:42 -0300983 ctrl->cur.val64 = ctrl->val64;
984 break;
985 default:
Hans Verkuil6e239392011-06-07 11:13:44 -0300986 changed = ctrl->val != ctrl->cur.val;
Hans Verkuil09965172010-08-01 14:32:42 -0300987 ctrl->cur.val = ctrl->val;
988 break;
989 }
Hans Verkuil72d877c2011-06-10 05:44:36 -0300990 if (update_inactive) {
Hans Verkuil5626b8c2011-08-26 07:53:53 -0300991 /* Note: update_inactive can only be true for auto clusters. */
992 ctrl->flags &=
993 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
994 if (!is_cur_manual(ctrl->cluster[0])) {
Hans Verkuil72d877c2011-06-10 05:44:36 -0300995 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -0300996 if (ctrl->cluster[0]->has_volatiles)
997 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
998 }
Hans de Goede1249a3a2011-10-31 11:16:44 -0300999 fh = NULL;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001000 }
Hans Verkuil639884a2011-07-05 07:09:26 -03001001 if (changed || update_inactive) {
1002 /* If a control was changed that was not one of the controls
1003 modified by the application, then send the event to all. */
1004 if (!ctrl->is_new)
1005 fh = NULL;
Hans Verkuil6e239392011-06-07 11:13:44 -03001006 send_event(fh, ctrl,
1007 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1008 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
Hans Verkuil639884a2011-07-05 07:09:26 -03001009 }
Hans Verkuil09965172010-08-01 14:32:42 -03001010}
1011
1012/* Copy the current value to the new value */
1013static void cur_to_new(struct v4l2_ctrl *ctrl)
1014{
1015 if (ctrl == NULL)
1016 return;
1017 switch (ctrl->type) {
1018 case V4L2_CTRL_TYPE_STRING:
1019 /* strings are always 0-terminated */
1020 strcpy(ctrl->string, ctrl->cur.string);
1021 break;
1022 case V4L2_CTRL_TYPE_INTEGER64:
1023 ctrl->val64 = ctrl->cur.val64;
1024 break;
1025 default:
1026 ctrl->val = ctrl->cur.val;
1027 break;
1028 }
1029}
1030
1031/* Return non-zero if one or more of the controls in the cluster has a new
1032 value that differs from the current value. */
1033static int cluster_changed(struct v4l2_ctrl *master)
1034{
1035 int diff = 0;
1036 int i;
1037
1038 for (i = 0; !diff && i < master->ncontrols; i++) {
1039 struct v4l2_ctrl *ctrl = master->cluster[i];
1040
1041 if (ctrl == NULL)
1042 continue;
1043 switch (ctrl->type) {
1044 case V4L2_CTRL_TYPE_BUTTON:
1045 /* Button controls are always 'different' */
1046 return 1;
1047 case V4L2_CTRL_TYPE_STRING:
1048 /* strings are always 0-terminated */
1049 diff = strcmp(ctrl->string, ctrl->cur.string);
1050 break;
1051 case V4L2_CTRL_TYPE_INTEGER64:
1052 diff = ctrl->val64 != ctrl->cur.val64;
1053 break;
1054 default:
1055 diff = ctrl->val != ctrl->cur.val;
1056 break;
1057 }
1058 }
1059 return diff;
1060}
1061
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001062/* Validate integer-type control */
1063static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
Hans Verkuil09965172010-08-01 14:32:42 -03001064{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001065 s32 val = *pval;
Hans Verkuil09965172010-08-01 14:32:42 -03001066 u32 offset;
Hans Verkuil09965172010-08-01 14:32:42 -03001067
1068 switch (ctrl->type) {
1069 case V4L2_CTRL_TYPE_INTEGER:
1070 /* Round towards the closest legal value */
1071 val += ctrl->step / 2;
1072 if (val < ctrl->minimum)
1073 val = ctrl->minimum;
1074 if (val > ctrl->maximum)
1075 val = ctrl->maximum;
1076 offset = val - ctrl->minimum;
1077 offset = ctrl->step * (offset / ctrl->step);
1078 val = ctrl->minimum + offset;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001079 *pval = val;
Hans Verkuil09965172010-08-01 14:32:42 -03001080 return 0;
1081
1082 case V4L2_CTRL_TYPE_BOOLEAN:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001083 *pval = !!val;
Hans Verkuil09965172010-08-01 14:32:42 -03001084 return 0;
1085
1086 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001087 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuil09965172010-08-01 14:32:42 -03001088 if (val < ctrl->minimum || val > ctrl->maximum)
1089 return -ERANGE;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001090 if (ctrl->menu_skip_mask & (1 << val))
1091 return -EINVAL;
1092 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1093 ctrl->qmenu[val][0] == '\0')
Hans Verkuil09965172010-08-01 14:32:42 -03001094 return -EINVAL;
1095 return 0;
1096
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001097 case V4L2_CTRL_TYPE_BITMASK:
1098 *pval &= ctrl->maximum;
1099 return 0;
1100
Hans Verkuil09965172010-08-01 14:32:42 -03001101 case V4L2_CTRL_TYPE_BUTTON:
1102 case V4L2_CTRL_TYPE_CTRL_CLASS:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001103 *pval = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001104 return 0;
1105
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001106 default:
1107 return -EINVAL;
1108 }
1109}
1110
1111/* Validate a new control */
1112static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1113{
1114 char *s = c->string;
1115 size_t len;
1116
1117 switch (ctrl->type) {
1118 case V4L2_CTRL_TYPE_INTEGER:
1119 case V4L2_CTRL_TYPE_BOOLEAN:
1120 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001121 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001122 case V4L2_CTRL_TYPE_BITMASK:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001123 case V4L2_CTRL_TYPE_BUTTON:
1124 case V4L2_CTRL_TYPE_CTRL_CLASS:
1125 return validate_new_int(ctrl, &c->value);
1126
Hans Verkuil09965172010-08-01 14:32:42 -03001127 case V4L2_CTRL_TYPE_INTEGER64:
1128 return 0;
1129
1130 case V4L2_CTRL_TYPE_STRING:
1131 len = strlen(s);
1132 if (len < ctrl->minimum)
1133 return -ERANGE;
1134 if ((len - ctrl->minimum) % ctrl->step)
1135 return -ERANGE;
1136 return 0;
1137
1138 default:
1139 return -EINVAL;
1140 }
1141}
1142
1143static inline u32 node2id(struct list_head *node)
1144{
1145 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1146}
1147
1148/* Set the handler's error code if it wasn't set earlier already */
1149static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1150{
1151 if (hdl->error == 0)
1152 hdl->error = err;
1153 return err;
1154}
1155
1156/* Initialize the handler */
1157int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1158 unsigned nr_of_controls_hint)
1159{
1160 mutex_init(&hdl->lock);
1161 INIT_LIST_HEAD(&hdl->ctrls);
1162 INIT_LIST_HEAD(&hdl->ctrl_refs);
1163 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
Thomas Meyer9884d7b2011-11-29 17:08:00 -03001164 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1165 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03001166 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1167 return hdl->error;
1168}
1169EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1170
1171/* Free all controls and control refs */
1172void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1173{
1174 struct v4l2_ctrl_ref *ref, *next_ref;
1175 struct v4l2_ctrl *ctrl, *next_ctrl;
Hans Verkuil77068d32011-06-13 18:55:58 -03001176 struct v4l2_subscribed_event *sev, *next_sev;
Hans Verkuil09965172010-08-01 14:32:42 -03001177
1178 if (hdl == NULL || hdl->buckets == NULL)
1179 return;
1180
1181 mutex_lock(&hdl->lock);
1182 /* Free all nodes */
1183 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1184 list_del(&ref->node);
1185 kfree(ref);
1186 }
1187 /* Free all controls owned by the handler */
1188 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1189 list_del(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001190 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1191 list_del(&sev->node);
Hans Verkuil09965172010-08-01 14:32:42 -03001192 kfree(ctrl);
1193 }
1194 kfree(hdl->buckets);
1195 hdl->buckets = NULL;
1196 hdl->cached = NULL;
1197 hdl->error = 0;
1198 mutex_unlock(&hdl->lock);
1199}
1200EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1201
1202/* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1203 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1204 with applications that do not use the NEXT_CTRL flag.
1205
1206 We just find the n-th private user control. It's O(N), but that should not
1207 be an issue in this particular case. */
1208static struct v4l2_ctrl_ref *find_private_ref(
1209 struct v4l2_ctrl_handler *hdl, u32 id)
1210{
1211 struct v4l2_ctrl_ref *ref;
1212
1213 id -= V4L2_CID_PRIVATE_BASE;
1214 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1215 /* Search for private user controls that are compatible with
1216 VIDIOC_G/S_CTRL. */
1217 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1218 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1219 if (!type_is_int(ref->ctrl))
1220 continue;
1221 if (id == 0)
1222 return ref;
1223 id--;
1224 }
1225 }
1226 return NULL;
1227}
1228
1229/* Find a control with the given ID. */
1230static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1231{
1232 struct v4l2_ctrl_ref *ref;
1233 int bucket;
1234
1235 id &= V4L2_CTRL_ID_MASK;
1236
1237 /* Old-style private controls need special handling */
1238 if (id >= V4L2_CID_PRIVATE_BASE)
1239 return find_private_ref(hdl, id);
1240 bucket = id % hdl->nr_of_buckets;
1241
1242 /* Simple optimization: cache the last control found */
1243 if (hdl->cached && hdl->cached->ctrl->id == id)
1244 return hdl->cached;
1245
1246 /* Not in cache, search the hash */
1247 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1248 while (ref && ref->ctrl->id != id)
1249 ref = ref->next;
1250
1251 if (ref)
1252 hdl->cached = ref; /* cache it! */
1253 return ref;
1254}
1255
1256/* Find a control with the given ID. Take the handler's lock first. */
1257static struct v4l2_ctrl_ref *find_ref_lock(
1258 struct v4l2_ctrl_handler *hdl, u32 id)
1259{
1260 struct v4l2_ctrl_ref *ref = NULL;
1261
1262 if (hdl) {
1263 mutex_lock(&hdl->lock);
1264 ref = find_ref(hdl, id);
1265 mutex_unlock(&hdl->lock);
1266 }
1267 return ref;
1268}
1269
1270/* Find a control with the given ID. */
1271struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1272{
1273 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1274
1275 return ref ? ref->ctrl : NULL;
1276}
1277EXPORT_SYMBOL(v4l2_ctrl_find);
1278
1279/* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1280static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1281 struct v4l2_ctrl *ctrl)
1282{
1283 struct v4l2_ctrl_ref *ref;
1284 struct v4l2_ctrl_ref *new_ref;
1285 u32 id = ctrl->id;
1286 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1287 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1288
1289 /* Automatically add the control class if it is not yet present. */
1290 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1291 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1292 return hdl->error;
1293
1294 if (hdl->error)
1295 return hdl->error;
1296
1297 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1298 if (!new_ref)
1299 return handler_set_err(hdl, -ENOMEM);
1300 new_ref->ctrl = ctrl;
1301 if (ctrl->handler == hdl) {
1302 /* By default each control starts in a cluster of its own.
1303 new_ref->ctrl is basically a cluster array with one
1304 element, so that's perfect to use as the cluster pointer.
1305 But only do this for the handler that owns the control. */
1306 ctrl->cluster = &new_ref->ctrl;
1307 ctrl->ncontrols = 1;
1308 }
1309
1310 INIT_LIST_HEAD(&new_ref->node);
1311
1312 mutex_lock(&hdl->lock);
1313
1314 /* Add immediately at the end of the list if the list is empty, or if
1315 the last element in the list has a lower ID.
1316 This ensures that when elements are added in ascending order the
1317 insertion is an O(1) operation. */
1318 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1319 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1320 goto insert_in_hash;
1321 }
1322
1323 /* Find insert position in sorted list */
1324 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1325 if (ref->ctrl->id < id)
1326 continue;
1327 /* Don't add duplicates */
1328 if (ref->ctrl->id == id) {
1329 kfree(new_ref);
1330 goto unlock;
1331 }
1332 list_add(&new_ref->node, ref->node.prev);
1333 break;
1334 }
1335
1336insert_in_hash:
1337 /* Insert the control node in the hash */
1338 new_ref->next = hdl->buckets[bucket];
1339 hdl->buckets[bucket] = new_ref;
1340
1341unlock:
1342 mutex_unlock(&hdl->lock);
1343 return 0;
1344}
1345
1346/* Add a new control */
1347static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1348 const struct v4l2_ctrl_ops *ops,
1349 u32 id, const char *name, enum v4l2_ctrl_type type,
1350 s32 min, s32 max, u32 step, s32 def,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001351 u32 flags, const char * const *qmenu,
1352 const s64 *qmenu_int, void *priv)
Hans Verkuil09965172010-08-01 14:32:42 -03001353{
1354 struct v4l2_ctrl *ctrl;
1355 unsigned sz_extra = 0;
1356
1357 if (hdl->error)
1358 return NULL;
1359
1360 /* Sanity checks */
1361 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
Hans Verkuil09965172010-08-01 14:32:42 -03001362 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001363 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001364 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001365 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001366 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1367 handler_set_err(hdl, -ERANGE);
1368 return NULL;
1369 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001370 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1371 handler_set_err(hdl, -ERANGE);
1372 return NULL;
1373 }
Hans Verkuil02ac0482010-12-29 14:27:05 -03001374 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1375 type == V4L2_CTRL_TYPE_MENU ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001376 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
Hans Verkuil02ac0482010-12-29 14:27:05 -03001377 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1378 (def < min || def > max)) {
1379 handler_set_err(hdl, -ERANGE);
1380 return NULL;
1381 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001382 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1383 handler_set_err(hdl, -ERANGE);
1384 return NULL;
1385 }
Hans Verkuil09965172010-08-01 14:32:42 -03001386
1387 if (type == V4L2_CTRL_TYPE_BUTTON)
1388 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1389 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1390 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1391 else if (type == V4L2_CTRL_TYPE_STRING)
1392 sz_extra += 2 * (max + 1);
1393
1394 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1395 if (ctrl == NULL) {
1396 handler_set_err(hdl, -ENOMEM);
1397 return NULL;
1398 }
1399
1400 INIT_LIST_HEAD(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001401 INIT_LIST_HEAD(&ctrl->ev_subs);
Hans Verkuil09965172010-08-01 14:32:42 -03001402 ctrl->handler = hdl;
1403 ctrl->ops = ops;
1404 ctrl->id = id;
1405 ctrl->name = name;
1406 ctrl->type = type;
1407 ctrl->flags = flags;
1408 ctrl->minimum = min;
1409 ctrl->maximum = max;
1410 ctrl->step = step;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001411 if (type == V4L2_CTRL_TYPE_MENU)
1412 ctrl->qmenu = qmenu;
1413 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1414 ctrl->qmenu_int = qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001415 ctrl->priv = priv;
1416 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1417
1418 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1419 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1420 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1421 if (ctrl->minimum)
1422 memset(ctrl->cur.string, ' ', ctrl->minimum);
1423 }
1424 if (handler_new_ref(hdl, ctrl)) {
1425 kfree(ctrl);
1426 return NULL;
1427 }
1428 mutex_lock(&hdl->lock);
1429 list_add_tail(&ctrl->node, &hdl->ctrls);
1430 mutex_unlock(&hdl->lock);
1431 return ctrl;
1432}
1433
1434struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1435 const struct v4l2_ctrl_config *cfg, void *priv)
1436{
1437 bool is_menu;
1438 struct v4l2_ctrl *ctrl;
1439 const char *name = cfg->name;
Hans Verkuil513521e2010-12-29 14:25:52 -03001440 const char * const *qmenu = cfg->qmenu;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001441 const s64 *qmenu_int = cfg->qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001442 enum v4l2_ctrl_type type = cfg->type;
1443 u32 flags = cfg->flags;
1444 s32 min = cfg->min;
1445 s32 max = cfg->max;
1446 u32 step = cfg->step;
1447 s32 def = cfg->def;
1448
1449 if (name == NULL)
1450 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1451 &def, &flags);
1452
Sakari Ailusce580fe2011-08-04 13:51:11 -03001453 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1454 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
Hans Verkuil09965172010-08-01 14:32:42 -03001455 if (is_menu)
1456 WARN_ON(step);
1457 else
1458 WARN_ON(cfg->menu_skip_mask);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001459 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001460 qmenu = v4l2_ctrl_get_menu(cfg->id);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001461 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1462 qmenu_int == NULL) {
1463 handler_set_err(hdl, -EINVAL);
1464 return NULL;
1465 }
Hans Verkuil09965172010-08-01 14:32:42 -03001466
1467 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1468 type, min, max,
1469 is_menu ? cfg->menu_skip_mask : step,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001470 def, flags, qmenu, qmenu_int, priv);
Hans Verkuil88365102011-08-26 07:35:14 -03001471 if (ctrl)
Hans Verkuil09965172010-08-01 14:32:42 -03001472 ctrl->is_private = cfg->is_private;
Hans Verkuil09965172010-08-01 14:32:42 -03001473 return ctrl;
1474}
1475EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1476
1477/* Helper function for standard non-menu controls */
1478struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1479 const struct v4l2_ctrl_ops *ops,
1480 u32 id, s32 min, s32 max, u32 step, s32 def)
1481{
1482 const char *name;
1483 enum v4l2_ctrl_type type;
1484 u32 flags;
1485
1486 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001487 if (type == V4L2_CTRL_TYPE_MENU
1488 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
Hans Verkuil09965172010-08-01 14:32:42 -03001489 handler_set_err(hdl, -EINVAL);
1490 return NULL;
1491 }
1492 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001493 min, max, step, def, flags, NULL, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001494}
1495EXPORT_SYMBOL(v4l2_ctrl_new_std);
1496
1497/* Helper function for standard menu controls */
1498struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1499 const struct v4l2_ctrl_ops *ops,
1500 u32 id, s32 max, s32 mask, s32 def)
1501{
Hans Verkuil513521e2010-12-29 14:25:52 -03001502 const char * const *qmenu = v4l2_ctrl_get_menu(id);
Hans Verkuil09965172010-08-01 14:32:42 -03001503 const char *name;
1504 enum v4l2_ctrl_type type;
1505 s32 min;
1506 s32 step;
1507 u32 flags;
1508
1509 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1510 if (type != V4L2_CTRL_TYPE_MENU) {
1511 handler_set_err(hdl, -EINVAL);
1512 return NULL;
1513 }
1514 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001515 0, max, mask, def, flags, qmenu, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001516}
1517EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1518
1519/* Add a control from another handler to this handler */
1520struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1521 struct v4l2_ctrl *ctrl)
1522{
1523 if (hdl == NULL || hdl->error)
1524 return NULL;
1525 if (ctrl == NULL) {
1526 handler_set_err(hdl, -EINVAL);
1527 return NULL;
1528 }
1529 if (ctrl->handler == hdl)
1530 return ctrl;
1531 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1532}
1533EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1534
1535/* Add the controls from another handler to our own. */
1536int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1537 struct v4l2_ctrl_handler *add)
1538{
Hans Verkuil072e6602012-03-02 12:41:25 -03001539 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001540 int ret = 0;
1541
1542 /* Do nothing if either handler is NULL or if they are the same */
1543 if (!hdl || !add || hdl == add)
1544 return 0;
1545 if (hdl->error)
1546 return hdl->error;
1547 mutex_lock(&add->lock);
Hans Verkuil072e6602012-03-02 12:41:25 -03001548 list_for_each_entry(ref, &add->ctrl_refs, node) {
1549 struct v4l2_ctrl *ctrl = ref->ctrl;
1550
Hans Verkuil09965172010-08-01 14:32:42 -03001551 /* Skip handler-private controls. */
1552 if (ctrl->is_private)
1553 continue;
Hans Verkuil6e239392011-06-07 11:13:44 -03001554 /* And control classes */
1555 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1556 continue;
Hans Verkuil09965172010-08-01 14:32:42 -03001557 ret = handler_new_ref(hdl, ctrl);
1558 if (ret)
1559 break;
1560 }
1561 mutex_unlock(&add->lock);
1562 return ret;
1563}
1564EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1565
1566/* Cluster controls */
1567void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1568{
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001569 bool has_volatiles = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001570 int i;
1571
1572 /* The first control is the master control and it must not be NULL */
Hans Verkuil72d877c2011-06-10 05:44:36 -03001573 BUG_ON(ncontrols == 0 || controls[0] == NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001574
1575 for (i = 0; i < ncontrols; i++) {
1576 if (controls[i]) {
1577 controls[i]->cluster = controls;
1578 controls[i]->ncontrols = ncontrols;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001579 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1580 has_volatiles = true;
Hans Verkuil09965172010-08-01 14:32:42 -03001581 }
1582 }
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001583 controls[0]->has_volatiles = has_volatiles;
Hans Verkuil09965172010-08-01 14:32:42 -03001584}
1585EXPORT_SYMBOL(v4l2_ctrl_cluster);
1586
Hans Verkuil72d877c2011-06-10 05:44:36 -03001587void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1588 u8 manual_val, bool set_volatile)
1589{
1590 struct v4l2_ctrl *master = controls[0];
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001591 u32 flag = 0;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001592 int i;
1593
1594 v4l2_ctrl_cluster(ncontrols, controls);
1595 WARN_ON(ncontrols <= 1);
Hans Verkuil82a7c042011-06-28 10:43:13 -03001596 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001597 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
Hans Verkuil72d877c2011-06-10 05:44:36 -03001598 master->is_auto = true;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001599 master->has_volatiles = set_volatile;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001600 master->manual_mode_value = manual_val;
1601 master->flags |= V4L2_CTRL_FLAG_UPDATE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001602
1603 if (!is_cur_manual(master))
1604 flag = V4L2_CTRL_FLAG_INACTIVE |
1605 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03001606
1607 for (i = 1; i < ncontrols; i++)
Hans Verkuil88365102011-08-26 07:35:14 -03001608 if (controls[i])
Hans Verkuil72d877c2011-06-10 05:44:36 -03001609 controls[i]->flags |= flag;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001610}
1611EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1612
Hans Verkuil09965172010-08-01 14:32:42 -03001613/* Activate/deactivate a control. */
1614void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1615{
Hans Verkuil6e239392011-06-07 11:13:44 -03001616 /* invert since the actual flag is called 'inactive' */
1617 bool inactive = !active;
1618 bool old;
1619
Hans Verkuil09965172010-08-01 14:32:42 -03001620 if (ctrl == NULL)
1621 return;
1622
Hans Verkuil6e239392011-06-07 11:13:44 -03001623 if (inactive)
Hans Verkuil09965172010-08-01 14:32:42 -03001624 /* set V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001625 old = test_and_set_bit(4, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001626 else
1627 /* clear V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001628 old = test_and_clear_bit(4, &ctrl->flags);
1629 if (old != inactive)
1630 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
Hans Verkuil09965172010-08-01 14:32:42 -03001631}
1632EXPORT_SYMBOL(v4l2_ctrl_activate);
1633
1634/* Grab/ungrab a control.
1635 Typically used when streaming starts and you want to grab controls,
1636 preventing the user from changing them.
1637
1638 Just call this and the framework will block any attempts to change
1639 these controls. */
1640void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1641{
Hans Verkuil6e239392011-06-07 11:13:44 -03001642 bool old;
1643
Hans Verkuil09965172010-08-01 14:32:42 -03001644 if (ctrl == NULL)
1645 return;
1646
Hans Verkuil6e239392011-06-07 11:13:44 -03001647 v4l2_ctrl_lock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001648 if (grabbed)
1649 /* set V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001650 old = test_and_set_bit(1, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001651 else
1652 /* clear V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001653 old = test_and_clear_bit(1, &ctrl->flags);
1654 if (old != grabbed)
1655 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1656 v4l2_ctrl_unlock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001657}
1658EXPORT_SYMBOL(v4l2_ctrl_grab);
1659
1660/* Log the control name and value */
1661static void log_ctrl(const struct v4l2_ctrl *ctrl,
1662 const char *prefix, const char *colon)
1663{
Hans Verkuil09965172010-08-01 14:32:42 -03001664 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1665 return;
1666 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1667 return;
1668
1669 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1670
1671 switch (ctrl->type) {
1672 case V4L2_CTRL_TYPE_INTEGER:
1673 printk(KERN_CONT "%d", ctrl->cur.val);
1674 break;
1675 case V4L2_CTRL_TYPE_BOOLEAN:
1676 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1677 break;
1678 case V4L2_CTRL_TYPE_MENU:
1679 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1680 break;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001681 case V4L2_CTRL_TYPE_INTEGER_MENU:
1682 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1683 break;
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001684 case V4L2_CTRL_TYPE_BITMASK:
1685 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1686 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001687 case V4L2_CTRL_TYPE_INTEGER64:
1688 printk(KERN_CONT "%lld", ctrl->cur.val64);
1689 break;
1690 case V4L2_CTRL_TYPE_STRING:
1691 printk(KERN_CONT "%s", ctrl->cur.string);
1692 break;
1693 default:
1694 printk(KERN_CONT "unknown type %d", ctrl->type);
1695 break;
1696 }
Hans Verkuil88365102011-08-26 07:35:14 -03001697 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1698 V4L2_CTRL_FLAG_GRABBED |
1699 V4L2_CTRL_FLAG_VOLATILE)) {
1700 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1701 printk(KERN_CONT " inactive");
1702 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1703 printk(KERN_CONT " grabbed");
1704 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1705 printk(KERN_CONT " volatile");
1706 }
1707 printk(KERN_CONT "\n");
Hans Verkuil09965172010-08-01 14:32:42 -03001708}
1709
1710/* Log all controls owned by the handler */
1711void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1712 const char *prefix)
1713{
1714 struct v4l2_ctrl *ctrl;
1715 const char *colon = "";
1716 int len;
1717
1718 if (hdl == NULL)
1719 return;
1720 if (prefix == NULL)
1721 prefix = "";
1722 len = strlen(prefix);
1723 if (len && prefix[len - 1] != ' ')
1724 colon = ": ";
1725 mutex_lock(&hdl->lock);
1726 list_for_each_entry(ctrl, &hdl->ctrls, node)
1727 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1728 log_ctrl(ctrl, prefix, colon);
1729 mutex_unlock(&hdl->lock);
1730}
1731EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1732
1733/* Call s_ctrl for all controls owned by the handler */
1734int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1735{
1736 struct v4l2_ctrl *ctrl;
1737 int ret = 0;
1738
1739 if (hdl == NULL)
1740 return 0;
1741 mutex_lock(&hdl->lock);
1742 list_for_each_entry(ctrl, &hdl->ctrls, node)
1743 ctrl->done = false;
1744
1745 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1746 struct v4l2_ctrl *master = ctrl->cluster[0];
1747 int i;
1748
1749 /* Skip if this control was already handled by a cluster. */
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001750 /* Skip button controls and read-only controls. */
1751 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1752 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
Hans Verkuil09965172010-08-01 14:32:42 -03001753 continue;
1754
Hans Verkuil2a863792011-01-11 14:45:03 -03001755 for (i = 0; i < master->ncontrols; i++) {
1756 if (master->cluster[i]) {
1757 cur_to_new(master->cluster[i]);
1758 master->cluster[i]->is_new = 1;
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001759 master->cluster[i]->done = true;
Hans Verkuil2a863792011-01-11 14:45:03 -03001760 }
1761 }
Hans Verkuil54c911e2011-05-25 06:04:58 -03001762 ret = call_op(master, s_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001763 if (ret)
1764 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001765 }
1766 mutex_unlock(&hdl->lock);
1767 return ret;
1768}
1769EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1770
1771/* Implement VIDIOC_QUERYCTRL */
1772int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1773{
1774 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1775 struct v4l2_ctrl_ref *ref;
1776 struct v4l2_ctrl *ctrl;
1777
1778 if (hdl == NULL)
1779 return -EINVAL;
1780
1781 mutex_lock(&hdl->lock);
1782
1783 /* Try to find it */
1784 ref = find_ref(hdl, id);
1785
1786 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1787 /* Find the next control with ID > qc->id */
1788
1789 /* Did we reach the end of the control list? */
1790 if (id >= node2id(hdl->ctrl_refs.prev)) {
1791 ref = NULL; /* Yes, so there is no next control */
1792 } else if (ref) {
1793 /* We found a control with the given ID, so just get
1794 the next one in the list. */
1795 ref = list_entry(ref->node.next, typeof(*ref), node);
1796 } else {
1797 /* No control with the given ID exists, so start
1798 searching for the next largest ID. We know there
1799 is one, otherwise the first 'if' above would have
1800 been true. */
1801 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1802 if (id < ref->ctrl->id)
1803 break;
1804 }
1805 }
1806 mutex_unlock(&hdl->lock);
1807 if (!ref)
1808 return -EINVAL;
1809
1810 ctrl = ref->ctrl;
1811 memset(qc, 0, sizeof(*qc));
Hans Verkuil829fb2d2011-01-16 11:21:40 -03001812 if (id >= V4L2_CID_PRIVATE_BASE)
1813 qc->id = id;
1814 else
1815 qc->id = ctrl->id;
Hans Verkuil09965172010-08-01 14:32:42 -03001816 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1817 qc->minimum = ctrl->minimum;
1818 qc->maximum = ctrl->maximum;
1819 qc->default_value = ctrl->default_value;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001820 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1821 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil09965172010-08-01 14:32:42 -03001822 qc->step = 1;
1823 else
1824 qc->step = ctrl->step;
1825 qc->flags = ctrl->flags;
1826 qc->type = ctrl->type;
1827 return 0;
1828}
1829EXPORT_SYMBOL(v4l2_queryctrl);
1830
1831int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1832{
Hans Verkuil87a0c942011-02-22 12:31:07 -03001833 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1834 return -EINVAL;
Hans Verkuil09965172010-08-01 14:32:42 -03001835 return v4l2_queryctrl(sd->ctrl_handler, qc);
1836}
1837EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1838
1839/* Implement VIDIOC_QUERYMENU */
1840int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1841{
1842 struct v4l2_ctrl *ctrl;
1843 u32 i = qm->index;
1844
1845 ctrl = v4l2_ctrl_find(hdl, qm->id);
1846 if (!ctrl)
1847 return -EINVAL;
1848
1849 qm->reserved = 0;
1850 /* Sanity checks */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001851 switch (ctrl->type) {
1852 case V4L2_CTRL_TYPE_MENU:
1853 if (ctrl->qmenu == NULL)
1854 return -EINVAL;
1855 break;
1856 case V4L2_CTRL_TYPE_INTEGER_MENU:
1857 if (ctrl->qmenu_int == NULL)
1858 return -EINVAL;
1859 break;
1860 default:
Hans Verkuil09965172010-08-01 14:32:42 -03001861 return -EINVAL;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001862 }
1863
1864 if (i < ctrl->minimum || i > ctrl->maximum)
1865 return -EINVAL;
1866
Hans Verkuil09965172010-08-01 14:32:42 -03001867 /* Use mask to see if this menu item should be skipped */
1868 if (ctrl->menu_skip_mask & (1 << i))
1869 return -EINVAL;
1870 /* Empty menu items should also be skipped */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001871 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
1872 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1873 return -EINVAL;
1874 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1875 } else {
1876 qm->value = ctrl->qmenu_int[i];
1877 }
Hans Verkuil09965172010-08-01 14:32:42 -03001878 return 0;
1879}
1880EXPORT_SYMBOL(v4l2_querymenu);
1881
1882int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1883{
1884 return v4l2_querymenu(sd->ctrl_handler, qm);
1885}
1886EXPORT_SYMBOL(v4l2_subdev_querymenu);
1887
1888
1889
1890/* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1891
1892 It is not a fully atomic operation, just best-effort only. After all, if
1893 multiple controls have to be set through multiple i2c writes (for example)
1894 then some initial writes may succeed while others fail. Thus leaving the
1895 system in an inconsistent state. The question is how much effort you are
1896 willing to spend on trying to make something atomic that really isn't.
1897
1898 From the point of view of an application the main requirement is that
1899 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1900 error should be returned without actually affecting any controls.
1901
1902 If all the values are correct, then it is acceptable to just give up
1903 in case of low-level errors.
1904
1905 It is important though that the application can tell when only a partial
1906 configuration was done. The way we do that is through the error_idx field
1907 of struct v4l2_ext_controls: if that is equal to the count field then no
1908 controls were affected. Otherwise all controls before that index were
1909 successful in performing their 'get' or 'set' operation, the control at
1910 the given index failed, and you don't know what happened with the controls
1911 after the failed one. Since if they were part of a control cluster they
1912 could have been successfully processed (if a cluster member was encountered
1913 at index < error_idx), they could have failed (if a cluster member was at
1914 error_idx), or they may not have been processed yet (if the first cluster
1915 member appeared after error_idx).
1916
1917 It is all fairly theoretical, though. In practice all you can do is to
1918 bail out. If error_idx == count, then it is an application bug. If
1919 error_idx < count then it is only an application bug if the error code was
1920 EBUSY. That usually means that something started streaming just when you
1921 tried to set the controls. In all other cases it is a driver/hardware
1922 problem and all you can do is to retry or bail out.
1923
1924 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1925 never modifies controls the error_idx is just set to whatever control
1926 has an invalid value.
1927 */
1928
1929/* Prepare for the extended g/s/try functions.
1930 Find the controls in the control array and do some basic checks. */
1931static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1932 struct v4l2_ext_controls *cs,
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001933 struct v4l2_ctrl_helper *helpers)
Hans Verkuil09965172010-08-01 14:32:42 -03001934{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001935 struct v4l2_ctrl_helper *h;
1936 bool have_clusters = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001937 u32 i;
1938
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001939 for (i = 0, h = helpers; i < cs->count; i++, h++) {
Hans Verkuil09965172010-08-01 14:32:42 -03001940 struct v4l2_ext_control *c = &cs->controls[i];
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001941 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001942 struct v4l2_ctrl *ctrl;
1943 u32 id = c->id & V4L2_CTRL_ID_MASK;
1944
Hans Verkuil37cd3b72011-06-07 04:40:04 -03001945 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03001946
1947 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1948 return -EINVAL;
1949
1950 /* Old-style private controls are not allowed for
1951 extended controls */
1952 if (id >= V4L2_CID_PRIVATE_BASE)
1953 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001954 ref = find_ref_lock(hdl, id);
1955 if (ref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001956 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001957 ctrl = ref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03001958 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1959 return -EINVAL;
1960
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001961 if (ctrl->cluster[0]->ncontrols > 1)
1962 have_clusters = true;
1963 if (ctrl->cluster[0] != ctrl)
1964 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1965 /* Store the ref to the master control of the cluster */
1966 h->mref = ref;
1967 h->ctrl = ctrl;
1968 /* Initially set next to 0, meaning that there is no other
1969 control in this helper array belonging to the same
1970 cluster */
1971 h->next = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001972 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001973
1974 /* We are done if there were no controls that belong to a multi-
1975 control cluster. */
1976 if (!have_clusters)
1977 return 0;
1978
1979 /* The code below figures out in O(n) time which controls in the list
1980 belong to the same cluster. */
1981
1982 /* This has to be done with the handler lock taken. */
1983 mutex_lock(&hdl->lock);
1984
1985 /* First zero the helper field in the master control references */
1986 for (i = 0; i < cs->count; i++)
1987 helpers[i].mref->helper = 0;
1988 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1989 struct v4l2_ctrl_ref *mref = h->mref;
1990
1991 /* If the mref->helper is set, then it points to an earlier
1992 helper that belongs to the same cluster. */
1993 if (mref->helper) {
1994 /* Set the next field of mref->helper to the current
1995 index: this means that that earlier helper now
1996 points to the next helper in the same cluster. */
1997 mref->helper->next = i;
1998 /* mref should be set only for the first helper in the
1999 cluster, clear the others. */
2000 h->mref = NULL;
2001 }
2002 /* Point the mref helper to the current helper struct. */
2003 mref->helper = h;
2004 }
2005 mutex_unlock(&hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03002006 return 0;
2007}
2008
Hans Verkuil09965172010-08-01 14:32:42 -03002009/* Handles the corner case where cs->count == 0. It checks whether the
2010 specified control class exists. If that class ID is 0, then it checks
2011 whether there are any controls at all. */
2012static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2013{
2014 if (ctrl_class == 0)
2015 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2016 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2017}
2018
2019
2020
2021/* Get extended controls. Allocates the helpers array if needed. */
2022int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2023{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002024 struct v4l2_ctrl_helper helper[4];
2025 struct v4l2_ctrl_helper *helpers = helper;
Hans Verkuil09965172010-08-01 14:32:42 -03002026 int ret;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002027 int i, j;
Hans Verkuil09965172010-08-01 14:32:42 -03002028
2029 cs->error_idx = cs->count;
2030 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2031
2032 if (hdl == NULL)
2033 return -EINVAL;
2034
2035 if (cs->count == 0)
2036 return class_check(hdl, cs->ctrl_class);
2037
2038 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang5f0049b2012-04-06 09:32:36 -03002039 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2040 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03002041 if (helpers == NULL)
2042 return -ENOMEM;
2043 }
2044
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002045 ret = prepare_ext_ctrls(hdl, cs, helpers);
2046 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002047
2048 for (i = 0; !ret && i < cs->count; i++)
2049 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2050 ret = -EACCES;
2051
2052 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002053 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2054 struct v4l2_ctrl *ctrl) = cur_to_user;
2055 struct v4l2_ctrl *master;
Hans Verkuil09965172010-08-01 14:32:42 -03002056
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002057 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002058 continue;
2059
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002060 master = helpers[i].mref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03002061 cs->error_idx = i;
2062
2063 v4l2_ctrl_lock(master);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002064
2065 /* g_volatile_ctrl will update the new control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002066 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2067 (master->has_volatiles && !is_cur_manual(master))) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002068 for (j = 0; j < master->ncontrols; j++)
2069 cur_to_new(master->cluster[j]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002070 ret = call_op(master, g_volatile_ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002071 ctrl_to_user = new_to_user;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002072 }
2073 /* If OK, then copy the current (for non-volatile controls)
2074 or the new (for volatile controls) control values to the
2075 caller */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002076 if (!ret) {
2077 u32 idx = i;
2078
2079 do {
2080 ret = ctrl_to_user(cs->controls + idx,
2081 helpers[idx].ctrl);
2082 idx = helpers[idx].next;
2083 } while (!ret && idx);
2084 }
Hans Verkuil09965172010-08-01 14:32:42 -03002085 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002086 }
2087
2088 if (cs->count > ARRAY_SIZE(helper))
2089 kfree(helpers);
2090 return ret;
2091}
2092EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2093
2094int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2095{
2096 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2097}
2098EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2099
2100/* Helper function to get a single control */
2101static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2102{
2103 struct v4l2_ctrl *master = ctrl->cluster[0];
2104 int ret = 0;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002105 int i;
Hans Verkuil09965172010-08-01 14:32:42 -03002106
2107 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2108 return -EACCES;
2109
2110 v4l2_ctrl_lock(master);
2111 /* g_volatile_ctrl will update the current control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002112 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002113 for (i = 0; i < master->ncontrols; i++)
2114 cur_to_new(master->cluster[i]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002115 ret = call_op(master, g_volatile_ctrl);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002116 *val = ctrl->val;
2117 } else {
2118 *val = ctrl->cur.val;
2119 }
Hans Verkuil09965172010-08-01 14:32:42 -03002120 v4l2_ctrl_unlock(master);
2121 return ret;
2122}
2123
2124int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2125{
2126 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2127
2128 if (ctrl == NULL || !type_is_int(ctrl))
2129 return -EINVAL;
2130 return get_ctrl(ctrl, &control->value);
2131}
2132EXPORT_SYMBOL(v4l2_g_ctrl);
2133
2134int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2135{
2136 return v4l2_g_ctrl(sd->ctrl_handler, control);
2137}
2138EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2139
2140s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2141{
2142 s32 val = 0;
2143
2144 /* It's a driver bug if this happens. */
2145 WARN_ON(!type_is_int(ctrl));
2146 get_ctrl(ctrl, &val);
2147 return val;
2148}
2149EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2150
2151
2152/* Core function that calls try/s_ctrl and ensures that the new value is
2153 copied to the current value on a set.
2154 Must be called with ctrl->handler->lock held. */
Hans Verkuile6402582011-06-14 10:56:42 -03002155static int try_or_set_cluster(struct v4l2_fh *fh,
2156 struct v4l2_ctrl *master, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002157{
Hans Verkuil72d877c2011-06-10 05:44:36 -03002158 bool update_flag;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002159 int ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002160 int i;
2161
2162 /* Go through the cluster and either validate the new value or
2163 (if no new value was set), copy the current value to the new
2164 value, ensuring a consistent view for the control ops when
2165 called. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002166 for (i = 0; i < master->ncontrols; i++) {
Hans Verkuil09965172010-08-01 14:32:42 -03002167 struct v4l2_ctrl *ctrl = master->cluster[i];
2168
2169 if (ctrl == NULL)
2170 continue;
2171
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002172 if (!ctrl->is_new) {
2173 cur_to_new(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002174 continue;
2175 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002176 /* Check again: it may have changed since the
2177 previous check in try_or_set_ext_ctrls(). */
2178 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2179 return -EBUSY;
Hans Verkuil09965172010-08-01 14:32:42 -03002180 }
2181
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002182 ret = call_op(master, try_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002183
2184 /* Don't set if there is no change */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002185 if (ret || !set || !cluster_changed(master))
2186 return ret;
2187 ret = call_op(master, s_ctrl);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002188 if (ret)
2189 return ret;
2190
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002191 /* If OK, then make the new values permanent. */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002192 update_flag = is_cur_manual(master) != is_new_manual(master);
2193 for (i = 0; i < master->ncontrols; i++)
Hans Verkuilab892ba2011-06-07 06:47:18 -03002194 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002195 return 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002196}
2197
Hans Verkuile6402582011-06-14 10:56:42 -03002198/* Validate controls. */
2199static int validate_ctrls(struct v4l2_ext_controls *cs,
2200 struct v4l2_ctrl_helper *helpers, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002201{
Hans Verkuile6402582011-06-14 10:56:42 -03002202 unsigned i;
Hans Verkuil09965172010-08-01 14:32:42 -03002203 int ret = 0;
2204
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002205 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002206 for (i = 0; i < cs->count; i++) {
2207 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2208
Hans Verkuile6402582011-06-14 10:56:42 -03002209 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002210
2211 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2212 return -EACCES;
2213 /* This test is also done in try_set_control_cluster() which
2214 is called in atomic context, so that has the final say,
2215 but it makes sense to do an up-front check as well. Once
2216 an error occurs in try_set_control_cluster() some other
2217 controls may have been set already and we want to do a
2218 best-effort to avoid that. */
2219 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2220 return -EBUSY;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002221 ret = validate_new(ctrl, &cs->controls[i]);
2222 if (ret)
2223 return ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002224 }
Hans Verkuile6402582011-06-14 10:56:42 -03002225 return 0;
2226}
Hans Verkuil09965172010-08-01 14:32:42 -03002227
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002228/* Obtain the current volatile values of an autocluster and mark them
2229 as new. */
2230static void update_from_auto_cluster(struct v4l2_ctrl *master)
2231{
2232 int i;
2233
2234 for (i = 0; i < master->ncontrols; i++)
2235 cur_to_new(master->cluster[i]);
2236 if (!call_op(master, g_volatile_ctrl))
2237 for (i = 1; i < master->ncontrols; i++)
2238 if (master->cluster[i])
2239 master->cluster[i]->is_new = 1;
2240}
2241
Hans Verkuile6402582011-06-14 10:56:42 -03002242/* Try or try-and-set controls */
2243static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2244 struct v4l2_ext_controls *cs,
2245 bool set)
2246{
2247 struct v4l2_ctrl_helper helper[4];
2248 struct v4l2_ctrl_helper *helpers = helper;
2249 unsigned i, j;
2250 int ret;
2251
2252 cs->error_idx = cs->count;
2253 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2254
2255 if (hdl == NULL)
2256 return -EINVAL;
2257
2258 if (cs->count == 0)
2259 return class_check(hdl, cs->ctrl_class);
2260
2261 if (cs->count > ARRAY_SIZE(helper)) {
2262 helpers = kmalloc(sizeof(helper[0]) * cs->count, GFP_KERNEL);
2263 if (!helpers)
2264 return -ENOMEM;
2265 }
2266 ret = prepare_ext_ctrls(hdl, cs, helpers);
2267 if (!ret)
2268 ret = validate_ctrls(cs, helpers, set);
2269 if (ret && set)
2270 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002271 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002272 struct v4l2_ctrl *master;
2273 u32 idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002274
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002275 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002276 continue;
2277
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002278 cs->error_idx = i;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002279 master = helpers[i].mref->ctrl;
2280 v4l2_ctrl_lock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002281
Hans Verkuil2a863792011-01-11 14:45:03 -03002282 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002283 for (j = 0; j < master->ncontrols; j++)
2284 if (master->cluster[j])
Hans Verkuil2a863792011-01-11 14:45:03 -03002285 master->cluster[j]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002286
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002287 /* For volatile autoclusters that are currently in auto mode
2288 we need to discover if it will be set to manual mode.
2289 If so, then we have to copy the current volatile values
2290 first since those will become the new manual values (which
2291 may be overwritten by explicit new values from this set
2292 of controls). */
2293 if (master->is_auto && master->has_volatiles &&
2294 !is_cur_manual(master)) {
2295 /* Pick an initial non-manual value */
2296 s32 new_auto_val = master->manual_mode_value + 1;
2297 u32 tmp_idx = idx;
2298
2299 do {
2300 /* Check if the auto control is part of the
2301 list, and remember the new value. */
2302 if (helpers[tmp_idx].ctrl == master)
2303 new_auto_val = cs->controls[tmp_idx].value;
2304 tmp_idx = helpers[tmp_idx].next;
2305 } while (tmp_idx);
2306 /* If the new value == the manual value, then copy
2307 the current volatile values. */
2308 if (new_auto_val == master->manual_mode_value)
2309 update_from_auto_cluster(master);
2310 }
2311
Hans Verkuil09965172010-08-01 14:32:42 -03002312 /* Copy the new caller-supplied control values.
Hans Verkuil2a863792011-01-11 14:45:03 -03002313 user_to_new() sets 'is_new' to 1. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002314 do {
2315 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2316 idx = helpers[idx].next;
2317 } while (!ret && idx);
Hans Verkuil09965172010-08-01 14:32:42 -03002318
2319 if (!ret)
Hans Verkuile6402582011-06-14 10:56:42 -03002320 ret = try_or_set_cluster(fh, master, set);
Hans Verkuil09965172010-08-01 14:32:42 -03002321
2322 /* Copy the new values back to userspace. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002323 if (!ret) {
2324 idx = i;
2325 do {
Hans Verkuiladf41b92011-07-05 06:56:37 -03002326 ret = new_to_user(cs->controls + idx,
Hans Verkuile6402582011-06-14 10:56:42 -03002327 helpers[idx].ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002328 idx = helpers[idx].next;
2329 } while (!ret && idx);
2330 }
2331 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002332 }
Hans Verkuil09965172010-08-01 14:32:42 -03002333
Hans Verkuil09965172010-08-01 14:32:42 -03002334 if (cs->count > ARRAY_SIZE(helper))
2335 kfree(helpers);
2336 return ret;
2337}
2338
2339int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2340{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002341 return try_set_ext_ctrls(NULL, hdl, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002342}
2343EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2344
Hans Verkuilab892ba2011-06-07 06:47:18 -03002345int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2346 struct v4l2_ext_controls *cs)
Hans Verkuil09965172010-08-01 14:32:42 -03002347{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002348 return try_set_ext_ctrls(fh, hdl, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002349}
2350EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2351
2352int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2353{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002354 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002355}
2356EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2357
2358int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2359{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002360 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002361}
2362EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2363
2364/* Helper function for VIDIOC_S_CTRL compatibility */
Hans Verkuilab892ba2011-06-07 06:47:18 -03002365static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
Hans Verkuil09965172010-08-01 14:32:42 -03002366{
2367 struct v4l2_ctrl *master = ctrl->cluster[0];
2368 int ret;
2369 int i;
2370
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002371 ret = validate_new_int(ctrl, val);
2372 if (ret)
2373 return ret;
2374
Hans Verkuil09965172010-08-01 14:32:42 -03002375 v4l2_ctrl_lock(ctrl);
2376
Hans Verkuil2a863792011-01-11 14:45:03 -03002377 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002378 for (i = 0; i < master->ncontrols; i++)
2379 if (master->cluster[i])
Hans Verkuil2a863792011-01-11 14:45:03 -03002380 master->cluster[i]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002381
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002382 /* For autoclusters with volatiles that are switched from auto to
2383 manual mode we have to update the current volatile values since
2384 those will become the initial manual values after such a switch. */
2385 if (master->is_auto && master->has_volatiles && ctrl == master &&
2386 !is_cur_manual(master) && *val == master->manual_mode_value)
2387 update_from_auto_cluster(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002388 ctrl->val = *val;
Hans Verkuil2a863792011-01-11 14:45:03 -03002389 ctrl->is_new = 1;
Hans Verkuile6402582011-06-14 10:56:42 -03002390 ret = try_or_set_cluster(fh, master, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002391 *val = ctrl->cur.val;
2392 v4l2_ctrl_unlock(ctrl);
2393 return ret;
2394}
2395
Hans Verkuilab892ba2011-06-07 06:47:18 -03002396int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2397 struct v4l2_control *control)
Hans Verkuil09965172010-08-01 14:32:42 -03002398{
2399 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2400
2401 if (ctrl == NULL || !type_is_int(ctrl))
2402 return -EINVAL;
2403
Hans Verkuil7ebbc392011-06-07 04:50:31 -03002404 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2405 return -EACCES;
2406
Hans Verkuilab892ba2011-06-07 06:47:18 -03002407 return set_ctrl(fh, ctrl, &control->value);
Hans Verkuil09965172010-08-01 14:32:42 -03002408}
2409EXPORT_SYMBOL(v4l2_s_ctrl);
2410
2411int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2412{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002413 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
Hans Verkuil09965172010-08-01 14:32:42 -03002414}
2415EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2416
2417int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2418{
2419 /* It's a driver bug if this happens. */
2420 WARN_ON(!type_is_int(ctrl));
Hans Verkuilab892ba2011-06-07 06:47:18 -03002421 return set_ctrl(NULL, ctrl, &val);
Hans Verkuil09965172010-08-01 14:32:42 -03002422}
2423EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
Hans Verkuil6e239392011-06-07 11:13:44 -03002424
Hans Verkuil77068d32011-06-13 18:55:58 -03002425void v4l2_ctrl_add_event(struct v4l2_ctrl *ctrl,
2426 struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002427{
Hans Verkuil6e239392011-06-07 11:13:44 -03002428 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002429 list_add_tail(&sev->node, &ctrl->ev_subs);
Hans Verkuil6e239392011-06-07 11:13:44 -03002430 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
Hans Verkuil77068d32011-06-13 18:55:58 -03002431 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
Hans Verkuil6e239392011-06-07 11:13:44 -03002432 struct v4l2_event ev;
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002433 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
Hans Verkuil6e239392011-06-07 11:13:44 -03002434
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002435 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2436 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2437 fill_event(&ev, ctrl, changes);
Hans Verkuil77068d32011-06-13 18:55:58 -03002438 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -03002439 }
2440 v4l2_ctrl_unlock(ctrl);
2441}
Hans Verkuil77068d32011-06-13 18:55:58 -03002442EXPORT_SYMBOL(v4l2_ctrl_add_event);
Hans Verkuil6e239392011-06-07 11:13:44 -03002443
Hans Verkuil77068d32011-06-13 18:55:58 -03002444void v4l2_ctrl_del_event(struct v4l2_ctrl *ctrl,
2445 struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002446{
Hans Verkuil6e239392011-06-07 11:13:44 -03002447 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002448 list_del(&sev->node);
Hans Verkuil6e239392011-06-07 11:13:44 -03002449 v4l2_ctrl_unlock(ctrl);
2450}
Hans Verkuil77068d32011-06-13 18:55:58 -03002451EXPORT_SYMBOL(v4l2_ctrl_del_event);
Hans Verkuile2ecb252012-02-02 08:20:53 -03002452
2453int v4l2_ctrl_log_status(struct file *file, void *fh)
2454{
2455 struct video_device *vfd = video_devdata(file);
2456 struct v4l2_fh *vfh = file->private_data;
2457
2458 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2459 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2460 vfd->v4l2_dev->name);
2461 return 0;
2462}
2463EXPORT_SYMBOL(v4l2_ctrl_log_status);
Hans Verkuila26243b2012-01-27 16:18:42 -03002464
2465int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2466 struct v4l2_event_subscription *sub)
2467{
2468 if (sub->type == V4L2_EVENT_CTRL)
2469 return v4l2_event_subscribe(fh, sub, 0);
2470 return -EINVAL;
2471}
2472EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2473
2474unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2475{
2476 struct v4l2_fh *fh = file->private_data;
2477
2478 if (v4l2_event_pending(fh))
2479 return POLLPRI;
2480 poll_wait(file, &fh->wait, wait);
2481 return 0;
2482}
2483EXPORT_SYMBOL(v4l2_ctrl_poll);