github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-30 18:13:41 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

media: subdev: Improve v4l2_subdev_get_frame_desc_passthrough() kdoc

Browse Source 
Improve the v4l2_subdev_get_frame_desc_passthrough() kernel doc:

- Fix 'v4l2_get_frame_desc' operation to 'get_frame_desc' operation
- Rewrite the body text to be more understandable and specific, and
  specifically mention the frame desc type handling.

Signed-off-by: Tomi Valkeinen <tomi.valkeinen+renesas@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Hans Verkuil <hverkuil+cisco@kernel.org>
This commit is contained in:
Tomi Valkeinen 2026-03-17 14:09:40 +02:00 committed by Hans Verkuil
parent 1b065199ea
commit 754ec1f196
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/media/v4l2-subdev.h
View File

@ -1724,19 +1724,25 @@ int v4l2_subdev_s_stream_helper(struct v4l2_subdev *sd, int enable);
/**
* v4l2_subdev_get_frame_desc_passthrough() - Helper to implement the subdev
* v4l2_get_frame_desc operation in simple passthrough cases
* get_frame_desc operation in simple passthrough cases
* @sd: The subdevice
* @pad: The source pad index
* @fd: The mbus frame desc
*
* Subdevice drivers that only pass through the streams can use this helper
* to implement the &v4l2_subdev_pad_ops.v4l2_get_frame_desc operation.
* This helper implements get_frame_desc operation for subdevices that pass
* streams through without modification. It can be assigned directly as the
* .get_frame_desc callback in &v4l2_subdev_pad_ops.
*
* The helper will call get_frame_desc on the subdevice's sources, create a new
* frame desc which contains only the streams on the given source pad. The data
* for each frame desc entry is copied directly from the data provided from the
* calls to the subdevice's sources, with the exception of the 'stream' field
* which is set according to the subdevice's routing table.
* The helper iterates over the subdevice's sink pads, calls get_frame_desc on
* the remote subdevice connected to each sink pad, and collects the frame desc
* entries for streams that are routed to the given source pad according to the
* subdevice's routing table. Each entry is copied as-is from the upstream
* source, with the exception of the 'stream' field which is remapped to the
* source stream ID from the routing table.
*
* The frame desc type is taken from the first upstream source. If multiple
* sink pads are involved and the upstream sources report different frame desc
* types, -EPIPE is returned.
*
* Return: 0 on success, or a negative error code otherwise.
*/