From patchwork Tue Apr 13 12:25:32 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 11909 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 35A17BD224 for ; Tue, 13 Apr 2021 12:25:43 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id E5E1E68800; Tue, 13 Apr 2021 14:25:42 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="dwoioEfL"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 97D0E687EC for ; Tue, 13 Apr 2021 14:25:40 +0200 (CEST) Received: from Q.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id C50F18AF; Tue, 13 Apr 2021 14:25:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1618316739; bh=L42dyyRK+Oit+tEx0yz6PHx9kue8aWuC+IXDn8z+Gck=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=dwoioEfLA2eKNnRlD9GU2riBUoz7Fm3DcUdVTeoZ9jQqdRc5UPI6eUSaxqaDkm7f9 ezRNljtRK7gf1LeW0nxTVfaCkTvpyxdAtRhQF4mGJ3ROte1D/mZaqfO2ZKQiVMGvKg UUWqZT4qJNn/dApWjaE64ok5diL+6QceAOt1T/r4= From: Kieran Bingham To: libcamera devel Date: Tue, 13 Apr 2021 13:25:32 +0100 Message-Id: <20210413122534.342138-2-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> References: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/3] libcamera: ipa_proxy: Scope ProxyState to IPAProxy 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The ProxyState is only used by the IPAProxy, so it should remain inside that scope. This helps clarify the usage, and improves the documentation by bringing the (future) ProxyState documentation into the class. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart --- include/libcamera/internal/ipa_proxy.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/libcamera/internal/ipa_proxy.h b/include/libcamera/internal/ipa_proxy.h index 9fe446c35f04..ea9f0760c2fc 100644 --- a/include/libcamera/internal/ipa_proxy.h +++ b/include/libcamera/internal/ipa_proxy.h @@ -17,15 +17,15 @@ namespace libcamera { class IPAModule; -enum ProxyState { - ProxyStopped, - ProxyStopping, - ProxyRunning, -}; - class IPAProxy : public IPAInterface { public: + enum ProxyState { + ProxyStopped, + ProxyStopping, + ProxyRunning, + }; + IPAProxy(IPAModule *ipam); ~IPAProxy(); From patchwork Tue Apr 13 12:25:33 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 11910 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 F10DFBD224 for ; Tue, 13 Apr 2021 12:25:43 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 4EC9E68809; Tue, 13 Apr 2021 14:25:43 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="u1CfCLpi"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id B04A8602C8 for ; Tue, 13 Apr 2021 14:25:40 +0200 (CEST) Received: from Q.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 19EF48B7; Tue, 13 Apr 2021 14:25:40 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1618316740; bh=qRqKTOOsGqO6Rhh9hiiWPjP4aZcyCV3wZoyFttQk06I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=u1CfCLpi1e6cgQuD32zZh2wV+tWf70T9oGqg8RWGpW9vlF4CmnxWXJ644ix5+Au7T 9HVxOFuib0BaddCgtozO4cpxfObTujip3QK7fjp3cwxOccujH+3Bqy7YeBFYhgihlJ KaGxbTikC7+mZ/WQwLYYAtS8xQBXNjkpu33X50fY= From: Kieran Bingham To: libcamera devel Date: Tue, 13 Apr 2021 13:25:33 +0100 Message-Id: <20210413122534.342138-3-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> References: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 2/3] libcamera: ipa_proxy: Document ProxyState 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The documentation for the ProxyState and tracking variable was not added when the IPA was extended with a state machine. Add it. Fixes: 70238ceca5b2 ("utils: ipc: proxy: Track IPA with a state machine") Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart --- src/libcamera/ipa_proxy.cpp | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/src/libcamera/ipa_proxy.cpp b/src/libcamera/ipa_proxy.cpp index ec4c2cc823c2..8608b0c92a87 100644 --- a/src/libcamera/ipa_proxy.cpp +++ b/src/libcamera/ipa_proxy.cpp @@ -32,6 +32,18 @@ LOG_DEFINE_CATEGORY(IPAProxy) * Isolate IPA into separate process. */ +/** + * \enum IPAProxy::ProxyState + * \brief Identifies the available operational states of the proxy + * + * \var IPAProxy::ProxyStopped + * \brief The proxy is not active and only synchronous operations are permitted + * \var IPAProxy::ProxyStopping + * \brief No new tasks can be submitted to the proxy, however existing events can be completed + * \var IPAProxy::ProxyRunning + * \brief The Proxy is active and asynchronous tasks may be queued + */ + /** * \brief Construct an IPAProxy instance * \param[in] ipam The IPA module @@ -213,4 +225,15 @@ std::string IPAProxy::resolvePath(const std::string &file) const * construction. */ +/** + * \var IPAProxy::state_ + * \brief Current state of the IPAProxy + * + * The IPAProxy can be Running, Stopped, or Stopping. + * + * This state provides a means to ensure that asynchronous methods are only + * called while the proxy is running, and prevent new tasks being submitted + * while still enabling events to complete when the IPAProxy is stopping. + */ + } /* namespace libcamera */ From patchwork Tue Apr 13 12:25:34 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 11911 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 5324CBD22F for ; Tue, 13 Apr 2021 12:25:44 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 985D36880E; Tue, 13 Apr 2021 14:25:43 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="NqeDbmJY"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id D36F8687D6 for ; Tue, 13 Apr 2021 14:25:40 +0200 (CEST) Received: from Q.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 676FF9F0; Tue, 13 Apr 2021 14:25:40 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1618316740; bh=SQXje+uGcTZktIAkTw5dMOiePQn76CiXjxmuBq61LVQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=NqeDbmJYcdeaJKXMY9PJPb9dMuF88+FsHTswI6sP4BId6zovyh6tCf5dkhD0QASuu YR4fl5KLG6U0mLa8bAggFK2OEYFGbL1KSGSg+BjgOklIeHPKAMxDexFOfB7C+jNP2j xTyyRPG85wsDtDRH8xMdN1V6HRcPOCVcI4pkI9mU= From: Kieran Bingham To: libcamera devel Date: Tue, 13 Apr 2021 13:25:34 +0100 Message-Id: <20210413122534.342138-4-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> References: <20210413122534.342138-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 3/3] libcamera: pipeline_handler: Document requestSequence_ 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The documentation for requestSequence_ was not added when the sequence number was implemented. Provide it. Fixes: d874b3e34173 ("libcamera: request: Provide a sequence number") Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart --- src/libcamera/pipeline_handler.cpp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 433c05f60db0..43395b57d818 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -97,6 +97,17 @@ LOG_DEFINE_CATEGORY(Pipeline) * when creating the camera, and shall not be modified afterwards. */ +/** + * \var CameraData::requestSequence_ + * \brief The queuing sequence of the request + * + * When requests are queued, they are given a per-camera sequence number to + * facilitate debugging of internal request usage. + * + * The requestSequence_ tracks the number of requests queued to a camera + * over its lifetime. + */ + /** * \class PipelineHandler * \brief Create and manage cameras based on a set of media devices