Re: [PATCH v3 03/17] media: v4l2: Add Apple interchange pixel formats

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] media: v4l2: missing uAPI documentation for V4L2_PIX_FMT_APPLE_AX* formats
--

commit d684a5929494768cf0717a93efaa873095757868
Author: Sofus Forstreuter <sofus.c@icloud.com>

media: v4l2: Add Apple interchange pixel formats

This commit adds six Apple Interchange compressed and tiled pixel format
identifiers to videodev2.h along with their descriptions in v4l_fill_fmtdesc()
and format info entries in v4l2_format_info().

[ ... ]

> diff --git a/include/uapi/linux/videodev2.h b/include/uapi/linux/videodev2.h
> index 5472e433ed06e..f218f4fb26a42 100644
> --- a/include/uapi/linux/videodev2.h
> +++ b/include/uapi/linux/videodev2.h
> @@ -842,6 +842,14 @@ struct v4l2_pix_format {
>  #define V4L2_PIX_FMT_PISP_COMP2_BGGR	v4l2_fourcc('P', 'C', '2', 'B') /* PiSP 8-bit mode 2 compressed BGGR bayer */
>  #define V4L2_PIX_FMT_PISP_COMP2_MONO	v4l2_fourcc('P', 'C', '2', 'M') /* PiSP 8-bit mode 2 compressed monochrome */
>  
> +/* Apple Interchange, compressed and tiled formats */
> +#define V4L2_PIX_FMT_APPLE_AX12	v4l2_fourcc('A', 'X', '1', '2') /* Apple Interchange NV12 */
> +#define V4L2_PIX_FMT_APPLE_AX16	v4l2_fourcc('A', 'X', '1', '6') /* Apple Interchange NV16 */
> +#define V4L2_PIX_FMT_APPLE_AX24	v4l2_fourcc('A', 'X', '2', '4') /* Apple Interchange NV24 */
> +#define V4L2_PIX_FMT_APPLE_AX03	v4l2_fourcc('A', 'X', '0', '3') /* Apple Interchange P030 */
> +#define V4L2_PIX_FMT_APPLE_AX23	v4l2_fourcc('A', 'X', '2', '3') /* Apple Interchange P230 */
> +#define V4L2_PIX_FMT_APPLE_AX43	v4l2_fourcc('A', 'X', '4', '3') /* Apple Interchange P430 */

[Severity: Low]
Documentation/userspace-api/media/v4l/videodev.rst includes
include/uapi/linux/videodev2.h with:

.. kernel-include:: include/uapi/linux/videodev2.h
    :generate-cross-refs:
    :exception-file: videodev2.h.rst.exceptions
    :toc:
    :warn-broken:

When building the documentation (make htmldocs),
ParseDataStructs.parse_file() in tools/lib/python/kdoc/parse_data_structs.py
generates :ref: cross-references for every #define macro in
include/uapi/linux/videodev2.h unless exempted in
videodev2.h.rst.exceptions, and check_missing_refs() in
Documentation/sphinx/kernel_include.py warns on unresolved references.

Should these six new V4L2_PIX_FMT_APPLE_AX* formats also be documented in
Documentation/userspace-api/media/v4l/ (for example, in
pixfmt-reserved.rst) so that building htmldocs does not emit broken
cross-reference warnings for v4l2-pix-fmt-apple-ax12,
v4l2-pix-fmt-apple-ax16, v4l2-pix-fmt-apple-ax24, v4l2-pix-fmt-apple-ax03,
v4l2-pix-fmt-apple-ax23, and v4l2-pix-fmt-apple-ax43?

> +
>  /* Renesas RZ/V2H CRU packed formats. 64-bit units with contiguous pixels */
>  #define V4L2_PIX_FMT_RAW_CRU10	v4l2_fourcc('C', 'R', '1', '0')
>  #define V4L2_PIX_FMT_RAW_CRU12	v4l2_fourcc('C', 'R', '1', '2')

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261020-avd-v3-0-85cbaa2125d8@icloud.com?part=3