From: Laurent Pinchart <laurent.pinchart@ideasonboard.com> To: Helen Koike <helen.koike@collabora.com> Cc: linux-rockchip@lists.infradead.org, devicetree@vger.kernel.org, eddie.cai.linux@gmail.com, mchehab@kernel.org, heiko@sntech.de, jacob2.chen@rock-chips.com, jeffy.chen@rock-chips.com, zyc@rock-chips.com, linux-kernel@vger.kernel.org, tfiga@chromium.org, hans.verkuil@cisco.com, sakari.ailus@linux.intel.com, kernel@collabora.com, ezequiel@collabora.com, linux-media@vger.kernel.org, linux-arm-kernel@lists.infradead.org, zhengsq@rock-chips.com, Jacob Chen <jacob-chen@rock-chips.com> Subject: Re: [PATCH v8 02/14] media: doc: add document for rkisp1 meta buffer format Date: Thu, 15 Aug 2019 16:51:43 +0300 [thread overview] Message-ID: <20190815135143.GU5011@pendragon.ideasonboard.com> (raw) In-Reply-To: <20190730184256.30338-3-helen.koike@collabora.com> Hi Helen, Thank you for the patch. On Tue, Jul 30, 2019 at 03:42:44PM -0300, Helen Koike wrote: > 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> > Acked-by: Hans Verkuil <hans.verkuil@cisco.com> > [update for upstream] > Signed-off-by: Helen Koike <helen.koike@collabora.com> > > --- > > 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.rst > > diff --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-stat > diff --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. I would say that "The buffer contains a single instance of the C structure :c:type:`rkisp1_isp_params_cfg`, defined in the ``linux/rkisp1-config.h`` header file." And add a sentence to explain what the alignment requirements are. > + > +The parameters consist of multiple modules. > +The module won't be updated if the corresponding bit was not set in module_*_update. Doesn't this belong to rkisp1-config.h ? I would group all the information related to fields of the structure in the header file, and only have here the information related to the buffer layout (this mainly referencing the structure and talking about alignment/padding). > + > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h > + :functions: rkisp1_isp_params_cfg > diff --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. Same comment here, I think we need to document alignment/padding constraints. > + > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h > + :functions: rkisp1_stat_buffer -- Regards, Laurent Pinchart
WARNING: multiple messages have this Message-ID (diff)
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com> To: Helen Koike <helen.koike@collabora.com> Cc: devicetree@vger.kernel.org, eddie.cai.linux@gmail.com, kernel@collabora.com, heiko@sntech.de, Jacob Chen <jacob-chen@rock-chips.com>, jacob2.chen@rock-chips.com, jeffy.chen@rock-chips.com, zyc@rock-chips.com, linux-kernel@vger.kernel.org, tfiga@chromium.org, linux-rockchip@lists.infradead.org, hans.verkuil@cisco.com, sakari.ailus@linux.intel.com, zhengsq@rock-chips.com, mchehab@kernel.org, ezequiel@collabora.com, linux-arm-kernel@lists.infradead.org, linux-media@vger.kernel.org Subject: Re: [PATCH v8 02/14] media: doc: add document for rkisp1 meta buffer format Date: Thu, 15 Aug 2019 16:51:43 +0300 [thread overview] Message-ID: <20190815135143.GU5011@pendragon.ideasonboard.com> (raw) In-Reply-To: <20190730184256.30338-3-helen.koike@collabora.com> Hi Helen, Thank you for the patch. On Tue, Jul 30, 2019 at 03:42:44PM -0300, Helen Koike wrote: > 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> > Acked-by: Hans Verkuil <hans.verkuil@cisco.com> > [update for upstream] > Signed-off-by: Helen Koike <helen.koike@collabora.com> > > --- > > 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.rst > > diff --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-stat > diff --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. I would say that "The buffer contains a single instance of the C structure :c:type:`rkisp1_isp_params_cfg`, defined in the ``linux/rkisp1-config.h`` header file." And add a sentence to explain what the alignment requirements are. > + > +The parameters consist of multiple modules. > +The module won't be updated if the corresponding bit was not set in module_*_update. Doesn't this belong to rkisp1-config.h ? I would group all the information related to fields of the structure in the header file, and only have here the information related to the buffer layout (this mainly referencing the structure and talking about alignment/padding). > + > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h > + :functions: rkisp1_isp_params_cfg > diff --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. Same comment here, I think we need to document alignment/padding constraints. > + > +.. kernel-doc:: include/uapi/linux/rkisp1-config.h > + :functions: rkisp1_stat_buffer -- Regards, Laurent Pinchart _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2019-08-15 13:51 UTC|newest] Thread overview: 173+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-07-30 18:42 [PATCH v8 00/14] Rockchip ISP1 Driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-07-30 18:42 ` [PATCH v8 01/14] media: videodev2.h, v4l2-ioctl: add rkisp1 meta buffer format Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-15 13:30 ` Laurent Pinchart 2019-08-15 13:30 ` Laurent Pinchart 2019-07-30 18:42 ` [PATCH v8 02/14] media: doc: add document for " Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-07 13:09 ` Sakari Ailus 2019-08-07 13:09 ` Sakari Ailus 2019-08-15 13:51 ` Laurent Pinchart [this message] 2019-08-15 13:51 ` Laurent Pinchart 2019-07-30 18:42 ` [PATCH v8 03/14] media: rkisp1: Add user space ABI definitions Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-15 18:46 ` Laurent Pinchart 2019-08-15 18:46 ` Laurent Pinchart 2020-07-10 12:59 ` Dafna Hirschfeld 2020-07-10 12:59 ` Dafna Hirschfeld 2020-07-10 12:59 ` Dafna Hirschfeld 2020-07-10 13:36 ` Laurent Pinchart 2020-07-10 13:36 ` Laurent Pinchart 2020-07-10 13:36 ` Laurent Pinchart 2020-07-10 14:30 ` Dafna Hirschfeld 2020-07-10 14:30 ` Dafna Hirschfeld 2019-07-30 18:42 ` [PATCH v8 04/14] media: rkisp1: add Rockchip MIPI Synopsys DPHY driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-07 13:05 ` Sakari Ailus 2019-08-07 13:05 ` Sakari Ailus 2019-08-07 13:37 ` Helen Koike 2019-08-07 13:37 ` Helen Koike 2019-08-15 17:54 ` Laurent Pinchart 2019-08-15 17:54 ` Laurent Pinchart 2019-08-15 18:26 ` Heiko Stübner 2019-08-15 18:26 ` Heiko Stübner 2019-08-21 21:46 ` Helen Koike 2019-08-21 21:46 ` Helen Koike 2019-08-22 2:32 ` Laurent Pinchart 2019-08-22 2:32 ` Laurent Pinchart 2019-08-22 2:32 ` Laurent Pinchart 2019-07-30 18:42 ` [PATCH v8 05/14] media: rkisp1: add Rockchip ISP1 subdev driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-06 18:51 ` Helen Koike 2019-08-06 18:51 ` Helen Koike 2019-08-07 10:39 ` Hans Verkuil 2019-08-07 10:39 ` Hans Verkuil 2019-08-15 19:35 ` Laurent Pinchart 2019-08-15 19:35 ` Laurent Pinchart 2020-03-25 6:34 ` Dafna Hirschfeld 2020-03-25 6:34 ` Dafna Hirschfeld 2020-03-25 7:11 ` Laurent Pinchart 2020-03-25 7:11 ` Laurent Pinchart 2020-03-25 8:51 ` Dafna Hirschfeld 2020-03-25 8:51 ` Dafna Hirschfeld 2020-03-25 9:11 ` Laurent Pinchart 2020-03-25 9:11 ` Laurent Pinchart 2019-08-08 9:14 ` Sakari Ailus 2019-08-08 9:14 ` Sakari Ailus 2019-08-15 0:58 ` Helen Koike 2019-08-15 0:58 ` Helen Koike 2019-08-15 0:58 ` Helen Koike 2019-08-15 8:24 ` Sakari Ailus 2019-08-15 8:24 ` Sakari Ailus 2019-08-15 10:29 ` Tomasz Figa 2019-08-15 10:29 ` Tomasz Figa 2019-08-15 10:29 ` Tomasz Figa 2019-08-15 10:45 ` Sakari Ailus 2019-08-15 10:45 ` Sakari Ailus 2019-08-15 10:45 ` Sakari Ailus 2019-08-15 13:17 ` Sakari Ailus 2019-08-15 13:17 ` Sakari Ailus 2020-01-31 19:38 ` Dafna Hirschfeld 2020-01-31 19:38 ` Dafna Hirschfeld 2020-02-12 21:13 ` Sakari Ailus 2020-02-12 21:13 ` Sakari Ailus 2020-02-13 12:50 ` Dafna Hirschfeld 2020-02-13 12:50 ` Dafna Hirschfeld 2019-08-16 0:13 ` Laurent Pinchart 2019-08-16 0:13 ` Laurent Pinchart 2020-07-11 11:04 ` Dafna Hirschfeld 2020-07-11 11:04 ` Dafna Hirschfeld 2020-07-17 7:46 ` Dafna Hirschfeld 2020-07-17 7:46 ` Dafna Hirschfeld 2020-07-22 16:01 ` Tomasz Figa 2020-07-22 16:01 ` Tomasz Figa 2020-07-22 15:24 ` Tomasz Figa 2020-07-22 15:24 ` Tomasz Figa 2020-07-22 15:24 ` Tomasz Figa 2020-07-22 16:30 ` Laurent Pinchart 2020-07-22 16:30 ` Laurent Pinchart 2020-07-22 16:30 ` Laurent Pinchart 2020-07-22 17:12 ` Tomasz Figa 2020-07-22 17:12 ` Tomasz Figa 2020-07-22 17:12 ` Tomasz Figa 2020-07-22 17:50 ` Laurent Pinchart 2020-07-22 17:50 ` Laurent Pinchart 2020-07-22 17:50 ` Laurent Pinchart 2020-08-05 21:10 ` Dafna Hirschfeld 2020-08-05 21:10 ` Dafna Hirschfeld 2020-08-06 9:21 ` Dafna Hirschfeld 2020-08-06 9:21 ` Dafna Hirschfeld 2020-08-06 12:22 ` Tomasz Figa 2020-08-06 12:22 ` Tomasz Figa 2020-08-06 12:22 ` Tomasz Figa 2020-08-07 16:08 ` Dafna Hirschfeld 2020-08-07 16:08 ` Dafna Hirschfeld 2020-08-07 16:08 ` Dafna Hirschfeld 2020-08-07 16:08 ` Dafna Hirschfeld 2020-08-13 6:17 ` Dafna Hirschfeld 2020-08-13 6:17 ` Dafna Hirschfeld 2020-08-13 6:17 ` Dafna Hirschfeld 2020-08-13 6:17 ` Dafna Hirschfeld 2020-08-06 12:08 ` Tomasz Figa 2020-08-06 12:08 ` Tomasz Figa 2020-08-06 12:08 ` Tomasz Figa 2020-08-07 16:02 ` Dafna Hirschfeld 2020-08-07 16:02 ` Dafna Hirschfeld 2020-08-07 16:02 ` Dafna Hirschfeld 2020-08-07 16:02 ` Dafna Hirschfeld 2019-07-30 18:42 ` [PATCH v8 06/14] media: rkisp1: add ISP1 statistics driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-08 9:37 ` Sakari Ailus 2019-08-08 9:37 ` Sakari Ailus 2019-07-30 18:42 ` [PATCH v8 07/14] media: rkisp1: add ISP1 params driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-07-30 18:42 ` [PATCH v8 08/14] media: rkisp1: add capture device driver Helen Koike 2019-07-30 18:42 ` [PATCH v8 09/14] media: rkisp1: add rockchip isp1 core driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-07 15:27 ` Sakari Ailus 2019-08-07 15:27 ` Sakari Ailus 2019-08-08 21:59 ` Helen Koike 2019-08-08 21:59 ` Helen Koike 2019-08-09 12:05 ` Sakari Ailus 2019-08-09 12:05 ` Sakari Ailus 2019-08-07 15:36 ` Sakari Ailus 2019-08-07 15:36 ` Sakari Ailus 2019-07-30 18:42 ` [PATCH v8 10/14] dt-bindings: Document the Rockchip ISP1 bindings Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-16 0:21 ` Laurent Pinchart 2019-08-16 0:21 ` Laurent Pinchart 2019-08-16 0:21 ` Laurent Pinchart 2019-07-30 18:42 ` [PATCH v8 11/14] dt-bindings: Document the Rockchip MIPI RX D-PHY bindings Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-15 18:14 ` Laurent Pinchart 2019-08-15 18:14 ` Laurent Pinchart 2019-07-30 18:42 ` [PATCH v8 12/14] arm64: dts: rockchip: add isp0 node for rk3399 Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-07-30 18:42 ` [PATCH v8 13/14] arm64: dts: rockchip: add rx0 mipi-phy " Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-07-30 18:42 ` [PATCH v8 14/14] MAINTAINERS: add entry for Rockchip ISP1 driver Helen Koike 2019-07-30 18:42 ` Helen Koike 2019-08-15 13:56 ` Laurent Pinchart 2019-08-15 13:56 ` Laurent Pinchart 2019-07-30 20:15 ` [PATCH v8 00/14] Rockchip ISP1 Driver Hans Verkuil 2019-07-30 20:15 ` Hans Verkuil 2019-07-30 20:50 ` Helen Koike 2019-07-30 20:50 ` Helen Koike 2019-07-31 0:08 ` Helen Koike 2019-07-31 0:08 ` Helen Koike 2019-07-31 4:29 ` Hans Verkuil 2019-07-31 4:29 ` Hans Verkuil 2019-07-31 4:33 ` Hans Verkuil 2019-07-31 4:33 ` Hans Verkuil 2019-07-31 4:55 ` Hans Verkuil 2019-07-31 4:55 ` Hans Verkuil 2019-07-31 4:55 ` Hans Verkuil 2019-07-31 14:42 ` Helen Koike 2019-07-31 14:42 ` Helen Koike 2019-08-07 15:37 ` Sakari Ailus 2019-08-07 15:37 ` Sakari Ailus 2019-08-07 17:57 ` Helen Koike 2019-08-07 17:57 ` Helen Koike 2019-08-09 18:45 ` Manivannan Sadhasivam 2019-08-09 18:45 ` Manivannan Sadhasivam
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=20190815135143.GU5011@pendragon.ideasonboard.com \ --to=laurent.pinchart@ideasonboard.com \ --cc=devicetree@vger.kernel.org \ --cc=eddie.cai.linux@gmail.com \ --cc=ezequiel@collabora.com \ --cc=hans.verkuil@cisco.com \ --cc=heiko@sntech.de \ --cc=helen.koike@collabora.com \ --cc=jacob-chen@rock-chips.com \ --cc=jacob2.chen@rock-chips.com \ --cc=jeffy.chen@rock-chips.com \ --cc=kernel@collabora.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=mchehab@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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.