tools/update-firmware

   1 #!/usr/bin/env python3
   2
   3 import argparse
   4 import serial
   5 import struct
   6 import sys
   7
   8 crc32_table = [
   9     0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
  10     0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
  11     0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
  12     0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
  13     0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
  14     0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
  15     0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
  16     0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
  17     0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
  18     0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
  19     0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
  20     0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
  21     0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
  22     0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
  23     0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
  24     0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
  25     0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
  26     0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
  27     0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
  28     0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
  29     0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
  30     0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
  31     0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
  32     0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
  33     0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
  34     0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
  35     0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
  36     0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
  37     0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
  38     0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
  39     0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
  40     0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
  41     0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
  42     0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
  43     0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
  44     0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
  45     0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
  46     0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
  47     0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
  48     0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
  49     0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
  50     0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
  51     0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
  52 ]
  53
  54 def crc32(buf):
  55     c = 0xffffffff
  56
  57     for b in buf:
  58         c = crc32_table[(c & 0xff) ^ b] ^ (c >> 8)
  59
  60     return c ^ 0xffffffff
  61
  62 class DummySerial():
  63     def __init__(self):
  64         pass
  65
  66     def read(self, count):
  67         return b'\0' * count
  68
  69     def write(self, buf):
  70         pass
  71
  72     def flush(self):
  73         pass
  74
  75 class BootloaderError(Exception):
  76     def __init__(self, msg):
  77         super(BootloaderError, self).__init__(msg)
  78
  79 class UnknownCommand(BootloaderError):
  80     def __init__(self, command):
  81         msg = 'Command {} not recognized by target'.format(command)
  82
  83         super(UnknownCommand, self).__init__(msg)
  84
  85 class InvalidArgument(BootloaderError):
  86     def __init__(self, command):
  87         msg = 'Target rejected arguments for command {}'.format(command)
  88
  89         super(InvalidArgument, self).__init__(msg)
  90
  91 class ChecksumMismatch(BootloaderError):
  92     def __init__(self, command):
  93         msg = 'Target reported bad checksum for command {}'.format(command)
  94
  95         super(ChecksumMismatch, self).__init__(msg)
  96
  97 class PermissionDenied(BootloaderError):
  98     def __init__(self, command):
  99         msg = 'Target reported permission denied for command {}'.format(command)
 100
 101         super(PermissionDenied, self).__init__(msg)
 102
 103 class Command:
 104     def __init__(self, num, name):
 105         self._num = num
 106         self._name = name
 107
 108     def __int__(self):
 109         return self._num
 110
 111     def __str__(self):
 112         return self._name
 113
 114 class EraseCommand(Command):
 115     def __init__(self):
 116         super(EraseCommand, self).__init__(0x49e89a20, 'ERASE')
 117
 118 class ProgramCommand(Command):
 119     def __init__(self):
 120         super(ProgramCommand, self).__init__(0x37f7dc8d, 'PROGRAM')
 121
 122 class VerifyCommand(Command):
 123     def __init__(self):
 124         super(VerifyCommand, self).__init__(0x4a213efb, 'VERIFY')
 125
 126 class LoadChunkCommand(Command):
 127     def __init__(self):
 128         super(LoadChunkCommand, self).__init__(0x1b329768, 'LOAD_CHUNK')
 129
 130 class StartAppCommand(Command):
 131     def __init__(self):
 132         super(StartAppCommand, self).__init__(0xd27df1bf, 'START_APP')
 133
 134 class Application:
 135     SECTOR_SIZE = 1024
 136     MAX_NUM_CHUNKS = 256
 137
 138     def __init__(self, args):
 139         self._last_command = None
 140         self._log_level = args.log_level
 141
 142         if args.dry_run:
 143             self._serial = DummySerial()
 144         else:
 145             self._serial = serial.Serial(args.device, 115200)
 146
 147         self._do_write = args.write
 148         self._do_verify = args.verify
 149         self._do_start = args.start
 150
 151         self._filename = args.filename
 152         self._offset = args.offset
 153
 154     def run(self):
 155         chunks = []
 156
 157         if self._filename:
 158             with open(self._filename, 'rb') as f:
 159                 while True:
 160                     chunk = f.read(Application.SECTOR_SIZE)
 161
 162                     if len(chunk) == 0:
 163                         break
 164
 165                     chunks.append(chunk)
 166
 167             if len(chunks) > Application.MAX_NUM_CHUNKS:
 168                 sys.stderr.write('File too large.\n')
 169                 return 3
 170
 171             # The bootloader only accepts chunks whose size is word-aligned:
 172             num_extra = len(chunks[-1]) & 3
 173
 174             if num_extra != 0:
 175                 num_pad = 4 - extra
 176                 chunks[-1] += b'\xff' * num_pad
 177
 178         # Defaulting to zero seems too dangerous:
 179         if self._offset is None:
 180             sector0 = None
 181         else:
 182             sector0 = self._offset // Application.SECTOR_SIZE
 183
 184         try:
 185             return self._run(sector0, chunks)
 186         except BootloaderError as e:
 187             print(e)
 188             return 10
 189
 190     def _run(self, sector0, chunks):
 191         if self._do_write:
 192             for i in range(len(chunks)):
 193                 sector = sector0 + i
 194
 195                 # The bootloader will refuse to erase the second sector
 196                 # as it contains the precious flash configuration field.
 197                 if sector != 1:
 198                     self._erase(sector)
 199
 200             # Write first sector last, to prevent the bootloader from
 201             # jumping to partially programmed code.
 202             for i, chunk in reversed(list(enumerate(chunks))):
 203                 sector = sector0 + i
 204
 205                 if sector != 1:
 206                     self._load_chunk(chunk)
 207                     self._program(sector)
 208
 209         num_verify_errors = 0
 210
 211         if self._do_verify:
 212             for i, chunk in enumerate(chunks):
 213                 sector = sector0 + i
 214
 215                 self._load_chunk(chunk)
 216
 217                 if not self._verify(sector):
 218                     self._log(0, 'Failed to verify sector {} contents.\n'.format(sector))
 219
 220                     num_verify_errors += 1
 221
 222         if self._do_start and num_verify_errors == 0:
 223             self._start_app()
 224
 225         if num_verify_errors == 0:
 226             return 0
 227         else:
 228             return 9
 229
 230     def _erase(self, sector):
 231         self._log(0, 'Erasing sector {}... '.format(sector))
 232
 233         self._prepare_command(EraseCommand())
 234         self._serial.write(struct.pack('<L', sector))
 235         self._serial.flush()
 236
 237         self._read_and_handle_error()
 238
 239         self._log(0, 'OK\n')
 240
 241     def _program(self, sector):
 242         self._log(0, 'Programming sector {}... '.format(sector))
 243
 244         self._prepare_command(ProgramCommand())
 245         self._serial.write(struct.pack('<L', sector))
 246         self._serial.flush()
 247
 248         self._read_and_handle_error()
 249
 250         self._log(0, 'OK\n')
 251
 252     def _load_chunk(self, chunk):
 253         self._log(3, 'Loading chunk of {} bytes... '.format(len(chunk)))
 254
 255         self._prepare_command(LoadChunkCommand())
 256         self._serial.write(struct.pack('<L', len(chunk)))
 257         self._serial.flush()
 258         self._read_and_handle_error()
 259
 260         self._serial.write(chunk)
 261         self._serial.write(struct.pack('<L', crc32(chunk)))
 262         self._serial.flush()
 263         self._read_and_handle_error()
 264
 265         self._log(3, 'OK\n')
 266
 267     def _verify(self, sector):
 268         self._log(0, 'Verifying sector {}... '.format(sector))
 269
 270         self._prepare_command(VerifyCommand())
 271         self._serial.write(struct.pack('<L', sector))
 272         self._serial.flush()
 273         self._read_and_handle_error()
 274
 275         response = self._serial.read(8)
 276         num_mismatches, first_mismatch = struct.unpack('<LL', response)
 277
 278         if num_mismatches == 0:
 279             self._log(0, 'OK\n')
 280
 281             return True
 282
 283         self._log(0, 'FAILED\n')
 284         self._log(0, 'Found {} mismatches. first one at 0x{:x}.\n'.format(num_mismatches, first_mismatch))
 285
 286         return False
 287
 288     def _start_app(self):
 289         self._log(0, 'Starting application... ')
 290
 291         self._prepare_command(StartAppCommand())
 292         self._serial.flush()
 293         self._read_and_handle_error()
 294
 295         self._log(0, 'OK\n')
 296
 297     def _prepare_command(self, command):
 298         self._last_command = command
 299
 300         self._serial.write(struct.pack('<L', int(command)))
 301
 302     def _read_and_handle_error(self):
 303         error_response = self._serial.read(1)
 304         e, = struct.unpack('<B', error_response)
 305
 306         if e == 0:
 307             return
 308
 309         if e == 1:
 310             raise UnknownCommand(self._last_command)
 311         elif e == 2:
 312             raise InvalidArgument(self._last_command)
 313         elif e == 3:
 314             raise ChecksumMismatch(self._last_command)
 315         elif e == 4:
 316             raise PermissionDenied(self._last_command)
 317         else:
 318             msg = 'Target reported some other error for {}'.format(self._last_command)
 319
 320             raise BootloaderError(msg)
 321
 322     def _log(self, required_log_level, s):
 323         if self._log_level >= required_log_level:
 324             sys.stdout.write(s)
 325             sys.stdout.flush()
 326
 327 def offset(s):
 328     o = int(s, 0)
 329
 330     if (o & (Application.SECTOR_SIZE - 1)) != 0:
 331         msg = 'offset needs to be multiple of {}'.format(Application.SECTOR_SIZE)
 332
 333         raise argparse.ArgumentTypeError(msg)
 334
 335     return o
 336
 337 if __name__ == '__main__':
 338     parser = argparse.ArgumentParser(description='Flash GPS watch firmware')
 339
 340     parser.add_argument('-d', '--device', type=str, required=True)
 341     parser.add_argument('-o', '--offset', type=offset, default=None)
 342     parser.add_argument('-n', '--dry-run', action='store_true')
 343     parser.add_argument('-l', '--log-level', type=int, default=0)
 344     parser.add_argument('-w', '--write', action='store_true')
 345     parser.add_argument('-v', '--verify', action='store_true')
 346     parser.add_argument('-s', '--start', action='store_true')
 347     parser.add_argument('filename', type=str, nargs='?', default=None)
 348
 349     args = parser.parse_args()
 350
 351     if not args.write and not args.verify and not args.start:
 352         parser.error('one or more of the following arguments are required: ' +
 353                      '-w/--write, -v/--verify, -s/--start')
 354
 355     if args.filename is None:
 356         if args.write:
 357             parser.error('argument -w/--write: expected one argument')
 358         elif args.verify:
 359             parser.error('argument -v/--verify: expected one argument')
 360
 361     if args.offset is None:
 362         if args.write or args.verify:
 363             parser.error('the following arguments are required: -o/--offset')
 364
 365     sys.exit(Application(args).run())