luke
/
OpenRAM
mirror of https://github.com/VLSIDA/OpenRAM.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add rom to index

This commit is contained in:
Sage Walker 2023-05-03 21:12:09 -07:00
parent a5a0cffe65
commit bb8f3f7eb8
3 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/source/basic_rom_usage.md
View File

@ -2,7 +2,7 @@
### [Go Back](./index.md#table-of-contents) ### [Go Back](./index.md#table-of-contents)
# Basic Usage # Basic Usage
This page of the documentation explains the basic usage of OpenRAM's ROM compiler (OpenROM). This page of the documentation explains the basic usage of OpenRAM's ROM compiler (OpenROM). For usage of the RAM compiler see [here](./basic_usage.md#go-back)
@ -84,3 +84,16 @@ make sky130_rom_1kbyte
# Add a supply ring to the generated layout # Add a supply ring to the generated layout
route_supplies = "ring" route_supplies = "ring"
``` ```
## Output Files
The output files are placed in the `output_dir` defined in the configuration
file.
The base name is specified by `output_name` and suffixes are added. Currently only layout and schematic files are generated.
The final results files are:
* GDS (.gds)
* SPICE (.sp)
* Log (.log)
* Configuration (.py) for replication of creation

2
docs/source/basic_usage.md
View File

@ -1,7 +1,7 @@
### [Go Back](./index.md#table-of-contents) ### [Go Back](./index.md#table-of-contents)
# Basic Usage # Basic Usage
This page of the documentation explains the basic usage of OpenRAM's SRAM compiler. This page of the documentation explains the basic usage of OpenRAM's SRAM compiler. For usage of the ROM compiler see [here](./basic_rom_usage.md#go-back)

3
docs/source/index.md
View File

@ -10,7 +10,8 @@ navigate through the documentation.
1. [OpenRAM Dependencies](#openram-dependencies) 1. [OpenRAM Dependencies](#openram-dependencies)
1. [Supported Technologies](#supported-technologies) 1. [Supported Technologies](#supported-technologies)
1. [Basic Setup](./basic_setup.md#go-back) 1. [Basic Setup](./basic_setup.md#go-back)
1. [Basic Usage](./basic_usage.md#go-back) 1. [Basic SRAM Usage](./basic_usage.md#go-back)
1. [Basic ROM Usage](./basic_rom_usage.md#go-back)
1. [Python Library](./python_library.md#go-back) 1. [Python Library](./python_library.md#go-back)
1. [Bitcells](./bitcells.md#go-back) 1. [Bitcells](./bitcells.md#go-back)
1. [Architecture](./architecture.md#go-back) 1. [Architecture](./architecture.md#go-back)