File size: 69,066 Bytes
d59bb1b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 |
# OpenROAD Flow Scripts Tutorial
## Introduction
This document describes a tutorial to run the complete
OpenROAD flow from RTL-to-GDS using [OpenROAD Flow
Scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts).
It includes examples of useful design and manual usage in key flow
stages to help users gain a good understanding of the
[OpenROAD](https://openroad.readthedocs.io/en/latest/main/README.html)
application flow, data organization, GUI and commands.
This is intended for:
- Beginners or new users with some understanding of basic VLSI
design flow. Users will learn the basics of installation to use
OpenROAD-flow-scripts for the complete RTL-to-GDS flow from
[here](../index.md#getting-started-with-openroad-flow-scripts).
- Users already familiar with the OpenROAD application and flow but would
like to learn more about specific features and commands.
## User Guidelines
- This tutorial requires a specific directory structure built by
OpenROAD-flow-scripts (ORFS). Do not modify this structure or
underlying files since this will cause problems in the flow execution.
- User can run the full RTL-to-GDS flow and learn specific flow
sections independently. This allows users to learn the flow and tool
capabilities at their own pace, time and preference.
- Results shown, such as images or outputs of reports and logs, could
vary based on release updates. However, the main flow and command
structure should generally apply.
Note: Please submit any problem found under Issues in the GitHub repository
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues).
## Getting Started
This section describes the environment setup to build OpenROAD-flow-scripts
and get ready to execute the RTL-to-GDS flow of the open-source
design `ibex` using the `sky130hd` technology.
`ibex` is a 32 bit RISC-V CPU core (`RV32IMC/EMC`) with a two-stage
pipeline.
### Setting Up The Environment
Use the `bash` shell to run commands and scripts.
#### OpenROAD-flow-scripts Installation
To install OpenROAD-flow-scripts, refer to the
[Build or installing ORFS Dependencies](https://openroad-flow-scripts.readthedocs.io/en/latest/#build-or-installing-orfs-dependencies)
documentation.
In general, we recommend using `Docker` for an efficient user
experience. Install OpenROAD-flow-scripts using a docker as described
here [Build from sources using Docker](../user/BuildWithDocker.md).
:::{Note}
If you need to update an existing OpenROAD-flow-scripts installation,
follow instructions from [here](../user/FAQS.md#how-do-i-update-openroad-flow-scripts).
:::
OpenROAD-flow-scripts installation is complete.
#### Running OpenROAD-flow-scripts inside the Docker
Launch the docker with OpenROAD-flow-scripts container as follows:
```shell
docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22-builder
```
:::{seealso}
To launch OpenROAD GUI inside the docker, based on the OS, use the command from [here](../user/BuildWithDocker.md#enable-gui-support).
:::
Once you are entered into OpenROAD-flow-scripts container run:
```shell
source env.sh
```
If your installation is successful, you will see the following message:
```
OPENROAD: /OpenROAD-flow-scripts/tools/OpenROAD
```
#### Verifying the Docker based Installation
To verify the installation run the built-in example design as follows:
```shell
cd flow
make
```
A successful run end with the log:
```
[INFO] Writing out GDS/OAS 'results/nangate45/gcd/base/6_1_merged.gds'
Elapsed time: 0:10.44[h:]min:sec. CPU time: user 2.17 sys 0.54 (26%). Peak memory: 274184KB.
cp results/nangate45/gcd/base/6_1_merged.gds results/nangate45/gcd/base/6_final.gds
Log Elapsed seconds
1_1_yosys 2
3_3_place_gp 1
4_1_cts 8
5_2_route 10
6_1_merge 10
6_report 3
```
## Configuring The Design
This section shows how to set up the necessary platform and design
configuration files to run the complete RTL-to-GDS flow using
OpenROAD-flow-scripts for `ibex` design.
```shell
cd flow
```
### Platform Configuration
View the platform configuration file setup for default variables for
`sky130hd`.
```shell
less ./platforms/sky130hd/config.mk
```
The `config.mk` file has all the required variables for the `sky130`
platform and hence it is not recommended to change any variable
definition here. You can view the `sky130hd` platform configuration
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/platforms/sky130hd/config.mk).
Refer to the [Flow variables](../user/FlowVariables.md) document for
details on how to use platform and design specific environment variables
in OpenROAD-flow-scripts to customize and configure your design flow.
### Design Configuration
View the default design configuration of `ibex` design:
```shell
less ./designs/sky130hd/ibex/config.mk
```
You can view `ibex` design `config.mk`
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/sky130hd/ibex/config.mk).
:::{Note} The following design-specific configuration variables are required
to specify main design inputs such as platform, top-level design name and
constraints. We will use default configuration variables for this tutorial.
:::
| Variable Name | Description |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `PLATFORM` | Specifies Process design kit. |
| `DESIGN_NAME` | The name of the top-level module of the design |
| `VERILOG_FILES` | The path to the design Verilog files or JSON files providing a description of modules (check `yosys -h write_json` for more details). |
| `SDC_FILE` | The path to design `.sdc` file |
| `CORE_UTILIZATION` | The core utilization percentage. |
| `PLACE_DENSITY` | The desired placement density of cells. It reflects how spread the cells would be on the core area. 1 = closely dense. 0 = widely spread |
:::{Note} To add a new design to the `flow`, refer to the document
[here](../user/AddingNewDesign.md). This step is for advanced users.
If you are a beginner, first understand the flow by completing this
tutorial and come back to this step later to add a new design.
:::
### Timing Constraints
View timing constraints specified in the `.sdc` file
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/sky130hd/ibex/constraint.sdc).
```shell
less ./designs/sky130hd/ibex/constraint.sdc
```
For `ibex` design, we simply use the clock definition as follows as a
minimum required timing constraint.
```tcl
create_clock -name core_clock -period 17.4 [get_ports {clk_i}]
```
### Design Input Verilog
The Verilog input files are located in `./designs/src/ibex/`
The design is defined in `ibex_core.v` available
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex/ibex_core.v).
Refer to the `ibex` design `README.md`
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex/README.md).
## Running The Automated RTL-to-GDS Flow
This section describes the complete execution of the design flow from
RTL-to-GDS. The OpenROAD application executes the entire autonomous flow
using Tcl scripts that invoke open-sourced tools, from synthesis to the final
`.gds` file creation, without requiring human intervention. However, in this
tutorial, the user will learn both the automated and a few interactive ways
to run Tcl commands for important flow stages.
From the OpenROAD-flow-scripts directory, users can access individual flow
stages, respective tools and the corresponding `README.md` for tool commands,
configuration examples using the Tcl interface and other such details.
- [Synthesis](https://github.com/The-OpenROAD-Project/yosys/blob/master/README.md)
- [Database](https://openroad.readthedocs.io/en/latest/main/src/odb/README.html)
- [Floorplanning](https://openroad.readthedocs.io/en/latest/main/src/ifp/README.html)
- [Pin Placement](https://openroad.readthedocs.io/en/latest/main/src/ppl/README.html)
- [Chip-level Connections](https://openroad.readthedocs.io/en/latest/main/src/pad/README.html)
- [Macro Placement](https://openroad.readthedocs.io/en/latest/main/src/mpl/README.html)
- [Tapcell insertion](https://openroad.readthedocs.io/en/latest/main/src/tap/README.html)
- [PDN Analysis](https://openroad.readthedocs.io/en/latest/main/src/pdn/README.html)
- [IR Drop Analysis](https://openroad.readthedocs.io/en/latest/main/src/psm/README.html)
- [Global Placement](https://openroad.readthedocs.io/en/latest/main/src/gpl/README.html)
- [Timing Analysis](https://openroad.readthedocs.io/en/latest/main/src/sta/README.html)
- [Detailed Placement](https://openroad.readthedocs.io/en/latest/main/src/dpl/README.html)
- [Timing Optimization using Resizer](https://openroad.readthedocs.io/en/latest/main/src/rsz/README.html)
- [Clock Tree Synthesis](https://openroad.readthedocs.io/en/latest/main/src/cts/README.html)
- [Global Routing](https://openroad.readthedocs.io/en/latest/main/src/grt/README.html)
- [Antenna Rule Checker](https://openroad.readthedocs.io/en/latest/main/src/ant/README.html)
- [Detail Routing](https://openroad.readthedocs.io/en/latest/main/src/drt/README.html)
- [Metall Fill](https://openroad.readthedocs.io/en/latest/main/src/fin/README.html)
- [Parasitics Extraction](https://openroad.readthedocs.io/en/latest/main/src/rcx/README.html)
- [Layout Generation](https://www.klayout.de/)
### Design Goals
Run the `ibex` design in OpenROAD-flow-scripts automated flow from
RTL-to-GDS using `sky130hd`. Find `ibex` design details
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex/README.md)
and the design goals are:
- Area
```
Minimum Required Die size: 0 0 798 800 (in micron)
Core size: 2 2 796 798 (in micron)
```
- Timing
```
Clock period to meet timing: 17.4 (in ns)
```
`ibex` takes approximately 8 minutes on a machine with 8-cores and 16GB RAM.
The runtime will vary based on your configuration.
Change your current directory to the `flow` directory.
```shell
cd flow
```
Run the complete flow with:
```shell
make DESIGN_CONFIG=./designs/sky130hd/ibex/config.mk
```
As the flow executes, check out the OpenROAD-flow-scripts directory contents and their
significance.
OpenROAD-flow-scripts can generally restart from a previous partial run. If you have errors which prevent restarting the flow, you may try deleting all generated files and start a fresh run. Errors can occur if a tool crashes or is killed while writing a file. The files for `sky130hd/ibex` as an example can be deleted with:
```shell
make clean_all DESIGN_CONFIG=./designs/sky130hd/ibex/config.mk
```
You can also delete files related to individual stages of RTL to GDSII conversion like synthesis, floorplanning, macro placement, clock tree synthesis, routing and layout generation with `clean_synth`, `clean_floorplan`, `clean_place`, `clean_cts`, `clean_route`, and `clean_finish`, respectively.
### Viewing OpenROAD-flow-scripts Directory Structure And Results
Open a new tab in the terminal and explore the directory structure in
`flow` by typing `ls` command to view its contents:
```shell
designs logs Makefile objects platforms reports results scripts test util
```
Navigate through each of the sub-directories above to understand how
underlying files are organized.
- `designs/sky130hd/ibex`
Files include: designs make file and SDC file for the `sky130hd`
platform and other files for autotuner and metrics.
```
autotuner.json config.mk constraint_doe.sdc constraint.sdc metadata-base-ok.json rules.json
```
- `platforms`
Includes public PDKs supported by OpenROAD flow
```
asap7 nangate45 sky130hd sky130hs sky130io sky130ram
```
- `objects/sky130hd/ibex/base`
Includes ABC constraints and all the temporary library files used
for the completion flow
```
abc.constr klayout.lyt klayout_tech.lef lib
```
- `logs/sky130hd/ibex/base`
Logs directory, which contains log files for each flow stage.
| `logs` | | |
|------------------------|------------------------|-----------------------|
| `1_1_yosys.log` | `3_1_place_gp.log` | `5_2_route.log` |
| `2_1_floorplan.log` | `3_2_place_iop.log` | `6_1_merge.log` |
| `2_2_floorplan_io.log` | `3_3_resizer.log` | `6_report.log` |
| `2_3_tdms_place.log` | `3_4_opendp.log` | |
| `2_4_floorplan_macro.log` | `4_1_cts.log` | |
| `2_5_floorplan_tapcell.log` | `4_2_cts_fillcell.log` | |
| `2_6_floorplan_pdn.log` | `5_1_grt.log` | |
- `results/sky130hd/ibex/base`
Results directory which contains `.v/.sdc/.odb/.def/.spef` files
| `results` | | |
|-----------------------------|-------------------------|--------------------|
| `1_1_yosys.v` | `3_1_place_gp.odb` | `5_route.sdc` |
| `1_synth.sdc` | `3_2_place_iop.odb` | `6_1_fill.odb` |
| `1_synth.v` | `3_3_place_resized.odb` | `6_1_fill.sdc` |
| `2_1_floorplan.odb` | `3_4_place_dp.odb` | `6_1_merged.gds` |
| `2_2_floorplan_io.odb` | `3_place.odb` | `6_final.odb` |
| `2_3_floorplan_tdms.odb` | `3_place.sdc` | `6_final.gds` |
| `2_4_floorplan_macro.odb` | `4_1_cts.odb` | `6_final.sdc` |
| `2_5_floorplan_tapcell.odb` | `4_2_cts_fillcell.odb` | `6_final.spef` |
| `2_6_floorplan_pdn.odb` | `4_cts.odb` | `6_final.v` |
| `2_floorplan.odb` | `4_cts.sdc` | `output_guide.mod` |
| `2_floorplan.sdc` | `4_cts.v` | `route.guide` |
| `2_floorplan.v` | `5_route.odb` | `updated_clks.sdc` |
- `reports/sky130hd/ibex/base`
Reports directory, which contains congestion report, DRC
report, design statistics and antenna log for reference.
| `reports` | | |
|-------------------|---------------------|------------------------|
| `congestion.rpt` | `VDD.rpt` | `VSS.rpt` |
| `5_route_drc.rpt` | `final_clocks.webp` | `final_placement.webp` |
| `antenna.log` | `final_clocks.webp` | `final.webp` |
| `synth_stat.txt` | `synth_check.txt` | `final_resizer.webp` |
The table below briefly describes the reports directory files.
| File Name | Description |
|------------------------|----------------------------------------------------------|
| `congestion.rpt` | Gloabl routing congestion if occurred. |
| `5_route_drc.rpt` | DRC violations if occurred. |
| `final_clocks.webp` | OR extracted image reference after clock tree synthesis. |
| `final_resizer.webp` | OR extracted image reference after resizer. |
| `synth_check.txt` | Synthesis warning/error messages. |
| `antenna.log` | Antenna check log report. |
| `final_placement.webp` | Extracted image after final placement. |
| `final.webp` | Extracted image after routing. |
| `synth_stat.txt` | Post synthesis design statistics log saved here. |
The flow completes with the message below by creating a merged final GDS file.
```
[INFO] Writing out GDS/OAS
'results/sky130hd/ibex/base/6_1_merged.gds'
cp results/sky130hd/ibex/base/6_1_merged.gds
results/sky130hd/ibex/base/6_final.gds
```
## Viewing Results And Logs
OpenROAD-flow-scripts prepends a prefix to each flow stage, as shown below, to
indicate the position in the RTL-GDS flow. This makes it easier to
understand and debug each flow stage in case of failure.
View `ibex` design logs:
```shell
ls logs/sky130hd/ibex/base/
```
The log structure is as follows:
| `logs` | | |
|------------------------|------------------------|-----------------------|
| `1_1_yosys.log` | `3_1_place_gp.log` | `5_2_route.log` |
| `2_1_floorplan.log` | `3_2_place_iop.log` | `6_1_merge.log` |
| `2_2_floorplan_io.log` | `3_3_resizer.log` | `6_report.log` |
| `2_3_tdms_place.log` | `3_4_opendp.log` | |
| `2_4_floorplan_macro.log` | `4_1_cts.log` | |
| `2_5_floorplan_tapcell.log` | `4_2_cts_fillcell.log` | |
| `2_6_floorplan_pdn.log` | `5_1_grt.log` | |
### Area
View design area and its core utilization:
```
make gui_final
report_design_area
```
View the resulting area as:
```
Design area 191262 u^2 30% utilization.
```
### Timing
Users can view flow results using the command interface from the shell or
the OpenROAD GUI to visualize further and debug. Learn more about the
[GUI](https://openroad.readthedocs.io/en/latest/main/README.html#gui).
```shell
make gui_final
```
Use the following commands in the `Tcl Commands` section of GUI:
```tcl
report_worst_slack
report_tns
report_wns
```
Note the worst slack, total negative slack and worst negative slack:
```
worst slack -0.99
tns -1.29
wns -0.99
```
Learn more about visualizing and tracing time paths across the design
hierarchy refer to the OpenROAD [GUI](https://openroad.readthedocs.io/en/latest/main/README.html#gui).
### Power
Use the report command to view individual power components i.e.
sequential, combinational, macro and power consumed by I/O pads.
```tcl
report_power
```
The power output is as follows:
```
--------------------------------------------------------------------------
Group Internal Switching Leakage Total
Power Power Power Power
----------------------------------------------------------------
Sequential 5.58e-03 6.12e-04 1.67e-08 6.19e-03 19.0%
Combinational 9.23e-03 1.71e-02 4.90e-08 2.63e-02 81.0%
Macro 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.0%
Pad 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.0%
----------------------------------------------------------------
Total 1.48e-02 1.77e-02 6.57e-08 3.25e-02 100.0%
45.6% 54.4% 0.0%
```
## OpenROAD GUI
The GUI allows users to select, control, highlight and navigate the
design hierarchy and design objects (nets, pins, instances, paths, etc.)
through detailed visualization and customization options. Find details
on how to use the [GUI](https://openroad.readthedocs.io/en/latest/main/README.html#gui). All the windows
aside from the layout are docking windows that can be undocked. Also it
can be closed and reopened from the Windows menu.
Note: When you are using remote access, you will need to include -Y (or -X) option in your command to
enable X11 applications to function properly over the network. By using the command "ssh -Y" followed
by the remote servers' address or hostname, you can establish a secure connection and activate X11 forwarding.
This feature enables you to run graphical programs on the remote server and have their windows display
on your local machines desktop environment.
In this section, learn how to:
1. Visualize design hierarchy
2. Load ODB files for floorplan and layout visualization
3. Trace the synthesized clock tree to view hierarchy and buffers
4. Use heat maps to view congestion and observe the effect of placement
5. View and trace critical timing paths
6. Set display control options
7. Zoom to object from inspector
If you have completed the RTL-GDS flow, then proceed to view the final
GDS file under results directory `./results/sky130hd/ibex/base/`
For the `ibex` design uncomment the `DESIGN_CONFIG`
variable in the `Makefile` available [here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/Makefile).
```
# DESIGN_CONFIG=./designs/sky130hd/gcd/config.mk
DESIGN_CONFIG=./designs/sky130hd/ibex/config.mk
# DESIGN_CONFIG=./designs/sky130hd/aes/config.mk
```
```shell
make gui_final
```
### Viewing Layout Results
The `make gui_final` command target successively reads and loads the
technology `.odb` files and the parasitics and invokes the
GUI in these steps:
- Reads and loads `.odb` files.
- Loads `.spef` (parasitics).
The figure below shows the post-routed DEF for the `ibex` design.
### Visualizing Design Objects And Connectivity
Note the `Display Control` window on the LHS that shows buttons
for color, visibility and selection options for various design
objects: Layers, Nets, Instances, Blockages, Heatmaps, etc.
The Inspector window on the RHS allows users to inspect details of
selected design objects and the timing report.
Try selectively displaying (show/hide) various design objects through
the display control window and observing their impact on the display.
### Tracing The Clock Tree
View the synthesized clock tree for `ibex` design:
- From the top Toolbar Click `Windows` -> `Clock Tree Viewer`
On RHS, click `Clock Tree Viewer` and top right corner, click
`Update` to view the synthesized clock tree of your design.
View clock tree structure below, the user needs to disable the metal
`Layers` section on LHS as shown below.
From the top Toolbar, click on the `Windows` menu to select/hide different
view options of Scripting, Display control, etc.
### Using Heat Maps
From the Menu Bar, Click on `Tools` -> `Heat Maps` -> `Placement Density` to view
congestion selectively on vertical and horizontal layers.
Expand `Heat Maps` -> `Placement Density` from the Display Control window
available on LHS of OpenROAD GUI.
View congestion on all layers between 50-100%:
In the `Placement density` setup pop-up window, Select `Minimum` -> `50.00%`
`Maximum` -> `100.00%`
From `Display Control`, select `Heat Maps` -> `Routing Congestion` as
follows:
From `Display Control`, select `Heat Maps` -> `Power Density` as
follows:
### Viewing Timing Report
Click `Timing` -> `Options` to view and traverse specific timing paths.
From Toolbar, click on the `Timing` icon, View `Timing Report` window added
at the right side (RHS) of GUI as shown below.
In `Timing Report` Select `Paths` -> `Update`, `Paths` should be integer
numbers. The number of timing paths should be displayed in the current
window as follows:
Select `Setup` or `Hold` tabs and view required arrival times and
slack for each timing path segment.
For each `Setup` or `Hold` path group, path details have a specific `pin
name, Time, Delay, Slew and Load` value with the clock to register, register
to register and register to output data path.
### Using Rulers
A ruler can measure the distance between any two objects in the design or
metal layer length and width to be measured, etc.
Example of how to measure the distance between VDD and VSS power grid click on:
`Tools` -> `Ruler K`
Distance between VDD and VSS layer is `11.970`
### DRC Viewer
You can use the GUI to trace DRC violations and fix them.
View DRC violations post routing:
```shell
less ./reports/sky130hd/ibex/base/5_route_drc.rpt
```
Any DRC violations are logged in the `5_route_drc.rpt` file, which is
empty otherwise.
From OpenROAD GUI, Enable the menu options `Windows` -> `DRC Viewer`. A
`DRC viewer` window is added on the right side (RHS) of the GUI. From
`DRC Viewer` -> `Load` navigate to `5_route_drc.rpt`
By selecting DRC violation details, designers can analyze and fix them. Here
user will learn how a DRC violation can be traced with the `gcd` design. Refer
to the following OpenROAD test case for more details.
```shell
cd ./flow/tutorials/scripts/drt/
openroad -gui
```
In the `Tcl Commands` section of GUI:
```tcl
source drc_issue.tcl
```
Post detail routing in the log, you can find the number of violations left
in the design:
```
[INFO DRT-0199] Number of violations = 7.
```
Based on `DRC Viewer` steps load `results/5_route_drc.rpt`. GUI as
follows
`X mark` in the design highlights DRC violations.
From `DRC Viewer` on RHS `expand` -> `Short`
This shows the number of `violations` in the design. Zoom the design
for a clean view of the violation:
`output53` has overlaps and this causes the `short violation`.
Open the input DEF file `drc_cts.def` to check the source of the
overlap.
Note the snippet of DEF file where `output51` and `output53` have
the same placed coordinates and hence cause the placement violation.
```
- output51 sky130_fd_sc_hd__clkbuf_1 + PLACED ( 267260 136000 ) N ;
- output53 sky130_fd_sc_hd__clkbuf_1 + PLACED ( 267260 136000 ) N ;
```
Use the test case provided in `4_cts.def` with the changes applied for
updated coordinates as follows:
```
- output51 sky130_fd_sc_hd__clkbuf_1 + PLACED ( 267260 136000 ) N ;
- output53 sky130_fd_sc_hd__clkbuf_1 + PLACED ( 124660 266560 ) N ;
```
Close the current GUI and re-load the GUI with the updated DEF to see
fixed DRC violation in the design:
```shell
openroad -gui
source drc_fix.tcl
```
In the post detail routing log, the user can find the number of violations
left in the design:
```
[INFO DRT-0199] Number of violations = 0.
```
Routing completed with 0 violations.
### Tcl Command Interface
Execute OpenROAD-flow-scripts Tcl commands from the GUI. Type `help`
to view Tcl Commands available. In OpenROAD GUI, at the bottom,
`TCL commands` executable space is available to run the commands.
For example
View `design area`:
```tcl
report_design_area
```
Try the below timing report commands to view timing results interactively:
```tcl
report_wns
report_tns
report_worst_slack
```
### Customizing The GUI
Customize the GUI by creating your own widgets such as menu bars,
toolbar buttons, dialog boxes, etc.
Refer to the [GUI](https://openroad.readthedocs.io/en/latest/main/README.html#gui).
Create `Load_LEF` toolbar button in GUI to automatically load
specified `.lef` files.
```shell
openroad -gui
```
To view `load_lef.tcl`, run the command:
```shell
less ./flow/tutorials/scripts/gui/load_lef.tcl
```
```tcl
proc load_lef_sky130 {} {
set FLOW_PATH [exec pwd]
read_lef $FLOW_PATH/../../../platforms/sky130hd/lef/sky130_fd_sc_hd.tlef
read_lef $FLOW_PATH/../../../platforms/sky130hd/lef/sky130_fd_sc_hd_merged.lef
}
create_toolbar_button -name "Load_LEF" -text "Load_LEF" -script {load_lef_sky130} -echo
```
From OpenROAD GUI `Tcl commands`:
```tcl
cd ./flow/tutorials/scripts/gui/
source load_lef.tcl
```
`Load_LEF` toolbar button added as follows:
From Toolbar menus, Click on `Load_LEF.` This loads the specified `sky130`
technology `.tlef` and `merged.lef` file in the current OpenROAD GUI
as follows:
## Understanding and Analyzing OpenROAD Flow Stages and Results
The OpenROAD flow is fully automated and yet the user can usefully intervene
to explore, analyze and optimize your design flow for good PPA.
In this section, you will learn specific details of flow stages and
learn to explore various design configurations and optimizations to
target specific design goals, i.e., PPA (area, timing, power).
### Synthesis Explorations
#### Area And Timing Optimization
Explore optimization options using synthesis options: `ABC_AREA` and `ABC_SPEED`.
Set `ABC_AREA=1` for area optimization and `ABC_SPEED=1` for timing optimization.
Update design `config.mk` for each case and re-run the flow to view impact.
To view `ibex` design [config.mk](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/sky130hd/ibex/config.mk).
```
#Synthesis strategies
export ABC_AREA = 1
```
Run `make` command from `flow` directory as follows:
```shell
make DESIGN_CONFIG=./designs/sky130hd/gcd/config.mk
```
The `gcd` design synthesis results for area and speed optimizations are shown below:
| Synthesis Statistics | ABC_SPEED | ABC_AREA |
|-----------------------|--------------------------------------|--------------------------------------|
| `Number of wires` | 224 | 224 |
| `Number of wire bits` | 270 | 270 |
| `Number of cells` | 234 | 234 |
| `Chip area` | 2083.248000 | 2083.248000 |
| `Final Design Area` | Design area 4295 u^2 6% utilization. | Design area 4074 u^2 6% utilization. |
Note: Results for area optimization should be ideally checked after
floorplanning to verify the final impact. First, relax the `.sdc` constraint
and re-run to see area impact. Otherwise, the repair design command will
increase the area to meet timing regardless of the netlist produced earlier.
### Floorplanning
This section describes OpenROAD-flow-scripts floorplanning and
placement functions using the GUI.
#### Floorplan Initialization Based On Core And Die Area
Refer to the following OpenROAD built-in examples
[here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ifp/test/init_floorplan1.tcl).
Run the following commands in the terminal in OpenROAD tool root directory to build and view the created
floorplan.
```shell
cd ../tools/OpenROAD/src/ifp/test/
openroad -gui
```
In `Tcl Commands` section GUI:
```tcl
source init_floorplan1.tcl
```
View the resulting die area "0 0 1000 1000" and core area "100 100 900 900"
in microns shown below:
#### Floorplan Based On Core Utilization
Refer to the following OpenROAD built-in examples
[here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ifp/test/init_floorplan2.tcl).
Run the following commands in the terminal in OpenROAD tool root directory to view how the floorplan
initialized:
```shell
cd ../tools/OpenROAD/src/ifp/test/
openroad -gui
```
In the `Tcl Commands` section of the GUI:
```tcl
source init_floorplan2.tcl
```
View the resulting core utilization of 30 created following floorplan:
### IO Pin Placement
Place pins on the boundary of the die on the track grid to minimize net
wirelengths. Pin placement also creates a metal shape for each pin using
min-area rules.
For designs with unplaced cells, the net wirelength is computed considering
the center of the die area as the unplaced cells position.
Find pin placement document [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ppl/README.md).
Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/ppl/test).
Launch openroad GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/ppl/test/
openroad -gui
```
Run [place_pin4.tcl](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ppl/test/place_pin4.tcl) script to view
pin placement.
From the GUI `Tcl commands` section:
```tcl
source place_pin4.tcl
```
View the resulting pin placement in GUI:
In OpenROAD GUI to enlarge `clk` pin placement, hold mouse right button
as follows and draw sqaure box in specific location:
Now `clk` pin zoom to clear view as follows:
### Chip Level IO Pad Placement
In this section, you will generate an I/O pad ring for the `coyote` design
using a Tcl script.
ICeWall is a utility to place IO cells around the periphery of a design,
and associate the IO cells with those present in the netlist of the
design.
For I/O pad placement using ICeWall refer to the readme file
[here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/pad/README.md).
Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/pad/test).
Launch openroad GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/pad/test/
openroad -gui
```
Run [skywater130_coyote_tc.tcl](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/pad/test/skywater130_coyote_tc.tcl) script
to view IO pad placement.
From the GUI `Tcl commands` section:
```tcl
source skywater130_coyote_tc.tcl
```
View the resulting IO pad ring in GUI:
### Power Planning And Analysis
In this section, you will use the design `gcd` to create a
power grid and run power analysis.
Pdngen is used for power planning. Find the document [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/pdn/README.md).
Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/pdn/test).
Launch openroad GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/pdn/test
openroad -gui
```
Run [core_grid_snap.tcl](.(https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/pdn/test/core_grid_snap.tcl)
to generate power grid for `gcd` design.
```tcl
source core_grid_snap.tcl
```
View the resulting power plan for `gcd` design:
#### IR Drop Analysis
IR drop is the voltage drop in the metal wires constituting the power
grid before it reaches the power pins of the standard cells. It becomes
very important to limit the IR drop as it affects the speed of the cells
and overall performance of the chip.
PDNSim is an open-source static IR analyzer.
Features:
- Report worst IR drop.
- Report worst current density over all nodes and wire segments in
the power distribution network, given a placed and PDN-synthesized design.
- Check for floating PDN stripes on the power and ground nets.
- Spice netlist writer for power distribution network wire segments.
Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/psm/test).
Launch openroad by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/psm/test
openroad
```
Run [gcd_test_vdd.tcl](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/psm/test/gcd_test_vdd.tcl)
to generate IR drop report for `gcd` design.
```tcl
source gcd_test_vdd.tcl
```
Find the IR drop report at the end of the log as follows:
```
########## IR report #################
Worstcase voltage: 1.10e+00 V
Average IR drop : 1.68e-04 V
Worstcase IR drop: 2.98e-04 V
######################################
```
### Tapcell insertion
Tap cells are non-functional cells that can have a well tie, substrate
tie or both. They are typically used when most or all of the standard
cells in the library contain no substrate or well taps. Tap cells help
tie the VDD and GND levels and thereby prevent drift and latch-up.
The end cap cell or boundary cell is placed at both the ends of each
placement row to terminate the row. They protect the standard cell
gate at the boundary from damage during manufacturing.
Tap cells are placed after the macro placement and power rail creation.
This stage is called the pre-placement stage. Tap cells are placed in a
regular interval in each row of placement. The maximum distance between
the tap cells must be as per the DRC rule of that particular technology library.
The figures below show two examples of tapcell insertion. When only the
`-tapcell_master` and `-endcap_master` masters are given, the tapcell placement
is similar to Figure 1. When the remaining masters are give, the tapcell
placement is similar to Figure 2.
Refer to the GUI figures to highlight well tap and end cap cells. The image
does not differentiate and just shows a bunch of rectangles.
| <img src="./images/tapcell_example1.svg" width=450px> | <img src="./images/tapcell_example2.svg" width=450px> |
|:--:|:--:|
| Figure 1: Tapcell insertion representation | Figure 2: Tapcell insertion around macro representation |
Refer to the following built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/tap/test/gcd_nangate45.tcl)
to learn about Tap/endcap cell insertion.
To view this in OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/tap/test/
openroad -gui
```
In the `Tcl Commands` section of GUI
```tcl
source gcd_nangate45.tcl
```
View the resulting tap cell insertion as follows:
### Tie Cells
The tie cell is a standard cell, designed specially to provide the high
or low signal to the input (gate terminal) of any logic gate.
Where ever netlist is having any pin connected to 0 logic or 1 logic
(like .A(1'b0) or .IN(1'b1), a tie cell gets inserted there.
Refer to the following built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ifp/test/tiecells.tcl)
to learn about Tie cell insertion.
To check this in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/ifp/test/
openroad
source tiecells.tcl
```
Refer the following verilog code which have tie high/low net.
[here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ifp/test/tiecells.v)
```
AND2_X1 u2 (.A1(r1q), .A2(1'b0), .ZN(u2z0));
AND2_X1 u3 (.A1(u1z), .A2(1'b1), .ZN(u2z1));
```
With following `insert_tiecells` command:
```
insert_tiecells LOGIC0_X1/Z -prefix "TIE_ZERO_"
insert_tiecells LOGIC1_X1/Z
```
During floorplan stage, those nets converted to tiecells as follows
based on library(This is Nangate45 specific):
```
[INFO IFP-0030] Inserted 1 tiecells using LOGIC0_X1/Z.
[INFO IFP-0030] Inserted 1 tiecells using LOGIC1_X1/Z.
```
### Macro or Standard Cell Placement
#### Macro Placement
In this section, you will explore various placement options for macros
and standard cells and study the impact on area and timing.
Refer to the following built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/gpl/test/macro01.tcl)
to learn about macro placement.
Placement density impacts how widely standard cells are placed in the
core area. To view this in OpenROAD GUI run the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/gpl/test/
openroad -gui
```
In the `Tcl Commands` section of GUI
```tcl
source macro01.tcl
```
Read the resulting macro placement with a complete core view:
| <img src="./images/macro_place_full_view.webp" width=450px> | <img src="./images/macro_place_close_view.webp" width=450px> |
|:--:|:--:|
| Figure 1: With density 0.7 | Figure 2: Zoomed view of macro and std cell placement|
Reduce the placement density and observe the impact on placement, by
running below command in `Tcl Commands` section of GUI:
```tcl
global_placement -density 0.6
```
Read the resulting macro placement with a complete core view:
| <img src="./images/placement_density_06_full.webp" width=450px> | <img src="./images/placement_density_06_zoomed.webp" width=450px> |
|:--:|:--:|
| Figure 1: With density 0.6 | Figure 2: Zoomed view of macro and std cell placement |
##### Macro Placement With Halo Spacing
Explore macro placement with halo spacing, refer to the example
[here]((https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/mpl/test/).
Launch GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/mpl/test
openroad -gui
```
In the `Tcl Commands` section of GUI:
```tcl
source helpers.tcl
source level3.tcl
global_placement
```
DEF file without halo spacing
Now increase the halo width for better routing resources.
In the `Tcl Commands` section of GUI:
```tcl
macro_placement -halo {0.5 0.5}
```
Overlapping macros placed `0.5` micron H/V halo around macros.
#### Defining Placement Density
To learn on placement density strategies for `ibex` design, go to
`OpenROAD-flow-scripts/flow`. Type:
```shell
openroad -gui
```
Enter the following commands in the `Tcl Commands` section of GUI
```tcl
read_lef ./platforms/sky130hd/lef/sky130_fd_sc_hd.tlef
read_lef ./platforms/sky130hd/lef/sky130_fd_sc_hd_merged.lef
read_def ./results/sky130hd/ibex/base/3_place.def
```
Change `CORE_UTILIZATION` and `PLACE_DENSITY` for the `ibex` design
`config.mk` as follows.
View `ibex` design `config.mk`
[here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/sky130hd/ibex/config.mk).
```
export CORE_UTILIZATION = 40
export PLACE_DENSITY_LB_ADDON = 0.1
```
Re-run the `ibex` design with the below command:
```shell
make DESIGN_CONFIG=./designs/sky130hd/ibex/config.mk
```
View the `ibex` design placement density heat map as shown below:
So from above, GUI understood that change in `CORE_UTILIZATION` from 20
to 40 and placement density default 0.60 to 0.50 changes standard cell
placement became widely spread.
### Timing Optimizations
#### Timing Optimization Using repair_design
The `repair_design` command inserts buffers on nets to repair `max
slew, max capacitance and max fanout` violations and on long wires to
reduce RC delay. It also resizes gates to normalize slews. Use
`estimate_parasitics -placement` before `repair_design` to account
for estimated post-placement parasitics.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/rsz/test/repair_slew1.tcl).
Launch GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/rsz/test/
openroad -gui
```
Copy and paste the below commands in the `Tcl Commands` section of GUI.
```tcl
source "helpers.tcl"
source "hi_fanout.tcl"
read_liberty Nangate45/Nangate45_typ.lib
read_lef Nangate45/Nangate45.lef
set def_file [make_result_file "repair_slew1.def"]
write_hi_fanout_def $def_file 30
read_def $def_file
create_clock -period 1 clk1
set_wire_rc -layer metal3
estimate_parasitics -placement
set_max_transition .05 [current_design]
puts "Found [sta::max_slew_violation_count] violations"
```
The number of violations log as:
```
Found 31 violations
```
These violations were fixed by:
```tcl
repair_design
```
The log is as follows:
```
[INFO RSZ-0058] Using max wire length 853um.
[INFO RSZ-0039] Resized 1 instance.
```
To view violation counts again:
```tcl
puts "Found [sta::max_slew_violation_count] violations"
```
The log follows:
```
Found 0 violations
```
`repair_design` fixed all 31 violations.
#### Timing Optimization Using repair_timing
The `repair_timing` command repairs setup and hold violations. It was
run after clock tree synthesis with propagated clocks.
While repairing hold violations, buffers are not inserted since that may
cause setup violations unless '-allow_setup_violations' is specified.
Use `-slack_margin` to add additional slack margin.
#### Timing Optimization Based On Multiple Corners
OpenROAD supports multiple corner analysis to calculate worst-case setup
and hold violations.
Setup time optimization is based on the slow corner or the best case when
the launch clock arrives later than the data clock.
Hold time optimization is based on the fast corner or the best case when
the launch clock arrives earlier than the capture clock.
Refer to the following `gcd` design on `repair_timing` with fast and slow
corners.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/test/gcd_sky130hd_fast_slow.tcl).
Run the following commands in the terminal:
```shell
cd ../../test/
openroad
source gcd_sky130hd_fast_slow.tcl
```
The resulting `worst slack`, `TNS`:
```
report_worst_slack -min -digits 3
worst slack 0.321
report_worst_slack -max -digits 3
worst slack -16.005
report_tns -digits 3
tns -529.496
```
#### Fixing Setup Violations
To fix setup timing path violations, use `repair_timing -setup.`
Refer to the following built-in example to learn more about fixing setup
timing violations.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/rsz/test/repair_setup4.tcl).
Launch OpenROAD in an interactive mode by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/rsz/test/
openroad
```
Copy and paste the following Tcl commands.
```tcl
define_corners fast slow
read_liberty -corner slow Nangate45/Nangate45_slow.lib
read_liberty -corner fast Nangate45/Nangate45_fast.lib
read_lef Nangate45/Nangate45.lef
read_def repair_setup1.def
create_clock -period 0.3 clk
set_wire_rc -layer metal3
estimate_parasitics -placement
report_checks -fields input -digits 3
```
View the generated timing report with the slack violation.
```
Startpoint: r1 (rising edge-triggered flip-flop clocked by clk)
Endpoint: r2 (rising edge-triggered flip-flop clocked by clk)
Path Group: clk
Path Type: max
Corner: slow
Delay Time Description
-----------------------------------------------------------
0.000 0.000 clock clk (rise edge)
0.000 0.000 clock network delay (ideal)
0.000 0.000 ^ r1/CK (DFF_X1)
0.835 0.835 ^ r1/Q (DFF_X1)
0.001 0.836 ^ u1/A (BUF_X1)
0.196 1.032 ^ u1/Z (BUF_X1)
0.001 1.033 ^ u2/A (BUF_X1)
0.121 1.154 ^ u2/Z (BUF_X1)
0.001 1.155 ^ u3/A (BUF_X1)
0.118 1.273 ^ u3/Z (BUF_X1)
0.001 1.275 ^ u4/A (BUF_X1)
0.118 1.393 ^ u4/Z (BUF_X1)
0.001 1.394 ^ u5/A (BUF_X1)
0.367 1.761 ^ u5/Z (BUF_X1)
0.048 1.809 ^ r2/D (DFF_X1)
1.809 data arrival time
0.300 0.300 clock clk (rise edge)
0.000 0.300 clock network delay (ideal)
0.000 0.300 clock reconvergence pessimism
0.300 ^ r2/CK (DFF_X1)
-0.155 0.145 library setup time
0.145 data required time
-----------------------------------------------------------
0.145 data required time
-1.809 data arrival time
-----------------------------------------------------------
-1.664 slack (VIOLATED)
```
Fix setup violation using:
```tcl
repair_timing -setup
```
The log is as follows:
```
[INFO RSZ-0040] Inserted 4 buffers.
[INFO RSZ-0041] Resized 16 instances.
[WARNING RSZ-0062] Unable to repair all setup violations.
```
Reduce the clock frequency by increasing the clock period to `0.9` and re-run
`repair_timing` to fix the setup violation warnings. Such timing violations
are automatically fixed by the `resizer` `post CTS` and `global routing.`
```yvl
create_clock -period 0.9 clk
repair_timing -setup
```
To view timing logs post-repair timing, type:
```tcl
report_checks -fields input -digits 3
```
The log is as follows:
```
Startpoint: r1 (rising edge-triggered flip-flop clocked by clk)
Endpoint: r2 (rising edge-triggered flip-flop clocked by clk)
Path Group: clk
Path Type: max
Corner: slow
Delay Time Description
-----------------------------------------------------------
0.000 0.000 clock clk (rise edge)
0.000 0.000 clock network delay (ideal)
0.000 0.000 ^ r1/CK (DFF_X1)
0.264 0.264 v r1/Q (DFF_X1)
0.002 0.266 v u1/A (BUF_X4)
0.090 0.356 v u1/Z (BUF_X4)
0.003 0.359 v u2/A (BUF_X8)
0.076 0.435 v u2/Z (BUF_X8)
0.003 0.438 v u3/A (BUF_X8)
0.074 0.512 v u3/Z (BUF_X8)
0.003 0.515 v u4/A (BUF_X8)
0.077 0.592 v u4/Z (BUF_X8)
0.005 0.597 v u5/A (BUF_X16)
0.077 0.674 v u5/Z (BUF_X16)
0.036 0.710 v r2/D (DFF_X1)
0.710 data arrival time
0.900 0.900 clock clk (rise edge)
0.000 0.900 clock network delay (ideal)
0.000 0.900 clock reconvergence pessimism
0.900 ^ r2/CK (DFF_X1)
-0.172 0.728 library setup time
0.728 data required time
-----------------------------------------------------------
0.728 data required time
-0.710 data arrival time
-----------------------------------------------------------
0.019 slack (MET)
```
#### Fixing Hold Violations
To fix hold violation for the design, command to use `repair_timing
-hold`
Refer to the example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/rsz/test/repair_hold10.tcl)
to learn more about fixing hold violations.
Check hold violation post-global routing using the following Tcl
commands. Run below steps in terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/rsz/test/
openroad -gui
```
Copy and paste the below commands in the `Tcl Commands` section of GUI.
```tcl
source helpers.tcl
read_liberty sky130hd/sky130hd_tt.lib
read_lef sky130hd/sky130hd.tlef
read_lef sky130hd/sky130hd_std_cell.lef
read_def repair_hold10.def
create_clock -period 2 clk
set_propagated_clock clk
set_wire_rc -resistance 0.0001 -capacitance 0.00001
set_routing_layers -signal met1-met5
global_route
estimate_parasitics -global_routing
report_worst_slack -min
```
Read the resulting worst slack as:
```
worst slack -1.95
```
The above worst slack was fixed with:
```tcl
repair_timing -hold
```
The log is as follows:
```
[INFO RSZ-0046] Found 2 endpoints with hold violations.
[INFO RSZ-0032] Inserted 5 hold buffers.
```
Re-check the slack value after repair_timing. Type:
```tcl
report_worst_slack -min
```
The result worst slack value is as follows:
```
worst slack 0.16
```
Note that the worst slack is now met and the hold violation was fixed by
the resizer.
### Clock Tree Synthesis
To perform clock tree synthesis `clock_tree_synthesis` flow command used.
The OpenROAD-flow-scripts automatically generates a well-balanced clock tree post-placement.
In this section, you will learn details about the building and visualize the
clock tree.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/cts/test/simple_test.tcl).
Launch OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/cts/test/
openroad -gui
```
To build the clock tree, run the following commands in `Tcl Commands` of
GUI:
```tcl
read_lef Nangate45/Nangate45.lef
read_liberty Nangate45/Nangate45_typ.lib
read_def "16sinks.def"
create_clock -period 5 clk
set_wire_rc -clock -layer metal3
clock_tree_synthesis -root_buf CLKBUF_X3 \
-buf_list CLKBUF_X3 \
-wire_unit 20
```
Layout view before CTS as follows:
Layout view after CTS can be viewed with `Update` option.
Here we explore how clock tree buffers are inserted to balance the clock
tree structure.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/cts/test/balance_levels.tcl).
Generate a clock- tree that is unbalanced first, then explore the
creation of a well-balanced clock tree.
Launch OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/cts/test/
openroad -gui
```
Use the following commands in the `TCL commands` section of GUI:
```tcl
source "helpers.tcl"
source "cts-helpers.tcl"
read_liberty Nangate45/Nangate45_typ.lib
read_lef Nangate45/Nangate45.lef
set block [make_array 300 200000 200000 150]
sta::db_network_defined
create_clock -period 5 clk
set_wire_rc -clock -layer metal5
```
The clock tree structure is as follows with unbalanced mode.
Use the `clock_tree_synthesis` command to balance this clock tree structure
with buffers. See the format as follows.
```tcl
clock_tree_synthesis -root_buf CLKBUF_X3 \
-buf_list CLKBUF_X3 \
-wire_unit 20 \
-post_cts_disable \
-sink_clustering_enable \
-distance_between_buffers 100 \
-sink_clustering_size 10 \
-sink_clustering_max_diameter 60 \
-balance_levels \
-num_static_layers 1
```
To view the balanced clock tree after CTS, in GUI Toolbar, select
`Clock Tree Viewer` and click `Update` to view the resulting clock
tree in GUI as follows:
#### Reporting Clock Skews
The OpenROAD-flow-scripts flow automatically fixes any skew issues that could potentially
cause hold violations downstream in the timing path.
```tcl
report_clock_skew
```
For the `ibex` design, refer to the following logs to view clock skew reports.
```shell
less logs/sky130hd/ibex/base/4_1_cts.log
```
```
cts pre-repair report_clock_skew
--------------------------------------------------------------------------
Clock core_clock
Latency CRPR Skew
_28453_/CLK ^
5.92
_29312_/CLK ^
1.41 0.00 4.51
```
```
cts post-repair report_clock_skew
--------------------------------------------------------------------------
Clock core_clock
Latency CRPR Skew
_28453_/CLK ^
5.92
_29312_/CLK ^
1.41 0.00 4.51
```
```
cts final report_clock_skew
--------------------------------------------------------------------------
Clock core_clock
Latency CRPR Skew
_27810_/CLK ^
5.97
_29266_/CLK ^
1.41 0.00 4.56
```
#### Reporting CTS Metrics
Run `report_cts` command to view useful metrics such as number of clock
roots, number of buffers inserted, number of clock subnets and number of
sinks.
Refer to the built-in examples [here](https://github.com/The-OpenROAD-Project/OpenROAD/tree/master/src/cts/test).
Run these Tcl commands in the terminal in OpenROAD tool root directory:
```
cd ../tools/OpenROAD/src/cts/test/
openroad
source post_cts_opt.tcl
report_cts
```
CTS metrics are as follows for the current design.
```
[INFO CTS-0003] Total number of Clock Roots: 1.
[INFO CTS-0004] Total number of Buffers Inserted: 35.
[INFO CTS-0005] Total number of Clock Subnets: 35.
[INFO CTS-0006] Total number of Sinks: 301.
```
### Adding Filler Cells
Filler cells fills gaps between detail-placed instances to connect the
power and ground rails in the rows. Filler cells have no logical
connectivity. These cells are provided continuity in the rows for VDD
and VSS nets and it also contains substrate nwell connection to improve
substrate biasing.
`filler_masters` is a list of master/macro names to use for
filling the gaps.
Refer to the following built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/dpl/test/fillers1.tcl)
to learn about filler cell insertion.
To view this in OpenROAD GUI run the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/grt/test/
openroad -gui
```
In the `Tcl Commands` section of GUI,run following commands:
```tcl
source "helpers.tcl"
read_lef "Nangate45/Nangate45.lef"
read_def "gcd.def"
```
Loaded DEF view without filler insertion:
Run following commands for filler cell insertion:
```
set filler_master [list FILLCELL_X1 FILLCELL_X2 FILLCELL_X4 FILLCELL_X8 FILLCELL_X16]
filler_placement $filler_master
```
View the resulting fill cell insertion as follows:
Filler cells removed with `remove_fillers` command.
### Global Routing
The global router analyzes available routing resources and automatically
allocates them to avoid any H/V overflow violations for optimal routing.
It generates a congestion report for GCells showing total resources, demand,
utilization, location and the H/V violation status. If there are no violations
reported then the design can proceed to detail routing.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/grt/test/gcd.tcl).
Launch OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/grt/test/
openroad -gui
```
To run the global routing, run the following commands in `Tcl Commands` of
GUI:
```tcl
source gcd.tcl
```
Routing resource and congestion analysis done with below log:
```
[INFO GRT-0096] Final congestion report:
Layer Resource Demand Usage (%) Max H / Max V / Total Overflow
---------------------------------------------------------------------------------------
metal1 31235 1651 5.29% 0 / 0 / 0
metal2 24628 1652 6.71% 0 / 0 / 0
metal3 33120 40 0.12% 0 / 0 / 0
metal4 15698 0 0.00% 0 / 0 / 0
metal5 15404 0 0.00% 0 / 0 / 0
metal6 15642 0 0.00% 0 / 0 / 0
metal7 4416 0 0.00% 0 / 0 / 0
metal8 4512 0 0.00% 0 / 0 / 0
metal9 2208 0 0.00% 0 / 0 / 0
metal10 2256 0 0.00% 0 / 0 / 0
---------------------------------------------------------------------------------------
Total 149119 3343 2.24% 0 / 0 / 0
[INFO GRT-0018] Total wirelength: 10598 um
[INFO GRT-0014] Routed nets: 563
```
View the resulting global routing in GUI as follows:
### Detail Routing
TritonRoute is an open-source detailed router for modern industrial designs.
The router consists of several main building blocks, including pin access
analysis, track assignment, initial detailed routing, search and repair, and a DRC engine.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/drt/test/gcd_nangate45.tcl).
Launch OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/drt/test/
openroad -gui
```
To run the detail routing, run the following commands in `Tcl Commands` of
GUI:
```tcl
read_lef Nangate45/Nangate45_tech.lef
read_lef Nangate45/Nangate45_stdcell.lef
read_def gcd_nangate45_preroute.def
read_guides gcd_nangate45.route_guide
set_thread_count [expr [exec getconf _NPROCESSORS_ONLN] / 4]
detailed_route -output_drc results/gcd_nangate45.output.drc.rpt \
-output_maze results/gcd_nangate45.output.maze.log \
-verbose 1
write_db gcd_nangate45.odb
```
For successful routing, DRT will end with 0 violations.
Log as follows:
```
[INFO DRT-0199] Number of violations = 0.
[INFO DRT-0267] cpu time = 00:00:00, elapsed time = 00:00:00, memory = 674.22 (MB), peak = 686.08 (MB)
Total wire length = 5680 um.
Total wire length on LAYER metal1 = 19 um.
Total wire length on LAYER metal2 = 2798 um.
Total wire length on LAYER metal3 = 2614 um.
Total wire length on LAYER metal4 = 116 um.
Total wire length on LAYER metal5 = 63 um.
Total wire length on LAYER metal6 = 36 um.
Total wire length on LAYER metal7 = 32 um.
Total wire length on LAYER metal8 = 0 um.
Total wire length on LAYER metal9 = 0 um.
Total wire length on LAYER metal10 = 0 um.
Total number of vias = 2223.
Up-via summary (total 2223):.
---------------
active 0
metal1 1151
metal2 1037
metal3 22
metal4 7
metal5 4
metal6 2
metal7 0
metal8 0
metal9 0
---------------
2223
[INFO DRT-0198] Complete detail routing.
```
View the resulting detail routing in GUI as follows:
### Antenna Checker
Antenna Violation occurs when the antenna ratio exceeds a value specified
in a Process Design Kit (PDK). The antenna ratio is the ratio of the gate
area to the gate oxide area. The amount of charge collection is determined
by the area/size of the conductor (gate area).
This tool checks antenna violations and generates a report to indicate violated nets.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/ant/test/ant_check.tcl).
Launch OpenROAD by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/ant/test/
openroad
```
To extract antenna violations, run the following commands:
```tcl
read_lef ant_check.lef
read_def ant_check.def
check_antennas -verbose
puts "violation count = [ant::antenna_violation_count]"
# check if net50 has a violation
set net "net50"
puts "Net $net violations: [ant::check_net_violation $net]"
```
The log as follows:
```
[INFO ANT-0002] Found 1 net violations.
[INFO ANT-0001] Found 2 pin violations.
violation count = 1
Net net50 violations: 1
```
### Metal Fill
Metal fill is a mandatory step at advanced nodes to ensure manufacturability
and high yield. It involves filling the empty or white spaces near the
design with metal polygons to ensure regular planarization of the wafer.
This module inserts floating metal fill shapes to meet metal density
design rules while obeying DRC constraints. It is driven by a json
configuration file.
Command used as follows:
```tcl
density_fill -rules <json_file> [-area <list of lx ly ux uy>]
```
If -area is not specified, the core area will be used.
To run metal fill post route, run the following:
```shell
cd flow/tutorials/scripts/metal_fill
openroad -gui
source "helpers.tcl"
read_db ./5_route.odb
```
Layout before adding metal fill is as follows:
To add metal fill, run the command:
```tcl
density_fill -rules ../../../platforms/sky130hd/fill.json
```
Layout after adding metal fill insertion is as follows:
Metal fill view can enabled with `Misc` and enable `Fills` check box.
### Parasitics Extraction
OpenRCX is a Parasitic Extraction (PEX, or RCX) tool that works on OpenDB design APIs.
It extracts routed designs based on the LEF/DEF layout model.
OpenRCX stores resistance, coupling capacitance and ground (i.e., grounded) capacitance
on OpenDB objects with direct pointers to the associated wire and via db
objects. Optionally, OpenRCX can generate a `.spef` file.
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/rcx/test/45_gcd.tcl).
Launch OpenROAD tool by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/rcx/test/
openroad
```
To run parasitics for gcd design:
```tcl
source 45_gcd.tcl
```
The log as follows:
```
[INFO ODB-0222] Reading LEF file: Nangate45/Nangate45.lef
[INFO ODB-0223] Created 22 technology layers
[INFO ODB-0224] Created 27 technology vias
[INFO ODB-0225] Created 135 library cells
[INFO ODB-0226] Finished LEF file: Nangate45/Nangate45.lef
[INFO ODB-0127] Reading DEF file: 45_gcd.def
[INFO ODB-0128] Design: gcd
[INFO ODB-0130] Created 54 pins.
[INFO ODB-0131] Created 1820 components and 4618 component-terminals.
[INFO ODB-0132] Created 2 special nets and 3640 connections.
[INFO ODB-0133] Created 350 nets and 978 connections.
[INFO ODB-0134] Finished DEF file: 45_gcd.def
[INFO RCX-0431] Defined process_corner X with ext_model_index 0
[INFO RCX-0029] Defined extraction corner X
[INFO RCX-0008] extracting parasitics of gcd ...
[INFO RCX-0435] Reading extraction model file 45_patterns.rules ...
[INFO RCX-0436] RC segment generation gcd (max_merge_res 0.0) ...
[INFO RCX-0040] Final 2656 rc segments
[INFO RCX-0439] Coupling Cap extraction gcd ...
[INFO RCX-0440] Coupling threshhold is 0.1000 fF, coupling capacitance less than 0.1000 fF will be grounded.
[INFO RCX-0043] 1954 wires to be extracted
[INFO RCX-0442] 48% completion -- 954 wires have been extracted
[INFO RCX-0442] 100% completion -- 1954 wires have been extracted
[INFO RCX-0045] Extract 350 nets, 2972 rsegs, 2972 caps, 2876 ccs
[INFO RCX-0015] Finished extracting gcd.
[INFO RCX-0016] Writing SPEF ...
[INFO RCX-0443] 350 nets finished
[INFO RCX-0017] Finished writing SPEF ...
```
`45_gcd.spef` viewed in `results` directory.
## Troubleshooting Problems
This section shows you how to troubleshoot commonly occurring problems
with the flow or any of the underlying application tools.
### Debugging Problems in Global Routing
The global router has a few useful functionalities to understand
high congestion issues in the designs.
Congestion heatmap can be used on any design, whether it has
congestion or not. Viewing congestion explained [here](content:heat:maps).
If the design has congestion issue, it ends with the error;
```
[ERROR GRT-0118] Routing congestion too high.
```
Refer to the built-in example [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/src/grt/test/congestion5.tcl).
Launch OpenROAD GUI by running the following command(s) in the terminal in OpenROAD tool root directory:
```shell
cd ../tools/OpenROAD/src/grt/test/
openroad -gui
```
To run the global routing, run the following commands in `Tcl Commands` of
GUI:
```tcl
source congestion5.tcl
```
The design fail with routing congestion error as follows:
In the GUI, you can go under `Heat Maps` and mark the
`Routing Congestion` checkbox to visualize the congestion map.
#### Dump congestion information to a text file
You can create a text file with the congestion information of the
GCells for further investigation on the GUI. To do that, add the
`-congestion_report_file file_name` to the `global_route` command, as shown below:
```tcl
global_route -guide_file out.guide -congestion_report_file congest.rpt
```
#### Visualization of overflowing GCells as markers
With the file created with the command described above, you can see more
details about the congested GCell, like the total resources, utilization,
location, etc. You can load the file following these steps:
- step 1: In the `DRC Viewer` window, click on `Load` and select the
file with the congestion report.
- step 2: A summary of the GCells with congestion is shown in the
`DRC Viewer` window. Also, the markers are added to the GUI.
- step 3: For details on the routing resources information, use the `Inspector` window.
By Clicking `zoom_to` options, you can enlarge the view as follows:
|