-
Notifications
You must be signed in to change notification settings - Fork 14
/
nxpprog.py
executable file
·1351 lines (1153 loc) · 42.1 KB
/
nxpprog.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python3
#
# Copyright (c) 2009 Brian Murphy <[email protected]>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# A simple programmer which works with the ISP protocol on NXP LPC arm
# processors.
import binascii
import os
import sys
import struct
import getopt
import serial # pyserial
import socket
import time
import ihex
CMD_SUCCESS = 0
INVALID_COMMAND = 1
SRC_ADDR_ERROR = 2
DST_ADDR_ERROR = 3
SRC_ADDR_NOT_MAPPED = 4
DST_ADDR_NOT_MAPPED = 5
COUNT_ERROR = 6
INVALID_SECTOR = 7
SECTOR_NOT_BLANK = 8
SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION = 9
COMPARE_ERROR = 10
BUSY = 11
PARAM_ERROR = 12
ADDR_ERROR = 13
ADDR_NOT_MAPPED = 14
CMD_LOCKED = 15
INVALID_CODE = 16
INVALID_BAUD_RATE = 17
INVALID_STOP_BIT = 18
CODE_READ_PROTECTION_ENABLED = 19
# flash sector sizes for lpc23xx/lpc24xx/lpc214x processors
flash_sector_lpc23xx = (
4, 4, 4, 4, 4, 4, 4, 4,
32, 32, 32, 32, 32, 32, 32,
32, 32, 32, 32, 32, 32, 32,
4, 4, 4, 4, 4, 4
)
# flash sector sizes for 64k lpc21xx processors (without bootsector)
flash_sector_lpc21xx_64 = (
8, 8, 8, 8, 8, 8, 8, 8
)
# flash sector sizes for 128k lpc21xx processors (without bootsector)
flash_sector_lpc21xx_128 = (
8, 8, 8, 8, 8, 8, 8, 8,
8, 8, 8, 8, 8, 8, 8
)
# flash sector sizes for 256k lpc21xx processors (without bootsector)
flash_sector_lpc21xx_256 = (
8, 8, 8, 8, 8, 8, 8, 8,
64, 64,
8, 8, 8, 8, 8, 8, 8,
)
# flash sector sizes for lpc17xx processors
flash_sector_lpc17xx = (
4, 4, 4, 4, 4, 4, 4, 4,
4, 4, 4, 4, 4, 4, 4, 4,
32, 32, 32, 32, 32, 32, 32,
32, 32, 32, 32, 32, 32, 32,
)
# flash sector sizes for lpc11xx processors
flash_sector_lpc11xx = (
4, 4, 4, 4, 4, 4, 4, 4,
)
# flash sector sizes for lpc18xx processors
flash_sector_lpc18xx = (
8, 8, 8, 8, 8, 8, 8, 8,
64, 64, 64, 64, 64, 64, 64,
)
flash_prog_buffer_base_default = 0x40001000
flash_prog_buffer_size_default = 4096
# cpu parameter table
cpu_parms = {
# 128k flash
"lpc2364" : {
"flash_sector" : flash_sector_lpc23xx,
"flash_sector_count": 11,
"devid": 369162498
},
# 256k flash
"lpc2365" : {
"flash_sector" : flash_sector_lpc23xx,
"flash_sector_count": 15,
"devid": 369158179
},
"lpc2366" : {
"flash_sector" : flash_sector_lpc23xx,
"flash_sector_count": 15,
"devid": 369162531
},
# 512k flash
"lpc2367" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 369158181
},
"lpc2368" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 369162533
},
"lpc2377" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 385935397
},
"lpc2378" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 385940773
},
"lpc2387" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 402716981
},
"lpc2388" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 402718517
},
# lpc21xx
# some incomplete info here need at least sector count
"lpc2141": {
"devid": 196353,
"flash_sector": flash_sector_lpc23xx,
"flash_sector_count": 8,
},
"lpc2142": {
"flash_sector": flash_sector_lpc23xx,
"flash_sector_count": 9,
"devid": 196369,
},
"lpc2144": {
"flash_sector": flash_sector_lpc23xx,
"flash_sector_count": 11,
"devid": 196370,
},
"lpc2146": {
"flash_sector": flash_sector_lpc23xx,
"flash_sector_count": 15,
"devid": 196387,
},
"lpc2148": {
"flash_sector": flash_sector_lpc23xx,
"flash_sector_count": 27,
"devid": 196389,
},
"lpc2109" : {
"flash_sector": flash_sector_lpc21xx_64,
"devid": 33685249
},
"lpc2119" : {
"flash_sector": flash_sector_lpc21xx_128,
"devid": 33685266
},
"lpc2129" : {
"flash_sector": flash_sector_lpc21xx_256,
"devid": 33685267
},
"lpc2114" : {
"flash_sector" : flash_sector_lpc21xx_128,
"devid": 16908050
},
"lpc2124" : {
"flash_sector" : flash_sector_lpc21xx_256,
"devid": 16908051
},
"lpc2194" : {
"flash_sector" : flash_sector_lpc21xx_256,
"devid": 50462483
},
"lpc2292" : {
"flash_sector" : flash_sector_lpc21xx_256,
"devid": 67239699
},
"lpc2294" : {
"flash_sector" : flash_sector_lpc21xx_256,
"devid": 84016915
},
# lpc22xx
"lpc2212" : {
"flash_sector" : flash_sector_lpc21xx_128
},
"lpc2214" : {
"flash_sector" : flash_sector_lpc21xx_256
},
# lpc24xx
"lpc2458" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 352386869,
},
"lpc2468" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 369164085,
},
"lpc2478" : {
"flash_sector" : flash_sector_lpc23xx,
"devid": 386006837,
},
# lpc17xx
"lpc1769" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10000200,
"csum_vec": 7,
"devid": 0x26113f37,
"cpu_type": "thumb",
},
"lpc1768" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26013f37,
"cpu_type": "thumb",
},
"lpc1767" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26012837,
"cpu_type": "thumb",
},
"lpc1766" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26013f33,
"cpu_type": "thumb",
},
"lpc1765" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26013733,
"cpu_type": "thumb",
},
"lpc1764" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26011922,
"cpu_type": "thumb",
},
"lpc1763" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x26012033,
"cpu_type": "thumb",
},
"lpc1759" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25113737,
"cpu_type": "thumb",
},
"lpc1758" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25013f37,
"cpu_type": "thumb",
},
"lpc1756" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25011723,
"cpu_type": "thumb",
},
"lpc1754" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25011722,
"cpu_type": "thumb",
},
"lpc1752" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25001121,
"cpu_type": "thumb",
},
"lpc1751" : {
"flash_sector" : flash_sector_lpc17xx,
"flash_prog_buffer_base" : 0x10001000,
"csum_vec": 7,
"devid": 0x25001110,
"cpu_type": "thumb",
},
"lpc1114" : {
"flash_sector" : flash_sector_lpc11xx,
"flash_prog_buffer_base" : 0x10000400,
"devid": 0x0444102B,
"flash_prog_buffer_size" : 1024
},
# lpc18xx
"lpc1817" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_bank_addr": (0x1a000000, 0x1b000000),
"flash_prog_buffer_base" : 0x10081000,
"devid": (0xF001DB3F, 0),
"devid_word1_mask": 0xff,
"csum_vec": 7,
"cpu_type": "thumb",
},
"lpc1832" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_bank_addr": (0x1a000000),
"flash_prog_buffer_base" : 0x10081000,
"csum_vec": 7,
"cpu_type": "thumb",
},
"lpc1833" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_sector_count": 11,
"flash_bank_addr": (0x1a000000, 0x1b000000),
"flash_prog_buffer_base" : 0x10081000,
"devid": (0xf001da30, 0x44),
"csum_vec": 7,
"cpu_type": "thumb",
},
"lpc1837" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_bank_addr": (0x1a000000, 0x1b000000),
"flash_prog_buffer_base" : 0x10081000,
"devid": (0xf001da30, 0),
"csum_vec": 7,
"cpu_type": "thumb",
},
"lpc1853" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_sector_count": 11,
"flash_bank_addr": (0x1a000000, 0x1b000000),
"flash_prog_buffer_base" : 0x10081000,
"devid": (0xf001d830, 0),
"csum_vec": 7,
"cpu_type": "thumb",
},
"lpc1857" : {
"flash_sector" : flash_sector_lpc18xx,
"flash_bank_addr": (0x1a000000, 0x1b000000),
"flash_prog_buffer_base" : 0x10081000,
"devid": (0xf001d830, 0x44),
"csum_vec": 7,
"cpu_type": "thumb",
},
}
def log(str):
sys.stderr.write("%s\n" % str)
sys.stderr.flush()
def dump(name, str):
sys.stderr.write("%s:\n" % name)
ct = 0
for i in str:
sys.stderr.write("%x, " % ord(i))
ct += 1
if ct == 4:
ct = 0
sys.stderr.write("\n")
sys.stderr.write("\n")
def panic(str):
log(str)
sys.exit(1)
def syntax():
panic(
"""\
{0} <serial device> <image_file> : program image file to processor.
{0} --udp <ip address> <image_file> : program processor using Ethernet.
{0} --start=<addr> <serial device> : start the device at <addr>.
{0} --read=<file> --addr=<address> --len=<length> <serial device>:
read length bytes from address and dump them to a file.
{0} --serialnumber <serial device> : get the device serial number
{0} --list : list supported processors.
options:
--cpu=<cpu> : set the cpu type.
--oscfreq=<freq> : set the oscillator frequency.
--baud=<baud> : set the baud rate.
--xonxoff : enable xonxoff flow control.
--control : use RTS and DTR to control reset and int0.
--addr=<image start address> : set the base address for the image.
--verify : read the device after programming.
--verifyonly : don't program, just verify.
--eraseonly : don't program, just erase. Implies --eraseall.
--eraseall : erase all flash not just the area written to.
--blankcheck : don't program, just check that the flash is blank.
--filetype=[ihex|bin] : set filetype to intel hex format or raw binary.
--bank=[0|1] : select bank for devices with flash banks.
--port=<udp port> : UDP port number to use (default 41825).
--mac=<mac address> : MAC address to associate IP address with.\
""".format(os.path.basename(sys.argv[0])))
class SerialDevice(object):
def __init__(self, device, baud, xonxoff=False, control=False):
# Create the Serial object without port to avoid automatic opening
self._serial = serial.Serial(port=None, baudrate=baud)
# Disable RTS and DRT to avoid automatic reset to ISP mode (use --control for explicit reset)
self._serial.setRTS(0)
self._serial.setDTR(0)
# Select and open the port after RTS and DTR are set to zero
self._serial.setPort(device)
self._serial.open()
# set a two second timeout just in case there is nothing connected
# or the device is in the wrong mode.
# This timeout is too short for slow baud rates but who wants to
# use them?
self._serial.setTimeout(5)
# device wants Xon Xoff flow control
if xonxoff:
self._serial.setXonXoff(1)
# reset pin is controlled by DTR implying int0 is controlled by RTS
self.reset_pin = "dtr"
if control:
self.isp_mode()
self._serial.flushInput()
# put the chip in isp mode by resetting it using RTS and DTR signals
# this is of course only possible if the signals are connected in
# this way
def isp_mode(self):
self.reset(0)
time.sleep(.1)
self.reset(1)
self.int0(1)
time.sleep(.1)
self.reset(0)
time.sleep(.1)
self.int0(0)
def reset(self, level):
if self.reset_pin == "rts":
self._serial.setRTS(level)
else:
self._serial.setDTR(level)
def int0(self, level):
# if reset pin is rts int0 pin is dtr
if self.reset_pin == "rts":
self._serial.setDTR(level)
else:
self._serial.setRTS(level)
def write(self, data):
self._serial.write(data)
def readline(self, timeout=None):
if timeout:
ot = self._serial.getTimeout()
self._serial.setTimeout(timeout)
line = b''
while True:
c = self._serial.read(1)
if not c:
break
if c == b'\r':
if not line:
continue
else:
break
if c == b'\n':
if not line:
continue
else:
break
line += c
if timeout:
self._serial.setTimeout(ot)
return line.decode("UTF-8", "ignore")
class UdpDevice(object):
def __init__(self, address):
self._sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
self._sock.settimeout(5)
self._inet_addr = address[0]
self._udp_port = address[1]
self._eth_addr = address[2]
if self._eth_addr:
import subprocess
# Try add host to ARP table
obj = subprocess.Popen(['arp', '-s', self._inet_addr, self._eth_addr],
stdout=subprocess.PIPE, stderr=subprocess.PIPE,
shell=True)
res = obj.communicate()
stdout_text = res[0].decode('ascii', 'ignore') if res[0] else ""
stderr_text = res[1].decode('ascii', 'ignore') if res[1] else ""
if obj.returncode or stderr_text:
panic("Failed to register IP address " +
"(Administrative privileges may be required)\r\n" +
stderr_text.replace('\r', '').replace('\n', ''))
self._sock.bind(('', self._udp_port))
def write(self, data):
self._sock.sendto(data, (self._inet_addr, self._udp_port))
def readline(self, timeout=None):
if timeout:
ot = self._sock.gettimeout()
self._sock.settimeout(timeout)
try:
line, addr = self._sock.recvfrom(1024)
except Exception as e:
line = b""
if timeout:
self._sock.settimeout(ot)
return line.decode("UTF-8", "ignore").replace('\r','').replace('\n','')
class nxpprog:
def __init__(self, cpu, device, baud, osc_freq, xonxoff=False, control=False, address=None, verify=False):
self.echo_on = True
self.verify = verify
self.OK = 'OK'
self.RESEND = 'RESEND'
self.sync_str = 'Synchronized'
# for calculations in 32 bit modulo arithmetic
self.U32_MOD = (2 ** 32)
# uuencoded line length
self.uu_line_size = 45
# uuencoded block length
self.uu_block_size = self.uu_line_size * 20
if address:
self.device = UdpDevice(address)
else:
self.device = SerialDevice(device, baud, xonxoff, control)
self.cpu = cpu
self.connection_init(osc_freq)
self.banks = self.get_cpu_parm("flash_bank_addr", 0)
if self.banks == 0:
self.sector_commands_need_bank = False
else:
self.sector_commands_need_bank = True
def connection_init(self, osc_freq):
self.sync(osc_freq)
if self.cpu == "autodetect":
devid = self.get_devid()
for dcpu in cpu_parms.keys():
cpu_devid = cpu_parms[dcpu].get("devid")
if not cpu_devid:
continue
# mask devid word1
devid_word1_mask = cpu_parms[dcpu].get("devid_word1_mask")
if devid_word1_mask and isinstance(devid, tuple) and devid[0] == cpu_devid[0] and (devid[1] & devid_word1_mask) == (cpu_devid[1] & devid_word1_mask):
log("Detected %s" % dcpu)
self.cpu = dcpu
break
if devid == cpu_devid:
log("Detected %s" % dcpu)
self.cpu = dcpu
break
if self.cpu == "autodetect":
panic("Cannot autodetect from device id %d(0x%x), set cpu name manually" %
(devid, devid))
# unlock write commands
self.isp_command("U 23130")
def dev_write(self, data):
self.device.write(data)
def dev_writeln(self, data):
data = data.encode('UTF-8') + b'\r\n'
# print('> ' + data)
self.device.write(data)
def dev_readline(self, timeout=None):
data = self.device.readline(timeout)
# print('< ' + data)
return data
def errexit(self, str, status):
if not status:
panic("%s: timeout" % str)
err = int(status)
if err != 0:
error_desc = [
'CMD_SUCCESS: Command is executed successfully',
'INVALID_COMMAND: Invalid command',
'SRC_ADDR_ERROR: Source address is not on word boundary',
'DST_ADDR_ERROR: Destination address is not on word or 256 byte boundary',
'SRC_ADDR_NOT_MAPPED: Source address is not mapped in the memory map',
'DST_ADDR_NOT_MAPPED: Destination address is not mapped in the memory map',
'COUNT_ERROR: Byte count is not multiple of 4 or is not a permitted value',
'INVALID_SECTOR: Sector number is invalid or end sector number is greater than start sector number',
'SECTOR_NOT_BLANK: Sector is not blank',
'SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION: Command to prepare sector for write operation was not executed',
'COMPARE_ERROR: Source and destination data not equal',
'BUSY: Flash programming hardware interface is busy',
'PARAM_ERROR: Insufficient number of parameters or invalid parameter',
'ADDR_ERROR: Address not on word boundary',
'ADDR_NOT_MAPPED: Address is not mapped in the memory map',
'CMD_LOCKED: Command is locked',
'INVALID_CODE: Unlock code is invalid',
'INVALID_BAUD_RATE: Invalid baud rate setting',
'INVALID_STOP_BIT: Invalid stop bit setting',
'CODE_READ_PROTECTION_ENABLED: Code read protection enabled'
]
str = str.replace('\r','').replace('\n','')
errstr = error_desc[err] if err < len(error_desc) else ""
panic("%s: %d - %s" % (str, err, errstr))
def isp_command(self, cmd):
retry = 3
while retry > 0:
retry -= 1
self.dev_writeln(cmd)
# throw away echo data
if self.echo_on:
echo = self.dev_readline()
if self.verify and echo != cmd:
log('Invalid echo')
status = self.dev_readline()
if status:
break
self.errexit("'%s' error" % cmd, status)
return status
def sync(self, osc):
self.dev_write(b'?')
s = self.dev_readline()
if not s:
panic("Sync timeout")
if s != self.sync_str:
panic("No sync string")
self.dev_writeln(self.sync_str)
s = self.dev_readline()
# detect echo state
if s == self.sync_str:
self.echo_on = True
s = self.dev_readline()
elif s == self.OK:
self.echo_on = False
else:
panic("No sync string")
if s != self.OK:
panic("Not ok")
# set the oscillator frequency
self.dev_writeln('%d' % osc)
if self.echo_on:
s = self.dev_readline()
if s != ('%d' % osc):
panic('Invalid echo')
s = self.dev_readline()
if s != self.OK:
if s == str(INVALID_COMMAND):
pass
else:
self.errexit("'%d' osc not ok" % osc, s)
panic("Osc not ok")
# disable echo
self.dev_writeln('A 0')
if self.echo_on:
s = self.dev_readline()
if s != 'A 0':
panic('Invalid echo')
s = self.dev_readline()
if s == str(CMD_SUCCESS):
self.echo_on = False
elif s == str(INVALID_COMMAND):
pass
else:
self.errexit("'A 0' echo disable failed", s)
panic("Echo disable failed")
def sum(self, data):
s = 0
if isinstance(data, str):
for ch in data:
s += ord(ch)
else:
for i in data:
s += i
return s
def write_ram_block(self, addr, data):
data_len = len(data)
for i in range(0, data_len, self.uu_line_size):
c_line_size = data_len - i
if c_line_size > self.uu_line_size:
c_line_size = self.uu_line_size
block = data[i:i+c_line_size]
bstr = binascii.b2a_uu(block)
self.dev_write(bstr)
retry = 3
while retry > 0:
retry -= 1
self.dev_writeln('%s' % self.sum(data))
status = self.dev_readline()
if status:
break
if not status:
return "timeout"
if status == self.RESEND:
return "resend"
if status == self.OK:
return ""
# unknown status result
panic(status)
def uudecode(self, line):
# uu encoded data has an encoded length first
linelen = ord(line[0]) - 32
uu_linelen = (linelen + 3 - 1) // 3 * 4
if uu_linelen + 1 != len(line):
panic("Error in line length")
# pure python implementation - if this was C we would
# use bitshift operations here
decoded = ""
for i in range(1, len(line), 4):
c = 0
for j in line[i: i + 4]:
ch = ord(j) - 32
ch %= 64
c = c * 64 + ch
s = []
for j in range(0, 3):
s.append(c % 256)
c = c // 256
for j in reversed(s):
decoded = decoded + chr(j)
# only return real data
return decoded[0:linelen]
def read_block(self, addr, data_len, fd=None):
self.isp_command("R %d %d" % ( addr, data_len ))
expected_lines = (data_len + self.uu_line_size - 1) // self.uu_line_size
data = ""
for i in range(0, expected_lines, 20):
lines = expected_lines - i
if lines > 20:
lines = 20
cdata = ""
for i in range(0, lines):
line = self.dev_readline()
decoded = self.uudecode(line)
cdata += decoded
s = self.dev_readline()
if int(s) != self.sum(cdata):
panic("Checksum mismatch on read got 0x%x expected 0x%x" % (int(s), self.sum(data)))
else:
self.dev_writeln(self.OK)
if fd:
fd.write(cdata)
else:
data += cdata
if fd:
return None
else:
return data
def write_ram_data(self, addr, data):
image_len = len(data)
for i in range(0, image_len, self.uu_block_size):
a_block_size = image_len - i
if a_block_size > self.uu_block_size:
a_block_size = self.uu_block_size
self.isp_command("W %d %d" % ( addr, a_block_size ))
retry = 3
while retry > 0:
retry -= 1
err = self.write_ram_block(addr, data[i : i + a_block_size])
if not err:
break
elif err != "resend":
panic("Write error: %s" % err)
else:
log("Resending")
addr += a_block_size
def find_flash_sector(self, addr):
table = self.get_cpu_parm("flash_sector")
flash_base_addr = self.get_cpu_parm("flash_bank_addr", 0)
if flash_base_addr == 0:
faddr = 0
else:
faddr = flash_base_addr[0] # fix to have a current flash bank
for i in range(0, len(table)):
n_faddr = faddr + table[i] * 1024
if addr >= faddr and addr < n_faddr:
return i
faddr = n_faddr
return -1
def bytestr(self, ch, count):
data = b''
for i in range(0, count):
data += bytes([ch])
return data
def insert_csum(self, orig_image):
# make this a valid image by inserting a checksum in the correct place
intvecs = struct.unpack("<8I", orig_image[0:32])
# default vector is 5: 0x14, new cortex cpus use 7: 0x1c
valid_image_csum_vec = self.get_cpu_parm("csum_vec", 5)
# calculate the checksum over the interrupt vectors
csum = 0
intvecs_list = []
for vec in range(0, len(intvecs)):
intvecs_list.append(intvecs[vec])
if valid_image_csum_vec == 5 or vec <= valid_image_csum_vec:
csum = csum + intvecs[vec]
# remove the value at the checksum location
csum -= intvecs[valid_image_csum_vec]
csum %= self.U32_MOD
csum = self.U32_MOD - csum
log("Inserting intvec checksum 0x%08x in image at offset %d" %
(csum, valid_image_csum_vec))
intvecs_list[valid_image_csum_vec] = csum
image = b''
for vecval in intvecs_list:
image += struct.pack("<I", vecval)
image += orig_image[32:]
return image
def prepare_flash_sectors(self, start_sector, end_sector):
if self.sector_commands_need_bank:
self.isp_command("P %d %d 0" % (start_sector, end_sector))
else:
self.isp_command("P %d %d" % (start_sector, end_sector))
def erase_sectors(self, start_sector, end_sector, verify=False):
self.prepare_flash_sectors(start_sector, end_sector)
log("Erasing flash sectors %d-%d" % (start_sector, end_sector))
if self.sector_commands_need_bank:
self.isp_command("E %d %d 0" % (start_sector, end_sector))
else:
self.isp_command("E %d %d" % (start_sector, end_sector))
if verify:
log("Blank checking sectors %d-%d" % (start_sector, end_sector))
self.blank_check_sectors(start_sector, end_sector)
def blank_check_sectors(self, start_sector, end_sector):
global panic
old_panic = panic
panic = log
for i in range(start_sector, end_sector+1):
if self.sector_commands_need_bank:
cmd = ("I %d %d 0" % (i, i))
else:
cmd = ("I %d %d" % (i, i))
result = self.isp_command(cmd)
if result == str(CMD_SUCCESS):
pass
elif result == str(SECTOR_NOT_BLANK):
self.dev_readline() # offset
self.dev_readline() # content
else:
self.errexit("'%s' error" % cmd, status)
panic = old_panic
def erase_flash_range(self, start_addr, end_addr, verify=False):
start_sector = self.find_flash_sector(start_addr)
end_sector = self.find_flash_sector(end_addr)
self.erase_sectors(start_sector, end_sector, verify)
def get_cpu_parm(self, key, default=None):
ccpu_parms = cpu_parms.get(self.cpu)
if not ccpu_parms:
panic("No parameters defined for cpu %s" % self.cpu)
parm = ccpu_parms.get(key)
if parm:
return parm
if default is not None:
return default
else:
panic("No value for required cpu parameter %s" % key)
def erase_all(self, verify=False):
end_sector = self.get_cpu_parm("flash_sector_count",
len(self.get_cpu_parm("flash_sector"))) - 1
self.erase_sectors(0, end_sector, verify)
def blank_check_all(self):
end_sector = self.get_cpu_parm("flash_sector_count",
len(self.get_cpu_parm("flash_sector"))) - 1
self.blank_check_sectors(0, end_sector)
def prog_image(self, image, flash_addr_base=0,