From patchwork Thu Sep 8 01:41:41 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 17322 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id F018DC327D for ; Thu, 8 Sep 2022 01:42:37 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id A28DD620CA; Thu, 8 Sep 2022 03:42:37 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1662601357; bh=N7T7B+FpWNY9q84INn+Mg4WQ1LCrieqE2TwIP0e0YQc=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=hOfQA0AVBA3R2NSpidgFdQpBNfg08oaYado5uSojQWPalqroBHs9+RCo2aoEIO5SC 7WD67hZRvTlO0IvLkz0FR/DWiuSFxje6wtJhN4ANUSQtjoYd1mXB+Az1bIgg/Rfbnx v4tttNj3adAqX/kga5tcebhmf2XEGozBLJk8biOwMRYIA0xjz+H28q7OPmidBCS2EB fG52Z9qbQ6+V0VHjQ0HNPIzEOUU0CFQplXaiGhBoA/zGkt7xJWX+bHKauBKbgD+Gfs fpiUFQHimxtR02VFvbIDOUokaLS2tvejPiL6G6HS51MEg9KzJK/Fi4lo7EghiLqSrA 0nbtG4r5bWl6g== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 0B957620B7 for ; Thu, 8 Sep 2022 03:42:36 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="OuX/9ier"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi [62.78.145.57]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 860038F1 for ; Thu, 8 Sep 2022 03:42:35 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1662601355; bh=N7T7B+FpWNY9q84INn+Mg4WQ1LCrieqE2TwIP0e0YQc=; h=From:To:Subject:Date:In-Reply-To:References:From; b=OuX/9ierMSzahFfAPEMEsDFgyl9iugvbHc3LgEEfsGVACZhfJPxEFI/ZUDpsOxZ3z Qn5g2wmtQs3oqeHSnffjfm2wyFmQb4JTfM4q3yVp53MxFmrPbEJsd+NpY5HR/MZRV2 3KQbea5o9KyVy8gsE6c3FxEulhqE16C1mJ/CxWTc= To: libcamera-devel@lists.libcamera.org Date: Thu, 8 Sep 2022 04:41:41 +0300 Message-Id: <20220908014200.28728-14-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220908014200.28728-1-laurent.pinchart@ideasonboard.com> References: <20220908014200.28728-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v4 13/32] ipa: rkisp1: Sort documentation of the IPA context X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The documentation of the IPA context structures is separate from the documentation of the structure members. Sort the documentation block to group members with their structure. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham Reviewed-by: Jacopo Mondi --- src/ipa/rkisp1/ipa_context.cpp | 62 +++++++++++++++++----------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/src/ipa/rkisp1/ipa_context.cpp b/src/ipa/rkisp1/ipa_context.cpp index f64af732260c..cc66bc70ac44 100644 --- a/src/ipa/rkisp1/ipa_context.cpp +++ b/src/ipa/rkisp1/ipa_context.cpp @@ -24,37 +24,6 @@ namespace libcamera::ipa::rkisp1 { * may also be updated in the start() operation. */ -/** - * \struct IPAFrameContext - * \brief Per-frame context for algorithms - * - * The frame context stores data specific to a single frame processed by the - * IPA. Each frame processed by the IPA has a context associated with it, - * accessible through the IPAContext structure. - * - * \todo Detail how to access contexts for a particular frame - * - * Each of the fields in the frame context belongs to either a specific - * algorithm, or to the top-level IPA module. A field may be read by any - * algorithm, but should only be written by its owner. - */ - -/** - * \struct IPAContext - * \brief Global IPA context data shared between all algorithms - * - * \var IPAContext::configuration - * \brief The IPA session configuration, immutable during the session - * - * \var IPAContext::frameContext - * \brief The frame context for the frame being processed - * - * \todo While the frame context is supposed to be per-frame, this - * single frame context stores data related to both the current frame - * and the previous frames, with fields being updated as the algorithms - * are run. This needs to be turned into real per-frame data storage. - */ - /** * \var IPASessionConfiguration::agc * \brief AGC parameters configuration of the IPA @@ -115,6 +84,21 @@ namespace libcamera::ipa::rkisp1 { * \brief Sensor output resolution */ +/** + * \struct IPAFrameContext + * \brief Per-frame context for algorithms + * + * The frame context stores data specific to a single frame processed by the + * IPA. Each frame processed by the IPA has a context associated with it, + * accessible through the IPAContext structure. + * + * \todo Detail how to access contexts for a particular frame + * + * Each of the fields in the frame context belongs to either a specific + * algorithm, or to the top-level IPA module. A field may be read by any + * algorithm, but should only be written by its owner. + */ + /** * \var IPAFrameContext::agc * \brief Context for the Automatic Gain Control algorithm @@ -216,4 +200,20 @@ namespace libcamera::ipa::rkisp1 { * Algorithm::prepare() function of all algorithms. */ +/** + * \struct IPAContext + * \brief Global IPA context data shared between all algorithms + * + * \var IPAContext::configuration + * \brief The IPA session configuration, immutable during the session + * + * \var IPAContext::frameContext + * \brief The frame context for the frame being processed + * + * \todo While the frame context is supposed to be per-frame, this + * single frame context stores data related to both the current frame + * and the previous frames, with fields being updated as the algorithms + * are run. This needs to be turned into real per-frame data storage. + */ + } /* namespace libcamera::ipa::rkisp1 */