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.
474 * initialising the bus. Current usage is to set a CSI-2 transmitter to
475 * LP-11 or LP-111 mode before streaming. See &enum
479 * indicated by the flags argument. In particular, -EACCES indicates lack
516 * struct v4l2_subdev_vbi_ops - Callbacks used when v4l device was opened
536 * the readback register contains invalid or erroneous data %-EIO is
561 * struct v4l2_subdev_sensor_ops - v4l2-subdev sensor operations
576 * enum v4l2_subdev_ir_mode- describes the type of IR supported
585 * struct v4l2_subdev_ir_parameters - Parameters for IR TX or TX
600 * @invert_carrier_sense: Send 0/space as a carrier burst. used only in TX.
623 /* Tx only */
634 * struct v4l2_subdev_ir_ops - operations for IR subdevices
637 * The semantics are similar to a non-blocking read() call.
646 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
653 * The semantics are similar to a non-blocking write() call.
662 * settings - e.g. an actual carrier setting of 35,904 Hz when 36,000 Hz
689 * struct v4l2_subdev_pad_config - Used for storing subdev pad information.
709 * struct v4l2_subdev_stream_config - Used for storing stream configuration.
731 * struct v4l2_subdev_stream_configs - A collection of stream configs.
742 * struct v4l2_subdev_krouting - subdev routing table
755 * struct v4l2_subdev_state - Used for storing subdev state information.
777 * 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
886 struct v4l2_subdev_krouting *route);
896 * struct v4l2_subdev_ops - Subdev operations
919 * struct v4l2_subdev_internal_ops - V4L2 subdev internal ops
934 * filehandle to the v4l-subdevX device node was closed. If no device
935 * node was created for this sub-device, then the @release callback
939 * sub-device that sets the V4L2_SUBDEV_FL_HAS_DEVNODE flag.
972 * - Centrally managed subdev active state is enabled
973 * - Legacy pad config is _not_ supported (state->pads is NULL)
974 * - Routing ioctls are available
975 * - Multiple streams per pad are supported
982 * struct v4l2_subdev_platform_data - regulators config struct
986 * @host_priv: Per-subdevice data, specific for a certain video host device
996 * struct v4l2_subdev - describes a V4L2 sub-device
999 * @list: List of sub-devices
1001 * @owner_v4l2_dev: true if the &sd->owner matches the owner of @v4l2_dev->dev
1004 * %V4L2_SUBDEV_FL_IS_I2C - Set this flag if this subdev is a i2c device;
1005 * %V4L2_SUBDEV_FL_IS_SPI - Set this flag if this subdev is a spi device;
1006 * %V4L2_SUBDEV_FL_HAS_DEVNODE - Set this flag if this subdev needs a
1008 * %V4L2_SUBDEV_FL_HAS_EVENTS - Set this flag if this subdev generates
1016 * @name: Name of the sub-device. Please notice that the name must be unique.
1017 * @grp_id: can be used to group similar subdevs. Value is driver-specific
1024 * either dev->of_node->fwnode or dev->fwnode (whichever is non-NULL).
1026 * @notifier->done_list list.
1029 * @subdev_notifier: A sub-device notifier implicitly registered for the sub-
1047 * stand-alone or embedded in a larger struct.
1097 * media_entity_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1112 * vdev_to_v4l2_subdev - Returns a &struct v4l2_subdev from
1121 * struct v4l2_subdev_fh - Used for storing subdev information per file handle
1138 * to_v4l2_subdev_fh - Returns a &struct v4l2_subdev_fh from
1149 * v4l2_subdev_get_pad_format - ancillary routine to call
1150 * &struct v4l2_subdev_pad_config->try_fmt
1154 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array
1163 if (WARN_ON(pad >= sd->entity.num_pads)) in v4l2_subdev_get_pad_format()
1165 return &state->pads[pad].try_fmt; in v4l2_subdev_get_pad_format()
1169 * v4l2_subdev_get_pad_crop - ancillary routine to call
1170 * &struct v4l2_subdev_pad_config->try_crop
1174 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1183 if (WARN_ON(pad >= sd->entity.num_pads)) in v4l2_subdev_get_pad_crop()
1185 return &state->pads[pad].try_crop; in v4l2_subdev_get_pad_crop()
1189 * v4l2_subdev_get_pad_compose - ancillary routine to call
1190 * &struct v4l2_subdev_pad_config->try_compose
1194 * @pad: index of the pad in the &struct v4l2_subdev_state->pads array.
1203 if (WARN_ON(pad >= sd->entity.num_pads)) in v4l2_subdev_get_pad_compose()
1205 return &state->pads[pad].try_compose; in v4l2_subdev_get_pad_compose()
1226 * v4l2_set_subdevdata - Sets V4L2 dev private device data
1233 sd->dev_priv = p; in v4l2_set_subdevdata()
1237 * v4l2_get_subdevdata - Gets V4L2 dev private device data
1245 return sd->dev_priv; in v4l2_get_subdevdata()
1249 * v4l2_set_subdev_hostdata - Sets V4L2 dev private host data
1256 sd->host_priv = p; in v4l2_set_subdev_hostdata()
1260 * v4l2_get_subdev_hostdata - Gets V4L2 dev private data
1268 return sd->host_priv; in v4l2_get_subdev_hostdata()
1274 * v4l2_subdev_get_fwnode_pad_1_to_1 - Get pad number from a subdev fwnode
1291 * v4l2_subdev_link_validate_default - validates a media link
1307 * v4l2_subdev_link_validate - validates a media link
1320 * v4l2_subdev_has_pad_interdep - MC has_pad_interdep implementation for subdevs
1331 * It considers two pads interdependent if there is an active route between pad0
1338 * __v4l2_subdev_state_alloc - allocate v4l2_subdev_state
1353 * __v4l2_subdev_state_free - free a v4l2_subdev_state
1362 * v4l2_subdev_init_finalize() - Finalizes the initialization of the subdevice
1379 ":" __stringify(__LINE__) ":sd->active_state->lock"; \
1387 * v4l2_subdev_cleanup() - Releases the resources allocated by the subdevice
1390 * Clean up a V4L2 async sub-device. Must be called for a sub-device as part of
1397 * v4l2_subdev_lock_state() - Locks the subdev state
1406 mutex_lock(state->lock); in v4l2_subdev_lock_state()
1410 * v4l2_subdev_unlock_state() - Unlocks the subdev state
1417 mutex_unlock(state->lock); in v4l2_subdev_unlock_state()
1421 * v4l2_subdev_get_unlocked_active_state() - Checks that the active subdev state
1435 if (sd->active_state) in v4l2_subdev_get_unlocked_active_state()
1436 lockdep_assert_not_held(sd->active_state->lock); in v4l2_subdev_get_unlocked_active_state()
1437 return sd->active_state; in v4l2_subdev_get_unlocked_active_state()
1441 * v4l2_subdev_get_locked_active_state() - Checks that the active subdev state
1456 if (sd->active_state) in v4l2_subdev_get_locked_active_state()
1457 lockdep_assert_held(sd->active_state->lock); in v4l2_subdev_get_locked_active_state()
1458 return sd->active_state; in v4l2_subdev_get_locked_active_state()
1462 * v4l2_subdev_lock_and_get_active_state() - Locks and returns the active subdev
1474 if (sd->active_state) in v4l2_subdev_lock_and_get_active_state()
1475 v4l2_subdev_lock_state(sd->active_state); in v4l2_subdev_lock_and_get_active_state()
1476 return sd->active_state; in v4l2_subdev_lock_and_get_active_state()
1482 * v4l2_subdev_get_fmt() - Fill format based on state
1487 * Fill @format->format field based on the information in the @format struct.
1499 * v4l2_subdev_set_routing() - Set given routing to subdev state
1516 struct v4l2_subdev_route *route);
1519 * for_each_active_route - iterate on all active routes of a routing table
1521 * @route: The route iterator
1523 #define for_each_active_route(routing, route) \ argument
1524 for ((route) = NULL; \
1525 ((route) = __v4l2_subdev_next_active_route((routing), (route)));)
1528 * v4l2_subdev_set_routing_with_fmt() - Set given routing and format to subdev
1544 * v4l2_subdev_state_get_stream_format() - Get pointer to a stream format
1559 * v4l2_subdev_state_get_stream_crop() - Get pointer to a stream crop rectangle
1574 * v4l2_subdev_state_get_stream_compose() - Get pointer to a stream compose
1590 * v4l2_subdev_routing_find_opposite_end() - Find the opposite stream
1603 * Returns 0 on success, or -EINVAL if no matching route is found.
1610 * v4l2_subdev_state_get_opposite_stream_format() - Get pointer to opposite
1626 * v4l2_subdev_state_xlate_streams() - Translate streams from one pad to another
1635 * the sink and source side of a route. This function translates stream numbers
1649 * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
1666 * only non-overlapping 1-to-1 stream routing is allowed (a combination of
1695 * v4l2_subdev_routing_validate() - Verify that routes comply with driver
1710 * v4l2_subdev_enable_streams() - Enable streams on a pad
1721 * contains an already enabled stream, this function returns -EALREADY without
1724 * Per-stream enable is only available for subdevs that implement the
1726 * function implements a best-effort compatibility by calling the .s_stream()
1731 * * -EALREADY: One of the streams in streams_mask is already enabled
1732 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1733 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1740 * v4l2_subdev_disable_streams() - Disable streams on a pad
1751 * contains a disabled stream, this function returns -EALREADY without
1754 * Per-stream disable is only available for subdevs that implement the
1756 * function implements a best-effort compatibility by calling the .s_stream()
1761 * * -EALREADY: One of the streams in streams_mask is not enabled
1762 * * -EINVAL: The pad index is invalid, or doesn't correspond to a source pad
1763 * * -EOPNOTSUPP: Falling back to the legacy .s_stream() operation is
1770 * v4l2_subdev_s_stream_helper() - Helper to implement the subdev s_stream
1775 * Subdevice drivers that implement the streams-aware
1791 * v4l2_subdev_init - initializes the sub-device struct
1802 * v4l2_subdev_call - call an operation of a v4l2_subdev.
1819 __result = -ENODEV; \
1820 else if (!(__sd->ops->o && __sd->ops->o->f)) \
1821 __result = -ENOIOCTLCMD; \
1823 v4l2_subdev_call_wrappers.o->f) \
1824 __result = v4l2_subdev_call_wrappers.o->f( \
1827 __result = __sd->ops->o->f(__sd, ##args); \
1832 * v4l2_subdev_call_state_active - call an operation of a v4l2_subdev which
1862 * v4l2_subdev_call_state_try - call an operation of a v4l2_subdev which
1878 * Note: only legacy non-MC drivers may need this macro.
1885 ":" __stringify(__LINE__) ":state->lock"; \
1896 * v4l2_subdev_has_op - Checks if a subdev defines a certain operation.
1904 ((sd)->ops->o && (sd)->ops->o->f)
1907 * v4l2_subdev_notify_event() - Delivers event notification for subdevice