Merge pull request #34 from mithro/liberty
Adding liberty file generation
diff --git a/.gitignore b/.gitignore
index a81c8ee..902f9e6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -136,3 +136,6 @@
# Cython debug symbols
cython_debug/
+
+
+**/timing/*.lib
diff --git a/Makefile b/Makefile
index 4f37195..0ad4828 100644
--- a/Makefile
+++ b/Makefile
@@ -59,4 +59,25 @@
all: README.rst
@true
+
+LIBRARIES = $(sort $(notdir $(wildcard libraries/sky130_*_sc_*)))
+
+$(LIBRARIES): | $(CONDA_ENV_PYTHON)
+ @$(IN_CONDA_ENV) for V in libraries/$@/*; do \
+ python -m skywater_pdk.liberty $$V; \
+ python -m skywater_pdk.liberty $$V all; \
+ python -m skywater_pdk.liberty $$V all --ccsnoise; \
+ done
+
+sky130_fd_sc_ms-leakage: | $(CONDA_ENV_PYTHON)
+ @$(IN_CONDA_ENV) for V in libraries/sky130_fd_sc_ms/*; do \
+ python -m skywater_pdk.liberty $$V all --leakage; \
+ done
+
+sky130_fd_sc_ms: sky130_fd_sc_ms-leakage
+
+timing: $(LIBRARIES) | $(CONDA_ENV_PYTHON)
+ @true
+
+
.PHONY: all
diff --git a/scripts/python-skywater-pdk/docs/skywater_pdk.rst b/scripts/python-skywater-pdk/docs/skywater_pdk.rst
index 8488d1e..0e832dd 100644
--- a/scripts/python-skywater-pdk/docs/skywater_pdk.rst
+++ b/scripts/python-skywater-pdk/docs/skywater_pdk.rst
@@ -12,6 +12,14 @@
:undoc-members:
:show-inheritance:
+skywater\_pdk.corners module
+----------------------------
+
+.. automodule:: skywater_pdk.corners
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
skywater\_pdk.sizes module
---------------------------
diff --git a/scripts/python-skywater-pdk/skywater_pdk/corners.py b/scripts/python-skywater-pdk/skywater_pdk/corners.py
new file mode 100644
index 0000000..6e212a1
--- /dev/null
+++ b/scripts/python-skywater-pdk/skywater_pdk/corners.py
@@ -0,0 +1,292 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 SkyWater PDK Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import re
+import os
+
+from enum import Flag
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+from typing import Tuple, Optional
+
+from . import base
+from .utils import OrderedFlag
+from .utils import comparable_to_none
+from .utils import dataclass_json_passthru_sequence_config as dj_pass_cfg
+
+
+CornerTypeMappings = {}
+# "wo" is "worst-case one" and corresponds to "fs"
+CornerTypeMappings["wo"] = "fs"
+# "wz" is "worst-case zero" and corresponds to "sf"
+CornerTypeMappings["wz"] = "sf"
+# "wp" is "worst-case power" and corresponds to "ff"
+CornerTypeMappings["wp"] = "ff"
+# "ws" is "worst-case speed" and corresponds to "ss"
+CornerTypeMappings["ws"] = "ss"
+
+CornerTypeValues = [
+ 'ff',
+ 'ss',
+ 'tt',
+ 'fs',
+ 'sf',
+]
+CORNER_TYPE_REGEX = re.compile('[tfs][tfs]')
+
+
+class CornerType(OrderedFlag):
+ """
+
+ See Also
+ --------
+ skywater_pdk.corners.Corner
+ skywater_pdk.corners.CornerFlag
+
+ Examples
+ --------
+
+ >>> CornerType.parse('t')
+ CornerType.t
+ >>> CornerType.parse('tt')
+ [CornerType.t, CornerType.t]
+ >>> CornerType.parse('wp')
+ [CornerType.f, CornerType.f]
+ """
+ t = 'Typical' # all nominal (typical) values
+ f = 'Fast' # fast, that is, values that make transistors run faster
+ s = 'Slow' # slow
+
+ @classmethod
+ def parse(cls, s):
+ if s in CornerTypeMappings:
+ return cls.parse(CornerTypeMappings[s])
+ if len(s) > 1:
+ try:
+ o = []
+ for c in s:
+ o.append(cls.parse(c))
+ return o
+ except TypeError:
+ raise TypeError("Unknown corner type: {}".format(s))
+ if not hasattr(cls, s):
+ raise TypeError("Unknown corner type: {}".format(s))
+ return getattr(cls, s)
+
+ def __repr__(self):
+ return 'CornerType.'+self.name
+
+ def __str__(self):
+ return self.value
+
+ def to_json(self):
+ return self.name
+
+
+class CornerFlag(OrderedFlag):
+ """
+
+ See Also
+ --------
+ skywater_pdk.corners.Corner
+ skywater_pdk.corners.CornerType
+ """
+
+ nointpr = 'No internal power'
+ lv = 'Low voltage'
+ hv = 'High voltage'
+ lowhv = 'Low High Voltage'
+ ccsnoise = 'Composite Current Source Noise'
+ pwr = 'Power'
+ xx = 'xx'
+ w = 'w'
+
+ @classmethod
+ def parse(cls, s):
+ if hasattr(cls, s):
+ return getattr(cls, s)
+ else:
+ raise TypeError("Unknown CornerFlags: {}".format(s))
+
+ def __repr__(self):
+ return 'CornerFlag.'+self.name
+
+ def __str__(self):
+ return self.value
+
+ def to_json(self):
+ return self.name
+
+
+@comparable_to_none
+class OptionalTuple(tuple):
+ pass
+
+
+@comparable_to_none
+@dataclass_json
+@dataclass(frozen=True, order=True)
+class Corner:
+ """
+
+ See Also
+ --------
+ skywater_pdk.corners.parse_filename
+ skywater_pdk.base.Cell
+ skywater_pdk.corners.CornerType
+ skywater_pdk.corners.CornerFlag
+
+ """
+ corner: Tuple[CornerType, CornerType] = dj_pass_cfg()
+ volts: Tuple[float, ...] = dj_pass_cfg()
+ temps: Tuple[int, ...] = dj_pass_cfg()
+ flags: Optional[Tuple[CornerFlag, ...]] = dj_pass_cfg(default=None)
+
+ def __post_init__(self):
+ if self.flags:
+ object.__setattr__(self, 'flags', OptionalTuple(self.flags))
+
+
+VOLTS_REGEX = re.compile('([0-9]p[0-9]+)V')
+TEMP_REGEX = re.compile('(n?)([0-9][0-9]+)C')
+def parse_filename(pathname):
+ """Extract corner information from a filename.
+
+ See Also
+ --------
+ skywater_pdk.base.parse_pathname
+ skywater_pdk.base.parse_filehname
+
+ Examples
+ --------
+
+ >>> parse_filename('tt_1p80V_3p30V_3p30V_25C')
+ (Corner(corner=(CornerType.t, CornerType.t), volts=(1.8, 3.3, 3.3), temps=(25,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_io__top_ground_padonlyv2__tt_1p80V_3p30V_3p30V_25C.wrap.lib')
+ (Corner(corner=(CornerType.t, CornerType.t), volts=(1.8, 3.3, 3.3), temps=(25,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__tt_1p80V_100C.wrap.json')
+ (Corner(corner=(CornerType.t, CornerType.t), volts=(1.8,), temps=(100,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__tt_1p80V_100C.wrap.lib')
+ (Corner(corner=(CornerType.t, CornerType.t), volts=(1.8,), temps=(100,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__tt_1p80V_25C_ccsnoise.wrap.json')
+ (Corner(corner=(CornerType.t, CornerType.t), volts=(1.8,), temps=(25,), flags=(CornerFlag.ccsnoise,)), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__wp_1p65V_n40C.wrap.json')
+ (Corner(corner=(CornerType.f, CornerType.f), volts=(1.65,), temps=(-40,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__wp_1p95V_85C_pwr.wrap.lib')
+ (Corner(corner=(CornerType.f, CornerType.f), volts=(1.95,), temps=(85,), flags=(CornerFlag.pwr,)), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__wp_1p95V_n40C_ccsnoise.wrap.json')
+ (Corner(corner=(CornerType.f, CornerType.f), volts=(1.95,), temps=(-40,), flags=(CornerFlag.ccsnoise,)), [])
+
+ >>> parse_filename('sky130_fd_sc_ms__wp_1p95V_n40C_pwr.wrap.lib')
+ (Corner(corner=(CornerType.f, CornerType.f), volts=(1.95,), temps=(-40,), flags=(CornerFlag.pwr,)), [])
+
+ >>> parse_filename('sky130_fd_sc_hd__a2111o_4__ss_1p76V_n40C.cell.json')
+ (Corner(corner=(CornerType.s, CornerType.s), volts=(1.76,), temps=(-40,), flags=None), [])
+
+ >>> parse_filename('sky130_fd_sc_ls__lpflow_lsbuf_lh_1__lpflow_wc_lh_level_shifters_ss_1p95V_n40C.cell.json')
+ (Corner(corner=(CornerType.s, CornerType.s), volts=(1.95,), temps=(-40,), flags=None), ['wc', 'lh', 'level', 'shifters'])
+
+ >>> parse_filename('sky130_fd_sc_hvl__lsbufhv2hv_hl_1__ff_5p50V_lowhv_1p65V_lv_ss_1p60V_100C.cell.json')
+ (Corner(corner=(CornerType.f, CornerType.s), volts=(5.5, 1.65, 1.6), temps=(100,), flags=(CornerFlag.lowhv, CornerFlag.lv)), [])
+
+ """
+ if base.SEPERATOR in pathname:
+ cell, extra, extension = base.parse_filename(pathname)
+ else:
+ cell = None
+ extra = pathname
+ extension = ''
+
+ if extension not in ('', 'lib', 'cell.lib', 'cell.json', 'wrap.lib', 'wrap.json'):
+ raise ValueError('Not possible to extract corners from: {!r}'.format(extension))
+
+ if not extra:
+ extra = cell.name
+ cell = None
+
+ # FIXME: Hack?
+ extra = extra.replace("lpflow_","")
+ extra = extra.replace("udb_","")
+
+ kw = {}
+ kw['flags'] = []
+ kw['volts'] = []
+ kw['temps'] = []
+
+ bits = extra.split("_")
+ random = []
+ while len(bits) > 0:
+ b = bits.pop(0)
+ try:
+ kw['corner'] = CornerType.parse(b)
+ break
+ except TypeError as e:
+ random.append(b)
+
+ while len(bits) > 0:
+ b = bits.pop(0)
+
+ if VOLTS_REGEX.match(b):
+ assert b.endswith('V'), b
+ kw['volts'].append(float(b[:-1].replace('p', '.')))
+ elif TEMP_REGEX.match(b):
+ assert b.endswith('C'), b
+ kw['temps'].append(int(b[:-1].replace('n', '-')))
+ elif CORNER_TYPE_REGEX.match(b):
+ # FIXME: These are horrible hacks that should be removed.
+ assert len(b) == 2, b
+ assert b[0] == b[1], b
+ assert 'corner' in kw, kw['corners']
+ assert len(kw['corner']) == 2, kw['corners']
+ assert kw['corner'][0] == kw['corner'][1], kw['corners']
+ other_corner = CornerType.parse(b)
+ assert len(other_corner) == 2, other_corner
+ assert other_corner[0] == other_corner[1], other_corner
+ kw['corner'][1] = other_corner[0]
+ else:
+ kw['flags'].append(CornerFlag.parse(b))
+
+ for k, v in kw.items():
+ kw[k] = tuple(v)
+
+ if not kw['flags']:
+ del kw['flags']
+
+ if 'corner' not in kw:
+ raise TypeError('Invalid corner value: '+extra)
+
+ return Corner(**kw), random
+
+
+
+# 1p60V 5p50V n40C
+
+
+
+
+if __name__ == "__main__":
+ import doctest
+ doctest.testmod()
diff --git a/scripts/python-skywater-pdk/skywater_pdk/liberty.py b/scripts/python-skywater-pdk/skywater_pdk/liberty.py
new file mode 100755
index 0000000..89f561b
--- /dev/null
+++ b/scripts/python-skywater-pdk/skywater_pdk/liberty.py
@@ -0,0 +1,894 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 SkyWater PDK Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+import argparse
+import enum
+import json
+import os
+import pathlib
+import pprint
+import re
+import sys
+
+from collections import defaultdict
+
+from typing import Tuple, List, Dict
+
+from . import sizes
+from .utils import sortable_extracted_numbers
+
+
+debug = False
+
+
+class TimingType(enum.IntFlag):
+ """
+
+ >>> TimingType.parse("ff_100C_1v65")
+ ('ff_100C_1v65', <TimingType.basic: 1>)
+
+ >>> TimingType.parse("ff_100C_1v65_ccsnoise")
+ ('ff_100C_1v65', <TimingType.ccsnoise: 3>)
+
+ >>> TimingType.basic in TimingType.ccsnoise
+ True
+
+ >>> TimingType.parse("ff_100C_1v65_pwrlkg")
+ ('ff_100C_1v65', <TimingType.leakage: 4>)
+
+ >>> (TimingType.basic).describe()
+ ''
+ >>> (TimingType.ccsnoise).describe()
+ '(with ccsnoise)'
+ >>> (TimingType.leakage).describe()
+ '(with power leakage)'
+ >>> (TimingType.leakage | TimingType.ccsnoise).describe()
+ '(with ccsnoise and power leakage)'
+
+ >>> (TimingType.leakage | TimingType.ccsnoise).names()
+ 'basic, ccsnoise, leakage'
+
+ >>> TimingType.ccsnoise.names()
+ 'basic, ccsnoise'
+ """
+
+ basic = 1
+
+ # ccsnoise files are basic files with extra 'ccsn_' values in the timing
+ # data.
+ ccsnoise = 2 | basic
+
+ # leakage files are separate from the basic files
+ leakage = 4
+
+ def names(self):
+ o = []
+ for t in TimingType:
+ if t in self:
+ o.append(t.name)
+ return ", ".join(o)
+
+ def describe(self):
+ o = []
+ if TimingType.ccsnoise in self:
+ o.append("ccsnoise")
+ if TimingType.leakage in self:
+ o.append("power leakage")
+ if not o:
+ return ""
+ return "(with "+" and ".join(o)+")"
+
+ @property
+ def file(self):
+ if self == TimingType.ccsnoise:
+ return "_ccsnoise"
+ elif self == TimingType.leakage:
+ return "_pwrlkg"
+ return ""
+
+ @classmethod
+ def parse(cls, name):
+ ttype = TimingType.basic
+ if name.endswith("_ccsnoise"):
+ name = name[:-len("_ccsnoise")]
+ ttype = TimingType.ccsnoise
+ elif name.endswith("_pwrlkg"):
+ name = name[:-len("_pwrlkg")]
+ ttype = TimingType.leakage
+ return name, ttype
+
+ @property
+ def singular(self):
+ return len(self.types) == 1
+
+ @property
+ def types(self):
+ tt = set(t for t in TimingType if t in self)
+ if TimingType.ccsnoise in tt:
+ tt.remove(TimingType.basic)
+ return list(tt)
+
+
+
+def cell_corner_file(lib, cell_with_size, corner, corner_type: TimingType):
+ """
+
+ >>> cell_corner_file("sky130_fd_sc_hd", "a2111o", "ff_100C_1v65", TimingType.basic)
+ 'cells/a2111o/sky130_fd_sc_hd__a2111o__ff_100C_1v65.lib.json'
+ >>> cell_corner_file("sky130_fd_sc_hd", "a2111o_1", "ff_100C_1v65", TimingType.basic)
+ 'cells/a2111o/sky130_fd_sc_hd__a2111o_1__ff_100C_1v65.lib.json'
+ >>> cell_corner_file("sky130_fd_sc_hd", "a2111o_1", "ff_100C_1v65", TimingType.ccsnoise)
+ 'cells/a2111o/sky130_fd_sc_hd__a2111o_1__ff_100C_1v65_ccsnoise.lib.json'
+
+ """
+ assert corner_type.singular, (lib, cell_with_size, corner, corner_type, corner_type.types())
+
+ sz = sizes.parse_size(cell_with_size)
+ if sz:
+ cell = cell_with_size[:-len(sz.suffix)]
+ else:
+ cell = cell_with_size
+
+ fname = "cells/{cell}/{lib}__{cell_sz}__{corner}{corner_type}.lib.json".format(
+ lib=lib, cell=cell, cell_sz=cell_with_size, corner=corner, corner_type=corner_type.file)
+ return fname
+
+
+def top_corner_file(libname, corner, corner_type: TimingType):
+ """
+
+ >>> top_corner_file("sky130_fd_sc_hd", "ff_100C_1v65", TimingType.ccsnoise)
+ 'timing/sky130_fd_sc_hd__ff_100C_1v65_ccsnoise.lib.json'
+ >>> top_corner_file("sky130_fd_sc_hd", "ff_100C_1v65", TimingType.basic)
+ 'timing/sky130_fd_sc_hd__ff_100C_1v65.lib.json'
+
+ """
+ assert corner_type.singular, (libname, corner, corner_type, corner_type.types())
+ return "timing/{libname}__{corner}{corner_type}.lib.json".format(
+ libname=libname,
+ corner=corner, corner_type=corner_type.file)
+
+
+def collect(library_dir) -> Tuple[Dict[str, TimingType], List[str]]:
+ """Collect the available timing information in corners.
+
+ Parameters
+ ----------
+ library_dir: str
+ Path to a library.
+
+ Returns
+ -------
+ lib : str
+ Library name
+
+ corners : {str: TimingType}
+ corners in the library.
+
+ cells : list of str
+ cells in the library.
+ """
+
+ if not isinstance(library_dir, pathlib.Path):
+ library_dir = pathlib.Path(library_dir)
+
+ libname0 = None
+
+ corners = {}
+ all_cells = set()
+ for p in library_dir.rglob("*.lib.json"):
+ if not p.is_file():
+ continue
+ if "timing" in str(p):
+ continue
+
+ fname, fext = str(p.name).split('.', 1)
+
+ libname, cellname, corner = fname.split("__")
+ if libname0 is None:
+ libname0 = libname
+ assert libname0 == libname, (libname0, libname)
+
+ corner_name, corner_type = TimingType.parse(corner)
+
+ if corner_name not in corners:
+ corners[corner_name] = [corner_type, set()]
+
+ corners[corner_name][0] |= corner_type
+ corners[corner_name][1].add(cellname)
+ all_cells.add(cellname)
+
+ for c in corners:
+ corners[c] = (corners[c][0], list(sorted(corners[c][1])))
+
+ assert corners, library_dir
+ assert all_cells, library_dir
+ assert libname0, library_dir
+
+ all_cells = list(sorted(all_cells))
+
+ # Sanity check to make sure the corner exists for all cells.
+ for corner, (corner_types, corner_cells) in sorted(corners.items()):
+ missing = set()
+ for cell_with_size in all_cells:
+ if cell_with_size not in corner_cells:
+ missing.add(cell_with_size)
+
+ if not missing:
+ continue
+
+ print("Missing", ", ".join(missing), "from", corner, corner_types)
+
+ return libname0, corners, all_cells
+
+ for corner, (corner_types, corner_cells) in sorted(corners.items()):
+ for corner_type in corner_types.types:
+ fname = cell_corner_file(libname0, cell_with_size, corner, corner_type)
+ fpath = os.path.join(library_dir, fname)
+ if not os.path.exists(fpath) and debug:
+ print("Missing", (fpath, corner, corner_type, corner_types))
+
+ timing_dir = os.path.join(library_dir, "timing")
+ assert os.path.exists(timing_dir), timing_dir
+ for corner, (corner_types, corner_cells) in sorted(corners.items()):
+ for corner_type in corner_types.types:
+ fname = top_corner_file(libname0, corner, corner_type)
+ fpath = os.path.join(library_dir, fname)
+ if not os.path.exists(fpath) and debug:
+ print("Missing", (fpath, corner, corner_type, corner_types))
+
+ return libname0, corners, all_cells
+
+
+def remove_ccsnoise(data):
+ for k, v in list(data.items()):
+ if "ccsn_" in k:
+ del data[k]
+ continue
+
+ if not k.startswith("pin "):
+ continue
+
+ pin_data = data[k]
+
+ if "input_voltage" in pin_data:
+ del pin_data["input_voltage"]
+
+ if "timing" not in pin_data:
+ continue
+ pin_timing = pin_data["timing"]
+
+ for t in pin_timing:
+ ccsn_keys = set()
+ for k in t:
+ if not k.startswith("ccsn_"):
+ continue
+ ccsn_keys.add(k)
+
+ for k in ccsn_keys:
+ del t[k]
+
+
+def generate(library_dir, lib, corner, ocorner_type, icorner_type, cells):
+ top_fname = top_corner_file(lib, corner, ocorner_type).replace('.lib.json', '.lib')
+ top_fpath = os.path.join(library_dir, top_fname)
+
+ top_fout = open(top_fpath, "w")
+ def top_write(lines):
+ print("\n".join(lines), file=top_fout)
+
+ otype_str = "({} from {})".format(ocorner_type.name, icorner_type.names())
+ print("Starting to write", top_fpath, otype_str, flush=True)
+
+ common_data = {}
+
+ common_data_path = os.path.join(library_dir, "timing", "{}__common.lib.json".format(lib))
+ assert os.path.exists(common_data_path), common_data_path
+ with open(common_data_path) as f:
+ d = json.load(f)
+ assert isinstance(d, dict)
+ for k, v in d.items():
+ assert k not in common_data, (k, common_data[k])
+ common_data[k] = v
+
+ top_data_path = os.path.join(library_dir, top_corner_file(lib, corner, icorner_type))
+ assert os.path.exists(top_data_path), top_data_path
+ with open(top_data_path) as f:
+ d = json.load(f)
+ assert isinstance(d, dict)
+ for k, v in d.items():
+ if k in common_data:
+ print("Overwriting", k, "with", v, "(existing value of", common_data[k], ")")
+ common_data[k] = v
+
+ # Remove the ccsnoise if it exists
+ if ocorner_type != TimingType.ccsnoise:
+ remove_ccsnoise(common_data)
+
+ output = liberty_dict("library", lib+"__"+corner, common_data)
+ assert output[-1] == '}', output
+ top_write(output[:-1])
+
+ for cell_with_size in cells:
+ fname = cell_corner_file(lib, cell_with_size, corner, icorner_type)
+ fpath = os.path.join(library_dir, fname)
+ assert os.path.exists(fpath), fpath
+
+ with open(fpath) as f:
+ cell_data = json.load(f)
+
+ # Remove the ccsnoise if it exists
+ if ocorner_type != TimingType.ccsnoise:
+ remove_ccsnoise(cell_data)
+
+ top_write([''])
+ top_write(liberty_dict("cell", "%s__%s" % (lib, cell_with_size), cell_data, [cell_with_size]))
+
+ top_write([''])
+ top_write(['}'])
+ top_fout.close()
+ print(" Finish writing", top_fpath, flush=True)
+ print("")
+
+
+# * The 'delay_model' should be the 1st attribute in the library
+# * The 'technology' should be the 1st attribute in the library
+
+LIBERTY_ATTRIBUTE_ORDER = re.sub('/\\*[^*]*\\*/', '', """
+library (name_string) {
+ /* Library-Level Simple and Complex Attributes */
+ define (...,...,...) ;
+ technology (name_enum) ;
+ delay_model : "model" ;
+
+ bus_naming_style : "string" ;
+ date : "date" ;
+ comment : "string" ;
+
+ /* Unit definitions */
+ time_unit : "unit" ;
+ voltage_unit : "unit" ;
+ leakage_power_unit : "unit" ;
+ current_unit : "unit" ;
+ pulling_resistance_unit : "unit" ;
+ ..._unit : "unit" ;
+ /* FIXME: Should capacitive_load_unit always be last? */
+ capacitive_load_unit (value, unit) ;
+
+ /* FIXME: Why is define_cell_area here, while other defines are up above? */
+ define_cell_area (area_name, resource_type) ;
+
+ revision : float | string ;
+
+ /* Default Attributes and Values */
+ default_cell_leakage_power : float ;
+ default_fanout_load : float ;
+ default_inout_pin_cap : float ;
+ default_input_pin_cap : float ;
+ default_max_transition : float ;
+ default_output_pin_cap : float ;
+ default_... : ... ;
+
+ /* Scaling Factors Attributes and Values */
+ k_process_cell_fall ... ;
+ k_process_cell_rise ... ;
+ k_process_fall_propagation ... ;
+ k_process_fall_transition ... ;
+ k_process_rise_propagation ... ;
+ k_process_rise_transition ... ;
+ k_temp_cell_fall ... ;
+ k_temp_cell_rise ... ;
+ k_temp_fall_propagation ... ;
+ k_temp_fall_transition ... ;
+ k_temp_rise_propagation ... ;
+ k_temp_rise_transition ... ;
+ k_volt_cell_fall ... ;
+ k_volt_cell_rise ... ;
+ k_volt_fall_propagation ... ;
+ k_volt_fall_transition ... ;
+ k_volt_rise_propagation ... ;
+ k_volt_rise_transition ... ;
+ k_... : ... ;
+
+ /* Library-Level Group Statements */
+ operating_conditions (name_string) {
+ ... operating conditions description ...
+ }
+ wire_load (name_string) {
+ ... wire load description ...
+ }
+ wire_load_selection (name_string) {
+ ... wire load selection criteria...
+ }
+ power_lut_template (namestring) {
+ ... power lookup table template information...
+ }
+ lu_table_template (name_string) {
+ variable_1 : value_enum ;
+ variable_2 : value_enum ;
+ variable_3 : value_enum ;
+ index_1 ("float, ..., float");
+ index_2 ("float, ..., float");
+ index_3 ("float, ..., float");
+ }
+ normalized_driver_waveform (waveform_template_name) {
+ driver_waveform_name : string; /* Specifies the name of the driver waveform table */
+ index_1 ("float, ... float"); /* Specifies input net transition */
+ index_2 ("float, ... float"); /* Specifies normalized voltage */
+ values ("float, ... float", \ /* Specifies the time in library units */
+ ... , \\
+ "float, ... float");
+ }
+
+ /* Cell definitions */
+ cell (namestring2) {
+ ... cell description ...
+ }
+
+ ...
+
+ /* FIXME: What are these and why are they last */
+ type (namestring) {
+ ... type description ...
+ }
+ input_voltage (name_string) {
+ ... input voltage information ...
+ }
+ output_voltage (name_string) {
+ ... output voltage information ...
+ }
+}
+""")
+
+
+RE_LIBERTY_LIST = re.compile("(.*)_([0-9]+)")
+RE_NUMBERS = re.compile('([0-9]+)')
+
+
+def _lookup_attribute_pos(name):
+ # Pad with spaces so you don't get substring matches.
+ name = ' ' + name
+ if name.endswith('_'):
+ name = name + ' '
+ i = LIBERTY_ATTRIBUTE_ORDER.find(name)
+ if i != -1:
+ return float(i)
+ return None
+
+
+def liberty_attribute_order(attr_name):
+ """
+
+ FIXME: Make these doctests less fragile...
+ >>> liberty_attribute_order("define")
+ (33.0, 0.0)
+
+ >>> liberty_attribute_order('voltage_map')
+ (inf, inf)
+
+ >>> liberty_attribute_order('slew_lower_threshold_pct_fall')
+ (inf, inf)
+
+ >>> liberty_attribute_order('time_unit')
+ (203.0, 0.0)
+ >>> liberty_attribute_order('random_unit')
+ (357.0, 0.0)
+ >>> liberty_attribute_order('capacitive_load_unit')
+ (386.0, 0.0)
+
+ >>> liberty_attribute_order('technology')
+ (60.0, 0.0)
+ >>> liberty_attribute_order('technology("cmos")')
+ (60.0, 0.0)
+
+ >>> liberty_attribute_order('delay_model')
+ (89.0, 0.0)
+
+ >>> liberty_attribute_order("cell")
+ (2282.0, 0.0)
+
+ >>> v1, v2 = "variable_1", "variable_2"
+ >>> i1, i2, i3, i4 = "index_1", "index_2", "index_3", "index_4"
+ >>> print('\\n'.join(sorted([v2, i1, v1, i2, i3, i4], key=liberty_attribute_order)))
+ variable_1
+ variable_2
+ index_1
+ index_2
+ index_3
+ index_4
+
+ >>> liberty_attribute_order("values")
+ (2182.0, 0.0)
+
+ >>> print('\\n'.join(sorted([
+ ... 'default_inout_pin_cap',
+ ... 'k_XXXX',
+ ... 'k_temp_cell_fall',
+ ... 'default_XXXX',
+ ... ], key=liberty_attribute_order)))
+ default_inout_pin_cap
+ default_XXXX
+ k_temp_cell_fall
+ k_XXXX
+
+
+ """
+ assert ':' not in attr_name, attr_name
+
+ m = RE_LIBERTY_LIST.match(attr_name)
+ if m:
+ k, n = m.group(1), m.group(2)
+
+ i = _lookup_attribute_pos(k)
+ if not i:
+ i = float('inf')
+
+ return float(i), float(n)
+
+ lookup_name = attr_name
+ i = _lookup_attribute_pos(lookup_name)
+ if i:
+ return i, 0.0
+
+ if '(' in lookup_name:
+ lookup_name = lookup_name[:lookup_name.index('(')]
+
+ if 'default_' in attr_name:
+ lookup_name = 'default_...'
+ if '_unit' in attr_name:
+ lookup_name = '..._unit'
+ if 'k_' in attr_name:
+ lookup_name = 'k_...'
+
+ i = _lookup_attribute_pos(lookup_name)
+ if i:
+ return i, 0.0
+
+ return float('inf'), float('inf')
+
+
+def is_liberty_list(k):
+ """
+
+ >>> is_liberty_list("variable_1")
+ True
+ >>> is_liberty_list("index_3")
+ True
+ >>> is_liberty_list("values")
+ True
+ """
+ m = RE_LIBERTY_LIST.match(k)
+ if m:
+ k, n = m.group(1), m.group(2)
+
+ return k in ('variable', 'index', 'values')
+
+
+def liberty_float(f):
+ """
+
+ >>> liberty_float(1.9208818e-02)
+ '0.0192088180'
+
+ >>> liberty_float(1.5)
+ '1.5000000000'
+
+ >>> liberty_float(1e20)
+ '1.000000e+20'
+
+ >>> liberty_float(1)
+ '1.0000000000'
+
+ """
+ WIDTH = len(str(0.0083333333))
+
+ s = json.dumps(f)
+ if 'e' in s:
+ a, b = s.split('e')
+ if '.' not in a:
+ a += '.'
+ while len(a)+len(b)+1 < WIDTH:
+ a += '0'
+ s = "%se%s" % (a, b)
+ elif '.' in s:
+ while len(s) < WIDTH:
+ s += '0'
+ else:
+ if len(s) < WIDTH:
+ s += '.'
+ while len(s) < WIDTH:
+ s += '0'
+ return s
+
+
+INDENT=" "
+
+
+def liberty_composite(k, v, i=tuple()):
+ """
+
+ >>> def pl(l):
+ ... print("\\n".join(l))
+
+ >>> pl(liberty_composite("capacitive_load_unit", [1.0, "pf"], []))
+ capacitive_load_unit(1.0000000000, "pf");
+
+ >>> pl(liberty_composite("voltage_map", [("vpwr", 1.95), ("vss", 0.0)], []))
+ voltage_map("vpwr", 1.9500000000);
+ voltage_map("vss", 0.0000000000);
+
+ >>> pl(liberty_composite("library_features", 'report_delay_calculation', []))
+ library_features("report_delay_calculation");
+
+ """
+ if isinstance(v, tuple):
+ v = list(v)
+ if not isinstance(v, list):
+ v = [v]
+ #assert isinstance(v, list), (k, v)
+
+ if isinstance(v[0], (list, tuple)):
+ o = []
+ for j, l in enumerate(v):
+ o.extend(liberty_composite(k, l, i))
+ return o
+
+ o = []
+ for l in v:
+ if isinstance(l, (float, int)):
+ o.append(liberty_float(l))
+ elif isinstance(l, str):
+ assert '"' not in l, (k, v)
+ o.append('"%s"' % l)
+ else:
+ raise ValueError("%s - %r (%r)" % (k, l, v))
+
+ return ["%s%s(%s);" % (INDENT*len(i), k, ", ".join(o))]
+
+
+def liberty_join(l):
+ """
+
+ >>> l = [5, 1.0, 10]
+ >>> liberty_join(l)(l)
+ '5.0000000000, 1.0000000000, 10.000000000'
+
+ >>> l = [1, 5, 8]
+ >>> liberty_join(l)(l)
+ '1, 5, 8'
+
+ """
+ d = defaultdict(lambda: 0)
+
+ for i in l:
+ d[type(i)] += 1
+
+ def types(l):
+ return [(i, type(i)) for i in l]
+
+ if d[float] > 0:
+ assert (d[float]+d[int]) == len(l), (d, types(l))
+ def join(l):
+ return ", ".join(liberty_float(f) for f in l)
+ return join
+
+ elif d[int] > 0:
+ assert d[int] == len(l), (d, types(l))
+ def join(l):
+ return ", ".join(str(f) for f in l)
+ return join
+
+ raise ValueError("Invalid value: %r" % types(l))
+
+
+def liberty_list(k, v, i=tuple()):
+ o = []
+ if isinstance(v[0], list):
+ o.append('%s%s(' % (INDENT*len(i), k))
+ join = liberty_join(v[0])
+ for l in v:
+ o.append('%s"%s", \\' % (INDENT*(len(i)+1), join(l)))
+
+ o[1] = o[0]+o[1]
+ o.pop(0)
+
+ o[-1] = o[-1][:-3] + ');'
+ else:
+ join = liberty_join(v)
+ o.append('%s%s("%s");' % (INDENT*len(i), k, join(v)))
+
+ return o
+
+
+def liberty_dict(dtype, dvalue, data, indent=tuple()):
+ assert isinstance(data, dict), (dtype, dvalue, data)
+ o = []
+
+ if dvalue:
+ dbits = dvalue.split(",")
+ for j, d in enumerate(dbits):
+ if '"' in d:
+ assert d.startswith('"'), (dvalue, dbits, indent)
+ assert d.endswith('"'), (dvalue, dbits, indent)
+ dbits[j] = d[1:-1]
+ dvalue = ','.join('"%s"' % d.strip() for d in dbits)
+ o.append('%s%s (%s) {' % (INDENT*len(indent), dtype, dvalue))
+
+ # Sort the attributes
+ def attr_sort_key(item):
+ k, v = item
+ if " " in k:
+ ktype, kvalue = k.split(" ", 1)
+ sortable_kv = sortable_extracted_numbers(kvalue)
+ else:
+ ktype = k
+ kvalue = ""
+ sortable_kv = tuple()
+
+ if ktype == "comp_attribute":
+ sortable_kt = liberty_attribute_order(kvalue)
+ else:
+ sortable_kt = liberty_attribute_order(ktype)
+
+ return sortable_kt, ktype, sortable_kv, kvalue, k, v
+
+ di = [attr_sort_key(i) for i in data.items()]
+ di.sort()
+ if debug:
+ for sk, kt, skv, kv, k, v in di:
+ print(str(indent), "%4.0f %4.0f -- " % sk, "%-40s" % kt, '%-40r' % kv, str(v)[:40], '...')
+
+ # Output all the attributes
+ for _, ktype, _, kvalue, k, v in di:
+ indent_n = list(indent)+[k]
+
+ if ktype == 'define':
+ for d in sorted(data['define'], key=lambda d: d['group_name']+'.'+d['attribute_name']):
+ o.append('%sdefine(%s,%s,%s);' % (
+ INDENT*len(indent_n),
+ d['attribute_name'],
+ d['group_name'],
+ d['attribute_type']),
+ )
+
+ elif ktype == "comp_attribute":
+ o.extend(liberty_composite(kvalue, v, indent_n))
+
+ elif isinstance(v, dict):
+ assert isinstance(v, dict), (dtype, dvalue, k, v)
+ o.extend(liberty_dict(ktype, kvalue, v, indent_n))
+
+ elif isinstance(v, list):
+ assert len(v) > 0, (dtype, dvalue, k, v)
+ if isinstance(v[0], dict):
+ def sk(o):
+ return o.items()
+
+ for l in sorted(v, key=sk):
+ o.extend(liberty_dict(ktype, kvalue, l, indent_n))
+
+ elif is_liberty_list(ktype):
+ o.extend(liberty_list(ktype, v, indent_n))
+
+ elif "clk_width" == ktype:
+ for l in sorted(v):
+ o.append("%s%s : %s;" % (INDENT*len(indent_n), k, l))
+
+ else:
+ raise ValueError("Unknown %s: %r\n%s" % (k, v, indent_n))
+
+ else:
+ if isinstance(v, str):
+ v = '"%s"' % v
+ elif isinstance(v, (float,int)):
+ v = liberty_float(v)
+ o.append("%s%s : %s;" % (INDENT*len(indent_n), k, v))
+
+ o.append("%s}" % (INDENT*len(indent)))
+ return o
+
+
+
+
+def main():
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ "library_path",
+ help="Path to the library.",
+ type=pathlib.Path,
+ nargs=1)
+ parser.add_argument(
+ "corner",
+ help="Corner to write output for.",
+ default=None,
+ nargs='*')
+
+ parser.add_argument(
+ "--ccsnoise",
+ help="Include ccsnoise in file output.",
+ action='store_true',
+ default=False)
+ parser.add_argument(
+ "--leakage",
+ help="Include power leakage in file output.",
+ action='store_true',
+ default=False)
+
+ args = parser.parse_args()
+
+ libdir = args.library_path[0]
+
+ retcode = 0
+
+ lib, corners, all_cells = collect(libdir)
+
+ if args.ccsnoise:
+ output_corner_type = TimingType.ccsnoise
+ elif args.leakage:
+ output_corner_type = TimingType.leakage
+ else:
+ output_corner_type = TimingType.basic
+
+ if args.corner == ['all']:
+ args.corner = list(sorted(k for k, (v0, v1) in corners.items() if output_corner_type in v0))
+
+ if args.corner:
+ for acorner in args.corner:
+ if acorner in corners:
+ continue
+ print()
+ print("Unknown corner:", acorner)
+ retcode = 1
+ if retcode != 0:
+ args.corner.clear()
+
+ if not args.corner:
+ print()
+ print("Available corners for", lib+":")
+ for k, v in sorted(corners.items()):
+ print(" -", k, v[0].describe())
+ print()
+ return retcode
+
+ print("Generating", output_corner_type.name, "liberty timing files for", lib, "at", ", ".join(args.corner))
+ print()
+ for corner in args.corner:
+ input_corner_type, corner_cells = corners[corner]
+ if output_corner_type not in input_corner_type:
+ print("Corner", corner, "doesn't support", output_corner_type, "(only {})".format(input_corner_type))
+ return 1
+
+ if output_corner_type == TimingType.basic and TimingType.ccsnoise in input_corner_type:
+ input_corner_type = TimingType.ccsnoise
+ else:
+ input_corner_type = output_corner_type
+
+ generate(
+ libdir, lib,
+ corner, output_corner_type, input_corner_type,
+ corner_cells,
+ )
+ return 0
+
+
+if __name__ == "__main__":
+ import doctest
+ doctest.testmod()
+ sys.exit(main())
diff --git a/scripts/python-skywater-pdk/skywater_pdk/sizes.py b/scripts/python-skywater-pdk/skywater_pdk/sizes.py
index aa3b02b..1988cfd 100644
--- a/scripts/python-skywater-pdk/skywater_pdk/sizes.py
+++ b/scripts/python-skywater-pdk/skywater_pdk/sizes.py
@@ -31,6 +31,9 @@
>>> parse_size('_1')
CellSizeNumeric(units=1)
+ >>> parse_size('a2111o_1')
+ CellSizeNumeric(units=1)
+
>>> parse_size('sky130_fd_sc_ms__sdfrtp_1.v')
CellSizeNumeric(units=1)
@@ -47,7 +50,7 @@
dirname, s = os.path.split(s)
if '.' in s:
s = s.split('.', 1)[0]
- if s.count('_') > 1:
+ if s.count('_') > 0:
s = '_' + (s.rsplit('_', 1)[-1])
if not s or s == '_':
return None
diff --git a/scripts/python-skywater-pdk/skywater_pdk/utils.py b/scripts/python-skywater-pdk/skywater_pdk/utils.py
index 9f7a641..30b3d9d 100644
--- a/scripts/python-skywater-pdk/skywater_pdk/utils.py
+++ b/scripts/python-skywater-pdk/skywater_pdk/utils.py
@@ -21,6 +21,7 @@
import dataclasses_json
import functools
import random
+import re
import sys
from dataclasses import dataclass
@@ -229,6 +230,64 @@
return hash(self._name_)
+def extract_numbers(s):
+ """Create tuple with sequences of numbers converted to ints.
+
+ >>> extract_numbers("pwr_template13x10")
+ ('pwr_template', 13, 'x', 10)
+ >>> extract_numbers("vio_10_10_1")
+ ('vio_', 10, '_', 10, '_', 1)
+ """
+ bits = []
+ for m in re.finditer("([^0-9]*)([0-9]*)", s):
+ if m.group(1):
+ bits.append(m.group(1))
+ if m.group(2):
+ bits.append(int(m.group(2)))
+ return tuple(bits)
+
+
+def sortable_extracted_numbers(s):
+ """Create output which is sortable by numeric values in string.
+
+ >>> sortable_extracted_numbers("pwr_template13x10")
+ ('pwr_template', '0000000013', 'x', '0000000010')
+ >>> sortable_extracted_numbers("vio_10_10_1")
+ ('vio_', '0000000010', '_', '0000000010', '_', '0000000001')
+
+ >>> l = ['a1', 'a2b2', 'a10b10', 'b2', 'a8b50', 'a10b1']
+ >>> l.sort()
+ >>> print('\\n'.join(l))
+ a1
+ a10b1
+ a10b10
+ a2b2
+ a8b50
+ b2
+ >>> l.sort(key=sortable_extracted_numbers)
+ >>> print('\\n'.join(l))
+ a1
+ a2b2
+ a8b50
+ a10b1
+ a10b10
+ b2
+
+ """
+ zero_pad_str = '%010i'
+ bits = extract_numbers(s)
+ o = []
+
+ for b in bits:
+ if not isinstance(b, str):
+ assert isinstance(b, int), (b, bits)
+ assert len(str(b)) < len(zero_pad_str % 0)
+ b = zero_pad_str % b
+ o.append(b)
+ return tuple(o)
+
+
+
if __name__ == "__main__":
import doctest
doctest.testmod()