Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@alibillalhammoud
alibillalhammoud committed Sep 1, 2023
1 parent e390cdf commit 6513458
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 10 deletions.
99 changes: 98 additions & 1 deletion openfasoc/generators/gdsfactory-gen/tapeout_and_RL/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,101 @@
This directory contains the `sky130_nist_tapeout.py` file which is a python program containing all functions and utils neccessary to produce the circuits, simulation info, and statistics used in the sky130 NIST tapeout.
`sky130_nist_tapeout.py` has a command line interface. use the `-h` option to see all args for this program. help output is replicated below

p
## general help
```
usage: sky130_nist_tapeout.py [-h] {extract_stats,get_training_data,gen_opamp,test} ...
sky130 nist tapeout sample, RL generation, and statistics utility.
options:
-h, --help show this help message and exit
mode:
{extract_stats,get_training_data,gen_opamp,test}
extract_stats Run the extract_stats function.
get_training_data Run the get_training_data function.
gen_opamp Run the gen_opamp function. optional parameters for transistors
are width,length,fingers,mults
test Test mode
```

## extract_stats mode
```
usage: sky130_nist_tapeout.py extract_stats [-h] [-p PARAMS] [-r RESULTS]
options:
-h, --help show this help message and exit
-p PARAMS, --params PARAMS
File path for params (default: training_params.npy)
-r RESULTS, --results RESULTS
File path for results (default: training_results.npy)
```

## gen_opamp mode
```
usage: sky130_nist_tapeout.py gen_opamp [-h]
[--diffpair_params DIFFPAIR_PARAMS DIFFPAIR_PARAMS DIFFPAIR_PARAMS]
[--diffpair_bias DIFFPAIR_BIAS DIFFPAIR_BIAS DIFFPAIR_BIAS]
[--half_common_source_params HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS]
[--half_common_source_bias HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS]
[--output_stage_params OUTPUT_STAGE_PARAMS OUTPUT_STAGE_PARAMS OUTPUT_STAGE_PARAMS]
[--output_stage_bias OUTPUT_STAGE_BIAS OUTPUT_STAGE_BIAS OUTPUT_STAGE_BIAS]
[--mim_cap_size MIM_CAP_SIZE MIM_CAP_SIZE]
[--mim_cap_rows MIM_CAP_ROWS] [--rmult RMULT]
[--add_pads] [--output_gds OUTPUT_GDS]
options:
-h, --help show this help message and exit
--diffpair_params DIFFPAIR_PARAMS DIFFPAIR_PARAMS DIFFPAIR_PARAMS
diffpair_params (default: 6 1 4)
--diffpair_bias DIFFPAIR_BIAS DIFFPAIR_BIAS DIFFPAIR_BIAS
diffpair_bias (default: 6 2 4)
--half_common_source_params HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS HALF_COMMON_SOURCE_PARAMS
half_common_source_params (default: 7 1 10 3)
--half_common_source_bias HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS HALF_COMMON_SOURCE_BIAS
half_common_source_bias (default: 6 2 8 3)
--output_stage_params OUTPUT_STAGE_PARAMS OUTPUT_STAGE_PARAMS OUTPUT_STAGE_PARAMS
pamp_hparams (default: 5 1 16)
--output_stage_bias OUTPUT_STAGE_BIAS OUTPUT_STAGE_BIAS OUTPUT_STAGE_BIAS
pamp_hparams (default: 6 2 4)
--mim_cap_size MIM_CAP_SIZE MIM_CAP_SIZE
mim_cap_size (default: 12 12)
--mim_cap_rows MIM_CAP_ROWS
mim_cap_rows (default: 3)
--rmult RMULT rmult (default: 2)
--add_pads add pads (gen_opamp mode only)
--output_gds OUTPUT_GDS
Filename for outputing opamp (gen_opamp mode only)
```

## get_training_data mode
```
usage: sky130_nist_tapeout.py get_training_data [-h] [-t] [--temp TEMP] [--cload CLOAD]
[--noparasitics] [--nparray NPARRAY]
[--saverawsims]
options:
-h, --help show this help message and exit
-t, --test-mode Set test_mode to True (default: False)
--temp TEMP Simulation temperature
--cload CLOAD run simulation with load capacitance units=pico Farads
--noparasitics specify that parasitics should be removed when simulating
--nparray NPARRAY overrides the test parameters and takes the ones you provide (file
path to .npy file)
--saverawsims specify that the raw simulation directories should be saved
(default saved under save_gds_by_index/...)
```

## test mode
```
usage: sky130_nist_tapeout.py test [-h] [--output_dir OUTPUT_DIR] [--temp TEMP]
[--cload CLOAD] [--noparasitics]
options:
-h, --help show this help message and exit
--output_dir OUTPUT_DIR
Directory for output GDS file
--temp TEMP Simulation temperature
--cload CLOAD run simulation with load capacitance units=pico Farads
--noparasitics specify that parasitics should be removed when simulating
```
19 changes: 10 additions & 9 deletions openfasoc/generators/gdsfactory-gen/tapeout_and_RL/sky130_nist_tapeout.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,30 +280,31 @@ def get_small_parameter_list(test_mode = False) -> np.array:
else:
for width in [3,6,9]:
for length in [0.3,1, 2]:
for fingers in [2,6]:
for fingers in [2,4,6]:
diffpairs.append((width,length,fingers))
# all bias2 (output amp bias) transistors
bias2s = list()
if test_mode:
bias2s.append((6,1,4,3))
else:
for width in [3,6,9]:
for width in [6]:
for length in [1]:
for fingers in [2,6]:
bias2s.append((width,length,fingers,3))
for fingers in [2,4,6]:
for mults in [1,2,3]:
bias2s.append((width,length,fingers,mults))
# all output pmos transistors
pamp_hparams = list()
if test_mode:
pamp_hparams.append((7,1,8,3))
else:
for width in [4,7,10]:
for length in [0.3,1,2]:
for fingers in [6,14]:
for width in [7,4]:
for length in [1,2]:
for fingers in [8,14]:
pamp_hparams.append((width,length,fingers,3))
# rows of the cap array to try
cap_arrays = [2,3]
cap_arrays = [1,2,3]
# routing mults to try
rmults = [1,2]
rmults = [2]
# ******************************************
# create and return the small parameters list
short_list_len = len(diffpairs) * len(bias2s) * len(pamp_hparams) * len(cap_arrays) * len(rmults)
Expand Down

0 comments on commit 6513458

Please sign in to comment.