include/media/v4l2-subdev.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3  *  V4L2 sub-device support header.
12 #include <linux/v4l2-subdev.h>
13 #include <media/media-entity.h>
14 #include <media/v4l2-async.h>
15 #include <media/v4l2-common.h>
16 #include <media/v4l2-dev.h>
17 #include <media/v4l2-fh.h>
18 #include <media/v4l2-mediabus.h>
44  * struct v4l2_decode_vbi_line - used to decode_vbi_line
50  * @line: Line number of the sliced VBI data (1-23)
61  * Sub-devices are devices that are connected somehow to the main bridge
69  * generic manner. Most operations that these sub-devices support fall in
98  * The ioctl ops is meant for generic ioctl-like commands. Depending on
99  * the use-case it might be better to use subdev-specific ops (currently
100  * not yet implemented) since ops provide proper type-checking.
104  * enum v4l2_subdev_io_pin_bits - Subdevice external IO pin configuration
111  *				  &struct v4l2_subdev_io_pin_config->value.
124  * struct v4l2_subdev_io_pin_config - Subdevice external IO pin configuration
130  * @value: Initial value for pin - e.g. GPIO output value
142  * struct v4l2_subdev_core_ops - Define core ops callbacks for subdevs
160  *	drivers without discussing this first on the linux-media mailinglist.
164  *	a direction argument if needed.
166  * @command: called by in-kernel drivers in order to call functions internal
181  *	Documentation/driver-api/media/camera-sensor.rst . pre_streamon and
182  *	post_streamoff callbacks can be used for e.g. setting the bus to LP-11
223  * struct v4l2_subdev_tuner_ops - Callbacks used when v4l device was opened
237  *		 freq->type must be filled in. Normally done by video_ioctl2()
244  * @s_tuner: callback for VIDIOC_S_TUNER() ioctl handler code. @vt->type must be
287  * struct v4l2_subdev_audio_ops - Callbacks used for audio-related settings
293  *	-EINVAL is returned.
298  *	If the frequency is not supported, then %-EINVAL is returned.
302  *	Never attempt to use user-level input IDs (e.g. Composite, S-Video,
306  *	The calling driver is responsible for mapping a user-level input to
322  * @vc: CSI-2 virtual channel
323  * @dt: CSI-2 data type ID
331  * enum v4l2_mbus_frame_desc_flags - media bus frame description flags
334  *	Indicates that &struct v4l2_mbus_frame_desc_entry->length field
346  * struct v4l2_mbus_frame_desc_entry - media bus frame description structure
354  * @bus:	Bus-specific frame descriptor parameters
355  * @bus.csi2:	CSI-2-specific bus configuration
374  * enum v4l2_mbus_frame_desc_type - media bus frame description type
382  *	CSI-2 media bus. Frame desc parameters must be set in
383  *	&struct v4l2_mbus_frame_desc_entry->csi2.
392  * struct v4l2_mbus_frame_desc - media bus data frame description
404  * enum v4l2_subdev_pre_streamon_flags - Flags for pre_streamon subdev core op
406  * @V4L2_SUBDEV_PRE_STREAMON_FL_MANUAL_LP: Set the transmitter to either LP-11
407  *	or LP-111 mode before call to s_stream().
414  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
423  *	to 0. If the frequency is not supported, then -EINVAL is returned.
447  *	sub-device. Failure on stop will remove any resources acquired in
451  *	v4l2-subdev.c.
468  *	initialising the bus. Current usage is to set a CSI-2 transmitter to
469  *	LP-11 or LP-111 mode before streaming. See &enum
473  *	indicated by the flags argument. In particular, -EACCES indicates lack
506  * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
526  *	the readback register contains invalid or erroneous data %-EIO is
551  * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
566  * enum v4l2_subdev_ir_mode- describes the type of IR supported
575  * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
585  * @max_pulse_width:  maximum pulse width in ns, valid only for baseband signal
587  * @duty_cycle: duty cycle percentage, valid only for modulated signal
592  * @noise_filter_min_width: min time of a valid pulse, in ns. Used only for RX.
597  * @resolution: The receive resolution, in ns . Used only for RX.
624  * struct v4l2_subdev_ir_ops - operations for IR subdevices
627  *	The semantics are similar to a non-blocking read() call.
636  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
643  *	The semantics are similar to a non-blocking write() call.
652  *	settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
679  * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
694  * struct v4l2_subdev_stream_config - Used for storing stream configuration.
718  * struct v4l2_subdev_stream_configs - A collection of stream configs.
729  * struct v4l2_subdev_krouting - subdev routing table
742  * struct v4l2_subdev_state - Used for storing subdev state information.
746  * @sd: the sub-device which the state is related to
766  * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
808  * @get_mbus_config: get the media bus configuration of a remote sub-device.
810  *		     firmware interface at sub-device probe time, immediately
812  *		     driver. Remote sub-devices (usually video receivers) shall
815  *		     Callers should make sure they get the most up-to-date as
895  * struct v4l2_subdev_ops - Subdev operations
918  * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
935  *	filehandle to the v4l-subdevX device node was closed. If no device
936  *	node was created for this sub-device, then the @release callback
940  *	sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
973  * - Centrally managed subdev active state is enabled
974  * - Legacy pad config is _not_ supported (state->pads is NULL)
975  * - Routing ioctls are available
976  * - Multiple streams per pad are supported
983  * struct v4l2_subdev_platform_data - regulators config struct
987  * @host_priv: Per-subdevice data, specific for a certain video host device
997  * struct v4l2_subdev - describes a V4L2 sub-device
1000  * @list: List of sub-devices
1002  * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
1005  *   %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
1006  *   %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
1007  *   %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
1009  *   %V4L2_SUBDEV_FL_HAS_EVENTS -  Set this flag if this subdev generates
1017  * @name: Name of the sub-device. Please notice that the name must be unique.
1018  * @grp_id: can be used to group similar subdevs. Value is driver-specific
1025  *	    either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
1027  *		@notifier->done_list list.
1030  * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
1048  * stand-alone or embedded in a larger struct.
1098  * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1113  * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1122  * struct v4l2_subdev_fh - Used for storing subdev information per file handle
1139  * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1150  * v4l2_set_subdevdata - Sets V4L2 dev private device data
1157 	sd->dev_priv = p;  in v4l2_set_subdevdata()
1161  * v4l2_get_subdevdata - Gets V4L2 dev private device data
1169 	return sd->dev_priv;  in v4l2_get_subdevdata()
1173  * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1180 	sd->host_priv = p;  in v4l2_set_subdev_hostdata()
1184  * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1192 	return sd->host_priv;  in v4l2_get_subdev_hostdata()
1198  * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1215  * v4l2_subdev_link_validate_default - validates a media link
1231  * v4l2_subdev_link_validate - validates a media link
1244  * v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs
1262  * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1277  * __v4l2_subdev_state_free - free a v4l2_subdev_state
1286  * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1303 			":" __stringify(__LINE__) ":sd->active_state->lock";   \
1311  * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1314  * Clean up a V4L2 async sub-device. Must be called for a sub-device as part of
1321  * A macro to generate the macro or function name for sub-devices state access
1328  * v4l2_subdev_state_get_format() - Get pointer to a stream format
1336  * For stream-unaware drivers the format for the corresponding pad is returned.
1358  * v4l2_subdev_state_get_crop() - Get pointer to a stream crop rectangle
1366  * For stream-unaware drivers the crop rectangle for the corresponding pad is
1379  * v4l2_subdev_state_get_compose() - Get pointer to a stream compose rectangle
1387  * For stream-unaware drivers the compose rectangle for the corresponding pad is
1400  * v4l2_subdev_state_get_interval() - Get pointer to a stream frame interval
1408  * For stream-unaware drivers the frame interval for the corresponding pad is
1423  * v4l2_subdev_get_fmt() - Fill format based on state
1428  * Fill @format->format field based on the information in the @format struct.
1440  * v4l2_subdev_get_frame_interval() - Fill frame interval based on state
1445  * Fill @fi->interval field based on the information in the @fi struct.
1458  * v4l2_subdev_set_routing() - Set given routing to subdev state
1478  * for_each_active_route - iterate on all active routes of a routing table
1487  * v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev
1503  * v4l2_subdev_routing_find_opposite_end() - Find the opposite stream
1516  * Returns 0 on success, or -EINVAL if no matching route is found.
1523  * v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite
1539  * v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another
1562  * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
1579  *	only non-overlapping 1-to-1 stream routing is allowed (a combination of
1608  * v4l2_subdev_routing_validate() - Verify that routes comply with driver
1623  * v4l2_subdev_enable_streams() - Enable streams on a pad
1634  * contains an already enabled stream, this function returns -EALREADY without
1637  * Per-stream enable is only available for subdevs that implement the
1639  * function implements a best-effort compatibility by calling the .s_stream()
1644  * * -EALREADY: One of the streams in streams_mask is already enabled
1645  * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1646  * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1653  * v4l2_subdev_disable_streams() - Disable streams on a pad
1664  * contains a disabled stream, this function returns -EALREADY without
1667  * Per-stream disable is only available for subdevs that implement the
1669  * function implements a best-effort compatibility by calling the .s_stream()
1674  * * -EALREADY: One of the streams in streams_mask is not enabled
1675  * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1676  * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1683  * v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream
1688  * Subdevice drivers that implement the streams-aware
1704  * v4l2_subdev_lock_state() - Locks the subdev state
1713 	mutex_lock(state->lock);  in v4l2_subdev_lock_state()
1717  * v4l2_subdev_unlock_state() - Unlocks the subdev state
1724 	mutex_unlock(state->lock);  in v4l2_subdev_unlock_state()
1728  * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1742 	if (sd->active_state)  in v4l2_subdev_get_unlocked_active_state()
1743 		lockdep_assert_not_held(sd->active_state->lock);  in v4l2_subdev_get_unlocked_active_state()
1744 	return sd->active_state;  in v4l2_subdev_get_unlocked_active_state()
1748  * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1763 	if (sd->active_state)  in v4l2_subdev_get_locked_active_state()
1764 		lockdep_assert_held(sd->active_state->lock);  in v4l2_subdev_get_locked_active_state()
1765 	return sd->active_state;  in v4l2_subdev_get_locked_active_state()
1769  * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1781 	if (sd->active_state)  in v4l2_subdev_lock_and_get_active_state()
1782 		v4l2_subdev_lock_state(sd->active_state);  in v4l2_subdev_lock_and_get_active_state()
1783 	return sd->active_state;  in v4l2_subdev_lock_and_get_active_state()
1787  * v4l2_subdev_init - initializes the sub-device struct
1798  * v4l2_subdev_call - call an operation of a v4l2_subdev.
1815 			__result = -ENODEV;				\
1816 		else if (!(__sd->ops->o && __sd->ops->o->f))		\
1817 			__result = -ENOIOCTLCMD;			\
1819 			 v4l2_subdev_call_wrappers.o->f)		\
1820 			__result = v4l2_subdev_call_wrappers.o->f(	\
1823 			__result = __sd->ops->o->f(__sd, ##args);	\
1828  * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1858  * v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which
1874  * Note: only legacy non-MC drivers may need this macro.
1881 			":" __stringify(__LINE__) ":state->lock";     \
1892  * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1900 	((sd)->ops->o && (sd)->ops->o->f)
1903  * v4l2_subdev_notify_event() - Delivers event notification for subdevice