mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-13 05:06:30 +04:00
Debug: revert cortex debug to lxml and drop DWT (#2651)
* Debug: revert cortex debug to lxml * Debug: update PyCortexMDebug readme * fbt: moved "debug" dir to "scripts" subfolder * ufbt: added missing debug_other & debug_other_blackmagic targets; github: fixed script bundling * lint: fixed formatting on debug scripts * vscode: updated configuration for debug dir changes --------- Co-authored-by: hedger <hedger@users.noreply.github.com> Co-authored-by: hedger <hedger@nanode.su>
This commit is contained in:
あく
0
scripts/debug/PyCortexMDebug/cmdebug/__init__.py
Executable file
0
scripts/debug/PyCortexMDebug/cmdebug/__init__.py
Executable file
448
scripts/debug/PyCortexMDebug/cmdebug/svd.py
Executable file
448
scripts/debug/PyCortexMDebug/cmdebug/svd.py
Executable file
@@ -0,0 +1,448 @@
|
||||
#!/usr/bin/env python
|
||||
"""
|
||||
This file is part of PyCortexMDebug
|
||||
|
||||
PyCortexMDebug 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.
|
||||
|
||||
PyCortexMDebug 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 PyCortexMDebug. If not, see <http://www.gnu.org/licenses/>.
|
||||
"""
|
||||
|
||||
import lxml.objectify as objectify
|
||||
import sys
|
||||
from collections import OrderedDict
|
||||
import os
|
||||
import pickle
|
||||
import traceback
|
||||
import re
|
||||
import warnings
|
||||
|
||||
|
||||
class SmartDict:
|
||||
"""
|
||||
Dictionary for search by case-insensitive lookup and/or prefix lookup
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.od = OrderedDict()
|
||||
self.casemap = {}
|
||||
|
||||
def __getitem__(self, key):
|
||||
if key in self.od:
|
||||
return self.od[key]
|
||||
|
||||
if key.lower() in self.casemap:
|
||||
return self.od[self.casemap[key.lower()]]
|
||||
|
||||
return self.od[self.prefix_match(key)]
|
||||
|
||||
def is_ambiguous(self, key):
|
||||
return (
|
||||
key not in self.od
|
||||
and key not in self.casemap
|
||||
and len(list(self.prefix_match_iter(key))) > 1
|
||||
)
|
||||
|
||||
def prefix_match_iter(self, key):
|
||||
name, number = re.match(r"^(.*?)([0-9]*)$", key.lower()).groups()
|
||||
for entry, od_key in self.casemap.items():
|
||||
if entry.startswith(name) and entry.endswith(number):
|
||||
yield od_key
|
||||
|
||||
def prefix_match(self, key):
|
||||
for od_key in self.prefix_match_iter(key):
|
||||
return od_key
|
||||
return None
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
if key in self.od:
|
||||
warnings.warn("Duplicate entry %s", key)
|
||||
elif key.lower() in self.casemap:
|
||||
warnings.warn(
|
||||
"Entry %s differs from duplicate %s only in cAsE",
|
||||
key,
|
||||
self.casemap[key.lower()],
|
||||
)
|
||||
|
||||
self.casemap[key.lower()] = key
|
||||
self.od[key] = value
|
||||
|
||||
def __delitem__(self, key):
|
||||
if (
|
||||
self.casemap[key.lower()] == key
|
||||
): # Check that we did not overwrite this entry
|
||||
del self.casemap[key.lower()]
|
||||
del self.od[key]
|
||||
|
||||
def __contains__(self, key):
|
||||
return key in self.od or key.lower() in self.casemap or self.prefix_match(key)
|
||||
|
||||
def __iter__(self):
|
||||
return iter(self.od)
|
||||
|
||||
def __len__(self):
|
||||
return len(self.od)
|
||||
|
||||
def items(self):
|
||||
return self.od.items()
|
||||
|
||||
def keys(self):
|
||||
return self.od.keys()
|
||||
|
||||
def values(self):
|
||||
return self.od.values()
|
||||
|
||||
def __str__(self):
|
||||
return str(self.od)
|
||||
|
||||
|
||||
class SVDNonFatalError(Exception):
|
||||
"""Exception class for non-fatal errors
|
||||
So far, these have related to quirks in some vendor SVD files which are reasonable to ignore
|
||||
"""
|
||||
|
||||
def __init__(self, m):
|
||||
self.m = m
|
||||
self.exc_info = sys.exc_info()
|
||||
|
||||
def __str__(self):
|
||||
s = "Non-fatal: {}".format(self.m)
|
||||
s += "\n" + str("".join(traceback.format_exc())).strip()
|
||||
return s
|
||||
|
||||
|
||||
class SVDFile:
|
||||
"""
|
||||
A parsed SVD file
|
||||
"""
|
||||
|
||||
def __init__(self, fname):
|
||||
"""
|
||||
|
||||
Args:
|
||||
fname: Filename for the SVD file
|
||||
"""
|
||||
f = objectify.parse(os.path.expanduser(fname))
|
||||
root = f.getroot()
|
||||
periph = root.peripherals.getchildren()
|
||||
self.peripherals = SmartDict()
|
||||
self.base_address = 0
|
||||
|
||||
# XML elements
|
||||
for p in periph:
|
||||
try:
|
||||
if p.tag == "peripheral":
|
||||
self.peripherals[str(p.name)] = SVDPeripheral(p, self)
|
||||
else:
|
||||
# This is some other tag
|
||||
pass
|
||||
except SVDNonFatalError as e:
|
||||
print(e)
|
||||
|
||||
|
||||
def add_register(parent, node):
|
||||
"""
|
||||
Add a register node to a peripheral
|
||||
|
||||
Args:
|
||||
parent: Parent SVDPeripheral object
|
||||
node: XML file node fot of the register
|
||||
"""
|
||||
|
||||
if hasattr(node, "dim"):
|
||||
dim = int(str(node.dim), 0)
|
||||
# dimension is not used, number of split indexes should be same
|
||||
incr = int(str(node.dimIncrement), 0)
|
||||
default_dim_index = ",".join((str(i) for i in range(dim)))
|
||||
dim_index = str(getattr(node, "dimIndex", default_dim_index))
|
||||
indices = dim_index.split(",")
|
||||
offset = 0
|
||||
for i in indices:
|
||||
name = str(node.name) % i
|
||||
reg = SVDPeripheralRegister(node, parent)
|
||||
reg.name = name
|
||||
reg.offset += offset
|
||||
parent.registers[name] = reg
|
||||
offset += incr
|
||||
else:
|
||||
try:
|
||||
reg = SVDPeripheralRegister(node, parent)
|
||||
name = str(node.name)
|
||||
if name not in parent.registers:
|
||||
parent.registers[name] = reg
|
||||
else:
|
||||
if hasattr(node, "alternateGroup"):
|
||||
print("Register %s has an alternate group", name)
|
||||
except SVDNonFatalError as e:
|
||||
print(e)
|
||||
|
||||
|
||||
def add_cluster(parent, node):
|
||||
"""
|
||||
Add a register cluster to a peripheral
|
||||
"""
|
||||
if hasattr(node, "dim"):
|
||||
dim = int(str(node.dim), 0)
|
||||
# dimension is not used, number of split indices should be same
|
||||
incr = int(str(node.dimIncrement), 0)
|
||||
default_dim_index = ",".join((str(i) for i in range(dim)))
|
||||
dim_index = str(getattr(node, "dimIndex", default_dim_index))
|
||||
indices = dim_index.split(",")
|
||||
offset = 0
|
||||
for i in indices:
|
||||
name = str(node.name) % i
|
||||
cluster = SVDRegisterCluster(node, parent)
|
||||
cluster.name = name
|
||||
cluster.address_offset += offset
|
||||
cluster.base_address += offset
|
||||
parent.clusters[name] = cluster
|
||||
offset += incr
|
||||
else:
|
||||
try:
|
||||
parent.clusters[str(node.name)] = SVDRegisterCluster(node, parent)
|
||||
except SVDNonFatalError as e:
|
||||
print(e)
|
||||
|
||||
|
||||
class SVDRegisterCluster:
|
||||
"""
|
||||
Register cluster
|
||||
"""
|
||||
|
||||
def __init__(self, svd_elem, parent):
|
||||
"""
|
||||
|
||||
Args:
|
||||
svd_elem: XML element for the register cluster
|
||||
parent: Parent SVDPeripheral object
|
||||
"""
|
||||
self.parent_base_address = parent.base_address
|
||||
self.parent_name = parent.name
|
||||
self.address_offset = int(str(svd_elem.addressOffset), 0)
|
||||
self.base_address = self.address_offset + self.parent_base_address
|
||||
# This doesn't inherit registers from anything
|
||||
children = svd_elem.getchildren()
|
||||
self.description = str(svd_elem.description)
|
||||
self.name = str(svd_elem.name)
|
||||
self.registers = SmartDict()
|
||||
self.clusters = SmartDict()
|
||||
for r in children:
|
||||
if r.tag == "register":
|
||||
add_register(self, r)
|
||||
|
||||
def refactor_parent(self, parent):
|
||||
self.parent_base_address = parent.base_address
|
||||
self.parent_name = parent.name
|
||||
self.base_address = self.parent_base_address + self.address_offset
|
||||
values = self.registers.values()
|
||||
for r in values:
|
||||
r.refactor_parent(self)
|
||||
|
||||
def __str__(self):
|
||||
return str(self.name)
|
||||
|
||||
|
||||
class SVDPeripheral:
|
||||
"""
|
||||
This is a peripheral as defined in the SVD file
|
||||
"""
|
||||
|
||||
def __init__(self, svd_elem, parent):
|
||||
"""
|
||||
|
||||
Args:
|
||||
svd_elem: XML element for the peripheral
|
||||
parent: Parent SVDFile object
|
||||
"""
|
||||
self.parent_base_address = parent.base_address
|
||||
|
||||
# Look for a base address, as it is required
|
||||
if not hasattr(svd_elem, "baseAddress"):
|
||||
raise SVDNonFatalError("Periph without base address")
|
||||
self.base_address = int(str(svd_elem.baseAddress), 0)
|
||||
if "derivedFrom" in svd_elem.attrib:
|
||||
derived_from = svd_elem.attrib["derivedFrom"]
|
||||
try:
|
||||
self.name = str(svd_elem.name)
|
||||
except AttributeError:
|
||||
self.name = parent.peripherals[derived_from].name
|
||||
try:
|
||||
self.description = str(svd_elem.description)
|
||||
except AttributeError:
|
||||
self.description = parent.peripherals[derived_from].description
|
||||
|
||||
# pickle is faster than deepcopy by up to 50% on svd files with a
|
||||
# lot of derivedFrom definitions
|
||||
def copier(a):
|
||||
return pickle.loads(pickle.dumps(a))
|
||||
|
||||
self.registers = copier(parent.peripherals[derived_from].registers)
|
||||
self.clusters = copier(parent.peripherals[derived_from].clusters)
|
||||
self.refactor_parent(parent)
|
||||
else:
|
||||
# This doesn't inherit registers from anything
|
||||
self.description = str(svd_elem.description)
|
||||
self.name = str(svd_elem.name)
|
||||
self.registers = SmartDict()
|
||||
self.clusters = SmartDict()
|
||||
|
||||
if hasattr(svd_elem, "registers"):
|
||||
registers = [
|
||||
r
|
||||
for r in svd_elem.registers.getchildren()
|
||||
if r.tag in ["cluster", "register"]
|
||||
]
|
||||
for r in registers:
|
||||
if r.tag == "cluster":
|
||||
add_cluster(self, r)
|
||||
elif r.tag == "register":
|
||||
add_register(self, r)
|
||||
|
||||
def refactor_parent(self, parent):
|
||||
self.parent_base_address = parent.base_address
|
||||
values = self.registers.values()
|
||||
for r in values:
|
||||
r.refactor_parent(self)
|
||||
|
||||
for c in self.clusters.values():
|
||||
c.refactor_parent(self)
|
||||
|
||||
def __str__(self):
|
||||
return str(self.name)
|
||||
|
||||
|
||||
class SVDPeripheralRegister:
|
||||
"""
|
||||
A register within a peripheral
|
||||
"""
|
||||
|
||||
def __init__(self, svd_elem, parent):
|
||||
self.parent_base_address = parent.base_address
|
||||
self.name = str(svd_elem.name)
|
||||
self.description = str(svd_elem.description)
|
||||
self.offset = int(str(svd_elem.addressOffset), 0)
|
||||
if hasattr(svd_elem, "access"):
|
||||
self.access = str(svd_elem.access)
|
||||
else:
|
||||
self.access = "read-write"
|
||||
if hasattr(svd_elem, "size"):
|
||||
self.size = int(str(svd_elem.size), 0)
|
||||
else:
|
||||
self.size = 0x20
|
||||
self.fields = SmartDict()
|
||||
if hasattr(svd_elem, "fields"):
|
||||
# Filter fields to only consider those of tag "field"
|
||||
fields = [f for f in svd_elem.fields.getchildren() if f.tag == "field"]
|
||||
for f in fields:
|
||||
self.fields[str(f.name)] = SVDPeripheralRegisterField(f, self)
|
||||
|
||||
def refactor_parent(self, parent):
|
||||
self.parent_base_address = parent.base_address
|
||||
|
||||
def address(self):
|
||||
return self.parent_base_address + self.offset
|
||||
|
||||
def readable(self):
|
||||
return self.access in ["read-only", "read-write", "read-writeOnce"]
|
||||
|
||||
def writable(self):
|
||||
return self.access in [
|
||||
"write-only",
|
||||
"read-write",
|
||||
"writeOnce",
|
||||
"read-writeOnce",
|
||||
]
|
||||
|
||||
def __str__(self):
|
||||
return str(self.name)
|
||||
|
||||
|
||||
class SVDPeripheralRegisterField:
|
||||
"""
|
||||
Field within a register
|
||||
"""
|
||||
|
||||
def __init__(self, svd_elem, parent):
|
||||
self.name = str(svd_elem.name)
|
||||
self.description = str(getattr(svd_elem, "description", ""))
|
||||
|
||||
# Try to extract a bit range (offset and width) from the available fields
|
||||
if hasattr(svd_elem, "bitOffset") and hasattr(svd_elem, "bitWidth"):
|
||||
self.offset = int(str(svd_elem.bitOffset))
|
||||
self.width = int(str(svd_elem.bitWidth))
|
||||
elif hasattr(svd_elem, "bitRange"):
|
||||
bitrange = list(map(int, str(svd_elem.bitRange).strip()[1:-1].split(":")))
|
||||
self.offset = bitrange[1]
|
||||
self.width = 1 + bitrange[0] - bitrange[1]
|
||||
else:
|
||||
assert hasattr(svd_elem, "lsb") and hasattr(
|
||||
svd_elem, "msb"
|
||||
), "Range not found for field {} in register {}".format(self.name, parent)
|
||||
lsb = int(str(svd_elem.lsb))
|
||||
msb = int(str(svd_elem.msb))
|
||||
self.offset = lsb
|
||||
self.width = 1 + msb - lsb
|
||||
|
||||
self.access = str(getattr(svd_elem, "access", parent.access))
|
||||
self.enum = {}
|
||||
|
||||
if hasattr(svd_elem, "enumeratedValues"):
|
||||
values = [
|
||||
v
|
||||
for v in svd_elem.enumeratedValues.getchildren()
|
||||
if v.tag == "enumeratedValue"
|
||||
]
|
||||
for v in values:
|
||||
# Skip the "name" tag and any entries that don't have a value
|
||||
if v.tag == "name" or not hasattr(v, "value"):
|
||||
continue
|
||||
# Some Kinetis parts have values with # instead of 0x...
|
||||
value = str(v.value).replace("#", "0x")
|
||||
description = str(v.description) if hasattr(v, "description") else ""
|
||||
try:
|
||||
index = int(value, 0)
|
||||
self.enum[int(value, 0)] = (str(v.name), description)
|
||||
except ValueError:
|
||||
# If the value couldn't be converted as a single integer, skip it
|
||||
pass
|
||||
|
||||
def readable(self):
|
||||
return self.access in ["read-only", "read-write", "read-writeOnce"]
|
||||
|
||||
def writable(self):
|
||||
return self.access in [
|
||||
"write-only",
|
||||
"read-write",
|
||||
"writeOnce",
|
||||
"read-writeOnce",
|
||||
]
|
||||
|
||||
def __str__(self):
|
||||
return str(self.name)
|
||||
|
||||
|
||||
def _main():
|
||||
"""
|
||||
Basic test to parse a file and do some things
|
||||
"""
|
||||
|
||||
for f in sys.argv[1:]:
|
||||
print("Testing file: {}".format(f))
|
||||
svd = SVDFile(f)
|
||||
print(svd.peripherals)
|
||||
key = list(svd.peripherals)[0]
|
||||
print("Registers in peripheral '{}':".format(key))
|
||||
print(svd.peripherals[key].registers)
|
||||
print("Done testing file: {}".format(f))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
_main()
|
||||
520
scripts/debug/PyCortexMDebug/cmdebug/svd_gdb.py
Executable file
520
scripts/debug/PyCortexMDebug/cmdebug/svd_gdb.py
Executable file
@@ -0,0 +1,520 @@
|
||||
#!/usr/bin/env python
|
||||
"""
|
||||
This file is part of PyCortexMDebug
|
||||
|
||||
PyCortexMDebug 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.
|
||||
|
||||
PyCortexMDebug 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 PyCortexMDebug. If not, see <http://www.gnu.org/licenses/>.
|
||||
"""
|
||||
|
||||
import gdb
|
||||
import re
|
||||
import math
|
||||
import sys
|
||||
import struct
|
||||
import pkg_resources
|
||||
import fnmatch
|
||||
import traceback
|
||||
|
||||
from .svd import SVDFile
|
||||
|
||||
BITS_TO_UNPACK_FORMAT = {
|
||||
8: "B",
|
||||
16: "H",
|
||||
32: "I",
|
||||
}
|
||||
|
||||
|
||||
class LoadSVD(gdb.Command):
|
||||
"""A command to load an SVD file and to create the command for inspecting
|
||||
that object
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.vendors = {}
|
||||
try:
|
||||
vendor_names = pkg_resources.resource_listdir("cmsis_svd", "data")
|
||||
for vendor in vendor_names:
|
||||
fnames = pkg_resources.resource_listdir(
|
||||
"cmsis_svd", "data/{}".format(vendor)
|
||||
)
|
||||
self.vendors[vendor] = [
|
||||
fname for fname in fnames if fname.lower().endswith(".svd")
|
||||
]
|
||||
except:
|
||||
pass
|
||||
|
||||
if len(self.vendors) > 0:
|
||||
gdb.Command.__init__(self, "svd_load", gdb.COMMAND_USER)
|
||||
else:
|
||||
gdb.Command.__init__(
|
||||
self, "svd_load", gdb.COMMAND_DATA, gdb.COMPLETE_FILENAME
|
||||
)
|
||||
|
||||
def complete(self, text, word):
|
||||
args = gdb.string_to_argv(text)
|
||||
num_args = len(args)
|
||||
if text.endswith(" "):
|
||||
num_args += 1
|
||||
if not text:
|
||||
num_args = 1
|
||||
|
||||
# "svd_load <tab>" or "svd_load ST<tab>"
|
||||
if num_args == 1:
|
||||
prefix = word.lower()
|
||||
return [
|
||||
vendor for vendor in self.vendors if vendor.lower().startswith(prefix)
|
||||
]
|
||||
# "svd_load STMicro<tab>" or "svd_load STMicro STM32F1<tab>"
|
||||
elif num_args == 2 and args[0] in self.vendors:
|
||||
prefix = word.lower()
|
||||
filenames = self.vendors[args[0]]
|
||||
return [fname for fname in filenames if fname.lower().startswith(prefix)]
|
||||
return gdb.COMPLETE_NONE
|
||||
|
||||
@staticmethod
|
||||
def invoke(args, from_tty):
|
||||
args = gdb.string_to_argv(args)
|
||||
argc = len(args)
|
||||
if argc == 1:
|
||||
gdb.write("Loading SVD file {}...\n".format(args[0]))
|
||||
f = args[0]
|
||||
elif argc == 2:
|
||||
gdb.write("Loading SVD file {}/{}...\n".format(args[0], args[1]))
|
||||
f = pkg_resources.resource_filename(
|
||||
"cmsis_svd", "data/{}/{}".format(args[0], args[1])
|
||||
)
|
||||
else:
|
||||
raise gdb.GdbError(
|
||||
"Usage: svd_load <vendor> <device.svd> or svd_load <path/to/filename.svd>\n"
|
||||
)
|
||||
try:
|
||||
SVD(SVDFile(f))
|
||||
except Exception as e:
|
||||
traceback.print_exc()
|
||||
raise gdb.GdbError("Could not load SVD file {} : {}...\n".format(f, e))
|
||||
|
||||
|
||||
class SVD(gdb.Command):
|
||||
"""The CMSIS SVD (System View Description) inspector command
|
||||
|
||||
This allows easy access to all peripheral registers supported by the system
|
||||
in the GDB debug environment
|
||||
"""
|
||||
|
||||
def __init__(self, svd_file):
|
||||
gdb.Command.__init__(self, "svd", gdb.COMMAND_DATA)
|
||||
self.svd_file = svd_file
|
||||
|
||||
def _print_registers(self, container_name, form, registers):
|
||||
if len(registers) == 0:
|
||||
return
|
||||
try:
|
||||
regs_iter = registers.itervalues()
|
||||
except AttributeError:
|
||||
regs_iter = registers.values()
|
||||
gdb.write("Registers in %s:\n" % container_name)
|
||||
reg_list = []
|
||||
for r in regs_iter:
|
||||
if r.readable():
|
||||
try:
|
||||
data = self.read(r.address(), r.size)
|
||||
data = self.format(data, form, r.size)
|
||||
if form == "a":
|
||||
data += (
|
||||
" <"
|
||||
+ re.sub(
|
||||
r"\s+",
|
||||
" ",
|
||||
gdb.execute(
|
||||
"info symbol {}".format(data), True, True
|
||||
).strip(),
|
||||
)
|
||||
+ ">"
|
||||
)
|
||||
except gdb.MemoryError:
|
||||
data = "(error reading)"
|
||||
else:
|
||||
data = "(not readable)"
|
||||
desc = re.sub(r"\s+", " ", r.description)
|
||||
reg_list.append((r.name, data, desc))
|
||||
|
||||
column1_width = max(len(reg[0]) for reg in reg_list) + 2 # padding
|
||||
column2_width = max(len(reg[1]) for reg in reg_list)
|
||||
for reg in reg_list:
|
||||
gdb.write(
|
||||
"\t{}:{}{}".format(
|
||||
reg[0],
|
||||
"".ljust(column1_width - len(reg[0])),
|
||||
reg[1].rjust(column2_width),
|
||||
)
|
||||
)
|
||||
if reg[2] != reg[0]:
|
||||
gdb.write(" {}".format(reg[2]))
|
||||
gdb.write("\n")
|
||||
|
||||
def _print_register_fields(self, container_name, form, register):
|
||||
gdb.write("Fields in {}:\n".format(container_name))
|
||||
fields = register.fields
|
||||
if not register.readable():
|
||||
data = 0
|
||||
else:
|
||||
data = self.read(register.address(), register.size)
|
||||
field_list = []
|
||||
try:
|
||||
fields_iter = fields.itervalues()
|
||||
except AttributeError:
|
||||
fields_iter = fields.values()
|
||||
for f in fields_iter:
|
||||
desc = re.sub(r"\s+", " ", f.description)
|
||||
if register.readable():
|
||||
val = data >> f.offset
|
||||
val &= (1 << f.width) - 1
|
||||
if f.enum:
|
||||
if val in f.enum:
|
||||
desc = f.enum[val][1] + " - " + desc
|
||||
val = f.enum[val][0]
|
||||
else:
|
||||
val = "Invalid enum value: " + self.format(val, form, f.width)
|
||||
else:
|
||||
val = self.format(val, form, f.width)
|
||||
else:
|
||||
val = "(not readable)"
|
||||
field_list.append((f.name, val, desc))
|
||||
|
||||
column1_width = max(len(field[0]) for field in field_list) + 2 # padding
|
||||
column2_width = max(len(field[1]) for field in field_list) # padding
|
||||
for field in field_list:
|
||||
gdb.write(
|
||||
"\t{}:{}{}".format(
|
||||
field[0],
|
||||
"".ljust(column1_width - len(field[0])),
|
||||
field[1].rjust(column2_width),
|
||||
)
|
||||
)
|
||||
if field[2] != field[0]:
|
||||
gdb.write(" {}".format(field[2]))
|
||||
gdb.write("\n")
|
||||
|
||||
def invoke(self, args, from_tty):
|
||||
s = str(args).split(" ")
|
||||
form = ""
|
||||
if s[0] and s[0][0] == "/":
|
||||
if len(s[0]) == 1:
|
||||
gdb.write("Incorrect format\n")
|
||||
return
|
||||
else:
|
||||
form = s[0][1:]
|
||||
if len(s) == 1:
|
||||
return
|
||||
s = s[1:]
|
||||
|
||||
if s[0].lower() == "help":
|
||||
gdb.write("Usage:\n")
|
||||
gdb.write("=========\n")
|
||||
gdb.write("svd:\n")
|
||||
gdb.write("\tList available peripherals\n")
|
||||
gdb.write("svd [peripheral_name]:\n")
|
||||
gdb.write("\tDisplay all registers pertaining to that peripheral\n")
|
||||
gdb.write("svd [peripheral_name] [register_name]:\n")
|
||||
gdb.write("\tDisplay the fields in that register\n")
|
||||
gdb.write("svd/[format_character] ...\n")
|
||||
gdb.write("\tFormat values using that character\n")
|
||||
gdb.write("\td(default):decimal, x: hex, o: octal, b: binary\n")
|
||||
gdb.write("\n")
|
||||
gdb.write(
|
||||
"Both prefix matching and case-insensitive matching is supported for peripherals, registers, clusters and fields.\n"
|
||||
)
|
||||
return
|
||||
|
||||
if not len(s[0]):
|
||||
gdb.write("Available Peripherals:\n")
|
||||
try:
|
||||
peripherals = self.svd_file.peripherals.itervalues()
|
||||
except AttributeError:
|
||||
peripherals = self.svd_file.peripherals.values()
|
||||
column_width = max(len(p.name) for p in peripherals) + 2 # padding
|
||||
try:
|
||||
peripherals = self.svd_file.peripherals.itervalues()
|
||||
except AttributeError:
|
||||
peripherals = self.svd_file.peripherals.values()
|
||||
for p in peripherals:
|
||||
desc = re.sub(r"\s+", " ", p.description)
|
||||
gdb.write(
|
||||
"\t{}:{}{}\n".format(
|
||||
p.name, "".ljust(column_width - len(p.name)), desc
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
def warn_if_ambiguous(smart_dict, key):
|
||||
if smart_dict.is_ambiguous(key):
|
||||
gdb.write(
|
||||
"Warning: {} could prefix match any of: {}\n".format(
|
||||
key, ", ".join(smart_dict.prefix_match_iter(key))
|
||||
)
|
||||
)
|
||||
|
||||
registers = None
|
||||
if len(s) >= 1:
|
||||
peripheral_name = s[0]
|
||||
if peripheral_name not in self.svd_file.peripherals:
|
||||
gdb.write("Peripheral {} does not exist!\n".format(s[0]))
|
||||
return
|
||||
|
||||
warn_if_ambiguous(self.svd_file.peripherals, peripheral_name)
|
||||
|
||||
peripheral = self.svd_file.peripherals[peripheral_name]
|
||||
|
||||
if len(s) == 1:
|
||||
self._print_registers(peripheral.name, form, peripheral.registers)
|
||||
if len(peripheral.clusters) > 0:
|
||||
try:
|
||||
clusters_iter = peripheral.clusters.itervalues()
|
||||
except AttributeError:
|
||||
clusters_iter = peripheral.clusters.values()
|
||||
gdb.write("Clusters in %s:\n" % peripheral.name)
|
||||
reg_list = []
|
||||
for r in clusters_iter:
|
||||
desc = re.sub(r"\s+", " ", r.description)
|
||||
reg_list.append((r.name, "", desc))
|
||||
|
||||
column1_width = max(len(reg[0]) for reg in reg_list) + 2 # padding
|
||||
column2_width = max(len(reg[1]) for reg in reg_list)
|
||||
for reg in reg_list:
|
||||
gdb.write(
|
||||
"\t{}:{}{}".format(
|
||||
reg[0],
|
||||
"".ljust(column1_width - len(reg[0])),
|
||||
reg[1].rjust(column2_width),
|
||||
)
|
||||
)
|
||||
if reg[2] != reg[0]:
|
||||
gdb.write(" {}".format(reg[2]))
|
||||
gdb.write("\n")
|
||||
return
|
||||
|
||||
cluster = None
|
||||
if len(s) == 2:
|
||||
if s[1] in peripheral.clusters:
|
||||
warn_if_ambiguous(peripheral.clusters, s[1])
|
||||
cluster = peripheral.clusters[s[1]]
|
||||
container = peripheral.name + " > " + cluster.name
|
||||
self._print_registers(container, form, cluster.registers)
|
||||
|
||||
elif s[1] in peripheral.registers:
|
||||
warn_if_ambiguous(peripheral.registers, s[1])
|
||||
register = peripheral.registers[s[1]]
|
||||
container = peripheral.name + " > " + register.name
|
||||
|
||||
self._print_register_fields(container, form, register)
|
||||
else:
|
||||
found = False
|
||||
for key in fnmatch.filter(peripheral.registers.keys(), s[1]):
|
||||
register = peripheral.registers[key]
|
||||
container = peripheral.name + " > " + register.name
|
||||
self._print_register_fields(container, form, register)
|
||||
found = True
|
||||
if not found:
|
||||
gdb.write(
|
||||
"Register/cluster {} in peripheral {} does not exist!\n".format(
|
||||
s[1], peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
if len(s) == 3:
|
||||
if s[1] not in peripheral.clusters:
|
||||
gdb.write(
|
||||
"Cluster {} in peripheral {} does not exist!\n".format(
|
||||
s[1], peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
warn_if_ambiguous(peripheral.clusters, s[1])
|
||||
|
||||
cluster = peripheral.clusters[s[1]]
|
||||
if s[2] not in cluster.registers:
|
||||
gdb.write(
|
||||
"Register {} in cluster {} in peripheral {} does not exist!\n".format(
|
||||
s[2], cluster.name, peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
warn_if_ambiguous(cluster.registers, s[2])
|
||||
|
||||
register = cluster.registers[s[2]]
|
||||
container = " > ".join([peripheral.name, cluster.name, register.name])
|
||||
self._print_register_fields(container, form, register)
|
||||
return
|
||||
|
||||
if len(s) == 4:
|
||||
if s[1] not in peripheral.registers:
|
||||
gdb.write(
|
||||
"Register {} in peripheral {} does not exist!\n".format(
|
||||
s[1], peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
warn_if_ambiguous(peripheral.registers, s[1])
|
||||
|
||||
reg = peripheral.registers[s[1]]
|
||||
|
||||
if s[2] not in reg.fields:
|
||||
gdb.write(
|
||||
"Field {} in register {} in peripheral {} does not exist!\n".format(
|
||||
s[2], reg.name, peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
warn_if_ambiguous(reg.fields, s[2])
|
||||
|
||||
field = reg.fields[s[2]]
|
||||
|
||||
if not field.writable() or not reg.writable():
|
||||
gdb.write(
|
||||
"Field {} in register {} in peripheral {} is read-only!\n".format(
|
||||
field.name, reg.name, peripheral.name
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
try:
|
||||
val = int(s[3], 0)
|
||||
except ValueError:
|
||||
gdb.write(
|
||||
"{} is not a valid number! You can prefix numbers with 0x for hex, 0b for binary, or any python "
|
||||
"int literal\n".format(s[3])
|
||||
)
|
||||
return
|
||||
|
||||
if val >= 1 << field.width or val < 0:
|
||||
gdb.write(
|
||||
"{} not a valid number for a field with width {}!\n".format(
|
||||
val, field.width
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
if not reg.readable():
|
||||
data = 0
|
||||
else:
|
||||
data = self.read(reg.address(), reg.size)
|
||||
data &= ~(((1 << field.width) - 1) << field.offset)
|
||||
data |= val << field.offset
|
||||
self.write(reg.address(), data, reg.size)
|
||||
return
|
||||
|
||||
gdb.write("Unknown input\n")
|
||||
|
||||
def complete(self, text, word):
|
||||
"""Perform tab-completion for the command"""
|
||||
text = str(text)
|
||||
s = text.split(" ")
|
||||
|
||||
# Deal with the possibility of a '/' parameter
|
||||
if s[0] and s[0][0] == "/":
|
||||
if len(s) > 1:
|
||||
s = s[1:]
|
||||
else:
|
||||
return [] # completion after e.g. "svd/x" but before trailing space
|
||||
|
||||
if len(s) == 1:
|
||||
return list(self.svd_file.peripherals.prefix_match_iter(s[0]))
|
||||
|
||||
if len(s) == 2:
|
||||
reg = s[1].upper()
|
||||
if len(reg) and reg[0] == "&":
|
||||
reg = reg[1:]
|
||||
|
||||
if s[0] not in self.svd_file.peripherals:
|
||||
return []
|
||||
|
||||
per = self.svd_file.peripherals[s[0]]
|
||||
return list(per.registers.prefix_match_iter(s[1]))
|
||||
|
||||
return []
|
||||
|
||||
@staticmethod
|
||||
def read(address, bits=32):
|
||||
"""Read from memory and return an integer"""
|
||||
value = gdb.selected_inferior().read_memory(address, bits / 8)
|
||||
unpack_format = "I"
|
||||
if bits in BITS_TO_UNPACK_FORMAT:
|
||||
unpack_format = BITS_TO_UNPACK_FORMAT[bits]
|
||||
# gdb.write("{:x} {}\n".format(address, binascii.hexlify(value)))
|
||||
return struct.unpack_from("<" + unpack_format, value)[0]
|
||||
|
||||
@staticmethod
|
||||
def write(address, data, bits=32):
|
||||
"""Write data to memory"""
|
||||
gdb.selected_inferior().write_memory(address, bytes(data), bits / 8)
|
||||
|
||||
@staticmethod
|
||||
def format(value, form, length=32):
|
||||
"""Format a number based on a format character and length"""
|
||||
# get current gdb radix setting
|
||||
radix = int(
|
||||
re.search(r"\d+", gdb.execute("show output-radix", True, True)).group(0)
|
||||
)
|
||||
|
||||
# override it if asked to
|
||||
if form == "x" or form == "a":
|
||||
radix = 16
|
||||
elif form == "o":
|
||||
radix = 8
|
||||
elif form == "b" or form == "t":
|
||||
radix = 2
|
||||
|
||||
# format the output
|
||||
if radix == 16:
|
||||
# For addresses, probably best in hex too
|
||||
l = int(math.ceil(length / 4.0))
|
||||
return "0x" + "{:X}".format(value).zfill(l)
|
||||
if radix == 8:
|
||||
l = int(math.ceil(length / 3.0))
|
||||
return "0" + "{:o}".format(value).zfill(l)
|
||||
if radix == 2:
|
||||
return "0b" + "{:b}".format(value).zfill(length)
|
||||
# Default: Just return in decimal
|
||||
return str(value)
|
||||
|
||||
def peripheral_list(self):
|
||||
try:
|
||||
keys = self.svd_file.peripherals.iterkeys()
|
||||
except AttributeError:
|
||||
keys = self.svd_file.peripherals.keys()
|
||||
return list(keys)
|
||||
|
||||
def register_list(self, peripheral):
|
||||
try:
|
||||
try:
|
||||
keys = self.svd_file.peripherals[peripheral].registers.iterkeys()
|
||||
except AttributeError:
|
||||
keys = self.svd_file.peripherals[peripheral].registers.keys()
|
||||
return list(keys)
|
||||
except:
|
||||
gdb.write("Peripheral {} doesn't exist\n".format(peripheral))
|
||||
return []
|
||||
|
||||
def field_list(self, peripheral, register):
|
||||
try:
|
||||
periph = self.svd_file.peripherals[peripheral]
|
||||
reg = periph.registers[register]
|
||||
try:
|
||||
regs = reg.fields.iterkeys()
|
||||
except AttributeError:
|
||||
regs = reg.fields.keys()
|
||||
return list(regs)
|
||||
except:
|
||||
gdb.write("Register {} doesn't exist on {}\n".format(register, peripheral))
|
||||
return []
|
||||
Reference in New Issue
Block a user