hw/ip/alert_handler/util/reg_alert_handler.py

#!/usr/bin/env python3
# Copyright lowRISC contributors.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0
r"""Convert mako template to hjson register description
"""
import argparse
import sys
from io import StringIO

from mako.template import Template


def main():
    parser = argparse.ArgumentParser(prog="reg_alert_handler")
    parser.add_argument('input',
                        nargs='?',
                        metavar='file',
                        type=argparse.FileType('r'),
                        default=sys.stdin,
                        help='input template file')
    parser.add_argument('--n_alerts',
                        type=int,
                        default=4,
                        help='Number of Alert Sources')
    parser.add_argument('--esc_cnt_dw',
                        type=int,
                        default=32,
                        help='Width of escalation counter')
    parser.add_argument('--accu_cnt_dw',
                        type=int,
                        default=16,
                        help='Width of accumulator')
    parser.add_argument('--lfsr_seed',
                        type=int,
                        default=2**31-1,
                        help='Seed for LFSR timer')
    parser.add_argument('--async_on',
                        type=str,
                        default="'0",
                        help="""Enables asynchronous sygnalling between specific
                        alert RX/TX pairs""")

    args = parser.parse_args()

    if (args.lfsr_seed & 0xFFFF_FFFF) == 0 or args.lfsr_seed > 2**32:
        parser.error("LFSR seed out of range or zero")

    # Determine output: if stdin then stdout if not then ??
    out = StringIO()

    reg_tpl = Template(args.input.read())
    out.write(
        reg_tpl.render(n_alerts=args.n_alerts,
                       esc_cnt_dw=args.esc_cnt_dw,
                       accu_cnt_dw=args.accu_cnt_dw,
                       lfsr_seed=args.lfsr_seed,
                       async_on=args.async_on,
                       n_classes=4)) # leave this constant for now

    print(out.getvalue())

    out.close()


if __name__ == "__main__":
    main()