[VSC-1604 | VSC-1606 | VSC-1624] use idf py qemu Allow qemu debug monitor

docs_espressif/en/additionalfeatures/qemu.rst

@@ -3,7 +3,9 @@
 ESP-IDF QEMU Integration with Visual Studio Code
 ===================================================
 
-When you create a project using this extension commands, there is Dockerfile which can be used with the `Microsoft Remote Containers Extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>`_. You can open any project inside a container with the **Remote Containers: Open Folder in Container..** command. Besides including an already configured setup for ESP-IDF and tools (this is based on the ESP-IDF docker image), a fork of `Espressif QEMU fork <https://github.com/espressif/qemu>`_ for Espressif devices is included, which can be used for emulated development.
+When you create a project using this extension commands, there is Dockerfile which can be used with the `Microsoft Remote Containers Extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>`_. You can open any project inside a container with the **Remote Containers: Open Folder in Container..** command. 
+
+ESP-IDF setup can include a fork of `Espressif QEMU fork <https://github.com/espressif/qemu>`_ for Espressif devices, which can be used for emulated development. You can make sure is installed it by running ``python $IDF_PATH/tools/idf_tools.py install qemu-xtensa qemu-riscv32`` in the **ESP-IDF: Open ESP-IDF Terminal** terminal.
 
 .. note::
   * The **ESP-IDF: Add Docker Container Configuration** command can be used to add these files to the current project directory.
@@ -18,8 +20,14 @@ Development steps:
 4. The extension should be self configured, otherwise run the setup wizard.
 5. Write your code and build the project with the **ESP-IDF: Build your Project** command.
 6. Use the **ESP-IDF: Launch QEMU Server** command or the **[QEMU Server]** link in the activity bar to launch QEMU with the binaries from the build directory.
-7. You can use the **ESP-IDF: Monitor QEMU Device** command to launch a terminal running IDF Monitor on QEMU. This extension uses the **idf.qemuTcpPort** configuration setting for the serial monitor in QEMU.
+7. You can use the **ESP-IDF: Monitor QEMU Device** command to launch a terminal running IDF Monitor on QEMU.
 8. If you want to launch a QEMU debug session, use the **ESP-IDF: Launch QEMU Debug Session** commmand, which will stop any existing QEMU server and launch a new QEMU server for debugging.
 
+You can use the ``idf.qemuDebugMonitor`` configuration setting to enable the monitor to start after QEMU debug session is launched. If you want to pass additional arguments ``idf.qemuExtraArgs`` configuration setting can be used.
+
+An example of ``"idf.qemuExtraArgs": ["--qemu-extra-args"]`` can be used to pass additional arguments to QEMU directly while ``--flash-file`` or ``--efuse-file`` are idf.py specific arguments as described in **ESP-IDF QEMU Emulator** documentation below.
+
+More information about how to use in `ESP-IDF QEMU Emulator <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/qemu.html>`_.
+
 .. note::
-  Using QEMU is not limited to a docker container, basically the extension assumes that ``qemu-system-xtensa`` or ``qemu-system-riscv32`` is available in the environment variable PATH for the **ESP-IDF: Launch QEMU Server** command and that a QEMU server is running for **ESP-IDF: Monitor QEMU Device** and **ESP-IDF: Launch QEMU Debug Session**.
+  The extension assumes that ``qemu-system-xtensa`` or ``qemu-system-riscv32`` is available in the environment variable PATH to run **ESP-IDF: Monitor QEMU Device** and **ESP-IDF: Launch QEMU Debug Session**.

docs_espressif/en/settings.rst

@@ -229,8 +229,10 @@ QEMU Specific Settings
 
     * - Setting ID
       - Description
-    * - **idf.qemuTcpPort**
-      - QEMU TCP port for serial communication
+    * - **idf.qemuDebugMonitor**
+      - Enable QEMU Monitor on debug session
+    * - **idf.qemuExtraArgs**
+      - QEMU extra arguments
 
 
 Log Tracing Specific Settings

docs_espressif/zh_CN/settings.rst

@@ -229,8 +229,10 @@ QEMU 相关设置
 
     * - 设置 ID
       - 描述
-    * - **idf.qemuTcpPort**
-      - QEMU 用于串行通信的 TCP 端口
+    * - **idf.qemuDebugMonitor**
+      - 在调试会话中启用 QEMU 显示器
+    * - **idf.qemuExtraArgs**
+      - QEMU 额外的论点
 
 
 日志追踪相关设置

package.json

@@ -980,11 +980,17 @@
             "scope": "window",
             "default": true
           },
-          "idf.qemuTcpPort": {
-            "type": "number",
-            "description": "%param.qemuTcpPort%",
+          "idf.qemuDebugMonitor": {
+            "type": "boolean",
+            "description": "%param.qemuDebugMonitor%",
+            "scope": "resource",
+            "default": true
+          },
+          "idf.qemuExtraArgs": {
+            "type": "array",
+            "description": "%param.qemuExtraArgs%",
             "scope": "resource",
-            "default": 5555
+            "default": []
           },
           "esp.component-manager.url": {
             "type": "string",

package.nls.es.json

@@ -148,7 +148,8 @@
 	"param.preBuildTask": "Tarea personalizada previa a la construcción",
 	"param.preFlashTask": "Tarea personalizada previa al flasheo",
 	"param.pythonBinPath": "Ruta absoluta del binario Python utilizado para ejecutar Scripts de Python de ESP-IDF",
-	"param.qemuTcpPort": "Puerto tcp de QEMU para comunicación serial",
+	"param.qemuDebugMonitor": "Habilitar el monitor QEMU en la sesión de depuración",
+	"param.qemuExtraArgs": "Argumentos adicionales QEMU",
 	"param.rainmaker.api.server_url": "URL del servidor en la nube de ESP-Rainmaker",
 	"param.saveBeforeBuildDescription": "Guardar todos los archivos editados en el espacio de trabajo antes de proceder con la construcción, aunque si no se pueden guardar los archivos, se construirá de todos modos",
 	"param.saveScope": "Dónde guardar la configuración con comandos ESP-IDF con valor numérico como vscode.ConfigurationTarget. Global = 1, Espacio de trabajo = 2, Carpeta de espacio de trabajo = 3",

package.nls.json

@@ -148,7 +148,8 @@
   "param.preBuildTask": "Pre build custom task",
   "param.preFlashTask": "Pre flash custom task",
   "param.pythonBinPath": "Python absolute binary path used to execute ESP-IDF Python scripts",
-  "param.qemuTcpPort": "QEMU TCP port for serial communication",
+  "param.qemuDebugMonitor": "Enable QEMU Monitor on debug session",
+	"param.qemuExtraArgs": "QEMU extra arguments",
   "param.rainmaker.api.server_url": "ESP-Rainmaker cloud server URL",
   "param.saveBeforeBuildDescription": "Save all edited files in the workspace before proceeding with the build. If saving fails, the build will proceed regardless",
   "param.saveScope": "Specify where to save the configuration for ESP-IDF commands. Global, Workspace or WorkspaceFolder",

package.nls.pt.json

@@ -148,7 +148,8 @@
 	"param.preBuildTask": "Tarefa personalizada de pré-construção",
 	"param.preFlashTask": "Tarefa personalizada pré-flash",
 	"param.pythonBinPath": "Caminho binário absoluto do Python usado para executar scripts Python ESP-IDF",
-	"param.qemuTcpPort": "Porta tcp QEMU para comunicação serial",
+	"param.qemuDebugMonitor": "Ativar monitor Qemu na sessão de depuração",
+	"param.qemuExtraArgs": "Qemu argumentos extras",
 	"param.rainmaker.api.server_url": "URL do servidor em nuvem ESP-Rainmaker",
 	"param.saveBeforeBuildDescription": "Salve todos os arquivos editados na área de trabalho antes de prosseguir com a compilação, embora se não conseguir salvar os arquivos, a compilação será de qualquer maneira",
 	"param.saveScope": "Onde salvar a configuração com comandos ESP-IDF com valor numérico como vscode.ConfigurationTarget. ",

package.nls.ru.json

@@ -148,7 +148,8 @@
 	"param.preBuildTask": "Пользовательская задача перед сборкой",
 	"param.preFlashTask": "Пользовательская задача перед прошивкой",
 	"param.pythonBinPath": "Абсолютный путь до бинарника Python, используемый для выполнения скриптов Python ESP-IDF",
-	"param.qemuTcpPort": "TCP-порт QEMU для последовательной связи",
+	"param.qemuDebugMonitor": "Включить монитор QEMU на сеанс отладки",
+	"param.qemuExtraArgs": "Qemu дополнительные аргументы",
 	"param.rainmaker.api.server_url": "URL-адрес облачного сервера ESP-Rainmaker",
 	"param.saveBeforeBuildDescription": "Сохранять все изменённые файлы в рабочей области перед сборкой. Если файлы не удастся сохранить, сборка все равно будет выполнена",
 	"param.saveScope": "Место хранения конфигурации для команд ESP-IDF. Global, Workspace или WorkspaceFolder",

package.nls.zh-CN.json

@@ -148,7 +148,8 @@
 	"param.preBuildTask": "构建前的自定义任务",
 	"param.preFlashTask": "烧录前的自定义任务",
 	"param.pythonBinPath": "用于执行 ESP-IDF Python 脚本的 Python 绝对路径",
-	"param.qemuTcpPort": "QEMU 用于串行通信的 TCP 端口",
+	"param.qemuDebugMonitor": "在调试会话中启用 QEMU 显示器",
+	"param.qemuExtraArgs": "QEMU 额外的论点",
 	"param.rainmaker.api.server_url": "ESP-Rainmaker 云服务器 URL",
 	"param.saveBeforeBuildDescription": "在继续构建之前保存工作区中的所有编辑文件（若未能保存文件，构建仍将继续）",
 	"param.saveScope": "指定 ESP-IDF 命令的配置作用域，Global = 1，Workspace = 2，WorkspaceFolder = 3",

src/build/buildCmd.ts

@@ -86,15 +86,6 @@ export async function buildCommand(
         await TaskManager.runTasks();
       }
     }
-    const buildDirPath = readParameter(
-      "idf.buildPath",
-      workspace
-    ) as string;
-    const qemuBinPath = join(buildDirPath, "merged_qemu.bin");
-    const qemuBinExists = await pathExists(qemuBinPath);
-    if (qemuBinExists) {
-      await vscode.workspace.fs.delete(vscode.Uri.file(qemuBinPath));
-    }
     if (!cancelToken.isCancellationRequested) {
       updateIdfComponentsTree(workspace);
       Logger.infoNotify("Build Successfully");

src/extension.ts

@@ -115,7 +115,6 @@ import { KconfigLangClient } from "./kconfig";
 import { configureProjectWithGcov } from "./coverage/configureProject";
 import { ComponentManagerUIPanel } from "./component-manager/panel";
 import { verifyAppBinary } from "./espIdf/debugAdapter/verifyApp";
-import { mergeFlashBinaries } from "./qemu/mergeFlashBin";
 import { QemuLaunchMode, QemuManager } from "./qemu/qemuManager";
 import {
   PartitionItem,
@@ -377,37 +376,8 @@ export async function activate(context: vscode.ExtensionContext) {
     } else {
       UpdateCmakeLists.updateSrcsInCmakeLists(e.fsPath, srcOp.other);
     }
-    await binTimestampEventFunc(e);
   });
   context.subscriptions.push(srcWatchOnChangeDisposable);
-
-  const buildWatcher = vscode.workspace.createFileSystemWatcher(
-    "**/.bin_timestamp",
-    false,
-    false,
-    true
-  );
-
-  const binTimestampEventFunc = async (e: vscode.Uri) => {
-    const buildDirPath = idfConf.readParameter(
-      "idf.buildPath",
-      workspaceRoot
-    ) as string;
-    const qemuBinPath = path.join(buildDirPath, "merged_qemu.bin");
-    const qemuBinExists = await pathExists(qemuBinPath);
-    if (qemuBinExists) {
-      await vscode.workspace.fs.delete(vscode.Uri.file(qemuBinPath));
-    }
-  };
-
-  const buildWatcherDisposable = buildWatcher.onDidChange(
-    binTimestampEventFunc
-  );
-  context.subscriptions.push(buildWatcherDisposable);
-  const buildWatcherCreateDisposable = buildWatcher.onDidCreate(
-    binTimestampEventFunc
-  );
-  context.subscriptions.push(buildWatcherCreateDisposable);
   context.subscriptions.push(
     vscode.workspace.onDidChangeWorkspaceFolders(async (e) => {
       if (PreCheck.isWorkspaceFolderOpen()) {
@@ -2483,20 +2453,6 @@ export async function activate(context: vscode.ExtensionContext) {
           cancelToken: vscode.CancellationToken
         ) => {
           try {
-            const buildDir = idfConf.readParameter(
-              "idf.buildPath",
-              workspaceRoot
-            ) as string;
-            const qemuBinExists = await pathExists(
-              path.join(buildDir, "merged_qemu.bin")
-            );
-            if (!qemuBinExists) {
-              progress.report({
-                message: vscode.l10n.t("Merging binaries for flashing"),
-                increment: 10,
-              });
-              await mergeFlashBinaries(workspaceRoot, cancelToken);
-            }
             await qemuManager.commandHandler();
           } catch (error) {
             const msg = error.message
@@ -2531,24 +2487,18 @@ export async function activate(context: vscode.ExtensionContext) {
           cancelToken: vscode.CancellationToken
         ) => {
           try {
-            if (IDFMonitor.terminal) {
-              IDFMonitor.terminal.sendText(ESP.CTRL_RBRACKET);
-            }
-            const buildDirPath = idfConf.readParameter(
-              "idf.buildPath",
-              workspaceRoot
-            ) as string;
-            const qemuBinExists = await pathExists(
-              path.join(buildDirPath, "merged_qemu.bin")
-            );
-            if (!qemuBinExists) {
-              await mergeFlashBinaries(workspaceRoot);
-            }
             if (qemuManager.isRunning()) {
               qemuManager.stop();
               await utils.sleep(1000);
             }
-            await qemuManager.start(QemuLaunchMode.Debug, workspaceRoot);
+            const monitorAfterDebug = idfConf.readParameter(
+              "idf.qemuDebugMonitor",
+              workspaceRoot
+            ) as boolean;
+            let qemuMode = monitorAfterDebug
+              ? QemuLaunchMode.DebugMonitor
+              : QemuLaunchMode.Debug;
+            await qemuManager.start(qemuMode, workspaceRoot);
             const gdbPath = await utils.getToolchainPath(workspaceRoot, "gdb");
             const workspaceFolder = vscode.workspace.getWorkspaceFolder(
               workspaceRoot
@@ -2568,7 +2518,7 @@ export async function activate(context: vscode.ExtensionContext) {
               target: {
                 type: "remote",
                 host: "localhost",
-                port: "1234",
+                port: "3333",
               },
             });
             vscode.debug.onDidTerminateDebugSession(async (session) => {
@@ -4086,30 +4036,7 @@ function createQemuMonitor() {
           if (isQemuLaunched) {
             qemuManager.stop();
           }
-          const buildDirPath = idfConf.readParameter(
-            "idf.buildPath",
-            workspaceRoot
-          ) as string;
-          const qemuBinExists = await pathExists(
-            path.join(buildDirPath, "merged_qemu.bin")
-          );
-          if (!qemuBinExists) {
-            await mergeFlashBinaries(workspaceRoot);
-          }
-          const qemuTcpPort = idfConf.readParameter(
-            "idf.qemuTcpPort",
-            workspaceRoot
-          ) as string;
           await qemuManager.start(QemuLaunchMode.Monitor, workspaceRoot);
-          if (IDFMonitor.terminal) {
-            await utils.sleep(1000);
-          }
-          const serialPort = `socket://localhost:${qemuTcpPort}`;
-          const noReset = idfConf.readParameter(
-            "idf.monitorNoReset",
-            workspaceRoot
-          ) as boolean;
-          await createNewIdfMonitor(workspaceRoot, noReset, serialPort);
         } catch (error) {
           const msg = error.message
             ? error.message