Lines Matching +full:i2s +full:- +full:tx +full:- +full:route
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
129 * @function: Internal signal pad/function to route to IO pin
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.
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.
295 * @s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
296 * way to select I2S clock used by driving digital audio streams at some
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.
470 * initialising the bus. Current usage is to set a CSI-2 transmitter to
471 * LP-11 or LP-111 mode before streaming. See &enum
475 * indicated by the flags argument. In particular, -EACCES indicates lack
502 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
522 * the readback register contains invalid or erroneous data %-EIO is
547 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
562 * enum v4l2_subdev_ir_mode- describes the type of IR supported
571 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
586 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
609 /* Tx only */
620 * struct v4l2_subdev_ir_ops - operations for IR subdevices
623 * The semantics are similar to a non-blocking read() call.
632 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
639 * The semantics are similar to a non-blocking write() call.
648 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
675 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
690 * struct v4l2_subdev_stream_config - Used for storing stream configuration.
714 * struct v4l2_subdev_stream_configs - A collection of stream configs.
725 * struct v4l2_subdev_krouting - subdev routing table
740 * struct v4l2_subdev_state - Used for storing subdev state information.
744 * @sd: the sub-device which the state is related to
764 * struct v4l2_subdev_pad_ops - v4l2-subdev pad level operations
814 * @get_mbus_config: get the media bus configuration of a remote sub-device.
816 * firmware interface at sub-device probe time, immediately
818 * driver. Remote sub-devices (usually video receivers) shall
821 * Callers should make sure they get the most up-to-date as
840 * V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
850 * V4L2_SUBDEV_CAP_STREAMS sub-device capability flag can ignore the mask
907 struct v4l2_subdev_krouting *route);
917 * struct v4l2_subdev_ops - Subdev operations
940 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
957 * filehandle to the v4l-subdevX device node was closed. If no device
958 * node was created for this sub-device, then the @release callback
962 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
995 * - Centrally managed subdev active state is enabled
996 * - Legacy pad config is _not_ supported (state->pads is NULL)
997 * - Routing ioctls are available
998 * - Multiple streams per pad are supported
1005 * struct v4l2_subdev_platform_data - regulators config struct
1009 * @host_priv: Per-subdevice data, specific for a certain video host device
1019 * struct v4l2_subdev - describes a V4L2 sub-device
1022 * @list: List of sub-devices
1024 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
1027 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
1028 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
1029 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
1031 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
1039 * @name: Name of the sub-device. Please notice that the name must be unique.
1040 * @grp_id: can be used to group similar subdevs. Value is driver-specific
1047 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
1049 * @notifier->done_list list.
1052 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
1071 * stand-alone or embedded in a larger struct.
1122 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1137 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1146 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
1163 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1174 * v4l2_set_subdevdata - Sets V4L2 dev private device data
1181 sd->dev_priv = p;
1185 * v4l2_get_subdevdata - Gets V4L2 dev private device data
1193 return sd->dev_priv;
1197 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1204 sd->host_priv = p;
1208 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1216 return sd->host_priv;
1222 * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1239 * v4l2_subdev_link_validate_default - validates a media link
1255 * v4l2_subdev_link_validate - validates a media link
1265 * The function can be used as a drop-in &media_entity_ops.link_validate
1274 * v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs
1285 * It considers two pads interdependent if there is an active route between pad0
1292 * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1307 * __v4l2_subdev_state_free - free a v4l2_subdev_state
1316 * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1333 ":" __stringify(__LINE__) ":sd->active_state->lock"; \
1341 * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1344 * Clean up a V4L2 async sub-device. Must be called for a sub-device as part of
1351 * A macro to generate the macro or function name for sub-devices state access
1368 * v4l2_subdev_state_get_format() - Get pointer to a stream format
1376 * For stream-unaware drivers the format for the corresponding pad is returned.
1387 * const-correctness in all cases.
1403 * v4l2_subdev_state_get_crop() - Get pointer to a stream crop rectangle
1411 * For stream-unaware drivers the crop rectangle for the corresponding pad is
1425 * v4l2_subdev_state_get_compose() - Get pointer to a stream compose rectangle
1433 * For stream-unaware drivers the compose rectangle for the corresponding pad is
1447 * v4l2_subdev_state_get_interval() - Get pointer to a stream frame interval
1455 * For stream-unaware drivers the frame interval for the corresponding pad is
1471 * v4l2_subdev_get_fmt() - Fill format based on state
1476 * Fill @format->format field based on the information in the @format struct.
1488 * v4l2_subdev_get_frame_interval() - Fill frame interval based on state
1493 * Fill @fi->interval field based on the information in the @fi struct.
1506 * v4l2_subdev_set_routing() - Set given routing to subdev state
1523 struct v4l2_subdev_route *route);
1526 * for_each_active_route - iterate on all active routes of a routing table
1528 * @route: The route iterator
1530 #define for_each_active_route(routing, route) \
1531 for ((route) = NULL; \
1532 ((route) = __v4l2_subdev_next_active_route((routing), (route)));)
1535 * v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev
1551 * v4l2_subdev_routing_find_opposite_end() - Find the opposite stream
1564 * Returns 0 on success, or -EINVAL if no matching route is found.
1571 * v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite
1587 * v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another
1596 * the sink and source side of a route. This function translates stream numbers
1610 * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
1627 * only non-overlapping 1-to-1 stream routing is allowed (a combination of
1656 * v4l2_subdev_routing_validate() - Verify that routes comply with driver
1671 * v4l2_subdev_enable_streams() - Enable streams on a pad
1682 * contains an already enabled stream, this function returns -EALREADY without
1685 * Per-stream enable is only available for subdevs that implement the
1687 * function implements a best-effort compatibility by calling the .s_stream()
1690 * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
1694 * * -EALREADY: One of the streams in streams_mask is already enabled
1695 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1696 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1703 * v4l2_subdev_disable_streams() - Disable streams on a pad
1714 * contains a disabled stream, this function returns -EALREADY without
1717 * Per-stream disable is only available for subdevs that implement the
1719 * function implements a best-effort compatibility by calling the .s_stream()
1722 * Drivers that are not stream-aware shall set @streams_mask to BIT_ULL(0).
1726 * * -EALREADY: One of the streams in streams_mask is not enabled
1727 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1728 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1735 * v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream
1740 * Subdevice drivers that implement the streams-aware
1756 * v4l2_subdev_lock_state() - Locks the subdev state
1765 mutex_lock(state->lock);
1769 * v4l2_subdev_unlock_state() - Unlocks the subdev state
1776 mutex_unlock(state->lock);
1780 * v4l2_subdev_lock_states - Lock two sub-device states
1784 * Locks the state of two sub-devices.
1796 mutex_lock(state1->lock);
1797 if (state1->lock != state2->lock)
1798 mutex_lock(state2->lock);
1802 * v4l2_subdev_unlock_states() - Unlock two sub-device states
1806 * Unlocks the state of two sub-devices.
1814 mutex_unlock(state1->lock);
1815 if (state1->lock != state2->lock)
1816 mutex_unlock(state2->lock);
1820 * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1834 if (sd->active_state)
1835 lockdep_assert_not_held(sd->active_state->lock);
1836 return sd->active_state;
1840 * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1855 if (sd->active_state)
1856 lockdep_assert_held(sd->active_state->lock);
1857 return sd->active_state;
1861 * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1873 if (sd->active_state)
1874 v4l2_subdev_lock_state(sd->active_state);
1875 return sd->active_state;
1879 * v4l2_subdev_init - initializes the sub-device struct
1890 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1907 __result = -ENODEV; \
1908 else if (!(__sd->ops->o && __sd->ops->o->f)) \
1909 __result = -ENOIOCTLCMD; \
1911 v4l2_subdev_call_wrappers.o->f) \
1912 __result = v4l2_subdev_call_wrappers.o->f( \
1915 __result = __sd->ops->o->f(__sd, ##args); \
1920 * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1950 * v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which
1966 * Note: only legacy non-MC drivers may need this macro.
1973 ":" __stringify(__LINE__) ":state->lock"; \
1984 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1992 ((sd)->ops->o && (sd)->ops->o->f)
1995 * v4l2_subdev_notify_event() - Delivers event notification for subdevice
2008 * v4l2_subdev_is_streaming() - Returns if the subdevice is streaming