From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.3 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A0DB0C3A589 for ; Thu, 15 Aug 2019 13:52:01 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 71BBD206C1 for ; Thu, 15 Aug 2019 13:52:01 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="nRZnTYaT"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="fvrGFVka" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 71BBD206C1 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=ideasonboard.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=aocRRZZxZtzOFGmX+cjtfTAt2YO8zDuGJy0xtAqIFnY=; b=nRZnTYaTQok3Cu fm6h6Lmac9i0a0qiOVQSCYDHGYE0J8xy7HE8UXNmbTa2eay6KpREleBrfNsgA3YjLUFWc57v1kdJC PcI0VYKxiLg1CIxSovRtd/Z8+I34FTd03cd727wZjV4pkIWMD73H3ICrQsxcndP6sPKynkGy/Ev1U 3jkGzgqrkiIvhm2KluLDcTm1kgjgmYHAP5GQzWulj/3TMYs/5zTNOvs/+iluT8ttKQ1rJ9h+Q/dEV pzdPtYrDfMREDt/pb5oVoPZla9ysIAvSaHsqeOOgfxh25m8FLXkSIueCEFEvA/S5VvuMvTLg3QInv dAaO9jafYcCA0gkIrhgg==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92 #3 (Red Hat Linux)) id 1hyGAT-00062Q-K2; Thu, 15 Aug 2019 13:51:53 +0000 Received: from perceval.ideasonboard.com ([2001:4b98:dc2:55:216:3eff:fef7:d647]) by bombadil.infradead.org with esmtps (Exim 4.92 #3 (Red Hat Linux)) id 1hyGAO-00061Y-9Y; Thu, 15 Aug 2019 13:51:51 +0000 Received: from pendragon.ideasonboard.com (dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 5E6122AF; Thu, 15 Aug 2019 15:51:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1565877106; bh=eQaxJ9fWzARXPrOco46drXtMqHl8iBVISexpgwltDec=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=fvrGFVkaMHxE7ZCJ6VmVuUBnwX+lY5NX8E3uYdQdN5um35yc0ZREjQtNfQOEUAl69 LsG3gXVAYtPbsxxTiaxIejTqesO+6fNhlsdlUvwaDnGNfUmP3zfFIsggKWEkrWEuwD hJp9t7xVupEFs5CVqLfePFRxogg15dsszGdhbves= Date: Thu, 15 Aug 2019 16:51:43 +0300 From: Laurent Pinchart To: Helen Koike Subject: Re: [PATCH v8 02/14] media: doc: add document for rkisp1 meta buffer format Message-ID: <20190815135143.GU5011@pendragon.ideasonboard.com> References: <20190730184256.30338-1-helen.koike@collabora.com> <20190730184256.30338-3-helen.koike@collabora.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20190730184256.30338-3-helen.koike@collabora.com> User-Agent: Mutt/1.10.1 (2018-07-13) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190815_065148_627997_40C2C5BD X-CRM114-Status: GOOD ( 15.05 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: devicetree@vger.kernel.org, eddie.cai.linux@gmail.com, kernel@collabora.com, heiko@sntech.de, Jacob Chen , 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 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org Hi Helen, Thank you for the patch. On Tue, Jul 30, 2019 at 03:42:44PM -0300, Helen Koike wrote: > From: Jacob Chen > > This commit add document for rkisp1 meta buffer format > > Signed-off-by: Jacob Chen > Acked-by: Hans Verkuil > [update for upstream] > Signed-off-by: Helen Koike > > --- > > 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