From: Bin Du <Bin.Du@amd.com>
To: <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>
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>,
<Svetoslav.Stoilov@amd.com>, <bin.du@amd.com>,
"Bin Du" <Bin.Du@amd.com>
Subject: [PATCH v1 8/9] Documentation: add documentation of AMD isp 4 driver
Date: Sun, 8 Jun 2025 22:49:15 +0800 [thread overview]
Message-ID: <20250608144916.222835-9-Bin.Du@amd.com> (raw)
In-Reply-To: <20250608144916.222835-1-Bin.Du@amd.com>
Add documentation for AMD isp 4 and describe the main components
Signed-off-by: Bin Du <Bin.Du@amd.com>
Signed-off-by: Svetoslav Stoilov <Svetoslav.Stoilov@amd.com>
Change-Id: I61dfb3a39e5ae372ed48f156a81ae81ee17734b2
---
Documentation/admin-guide/media/amdisp4-1.rst | 60 +++++++++++++++++++
Documentation/admin-guide/media/amdisp4.dot | 8 +++
2 files changed, 68 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..c933e7ae171d
--- /dev/null
+++ b/Documentation/admin-guide/media/amdisp4-1.rst
@@ -0,0 +1,60 @@
+.. 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.
+
+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]
+}
--
2.34.1
next prev parent reply other threads:[~2025-06-08 14:50 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-08 14:49 [PATCH v1 0/9] Add AMD ISP4 driver Bin Du
2025-06-08 14:49 ` [PATCH v1 1/9] media: platform: amd: Introduce amd isp4 capture driver Bin Du
2025-06-13 2:39 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 2/9] media: platform: amd: low level support for isp4 firmware Bin Du
2025-06-13 2:40 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 3/9] media: platform: amd: Add helpers to configure isp4 mipi phy Bin Du
2025-06-13 2:40 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 4/9] media: platform: amd: Add isp4 fw and hw interface Bin Du
2025-06-13 2:41 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 5/9] media: platform: amd: isp4 subdev and firmware loading handling added Bin Du
2025-06-13 2:42 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 6/9] media: platform: amd: isp4 video node and buffers " Bin Du
2025-06-13 2:42 ` Du, Bin
2025-06-08 14:49 ` [PATCH v1 7/9] media: platform: amd: isp4 debug fs logging and more descriptive errors Bin Du
2025-06-13 2:43 ` Du, Bin
2025-06-08 14:49 ` Bin Du [this message]
2025-06-13 2:43 ` [PATCH v1 8/9] Documentation: add documentation of AMD isp 4 driver Du, Bin
2025-06-08 14:49 ` [PATCH v1 9/9] MAINTAINERS: add entry for " Bin Du
2025-06-13 2:46 ` 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=20250608144916.222835-9-Bin.Du@amd.com \
--to=bin.du@amd.com \
--cc=Dominic.Antony@amd.com \
--cc=Phil.Jawich@amd.com \
--cc=Svetoslav.Stoilov@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=sakari.ailus@linux.intel.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®