Add option to specify partition table size (#52)

***NO_CI***

Author: gukoff

nanoFirmwareFlasher/Esp32Firmware.cs

@@ -25,20 +25,29 @@ internal class Esp32Firmware : FirmwarePackage
 
         internal Dictionary<int, string> FlashPartitions;
 
+        internal PartitionTableSize? _partitionTableSize;
 
         /// <summary>
         /// Address of the deployment partition.
         /// </summary>
         internal int DeploymentPartionAddress =>  0x110000;
 
-        public Esp32Firmware(string targetName, string fwVersion, bool stable)
+        public Esp32Firmware(string targetName, string fwVersion, bool stable, PartitionTableSize? partitionTableSize)
             :base(targetName, fwVersion, stable)
         {
+            _partitionTableSize = partitionTableSize;
         }
 
         internal async System.Threading.Tasks.Task<ExitCodes> DownloadAndExtractAsync(int flashSize)
         {
-            string humanReadable = flashSize >= 0x10000 ? $"{ flashSize / 0x100000 }MB" : $"{ flashSize / 0x400 }kB";
+            if (_partitionTableSize is not null)
+            {
+                // if specified, partition table size overrides flash size.
+                flashSize = (int)_partitionTableSize * 0x100000;
+            }
+            var humanReadable = flashSize >= 0x10000 ? $"{ flashSize / 0x100000 }MB" : $"{ flashSize / 0x400 }kB";
+
+            // check if the option to override the partition table was set
 
             if (!SupportedFlashSizes.Contains(flashSize))
             {

nanoFirmwareFlasher/Esp32Operations.cs

@@ -89,6 +89,7 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
             bool stable, 
             string applicationPath,
             string deploymentAddress,
+            PartitionTableSize? partitionTableSize,
             VerbosityLevel verbosity)
         {
             ExitCodes operationResult = ExitCodes.OK;
@@ -103,7 +104,8 @@ internal static async System.Threading.Tasks.Task<ExitCodes> UpdateFirmwareAsync
             Esp32Firmware firmware = new Esp32Firmware(
                 targetName, 
                 fwVersion, 
-                stable)
+                stable,
+                partitionTableSize)
             {
                 Verbosity = verbosity
             };

nanoFirmwareFlasher/EspTool.cs

@@ -47,6 +47,11 @@ internal class EspTool
         /// </remarks>
         private readonly int _flashFrequency = 0;
 
+        /// <summary>
+        /// Partition table size, when specified in the options.
+        /// </summary>
+        private readonly PartitionTableSize? _partitionTableSize = null;
+
         /// <summary>
         /// The size of the flash in bytes; 4 MB = 0x40000 bytes
         /// </summary>
@@ -149,11 +154,13 @@ internal DeviceInfo(
         /// <param name="baudRate">The baud rate for the serial port.</param>
         /// <param name="flashMode">The flash mode for the esptool</param>
         /// <param name="flashFrequency">The flash frequency for the esptool</param>
+        /// <param name="partitionTableSize">Partition table size to use</param>
         internal EspTool(
             string serialPort, 
             int baudRate,
             string flashMode, 
-            int flashFrequency)
+            int flashFrequency,
+            PartitionTableSize? partitionTableSize)
         {
             // open/close the port to see if it is available
             using (SerialPort test = new SerialPort(serialPort, baudRate))
@@ -180,6 +187,7 @@ internal EspTool(
             _baudRate = baudRate;
             _flashMode = flashMode;
             _flashFrequency = flashFrequency;
+            _partitionTableSize = partitionTableSize;
         }
 
         /// <summary>

nanoFirmwareFlasher/Options.cs

@@ -98,6 +98,19 @@ public class Options
             HelpText = "Flash frequency to use [MHz].")]
         public int Esp32FlashFrequency { get; set; }
 
+        /// <summary>
+        /// Allowed values:
+        /// 2
+        /// 4
+        /// 8
+        /// 16
+        /// </summary>
+        [Option(
+            "partitiontablesize",
+            Required = false,
+            Default = null,
+            HelpText = "Partition table size to use. Valid sizes are: 2, 4, 8 and 16.")]
+        public PartitionTableSize? Esp32PartitionTableSize { get; set; }
         #endregion
 
 
@@ -245,4 +258,11 @@ public enum VerbosityLevel
         Diagnostic = 4
     }
 
+    public enum PartitionTableSize
+    {
+        _2 = 2,
+        _4 = 4,
+        _8 = 8,
+        _16 = 16,
+    }
 }

nanoFirmwareFlasher/Program.cs

@@ -229,7 +229,8 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                         o.SerialPort,
                         o.BaudRate,
                         o.Esp32FlashMode,
-                        o.Esp32FlashFrequency);
+                        o.Esp32FlashFrequency,
+                        o.Esp32PartitionTableSize);
                 }
                 catch(Exception)
                 {
@@ -314,6 +315,7 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                             o.Stable,
                             o.DeploymentImage,
                             null,
+                            o.Esp32PartitionTableSize,
                             verbosityLevel);
 
                         if (_exitCode != ExitCodes.OK)
@@ -373,6 +375,7 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                             false,
                             o.DeploymentImage,
                             appFlashAddress,
+                            o.Esp32PartitionTableSize,
                             verbosityLevel);
 
                         if (_exitCode != ExitCodes.OK)

nanoFirmwareFlasher/nanoFirmwareFlasher.csproj

@@ -46,7 +46,7 @@
 
   <ItemGroup>
     <PackageReference Include="CommandLineParser" Version="2.8.0" />
-    <PackageReference Include="Nerdbank.GitVersioning" Version="3.1.91" PrivateAssets="All" />
+    <PackageReference Include="Nerdbank.GitVersioning" Version="3.4.194" PrivateAssets="All" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
     <PackageReference Include="System.IO.Ports" Version="4.7.0" />