robinkrens.nl - git repository - renesas-ra-flasher/blob - src/RAFlasher.py

   1 import os
   2 import math
   3 import time
   4 import argparse
   5 import tempfile
   6 from tqdm import tqdm
   7 from RAConnect import *
   8 from RAPacker import *
   9
  10 VENDOR_ID = 0x045B
  11 PRODUCT_ID = 0x0261
  12
  13 commands = {
  14     "write": lambda dev, args: write_img(dev, args.file_name, args.start_address, args.size, args.verify),
  15     "read": lambda dev, args: read_img(dev, args.file_name, args.start_address, args.size),
  16     "erase": lambda dev, args: erase_chip(dev, args.start_address, args.size),
  17     "info": lambda dev, args: (get_dev_info(dev), dev.set_chip_layout(get_area_info(dev, output=True)))
  18 }
  19
  20 def int_to_hex_list(num):
  21     hex_string = hex(num)[2:].upper()  # convert to hex string
  22     hex_string = hex_string.zfill(8) # pad for 8 char's long
  23     hex_list = [f'0x{hex_string[c:c+2]}' for c in range(0, 8, 2)]
  24     return hex_list
  25
  26 def hex_type(string):
  27     try:
  28         value = int(string, 16)
  29         return value
  30     except ValueError:
  31         raise argparse.ArgumentTypeError(f"'{string}' is not a valid hexadecimal value.")
  32
  33 def set_size_boundaries(dev, start_addr, size):
  34
  35     sector_size = dev.chip_layout[dev.sel_area]['ALIGN'] # currently only area 0 supported
  36
  37     if start_addr % sector_size:
  38         raise ValueError(f"start addr not aligned on sector size {sector_size}")
  39
  40     if size < sector_size:
  41         print("Warning: you are trying to write something that is less than one sector size: padding with zeroes")
  42
  43     blocks = (size + sector_size - 1) // sector_size
  44     end_addr = blocks * sector_size + start_addr - 1
  45
  46     if (end_addr <= start_addr):
  47         raise ValueError(f"End address smaller or equal than start_address")
  48
  49     if (end_addr > dev.chip_layout[dev.sel_area]['EAD']):
  50         raise ValueError(f"Binary file is bigger than available ROM space")
  51
  52     return (start_addr, end_addr)
  53
  54 def get_area_info(dev, output=False):
  55     cfg = {}
  56     for i in [0,1,2]:
  57         packed = pack_pkt(ARE_CMD, [str(i)])
  58         dev.send_data(packed)
  59         info = dev.recv_data(23)
  60         msg = unpack_pkt(info)
  61         fmt = '>BIIII'
  62         KOA, SAD, EAD, EAU, WAU = struct.unpack(fmt, bytes(int(x, 16) for x in msg))
  63         cfg[i] = {"SAD": SAD, "EAD": EAD, "ALIGN": EAU}
  64         if output:
  65             print(f'Area {KOA}: {hex(SAD)}:{hex(EAD)} (erase {hex(EAU)} - write {hex(WAU)})')
  66
  67     return cfg
  68
  69 def get_dev_info(dev):
  70     packed = pack_pkt(SIG_CMD, "")
  71     dev.send_data(packed)
  72     info = dev.recv_data(18)
  73     fmt = '>IIIBBHH'
  74     _HEADER, SCI, RMB, NOA, TYP, BFV, _FOOTER = struct.unpack(fmt, info)
  75     print('====================')
  76     if TYP == 0x02:
  77         print('Chip: RA MCU + RA2/RA4 Series')
  78     elif TYP == 0x03:
  79         print('Chip: RA MCU + RA6 Series')
  80     else:
  81         print('Unknown MCU type')
  82     print(f'Serial interface speed: {SCI} Hz')
  83     print(f'Recommend max UART baud rate: {RMB} bps')
  84     print(f'User area in Code flash [{NOA & 0x1}|{NOA & 0x02 >> 1}]')
  85     print(f'User area in Data flash [{NOA & 0x03 >> 2}]')
  86     print(f'Config area [{NOA & 0x04 >> 3}]')
  87     print(f'Boot firmware: version {BFV >> 8}.{BFV & 0xFF}')
  88
  89 def erase_chip(dev, start_addr, size):
  90
  91     if size == None:
  92         size = dev.chip_layout[dev.sel_area]['EAD'] - start_addr # erase all
  93
  94     (start_addr, end_addr) = set_size_boundaries(dev, start_addr, size)
  95     print(f'Erasing {hex(start_addr)}:{hex(end_addr)}')
  96
  97     # setup initial communication
  98     SAD = int_to_hex_list(start_addr)
  99     EAD = int_to_hex_list(end_addr)
 100     packed = pack_pkt(ERA_CMD, SAD + EAD)
 101     dev.send_data(packed)
 102
 103     ret = dev.recv_data(7, timeout=1000) # erase takes usually a bit longer
 104     unpack_pkt(ret)
 105     print("Erase complete")
 106
 107 def read_img(dev, img, start_addr, size):
 108
 109     if size == None:
 110         size = 0x3FFFF - start_addr # read maximum possible
 111
 112     (start_addr, end_addr) = set_size_boundaries(dev, start_addr, size)
 113
 114     # setup initial communication
 115     SAD = int_to_hex_list(start_addr)
 116     EAD = int_to_hex_list(end_addr)
 117     packed = pack_pkt(REA_CMD, SAD + EAD)
 118     dev.send_data(packed)
 119
 120     # calculate how many packets are have to be received
 121     nr_packet = (end_addr - start_addr) // 1024 # TODO: set other than just 1024
 122
 123     with open(img, 'wb') as f:
 124         for i in tqdm(range(0, nr_packet+1), desc="Reading progress"):
 125             ret = dev.recv_data(1024 + 6)
 126             chunk = unpack_pkt(ret)
 127             chunky = bytes(int(x, 16) for x in chunk)
 128             f.write(chunky)
 129             packed = pack_pkt(REA_CMD, ['0x00'], ack=True)
 130             dev.send_data(packed)
 131
 132
 133 def write_img(dev, img, start_addr, size, verify=False):
 134
 135     if os.path.exists(img):
 136         file_size = os.path.getsize(img)
 137     else:
 138         raise Exception(f'file {img} does not exist')
 139
 140     if size == None:
 141         size = file_size
 142
 143     if size > file_size:
 144         raise ValueError("Write size > file size")
 145
 146     (start_addr, end_addr) = set_size_boundaries(dev, start_addr, size)
 147
 148     chunk_size = 1024 # max is 1024 according to protocol
 149
 150     # setup initial communication
 151     SAD = int_to_hex_list(start_addr)
 152     EAD = int_to_hex_list(end_addr)
 153     packed = pack_pkt(WRI_CMD, SAD + EAD)
 154     dev.send_data(packed)
 155     ret = dev.recv_data(7)
 156     unpack_pkt(ret)
 157
 158     totalread = 0
 159     with open(img, 'rb') as f:
 160         with tqdm(total=size, desc="Writing progress") as pbar:
 161             chunk = f.read(chunk_size)
 162             pbar.update(len(chunk))
 163             while chunk and totalread < size:
 164                 if len(chunk) != chunk_size:
 165                     padding_length = chunk_size - len(chunk)
 166                     chunk += b'\0' * padding_length
 167                 packed = pack_pkt(WRI_CMD, chunk, ack=True)
 168                 dev.send_data(packed)
 169                 reply_len = 7
 170                 reply = dev.recv_data(reply_len)
 171                 msg = unpack_pkt(reply)
 172                 chunk = f.read(chunk_size)
 173                 totalread += chunk_size
 174                 pbar.update(len(chunk))
 175
 176
 177     if verify:
 178         with tempfile.NamedTemporaryFile(prefix='.hidden_', delete=False) as tmp_file, open(img, 'rb') as cmp_file:
 179             read_img(dev, tmp_file.name, start_addr, size)
 180             c1 = tmp_file.read(file_size) # due to byte alignment read file is longer
 181             c2 = cmp_file.read()
 182             if c1 == c2:
 183                 print("Verify complete")
 184             else:
 185                 print("Verify failed")
 186
 187 def main():
 188     parser = argparse.ArgumentParser(description="RA Flasher Tool")
 189
 190     subparsers = parser.add_subparsers(dest="command", title="Commands")
 191
 192     write_parser = subparsers.add_parser("write", help="Write data to flash")
 193     write_parser.add_argument("--start_address", type=hex_type, default='0x0000', help="Start address")
 194     write_parser.add_argument("--size", type=hex_type, default=None, help="Size in bytes")
 195     write_parser.add_argument("--verify", action="store_true", help="Verify after writing")
 196     write_parser.add_argument("file_name", type=str, help="File name")
 197
 198     read_parser = subparsers.add_parser("read", help="Read data from flash")
 199     read_parser.add_argument("--start_address", type=hex_type, default='0x0000', help="Start address")
 200     read_parser.add_argument("--size", type=hex_type, default=None, help="Size in bytes")
 201     read_parser.add_argument("file_name", type=str, help="File name")
 202
 203     erase_parser = subparsers.add_parser("erase", help="Erase sectors")
 204     erase_parser.add_argument("--start_address", default='0x0000', type=hex_type, help="Start address")
 205     erase_parser.add_argument("--size", type=hex_type, help="Size")
 206
 207     subparsers.add_parser("info", help="Show flasher information")
 208
 209     args = parser.parse_args()
 210
 211     if args.command in commands:
 212         dev = RAConnect(VENDOR_ID, PRODUCT_ID)
 213         area_cfg = get_area_info(dev)
 214         dev.set_chip_layout(area_cfg)
 215         commands[args.command](dev, args)
 216     else:
 217         parser.print_help()
 218
 219 if __name__ == "__main__":
 220     main()