3 OpenOCD RPC example, covered by GNU GPLv3 or later
4 Copyright (C) 2014 Andreas Ortmann (ortmann@finf.uni-hannover.de)
12 target halted due to debug-request, current mode: Thread
13 xPSR: 0x01000000 pc: 0x00000188 msp: 0x10000fd8
15 variable @ 0x10000000: 0x01c9c380
17 variable @ 0x10000000: 0xdeadc0de
19 memory (before): ['0xdeadc0de', '0x00000011', '0xaaaaaaaa', '0x00000023',
20 '0x00000042', '0x0000ffff']
22 memory (after): ['0x00000001', '0x00000000', '0xaaaaaaaa', '0x00000023',
23 '0x00000042', '0x0000ffff']
30 return map(strToHex
, data
) if isinstance(data
, list) else int(data
, 16)
33 return "<None>" if data
is None else ("0x%08x" % data
)
35 def compareData(a
, b
):
36 for i
, j
, num
in zip(a
, b
, itertools
.count(0)):
38 print("difference at %d: %s != %s" % (num
, hexify(i
), hexify(j
)))
42 COMMAND_TOKEN
= '\x1a'
43 def __init__(self
, verbose
=False):
44 self
.verbose
= verbose
45 self
.tclRpcIp
= "127.0.0.1"
46 self
.tclRpcPort
= 6666
47 self
.bufferSize
= 4096
49 self
.sock
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
52 self
.sock
.connect((self
.tclRpcIp
, self
.tclRpcPort
))
55 def __exit__(self
, type, value
, traceback
):
62 """Send a command string to TCL RPC. Return the result that was read."""
63 data
= (cmd
+ OpenOcd
.COMMAND_TOKEN
).encode("utf-8")
71 """Read from the stream until the token (\x1a) was received."""
74 chunk
= self
.sock
.recv(self
.bufferSize
)
76 if bytes(OpenOcd
.COMMAND_TOKEN
, encoding
="utf-8") in chunk
:
82 data
= data
.decode("utf-8").strip()
83 data
= data
[:-1] # strip trailing \x1a
87 def readVariable(self
, address
):
88 raw
= self
.send("ocd_mdw 0x%x" % address
).split(": ")
89 return None if (len(raw
) < 2) else strToHex(raw
[1])
91 def readMemory(self
, wordLen
, address
, n
):
92 self
.send("array unset output") # better to clear the array before
93 self
.send("mem2array output %d 0x%x %d" % (wordLen
, address
, n
))
95 output
= self
.send("ocd_echo $output").split(" ")
97 return [int(output
[2*i
+1]) for i
in range(len(output
)//2)]
99 def writeVariable(self
, address
, value
):
100 assert value
is not None
101 self
.send("mww 0x%x 0x%x" % (address
, value
))
103 def writeMemory(self
, wordLen
, address
, n
, data
):
104 array
= " ".join(["%d 0x%x" % (a
, b
) for a
, b
in enumerate(data
)])
106 self
.send("array unset 1986ве1т") # better to clear the array before
107 self
.send("array set 1986ве1т { %s }" % array
)
108 self
.send("array2mem 1986ве1т 0x%x %s %d" % (wordLen
, address
, n
))
110 if __name__
== "__main__":
113 print(*args
, end
="\n\n")
115 with
OpenOcd() as ocd
:
118 show(ocd
.send("ocd_echo \"echo says hi!\"")[:-1])
119 show(ocd
.send("capture \"ocd_halt\"")[:-1])
121 # Read the first few words at the RAM region (put starting adress of RAM
122 # region into 'addr')
125 value
= ocd
.readVariable(addr
)
126 show("variable @ %s: %s" % (hexify(addr
), hexify(value
)))
128 ocd
.writeVariable(addr
, 0xdeadc0de)
129 show("variable @ %s: %s" % (hexify(addr
), hexify(ocd
.readVariable(addr
))))
131 data
= [1, 0, 0xaaaaaaaa, 0x23, 0x42, 0xffff]
135 read
= ocd
.readMemory(wordlen
, addr
, n
)
136 show("memory (before):", list(map(hexify
, read
)))
138 ocd
.writeMemory(wordlen
, addr
, n
, data
)
140 read
= ocd
.readMemory(wordlen
, addr
, n
)
141 show("memory (after):", list(map(hexify
, read
)))
143 compareData(read
, data
)