[{"id":16234,"web_url":"https://patchwork.libcamera.org/comment/16234/","msgid":"<YHXYoBhO9q7V5pxR@pendragon.ideasonboard.com>","date":"2021-04-13T17:45:04","subject":"Re: [libcamera-devel] [PATCH 2/3] libcamera: ipa_proxy: Document\n\tProxyState","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nThank you for the patch.\n\nOn Tue, Apr 13, 2021 at 01:25:33PM +0100, Kieran Bingham wrote:\n> The documentation for the ProxyState and tracking variable was not added\n> when the IPA was extended with a state machine.\n> \n> Add it.\n> \n> Fixes: 70238ceca5b2 (\"utils: ipc: proxy: Track IPA with a state machine\")\n> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n> ---\n>  src/libcamera/ipa_proxy.cpp | 23 +++++++++++++++++++++++\n>  1 file changed, 23 insertions(+)\n> \n> diff --git a/src/libcamera/ipa_proxy.cpp b/src/libcamera/ipa_proxy.cpp\n> index ec4c2cc823c2..8608b0c92a87 100644\n> --- a/src/libcamera/ipa_proxy.cpp\n> +++ b/src/libcamera/ipa_proxy.cpp\n> @@ -32,6 +32,18 @@ LOG_DEFINE_CATEGORY(IPAProxy)\n>   * Isolate IPA into separate process.\n>   */\n>  \n> +/**\n> + * \\enum IPAProxy::ProxyState\n> + * \\brief Identifies the available operational states of the proxy\n> + *\n> + * \\var IPAProxy::ProxyStopped\n> + * \\brief The proxy is not active and only synchronous operations are permitted\n> + * \\var IPAProxy::ProxyStopping\n> + * \\brief No new tasks can be submitted to the proxy, however existing events can be completed\n\nWith a line wrap here,\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n> + * \\var IPAProxy::ProxyRunning\n> + * \\brief The Proxy is active and asynchronous tasks may be queued\n> + */\n> +\n>  /**\n>   * \\brief Construct an IPAProxy instance\n>   * \\param[in] ipam The IPA module\n> @@ -213,4 +225,15 @@ std::string IPAProxy::resolvePath(const std::string &file) const\n>   * construction.\n>   */\n>  \n> +/**\n> + * \\var IPAProxy::state_\n> + * \\brief Current state of the IPAProxy\n> + *\n> + * The IPAProxy can be Running, Stopped, or Stopping.\n> + *\n> + * This state provides a means to ensure that asynchronous methods are only\n> + * called while the proxy is running, and prevent new tasks being submitted\n> + * while still enabling events to complete when the IPAProxy is stopping.\n> + */\n> +\n>  } /* namespace libcamera */","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3FD27BD1F6\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 13 Apr 2021 17:45:58 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id AA7D8687D6;\n\tTue, 13 Apr 2021 19:45:57 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B72A2602D1\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 13 Apr 2021 19:45:55 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 298C89F0;\n\tTue, 13 Apr 2021 19:45:55 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"mcECIwZT\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1618335955;\n\tbh=ZNWyY8JQ7hQZkMk6c8OtJ6wp1splr7RrxPxcodQloO0=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=mcECIwZTtE9KLfiz+5jqzl3CjRXqvcqHfZk/Ktk6gvUfV2MV8upscwJseA5g2zZI2\n\tgyqRDZS11Hhqf3et1S7B/YOH2Y2zvNUnL+b7Wx6ZpHZ+k2LBm+nzhjVn/qSVJtA9te\n\tJHXWRdeDRHzb8thp6x8kNrmyBOHfLkk8fTsIUEK8=","Date":"Tue, 13 Apr 2021 20:45:04 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Message-ID":"<YHXYoBhO9q7V5pxR@pendragon.ideasonboard.com>","References":"<20210413122534.342138-1-kieran.bingham@ideasonboard.com>\n\t<20210413122534.342138-3-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210413122534.342138-3-kieran.bingham@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 2/3] libcamera: ipa_proxy: Document\n\tProxyState","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera devel <libcamera-devel@lists.libcamera.org>","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]