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/mutex.h>
  26 #include <linux/videodev2.h>
  27
  28 /* forward references */
  29 struct file;
  30 struct v4l2_ctrl_handler;
  31 struct v4l2_ctrl_helper;
  32 struct v4l2_ctrl;
  33 struct video_device;
  34 struct v4l2_subdev;
  35 struct v4l2_subscribed_event;
  36 struct v4l2_fh;
  37 struct poll_table_struct;
  38
  39 /** union v4l2_ctrl_ptr - A pointer to a control value.
  40  * @p_s32:      Pointer to a 32-bit signed value.
  41  * @p_s64:      Pointer to a 64-bit signed value.
  42  * @p_u8:       Pointer to a 8-bit unsigned value.
  43  * @p_u16:      Pointer to a 16-bit unsigned value.
  44  * @p_char:     Pointer to a string.
  45  * @p:          Pointer to a compound value.
  46  */
  47 union v4l2_ctrl_ptr {
  48         s32 *p_s32;
  49         s64 *p_s64;
  50         u8 *p_u8;
  51         u16 *p_u16;
  52         char *p_char;
  53         void *p;
  54 };
  55
  56 /** struct v4l2_ctrl_ops - The control operations that the driver has to provide.
  57   * @g_volatile_ctrl: Get a new value for this control. Generally only relevant
  58   *             for volatile (and usually read-only) controls such as a control
  59   *             that returns the current signal strength which changes
  60   *             continuously.
  61   *             If not set, then the currently cached value will be returned.
  62   * @try_ctrl:  Test whether the control's value is valid. Only relevant when
  63   *             the usual min/max/step checks are not sufficient.
  64   * @s_ctrl:    Actually set the new control value. s_ctrl is compulsory. The
  65   *             ctrl->handler->lock is held when these ops are called, so no
  66   *             one else can access controls owned by that handler.
  67   */
  68 struct v4l2_ctrl_ops {
  69         int (*g_volatile_ctrl)(struct v4l2_ctrl *ctrl);
  70         int (*try_ctrl)(struct v4l2_ctrl *ctrl);
  71         int (*s_ctrl)(struct v4l2_ctrl *ctrl);
  72 };
  73
  74 /** struct v4l2_ctrl_type_ops - The control type operations that the driver has to provide.
  75   * @equal: return true if both values are equal.
  76   * @init: initialize the value.
  77   * @log: log the value.
  78   * @validate: validate the value. Return 0 on success and a negative value otherwise.
  79   */
  80 struct v4l2_ctrl_type_ops {
  81         bool (*equal)(const struct v4l2_ctrl *ctrl, u32 idx,
  82                       union v4l2_ctrl_ptr ptr1,
  83                       union v4l2_ctrl_ptr ptr2);
  84         void (*init)(const struct v4l2_ctrl *ctrl, u32 idx,
  85                      union v4l2_ctrl_ptr ptr);
  86         void (*log)(const struct v4l2_ctrl *ctrl);
  87         int (*validate)(const struct v4l2_ctrl *ctrl, u32 idx,
  88                         union v4l2_ctrl_ptr ptr);
  89 };
  90
  91 typedef void (*v4l2_ctrl_notify_fnc)(struct v4l2_ctrl *ctrl, void *priv);
  92
  93 /** struct v4l2_ctrl - The control structure.
  94   * @node:      The list node.
  95   * @ev_subs:   The list of control event subscriptions.
  96   * @handler:   The handler that owns the control.
  97   * @cluster:   Point to start of cluster array.
  98   * @ncontrols: Number of controls in cluster array.
  99   * @done:      Internal flag: set for each processed control.
 100   * @is_new:    Set when the user specified a new value for this control. It
 101   *             is also set when called from v4l2_ctrl_handler_setup. Drivers
 102   *             should never set this flag.
 103   * @has_changed: Set when the current value differs from the new value. Drivers
 104   *             should never use this flag.
 105   * @is_private: If set, then this control is private to its handler and it
 106   *             will not be added to any other handlers. Drivers can set
 107   *             this flag.
 108   * @is_auto:   If set, then this control selects whether the other cluster
 109   *             members are in 'automatic' mode or 'manual' mode. This is
 110   *             used for autogain/gain type clusters. Drivers should never
 111   *             set this flag directly.
 112   * @is_int:    If set, then this control has a simple integer value (i.e. it
 113   *             uses ctrl->val).
 114   * @is_string: If set, then this control has type V4L2_CTRL_TYPE_STRING.
 115   * @is_ptr:    If set, then this control is an array and/or has type >= V4L2_CTRL_COMPOUND_TYPES
 116   *             and/or has type V4L2_CTRL_TYPE_STRING. In other words, struct
 117   *             v4l2_ext_control uses field p to point to the data.
 118   * @is_array: If set, then this control contains an N-dimensional array.
 119   * @has_volatiles: If set, then one or more members of the cluster are volatile.
 120   *             Drivers should never touch this flag.
 121   * @call_notify: If set, then call the handler's notify function whenever the
 122   *             control's value changes.
 123   * @manual_mode_value: If the is_auto flag is set, then this is the value
 124   *             of the auto control that determines if that control is in
 125   *             manual mode. So if the value of the auto control equals this
 126   *             value, then the whole cluster is in manual mode. Drivers should
 127   *             never set this flag directly.
 128   * @ops:       The control ops.
 129   * @type_ops:  The control type ops.
 130   * @id:        The control ID.
 131   * @name:      The control name.
 132   * @type:      The control type.
 133   * @minimum:   The control's minimum value.
 134   * @maximum:   The control's maximum value.
 135   * @default_value: The control's default value.
 136   * @step:      The control's step value for non-menu controls.
 137   * @elems:     The number of elements in the N-dimensional array.
 138   * @elem_size: The size in bytes of the control.
 139   * @dims:      The size of each dimension.
 140   * @nr_of_dims:The number of dimensions in @dims.
 141   * @menu_skip_mask: The control's skip mask for menu controls. This makes it
 142   *             easy to skip menu items that are not valid. If bit X is set,
 143   *             then menu item X is skipped. Of course, this only works for
 144   *             menus with <= 32 menu items. There are no menus that come
 145   *             close to that number, so this is OK. Should we ever need more,
 146   *             then this will have to be extended to a u64 or a bit array.
 147   * @qmenu:     A const char * array for all menu items. Array entries that are
 148   *             empty strings ("") correspond to non-existing menu items (this
 149   *             is in addition to the menu_skip_mask above). The last entry
 150   *             must be NULL.
 151   * @flags:     The control's flags.
 152   * @cur:       The control's current value.
 153   * @val:       The control's new s32 value.
 154   * @val64:     The control's new s64 value.
 155   * @priv:      The control's private pointer. For use by the driver. It is
 156   *             untouched by the control framework. Note that this pointer is
 157   *             not freed when the control is deleted. Should this be needed
 158   *             then a new internal bitfield can be added to tell the framework
 159   *             to free this pointer.
 160   */
 161 struct v4l2_ctrl {
 162         /* Administrative fields */
 163         struct list_head node;
 164         struct list_head ev_subs;
 165         struct v4l2_ctrl_handler *handler;
 166         struct v4l2_ctrl **cluster;
 167         unsigned ncontrols;
 168         unsigned int done:1;
 169
 170         unsigned int is_new:1;
 171         unsigned int has_changed:1;
 172         unsigned int is_private:1;
 173         unsigned int is_auto:1;
 174         unsigned int is_int:1;
 175         unsigned int is_string:1;
 176         unsigned int is_ptr:1;
 177         unsigned int is_array:1;
 178         unsigned int has_volatiles:1;
 179         unsigned int call_notify:1;
 180         unsigned int manual_mode_value:8;
 181
 182         const struct v4l2_ctrl_ops *ops;
 183         const struct v4l2_ctrl_type_ops *type_ops;
 184         u32 id;
 185         const char *name;
 186         enum v4l2_ctrl_type type;
 187         s64 minimum, maximum, default_value;
 188         u32 elems;
 189         u32 elem_size;
 190         u32 dims[V4L2_CTRL_MAX_DIMS];
 191         u32 nr_of_dims;
 192         union {
 193                 u64 step;
 194                 u64 menu_skip_mask;
 195         };
 196         union {
 197                 const char * const *qmenu;
 198                 const s64 *qmenu_int;
 199         };
 200         unsigned long flags;
 201         void *priv;
 202         s32 val;
 203         struct {
 204                 s32 val;
 205         } cur;
 206
 207         union v4l2_ctrl_ptr p_new;
 208         union v4l2_ctrl_ptr p_cur;
 209 };
 210
 211 /** struct v4l2_ctrl_ref - The control reference.
 212   * @node:      List node for the sorted list.
 213   * @next:      Single-link list node for the hash.
 214   * @ctrl:      The actual control information.
 215   * @helper:    Pointer to helper struct. Used internally in prepare_ext_ctrls().
 216   *
 217   * Each control handler has a list of these refs. The list_head is used to
 218   * keep a sorted-by-control-ID list of all controls, while the next pointer
 219   * is used to link the control in the hash's bucket.
 220   */
 221 struct v4l2_ctrl_ref {
 222         struct list_head node;
 223         struct v4l2_ctrl_ref *next;
 224         struct v4l2_ctrl *ctrl;
 225         struct v4l2_ctrl_helper *helper;
 226 };
 227
 228 /** struct v4l2_ctrl_handler - The control handler keeps track of all the
 229   * controls: both the controls owned by the handler and those inherited
 230   * from other handlers.
 231   * @_lock:     Default for "lock".
 232   * @lock:      Lock to control access to this handler and its controls.
 233   *             May be replaced by the user right after init.
 234   * @ctrls:     The list of controls owned by this handler.
 235   * @ctrl_refs: The list of control references.
 236   * @cached:    The last found control reference. It is common that the same
 237   *             control is needed multiple times, so this is a simple
 238   *             optimization.
 239   * @buckets:   Buckets for the hashing. Allows for quick control lookup.
 240   * @notify:    A notify callback that is called whenever the control changes value.
 241   *             Note that the handler's lock is held when the notify function
 242   *             is called!
 243   * @notify_priv: Passed as argument to the v4l2_ctrl notify callback.
 244   * @nr_of_buckets: Total number of buckets in the array.
 245   * @error:     The error code of the first failed control addition.
 246   */
 247 struct v4l2_ctrl_handler {
 248         struct mutex _lock;
 249         struct mutex *lock;
 250         struct list_head ctrls;
 251         struct list_head ctrl_refs;
 252         struct v4l2_ctrl_ref *cached;
 253         struct v4l2_ctrl_ref **buckets;
 254         v4l2_ctrl_notify_fnc notify;
 255         void *notify_priv;
 256         u16 nr_of_buckets;
 257         int error;
 258 };
 259
 260 /** struct v4l2_ctrl_config - Control configuration structure.
 261   * @ops:       The control ops.
 262   * @type_ops:  The control type ops. Only needed for compound controls.
 263   * @id:        The control ID.
 264   * @name:      The control name.
 265   * @type:      The control type.
 266   * @min:       The control's minimum value.
 267   * @max:       The control's maximum value.
 268   * @step:      The control's step value for non-menu controls.
 269   * @def:       The control's default value.
 270   * @dims:      The size of each dimension.
 271   * @elem_size: The size in bytes of the control.
 272   * @flags:     The control's flags.
 273   * @menu_skip_mask: The control's skip mask for menu controls. This makes it
 274   *             easy to skip menu items that are not valid. If bit X is set,
 275   *             then menu item X is skipped. Of course, this only works for
 276   *             menus with <= 64 menu items. There are no menus that come
 277   *             close to that number, so this is OK. Should we ever need more,
 278   *             then this will have to be extended to a bit array.
 279   * @qmenu:     A const char * array for all menu items. Array entries that are
 280   *             empty strings ("") correspond to non-existing menu items (this
 281   *             is in addition to the menu_skip_mask above). The last entry
 282   *             must be NULL.
 283   * @is_private: If set, then this control is private to its handler and it
 284   *             will not be added to any other handlers.
 285   */
 286 struct v4l2_ctrl_config {
 287         const struct v4l2_ctrl_ops *ops;
 288         const struct v4l2_ctrl_type_ops *type_ops;
 289         u32 id;
 290         const char *name;
 291         enum v4l2_ctrl_type type;
 292         s64 min;
 293         s64 max;
 294         u64 step;
 295         s64 def;
 296         u32 dims[V4L2_CTRL_MAX_DIMS];
 297         u32 elem_size;
 298         u32 flags;
 299         u64 menu_skip_mask;
 300         const char * const *qmenu;
 301         const s64 *qmenu_int;
 302         unsigned int is_private:1;
 303 };
 304
 305 /** v4l2_ctrl_fill() - Fill in the control fields based on the control ID.
 306   *
 307   * This works for all standard V4L2 controls.
 308   * For non-standard controls it will only fill in the given arguments
 309   * and @name will be NULL.
 310   *
 311   * This function will overwrite the contents of @name, @type and @flags.
 312   * The contents of @min, @max, @step and @def may be modified depending on
 313   * the type.
 314   *
 315   * Do not use in drivers! It is used internally for backwards compatibility
 316   * control handling only. Once all drivers are converted to use the new
 317   * control framework this function will no longer be exported.
 318   */
 319 void v4l2_ctrl_fill(u32 id, const char **name, enum v4l2_ctrl_type *type,
 320                     s64 *min, s64 *max, u64 *step, s64 *def, u32 *flags);
 321
 322
 323 /** v4l2_ctrl_handler_init_class() - Initialize the control handler.
 324   * @hdl:       The control handler.
 325   * @nr_of_controls_hint: A hint of how many controls this handler is
 326   *             expected to refer to. This is the total number, so including
 327   *             any inherited controls. It doesn't have to be precise, but if
 328   *             it is way off, then you either waste memory (too many buckets
 329   *             are allocated) or the control lookup becomes slower (not enough
 330   *             buckets are allocated, so there are more slow list lookups).
 331   *             It will always work, though.
 332   * @key:       Used by the lock validator if CONFIG_LOCKDEP is set.
 333   * @name:      Used by the lock validator if CONFIG_LOCKDEP is set.
 334   *
 335   * Returns an error if the buckets could not be allocated. This error will
 336   * also be stored in @hdl->error.
 337   *
 338   * Never use this call directly, always use the v4l2_ctrl_handler_init
 339   * macro that hides the @key and @name arguments.
 340   */
 341 int v4l2_ctrl_handler_init_class(struct v4l2_ctrl_handler *hdl,
 342                                  unsigned nr_of_controls_hint,
 343                                  struct lock_class_key *key, const char *name);
 344
 345 #ifdef CONFIG_LOCKDEP
 346 #define v4l2_ctrl_handler_init(hdl, nr_of_controls_hint)                \
 347 (                                                                       \
 348         ({                                                              \
 349                 static struct lock_class_key _key;                      \
 350                 v4l2_ctrl_handler_init_class(hdl, nr_of_controls_hint,  \
 351                                         &_key,                          \
 352                                         KBUILD_BASENAME ":"             \
 353                                         __stringify(__LINE__) ":"       \
 354                                         "(" #hdl ")->_lock");           \
 355         })                                                              \
 356 )
 357 #else
 358 #define v4l2_ctrl_handler_init(hdl, nr_of_controls_hint)                \
 359         v4l2_ctrl_handler_init_class(hdl, nr_of_controls_hint, NULL, NULL)
 360 #endif
 361
 362 /** v4l2_ctrl_handler_free() - Free all controls owned by the handler and free
 363   * the control list.
 364   * @hdl:       The control handler.
 365   *
 366   * Does nothing if @hdl == NULL.
 367   */
 368 void v4l2_ctrl_handler_free(struct v4l2_ctrl_handler *hdl);
 369
 370 /** v4l2_ctrl_handler_setup() - Call the s_ctrl op for all controls belonging
 371   * to the handler to initialize the hardware to the current control values.
 372   * @hdl:       The control handler.
 373   *
 374   * Button controls will be skipped, as are read-only controls.
 375   *
 376   * If @hdl == NULL, then this just returns 0.
 377   */
 378 int v4l2_ctrl_handler_setup(struct v4l2_ctrl_handler *hdl);
 379
 380 /** v4l2_ctrl_handler_log_status() - Log all controls owned by the handler.
 381   * @hdl:       The control handler.
 382   * @prefix:    The prefix to use when logging the control values. If the
 383   *             prefix does not end with a space, then ": " will be added
 384   *             after the prefix. If @prefix == NULL, then no prefix will be
 385   *             used.
 386   *
 387   * For use with VIDIOC_LOG_STATUS.
 388   *
 389   * Does nothing if @hdl == NULL.
 390   */
 391 void v4l2_ctrl_handler_log_status(struct v4l2_ctrl_handler *hdl,
 392                                   const char *prefix);
 393
 394 /** v4l2_ctrl_new_custom() - Allocate and initialize a new custom V4L2
 395   * control.
 396   * @hdl:       The control handler.
 397   * @cfg:       The control's configuration data.
 398   * @priv:      The control's driver-specific private data.
 399   *
 400   * If the &v4l2_ctrl struct could not be allocated then NULL is returned
 401   * and @hdl->error is set to the error code (if it wasn't set already).
 402   */
 403 struct v4l2_ctrl *v4l2_ctrl_new_custom(struct v4l2_ctrl_handler *hdl,
 404                         const struct v4l2_ctrl_config *cfg, void *priv);
 405
 406 /** v4l2_ctrl_new_std() - Allocate and initialize a new standard V4L2 non-menu control.
 407   * @hdl:       The control handler.
 408   * @ops:       The control ops.
 409   * @id:        The control ID.
 410   * @min:       The control's minimum value.
 411   * @max:       The control's maximum value.
 412   * @step:      The control's step value
 413   * @def:       The control's default value.
 414   *
 415   * If the &v4l2_ctrl struct could not be allocated, or the control
 416   * ID is not known, then NULL is returned and @hdl->error is set to the
 417   * appropriate error code (if it wasn't set already).
 418   *
 419   * If @id refers to a menu control, then this function will return NULL.
 420   *
 421   * Use v4l2_ctrl_new_std_menu() when adding menu controls.
 422   */
 423 struct v4l2_ctrl *v4l2_ctrl_new_std(struct v4l2_ctrl_handler *hdl,
 424                         const struct v4l2_ctrl_ops *ops,
 425                         u32 id, s64 min, s64 max, u64 step, s64 def);
 426
 427 /** v4l2_ctrl_new_std_menu() - Allocate and initialize a new standard V4L2 menu control.
 428   * @hdl:       The control handler.
 429   * @ops:       The control ops.
 430   * @id:        The control ID.
 431   * @max:       The control's maximum value.
 432   * @mask:      The control's skip mask for menu controls. This makes it
 433   *             easy to skip menu items that are not valid. If bit X is set,
 434   *             then menu item X is skipped. Of course, this only works for
 435   *             menus with <= 64 menu items. There are no menus that come
 436   *             close to that number, so this is OK. Should we ever need more,
 437   *             then this will have to be extended to a bit array.
 438   * @def:       The control's default value.
 439   *
 440   * Same as v4l2_ctrl_new_std(), but @min is set to 0 and the @mask value
 441   * determines which menu items are to be skipped.
 442   *
 443   * If @id refers to a non-menu control, then this function will return NULL.
 444   */
 445 struct v4l2_ctrl *v4l2_ctrl_new_std_menu(struct v4l2_ctrl_handler *hdl,
 446                         const struct v4l2_ctrl_ops *ops,
 447                         u32 id, u8 max, u64 mask, u8 def);
 448
 449 /** v4l2_ctrl_new_std_menu_items() - Create a new standard V4L2 menu control
 450   * with driver specific menu.
 451   * @hdl:       The control handler.
 452   * @ops:       The control ops.
 453   * @id:        The control ID.
 454   * @max:       The control's maximum value.
 455   * @mask:      The control's skip mask for menu controls. This makes it
 456   *             easy to skip menu items that are not valid. If bit X is set,
 457   *             then menu item X is skipped. Of course, this only works for
 458   *             menus with <= 64 menu items. There are no menus that come
 459   *             close to that number, so this is OK. Should we ever need more,
 460   *             then this will have to be extended to a bit array.
 461   * @def:       The control's default value.
 462   * @qmenu:     The new menu.
 463   *
 464   * Same as v4l2_ctrl_new_std_menu(), but @qmenu will be the driver specific
 465   * menu of this control.
 466   *
 467   */
 468 struct v4l2_ctrl *v4l2_ctrl_new_std_menu_items(struct v4l2_ctrl_handler *hdl,
 469                         const struct v4l2_ctrl_ops *ops, u32 id, u8 max,
 470                         u64 mask, u8 def, const char * const *qmenu);
 471
 472 /** v4l2_ctrl_new_int_menu() - Create a new standard V4L2 integer menu control.
 473   * @hdl:       The control handler.
 474   * @ops:       The control ops.
 475   * @id:        The control ID.
 476   * @max:       The control's maximum value.
 477   * @def:       The control's default value.
 478   * @qmenu_int: The control's menu entries.
 479   *
 480   * Same as v4l2_ctrl_new_std_menu(), but @mask is set to 0 and it additionaly
 481   * takes as an argument an array of integers determining the menu items.
 482   *
 483   * If @id refers to a non-integer-menu control, then this function will return NULL.
 484   */
 485 struct v4l2_ctrl *v4l2_ctrl_new_int_menu(struct v4l2_ctrl_handler *hdl,
 486                         const struct v4l2_ctrl_ops *ops,
 487                         u32 id, u8 max, u8 def, const s64 *qmenu_int);
 488
 489 /** v4l2_ctrl_add_ctrl() - Add a control from another handler to this handler.
 490   * @hdl:       The control handler.
 491   * @ctrl:      The control to add.
 492   *
 493   * It will return NULL if it was unable to add the control reference.
 494   * If the control already belonged to the handler, then it will do
 495   * nothing and just return @ctrl.
 496   */
 497 struct v4l2_ctrl *v4l2_ctrl_add_ctrl(struct v4l2_ctrl_handler *hdl,
 498                                           struct v4l2_ctrl *ctrl);
 499
 500 /** v4l2_ctrl_add_handler() - Add all controls from handler @add to
 501   * handler @hdl.
 502   * @hdl:       The control handler.
 503   * @add:       The control handler whose controls you want to add to
 504   *             the @hdl control handler.
 505   * @filter:    This function will filter which controls should be added.
 506   *
 507   * Does nothing if either of the two handlers is a NULL pointer.
 508   * If @filter is NULL, then all controls are added. Otherwise only those
 509   * controls for which @filter returns true will be added.
 510   * In case of an error @hdl->error will be set to the error code (if it
 511   * wasn't set already).
 512   */
 513 int v4l2_ctrl_add_handler(struct v4l2_ctrl_handler *hdl,
 514                           struct v4l2_ctrl_handler *add,
 515                           bool (*filter)(const struct v4l2_ctrl *ctrl));
 516
 517 /** v4l2_ctrl_radio_filter() - Standard filter for radio controls.
 518   * @ctrl:      The control that is filtered.
 519   *
 520   * This will return true for any controls that are valid for radio device
 521   * nodes. Those are all of the V4L2_CID_AUDIO_* user controls and all FM
 522   * transmitter class controls.
 523   *
 524   * This function is to be used with v4l2_ctrl_add_handler().
 525   */
 526 bool v4l2_ctrl_radio_filter(const struct v4l2_ctrl *ctrl);
 527
 528 /** v4l2_ctrl_cluster() - Mark all controls in the cluster as belonging to that cluster.
 529   * @ncontrols: The number of controls in this cluster.
 530   * @controls:  The cluster control array of size @ncontrols.
 531   */
 532 void v4l2_ctrl_cluster(unsigned ncontrols, struct v4l2_ctrl **controls);
 533
 534
 535 /** v4l2_ctrl_auto_cluster() - Mark all controls in the cluster as belonging to
 536   * that cluster and set it up for autofoo/foo-type handling.
 537   * @ncontrols: The number of controls in this cluster.
 538   * @controls:  The cluster control array of size @ncontrols. The first control
 539   *             must be the 'auto' control (e.g. autogain, autoexposure, etc.)
 540   * @manual_val: The value for the first control in the cluster that equals the
 541   *             manual setting.
 542   * @set_volatile: If true, then all controls except the first auto control will
 543   *             be volatile.
 544   *
 545   * Use for control groups where one control selects some automatic feature and
 546   * the other controls are only active whenever the automatic feature is turned
 547   * off (manual mode). Typical examples: autogain vs gain, auto-whitebalance vs
 548   * red and blue balance, etc.
 549   *
 550   * The behavior of such controls is as follows:
 551   *
 552   * When the autofoo control is set to automatic, then any manual controls
 553   * are set to inactive and any reads will call g_volatile_ctrl (if the control
 554   * was marked volatile).
 555   *
 556   * When the autofoo control is set to manual, then any manual controls will
 557   * be marked active, and any reads will just return the current value without
 558   * going through g_volatile_ctrl.
 559   *
 560   * In addition, this function will set the V4L2_CTRL_FLAG_UPDATE flag
 561   * on the autofoo control and V4L2_CTRL_FLAG_INACTIVE on the foo control(s)
 562   * if autofoo is in auto mode.
 563   */
 564 void v4l2_ctrl_auto_cluster(unsigned ncontrols, struct v4l2_ctrl **controls,
 565                         u8 manual_val, bool set_volatile);
 566
 567
 568 /** v4l2_ctrl_find() - Find a control with the given ID.
 569   * @hdl:       The control handler.
 570   * @id:        The control ID to find.
 571   *
 572   * If @hdl == NULL this will return NULL as well. Will lock the handler so
 573   * do not use from inside &v4l2_ctrl_ops.
 574   */
 575 struct v4l2_ctrl *v4l2_ctrl_find(struct v4l2_ctrl_handler *hdl, u32 id);
 576
 577 /** v4l2_ctrl_activate() - Make the control active or inactive.
 578   * @ctrl:      The control to (de)activate.
 579   * @active:    True if the control should become active.
 580   *
 581   * This sets or clears the V4L2_CTRL_FLAG_INACTIVE flag atomically.
 582   * Does nothing if @ctrl == NULL.
 583   * This will usually be called from within the s_ctrl op.
 584   * The V4L2_EVENT_CTRL event will be generated afterwards.
 585   *
 586   * This function assumes that the control handler is locked.
 587   */
 588 void v4l2_ctrl_activate(struct v4l2_ctrl *ctrl, bool active);
 589
 590 /** v4l2_ctrl_grab() - Mark the control as grabbed or not grabbed.
 591   * @ctrl:      The control to (de)activate.
 592   * @grabbed:   True if the control should become grabbed.
 593   *
 594   * This sets or clears the V4L2_CTRL_FLAG_GRABBED flag atomically.
 595   * Does nothing if @ctrl == NULL.
 596   * The V4L2_EVENT_CTRL event will be generated afterwards.
 597   * This will usually be called when starting or stopping streaming in the
 598   * driver.
 599   *
 600   * This function assumes that the control handler is not locked and will
 601   * take the lock itself.
 602   */
 603 void v4l2_ctrl_grab(struct v4l2_ctrl *ctrl, bool grabbed);
 604
 605 /** v4l2_ctrl_modify_range() - Update the range of a control.
 606   * @ctrl:      The control to update.
 607   * @min:       The control's minimum value.
 608   * @max:       The control's maximum value.
 609   * @step:      The control's step value
 610   * @def:       The control's default value.
 611   *
 612   * Update the range of a control on the fly. This works for control types
 613   * INTEGER, BOOLEAN, MENU, INTEGER MENU and BITMASK. For menu controls the
 614   * @step value is interpreted as a menu_skip_mask.
 615   *
 616   * An error is returned if one of the range arguments is invalid for this
 617   * control type.
 618   *
 619   * This function assumes that the control handler is not locked and will
 620   * take the lock itself.
 621   */
 622 int v4l2_ctrl_modify_range(struct v4l2_ctrl *ctrl,
 623                         s64 min, s64 max, u64 step, s64 def);
 624
 625 /** v4l2_ctrl_lock() - Helper function to lock the handler
 626   * associated with the control.
 627   * @ctrl:      The control to lock.
 628   */
 629 static inline void v4l2_ctrl_lock(struct v4l2_ctrl *ctrl)
 630 {
 631         mutex_lock(ctrl->handler->lock);
 632 }
 633
 634 /** v4l2_ctrl_unlock() - Helper function to unlock the handler
 635   * associated with the control.
 636   * @ctrl:      The control to unlock.
 637   */
 638 static inline void v4l2_ctrl_unlock(struct v4l2_ctrl *ctrl)
 639 {
 640         mutex_unlock(ctrl->handler->lock);
 641 }
 642
 643 /** v4l2_ctrl_notify() - Function to set a notify callback for a control.
 644   * @ctrl:      The control.
 645   * @notify:    The callback function.
 646   * @priv:      The callback private handle, passed as argument to the callback.
 647   *
 648   * This function sets a callback function for the control. If @ctrl is NULL,
 649   * then it will do nothing. If @notify is NULL, then the notify callback will
 650   * be removed.
 651   *
 652   * There can be only one notify. If another already exists, then a WARN_ON
 653   * will be issued and the function will do nothing.
 654   */
 655 void v4l2_ctrl_notify(struct v4l2_ctrl *ctrl, v4l2_ctrl_notify_fnc notify, void *priv);
 656
 657 /** v4l2_ctrl_g_ctrl() - Helper function to get the control's value from within a driver.
 658   * @ctrl:      The control.
 659   *
 660   * This returns the control's value safely by going through the control
 661   * framework. This function will lock the control's handler, so it cannot be
 662   * used from within the &v4l2_ctrl_ops functions.
 663   *
 664   * This function is for integer type controls only.
 665   */
 666 s32 v4l2_ctrl_g_ctrl(struct v4l2_ctrl *ctrl);
 667
 668 /** v4l2_ctrl_s_ctrl() - Helper function to set the control's value from within a driver.
 669   * @ctrl:      The control.
 670   * @val:       The new value.
 671   *
 672   * This set the control's new value safely by going through the control
 673   * framework. This function will lock the control's handler, so it cannot be
 674   * used from within the &v4l2_ctrl_ops functions.
 675   *
 676   * This function is for integer type controls only.
 677   */
 678 int v4l2_ctrl_s_ctrl(struct v4l2_ctrl *ctrl, s32 val);
 679
 680 /** v4l2_ctrl_g_ctrl_int64() - Helper function to get a 64-bit control's value from within a driver.
 681   * @ctrl:      The control.
 682   *
 683   * This returns the control's value safely by going through the control
 684   * framework. This function will lock the control's handler, so it cannot be
 685   * used from within the &v4l2_ctrl_ops functions.
 686   *
 687   * This function is for 64-bit integer type controls only.
 688   */
 689 s64 v4l2_ctrl_g_ctrl_int64(struct v4l2_ctrl *ctrl);
 690
 691 /** v4l2_ctrl_s_ctrl_int64() - Helper function to set a 64-bit control's value from within a driver.
 692   * @ctrl:      The control.
 693   * @val:       The new value.
 694   *
 695   * This set the control's new value safely by going through the control
 696   * framework. This function will lock the control's handler, so it cannot be
 697   * used from within the &v4l2_ctrl_ops functions.
 698   *
 699   * This function is for 64-bit integer type controls only.
 700   */
 701 int v4l2_ctrl_s_ctrl_int64(struct v4l2_ctrl *ctrl, s64 val);
 702
 703 /* Internal helper functions that deal with control events. */
 704 extern const struct v4l2_subscribed_event_ops v4l2_ctrl_sub_ev_ops;
 705 void v4l2_ctrl_replace(struct v4l2_event *old, const struct v4l2_event *new);
 706 void v4l2_ctrl_merge(const struct v4l2_event *old, struct v4l2_event *new);
 707
 708 /* Can be used as a vidioc_log_status function that just dumps all controls
 709    associated with the filehandle. */
 710 int v4l2_ctrl_log_status(struct file *file, void *fh);
 711
 712 /* Can be used as a vidioc_subscribe_event function that just subscribes
 713    control events. */
 714 int v4l2_ctrl_subscribe_event(struct v4l2_fh *fh,
 715                                 const struct v4l2_event_subscription *sub);
 716
 717 /* Can be used as a poll function that just polls for control events. */
 718 unsigned int v4l2_ctrl_poll(struct file *file, struct poll_table_struct *wait);
 719
 720 /* Helpers for ioctl_ops. If hdl == NULL then they will all return -EINVAL. */
 721 int v4l2_queryctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_queryctrl *qc);
 722 int v4l2_query_ext_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_query_ext_ctrl *qc);
 723 int v4l2_querymenu(struct v4l2_ctrl_handler *hdl, struct v4l2_querymenu *qm);
 724 int v4l2_g_ctrl(struct v4l2_ctrl_handler *hdl, struct v4l2_control *ctrl);
 725 int v4l2_s_ctrl(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
 726                                                 struct v4l2_control *ctrl);
 727 int v4l2_g_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *c);
 728 int v4l2_try_ext_ctrls(struct v4l2_ctrl_handler *hdl, struct v4l2_ext_controls *c);
 729 int v4l2_s_ext_ctrls(struct v4l2_fh *fh, struct v4l2_ctrl_handler *hdl,
 730                                                 struct v4l2_ext_controls *c);
 731
 732 /* Helpers for subdevices. If the associated ctrl_handler == NULL then they
 733    will all return -EINVAL. */
 734 int v4l2_subdev_queryctrl(struct v4l2_subdev *sd, struct v4l2_queryctrl *qc);
 735 int v4l2_subdev_querymenu(struct v4l2_subdev *sd, struct v4l2_querymenu *qm);
 736 int v4l2_subdev_g_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
 737 int v4l2_subdev_try_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
 738 int v4l2_subdev_s_ext_ctrls(struct v4l2_subdev *sd, struct v4l2_ext_controls *cs);
 739 int v4l2_subdev_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 740 int v4l2_subdev_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl);
 741
 742 /* Can be used as a subscribe_event function that just subscribes control
 743    events. */
 744 int v4l2_ctrl_subdev_subscribe_event(struct v4l2_subdev *sd, struct v4l2_fh *fh,
 745                                      struct v4l2_event_subscription *sub);
 746
 747 /* Log all controls owned by subdev's control handler. */
 748 int v4l2_ctrl_subdev_log_status(struct v4l2_subdev *sd);
 749
 750 #endif