mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mario Limonciello <superm1@kernel.org>
To: Bin Du <Bin.Du@amd.com>,
	mchehab@kernel.org, hverkuil@xs4all.nl,
	laurent.pinchart+renesas@ideasonboard.com,
	bryan.odonoghue@linaro.org, sakari.ailus@linux.intel.com,
	prabhakar.mahadev-lad.rj@bp.renesas.com,
	linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	sultan@kerneltoast.com
Cc: pratap.nirujogi@amd.com, benjamin.chan@amd.com, king.li@amd.com,
	gjorgji.rosikopulos@amd.com, Phil.Jawich@amd.com,
	Dominic.Antony@amd.com, richard.gong@amd.com, anson.tsao@amd.com,
	Svetoslav Stoilov <Svetoslav.Stoilov@amd.com>
Subject: Re: [PATCH v3 7/7] Documentation: add documentation of AMD isp 4 driver
Date: Thu, 28 Aug 2025 11:50:21 -0500	[thread overview]
Message-ID: <906411e5-4354-4670-bd84-640a5b47a2bd@kernel.org> (raw)
In-Reply-To: <20250828100811.95722-7-Bin.Du@amd.com>

Just two small nits to me.

On 8/28/25 5:08 AM, Du, Bin wrote:
> Add documentation for AMD isp 4 and describe the main components

Probably should be "ISP"

> 
> Co-developed-by: Svetoslav Stoilov <Svetoslav.Stoilov@amd.com>
> Signed-off-by: Svetoslav Stoilov <Svetoslav.Stoilov@amd.com>
> Signed-off-by: Bin Du <Bin.Du@amd.com>

Reviewed-by: Mario Limonciello (AMD) <superm1@kernel.org>

> ---
>   Documentation/admin-guide/media/amdisp4-1.rst | 66 +++++++++++++++++++
>   Documentation/admin-guide/media/amdisp4.dot   |  8 +++
>   .../admin-guide/media/v4l-drivers.rst         |  1 +
>   MAINTAINERS                                   |  2 +
>   4 files changed, 77 insertions(+)
>   create mode 100644 Documentation/admin-guide/media/amdisp4-1.rst
>   create mode 100644 Documentation/admin-guide/media/amdisp4.dot
> 
> diff --git a/Documentation/admin-guide/media/amdisp4-1.rst b/Documentation/admin-guide/media/amdisp4-1.rst
> new file mode 100644
> index 000000000000..a5ed78912d0f
> --- /dev/null
> +++ b/Documentation/admin-guide/media/amdisp4-1.rst
> @@ -0,0 +1,66 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: <isonum.txt>
> +
> +====================================
> +AMD Image Signal Processor (amdisp4)
> +====================================
> +
> +Introduction
> +============
> +
> +This file documents the driver for the AMD ISP4 that is part of
> +AMD Ryzen AI Max 385 SoC.

It's in 390 too isn't it?

Maybe it's better to say:
Ryzen AI Max 300 Series

That's what 
https://www.amd.com/en/products/processors/laptop/ryzen/ai-300-series/amd-ryzen-ai-max-plus-395.html 
uses after all.

> +
> +The driver is located under drivers/media/platform/amd/isp4 and uses
> +the Media-Controller API.
> +
> +Topology
> +========
> +
> +.. _amdisp4_topology_graph:
> +
> +.. kernel-figure:: amdisp4.dot
> +     :alt:   Diagram of the media pipeline topology
> +     :align: center
> +
> +
> +
> +The driver has 1 sub-device:
> +
> +- isp: used to resize and process bayer raw frames in to yuv.
> +
> +The driver has 1 video device:
> +
> +- capture video device: capture device for retrieving images.
> +
> +
> +  - ISP4 Image Signal Processing Subdevice Node
> +
> +-----------------------------------------------
> +
> +The isp4 is represented as a single V4L2 subdev, the sub-device does not
> +provide interface to the user space. The sub-device is connected to one video node
> +(isp4_capture) with immutable active link. The isp entity is connected
> +to sensor pad 0 and receives the frames using CSI-2 protocol. The sub-device is
> +also responsible to configure CSI2-2 receiver.
> +The sub-device processes bayer raw data from the connected sensor and output
> +them to different YUV formats. The isp also has scaling capabilities.
> +
> +  - isp4_capture - Frames Capture Video Node
> +
> +--------------------------------------------
> +
> +Isp4_capture is a capture device to capture frames to memory.
> +This entity is the DMA engine that write the frames to memory.
> +The entity is connected to isp4 sub-device.
> +
> +Capturing Video Frames Example
> +==============================
> +
> +.. code-block:: bash
> +
> +         # set the links
> +
> +         # start streaming:
> +         v4l2-ctl "-d" "/dev/video0" "--set-fmt-video=width=1920,height=1080,pixelformat=NV12" "--stream-mmap" "--stream-count=10"
> diff --git a/Documentation/admin-guide/media/amdisp4.dot b/Documentation/admin-guide/media/amdisp4.dot
> new file mode 100644
> index 000000000000..a4c2f0cceb30
> --- /dev/null
> +++ b/Documentation/admin-guide/media/amdisp4.dot
> @@ -0,0 +1,8 @@
> +digraph board {
> +	rankdir=TB
> +	n00000001 [label="{{<port0> 0} | amd isp4\n | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
> +	n00000001:port1 -> n00000004 [style=bold]
> +	n00000004 [label="Preview\n/dev/video0", shape=box, style=filled, fillcolor=yellow]
> +	n0000000a [label="{{} | ov05c10 22-0010\n/dev/v4l-subdev0 | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]
> +	n0000000a:port0 -> n00000001:port0 [style=bold]
> +}
> diff --git a/Documentation/admin-guide/media/v4l-drivers.rst b/Documentation/admin-guide/media/v4l-drivers.rst
> index 3bac5165b134..6027416e5373 100644
> --- a/Documentation/admin-guide/media/v4l-drivers.rst
> +++ b/Documentation/admin-guide/media/v4l-drivers.rst
> @@ -9,6 +9,7 @@ Video4Linux (V4L) driver-specific documentation
>   .. toctree::
>   	:maxdepth: 2
>   
> +	amdisp4-1
>   	bttv
>   	c3-isp
>   	cafe_ccic
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7724620896e7..72ef7c77d881 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1139,6 +1139,8 @@ M:	Nirujogi Pratap <pratap.nirujogi@amd.com>
>   L:	linux-media@vger.kernel.org
>   S:	Maintained
>   T:	git git://linuxtv.org/media.git
> +F:	Documentation/admin-guide/media/amdisp4-1.rst
> +F:	Documentation/admin-guide/media/amdisp4.dot
>   F:	drivers/media/platform/amd/Kconfig
>   F:	drivers/media/platform/amd/Makefile
>   F:	drivers/media/platform/amd/isp4/Kconfig


  reply	other threads:[~2025-08-28 16:50 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-28 10:08 [PATCH v3 1/7] media: platform: amd: Introduce amd isp4 capture driver Bin Du
2025-08-28 10:08 ` [PATCH v3 2/7] media: platform: amd: low level support for isp4 firmware Bin Du
2025-08-28 10:08 ` [PATCH v3 3/7] media: platform: amd: Add isp4 fw and hw interface Bin Du
2025-08-28 10:08 ` [PATCH v3 4/7] media: platform: amd: isp4 subdev and firmware loading handling added Bin Du
2025-09-02  7:48   ` Markus Elfring
2025-09-05  6:35     ` Du, Bin
2025-09-03 10:10   ` Laurent Pinchart
2025-08-28 10:08 ` [PATCH v3 5/7] media: platform: amd: isp4 video node and buffers " Bin Du
2025-09-02  8:10   ` Markus Elfring
2025-09-02  9:16     ` Du, Bin
2025-09-03 10:08   ` Laurent Pinchart
2025-09-05  7:05     ` Du, Bin
2025-08-28 10:08 ` [PATCH v3 6/7] media: platform: amd: isp4 debug fs logging and more descriptive errors Bin Du
2025-08-28 10:08 ` [PATCH v3 7/7] Documentation: add documentation of AMD isp 4 driver Bin Du
2025-08-28 16:50   ` Mario Limonciello [this message]
2025-09-02  3:04     ` Du, Bin
2025-09-03 10:04   ` Laurent Pinchart
2025-09-03 10:34     ` Du, Bin
2025-08-28 16:54 ` [PATCH v3 1/7] media: platform: amd: Introduce amd isp4 capture driver Mario Limonciello
2025-09-02  3:11   ` Du, Bin
2025-09-02  6:48 ` Sakari Ailus
2025-09-02  7:58   ` Sakari Ailus
2025-09-02  9:09     ` Du, Bin
2025-09-02  7:06 ` Markus Elfring
2025-09-02  9:05   ` Du, Bin
2025-09-02 12:49 ` Laurent Pinchart
2025-09-03  3:22   ` Du, Bin
2025-09-03  7:51     ` Laurent Pinchart
2025-09-03  8:20       ` Du, Bin
2025-09-10 17:17 ` Mario Limonciello
2025-09-11  2:19   ` Du, Bin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=906411e5-4354-4670-bd84-640a5b47a2bd@kernel.org \
    --to=superm1@kernel.org \
    --cc=Bin.Du@amd.com \
    --cc=Dominic.Antony@amd.com \
    --cc=Phil.Jawich@amd.com \
    --cc=Svetoslav.Stoilov@amd.com \
    --cc=anson.tsao@amd.com \
    --cc=benjamin.chan@amd.com \
    --cc=bryan.odonoghue@linaro.org \
    --cc=gjorgji.rosikopulos@amd.com \
    --cc=hverkuil@xs4all.nl \
    --cc=king.li@amd.com \
    --cc=laurent.pinchart+renesas@ideasonboard.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=prabhakar.mahadev-lad.rj@bp.renesas.com \
    --cc=pratap.nirujogi@amd.com \
    --cc=richard.gong@amd.com \
    --cc=sakari.ailus@linux.intel.com \
    --cc=sultan@kerneltoast.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®