From c707eb533a4c582e7377d2ad617482459da385f1 Mon Sep 17 00:00:00 2001 From: Paul Elder Date: Mon, 24 May 2021 17:18:59 +0900 Subject: ipa: core: Move documentation from cpp file back into the mojom file Move the documentation back to the mojom file from the cpp file. While at it, move the documentation for IPAInterface::init() and IPAInterface::stop() to the IPA guide. While at it, update the todo comment in all of the mojom files accordingly. Signed-off-by: Paul Elder Reviewed-by: Laurent Pinchart Reviewed-by: Umang Jain [umang.jain@ideasonboard.com: Update todos] Signed-off-by: Umang Jain Reviewed-by: Paul Elder --- Documentation/guides/ipa.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'Documentation/guides') diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst index 6195b2b7..c612470f 100644 --- a/Documentation/guides/ipa.rst +++ b/Documentation/guides/ipa.rst @@ -166,6 +166,12 @@ At a minimum, the following three functions must be present (and implemented): All three of these functions are synchronous. The parameters for start() and init() may be customized. +init() initializes the IPA interface. It shall be called before any other +function of the IPAInterface. + +stop() informs the IPA module that the camera is stopped. The IPA module shall +release resources prepared in start(). + A configure() method is recommended. Any ControlInfoMap instances that will be used by the IPA must be sent to the IPA from the pipeline handler, at configure time, for example. -- cgit v1.2.1