#!/usr/bin/env python3
# Copyright lowRISC contributors (OpenTitan project).
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0
r"""FuseSoc generator for UVM RAL package created with either regtool or
topgen tools.
"""
import os
import shlex
import subprocess
import sys
from pathlib import Path

import yaml

try:
    from yaml import CSafeLoader as YamlLoader
except ImportError:
    from yaml import SafeLoader as YamlLoader

# Repo root is 4 levels up. Note that this will require an update if the path to
# this tool is changed.
REPO_ROOT = "../../../.."


def main():
    if len(sys.argv) != 2:
        print("ERROR: This script takes a single YAML file as input argument")
        sys.exit(1)

    gapi_filepath = sys.argv[1]
    gapi = yaml.load(open(gapi_filepath), Loader=YamlLoader)

    # The reggen and topgen tools live in REPO_ROOT/util area.
    util_path = Path(__file__).parent / REPO_ROOT / "util"

    # Retrieve the parameters from the yml.
    root_dir = Path(gapi['files_root'])
    name = gapi['parameters'].get('name')
    alias_hjson = gapi['parameters'].get('alias_hjson')
    ip_hjson = gapi['parameters'].get('ip_hjson')
    top_hjson = gapi['parameters'].get('top_hjson')
    dv_base_names = gapi['parameters'].get('dv_base_names')
    hjson_path = gapi['parameters'].get('hjson_path')

    if not name or (bool(ip_hjson) == bool(top_hjson)):
        print("Error: ralgen requires the \"name\" and exactly one of "
              "{\"ip_hjson\" and \"top_hjson\"} parameters to be set.")
        sys.exit(1)

    # Generate the RAL pkg.
    if ip_hjson:
        ral_spec = root_dir / ip_hjson
        cmd = util_path / "regtool.py"
        args = [cmd, "-s", "-t", os.getcwd(), ral_spec]
        if alias_hjson:
            args += ["--alias", root_dir / alias_hjson]
    else:
        ral_spec = root_dir / top_hjson
        # Extract top_name from ral spec path and create _seed.testing.hjson
        ral_path = Path(ral_spec)
        top_name = ral_path.stem
        seed_path = ral_path.with_name(f"{top_name}_seed.testing.hjson")

        cmd = util_path / "topgen.py"
        args = [cmd, "-r", "-o", os.getcwd(), "-t", ral_spec, "-s", seed_path]
        if hjson_path:
            args += ["--hjson-path", root_dir / hjson_path]
        if alias_hjson:
            args += ["--alias-files"]
            for alias in alias_hjson:
                args += [root_dir / alias]
    if dv_base_names:
        args += ["--dv-base-names"] + dv_base_names

    cmd_str = ' '.join([shlex.quote(str(arg)) for arg in args])
    print(f"Calling tool in ralgen.py: {cmd_str}")
    try:
        subprocess.run(args, check=True)
    except subprocess.CalledProcessError as e:
        print(f"Error: RAL pkg generation failed:\n{e}")
        sys.exit(e.returncode)

    print(f"RAL pkg for {name} written to {Path.cwd()}.")


if __name__ == '__main__':
    main()
