devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Keke Li via B4 Relay <devnull+keke.li.amlogic.com@kernel.org>
To: Mauro Carvalho Chehab <mchehab@kernel.org>,
	 Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	 Conor Dooley <conor+dt@kernel.org>
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,
	 Keke Li <keke.li@amlogic.com>
Subject: [PATCH v3 8/9] Documentation: media: add documentation file metafmt-c3-isp.rst
Date: Wed, 18 Sep 2024 14:07:19 +0800	[thread overview]
Message-ID: <20240918-c3isp-v3-8-f774a39e6774@amlogic.com> (raw)
In-Reply-To: <20240918-c3isp-v3-0-f774a39e6774@amlogic.com>

From: Keke Li <keke.li@amlogic.com>

Add the file 'metafmt-c3-isp.rst' that documents
the meta format of c3-isp.

Signed-off-by: Keke Li <keke.li@amlogic.com>
---
 .../userspace-api/media/v4l/meta-formats.rst       |  1 +
 .../userspace-api/media/v4l/metafmt-c3-isp.rst     | 39 ++++++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/Documentation/userspace-api/media/v4l/meta-formats.rst b/Documentation/userspace-api/media/v4l/meta-formats.rst
index c6e56b5888bc..3a420747f6e7 100644
--- a/Documentation/userspace-api/media/v4l/meta-formats.rst
+++ b/Documentation/userspace-api/media/v4l/meta-formats.rst
@@ -12,6 +12,7 @@ These formats are used for the :ref:`metadata` interface only.
 .. toctree::
     :maxdepth: 1
 
+    metafmt-c3-isp
     metafmt-d4xx
     metafmt-generic
     metafmt-intel-ipu3
diff --git a/Documentation/userspace-api/media/v4l/metafmt-c3-isp.rst b/Documentation/userspace-api/media/v4l/metafmt-c3-isp.rst
new file mode 100644
index 000000000000..bbaf3542c1ca
--- /dev/null
+++ b/Documentation/userspace-api/media/v4l/metafmt-c3-isp.rst
@@ -0,0 +1,39 @@
+.. SPDX-License-Identifier: (GPL-2.0-only OR MIT)
+
+.. _v4l2-meta-fmt-c3isp-stats:
+.. _v4l2-meta-fmt-c3isp-params:
+
+***********************************************************************
+V4L2_META_FMT_C3ISP_STATS ('CSTS'), V4L2_META_FMT_C3ISP_PARAMS ('CPRM')
+***********************************************************************
+
+.. c3_isp_stats_info
+
+3A statistics
+=============
+
+The C3 ISP can collect different statistics over an input Bayer frame.
+Those statistics are obtained from the "isp-stats" metadata capture video nodes,
+using the :c:type:`v4l2_meta_format` interface.
+They are formatted as described by the :c:type:`c3_isp_stats_info` structure.
+
+The statistics collected are  Auto-white balance,
+Auto-exposure and Auto-focus information.
+
+.. c3_isp_params_buffer
+
+Pipeline parameters
+===================
+
+The pipeline parameters are passed to the "isp-params" metadata
+output video nodes, using the :c:type:`v4l2_meta_format` interface. They are
+formatted as described by the :c:type:`c3_isp_params_buffer` structure.
+
+The structure c3_isp_params_buffer includes the necessary parameters
+required by the ISP.
+These parameters are written to the ISP hardware.
+
+Amlogic C3 ISP uAPI data types
+===============================
+
+.. kernel-doc:: drivers/media/platform/amlogic/c3-isp/include/uapi/c3-isp-config.h

-- 
2.46.1



  parent reply	other threads:[~2024-09-18  6:07 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-18  6:07 [PATCH v3 0/9] Amlogic C3 ISP support Keke Li via B4 Relay
2024-09-18  6:07 ` [PATCH v3 1/9] dt-bindings: media: Add amlogic,c3-mipi-csi2.yaml Keke Li via B4 Relay
2024-09-18  6:07 ` [PATCH v3 2/9] media: platform: Add c3 mipi csi2 driver Keke Li via B4 Relay
2024-11-04 17:50   ` Jacopo Mondi
2024-11-05 10:06     ` Jacopo Mondi
2024-11-05 11:40       ` Keke Li
2024-11-05 11:21     ` Keke Li
2024-11-05 11:39       ` Jacopo Mondi
2024-11-05 11:58         ` Keke Li
2024-11-05 12:08         ` Tomi Valkeinen
2024-11-06  2:10           ` Keke Li
2024-11-05  8:21   ` Jacopo Mondi
2024-11-05 11:36     ` Keke Li
2024-09-18  6:07 ` [PATCH v3 3/9] dt-bindings: media: Add amlogic,c3-mipi-adapter.yaml Keke Li via B4 Relay
2024-09-18  6:07 ` [PATCH v3 4/9] media: platform: Add c3 mipi adapter driver Keke Li via B4 Relay
2024-11-05 11:24   ` Jacopo Mondi
2024-11-06  5:32     ` Keke Li
2024-11-07  8:48       ` Jacopo Mondi
2024-11-08  7:48         ` Keke Li
2024-09-18  6:07 ` [PATCH v3 5/9] dt-bindings: media: Add amlogic,c3-isp.yaml Keke Li via B4 Relay
2024-09-21  0:32   ` Rob Herring (Arm)
2024-09-18  6:07 ` [PATCH v3 6/9] media: Add C3ISP_PARAMS and C3ISP_STATS meta formats Keke Li via B4 Relay
2024-09-18  6:07 ` [PATCH v3 7/9] media: platform: Add c3 ISP driver Keke Li via B4 Relay
2024-11-07 16:03   ` Jacopo Mondi
2024-11-07 16:15     ` Jacopo Mondi
2024-11-08 12:38       ` Keke Li
2024-11-08 12:34     ` Keke Li
2024-11-08 14:04       ` Jacopo Mondi
2024-11-11  3:00         ` Keke Li
2024-11-11  7:50           ` Jacopo Mondi
2024-11-08 10:47   ` Dan Scally
2024-11-11  9:05     ` Keke Li
2024-11-12 11:41       ` Dan Scally
2024-09-18  6:07 ` Keke Li via B4 Relay [this message]
2024-11-07 10:38   ` [PATCH v3 8/9] Documentation: media: add documentation file metafmt-c3-isp.rst Jacopo Mondi
2024-09-18  6:07 ` [PATCH v3 9/9] Documentation: media: add documentation file c3-isp.rst Keke Li via B4 Relay
2024-11-07  9:07   ` Jacopo Mondi

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=20240918-c3isp-v3-8-f774a39e6774@amlogic.com \
    --to=devnull+keke.li.amlogic.com@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=dan.scally@ideasonboard.com \
    --cc=devicetree@vger.kernel.org \
    --cc=keke.li@amlogic.com \
    --cc=kieran.bingham@ideasonboard.com \
    --cc=krzk+dt@kernel.org \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=robh@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).