2 # SPDX-License-Identifier: GPL-3.0-or-later
5 OpenOCD RPC example, covered by GNU GPLv3 or later
6 Copyright (C) 2014 Andreas Ortmann (ortmann@finf.uni-hannover.de)
14 target halted due to debug-request, current mode: Thread
15 xPSR: 0x01000000 pc: 0x00000188 msp: 0x10000fd8
17 variable @ 0x10000000: 0x01c9c380
19 variable @ 0x10000000: 0xdeadc0de
21 memory (before): ['0xdeadc0de', '0x00000011', '0xaaaaaaaa', '0x00000023',
22 '0x00000042', '0x0000ffff']
24 memory (after): ['0x00000001', '0x00000000', '0xaaaaaaaa', '0x00000023',
25 '0x00000042', '0x0000ffff']
32 return map(strToHex
, data
) if isinstance(data
, list) else int(data
, 16)
35 return "<None>" if data
is None else ("0x%08x" % data
)
37 def compareData(a
, b
):
38 for i
, j
, num
in zip(a
, b
, itertools
.count(0)):
40 print("difference at %d: %s != %s" % (num
, hexify(i
), hexify(j
)))
44 COMMAND_TOKEN
= '\x1a'
45 def __init__(self
, verbose
=False):
46 self
.verbose
= verbose
47 self
.tclRpcIp
= "127.0.0.1"
48 self
.tclRpcPort
= 6666
49 self
.bufferSize
= 4096
51 self
.sock
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
57 def __exit__(self
, type, value
, traceback
):
61 self
.sock
.connect((self
.tclRpcIp
, self
.tclRpcPort
))
70 """Send a command string to TCL RPC. Return the result that was read."""
71 data
= (cmd
+ OpenOcd
.COMMAND_TOKEN
).encode("utf-8")
79 """Read from the stream until the token (\x1a) was received."""
82 chunk
= self
.sock
.recv(self
.bufferSize
)
84 if bytes(OpenOcd
.COMMAND_TOKEN
, encoding
="utf-8") in chunk
:
90 data
= data
.decode("utf-8").strip()
91 data
= data
[:-1] # strip trailing \x1a
95 def readVariable(self
, address
):
96 raw
= self
.send("mdw 0x%x" % address
).split(": ")
97 return None if (len(raw
) < 2) else strToHex(raw
[1])
99 def readMemory(self
, wordLen
, address
, n
):
100 output
= self
.send("read_memory 0x%x %d %d" % (address
, wordLen
, n
))
101 return [*map(lambda x
: int(x
, 16), output
.split(" "))]
103 def writeVariable(self
, address
, value
):
104 assert value
is not None
105 self
.send("mww 0x%x 0x%x" % (address
, value
))
107 def writeMemory(self
, wordLen
, address
, data
):
108 data
= "{" + ' '.join(['0x%x' % x
for x
in data
]) + "}"
109 self
.send("write_memory 0x%x %d %s" % (address
, wordLen
, data
))
111 if __name__
== "__main__":
114 print(*args
, end
="\n\n")
116 with
OpenOcd() as ocd
:
119 show(ocd
.send("capture { echo \"echo says hi!\" }")[:-1])
120 show(ocd
.send("capture \"halt\"")[:-1])
122 # Read the first few words at the RAM region (put starting address of RAM
123 # region into 'addr')
126 value
= ocd
.readVariable(addr
)
127 show("variable @ %s: %s" % (hexify(addr
), hexify(value
)))
129 ocd
.writeVariable(addr
, 0xdeadc0de)
130 show("variable @ %s: %s" % (hexify(addr
), hexify(ocd
.readVariable(addr
))))
132 data
= [1, 0, 0xaaaaaaaa, 0x23, 0x42, 0xffff]
136 read
= ocd
.readMemory(wordlen
, addr
, n
)
137 show("memory (before):", list(map(hexify
, read
)))
139 ocd
.writeMemory(wordlen
, addr
, n
, data
)
141 read
= ocd
.readMemory(wordlen
, addr
, n
)
142 show("memory (after):", list(map(hexify
, read
)))
144 compareData(read
, data
)