extractparams.py

# Read the user parameters file (usually hwconfig.user) and extract
# parameters for all of the user-defined modules specified there.
from __future__ import print_function
import os
import yaml
from lxml import etree
#from IPython import embed

inpath = 'hwconfig.user'
outpath = 'hwconfig.all'

params = yaml.load(open(inpath))

for module in params['hw']:
  if module['type'] == 'dma':
    # Xilinx provided stuff doesn't need probing
    continue

  if not os.path.isdir(module['path']):
    print("[Error] Couldn't find IP for %s in %s!" % (module['name'], module['path']))
    continue

  print("Extracting parameters for", module['name'])
  module['streams'] = [] # Start empty list of data streams

  desc = etree.parse(open(module['path']+'/component.xml'))
  # Have to pass the namespace mappings, or lxml chokes
  ns = desc.getroot().nsmap

  # Create the VLNV (formal Xilinx name: vendor-library-name-version)
  module['vlnv'] = \
    str(desc.xpath('/spirit:component/spirit:vendor/text()', namespaces=ns)[0]) + ":" + \
    str(desc.xpath('/spirit:component/spirit:library/text()', namespaces=ns)[0]) + ":" + \
    str(desc.xpath('/spirit:component/spirit:name/text()', namespaces=ns)[0]) +  ":" +\
    str(desc.xpath('/spirit:component/spirit:version/text()', namespaces=ns)[0])

  # Get all of the AXI-stream interfaces
  ifaces = desc.xpath('//spirit:busInterface[spirit:busType/@spirit:name="axis"]', namespaces=ns)
  for iface in ifaces:
    stream = {}
    stream['name'] = str(iface.xpath('spirit:name/text()', namespaces=ns)[0])
    print("  Parsing stream: '{}'".format(stream['name']))
    if len(iface.xpath('spirit:master', namespaces=ns)) is not 0:
      stream['type'] = 'output'
    elif len(iface.xpath('spirit:slave', namespaces=ns)) is not 0:
      stream['type'] = 'input'
    else:
      stream['type'] = 'unknown' # We're in serious trouble...

    streamdepths = iface.xpath('.//spirit:parameter[spirit:name="TDATA_NUM_BYTES"]/spirit:value/text()', namespaces=ns)
    if len(streamdepths) == 1:
      stream['depth'] = int(streamdepths[0])
    else:
      print("[Warning] Failed to get stream depth for stream", stream['name'])

    module['streams'].append(stream)

# second pass
for module in params["hw"]:
  if module["type"] == "hls":
    input_types = ["dma", "csi"]
    # we need to collect all the DMA's that are pointing to it
    input_dmas = []
    specified_dmas = []
    for dma in params["hw"]:
      if dma["type"] not in input_types or not dma.has_key("outputto"):
        continue
      # we have found an input dma channel
      if dma["outputto"] == module["name"]:
        input_dmas.append(dma)
      elif "." in dma["outputto"] and dma["outputto"].split(".")[0] == module["name"]:
        specified_dmas.append(dma)
      else:
        pass
        # This is misleading; it's just ignoring things that shouldn't be connected
        #print("[Info] Mismatched channel name. Expect module name", module["name"],
              #"got", dma["outputto"])
    input_streams = [entry for entry in module["streams"]
                     if entry["type"] == "input"]
    # we need to make sure that the input list matches with the HLS IP
    assert(len(input_dmas + specified_dmas) == len(input_streams))
    # remove the input_streams that's been specified already
    for dma in specified_dmas:
      input_streams = [entry for entry in input_streams
                       if entry["name"] != dma["outputto"].split(".")[-1]]
    # rename the outputto property
    # also double check if the user already specifies the connections
    for i in range(len(input_dmas)):
      # updating the object by reference
      # the format will be hls_module.arg_#
      input_dmas[i]["outputto"] += "." + input_streams[i]["name"]

# thid pass to see if there is any input only dma
for module in params["hw"]:
    if module["type"] == "dma":
        out_connected = False
        for m in params["hw"]:
            if m["type"] == "hls" and m["outputto"] == module["name"]:
                out_connected = True
                break
        module["out_connected"] = out_connected

outfile = open(outpath, 'w')
outfile.write(yaml.dump(params))
outfile.close()