Merge branch 'fix/remove_printf' into 'staging'

Clean-up host side logging

See merge request app-frameworks/esp_hosted_mcu!149

Author: mantriyogesh

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.6.8
+
+### Bug Fixes
+- Clean up ESP-Hosted prints at host
+
 ## 2.6.7
 
 ### Features

Kconfig

@@ -1572,6 +1572,14 @@ ESP32XX_SPI_HD_CLK_FREQ_RANGE_MAX := 40
 
 	menu "Debug Settings"
 
+		config ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
+			bool "Suppress firmware version mismatch warnings"
+			default n
+			help
+				Suppress warnings when host and co-processor firmware versions do not match.
+				By default, version mismatch warnings are shown during initialization.
+				Enable this option to suppress these warnings.
+
 		config ESP_HOSTED_RAW_THROUGHPUT_TRANSPORT
 			bool "RawTP: Transport level throughput debug test"
 			default n

examples/host_performs_slave_ota/main/main.c

@@ -47,18 +47,17 @@ static int compare_self_version_with_slave_version(uint32_t slave_version)
         return 0;
     } else if (host_version > slave_version) {
         // host version > slave version
-        ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
-        printf("Version on Host is NEWER than version on co-processor\n");
-        printf("RPC requests sent by host may encounter timeout errors\n");
-        printf("or may not be supported by co-processor\n");
-        ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
+#ifndef CONFIG_ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
+        ESP_LOGW(TAG, "Version mismatch: Host [%u.%u.%u] > Co-proc [%u.%u.%u] ==> Upgrade co-proc to avoid RPC timeouts",
+            ESP_HOSTED_VERSION_PRINTF_ARGS(host_version), ESP_HOSTED_VERSION_PRINTF_ARGS(slave_version));
+#endif
         return -1;
     } else {
         // host version < slave version
-        ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
-        printf("Version on Host is OLDER than version on co-processor\n");
-        printf("Host may not be compatible with co-processor\n");
-        ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
+#ifndef CONFIG_ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
+        ESP_LOGW(TAG, "Version mismatch: Host [%u.%u.%u] < Co-proc [%u.%u.%u] ==> Upgrade host to avoid compatibility issues",
+            ESP_HOSTED_VERSION_PRINTF_ARGS(host_version), ESP_HOSTED_VERSION_PRINTF_ARGS(slave_version));
+#endif
         return 1;
     }
 }

host/drivers/transport/transport_drv.c

@@ -359,7 +359,7 @@ transport_channel_t *transport_drv_add_channel(void *api_chan,
 	assert(channel->memp);
 #endif
 
-	ESP_LOGI(TAG, "Add ESP-Hosted channel IF[%u]: S[%u] Tx[%p] Rx[%p]",
+	ESP_LOGD(TAG, "Add ESP-Hosted channel IF[%u]: S[%u] Tx[%p] Rx[%p]",
 			if_type, secure, *tx, rx);
 
 	return channel;
@@ -569,18 +569,17 @@ static int compare_fw_version(uint32_t slave_version)
 		return 0;
 	} else if (host_version > slave_version) {
 	    // host version > slave version
-		ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
-		printf("Version on Host is NEWER than version on co-processor\n");
-		printf("RPC requests sent by host may encounter timeout errors\n");
-		printf("or may not be supported by co-processor\n");
-		ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
+#ifndef CONFIG_ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
+		ESP_LOGW(TAG, "Version mismatch: Host [%u.%u.%u] > Co-proc [%u.%u.%u] ==> Upgrade co-proc to avoid RPC timeouts",
+			ESP_HOSTED_VERSION_PRINTF_ARGS(host_version), ESP_HOSTED_VERSION_PRINTF_ARGS(slave_version));
+#endif
 		return -1;
 	} else {
 	    // host version < slave version
-		ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
-		printf("Version on Host is OLDER than version on co-processor\n");
-		printf("Host may not be compatible with co-processor\n");
-		ESP_LOGW(TAG, "=== ESP-Hosted Version Warning ===");
+#ifndef CONFIG_ESP_HOSTED_FW_VERSION_MISMATCH_WARNING_SUPPRESS
+		ESP_LOGW(TAG, "Version mismatch: Host [%u.%u.%u] < Co-proc [%u.%u.%u] ==> Upgrade host to avoid compatibility issues",
+			ESP_HOSTED_VERSION_PRINTF_ARGS(host_version), ESP_HOSTED_VERSION_PRINTF_ARGS(slave_version));
+#endif
 		return 1;
 	}
 }

host/esp_hosted_host_fw_ver.h

@@ -15,11 +15,24 @@
 
 #define ESP_HOSTED_VERSION_MAJOR_1 2
 #define ESP_HOSTED_VERSION_MINOR_1 6
-#define ESP_HOSTED_VERSION_PATCH_1 7
+#define ESP_HOSTED_VERSION_PATCH_1 8
 
 /**
  * Macro to convert version number into an integer
  */
 #define ESP_HOSTED_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch))
 
+/* Extract version components from version value */
+#define ESP_HOSTED_VERSION_MAJOR(ver) (((ver) >> 16) & 0xFF)
+#define ESP_HOSTED_VERSION_MINOR(ver) (((ver) >> 8) & 0xFF)
+#define ESP_HOSTED_VERSION_PATCH(ver) ((ver) & 0xFF)
+
+/* Format version tuple for printing */
+#define ESP_HOSTED_VERSION_PRINTF_ARGS(ver) \
+	ESP_HOSTED_VERSION_MAJOR(ver), \
+	ESP_HOSTED_VERSION_MINOR(ver), \
+	ESP_HOSTED_VERSION_PATCH(ver)
+
+#define ESP_HOSTED_VERSION_PRINTF_FMT "%u.%u.%u"
+
 #endif

host/port/esp/freertos/include/port_esp_hosted_host_os.h

@@ -115,7 +115,7 @@ enum hardware_type_e {
 #define MILLISEC_TO_MICROSEC(x) (1000*(x))
 
 #define MEM_DUMP(s) \
-	printf("%s free:%lu min-free:%lu lfb-def:%u lfb-8bit:%u\n\n", s,	\
+	ESP_LOGD(TAG, "%s free:%lu min-free:%lu lfb-def:%u lfb-8bit:%u", s,	\
 			(unsigned long int)esp_get_free_heap_size(), (unsigned long int)esp_get_minimum_free_heap_size(), \
 			heap_caps_get_largest_free_block(MALLOC_CAP_DEFAULT),		\
 			heap_caps_get_largest_free_block(MALLOC_CAP_8BIT))
@@ -125,7 +125,7 @@ enum hardware_type_e {
 #define HOSTED_CREATE_HANDLE(tYPE, hANDLE) {                                   \
 	hANDLE = (tYPE *)g_h.funcs->_h_malloc(sizeof(tYPE));                       \
 	if (!hANDLE) {                                                             \
-		printf("%s:%u Mem alloc fail while create handle\n", __func__,__LINE__); \
+		ESP_LOGE(TAG, "%s:%u Mem alloc fail while create handle", __func__,__LINE__); \
 		return NULL;                                                           \
 	}                                                                          \
 }
@@ -142,15 +142,15 @@ enum hardware_type_e {
 #define HOSTED_CALLOC(struct_name, buff, nbytes, gotosym) do {    \
 	buff = (struct_name *)g_h.funcs->_h_calloc(1, nbytes);	  \
 	if (!buff) {                                                  \
-		printf("%s, Failed to allocate memory \n", __func__);     \
+		ESP_LOGE(TAG, "%s, Failed to allocate memory", __func__);     \
 		goto gotosym;                                             \
 	}                                                             \
 } while(0);
 
 #define HOSTED_MALLOC(struct_name, buff, nbytes, gotosym) do {    \
 	buff = (struct_name *)g_h.funcs->_h_malloc(nbytes);		  \
 	if (!buff) {                                                  \
-		printf("%s, Failed to allocate memory \n", __func__);     \
+		ESP_LOGE(TAG, "%s, Failed to allocate memory", __func__);     \
 		goto gotosym;                                             \
 	}                                                             \
 } while(0);

host/port/esp/freertos/src/port_esp_hosted_host_os.c

@@ -796,7 +796,8 @@ void hosted_log_write(int  level,
 {
 	va_list list;
 	va_start(list, format);
-	printf(format, list);
+	/* Use ESP-IDF logging system with proper level and tag */
+	esp_log_writev((esp_log_level_t)level, tag, format, list);
 	va_end(list);
 }
 

idf_component.yml

@@ -1,4 +1,4 @@
-version: "2.6.7"
+version: "2.6.8"
 description: ESP-Hosted-MCU provide drivers to act any ESP chipset as Wi-Fi or Bluetooth co-processor.
 url: https://github.com/espressif/esp-hosted-mcu
 examples:

slave/main/esp_hosted_coprocessor_fw_ver.h

@@ -15,7 +15,7 @@
 
 #define PROJECT_VERSION_MAJOR_1 2
 #define PROJECT_VERSION_MINOR_1 6
-#define PROJECT_VERSION_PATCH_1 7
+#define PROJECT_VERSION_PATCH_1 8
 
 /**
  * Macro to convert version number into an integer

tools/check_fw_versions.py

@@ -118,6 +118,19 @@ def write_host_footer(file_info):
 	file_info.write(" */\n")
 	file_info.write("#define ESP_HOSTED_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch))\n")
 	file_info.write("\n")
+	file_info.write("/* Extract version components from version value */\n")
+	file_info.write("#define ESP_HOSTED_VERSION_MAJOR(ver) (((ver) >> 16) & 0xFF)\n")
+	file_info.write("#define ESP_HOSTED_VERSION_MINOR(ver) (((ver) >> 8) & 0xFF)\n")
+	file_info.write("#define ESP_HOSTED_VERSION_PATCH(ver) ((ver) & 0xFF)\n")
+	file_info.write("\n")
+	file_info.write("/* Format version tuple for printing */\n")
+	file_info.write("#define ESP_HOSTED_VERSION_PRINTF_ARGS(ver) \\\n")
+	file_info.write("\tESP_HOSTED_VERSION_MAJOR(ver), \\\n")
+	file_info.write("\tESP_HOSTED_VERSION_MINOR(ver), \\\n")
+	file_info.write("\tESP_HOSTED_VERSION_PATCH(ver)\n")
+	file_info.write("\n")
+	file_info.write("#define ESP_HOSTED_VERSION_PRINTF_FMT \"%u.%u.%u\"\n")
+	file_info.write("\n")
 
 def set_coprocessor_version(version: tuple) -> int:
 	# write the coprocessor file