Skip to content

Commit e7177ad

Browse files
Bin Du1Naim
authored andcommitted
Documentation: add documentation of AMD isp 4 driver
Add documentation for AMD ISP 4 and describe the main components 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> Reviewed-by: Sultan Alsawaf <sultan@kerneltoast.com> Tested-by: Alexey Zagorodnikov <xglooom@gmail.com> Tested-by: Kate Hsuan <hpa@redhat.com>
1 parent 03c349c commit e7177ad

4 files changed

Lines changed: 72 additions & 0 deletions

File tree

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
.. include:: <isonum.txt>
4+
5+
====================================
6+
AMD Image Signal Processor (amdisp4)
7+
====================================
8+
9+
Introduction
10+
============
11+
12+
This file documents the driver for the AMD ISP4 that is part of
13+
AMD Ryzen AI Max 300 Series.
14+
15+
The driver is located under drivers/media/platform/amd/isp4 and uses
16+
the Media-Controller API.
17+
18+
The driver exposes one video capture device to userspace and provide
19+
web camera like interface. Internally the video device is connected
20+
to the isp4 sub-device responsible for communication with the CCPU FW.
21+
22+
Topology
23+
========
24+
25+
.. _amdisp4_topology_graph:
26+
27+
.. kernel-figure:: amdisp4.dot
28+
:alt: Diagram of the media pipeline topology
29+
:align: center
30+
31+
32+
33+
The driver has 1 sub-device: Representing isp4 image signal processor.
34+
The driver has 1 video device: Capture device for retrieving images.
35+
36+
- ISP4 Image Signal Processing Subdevice Node
37+
38+
---------------------------------------------
39+
40+
The isp4 is represented as a single V4L2 subdev, the sub-device does not
41+
provide interface to the user space. The sub-device is connected to one video node
42+
(isp4_capture) with immutable active link. The sub-device represents ISP with
43+
connected sensor similar to smart cameras (sensors with integrated ISP).
44+
sub-device has only one link to the video device for capturing the frames.
45+
The sub-device communicates with CCPU FW for streaming configuration and
46+
buffer management.
47+
48+
49+
- isp4_capture - Frames Capture Video Node
50+
51+
------------------------------------------
52+
53+
Isp4_capture is a capture device to capture frames to memory.
54+
The entity is connected to isp4 sub-device. The video device
55+
provides web camera like interface to userspace. It supports
56+
mmap and dma buf types of memory.
57+
58+
Capturing Video Frames Example
59+
==============================
60+
61+
.. code-block:: bash
62+
63+
v4l2-ctl "-d" "/dev/video0" "--set-fmt-video=width=1920,height=1080,pixelformat=NV12" "--stream-mmap" "--stream-count=10"
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
digraph board {
2+
rankdir=TB
3+
n00000001 [label="{{} | amd isp4\n | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]
4+
n00000001:port0 -> n00000003 [style=bold]
5+
n00000003 [label="Preview\n/dev/video0", shape=box, style=filled, fillcolor=yellow]
6+
}

Documentation/admin-guide/media/v4l-drivers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Video4Linux (V4L) driver-specific documentation
99
.. toctree::
1010
:maxdepth: 2
1111

12+
amdisp4-1
1213
bttv
1314
c3-isp
1415
cafe_ccic

MAINTAINERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1168,6 +1168,8 @@ M: Nirujogi Pratap <pratap.nirujogi@amd.com>
11681168
L: linux-media@vger.kernel.org
11691169
S: Maintained
11701170
T: git git://linuxtv.org/media.git
1171+
F: Documentation/admin-guide/media/amdisp4-1.rst
1172+
F: Documentation/admin-guide/media/amdisp4.dot
11711173
F: drivers/media/platform/amd/Kconfig
11721174
F: drivers/media/platform/amd/Makefile
11731175
F: drivers/media/platform/amd/isp4/Kconfig

0 commit comments

Comments
 (0)