# See LICENSE for licensing information.
#
# Copyright (c) 2016-2019 Regents of the University of California
# All rights reserved.
#
import design
from sram_factory import factory
from globals import OPTS
from tech import cell_properties


class s8_row_cap_array(design.design):
    """
    Generate a dummy row/column for the replica array.
    """
    def __init__(self, rows, cols, column_offset=0, mirror=0, name=""):
        super().__init__(name)
        self.rows = rows
        self.cols = cols
        self.column_offset = column_offset
        self.mirror = mirror
        self.no_instances = True
        self.create_netlist()
        if not OPTS.netlist_only:
            self.create_layout()

    def create_netlist(self):
        """ Create and connect the netlist """
        self.add_modules()
        self.add_pins()
        self.create_instances()

    def create_layout(self):

        self.place_array("dummy_r{0}_c{1}", self.mirror)
        self.add_layout_pins()
        self.add_boundary()
        self.DRC_LVS()

    def add_modules(self):
        """ Add the modules used in this design """
        if self.column_offset == 0:
            self.top_corner = factory.create(module_type="s8_corner", location = "ul")
            self.add_mod(self.top_corner)
            self.bottom_corner =factory.create(module_type="s8_corner", location = "ll")
            self.add_mod(self.bottom_corner)
        else:
            self.top_corner = factory.create(module_type="s8_corner", location = "ur")
            self.add_mod(self.top_corner)
            self.bottom_corner = factory.create(module_type="s8_corner", location = "lr")
            self.add_mod(self.bottom_corner)
        
        self.rowend1 = factory.create(module_type="s8_row_end", version = "rowend")
        self.add_mod(self.rowend1)
        self.rowend2 = factory.create(module_type="s8_row_end", version = "rowenda")
        self.add_mod(self.rowend2)

        self.cell = factory.create(module_type="s8_bitcell", version = "opt1")

    def create_instances(self):
        """ Create the module instances used in this design """
        self.cell_inst = {}
        self.array_layout = []
        alternate_bitcell = 0
        for row in range(self.rows):
            row_layout = []
            name="rca_{0}".format(row)
            # Top/bottom cell are always dummy cells.
            # Regular array cells are replica cells (>left_rbl and <rows-right_rbl)
            # Replic bit specifies which other bit (in the full range (0,rows) to make a replica cell.
            if (row < self.rows -1 and row >0):

                if alternate_bitcell == 0:
                    row_layout.append(self.rowend1)
                    self.cell_inst[row]=self.add_inst(name=name, mod=self.rowend1)
                    self.connect_inst(["wl_0_{}".format(row-1), "vpwr"])
                    alternate_bitcell = 1

                else:
                    row_layout.append(self.rowend2)
                    self.cell_inst[row]=self.add_inst(name=name,mod=self.rowend2)
                    self.connect_inst(["wl_0_{}".format(row-1), "vpwr"])
                    alternate_bitcell = 0

            elif (row == 0):
                row_layout.append(self.bottom_corner)
                self.cell_inst[row]=self.add_inst(name=name, mod=self.bottom_corner)
                self.connect_inst([])

            elif (row == self.rows - 1):
                row_layout.append(self.top_corner)
                self.cell_inst[row]=self.add_inst(name=name, mod=self.top_corner)
                self.connect_inst([])


            self.array_layout.append(row_layout)


    def get_bitcell_pins(self, row, col):
        """
        Creates a list of connections in the bitcell,
        indexed by column and row, for instance use in bitcell_array
        """

        pin_name = cell_properties.bitcell.cell_1rw1r.pin
        bitcell_pins = ["{0}_{1}".format(pin_name.wl0, row),
                        "{0}_{1}".format(pin_name.wl1, row),
                        "gnd"]

        return bitcell_pins

    def place_array(self, name_template, row_offset=0):
        self.width = 0
        self.height = 0

        for inst in self.insts:
            self.height += inst.height
            if inst.width > self.width:
                self.width = inst.width
        yoffset = 0.0
        for row in range(0, len(self.array_layout)):
            xoffset = 0.0

            for col in range(0, len(self.array_layout[row])):
                inst = self.insts[col + row*len(self.array_layout[row])]
                inst.place(offset=[xoffset, yoffset])
                xoffset += inst.width
                yoffset += inst.height



    def add_pins(self):
        for row in range(self.rows - 2):
            for port in self.all_ports:
                self.add_pin("wl_{}_{}".format(port, row), "OUTPUT")
        self.add_pin("vpwr", "POWER")
        self.add_pin("vgnd", "GROUND")

    def add_layout_pins(self):
        """ Add the layout pins """
        if self.column_offset == 0:
            row_list = self.cell.get_all_wl_names()

            for row in range(1, self.rows-1):
                if row > 0 and row < self.rows:
                    for cell_row in row_list:
                        wl_pin = self.cell_inst[row].get_pin(cell_row)
                        self.add_layout_pin(text=cell_row + "_0_{0}".format(row),
                                            layer=wl_pin.layer,
                                            offset=wl_pin.ll().scale(0, 1),
                                            width=self.width,
                                            height=wl_pin.height())

            # Add vdd/gnd via stacks
            for row in range(1, self.rows):
                inst = self.cell_inst[row]
                for pin_name in ["vpwr", "vgnd"]:
                    for pin in inst.get_pins(pin_name):
                        self.add_power_pin(name=pin.name,
                                            loc=pin.center(),
                                            start_layer=pin.layer)