blob: 7a2f855d4e210e5f718f90e0f27c18c28ba2cc8d [file] [log] [blame]
Hans Verkuil09965172010-08-01 14:32:42 -03001/*
2 V4L2 controls framework implementation.
3
4 Copyright (C) 2010 Hans Verkuil <hverkuil@xs4all.nl>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21#include <linux/ctype.h>
Randy Dunlap2b801632010-08-09 14:56:35 -030022#include <linux/slab.h>
Paul Gortmaker35a24632011-08-01 15:26:38 -040023#include <linux/export.h>
Hans Verkuil09965172010-08-01 14:32:42 -030024#include <media/v4l2-ioctl.h>
25#include <media/v4l2-device.h>
26#include <media/v4l2-ctrls.h>
Hans Verkuil6e239392011-06-07 11:13:44 -030027#include <media/v4l2-event.h>
Hans Verkuil09965172010-08-01 14:32:42 -030028#include <media/v4l2-dev.h>
29
Hans Verkuilddac5c12011-06-10 05:43:34 -030030#define has_op(master, op) \
31 (master->ops && master->ops->op)
Hans Verkuil54c911e2011-05-25 06:04:58 -030032#define call_op(master, op) \
Hans Verkuilddac5c12011-06-10 05:43:34 -030033 (has_op(master, op) ? master->ops->op(master) : 0)
Hans Verkuil54c911e2011-05-25 06:04:58 -030034
Hans Verkuil09965172010-08-01 14:32:42 -030035/* Internal temporary helper struct, one for each v4l2_ext_control */
Hans Verkuileb5b16e2011-06-14 10:04:06 -030036struct v4l2_ctrl_helper {
37 /* Pointer to the control reference of the master control */
38 struct v4l2_ctrl_ref *mref;
Hans Verkuil09965172010-08-01 14:32:42 -030039 /* The control corresponding to the v4l2_ext_control ID field. */
40 struct v4l2_ctrl *ctrl;
Hans Verkuileb5b16e2011-06-14 10:04:06 -030041 /* v4l2_ext_control index of the next control belonging to the
42 same cluster, or 0 if there isn't any. */
43 u32 next;
Hans Verkuil09965172010-08-01 14:32:42 -030044};
45
Hans Verkuil72d877c2011-06-10 05:44:36 -030046/* Small helper function to determine if the autocluster is set to manual
Hans Verkuil88365102011-08-26 07:35:14 -030047 mode. */
Hans Verkuil72d877c2011-06-10 05:44:36 -030048static bool is_cur_manual(const struct v4l2_ctrl *master)
49{
50 return master->is_auto && master->cur.val == master->manual_mode_value;
51}
52
53/* Same as above, but this checks the against the new value instead of the
54 current value. */
55static bool is_new_manual(const struct v4l2_ctrl *master)
56{
57 return master->is_auto && master->val == master->manual_mode_value;
58}
59
Hans Verkuil09965172010-08-01 14:32:42 -030060/* Returns NULL or a character pointer array containing the menu for
61 the given control ID. The pointer array ends with a NULL pointer.
62 An empty string signifies a menu entry that is invalid. This allows
63 drivers to disable certain options if it is not supported. */
Hans Verkuil513521e2010-12-29 14:25:52 -030064const char * const *v4l2_ctrl_get_menu(u32 id)
Hans Verkuil09965172010-08-01 14:32:42 -030065{
Hans Verkuil513521e2010-12-29 14:25:52 -030066 static const char * const mpeg_audio_sampling_freq[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030067 "44.1 kHz",
68 "48 kHz",
69 "32 kHz",
70 NULL
71 };
Hans Verkuil513521e2010-12-29 14:25:52 -030072 static const char * const mpeg_audio_encoding[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030073 "MPEG-1/2 Layer I",
74 "MPEG-1/2 Layer II",
75 "MPEG-1/2 Layer III",
76 "MPEG-2/4 AAC",
77 "AC-3",
78 NULL
79 };
Hans Verkuil513521e2010-12-29 14:25:52 -030080 static const char * const mpeg_audio_l1_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030081 "32 kbps",
82 "64 kbps",
83 "96 kbps",
84 "128 kbps",
85 "160 kbps",
86 "192 kbps",
87 "224 kbps",
88 "256 kbps",
89 "288 kbps",
90 "320 kbps",
91 "352 kbps",
92 "384 kbps",
93 "416 kbps",
94 "448 kbps",
95 NULL
96 };
Hans Verkuil513521e2010-12-29 14:25:52 -030097 static const char * const mpeg_audio_l2_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -030098 "32 kbps",
99 "48 kbps",
100 "56 kbps",
101 "64 kbps",
102 "80 kbps",
103 "96 kbps",
104 "112 kbps",
105 "128 kbps",
106 "160 kbps",
107 "192 kbps",
108 "224 kbps",
109 "256 kbps",
110 "320 kbps",
111 "384 kbps",
112 NULL
113 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300114 static const char * const mpeg_audio_l3_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300115 "32 kbps",
116 "40 kbps",
117 "48 kbps",
118 "56 kbps",
119 "64 kbps",
120 "80 kbps",
121 "96 kbps",
122 "112 kbps",
123 "128 kbps",
124 "160 kbps",
125 "192 kbps",
126 "224 kbps",
127 "256 kbps",
128 "320 kbps",
129 NULL
130 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300131 static const char * const mpeg_audio_ac3_bitrate[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300132 "32 kbps",
133 "40 kbps",
134 "48 kbps",
135 "56 kbps",
136 "64 kbps",
137 "80 kbps",
138 "96 kbps",
139 "112 kbps",
140 "128 kbps",
141 "160 kbps",
142 "192 kbps",
143 "224 kbps",
144 "256 kbps",
145 "320 kbps",
146 "384 kbps",
147 "448 kbps",
148 "512 kbps",
149 "576 kbps",
150 "640 kbps",
151 NULL
152 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300153 static const char * const mpeg_audio_mode[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300154 "Stereo",
155 "Joint Stereo",
156 "Dual",
157 "Mono",
158 NULL
159 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300160 static const char * const mpeg_audio_mode_extension[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300161 "Bound 4",
162 "Bound 8",
163 "Bound 12",
164 "Bound 16",
165 NULL
166 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300167 static const char * const mpeg_audio_emphasis[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300168 "No Emphasis",
169 "50/15 us",
170 "CCITT J17",
171 NULL
172 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300173 static const char * const mpeg_audio_crc[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300174 "No CRC",
175 "16-bit CRC",
176 NULL
177 };
Hans Verkuil24c19a22011-12-15 10:46:16 -0300178 static const char * const mpeg_audio_dec_playback[] = {
179 "Auto",
180 "Stereo",
181 "Left",
182 "Right",
183 "Mono",
184 "Swapped Stereo",
185 NULL
186 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300187 static const char * const mpeg_video_encoding[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300188 "MPEG-1",
189 "MPEG-2",
190 "MPEG-4 AVC",
191 NULL
192 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300193 static const char * const mpeg_video_aspect[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300194 "1x1",
195 "4x3",
196 "16x9",
197 "2.21x1",
198 NULL
199 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300200 static const char * const mpeg_video_bitrate_mode[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300201 "Variable Bitrate",
202 "Constant Bitrate",
203 NULL
204 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300205 static const char * const mpeg_stream_type[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300206 "MPEG-2 Program Stream",
207 "MPEG-2 Transport Stream",
208 "MPEG-1 System Stream",
209 "MPEG-2 DVD-compatible Stream",
210 "MPEG-1 VCD-compatible Stream",
211 "MPEG-2 SVCD-compatible Stream",
212 NULL
213 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300214 static const char * const mpeg_stream_vbi_fmt[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300215 "No VBI",
Kamil Debski064f5092011-06-14 10:46:22 -0300216 "Private Packet, IVTV Format",
Hans Verkuil09965172010-08-01 14:32:42 -0300217 NULL
218 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300219 static const char * const camera_power_line_frequency[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300220 "Disabled",
221 "50 Hz",
222 "60 Hz",
Sylwester Nawrockid26a6632011-09-04 19:08:54 -0300223 "Auto",
Hans Verkuil09965172010-08-01 14:32:42 -0300224 NULL
225 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300226 static const char * const camera_exposure_auto[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300227 "Auto Mode",
228 "Manual Mode",
229 "Shutter Priority Mode",
230 "Aperture Priority Mode",
231 NULL
232 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300233 static const char * const colorfx[] = {
Hans Verkuil09965172010-08-01 14:32:42 -0300234 "None",
235 "Black & White",
236 "Sepia",
237 "Negative",
238 "Emboss",
239 "Sketch",
Kamil Debski064f5092011-06-14 10:46:22 -0300240 "Sky Blue",
241 "Grass Green",
242 "Skin Whiten",
Hans Verkuil09965172010-08-01 14:32:42 -0300243 "Vivid",
244 NULL
245 };
Hans Verkuil513521e2010-12-29 14:25:52 -0300246 static const char * const tune_preemphasis[] = {
Kamil Debski064f5092011-06-14 10:46:22 -0300247 "No Preemphasis",
Hans Verkuilf769c262012-03-02 04:20:19 -0300248 "50 Microseconds",
249 "75 Microseconds",
Hans Verkuil09965172010-08-01 14:32:42 -0300250 NULL,
251 };
Kamil Debski064f5092011-06-14 10:46:22 -0300252 static const char * const header_mode[] = {
253 "Separate Buffer",
254 "Joined With 1st Frame",
255 NULL,
256 };
257 static const char * const multi_slice[] = {
258 "Single",
259 "Max Macroblocks",
260 "Max Bytes",
261 NULL,
262 };
263 static const char * const entropy_mode[] = {
264 "CAVLC",
265 "CABAC",
266 NULL,
267 };
268 static const char * const mpeg_h264_level[] = {
269 "1",
270 "1b",
271 "1.1",
272 "1.2",
273 "1.3",
274 "2",
275 "2.1",
276 "2.2",
277 "3",
278 "3.1",
279 "3.2",
280 "4",
281 "4.1",
282 "4.2",
283 "5",
284 "5.1",
285 NULL,
286 };
287 static const char * const h264_loop_filter[] = {
288 "Enabled",
289 "Disabled",
290 "Disabled at Slice Boundary",
291 NULL,
292 };
293 static const char * const h264_profile[] = {
294 "Baseline",
295 "Constrained Baseline",
296 "Main",
297 "Extended",
298 "High",
299 "High 10",
300 "High 422",
301 "High 444 Predictive",
302 "High 10 Intra",
303 "High 422 Intra",
304 "High 444 Intra",
305 "CAVLC 444 Intra",
306 "Scalable Baseline",
307 "Scalable High",
308 "Scalable High Intra",
309 "Multiview High",
310 NULL,
311 };
312 static const char * const vui_sar_idc[] = {
313 "Unspecified",
314 "1:1",
315 "12:11",
316 "10:11",
317 "16:11",
318 "40:33",
319 "24:11",
320 "20:11",
321 "32:11",
322 "80:33",
323 "18:11",
324 "15:11",
325 "64:33",
326 "160:99",
327 "4:3",
328 "3:2",
329 "2:1",
330 "Extended SAR",
331 NULL,
332 };
333 static const char * const mpeg_mpeg4_level[] = {
334 "0",
335 "0b",
336 "1",
337 "2",
338 "3",
339 "3b",
340 "4",
341 "5",
342 NULL,
343 };
344 static const char * const mpeg4_profile[] = {
345 "Simple",
Hans Verkuilf769c262012-03-02 04:20:19 -0300346 "Advanced Simple",
Kamil Debski064f5092011-06-14 10:46:22 -0300347 "Core",
348 "Simple Scalable",
349 "Advanced Coding Efficency",
350 NULL,
351 };
352
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300353 static const char * const flash_led_mode[] = {
354 "Off",
355 "Flash",
356 "Torch",
357 NULL,
358 };
359 static const char * const flash_strobe_source[] = {
360 "Software",
361 "External",
362 NULL,
363 };
Hans Verkuil09965172010-08-01 14:32:42 -0300364
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300365 static const char * const jpeg_chroma_subsampling[] = {
366 "4:4:4",
367 "4:2:2",
368 "4:2:0",
369 "4:1:1",
370 "4:1:0",
371 "Gray",
372 NULL,
373 };
374
Hans Verkuil09965172010-08-01 14:32:42 -0300375 switch (id) {
376 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
377 return mpeg_audio_sampling_freq;
378 case V4L2_CID_MPEG_AUDIO_ENCODING:
379 return mpeg_audio_encoding;
380 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
381 return mpeg_audio_l1_bitrate;
382 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
383 return mpeg_audio_l2_bitrate;
384 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
385 return mpeg_audio_l3_bitrate;
386 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
387 return mpeg_audio_ac3_bitrate;
388 case V4L2_CID_MPEG_AUDIO_MODE:
389 return mpeg_audio_mode;
390 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
391 return mpeg_audio_mode_extension;
392 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
393 return mpeg_audio_emphasis;
394 case V4L2_CID_MPEG_AUDIO_CRC:
395 return mpeg_audio_crc;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300396 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
397 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
398 return mpeg_audio_dec_playback;
Hans Verkuil09965172010-08-01 14:32:42 -0300399 case V4L2_CID_MPEG_VIDEO_ENCODING:
400 return mpeg_video_encoding;
401 case V4L2_CID_MPEG_VIDEO_ASPECT:
402 return mpeg_video_aspect;
403 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
404 return mpeg_video_bitrate_mode;
405 case V4L2_CID_MPEG_STREAM_TYPE:
406 return mpeg_stream_type;
407 case V4L2_CID_MPEG_STREAM_VBI_FMT:
408 return mpeg_stream_vbi_fmt;
409 case V4L2_CID_POWER_LINE_FREQUENCY:
410 return camera_power_line_frequency;
411 case V4L2_CID_EXPOSURE_AUTO:
412 return camera_exposure_auto;
413 case V4L2_CID_COLORFX:
414 return colorfx;
415 case V4L2_CID_TUNE_PREEMPHASIS:
416 return tune_preemphasis;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300417 case V4L2_CID_FLASH_LED_MODE:
418 return flash_led_mode;
419 case V4L2_CID_FLASH_STROBE_SOURCE:
420 return flash_strobe_source;
Kamil Debski064f5092011-06-14 10:46:22 -0300421 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
422 return header_mode;
423 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
424 return multi_slice;
425 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
426 return entropy_mode;
427 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
428 return mpeg_h264_level;
429 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
430 return h264_loop_filter;
431 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
432 return h264_profile;
433 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
434 return vui_sar_idc;
435 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
436 return mpeg_mpeg4_level;
437 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
438 return mpeg4_profile;
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300439 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
440 return jpeg_chroma_subsampling;
441
Hans Verkuil09965172010-08-01 14:32:42 -0300442 default:
443 return NULL;
444 }
445}
446EXPORT_SYMBOL(v4l2_ctrl_get_menu);
447
448/* Return the control name. */
449const char *v4l2_ctrl_get_name(u32 id)
450{
451 switch (id) {
452 /* USER controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300453 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300454 case V4L2_CID_USER_CLASS: return "User Controls";
455 case V4L2_CID_BRIGHTNESS: return "Brightness";
456 case V4L2_CID_CONTRAST: return "Contrast";
457 case V4L2_CID_SATURATION: return "Saturation";
458 case V4L2_CID_HUE: return "Hue";
459 case V4L2_CID_AUDIO_VOLUME: return "Volume";
460 case V4L2_CID_AUDIO_BALANCE: return "Balance";
461 case V4L2_CID_AUDIO_BASS: return "Bass";
462 case V4L2_CID_AUDIO_TREBLE: return "Treble";
463 case V4L2_CID_AUDIO_MUTE: return "Mute";
464 case V4L2_CID_AUDIO_LOUDNESS: return "Loudness";
Hans Verkuil09965172010-08-01 14:32:42 -0300465 case V4L2_CID_BLACK_LEVEL: return "Black Level";
466 case V4L2_CID_AUTO_WHITE_BALANCE: return "White Balance, Automatic";
467 case V4L2_CID_DO_WHITE_BALANCE: return "Do White Balance";
468 case V4L2_CID_RED_BALANCE: return "Red Balance";
469 case V4L2_CID_BLUE_BALANCE: return "Blue Balance";
470 case V4L2_CID_GAMMA: return "Gamma";
471 case V4L2_CID_EXPOSURE: return "Exposure";
472 case V4L2_CID_AUTOGAIN: return "Gain, Automatic";
473 case V4L2_CID_GAIN: return "Gain";
474 case V4L2_CID_HFLIP: return "Horizontal Flip";
475 case V4L2_CID_VFLIP: return "Vertical Flip";
476 case V4L2_CID_HCENTER: return "Horizontal Center";
477 case V4L2_CID_VCENTER: return "Vertical Center";
478 case V4L2_CID_POWER_LINE_FREQUENCY: return "Power Line Frequency";
479 case V4L2_CID_HUE_AUTO: return "Hue, Automatic";
480 case V4L2_CID_WHITE_BALANCE_TEMPERATURE: return "White Balance Temperature";
481 case V4L2_CID_SHARPNESS: return "Sharpness";
482 case V4L2_CID_BACKLIGHT_COMPENSATION: return "Backlight Compensation";
483 case V4L2_CID_CHROMA_AGC: return "Chroma AGC";
Hans Verkuil09965172010-08-01 14:32:42 -0300484 case V4L2_CID_COLOR_KILLER: return "Color Killer";
485 case V4L2_CID_COLORFX: return "Color Effects";
486 case V4L2_CID_AUTOBRIGHTNESS: return "Brightness, Automatic";
487 case V4L2_CID_BAND_STOP_FILTER: return "Band-Stop Filter";
488 case V4L2_CID_ROTATE: return "Rotate";
489 case V4L2_CID_BG_COLOR: return "Background Color";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300490 case V4L2_CID_CHROMA_GAIN: return "Chroma Gain";
Jean-François Moine008d35f2010-09-13 07:04:49 -0300491 case V4L2_CID_ILLUMINATORS_1: return "Illuminator 1";
492 case V4L2_CID_ILLUMINATORS_2: return "Illuminator 2";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300493 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE: return "Min Number of Capture Buffers";
494 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT: return "Min Number of Output Buffers";
Sylwester Nawrockicc1d3272011-11-14 08:48:18 -0300495 case V4L2_CID_ALPHA_COMPONENT: return "Alpha Component";
Hans Verkuil09965172010-08-01 14:32:42 -0300496
497 /* MPEG controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300498 /* Keep the order of the 'case's the same as in videodev2.h! */
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300499 case V4L2_CID_MPEG_CLASS: return "MPEG Encoder Controls";
500 case V4L2_CID_MPEG_STREAM_TYPE: return "Stream Type";
501 case V4L2_CID_MPEG_STREAM_PID_PMT: return "Stream PMT Program ID";
502 case V4L2_CID_MPEG_STREAM_PID_AUDIO: return "Stream Audio Program ID";
503 case V4L2_CID_MPEG_STREAM_PID_VIDEO: return "Stream Video Program ID";
504 case V4L2_CID_MPEG_STREAM_PID_PCR: return "Stream PCR Program ID";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300505 case V4L2_CID_MPEG_STREAM_PES_ID_AUDIO: return "Stream PES Audio ID";
506 case V4L2_CID_MPEG_STREAM_PES_ID_VIDEO: return "Stream PES Video ID";
507 case V4L2_CID_MPEG_STREAM_VBI_FMT: return "Stream VBI Format";
Hans Verkuil09965172010-08-01 14:32:42 -0300508 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ: return "Audio Sampling Frequency";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300509 case V4L2_CID_MPEG_AUDIO_ENCODING: return "Audio Encoding";
510 case V4L2_CID_MPEG_AUDIO_L1_BITRATE: return "Audio Layer I Bitrate";
511 case V4L2_CID_MPEG_AUDIO_L2_BITRATE: return "Audio Layer II Bitrate";
512 case V4L2_CID_MPEG_AUDIO_L3_BITRATE: return "Audio Layer III Bitrate";
513 case V4L2_CID_MPEG_AUDIO_MODE: return "Audio Stereo Mode";
Hans Verkuil09965172010-08-01 14:32:42 -0300514 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION: return "Audio Stereo Mode Extension";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300515 case V4L2_CID_MPEG_AUDIO_EMPHASIS: return "Audio Emphasis";
516 case V4L2_CID_MPEG_AUDIO_CRC: return "Audio CRC";
517 case V4L2_CID_MPEG_AUDIO_MUTE: return "Audio Mute";
518 case V4L2_CID_MPEG_AUDIO_AAC_BITRATE: return "Audio AAC Bitrate";
519 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE: return "Audio AC-3 Bitrate";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300520 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK: return "Audio Playback";
521 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK: return "Audio Multilingual Playback";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300522 case V4L2_CID_MPEG_VIDEO_ENCODING: return "Video Encoding";
523 case V4L2_CID_MPEG_VIDEO_ASPECT: return "Video Aspect";
524 case V4L2_CID_MPEG_VIDEO_B_FRAMES: return "Video B Frames";
525 case V4L2_CID_MPEG_VIDEO_GOP_SIZE: return "Video GOP Size";
526 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE: return "Video GOP Closure";
527 case V4L2_CID_MPEG_VIDEO_PULLDOWN: return "Video Pulldown";
528 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE: return "Video Bitrate Mode";
529 case V4L2_CID_MPEG_VIDEO_BITRATE: return "Video Bitrate";
530 case V4L2_CID_MPEG_VIDEO_BITRATE_PEAK: return "Video Peak Bitrate";
Hans Verkuil09965172010-08-01 14:32:42 -0300531 case V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION: return "Video Temporal Decimation";
Mauro Carvalho Chehab6dd5aff2010-08-06 09:57:02 -0300532 case V4L2_CID_MPEG_VIDEO_MUTE: return "Video Mute";
Hans Verkuil09965172010-08-01 14:32:42 -0300533 case V4L2_CID_MPEG_VIDEO_MUTE_YUV: return "Video Mute YUV";
Kamil Debski064f5092011-06-14 10:46:22 -0300534 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE: return "Decoder Slice Interface";
535 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER: return "MPEG4 Loop Filter Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300536 case V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB: return "Number of Intra Refresh MBs";
Kamil Debski064f5092011-06-14 10:46:22 -0300537 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE: return "Frame Level Rate Control Enable";
538 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE: return "H264 MB Level Rate Control";
539 case V4L2_CID_MPEG_VIDEO_HEADER_MODE: return "Sequence Header Mode";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300540 case V4L2_CID_MPEG_VIDEO_MAX_REF_PIC: return "Max Number of Reference Pics";
Kamil Debski064f5092011-06-14 10:46:22 -0300541 case V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP: return "H263 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300542 case V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP: return "H263 P-Frame QP Value";
543 case V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP: return "H263 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300544 case V4L2_CID_MPEG_VIDEO_H263_MIN_QP: return "H263 Minimum QP Value";
545 case V4L2_CID_MPEG_VIDEO_H263_MAX_QP: return "H263 Maximum QP Value";
546 case V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP: return "H264 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300547 case V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP: return "H264 P-Frame QP Value";
548 case V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP: return "H264 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300549 case V4L2_CID_MPEG_VIDEO_H264_MAX_QP: return "H264 Maximum QP Value";
550 case V4L2_CID_MPEG_VIDEO_H264_MIN_QP: return "H264 Minimum QP Value";
551 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM: return "H264 8x8 Transform Enable";
552 case V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE: return "H264 CPB Buffer Size";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300553 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE: return "H264 Entropy Mode";
554 case V4L2_CID_MPEG_VIDEO_H264_I_PERIOD: return "H264 I-Frame Period";
Kamil Debski064f5092011-06-14 10:46:22 -0300555 case V4L2_CID_MPEG_VIDEO_H264_LEVEL: return "H264 Level";
556 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA: return "H264 Loop Filter Alpha Offset";
557 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA: return "H264 Loop Filter Beta Offset";
558 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE: return "H264 Loop Filter Mode";
559 case V4L2_CID_MPEG_VIDEO_H264_PROFILE: return "H264 Profile";
560 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT: return "Vertical Size of SAR";
561 case V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH: return "Horizontal Size of SAR";
562 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE: return "Aspect Ratio VUI Enable";
563 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC: return "VUI Aspect Ratio IDC";
564 case V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP: return "MPEG4 I-Frame QP Value";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300565 case V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP: return "MPEG4 P-Frame QP Value";
566 case V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP: return "MPEG4 B-Frame QP Value";
Kamil Debski064f5092011-06-14 10:46:22 -0300567 case V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP: return "MPEG4 Minimum QP Value";
568 case V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP: return "MPEG4 Maximum QP Value";
569 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL: return "MPEG4 Level";
570 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE: return "MPEG4 Profile";
571 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL: return "Quarter Pixel Search Enable";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300572 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES: return "Maximum Bytes in a Slice";
573 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB: return "Number of MBs in a Slice";
574 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE: return "Slice Partitioning Method";
Kamil Debski064f5092011-06-14 10:46:22 -0300575 case V4L2_CID_MPEG_VIDEO_VBV_SIZE: return "VBV Buffer Size";
Hans Verkuil24c19a22011-12-15 10:46:16 -0300576 case V4L2_CID_MPEG_VIDEO_DEC_PTS: return "Video Decoder PTS";
577 case V4L2_CID_MPEG_VIDEO_DEC_FRAME: return "Video Decoder Frame Count";
Hans Verkuil09965172010-08-01 14:32:42 -0300578
579 /* CAMERA controls */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300580 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300581 case V4L2_CID_CAMERA_CLASS: return "Camera Controls";
582 case V4L2_CID_EXPOSURE_AUTO: return "Auto Exposure";
583 case V4L2_CID_EXPOSURE_ABSOLUTE: return "Exposure Time, Absolute";
584 case V4L2_CID_EXPOSURE_AUTO_PRIORITY: return "Exposure, Dynamic Framerate";
585 case V4L2_CID_PAN_RELATIVE: return "Pan, Relative";
586 case V4L2_CID_TILT_RELATIVE: return "Tilt, Relative";
587 case V4L2_CID_PAN_RESET: return "Pan, Reset";
588 case V4L2_CID_TILT_RESET: return "Tilt, Reset";
589 case V4L2_CID_PAN_ABSOLUTE: return "Pan, Absolute";
590 case V4L2_CID_TILT_ABSOLUTE: return "Tilt, Absolute";
591 case V4L2_CID_FOCUS_ABSOLUTE: return "Focus, Absolute";
592 case V4L2_CID_FOCUS_RELATIVE: return "Focus, Relative";
593 case V4L2_CID_FOCUS_AUTO: return "Focus, Automatic";
Hans Verkuil09965172010-08-01 14:32:42 -0300594 case V4L2_CID_ZOOM_ABSOLUTE: return "Zoom, Absolute";
595 case V4L2_CID_ZOOM_RELATIVE: return "Zoom, Relative";
596 case V4L2_CID_ZOOM_CONTINUOUS: return "Zoom, Continuous";
597 case V4L2_CID_PRIVACY: return "Privacy";
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300598 case V4L2_CID_IRIS_ABSOLUTE: return "Iris, Absolute";
599 case V4L2_CID_IRIS_RELATIVE: return "Iris, Relative";
Hans Verkuil09965172010-08-01 14:32:42 -0300600
601 /* FM Radio Modulator control */
Hans Verkuil6c8d6112010-04-25 19:21:00 -0300602 /* Keep the order of the 'case's the same as in videodev2.h! */
Hans Verkuil09965172010-08-01 14:32:42 -0300603 case V4L2_CID_FM_TX_CLASS: return "FM Radio Modulator Controls";
604 case V4L2_CID_RDS_TX_DEVIATION: return "RDS Signal Deviation";
605 case V4L2_CID_RDS_TX_PI: return "RDS Program ID";
606 case V4L2_CID_RDS_TX_PTY: return "RDS Program Type";
607 case V4L2_CID_RDS_TX_PS_NAME: return "RDS PS Name";
608 case V4L2_CID_RDS_TX_RADIO_TEXT: return "RDS Radio Text";
609 case V4L2_CID_AUDIO_LIMITER_ENABLED: return "Audio Limiter Feature Enabled";
610 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME: return "Audio Limiter Release Time";
611 case V4L2_CID_AUDIO_LIMITER_DEVIATION: return "Audio Limiter Deviation";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300612 case V4L2_CID_AUDIO_COMPRESSION_ENABLED: return "Audio Compression Enabled";
Hans Verkuil09965172010-08-01 14:32:42 -0300613 case V4L2_CID_AUDIO_COMPRESSION_GAIN: return "Audio Compression Gain";
614 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD: return "Audio Compression Threshold";
615 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME: return "Audio Compression Attack Time";
616 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME: return "Audio Compression Release Time";
617 case V4L2_CID_PILOT_TONE_ENABLED: return "Pilot Tone Feature Enabled";
618 case V4L2_CID_PILOT_TONE_DEVIATION: return "Pilot Tone Deviation";
619 case V4L2_CID_PILOT_TONE_FREQUENCY: return "Pilot Tone Frequency";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300620 case V4L2_CID_TUNE_PREEMPHASIS: return "Pre-Emphasis";
Hans Verkuil09965172010-08-01 14:32:42 -0300621 case V4L2_CID_TUNE_POWER_LEVEL: return "Tune Power Level";
622 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: return "Tune Antenna Capacitor";
623
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300624 /* Flash controls */
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300625 case V4L2_CID_FLASH_CLASS: return "Flash Controls";
626 case V4L2_CID_FLASH_LED_MODE: return "LED Mode";
627 case V4L2_CID_FLASH_STROBE_SOURCE: return "Strobe Source";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300628 case V4L2_CID_FLASH_STROBE: return "Strobe";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300629 case V4L2_CID_FLASH_STROBE_STOP: return "Stop Strobe";
630 case V4L2_CID_FLASH_STROBE_STATUS: return "Strobe Status";
631 case V4L2_CID_FLASH_TIMEOUT: return "Strobe Timeout";
632 case V4L2_CID_FLASH_INTENSITY: return "Intensity, Flash Mode";
633 case V4L2_CID_FLASH_TORCH_INTENSITY: return "Intensity, Torch Mode";
634 case V4L2_CID_FLASH_INDICATOR_INTENSITY: return "Intensity, Indicator";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300635 case V4L2_CID_FLASH_FAULT: return "Faults";
636 case V4L2_CID_FLASH_CHARGE: return "Charge";
Hans Verkuilf08aacf2012-01-16 12:27:15 -0300637 case V4L2_CID_FLASH_READY: return "Ready to Strobe";
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300638
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300639 /* JPEG encoder controls */
640 /* Keep the order of the 'case's the same as in videodev2.h! */
641 case V4L2_CID_JPEG_CLASS: return "JPEG Compression Controls";
642 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING: return "Chroma Subsampling";
643 case V4L2_CID_JPEG_RESTART_INTERVAL: return "Restart Interval";
644 case V4L2_CID_JPEG_COMPRESSION_QUALITY: return "Compression Quality";
645 case V4L2_CID_JPEG_ACTIVE_MARKER: return "Active Markers";
646
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300647 /* Image source controls */
648 case V4L2_CID_IMAGE_SOURCE_CLASS: return "Image Source Controls";
649 case V4L2_CID_VBLANK: return "Vertical Blanking";
650 case V4L2_CID_HBLANK: return "Horizontal Blanking";
651 case V4L2_CID_ANALOGUE_GAIN: return "Analogue Gain";
652
Hans Verkuil09965172010-08-01 14:32:42 -0300653 default:
654 return NULL;
655 }
656}
657EXPORT_SYMBOL(v4l2_ctrl_get_name);
658
659void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
660 s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags)
661{
662 *name = v4l2_ctrl_get_name(id);
663 *flags = 0;
664
665 switch (id) {
666 case V4L2_CID_AUDIO_MUTE:
667 case V4L2_CID_AUDIO_LOUDNESS:
668 case V4L2_CID_AUTO_WHITE_BALANCE:
669 case V4L2_CID_AUTOGAIN:
670 case V4L2_CID_HFLIP:
671 case V4L2_CID_VFLIP:
672 case V4L2_CID_HUE_AUTO:
673 case V4L2_CID_CHROMA_AGC:
674 case V4L2_CID_COLOR_KILLER:
675 case V4L2_CID_MPEG_AUDIO_MUTE:
676 case V4L2_CID_MPEG_VIDEO_MUTE:
677 case V4L2_CID_MPEG_VIDEO_GOP_CLOSURE:
678 case V4L2_CID_MPEG_VIDEO_PULLDOWN:
679 case V4L2_CID_EXPOSURE_AUTO_PRIORITY:
680 case V4L2_CID_FOCUS_AUTO:
681 case V4L2_CID_PRIVACY:
682 case V4L2_CID_AUDIO_LIMITER_ENABLED:
683 case V4L2_CID_AUDIO_COMPRESSION_ENABLED:
684 case V4L2_CID_PILOT_TONE_ENABLED:
Jean-François Moine008d35f2010-09-13 07:04:49 -0300685 case V4L2_CID_ILLUMINATORS_1:
686 case V4L2_CID_ILLUMINATORS_2:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300687 case V4L2_CID_FLASH_STROBE_STATUS:
688 case V4L2_CID_FLASH_CHARGE:
689 case V4L2_CID_FLASH_READY:
Kamil Debski064f5092011-06-14 10:46:22 -0300690 case V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER:
691 case V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE:
692 case V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE:
693 case V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE:
694 case V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM:
695 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE:
696 case V4L2_CID_MPEG_VIDEO_MPEG4_QPEL:
Hans Verkuil09965172010-08-01 14:32:42 -0300697 *type = V4L2_CTRL_TYPE_BOOLEAN;
698 *min = 0;
699 *max = *step = 1;
700 break;
701 case V4L2_CID_PAN_RESET:
702 case V4L2_CID_TILT_RESET:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300703 case V4L2_CID_FLASH_STROBE:
704 case V4L2_CID_FLASH_STROBE_STOP:
Hans Verkuil09965172010-08-01 14:32:42 -0300705 *type = V4L2_CTRL_TYPE_BUTTON;
706 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
707 *min = *max = *step = *def = 0;
708 break;
709 case V4L2_CID_POWER_LINE_FREQUENCY:
710 case V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ:
711 case V4L2_CID_MPEG_AUDIO_ENCODING:
712 case V4L2_CID_MPEG_AUDIO_L1_BITRATE:
713 case V4L2_CID_MPEG_AUDIO_L2_BITRATE:
714 case V4L2_CID_MPEG_AUDIO_L3_BITRATE:
715 case V4L2_CID_MPEG_AUDIO_AC3_BITRATE:
716 case V4L2_CID_MPEG_AUDIO_MODE:
717 case V4L2_CID_MPEG_AUDIO_MODE_EXTENSION:
718 case V4L2_CID_MPEG_AUDIO_EMPHASIS:
719 case V4L2_CID_MPEG_AUDIO_CRC:
Hans Verkuil24c19a22011-12-15 10:46:16 -0300720 case V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK:
721 case V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK:
Hans Verkuil09965172010-08-01 14:32:42 -0300722 case V4L2_CID_MPEG_VIDEO_ENCODING:
723 case V4L2_CID_MPEG_VIDEO_ASPECT:
724 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
725 case V4L2_CID_MPEG_STREAM_TYPE:
726 case V4L2_CID_MPEG_STREAM_VBI_FMT:
727 case V4L2_CID_EXPOSURE_AUTO:
728 case V4L2_CID_COLORFX:
729 case V4L2_CID_TUNE_PREEMPHASIS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300730 case V4L2_CID_FLASH_LED_MODE:
731 case V4L2_CID_FLASH_STROBE_SOURCE:
Kamil Debski064f5092011-06-14 10:46:22 -0300732 case V4L2_CID_MPEG_VIDEO_HEADER_MODE:
733 case V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE:
734 case V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE:
735 case V4L2_CID_MPEG_VIDEO_H264_LEVEL:
736 case V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE:
737 case V4L2_CID_MPEG_VIDEO_H264_PROFILE:
738 case V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC:
739 case V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL:
740 case V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300741 case V4L2_CID_JPEG_CHROMA_SUBSAMPLING:
Hans Verkuil09965172010-08-01 14:32:42 -0300742 *type = V4L2_CTRL_TYPE_MENU;
743 break;
744 case V4L2_CID_RDS_TX_PS_NAME:
745 case V4L2_CID_RDS_TX_RADIO_TEXT:
746 *type = V4L2_CTRL_TYPE_STRING;
747 break;
748 case V4L2_CID_USER_CLASS:
749 case V4L2_CID_CAMERA_CLASS:
750 case V4L2_CID_MPEG_CLASS:
751 case V4L2_CID_FM_TX_CLASS:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300752 case V4L2_CID_FLASH_CLASS:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300753 case V4L2_CID_JPEG_CLASS:
Sakari Ailus8c9d2362011-10-04 08:20:05 -0300754 case V4L2_CID_IMAGE_SOURCE_CLASS:
Hans Verkuil09965172010-08-01 14:32:42 -0300755 *type = V4L2_CTRL_TYPE_CTRL_CLASS;
756 /* You can neither read not write these */
757 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_WRITE_ONLY;
758 *min = *max = *step = *def = 0;
759 break;
760 case V4L2_CID_BG_COLOR:
761 *type = V4L2_CTRL_TYPE_INTEGER;
762 *step = 1;
763 *min = 0;
764 /* Max is calculated as RGB888 that is 2^24 */
765 *max = 0xFFFFFF;
766 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300767 case V4L2_CID_FLASH_FAULT:
Sylwester Nawrockic7361ae2012-01-20 15:37:44 -0300768 case V4L2_CID_JPEG_ACTIVE_MARKER:
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300769 *type = V4L2_CTRL_TYPE_BITMASK;
770 break;
Kamil Debski064f5092011-06-14 10:46:22 -0300771 case V4L2_CID_MIN_BUFFERS_FOR_CAPTURE:
772 case V4L2_CID_MIN_BUFFERS_FOR_OUTPUT:
773 *type = V4L2_CTRL_TYPE_INTEGER;
774 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
775 break;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300776 case V4L2_CID_MPEG_VIDEO_DEC_FRAME:
777 case V4L2_CID_MPEG_VIDEO_DEC_PTS:
778 *type = V4L2_CTRL_TYPE_INTEGER64;
779 *flags |= V4L2_CTRL_FLAG_READ_ONLY | V4L2_CTRL_FLAG_VOLATILE;
Hans Verkuilca576812012-04-19 12:37:18 -0300780 *min = *max = *step = *def = 0;
Hans Verkuil24c19a22011-12-15 10:46:16 -0300781 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300782 default:
783 *type = V4L2_CTRL_TYPE_INTEGER;
784 break;
785 }
786 switch (id) {
787 case V4L2_CID_MPEG_AUDIO_ENCODING:
788 case V4L2_CID_MPEG_AUDIO_MODE:
789 case V4L2_CID_MPEG_VIDEO_BITRATE_MODE:
790 case V4L2_CID_MPEG_VIDEO_B_FRAMES:
791 case V4L2_CID_MPEG_STREAM_TYPE:
792 *flags |= V4L2_CTRL_FLAG_UPDATE;
793 break;
794 case V4L2_CID_AUDIO_VOLUME:
795 case V4L2_CID_AUDIO_BALANCE:
796 case V4L2_CID_AUDIO_BASS:
797 case V4L2_CID_AUDIO_TREBLE:
798 case V4L2_CID_BRIGHTNESS:
799 case V4L2_CID_CONTRAST:
800 case V4L2_CID_SATURATION:
801 case V4L2_CID_HUE:
802 case V4L2_CID_RED_BALANCE:
803 case V4L2_CID_BLUE_BALANCE:
804 case V4L2_CID_GAMMA:
805 case V4L2_CID_SHARPNESS:
806 case V4L2_CID_CHROMA_GAIN:
807 case V4L2_CID_RDS_TX_DEVIATION:
808 case V4L2_CID_AUDIO_LIMITER_RELEASE_TIME:
809 case V4L2_CID_AUDIO_LIMITER_DEVIATION:
810 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
811 case V4L2_CID_AUDIO_COMPRESSION_THRESHOLD:
812 case V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME:
813 case V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME:
814 case V4L2_CID_PILOT_TONE_DEVIATION:
815 case V4L2_CID_PILOT_TONE_FREQUENCY:
816 case V4L2_CID_TUNE_POWER_LEVEL:
817 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
818 *flags |= V4L2_CTRL_FLAG_SLIDER;
819 break;
820 case V4L2_CID_PAN_RELATIVE:
821 case V4L2_CID_TILT_RELATIVE:
822 case V4L2_CID_FOCUS_RELATIVE:
823 case V4L2_CID_IRIS_RELATIVE:
824 case V4L2_CID_ZOOM_RELATIVE:
825 *flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
826 break;
Sakari Ailus0b159ac2011-03-21 12:52:51 -0300827 case V4L2_CID_FLASH_STROBE_STATUS:
828 case V4L2_CID_FLASH_READY:
829 *flags |= V4L2_CTRL_FLAG_READ_ONLY;
830 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300831 }
832}
833EXPORT_SYMBOL(v4l2_ctrl_fill);
834
835/* Helper function to determine whether the control type is compatible with
836 VIDIOC_G/S_CTRL. */
837static bool type_is_int(const struct v4l2_ctrl *ctrl)
838{
839 switch (ctrl->type) {
840 case V4L2_CTRL_TYPE_INTEGER64:
841 case V4L2_CTRL_TYPE_STRING:
842 /* Nope, these need v4l2_ext_control */
843 return false;
844 default:
845 return true;
846 }
847}
848
Hans Verkuil6e239392011-06-07 11:13:44 -0300849static void fill_event(struct v4l2_event *ev, struct v4l2_ctrl *ctrl, u32 changes)
850{
851 memset(ev->reserved, 0, sizeof(ev->reserved));
852 ev->type = V4L2_EVENT_CTRL;
853 ev->id = ctrl->id;
854 ev->u.ctrl.changes = changes;
855 ev->u.ctrl.type = ctrl->type;
856 ev->u.ctrl.flags = ctrl->flags;
857 if (ctrl->type == V4L2_CTRL_TYPE_STRING)
858 ev->u.ctrl.value64 = 0;
859 else
860 ev->u.ctrl.value64 = ctrl->cur.val64;
861 ev->u.ctrl.minimum = ctrl->minimum;
862 ev->u.ctrl.maximum = ctrl->maximum;
Sakari Ailusce580fe2011-08-04 13:51:11 -0300863 if (ctrl->type == V4L2_CTRL_TYPE_MENU
864 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil6e239392011-06-07 11:13:44 -0300865 ev->u.ctrl.step = 1;
866 else
867 ev->u.ctrl.step = ctrl->step;
868 ev->u.ctrl.default_value = ctrl->default_value;
869}
870
871static void send_event(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, u32 changes)
872{
873 struct v4l2_event ev;
Hans Verkuil77068d32011-06-13 18:55:58 -0300874 struct v4l2_subscribed_event *sev;
Hans Verkuil6e239392011-06-07 11:13:44 -0300875
Hans Verkuil77068d32011-06-13 18:55:58 -0300876 if (list_empty(&ctrl->ev_subs))
Hans Verkuil3f66f0e2011-06-20 11:56:24 -0300877 return;
Hans Verkuil6e239392011-06-07 11:13:44 -0300878 fill_event(&ev, ctrl, changes);
879
Hans Verkuil77068d32011-06-13 18:55:58 -0300880 list_for_each_entry(sev, &ctrl->ev_subs, node)
Hans de Goedee3e72f392011-10-26 05:52:47 -0300881 if (sev->fh != fh ||
882 (sev->flags & V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK))
Hans Verkuil77068d32011-06-13 18:55:58 -0300883 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -0300884}
885
Hans Verkuil09965172010-08-01 14:32:42 -0300886/* Helper function: copy the current control value back to the caller */
887static int cur_to_user(struct v4l2_ext_control *c,
888 struct v4l2_ctrl *ctrl)
889{
890 u32 len;
891
892 switch (ctrl->type) {
893 case V4L2_CTRL_TYPE_STRING:
894 len = strlen(ctrl->cur.string);
895 if (c->size < len + 1) {
896 c->size = len + 1;
897 return -ENOSPC;
898 }
899 return copy_to_user(c->string, ctrl->cur.string,
900 len + 1) ? -EFAULT : 0;
901 case V4L2_CTRL_TYPE_INTEGER64:
902 c->value64 = ctrl->cur.val64;
903 break;
904 default:
905 c->value = ctrl->cur.val;
906 break;
907 }
908 return 0;
909}
910
911/* Helper function: copy the caller-provider value as the new control value */
912static int user_to_new(struct v4l2_ext_control *c,
913 struct v4l2_ctrl *ctrl)
914{
915 int ret;
916 u32 size;
917
Hans Verkuil2a863792011-01-11 14:45:03 -0300918 ctrl->is_new = 1;
Hans Verkuil09965172010-08-01 14:32:42 -0300919 switch (ctrl->type) {
920 case V4L2_CTRL_TYPE_INTEGER64:
921 ctrl->val64 = c->value64;
922 break;
923 case V4L2_CTRL_TYPE_STRING:
924 size = c->size;
925 if (size == 0)
926 return -ERANGE;
927 if (size > ctrl->maximum + 1)
928 size = ctrl->maximum + 1;
929 ret = copy_from_user(ctrl->string, c->string, size);
930 if (!ret) {
931 char last = ctrl->string[size - 1];
932
933 ctrl->string[size - 1] = 0;
934 /* If the string was longer than ctrl->maximum,
935 then return an error. */
936 if (strlen(ctrl->string) == ctrl->maximum && last)
937 return -ERANGE;
938 }
939 return ret ? -EFAULT : 0;
940 default:
941 ctrl->val = c->value;
942 break;
943 }
944 return 0;
945}
946
947/* Helper function: copy the new control value back to the caller */
948static int new_to_user(struct v4l2_ext_control *c,
949 struct v4l2_ctrl *ctrl)
950{
951 u32 len;
952
953 switch (ctrl->type) {
954 case V4L2_CTRL_TYPE_STRING:
955 len = strlen(ctrl->string);
956 if (c->size < len + 1) {
957 c->size = ctrl->maximum + 1;
958 return -ENOSPC;
959 }
960 return copy_to_user(c->string, ctrl->string,
961 len + 1) ? -EFAULT : 0;
962 case V4L2_CTRL_TYPE_INTEGER64:
963 c->value64 = ctrl->val64;
964 break;
965 default:
966 c->value = ctrl->val;
967 break;
968 }
969 return 0;
970}
971
972/* Copy the new value to the current value. */
Hans Verkuilab892ba2011-06-07 06:47:18 -0300973static void new_to_cur(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl,
974 bool update_inactive)
Hans Verkuil09965172010-08-01 14:32:42 -0300975{
Hans Verkuil6e239392011-06-07 11:13:44 -0300976 bool changed = false;
977
Hans Verkuil09965172010-08-01 14:32:42 -0300978 if (ctrl == NULL)
979 return;
980 switch (ctrl->type) {
Hans Verkuil6e239392011-06-07 11:13:44 -0300981 case V4L2_CTRL_TYPE_BUTTON:
982 changed = true;
983 break;
Hans Verkuil09965172010-08-01 14:32:42 -0300984 case V4L2_CTRL_TYPE_STRING:
985 /* strings are always 0-terminated */
Hans Verkuil6e239392011-06-07 11:13:44 -0300986 changed = strcmp(ctrl->string, ctrl->cur.string);
Hans Verkuil09965172010-08-01 14:32:42 -0300987 strcpy(ctrl->cur.string, ctrl->string);
988 break;
989 case V4L2_CTRL_TYPE_INTEGER64:
Hans Verkuil6e239392011-06-07 11:13:44 -0300990 changed = ctrl->val64 != ctrl->cur.val64;
Hans Verkuil09965172010-08-01 14:32:42 -0300991 ctrl->cur.val64 = ctrl->val64;
992 break;
993 default:
Hans Verkuil6e239392011-06-07 11:13:44 -0300994 changed = ctrl->val != ctrl->cur.val;
Hans Verkuil09965172010-08-01 14:32:42 -0300995 ctrl->cur.val = ctrl->val;
996 break;
997 }
Hans Verkuil72d877c2011-06-10 05:44:36 -0300998 if (update_inactive) {
Hans Verkuil5626b8c2011-08-26 07:53:53 -0300999 /* Note: update_inactive can only be true for auto clusters. */
1000 ctrl->flags &=
1001 ~(V4L2_CTRL_FLAG_INACTIVE | V4L2_CTRL_FLAG_VOLATILE);
1002 if (!is_cur_manual(ctrl->cluster[0])) {
Hans Verkuil72d877c2011-06-10 05:44:36 -03001003 ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001004 if (ctrl->cluster[0]->has_volatiles)
1005 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
1006 }
Hans de Goede1249a3a2011-10-31 11:16:44 -03001007 fh = NULL;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001008 }
Hans Verkuil639884a2011-07-05 07:09:26 -03001009 if (changed || update_inactive) {
1010 /* If a control was changed that was not one of the controls
1011 modified by the application, then send the event to all. */
1012 if (!ctrl->is_new)
1013 fh = NULL;
Hans Verkuil6e239392011-06-07 11:13:44 -03001014 send_event(fh, ctrl,
1015 (changed ? V4L2_EVENT_CTRL_CH_VALUE : 0) |
1016 (update_inactive ? V4L2_EVENT_CTRL_CH_FLAGS : 0));
Hans Verkuil639884a2011-07-05 07:09:26 -03001017 }
Hans Verkuil09965172010-08-01 14:32:42 -03001018}
1019
1020/* Copy the current value to the new value */
1021static void cur_to_new(struct v4l2_ctrl *ctrl)
1022{
1023 if (ctrl == NULL)
1024 return;
1025 switch (ctrl->type) {
1026 case V4L2_CTRL_TYPE_STRING:
1027 /* strings are always 0-terminated */
1028 strcpy(ctrl->string, ctrl->cur.string);
1029 break;
1030 case V4L2_CTRL_TYPE_INTEGER64:
1031 ctrl->val64 = ctrl->cur.val64;
1032 break;
1033 default:
1034 ctrl->val = ctrl->cur.val;
1035 break;
1036 }
1037}
1038
1039/* Return non-zero if one or more of the controls in the cluster has a new
1040 value that differs from the current value. */
1041static int cluster_changed(struct v4l2_ctrl *master)
1042{
1043 int diff = 0;
1044 int i;
1045
1046 for (i = 0; !diff && i < master->ncontrols; i++) {
1047 struct v4l2_ctrl *ctrl = master->cluster[i];
1048
1049 if (ctrl == NULL)
1050 continue;
1051 switch (ctrl->type) {
1052 case V4L2_CTRL_TYPE_BUTTON:
1053 /* Button controls are always 'different' */
1054 return 1;
1055 case V4L2_CTRL_TYPE_STRING:
1056 /* strings are always 0-terminated */
1057 diff = strcmp(ctrl->string, ctrl->cur.string);
1058 break;
1059 case V4L2_CTRL_TYPE_INTEGER64:
1060 diff = ctrl->val64 != ctrl->cur.val64;
1061 break;
1062 default:
1063 diff = ctrl->val != ctrl->cur.val;
1064 break;
1065 }
1066 }
1067 return diff;
1068}
1069
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001070/* Validate integer-type control */
1071static int validate_new_int(const struct v4l2_ctrl *ctrl, s32 *pval)
Hans Verkuil09965172010-08-01 14:32:42 -03001072{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001073 s32 val = *pval;
Hans Verkuil09965172010-08-01 14:32:42 -03001074 u32 offset;
Hans Verkuil09965172010-08-01 14:32:42 -03001075
1076 switch (ctrl->type) {
1077 case V4L2_CTRL_TYPE_INTEGER:
1078 /* Round towards the closest legal value */
1079 val += ctrl->step / 2;
1080 if (val < ctrl->minimum)
1081 val = ctrl->minimum;
1082 if (val > ctrl->maximum)
1083 val = ctrl->maximum;
1084 offset = val - ctrl->minimum;
1085 offset = ctrl->step * (offset / ctrl->step);
1086 val = ctrl->minimum + offset;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001087 *pval = val;
Hans Verkuil09965172010-08-01 14:32:42 -03001088 return 0;
1089
1090 case V4L2_CTRL_TYPE_BOOLEAN:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001091 *pval = !!val;
Hans Verkuil09965172010-08-01 14:32:42 -03001092 return 0;
1093
1094 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001095 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuil09965172010-08-01 14:32:42 -03001096 if (val < ctrl->minimum || val > ctrl->maximum)
1097 return -ERANGE;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001098 if (ctrl->menu_skip_mask & (1 << val))
1099 return -EINVAL;
1100 if (ctrl->type == V4L2_CTRL_TYPE_MENU &&
1101 ctrl->qmenu[val][0] == '\0')
Hans Verkuil09965172010-08-01 14:32:42 -03001102 return -EINVAL;
1103 return 0;
1104
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001105 case V4L2_CTRL_TYPE_BITMASK:
1106 *pval &= ctrl->maximum;
1107 return 0;
1108
Hans Verkuil09965172010-08-01 14:32:42 -03001109 case V4L2_CTRL_TYPE_BUTTON:
1110 case V4L2_CTRL_TYPE_CTRL_CLASS:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001111 *pval = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001112 return 0;
1113
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001114 default:
1115 return -EINVAL;
1116 }
1117}
1118
1119/* Validate a new control */
1120static int validate_new(const struct v4l2_ctrl *ctrl, struct v4l2_ext_control *c)
1121{
1122 char *s = c->string;
1123 size_t len;
1124
1125 switch (ctrl->type) {
1126 case V4L2_CTRL_TYPE_INTEGER:
1127 case V4L2_CTRL_TYPE_BOOLEAN:
1128 case V4L2_CTRL_TYPE_MENU:
Sakari Ailusce580fe2011-08-04 13:51:11 -03001129 case V4L2_CTRL_TYPE_INTEGER_MENU:
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001130 case V4L2_CTRL_TYPE_BITMASK:
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001131 case V4L2_CTRL_TYPE_BUTTON:
1132 case V4L2_CTRL_TYPE_CTRL_CLASS:
1133 return validate_new_int(ctrl, &c->value);
1134
Hans Verkuil09965172010-08-01 14:32:42 -03001135 case V4L2_CTRL_TYPE_INTEGER64:
1136 return 0;
1137
1138 case V4L2_CTRL_TYPE_STRING:
1139 len = strlen(s);
1140 if (len < ctrl->minimum)
1141 return -ERANGE;
1142 if ((len - ctrl->minimum) % ctrl->step)
1143 return -ERANGE;
1144 return 0;
1145
1146 default:
1147 return -EINVAL;
1148 }
1149}
1150
1151static inline u32 node2id(struct list_head *node)
1152{
1153 return list_entry(node, struct v4l2_ctrl_ref, node)->ctrl->id;
1154}
1155
1156/* Set the handler's error code if it wasn't set earlier already */
1157static inline int handler_set_err(struct v4l2_ctrl_handler *hdl, int err)
1158{
1159 if (hdl->error == 0)
1160 hdl->error = err;
1161 return err;
1162}
1163
1164/* Initialize the handler */
1165int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
1166 unsigned nr_of_controls_hint)
1167{
1168 mutex_init(&hdl->lock);
1169 INIT_LIST_HEAD(&hdl->ctrls);
1170 INIT_LIST_HEAD(&hdl->ctrl_refs);
1171 hdl->nr_of_buckets = 1 + nr_of_controls_hint / 8;
Thomas Meyer9884d7b2011-11-29 17:08:00 -03001172 hdl->buckets = kcalloc(hdl->nr_of_buckets, sizeof(hdl->buckets[0]),
1173 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03001174 hdl->error = hdl->buckets ? 0 : -ENOMEM;
1175 return hdl->error;
1176}
1177EXPORT_SYMBOL(v4l2_ctrl_handler_init);
1178
1179/* Free all controls and control refs */
1180void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl)
1181{
1182 struct v4l2_ctrl_ref *ref, *next_ref;
1183 struct v4l2_ctrl *ctrl, *next_ctrl;
Hans Verkuil77068d32011-06-13 18:55:58 -03001184 struct v4l2_subscribed_event *sev, *next_sev;
Hans Verkuil09965172010-08-01 14:32:42 -03001185
1186 if (hdl == NULL || hdl->buckets == NULL)
1187 return;
1188
1189 mutex_lock(&hdl->lock);
1190 /* Free all nodes */
1191 list_for_each_entry_safe(ref, next_ref, &hdl->ctrl_refs, node) {
1192 list_del(&ref->node);
1193 kfree(ref);
1194 }
1195 /* Free all controls owned by the handler */
1196 list_for_each_entry_safe(ctrl, next_ctrl, &hdl->ctrls, node) {
1197 list_del(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001198 list_for_each_entry_safe(sev, next_sev, &ctrl->ev_subs, node)
1199 list_del(&sev->node);
Hans Verkuil09965172010-08-01 14:32:42 -03001200 kfree(ctrl);
1201 }
1202 kfree(hdl->buckets);
1203 hdl->buckets = NULL;
1204 hdl->cached = NULL;
1205 hdl->error = 0;
1206 mutex_unlock(&hdl->lock);
1207}
1208EXPORT_SYMBOL(v4l2_ctrl_handler_free);
1209
1210/* For backwards compatibility: V4L2_CID_PRIVATE_BASE should no longer
1211 be used except in G_CTRL, S_CTRL, QUERYCTRL and QUERYMENU when dealing
1212 with applications that do not use the NEXT_CTRL flag.
1213
1214 We just find the n-th private user control. It's O(N), but that should not
1215 be an issue in this particular case. */
1216static struct v4l2_ctrl_ref *find_private_ref(
1217 struct v4l2_ctrl_handler *hdl, u32 id)
1218{
1219 struct v4l2_ctrl_ref *ref;
1220
1221 id -= V4L2_CID_PRIVATE_BASE;
1222 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1223 /* Search for private user controls that are compatible with
1224 VIDIOC_G/S_CTRL. */
1225 if (V4L2_CTRL_ID2CLASS(ref->ctrl->id) == V4L2_CTRL_CLASS_USER &&
1226 V4L2_CTRL_DRIVER_PRIV(ref->ctrl->id)) {
1227 if (!type_is_int(ref->ctrl))
1228 continue;
1229 if (id == 0)
1230 return ref;
1231 id--;
1232 }
1233 }
1234 return NULL;
1235}
1236
1237/* Find a control with the given ID. */
1238static struct v4l2_ctrl_ref *find_ref(struct v4l2_ctrl_handler *hdl, u32 id)
1239{
1240 struct v4l2_ctrl_ref *ref;
1241 int bucket;
1242
1243 id &= V4L2_CTRL_ID_MASK;
1244
1245 /* Old-style private controls need special handling */
1246 if (id >= V4L2_CID_PRIVATE_BASE)
1247 return find_private_ref(hdl, id);
1248 bucket = id % hdl->nr_of_buckets;
1249
1250 /* Simple optimization: cache the last control found */
1251 if (hdl->cached && hdl->cached->ctrl->id == id)
1252 return hdl->cached;
1253
1254 /* Not in cache, search the hash */
1255 ref = hdl->buckets ? hdl->buckets[bucket] : NULL;
1256 while (ref && ref->ctrl->id != id)
1257 ref = ref->next;
1258
1259 if (ref)
1260 hdl->cached = ref; /* cache it! */
1261 return ref;
1262}
1263
1264/* Find a control with the given ID. Take the handler's lock first. */
1265static struct v4l2_ctrl_ref *find_ref_lock(
1266 struct v4l2_ctrl_handler *hdl, u32 id)
1267{
1268 struct v4l2_ctrl_ref *ref = NULL;
1269
1270 if (hdl) {
1271 mutex_lock(&hdl->lock);
1272 ref = find_ref(hdl, id);
1273 mutex_unlock(&hdl->lock);
1274 }
1275 return ref;
1276}
1277
1278/* Find a control with the given ID. */
1279struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id)
1280{
1281 struct v4l2_ctrl_ref *ref = find_ref_lock(hdl, id);
1282
1283 return ref ? ref->ctrl : NULL;
1284}
1285EXPORT_SYMBOL(v4l2_ctrl_find);
1286
1287/* Allocate a new v4l2_ctrl_ref and hook it into the handler. */
1288static int handler_new_ref(struct v4l2_ctrl_handler *hdl,
1289 struct v4l2_ctrl *ctrl)
1290{
1291 struct v4l2_ctrl_ref *ref;
1292 struct v4l2_ctrl_ref *new_ref;
1293 u32 id = ctrl->id;
1294 u32 class_ctrl = V4L2_CTRL_ID2CLASS(id) | 1;
1295 int bucket = id % hdl->nr_of_buckets; /* which bucket to use */
1296
1297 /* Automatically add the control class if it is not yet present. */
1298 if (id != class_ctrl && find_ref_lock(hdl, class_ctrl) == NULL)
1299 if (!v4l2_ctrl_new_std(hdl, NULL, class_ctrl, 0, 0, 0, 0))
1300 return hdl->error;
1301
1302 if (hdl->error)
1303 return hdl->error;
1304
1305 new_ref = kzalloc(sizeof(*new_ref), GFP_KERNEL);
1306 if (!new_ref)
1307 return handler_set_err(hdl, -ENOMEM);
1308 new_ref->ctrl = ctrl;
1309 if (ctrl->handler == hdl) {
1310 /* By default each control starts in a cluster of its own.
1311 new_ref->ctrl is basically a cluster array with one
1312 element, so that's perfect to use as the cluster pointer.
1313 But only do this for the handler that owns the control. */
1314 ctrl->cluster = &new_ref->ctrl;
1315 ctrl->ncontrols = 1;
1316 }
1317
1318 INIT_LIST_HEAD(&new_ref->node);
1319
1320 mutex_lock(&hdl->lock);
1321
1322 /* Add immediately at the end of the list if the list is empty, or if
1323 the last element in the list has a lower ID.
1324 This ensures that when elements are added in ascending order the
1325 insertion is an O(1) operation. */
1326 if (list_empty(&hdl->ctrl_refs) || id > node2id(hdl->ctrl_refs.prev)) {
1327 list_add_tail(&new_ref->node, &hdl->ctrl_refs);
1328 goto insert_in_hash;
1329 }
1330
1331 /* Find insert position in sorted list */
1332 list_for_each_entry(ref, &hdl->ctrl_refs, node) {
1333 if (ref->ctrl->id < id)
1334 continue;
1335 /* Don't add duplicates */
1336 if (ref->ctrl->id == id) {
1337 kfree(new_ref);
1338 goto unlock;
1339 }
1340 list_add(&new_ref->node, ref->node.prev);
1341 break;
1342 }
1343
1344insert_in_hash:
1345 /* Insert the control node in the hash */
1346 new_ref->next = hdl->buckets[bucket];
1347 hdl->buckets[bucket] = new_ref;
1348
1349unlock:
1350 mutex_unlock(&hdl->lock);
1351 return 0;
1352}
1353
1354/* Add a new control */
1355static struct v4l2_ctrl *v4l2_ctrl_new(struct v4l2_ctrl_handler *hdl,
1356 const struct v4l2_ctrl_ops *ops,
1357 u32 id, const char *name, enum v4l2_ctrl_type type,
1358 s32 min, s32 max, u32 step, s32 def,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001359 u32 flags, const char * const *qmenu,
1360 const s64 *qmenu_int, void *priv)
Hans Verkuil09965172010-08-01 14:32:42 -03001361{
1362 struct v4l2_ctrl *ctrl;
1363 unsigned sz_extra = 0;
1364
1365 if (hdl->error)
1366 return NULL;
1367
1368 /* Sanity checks */
1369 if (id == 0 || name == NULL || id >= V4L2_CID_PRIVATE_BASE ||
Hans Verkuil09965172010-08-01 14:32:42 -03001370 (type == V4L2_CTRL_TYPE_INTEGER && step == 0) ||
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001371 (type == V4L2_CTRL_TYPE_BITMASK && max == 0) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001372 (type == V4L2_CTRL_TYPE_MENU && qmenu == NULL) ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001373 (type == V4L2_CTRL_TYPE_INTEGER_MENU && qmenu_int == NULL) ||
Hans Verkuil09965172010-08-01 14:32:42 -03001374 (type == V4L2_CTRL_TYPE_STRING && max == 0)) {
1375 handler_set_err(hdl, -ERANGE);
1376 return NULL;
1377 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001378 if (type != V4L2_CTRL_TYPE_BITMASK && max < min) {
1379 handler_set_err(hdl, -ERANGE);
1380 return NULL;
1381 }
Hans Verkuil02ac0482010-12-29 14:27:05 -03001382 if ((type == V4L2_CTRL_TYPE_INTEGER ||
1383 type == V4L2_CTRL_TYPE_MENU ||
Sakari Ailusce580fe2011-08-04 13:51:11 -03001384 type == V4L2_CTRL_TYPE_INTEGER_MENU ||
Hans Verkuil02ac0482010-12-29 14:27:05 -03001385 type == V4L2_CTRL_TYPE_BOOLEAN) &&
1386 (def < min || def > max)) {
1387 handler_set_err(hdl, -ERANGE);
1388 return NULL;
1389 }
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001390 if (type == V4L2_CTRL_TYPE_BITMASK && ((def & ~max) || min || step)) {
1391 handler_set_err(hdl, -ERANGE);
1392 return NULL;
1393 }
Hans Verkuil09965172010-08-01 14:32:42 -03001394
1395 if (type == V4L2_CTRL_TYPE_BUTTON)
1396 flags |= V4L2_CTRL_FLAG_WRITE_ONLY;
1397 else if (type == V4L2_CTRL_TYPE_CTRL_CLASS)
1398 flags |= V4L2_CTRL_FLAG_READ_ONLY;
1399 else if (type == V4L2_CTRL_TYPE_STRING)
1400 sz_extra += 2 * (max + 1);
1401
1402 ctrl = kzalloc(sizeof(*ctrl) + sz_extra, GFP_KERNEL);
1403 if (ctrl == NULL) {
1404 handler_set_err(hdl, -ENOMEM);
1405 return NULL;
1406 }
1407
1408 INIT_LIST_HEAD(&ctrl->node);
Hans Verkuil77068d32011-06-13 18:55:58 -03001409 INIT_LIST_HEAD(&ctrl->ev_subs);
Hans Verkuil09965172010-08-01 14:32:42 -03001410 ctrl->handler = hdl;
1411 ctrl->ops = ops;
1412 ctrl->id = id;
1413 ctrl->name = name;
1414 ctrl->type = type;
1415 ctrl->flags = flags;
1416 ctrl->minimum = min;
1417 ctrl->maximum = max;
1418 ctrl->step = step;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001419 if (type == V4L2_CTRL_TYPE_MENU)
1420 ctrl->qmenu = qmenu;
1421 else if (type == V4L2_CTRL_TYPE_INTEGER_MENU)
1422 ctrl->qmenu_int = qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001423 ctrl->priv = priv;
1424 ctrl->cur.val = ctrl->val = ctrl->default_value = def;
1425
1426 if (ctrl->type == V4L2_CTRL_TYPE_STRING) {
1427 ctrl->cur.string = (char *)&ctrl[1] + sz_extra - (max + 1);
1428 ctrl->string = (char *)&ctrl[1] + sz_extra - 2 * (max + 1);
1429 if (ctrl->minimum)
1430 memset(ctrl->cur.string, ' ', ctrl->minimum);
1431 }
1432 if (handler_new_ref(hdl, ctrl)) {
1433 kfree(ctrl);
1434 return NULL;
1435 }
1436 mutex_lock(&hdl->lock);
1437 list_add_tail(&ctrl->node, &hdl->ctrls);
1438 mutex_unlock(&hdl->lock);
1439 return ctrl;
1440}
1441
1442struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
1443 const struct v4l2_ctrl_config *cfg, void *priv)
1444{
1445 bool is_menu;
1446 struct v4l2_ctrl *ctrl;
1447 const char *name = cfg->name;
Hans Verkuil513521e2010-12-29 14:25:52 -03001448 const char * const *qmenu = cfg->qmenu;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001449 const s64 *qmenu_int = cfg->qmenu_int;
Hans Verkuil09965172010-08-01 14:32:42 -03001450 enum v4l2_ctrl_type type = cfg->type;
1451 u32 flags = cfg->flags;
1452 s32 min = cfg->min;
1453 s32 max = cfg->max;
1454 u32 step = cfg->step;
1455 s32 def = cfg->def;
1456
1457 if (name == NULL)
1458 v4l2_ctrl_fill(cfg->id, &name, &type, &min, &max, &step,
1459 &def, &flags);
1460
Sakari Ailusce580fe2011-08-04 13:51:11 -03001461 is_menu = (cfg->type == V4L2_CTRL_TYPE_MENU ||
1462 cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU);
Hans Verkuil09965172010-08-01 14:32:42 -03001463 if (is_menu)
1464 WARN_ON(step);
1465 else
1466 WARN_ON(cfg->menu_skip_mask);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001467 if (cfg->type == V4L2_CTRL_TYPE_MENU && qmenu == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001468 qmenu = v4l2_ctrl_get_menu(cfg->id);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001469 else if (cfg->type == V4L2_CTRL_TYPE_INTEGER_MENU &&
1470 qmenu_int == NULL) {
1471 handler_set_err(hdl, -EINVAL);
1472 return NULL;
1473 }
Hans Verkuil09965172010-08-01 14:32:42 -03001474
1475 ctrl = v4l2_ctrl_new(hdl, cfg->ops, cfg->id, name,
1476 type, min, max,
1477 is_menu ? cfg->menu_skip_mask : step,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001478 def, flags, qmenu, qmenu_int, priv);
Hans Verkuil88365102011-08-26 07:35:14 -03001479 if (ctrl)
Hans Verkuil09965172010-08-01 14:32:42 -03001480 ctrl->is_private = cfg->is_private;
Hans Verkuil09965172010-08-01 14:32:42 -03001481 return ctrl;
1482}
1483EXPORT_SYMBOL(v4l2_ctrl_new_custom);
1484
1485/* Helper function for standard non-menu controls */
1486struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
1487 const struct v4l2_ctrl_ops *ops,
1488 u32 id, s32 min, s32 max, u32 step, s32 def)
1489{
1490 const char *name;
1491 enum v4l2_ctrl_type type;
1492 u32 flags;
1493
1494 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
Sakari Ailusce580fe2011-08-04 13:51:11 -03001495 if (type == V4L2_CTRL_TYPE_MENU
1496 || type == V4L2_CTRL_TYPE_INTEGER_MENU) {
Hans Verkuil09965172010-08-01 14:32:42 -03001497 handler_set_err(hdl, -EINVAL);
1498 return NULL;
1499 }
1500 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001501 min, max, step, def, flags, NULL, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001502}
1503EXPORT_SYMBOL(v4l2_ctrl_new_std);
1504
1505/* Helper function for standard menu controls */
1506struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
1507 const struct v4l2_ctrl_ops *ops,
1508 u32 id, s32 max, s32 mask, s32 def)
1509{
Hans Verkuil513521e2010-12-29 14:25:52 -03001510 const char * const *qmenu = v4l2_ctrl_get_menu(id);
Hans Verkuil09965172010-08-01 14:32:42 -03001511 const char *name;
1512 enum v4l2_ctrl_type type;
1513 s32 min;
1514 s32 step;
1515 u32 flags;
1516
1517 v4l2_ctrl_fill(id, &name, &type, &min, &max, &step, &def, &flags);
1518 if (type != V4L2_CTRL_TYPE_MENU) {
1519 handler_set_err(hdl, -EINVAL);
1520 return NULL;
1521 }
1522 return v4l2_ctrl_new(hdl, ops, id, name, type,
Sakari Ailusce580fe2011-08-04 13:51:11 -03001523 0, max, mask, def, flags, qmenu, NULL, NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001524}
1525EXPORT_SYMBOL(v4l2_ctrl_new_std_menu);
1526
1527/* Add a control from another handler to this handler */
1528struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
1529 struct v4l2_ctrl *ctrl)
1530{
1531 if (hdl == NULL || hdl->error)
1532 return NULL;
1533 if (ctrl == NULL) {
1534 handler_set_err(hdl, -EINVAL);
1535 return NULL;
1536 }
1537 if (ctrl->handler == hdl)
1538 return ctrl;
1539 return handler_new_ref(hdl, ctrl) ? NULL : ctrl;
1540}
1541EXPORT_SYMBOL(v4l2_ctrl_add_ctrl);
1542
1543/* Add the controls from another handler to our own. */
1544int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
1545 struct v4l2_ctrl_handler *add)
1546{
Hans Verkuil072e6602012-03-02 12:41:25 -03001547 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001548 int ret = 0;
1549
1550 /* Do nothing if either handler is NULL or if they are the same */
1551 if (!hdl || !add || hdl == add)
1552 return 0;
1553 if (hdl->error)
1554 return hdl->error;
1555 mutex_lock(&add->lock);
Hans Verkuil072e6602012-03-02 12:41:25 -03001556 list_for_each_entry(ref, &add->ctrl_refs, node) {
1557 struct v4l2_ctrl *ctrl = ref->ctrl;
1558
Hans Verkuil09965172010-08-01 14:32:42 -03001559 /* Skip handler-private controls. */
1560 if (ctrl->is_private)
1561 continue;
Hans Verkuil6e239392011-06-07 11:13:44 -03001562 /* And control classes */
1563 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1564 continue;
Hans Verkuil09965172010-08-01 14:32:42 -03001565 ret = handler_new_ref(hdl, ctrl);
1566 if (ret)
1567 break;
1568 }
1569 mutex_unlock(&add->lock);
1570 return ret;
1571}
1572EXPORT_SYMBOL(v4l2_ctrl_add_handler);
1573
1574/* Cluster controls */
1575void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls)
1576{
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001577 bool has_volatiles = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001578 int i;
1579
1580 /* The first control is the master control and it must not be NULL */
Hans Verkuil72d877c2011-06-10 05:44:36 -03001581 BUG_ON(ncontrols == 0 || controls[0] == NULL);
Hans Verkuil09965172010-08-01 14:32:42 -03001582
1583 for (i = 0; i < ncontrols; i++) {
1584 if (controls[i]) {
1585 controls[i]->cluster = controls;
1586 controls[i]->ncontrols = ncontrols;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001587 if (controls[i]->flags & V4L2_CTRL_FLAG_VOLATILE)
1588 has_volatiles = true;
Hans Verkuil09965172010-08-01 14:32:42 -03001589 }
1590 }
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001591 controls[0]->has_volatiles = has_volatiles;
Hans Verkuil09965172010-08-01 14:32:42 -03001592}
1593EXPORT_SYMBOL(v4l2_ctrl_cluster);
1594
Hans Verkuil72d877c2011-06-10 05:44:36 -03001595void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
1596 u8 manual_val, bool set_volatile)
1597{
1598 struct v4l2_ctrl *master = controls[0];
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001599 u32 flag = 0;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001600 int i;
1601
1602 v4l2_ctrl_cluster(ncontrols, controls);
1603 WARN_ON(ncontrols <= 1);
Hans Verkuil82a7c042011-06-28 10:43:13 -03001604 WARN_ON(manual_val < master->minimum || manual_val > master->maximum);
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001605 WARN_ON(set_volatile && !has_op(master, g_volatile_ctrl));
Hans Verkuil72d877c2011-06-10 05:44:36 -03001606 master->is_auto = true;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001607 master->has_volatiles = set_volatile;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001608 master->manual_mode_value = manual_val;
1609 master->flags |= V4L2_CTRL_FLAG_UPDATE;
Hans Verkuil5626b8c2011-08-26 07:53:53 -03001610
1611 if (!is_cur_manual(master))
1612 flag = V4L2_CTRL_FLAG_INACTIVE |
1613 (set_volatile ? V4L2_CTRL_FLAG_VOLATILE : 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03001614
1615 for (i = 1; i < ncontrols; i++)
Hans Verkuil88365102011-08-26 07:35:14 -03001616 if (controls[i])
Hans Verkuil72d877c2011-06-10 05:44:36 -03001617 controls[i]->flags |= flag;
Hans Verkuil72d877c2011-06-10 05:44:36 -03001618}
1619EXPORT_SYMBOL(v4l2_ctrl_auto_cluster);
1620
Hans Verkuil09965172010-08-01 14:32:42 -03001621/* Activate/deactivate a control. */
1622void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active)
1623{
Hans Verkuil6e239392011-06-07 11:13:44 -03001624 /* invert since the actual flag is called 'inactive' */
1625 bool inactive = !active;
1626 bool old;
1627
Hans Verkuil09965172010-08-01 14:32:42 -03001628 if (ctrl == NULL)
1629 return;
1630
Hans Verkuil6e239392011-06-07 11:13:44 -03001631 if (inactive)
Hans Verkuil09965172010-08-01 14:32:42 -03001632 /* set V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001633 old = test_and_set_bit(4, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001634 else
1635 /* clear V4L2_CTRL_FLAG_INACTIVE */
Hans Verkuil6e239392011-06-07 11:13:44 -03001636 old = test_and_clear_bit(4, &ctrl->flags);
1637 if (old != inactive)
1638 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
Hans Verkuil09965172010-08-01 14:32:42 -03001639}
1640EXPORT_SYMBOL(v4l2_ctrl_activate);
1641
1642/* Grab/ungrab a control.
1643 Typically used when streaming starts and you want to grab controls,
1644 preventing the user from changing them.
1645
1646 Just call this and the framework will block any attempts to change
1647 these controls. */
1648void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed)
1649{
Hans Verkuil6e239392011-06-07 11:13:44 -03001650 bool old;
1651
Hans Verkuil09965172010-08-01 14:32:42 -03001652 if (ctrl == NULL)
1653 return;
1654
Hans Verkuil6e239392011-06-07 11:13:44 -03001655 v4l2_ctrl_lock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001656 if (grabbed)
1657 /* set V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001658 old = test_and_set_bit(1, &ctrl->flags);
Hans Verkuil09965172010-08-01 14:32:42 -03001659 else
1660 /* clear V4L2_CTRL_FLAG_GRABBED */
Hans Verkuil6e239392011-06-07 11:13:44 -03001661 old = test_and_clear_bit(1, &ctrl->flags);
1662 if (old != grabbed)
1663 send_event(NULL, ctrl, V4L2_EVENT_CTRL_CH_FLAGS);
1664 v4l2_ctrl_unlock(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001665}
1666EXPORT_SYMBOL(v4l2_ctrl_grab);
1667
1668/* Log the control name and value */
1669static void log_ctrl(const struct v4l2_ctrl *ctrl,
1670 const char *prefix, const char *colon)
1671{
Hans Verkuil09965172010-08-01 14:32:42 -03001672 if (ctrl->flags & (V4L2_CTRL_FLAG_DISABLED | V4L2_CTRL_FLAG_WRITE_ONLY))
1673 return;
1674 if (ctrl->type == V4L2_CTRL_TYPE_CTRL_CLASS)
1675 return;
1676
1677 printk(KERN_INFO "%s%s%s: ", prefix, colon, ctrl->name);
1678
1679 switch (ctrl->type) {
1680 case V4L2_CTRL_TYPE_INTEGER:
1681 printk(KERN_CONT "%d", ctrl->cur.val);
1682 break;
1683 case V4L2_CTRL_TYPE_BOOLEAN:
1684 printk(KERN_CONT "%s", ctrl->cur.val ? "true" : "false");
1685 break;
1686 case V4L2_CTRL_TYPE_MENU:
1687 printk(KERN_CONT "%s", ctrl->qmenu[ctrl->cur.val]);
1688 break;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001689 case V4L2_CTRL_TYPE_INTEGER_MENU:
1690 printk(KERN_CONT "%lld", ctrl->qmenu_int[ctrl->cur.val]);
1691 break;
Hans Verkuilfa4d7092011-05-23 04:07:05 -03001692 case V4L2_CTRL_TYPE_BITMASK:
1693 printk(KERN_CONT "0x%08x", ctrl->cur.val);
1694 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001695 case V4L2_CTRL_TYPE_INTEGER64:
1696 printk(KERN_CONT "%lld", ctrl->cur.val64);
1697 break;
1698 case V4L2_CTRL_TYPE_STRING:
1699 printk(KERN_CONT "%s", ctrl->cur.string);
1700 break;
1701 default:
1702 printk(KERN_CONT "unknown type %d", ctrl->type);
1703 break;
1704 }
Hans Verkuil88365102011-08-26 07:35:14 -03001705 if (ctrl->flags & (V4L2_CTRL_FLAG_INACTIVE |
1706 V4L2_CTRL_FLAG_GRABBED |
1707 V4L2_CTRL_FLAG_VOLATILE)) {
1708 if (ctrl->flags & V4L2_CTRL_FLAG_INACTIVE)
1709 printk(KERN_CONT " inactive");
1710 if (ctrl->flags & V4L2_CTRL_FLAG_GRABBED)
1711 printk(KERN_CONT " grabbed");
1712 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE)
1713 printk(KERN_CONT " volatile");
1714 }
1715 printk(KERN_CONT "\n");
Hans Verkuil09965172010-08-01 14:32:42 -03001716}
1717
1718/* Log all controls owned by the handler */
1719void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
1720 const char *prefix)
1721{
1722 struct v4l2_ctrl *ctrl;
1723 const char *colon = "";
1724 int len;
1725
1726 if (hdl == NULL)
1727 return;
1728 if (prefix == NULL)
1729 prefix = "";
1730 len = strlen(prefix);
1731 if (len && prefix[len - 1] != ' ')
1732 colon = ": ";
1733 mutex_lock(&hdl->lock);
1734 list_for_each_entry(ctrl, &hdl->ctrls, node)
1735 if (!(ctrl->flags & V4L2_CTRL_FLAG_DISABLED))
1736 log_ctrl(ctrl, prefix, colon);
1737 mutex_unlock(&hdl->lock);
1738}
1739EXPORT_SYMBOL(v4l2_ctrl_handler_log_status);
1740
1741/* Call s_ctrl for all controls owned by the handler */
1742int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl)
1743{
1744 struct v4l2_ctrl *ctrl;
1745 int ret = 0;
1746
1747 if (hdl == NULL)
1748 return 0;
1749 mutex_lock(&hdl->lock);
1750 list_for_each_entry(ctrl, &hdl->ctrls, node)
1751 ctrl->done = false;
1752
1753 list_for_each_entry(ctrl, &hdl->ctrls, node) {
1754 struct v4l2_ctrl *master = ctrl->cluster[0];
1755 int i;
1756
1757 /* Skip if this control was already handled by a cluster. */
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001758 /* Skip button controls and read-only controls. */
1759 if (ctrl->done || ctrl->type == V4L2_CTRL_TYPE_BUTTON ||
1760 (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY))
Hans Verkuil09965172010-08-01 14:32:42 -03001761 continue;
1762
Hans Verkuil2a863792011-01-11 14:45:03 -03001763 for (i = 0; i < master->ncontrols; i++) {
1764 if (master->cluster[i]) {
1765 cur_to_new(master->cluster[i]);
1766 master->cluster[i]->is_new = 1;
Hans Verkuil71c6c4c2011-06-14 11:01:52 -03001767 master->cluster[i]->done = true;
Hans Verkuil2a863792011-01-11 14:45:03 -03001768 }
1769 }
Hans Verkuil54c911e2011-05-25 06:04:58 -03001770 ret = call_op(master, s_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03001771 if (ret)
1772 break;
Hans Verkuil09965172010-08-01 14:32:42 -03001773 }
1774 mutex_unlock(&hdl->lock);
1775 return ret;
1776}
1777EXPORT_SYMBOL(v4l2_ctrl_handler_setup);
1778
1779/* Implement VIDIOC_QUERYCTRL */
1780int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc)
1781{
1782 u32 id = qc->id & V4L2_CTRL_ID_MASK;
1783 struct v4l2_ctrl_ref *ref;
1784 struct v4l2_ctrl *ctrl;
1785
1786 if (hdl == NULL)
1787 return -EINVAL;
1788
1789 mutex_lock(&hdl->lock);
1790
1791 /* Try to find it */
1792 ref = find_ref(hdl, id);
1793
1794 if ((qc->id & V4L2_CTRL_FLAG_NEXT_CTRL) && !list_empty(&hdl->ctrl_refs)) {
1795 /* Find the next control with ID > qc->id */
1796
1797 /* Did we reach the end of the control list? */
1798 if (id >= node2id(hdl->ctrl_refs.prev)) {
1799 ref = NULL; /* Yes, so there is no next control */
1800 } else if (ref) {
1801 /* We found a control with the given ID, so just get
1802 the next one in the list. */
1803 ref = list_entry(ref->node.next, typeof(*ref), node);
1804 } else {
1805 /* No control with the given ID exists, so start
1806 searching for the next largest ID. We know there
1807 is one, otherwise the first 'if' above would have
1808 been true. */
1809 list_for_each_entry(ref, &hdl->ctrl_refs, node)
1810 if (id < ref->ctrl->id)
1811 break;
1812 }
1813 }
1814 mutex_unlock(&hdl->lock);
1815 if (!ref)
1816 return -EINVAL;
1817
1818 ctrl = ref->ctrl;
1819 memset(qc, 0, sizeof(*qc));
Hans Verkuil829fb2d2011-01-16 11:21:40 -03001820 if (id >= V4L2_CID_PRIVATE_BASE)
1821 qc->id = id;
1822 else
1823 qc->id = ctrl->id;
Hans Verkuil09965172010-08-01 14:32:42 -03001824 strlcpy(qc->name, ctrl->name, sizeof(qc->name));
1825 qc->minimum = ctrl->minimum;
1826 qc->maximum = ctrl->maximum;
1827 qc->default_value = ctrl->default_value;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001828 if (ctrl->type == V4L2_CTRL_TYPE_MENU
1829 || ctrl->type == V4L2_CTRL_TYPE_INTEGER_MENU)
Hans Verkuil09965172010-08-01 14:32:42 -03001830 qc->step = 1;
1831 else
1832 qc->step = ctrl->step;
1833 qc->flags = ctrl->flags;
1834 qc->type = ctrl->type;
1835 return 0;
1836}
1837EXPORT_SYMBOL(v4l2_queryctrl);
1838
1839int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc)
1840{
Hans Verkuil87a0c942011-02-22 12:31:07 -03001841 if (qc->id & V4L2_CTRL_FLAG_NEXT_CTRL)
1842 return -EINVAL;
Hans Verkuil09965172010-08-01 14:32:42 -03001843 return v4l2_queryctrl(sd->ctrl_handler, qc);
1844}
1845EXPORT_SYMBOL(v4l2_subdev_queryctrl);
1846
1847/* Implement VIDIOC_QUERYMENU */
1848int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm)
1849{
1850 struct v4l2_ctrl *ctrl;
1851 u32 i = qm->index;
1852
1853 ctrl = v4l2_ctrl_find(hdl, qm->id);
1854 if (!ctrl)
1855 return -EINVAL;
1856
1857 qm->reserved = 0;
1858 /* Sanity checks */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001859 switch (ctrl->type) {
1860 case V4L2_CTRL_TYPE_MENU:
1861 if (ctrl->qmenu == NULL)
1862 return -EINVAL;
1863 break;
1864 case V4L2_CTRL_TYPE_INTEGER_MENU:
1865 if (ctrl->qmenu_int == NULL)
1866 return -EINVAL;
1867 break;
1868 default:
Hans Verkuil09965172010-08-01 14:32:42 -03001869 return -EINVAL;
Sakari Ailusce580fe2011-08-04 13:51:11 -03001870 }
1871
1872 if (i < ctrl->minimum || i > ctrl->maximum)
1873 return -EINVAL;
1874
Hans Verkuil09965172010-08-01 14:32:42 -03001875 /* Use mask to see if this menu item should be skipped */
1876 if (ctrl->menu_skip_mask & (1 << i))
1877 return -EINVAL;
1878 /* Empty menu items should also be skipped */
Sakari Ailusce580fe2011-08-04 13:51:11 -03001879 if (ctrl->type == V4L2_CTRL_TYPE_MENU) {
1880 if (ctrl->qmenu[i] == NULL || ctrl->qmenu[i][0] == '\0')
1881 return -EINVAL;
1882 strlcpy(qm->name, ctrl->qmenu[i], sizeof(qm->name));
1883 } else {
1884 qm->value = ctrl->qmenu_int[i];
1885 }
Hans Verkuil09965172010-08-01 14:32:42 -03001886 return 0;
1887}
1888EXPORT_SYMBOL(v4l2_querymenu);
1889
1890int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm)
1891{
1892 return v4l2_querymenu(sd->ctrl_handler, qm);
1893}
1894EXPORT_SYMBOL(v4l2_subdev_querymenu);
1895
1896
1897
1898/* Some general notes on the atomic requirements of VIDIOC_G/TRY/S_EXT_CTRLS:
1899
1900 It is not a fully atomic operation, just best-effort only. After all, if
1901 multiple controls have to be set through multiple i2c writes (for example)
1902 then some initial writes may succeed while others fail. Thus leaving the
1903 system in an inconsistent state. The question is how much effort you are
1904 willing to spend on trying to make something atomic that really isn't.
1905
1906 From the point of view of an application the main requirement is that
1907 when you call VIDIOC_S_EXT_CTRLS and some values are invalid then an
1908 error should be returned without actually affecting any controls.
1909
1910 If all the values are correct, then it is acceptable to just give up
1911 in case of low-level errors.
1912
1913 It is important though that the application can tell when only a partial
1914 configuration was done. The way we do that is through the error_idx field
1915 of struct v4l2_ext_controls: if that is equal to the count field then no
1916 controls were affected. Otherwise all controls before that index were
1917 successful in performing their 'get' or 'set' operation, the control at
1918 the given index failed, and you don't know what happened with the controls
1919 after the failed one. Since if they were part of a control cluster they
1920 could have been successfully processed (if a cluster member was encountered
1921 at index < error_idx), they could have failed (if a cluster member was at
1922 error_idx), or they may not have been processed yet (if the first cluster
1923 member appeared after error_idx).
1924
1925 It is all fairly theoretical, though. In practice all you can do is to
1926 bail out. If error_idx == count, then it is an application bug. If
1927 error_idx < count then it is only an application bug if the error code was
1928 EBUSY. That usually means that something started streaming just when you
1929 tried to set the controls. In all other cases it is a driver/hardware
1930 problem and all you can do is to retry or bail out.
1931
1932 Note that these rules do not apply to VIDIOC_TRY_EXT_CTRLS: since that
1933 never modifies controls the error_idx is just set to whatever control
1934 has an invalid value.
1935 */
1936
1937/* Prepare for the extended g/s/try functions.
1938 Find the controls in the control array and do some basic checks. */
1939static int prepare_ext_ctrls(struct v4l2_ctrl_handler *hdl,
1940 struct v4l2_ext_controls *cs,
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001941 struct v4l2_ctrl_helper *helpers)
Hans Verkuil09965172010-08-01 14:32:42 -03001942{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001943 struct v4l2_ctrl_helper *h;
1944 bool have_clusters = false;
Hans Verkuil09965172010-08-01 14:32:42 -03001945 u32 i;
1946
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001947 for (i = 0, h = helpers; i < cs->count; i++, h++) {
Hans Verkuil09965172010-08-01 14:32:42 -03001948 struct v4l2_ext_control *c = &cs->controls[i];
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001949 struct v4l2_ctrl_ref *ref;
Hans Verkuil09965172010-08-01 14:32:42 -03001950 struct v4l2_ctrl *ctrl;
1951 u32 id = c->id & V4L2_CTRL_ID_MASK;
1952
Hans Verkuil37cd3b72011-06-07 04:40:04 -03001953 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03001954
1955 if (cs->ctrl_class && V4L2_CTRL_ID2CLASS(id) != cs->ctrl_class)
1956 return -EINVAL;
1957
1958 /* Old-style private controls are not allowed for
1959 extended controls */
1960 if (id >= V4L2_CID_PRIVATE_BASE)
1961 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001962 ref = find_ref_lock(hdl, id);
1963 if (ref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03001964 return -EINVAL;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001965 ctrl = ref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03001966 if (ctrl->flags & V4L2_CTRL_FLAG_DISABLED)
1967 return -EINVAL;
1968
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001969 if (ctrl->cluster[0]->ncontrols > 1)
1970 have_clusters = true;
1971 if (ctrl->cluster[0] != ctrl)
1972 ref = find_ref_lock(hdl, ctrl->cluster[0]->id);
1973 /* Store the ref to the master control of the cluster */
1974 h->mref = ref;
1975 h->ctrl = ctrl;
1976 /* Initially set next to 0, meaning that there is no other
1977 control in this helper array belonging to the same
1978 cluster */
1979 h->next = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03001980 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03001981
1982 /* We are done if there were no controls that belong to a multi-
1983 control cluster. */
1984 if (!have_clusters)
1985 return 0;
1986
1987 /* The code below figures out in O(n) time which controls in the list
1988 belong to the same cluster. */
1989
1990 /* This has to be done with the handler lock taken. */
1991 mutex_lock(&hdl->lock);
1992
1993 /* First zero the helper field in the master control references */
1994 for (i = 0; i < cs->count; i++)
1995 helpers[i].mref->helper = 0;
1996 for (i = 0, h = helpers; i < cs->count; i++, h++) {
1997 struct v4l2_ctrl_ref *mref = h->mref;
1998
1999 /* If the mref->helper is set, then it points to an earlier
2000 helper that belongs to the same cluster. */
2001 if (mref->helper) {
2002 /* Set the next field of mref->helper to the current
2003 index: this means that that earlier helper now
2004 points to the next helper in the same cluster. */
2005 mref->helper->next = i;
2006 /* mref should be set only for the first helper in the
2007 cluster, clear the others. */
2008 h->mref = NULL;
2009 }
2010 /* Point the mref helper to the current helper struct. */
2011 mref->helper = h;
2012 }
2013 mutex_unlock(&hdl->lock);
Hans Verkuil09965172010-08-01 14:32:42 -03002014 return 0;
2015}
2016
Hans Verkuil09965172010-08-01 14:32:42 -03002017/* Handles the corner case where cs->count == 0. It checks whether the
2018 specified control class exists. If that class ID is 0, then it checks
2019 whether there are any controls at all. */
2020static int class_check(struct v4l2_ctrl_handler *hdl, u32 ctrl_class)
2021{
2022 if (ctrl_class == 0)
2023 return list_empty(&hdl->ctrl_refs) ? -EINVAL : 0;
2024 return find_ref_lock(hdl, ctrl_class | 1) ? 0 : -EINVAL;
2025}
2026
2027
2028
2029/* Get extended controls. Allocates the helpers array if needed. */
2030int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2031{
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002032 struct v4l2_ctrl_helper helper[4];
2033 struct v4l2_ctrl_helper *helpers = helper;
Hans Verkuil09965172010-08-01 14:32:42 -03002034 int ret;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002035 int i, j;
Hans Verkuil09965172010-08-01 14:32:42 -03002036
2037 cs->error_idx = cs->count;
2038 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2039
2040 if (hdl == NULL)
2041 return -EINVAL;
2042
2043 if (cs->count == 0)
2044 return class_check(hdl, cs->ctrl_class);
2045
2046 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang5f0049b2012-04-06 09:32:36 -03002047 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2048 GFP_KERNEL);
Hans Verkuil09965172010-08-01 14:32:42 -03002049 if (helpers == NULL)
2050 return -ENOMEM;
2051 }
2052
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002053 ret = prepare_ext_ctrls(hdl, cs, helpers);
2054 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002055
2056 for (i = 0; !ret && i < cs->count; i++)
2057 if (helpers[i].ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2058 ret = -EACCES;
2059
2060 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002061 int (*ctrl_to_user)(struct v4l2_ext_control *c,
2062 struct v4l2_ctrl *ctrl) = cur_to_user;
2063 struct v4l2_ctrl *master;
Hans Verkuil09965172010-08-01 14:32:42 -03002064
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002065 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002066 continue;
2067
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002068 master = helpers[i].mref->ctrl;
Hans Verkuil09965172010-08-01 14:32:42 -03002069 cs->error_idx = i;
2070
2071 v4l2_ctrl_lock(master);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002072
2073 /* g_volatile_ctrl will update the new control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002074 if ((master->flags & V4L2_CTRL_FLAG_VOLATILE) ||
2075 (master->has_volatiles && !is_cur_manual(master))) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002076 for (j = 0; j < master->ncontrols; j++)
2077 cur_to_new(master->cluster[j]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002078 ret = call_op(master, g_volatile_ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002079 ctrl_to_user = new_to_user;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002080 }
2081 /* If OK, then copy the current (for non-volatile controls)
2082 or the new (for volatile controls) control values to the
2083 caller */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002084 if (!ret) {
2085 u32 idx = i;
2086
2087 do {
2088 ret = ctrl_to_user(cs->controls + idx,
2089 helpers[idx].ctrl);
2090 idx = helpers[idx].next;
2091 } while (!ret && idx);
2092 }
Hans Verkuil09965172010-08-01 14:32:42 -03002093 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002094 }
2095
2096 if (cs->count > ARRAY_SIZE(helper))
2097 kfree(helpers);
2098 return ret;
2099}
2100EXPORT_SYMBOL(v4l2_g_ext_ctrls);
2101
2102int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2103{
2104 return v4l2_g_ext_ctrls(sd->ctrl_handler, cs);
2105}
2106EXPORT_SYMBOL(v4l2_subdev_g_ext_ctrls);
2107
2108/* Helper function to get a single control */
2109static int get_ctrl(struct v4l2_ctrl *ctrl, s32 *val)
2110{
2111 struct v4l2_ctrl *master = ctrl->cluster[0];
2112 int ret = 0;
Hans Verkuilddac5c12011-06-10 05:43:34 -03002113 int i;
Hans Verkuil09965172010-08-01 14:32:42 -03002114
2115 if (ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY)
2116 return -EACCES;
2117
2118 v4l2_ctrl_lock(master);
2119 /* g_volatile_ctrl will update the current control values */
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002120 if (ctrl->flags & V4L2_CTRL_FLAG_VOLATILE) {
Hans Verkuilddac5c12011-06-10 05:43:34 -03002121 for (i = 0; i < master->ncontrols; i++)
2122 cur_to_new(master->cluster[i]);
Hans Verkuil54c911e2011-05-25 06:04:58 -03002123 ret = call_op(master, g_volatile_ctrl);
Hans Verkuilddac5c12011-06-10 05:43:34 -03002124 *val = ctrl->val;
2125 } else {
2126 *val = ctrl->cur.val;
2127 }
Hans Verkuil09965172010-08-01 14:32:42 -03002128 v4l2_ctrl_unlock(master);
2129 return ret;
2130}
2131
2132int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *control)
2133{
2134 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2135
2136 if (ctrl == NULL || !type_is_int(ctrl))
2137 return -EINVAL;
2138 return get_ctrl(ctrl, &control->value);
2139}
2140EXPORT_SYMBOL(v4l2_g_ctrl);
2141
2142int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2143{
2144 return v4l2_g_ctrl(sd->ctrl_handler, control);
2145}
2146EXPORT_SYMBOL(v4l2_subdev_g_ctrl);
2147
2148s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl)
2149{
2150 s32 val = 0;
2151
2152 /* It's a driver bug if this happens. */
2153 WARN_ON(!type_is_int(ctrl));
2154 get_ctrl(ctrl, &val);
2155 return val;
2156}
2157EXPORT_SYMBOL(v4l2_ctrl_g_ctrl);
2158
2159
2160/* Core function that calls try/s_ctrl and ensures that the new value is
2161 copied to the current value on a set.
2162 Must be called with ctrl->handler->lock held. */
Hans Verkuile6402582011-06-14 10:56:42 -03002163static int try_or_set_cluster(struct v4l2_fh *fh,
2164 struct v4l2_ctrl *master, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002165{
Hans Verkuil72d877c2011-06-10 05:44:36 -03002166 bool update_flag;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002167 int ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002168 int i;
2169
2170 /* Go through the cluster and either validate the new value or
2171 (if no new value was set), copy the current value to the new
2172 value, ensuring a consistent view for the control ops when
2173 called. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002174 for (i = 0; i < master->ncontrols; i++) {
Hans Verkuil09965172010-08-01 14:32:42 -03002175 struct v4l2_ctrl *ctrl = master->cluster[i];
2176
2177 if (ctrl == NULL)
2178 continue;
2179
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002180 if (!ctrl->is_new) {
2181 cur_to_new(ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002182 continue;
2183 }
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002184 /* Check again: it may have changed since the
2185 previous check in try_or_set_ext_ctrls(). */
2186 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2187 return -EBUSY;
Hans Verkuil09965172010-08-01 14:32:42 -03002188 }
2189
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002190 ret = call_op(master, try_ctrl);
Hans Verkuil09965172010-08-01 14:32:42 -03002191
2192 /* Don't set if there is no change */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002193 if (ret || !set || !cluster_changed(master))
2194 return ret;
2195 ret = call_op(master, s_ctrl);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002196 if (ret)
2197 return ret;
2198
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002199 /* If OK, then make the new values permanent. */
Hans Verkuil72d877c2011-06-10 05:44:36 -03002200 update_flag = is_cur_manual(master) != is_new_manual(master);
2201 for (i = 0; i < master->ncontrols; i++)
Hans Verkuilab892ba2011-06-07 06:47:18 -03002202 new_to_cur(fh, master->cluster[i], update_flag && i > 0);
Hans Verkuil72d877c2011-06-10 05:44:36 -03002203 return 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002204}
2205
Hans Verkuile6402582011-06-14 10:56:42 -03002206/* Validate controls. */
2207static int validate_ctrls(struct v4l2_ext_controls *cs,
2208 struct v4l2_ctrl_helper *helpers, bool set)
Hans Verkuil09965172010-08-01 14:32:42 -03002209{
Hans Verkuile6402582011-06-14 10:56:42 -03002210 unsigned i;
Hans Verkuil09965172010-08-01 14:32:42 -03002211 int ret = 0;
2212
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002213 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002214 for (i = 0; i < cs->count; i++) {
2215 struct v4l2_ctrl *ctrl = helpers[i].ctrl;
2216
Hans Verkuile6402582011-06-14 10:56:42 -03002217 cs->error_idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002218
2219 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2220 return -EACCES;
2221 /* This test is also done in try_set_control_cluster() which
2222 is called in atomic context, so that has the final say,
2223 but it makes sense to do an up-front check as well. Once
2224 an error occurs in try_set_control_cluster() some other
2225 controls may have been set already and we want to do a
2226 best-effort to avoid that. */
2227 if (set && (ctrl->flags & V4L2_CTRL_FLAG_GRABBED))
2228 return -EBUSY;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002229 ret = validate_new(ctrl, &cs->controls[i]);
2230 if (ret)
2231 return ret;
Hans Verkuil09965172010-08-01 14:32:42 -03002232 }
Hans Verkuile6402582011-06-14 10:56:42 -03002233 return 0;
2234}
Hans Verkuil09965172010-08-01 14:32:42 -03002235
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002236/* Obtain the current volatile values of an autocluster and mark them
2237 as new. */
2238static void update_from_auto_cluster(struct v4l2_ctrl *master)
2239{
2240 int i;
2241
2242 for (i = 0; i < master->ncontrols; i++)
2243 cur_to_new(master->cluster[i]);
2244 if (!call_op(master, g_volatile_ctrl))
2245 for (i = 1; i < master->ncontrols; i++)
2246 if (master->cluster[i])
2247 master->cluster[i]->is_new = 1;
2248}
2249
Hans Verkuile6402582011-06-14 10:56:42 -03002250/* Try or try-and-set controls */
2251static int try_set_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2252 struct v4l2_ext_controls *cs,
2253 bool set)
2254{
2255 struct v4l2_ctrl_helper helper[4];
2256 struct v4l2_ctrl_helper *helpers = helper;
2257 unsigned i, j;
2258 int ret;
2259
2260 cs->error_idx = cs->count;
2261 cs->ctrl_class = V4L2_CTRL_ID2CLASS(cs->ctrl_class);
2262
2263 if (hdl == NULL)
2264 return -EINVAL;
2265
2266 if (cs->count == 0)
2267 return class_check(hdl, cs->ctrl_class);
2268
2269 if (cs->count > ARRAY_SIZE(helper)) {
Xi Wang0a3475e2012-04-06 09:32:37 -03002270 helpers = kmalloc_array(cs->count, sizeof(helper[0]),
2271 GFP_KERNEL);
Hans Verkuile6402582011-06-14 10:56:42 -03002272 if (!helpers)
2273 return -ENOMEM;
2274 }
2275 ret = prepare_ext_ctrls(hdl, cs, helpers);
2276 if (!ret)
2277 ret = validate_ctrls(cs, helpers, set);
2278 if (ret && set)
2279 cs->error_idx = cs->count;
Hans Verkuil09965172010-08-01 14:32:42 -03002280 for (i = 0; !ret && i < cs->count; i++) {
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002281 struct v4l2_ctrl *master;
2282 u32 idx = i;
Hans Verkuil09965172010-08-01 14:32:42 -03002283
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002284 if (helpers[i].mref == NULL)
Hans Verkuil09965172010-08-01 14:32:42 -03002285 continue;
2286
Hans Verkuil37cd3b72011-06-07 04:40:04 -03002287 cs->error_idx = i;
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002288 master = helpers[i].mref->ctrl;
2289 v4l2_ctrl_lock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002290
Hans Verkuil2a863792011-01-11 14:45:03 -03002291 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002292 for (j = 0; j < master->ncontrols; j++)
2293 if (master->cluster[j])
Hans Verkuil2a863792011-01-11 14:45:03 -03002294 master->cluster[j]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002295
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002296 /* For volatile autoclusters that are currently in auto mode
2297 we need to discover if it will be set to manual mode.
2298 If so, then we have to copy the current volatile values
2299 first since those will become the new manual values (which
2300 may be overwritten by explicit new values from this set
2301 of controls). */
2302 if (master->is_auto && master->has_volatiles &&
2303 !is_cur_manual(master)) {
2304 /* Pick an initial non-manual value */
2305 s32 new_auto_val = master->manual_mode_value + 1;
2306 u32 tmp_idx = idx;
2307
2308 do {
2309 /* Check if the auto control is part of the
2310 list, and remember the new value. */
2311 if (helpers[tmp_idx].ctrl == master)
2312 new_auto_val = cs->controls[tmp_idx].value;
2313 tmp_idx = helpers[tmp_idx].next;
2314 } while (tmp_idx);
2315 /* If the new value == the manual value, then copy
2316 the current volatile values. */
2317 if (new_auto_val == master->manual_mode_value)
2318 update_from_auto_cluster(master);
2319 }
2320
Hans Verkuil09965172010-08-01 14:32:42 -03002321 /* Copy the new caller-supplied control values.
Hans Verkuil2a863792011-01-11 14:45:03 -03002322 user_to_new() sets 'is_new' to 1. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002323 do {
2324 ret = user_to_new(cs->controls + idx, helpers[idx].ctrl);
2325 idx = helpers[idx].next;
2326 } while (!ret && idx);
Hans Verkuil09965172010-08-01 14:32:42 -03002327
2328 if (!ret)
Hans Verkuile6402582011-06-14 10:56:42 -03002329 ret = try_or_set_cluster(fh, master, set);
Hans Verkuil09965172010-08-01 14:32:42 -03002330
2331 /* Copy the new values back to userspace. */
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002332 if (!ret) {
2333 idx = i;
2334 do {
Hans Verkuiladf41b92011-07-05 06:56:37 -03002335 ret = new_to_user(cs->controls + idx,
Hans Verkuile6402582011-06-14 10:56:42 -03002336 helpers[idx].ctrl);
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002337 idx = helpers[idx].next;
2338 } while (!ret && idx);
2339 }
2340 v4l2_ctrl_unlock(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002341 }
Hans Verkuil09965172010-08-01 14:32:42 -03002342
Hans Verkuil09965172010-08-01 14:32:42 -03002343 if (cs->count > ARRAY_SIZE(helper))
2344 kfree(helpers);
2345 return ret;
2346}
2347
2348int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *cs)
2349{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002350 return try_set_ext_ctrls(NULL, hdl, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002351}
2352EXPORT_SYMBOL(v4l2_try_ext_ctrls);
2353
Hans Verkuilab892ba2011-06-07 06:47:18 -03002354int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2355 struct v4l2_ext_controls *cs)
Hans Verkuil09965172010-08-01 14:32:42 -03002356{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002357 return try_set_ext_ctrls(fh, hdl, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002358}
2359EXPORT_SYMBOL(v4l2_s_ext_ctrls);
2360
2361int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2362{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002363 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, false);
Hans Verkuil09965172010-08-01 14:32:42 -03002364}
2365EXPORT_SYMBOL(v4l2_subdev_try_ext_ctrls);
2366
2367int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs)
2368{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002369 return try_set_ext_ctrls(NULL, sd->ctrl_handler, cs, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002370}
2371EXPORT_SYMBOL(v4l2_subdev_s_ext_ctrls);
2372
2373/* Helper function for VIDIOC_S_CTRL compatibility */
Hans Verkuilab892ba2011-06-07 06:47:18 -03002374static int set_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl *ctrl, s32 *val)
Hans Verkuil09965172010-08-01 14:32:42 -03002375{
2376 struct v4l2_ctrl *master = ctrl->cluster[0];
2377 int ret;
2378 int i;
2379
Hans Verkuileb5b16e2011-06-14 10:04:06 -03002380 ret = validate_new_int(ctrl, val);
2381 if (ret)
2382 return ret;
2383
Hans Verkuil09965172010-08-01 14:32:42 -03002384 v4l2_ctrl_lock(ctrl);
2385
Hans Verkuil2a863792011-01-11 14:45:03 -03002386 /* Reset the 'is_new' flags of the cluster */
Hans Verkuil09965172010-08-01 14:32:42 -03002387 for (i = 0; i < master->ncontrols; i++)
2388 if (master->cluster[i])
Hans Verkuil2a863792011-01-11 14:45:03 -03002389 master->cluster[i]->is_new = 0;
Hans Verkuil09965172010-08-01 14:32:42 -03002390
Hans Verkuil5626b8c2011-08-26 07:53:53 -03002391 /* For autoclusters with volatiles that are switched from auto to
2392 manual mode we have to update the current volatile values since
2393 those will become the initial manual values after such a switch. */
2394 if (master->is_auto && master->has_volatiles && ctrl == master &&
2395 !is_cur_manual(master) && *val == master->manual_mode_value)
2396 update_from_auto_cluster(master);
Hans Verkuil09965172010-08-01 14:32:42 -03002397 ctrl->val = *val;
Hans Verkuil2a863792011-01-11 14:45:03 -03002398 ctrl->is_new = 1;
Hans Verkuile6402582011-06-14 10:56:42 -03002399 ret = try_or_set_cluster(fh, master, true);
Hans Verkuil09965172010-08-01 14:32:42 -03002400 *val = ctrl->cur.val;
2401 v4l2_ctrl_unlock(ctrl);
2402 return ret;
2403}
2404
Hans Verkuilab892ba2011-06-07 06:47:18 -03002405int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
2406 struct v4l2_control *control)
Hans Verkuil09965172010-08-01 14:32:42 -03002407{
2408 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(hdl, control->id);
2409
2410 if (ctrl == NULL || !type_is_int(ctrl))
2411 return -EINVAL;
2412
Hans Verkuil7ebbc392011-06-07 04:50:31 -03002413 if (ctrl->flags & V4L2_CTRL_FLAG_READ_ONLY)
2414 return -EACCES;
2415
Hans Verkuilab892ba2011-06-07 06:47:18 -03002416 return set_ctrl(fh, ctrl, &control->value);
Hans Verkuil09965172010-08-01 14:32:42 -03002417}
2418EXPORT_SYMBOL(v4l2_s_ctrl);
2419
2420int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *control)
2421{
Hans Verkuilab892ba2011-06-07 06:47:18 -03002422 return v4l2_s_ctrl(NULL, sd->ctrl_handler, control);
Hans Verkuil09965172010-08-01 14:32:42 -03002423}
2424EXPORT_SYMBOL(v4l2_subdev_s_ctrl);
2425
2426int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val)
2427{
2428 /* It's a driver bug if this happens. */
2429 WARN_ON(!type_is_int(ctrl));
Hans Verkuilab892ba2011-06-07 06:47:18 -03002430 return set_ctrl(NULL, ctrl, &val);
Hans Verkuil09965172010-08-01 14:32:42 -03002431}
2432EXPORT_SYMBOL(v4l2_ctrl_s_ctrl);
Hans Verkuil6e239392011-06-07 11:13:44 -03002433
Hans de Goede3e3661492012-04-08 12:59:47 -03002434static int v4l2_ctrl_add_event(struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002435{
Hans de Goede3e3661492012-04-08 12:59:47 -03002436 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2437
2438 if (ctrl == NULL)
2439 return -EINVAL;
2440
Hans Verkuil6e239392011-06-07 11:13:44 -03002441 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002442 list_add_tail(&sev->node, &ctrl->ev_subs);
Hans Verkuil6e239392011-06-07 11:13:44 -03002443 if (ctrl->type != V4L2_CTRL_TYPE_CTRL_CLASS &&
Hans Verkuil77068d32011-06-13 18:55:58 -03002444 (sev->flags & V4L2_EVENT_SUB_FL_SEND_INITIAL)) {
Hans Verkuil6e239392011-06-07 11:13:44 -03002445 struct v4l2_event ev;
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002446 u32 changes = V4L2_EVENT_CTRL_CH_FLAGS;
Hans Verkuil6e239392011-06-07 11:13:44 -03002447
Hans Verkuilc12fcfd2011-06-14 02:42:45 -03002448 if (!(ctrl->flags & V4L2_CTRL_FLAG_WRITE_ONLY))
2449 changes |= V4L2_EVENT_CTRL_CH_VALUE;
2450 fill_event(&ev, ctrl, changes);
Hans Verkuil77068d32011-06-13 18:55:58 -03002451 v4l2_event_queue_fh(sev->fh, &ev);
Hans Verkuil6e239392011-06-07 11:13:44 -03002452 }
2453 v4l2_ctrl_unlock(ctrl);
Hans de Goede3e3661492012-04-08 12:59:47 -03002454 return 0;
Hans Verkuil6e239392011-06-07 11:13:44 -03002455}
Hans Verkuil6e239392011-06-07 11:13:44 -03002456
Hans de Goede3e3661492012-04-08 12:59:47 -03002457static void v4l2_ctrl_del_event(struct v4l2_subscribed_event *sev)
Hans Verkuil6e239392011-06-07 11:13:44 -03002458{
Hans de Goede3e3661492012-04-08 12:59:47 -03002459 struct v4l2_ctrl *ctrl = v4l2_ctrl_find(sev->fh->ctrl_handler, sev->id);
2460
Hans Verkuil6e239392011-06-07 11:13:44 -03002461 v4l2_ctrl_lock(ctrl);
Hans Verkuil77068d32011-06-13 18:55:58 -03002462 list_del(&sev->node);
Hans Verkuil6e239392011-06-07 11:13:44 -03002463 v4l2_ctrl_unlock(ctrl);
2464}
Hans de Goede3e3661492012-04-08 12:59:47 -03002465
2466void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new)
2467{
2468 u32 old_changes = old->u.ctrl.changes;
2469
2470 old->u.ctrl = new->u.ctrl;
2471 old->u.ctrl.changes |= old_changes;
2472}
2473EXPORT_SYMBOL(v4l2_ctrl_replace);
2474
2475void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new)
2476{
2477 new->u.ctrl.changes |= old->u.ctrl.changes;
2478}
2479EXPORT_SYMBOL(v4l2_ctrl_merge);
2480
2481const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops = {
2482 .add = v4l2_ctrl_add_event,
2483 .del = v4l2_ctrl_del_event,
2484 .replace = v4l2_ctrl_replace,
2485 .merge = v4l2_ctrl_merge,
2486};
2487EXPORT_SYMBOL(v4l2_ctrl_sub_ev_ops);
Hans Verkuile2ecb252012-02-02 08:20:53 -03002488
2489int v4l2_ctrl_log_status(struct file *file, void *fh)
2490{
2491 struct video_device *vfd = video_devdata(file);
2492 struct v4l2_fh *vfh = file->private_data;
2493
2494 if (test_bit(V4L2_FL_USES_V4L2_FH, &vfd->flags) && vfd->v4l2_dev)
2495 v4l2_ctrl_handler_log_status(vfh->ctrl_handler,
2496 vfd->v4l2_dev->name);
2497 return 0;
2498}
2499EXPORT_SYMBOL(v4l2_ctrl_log_status);
Hans Verkuila26243b2012-01-27 16:18:42 -03002500
2501int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
2502 struct v4l2_event_subscription *sub)
2503{
2504 if (sub->type == V4L2_EVENT_CTRL)
Hans de Goede3e3661492012-04-08 12:59:47 -03002505 return v4l2_event_subscribe(fh, sub, 0, &v4l2_ctrl_sub_ev_ops);
Hans Verkuila26243b2012-01-27 16:18:42 -03002506 return -EINVAL;
2507}
2508EXPORT_SYMBOL(v4l2_ctrl_subscribe_event);
2509
2510unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait)
2511{
2512 struct v4l2_fh *fh = file->private_data;
2513
2514 if (v4l2_event_pending(fh))
2515 return POLLPRI;
2516 poll_wait(file, &fh->wait, wait);
2517 return 0;
2518}
2519EXPORT_SYMBOL(v4l2_ctrl_poll);