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