Merge pull request #53 from osresearch/tinyprog-security

tinyprog security page writing and other features

Author: mithro

README.md

@@ -50,10 +50,10 @@ Optionally, an additional `desc.tgz` file may be included in the SPI flash itsel
   "bver": "2.0.0",
   "update": "https://tinyfpga.com/update/tinyfpga-bx",
   "addrmap": {
-    "bootloader": "0x00000+131542",
-    "userimage":  "0x30000+131542",
-    "userdata":   "0x50000+710000",
-    "desc.tgz":   "0xFC000+16000"
+    "bootloader": "0x00000-0x2FFFF",
+    "userimage":  "0x30000-0x4FFFF",
+    "userdata":   "0x50000-0xFBFFF",
+    "desc.tgz":   "0xFC000-0xFFFFF"
   }
 }
 ```

programmer/tinyprog/__init__.py

@@ -2,6 +2,7 @@
 import platform
 import re
 import struct
+import time
 
 from functools import reduce
 from pkg_resources import get_distribution, DistributionNotFound
@@ -493,12 +494,32 @@ def program_sectors(self, addr, data):
             for offset in range(0, len(data), sector_size):
                 current_addr = addr + offset
                 current_write_data = data[offset:offset + sector_size]
+
+                # Determine if we need to write this sector at all
+                current_flash_data = self.read(
+                    current_addr,
+                    sector_size,
+                    disable_progress=True,
+                    max_length=sector_size)
+
+                if current_flash_data == current_write_data:
+                    # skip this sector since it matches
+                    pbar.update(sector_size)
+                    continue
+
                 self.erase(current_addr, sector_size, disable_progress=True)
 
                 minor_sector_size = 256
                 for minor_offset in range(0, 4 * 1024, minor_sector_size):
                     minor_write_data = current_write_data[
                         minor_offset:minor_offset + minor_sector_size]
+
+                    # if the minor data is all 0xFF then it will match
+                    # the erased bits and doesn't need to be re-sent
+                    if minor_write_data == chr(0xFF) * len(minor_write_data):
+                        pbar.update(len(minor_write_data))
+                        continue;
+
                     self.write(
                         current_addr + minor_offset,
                         minor_write_data,
@@ -566,3 +587,12 @@ def program_bitstream_fast(self, addr, bitstream):
         self.wake()
         self.progress(str(len(bitstream)) + " bytes to program")
         return self.program_fast(addr, bitstream)
+
+    def program_security_page(self, page, data):
+        self.progress("Waking up SPI flash")
+        self.wake()
+        self.progress("Erasing security page " + str(page))
+        self.erase_security_register_page(page)
+        self.progress(str(len(data)) + " bytes to program")
+        return self.program_security_register_page(page, data)
+

programmer/tinyprog/__main__.py

@@ -266,6 +266,10 @@ def parse_int(str_value):
         "--meta",
         action="store_true",
         help="dump out the metadata for all connected boards in JSON")
+    parser.add_argument(
+        "--security",
+        type=str,
+        help="update the security page in the flash at address addr")
     parser.add_argument(
         "--update-bootloader",
         action="store_true",
@@ -372,6 +376,7 @@ def parse_int(str_value):
         # program the flash memory
         if (args.program is not None) or (
                 args.program_userdata is not None) or (
+                args.security is not None) or (
                 args.program_image is not None):
             boot_fpga = False
 
@@ -381,6 +386,7 @@ def progress(info):
 
             with active_port:
                 fpga = TinyProg(active_port, progress)
+                force = False
 
                 if args.program is not None:
                     print("    Programming %s with %s" % (
@@ -390,6 +396,7 @@ def progress(info):
 
                     if args.addr is not None:
                         addr = parse_int(args.addr)
+                        force = True
                     else:
                         addr = fpga.meta.userimage_addr_range()[0]
 
@@ -400,7 +407,7 @@ def progress(info):
                         print("    Bootloader not active")
                         sys.exit(1)
 
-                    if check_if_overwrite_bootloader(
+                    if force or check_if_overwrite_bootloader(
                             addr, len(bitstream),
                             fpga.meta.userimage_addr_range()):
                         boot_fpga = True
@@ -417,6 +424,7 @@ def progress(info):
 
                     if args.addr is not None:
                         addr = parse_int(args.addr)
+                        force = True
                     else:
                         addr = fpga.meta.userdata_addr_range()[0]
 
@@ -427,7 +435,7 @@ def progress(info):
                         print("    Bootloader not active")
                         sys.exit(1)
 
-                    if check_if_overwrite_bootloader(
+                    if force or check_if_overwrite_bootloader(
                             addr, len(bitstream),
                             fpga.meta.userdata_addr_range()):
                         boot_fpga = True
@@ -444,6 +452,7 @@ def progress(info):
 
                     if args.addr is not None:
                         addr = parse_int(args.addr)
+                        force = True
                     else:
                         addr = fpga.meta.userimage_addr_range()[0]
 
@@ -454,7 +463,7 @@ def progress(info):
                         print("    Bootloader not active")
                         sys.exit(1)
 
-                    if check_if_overwrite_bootloader(
+                    if force or check_if_overwrite_bootloader(
                             addr, len(bitstream),
                             (fpga.meta.userimage_addr_range()[0],
                              fpga.meta.userdata_addr_range()[1])):
@@ -463,6 +472,27 @@ def progress(info):
                         if not fpga.program_bitstream(addr, bitstream):
                             sys.exit(1)
 
+                if args.security is not None:
+                    print("    Programming %s security page with %s" % (
+                        active_port, args.security))
+
+                    data = open(args.security, 'r').read()
+
+                    if args.addr is not None:
+                        addr = parse_int(args.addr)
+                    else:
+                        addr = 1
+
+                    if addr < 0:
+                        print("    Negative write addr: {}".format(addr))
+                        sys.exit(1)
+                    if not fpga.is_bootloader_active():
+                        print("    Bootloader not active")
+                        sys.exit(1)
+
+                    if not fpga.program_security_page(addr, data):
+                        sys.exit(1)
+
                 if boot_fpga:
                     fpga.boot()
                     print("")