Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
watbulb authored Sep 8, 2024
1 parent a0af067 commit e024e53
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,19 @@ _Note: Work In Progress, see top of `config.json`_

GDSPY is required to add boundary layers to GDS files: `apt install python3-gdspy`

- First, `git submodule update --init`.
- Place your magic art designs in `mag/` or `gds/`
- If your design is a `.mag`, run `make preproc <name_of_mag>`
- run `make preproc <name_of_macro_in_gds_or_mag>`
- This will produce GDS/LEF outputs used during a Openlane2 custom flow.

```bash
git submodule update --init
make preproc ttlogo
make tt_harden_top
```
- Additionally, a PN boundary layer will be added to any converted GDS or converted MAG during the preproc phase.
- Make a copy of `src/ttlogo_config.json` as `src/<my_macro_name>_config.json`
- Edit the `VERILOG_DEFINES` and `MACROS` options to specify which macro you would like to place.
- Run `make tt_harden_top <my_macro_name>`

**Things to be done**

- [ ] (Fix the flow properly stream out the GDS, GDS -> isn't including PR boundary)
- [ ] (Dynamically generate macro inclusions into the config from a macros.cfg)
- [X] (Fix the flow properly stream out the GDS, GDS -> isn't including PR boundary)
- [X] (Make sure we support input mags that have power nets that we will eventually ignore)
- [X] (The PDN config is basically a no-op. we can interleave configs for mags that needs a POWER net)
- [ ] (Standardize and document minimal flow required to macro place without detailed or global routing)
- [ ] (Make sure we support input mags that have power nets that we will eventually ignore)
- [ ] (The PDN config is basically a no-op. we can interleave configs for mags that needs a POWER net)
- [ ] (Alow the usage of multiple macros in the blackbox using a generate verilog statement)

0 comments on commit e024e53

Please sign in to comment.