Adding merge_image functionality (ESPTOOL-79)

esptool.py

@@ -3146,6 +3146,101 @@ def make_image(args):
     image.save(args.output)
 
 
+def merge_image(args):
+    import espsecure
+
+    # Helper classes
+    class Bin(object):
+        def __init__(self, addr, file):
+            self.start_addr = addr
+            self.file = file
+            self.file_name = os.path.basename(file.name)
+            self.size = self._get_size()
+            self.end_addr = self.start_addr + self.size
+
+        def _get_size(self):
+            self.file.seek(0, 2)  # seek to end
+            size = self.file.tell()
+            self.file.seek(0)
+            return size
+
+    class MultiBin(object):
+        def __init__(self, name, output_folder='.'):
+            # Create output folder(s) (if needed)
+            try:
+                os.makedirs(os.path.realpath(output_folder))
+            except OSError:
+                pass    # file already exists, overwrite
+
+            self.output_path = os.path.realpath(os.path.join(output_folder, name))
+            self.bins = []
+
+        def add_bin(self, addr, file):
+            self.bins.append(Bin(addr, file))
+
+        def _sort_bins(self):
+            self.bins = sorted(self.bins, key=lambda b: b.addr)
+
+        def _check_overlap(self):
+            # Check for bin overlap
+            for bin_index, curr_bin in enumerate(self.bins):
+                if bin_index > 1:
+                    prev_bin = self.bins[bin_index - 1]
+
+                    # Compare current bin start and previous bin end addresses
+                    if prev_bin.end_addr > curr_bin.start_addr:
+                        raise Exception("Not possible to create this bin, overlapping between %s and %s" % (
+                            curr_bin.file_name, prev_bin.file_name))
+
+        def create_bin(self):
+            self._sort_bins()
+            self._check_overlap()
+
+            with open(self.output_path, "wb") as output_file:
+                for bin_index, curr_bin in enumerate(self.bins):
+                    # Read previous bin end address
+                    if bin_index > 1:
+                        prev_end = self.bins[bin_index - 1].end_addr
+                    else:
+                        prev_end = 0
+
+                    # Fill the gaps with 0xFF (if needed)
+                    if curr_bin.addr > prev_end:
+                        output_file.write('\xff' * (curr_bin.addr - prev_end))
+
+                    # Inform user
+                    print("Add %s from 0x%x to 0x%x (0x%x)" % (
+                        curr_bin.file_name, curr_bin.start_addr, curr_bin.end_addr, curr_bin.size))
+
+                    # Read bin data
+                    with open(curr_bin.file, 'rb') as f:
+                        bin_data = f.read()
+
+                    # Write bin to output file
+                    output_file.write(bin_data)
+
+    # Check that bins are provided
+    if len(args.addr_filename) == 0:
+        raise FatalError('No segments specified')
+
+    encrypt = bool(args.keyfile is not None)
+    unenc_name = args.output + '.bin'
+    enc_name = args.output + '.enc.bin'
+
+    # Combine bins into unencrypted image
+    mb = MultiBin(unenc_name)
+    for address, argfile in args.addr_filename:
+        mb.add_bin(address, argfile)
+    mb.create_bin()
+
+    # Encrypt image (if needed)
+    if encrypt:
+        with open(unenc_name, 'rb') as input_file:
+            with open(enc_name, 'wb') as output_file:
+                espsecure._flash_encryption_operation(
+                    output_file, input_file, 0, args.keyfile, args.flash_crypt_conf, False)
+
+
 def elf2image(args):
     e = ELFFile(args.input)
     if args.chip == 'auto':  # Default to ESP8266 for backwards compatibility
@@ -3488,6 +3583,19 @@ def add_spi_flash_subparsers(parent, is_elf2image):
     parser_make_image.add_argument('--segaddr', '-a', action='append', help='Segment base address', type=arg_auto_int)
     parser_make_image.add_argument('--entrypoint', '-e', help='Address of entry point', type=arg_auto_int, default=0)
 
+    parser_merge_image = subparsers.add_parser(
+        'merge_image',
+        help='Create an application image from binary files')
+    parser_merge_image.add_argument('addr_filename', metavar='<address> <filename>', help='Address followed by binary filename, separated by space',
+                                    action=AddrFilenamePairAction)
+    parser_merge_image.add_argument('--output', '-o', help='Output image file postfix (default: flash)', type=str, default='flash')
+    parser_merge_image.add_argument('--keyfile', '-k', help="File with flash encryption key", type=argparse.FileType('rb'), default=None)
+    parser_merge_image.add_argument('--flash_crypt_conf', help="Override FLASH_CRYPT_CONF efuse value (default: 0xF).",
+                                    default=0xF, type=arg_auto_int)
+
+    # Adding so we can use the same download.config for image composition
+    add_spi_flash_subparsers(parser_merge_image, is_elf2image=False)
+
     parser_elf2image = subparsers.add_parser(
         'elf2image',
         help='Create an application image from ELF file')