Add GitHub actions

.clang-format

@@ -24,29 +24,24 @@ AttributeMacros:
   - __packed
   - __printf_like
   - __syscall
-  - __syscall_always_inline
   - __subsystem
 BitFieldColonSpacing: After
 BreakBeforeBraces: Linux
 ColumnLimit: 100
 ConstructorInitializerIndentWidth: 8
 ContinuationIndentWidth: 8
 ForEachMacros:
-  - 'ARRAY_FOR_EACH'
-  - 'ARRAY_FOR_EACH_PTR'
   - 'FOR_EACH'
   - 'FOR_EACH_FIXED_ARG'
   - 'FOR_EACH_IDX'
   - 'FOR_EACH_IDX_FIXED_ARG'
   - 'FOR_EACH_NONEMPTY_TERM'
-  - 'FOR_EACH_FIXED_ARG_NONEMPTY_TERM'
   - 'RB_FOR_EACH'
   - 'RB_FOR_EACH_CONTAINER'
   - 'SYS_DLIST_FOR_EACH_CONTAINER'
   - 'SYS_DLIST_FOR_EACH_CONTAINER_SAFE'
   - 'SYS_DLIST_FOR_EACH_NODE'
   - 'SYS_DLIST_FOR_EACH_NODE_SAFE'
-  - 'SYS_SEM_LOCK'
   - 'SYS_SFLIST_FOR_EACH_CONTAINER'
   - 'SYS_SFLIST_FOR_EACH_CONTAINER_SAFE'
   - 'SYS_SFLIST_FOR_EACH_NODE'
@@ -69,22 +64,10 @@ ForEachMacros:
   - 'Z_GENLIST_FOR_EACH_CONTAINER_SAFE'
   - 'Z_GENLIST_FOR_EACH_NODE'
   - 'Z_GENLIST_FOR_EACH_NODE_SAFE'
-  - 'STRUCT_SECTION_FOREACH'
-  - 'STRUCT_SECTION_FOREACH_ALTERNATE'
-  - 'TYPE_SECTION_FOREACH'
-  - 'K_SPINLOCK'
-  - 'COAP_RESOURCE_FOREACH'
-  - 'COAP_SERVICE_FOREACH'
-  - 'COAP_SERVICE_FOREACH_RESOURCE'
-  - 'HTTP_RESOURCE_FOREACH'
-  - 'HTTP_SERVER_CONTENT_TYPE_FOREACH'
-  - 'HTTP_SERVICE_FOREACH'
-  - 'HTTP_SERVICE_FOREACH_RESOURCE'
-  - 'I3C_BUS_FOR_EACH_I3CDEV'
-  - 'I3C_BUS_FOR_EACH_I2CDEV'
 IfMacros:
   - 'CHECKIF'
-IncludeBlocks: Regroup
+# Disabled for now, see bug https://github.com/zephyrproject-rtos/zephyr/issues/48520
+#IncludeBlocks: Regroup
 IncludeCategories:
   - Regex: '^".*\.h"$'
     Priority: 0
@@ -98,17 +81,9 @@ IndentCaseLabels: false
 IndentGotoLabels: false
 IndentWidth: 8
 InsertBraces: true
-InsertNewlineAtEOF: true
-SpaceBeforeInheritanceColon: False
 SpaceBeforeParens: ControlStatementsExceptControlMacros
-SortIncludes: CaseInsensitive
-UseTab: ForContinuationAndIndentation
+SortIncludes: Never
+UseTab: Always
 WhitespaceSensitiveMacros:
-  - COND_CODE_0
-  - COND_CODE_1
-  - IF_DISABLED
-  - IF_ENABLED
-  - LISTIFY
   - STRINGIFY
-  - Z_STRINGIFY
-  - DT_FOREACH_PROP_ELEM_SEP
+  - Z_STRINGIFY

.github/workflows/build-using-docker.yml

@@ -0,0 +1,76 @@
+name: Build and test app in NCS docker container
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  set-image-tag:
+    runs-on: ubuntu-24.04
+    outputs:
+      IMAGE_TAG: ${{ steps.set-output.outputs.IMAGE_TAG }}
+    steps:
+      - name: Checkout repository with Edge-ai AddOn
+        uses: actions/checkout@v4
+        with:
+          path: edge-ai
+
+      - name: Prepare west project
+        run: |
+          python3 -m pip install west
+          west init -l edge-ai
+          west update -o=--depth=1 -n nrf
+
+      - name: Find toolchain bundle id
+        id: set-output
+        run: echo "IMAGE_TAG=$(./nrf/scripts/print_toolchain_checksum.sh)" >> $GITHUB_OUTPUT
+
+  build-and-test-in-docker:
+    needs: set-image-tag
+    runs-on: ubuntu-24.04
+    container: ghcr.io/nrfconnect/sdk-nrf-toolchain:${{ needs.set-image-tag.outputs.IMAGE_TAG }}
+    defaults:
+      run:
+        # Bash shell is needed to set toolchain related environment variables in docker container
+        # It is a workaround for GitHub Actions limitation https://github.com/actions/runner/issues/1964
+        shell: bash
+    steps:
+      - name: Checkout repository with Edge-ai AddOn
+        uses: actions/checkout@v4
+        with:
+          path: edge-ai
+
+      - name: Prepare west project
+        run: |
+          west init -l edge-ai
+          west update -o=--depth=1 -n
+
+      - name: Build anomaly sample
+        working-directory: edge-ai/samples/nrf_edgeai/anomaly
+        run: |
+          west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+          west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+          west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+          west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2
+
+      - name: Build classification sample
+        working-directory: edge-ai/samples/nrf_edgeai/classification
+        run: |
+          west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+          west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+          west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+          west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2
+
+      - name: Build regression sample
+        working-directory: edge-ai/samples/nrf_edgeai/regression
+        run: |
+          west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+          west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+          west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+          west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+          west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2

.github/workflows/build-using-toolchain-bundle.yml

@@ -0,0 +1,83 @@
+name: Build and test app in toolchain bundle environment
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  build-and-test-in-toolchain-bundle:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository with Edge-ai AddOn
+        uses: actions/checkout@v4
+        with:
+          path: edge-ai
+
+      - name: Prepare west project
+        run: |
+          python3 -m pip install west
+          west init -l edge-ai
+          west update -o=--depth=1 -n
+
+      - name: Install nrfutil and toolchain manager
+        run: |
+          wget -q https://files.nordicsemi.com/artifactory/swtools/external/nrfutil/executables/x86_64-unknown-linux-gnu/nrfutil
+          chmod +x nrfutil
+          ./nrfutil install toolchain-manager
+
+      - name: Find proper toolchain bundle
+        id: set-tb-id
+        run: echo "TOOLCHAIN_BUNDLE_NAME=ncs-toolchain-x86_64-linux-$(./nrf/scripts/print_toolchain_checksum.sh).tar.gz" >> $GITHUB_OUTPUT
+
+      - name: Restore toolchain bundle from cache
+        id: restore-cached-tb
+        uses: actions/cache/restore@v4
+        with:
+          path: ${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+          key: ${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+
+      - name: Download toolchain bundle if not cached
+        if: steps.restore-cached-tb.outputs.cache-hit != 'true'
+        run: wget https://files.nordicsemi.com/artifactory/NCS/external/bundles/v3/${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+
+      - name: Save toolchain bundle to cache
+        if: steps.restore-cached-tb.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+          path: ${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+          key: ${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+
+      - name: Install proper toolchain bundle
+        run: ./nrfutil toolchain-manager install --toolchain-bundle ${{steps.set-tb-id.outputs.TOOLCHAIN_BUNDLE_NAME}}
+
+      - name: Build firmware
+        run: |
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf52dk/nrf52832 --build-dir build_nrf52dk_nrf52832 -o=-j2
+
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf52840dk/nrf52840 --build-dir build_nrf52840dk_nrf52840 -o=-j2
+
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf5340dk/nrf5340/cpuapp --build-dir build_nrf5340dk_nrf5340_cpuapp -o=-j2
+
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf5340dk/nrf5340/cpuapp/ns --build-dir build_nrf5340dk_nrf5340_cpuapp_ns -o=-j2
+
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf54l15dk/nrf54l15/cpuapp --build-dir build_nrf54l15dk_nrf54l15_cpuapp -o=-j2
+
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/anomaly/ -- west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/classification/ -- west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2
+          ./nrfutil toolchain-manager launch --chdir edge-ai/samples/nrf_edgeai/regression/ -- west build --board nrf54h20dk/nrf54h20/cpuapp --build-dir build_nrf54h20dk_nrf54h20_cpuapp -o=-j2
+
+#      - name: Store hex files
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name: built-applications
+#          path: edge-ai/samples/nrf_edgeai/*/build_*/*.hex

.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+# Copyright (c) 2024, Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+name: Documentation
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        doxygen-version: [1.9.6, 1.14.0]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install dependencies
+        run: |
+          DOXYGEN_VERSION="${{ matrix.doxygen-version }}"
+          wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
+          tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
+          echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
+          pip install -r doc/requirements.txt
+
+      - name: Build
+        run: |
+          cd doc
+          doxygen
+
+          SPHINXOPTS="-W" make html
+
+          mkdir deploy
+          mv _build_doxygen/html deploy/doxygen
+          mv _build_sphinx/html/* deploy
+
+      - name: Setup pages
+        if: github.event_name != 'pull_request' && matrix.doxygen-version == '1.14.0'
+        uses: actions/configure-pages@v4
+
+      - name: Upload pages artifact
+        if: github.event_name != 'pull_request' && matrix.doxygen-version == '1.14.0'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: doc/deploy
+
+      - name: Upload artifacts
+        if: github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-doxygen-${{ matrix.doxygen-version }}
+          path: doc/deploy
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-22.04
+    needs: build
+    if: github.event_name != 'pull_request'
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.github/workflows/src-mirror.yml

@@ -0,0 +1,43 @@
+name: src-mirror
+
+on:
+  workflow_dispatch:
+    inputs:
+      git-ref:
+        description: "Branch, tag or SHA to checkout"
+        required: true
+        default: "main"
+  push:
+    tags:
+      - "*"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths:
+      - .github/workflows/src-mirror.yml
+
+concurrency:
+  group: src-mirror-${{ github.ref }}
+  cancel-in-progress: true
+
+  # Tar entire project west workspace, prune, and upload to artifact service.
+jobs:
+  standard:
+    runs-on:
+      - runs-on=${{ github.run_id }}
+      - runner=16cpu-linux-x64
+    steps:
+      - name: Upload src.tar.gz
+        uses: nrfconnect/action-src-mirror@main
+        with:
+          path: "sdk-edge-ai-addon"
+          west-update-args: ""
+          artifactory-path: >-
+            ${{ (github.ref_type != 'tag') &&
+              format('ncs-src-mirror/internal/{0}/{1}/src.tar.gz', github.event.repository.name, github.ref_name) }}
+          # Enable external after testing that this works as intended
+          #              format('ncs-src-mirror/internal/{0}/{1}/src.tar.gz', github.event.repository.name, github.ref_name) ||
+          #              format('ncs-src-mirror/external/{0}/{1}/src.tar.gz', github.event.repository.name, github.ref_name) }}
+          artifactory-user: ${{ secrets.COM_NORDICSEMI_FILES_USERNAME }}
+          artifactory-pass: ${{ secrets.COM_NORDICSEMI_FILES_PASSWORD }}

.gitignore

@@ -35,3 +35,5 @@ doc/nrf/_doxygen/
 doc/nrf/_samples/
 doc/*_warnings.txt
 doc/*_doc.log
+
+!.github/workflows/build*

README.md

@@ -1,3 +1,18 @@
-# Edge AI add-on for nRF Connect SDK
+# Edge AI Add-on for nRF Connect SDK
+
+A compact add-on that makes it easy to run small, generated machine-learning
+models on Nordic Semiconductor devices using the nRF Connect SDK (NCS).
+
+License
+-------
+
+Source files in this repository include SPDX license identifiers. See file
+headers for the exact license text.
+
+Questions or help
+-----------------
+
+Open an issue on the repository or contact the maintainers via your project
+communication channels.
+
 
-Edge AI add-on