GoodFETCCSPI added sniffdisect verb that tries to load dot15d4 scapy library to use...
[goodfet] / client / GoodFETARM7.py
1 #!/usr/bin/env python
2 # GoodFET ARM Client Library
3
4 # Contributions and bug reports welcome.
5 #
6 # todo:
7 #  * full cycle debugging.. halt to resume
8 #  * ensure correct PC handling
9 #  * flash manipulation (probably need to get the specific chip for this one)
10 #  * set security (chip-specific)
11
12 import sys, binascii, struct, time
13 from GoodFET import GoodFET
14 from intelhex import IntelHex
15
16
17 #Global Commands
18 READ  = 0x00
19 WRITE = 0x01
20 PEEK  = 0x02
21 POKE  = 0x03
22 SETUP = 0x10
23 START = 0x20
24 STOP  = 0x21
25 CALL  = 0x30
26 EXEC  = 0x31
27 NOK   = 0x7E
28 OK    = 0x7F
29
30 # ARM7TDMI JTAG commands
31 IR_SHIFT =                  0x80
32 DR_SHIFT =                  0x81
33 RESETTAP =                  0x82
34 RESETTARGET =               0x83
35 GET_REGISTER =              0x87
36 SET_REGISTER =              0x88
37 DEBUG_INSTR =               0x89
38 # Really ARM specific stuff
39 WAIT_DBG =                  0x91
40 CHAIN0 =                    0x93
41 SCANCHAIN1 =                0x94
42 EICE_READ =                 0x95
43 EICE_WRITE =                0x96
44
45 IR_EXTEST           =  0x0
46 IR_SCAN_N           =  0x2
47 IR_SAMPLE           =  0x3
48 IR_RESTART          =  0x4
49 IR_CLAMP            =  0x5
50 IR_HIGHZ            =  0x7
51 IR_CLAMPZ           =  0x9
52 IR_INTEST           =  0xC
53 IR_IDCODE           =  0xE
54 IR_BYPASS           =  0xF
55
56 DBG_DBGACK =    1
57 DBG_DBGRQ =     2
58 DBG_IFEN =      4
59 DBG_cgenL =     8
60 DBG_TBIT =      16
61
62
63 EICE_DBGCTRL =                     0  # read 3 bit - Debug Control
64 EICE_DBGCTRL_BITLEN =              3
65 EICE_DBGSTATUS =                   1  # read 5 bit - Debug Status
66 EICE_DBGSTATUS_BITLEN =            5
67 EICE_DBGCCR =                      4  # read 6 bit - Debug Comms Control Register
68 EICE_DBGCCR_BITLEN =               6
69 EICE_DBGCDR =                      5  # r/w 32 bit - Debug Comms Data Register
70 EICE_WP0ADDR =                     8  # r/w 32 bit - Watchpoint 0 Address
71 EICE_WP0ADDRMASK =                 9  # r/w 32 bit - Watchpoint 0 Addres Mask
72 EICE_WP0DATA =                     10 # r/w 32 bit - Watchpoint 0 Data
73 EICE_WP0DATAMASK =                 11 # r/w 32 bit - Watchpoint 0 Data Masl
74 EICE_WP0CTRL =                     12 # r/w 9 bit - Watchpoint 0 Control Value
75 EICE_WP0CTRLMASK =                 13 # r/w 8 bit - Watchpoint 0 Control Mask
76 EICE_WP1ADDR =                     16 # r/w 32 bit - Watchpoint 0 Address
77 EICE_WP1ADDRMASK =                 17 # r/w 32 bit - Watchpoint 0 Addres Mask
78 EICE_WP1DATA =                     18 # r/w 32 bit - Watchpoint 0 Data
79 EICE_WP1DATAMASK =                 19 # r/w 32 bit - Watchpoint 0 Data Masl
80 EICE_WP1CTRL =                     20 # r/w 9 bit - Watchpoint 0 Control Value
81 EICE_WP1CTRLMASK =                 21 # r/w 8 bit - Watchpoint 0 Control Mask
82
83 MSB         = 0
84 LSB         = 1
85 NOEND       = 2
86 NORETIDLE   = 4
87
88 F_TBIT      = 1<<40
89
90 PM_usr = 0b10000
91 PM_fiq = 0b10001
92 PM_irq = 0b10010
93 PM_svc = 0b10011
94 PM_abt = 0b10111
95 PM_und = 0b11011
96 PM_sys = 0b11111
97 proc_modes = {
98     0:      ("UNKNOWN, MESSED UP PROCESSOR MODE","fsck", "This should Never happen.  MCU is in funky state!"),
99     PM_usr: ("User Processor Mode", "usr", "Normal program execution mode"),
100     PM_fiq: ("FIQ Processor Mode", "fiq", "Supports a high-speed data transfer or channel process"),
101     PM_irq: ("IRQ Processor Mode", "irq", "Used for general-purpose interrupt handling"),
102     PM_svc: ("Supervisor Processor Mode", "svc", "A protected mode for the operating system"),
103     PM_abt: ("Abort Processor Mode", "abt", "Implements virtual memory and/or memory protection"),
104     PM_und: ("Undefined Processor Mode", "und", "Supports software emulation of hardware coprocessor"),
105     PM_sys: ("System Processor Mode", "sys", "Runs privileged operating system tasks (ARMv4 and above)"),
106 }
107
108 PSR_bits = [ 
109     None, None, None, None, None, "Thumb", "nFIQ_int", "nIRQ_int", 
110     "nImprDataAbort_int", "BIGendian", None, None, None, None, None, None, 
111     "GE_0", "GE_1", "GE_2", "GE_3", None, None, None, None, 
112     "Jazelle", None, None, "Q (DSP-overflow)", "oVerflow", "Carry", "Zero", "Neg",
113     ]
114
115 ARM_INSTR_NOP =             0xe1a00000L
116 ARM_INSTR_BX_R0 =           0xe12fff10L
117 ARM_INSTR_STR_Rx_r14 =      0xe58f0000L # from atmel docs
118 ARM_READ_REG =              ARM_INSTR_STR_Rx_r14
119 ARM_INSTR_LDR_Rx_r14 =      0xe59f0000L # from atmel docs
120 ARM_WRITE_REG =             ARM_INSTR_LDR_Rx_r14
121 ARM_INSTR_LDR_R1_r0_4 =     0xe4901004L
122 ARM_READ_MEM =              ARM_INSTR_LDR_R1_r0_4
123 ARM_INSTR_STR_R1_r0_4 =     0xe4801004L
124 ARM_WRITE_MEM =             ARM_INSTR_STR_R1_r0_4
125 ARM_INSTR_STRB_R1_r0_1 =    0xe4c01001L
126 ARM_WRITE_MEM_BYTE =        ARM_INSTR_STRB_R1_r0_1
127 ARM_INSTR_MRS_R0_CPSR =     0xe10f0000L
128 ARM_INSTR_MSR_cpsr_cxsf_R0 =0xe12ff000L
129 ARM_INSTR_STMIA_R14_r0_rx = 0xE88e0000L      # add up to 65k to indicate which registers...
130 ARM_INSTR_LDMIA_R14_r0_rx = 0xE89e0000L      # add up to 65k to indicate which registers...
131 ARM_STORE_MULTIPLE =        ARM_INSTR_STMIA_R14_r0_rx
132 ARM_INSTR_SKANKREGS =       0xE88F7fffL
133 ARM_INSTR_CLOBBEREGS =      0xE89F7fffL
134
135 ARM_INSTR_B_IMM =           0xea000000L
136 ARM_INSTR_B_PC =            0xea000000L
137 ARM_INSTR_BX_PC =           0xe1200010L      # need to set r0 to the desired address
138 THUMB_INSTR_LDR_R0_r0 =     0x68006800L
139 THUMB_WRITE_REG =           THUMB_INSTR_LDR_R0_r0
140 THUMB_INSTR_STR_R0_r0 =     0x60006000L
141 THUMB_READ_REG =            THUMB_INSTR_STR_R0_r0
142 THUMB_INSTR_MOV_R0_PC =     0x46b846b8L
143 THUMB_INSTR_MOV_PC_R0 =     0x46474647L
144 THUMB_INSTR_BX_PC =         0x47784778L
145 THUMB_INSTR_NOP =           0x1c001c00L
146 THUMB_INSTR_B_IMM =         0xe000e000L
147 ARM_REG_PC =                15
148
149 nRW         = 0
150 MAS0        = 1
151 MAS1        = 2
152 nOPC        = 3
153 nTRANS      = 4
154 EXTERN      = 5
155 CHAIN       = 6
156 RANGE       = 7
157 ENABLE      = 8
158
159 DBGCTRLBITS = {
160         'nRW':nRW,
161         'MAS0':MAS0,
162         'MAS1':MAS1,
163         'nOPC':nOPC,
164         'nTRANS':nTRANS,
165         'EXTERN':EXTERN,
166         'CHAIN':CHAIN,
167         'RANGE':RANGE,
168         'ENABLE':ENABLE,
169         1<<nRW:'nRW',
170         1<<MAS0:'MAS0',
171         1<<MAS1:'MAS1',
172         1<<nOPC:'nOPC',
173         1<<nTRANS:'nTRANS',
174         1<<EXTERN:'EXTERN',
175         1<<CHAIN:'CHAIN',
176         1<<RANGE:'RANGE',
177         1<<ENABLE:'ENABLE',
178         }
179
180 LDM_BITMASKS = [(1<<x)-1 for x in xrange(16)]
181 #### TOTALLY BROKEN, NEED VALIDATION AND TESTING
182 PCOFF_DBGRQ = 4 * 4
183 PCOFF_WATCH = 4 * 4
184 PCOFF_BREAK = 4 * 4
185
186
187 def debugstr(strng):
188     print >>sys.stderr,(strng)
189 def PSRdecode(psrval):
190     output = [ "(%s mode)"%proc_modes[psrval&0x1f][1] ]
191     for x in xrange(5,32):
192         if psrval & (1<<x):
193             output.append(PSR_bits[x])
194     return " ".join(output)
195    
196 fmt = [None, "B", "<H", None, "<L", None, None, None, "<Q"]
197 def chop(val,byts):
198     s = struct.pack(fmt[byts], val)
199     return [ord(b) for b in s ]
200         
201 class GoodFETARM(GoodFET):
202     """A GoodFET variant for use with ARM7TDMI microprocessor."""
203     def __init__(self):
204         GoodFET.__init__(self)
205         self.storedPC =         0xffffffff
206         self.current_dbgstate = 0xffffffff
207         self.flags =            0xffffffff
208         self.nothing =          0xffffffff
209     def __del__(self):
210         try:
211             if (self.ARMget_dbgstate()&9) == 9:
212                 self.resume()
213         except:
214             sys.excepthook(*sys.exc_info())
215     def setup(self):
216         """Move the FET into the JTAG ARM application."""
217         #print "Initializing ARM."
218         self.writecmd(0x13,SETUP,0,self.data)
219     def getpc(self):
220         return self.ARMgetPC()
221     def flash(self,file):
222         """Flash an intel hex file to code memory."""
223         print "Flash not implemented.";
224     def dump(self,file,start=0,stop=0xffff):
225         """Dump an intel hex file from code memory."""
226         print "Dump not implemented.";
227     def ARMshift_IR(self, IR, noretidle=0):
228         self.writecmd(0x13,IR_SHIFT,2, [IR, LSB|noretidle])
229         return self.data
230     def ARMshift_DR(self, data, bits, flags):
231         self.writecmd(0x13,DR_SHIFT,8,[bits&0xff, flags&0xff, 0, 0, data&0xff,(data>>8)&0xff,(data>>16)&0xff,(data>>24)&0xff])
232         return self.data
233     def ARMwaitDBG(self, timeout=0xff):
234         self.current_dbgstate = self.ARMget_dbgstate()
235         while ( not ((self.current_dbgstate & 9L) == 9)):
236             timeout -=1
237             self.current_dbgstate = self.ARMget_dbgstate()
238         return timeout
239     def ARMident(self):
240         """Get an ARM's ID."""
241         self.ARMshift_IR(IR_IDCODE,0)
242         self.ARMshift_DR(0,32,LSB)
243         retval = struct.unpack("<L", "".join(self.data[0:4]))[0]
244         return retval
245     def ARMidentstr(self):
246         ident=self.ARMident()
247         ver     = (ident >> 28)
248         partno  = (ident >> 12) & 0xffff
249         mfgid   = (ident >> 1)  & 0x7ff
250         return "Chip IDCODE: 0x%x\n\tver: %x\n\tpartno: %x\n\tmfgid: %x\n" % (ident, ver, partno, mfgid); 
251     def ARMeice_write(self, reg, val):
252         data = chop(val,4)
253         data.extend([reg])
254         retval = self.writecmd(0x13, EICE_WRITE, 5, data)
255         return retval
256     def ARMeice_read(self, reg):
257         self.writecmd(0x13, EICE_READ, 1, [reg])
258         retval, = struct.unpack("<L",self.data)
259         return retval
260     def ARMget_dbgstate(self):
261         """Read the config register of an ARM."""
262         self.ARMeice_read(EICE_DBGSTATUS)
263         self.current_dbgstate = struct.unpack("<L", self.data[:4])[0]
264         return self.current_dbgstate
265     status = ARMget_dbgstate
266     def statusstr(self):
267         """Check the status as a string."""
268         status=self.status()
269         str=""
270         i=1
271         while i<0x20:
272             if(status&i):
273                 str="%s %s" %(self.ARMstatusbits[i],str)
274             i*=2
275         return str
276     def ARMget_dbgctrl(self):
277         """Read the config register of an ARM."""
278         self.ARMeice_read(EICE_DBGCTRL)
279         retval = struct.unpack("<L", self.data[:4])[0]
280         return retval
281     def ARMset_dbgctrl(self,config):
282         """Write the config register of an ARM."""
283         self.ARMeice_write(EICE_DBGCTRL, config&7)
284     def ARMgetPC(self):
285         """Get an ARM's PC. Note: real PC gets all wonky in debug mode, this is the "saved" PC"""
286         return self.storedPC
287     def ARMsetPC(self, val):
288         """Set an ARM's PC.  Note: real PC gets all wonky in debug mode, this changes the "saved" PC which is used when exiting debug mode"""
289         self.storedPC = val
290     def ARMget_register(self, reg):
291         """Get an ARM's Register"""
292         self.writecmd(0x13,GET_REGISTER,1,[reg&0xf])
293         retval = struct.unpack("<L", "".join(self.data[0:4]))[0]
294         return retval
295     def ARMset_register(self, reg, val):
296         """Get an ARM's Register"""
297         self.writecmd(0x13,SET_REGISTER,8,[val&0xff, (val>>8)&0xff, (val>>16)&0xff, val>>24, reg,0,0,0])
298         retval = struct.unpack("<L", "".join(self.data[0:4]))[0]
299         return retval
300     def ARMget_registers(self):
301         """Get ARM Registers"""
302         regs = [ self.ARMget_register(x) for x in range(15) ]
303         regs.append(self.ARMgetPC())            # make sure we snag the "static" version of PC
304         return regs
305     def ARMset_registers(self, regs, mask):
306         """Set ARM Registers"""
307         for x in xrange(15):
308           if (1<<x) & mask:
309             self.ARMset_register(x,regs.pop(0))
310         if (1<<15) & mask:                      # make sure we set the "static" version of PC or changes will be lost
311           self.ARMsetPC(regs.pop(0))
312     def ARMdebuginstr(self,instr,bkpt):
313         if type (instr) == int or type(instr) == long:
314             instr = struct.pack("<L", instr)
315         instr = [int("0x%x"%ord(x),16) for x in instr]
316         instr.extend([bkpt])
317         self.writecmd(0x13,DEBUG_INSTR,len(instr),instr)
318         return (self.data)
319     def ARM_nop(self, bkpt=0):
320         if self.status() & DBG_TBIT:
321             return self.ARMdebuginstr(THUMB_INSTR_NOP, bkpt)
322         return self.ARMdebuginstr(ARM_INSTR_NOP, bkpt)
323     def ARMrestart(self):
324         self.ARMshift_IR(IR_RESTART)
325     def ARMset_watchpoint0(self, addr, addrmask, data, datamask, ctrl, ctrlmask):
326         self.ARMeice_write(EICE_WP0ADDR, addr);           # write 0 in watchpoint 0 address
327         self.ARMeice_write(EICE_WP0ADDRMASK, addrmask);   # write 0xffffffff in watchpoint 0 address mask
328         self.ARMeice_write(EICE_WP0DATA, data);           # write 0 in watchpoint 0 data
329         self.ARMeice_write(EICE_WP0DATAMASK, datamask);   # write 0xffffffff in watchpoint 0 data mask
330         self.ARMeice_write(EICE_WP0CTRL, ctrl);           # write 0x00000100 in watchpoint 0 control value register (enables watchpoint)
331         self.ARMeice_write(EICE_WP0CTRLMASK, ctrlmask);   # write 0xfffffff7 in watchpoint 0 control mask - only detect the fetch instruction
332         return self.data
333     def ARMset_watchpoint1(self, addr, addrmask, data, datamask, ctrl, ctrlmask):
334         self.ARMeice_write(EICE_WP1ADDR, addr);           # write 0 in watchpoint 1 address
335         self.ARMeice_write(EICE_WP1ADDRMASK, addrmask);   # write 0xffffffff in watchpoint 1 address mask
336         self.ARMeice_write(EICE_WP1DATA, data);           # write 0 in watchpoint 1 data
337         self.ARMeice_write(EICE_WP1DATAMASK, datamask);   # write 0xffffffff in watchpoint 1 data mask
338         self.ARMeice_write(EICE_WP1CTRL, ctrl);           # write 0x00000100 in watchpoint 1 control value register (enables watchpoint)
339         self.ARMeice_write(EICE_WP1CTRLMASK, ctrlmask);   # write 0xfffffff7 in watchpoint 1 control mask - only detect the fetch instruction
340         return self.data
341     def THUMBgetPC(self):
342         THUMB_INSTR_STR_R0_r0 =     0x60006000L
343         THUMB_INSTR_MOV_R0_PC =     0x46b846b8L
344         THUMB_INSTR_BX_PC =         0x47784778L
345         THUMB_INSTR_NOP =           0x1c001c00L
346
347         r0 = self.ARMget_register(0)
348         self.ARMdebuginstr(THUMB_INSTR_MOV_R0_PC, 0)
349         retval = self.ARMget_register(0)
350         self.ARMset_register(0,r0)
351         return retval
352     def ARMcapture_system_state(self, pcoffset):
353         if self.ARMget_dbgstate() & DBG_TBIT:
354             pcoffset += 8
355         else:
356             pcoffset += 4
357         self.storedPC = self.ARMget_register(15) + pcoffset
358         self.last_dbg_state = self.ARMget_dbgstate()
359     def ARMhaltcpu(self):
360         """Halt the CPU."""
361         if not(self.ARMget_dbgstate()&1):
362             self.ARMset_dbgctrl(2)
363             if (self.ARMwaitDBG() == 0):
364                 raise Exception("Timeout waiting to enter DEBUG mode on HALT")
365             self.ARMset_dbgctrl(0)
366             self.ARMcapture_system_state(PCOFF_DBGRQ)
367             if self.last_dbg_state&0x10:
368                 self.storedPC = self.THUMBgetPC()
369             else:
370                 self.storedPC = self.ARMget_register(15)
371         self.storedPC, self.flags, self.nothing = self.ARMchain0(0)
372         if self.ARMget_dbgstate() & DBG_TBIT:
373             self.ARMsetModeARM()
374             if self.storedPC ^ 4:
375                 self.ARMset_register(15,self.storedPC&0xfffffffc)
376         print "CPSR: (%s) %s"%(self.ARMget_regCPSRstr())
377     halt = ARMhaltcpu
378     def ARMreleasecpu(self):
379         """Resume the CPU."""
380         # restore registers FIXME: DO THIS
381         if self.ARMget_dbgstate()&1 == 0:
382             return
383         currentPC, self.currentflags, nothing = self.ARMchain0(self.storedPC,self.flags)
384         if not(self.flags & F_TBIT):                                    # need to be in arm mode
385             if self.currentflags & F_TBIT:                              # currently in thumb mode
386                 self.ARMsetModeARM()
387             # branch to the right address
388             self.ARMset_register(15, self.storedPC)
389             print hex(self.storedPC)
390             print hex(self.ARMget_register(15))
391             print hex(self.ARMchain0(self.storedPC,self.flags)[0])
392             self.ARM_nop(0)
393             self.ARM_nop(1)
394             self.ARMdebuginstr(ARM_INSTR_B_IMM | 0xfffff0,0)
395             self.ARM_nop(0)
396             self.ARMrestart()
397
398         elif self.flags & F_TBIT:                                       # need to be in thumb mode
399             if not (self.currentflags & F_TBIT):                        # currently in arm mode
400                 self.ARMsetModeThumb()
401             r0=self.ARMget_register(0)
402             self.ARMset_register(0, self.storedPC)
403             self.ARMdebuginstr(THUMB_INSTR_MOV_PC_R0,0)
404             self.ARM_nop(0)
405             self.ARM_nop(1)
406             print hex(self.storedPC)
407             print hex(self.ARMget_register(15))
408             print hex(self.ARMchain0(self.storedPC,self.flags)[0])
409             self.ARMdebuginstr(THUMB_INSTR_B_IMM | (0x7fc07fc),0)
410             self.ARM_nop(0)
411             self.ARMrestart()
412
413
414     resume = ARMreleasecpu
415     def resettap(self):
416         self.writecmd(0x13, RESETTAP, 0,[])
417     def ARMsetModeARM(self):
418         r0 = None
419         if ((self.current_dbgstate & DBG_TBIT)):
420             debugstr("=== Switching to ARM mode ===")
421             self.ARM_nop(0)
422             self.ARMdebuginstr(THUMB_INSTR_BX_PC,0)
423             self.ARM_nop(0)
424             self.ARM_nop(0)
425         self.resettap()
426         self.current_dbgstate = self.ARMget_dbgstate();
427         return self.current_dbgstate
428     def ARMsetModeThumb(self):                               # needs serious work and truing
429         self.resettap()
430         debugstr("=== Switching to THUMB mode ===")
431         if ( not (self.current_dbgstate & DBG_TBIT)):
432             self.storedPC |= 1
433             r0 = self.ARMget_register(0)
434             self.ARMset_register(0, self.storedPC)
435             self.ARM_nop(0)
436             self.ARMdebuginstr(ARM_INSTR_BX_R0,0)
437             self.ARM_nop(0)
438             self.ARM_nop(0)
439             self.resettap()
440             self.ARMset_register(0,r0)
441         self.current_dbgstate = self.ARMget_dbgstate();
442         return self.current_dbgstate
443     def ARMget_regCPSRstr(self):
444         psr = self.ARMget_regCPSR()
445         return hex(psr), PSRdecode(psr)
446     def ARMget_regCPSR(self):
447         """Get an ARM's Register"""
448         r0 = self.ARMget_register(0)
449         self.ARM_nop( 0) # push nop into pipeline - clean out the pipeline...
450         self.ARMdebuginstr(ARM_INSTR_MRS_R0_CPSR, 0) # push MRS_R0, CPSR into pipeline - fetch
451         self.ARM_nop( 0) # push nop into pipeline - decoded
452         self.ARM_nop( 0) # push nop into pipeline - execute
453         retval = self.ARMget_register(0)
454         self.ARMset_register(0, r0)
455         return retval
456     def ARMset_regCPSR(self, val):
457         """Get an ARM's Register"""
458         r0 = self.ARMget_register(0)
459         self.ARMset_register(0, val)
460         self.ARM_nop( 0)        # push nop into pipeline - clean out the pipeline...
461         self.ARMdebuginstr(ARM_INSTR_MSR_cpsr_cxsf_R0, 0) # push MSR cpsr_cxsf, R0 into pipeline - fetch
462         self.ARM_nop( 0)        # push nop into pipeline - decoded
463         self.ARM_nop( 0)        # push nop into pipeline - execute
464         self.ARMset_register(0, r0)
465         return(val)
466     def ARMreadMem(self, adr, wrdcount=1):
467         retval = [] 
468         r0 = self.ARMget_register(0);        # store R0 and R1
469         r1 = self.ARMget_register(1);
470         #print >>sys.stderr,("CPSR:\t%x"%self.ARMget_regCPSR())
471         self.ARMset_register(0, adr);        # write address into R0
472         self.ARMset_register(1, 0xdeadbeef)
473         for word in range(adr, adr+(wrdcount*4), 4):
474             #sys.stdin.readline()
475             self.ARM_nop(0)
476             self.ARM_nop(1)
477             self.ARMdebuginstr(ARM_READ_MEM, 0); # push LDR R1, [R0], #4 into instruction pipeline  (autoincrements for consecutive reads)
478             self.ARM_nop(0)
479             self.ARMrestart()
480             self.ARMwaitDBG()
481             print hex(self.ARMget_register(1))
482
483             # FIXME: this may end up changing te current debug-state.  should we compare to current_dbgstate?
484             #print repr(self.data[4])
485             if (len(self.data)>4 and self.data[4] == '\x00'):
486               print >>sys.stderr,("FAILED TO READ MEMORY/RE-ENTER DEBUG MODE")
487               raise Exception("FAILED TO READ MEMORY/RE-ENTER DEBUG MODE")
488               return (-1);
489             else:
490               retval.append( self.ARMget_register(1) )  # read memory value from R1 register
491               #print >>sys.stderr,("CPSR: %x\t\tR0: %x\t\tR1: %x"%(self.ARMget_regCPSR(),self.ARMget_register(0),self.ARMget_register(1)))
492         self.ARMset_register(1, r1);       # restore R0 and R1 
493         self.ARMset_register(0, r0);
494         return retval
495     def ARMreadChunk(self, adr, wordcount):         
496         """ Only works in ARM mode currently
497         WARNING: Addresses must be word-aligned!
498         """
499         regs = self.ARMget_registers()
500         self.ARMset_registers([0xdeadbeef for x in xrange(14)], 0xe)
501         output = []
502         count = wordcount
503         while (wordcount > 0):
504             if (wordcount%64 == 0):  sys.stderr.write(".")
505             count = (wordcount, 0xe)[wordcount>0xd]
506             bitmask = LDM_BITMASKS[count]
507             self.ARMset_register(14,adr)
508             self.ARM_nop(1)
509             self.ARMdebuginstr(ARM_INSTR_LDMIA_R14_r0_rx | bitmask ,0)
510             #FIXME: do we need the extra nop here?
511             self.ARMrestart()
512             self.ARMwaitDBG()
513             output.extend([self.ARMget_register(x) for x in xrange(count)])
514             wordcount -= count
515             adr += count*4
516             #print hex(adr)
517         # FIXME: handle the rest of the wordcount here.
518         self.ARMset_registers(regs,0xe)
519         return output
520     def ARMreadStream(self, adr, bytecount):
521         data = [struct.unpack("<L", x) for x in self.ARMreadChunk(adr, (bytecount-1/4)+1)]
522         return "".join(data)[:bytecount]
523         
524     def ARMwriteChunk(self, adr, wordarray):         
525         """ Only works in ARM mode currently
526         WARNING: Addresses must be word-aligned!
527         """
528         regs = self.ARMget_registers()
529         wordcount = len(wordarray)
530         while (wordcount > 0):
531             if (wordcount%64 == 0):  sys.stderr.write(".")
532             count = (wordcount, 0xe)[wordcount>0xd]
533             bitmask = LDM_BITMASKS[count]
534             self.ARMset_register(14,adr)
535             #print len(wordarray),bin(bitmask)
536             self.ARMset_registers(wordarray[:count],bitmask)
537             self.ARM_nop(1)
538             self.ARMdebuginstr(ARM_INSTR_STMIA_R14_r0_rx | bitmask ,0)
539             #FIXME: do we need the extra nop here?
540             self.ARMrestart()
541             self.ARMwaitDBG()
542             wordarray = wordarray[count:]
543             wordcount -= count
544             adr += count*4
545             #print hex(adr)
546         # FIXME: handle the rest of the wordcount here.
547     def ARMwriteMem(self, adr, wordarray, instr=ARM_WRITE_MEM):
548         r0 = self.ARMget_register(0);        # store R0 and R1
549         r1 = self.ARMget_register(1);
550         #print >>sys.stderr,("CPSR:\t%x"%self.ARMget_regCPSR())
551         for widx in xrange(len(wordarray)):
552             address = adr + (widx*4)
553             word = wordarray[widx]
554             self.ARMset_register(0, address);        # write address into R0
555             self.ARMset_register(1, word);        # write address into R0
556             self.ARM_nop(0)
557             self.ARM_nop(1)
558             self.ARMdebuginstr(instr, 0); # push STR R1, [R0], #4 into instruction pipeline  (autoincrements for consecutive writes)
559             self.ARM_nop(0)
560             self.ARMrestart()
561             self.ARMwaitDBG()
562             print >>sys.stderr,hex(self.ARMget_register(1))
563         self.ARMset_register(1, r1);       # restore R0 and R1 
564         self.ARMset_register(0, r0);
565     def writeMemByte(self, adr, byte):
566         self.ARMwriteMem(adr, byte, ARM_WRITE_MEM_BYTE)
567
568
569     ARMstatusbits={
570                   0x10 : "TBIT",
571                   0x08 : "cgenL",
572                   0x04 : "Interrupts Enabled (or not?)",
573                   0x02 : "DBGRQ",
574                   0x01 : "DGBACK"
575                   }
576     ARMctrlbits={
577                   0x04 : "disable interrupts",
578                   0x02 : "force dbgrq",
579                   0x01 : "force dbgack"
580                   }
581     def ARMresettarget(self, delay=10):
582         return self.writecmd(0x13,RESETTARGET,2, [ delay&0xff, (delay>>8)&0xff ] )
583     def ARMchain0(self, address, bits=0x819684c054, data=0):
584         bulk = chop(address,4)
585         bulk.extend(chop(bits,8))
586         bulk.extend(chop(data,4))
587         print >>sys.stderr,(repr(bulk))
588         self.writecmd(0x13,CHAIN0,16,bulk)
589         d1,b1,a1 = struct.unpack("<LQL",self.data)
590         return (a1,b1,d1)
591     def start(self):
592         """Start debugging."""
593         self.writecmd(0x13,START,0,self.data)
594         print >>sys.stderr,"Identifying Target:"
595         ident=self.ARMidentstr()
596         print >>sys.stderr,ident
597         print >>sys.stderr,"Debug Status:\t%s\n" % self.statusstr()
598
599     def stop(self):
600         """Stop debugging."""
601         self.writecmd(0x13,STOP,0,self.data)
602     #def ARMstep_instr(self):
603     #    """Step one instruction."""
604     #    self.writecmd(0x13,STEP_INSTR,0,self.data)
605     #def ARMflashpage(self,adr):
606     #    """Flash 2kB a page of flash from 0xF000 in XDATA"""
607     #    data=[adr&0xFF,
608     #          (adr>>8)&0xFF,
609     #          (adr>>16)&0xFF,
610     #          (adr>>24)&0xFF]
611     #    print "Flashing buffer to 0x%06x" % adr
612     #    self.writecmd(0x13,MASS_FLASH_PAGE,4,data)
613
614