From 508c21f203be3d53b20e18ed4d47769f9bf35ed3 Mon Sep 17 00:00:00 2001
From: Grzegorz Latosinski <glatosinski@antmicro.com>
Date: Wed, 11 Nov 2020 01:37:04 +0100
Subject: [PATCH] Added script for generating nfet and pfet plots from
 libraries directory

Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
---
 .../fet_simulator/fet_simulator.py            | 19 ++++-
 .../fet_simulator/generate-docs-plots.py      | 72 +++++++++++++++++++
 2 files changed, 88 insertions(+), 3 deletions(-)
 create mode 100644 scripts/python-skywater-pdk/skywater_pdk/fet_simulator/generate-docs-plots.py

diff --git a/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/fet_simulator.py b/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/fet_simulator.py
index 15bf9e7..d76c4ec 100644
--- a/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/fet_simulator.py
+++ b/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/fet_simulator.py
@@ -33,13 +33,18 @@ def create_test_circuit(fet_type, iparam, fet_L, fet_W, corner_path):
     # create the circuit
     c.V('gg', 1, c.gnd, 0@u_V)
     c.V('dd', 2, c.gnd, 1.8@u_V)
-    c.X('M1', fet_type, 2, 1, c.gnd, c.gnd, L=fet_L, W=fet_W, ad="'W*0.29'", pd="'2*(W+0.29)'", as_="'W*0.29'", ps="'2*(W+0.29)'", nrd="'0.29/W'", nrs="'0.29/W'", sa=0, sb=0, sd=0, nf=1, mult=1)
+    c.X('M1', fet_type, 2, 1, c.gnd, c.gnd, L=fet_L, W=fet_W, ad="'W*0.29'",
+        pd="'2*(W+0.29)'", as_="'W*0.29'", ps="'2*(W+0.29)'", nrd="'0.29/W'", 
+        nrs="'0.29/W'", sa=0, sb=0, sd=0, nf=1, mult=1
+    )
     return c 
 
 
 def run_sim(c, iparam, fet_W):
     sim = c.simulator()
-    sim.save_internal_parameters(iparam%'gm', iparam%'id', iparam%'gds', iparam%'cgg')
+    sim.save_internal_parameters(
+        iparam%'gm', iparam%'id', iparam%'gds', iparam%'cgg'
+    )
 
     # run the dc simulation
     an = sim.dc(Vgg=slice(0, 1.8, 0.01))
@@ -85,7 +90,15 @@ def read_bins(fname):
         return r
 
 
-def generate_fet_plots(fet_type, corner_path, bins_csv, outdir, outprefix, only_W=None, ext='png'):
+def generate_fet_plots(
+        fet_type,
+        corner_path,
+        bins_csv,
+        outdir,
+        outprefix,
+        only_W=None,
+        ext='png'):
+    print(f'[generate_fet_plots] {fet_type} {corner_path} {bins_csv} {outdir} {outprefix} {only_W}')
     iparam = f'@m.xm1.m{fet_type}[%s]'
     # fet_W and fet_L values here are only for initialization, they are
     # later changed in the for loop
diff --git a/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/generate-docs-plots.py b/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/generate-docs-plots.py
new file mode 100644
index 0000000..3d7ec7c
--- /dev/null
+++ b/scripts/python-skywater-pdk/skywater_pdk/fet_simulator/generate-docs-plots.py
@@ -0,0 +1,72 @@
+#!/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
+from pathlib import Path
+
+from fet_simulator import generate_fet_plots
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        'fd_pr_dir',
+        help='Path to the particular version of the primitive library',
+        type=Path
+    )
+    parser.add_argument(
+        'device_details_dir',
+        help='Path to the directory with device details to save images to',
+        type=Path
+    )
+
+    args = parser.parse_args()
+
+    typicalcorner = args.fd_pr_dir / 'models/corners/tt.spice'
+
+    fets = [
+        ['esd_nfet', 'esd_nfet_01v8', None],
+        ['nfet_01v8', 'nfet_01v8', None],
+        ['nfet_01v8_lvt', 'nfet_01v8_lvt', None],
+        ['nfet_03v3_nvt', 'nfet_03v3_nvt', None],
+        ['nfet_03v3_nvt-and-nfet_05v0_nvt', 'nfet_05v0_nvt', None],
+        ['nfet_03v3_nvt-and-nfet_05v0_nvt', 'nfet_03v3_nvt', None],
+        ['nfet_05v0_nvt', 'nfet_05v0_nvt', None],
+        # ['nfet_20v0'], TODO provide
+        # ['nfet_20v0_iso', 'nfet_20v0_nvt_iso', None], TODO invalid bins.csv file
+        # ['nfet_20v0_nvt', 'nfet_20v0_nvt', None], TODO invalid bins.csv file
+        # ['nfet_20v0_zvt', 'nfet_20v0_zvt', None], TODO invalid bins.csv file
+        # ['nfet_g11v0d16v0'], TODO provide
+        ['nfet_g5v0d10v5', 'nfet_g5v0d10v5', None],
+        ['pfet_01v8', 'pfet_01v8', None],
+        ['pfet_01v8_hvt', 'pfet_01v8_hvt', None],
+        ['pfet_01v8_lvt', 'pfet_01v8_lvt', None],
+        # ['pfet_20v0', 'pfet_20v0', None], TODO some plot issues
+        ['pfet_g5v0d10v5', 'pfet_g5v0d10v5', None],
+        ['pfet_g5v0d16v0', 'pfet_g5v0d16v0', None]
+    ]
+
+    for outdir, fetname, onlyw in fets:
+        generate_fet_plots(
+            f'sky130_fd_pr__{fetname}',
+            typicalcorner,
+            args.fd_pr_dir / f'cells/{fetname}/sky130_fd_pr__{fetname}.bins.csv',
+            args.device_details_dir / outdir,
+            f'sim_{fetname}_',
+            onlyw
+        )