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