ff9276cc62
Moving the core.mojom documentation to its corresponding .cpp file (core_ipa_interface.cpp). This will allow Doxygen to generate the documentation for IPABuffer, IPASettings and IPAStream structures. Since the .mojom files are placed in include/ directory, the .cpp file will live in $sourcedir/src/libcamera/ipa/ - which can also contain documentation for other mojom generated IPA interfaces in subsequent commit. Also hide the constructors in generated IPA interface from doxygen, via #ifndef __DOXYGEN__. These constructors provide no major value in documenting them, instead will spew out doxygen warnings during the build. Signed-off-by: Umang Jain <umang.jain@ideasonboard.com> Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
30 lines
623 B
Plaintext
30 lines
623 B
Plaintext
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
|
|
/*
|
|
* \todo Document the interface as src/libcamera/ipa/vimc_ipa_interface.cpp
|
|
* and remove the EXCLUDE_PATTERNS entry in Doxygen.in for its generation.
|
|
*/
|
|
|
|
module ipa.vimc;
|
|
|
|
import "include/libcamera/ipa/core.mojom";
|
|
|
|
const string VimcIPAFIFOPath = "/tmp/libcamera_ipa_vimc_fifo";
|
|
|
|
enum IPAOperationCode {
|
|
IPAOperationNone,
|
|
IPAOperationInit,
|
|
IPAOperationStart,
|
|
IPAOperationStop,
|
|
};
|
|
|
|
interface IPAVimcInterface {
|
|
init(libcamera.IPASettings settings) => (int32 ret);
|
|
start() => (int32 ret);
|
|
stop();
|
|
};
|
|
|
|
interface IPAVimcEventInterface {
|
|
dummyEvent(uint32 val);
|
|
};
|