include/media/v4l2-ctrls.h

3  *  V4L2 controls support header.
114  *		for volatile (and usually read-only) controls such as a control
122  *		one else can access controls owned by that handler.
174  * @ncontrols:	Number of controls in cluster array.
215  * @step:	The control's step value for non-menu controls.
223  * @menu_skip_mask: The control's skip mask for menu controls. This makes it
255  *		through a pointer (for compound controls only).
258  *		through a pointer (for compound controls only).
261  *		through a pointer (for compound controls only).
339  *		the control has been applied. This prevents applying controls
340  *		from a cluster with multiple controls twice (when the first
362  * keep a sorted-by-control-ID list of all controls, while the next pointer
381  *	controls: both the controls owned by the handler and those inherited
385  * @lock:	Lock to control access to this handler and its controls.
387  * @ctrls:	The list of controls owned by this handler.
407  *		in which these controls are applied. Once the request is
433  * @type_ops:	The control type ops. Only needed for compound controls.
439  * @step:	The control's step value for non-menu controls.
441  * @p_def:	The control's default value for compound controls.
442  * @p_min:	The control's minimum value for compound controls.
443  * @p_max:	The control's maximum value for compound controls.
447  * @menu_skip_mask: The control's skip mask for menu controls. This makes it
496  * This works for all standard V4L2 controls.
497  * For non-standard controls it will only fill in the given arguments
517  * @nr_of_controls_hint: A hint of how many controls this handler is
519  *		any inherited controls. It doesn't have to be precise, but if
546  * @nr_of_controls_hint: A hint of how many controls this handler is
548  *		any inherited controls. It doesn't have to be precise, but if
577  * v4l2_ctrl_handler_free() - Free all controls owned by the handler and free
608  * __v4l2_ctrl_handler_setup() - Call the s_ctrl op for all controls belonging
614  * Button controls will be skipped, as are read-only controls.
621  * v4l2_ctrl_handler_setup() - Call the s_ctrl op for all controls belonging
625  * Button controls will be skipped, as are read-only controls.
632  * v4l2_ctrl_handler_log_status() - Log all controls owned by the handler.
679  * Use v4l2_ctrl_new_std_menu() when adding menu controls.
694  * @mask:	The control's skip mask for menu controls. This makes it
719  * @mask:	The control's skip mask for menu controls. This makes it
749  * Same as v4l2_ctrl_new_std(), but with support for compound controls.
797  * v4l2_ctrl_add_handler() - Add all controls from handler @add to
801  * @add:	The control handler whose controls you want to add to
803  * @filter:	This function will filter which controls should be added.
804  * @from_other_dev: If true, then the controls in @add were defined in another
808  * If @filter is NULL, then all controls are added. Otherwise only those
809  * controls for which @filter returns true will be added.
819  * v4l2_ctrl_radio_filter() - Standard filter for radio controls.
823  * This will return true for any controls that are valid for radio device
824  * nodes. Those are all of the V4L2_CID_AUDIO_* user controls and all FM
825  * transmitter class controls.
832  * v4l2_ctrl_cluster() - Mark all controls in the cluster as belonging
835  * @ncontrols:	The number of controls in this cluster.
836  * @controls:	The cluster control array of size @ncontrols.
838 void v4l2_ctrl_cluster(unsigned int ncontrols, struct v4l2_ctrl **controls);
842  * v4l2_ctrl_auto_cluster() - Mark all controls in the cluster as belonging
845  * @ncontrols:	The number of controls in this cluster.
846  * @controls:	The cluster control array of size @ncontrols. The first control
850  * @set_volatile: If true, then all controls except the first auto control will
854  * the other controls are only active whenever the automatic feature is turned
858  * The behavior of such controls is as follows:
860  * When the autofoo control is set to automatic, then any manual controls
864  * When the autofoo control is set to manual, then any manual controls will
873 			    struct v4l2_ctrl **controls,
953  * INTEGER, BOOLEAN, MENU, INTEGER MENU and BITMASK. For menu controls the
975  * INTEGER, BOOLEAN, MENU, INTEGER MENU and BITMASK. For menu controls the
1107  * This function is for integer type controls only.
1121  * This function is for integer type controls only.
1135  * This function is for integer type controls only.
1158  * This function is for 64-bit integer type controls only.
1172  * This function is for 64-bit integer type controls only.
1187  * This function is for 64-bit integer type controls only.
1210  * This function is for string type controls only.
1225  * This function is for string type controls only.
1249  * This function is for compound type controls only.
1266  * This function is for compound type controls only.
1281 /* Helper defines for area type controls */
1319  * Can be used as a vidioc_log_status function that just dumps all controls
1370  * The function first obtains the values of any volatile controls in the control
1557  * v4l2_ctrl_subdev_log_status - Log all controls owned by subdev's control
1565  * v4l2_ctrl_new_fwnode_properties() - Register controls for the device
1568  * @hdl: pointer to &struct v4l2_ctrl_handler to register controls on
1569  * @ctrl_ops: pointer to &struct v4l2_ctrl_ops to register controls with
1572  * This function registers controls associated to device properties, using the
1576  * Currently the following v4l2 controls are parsed and registered:
1580  * Controls already registered by the caller with the @hdl control handler are
1581  * not overwritten. Callers should register the controls they want to handle
1585  * other functions adding controls to the handler.