hwcomponents-library 1.1.0.dev21__py3-none-any.whl

hwcomponents_library/library/timely.py

@@ -0,0 +1,437 @@
+"""
+@INPROCEEDINGS{9138916,
+  author={Li, Weitao and Xu, Pengfei and Zhao, Yang and Li, Haitong and Xie, Yuan and Lin, Yingyan},
+  booktitle={2020 ACM/IEEE 47th Annual International Symposium on Computer Architecture (ISCA)},
+  title={Timely: Pushing Data Movements And Interfaces In Pim Accelerators Towards Local And In Time Domain},
+  year={2020},
+  volume={},
+  number={},
+  pages={832-845},
+  doi={10.1109/ISCA45697.2020.00073}}
+"""
+
+from hwcomponents_library.base import LibraryEstimatorClassBase
+from hwcomponents.scaling import *
+from hwcomponents import actionDynamicEnergy
+from .isaac import IsaacChip2ChipLink
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,energy,area,action
+# 65nm,1e-9,0.0368,40,read|add
+# 65nm,1e-9,0,40,write|update|leak
+# # TIMELY says these don't contribute to area
+# # Numbers from paper table II
+class TimelyIAdder(LibraryEstimatorClassBase):
+    """
+    The current adder from the TIMELY paper. This unit will sum multiple currents into
+    one.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    """
+
+    component_name = "timely_iadder"
+    priority = 0.9
+
+    def __init__(self, tech_node: float):
+        super().__init__(leak_power=0.0, area=40.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to sum two currents in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to sum two currents in Joules.
+        """
+
+        return 0.0368e-12
+
+    @actionDynamicEnergy
+    def add(self) -> float:
+        """
+        Returns the energy used to sum two currents in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to sum two currents in Joules.
+        """
+
+        return 0.0368e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,n_instances,energy,area,action
+# 65nm,1e-9,1,0.0023,5,drive|read|convert
+# 65nm,1e-9,1,0,5,leak|update|write
+# # Numbers from paper table II
+class TimelyPSubBuf(LibraryEstimatorClassBase):
+    """
+    PSubBuf from the TIMELY paper. This unit will repeat & amplify an input voltage
+    value.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    """
+    component_name = "timely_psubBuf"
+    priority = 0.9
+
+    def __init__(self, tech_node: float):
+        super().__init__(leak_power=0.0, area=5.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+
+    @actionDynamicEnergy
+    def drive(self) -> float:
+        """
+        Returns the energy used to drive a voltage in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to drive a voltage in Joules.
+        """
+        return 0.0023e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to drive a voltage in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to drive a voltage in Joules.
+        """
+        return 0.0023e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,resolution,energy,area,action
+# 65nm,1e-9,8,0.0375,240,convert|read
+# 65nm,1e-9,8,0,240,write|leak|update
+# # Numbers from paper table II
+class TimelyDTC(LibraryEstimatorClassBase):
+    """
+    The digital-to-time converter (DTC) from the TIMELY paper. This unit will convert
+    a digital value into a pulse width modulated (PWM) signal.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    resolution: int
+        Resolution of the DTC in bits.
+    """
+    component_name = "timely_dtc"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, resolution: int = 8):
+        super().__init__(leak_power=0.0, area=240.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.resolution: int = self.scale(
+            "resolution", resolution, 8, pow_base(2), pow_base(2), pow_base(2)
+        )
+
+    @actionDynamicEnergy
+    def convert(self) -> float:
+        """
+        Returns the energy used to convert a digital value into a PWM signal in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a digital value into a PWM signal in Joules.
+        """
+        return 0.0375e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to convert a digital value into a PWM signal in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a digital value into a PWM signal in Joules.
+        """
+        return 0.0375e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,resolution,energy,area,action
+# 65nm,1e-9,8,0.145,310,convert|read
+# 65nm,1e-9,8,0,310,leak|write|update
+class TimelyTDC(LibraryEstimatorClassBase):
+    """
+    The time-to-digital converter (TDC) from the TIMELY paper. This unit will convert
+    a pulse width modulated (PWM) signal into a digital value.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    resolution: int
+        Resolution of the TDC in bits.
+    """
+
+    component_name = "timely_tdc"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, resolution: int = 8):
+        super().__init__(leak_power=0.0, area=310.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.resolution: int = self.scale(
+            "resolution", resolution, 8, pow_base(2), pow_base(2), pow_base(2)
+        )
+
+    @actionDynamicEnergy
+    def convert(self) -> float:
+        """
+        Returns the energy used to convert a PWM signal into a digital value in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a PWM signal into a digital value in Joules.
+        """
+        return 0.145e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to convert a PWM signal into a digital value in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to convert a PWM signal into a digital value in Joules.
+        """
+        return 0.145e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,rows,energy,area,action
+# 65nm,1e-9,1,0.00062,5,read|drive|buffer
+# 65nm,1e-9,1,0,5,leak|write|update
+# # Numbers from paper table II
+class TimelyXSubBuf(LibraryEstimatorClassBase):
+    """
+    The XSubBuf from the TIMELY paper. This unit will repeat & amplify an input current
+    value.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    rows: int
+        Number of rows of the CiM array that are applying current to the XSubBuf. Power
+        will increase with more rows.
+    """
+
+    component_name = "timely_xsubBuf"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, rows: int = 1):
+        super().__init__(leak_power=0.0, area=5.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.rows: int = self.scale("rows", rows, 1, linear, noscale, noscale)
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to repeat & amplify an input current in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to repeat & amplify an input current in Joules.
+        """
+        return 0.00062e-12
+
+    @actionDynamicEnergy
+    def drive(self) -> float:
+        """
+        Returns the energy used to repeat & amplify an input current in Joules.
+
+        Returns
+        -------
+        float
+            The energy used to repeat & amplify an input current in Joules.
+        """
+        return 0.00062e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,energy,area,action
+# 65nm,1e-9,0.0417,40,compare|read
+# 65nm,1e-9,0,40,write|update|leak
+# # Numbers from paper table II
+class TimelyChargingComparator(LibraryEstimatorClassBase):
+    """
+    The charging comparator from the TIMELY paper. This unit will accumulate charge on a
+    capacitor and trigger a singal once it exceed a reference charge.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    """
+
+    component_name = "timely_charging_comparator"
+    priority = 0.9
+
+    def __init__(self, tech_node: float):
+        super().__init__(leak_power=0.0, area=40.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+
+    @actionDynamicEnergy
+    def compare(self) -> float:
+        """
+        Returns the energy used to compare an input to the reference.
+
+        Returns
+        -------
+        float
+            The energy used to compare an input current to the reference.
+        """
+        return 0.0417e-12
+
+    @actionDynamicEnergy
+    def read(self) -> float:
+        """
+        Returns the energy used to compare an input to the reference.
+
+        Returns
+        -------
+        float
+            The energy used to compare an input current to the reference.
+        """
+        return 0.0417e-12
+
+
+# Original CSV contents:
+# tech_node,global_cycle_period,width|datawidth,depth,energy,area,action
+# 65nm,1e-9,128,128,203.776,40,read
+# 65nm,1e-9,128,128,496.624,40,write|update
+# 65nm,1e-9,128,128,0,40,leak
+class TimelyInputOutputBuffer(LibraryEstimatorClassBase):
+    """
+    The input/output buffers from the TIMELY paper. These digital buffers store inputs and outputs to the CiM arrays.
+
+    Parameters
+    ----------
+    tech_node: float
+        Technology node in meters.
+    width : int, optional
+        The width of the read/write port of the buffer in bits. Total size = width * depth.
+    depth: int
+        The number of entries in the buffer, each with `width` bits. Total size = width
+        * depth.
+    """
+
+    component_name = "timely_input_output_buffer"
+    priority = 0.9
+
+    def __init__(self, tech_node: float, width: int = 128, depth: int = 128):
+        super().__init__(leak_power=0.0, area=40.0e-12)
+        self.tech_node: float = self.scale(
+            "tech_node",
+            tech_node,
+            65e-9,
+            tech_node_energy,
+            tech_node_area,
+            tech_node_leak,
+        )
+        self.width: int = self.scale("width", width, 128, linear, linear, linear)
+        self.depth: int = self.scale(
+            "depth", depth, 128, linear, cacti_depth_energy, cacti_depth_energy
+        )
+
+    @actionDynamicEnergy(bits_per_action="width")
+    def read(self) -> float:
+        """
+        Returns the energy used to read from the buffer in Joules.
+
+        Parameters
+        ----------
+        bits_per_action: int
+            The number of bits to read.
+
+        Returns
+        -------
+        float
+            The energy used to read from the buffer in Joules.
+        """
+        return 203.776e-12
+
+    @actionDynamicEnergy(bits_per_action="width")
+    def write(self) -> float:
+        """
+        Returns the energy used to write to the buffer in Joules.
+
+        Parameters
+        ----------
+        bits_per_action: int
+            The number of bits to write.
+
+        Returns
+        -------
+        float
+            The energy used to write to the buffer in Joules.
+        """
+        return 496.624e-12
+
+
+class TimelyChip2ChipLink(IsaacChip2ChipLink):
+    pass