From patchwork Thu Feb 27 07:27:21 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Keke Li via B4 Relay X-Patchwork-Id: 870381 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A5BB32236F7; Thu, 27 Feb 2025 07:27:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740641238; cv=none; b=HBPB+MwUivyvgTBzK4KNK2KQxf6ZBAftdN8M5K+5at1AuKfvg2HRK6Diws21dSzrMfbnoNuLeK9WLqQf9NwCZYO/vSZbdjLqWu4FhsgOfvTxS01lF5lzpY88HmXs3DTUG2ehdRdGKPj7heIS6Zbrx7Wi4PKnWVsEAzRLG3icubc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740641238; c=relaxed/simple; bh=d32okfY48AdP5onR7d4GoJDusegmSjxz19/DzrOVxCw=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=MvJScmj9iO4boEKQTsK1dkrLIcrLNat+ROhEuI/vw1ETXWf++0y/uyYYpE1jA9i+y6JYm01B2gadeY+Xxsodnwq5KzEzWEBDN80Xsji+6BH+CwHgGHWS9tLiCxL8k/MxDXr0BlQ5BOIF5h3tw8Tl2vsCMFaqjJC+IKqvqQfppHQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=ji+Ssq5R; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="ji+Ssq5R" Received: by smtp.kernel.org (Postfix) with ESMTPS id 69E31C4CEFD; Thu, 27 Feb 2025 07:27:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1740641238; bh=d32okfY48AdP5onR7d4GoJDusegmSjxz19/DzrOVxCw=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=ji+Ssq5RG1sI+xITly+YirCC/yFW2M/5sHdYbOLJWUVLmk0IUFAuCgctFJAcnUjiV 04EowNoinWTt+r9bzTKW8DZWiV7DajRLTfQiu+nP/1yjrwPpUblGsPCqQ4Z/jEZTJg 09N1vjjDLE/irU+rv/HToYsqDhzjsWNsYGE0q4yVGMStH+f5BBi+KoIF6bV2TodEBW /ftxUnGfGXtFjB/xTItr996uvagwbtg5+74g8t5fFRSgiOcvlEkPlW8jCpCo0ouPkj FPwviVeuW7gGvv8ZNtFkPRS3KUx7efAstIKzjkq0AzUWzKimB9T0T8nLZpxrNgKh7o 7GKiVQg+HkrCA== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5F8BAC1B0FF; Thu, 27 Feb 2025 07:27:18 +0000 (UTC) From: Keke Li via B4 Relay Date: Thu, 27 Feb 2025 15:27:21 +0800 Subject: [PATCH v6 10/10] Documentation: media: add documentation file c3-isp.rst Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20250227-c3isp-v6-10-f72e19084d0d@amlogic.com> References: <20250227-c3isp-v6-0-f72e19084d0d@amlogic.com> In-Reply-To: <20250227-c3isp-v6-0-f72e19084d0d@amlogic.com> To: Mauro Carvalho Chehab , Rob Herring , Krzysztof Kozlowski , Conor Dooley Cc: linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, kieran.bingham@ideasonboard.com, laurent.pinchart@ideasonboard.com, dan.scally@ideasonboard.com, jacopo.mondi@ideasonboard.com, Keke Li X-Mailer: b4 0.14.1 X-Developer-Signature: v=1; a=ed25519-sha256; t=1740641235; l=8134; i=keke.li@amlogic.com; s=20240902; h=from:subject:message-id; bh=TjlqiBcQ0rs6eWQ9C0wNEtdDuotwwwwL0LT9Qczu0Yg=; b=hhqnSGAWvWp4O4AiVdKCE7AY5cKTTVs/ZO572LL8JxgI8wNCr4TCZIIKpX+XHau9nEcZFEKqu Pxy+RzpIEESA8vU/sKXdy5VftRu20PTjzS6FXlkLFX6S826U6IjApSJ X-Developer-Key: i=keke.li@amlogic.com; a=ed25519; pk=XxNPTsQ0YqMJLLekV456eoKV5gbSlxnViB1k1DhfRmU= X-Endpoint-Received: by B4 Relay for keke.li@amlogic.com/20240902 with auth_id=204 X-Original-From: Keke Li Reply-To: keke.li@amlogic.com From: Keke Li Add the file 'c3-isp.rst' that documents the c3-isp driver. Signed-off-by: Keke Li --- Documentation/admin-guide/media/c3-isp.dot | 26 ++++++ Documentation/admin-guide/media/c3-isp.rst | 109 ++++++++++++++++++++++++ Documentation/admin-guide/media/v4l-drivers.rst | 1 + MAINTAINERS | 2 + 4 files changed, 138 insertions(+) diff --git a/Documentation/admin-guide/media/c3-isp.dot b/Documentation/admin-guide/media/c3-isp.dot new file mode 100644 index 000000000000..42dc931ee84a --- /dev/null +++ b/Documentation/admin-guide/media/c3-isp.dot @@ -0,0 +1,26 @@ +digraph board { + rankdir=TB + n00000001 [label="{{ 0 | 1} | c3-isp-core\n/dev/v4l-subdev0 | { 2 | 3 | 4 | 5}}", shape=Mrecord, style=filled, fillcolor=green] + n00000001:port3 -> n00000008:port0 + n00000001:port4 -> n0000000b:port0 + n00000001:port5 -> n0000000e:port0 + n00000001:port2 -> n00000027 + n00000008 [label="{{ 0} | c3-isp-resizer0\n/dev/v4l-subdev1 | { 1}}", shape=Mrecord, style=filled, fillcolor=green] + n00000008:port1 -> n00000016 [style=bold] + n0000000b [label="{{ 0} | c3-isp-resizer1\n/dev/v4l-subdev2 | { 1}}", shape=Mrecord, style=filled, fillcolor=green] + n0000000b:port1 -> n0000001a [style=bold] + n0000000e [label="{{ 0} | c3-isp-resizer2\n/dev/v4l-subdev3 | { 1}}", shape=Mrecord, style=filled, fillcolor=green] + n0000000e:port1 -> n00000023 [style=bold] + n00000011 [label="{{ 0} | c3-mipi-adapter\n/dev/v4l-subdev4 | { 1}}", shape=Mrecord, style=filled, fillcolor=green] + n00000011:port1 -> n00000001:port0 [style=bold] + n00000016 [label="c3-isp-cap0\n/dev/video0", shape=box, style=filled, fillcolor=yellow] + n0000001a [label="c3-isp-cap1\n/dev/video1", shape=box, style=filled, fillcolor=yellow] + n0000001e [label="{{ 0} | c3-mipi-csi2\n/dev/v4l-subdev5 | { 1}}", shape=Mrecord, style=filled, fillcolor=green] + n0000001e:port1 -> n00000011:port0 [style=bold] + n00000023 [label="c3-isp-cap2\n/dev/video2", shape=box, style=filled, fillcolor=yellow] + n00000027 [label="c3-isp-stats\n/dev/video3", shape=box, style=filled, fillcolor=yellow] + n0000002b [label="c3-isp-params\n/dev/video4", shape=box, style=filled, fillcolor=yellow] + n0000002b -> n00000001:port1 + n0000003f [label="{{} | imx290 2-001a\n/dev/v4l-subdev6 | { 0}}", shape=Mrecord, style=filled, fillcolor=green] + n0000003f:port0 -> n0000001e:port0 [style=bold] +} diff --git a/Documentation/admin-guide/media/c3-isp.rst b/Documentation/admin-guide/media/c3-isp.rst new file mode 100644 index 000000000000..8adac4605a6a --- /dev/null +++ b/Documentation/admin-guide/media/c3-isp.rst @@ -0,0 +1,109 @@ +.. SPDX-License-Identifier: (GPL-2.0-only OR MIT) + +.. include:: + +================================================= +Amlogic C3 Image Signal Processing (C3ISP) driver +================================================= + +Introduction +============ + +This file documents the Amlogic C3ISP driver located under +drivers/media/platform/amlogic/c3/isp. + +The current version of the driver supports the C3ISP found on +Amlogic C308L processor. + +The driver implements V4L2, Media controller and V4L2 subdev interfaces. +Camera sensor using V4L2 subdev interface in the kernel is supported. + +The driver has been tested on AW419-C308L-Socket platform. + +Anlogic Camera hardware +======================= + +The Camera hardware found on C308L processors and supported by +the driver consists of: + +- 1 MIPI-CSI2 module. It handle the Physical layer of the CSI2 receivers and + receive MIPI data. + A separate camera sensor can be connected to MIPI-CSi2 module. +- 1 MIPI-ADAPTER module. Organize MIPI data to meet ISP input requirements and + send MIPI data to ISP +- 1 ISP (Image Signal Processing) module. Contain a pipeline of image processing + hardware blocks. + The ISP pipeline contains three scalers at the end. + The ISP also contains the DMA interface which writes the output data to memory. + +A high level functional view of the C3 ISP is presented below. The ISP +takes input from the sensor.:: + + +---------+ +-------+ + | Scaler |--->| WRMIF | + +---------+ +------------+ +--------------+ +-------+ |---------+ +-------+ + | Sensor |--->| MIPI CSI-2 |--->| MIPI ADAPTER |--->| ISP |---|---------+ +-------+ + +---------+ +------------+ +--------------+ +-------+ | Scaler |--->| WRMIF | + +---------+ +-------+ + |---------+ +-------+ + | Scaler |--->| WRMIF | + +---------+ +-------+ + +Supported functionality +======================= + +The current version of the driver supports: + +- Input from camera sensor via MIPI-CSI2; + +- Pixel output interface of ISP + + - Scaling support. Configuration of the scaler module + for downscalling with ratio up to 8x. + +Driver Architecture and Design +============================== + +The driver implements the V4L2 subdev interface. With the goal to model the +hardware links between the modules and to expose a clean, logical and usable +interface, the driver is split into V4L2 sub-devices as follows: + +- 1 c3-mipi-csi2 sub-device - mipi-csi2 is represented by a single sub-device. +- 1 c3-mipi-adapter sub-device - mipi-adapter is represented by a single sub-devices. +- 1 c3-isp-core sub-device - isp-core is represented by a single sub-devices. +- 3 c3-isp-resizer sub-devices - isp-resizer is represented by a number of sub-devices + equal to the number of capture device. + +c3-isp-core sub-device is linked to 2 separate video device nodes and +3 c3-isp-resizer sub-devices nodes. + +- 1 capture statistics video device node. +- 1 output parameters video device node. +- 3 c3-isp-resizer sub-device nodes. + +c3-isp-resizer sub-device is linked to capture video device node. + +- c3-isp-resizer0 is linked to c3-isp-cap0 +- c3-isp-resizer1 is linked to c3-isp-cap1 +- c3-isp-resizer2 is linked to c3-isp-cap2 + +The media controller pipeline graph is as follows (with connected a +IMX290 camera sensor): + +.. _isp_topology_graph: + +.. kernel-figure:: c3-isp.dot + :alt: c3-isp.dot + :align: center + + Media pipeline topology + +Implementation +============== + +Runtime configuration of the hardware via 'c3-isp-params' video device node. +Acquiring statistics of ISP hardware via 'c3-isp-stats' video device node. +Acquiring output image of ISP hardware via 'c3-isp-cap[0, 2]' video device node. + +The output size of the scaler module in the ISP is configured with +the pixel format of 'c3-isp-cap[0, 2]' video device node. diff --git a/Documentation/admin-guide/media/v4l-drivers.rst b/Documentation/admin-guide/media/v4l-drivers.rst index e8761561b2fe..3bac5165b134 100644 --- a/Documentation/admin-guide/media/v4l-drivers.rst +++ b/Documentation/admin-guide/media/v4l-drivers.rst @@ -10,6 +10,7 @@ Video4Linux (V4L) driver-specific documentation :maxdepth: 2 bttv + c3-isp cafe_ccic cx88 fimc diff --git a/MAINTAINERS b/MAINTAINERS index b277304ff3e8..35af62270fcb 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1256,6 +1256,8 @@ AMLOGIC ISP DRIVER M: Keke Li L: linux-media@vger.kernel.org S: Maintained +F: Documentation/admin-guide/media/c3-isp.dot +F: Documentation/admin-guide/media/c3-isp.rst F: Documentation/devicetree/bindings/media/amlogic,c3-isp.yaml F: Documentation/userspace-api/media/v4l/metafmt-c3-isp.rst F: drivers/media/platform/amlogic/c3/isp/