Skip to content
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

Jump to bottom

csr: add ability to express clusters #1659

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

csr: add ability to express clusters #1659

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
12 changes: 9 additions & 3 deletions litex/soc/doc/csr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ def __init__(self, name, address,
size = 8,
description = None,
access = "read-write",
cluster = None,
fields = []):

self.name = name
Expand All @@ -53,6 +54,7 @@ def __init__(self, name, address,
self.address = address
self.offset = offset
self.size = size
self.cluster = cluster
if size == 0:
print("!!! Warning: creating CSR of size 0 {}".format(name))
self.description = self.trim(description)
Expand Down Expand Up @@ -337,6 +339,7 @@ def document_csr(self, csr):
atomic_write = csr.atomic_write
size = self.get_csr_size(csr)
reset = self.get_csr_reset(csr)
cluster = csr.cluster

# If the CSR is composed of multiple sub-CSRs, document each
# one individually.
Expand Down Expand Up @@ -366,7 +369,8 @@ def document_csr(self, csr):
size = self.csr_data_width,
description = d,
fields = self.split_fields(fields, start, start + length),
access = access
access = access,
cluster = cluster
))
else:
self.csrs.append(DocumentedCSR(
Expand All @@ -379,7 +383,8 @@ def document_csr(self, csr):
size = self.csr_data_width,
description = bits_str,
fields = self.split_fields(fields, start, start + length),
access = access
access = access,
cluster = cluster
))
self.current_address += 4
else:
Expand All @@ -392,7 +397,8 @@ def document_csr(self, csr):
size = size,
description = description,
fields = fields,
access = access
access = access,
cluster = cluster
))
self.current_address += 4

Expand Down
189 changes: 151 additions & 38 deletions litex/soc/integration/export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import time
import datetime
import inspect
import collections
from shutil import which
from sysconfig import get_platform

Expand Down Expand Up @@ -435,6 +436,20 @@ def get_csr_csv(csr_regions={}, constants={}, mem_regions={}):
# SVD Export --------------------------------------------------------------------------------------

def get_csr_svd(soc, vendor="litex", name="soc", description=None):
class IndentedAppender:
def __init__(self, receiver, indent=""):
self._receiver = receiver
self._indent = indent

def append(self, line):
self._receiver.append(self._indent + line)

def indent(self, indent):
return IndentedAppender(self, indent)

def unindent(self):
return self._receiver

def sub_csr_bit_range(busword, csr, offset):
nwords = (csr.size + busword - 1)//busword
i = nwords - offset - 1
Expand All @@ -443,16 +458,18 @@ def sub_csr_bit_range(busword, csr, offset):
origin = i*busword
return (origin, nbits, name)

def print_svd_register(csr, csr_address, description, length, svd):
def print_svd_register(csr, csr_address, description, length, cluster_state, svd):
prefix_len = 0
if cluster_state is not None:
prefix_len = cluster_state.prefix_len
svd.append(' <register>')
svd.append(' <name>{}</name>'.format(csr.short_numbered_name))
svd.append(' <name>{}</name>'.format(csr.short_numbered_name[prefix_len:]))
if description is not None:
svd.append(' <description><![CDATA[{}]]></description>'.format(description))
svd.append(' <addressOffset>0x{:04x}</addressOffset>'.format(csr_address))
svd.append(' <resetValue>0x{:02x}</resetValue>'.format(csr.reset_value))
svd.append(' <size>{}</size>'.format(length))
# svd.append(' <access>{}</access>'.format(csr.access)) # 'access' is a lie: "read-only" registers can legitimately change state based on a write, and is in fact used to handle the "pending" field in events
csr_address = csr_address + 4
svd.append(' <fields>')
if hasattr(csr, "fields") and len(csr.fields) > 0:
for field in csr.fields:
Expand All @@ -468,7 +485,7 @@ def print_svd_register(csr, csr_address, description, length, svd):
svd.append(' </field>')
else:
field_size = csr.size
field_name = csr.short_name.lower()
field_name = csr.short_name.lower()[prefix_len:]
# Strip off "ev_" from eventmanager fields
if field_name == "ev_enable":
field_name = "enable"
Expand All @@ -485,6 +502,135 @@ def print_svd_register(csr, csr_address, description, length, svd):
svd.append(' </fields>')
svd.append(' </register>')

def print_svd_registers(region, csrs, svd):
csr_address = 0
current_cluster = []
cluster_states = []
do_print = True

class ClusterState:
def __init__(self, cluster, prev_state, must_close):
self.offset = None
self.current_address = 0
self.end = None
self.layout = list(reversed(cluster._layout_csrs))
self.cluster = cluster
self.must_close = must_close
# We use index 0 for the prefix as that's the only item we are going to print
self.prefix_len = len(f"{cluster.name}_{cluster._prefix_for(0)}")
if prev_state:
self.prefix_len += prev_state.prefix_len
self.prev_state = prev_state

def push_cluster(cluster, prev_state):
nonlocal svd
if do_print:
svd.append(' <cluster>')
svd.append(' <name>{}[%s]</name>'.format(cluster.name.upper()))
svd.append(' <dim>{}</dim>'.format(len(cluster.items)))
if cluster.description is not None:
svd.append(' <description><![CDATA[{}]]></description>'.format(cluster.description))
svd = svd.indent(" ")
return ClusterState(cluster, prev_state, do_print)

def pop_cluster(cluster, state):
nonlocal svd
if state.must_close:
svd = svd.unindent()
increment = int(state.current_address / len(state.cluster.items))
svd.append(' <dimIncrement>0x{:04x}</dimIncrement>'.format(increment))
svd.append(' <addressOffset>0x{:04x}</addressOffset>'.format(state.offset))
svd.append(' </cluster>')

for csr in csrs:
description = None
if hasattr(csr, "description"):
description = csr.description

# Find cluster differences
exits = collections.deque(current_cluster)
entries = collections.deque(csr.cluster or [])
while exits and entries and exits[0] == entries[0]:
exits.popleft()
entries.popleft()

while exits:
pop_cluster(exits.pop(), cluster_states.pop())

# We can do this before pushing a new cluster, a new cluster would
# push with a layout and would not set `do_print = False`.
do_print = True
for state in cluster_states:
if not state.layout:
do_print = False

while entries:
if cluster_states:
prev_state = cluster_states[-1]
else:
prev_state = None
state = push_cluster(entries.popleft(), prev_state)
if state.prev_state:
state.offset = state.prev_state.current_address
else:
state.offset = csr_address
cluster_states.append(state)

current_cluster = csr.cluster or []

# Grab the latest cluster state for easy access to the address later
cluster_state = None
if cluster_states:
cluster_state = cluster_states[-1]

if isinstance(csr, _CompoundCSR) and len(csr.simple_csrs) > 1:
is_first = True
for i in range(len(csr.simple_csrs)):
(start, length, name) = sub_csr_bit_range(
region.busword, csr, i)
if length > 0:
bits_str = "Bits {}-{} of `{}`.".format(
start, start+length, csr.name)
else:
bits_str = "Bit {} of `{}`.".format(
start, csr.name)
if do_print:
address = csr_address if cluster_state is None else cluster_state.current_address
if is_first:
if description is not None:
print_svd_register(
csr.simple_csrs[i], address, bits_str + " " + description, length,
cluster_state, svd)
else:
print_svd_register(
csr.simple_csrs[i], address, bits_str, length, cluster_state, svd)
is_first = False
else:
print_svd_register(
csr.simple_csrs[i], csr_address, bits_str, length, cluster_state, svd)
for state in cluster_states:
state.current_address += 4
csr_address = csr_address + 4
else:
length = ((csr.size + region.busword - 1) //
region.busword) * region.busword
if do_print:
address = csr_address if cluster_state is None else cluster_state.current_address
print_svd_register(
csr, address, description, length, cluster_state, svd)
for state in cluster_states:
state.current_address += 4
csr_address = csr_address + 4

for state in cluster_states:
if state.layout:
state.layout.pop()

while current_cluster:
pop_cluster(current_cluster.pop(), cluster_states.pop())

return csr_address

interrupts = {}
for csr, irq in sorted(soc.irq.locs.items()):
interrupts[csr] = irq
Expand Down Expand Up @@ -520,7 +666,6 @@ def print_svd_register(csr, csr_address, description, length, svd):
svd.append(' <peripherals>')

for region in documented_regions:
csr_address = 0
svd.append(' <peripheral>')
svd.append(' <name>{}</name>'.format(region.name.upper()))
svd.append(' <baseAddress>0x{:08X}</baseAddress>'.format(region.origin))
Expand All @@ -529,39 +674,7 @@ def print_svd_register(csr, csr_address, description, length, svd):
svd.append(' <description><![CDATA[{}]]></description>'.format(
reflow(region.sections[0].body())))
svd.append(' <registers>')
for csr in region.csrs:
description = None
if hasattr(csr, "description"):
description = csr.description
if isinstance(csr, _CompoundCSR) and len(csr.simple_csrs) > 1:
is_first = True
for i in range(len(csr.simple_csrs)):
(start, length, name) = sub_csr_bit_range(
region.busword, csr, i)
if length > 0:
bits_str = "Bits {}-{} of `{}`.".format(
start, start+length, csr.name)
else:
bits_str = "Bit {} of `{}`.".format(
start, csr.name)
if is_first:
if description is not None:
print_svd_register(
csr.simple_csrs[i], csr_address, bits_str + " " + description, length, svd)
else:
print_svd_register(
csr.simple_csrs[i], csr_address, bits_str, length, svd)
is_first = False
else:
print_svd_register(
csr.simple_csrs[i], csr_address, bits_str, length, svd)
csr_address = csr_address + 4
else:
length = ((csr.size + region.busword - 1) //
region.busword) * region.busword
print_svd_register(
csr, csr_address, description, length, svd)
csr_address = csr_address + 4
csr_address = print_svd_registers(region, region.csrs, IndentedAppender(svd))
svd.append(' </registers>')
svd.append(' <addressBlock>')
svd.append(' <offset>0</offset>')
Expand Down
Loading