Skip to content

LoadSVD: Load SVD from ZIP file instead of pkg_resources #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maribu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

LoadSVD: Load SVD from ZIP file instead of pkg_resources #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 42 additions & 10 deletions cmdebug/svd_gdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@
"""

import gdb
import re
import math
import sys
import pathlib
import re
import struct
import pkg_resources
import sys
import tempfile
import zipfile

from os import environ

sys.path.append('.')
from cmdebug.svd import SVDFile
Expand All @@ -31,6 +35,16 @@
32: "I",
}

if "XDG_CACHE_HOME" in environ and environ["XDG_CACHE_HOME"] != "":
CACHE_DIR = pathlib.Path.joinpath(environ["XDG_CACHE_HOME"], "cmdebug")
else:
CACHE_DIR = pathlib.Path.joinpath(pathlib.Path.home(), ".cache", "cmdebug")

if "CMSIS_SVD_ZIPFILE" in environ and environ["CMSIS_SVD_ZIPFILE"] != "":
CMSIS_SVD_ZIPFILE = pathlib.Path(environ("CMSIS_SVD_ZIPFILE"))
else:
CMSIS_SVD_ZIPFILE = pathlib.Path.joinpath(CACHE_DIR, "cmsis-svd-data.zip")


class LoadSVD(gdb.Command):
""" A command to load an SVD file and to create the command for inspecting
Expand All @@ -40,11 +54,16 @@ class LoadSVD(gdb.Command):
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:
with zipfile.ZipFile(CMSIS_SVD_ZIPFILE, mode='r') as svdzip:
for entry in svdzip.namelist():
if entry.lower().endswith(".svd"):
p = pathlib.Path(entry)
vendor = p.parent.name
model = p.name[:-4]
if vendor not in self.vendors:
self.vendors[vendor] = list()
self.vendors[vendor].append(model)
except FileNotFoundError:
pass

if len(self.vendors) > 0:
Expand Down Expand Up @@ -75,14 +94,27 @@ def complete(self, text, word):
def invoke(args, from_tty):
args = gdb.string_to_argv(args)
argc = len(args)
f = None
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]))
name = args[0].lower() + "/" + args[1].lower() + ".svd"
try:
with zipfile.ZipFile(CMSIS_SVD_ZIPFILE, mode='r') as svdzip:
for entry in svdzip.namelist():
lower = entry.lower()
if lower == name or lower.endswith("/" + name):
f = svdzip.extract(entry, path=tempfile.TemporaryDirectory().name)
break
except FileNotFoundError:
raise gdb.GdbError(f"Could not open \"{CMSIS_SVD_ZIPFILE}\"")

if f is None:
raise gdb.GdbError(f"Could not find SVD for \"{args[0]}/{args[1]}\" in \"{CMSIS_SVD_ZIPFILE}\": No case-insensitive match for \"**/{name}\"")
else:
raise gdb.GdbError("Usage: svd_load <vendor> <device.svd> or svd_load <path/to/filename.svd>\n")
raise gdb.GdbError("Usage: svd_load <vendor> <device> or svd_load <path/to/filename.svd>\n")
try:
SVD(SVDFile(f))
except Exception as e:
Expand Down