linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Helen Koike <helen.koike@collabora.com>
To: linux-rockchip@lists.infradead.org
Cc: mark.rutland@arm.com, devicetree@vger.kernel.org,
	eddie.cai.linux@gmail.com, mchehab@kernel.org, heiko@sntech.de,
	linux-arm-kernel@lists.infradead.org, gregkh@linuxfoundation.org,
	jeffy.chen@rock-chips.com, zyc@rock-chips.com,
	linux-kernel@vger.kernel.org, tfiga@chromium.org,
	robh+dt@kernel.org, hans.verkuil@cisco.com,
	laurent.pinchart@ideasonboard.com, sakari.ailus@linux.intel.com,
	kernel@collabora.com, ezequiel@collabora.com,
	linux-media@vger.kernel.org, jacob-chen@iotwrt.com,
	zhengsq@rock-chips.com, Jacob Chen <jacob2.chen@rock-chips.com>,
	Jacob Chen <jacob-chen@rock-chips.com>,
	Helen Koike <helen.koike@collabora.com>
Subject: [PATCH v11 02/11] media: staging: rkisp1: add document for rkisp1 meta buffer format
Date: Thu, 14 Nov 2019 02:12:33 -0300	[thread overview]
Message-ID: <20191114051242.14651-3-helen.koike@collabora.com> (raw)
In-Reply-To: <20191114051242.14651-1-helen.koike@collabora.com>

From: Jacob Chen <jacob2.chen@rock-chips.com>

This commit add document for rkisp1 meta buffer format

Signed-off-by: Jacob Chen <jacob-chen@rock-chips.com>
[refactored for upstream]
Signed-off-by: Helen Koike <helen.koike@collabora.com>

---

Changes in v11: None
Changes in v10:
- unsquash

Changes in v9:
- squash
- migrate to staging
- remove meta-formats.rst update

Changes in v8:
- Add SPDX in the header
- Remove emacs configs
- Fix doc style

Changes in v7:
- s/correspond/corresponding
- s/use/uses
- s/docuemnt/document

 .../uapi/v4l/pixfmt-meta-rkisp1-params.rst    | 23 +++++++++++++++++++
 .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst      | 22 ++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
 create mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst

diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
new file mode 100644
index 000000000000..103b5cb79b7c
--- /dev/null
+++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
@@ -0,0 +1,23 @@
+.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+
+.. _v4l2-meta-fmt-rkisp1-params:
+
+============================
+V4L2_META_FMT_RK_ISP1_PARAMS
+============================
+
+Rockchip ISP1 Parameters Data
+
+Description
+===========
+
+This format describes input parameters for the Rockchip ISP1.
+
+It uses c-struct :c:type:`rkisp1_isp_params_cfg`, which is defined in
+the ``linux/rkisp1-config.h`` header file.
+
+The parameters consist of multiple modules.
+The module won't be updated if the corresponding bit was not set in module_*_update.
+
+.. kernel-doc:: include/uapi/linux/rkisp1-config.h
+   :functions: rkisp1_isp_params_cfg
diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
new file mode 100644
index 000000000000..4ad303f96421
--- /dev/null
+++ b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
@@ -0,0 +1,22 @@
+.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+
+.. _v4l2-meta-fmt-rkisp1-stat:
+
+=============================
+V4L2_META_FMT_RK_ISP1_STAT_3A
+=============================
+
+
+Rockchip ISP1 Statistics Data
+
+Description
+===========
+
+This format describes image color statistics information generated by the Rockchip
+ISP1.
+
+It uses c-struct :c:type:`rkisp1_stat_buffer`, which is defined in
+the ``linux/rkisp1-config.h`` header file.
+
+.. kernel-doc:: include/uapi/linux/rkisp1-config.h
+   :functions: rkisp1_stat_buffer
-- 
2.22.0


  parent reply	other threads:[~2019-11-14  5:13 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-14  5:12 [PATCH v11 00/11] Rockchip ISP Driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 01/11] media: staging: phy-rockchip-dphy: add Rockchip MIPI Synopsys DPHY driver Helen Koike
2019-11-14  5:12 ` Helen Koike [this message]
2019-11-14  8:21   ` [PATCH v11 02/11] media: staging: rkisp1: add document for rkisp1 meta buffer format Hans Verkuil
2019-11-14  8:47     ` Tomasz Figa
2019-11-14 10:58     ` Helen Koike
2019-11-19 10:16       ` Jacob Chen
2019-11-19 12:55         ` Ezequiel Garcia
2019-11-19 13:03           ` Tomasz Figa
2019-11-14  5:12 ` [PATCH v11 03/11] media: staging: rkisp1: add user space ABI definitions Helen Koike
2019-11-14  5:12 ` [PATCH v11 04/11] media: staging: rkisp1: add Rockchip ISP1 subdev driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 05/11] media: staging: rkisp1: add ISP1 statistics driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 06/11] media: staging: rkisp1: add ISP1 params driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 07/11] media: staging: rkisp1: add capture device driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 08/11] media: staging: rkisp1: add rockchip isp1 core driver Helen Koike
2019-11-14  5:12 ` [PATCH v11 09/11] media: staging: dt-bindings: Document the Rockchip ISP1 bindings Helen Koike
2019-11-14  5:12 ` [PATCH v11 10/11] media: staging: dt-bindings: Document the Rockchip MIPI RX D-PHY bindings Helen Koike
2019-11-14  5:12 ` [PATCH v11 11/11] MAINTAINERS: add entry for Rockchip ISP1 driver Helen Koike
2019-11-14  5:17 ` [PATCH v11 00/11] Rockchip ISP Driver Greg KH
2019-11-14  7:22   ` Hans Verkuil
2019-11-14  8:42 ` Hans Verkuil
2019-11-18 18:52   ` Ezequiel Garcia
2019-11-19  8:30     ` Hans Verkuil

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=20191114051242.14651-3-helen.koike@collabora.com \
    --to=helen.koike@collabora.com \
    --cc=devicetree@vger.kernel.org \
    --cc=eddie.cai.linux@gmail.com \
    --cc=ezequiel@collabora.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hans.verkuil@cisco.com \
    --cc=heiko@sntech.de \
    --cc=jacob-chen@iotwrt.com \
    --cc=jacob-chen@rock-chips.com \
    --cc=jacob2.chen@rock-chips.com \
    --cc=jeffy.chen@rock-chips.com \
    --cc=kernel@collabora.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-rockchip@lists.infradead.org \
    --cc=mark.rutland@arm.com \
    --cc=mchehab@kernel.org \
    --cc=robh+dt@kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    --cc=tfiga@chromium.org \
    --cc=zhengsq@rock-chips.com \
    --cc=zyc@rock-chips.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;
as well as URLs for NNTP newsgroup(s).