mlonmcu 0.3.0.dev0__3-none-any.whl

resources/patches/fix_esp32c3_march.patch

@@ -0,0 +1,20 @@
+commit 1ac774cd01c6be140f728696c48c3c2466157158
+Author: Philipp van Kempen <philipp.van-kempen@tum.de>
+Date:   Mon Aug 8 16:22:38 2022 +0200
+
+    esp32c3 related fix: missing _zicsr support
+
+diff --git a/tools/cmake/toolchain-esp32c3.cmake b/tools/cmake/toolchain-esp32c3.cmake
+index 012d93d07..4fac9cefa 100644
+--- a/tools/cmake/toolchain-esp32c3.cmake
++++ b/tools/cmake/toolchain-esp32c3.cmake
+@@ -5,6 +5,6 @@ set(CMAKE_SYSTEM_NAME Generic)
+ # set(CMAKE_CXX_COMPILER riscv32-esp-elf-g++)
+ # set(CMAKE_ASM_COMPILER riscv32-esp-elf-gcc)
+ 
+-set(CMAKE_C_FLAGS "-march=rv32imc" CACHE STRING "C Compiler Base Flags")
+-set(CMAKE_CXX_FLAGS "-march=rv32imc" CACHE STRING "C++ Compiler Base Flags")
+-set(CMAKE_EXE_LINKER_FLAGS "-nostartfiles -march=rv32imc --specs=nosys.specs" CACHE STRING "Linker Base Flags")
++set(CMAKE_C_FLAGS "-march=rv32imc_zicsr" CACHE STRING "C Compiler Base Flags")
++set(CMAKE_CXX_FLAGS "-march=rv32imc_zicsr" CACHE STRING "C++ Compiler Base Flags")
++set(CMAKE_EXE_LINKER_FLAGS "-nostartfiles -march=rv32imc_zicsr --specs=nosys.specs" CACHE STRING "Linker Base Flags")

resources/patches/pulp_freertos_support.patch

@@ -0,0 +1,55 @@
+diff --git a/support/support.mk b/support/support.mk
+index 6b22f93..fc128b4 100644
+--- a/support/support.mk
++++ b/support/support.mk
+@@ -17,26 +17,27 @@
+ 
+ # Try to build a full dependency tree for all libraries
+ 
++SUPPORT_INSTALL_DIR ?= $(SUPPORT_ROOT)/install
+ SUPPORT_LIB_DIR = $(SUPPORT_ROOT)/install/lib
+ 
+ $(SUPPORT_LIB_DIR)/libjson.a: \
+ $(shell find "$(SUPPORT_ROOT)/json-tools" -name '*.cpp' -o -name '*.hpp')
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" $(MAKE) -C "$(SUPPORT_ROOT)/json-tools" all install
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" $(MAKE) -C "$(SUPPORT_ROOT)/json-tools" all install
+ 
+ $(SUPPORT_LIB_DIR)/libpulpdebugbridge.so: $(SUPPORT_LIB_DIR)/libjson.a \
+ $(shell find "$(SUPPORT_ROOT)/pulp-debug-bridge" -name '*.cpp' -o -name '*.hpp')
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" $(MAKE) -C "$(SUPPORT_ROOT)/pulp-debug-bridge" build
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" $(MAKE) -C "$(SUPPORT_ROOT)/pulp-debug-bridge" build
+ 
+ $(SUPPORT_LIB_DIR)/libpulpperiph.so $(SUPPORT_LIB_DIR)/libpulpdpi.so: \
+ $(SUPPORT_LIB_DIR)/libjson.a $(SUPPORT_LIB_DIR)/libpulpdebugbridge.so \
+ $(shell find "$(SUPPORT_ROOT)/dpi-models" -name '*.cpp' -o -name '*.hpp')
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" $(MAKE) -C "$(SUPPORT_ROOT)/dpi-models" build
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" $(MAKE) -C "$(SUPPORT_ROOT)/dpi-models" build
+ 
+-$(SUPPORT_ROOT)/install/bin/plpinfo:
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" $(MAKE) -C "$(SUPPORT_ROOT)/pulp-configs" all_scons
++$(SUPPORT_INSTALL_DIR)/bin/plpinfo:
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" $(MAKE) -C "$(SUPPORT_ROOT)/pulp-configs" all_scons
+ 
+-$(SUPPORT_ROOT)/install/bin/plp_mkflash:
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" $(MAKE) -C "$(SUPPORT_ROOT)/runner" sdk.build
++$(SUPPORT_INSTALL_DIR)/bin/plp_mkflash:
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" $(MAKE) -C "$(SUPPORT_ROOT)/runner" sdk.build
+ 
+ 
+ ## Build the gvsoc simulator
+@@ -45,12 +46,12 @@ gvsoc: $(addprefix $(SUPPORT_LIB_DIR)/,libpulpvp.so libpulpvplauncher.so libpulp
+ # TODO: fix build configuration per chip thing
+ $(addprefix $(SUPPORT_LIB_DIR)/,libpulpvp.so libpulpvplauncher.so libpulpvp-debug.so): \
+ $(SUPPORT_LIB_DIR)/libjson.a $(SUPPORT_LIB_DIR)/libpulpdpi.so \
+-$(SUPPORT_ROOT)/install/bin/plpinfo $(SUPPORT_ROOT)/install/bin/plp_mkflash \
++$(SUPPORT_INSTALL_DIR)/bin/plpinfo $(SUPPORT_INSTALL_DIR)/bin/plp_mkflash \
+ $(shell find "$(SUPPORT_ROOT)/gvsoc" -name '*.cpp' -o -name '*.hpp' -o -name '*.py')
+ 	PULP_CURRENT_CONFIG=pulp@config_file=chips/pulp/pulp.json \
+ 	PULP_CONFIGS_PATH=$(SUPPORT_ROOT)/pulp-configs/configs \
+-	PYTHONPATH=$(SUPPORT_ROOT)/install/python \
+-	INSTALL_DIR="$(SUPPORT_ROOT)/install" \
++	PYTHONPATH=$(SUPPORT_INSTALL_DIR)/python \
++	INSTALL_DIR="$(SUPPORT_INSTALL_DIR)" \
+ 	$(MAKE) -C "$(SUPPORT_ROOT)/gvsoc" build ARCHI_DIR=$(SUPPORT_ROOT)/archi/include
+ 
+ 

resources/platforms/espidf/micro_speech_esp32devboard/CMakeLists.txt

@@ -0,0 +1,29 @@
+#[[
+Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+
+This file is part of MLonMCU.
+See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+]]
+
+# The following lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+
+set(COMPONENTS )
+
+project(app)

resources/platforms/espidf/micro_speech_esp32devboard/README.md

@@ -0,0 +1,70 @@
+<!--
+Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+
+This file is part of MLonMCU.
+See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+# Hello World Example
+
+Starts a FreeRTOS task to print "Hello World".
+
+(See the README.md file in the upper level 'examples' directory for more information about examples.)
+
+## How to use example
+
+Follow detailed instructions provided specifically for this example. 
+
+Select the instructions depending on Espressif chip installed on your development board:
+
+- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)
+- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)
+
+
+## Example folder contents
+
+The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main).
+
+ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both). 
+
+Below is short explanation of remaining files in the project folder.
+
+```
+├── CMakeLists.txt
+├── example_test.py            Python script used for automated example testing
+├── main
+│   ├── CMakeLists.txt
+│   ├── component.mk           Component make file
+│   └── hello_world_main.c
+├── Makefile                   Makefile used by legacy GNU Make
+└── README.md                  This is the file you are currently reading
+```
+
+For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide.
+
+## Troubleshooting
+
+* Program upload failure
+
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
+    * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
+
+## Technical support and feedback
+
+Please use the following feedback channels:
+
+* For technical queries, go to the [esp32.com](https://esp32.com/) forum
+* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues)
+
+We will get back to you as soon as possible.

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/CMakeLists.txt

@@ -0,0 +1,78 @@
+#[[
+Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+
+This file is part of MLonMCU.
+See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+]]
+
+SET(MLONMCU_CODEGEN_DIR ${CONFIG_MLONMCU_CODEGEN_DIR})
+SET(MLONMCU_FRAMEWORK ${CONFIG_MLONMCU_FRAMEWORK})
+SET(MLONMCU_BACKEND ${CONFIG_MLONMCU_BACKEND})
+
+
+SET(MLIF_SRCS ml_interface.c)
+SET(CODEGEN_INCS ${MLONMCU_CODEGEN_DIR})
+IF("${MLONMCU_FRAMEWORK}" STREQUAL "tflm")
+    SET(LIB_NAME tflite-lib)
+    LIST(APPEND MLIF_SRCS ml_interface_tflm.cc)
+    FILE(GLOB CODEGEN_SRCS
+        ${MLONMCU_CODEGEN_DIR}/*.cc
+        ${MLONMCU_CODEGEN_DIR}/*.c
+    )
+
+ELSEIF("${MLONMCU_FRAMEWORK}" STREQUAL "tvm")
+    SET(LIB_NAME tvm-lib)
+    LIST(APPEND MLIF_SRCS ml_interface_tvm.c)
+    FILE(GLOB CODEGEN_SRCS
+        ${MLONMCU_CODEGEN_DIR}/codegen/host/src/*.c
+        ${MLONMCU_CODEGEN_DIR}/codegen/host/src/*.cc
+    )
+    IF(EXISTS ${MLONMCU_CODEGEN_DIR}/codegen/host/include/)
+        LIST(APPEND CODEGEN_INCS ${MLONMCU_CODEGEN_DIR}/codegen/host/include/)
+    ENDIF()
+
+    IF ("${MLONMCU_BACKEND}" STREQUAL "tvmaot")
+        LIST(APPEND CODEGEN_SRCS ${MLONMCU_CODEGEN_DIR}/aot_wrapper.c)
+    ELSEIF ("${MLONMCU_BACKEND}" STREQUAL "tvmrt")
+        LIST(APPEND CODEGEN_SRCS ${MLONMCU_CODEGEN_DIR}/rt_wrapper.c)
+    ELSEIF ("${MLONMCU_BACKEND}" STREQUAL "tvmcg")
+        LIST(APPEND CODEGEN_SRCS ${MLONMCU_CODEGEN_DIR}/staticrt.c)
+    ELSE()
+        MESSAGE(WARNING "Invalid Backend: ${MLONMCU_BACKEND}")
+    ENDIF()
+ELSE()
+    MESSAGE(WARNING "Invalid Framework: ${MLONMCU_FRAMEWORK}")
+    SET(LIB_NAME tflite-lib tvm-lib)
+ENDIF()
+
+# SET(MODEL_SUPPORT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/default_model_support)
+# SET(MODEL_SUPPORT_SRCS
+#     ${MODEL_SUPPORT_DIR}/process_input.c
+#     ${MODEL_SUPPORT_DIR}/process_output.c
+# )
+# SET(DATA_SRC ${CMAKE_CURRENT_SOURCE_DIR}/default_data.c)
+
+# idf_component_register(SRCS ${CODEGEN_SRCS} ${MLIF_SRCS} ${MODEL_SUPPORT_SRCS} ${DATA_SRC}
+#                     INCLUDE_DIRS ${CODEGEN_INCS} ${MODEL_SUPPORT_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/include
+#                     REQUIRES ${LIB_NAME})
+# SET(MLIF_EXTRA_INCS
+#   ${CMAKE_CURRENT_SOURCE_DIR}/${MLONMCU_FRAMEWORK}
+# )
+
+idf_component_register(SRCS ${CODEGEN_SRCS} ${MLIF_SRCS}
+                    INCLUDE_DIRS ${CODEGEN_INCS} ${CMAKE_CURRENT_SOURCE_DIR}/include
+                    REQUIRES ${LIB_NAME})
+
+# target_compile_definitions(${COMPONENT_LIB} PUBLIC NUM_RUNS=${NUM_RUNS})

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/Kconfig

@@ -0,0 +1,76 @@
+menu "MLonMCU Options"
+
+    config MLONMCU_CODEGEN_DIR
+        string "Codegen Directory"
+        default "$(CODEGEN_SRC)"
+        help
+            Path to the directory with the codegen results.
+
+    choice MLONMCU_FRAMEWORK
+        prompt "MLonMCU framework"
+        default MLONMCU_FRAMEWORK_TFLM
+        help
+            Choose a MLonMCU framework from the list.
+
+        config MLONMCU_FRAMEWORK_TFLM
+            bool "TFLite Micro"
+        config MLONMCU_FRAMEWORK_TVM
+            bool "TVM"
+    endchoice
+
+    config MLONMCU_FRAMEWORK
+        string
+        default "tflm" if MLONMCU_FRAMEWORK_TFLM
+        default "tvm" if MLONMCU_FRAMEWORK_TVM
+
+    choice MLONMCU_BACKEND
+        prompt "MLonMCU backend"
+        default MLONMCU_BACKEND_TFLMI if MLONMCU_FRAMEWORK_TFLM
+        default MLONMCU_BACKEND_TVMAOT if MLONMCU_FRAMEWORK_TVM
+        help
+            Choose a MLonMCU backend for the chosen framwork.
+
+        config MLONMCU_BACKEND_TFLMI
+            bool "TFLite Micro Default Interpreter"
+            depends on MLONMCU_FRAMEWORK_TFLM
+        config MLONMCU_BACKEND_TFLMC
+            bool "TFLite Micro Compiler"
+            depends on MLONMCU_FRAMEWORK_TFLM
+        config MLONMCU_BACKEND_TVMAOT
+            bool "TVM AoT Executor"
+            depends on MLONMCU_FRAMEWORK_TVM
+        config MLONMCU_BACKEND_TVMRT
+            bool "TVM Graph Executor"
+            depends on MLONMCU_FRAMEWORK_TVM
+        config MLONMCU_BACKEND_TVMCG
+            bool "TVM Custom Codegenerator"
+            depends on MLONMCU_FRAMEWORK_TVM
+    endchoice
+
+    config MLONMCU_BACKEND
+        string
+        default "tflmi" if MLONMCU_BACKEND_TFLMI
+        default "tflmc" if MLONMCU_BACKEND_TFLMC
+        default "tvmaot" if MLONMCU_BACKEND_TVMAOT
+        default "tvmrt" if MLONMCU_BACKEND_TVMRT
+        default "tvmcg" if MLONMCU_BACKEND_TVMCG
+
+    config MLONMCU_NUM_RUNS
+        int "Number of inferences"
+        default 1
+        help
+            How many times the network should be invoked. A negative value maps to a infinite number of runs.
+
+    config MLONMCU_VALIDATE
+        bool "Validate model output data"
+        default false
+        help
+            Compare model outputs with expected results (if available). Only works in DEBUG mode.
+
+    config MLONMCU_MODLE_DIR
+        string "Model Directory"
+        depends on MLONMCU_VALIDATE
+        default "$(MODEL_DIR)"
+        help
+            Directory where model support code and reference data can be found.
+endmenu

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/default_data.c

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "ml_interface.h"
+#include <stddef.h>
+const int num_data_buffers_in = 0;
+const int num_data_buffers_out = 0;
+const unsigned char *const data_buffers_in[] = {};
+const unsigned char *const data_buffers_out[] = {};
+const size_t data_size_in[] = {};
+const size_t data_size_out[] = {};

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/default_model_support/process_input.c

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include <stdlib.h>
+#include <memory.h>
+
+#include "printing.h"
+#include "exit.h"
+
+void mlif_process_input(const void *in_data, size_t in_size, void *model_input_ptr, size_t model_input_sz) {
+  if (in_size != 0) {
+    if (in_size != model_input_sz) {
+      DBGPRINTF("MLIF: Given input size (%lu) does not match model input buffer size (%lu)!\n", in_size,
+                model_input_sz);
+      exit(EXIT_MLIF_INVALID_SIZE);
+    }
+  }
+
+  memcpy(model_input_ptr, in_data, in_size);
+}

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/default_model_support/process_output.c

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include <stdlib.h>
+#include <memory.h>
+
+#include "printing.h"
+#include "exit.h"
+
+void mlif_process_output(void *model_output_ptr, size_t model_output_sz, const void *expected_out_data,
+                         size_t expected_out_size) {
+#ifdef _DEBUG
+  if (model_output_sz >= 4) {
+    DBGPRINTF("MLIF: First float of output: %f\n", *(float *)model_output_ptr);
+  }
+  DBGPRINTF("MLIF: Model output data: ");
+  for (size_t i = 0; i < model_output_sz; i++) {
+    DBGPRINTF("\\x%02X", ((unsigned char *)model_output_ptr)[i]);
+    fflush(0);
+  }
+  DBGPRINTF("\n");
+#endif
+
+  if (model_output_sz == expected_out_size && memcmp(model_output_ptr, expected_out_data, model_output_sz) == 0) {
+    DBGPRINTF("MLIF: Output data matches expected data\n");
+  } else {
+    DBGPRINTF("MLIF: Wrong output data!\n");
+    exit(EXIT_MLIF_MISSMATCH);
+  }
+}

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/include/exit.h

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef SUPPORT_EXIT_H
+#define SUPPORT_EXIT_H
+
+#define EXIT_MLIF_BASE        (0x10)
+#define EXIT_MLIF_INVALID_SIZE  (EXIT_MLIF_BASE + 1)
+#define EXIT_MLIF_MISSMATCH   (EXIT_MLIF_BASE + 2)
+
+#endif  // SUPPORT_EXIT_H

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/include/ml_interface.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef ML_INTERFACE_H
+#define ML_INTERFACE_H
+
+#include <stddef.h>
+#include <stdbool.h>
+
+#ifndef NUM_RUNS
+#define NUM_RUNS 1
+#endif  /* NUM_RUNS */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// TODO: docs
+void mlif_init();
+void *mlif_input_ptr(int index);
+size_t mlif_input_size(int index);
+size_t mlif_inputs();
+void mlif_invoke();
+void *mlif_output_ptr(int index);
+size_t mlif_output_size(int index);
+size_t mlif_outputs();
+
+void mlif_run(void);
+
+// These can be overridden by use code.
+
+// Provides input data for the model. The default implementation retrieves input from
+// the global variables below and fills the model input with mlif_process_input.
+bool mlif_request_input(void *model_input_ptr, size_t model_input_sz);
+// Is called when the output data is available. The default implementation
+void mlif_handle_result(void *model_output_ptr, size_t model_output_sz);
+
+// Callback for any preprocessing on the input data. Responsible for copying the data.
+void mlif_process_input(const void *in_data, size_t in_size, void *model_input_ptr, size_t model_input_sz);
+// Callback for any postprocessing on the output data. The default implementation prints
+// the output and verifies consistency with the expected output.
+void mlif_process_output(void *model_output_ptr, size_t model_output_sz, const void *expected_out_data, size_t expected_out_size);
+
+extern const int num_data_buffers_in;
+extern const int num_data_buffers_out;
+extern const unsigned char * const data_buffers_in[];
+extern const unsigned char * const data_buffers_out[];
+extern const size_t data_size_in[];
+extern const size_t data_size_out[];
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/include/printing.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef SUPPORT_PRINTING_H
+#define SUPPORT_PRINTING_H
+
+
+#ifdef _DEBUG
+#include <stdio.h>
+#define DBGPRINTF(format, ...) printf(format, ##__VA_ARGS__)
+#else
+#define DBGPRINTF(format, ...)
+#endif
+
+
+#endif

resources/platforms/espidf/micro_speech_esp32devboard/components/mlif2/ml_interface.c

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
+ *
+ * This file is part of MLonMCU.
+ * See https://github.com/tum-ei-eda/mlonmcu.git for further info.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "ml_interface.h"
+#include "printing.h"
+
+#include <string.h>
+#include <stdlib.h>
+
+void mlif_run() {
+  mlif_init();
+
+  size_t input_num = 0;
+  size_t remaining = NUM_RUNS;
+  // inout data will only be applied in the first run!
+  while (mlif_request_input(mlif_input_ptr(input_num), mlif_input_size(input_num)) || remaining) {
+    if (input_num == mlif_inputs() - 1) {
+      mlif_invoke();
+      for (size_t i = 0; i < mlif_outputs(); i++) {
+        mlif_handle_result(mlif_output_ptr(i), mlif_output_size(i));
+      }
+      input_num = 0;
+      remaining = remaining > 0 ? remaining - 1 : 0;
+    } else {
+      input_num++;
+    }
+  }
+}
+
+__attribute__((weak)) bool mlif_request_input(void *model_input_ptr, size_t model_input_sz) {
+  static int num_done = 0;
+  if (num_done == num_data_buffers_in) {
+    static bool run_once = true;
+    if (num_data_buffers_in == 0 && run_once) {
+      // Minimal run. Just run the model without data.
+      run_once = false;
+      return true;
+    }
+    return false;
+  }
+
+  mlif_process_input(data_buffers_in[num_done], data_size_in[num_done], model_input_ptr, model_input_sz);
+  num_done++;
+  return true;
+}
+
+__attribute__((weak)) void mlif_handle_result(void *model_output_ptr, size_t model_output_sz) {
+  static int num_done = 0;
+
+  if (num_data_buffers_out == 0) {
+    return;
+  }
+
+  if (num_done < num_data_buffers_out) {
+    mlif_process_output(model_output_ptr, model_output_sz, data_buffers_out[num_done], data_size_out[num_done]);
+  }
+
+  num_done++;
+}