platform: add support of zephyr

Author: joelguittet

.clang-format-ignore

@@ -13,3 +13,27 @@ tests/mocks/esp-idf/src/esp_http_client.c
 tests/mocks/esp-idf/src/esp_ota_ops.c
 tests/mocks/esp-idf/src/nvs.c
 tests/mocks/freertos/include/FreeRTOSConfig.h
+tests/mocks/zephyr/include/zephyr/device.h
+tests/mocks/zephyr/include/zephyr/dfu/flash_img.h
+tests/mocks/zephyr/include/zephyr/dfu/mcuboot.h
+tests/mocks/zephyr/include/zephyr/drivers/flash.h
+tests/mocks/zephyr/include/zephyr/fs/nvs.h
+tests/mocks/zephyr/include/zephyr/kernel.h
+tests/mocks/zephyr/include/zephyr/logging/log.h
+tests/mocks/zephyr/include/zephyr/net/http/client.h
+tests/mocks/zephyr/include/zephyr/net/net_ip.h
+tests/mocks/zephyr/include/zephyr/net/socket.h
+tests/mocks/zephyr/include/zephyr/net/tls_credentials.h
+tests/mocks/zephyr/include/zephyr/storage/flash_map.h
+tests/mocks/zephyr/include/zephyr/sys/reboot.h
+tests/mocks/zephyr/include/zephyr/sys/util_macro.h
+tests/mocks/zephyr/include/zephyr/sys_clock.h
+tests/mocks/zephyr/src/device.c
+tests/mocks/zephyr/src/flash.c
+tests/mocks/zephyr/src/flash_img.c
+tests/mocks/zephyr/src/http_client.c
+tests/mocks/zephyr/src/kernel.c
+tests/mocks/zephyr/src/mcuboot.c
+tests/mocks/zephyr/src/nvs.c
+tests/mocks/zephyr/src/reboot.c
+tests/mocks/zephyr/src/socket.c

.github/workflows/build_tests.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+# @file      build_tests.sh
+# @brief     Build all tests
+#
+# MIT License
+#
+# Copyright (c) 2022-2023 joelguittet and mender-mcu-client contributors
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+cd tests
+mkdir build
+cd build
+
+# Build ESP-IDF use case
+cmake .. -G "Unix Makefiles" -DCONFIG_MENDER_MCU_CLIENT_BOARD_TYPE="esp-idf" -DCONFIG_MENDER_MCU_CLIENT_HTTP_TYPE="esp-idf" -DCONFIG_MENDER_MCU_CLIENT_RTOS_TYPE="freertos" -DCONFIG_MENDER_MCU_CLIENT_TLS_TYPE="mbedtls"
+make -j$(nproc)
+
+# Build Zephyr use case
+cmake .. -G "Unix Makefiles" -DCONFIG_MENDER_MCU_CLIENT_BOARD_TYPE="zephyr" -DCONFIG_MENDER_MCU_CLIENT_HTTP_TYPE="zephyr" -DCONFIG_MENDER_MCU_CLIENT_RTOS_TYPE="zephyr" -DCONFIG_MENDER_MCU_CLIENT_TLS_TYPE="mbedtls"
+make -j$(nproc)

.github/workflows/ci.yml

@@ -64,14 +64,10 @@ jobs:
         uses: SonarSource/sonarcloud-github-c-cpp@v1
       - name: Run build-wrapper
         run: |
-          cd tests
-          mkdir build
-          cd build
-          cmake .. -G "Unix Makefiles"
-          build-wrapper-linux-x86-64 --out-dir bw_output make -j$(nproc)
+          build-wrapper-linux-x86-64 --out-dir bw_output ./.github/workflows/build_tests.sh
       - name: Run sonar-scanner
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         run: |
-          sonar-scanner -Dsonar.organization=joelguittet -Dsonar.projectKey=joelguittet_mender-mcu-client -Dsonar.cfamily.cache.enabled=false -Dsonar.inclusions=include/**/*,core/**/*,platform/**/* -Dsonar.projectVersion=$(cat VERSION) -Dsonar.cfamily.build-wrapper-output="tests/build/bw_output"
+          sonar-scanner -Dsonar.organization=joelguittet -Dsonar.projectKey=joelguittet_mender-mcu-client -Dsonar.cfamily.cache.enabled=false -Dsonar.inclusions=include/**/*,core/**/*,platform/**/* -Dsonar.projectVersion=$(cat VERSION) -Dsonar.cfamily.build-wrapper-output=bw_output

README.md

@@ -31,7 +31,8 @@ To start using Mender, we recommend that you begin with the Getting started sect
 
 To start using mender-mcu-client, we recommend that you begin with one of the example provided with the library:
 
-* [mender-esp32-example](https://github.com/joelguittet/mender-esp32-example) demonstrates the usage of mender-mcu-client on ESP32 MCU to perform upgrade with dual OTA partitions and rollback capability.
+* [mender-esp32-example](https://github.com/joelguittet/mender-esp32-example) demonstrates the usage of mender-mcu-client on ESP32 MCU to perform upgrade with dual OTA partitions and rollback capability using ESP-IDF framework.
+* [mender-stm32l4a6-zephyr-example](https://github.com/joelguittet/mender-stm32l4a6-zephyr-example) demonstrates the usage of mender-mcu-client on STM32L4A6 MCU to perform upgrade with dual OTA partitions and rollback capability using Zephyr RTOS.
 * More examples will come, and particularly new platforms support will be added soon.
 
 

core/src/mender-untar.c

@@ -30,7 +30,7 @@
 /**
  * @brief tar block size
  */
-#define UNTAR_STREAM_BLOCK_SIZE 512
+#define MENDER_UNTAR_STREAM_BLOCK_SIZE (512)
 
 /**
  * @brief tar file header
@@ -109,12 +109,12 @@ mender_untar_parse(mender_untar_ctx_t *ctx, void *input_data, size_t input_lengt
             return -1;
         }
         ctx->data = tmp;
-        memcpy(ctx->data + ctx->data_length, input_data, input_length);
+        memcpy((void *)(((uint8_t *)ctx->data) + ctx->data_length), input_data, input_length);
         ctx->data_length += input_length;
     }
 
     /* Check if enought data are received */
-    if (ctx->data_length < UNTAR_STREAM_BLOCK_SIZE) {
+    if (ctx->data_length < MENDER_UNTAR_STREAM_BLOCK_SIZE) {
         return 0;
     }
 
@@ -206,8 +206,8 @@ mender_untar_parse_file(mender_untar_ctx_t *ctx, void **output_data, size_t *out
 
     /* Compute length to be copied */
     if (0
-        != (*output_length = ((ctx->current_file.size - ctx->current_file.index) > UNTAR_STREAM_BLOCK_SIZE)
-                                 ? UNTAR_STREAM_BLOCK_SIZE
+        != (*output_length = ((ctx->current_file.size - ctx->current_file.index) > MENDER_UNTAR_STREAM_BLOCK_SIZE)
+                                 ? MENDER_UNTAR_STREAM_BLOCK_SIZE
                                  : (ctx->current_file.size - ctx->current_file.index))) {
 
         /* Create new file data block */
@@ -238,19 +238,19 @@ mender_untar_shift_data(mender_untar_ctx_t *ctx) {
     char *tmp;
 
     /* Shift remaining data */
-    if (ctx->data_length > UNTAR_STREAM_BLOCK_SIZE) {
-        memcpy(ctx->data, ctx->data + UNTAR_STREAM_BLOCK_SIZE, ctx->data_length - UNTAR_STREAM_BLOCK_SIZE);
-        if (NULL == (tmp = realloc(ctx->data, ctx->data_length - UNTAR_STREAM_BLOCK_SIZE))) {
+    if (ctx->data_length > MENDER_UNTAR_STREAM_BLOCK_SIZE) {
+        memcpy(ctx->data, (void *)(((uint8_t *)ctx->data) + MENDER_UNTAR_STREAM_BLOCK_SIZE), ctx->data_length - MENDER_UNTAR_STREAM_BLOCK_SIZE);
+        if (NULL == (tmp = realloc(ctx->data, ctx->data_length - MENDER_UNTAR_STREAM_BLOCK_SIZE))) {
             /* Unable to allocate memory */
             return -1;
         }
         ctx->data = tmp;
-        ctx->data_length -= UNTAR_STREAM_BLOCK_SIZE;
+        ctx->data_length -= MENDER_UNTAR_STREAM_BLOCK_SIZE;
     } else {
         free(ctx->data);
         ctx->data        = NULL;
         ctx->data_length = 0;
     }
 
-    return (ctx->data_length >= UNTAR_STREAM_BLOCK_SIZE) ? 1 : 0;
+    return (ctx->data_length >= MENDER_UNTAR_STREAM_BLOCK_SIZE) ? 1 : 0;
 }

include/mender-rtos.h

@@ -39,7 +39,7 @@
  * @param priority priority of the task
  * @param handle Task handle if the function succeeds, NULL otherwise
  */
-void mender_rtos_task_create(void (*task_function)(void *), char *name, size_t stack_size, void *arg, uint32_t priority, void **handle);
+void mender_rtos_task_create(void (*task_function)(void *), char *name, size_t stack_size, void *arg, int priority, void **handle);
 
 /**
  * @brief Fucntion used to delete a task

include/mender-storage.h

@@ -45,9 +45,9 @@ mender_err_t mender_storage_erase_authentication_keys(void);
 /**
  * @brief Get authentication keys
  * @param private_key Private key from storage, NULL if not found
- * @param private_key_lentgh Private key length from storage, 0 if not found
+ * @param private_key_length Private key length from storage, 0 if not found
  * @param public_key Public key from storage, NULL if not found
- * @param public_key_lentgh Public key length from storage, 0 if not found
+ * @param public_key_length Public key length from storage, 0 if not found
  * @return MENDER_OK if the function succeeds, error code otherwise
  */
 mender_err_t mender_storage_get_authentication_keys(unsigned char **private_key,
@@ -58,19 +58,19 @@ mender_err_t mender_storage_get_authentication_keys(unsigned char **private_key,
 /**
  * @brief Set authentication keys
  * @param private_key Private key to store
- * @param private_key_lentgh Private key length
+ * @param private_key_length Private key length
  * @param public_key Public key to store
- * @param public_key_lentgh Public key length
+ * @param public_key_length Public key length
  * @return MENDER_OK if the function succeeds, error code otherwise
  */
 mender_err_t mender_storage_set_authentication_keys(unsigned char *private_key, size_t private_key_length, unsigned char *public_key, size_t public_key_length);
 
 /**
  * @brief Get OTA deployment
  * @param ota_id OTA ID from storage, NULL if not found
- * @param ota_id_lentgh OTA ID length from storage, 0 if not found
+ * @param ota_id_length OTA ID length from storage, 0 if not found
  * @param ota_artifact_name Artifact name from storage, NULL if not found
- * @param ota_artifact_name_lentgh Artifact name length from storage, 0 if not found
+ * @param ota_artifact_name_length Artifact name length from storage, 0 if not found
  * @return MENDER_OK if the function succeeds, error code otherwise
  */
 mender_err_t mender_storage_get_ota_deployment(char **ota_id, size_t *ota_id_length, char **ota_artifact_name, size_t *ota_artifact_name_length);

platform/board/esp-idf/src/mender-storage.c

@@ -157,13 +157,18 @@ mender_storage_get_ota_deployment(char **ota_id, size_t *ota_id_length, char **o
     if (NULL == (*ota_artifact_name = malloc(*ota_artifact_name_length + 1))) {
         mender_log_error("Unable to allocate memory");
         free(*ota_id);
+        *ota_id = NULL;
         return MENDER_FAIL;
     }
 
     /* Read ID and artifact name */
     if ((ESP_OK != nvs_get_str(mender_storage_nvs_handle, MENDER_STORAGE_NVS_OTA_ID, *ota_id, ota_id_length))
         || (ESP_OK != nvs_get_str(mender_storage_nvs_handle, MENDER_STORAGE_NVS_OTA_ARTIFACT_NAME, *ota_artifact_name, ota_artifact_name_length))) {
         mender_log_error("Unable to read OTA ID or artifact name");
+        free(*ota_id);
+        *ota_id = NULL;
+        free(*ota_artifact_name);
+        *ota_artifact_name = NULL;
         return MENDER_FAIL;
     }
 

platform/board/zephyr/src/mender-log.c

@@ -0,0 +1,76 @@
+/**
+ * @file      mender-log.c
+ * @brief     Mender logging interface for Zephyr platform
+ *
+ * MIT License
+ *
+ * Copyright (c) 2022-2023 joelguittet and mender-mcu-client contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_REGISTER(mender, CONFIG_MENDER_LOG_LEVEL);
+
+#include "mender-log.h"
+
+mender_err_t
+mender_log_init(void) {
+
+    /* Nothing to do */
+    return MENDER_OK;
+}
+
+mender_err_t
+mender_log_print(mender_log_level_t level, const char *filename, const char *function, int line, char *format, ...) {
+
+    (void)function;
+    char log[256] = { 0 };
+
+    /* Format message */
+    va_list args;
+    va_start(args, format);
+    vsnprintf(log, sizeof(log), format, args);
+    va_end(args);
+
+    /* Switch depending log level */
+    switch (level) {
+        case MENDER_LOG_ERROR:
+            LOG_ERR("%s (%d): %s", filename, line, log);
+            break;
+        case MENDER_LOG_WARNING:
+            LOG_WRN("%s (%d): %s", filename, line, log);
+            break;
+        case MENDER_LOG_INFO:
+            LOG_INF("%s (%d): %s", filename, line, log);
+            break;
+        case MENDER_LOG_DEBUG:
+            LOG_DBG("%s (%d): %s", filename, line, log);
+            break;
+    }
+
+    return MENDER_OK;
+}
+
+mender_err_t
+mender_log_exit(void) {
+
+    /* Nothing to do */
+    return MENDER_OK;
+}