How to represent AI_Layer.clayer.yml in CMake compliant project

[ReinhardKeil]

Describe The Problem To Be Solved

CMSIS-ExecuTorch represents the AI_Layer in a .clayer.yml file.

How is this file represented for a generic CMake system to interface with Zephyr.

[brondani]

A CMake file ai_layer.cmake equivalent to ai_layer.clayer.yml could look like this:

set(SOLUTION_ROOT "D:/examples/executorch")
cmake_path(ABSOLUTE_PATH SOLUTION_ROOT NORMALIZE OUTPUT_VARIABLE SOLUTION_ROOT)

add_library(Group_ExecuTorch_Libraries INTERFACE)

target_include_directories(Group_ExecuTorch_Libraries INTERFACE
  $<$<COMPILE_LANGUAGE:C,CXX>:
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/runtime"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/runtime/core"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/runtime/executor"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/extension"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/extension/data_loader"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/extension/memory_allocator"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/extension/runner_util"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/util"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/schema"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/devtools"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/devtools/etdump"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/runtime/core/portable_type/c10"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/kernels"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/kernels/portable"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/backends"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/executorch/backends/xnnpack"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/third-party"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/third-party/flatbuffers"
    "${SOLUTION_ROOT}/executorch/ai_layer/engine/include/third-party/flatbuffers/include"
    "${SOLUTION_ROOT}/executorch/ai_layer/model"
  >
)

target_link_libraries(Group_ExecuTorch_Libraries INTERFACE
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libexecutorch.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libexecutorch_core.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libportable_kernels.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libportable_ops_lib.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libcortex_m_kernels.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libcortex_m_ops_lib.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libquantized_kernels.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libquantized_ops_lib.a
  ${SOLUTION_ROOT}/executorch/ai_layer/engine/lib/libexecutorch_delegate_ethos_u.a
)

target_link_libraries(app PRIVATE Group_ExecuTorch_Libraries)

It assumes the Zephyr CMake target is named app by default and the Zephyr project is correctly configured with needed defines and compile options.

If this file would be generated in the Zephyr build directory, just a single include line should be appended to the CMakeLists.txt in the Zephyr app-path directory:

include("${CMAKE_CURRENT_BINARY_DIR}/ai_layer.cmake")

[ReinhardKeil]

I believe we should also explore Zephyr modules as it has the benefit that it can be included in several applications.

A Zephyr module is constructed like this:

ml_module/
|-- CMakeLists.txt
|-- Kconfig
|-- zephyr/
|    |-- module.yml
|-- lib
|    |-- mlfile1.a
|    |-- mlfile2.a
|-- inc
     |-- file1.h
     |-- file2.h

module.yml:

name: my_ml_module
build:
  cmake: .
  kconfig: Kconfig

Kconfig:

config MY_ML_MODULE
  bool "My ML Module"
  default n
  help
    Include My ML Module into application

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20.0)

if(DEFINED CONFIG_MY_ML_MODULE)
  zephyr_library()

  zephyr_library_import(mlfile1   $(CMAKE_CURRENT_LIST_DIR}/lib/mlfile1.a)
  zephyr_library_import(mlfile2   $(CMAKE_CURRENT_LIST_DIR}/lib/mlfile2.a)

  zephyr_library_include_directories(
        $(CMAKE_CURRENT_LIST_DIR}/inc)
  )
endif(DEFINED CONFIG_MY_ML_MODULE)