diff options
Diffstat (limited to 'docs/04_Developer_Guides')
6 files changed, 3 insertions, 339 deletions
diff --git a/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md index e94b1ed..dd888c7 100644 --- a/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md +++ b/docs/04_Developer_Guides/01_Setting_Up_AGL_SDK.md @@ -2,27 +2,12 @@ title: Setting Up AGL SDK --- -AGL provides a pre-built ready-made Software Development Kit (SDK) to help -quickstart the service and application development process. -1. Download the prebuilt SDK : +You will have to build the agl-ivi-demo-qt-crosssdk image to retrieve the sdk files ! - Please open the link below and download .sh file for desired machine. - - - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemux86-64/deploy/sdk/) - - **Note:** .sh file will be with name "poky-agl-glibc-x86_64-agl-ivi-demo-qt-crosssdk-corei7-64-qemux86-64-toolchain-$(version number).sh" where version number is regularly updated on the site. - - - - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm/deploy/sdk/) - - **Note:** .sh file will be with name " poky-agl-glibc-x86_64-agl-ivi-demo-qt-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-$(version number).sh" where version number is regularly updated on the site. - - - - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm64/deploy/sdk/) - - **Note:** .sh file will be with name " poky-agl-glibc-x86_64-agl-ivi-demo-qt-crosssdk-aarch64-qemuarm64-toolchain-$(version number).sh" where version number is regularly updated on the site. +1. Build the SDK : +Follow the build setup as before but do build 'agl-ivi-demo-qt-crosssdk' as image. *Henceforth,* **qemux86-64** *is used in these guides, unless specified otherwise. We also use the 'agl-ivi-demo-qt-crosssdk' as example.* diff --git a/docs/04_Developer_Guides/02_AGL_Layers/01_Overview.md b/docs/04_Developer_Guides/02_AGL_Layers/01_Overview.md deleted file mode 100644 index dec8054..0000000 --- a/docs/04_Developer_Guides/02_AGL_Layers/01_Overview.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Overview ---- - -The [AGL Project](https://www.automotivelinux.org/) is an automotive-specific -development environment that provides a Linux distribution -([AGL UCB](https://www.automotivelinux.org/software/unified-code-base)). - -AGL uses layers designed to be compatible with the -[Yocto Project](https://www.yoctoproject.org) and the -[OpenEmbedded Project (OE)](https://www.openembedded.org/wiki/Main_Page). - -This section provides information about the layers used by the AGL Project: - -* **`meta-agl`**: Minimal set of software needed to create an AGL distribution - used to boot a system. - AGL profiles are built on top of this minimal set of software. - -* **`meta-agl-demo`**: Provides a reference or demo platform and applications - for the AGL Distribution. - The reference UI is part of the `meta-agl-demo` layer. - -* **`meta-agl-devel`**: Contains components under development or being tested. - This layer also contains software packages that OEMs need but do not exist - in AGL. diff --git a/docs/04_Developer_Guides/02_AGL_Layers/02_meta_agl.md b/docs/04_Developer_Guides/02_AGL_Layers/02_meta_agl.md deleted file mode 100644 index 0f5d57e..0000000 --- a/docs/04_Developer_Guides/02_AGL_Layers/02_meta_agl.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: meta-agl ---- - -## Introduction - -The `meta-agl` layer provides the minimal set of software -to boot an AGL Distribution system. -You use this layer as the minimal core on which to build AGL profiles. - -**NOTE:** The `meta-agl` layer does not include a reference UI. - The reference UI is included as part of the - [`meta-agl-demo`](03_meta_agl_demo.md) layer. - Furthermore, `meta-agl` does not include additional components, such - as security, which are part of the - `meta-agl-extra` layer. - -## Sub-Layers - -The `meta-agl` layer itself contains many sub-layers and files. -Following is a "tree" look at the layer: - -``` -. -├── LICENSE -├── LICENSE.GPL-2.0-only -├── LICENSE.MIT -├── README-AGL.md -├── README.md -> meta-agl.md -├── agl-layers-overview.md -├── docs -├── meta-agl-bsp -├── meta-agl-core -├── meta-agl-core-test -├── meta-agl-ic -├── meta-agl-ivi -├── meta-agl.md -├── meta-netboot -├── meta-pipewire -├── scripts -├── templates -``` - -This list provides some overview information on the files and sub-layers -in `meta-agl`: - -* LICENSE* : licenses of the various components. -* README* : RTFM -* agl-layers-overview.md: references to the various layers that make up AGL -* `docs`: Contains files that support AGL documentation. -* `meta-agl-bsp`: Contains adaptations for recipes and required packages - to boot an AGL distribution on targeted hardware and emulation (i.e. QEMU). -* `meta-agl-core`: This is the core layer with essential recipes and the distro. -* `meta-agl-core-test`: recipes supporting qa images (separate layer due to external dependencies) -* `meta-agl-ic`: Instrument Cluster platform -* `meta-agl-ivi`: IVI platform -* `meta-netboot`: Contains recipes and configuration adjustments to allow network - boot through network block device (NBD) since network file system (NFS) does not - support security labels. -* `meta-pipewire`: Configuration and recipes supporting pipewire as audio manager -* `scripts`: AGL development setup and support scripts. -* `templates`: Base, feature, and machine templates used in the AGL development - environment. - -## Packagegroups - -This section describes the AGL -[packagegroup](https://docs.yoctoproject.org/dev-manual/common-tasks.html#customizing-images-using-custom-package-groups) -design: - -### core non-ui packagegroups -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-connectivity.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-devel.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-security.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-os-commonlibs.bb - -### graphical subsystem -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-profile-graphical.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-multimedia.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-graphical-weston.bb - -### image-related packagegroups -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-core-boot.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-boot.bb -* meta-agl-core/recipes-platform/packagegroups/packagegroup-agl-image-minimal.bb - -### QA/Test related packagegroups -* meta-agl-core-test/recipes-test/packagegroups -* meta-agl-core-test/recipes-test/packagegroups/packagegroup-agl-test.bb - -## Images - -### (Barely) bootable image -* meta-agl-core/recipes-platform/images/agl-image-boot.bb - -### minimal image and SDK (console) -* meta-agl-core/recipes-platform/images/agl-image-minimal.bb -* meta-agl-core/recipes-platform/images/agl-image-minimal-crosssdk.bb - -### weston-based image for re-use -* meta-agl-core/recipes-platform/images/agl-image-weston.bb - -### image for use in the YP autobuilder -* meta-agl-core/recipes-platform/images/agl-image-core-autobuilder.bb - -### image with extra QA tooling (e.g. to run LTP) -* meta-agl-core-test/images/agl-image-minimal-qa.bb - - - -**Note:** For update details on this page please refer - -<https://git.automotivelinux.org/AGL/meta-agl/tree/meta-agl.md> diff --git a/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md b/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md deleted file mode 100644 index 1527889..0000000 --- a/docs/04_Developer_Guides/02_AGL_Layers/03_meta_agl_demo.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: meta-agl-demo ---- - -## Introduction - -The `meta-agl-demo` layer is the reference user interface layer for the DEMO -platform of Automotive Grade Linux (AGL). -The layer provides a reference platform and applications. -The BitBake target name for the DEMO platform is `agl-ivi-demo-qt`, which is -the full DEMO platform image. - -## Layer Dependencies - -This section describes dependencies for the `meta-agl-demo` layer. -Dependencies are grouped into base, hardware, and feature dependencies. - -### Base Dependencies - -The `meta-agl-demo` layer has the following base dependencies: - -- Yocto Project Release: - - - URI: git://git.yoctoproject.org/poky - - Branch: "kirkstone" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. - -- AGL `meta-agl` Layer: - - - URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl - - Branch: "master" - -- OpenEmbedded `meta-openembedded` Layer: - - Specifically, out of `meta-openembedded`, these sub-layers are used: - - - `meta-oe` - - `meta-multimedia` - - `meta-networking` - - `meta-python` - -- Yocto Project `meta-qt5` Layer from the - [OpenEmbedded Layer Index](https://layers.openembedded.org/layerindex/branch/master/layers/): - - - URI: https://github.com/meta-qt5/meta-qt5.git - -### Feature Dependencies - -The `meta-agl-demo` layer has the following AGL [feature](../../01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md/#agl-features) -dependencies: - -- Yocto Project `meta-security` Layer: - -- OpenEmbedded's `meta-openembedded` Layer: - - - URI: https://github.com/openembedded/meta-openembedded - - Branch: "kirkstone" - - Tested Revision: See the - [`default.xml`](https://github.com/leon-anavi/AGL-repo/blob/master/default.xml) - manifest file for the `AGL-repo` repository for revision information. - - Specifically, out of `meta-openembedded`, these sub-layers are used: - - - `meta-filesystems` - - `meta-oe` - - `meta-python` - -**The `agl-netboot` Feature:** - -- AGL's `meta-netboot` Layer within the `meta-agl` Layer: - - - URI: https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl.git - - Branch: "master" - -## Maintenance - -All patches must be submitted via the AGL Gerrit instance at -<https://gerrit.automotivelinux.org>. See this wiki page for -details: - -<https://wiki.automotivelinux.org/agl-distro/contributing> - -Layer maintainers: - -* Jan-Simon Möller <jsmoeller@linuxfoundation.org> - - -**Note:** For update details on this page please refer - -<https://git.automotivelinux.org/AGL/meta-agl-demo/tree/meta-agl-demo.md> diff --git a/docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md b/docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md deleted file mode 100644 index 8dc77e4..0000000 --- a/docs/04_Developer_Guides/02_AGL_Layers/04_meta_agl_devel.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: meta-agl-devel ---- - -## Introduction - -The `meta-agl-devel` layer contains components that are being tested or -still in development. -The layer also contains software packages that Original Equipment -Manufacturers (OEMs) need but are not included in the AGL software. - -## Sub-Layers - -The `meta-agl-devel` layer contains the following files and sub-layers: - -``` -. -├── docs -├── LICENSE -├── LICENSE.GPL-2.0-only -├── LICENSE.MIT -├── meta-agl-devel.md -├── meta-agl-jailhouse -├── meta-agl-lxc -├── meta-agl-ros2 -├── meta-oem-production-readiness -├── meta-offline-voice-agent -├── README.md -└── templates -``` - -The following list provides a summary of these sub-layers: - -* `meta-offline-voice-agent`: Provides libraries and software packages needed - for voice recognition, intent extraction, and voice command execution. - -* `meta-agl-jailhouse`: Provides Jailhouse partitioning hypervisor and - supporting packages. - -* `meta-agl-lxc`: Provides LXC container support and example images. - -* `meta-agl-ros2`: Provides ROS2 and additional YDLIDAR support. - -* `meta-oem-production-readiness`: Provides libraries and software packages of - IVI product readiness - -* `meta-agl-flutter`: Provides Flutter support. - -* `templates`: Feature templates that support the `meta-agl-devel` layer. - - - -**Note:** For update details on this page please refer - -<https://git.automotivelinux.org/AGL/meta-agl-devel/tree/meta-agl-devel.md> diff --git a/docs/04_Developer_Guides/02_AGL_Layers/05_conf_notes.md b/docs/04_Developer_Guides/02_AGL_Layers/05_conf_notes.md deleted file mode 100644 index d51aafd..0000000 --- a/docs/04_Developer_Guides/02_AGL_Layers/05_conf_notes.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: conf-notes ---- - -``` -Common targets are: -- meta-agl layer: - - included by default - * agl-image-boot (just enough to boot) - * agl-image-minimal (minimal filesystem with APIs) - * agl-image-minimal-crosssdk (crosssdk for ^^) - - * agl-image-weston (minimal filesystem with weston) - * agl-image-compositor (minimal filesystem with AGL compositor) - -- meta-agl-demo: (IVI demo with UI) - - with 'agl-demo' - * agl-ivi-image (base for IVI targets) - * agl-ivi-image-crosssdk (sdk for ^^) - - * agl-ivi-demo-qt (IVI Qt demo image) - * agl-ivi-demo-qt-crosssdk (sdk for ^^) - * agl-ivi-demo-flutter (IVI Flutter demo image) - * agl-ivi-demo-html5 (IVI HTML5 demo image) - - * agl-cluster-demo-qt (cluster Qt demo image) - * agl-cluster-demo-flutter (cluster Flutter demo image) - - * agl-telematics-demo (telematics demo image) - - * agl-gateway-demo (gateway demo image) -``` - -**Note:** For update details on this page please refer - -<https://git.automotivelinux.org/AGL/meta-agl/tree/templates/base/conf-notes.txt> |