Merge pull request #28 from toniebox-reverse-engineering/develop

Next Version

Author: SciLor

README.md

@@ -1,4 +1,4 @@
-# CC3200 Tool v1.2.2
+# CC3200 Tool v1.2.3
 
 A small tool to read and write files in TI's CC3200 SimpleLink (TM) filesystem.
 Partial support for the CC32XX (CC3230/CC3235) series (via flash image)

cc3200tool/cc.py

@@ -19,6 +19,7 @@
 
 import sys
 import os
+import tempfile
 import time
 import argparse
 import struct
@@ -232,19 +233,26 @@ def __call__(self, string):
         help="enables fail safe MIRROR feature")
 parser_write_file.add_argument(
         "--file-id", type=auto_int, default=-1, help="if filename not available you can read a file by its id (image_file only!)")
+parser_write_file.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a read of the written data to verify")
 
 parser_read_file = subparsers.add_parser(
         "read_file", help="read a file from the SL filesystem")
 parser_read_file.add_argument(
         "cc_filename", help="file to read from the target")
 parser_read_file.add_argument(
-        "local_file", type=argparse.FileType('wb'),
+        "local_file", type=argparse.FileType('w+b'),
         help="local path to store the file contents in")
 parser_read_file.add_argument(
         "--file-id", type=auto_int, default=-1, help="if filename not available you can read a file by its id")
 parser_read_file.add_argument(
         "--inactive", action="store_true",
         help="read from inactive FAT copy")
+parser_read_file.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a second read of the data to verify")
+
 
 parser_write_flash = subparsers.add_parser(
         "write_flash", help="Write a Gang image on the flash")
@@ -254,6 +262,9 @@ def __call__(self, string):
 parser_write_flash.add_argument(
         "--no-erase", type=bool, default=False,
         help="do not perform an erase before write (for blank chips)")
+parser_write_flash.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a read of the written data to verify")
 
 parser_read_flash = subparsers.add_parser(
         "read_flash", help="Read SFFS contents into the file")
@@ -266,6 +277,12 @@ def __call__(self, string):
 parser_read_flash.add_argument(
         "--size", type=auto_int, default=-1,
         help="dump size (default is complete SFFS)")
+parser_read_flash.add_argument(
+        "--ignore-max-size", type=bool, default=False,
+        help="ignore the maximum size of the flash")
+parser_read_flash.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a second read of the data to verify")
 
 
 parser_list_filesystem = subparsers.add_parser(
@@ -285,7 +302,8 @@ def __call__(self, string):
         "read_all_files",
         help="Reads all files into a subfolder structure")
 parser_read_all_files.add_argument(
-        "local_dir", type=PathType(exists=True, type='dir'),
+        #"local_dir", type=PathType(exists=False, type='dir'),
+        "local_dir",
         help="local path to store the files in")
 parser_read_all_files.add_argument(
         "--by-file-id", action="store_true",
@@ -296,6 +314,9 @@ def __call__(self, string):
 parser_read_all_files.add_argument(
         "--inactive", action="store_true",
         help="read from inactive FAT copy")
+parser_read_all_files.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a second read of the data to verify")
 
 parser_write_all_files = subparsers.add_parser(
         "write_all_files",
@@ -306,6 +327,9 @@ def __call__(self, string):
 parser_write_all_files.add_argument(
         "--simulate", action="store_false",
         help="List all files to be written and skip writing them")
+parser_write_all_files.add_argument(
+        "--no-verify", type=bool, default=False,
+        help="do not perform a read of the written data to verify")
 
 def dll_data(fname):
     return get_data('cc3200tool', os.path.join('dll', fname))
@@ -860,7 +884,7 @@ def _read_chunk(self, offset, size, storage_id=STORAGE_ID_SRAM):
         data = self._image_file.read(size)
         return data
 
-    def _raw_read(self, offset, size, storage_id=STORAGE_ID_SRAM, sinfo=None):
+    def _raw_read(self, offset, size, storage_id=STORAGE_ID_SRAM, sinfo=None, ignore_max_size=False):
         slist = self._get_storage_list()
         if storage_id == STORAGE_ID_SFLASH and not slist.sflash:
             raise CC3200Error("no serial flash?!")
@@ -871,9 +895,13 @@ def _raw_read(self, offset, size, storage_id=STORAGE_ID_SRAM, sinfo=None):
             sinfo = self._get_storage_info(storage_id)
         storage_size = sinfo.block_count * sinfo.block_size
 
+        if ignore_max_size:
+            storage_size = offset + size
+            log.warning("Ignoring storage size limits")
+
         if offset > storage_size:
             raise CC3200Error("offset %d is bigger than available mem %d" %
-                              (offset, storage_size))
+                                (offset, storage_size))
 
         if size < 1:
             size = storage_size - offset
@@ -1211,8 +1239,8 @@ def write_flash(self, image, erase=True):
         self._raw_write(8, data[8:], storage_id=STORAGE_ID_SFLASH)
         self._raw_write(0, data[:8], storage_id=STORAGE_ID_SFLASH)
 
-    def read_flash(self, image_file, offset, size):
-        data = self._raw_read(offset, size, storage_id=STORAGE_ID_SFLASH)
+    def read_flash(self, image_file, offset, size, ignore_max_size=False):
+        data = self._raw_read(offset, size, storage_id=STORAGE_ID_SFLASH, ignore_max_size=ignore_max_size)
         image_file.write(data)
 
     def get_fat_info(self, inactive=False, extended=False):
@@ -1290,13 +1318,26 @@ def list_filesystem(self, json_output=False, inactive=False, extended=False):
         if json_output:
             fat_info.print_sffs_info_json()
 
-    def read_all_files(self, local_dir, by_file_id=False, all_by_file_id=False, inactive=False):
+    def read_all_files(self, local_dir, by_file_id=False, all_by_file_id=False, inactive=False, no_verify=False):
         fat_info = self.get_fat_info(inactive=inactive)
         fat_info.print_sffs_info()
+        has_error = False
+
+        if not os.path.exists(local_dir):
+            os.makedirs(local_dir)
+            if not os.path.exists(local_dir):
+                raise CC3200Error("could not create local directory %s" % local_dir)
+            log.info("Created local directory %s" % local_dir)
+
         for f in fat_info.files:
             ccname = f.fname
-            if by_file_id and f.fname == '':
-                ccname = str(f.index)
+            if f.fname == '':
+                if by_file_id:
+                    ccname = str(f.index)
+                else:
+                    log.error("Found file without filename, skipping index=%i", f.index)
+                    has_error = True
+                    continue
 
             if ccname.startswith('/'):
                 ccname = ccname[1:]
@@ -1309,25 +1350,58 @@ def read_all_files(self, local_dir, by_file_id=False, all_by_file_id=False, inac
                 os.makedirs(name=os.path.dirname(target_file))
 
             try:
+                tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
                 if all_by_file_id or ( by_file_id and f.fname == '' ):
-                    self.read_file(ccname, open(target_file, 'wb', -1), f.index, inactive=inactive)
+                    self.read_file(ccname, open(target_file, 'w+b', -1), f.index, inactive=inactive)
+                    if not no_verify:
+                        self.read_file(ccname, tmpFile, f.index, inactive=inactive)
                 else:
-                    self.read_file(f.fname, open(target_file, 'wb', -1), inactive=inactive)
+                    self.read_file(f.fname, open(target_file, 'w+b', -1), inactive=inactive)
+                    if not no_verify:
+                        self.read_file(f.fname, tmpFile, inactive=inactive)
+
+                if not no_verify:
+                    tmpFile.seek(0)
+                    if tmpFile.read() == open(target_file, 'rb').read():
+                        log.info("File %s verified" % target_file)
+                    else:
+                        log.error("File %s could not be verified" % target_file)
+                        has_error = True
             except Exception as ex:
                 log.error("File %s could not be read, %s" % (f.fname, str (ex)))
+                has_error = True
+
+        if has_error:
+            log.error("One or more files could not be verified or read at all")
+            sys.exit(-4)
 
-    def write_all_files(self, local_dir, write=True, use_api=True):
+    def write_all_files(self, local_dir, write=True, use_api=True, no_verify=False):
+        has_error = False
         for root, dirs, files in os.walk(local_dir):
             for file in files:
                 filepath = os.path.join(root, file)
                 ccpath = filepath[len(local_dir):]
+                ccpath = ccpath.replace("\\", "/")
                 if not ccpath.startswith("/"):
                     ccpath = "/" + ccpath
 
                 if write:
                     self.write_file(local_file=open(filepath, 'rb', -1), cc_filename=ccpath, use_api=use_api)
+                    if not no_verify:
+                        log.info("Verify written file with second read...")
+                        tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
+                        self.read_file(ccpath, tmpFile)
+                        tmpFile.seek(0)
+                        if tmpFile.read() == open(filepath, 'rb').read():
+                            log.info("File %s verified" % ccpath)
+                        else:
+                            log.error("File %s could not be verified" % ccpath)
+                            has_error = True
                 else:
                     log.info("Simulation: Would copy local file %s to cc3200 %s" % (filepath, ccpath))
+        if has_error:
+            log.error("One or more files could not be verified")
+            sys.exit(-4)
 
 
 def split_argv(cmdline_args):
@@ -1417,33 +1491,86 @@ def main():
             cc.write_file(command.local_file, command.cc_filename, command.file_id,
                           command.signature, command.file_size,
                           command.commit_flag, use_api)
+
+            if not command.no_verify:
+                log.info("Read file after writing for verification...")
+                tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
+                cc.read_file(command.cc_filename, tmpFile)
+                tmpFile.seek(0)
+                command.local_file.seek(0)
+                if tmpFile.read() == command.local_file.read():
+                    log.info("File %s verified" % command.cc_filename)
+                else:
+                    log.error("File %s could not be verified" % command.cc_filename)
+                    sys.exit(-4)
+            
             check_fat = True
 
         if command.cmd == "read_file":
             cc.read_file(command.cc_filename, command.local_file, command.file_id, command.inactive)
+            if not command.no_verify:
+                log.info("Read file a second time for verification...")
+                tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
+                cc.read_file(command.cc_filename, tmpFile, command.file_id, command.inactive)
+                tmpFile.seek(0)
+                command.local_file.seek(0)
+                if tmpFile.read() == command.local_file.read():
+                    log.info("File %s verified" % command.cc_filename)
+                else:
+                    log.error("File %s could not be verified" % command.cc_filename)
+                    local_file_name = command.local_file.name
+                    command.local_file.close()
+                    os.remove(local_file_name)
+                    sys.exit(-4)
 
         if command.cmd == "erase_file":
             log.info("Erasing file %s", command.filename)
             cc.erase_file(command.filename)
 
         if command.cmd == "write_flash":
             cc.write_flash(command.gang_image_file, not command.no_erase)
+            if not command.no_verify:
+                log.info("Verify flash write by reading...")
+                tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
+                cc.read_flash(tmpFile, 0, -1)
+                tmpFile.seek(0)
+                command.gang_image_file.seek(0)
+                if tmpFile.read() == command.gang_image_file.read():
+                    log.info("Flash verified")
+                else:
+                    log.error("Flash could not be verified, please flash again!")
+                    sys.exit(-4)
+
 
         if command.cmd == "read_flash":
-            cc.read_flash(command.dump_file, command.offset, command.size)
+            cc.read_flash(command.dump_file, command.offset, command.size, command.ignore_max_size)
+            if not command.no_verify:
+                log.info("Verify flash dump with second reading...")
+                tmpFile = tempfile.NamedTemporaryFile(mode='w+b')
+                cc.read_flash(tmpFile, command.offset, command.size, command.ignore_max_size)
+                tmpFile.seek(0)
+                command.dump_file.seek(0)
+                if tmpFile.read() == command.dump_file.read():
+                    log.info("Flash verified, reading equal!")
+                else:
+                    log.error("Flash could not be verified, first and second dump are different!")
+                    dump_file_name = command.dump_file.name
+                    command.dump_file.close()
+                    os.remove(dump_file_name)
+                    sys.exit(-4)
 
         if command.cmd == "list_filesystem":
             cc.list_filesystem(command.json_output, command.inactive, command.extended)
 
         if command.cmd == "read_all_files":
-            cc.read_all_files(command.local_dir, command.by_file_id, command.all_by_file_id, command.inactive)
+            cc.read_all_files(command.local_dir, command.by_file_id, command.all_by_file_id, command.inactive, command.no_verify)
 
         if command.cmd == "write_all_files":
             use_api = True
             if not command.image_file is None and not command.output_file is None:
                 use_api = False
                 cc.copy_input_file_to_output_file()
-            cc.write_all_files(command.local_dir, command.simulate, use_api)
+            cc.write_all_files(command.local_dir, command.simulate, use_api, command.no_verify)
             check_fat = True
 
 

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="cc3200tool",
-    version="1.2.2",
+    version="1.2.3",
     description="A tool to down-/upload files form/to TI CC3200",
     author="Kiril Zyapkov, 0xbadbee",
     author_email="k.zyapkov@allterco.com",