Skip to content

field array collect #54

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

Merged
merged 1 commit into from
May 28, 2021
Merged

field array collect #54

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## [Unreleased]

* Support for collecting fields in field arrays
* Deriving fields

## [v0.1.13] 2021-04-16

* Fix use of `vendorExtensions` tag in SVD files (#53)
Expand Down
5 changes: 5 additions & 0 deletions example/common_patches/tsc/tsc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
TSC:
_array:
IOG?CR: {}
IOHCR:
_array:
G1_IO?: {}
G2_IO*:
_derivedFrom: "G1_IO1"
6 changes: 1 addition & 5 deletions svdtools/mmap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,7 @@ def iter_fields(rtag):
return fields.findall("field")


ACCESS = {
"read-only": "ro",
"read-write": "rw",
"write-only": "wo",
}
ACCESS = {"read-only": "ro", "read-write": "rw", "write-only": "wo"}


def get_access(tag):
Expand Down
152 changes: 108 additions & 44 deletions svdtools/patch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,11 +892,17 @@ def collect_in_array(self, rspec, rmod):
for rtag, _, _ in registers[1:]:
self.ptag.find("registers").remove(rtag)
rtag = registers[0][0]
nametag = rtag.find("name")
if "name" in rmod:
name = rmod["name"]
else:
name = rspec[:li] + "%s" + rspec[len(rspec) - ri :]
rtag.find("name").text = name
if dimIndex[0] == "0":
desc = rtag.find("description")
desc.text = desc.text.replace(
nametag.text[li : len(nametag.text) - ri], "%s"
)
nametag.text = name
self.process_register(name, rmod)
ET.SubElement(rtag, "dim").text = str(dim)
ET.SubElement(rtag, "dimIncrement").text = hex(dimIncrement)
Expand Down Expand Up @@ -1021,6 +1027,10 @@ def process_register(self, rspec, register, update_fields=True):
if not fspec.startswith("_"):
field = register[fspec]
r.process_field(pname, fspec, field)
# Handle field arrays
for fspec in register.get("_array", {}):
fmod = register["_array"][fspec]
r.collect_fields_in_array(fspec, fmod)
if rcount == 0:
raise MissingRegisterError("Could not find {}:{}".format(pname, rspec))

Expand Down Expand Up @@ -1134,6 +1144,56 @@ def merge_fields(self, fspec):
ET.SubElement(fnew, "bitOffset").text = str(bitoffset)
ET.SubElement(fnew, "bitWidth").text = str(bitwidth)

def collect_fields_in_array(self, fspec, fmod):
"""Collect same fields in peripheral into register array."""
fields = []
li, ri = spec_ind(fspec)
for ftag in list(self.iter_fields(fspec)):
fname = ftag.findtext("name")
fields.append(
[ftag, fname[li : len(fname) - ri], int(ftag.findtext("bitOffset"), 0)]
)
dim = len(fields)
if dim == 0:
raise SvdPatchError(
"{}: fields {} not found".format(self.rtag.findtext("name"), fspec)
)
fields = sorted(fields, key=lambda f: f[2])

if fmod.get("_start_from_zero", ""):
dimIndex = ",".join([str(i) for i in range(dim)])
else:
if dim == 1:
dimIndex = "{0}-{0}".format(fields[0][1])
else:
dimIndex = ",".join(f[1] for f in fields)
offsets = [f[2] for f in fields]
dimIncrement = 0
if dim > 1:
dimIncrement = offsets[1] - offsets[0]

if not check_offsets(offsets, dimIncrement):
raise SvdPatchError(
"{}: fields cannot be collected into {} array".format(
self.rtag.findtext("name"), fspec
)
)
for ftag, _, _ in fields[1:]:
self.rtag.find("fields").remove(ftag)
ftag = fields[0][0]
nametag = ftag.find("name")
if "name" in fmod:
name = fmod["name"]
else:
name = fspec[:li] + "%s" + fspec[len(fspec) - ri :]
desc = ftag.find("description")
desc.text = desc.text.replace(nametag.text[li : len(nametag.text) - ri], "%s")
nametag.text = name
# self.process_field(name, fmod)
ET.SubElement(ftag, "dim").text = str(dim)
ET.SubElement(ftag, "dimIndex").text = dimIndex
ET.SubElement(ftag, "dimIncrement").text = hex(dimIncrement)

def split_fields(self, fspec):
"""split all fspec in rtag."""
fields = list(self.iter_fields(fspec))
Expand Down Expand Up @@ -1179,56 +1239,60 @@ def process_field_enum(self, pname, fspec, field, usage="read-write"):

derived, enum, enum_name, enum_usage = None, None, None, None
for ftag in self.iter_fields(fspec):
name = ftag.find("name").text

if enum is None:
enum = make_enumerated_values(name, field, usage=usage)
enum_name = enum.find("name").text
enum_usage = enum.find("usage").text

for ev in ftag.iter("enumeratedValues"):
if len(ev) > 0:
ev_usage_tag = ev.find("usage")
ev_usage = (
ev_usage_tag.text if ev_usage_tag is not None else "read-write"
)
else:
# This is a derived enumeratedValues => Try to find the
# original definition to extract its <usage>
derived_name = ev.attrib["derivedFrom"]
derived_enums = self.rtag.findall(
"./fields/field/enumeratedValues/[name='{}']".format(
derived_name
)
)
if "_derivedFrom" in field:
derived = field["_derivedFrom"]
else:
name = ftag.find("name").text

if derived_enums == []:
raise SvdPatchError(
"{}: field {} derives enumeratedValues {} which could not be found".format(
pname, name, derived_name
)
if derived is None:
if enum is None:
enum = make_enumerated_values(name, field, usage=usage)
enum_name = enum.find("name").text
enum_usage = enum.find("usage").text

for ev in ftag.iter("enumeratedValues"):
if len(ev) > 0:
ev_usage_tag = ev.find("usage")
ev_usage = (
ev_usage_tag.text
if ev_usage_tag is not None
else "read-write"
)
elif len(derived_enums) != 1:
raise SvdPatchError(
"{}: field {} derives enumeratedValues {} which was found multiple times".format(
pname, name, derived_name
else:
# This is a derived enumeratedValues => Try to find the
# original definition to extract its <usage>
derived_name = ev.attrib["derivedFrom"]
derived_enums = self.rtag.findall(
"./fields/field/enumeratedValues/[name='{}']".format(
derived_name
)
)

ev_usage = derived_enums[0].find("usage").text

if ev_usage == enum_usage or ev_usage == "read-write":
if replace_if_exists:
ftag.remove(ev)
else:
print(pname, fspec, field)
raise SvdPatchError(
"{}: field {} already has enumeratedValues for {}".format(
pname, name, ev_usage
if derived_enums == []:
raise SvdPatchError(
"{}: field {} derives enumeratedValues {} which could not be found".format(
pname, name, derived_name
)
)
elif len(derived_enums) != 1:
raise SvdPatchError(
"{}: field {} derives enumeratedValues {} which was found multiple times".format(
pname, name, derived_name
)
)
)

if derived is None:
ev_usage = derived_enums[0].find("usage").text

if ev_usage == enum_usage or ev_usage == "read-write":
if replace_if_exists:
ftag.remove(ev)
else:
print(pname, fspec, field)
raise SvdPatchError(
"{}: field {} already has enumeratedValues for {}".format(
pname, name, ev_usage
)
)
ftag.append(enum)
derived = enum_name
else:
Expand Down