RAFlasher.py: add progress bar
[renesas-ra-flasher] / src / RAFlasher.py
1 import os
2 import math
3 import time
4 import argparse
5 from tqdm import tqdm
6 from RAConnect import *
7 from RAPacker import *
8
9 SECTOR_SIZE = 2048
10
11 def int_to_hex_list(num):
12     hex_string = hex(num)[2:].upper()  # convert to hex string
13     hex_string = hex_string.zfill(8) # pad for 8 char's long
14     hex_list = [f'0x{hex_string[c:c+2]}' for c in range(0, 8, 2)]
15     return hex_list
16
17 def inquire_connection(dev):
18     packed = pack_pkt(INQ_CMD, "")
19     dev.send_data(packed)
20     info = dev.recv_data(7)
21     #print(info)
22     if info == bytearray(b'\x00') or info == bytearray(b''):
23         return False
24     msg = unpack_pkt(info)
25     print("Connection already established")
26     #print(msg)
27     return True
28
29 def get_area_info(dev):
30     for i in [0,1,2]:
31         print("===================")
32         packed = pack_pkt(ARE_CMD, [str(i)])
33         dev.send_data(packed)
34         info = dev.recv_data(23)
35         msg = unpack_pkt(info)
36         fmt = '>BIIII'
37         KOA, SAD, EAD, EAU, WAU = struct.unpack(fmt, bytes(int(x, 16) for x in msg))
38         print(f'Area {KOA} - {hex(SAD)}:{hex(EAD)}')
39         print(f'Erase {hex(EAU)} bytes - write {hex(WAU)} bytes')
40
41 def get_dev_info(dev):
42
43     packed = pack_pkt(SIG_CMD, "")
44     dev.send_data(packed)
45     print(packed)
46     info = dev.recv_data(18)
47     print(info, len(info))
48     #info = b'\x81\x00\x0D\x3A\x01\x31\x2d\x00\x00\x1e\x84\x80\x04\x02\x0a\x08' # test
49     fmt = '>IIIBBHH'
50     _HEADER, SCI, RMB, NOA, TYP, BFV, _FOOTER = struct.unpack(fmt, info)
51     print('Chip info:')
52     print('====================')
53     print(f'Serial interface speed: {SCI} Hz')
54     print(f'Recommend max UART baud rate {RMB} bps')
55     print(f'User area in Code flash [{NOA & 0x1}|{NOA & 0x02 >> 1}]')
56     print(f'User area in Data flash [{NOA & 0x03 >> 2}]')
57     print(f'Config area [{NOA & 0x04 >> 3}]')
58     if TYP == 0x02:
59         print('RA MCU + RA2/RA4 Series')
60     elif TYP == 0x03:
61         print('RA MCU + RA6 Series')
62     else:
63         print('Unknown MCU type')
64     print(f'Boot firmware version {BFV >> 8}.{BFV & 0xFF}')
65     print('====================')
66
67
68 def verify_img(dev, img, start_addr, end_addr):
69     raise Exception("Not implemented")
70
71 def read_img(dev, img, start_addr, end_addr):
72     
73     # calculate / check start and end address 
74     if start_addr == None or end_addr == None:
75         if start_addr == None:
76             start_addr = 0
77         # align start addr
78         if start_addr % SECTOR_SIZE:
79             raise ValueError(f"start addr not aligned on sector size {SECTOR_SIZE}")
80         blocks = (file_size + SECTOR_SIZE - 1) // SECTOR_SIZE
81         end_addr = blocks * SECTOR_SIZE + start_addr
82         print(end_addr)
83     
84     if (start_addr > 0xFF800): # for RA4 series
85         raise ValueError("start address value error")
86     if (end_addr <= start_addr or end_addr > 0xFF800):
87         raise ValueError("end address value error")
88     
89     # setup initial communication
90     SAD = int_to_hex_list(start_addr)
91     EAD = int_to_hex_list(end_addr)
92     packed = pack_pkt(REA_CMD, SAD + EAD)
93     dev.send_data(packed)
94
95     # calculate how many packets are have to be received
96     nr_packet = (end_addr - start_addr) // 1024 # TODO: set other than just 1024
97     print(f'Sending {nr_packet} packets to MCU')
98
99     with open('output.bin', 'wb') as f:
100         for i in tqdm(range(0, nr_packet+1), desc="Reading progess"):
101             ret = dev.recv_data(1024 + 6)
102             #print(f'Packet nr: {i}')
103             chunk = unpack_pkt(ret)
104             chunky = bytes(int(x, 16) for x in chunk)
105             f.write(chunky)
106             #print(ret)
107             packed = pack_pkt(REA_CMD, ['0x00'], ack=True)
108             dev.send_data(packed)
109
110
111 def write_img(dev, img, start_addr, end_addr, verify=False):
112
113     if os.path.exists(img):
114         file_size = os.path.getsize(img)
115     else:
116         raise Exception(f'file {img} does not exist')
117
118     # calculate / check start and end address 
119     if start_addr == None or end_addr == None:
120         if start_addr == None:
121             start_addr = 0
122         # align start addr
123         if start_addr % SECTOR_SIZE:
124             raise ValueError(f"start addr not aligned on sector size {SECTOR_SIZE}")
125         blocks = (file_size + SECTOR_SIZE - 1) // SECTOR_SIZE
126         end_addr = blocks * SECTOR_SIZE + start_addr - 1
127     
128     chunk_size = 1024 # max is 1024
129     #if (start_addr > 0xFF800): # for RA4 series
130     #    raise ValueError("start address value error")
131     #if (end_addr <= start_addr or end_addr > 0xFF800):
132     #    raise ValueError("end address value error")
133
134     # setup initial communication
135     SAD = int_to_hex_list(start_addr)
136     EAD = int_to_hex_list(end_addr)
137     print(SAD, EAD)
138     #packed = pack_pkt(ERA_CMD, SAD + EAD) # actually works
139     packed = pack_pkt(WRI_CMD, SAD + EAD)
140     print(packed)
141     dev.send_data(packed)
142     ret = dev.recv_data(7)
143     unpack_pkt(ret) 
144
145     with open(img, 'rb') as f:
146         with tqdm(total=file_size, desc="Sending chunks") as pbar:
147             chunk = f.read(chunk_size)
148             pbar.update(len(chunk))
149             while chunk:
150                 if len(chunk) != chunk_size:
151                     padding_length = chunk_size - len(chunk)
152                     chunk += b'\0' * padding_length
153                 packed = pack_pkt(WRI_CMD, chunk, ack=True)
154                 dev.send_data(packed)
155                 reply_len = 7
156                 reply = dev.recv_data(reply_len)
157                 msg = unpack_pkt(reply)
158                 chunk = f.read(chunk_size)
159                 pbar.update(len(chunk))
160
161
162 def main():
163     parser = argparse.ArgumentParser(description="RA Flasher Tool")
164
165     subparsers = parser.add_subparsers(dest="command", title="Commands")
166
167     # Subparser for the write command
168     write_parser = subparsers.add_parser("write", help="Write data to flash")
169     write_parser.add_argument("--start_address", type=int, default=0x0000, help="Start address")
170     write_parser.add_argument("--end_address", type=int, help="End address")
171     write_parser.add_argument("--verify", action="store_true", help="Verify after writing")
172     write_parser.add_argument("file_name", type=str, help="File name")
173
174     # Subparser for the read command
175     read_parser = subparsers.add_parser("read", help="Read data from flash")
176     read_parser.add_argument("--start_address", type=int, default=0x000, help="Start address")
177     read_parser.add_argument("--size", type=int, default=1024, help="Size in bytes")
178     read_parser.add_argument("file_name", type=str, help="File name")
179
180     # Subparser for the info command
181     subparsers.add_parser("info", help="Show flasher information")
182
183     args = parser.parse_args()
184
185     if args.command == "write":
186         dev = RAConnect(vendor_id=0x045B, product_id=0x0261)
187         print(args)
188         write_img(dev, args.file_name, args.start_address, args.end_address, args.verify)
189     elif args.command == "read":
190         print('read command')
191     elif args.command == "info":
192         dev = RAConnect(vendor_id=0x045B, product_id=0x0261)
193         status_con = inquire_connection(dev)
194         if not status_con:
195             #dev.establish_connection()
196             dev.confirm_connection()
197         get_dev_info(dev)
198         get_area_info(dev)
199         #read_img(dev, "save.bin", 0x0000, 0x3FFFF)
200         write_img(dev, "src/sample.bin", 0x8000, None)
201     else:
202         parser.print_help()
203
204 if __name__ == "__main__":
205     main()
206