openocd.py

## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.
##

import sys
import math
import argparse
import struct
import enum
import os
import pathlib
import socket

class OpenOcd:
 COMMAND_TOKEN = '\x1a'

 def __init__(self, host='localhost', port=4444):
  self._tcl_rpc_host = host
  self._tcl_rpc_port = port
  self._buffer_size = 4096

  self._tcl_variable = 'python_tcl'

  self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

 def __enter__(self):
  self.connect()
  return self

 def __exit__(self, type, value, traceback):
  try:
   self.exit()
  finally:
   self.close()

 def connect(self):
  self._socket.connect((self._tcl_rpc_host, self._tcl_rpc_port))

 def close(self):
  self._socket.close()

 def send(self, cmd):
  data = (cmd + OpenOcd.COMMAND_TOKEN).encode('utf-8')
  self._socket.send(data)

  return self._recv()

 def _recv(self):
  data = bytes()
  while True:
   tmp = self._socket.recv(self._buffer_size)
   data += tmp
   if bytes(OpenOcd.COMMAND_TOKEN, encoding='utf-8') in tmp:
    break

  data = data.decode('utf-8').strip()

  # Strip trailing command token.
  data = data[:-1]

  return data

 def exit(self):
  self.send('exit')

 def step(self):
  self.send('step')

 def resume(self, address=None):
  if address is None:
   self.send('resume')
  else:
   self.send('resume 0x%x' % address)

 def halt(self):
  self.send('halt')

 def wait_halt(self, timeout=5000):
  self.send('wait_halt %u' % timeout)

 def write_binary(self, address, binary):
  path = str(pathlib.Path(__file__).parent.absolute())
  command='program '+path+'\\'+binary+(' verify 0x%x' % address)
  self.send(command.replace('\\','/'))
  
 def write_hex(self, hex_file):
  path = str(pathlib.Path(__file__).parent.absolute())
  command='program '+path+'\\'+hex_file+' verify'
  self.send(command.replace('\\','/'))
  
 def write_memory(self, address, data, word_length=32):
  array = ' '.join(['%d 0x%x' % (i, v) for (i, v) in enumerate(data)])

  # Clear the array before using it.
  self.send('array unset %s' % self._tcl_variable)

  self.send('array set %s { %s }' % (self._tcl_variable, array))
  self.send('array2mem %s 0x%x %s %d' % (self._tcl_variable,
   word_length, address, len(data)))

 def read_memory(self, address, count, word_length=32):
  # Clear the array before using it.
  self.send('array unset %s' % self._tcl_variable)

  self.send('mem2array %s %d 0x%x %d' % (self._tcl_variable,
   word_length, address, count))

  raw = self.send('return $%s' % self._tcl_variable).split(' ')

  order = [int(raw[2 * i]) for i in range(len(raw) // 2)]
  values = [int(raw[2 * i + 1]) for i in range(len(raw) // 2)]

  # Sort the array because it may not be sorted by the memory address.
  result = [0] * len(values)
  for (i, pos) in enumerate(order):
   result[pos] = values[i]

  return result

 def read_register(self, register):
  if issubclass(type(register), int):
   raw = self.send('ocd_reg %u' % register).split(': ')
  else:
   raw = self.send('ocd_reg %s' % register).split(': ')
  if len(raw) < 2:
   return None

  return int(raw[1], 16)

 def read_registers(self, registers):
  result = dict()

  for register in registers:
   value = self.read_register(register)

   if value is None:
    return None

   result[register] = value

  return result

 def read_register_list(self, registers):
  register_list = [None] * len(registers)
  result = self.read_registers(registers)

  # Preserve register order.
  for reg in result:
   register_list[registers.index(reg)] = result[reg]

  return register_list

 def write_register(self, register, value):
  if issubclass(type(register), int):
   self.send('reg %u 0x%x' % (register, value))
  else:
   self.send('reg %s 0x%x' % (register, value))

 def write_registers(self, registers):
  for reg in registers:
   self.write_register(reg, registers[reg])

 def set_breakpoint(self, address, length=2, hardware=True):
  if hardware:
   self.send('bp 0x%x %u hw' % (address, length))
  else:
   self.send('bp 0x%x %u' % (address, length))

 def remove_breakpoint(self, address):
  self.send('rbp 0x%x' % address)