blob: 89f929f3a2d1383819c530963fa8e853b698ad8a [file] [log] [blame] [view]
Tim Edwards55f4d0e2020-07-05 15:41:02 -04001Open-PDKs (open_pdks)
2-----------------------------------------
3
4Summary:
5
6Automatic setup of PDKs for open-source tools from foundry sources.
7
8Builds out and populates a new set of directories and subdirectories in
9the efabless format, with the efabless name for the PDK at the top,
10followed by categories "libs.ref" (IP) and "libs.tech" (EDA tool setup),
11each with subcategories corresponding to layout, abstract views,
12netlists, etc. for the IP; and magic, netgen, qflow, etc., for the
13EDA tool setup.
14
15The populated PDK directories can contain either copies of files from
16the foundry sources, links to the foundry sources, or links back to
17another PDK.
18
19Generates magic layout views for all vendor IP for which either a GDS
20view or a LEF view exists. Annotates the views as needed to handle
21ports, bounding boxes, etc.
22
23-----------------------------------------
24
Tim Edwards5cd63752020-10-24 21:00:06 -040025This distribution contains sources for building out the SkyWater SKY130
Tim Edwards55f4d0e2020-07-05 15:41:02 -040026130nm process. Sources for the foundry process data must be obtained
Tim Edwards5cd63752020-10-24 21:00:06 -040027separately. Read the README file in subdirectory sky130/ for instructions
28on obtaining and building the SkyWater sky130A PDK.
Tim Edwards55f4d0e2020-07-05 15:41:02 -040029
30-----------------------------------------
31
Tim Edwards2a700da2020-07-08 21:35:56 -040032License:
33
34Open_PDKs is open-source software distributed under the Apache-2.0 license.
35See file LICENSE for the complete license text.
36
37-----------------------------------------
38
Tim Edwards55f4d0e2020-07-05 15:41:02 -040039Instructions:
40
Tim Edwards37e8ac42020-10-24 21:13:20 -040041 git clone https://github.com/RTimothyEdwards/open_pdks.git
42 cd open_pdks
43 ./configure [options]
44 make
Tim Edwardsba45dee2021-04-28 11:09:39 -040045 [sudo] make install
Tim Edwards55f4d0e2020-07-05 15:41:02 -040046
Tim Edwards37e8ac42020-10-24 21:13:20 -040047where the configure [options] are specific to each foundry PDK supported
48by open_pdks and can be queried using
49
50 ./configure --help
51
52At a minimum you will want to pass a configure option to declare the location
53of the PDK vendor source distribution (which can be obtained separately),
54
Tim Edwardscdfec5e2021-04-22 20:59:13 -040055 ./configure --enable-[PDK_name]-pdk=[path]
Tim Edwards37e8ac42020-10-24 21:13:20 -040056
57The open_pdks version of the PDK can be built locally within open_pdks without
58the need to declare an install target or run "make install". However, it is
59recommended to declare a target location and install there, using
60
Tim Edwardscdfec5e2021-04-22 20:59:13 -040061 ./configure --enable-[PDK_name]-pdk=[path] --with-[PDK_name]-local-path=[path]
Tim Edwards37e8ac42020-10-24 21:13:20 -040062
63followed by "make" and "make install".
64
65Also see the website at http://opencircuitdesign.com/open_pdks/. The "Install"
66page has full instructions for configuring and installing open_pdks.
Tim Edwards2a700da2020-07-08 21:35:56 -040067