feat: error codes as a list

Author: antmak

include/esp-stub-lib/err.h

@@ -6,7 +6,19 @@
 
 #pragma once
 
-typedef int stub_lib_err_t;
+// Limit error code range for stub-lib
+#define STUB_LIB_ERR_END                            0x100000
 
-#define STUB_LIB_OK         0       // stub_lib_err_t value indicating success (no error)
-#define STUB_LIB_FAIL       -1      // Generic stub_lib_err_t code indicating failure
+#define STUB_LIB_ERROR_CODE_LIST \
+    X(STUB_LIB_OK,                                  0,                              "Operation esp-stub-lib success") \
+    X(STUB_LIB_FAIL,                                (STUB_LIB_ERR_END - 1),         "Generic esp-stub-lib failure") \
+    \
+    X(STUB_LIB_ERR_FLASH_INIT_UNKNOWN_FLASH_ID,     0x1000,                         "Unknown flash size, unknown flash id") \
+
+// Only numerical values, used in esp-stub-lib sources
+
+#define X(code_, value_, info_) code_ = value_,
+typedef enum stub_lib_err_codes {
+    STUB_LIB_ERROR_CODE_LIST
+} stub_lib_err_t;
+#undef X

src/flash.c

@@ -16,8 +16,7 @@ stub_lib_err_t stub_lib_flash_init(void **state)
     uint32_t flash_id = stub_target_flash_get_flash_id();
     uint32_t flash_size = stub_target_flash_id_to_flash_size(flash_id);
     if (flash_size == 0) {
-        STUB_LOGE("Invalid flash size: 0\n");
-        return STUB_LIB_FAIL;
+        return STUB_LIB_ERR_FLASH_INIT_UNKNOWN_FLASH_ID;
     }
     STUB_LOG_TRACEF("Flash size: %d MB\n", flash_size / (1024 * 1024));
 

src/target/common/src/flash.c

@@ -45,6 +45,6 @@ uint32_t stub_target_flash_id_to_flash_size(uint32_t flash_id)
         return 32 * 1024 * 1024;
     }
 
-    STUB_LOGE("Unknown flash_id: 0x%x", flash_id);
+    STUB_LOGE("Unknown flash_id: 0x%x\n", flash_id);
     return 0;
 }