#!/usr/bin/env python3
# See LICENSE for licensing information.
#
# Copyright (c) 2016-2023 Regents of the University of California and The Board
# of Regents for the Oklahoma Agricultural and Mechanical College
# (acting for and on behalf of Oklahoma State University)
# All rights reserved.
#
import sys, os
import unittest
from testutils import *

import openram
from openram import debug
from openram.sram_factory import factory
from openram import OPTS


class timing_sram_test(openram_test):

    def runTest(self):
        config_file = "{}/tests/configs/config".format(os.getenv("OPENRAM_HOME"))
        openram.init_openram(config_file, is_unit_test=True)
        OPTS.spice_name="xyce"
        OPTS.analytical_delay = False
        OPTS.netlist_only = True

        # This is a hack to reload the characterizer __init__ with the spice version
        from importlib import reload
        from openram import characterizer
        reload(characterizer)
        from openram.characterizer import delay
        from openram import sram_config
        if OPTS.tech_name == "sky130":
            num_spare_rows = 1
            num_spare_cols = 1
        else:
            num_spare_rows = 0
            num_spare_cols = 0

        c = sram_config(word_size=4,
                        num_words=16,
                        num_banks=1,
                        num_spare_cols=num_spare_cols,
                        num_spare_rows=num_spare_rows)
        c.words_per_row=1
        c.recompute_sizes()
        debug.info(1, "Testing timing for sample 1bit, 16words SRAM with 1 bank")
        s = factory.create(module_type="sram", sram_config=c)

        tempspice = OPTS.openram_temp + "temp.sp"
        s.sp_write(tempspice)

        probe_address = "1" * s.s.addr_size
        probe_data = s.s.word_size - 1
        debug.info(1, "Probe address {0} probe data bit {1}".format(probe_address, probe_data))

        corner = (OPTS.process_corners[0], OPTS.supply_voltages[0], OPTS.temperatures[0])
        d = delay(s.s, tempspice, corner)
        from openram import tech
        loads = [tech.spice["dff_in_cap"]*4]
        slews = [tech.spice["rise_time"]*2]
        load_slews = []
        for slew in slews:
            for load in loads:
                load_slews.append((load, slew))
        data, port_data = d.analyze(probe_address, probe_data, load_slews)
        # Combine info about port into all data
        data.update(port_data[0])

        if OPTS.tech_name == "freepdk45":
            golden_data = {'delay_hl': [0.2314011],
                           'delay_lh': [0.2314011],
                           'disabled_read0_power': [0.173459901],
                           'disabled_read1_power': [0.185612201],
                           'disabled_write0_power': [0.202493001],
                           'disabled_write1_power': [0.224080601],
                           'leakage_power': 0.0017065770000000001,
                           'min_period': 0.938,
                           'read0_power': [0.372276201],
                           'read1_power': [0.37621480100000004],
                           'slew_hl': [0.27947489999999997],
                           'slew_lh': [0.27947489999999997],
                           'write0_power': [0.429895901],
                           'write1_power': [0.383337501]}
        elif OPTS.tech_name == "scn4m_subm":
            golden_data = {'delay_hl': [1.884186],
                           'delay_lh': [1.884186],
                           'disabled_read0_power': [20.86336],
                           'disabled_read1_power': [22.10636],
                           'disabled_write0_power': [22.62321],
                           'disabled_write1_power': [23.316010000000002],
                           'leakage_power': 13.351170000000002,
                           'min_period': 7.188,
                           'read0_power': [29.90159],
                           'read1_power': [30.47858],
                           'slew_hl': [2.042723],
                           'slew_lh': [2.042723],
                           'write0_power': [32.13199],
                           'write1_power': [28.46703]}
        else:
            self.assertTrue(False) # other techs fail
        # Check if no too many or too few results
        self.assertTrue(len(data.keys())==len(golden_data.keys()))

        self.assertTrue(self.check_golden_data(data,golden_data,0.25))

        openram.end_openram()


# run the test from the command line
if __name__ == "__main__":
    (OPTS, args) = openram.parse_args()
    del sys.argv[1:]
    header(__file__, OPTS.tech_name)
    unittest.main(testRunner=debugTestRunner())