util/uvmdvgen/gen_env.py

# Copyright lowRISC contributors.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0
"""Generate SystemVerilog UVM agent extended freom our DV lib
"""

import os

from mako.template import Template
from pkg_resources import resource_filename


def gen_env(name, is_cip, env_agents, root_dir):
    # yapf: disable
    # 4-tuple - sub-path, ip name, class name, file ext
    env_srcs = [('env',         name + '_', 'env_cfg',            '.sv'),
                ('env',         name + '_', 'env_cov',            '.sv'),
                ('env',         name + '_', 'env_pkg',            '.sv'),
                ('env',         name + '_', 'reg_block',          '.sv'),
                ('env',         name + '_', 'scoreboard',         '.sv'),
                ('env',         name + '_', 'virtual_sequencer',  '.sv'),
                ('env',         name + '_', 'env',                '.sv'),
                ('env',         name + '_', 'env',                '.core'),
                ('env/seq_lib', name + '_', 'base_vseq',          '.sv'),
                ('env/seq_lib', name + '_', 'sanity_vseq',        '.sv'),
                ('env/seq_lib', name + '_', 'common_vseq',        '.sv'),
                ('env/seq_lib', name + '_', 'vseq_list',          '.sv'),
                ('tb',          '',         'tb',                 '.sv'),
                ('tb',          name + '_', 'bind',               '.sv'),
                ('tests',       name + '_', 'base_test',          '.sv'),
                ('tests',       name + '_', 'test_pkg',           '.sv'),
                ('tests',       name + '_', 'test',               '.core'),
                ('.',           '',         'Makefile',           ''),
                ('.',           '',         'plan',               '.md'),
                ('.',           name + '_', 'sim',                '.core')]
    # yapf: enable

    for tup in env_srcs:
        path_dir = root_dir + '/' + tup[0]
        src_prefix = tup[1]
        src = tup[2]
        src_suffix = tup[3]

        if env_agents == [] and src == "virtual_sequencer": continue

        ftpl = src + src_suffix + '.tpl'
        fname = src_prefix + src + src_suffix

        # read template
        tpl = Template(filename=resource_filename('uvmdvgen', ftpl))

        if not os.path.exists(path_dir): os.system("mkdir -p " + path_dir)
        with open(path_dir + "/" + fname, 'w') as fout:
            fout.write(
                tpl.render(name=name, is_cip=is_cip, env_agents=env_agents))