Fixes for ESP32-S2 targets (#91)

Author: josesimoes

README.md

@@ -97,7 +97,9 @@ When using nanoff you can add `--target MY_TARGET_NAME_HERE` to use a specific i
 ```console
 No target name was provided! Using 'ESP32_REV0' based on the device characteristics.
 ```
- 
+
+>Note: Please note that for ESP32-S2 targets is not possible to safely determine what's the best image to use. For this reason it's mandatory providing the appropriate target name with `--target MY_TARGET_NAME_HERE`.
+
 Some ESP32 boards have issues entering bootloader mode. This can be usually overcome by holding down the BOOT/FLASH button in the board.
 In case nanoff detects this situation the following warning is shown:
 
@@ -115,13 +117,13 @@ To update the firmware of an ESP32 target connected to COM31, to the latest avai
 nanoff --update --target ESP32_PSRAM_REV0 --serialport COM31
 ```
 
-### Update the firmware of an ESP_WROVER_KIT with a local CLR file
+### Update the firmware of an ESP32-S2 KALUGA 1 with a local CLR file
 
-To update the firmware of an ESP_WROVER_KIT target connected to COM31 with a local CLR file (for example from a build).
+To update the firmware of an ESP32-S2 KALUGA 1 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 ESP_WROVER_KIT --serialport COM31 --clrfile "C:\nf-interpreter\build\nanoCLR.bin" 
+nanoff --update --target KALUGA_1 --serialport COM31 --clrfile "C:\nf-interpreter\build\nanoCLR.bin" 
 ```
 
 You can adjust the name of the core image you want to use. Refer to the previous section to get the full list.

lib/esp32s2bootloader/bootloader.bin

@@ -98,7 +98,8 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
             bool updateCLRfile = !string.IsNullOrEmpty(clrFile);
 
             // perform sanity checks for the specified target against the connected device details
-            if (esp32Device.ChipType != "ESP32")
+            if (esp32Device.ChipType != "ESP32" &&
+                esp32Device.ChipType != "ESP32-S2")
             {
                 // connected to a device not supported
                 Console.ForegroundColor = ConsoleColor.Yellow;
@@ -113,27 +114,45 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
             // if a target name wasn't specified try to guess from the device characteristics 
             if (string.IsNullOrEmpty(targetName))
             {
-                if (esp32Device.ChipName.Contains("PICO"))
+                if (esp32Device.ChipType == "ESP32")
                 {
-                    targetName = "ESP32_PICO";
-                }
-                else 
-                {
-                    var revisionSuffix = "REV0";
-                    var psRamSegment = "";
-
-                    if (esp32Device.ChipName.Contains("revision 3"))
+                    if (esp32Device.ChipName.Contains("PICO"))
                     {
-                        revisionSuffix = "REV3";
+                        targetName = "ESP32_PICO";
                     }
-
-                    if(esp32Device.PSRamAvailable == PSRamAvailability.Yes)
+                    else
                     {
-                        psRamSegment = "_PSRAM";
+                        var revisionSuffix = "REV0";
+                        var psRamSegment = "";
+
+                        if (esp32Device.ChipName.Contains("revision 3"))
+                        {
+                            revisionSuffix = "REV3";
+                        }
+
+                        if (esp32Device.PSRamAvailable == PSRamAvailability.Yes)
+                        {
+                            psRamSegment = "_PSRAM";
+                        }
+
+                        // compose target name
+                        targetName = $"ESP32{psRamSegment}_{revisionSuffix}";
                     }
+                }
+                else if (esp32Device.ChipType == "ESP32-S2")
+                {
+                    // can't guess with certainty for this series, better have the user provide 
+                    // a target name
+
+                    Console.ForegroundColor = ConsoleColor.Red;
+
+                    Console.WriteLine("");
+                    Console.WriteLine($"No target name was provided! Please provide an appropriate one adding this option '--target MY_ESP32_S2_TARGET'.");
+                    Console.WriteLine("");
 
-                    // compose target name
-                    targetName = $"ESP32{psRamSegment}_{revisionSuffix}";
+                    Console.ForegroundColor = ConsoleColor.White;
+
+                    return ExitCodes.E9000;
                 }
 
                 Console.ForegroundColor = ConsoleColor.Blue;
@@ -310,6 +329,21 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
                     {
                         Console.ForegroundColor = ConsoleColor.Green;
                         Console.WriteLine("OK");
+
+                        // warn user if reboot is not possible
+                        if (espTool.CouldntResetTarget)
+                        {
+                            Console.ForegroundColor = ConsoleColor.Yellow;
+
+                            Console.WriteLine("");
+                            Console.WriteLine("**********************************************");
+                            Console.WriteLine("The connected device is in 'download mode'.");
+                            Console.WriteLine("Please reset the chip manually to run nanoCLR.");
+                            Console.WriteLine("**********************************************");
+                            Console.WriteLine("");
+
+                            Console.ForegroundColor = ConsoleColor.White;
+                        }
                     }
                     else
                     {

lib/esp32s2bootloader/partitions_16mb.bin

@@ -21,13 +21,15 @@ namespace nanoFramework.Tools.FirmwareFlasher
     /// </summary>
     internal partial class EspTool
     {
+        private string _esptoolMessage;
+
         /// <summary>
         /// The serial port over which all the communication goes
         /// </summary>
         private readonly string _serialPort = null;
 
         /// <summary>
-        /// The baud rate for the serial port. The default comming from <see cref="Options.BaudRate"/> is 9216000.
+        /// The baud rate for the serial port. The default comming from <see cref="Options.BaudRate"/>.
         /// </summary>
         private int _baudRate = 0;
 
@@ -77,6 +79,11 @@ internal partial class EspTool
         /// </summary>
         public VerbosityLevel Verbosity { get; internal set; } = VerbosityLevel.Normal;
 
+        /// <summary>
+        /// Flag to report if the target couldn't be reset after flashing it.
+        /// </summary>
+        public bool CouldntResetTarget;
+
         // ESP32 chip type to connect to.
         // Default is 'auto'. It's replaced with the actual chip type after detection to improve operations.
         internal string _chipType = "auto";
@@ -139,7 +146,9 @@ internal EspTool(
         /// Tries reading ESP32 device details.
         /// </summary>
         /// <returns>The filled info structure with all the information about the connected ESP32 device or null if an error occured</returns>
-        internal Esp32DeviceInfo GetDeviceDetails(bool requireFlashSize = true)
+        internal Esp32DeviceInfo GetDeviceDetails(
+            string targetName,
+            bool requireFlashSize = true)
         {
             string messages;
 
@@ -152,7 +161,7 @@ internal Esp32DeviceInfo GetDeviceDetails(bool requireFlashSize = true)
             // execute flash_id command and parse the result
             if (!RunEspTool(
                 "flash_id",
-                true,
+                false,
                 true,
                 false,
                 null,
@@ -168,7 +177,7 @@ internal Esp32DeviceInfo GetDeviceDetails(bool requireFlashSize = true)
                 // try again now without the stub
                 if (!RunEspTool(
                     "flash_id",
-                    false,
+                    true,
                     true,
                     false,
                     null,
@@ -217,16 +226,26 @@ internal Esp32DeviceInfo GetDeviceDetails(bool requireFlashSize = true)
             _chipType = chipType.ToLower().Replace("-", "");
 
             // try to find out if PSRAM is present
-            PSRamAvailability psramIsAvailable;
+            PSRamAvailability psramIsAvailable = PSRamAvailability.Unknown;
 
             if (name.Contains("PICO"))
             {
                 // PICO's don't have PSRAM, so don't even bother
                 psramIsAvailable = PSRamAvailability.No;
             }
+            else if (name.Contains("ESP32-S2")
+                     && targetName == "FEATHER_S2")
+            {
+                // FEATHER_S2's have PSRAM, so don't even bother
+                psramIsAvailable = PSRamAvailability.Yes;
+            }
             else
             {
-                psramIsAvailable = FindPSRamAvailable();
+                // if a target name was provided, don't bother to check PSRAM
+                if (targetName == null)
+                {
+                    psramIsAvailable = FindPSRamAvailable();
+                }
             }
 
             if (Verbosity >= VerbosityLevel.Normal)
@@ -274,12 +293,22 @@ private PSRamAvailability FindPSRamAvailable()
 				{ 0x8000, Path.Combine(Program.ExecutingPath, $"{_chipType}bootloader", $"partitions_{Esp32DeviceInfo.GetFlashSizeAsString(_flashSize).ToLowerInvariant()}.bin") }
             };
 
-            if (WriteFlash(bootloaderPartition) == ExitCodes.OK)
+            // need to use standard baud rate here because of boards put in download mode
+            if (WriteFlash(bootloaderPartition, true) == ExitCodes.OK)
             {
+                // check if the
+                if(_esptoolMessage.Contains("esptool.py can not exit the download mode over USB"))
+                {
+                    // this board was put on download mode manually, can't run the test app...
+
+                    return PSRamAvailability.Unknown;
+                }
+
                 try
                 {
                     // open COM port and grab output
-                    SerialPort espDevice = new SerialPort(_serialPort, _baudRate);
+                    // force baud rate to 115200 (standard baud rate for boootloader)
+                    SerialPort espDevice = new SerialPort(_serialPort, 115200);
                     espDevice.Open();
 
                     if (espDevice.IsOpen)
@@ -327,7 +356,7 @@ internal void BackupFlash(string backupFilename,
             // execute read_flash command and parse the result; progress message can be found be searching for backspaces (ASCII code 8)
             if (!RunEspTool(
                 $"read_flash 0 0x{flashSize:X} \"{backupFilename}\"",
-                false,
+                true,
                 false,
                 false,
                 (char)8,
@@ -358,7 +387,7 @@ internal ExitCodes EraseFlash()
             if (!RunEspTool(
                 "erase_flash",
                 false,
-                false,
+                true,
                 false,
                 null,
                 out string messages))
@@ -415,7 +444,9 @@ internal ExitCodes EraseFlashSegment(uint startAddress, uint length)
         /// </summary>
         /// <param name="partsToWrite">dictionary which keys are the start addresses and the values are the complete filenames (the bin files)</param>
         /// <returns>true if successful</returns>
-        internal ExitCodes WriteFlash(Dictionary<int, string> partsToWrite)
+        internal ExitCodes WriteFlash(
+            Dictionary<int, string> partsToWrite,
+            bool useStandardBaudrate = false)
         {
             // put the parts to flash together and prepare the regex for parsing the output
             var partsArguments = new StringBuilder();
@@ -445,7 +476,7 @@ internal ExitCodes WriteFlash(Dictionary<int, string> partsToWrite)
             if (!RunEspTool(
                 $"write_flash --flash_mode {_flashMode} --flash_freq {_flashFrequency}m --flash_size {flashSize} {partsArguments.ToString().Trim()}",
                 false,
-                false,
+                useStandardBaudrate,
                 true,
                 '\r',
                 out string messages))
@@ -467,6 +498,9 @@ internal ExitCodes WriteFlash(Dictionary<int, string> partsToWrite)
                 }
             }
 
+            // check if there is any mention of not being able to run the app
+            CouldntResetTarget = messages.Contains("To run the app, reset the chip manually");
+
             return ExitCodes.OK;
         }
 
@@ -475,6 +509,7 @@ internal ExitCodes WriteFlash(Dictionary<int, string> partsToWrite)
         /// </summary>
         /// <param name="commandWithArguments">the esptool command (e.g. write_flash) incl. all arguments (if needed)</param>
         /// <param name="noStub">if true --no-stub will be added; the chip_id, read_mac and flash_id commands can be quicker executes without uploading the stub program to the chip</param>
+        /// <param name="useStandardBaudRate">If <see langword="true"/> the tool will use the standard baud rate to connect to the chip.</param>
         /// <param name="hardResetAfterCommand">if true the chip will execute a hard reset via DTR signal</param>
         /// <param name="progressTestChar">If not null: After each of this char a progress message will be printed out</param>
         /// <param name="messages">StandardOutput and StandardError messages that the esptool prints out</param>
@@ -487,6 +522,9 @@ private bool RunEspTool(
             char? progressTestChar,
             out string messages)
         {
+            // reset message
+            _esptoolMessage = string.Empty;
+
             // create the process start info
             // if we can directly talk to the ROM bootloader without a stub program use the --no-stub option
             // --nostub requires to not change the baudrate (ROM doesn't support changing baud rate. Keeping initial baud rate 115200)
@@ -510,8 +548,9 @@ private bool RunEspTool(
             }
 
             // prepare the process start of the esptool
-            string appName = string.Empty;
-            string appDir = string.Empty;
+            string appName;
+            string appDir;
+
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
                 appName = "esptool.exe";
@@ -631,11 +670,31 @@ private bool RunEspTool(
 
             messages = messageBuilder.ToString();
 
+            // save output messages
+            _esptoolMessage = messages;
+
             // if the stub program was used then we don't need to transfer ist again
             _isStubActive = !noStub;
 
-            // true if exit code was 0 (success)
-            return espTool.ExitCode == 0;
+            if(espTool.ExitCode == 0)
+            {
+                // exit code was 0 (success), all good
+                return true;
+            }
+            else
+            {
+                // need to look for specific error messages to do a safe guess if execution is as expected
+                if(messages.Contains("esptool.py can not exit the download mode over USB") ||
+                   messages.Contains("Staying in bootloader.") )
+                {
+                    // we are probably good with this as we can't do much about it...
+                    return true;
+                }
+                else
+                {
+                    return false;
+                }
+            }
         }
 
         private void ProcessConnectPattern(StringBuilder messageBuilder)

lib/esp32s2bootloader/partitions_4mb.bin

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

lib/esp32s2bootloader/partitions_8mb.bin

@@ -101,7 +101,7 @@ public class Options
         [Option(
             "baud",
             Required = false,
-            Default = 921600,
+            Default = 1500000,
             HelpText = "Baud rate to use for the serial port.")]
         public int BaudRate { get; set; }