From 05f50b5c65de6027429e74c6f8dff53c86fff512 Mon Sep 17 00:00:00 2001 From: Shankho Boron Ghosh Date: Mon, 30 Nov 2020 03:44:47 +0530 Subject: Added AFB Helper Guide in Developer Guides Revised and added AFB Helper Guide as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh Change-Id: I3df9265ae0570e987d80bc4bd2d3d14e7743b26a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25665 Reviewed-by: Jan-Simon Moeller Tested-by: Jan-Simon Moeller --- .../4_AFB_Helper_Guide/1_Usage.md | 83 ++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/3_Developer_Guides/4_AFB_Helper_Guide/1_Usage.md (limited to 'docs/3_Developer_Guides/4_AFB_Helper_Guide/1_Usage.md') diff --git a/docs/3_Developer_Guides/4_AFB_Helper_Guide/1_Usage.md b/docs/3_Developer_Guides/4_AFB_Helper_Guide/1_Usage.md new file mode 100644 index 0000000..80c2c08 --- /dev/null +++ b/docs/3_Developer_Guides/4_AFB_Helper_Guide/1_Usage.md @@ -0,0 +1,83 @@ +--- +title: Usage +--- + +## Installation + +The afb-helpers library is integrated by default in the AGL SDK since the Guppy +version (>=7) and is also available as a package for the AGL supported linux +distributions. + +You could find the SDK build from Yocto which embed the afb-helpers library +here: + +- **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh) + +- **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-10.90.0+snapshot.sh) + +- **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-10.90.0+snapshot.sh) + +Then use your package manager to install the library. + +### OpenSuse + +```bash +sudo zypper ref +sudo zypper install agl-libafb-helpers-devel +``` + +### Fedora + +```bash +sudo dnf ref +sudo dnf install agl-libafb-helpers-devel +``` + +### Ubuntu/Debian + +```bash +sudo apt-get update +sudo apt-get install agl-libafb-helpers-dev +``` + +## (Optional) Remove the git submodule version + +If you already use the afb-helpers component but using the submodule version +then you have to get rid of it to be sure to link and use the library version. +To do so, you have to do the following: + +* Deinitialize the submodule using `git` + +```bash +# This example assumes that the git submodule is named app-afb-helpers-submodule +# and is located at your root project repository. +git submodule deinit app-afb-helpers-submodule +``` + +* Remove the submodule relatives lines from the `.gitmodules` file + +```bash +vim .gitmodules +``` + +* Remove the `afb-helpers` target link from any CMake target you specified. + Those lines look like: + +```bash +TARGET_LINK_LIBRARIES(${TARGET_NAME} + afb-helpers # REMOVE THIS LINE + ${link_libraries} + ) +``` + +## Add the libafb-helpers as a static library to your binding + +In your `config.cmake` file, add a dependency to the controller library, i.e: + +```cmake +set(PKG_REQUIRED_LIST + json-c + afb-daemon + afb-helpers --> this is the afb-helpers library dependency name. +) +``` \ No newline at end of file -- cgit 1.2.3-korg