summaryrefslogtreecommitdiff
path: root/Documentation/guides
diff options
context:
space:
mode:
authorPaul Elder <paul.elder@ideasonboard.com>2021-05-24 17:18:59 +0900
committerPaul Elder <paul.elder@ideasonboard.com>2021-05-27 18:20:35 +0900
commitc707eb533a4c582e7377d2ad617482459da385f1 (patch)
treeabf05c93df032c2edc1f2865f478f577d1898cfa /Documentation/guides
parente371805a0374f74056dc7db1400ec063e7cbe5ba (diff)
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 <paul.elder@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com> [umang.jain@ideasonboard.com: Update todos] Signed-off-by: Umang Jain <umang.jain@ideasonboard.com> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Diffstat (limited to 'Documentation/guides')
-rw-r--r--Documentation/guides/ipa.rst6
1 files changed, 6 insertions, 0 deletions
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.