github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-06 21:58:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

media: v4l2-common: Add kernel-doc for v4l2_fill_pixfmt_mp_aligned()

Browse Source 
Replace the bare placeholder comment with a full kernel-doc block
documenting all parameters, the function behaviour for both single
memory plane (mem_planes == 1) and multiple memory plane (mem_planes > 1)
formats, and the return value.

Reviewed-by: Jacopo Mondi <jacopo.mondi+renesas@ideasonboard.com>
Signed-off-by: Tommaso Merciai <tommaso.merciai.xr@bp.renesas.com>
Reviewed-by: Sven Püschel <s.pueschel@pengutronix.de>
Reviewed-by: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
This commit is contained in:
Tommaso Merciai 2026-08-19 12:28:07 +02:00 committed by Sakari Ailus
parent 9dd982125d
commit ef3081d495
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
include/media/v4l2-common.h
View File

@ -591,7 +591,33 @@ static inline int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt,
return v4l2_fill_pixfmt_aligned(pixfmt, pixelformat, width, height, 1);
}
/* @stride_alignment is a power of 2 value in bytes */
/**
* v4l2_fill_pixfmt_mp_aligned - Fill in a &struct v4l2_pix_format_mplane with
* stride alignment requirements.
*
* @pixfmt: pointer to the &struct v4l2_pix_format_mplane to be filled
* @pixelformat: the V4L2 pixel format (V4L2_PIX_FMT_*)
* @width: image width in pixels
* @height: image height in pixels
* @stride_alignment: stride alignment in bytes; must be a power of 2
*
* Fills all fields of @pixfmt for the given pixel format, dimensions, and
* stride alignment.
*
* For formats stored in a single memory plane (mem_planes == 1), the
* behaviour matches v4l2_fill_pixfmt_aligned(): plane_fmt[0].bytesperline
* is set to the primary plane stride. The strides of all components are
* aligned to the @stride_alignment. To keep the chroma strides consistently
* derivable from the luma stride, strides may be aligned to a multiple of
* the @stride_alignment instead. plane_fmt[0].sizeimage covers all
* component planes.
*
* For formats with multiple memory planes (mem_planes > 1), each plane's
* bytesperline is independently rounded up to @stride_alignment, and each
* plane's sizeimage is set to bytesperline multiplied by the plane height.
*
* Return: 0 on success, -EINVAL if @pixelformat is unknown.
*/
int v4l2_fill_pixfmt_mp_aligned(struct v4l2_pix_format_mplane *pixfmt,
u32 pixelformat, u32 width, u32 height,
u8 stride_alignment);