Re: [PATCH v8 02/14] media: doc: add document for rkisp1 meta buffer format
From: Sakari Ailus <sakari.ailus@linux.intel.com>
Date: 2019-08-07 13:09:11
Also in:
linux-devicetree, linux-media, linux-rockchip, lkml
Hi Helen, On Tue, Jul 30, 2019 at 03:42:44PM -0300, Helen Koike wrote:
quoted hunk ↗ jump to hunk
From: Jacob Chen <redacted> This commit add document for rkisp1 meta buffer format Signed-off-by: Jacob Chen <redacted> Acked-by: Hans Verkuil <redacted> [update for upstream] Signed-off-by: Helen Koike <redacted> --- 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 Documentation/media/uapi/v4l/meta-formats.rst | 2 ++ .../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 +++++++++++++++++++ .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst create mode 100644 Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rstdiff --git a/Documentation/media/uapi/v4l/meta-formats.rst b/Documentation/media/uapi/v4l/meta-formats.rst index b10ca9ee3968..5de621fea3cc 100644 --- a/Documentation/media/uapi/v4l/meta-formats.rst +++ b/Documentation/media/uapi/v4l/meta-formats.rst@@ -24,3 +24,5 @@ These formats are used for the :ref:`metadata` interface only. pixfmt-meta-uvc pixfmt-meta-vsp1-hgo pixfmt-meta-vsp1-hgt + pixfmt-meta-rkisp1-params + pixfmt-meta-rkisp1-statdiff --git a/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst new file mode 100644 index 000000000000..103b5cb79b7c --- /dev/null +++ b/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.
Do you have an insight on in which order the device executes the processing steps for the image data? The pipeline may not be entirely linear either (statistics, for instance). This should be included in the documentation.
quoted hunk ↗ jump to hunk
+ +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_cfgdiff --git a/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst new file mode 100644 index 000000000000..4ad303f96421 --- /dev/null +++ b/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
-- Kind regards, Sakari Ailus sakari.ailus@linux.intel.com _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel