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