IEP-1613 Encrypted Flash: regular flash command is not separated from encrypted-flash command

bundles/com.espressif.idf.core/OSGI-INF/l10n/bundle.properties

@@ -7,3 +7,4 @@ openocd_scripts = OPENOCD_SCRIPTS represents the value specified in environment
 jtag_flash_args = JTAG_FLASH_ARGS dynamically converts ${JTAG_FLASH_ARGS} into a command line with -c and -f options. These options are generated based on the current launch target, configuring settings like flash voltage and specifying configuration files for the JTAG interface and target device.
 gdb_client_executable = GDB_CLIENT_EXECUTABLE is a dynamic variable that is replaced during the debug session with the appropriate toolchain path automatically based on the selected target.
 serial_port = serial_port is a dynamic variable that is replaced by the serial port specified in the launch target
+flash_command = Specifies which idf.py flash command should be executed, depending on whether flash encryption is enabled (e.g., "flash" or "encrypted-flash").

bundles/com.espressif.idf.core/plugin.xml

@@ -275,5 +275,10 @@ config-only component and an interface library is created instead."
            name="serial_port"
            resolver="com.espressif.idf.core.variable.UartVariableResolver">
      </variable>
+     <variable
+           description="%flash_command"
+           name="flash_command"
+           resolver="com.espressif.idf.core.variable.UartVariableResolver">
+     </variable>
   </extension>
 </plugin>

bundles/com.espressif.idf.core/src/com/espressif/idf/core/IDFConstants.java

@@ -39,22 +39,22 @@ public interface IDFConstants
 	 * idf python file
 	 */
 	String IDF_PYTHON_SCRIPT = "idf.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf.py list targets
 	 */
-	String IDF_LIST_TARGETS_CMD = "--list-targets";  //$NON-NLS-1$
-	
+	String IDF_LIST_TARGETS_CMD = "--list-targets"; //$NON-NLS-1$
+
 	/**
 	 * idf_monitor python file
 	 */
 	String IDF_MONITOR_PYTHON_SCRIPT = "idf_monitor.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf sysviewtrace_proc script file
 	 */
 	String IDF_SYSVIEW_TRACE_SCRIPT = "sysviewtrace_proc.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf app_trace_folder
 	 */
@@ -64,17 +64,17 @@ public interface IDFConstants
 	 * idf tools file
 	 */
 	String IDF_TOOLS_SCRIPT = "idf_tools.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf_monitor.py
 	 */
 	String IDF_MONITOR_SCRIPT = "idf_monitor.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf size file
 	 */
 	String IDF_SIZE_SCRIPT = "idf_size.py"; //$NON-NLS-1$
-	
+
 	/**
 	 * idf tools.json file for installable tools
 	 */
@@ -84,9 +84,11 @@ public interface IDFConstants
 	 * <IDF_PATH>/tools
 	 */
 	String TOOLS_FOLDER = "tools"; //$NON-NLS-1$
-	
+
 	String FLASH_CMD = "flash"; //$NON-NLS-1$
 
+	String FLASH_ENCRYPTED_CMD = "encrypted-flash"; //$NON-NLS-1$
+
 	/**
 	 * <IDF_PATH>/tools/cmake
 	 */
@@ -106,7 +108,7 @@ public interface IDFConstants
 	 * Json config menu file name
 	 */
 	String KCONFIG_MENUS_JSON = "kconfig_menus.json"; //$NON-NLS-1$
-	
+
 	/**
 	 * sdk config json file
 	 */
@@ -130,28 +132,28 @@ public interface IDFConstants
 	String TOOLS_INSTALL_CMD = "install"; //$NON-NLS-1$
 
 	String TOOLS_INSTALL_ALL_CMD = "all"; //$NON-NLS-1$
-	
+
 	String TOOLS_INSTALL_PYTHON_CMD = "install-python-env"; //$NON-NLS-1$
-	
+
 	String TOOLS_LIST_CMD = "list"; //$NON-NLS-1$
 
 	String TOOLS_EXPORT_FORMAT_KEYVALUE = "key-value"; //$NON-NLS-1$
 
 	String TOOLS_EXPORT_CMD_FORMAT = "--format"; //$NON-NLS-1$
 
 	String TOOLS_EXPORT_CMD_FORMAT_VAL = TOOLS_EXPORT_CMD_FORMAT + "=" + TOOLS_EXPORT_FORMAT_KEYVALUE; //$NON-NLS-1$
-	
+
 	String PYTHON_CMD = "python"; //$NON-NLS-1$
-	
+
 	String PYTHON3_CMD = "python3"; //$NON-NLS-1$
 
 	/**
 	 * <IDF_PATH>/components
 	 */
 	String COMPONENTS_FOLDER = "components"; //$NON-NLS-1$
-	
+
 	String ESP_CORE_DUMP_FOLDER = "espcoredump"; //$NON-NLS-1$
-	
+
 	String ESP_CORE_DUMP_SCRIPT = "espcoredump.py"; //$NON-NLS-1$
 
 	/**
@@ -172,13 +174,13 @@ public interface IDFConstants
 	String ESP_TOOL_CHIP_ID_CMD = "chip_id"; //$NON-NLS-1$
 
 	String ESP_TOOL_ERASE_FLASH_CMD = "erase_flash"; //$NON-NLS-1$
-	
+
 	String ESP_WRITE_FLASH_CMD = "write_flash"; //$NON-NLS-1$
 
 	/**
 	 * Property to store project custom build directory
 	 */
 	String BUILD_DIR_PROPERTY = "idf.buildDirectory.property"; //$NON-NLS-1$
-	
+
 	String PROECT_DESCRIPTION_JSON = "project_description.json"; //$NON-NLS-1$
 }

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFLaunchConstants.java

@@ -19,4 +19,6 @@ public final class IDFLaunchConstants
 	public static final String SERIAL_MONITOR_ENCODING = "SERIAL_MONITOR_ENCODING"; //$NON-NLS-1$
 	public static final String BUILD_FOLDER_PATH = "com.espressif.idf.launch.serial.core.idfBuildFolderPath"; //$NON-NLS-1$
 	public static final String OPENOCD_USB_LOCATION = "OPENOCD_USB_ADAPTER_LOCATION"; //$NON-NLS-1$
+	public static final String FLASH_ENCRYPTION_ENABLED = "com.espressif.idf.launch.FLASH_ENCRYPTION_ENABLED"; //$NON-NLS-1$
+
 }

bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/IDFUtil.java

@@ -717,37 +717,80 @@ public static void updateEspressifPrefPageOpenocdPath()
 
 	public static String getCurrentTarget()
 	{
-		IProject project = null;
+		IProject project = getProjectFromActiveLaunchConfig();
+		if (project == null)
+		{
+			Logger.log(Messages.IDFUtil_CantFindProjectMsg);
+			return null;
+		}
+		return new SDKConfigJsonReader(project).getValue("IDF_TARGET"); //$NON-NLS-1$
+	}
+
+	public static boolean isFlashEncrypted()
+	{
+		ILaunchConfiguration configuration;
+		try
+		{
+			configuration = getActiveLaunchConfiguration();
+
+			return configuration != null
+					&& configuration.getAttribute(IDFLaunchConstants.FLASH_ENCRYPTION_ENABLED, false);
+		}
+		catch (CoreException e)
+		{
+			Logger.log(e);
+		}
+
+		return false;
+	}
+
+	/**
+	 * Returns the active project from the currently selected launch configuration.
+	 */
+	public static IProject getProjectFromActiveLaunchConfig()
+	{
 		try
 		{
-			ILaunchBarManager launchBarManager = IDFCorePlugin.getService(ILaunchBarManager.class);
-			ILaunchConfiguration activeConfig = launchBarManager.getActiveLaunchConfiguration();
-			if (activeConfig == null || activeConfig.getMappedResources() == null)
+			ILaunchConfiguration activeConfig = getActiveLaunchConfiguration();
+			if (activeConfig == null)
 			{
-				Logger.log(Messages.IDFUtil_CantFindProjectMsg);
-				return StringUtil.EMPTY;
+				return null;
+			}
+
+			IResource[] resources = activeConfig.getMappedResources();
+			if (resources == null || resources.length == 0)
+			{
+				Logger.log("No mapped resources in active launch configuration."); //$NON-NLS-1$
+				return null;
 			}
-			project = activeConfig.getMappedResources()[0].getProject();
-			Logger.log("Project:: " + project); //$NON-NLS-1$
+
+			IProject project = resources[0].getProject();
+			Logger.log("Active project: " + project); //$NON-NLS-1$
+			return project;
 		}
 		catch (CoreException e)
 		{
 			Logger.log(e);
+			return null;
 		}
-		return new SDKConfigJsonReader(project).getValue("IDF_TARGET"); //$NON-NLS-1$
 	}
 
-	public static IProject getProjectFromActiveLaunchConfig() throws CoreException
+	private static ILaunchConfiguration getActiveLaunchConfiguration() throws CoreException
 	{
-		final ILaunchBarManager launchBarManager = IDFCorePlugin.getService(ILaunchBarManager.class);
-		ILaunchConfiguration launchConfiguration = launchBarManager.getActiveLaunchConfiguration();
-		IResource[] mappedResources = launchConfiguration.getMappedResources();
-		if (mappedResources != null && mappedResources[0].getProject() != null)
+		ILaunchBarManager launchBarManager = IDFCorePlugin.getService(ILaunchBarManager.class);
+		if (launchBarManager == null)
 		{
-			return mappedResources[0].getProject();
+			Logger.log("LaunchBarManager service not found."); //$NON-NLS-1$
+			return null;
 		}
 
-		return null;
+		ILaunchConfiguration activeConfig = launchBarManager.getActiveLaunchConfiguration();
+		if (activeConfig == null)
+		{
+			Logger.log("No active launch configuration."); //$NON-NLS-1$
+			return null;
+		}
+		return activeConfig;
 	}
 
 	public static String getGitExecutablePathFromSystem()

bundles/com.espressif.idf.core/src/com/espressif/idf/core/variable/UartDynamicVariable.java

@@ -2,7 +2,8 @@
 
 public enum UartDynamicVariable
 {
-	SERIAL_PORT("serial_port"); //$NON-NLS-1$
+	SERIAL_PORT("serial_port"), //$NON-NLS-1$
+	FLASH_COMMAND("flash_command"); //$NON-NLS-1$
 
 	private String value;
 

bundles/com.espressif.idf.core/src/com/espressif/idf/core/variable/UartVariableResolver.java

@@ -9,9 +9,11 @@
 import org.eclipse.launchbar.core.ILaunchBarManager;
 import org.eclipse.launchbar.core.target.ILaunchTarget;
 
+import com.espressif.idf.core.IDFConstants;
 import com.espressif.idf.core.IDFCorePlugin;
 import com.espressif.idf.core.LaunchBarTargetConstants;
 import com.espressif.idf.core.logging.Logger;
+import com.espressif.idf.core.util.IDFUtil;
 import com.espressif.idf.core.util.StringUtil;
 
 public class UartVariableResolver implements IDynamicVariableResolver
@@ -34,6 +36,7 @@ private String resolveForDynamicEnum(UartDynamicVariable enumVariable)
 		return switch (enumVariable)
 		{
 		case SERIAL_PORT -> getSerialPort(); // $NON-NLS-1$
+		case FLASH_COMMAND -> IDFUtil.isFlashEncrypted() ? IDFConstants.FLASH_ENCRYPTED_CMD : IDFConstants.FLASH_CMD;
 		};
 	}
 

bundles/com.espressif.idf.launch.serial.core/src/com/espressif/idf/launch/serial/internal/SerialFlashLaunchConfigDelegate.java

@@ -225,6 +225,7 @@ private void openSerialMonitor(ILaunchConfiguration configuration) throws CoreEx
 		map.put(ITerminalsConnectorConstants.PROP_ENCODING, configuration.getAttribute(
 				IDFLaunchConstants.SERIAL_MONITOR_ENCODING, WorkbenchEncoding.getWorkbenchDefaultEncoding()));
 		map.put(ITerminalsConnectorConstants.PROP_FORCE_NEW, Boolean.FALSE);
+		map.put(SerialSettings.ENCRYPTION_ATTR, IDFUtil.isFlashEncrypted());
 		new SerialLauncherDelegate().execute(map, null);
 	}
 

bundles/com.espressif.idf.launch.serial.core/src/com/espressif/idf/launch/serial/util/ESPFlashUtil.java

@@ -30,6 +30,7 @@
 import com.espressif.idf.core.configparser.EspConfigParser;
 import com.espressif.idf.core.logging.Logger;
 import com.espressif.idf.core.util.IDFUtil;
+import com.espressif.idf.core.variable.UartDynamicVariable;
 
 public class ESPFlashUtil
 {
@@ -75,7 +76,8 @@ public static String getParseableEspFlashCommand(String serialPort)
 				.generateVariableExpression(IDFDynamicVariables.BUILD_DIR.name(), null));
 		commands.add("-p"); //$NON-NLS-1$
 		commands.add(serialPort);
-		commands.add(IDFConstants.FLASH_CMD);
+		commands.add(VariablesPlugin.getDefault().getStringVariableManager()
+				.generateVariableExpression(UartDynamicVariable.FLASH_COMMAND.getValue(), null));
 
 		return String.join(" ", commands); //$NON-NLS-1$
 	}

bundles/com.espressif.idf.launch.serial.ui/src/com/espressif/idf/launch/serial/ui/internal/CMakeMainTab2.java

@@ -54,12 +54,14 @@
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.program.Program;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Combo;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Group;
 import org.eclipse.swt.widgets.Label;
+import org.eclipse.swt.widgets.Link;
 import org.eclipse.swt.widgets.Text;
 import org.eclipse.ui.dialogs.ElementListSelectionDialog;
 import org.eclipse.ui.ide.IDEEncoding;
@@ -79,6 +81,7 @@
 @SuppressWarnings("restriction")
 public class CMakeMainTab2 extends GenericMainTab
 {
+	private static final String DOCS_ESPRESSIF_FLASH_ENCRYPTION_HTML = "https://docs.espressif.com/projects/espressif-ide/en/latest/flashdevice.html#customize-flash-arguments"; //$NON-NLS-1$
 	private static final String DEFAULT_JTAG_CONFIG_OPTIONS = String.format("-s ${%s} ${%s}", //$NON-NLS-1$
 			OpenocdDynamicVariable.OPENOCD_SCRIPTS, JtagDynamicVariable.JTAG_FLASH_ARGS);
 	private Combo flashOverComboButton;
@@ -94,6 +97,7 @@ public class CMakeMainTab2 extends GenericMainTab
 	private TextWithButton dfuArgumentsField;
 	private Button checkOpenSerialMonitorButton;
 	private Combo fEncodingCombo;
+	private Button flashEncryptionCheckbox;
 
 	public enum FlashInterface
 	{
@@ -230,9 +234,27 @@ protected void createUartComposite(Composite parent)
 		uartAgrumentsField = new TextWithButton(parent, SWT.WRAP | SWT.BORDER);
 
 		createArgumentComponent(defaultComposite, uartAgrumentsField);
+		createFlashEncryptionCheckbox(defaultComposite);
 		createVerticalSpacer(defaultComposite, 1);
 	}
 
+	private void createFlashEncryptionCheckbox(Composite parent)
+	{
+		Group flashGroup = new Group(parent, SWT.NONE);
+		flashGroup.setText(Messages.CMakeMainTab2_FlashEncryptionGroup);
+		flashGroup.setLayout(new GridLayout(1, false));
+		flashGroup.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, false));
+
+		flashEncryptionCheckbox = new Button(flashGroup, SWT.CHECK);
+		flashEncryptionCheckbox.setText(Messages.CMakeMainTab2_FlashEncryptionCheckbox);
+		flashEncryptionCheckbox.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, true));
+
+		Link flashEncryptionNote = new Link(flashGroup, SWT.WRAP);
+		flashEncryptionNote.setText(Messages.CMakeMainTab2_FlashEncryptionNote);
+
+		flashEncryptionNote.addListener(SWT.Selection, e -> Program.launch(DOCS_ESPRESSIF_FLASH_ENCRYPTION_HTML));
+	}
+
 	protected void createJtagflashComposite(Composite parent)
 	{
 
@@ -541,6 +563,8 @@ public void performApply(ILaunchConfigurationWorkingCopy configuration)
 			wc.setAttribute(IDFLaunchConstants.OPEN_SERIAL_MONITOR, checkOpenSerialMonitorButton.getSelection());
 			if (checkOpenSerialMonitorButton.getSelection())
 				wc.setAttribute(IDFLaunchConstants.SERIAL_MONITOR_ENCODING, fEncodingCombo.getText());
+			wc.setAttribute(IDFLaunchConstants.FLASH_ENCRYPTION_ENABLED, flashEncryptionCheckbox.getSelection());
+
 			wc.doSave();
 		}
 		catch (CoreException e)
@@ -553,13 +577,28 @@ public void performApply(ILaunchConfigurationWorkingCopy configuration)
 	public void initializeFrom(ILaunchConfiguration configuration)
 	{
 		super.initializeFrom(configuration);
+		updateFlashEncryptionGroup(configuration);
 		updateStartSerialMonitorGroup(configuration);
 		updateProjetFromConfig(configuration);
 		updateFlashOverStatus(configuration);
 		updateArgumentsWithDefaultFlashCommand(configuration);
 		switchUI(FlashInterface.values()[flashOverComboButton.getSelectionIndex()]);
 	}
 
+	private void updateFlashEncryptionGroup(ILaunchConfiguration configuration)
+	{
+		boolean isFlashEncryptionEnabled = false;
+		try
+		{
+			isFlashEncryptionEnabled = configuration.getAttribute(IDFLaunchConstants.FLASH_ENCRYPTION_ENABLED, false);
+		}
+		catch (CoreException e)
+		{
+			Logger.log(e);
+		}
+		flashEncryptionCheckbox.setSelection(isFlashEncryptionEnabled);
+	}
+
 	private void updateProjetFromConfig(ILaunchConfiguration configuration)
 	{
 		String projectName = StringUtil.EMPTY;