blob: 7c4833e04ea352ae117923e4573c7eefa1f7aeea [file] [log] [blame] [view]
Steve Kelly50bfa482020-12-17 23:29:33 -05001# Repositories and versions to use
2
3## skywater-pdk:
4
5Please stick to version `v0.0.0-303-g3d7617a`
6(commit hash: `3d7617a1acb92ea883539bcf22a632d6361a5de4`)
7```
8git clone https://github.com/google/skywater-pdk.git
9cd skywater-pdk
10git checkout v0.0.0-303-g3d7617a
11git submodule update --init libraries/sky130_fd_sc_hd/latest
12git submodule update --init libraries/sky130_fd_sc_hvl/latest
13...
14git submodule update --init libraries/sky130_fd_io/latest
15```
16
17## open_pdks:
18
19Please stick to the `mpw-one-a` tag.
20```
21git clone https://github.com/RTimothyEdwards/open_pdks.git -b mpw-one-a
22```
23
24## OpenLane:
25
26Please stick to the `mpw-one-a` tag.
27```
28git clone https://github.com/efabless/openlane.git -b mpw-one-a
29```
30Note that the `mpw-one-a` tag is equivalent to the `rc5` tag. Also, note that
31running `make` inside the openlane directory will automatically grab the right
32versions of `open_pdks` and `skywater-pdk` as listed above and install them to
33PDK_ROOT.
34
35For example,
36
37```
38export PDK_ROOT=$HOME/pdks
39cd openlane
40make
41```
42
43## Caravel:
44
45Please stick to the `mpw-one-a` tag.
46```
47git clone https://github.com/efabless/caravel.git -b mpw-one-a
48```
49
50## Notes
51
52- If you have already successfully hardened your blocks and have a clean
53 `user_project_wrapper`, you don't have to recreate it and can just reuse it.
54 No changes have been made to the user project area or to the tools that
55 require you to reharden your design(s).
56
57- If you prefer to re-generate your blocks (using OpenLane), you can refer to
58 this [page][1].
59
60- **IMPORTANT**. Do not forget to run `make uncompress -j4` in the caravel root
61 directory before you start working. Likewise, before you commit and push your
62 changes back, run `make compress -j4`.
63
64- If you already have a clean working tree in a previously cloned repository from
65 those listed above, what you need to do is:
66 ```
67 git pull
68 git checkout tag
69 ```
70
71[1]: ./openlane/README.md