semihosting: integration with the existing OpenOCD semihosting implementation

* old implementation now is version 0, native OOCD's is verison 1.
* added jobs to run tests for specific IDF version
* refactoring

For openocd's semihosting:
* added a custom read/write fields implementation
* added a custom semihosting->get_filename for a custom implementation

Author: gerekon

.gitignore

@@ -99,3 +99,9 @@ TAGS
 
 # ctags tag files
 tags
+
+#temp file
+*.bak
+*.old
+temp/**
+

.gitlab-ci.yml

@@ -134,12 +134,16 @@ variables:
 .finish_test_app_build: &finish_test_app_build |
   export UT_APP_DIR=$PWD
   mkdir -p $UT_APP_DIR/gcov_data
-  pushd $UT_APP_DIR/builds/gcov_dual
-  find . -type d -exec mkdir -p $UT_APP_DIR/gcov_data/gcov_dual/\{\} \;
-  popd
-  pushd $UT_APP_DIR/builds/gcov_single
-  find . -type d -exec mkdir -p $UT_APP_DIR/gcov_data/gcov_single/\{\} \;
-  popd
+  if [ -d "$UT_APP_DIR/builds/gcov_dual" ]; then
+    pushd $UT_APP_DIR/builds/gcov_dual
+    find . -type d -exec mkdir -p $UT_APP_DIR/gcov_data/gcov_dual/\{\} \;
+    popd
+  fi
+  if [ -d "$UT_APP_DIR/builds/gcov_single" ]; then
+    pushd $UT_APP_DIR/builds/gcov_single
+    find . -type d -exec mkdir -p $UT_APP_DIR/gcov_data/gcov_single/\{\} \;
+    popd
+  fi
   echo "export OPENOCD_GCOV_PREFIX=$UT_APP_DIR/gcov_data" > $UT_APP_DIR/gcov_data/gcov_env.sh
   export PREFIX_STRIP=$(awk -F"/" '{print NF-1}' <<< $UT_APP_DIR/builds)
   echo "export OPENOCD_GCOV_PREFIX_STRIP=$PREFIX_STRIP" >> $UT_APP_DIR/gcov_data/gcov_env.sh
@@ -173,6 +177,19 @@ variables:
     - *finish_test_app_build
     - *prepare_espytrace_package
 
+.do_build_test_app: &do_build_test_app |
+  if [ -z "$TEST_APP_CONFIGS" ]; then
+    echo "Build ALL"
+    $IDF_PATH/tools/idf.py -D IDF_TARGET=esp32 ut-build-all-configs
+  else
+    for cfg_name in $TEST_APP_CONFIGS
+    do
+      echo "Build <${cfg_name}>"
+      $IDF_PATH/tools/idf.py ut-apply-config-$cfg_name
+      $IDF_PATH/tools/idf.py ut-build-$cfg_name
+    done
+  fi
+
 .build_test_app_template: &build_test_app_template
   stage: build
   image: $CI_DOCKER_REGISTRY/esp32-ci-env
@@ -200,7 +217,7 @@ variables:
     # in the image and `export.sh` fails w/o adding tools to $PATH
     - idf_exports=$(${IDF_PATH}/tools/idf_tools.py export) || true
     - eval "${idf_exports}"
-    - $IDF_PATH/tools/idf.py -D IDF_TARGET=esp32 ut-build-all-configs
+    - *do_build_test_app
     - *finish_test_app_build
     - *prepare_espytrace_package
 
@@ -393,14 +410,24 @@ build_test_app:
   <<: *build_test_app_template
   variables:
     BUILD_TEST_APP_DIR: "build_test_app"
+    TEST_APP_CONFIGS: ""
     TEST_APP_IDF_TAG: $CI_COMMIT_REF_NAME
     UT_GET_IDF_VER: "0"
 
 build_test_app_legacy_idf_release:
   <<: *build_legacy_test_app_template
   variables:
     BUILD_TEST_APP_DIR: "build_test_app_legacy_idf_release"
-    TEST_APP_IDF_TAG: "release/v$TEST_APP_LEGACY_IDF_RELEASE_TAG"
+    TEST_APP_CONFIGS: ""
+    TEST_APP_IDF_TAG: "v$TEST_APP_LEGACY_IDF_RELEASE_TAG"
+    UT_GET_IDF_VER: "1"
+
+build_test_app_custom_idf_release:
+  <<: *build_test_app_template
+  variables:
+    BUILD_TEST_APP_DIR: "build_test_app_custom_idf_release"
+    TEST_APP_CONFIGS: "default single_core"
+    TEST_APP_IDF_TAG: "v$TEST_APP_CUSTOM_IDF_RELEASE_TAG"
     UT_GET_IDF_VER: "1"
 
 tests_linux64:
@@ -427,6 +454,19 @@ tests_linux64_legacy_idf_release:
     TEST_RUN_DIR: "build_test_app_legacy_idf_release"
     TEST_RUN_EXTRA_OPTS: "-i $TEST_APP_LEGACY_IDF_RELEASE_TAG -b esp32-wrover-kit-3.3v"
 
+tests_linux64_custom_idf_release:
+  <<: *tests_linux_template
+  tags:
+    - test_jtag
+  dependencies:
+    - build_test_app_custom_idf_release
+    - build_linux
+  variables:
+    PLATFORM_NAME: "linux64"
+    TEST_RUN_DIR: "build_test_app_custom_idf_release"
+    # currently we need to run semihost test on IDF with old semihost driver
+    TEST_RUN_EXTRA_OPTS: "-i $TEST_APP_CUSTOM_IDF_RELEASE_TAG -b esp32-wrover-kit-3.3v -p test_semihost"
+
 tests_armel:
   stage: test
   image: $CI_DOCKER_REGISTRY/rpi-esp-idf-env:1

src/target/Makefile.am

@@ -142,8 +142,10 @@ XTENSA_SRC= \
 	%D%/xtensa_debug_module.c \
 	%D%/xtensa_algorithm.c \
 	%D%/xtensa_mcore.c \
+	%D%/xtensa_semihosting.c \
 	%D%/esp_xtensa.c \
-	%D%/esp_xtensa_apptrace.c
+	%D%/esp_xtensa_apptrace.c \
+	%D%/esp_xtensa_semihosting.c
 
 ESP32_SRC= \
 	%D%/esp32.c \

src/target/esp32.c

@@ -516,7 +516,20 @@ static bool esp32_on_halt(struct target *target)
 	if (ret != ERROR_OK)
 		return false;
 	/* do some stuff generic for ESP Xtensa (semihosting) */
-	return esp_xtensa_on_halt(&xtensa_mcore->cores_targets[xtensa_mcore->active_core]);
+	struct target *active_sub_target = &xtensa_mcore->cores_targets[xtensa_mcore->active_core];
+	ret = esp_xtensa_on_halt(active_sub_target);
+
+	/* semihosting's version syncing */
+	for (size_t i = 0; i < xtensa_mcore->configured_cores_num; i++) {
+		if (i != xtensa_mcore->active_core) {	/* for non-active cores */
+			/* take a core */
+			struct target *sub_target = &xtensa_mcore->cores_targets[i];
+			/* sync version with an active core */
+			target_to_esp_xtensa(sub_target)->semihost.version =
+				target_to_esp_xtensa(active_sub_target)->semihost.version;
+		}
+	}
+	return ret;
 }
 
 static int esp32_virt2phys(struct target *target,
@@ -597,13 +610,19 @@ static int esp32_handle_target_event(struct target *target, enum target_event ev
 static int esp32_target_init(struct command_context *cmd_ctx, struct target *target)
 {
 	struct xtensa_mcore_common *xtensa_mcore = target_to_xtensa_mcore(target);
-
 	int ret = target_register_event_callback(esp32_handle_target_event, target);
 	if (ret != ERROR_OK)
 		return ret;
+
 	ret = xtensa_mcore_target_init(cmd_ctx, target);
 	if (ret != ERROR_OK)
 		return ret;
+
+	for (int i = 0; i < xtensa_mcore->configured_cores_num; i++) {
+		struct target *sub_target = &xtensa_mcore->cores_targets[i];
+		if (esp_xtensa_semihosting_init(sub_target))
+			return ERROR_FAIL;
+	}
 	xtensa_mcore->smp_break = OCDDCR_BREAKINEN|OCDDCR_BREAKOUTEN;
 	return ERROR_OK;
 }

src/target/esp32s2.c

@@ -422,6 +422,11 @@ static int esp32_s2_target_init(struct command_context *cmd_ctx, struct target *
 	int ret = esp_xtensa_target_init(cmd_ctx, target);
 	if (ret != ERROR_OK)
 		return ret;
+
+	ret = esp_xtensa_semihosting_init(target);
+	if (ret != ERROR_OK)
+		return ERROR_FAIL;
+
 	return ERROR_OK;
 }