# See LICENSE for licensing information.
#
# Copyright (c) 2016-2019 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 debug
import design
from vector import vector
from globals import OPTS
from sram_factory import factory


class replica_pbitcell(design.design):
    """
    Creates a replica bitcell using pbitcell
    """

    def __init__(self, name):
        self.num_rw_ports = OPTS.num_rw_ports
        self.num_w_ports = OPTS.num_w_ports
        self.num_r_ports = OPTS.num_r_ports
        self.total_ports = self.num_rw_ports + self.num_w_ports + self.num_r_ports
    
        design.design.__init__(self, name, name)
        debug.info(1, "create a replica bitcell using pbitcell with {0} rw ports, {1} w ports and {2} r ports".format(self.num_rw_ports,
                                                                                                                      self.num_w_ports,
                                                                                                                      self.num_r_ports))
                                                                                                                      
        self.create_netlist()
        self.create_layout()
        self.add_boundary()
        
    def create_netlist(self):
        self.add_pins()
        self.add_modules()
        self.create_modules()
        
    def create_layout(self):
        self.place_pbitcell()
        self.route_rbc_connections()
        self.DRC_LVS()
        
    def add_pins(self):
        for port in range(self.total_ports):
            self.add_pin("bl{}".format(port))
            self.add_pin("br{}".format(port))
        
        for port in range(self.total_ports):
            self.add_pin("wl{}".format(port))
            
        self.add_pin("vdd")
        self.add_pin("gnd")
        
    def add_modules(self):
        self.prbc = factory.create(module_type="pbitcell",
                                   replica_bitcell=True)
        self.add_mod(self.prbc)
        
        self.height = self.prbc.height
        self.width = self.prbc.width
        
    def create_modules(self):
        self.prbc_inst = self.add_inst(name="pbitcell",
                                       mod=self.prbc)
        
        temp = []
        for port in range(self.total_ports):
            temp.append("bl{}".format(port))
            temp.append("br{}".format(port))
        for port in range(self.total_ports):
            temp.append("wl{}".format(port))
        temp.append("vdd")
        temp.append("gnd")
        self.connect_inst(temp)
        
    def place_pbitcell(self):
        self.prbc_inst.place(offset=vector(0, 0))
        
    def route_rbc_connections(self):
        for port in range(self.total_ports):
            self.copy_layout_pin(self.prbc_inst, "bl{}".format(port))
            self.copy_layout_pin(self.prbc_inst, "br{}".format(port))
        for port in range(self.total_ports):
            self.copy_layout_pin(self.prbc_inst, "wl{}".format(port))
        self.copy_layout_pin(self.prbc_inst, "vdd")
        self.copy_layout_pin(self.prbc_inst, "gnd")