[media] v4l2-ctrls: add control events
[pandora-kernel.git] / include / media / v4l2-ctrls.h
1 /*
2     V4L2 controls support header.
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 #ifndef _V4L2_CTRLS_H
22 #define _V4L2_CTRLS_H
23
24 #include <linux/list.h>
25 #include <linux/device.h>
26 #include <linux/videodev2.h>
27
28 /* forward references */
29 struct v4l2_ctrl_handler;
30 struct v4l2_ctrl;
31 struct video_device;
32 struct v4l2_subdev;
33 struct v4l2_event_subscription;
34 struct v4l2_fh;
35
36 /** struct v4l2_ctrl_ops - The control operations that the driver has to provide.
37   * @g_volatile_ctrl: Get a new value for this control. Generally only relevant
38   *             for volatile (and usually read-only) controls such as a control
39   *             that returns the current signal strength which changes
40   *             continuously.
41   *             If not set, then the currently cached value will be returned.
42   * @try_ctrl:  Test whether the control's value is valid. Only relevant when
43   *             the usual min/max/step checks are not sufficient.
44   * @s_ctrl:    Actually set the new control value. s_ctrl is compulsory. The
45   *             ctrl->handler->lock is held when these ops are called, so no
46   *             one else can access controls owned by that handler.
47   */
48 struct v4l2_ctrl_ops {
49         int (*g_volatile_ctrl)(struct v4l2_ctrl *ctrl);
50         int (*try_ctrl)(struct v4l2_ctrl *ctrl);
51         int (*s_ctrl)(struct v4l2_ctrl *ctrl);
52 };
53
54 /** struct v4l2_ctrl - The control structure.
55   * @node:      The list node.
56   * @handler:   The handler that owns the control.
57   * @cluster:   Point to start of cluster array.
58   * @ncontrols: Number of controls in cluster array.
59   * @done:      Internal flag: set for each processed control.
60   * @is_new:    Set when the user specified a new value for this control. It
61   *             is also set when called from v4l2_ctrl_handler_setup. Drivers
62   *             should never set this flag.
63   * @is_private: If set, then this control is private to its handler and it
64   *             will not be added to any other handlers. Drivers can set
65   *             this flag.
66   * @is_volatile: If set, then this control is volatile. This means that the
67   *             control's current value cannot be cached and needs to be
68   *             retrieved through the g_volatile_ctrl op. Drivers can set
69   *             this flag.
70   * @is_auto:   If set, then this control selects whether the other cluster
71   *             members are in 'automatic' mode or 'manual' mode. This is
72   *             used for autogain/gain type clusters. Drivers should never
73   *             set this flag directly.
74   * @manual_mode_value: If the is_auto flag is set, then this is the value
75   *             of the auto control that determines if that control is in
76   *             manual mode. So if the value of the auto control equals this
77   *             value, then the whole cluster is in manual mode. Drivers should
78   *             never set this flag directly.
79   * @ops:       The control ops.
80   * @id:        The control ID.
81   * @name:      The control name.
82   * @type:      The control type.
83   * @minimum:   The control's minimum value.
84   * @maximum:   The control's maximum value.
85   * @default_value: The control's default value.
86   * @step:      The control's step value for non-menu controls.
87   * @menu_skip_mask: The control's skip mask for menu controls. This makes it
88   *             easy to skip menu items that are not valid. If bit X is set,
89   *             then menu item X is skipped. Of course, this only works for
90   *             menus with <= 32 menu items. There are no menus that come
91   *             close to that number, so this is OK. Should we ever need more,
92   *             then this will have to be extended to a u64 or a bit array.
93   * @qmenu:     A const char * array for all menu items. Array entries that are
94   *             empty strings ("") correspond to non-existing menu items (this
95   *             is in addition to the menu_skip_mask above). The last entry
96   *             must be NULL.
97   * @flags:     The control's flags.
98   * @cur:       The control's current value.
99   * @val:       The control's new s32 value.
100   * @val64:     The control's new s64 value.
101   * @string:    The control's new string value.
102   * @priv:      The control's private pointer. For use by the driver. It is
103   *             untouched by the control framework. Note that this pointer is
104   *             not freed when the control is deleted. Should this be needed
105   *             then a new internal bitfield can be added to tell the framework
106   *             to free this pointer.
107   */
108 struct v4l2_ctrl {
109         /* Administrative fields */
110         struct list_head node;
111         struct list_head fhs;
112         struct v4l2_ctrl_handler *handler;
113         struct v4l2_ctrl **cluster;
114         unsigned ncontrols;
115         unsigned int done:1;
116
117         unsigned int is_new:1;
118         unsigned int is_private:1;
119         unsigned int is_volatile:1;
120         unsigned int is_auto:1;
121         unsigned int manual_mode_value:5;
122
123         const struct v4l2_ctrl_ops *ops;
124         u32 id;
125         const char *name;
126         enum v4l2_ctrl_type type;
127         s32 minimum, maximum, default_value;
128         union {
129                 u32 step;
130                 u32 menu_skip_mask;
131         };
132         const char * const *qmenu;
133         unsigned long flags;
134         union {
135                 s32 val;
136                 s64 val64;
137                 char *string;
138         } cur;
139         union {
140                 s32 val;
141                 s64 val64;
142                 char *string;
143         };
144         void *priv;
145 };
146
147 /** struct v4l2_ctrl_ref - The control reference.
148   * @node:      List node for the sorted list.
149   * @next:      Single-link list node for the hash.
150   * @ctrl:      The actual control information.
151   *
152   * Each control handler has a list of these refs. The list_head is used to
153   * keep a sorted-by-control-ID list of all controls, while the next pointer
154   * is used to link the control in the hash's bucket.
155   */
156 struct v4l2_ctrl_ref {
157         struct list_head node;
158         struct v4l2_ctrl_ref *next;
159         struct v4l2_ctrl *ctrl;
160 };
161
162 /** struct v4l2_ctrl_handler - The control handler keeps track of all the
163   * controls: both the controls owned by the handler and those inherited
164   * from other handlers.
165   * @lock:      Lock to control access to this handler and its controls.
166   * @ctrls:     The list of controls owned by this handler.
167   * @ctrl_refs: The list of control references.
168   * @cached:    The last found control reference. It is common that the same
169   *             control is needed multiple times, so this is a simple
170   *             optimization.
171   * @buckets:   Buckets for the hashing. Allows for quick control lookup.
172   * @nr_of_buckets: Total number of buckets in the array.
173   * @error:     The error code of the first failed control addition.
174   */
175 struct v4l2_ctrl_handler {
176         struct mutex lock;
177         struct list_head ctrls;
178         struct list_head ctrl_refs;
179         struct v4l2_ctrl_ref *cached;
180         struct v4l2_ctrl_ref **buckets;
181         u16 nr_of_buckets;
182         int error;
183 };
184
185 struct v4l2_ctrl_fh {
186         struct list_head node;
187         struct v4l2_fh *fh;
188 };
189
190 /** struct v4l2_ctrl_config - Control configuration structure.
191   * @ops:       The control ops.
192   * @id:        The control ID.
193   * @name:      The control name.
194   * @type:      The control type.
195   * @min:       The control's minimum value.
196   * @max:       The control's maximum value.
197   * @step:      The control's step value for non-menu controls.
198   * @def:       The control's default value.
199   * @flags:     The control's flags.
200   * @menu_skip_mask: The control's skip mask for menu controls. This makes it
201   *             easy to skip menu items that are not valid. If bit X is set,
202   *             then menu item X is skipped. Of course, this only works for
203   *             menus with <= 32 menu items. There are no menus that come
204   *             close to that number, so this is OK. Should we ever need more,
205   *             then this will have to be extended to a u64 or a bit array.
206   * @qmenu:     A const char * array for all menu items. Array entries that are
207   *             empty strings ("") correspond to non-existing menu items (this
208   *             is in addition to the menu_skip_mask above). The last entry
209   *             must be NULL.
210   * @is_private: If set, then this control is private to its handler and it
211   *             will not be added to any other handlers.
212   * @is_volatile: If set, then this control is volatile. This means that the
213   *             control's current value cannot be cached and needs to be
214   *             retrieved through the g_volatile_ctrl op.
215   */
216 struct v4l2_ctrl_config {
217         const struct v4l2_ctrl_ops *ops;
218         u32 id;
219         const char *name;
220         enum v4l2_ctrl_type type;
221         s32 min;
222         s32 max;
223         u32 step;
224         s32 def;
225         u32 flags;
226         u32 menu_skip_mask;
227         const char * const *qmenu;
228         unsigned int is_private:1;
229         unsigned int is_volatile:1;
230 };
231
232 /** v4l2_ctrl_fill() - Fill in the control fields based on the control ID.
233   *
234   * This works for all standard V4L2 controls.
235   * For non-standard controls it will only fill in the given arguments
236   * and @name will be NULL.
237   *
238   * This function will overwrite the contents of @name, @type and @flags.
239   * The contents of @min, @max, @step and @def may be modified depending on
240   * the type.
241   *
242   * Do not use in drivers! It is used internally for backwards compatibility
243   * control handling only. Once all drivers are converted to use the new
244   * control framework this function will no longer be exported.
245   */
246 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
247                     s32 *min, s32 *max, s32 *step, s32 *def, u32 *flags);
248
249
250 /** v4l2_ctrl_handler_init() - Initialize the control handler.
251   * @hdl:       The control handler.
252   * @nr_of_controls_hint: A hint of how many controls this handler is
253   *             expected to refer to. This is the total number, so including
254   *             any inherited controls. It doesn't have to be precise, but if
255   *             it is way off, then you either waste memory (too many buckets
256   *             are allocated) or the control lookup becomes slower (not enough
257   *             buckets are allocated, so there are more slow list lookups).
258   *             It will always work, though.
259   *
260   * Returns an error if the buckets could not be allocated. This error will
261   * also be stored in @hdl->error.
262   */
263 int v4l2_ctrl_handler_init(struct v4l2_ctrl_handler *hdl,
264                            unsigned nr_of_controls_hint);
265
266 /** v4l2_ctrl_handler_free() - Free all controls owned by the handler and free
267   * the control list.
268   * @hdl:       The control handler.
269   *
270   * Does nothing if @hdl == NULL.
271   */
272 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl);
273
274 /** v4l2_ctrl_handler_setup() - Call the s_ctrl op for all controls belonging
275   * to the handler to initialize the hardware to the current control values.
276   * @hdl:       The control handler.
277   *
278   * Button controls will be skipped, as are read-only controls.
279   *
280   * If @hdl == NULL, then this just returns 0.
281   */
282 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl);
283
284 /** v4l2_ctrl_handler_log_status() - Log all controls owned by the handler.
285   * @hdl:       The control handler.
286   * @prefix:    The prefix to use when logging the control values. If the
287   *             prefix does not end with a space, then ": " will be added
288   *             after the prefix. If @prefix == NULL, then no prefix will be
289   *             used.
290   *
291   * For use with VIDIOC_LOG_STATUS.
292   *
293   * Does nothing if @hdl == NULL.
294   */
295 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
296                                   const char *prefix);
297
298 /** v4l2_ctrl_new_custom() - Allocate and initialize a new custom V4L2
299   * control.
300   * @hdl:       The control handler.
301   * @cfg:       The control's configuration data.
302   * @priv:      The control's driver-specific private data.
303   *
304   * If the &v4l2_ctrl struct could not be allocated then NULL is returned
305   * and @hdl->error is set to the error code (if it wasn't set already).
306   */
307 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
308                         const struct v4l2_ctrl_config *cfg, void *priv);
309
310 /** v4l2_ctrl_new_std() - Allocate and initialize a new standard V4L2 non-menu control.
311   * @hdl:       The control handler.
312   * @ops:       The control ops.
313   * @id:        The control ID.
314   * @min:       The control's minimum value.
315   * @max:       The control's maximum value.
316   * @step:      The control's step value
317   * @def:       The control's default value.
318   *
319   * If the &v4l2_ctrl struct could not be allocated, or the control
320   * ID is not known, then NULL is returned and @hdl->error is set to the
321   * appropriate error code (if it wasn't set already).
322   *
323   * If @id refers to a menu control, then this function will return NULL.
324   *
325   * Use v4l2_ctrl_new_std_menu() when adding menu controls.
326   */
327 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
328                         const struct v4l2_ctrl_ops *ops,
329                         u32 id, s32 min, s32 max, u32 step, s32 def);
330
331 /** v4l2_ctrl_new_std_menu() - Allocate and initialize a new standard V4L2 menu control.
332   * @hdl:       The control handler.
333   * @ops:       The control ops.
334   * @id:        The control ID.
335   * @max:       The control's maximum value.
336   * @mask:      The control's skip mask for menu controls. This makes it
337   *             easy to skip menu items that are not valid. If bit X is set,
338   *             then menu item X is skipped. Of course, this only works for
339   *             menus with <= 32 menu items. There are no menus that come
340   *             close to that number, so this is OK. Should we ever need more,
341   *             then this will have to be extended to a u64 or a bit array.
342   * @def:       The control's default value.
343   *
344   * Same as v4l2_ctrl_new_std(), but @min is set to 0 and the @mask value
345   * determines which menu items are to be skipped.
346   *
347   * If @id refers to a non-menu control, then this function will return NULL.
348   */
349 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
350                         const struct v4l2_ctrl_ops *ops,
351                         u32 id, s32 max, s32 mask, s32 def);
352
353 /** v4l2_ctrl_add_ctrl() - Add a control from another handler to this handler.
354   * @hdl:       The control handler.
355   * @ctrl:      The control to add.
356   *
357   * It will return NULL if it was unable to add the control reference.
358   * If the control already belonged to the handler, then it will do
359   * nothing and just return @ctrl.
360   */
361 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
362                                           struct v4l2_ctrl *ctrl);
363
364 /** v4l2_ctrl_add_handler() - Add all controls from handler @add to
365   * handler @hdl.
366   * @hdl:       The control handler.
367   * @add:       The control handler whose controls you want to add to
368   *             the @hdl control handler.
369   *
370   * Does nothing if either of the two is a NULL pointer.
371   * In case of an error @hdl->error will be set to the error code (if it
372   * wasn't set already).
373   */
374 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
375                           struct v4l2_ctrl_handler *add);
376
377
378 /** v4l2_ctrl_cluster() - Mark all controls in the cluster as belonging to that cluster.
379   * @ncontrols: The number of controls in this cluster.
380   * @controls:  The cluster control array of size @ncontrols.
381   */
382 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls);
383
384
385 /** v4l2_ctrl_auto_cluster() - Mark all controls in the cluster as belonging to
386   * that cluster and set it up for autofoo/foo-type handling.
387   * @ncontrols: The number of controls in this cluster.
388   * @controls:  The cluster control array of size @ncontrols. The first control
389   *             must be the 'auto' control (e.g. autogain, autoexposure, etc.)
390   * @manual_val: The value for the first control in the cluster that equals the
391   *             manual setting.
392   * @set_volatile: If true, then all controls except the first auto control will
393   *             have is_volatile set to true. If false, then is_volatile will not
394   *             be touched.
395   *
396   * Use for control groups where one control selects some automatic feature and
397   * the other controls are only active whenever the automatic feature is turned
398   * off (manual mode). Typical examples: autogain vs gain, auto-whitebalance vs
399   * red and blue balance, etc.
400   *
401   * The behavior of such controls is as follows:
402   *
403   * When the autofoo control is set to automatic, then any manual controls
404   * are set to inactive and any reads will call g_volatile_ctrl (if the control
405   * was marked volatile).
406   *
407   * When the autofoo control is set to manual, then any manual controls will
408   * be marked active, and any reads will just return the current value without
409   * going through g_volatile_ctrl.
410   *
411   * In addition, this function will set the V4L2_CTRL_FLAG_UPDATE flag
412   * on the autofoo control and V4L2_CTRL_FLAG_INACTIVE on the foo control(s)
413   * if autofoo is in auto mode.
414   */
415 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
416                         u8 manual_val, bool set_volatile);
417
418
419 /** v4l2_ctrl_find() - Find a control with the given ID.
420   * @hdl:       The control handler.
421   * @id:        The control ID to find.
422   *
423   * If @hdl == NULL this will return NULL as well. Will lock the handler so
424   * do not use from inside &v4l2_ctrl_ops.
425   */
426 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id);
427
428 /** v4l2_ctrl_activate() - Make the control active or inactive.
429   * @ctrl:      The control to (de)activate.
430   * @active:    True if the control should become active.
431   *
432   * This sets or clears the V4L2_CTRL_FLAG_INACTIVE flag atomically.
433   * Does nothing if @ctrl == NULL.
434   * This will usually be called from within the s_ctrl op.
435   * The V4L2_EVENT_CTRL event will be generated afterwards.
436   *
437   * This function assumes that the control handler is locked.
438   */
439 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active);
440
441 /** v4l2_ctrl_grab() - Mark the control as grabbed or not grabbed.
442   * @ctrl:      The control to (de)activate.
443   * @grabbed:   True if the control should become grabbed.
444   *
445   * This sets or clears the V4L2_CTRL_FLAG_GRABBED flag atomically.
446   * Does nothing if @ctrl == NULL.
447   * The V4L2_EVENT_CTRL event will be generated afterwards.
448   * This will usually be called when starting or stopping streaming in the
449   * driver.
450   *
451   * This function assumes that the control handler is not locked and will
452   * take the lock itself.
453   */
454 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed);
455
456 /** v4l2_ctrl_lock() - Helper function to lock the handler
457   * associated with the control.
458   * @ctrl:      The control to lock.
459   */
460 static inline void v4l2_ctrl_lock(struct v4l2_ctrl *ctrl)
461 {
462         mutex_lock(&ctrl->handler->lock);
463 }
464
465 /** v4l2_ctrl_lock() - Helper function to unlock the handler
466   * associated with the control.
467   * @ctrl:      The control to unlock.
468   */
469 static inline void v4l2_ctrl_unlock(struct v4l2_ctrl *ctrl)
470 {
471         mutex_unlock(&ctrl->handler->lock);
472 }
473
474 /** v4l2_ctrl_g_ctrl() - Helper function to get the control's value from within a driver.
475   * @ctrl:      The control.
476   *
477   * This returns the control's value safely by going through the control
478   * framework. This function will lock the control's handler, so it cannot be
479   * used from within the &v4l2_ctrl_ops functions.
480   *
481   * This function is for integer type controls only.
482   */
483 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl);
484
485 /** v4l2_ctrl_s_ctrl() - Helper function to set the control's value from within a driver.
486   * @ctrl:      The control.
487   * @val:       The new value.
488   *
489   * This set the control's new value safely by going through the control
490   * framework. This function will lock the control's handler, so it cannot be
491   * used from within the &v4l2_ctrl_ops functions.
492   *
493   * This function is for integer type controls only.
494   */
495 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val);
496
497 void v4l2_ctrl_add_fh(struct v4l2_ctrl_handler *hdl,
498                 struct v4l2_ctrl_fh *ctrl_fh,
499                 struct v4l2_event_subscription *sub);
500 void v4l2_ctrl_del_fh(struct v4l2_ctrl *ctrl, struct v4l2_fh *fh);
501
502 /* Helpers for ioctl_ops. If hdl == NULL then they will all return -EINVAL. */
503 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc);
504 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm);
505 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *ctrl);
506 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
507                                                 struct v4l2_control *ctrl);
508 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *c);
509 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *c);
510 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
511                                                 struct v4l2_ext_controls *c);
512
513 /* Helpers for subdevices. If the associated ctrl_handler == NULL then they
514    will all return -EINVAL. */
515 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
516 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
517 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
518 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
519 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
520 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
521 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
522
523 #endif