Add support to flash ESP32 with a local CLR image (#57)

Author: josesimoes

README.md

@@ -58,6 +58,8 @@ The tool includes help for all available commands. You can see a list of all ava
 nanoff --help
 ```
 
+## ESP32 usage examples 
+
 ### Update the firmware of an ESP32_WROOM_32 target
 
 To update the firmware of an ESP32_WROOM_32 target connected to COM31, to the latest available development version.
@@ -66,6 +68,15 @@ To update the firmware of an ESP32_WROOM_32 target connected to COM31, to the la
 nanoff --update --target ESP32_WROOM_32 --serialport COM31
 ```
 
+### Update the firmware of an ESP32_WROOM_32 target with a local CLR file
+
+To update the firmware of an ESP32_WROOM_32 target connected to COM31 with a local CLR file (for example from a build).
+This file has to be a binary file with a valid CLR from a build. No other checks or validations are performed on the file content.
+
+```console
+nanoff --update --target ESP32_WROOM_32 --serialport COM31 --clrfile "C:\nf-interpreter\build\nanoCLR.bin" 
+```
+
 ### Deploy a managed application to an ESP32_WROOM_32 target
 
 To deploy a managed application to an ESP32_WROOM_32 target connected to COM31, which has the deployment region at 0x190000 flash address.
@@ -86,6 +97,8 @@ This example uses the binary format file that was saved on a previous backup ope
 nanoff --update --target ESP32_WROOM_32 --serialport COM31 --deployment "c:\eps32-backups\my_awesome_app.bin"
 ```
 
+## STMP32 usage examples 
+
 ### Update the firmware of a specific STM32 target
 
 To update the firmware of the ST_STM32F769I_DISCOVERY target to the latest available stable version using the JTAG connection.
@@ -146,6 +159,8 @@ To install the drivers for STM32 DFU connected targets.
 nanoff --installdfudrivers
 ```
 
+## TI CC13x2 usage examples 
+
 ### Update the firmware of a specific TI CC13x2 target
 
 To update the firmware of the TI_CC1352R1_LAUNCHXL target to the latest preview version.

nanoFirmwareFlasher/Esp32Firmware.cs

@@ -16,6 +16,11 @@ namespace nanoFramework.Tools.FirmwareFlasher
     /// </summary>
     internal class Esp32Firmware : FirmwarePackage
     {
+        /// <summary>
+        /// Address of the CLR partition.
+        /// </summary>
+        public const int CLRAddress = 0x10000;
+
         /// <summary>
         /// ESP32 nanoCLR is available for 2MB, 4MB, 8MB and 16MB flash sizes
         /// </summary>
@@ -80,7 +85,7 @@ internal async System.Threading.Tasks.Task<ExitCodes> DownloadAndExtractAsync(in
 				    { 0x1000, Path.Combine(LocationPath, BootloaderPath) },
 
 				    // nanoCLR goes to 0x10000
-				    { 0x10000, Path.Combine(LocationPath, "nanoCLR.bin") },
+				    { CLRAddress, Path.Combine(LocationPath, "nanoCLR.bin") },
 
 				    // partition table goes to 0x8000; there are partition tables for 2MB, 4MB, 8MB and 16MB flash sizes
 				    { 0x8000, Path.Combine(LocationPath, $"partitions_{humanReadable.ToLowerInvariant()}.bin") }

nanoFirmwareFlasher/Esp32Operations.cs

@@ -92,11 +92,13 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
             bool preview, 
             string applicationPath,
             string deploymentAddress,
-            PartitionTableSize? partitionTableSize,
-            VerbosityLevel verbosity)
+            string clrFile,
+            VerbosityLevel verbosity,
+            PartitionTableSize? partitionTableSize)
         {
             var operationResult = ExitCodes.OK;
             uint address = 0;
+            bool updateCLRfile = !string.IsNullOrEmpty(clrFile);
 
             // if a target name wasn't specified use the default (and only available) ESP32 target
             if (string.IsNullOrEmpty(targetName))
@@ -113,17 +115,46 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
                 Verbosity = verbosity
             };
 
+            // if this is updating with a local CLR file, download the package silently
+            if (updateCLRfile)
+            {
+                // check file
+                if (!File.Exists(clrFile))
+                {
+                    return ExitCodes.E9011;
+                }
+
+                // has to be a binary file
+                if (Path.GetExtension(clrFile) != ".bin")
+                {
+                    return ExitCodes.E9012;
+                }
+
+                firmware.Verbosity = VerbosityLevel.Quiet;
+            }
+
             // need to download update package?
             if (updateFw)
             {
                 operationResult = await firmware.DownloadAndExtractAsync(esp32Device.FlashSize);
+                
                 if (operationResult != ExitCodes.OK)
                 {
                     return operationResult;
                 }
                 // download successful
             }
 
+            // if updating with a CRL file, need to have a new fw package
+            if(updateCLRfile)
+            {
+                // remove the CLR file from the image
+                firmware.FlashPartitions.Remove(Esp32Firmware.CLRAddress);
+
+                // add it back with the file image from the command line option
+                firmware.FlashPartitions.Add(Esp32Firmware.CLRAddress, clrFile);
+            }
+
             // need to include application file?
             if (!string.IsNullOrEmpty(applicationPath))
             {
@@ -197,7 +228,7 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
 
                 if (verbosity >= VerbosityLevel.Normal)
                 {
-                    Console.Write($"Flashing firmware...");
+                    Console.WriteLine($"Flashing firmware...");
                 }
 
                 // write to flash

nanoFirmwareFlasher/EspTool.cs

@@ -302,11 +302,6 @@ internal ExitCodes EraseFlash()
                 throw new EraseEsp32FlashException(messages);
             }
 
-            if (Verbosity >= VerbosityLevel.Detailed)
-            {
-                Console.WriteLine(match.Groups["message"].ToString().Trim());
-            }
-
             return ExitCodes.OK;
         }
 

nanoFirmwareFlasher/ExitCodes.cs

@@ -242,5 +242,17 @@ public enum ExitCodes
         /// </summary>
         [Display(Name = "Couldn't find any device connected.")]
         E9010 = 9010,
+
+        /// <summary>
+        /// Couldn't find CLR image file. Check the path.
+        /// </summary>
+        [Display(Name = "Couldn't find CLR image file. Check the path.")]
+        E9011 = 9011,
+
+        /// <summary>
+        /// CLR image file has wrong format. It has to be a binary file.
+        /// </summary>
+        [Display(Name = "CLR image file has wrong format.It has to be a binary file.")]
+        E9012 = 9012,
     }
 }

nanoFirmwareFlasher/FirmwarePackage.cs

@@ -365,9 +365,12 @@ protected async System.Threading.Tasks.Task<ExitCodes> DownloadAndExtractAsync()
                 }
             }
 
-            Console.ForegroundColor = ConsoleColor.Yellow;
-            Console.WriteLine($"Updating to {Version}");
-            Console.ForegroundColor = ConsoleColor.White;
+            if (Verbosity >= VerbosityLevel.Normal)
+            {
+                Console.ForegroundColor = ConsoleColor.Yellow;
+                Console.WriteLine($"Updating to {Version}");
+                Console.ForegroundColor = ConsoleColor.White;
+            }
 
             return ExitCodes.OK;
         }

nanoFirmwareFlasher/Options.cs

@@ -139,10 +139,18 @@ public class Options
             Default = null,
             HelpText = "Partition table size to use. Valid sizes are: 2, 4, 8 and 16.")]
         public PartitionTableSize? Esp32PartitionTableSize { get; set; }
+
+        [Option(
+            "clrfile",
+            Required = false,
+            Default = null,
+            HelpText = "Path to file with CLR image. Partitions table and bootloader file will be automatically flashed to the device.")]
+        public string Esp32ClrFile { get; set; }
+
         #endregion
 
 
-        # region TI options
+        #region TI options
 
 
         [Option(

nanoFirmwareFlasher/Program.cs

@@ -237,7 +237,8 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                     !string.IsNullOrEmpty(o.SerialPort) ||
                     (o.BaudRate != 921600) ||
                     (o.Esp32FlashMode != "dio") ||
-                    (o.Esp32FlashFrequency != 40))
+                    (o.Esp32FlashFrequency != 40) ||
+                    !string.IsNullOrEmpty(o.Esp32ClrFile))
                 {
                     o.Platform = "esp32";
                 }
@@ -361,8 +362,9 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                             o.Preview,
                             o.DeploymentImage,
                             null,
-                            o.Esp32PartitionTableSize,
-                            _verbosityLevel);
+                            o.Esp32ClrFile,
+                            _verbosityLevel,
+                            o.Esp32PartitionTableSize);
 
                         if (_exitCode != ExitCodes.OK)
                         {
@@ -421,8 +423,9 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                             false,
                             o.DeploymentImage,
                             appFlashAddress,
-                            o.Esp32PartitionTableSize,
-                            _verbosityLevel);
+                            null,
+                            _verbosityLevel,
+                            o.Esp32PartitionTableSize);
 
                         if (_exitCode != ExitCodes.OK)
                         {