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
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
|
<html lang="en">
<head>
<title>GHDL guide</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GHDL guide">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">GHDL guide</h1>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">GHDL guide</a>
<li><a name="toc_Introduction" href="#Introduction">1 Introduction</a>
<ul>
<li><a href="#Introduction">1.1 Content of this manual</a>
<li><a href="#What-is-VHDL">1.2 What is <code>VHDL</code>?</a>
<li><a href="#What-is-GHDL">1.3 What is <code>GHDL</code>?</a>
</li></ul>
<li><a name="toc_Starting-with-GHDL" href="#Starting-with-GHDL">2 Starting with GHDL</a>
<ul>
<li><a href="#The-hello-word-program">2.1 The hello world program</a>
<li><a href="#A-full-adder">2.2 A full adder</a>
<li><a href="#Starting-with-a-design">2.3 Starting with a design</a>
</li></ul>
<li><a name="toc_Invoking-GHDL" href="#Invoking-GHDL">3 Invoking GHDL</a>
<ul>
<li><a href="#Building-commands">3.1 Building commands</a>
<ul>
<li><a href="#Analysis-command">3.1.1 Analysis command</a>
<li><a href="#Elaboration-command">3.1.2 Elaboration command</a>
<li><a href="#Run-command">3.1.3 Run command</a>
<li><a href="#Elaborate-and-run-command">3.1.4 Elaborate and run command</a>
<li><a href="#Bind-command">3.1.5 Bind command</a>
<li><a href="#Link-command">3.1.6 Link command</a>
<li><a href="#List-link-command">3.1.7 List link command</a>
<li><a href="#Check-syntax-command">3.1.8 Check syntax command</a>
<li><a href="#Analyze-and-elaborate-command">3.1.9 Analyze and elaborate command</a>
</li></ul>
<li><a href="#GHDL-options">3.2 GHDL options</a>
<li><a href="#Passing-options-to-other-programs">3.3 Passing options to other programs</a>
<li><a href="#GHDL-warnings">3.4 GHDL warnings</a>
<li><a href="#Rebuilding-commands">3.5 Rebuilding commands</a>
<ul>
<li><a href="#Import-command">3.5.1 Import command</a>
<li><a href="#Make-command">3.5.2 Make command</a>
<li><a href="#Generate-Makefile-command">3.5.3 Generate Makefile command</a>
</li></ul>
<li><a href="#Library-commands">3.6 Library commands</a>
<ul>
<li><a href="#Directory-command">3.6.1 Directory command</a>
<li><a href="#Clean-command">3.6.2 Clean command</a>
<li><a href="#Remove-command">3.6.3 Remove command</a>
</li></ul>
<li><a href="#Cross_002dreference-command">3.7 Cross-reference command</a>
<li><a href="#File-commands">3.8 File commands</a>
<ul>
<li><a href="#Pretty-print-command">3.8.1 Pretty print command</a>
<li><a href="#Find-command">3.8.2 Find command</a>
<li><a href="#Chop-command">3.8.3 Chop command</a>
<li><a href="#Lines-command">3.8.4 Lines command</a>
</li></ul>
<li><a href="#Misc-commands">3.9 Misc commands</a>
<ul>
<li><a href="#Help-command">3.9.1 Help command</a>
<li><a href="#Dispconfig-command">3.9.2 Dispconfig command</a>
<li><a href="#Disp-standard-command">3.9.3 Disp standard command</a>
<li><a href="#Version-command">3.9.4 Version command</a>
</li></ul>
<li><a href="#Installation-Directory">3.10 Installation Directory</a>
<li><a href="#IEEE-library-pitfalls">3.11 IEEE library pitfalls</a>
</li></ul>
<li><a name="toc_Simulation-and-run-time" href="#Simulation-and-run-time">4 Simulation and run time</a>
<ul>
<li><a href="#Simulation-options">4.1 Simulation options</a>
<li><a href="#Debugging-VHDL-programs">4.2 Debugging VHDL programs</a>
</li></ul>
<li><a name="toc_GHDL-implementation-of-VHDL" href="#GHDL-implementation-of-VHDL">5 GHDL implementation of VHDL</a>
<ul>
<li><a href="#VHDL-standards">5.1 VHDL standards</a>
<li><a href="#Source-representation">5.2 Source representation</a>
<li><a href="#Library-database">5.3 Library database</a>
<li><a href="#VHDL-files-format">5.4 VHDL files format</a>
<li><a href="#Top-entity">5.5 Top entity</a>
<li><a href="#Using-vendor-libraries">5.6 Using vendor libraries</a>
<li><a href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">5.7 Using ieee.math_real or ieee.math_complex</a>
<li><a href="#Interfacing-to-other-languages">5.8 Interfacing to other languages</a>
<ul>
<li><a href="#Interfacing-to-other-languages">5.8.1 Foreign declarations</a>
<li><a href="#Restrictions-on-foreign-declarations">5.8.2 Restrictions on foreign declarations</a>
<li><a href="#Linking-with-foreign-object-files">5.8.3 Linking with foreign object files</a>
<li><a href="#Starting-a-simulation-from-a-foreign-program">5.8.4 Starting a simulation from a foreign program</a>
<li><a href="#Linking-with-Ada">5.8.5 Linking with Ada</a>
<li><a href="#Using-GRT-from-Ada">5.8.6 Using GRT from Ada</a>
</li></ul>
</li></ul>
<li><a name="toc_GHDL-implementation-of-VITAL" href="#GHDL-implementation-of-VITAL">6 GHDL implementation of VITAL</a>
<ul>
<li><a href="#VITAL-packages">6.1 VITAL packages</a>
<li><a href="#VHDL-restrictions-for-VITAL">6.2 VHDL restrictions for VITAL</a>
<li><a href="#Backannotation">6.3 Backannotation</a>
<li><a href="#Negative-constraint-calculation">6.4 Negative constraint calculation</a>
</li></ul>
<li><a name="toc_Flaws-and-bugs-report" href="#Flaws-and-bugs-report">7 Flaws and bugs report</a>
<ul>
<li><a href="#Deficiencies">7.1 Deficiencies</a>
<li><a href="#Reporting-bugs">7.2 Reporting bugs</a>
<li><a href="#Future-improvements">7.3 Future improvements</a>
</li></ul>
<li><a name="toc_Copyrights" href="#Copyrights">8 Copyrights</a>
<li><a name="toc_Index" href="#Index">Index</a>
</li></ul>
</div>
<div class="node">
<p><hr>
<a name="Top"></a>
Next: <a rel="next" accesskey="n" href="#Introduction">Introduction</a>,
Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">GHDL guide</h2>
<p>GHDL, a VHDL compiler.
<p>Copyright © 2002, 2003, 2004, 2005, 2006, 2007 Tristan Gingold.
<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation.
<ul class="menu">
<li><a accesskey="1" href="#Introduction">Introduction</a>: What is GHDL, what is VHDL
<li><a accesskey="2" href="#Starting-with-GHDL">Starting with GHDL</a>: Build a VHDL program with GHDL
<li><a accesskey="3" href="#Invoking-GHDL">Invoking GHDL</a>
<li><a accesskey="4" href="#Simulation-and-run-time">Simulation and run time</a>
<li><a accesskey="5" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
<li><a accesskey="6" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>
<li><a accesskey="7" href="#Flaws-and-bugs-report">Flaws and bugs report</a>
<li><a accesskey="8" href="#Copyrights">Copyrights</a>
<li><a accesskey="9" href="#Index">Index</a>
</ul>
<div class="node">
<p><hr>
<a name="Introduction"></a>
Next: <a rel="next" accesskey="n" href="#Starting-with-GHDL">Starting with GHDL</a>,
Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">1 Introduction</h2>
<ul class="menu">
<li><a accesskey="1" href="#What-is-VHDL">What is VHDL</a>
<li><a accesskey="2" href="#What-is-GHDL">What is GHDL</a>
</ul>
<h3 class="section">1.1 Content of this manual</h3>
<p>This manual is the user and reference manual for GHDL. It does not
contain an introduction to VHDL. Thus, the reader should have at least
a basic knowledge of VHDL. A good knowledge of VHDL language reference
manual (usually called LRM) is a plus.
<!-- FIXME: references: URL, LRM reference. -->
<div class="node">
<p><hr>
<a name="What-is-VHDL"></a>
Next: <a rel="next" accesskey="n" href="#What-is-GHDL">What is GHDL</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>,
Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">1.2 What is <code>VHDL</code>?</h3>
<p><dfn>VHDL</dfn> is an acronym for Very High Speed Integrated Circuit Hardware
Description Language which is a programming language used to describe a
logic circuit by function, data flow behaviour, or structure.
<p><code>VHDL</code> <em>is</em> a programming language: although <code>VHDL</code> was
not designed for writing general purpose programs, you can write any
algorithm with the <code>VHDL</code> language. If you are able to write
programs, you will find in <code>VHDL</code> features similar to those found
in procedural languages such as <code>C</code>, <code>Pascal</code> or <code>Ada</code>.
<code>VHDL</code> derives most of its syntax and semantics from <code>Ada</code>.
Knowing <code>Ada</code> is an advantage for learning <code>VHDL</code> (it is an
advantage in general as well).
<p>However, <code>VHDL</code> was not designed as a general purpose language but as an
<code>HDL</code> (hardware description language). As the name implies, <code>VHDL</code>
aims at modeling or documenting electronics systems. Due to the nature
of hardware components which are always running, <code>VHDL</code> is a highly
concurrent language, built upon an event-based timing model.
<p>Like a program written in any other language, a <code>VHDL</code> program
can be executed. Since <code>VHDL</code> is used to model designs, the term
<dfn>simulation</dfn> is often used instead of <dfn>execution</dfn>, with the
same meaning.
<p>Like a program written in another hardware description language, a
<code>VHDL</code> program can be transformed with a <code>synthesis tool</code>
into a netlist, that is, a detailed gate-level implementation.
<div class="node">
<p><hr>
<a name="What-is-GHDL"></a>
Previous: <a rel="previous" accesskey="p" href="#What-is-VHDL">What is VHDL</a>,
Up: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">1.3 What is <code>GHDL</code>?</h3>
<p><dfn>GHDL</dfn> is a shorthand for G Hardware Design Language. Currently,
<code>G</code> has no meaning.
<p><dfn>GHDL</dfn> is a <code>VHDL</code> compiler that can execute (nearly) any
<code>VHDL</code> program. <code>GHDL</code> is <em>not</em> a synthesis tool: you cannot
create a netlist with <code>GHDL</code>.
<p>Unlike some other simulators, <code>GHDL</code> is a compiler: it directly
translates a <code>VHDL</code> file to machine code, using the <code>GCC</code>
back-end and without using an intermediary language such as <code>C</code>
or <code>C++</code>. Therefore, the compiled code should be faster and
the analysis time should be shorter than with a compiler using an
intermediary language.
<p>The Windows(TM) version of <code>GHDL</code> is not based on <code>GCC</code> but on
an internal code generator.
<p>The current version of <code>GHDL</code> does not contain any graphical
viewer: you cannot see signal waves. You can still check with a test
bench. The current version can produce a <code>VCD</code> file which can be
viewed with a wave viewer, as well as <code>ghw</code> files to be viewed by
`<samp><span class="samp">gtkwave</span></samp>'.
<p><code>GHDL</code> aims at implementing <code>VHDL</code> as defined by IEEE 1076.
It supports most of the 1987 standard and most features added by the
1993 standard.
<div class="node">
<p><hr>
<a name="Starting-with-GHDL"></a>
Next: <a rel="next" accesskey="n" href="#Invoking-GHDL">Invoking GHDL</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">2 Starting with GHDL</h2>
<p>In this chapter, you will learn how to use the GHDL compiler by
working on two examples.
<ul class="menu">
<li><a accesskey="1" href="#The-hello-word-program">The hello word program</a>
<li><a accesskey="2" href="#A-full-adder">A full adder</a>
<li><a accesskey="3" href="#Starting-with-a-design">Starting with a design</a>
</ul>
<div class="node">
<p><hr>
<a name="The-hello-word-program"></a>
Next: <a rel="next" accesskey="n" href="#A-full-adder">A full adder</a>,
Previous: <a rel="previous" accesskey="p" href="#Starting-with-GHDL">Starting with GHDL</a>,
Up: <a rel="up" accesskey="u" href="#Starting-with-GHDL">Starting with GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.1 The hello world program</h3>
<p>To illustrate the large purpose of VHDL, here is a commented VHDL
"Hello world" program.
<pre class="example"> -- <span class="roman">Hello world program.</span>
use std.textio.all; -- <span class="roman">Imports the standard textio package.</span>
-- <span class="roman">Defines a design entity, without any ports.</span>
entity hello_world is
end hello_world;
architecture behaviour of hello_world is
begin
process
variable l : line;
begin
write (l, String'("Hello world!"));
writeline (output, l);
wait;
end process;
end behaviour;
</pre>
<p>Suppose this program is contained in the file <samp><span class="file">hello.vhdl</span></samp>.
First, you have to compile the file; this is called <dfn>analysis</dfn> of a design
file in VHDL terms.
<pre class="smallexample"> $ ghdl -a hello.vhdl
</pre>
<p>This command creates or updates a file <samp><span class="file">work-obj93.cf</span></samp>, which
describes the library `<samp><span class="samp">work</span></samp>'. On GNU/Linux, this command generates a
file <samp><span class="file">hello.o</span></samp>, which is the object file corresponding to your
VHDL program. The object file is not created on Windows.
<p>Then, you have to build an executable file.
<pre class="smallexample"> $ ghdl -e hello_world
</pre>
<p>The `<samp><span class="samp">-e</span></samp>' option means <dfn>elaborate</dfn>. With this option, <code>GHDL</code>
creates code in order to elaborate a design, with the `<samp><span class="samp">hello</span></samp>'
entity at the top of the hierarchy.
<p>On GNU/Linux, the result is an executable program called <samp><span class="file">hello</span></samp>
which can be run:
<pre class="smallexample"> $ ghdl -r hello_world
</pre>
<p>or directly:
<pre class="smallexample"> $ ./hello_world
</pre>
<p>On Windows, no file is created. The simulation is launched using this command:
<pre class="smallexample"> > ghdl -r hello_world
</pre>
<p>The result of the simulation appears on the screen:
<pre class="smallexample"> Hello world!
</pre>
<div class="node">
<p><hr>
<a name="A-full-adder"></a>
Next: <a rel="next" accesskey="n" href="#Starting-with-a-design">Starting with a design</a>,
Previous: <a rel="previous" accesskey="p" href="#The-hello-word-program">The hello word program</a>,
Up: <a rel="up" accesskey="u" href="#Starting-with-GHDL">Starting with GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.2 A full adder</h3>
<p>VHDL is generally used for hardware design. This example starts with
a full adder described in the <samp><span class="file">adder.vhdl</span></samp> file:
<pre class="example"> entity adder is
-- <var>i0</var><span class="roman">, </span><var>i1</var><span class="roman"> and the carry-in </span><var>ci</var><span class="roman"> are inputs of the adder.</span>
-- <var>s</var><span class="roman"> is the sum output, </span><var>co</var><span class="roman"> is the carry-out.</span>
port (i0, i1 : in bit; ci : in bit; s : out bit; co : out bit);
end adder;
architecture rtl of adder is
begin
-- <span class="roman">This full-adder architecture contains two concurrent assignment.</span>
-- <span class="roman">Compute the sum.</span>
s <= i0 xor i1 xor ci;
-- <span class="roman">Compute the carry.</span>
co <= (i0 and i1) or (i0 and ci) or (i1 and ci);
end rtl;
</pre>
<p>You can analyze this design file:
<pre class="smallexample"> $ ghdl -a adder.vhdl
</pre>
<p>You can try to execute the `<samp><span class="samp">adder</span></samp>' design, but this is useless,
since nothing externally visible will happen. In order to
check this full adder, a testbench has to be run. This testbench is
very simple, since the adder is also simple: it checks exhaustively all
inputs. Note that only the behaviour is tested, timing constraints are
not checked. The file <samp><span class="file">adder_tb.vhdl</span></samp> contains the testbench for
the adder:
<pre class="example"> -- <span class="roman">A testbench has no ports.</span>
entity adder_tb is
end adder_tb;
architecture behav of adder_tb is
-- <span class="roman">Declaration of the component that will be instantiated.</span>
component adder
port (i0, i1 : in bit; ci : in bit; s : out bit; co : out bit);
end component;
-- <span class="roman">Specifies which entity is bound with the component.</span>
for adder_0: adder use entity work.adder;
signal i0, i1, ci, s, co : bit;
begin
-- <span class="roman">Component instantiation.</span>
adder_0: adder port map (i0 => i0, i1 => i1, ci => ci,
s => s, co => co);
-- <span class="roman">This process does the real job.</span>
process
type pattern_type is record
-- <span class="roman">The inputs of the adder.</span>
i0, i1, ci : bit;
-- <span class="roman">The expected outputs of the adder.</span>
s, co : bit;
end record;
-- <span class="roman">The patterns to apply.</span>
type pattern_array is array (natural range <>) of pattern_type;
constant patterns : pattern_array :=
(('0', '0', '0', '0', '0'),
('0', '0', '1', '1', '0'),
('0', '1', '0', '1', '0'),
('0', '1', '1', '0', '1'),
('1', '0', '0', '1', '0'),
('1', '0', '1', '0', '1'),
('1', '1', '0', '0', '1'),
('1', '1', '1', '1', '1'));
begin
-- <span class="roman">Check each pattern.</span>
for i in patterns'range loop
-- <span class="roman">Set the inputs.</span>
i0 <= patterns(i).i0;
i1 <= patterns(i).i1;
ci <= patterns(i).ci;
-- <span class="roman">Wait for the results.</span>
wait for 1 ns;
-- <span class="roman">Check the outputs.</span>
assert s = patterns(i).s
report "bad sum value" severity error;
assert co = patterns(i).co
report "bad carray out value" severity error;
end loop;
assert false report "end of test" severity note;
-- <span class="roman">Wait forever; this will finish the simulation.</span>
wait;
end process;
end behav;
</pre>
<p>As usual, you should analyze the design:
<pre class="smallexample"> $ ghdl -a adder_tb.vhdl
</pre>
<p>And build an executable for the testbench:
<pre class="smallexample"> $ ghdl -e adder_tb
</pre>
<p>You do not need to specify which object files are required: GHDL knows them
and automatically adds them in the executable. Now, it is time to run the
testbench:
<pre class="smallexample"> $ ghdl -r adder_tb
adder_tb.vhdl:52:7:(assertion note): end of test
</pre>
<p>If your design is rather complex, you'd like to inspect signals. Signals
value can be dumped using the VCD file format. The resulting file can be
read with a wave viewer such as GTKWave. First, you should simulate your
design and dump a waveform file:
<pre class="smallexample"> $ ghdl -r adder_tb --vcd=adder.vcd
</pre>
<p>Then, you may now view the waves:
<pre class="smallexample"> $ gtkwave adder.vcd
</pre>
<p>See <a href="#Simulation-options">Simulation options</a>, for more details on the <samp><span class="option">--vcd</span></samp> option and
other run time options.
<div class="node">
<p><hr>
<a name="Starting-with-a-design"></a>
Previous: <a rel="previous" accesskey="p" href="#A-full-adder">A full adder</a>,
Up: <a rel="up" accesskey="u" href="#Starting-with-GHDL">Starting with GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.3 Starting with a design</h3>
<p>Unless you are only studying VHDL, you will work with bigger designs than
the ones of the previous examples.
<p>Let's see how to analyze and run a bigger design, such as the DLX model
suite written by Peter Ashenden which is distributed under the terms of the
GNU General Public License. A copy is kept on
<<code>http://ghdl.free.fr/dlx.tar.gz</code>>
<p>First, untar the sources:
<pre class="smallexample"> $ tar zxvf dlx.tar.gz
</pre>
<p>In order not to pollute the sources with the library, it is a good idea
to create a <samp><span class="file">work/</span></samp> subdirectory for the `<samp><span class="samp">WORK</span></samp>' library. To
any GHDL commands, we will add the <samp><span class="option">--workdir=work</span></samp> option, so
that all files generated by the compiler (except the executable) will be
placed in this directory.
<pre class="smallexample"> $ cd dlx
$ mkdir work
</pre>
<p>We will run the `<samp><span class="samp">dlx_test_behaviour</span></samp>' design. We need to analyze
all the design units for the design hierarchy, in the correct order.
GHDL provides an easy way to do this, by importing the sources:
<pre class="smallexample"> $ ghdl -i --workdir=work *.vhdl
</pre>
<p>and making a design:
<pre class="smallexample"> $ ghdl -m --workdir=work dlx_test_behaviour
</pre>
<p>Before this second stage, GHDL knows all the design units of the DLX,
but no one have been analyzed. The make command of GHDL analyzes and
elaborates a design. This creates many files in the <samp><span class="file">work/</span></samp>
directory, and the <samp><span class="file">dlx_test_behaviour</span></samp> executable in the current
directory.
<p>The simulation needs to have a DLX program contained in the file
<samp><span class="file">dlx.out</span></samp>. This memory image will be be loaded in the DLX memory.
Just take one sample:
<pre class="smallexample"> $ cp test_loop.out dlx.out
</pre>
<p>And you can run the test suite:
<pre class="smallexample"> $ ghdl -r dlx_test_behaviour
</pre>
<p>The test bench monitors the bus and displays each instruction executed.
It finishes with an assertion of severity level note:
<pre class="smallexample"> dlx-behaviour.vhdl:395:11:(assertion note): TRAP instruction
encountered, execution halted
</pre>
<p>Since the clock is still running, you have to manually stop the program
with the <kbd>C-c</kbd> key sequence. This behavior prevents you from running the
test bench in batch mode. However, you may force the simulator to
stop when an assertion above or equal a certain severity level occurs:
<pre class="smallexample"> $ ghdl -r dlx_test_behaviour --assert-level=note
</pre>
<p>With this option, the program stops just after the previous message:
<pre class="smallexample"> dlx-behaviour.vhdl:395:11:(assertion note): TRAP instruction
encountered, execution halted
error: assertion failed
</pre>
<p>If you want to make room on your hard drive, you can either:
<ul>
<li>clean the design library with the GHDL command:
<pre class="smallexample"> $ ghdl --clean --workdir=work
</pre>
<p>This removes the executable and all the object files. If you want to
rebuild the design at this point, just do the make command as shown above.
<li>remove the design library with the GHDL command:
<pre class="smallexample"> $ ghdl --remove --workdir=work
</pre>
<p>This removes the executable, all the object files and the library file.
If you want to rebuild the design, you have to import the sources again,
and to make the design.
<li>remove the <samp><span class="file">work/</span></samp> directory:
<pre class="smallexample"> $ rm -rf work
</pre>
<p>Only the executable is kept. If you want to rebuild the design, create
the <samp><span class="file">work/</span></samp> directory, import the sources, and make the design.
</ul>
<p>Sometimes, a design does not fully follow the VHDL standards. For example it
uses the badly engineered `<samp><span class="samp">std_logic_unsigned</span></samp>' package. GHDL supports
this VHDL dialect through some options:
<pre class="smallexample"> --ieee=synopsys -fexplicit
</pre>
<p>See <a href="#IEEE-library-pitfalls">IEEE library pitfalls</a>, for more details.
<div class="node">
<p><hr>
<a name="Invoking-GHDL"></a>
Next: <a rel="next" accesskey="n" href="#Simulation-and-run-time">Simulation and run time</a>,
Previous: <a rel="previous" accesskey="p" href="#Starting-with-GHDL">Starting with GHDL</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">3 Invoking GHDL</h2>
<p>The form of the <code>ghdl</code> command is
<pre class="smallexample"> $ ghdl <var>command</var> [<var>options<small class="dots">...</small></var>]
</pre>
<p>The GHDL program has several commands. The first argument selects
the commands. The options are used to slighly modify the action.
<p>No options are allowed before the command. Except for the run commands,
no options are allowed after a filename or a unit name.
<ul class="menu">
<li><a accesskey="1" href="#Building-commands">Building commands</a>
<li><a accesskey="2" href="#GHDL-options">GHDL options</a>
<li><a accesskey="3" href="#Passing-options-to-other-programs">Passing options to other programs</a>
<li><a accesskey="4" href="#GHDL-warnings">GHDL warnings</a>
<li><a accesskey="5" href="#Rebuilding-commands">Rebuilding commands</a>
<li><a accesskey="6" href="#Library-commands">Library commands</a>
<li><a accesskey="7" href="#Cross_002dreference-command">Cross-reference command</a>
<li><a accesskey="8" href="#File-commands">File commands</a>
<li><a accesskey="9" href="#Misc-commands">Misc commands</a>
<li><a href="#Installation-Directory">Installation Directory</a>
<li><a href="#IEEE-library-pitfalls">IEEE library pitfalls</a>
</ul>
<div class="node">
<p><hr>
<a name="Building-commands"></a>
Next: <a rel="next" accesskey="n" href="#GHDL-options">GHDL options</a>,
Previous: <a rel="previous" accesskey="p" href="#Invoking-GHDL">Invoking GHDL</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.1 Building commands</h3>
<p>The mostly used commands of GHDL are those to analyze and elaborate a design.
<ul class="menu">
<li><a accesskey="1" href="#Analysis-command">Analysis command</a>
<li><a accesskey="2" href="#Elaboration-command">Elaboration command</a>
<li><a accesskey="3" href="#Run-command">Run command</a>
<li><a accesskey="4" href="#Elaborate-and-run-command">Elaborate and run command</a>
<li><a accesskey="5" href="#Bind-command">Bind command</a>
<li><a accesskey="6" href="#Link-command">Link command</a>
<li><a accesskey="7" href="#List-link-command">List link command</a>
<li><a accesskey="8" href="#Check-syntax-command">Check syntax command</a>
<li><a accesskey="9" href="#Analyze-and-elaborate-command">Analyze and elaborate command</a>
</ul>
<div class="node">
<p><hr>
<a name="Analysis-command"></a>
Next: <a rel="next" accesskey="n" href="#Elaboration-command">Elaboration command</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-commands">Building commands</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.1.1 Analysis command</h4>
<p><a name="index-analysis-1"></a><a name="index-g_t_0040option_007b_002da_007d-command-2"></a>
<pre class="smallexample"> $ ghdl -a [<var>options</var>] <var>files</var>
</pre>
<p>The <dfn>analysis</dfn> command compiles one or more files, and creates an
object file for each source file. The analysis command is selected with
<var>-a</var> switch. Any argument starting with a dash is a option, the
others are filenames. No options are allowed after a filename
argument. GHDL analyzes each filename in the given order, and stops the
analysis in case of error (the following files are not analyzed).
<!-- FIXME: check this. -->
<p>See <a href="#GHDL-options">GHDL options</a>, for details on the GHDL options. For example,
to produce debugging information such as line numbers, use:
<pre class="smallexample"> $ ghdl -a -g my_design.vhdl
</pre>
<div class="node">
<p><hr>
<a name="Elaboration-command"></a>
Next: <a rel="next" accesskey="n" href="#Run-command">Run command</a>,
Previous: <a rel="previous" accesskey="p" href="#Analysis-command">Analysis command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.1.2 Elaboration command</h4>
<p><a name="index-elaboration-3"></a><a name="index-g_t_0040option_007b_002de_007d-command-4"></a>
<pre class="smallexample"> $ ghdl -e [<var>options</var>] <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>On GNU/Linux the <dfn>elaboration</dfn> command creates an executable
containing the code of the <code>VHDL</code> sources, the elaboration code
and simulation code to execute a design hiearachy. On Windows this
command elaborates the design but does not generate anything.
<p>The elaboration command is selected with <var>-e</var> switch, and must be
followed by either:
<ul>
<li>a name of a configuration unit
<li>a name of an entity unit
<li>a name of an entity unit followed by a name of an architecture unit
</ul>
<p>Name of the units must be a simple name, without any dot. You can
select the name of the `<samp><span class="samp">WORK</span></samp>' library with the <samp><span class="option">--work=NAME</span></samp>
option, as described in <a href="#GHDL-options">GHDL options</a>.
<p>See <a href="#Top-entity">Top entity</a>, for the restrictions on the root design of a
hierarchy.
<p>On GNU/Linux the file name of the executable is the name of the
primary unit, or for the later case, the concatenation of the name of
the primary unit, a dash, and the name of the secondary unit (or
architecture). On Windows there is no executable generated.
<p>The <samp><span class="option">-o</span></samp> followed by a file name can override the default
executable file name.
<p>For the elaboration command, <code>GHDL</code> re-analyzes all the
configurations, entities, architectures and package declarations, and
creates the default configurations and the default binding indications
according to the LRM rules. It also generates the list of objects files
required for the executable. Then, it links all these files with the
run time library.
<p>The actual elaboration is performed at run-time.
<p>On Windows this command can be skipped because it is also done by the
run command.
<div class="node">
<p><hr>
<a name="Run-command"></a>
Next: <a rel="next" accesskey="n" href="#Elaborate-and-run-command">Elaborate and run command</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-command">Elaboration command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.1.3 Run command</h4>
<p><a name="index-run-5"></a><a name="index-g_t_0040option_007b_002dr_007d-command-6"></a>Run (or simulate) a design.
<pre class="smallexample"> $ ghdl -r [<var>options</var>] <var>primary_unit</var> [<var>secondary_unit</var>] [<var>simulation_options</var>]
</pre>
<p>The options and arguments are the same as the See <a href="#Elaboration-command">Elaboration command</a>.
<p>On GNU/Linux this command simply build the filename of the executable
and execute it. Options are ignored. You may also directly execute
the program.
<p>This command exists for three reasons:
<ul>
<li>You don't have to create the executable program name.
<li>It is coherent with the `<samp><span class="samp">-a</span></samp>' and `<samp><span class="samp">-e</span></samp>' commands.
<li>It works with the Windows implementation, where the code is generated in
memory.
</ul>
<p>On Windows this command elaborate and launch the simulation. As a consequence
you must use the same options used during analysis.
<p>See <a href="#Simulation-and-run-time">Simulation and run time</a>, for details on options.
<div class="node">
<p><hr>
<a name="Elaborate-and-run-command"></a>
Next: <a rel="next" accesskey="n" href="#Bind-command">Bind command</a>,
Previous: <a rel="previous" accesskey="p" href="#Run-command">Run command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.1.4 Elaborate and run command</h4>
<p><a name="index-elaborate-and-run-7"></a><a name="index-g_t_0040option_007b_002d_002delab_002drun_007d-command-8"></a>Elaborate and then simulate a design unit.
<pre class="smallexample"> $ ghdl --elab-run [<var>elab_options</var>] <var>primary_unit</var> [<var>secondary_unit</var>] [<var>run_options</var>]
</pre>
<p>This command acts like the elaboration command (see <a href="#Elaboration-command">Elaboration command</a>)
followed by the run command (see <a href="#Run-command">Run command</a>).
<div class="node">
<p><hr>
<a name="Bind-command"></a>
Next: <a rel="next" accesskey="n" href="#Link-command">Link command</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaborate-and-run-command">Elaborate and run command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<h4 class="subsection">3.1.5 Bind command</h4>
<p><a name="index-binding-9"></a><a name="index-g_t_0040option_007b_002d_002dbind_007d-command-10"></a>Bind a design unit and prepare the link step.
<pre class="smallexample"> $ ghdl --bind [<var>options</var>] <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>This command is only available on GNU/Linux.
<p>This performs only the first stage of the elaboration command; the list
of objects files is created but the executable is not built. This
command should be used only when the main entry point is not ghdl.
<div class="node">
<p><hr>
<a name="Link-command"></a>
Next: <a rel="next" accesskey="n" href="#List-link-command">List link command</a>,
Previous: <a rel="previous" accesskey="p" href="#Bind-command">Bind command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<h4 class="subsection">3.1.6 Link command</h4>
<p><a name="index-linking-11"></a><a name="index-g_t_0040option_007b_002d_002dlink_007d-command-12"></a>Link an already bound design unit.
<pre class="smallexample"> $ ghdl --link [<var>options</var>] <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>This performs only the second stage of the elaboration command: the
executable is created by linking the files of the object files list.
This command is available only for completness. The elaboration command is
equivalent to the bind command followed by the link command.
<div class="node">
<p><hr>
<a name="List-link-command"></a>
Next: <a rel="next" accesskey="n" href="#Check-syntax-command">Check syntax command</a>,
Previous: <a rel="previous" accesskey="p" href="#Link-command">Link command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<h4 class="subsection">3.1.7 List link command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dlist_002dlink_007d-command-13"></a>Disp files which will be linked.
<pre class="smallexample"> $ ghdl --list-link <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>This command is only available on GNU/Linux.
<p>This command may be used only after a bind command. GHDL displays all
the files which will be linked to create an executable. This command is
intended to add object files in a link of an foreign program.
<div class="node">
<p><hr>
<a name="Check-syntax-command"></a>
Next: <a rel="next" accesskey="n" href="#Analyze-and-elaborate-command">Analyze and elaborate command</a>,
Previous: <a rel="previous" accesskey="p" href="#List-link-command">List link command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<h4 class="subsection">3.1.8 Check syntax command</h4>
<p><a name="index-checking-syntax-14"></a><a name="index-g_t_0040option_007b_002ds_007d-command-15"></a>Analyze files but do not generate code.
<pre class="smallexample"> $ ghdl -s [<var>options</var>] <var>files</var>
</pre>
<p>This command may be used to check the syntax of files. It does not update
the library.
<div class="node">
<p><hr>
<a name="Analyze-and-elaborate-command"></a>
Previous: <a rel="previous" accesskey="p" href="#Check-syntax-command">Check syntax command</a>,
Up: <a rel="up" accesskey="u" href="#Building-commands">Building commands</a>
</div>
<h4 class="subsection">3.1.9 Analyze and elaborate command</h4>
<p><a name="index-Analyze-and-elaborate-command-16"></a><a name="index-g_t_0040option_007b_002dc_007d-command-17"></a>Analyze files and elaborate in the same time.
<p>On GNU/Linux:
<pre class="smallexample"> $ ghdl -c [<var>options</var>] <var>file</var>... -e <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>On Windows:
<pre class="smallexample"> $ ghdl -c [<var>options</var>] <var>file</var>... -r <var>primary_unit</var> [<var>secondary_unit</var>]
</pre>
<p>This command combines analyze and elaboration: <var>file</var>s are analyzed and
the unit is then elaborated. However, code is only generated during the
elaboration. On Windows the simulation is launched.
<p>To be more precise, the files are first parsed, and then the elaboration
drives the analysis. Therefore, there is no analysis order, and you don't
need to care about it.
<p>All the units of the files are put into the `<samp><span class="samp">work</span></samp>' library. But, the
work library is neither read from disk nor saved. Therefore, you must give
all the files of the `<samp><span class="samp">work</span></samp>' library your design needs.
<p>The advantages over the traditionnal approach (analyze and then elaborate) are:
<ul>
<li>The compilation cycle is achieved in one command.
<li>Since the files are only parsed once, the compilation cycle may be faster.
<li>You don't need to know an analysis order
<li>This command produces smaller executable, since unused units and subprograms
do not generate code.
</ul>
However, you should know that currently most of the time is spent in code
generation and the analyze and elaborate command generate code for all units
needed, even units of `<samp><span class="samp">std</span></samp>' and `<samp><span class="samp">ieee</span></samp>' libraries. Therefore,
according to the design, the time for this command may be higher than the time
for the analyze command followed by the elaborate command.
<p>This command is still experimental. In case of problems, you should go back
to the traditionnal way.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="GHDL-options"></a>
Next: <a rel="next" accesskey="n" href="#Passing-options-to-other-programs">Passing options to other programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-commands">Building commands</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.2 GHDL options</h3>
<p><a name="index-IEEE-1164-18"></a><a name="index-g_t1164-19"></a><a name="index-IEEE-1076_002e3-20"></a><a name="index-g_t1076_002e3-21"></a><!-- document gcc options -->
Besides the options described below, <code>GHDL</code> passes any debugging options
(those that begin with <samp><span class="option">-g</span></samp>) and optimizations options (those that
begin with <samp><span class="option">-O</span></samp> or <samp><span class="option">-f</span></samp>) to <code>GCC</code>. Refer to the <code>GCC</code>
manual for details.
<dl>
<dt><code>--work=</code><var>NAME</var><dd><a name="index-g_t_0040option_007b_002d_002dwork_007d-switch-22"></a><a name="index-WORK-library-23"></a>Specify the name of the `<samp><span class="samp">WORK</span></samp>' library. Analyzed units are always
placed in the library logically named `<samp><span class="samp">WORK</span></samp>'. With this option,
you can set its name. By default, the name is <var>work</var>.
<p><code>GHDL</code> checks `<samp><span class="samp">WORK</span></samp>' is a valid identifier. Although being
more or less supported, the `<samp><span class="samp">WORK</span></samp>' identifier should not be an
extended identifier, since the filesystem may prevent it from correctly
working (due to case sensitivity or forbidden characters in filenames).
<p><code>VHDL</code> rules forbides you to add units in the `<samp><span class="samp">std</span></samp>' library.
Furthermode, you should not put units in the `<samp><span class="samp">ieee</span></samp>' library.
<br><dt><code>--workdir=</code><var>PATH</var><dd><a name="index-g_t_0040option_007b_002d_002dworkdir_007d-switch-24"></a>Specify the directory where the `<samp><span class="samp">WORK</span></samp>' library is. When this
option is not present, the `<samp><span class="samp">WORK</span></samp>' library is in the current
directory. The object files created by the compiler are always placed
in the same directory as the `<samp><span class="samp">WORK</span></samp>' library.
<br><dt><code>--std=</code><var>STD</var><dd><a name="index-g_t_0040option_007b_002d_002dstd_007d-switch-25"></a>Specify the standard to use. By default, the standard is `<samp><span class="samp">93c</span></samp>', which
means VHDL-93 accepting VHDL-87 syntax. For details on <var>STD</var> values see
<a href="#VHDL-standards">VHDL standards</a>.
<br><dt><code>--ieee=</code><var>VER</var><dd><a name="index-g_t_0040option_007b_002d_002dieee_007d-switch-26"></a><a name="index-ieee-library-27"></a><a name="index-synopsys-library-28"></a><a name="index-mentor-library-29"></a>Select the <code>IEEE</code> library to use. <var>VER</var> must be one of:
<dl>
<dt>`<samp><span class="samp">none</span></samp>'<dd>Do not supply an <code>IEEE</code> library. Any library clause with the `<samp><span class="samp">IEEE</span></samp>'
identifier will fail, unless you have created by your own a library with
the <code>IEEE</code> name.
<br><dt>`<samp><span class="samp">standard</span></samp>'<dd>Supply an <code>IEEE</code> library containing only packages defined by
<span class="sc">ieee</span> standards. Currently, there are the multivalue logic system
packages `<samp><span class="samp">std_logic_1164</span></samp>' defined by IEEE 1164, the synthesis
packages , `<samp><span class="samp">numeric_bit</span></samp>' and `<samp><span class="samp">numeric_std</span></samp>' defined by IEEE
1076.3, and the <span class="sc">vital</span> packages `<samp><span class="samp">vital_timing</span></samp>' and
`<samp><span class="samp">vital_primitives</span></samp>', defined by IEEE 1076.4. The version of these
packages is defined by the VHDL standard used. See <a href="#VITAL-packages">VITAL packages</a>,
for more details.
<br><dt>`<samp><span class="samp">synopsys</span></samp>'<dd>Supply the former packages and the following additionnal packages:
`<samp><span class="samp">std_logic_arith</span></samp>', `<samp><span class="samp">std_logic_signed</span></samp>',
`<samp><span class="samp">std_logic_unsigned</span></samp>', `<samp><span class="samp">std_logic_textio</span></samp>'.
<!-- @samp{std_logic_misc}. -->
These packages were created by some companies, and are popular. However
they are not standard packages, and have been placed in the <code>IEEE</code>
library without the <span class="sc">ieee</span> permission.
<br><dt>`<samp><span class="samp">mentor</span></samp>'<dd>Supply the standardr packages and the following additionnal package:
`<samp><span class="samp">std_logic_arith</span></samp>'. The package is a slight variation on a definitly
not standard but widely mis-used package.
</dl>
<p>To avoid errors, you must use the same <code>IEEE</code> library for all units of
your design, and during elaboration.
<br><dt><code>-P</code><var>PATH</var><dd><a name="index-g_t_0040option_007b_002dP_007d-switch-30"></a>Add <var>PATH</var> to the end of the list of directories to be searched for
library files.
<p>The <code>WORK</code> library is always searched in the path specified by the
<samp><span class="option">--workdir=</span></samp> option, or in the current directory if the later
option is not specified.
<br><dt><code>-fexplicit</code><dd><a name="index-g_t_0040option_007b_002dfexplicit_007d-switch-31"></a>When two operators are overloaded, give preference to the explicit declaration.
This may be used to avoid the most common pitfall of the `<samp><span class="samp">std_logic_arith</span></samp>'
package. See <a href="#IEEE-library-pitfalls">IEEE library pitfalls</a>, for an example.
<p>This option is not set by default. I don't think this option is a
good feature, because it breaks the encapsulation rule. When set, an
operator can be silently overriden in another package. You'd better to fix
your design and use the `<samp><span class="samp">numeric_std</span></samp>' package.
<br><dt><code>--no-vital-checks</code><br><dt><code>--vital-checks</code><dd><a name="index-g_t_0040option_007b_002d_002dno_002dvital_002dchecks_007d-switch-32"></a><a name="index-g_t_0040option_007b_002d_002dvital_002dchecks_007d-switch-33"></a>Disable or enable checks of restriction on VITAL units. Checks are enabled
by default.
<p>Checks are performed only when a design unit is decorated by a VITAL attribute.
The VITAL attributes are `<samp><span class="samp">VITAL_Level0</span></samp>' and `<samp><span class="samp">VITAL_Level1</span></samp>', both
declared in the `<samp><span class="samp">ieee.VITAL_Timing</span></samp>' package.
<p>Currently, VITAL checks are only partially implemented. See <a href="#VHDL-restrictions-for-VITAL">VHDL restrictions for VITAL</a>, for more details.
<br><dt><code>--syn-binding</code><dd><a name="index-g_t_0040option_007b_002d_002dsyn_002dbinding_007d-switch-34"></a>Use synthetizer rules for component binding. During elaboration, if a
component is not bound to an entity using VHDL LRM rules, try to find
in any known library an entity whose name is the same as the component
name.
<p>This rule is known as synthetizer rule.
<p>There are two key points: normal VHDL LRM rules are tried first and
entities are search only in known library. A known library is a
library which has been named in your design.
<p>This option is only useful during elaboration.
<br><dt><code>--PREFIX=</code><var>PATH</var><dd><a name="index-g_t_0040option_007b_002d_002dPREFIX_007d-switch-35"></a>Use <var>PATH</var> as the prefix path to find commands and pre-installed (std and
ieee) libraries.
<br><dt><code>--GHDL1=</code><var>COMMAND</var><dd><a name="index-g_t_0040option_007b_002d_002dGHLD1_007d-switch-36"></a>Use <var>COMMAND</var> as the command name for the compiler. If <var>COMMAND</var> is
not a path, then it is search in the list of program directories.
<br><dt><code>-v</code><dd>Be verbose. For example, for analysis, elaboration and make commands, GHDL
displays the commands executed.
</dl>
<div class="node">
<p><hr>
<a name="Passing-options-to-other-programs"></a>
Next: <a rel="next" accesskey="n" href="#GHDL-warnings">GHDL warnings</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-options">GHDL options</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.3 Passing options to other programs</h3>
<p>These options are only available on GNU/Linux.
<p>For many commands, <code>GHDL</code> acts as a driver: it invokes programs to perform
the command. You can pass arbritrary options to these programs.
<p>Both the compiler and the linker are in fact GCC programs. See <a href="gcc.html#Invoking-GCC">GCC options</a>, for details on GCC
options.
<dl>
<dt><code>-Wc,</code><var>OPTION</var><dd><a name="index-g_t_0040option_007b_002dW_007d-switch-37"></a>Pass <var>OPTION</var> as an option to the compiler.
<br><dt><code>-Wa,</code><var>OPTION</var><dd><a name="index-g_t_0040option_007b_002dWa_007d-switch-38"></a>Pass <var>OPTION</var> as an option to the assembler.
<br><dt><code>-Wl,</code><var>OPTION</var><dd><a name="index-g_t_0040option_007b_002dWl_007d-switch-39"></a>Pass <var>OPTION</var> as an option to the linker.
</dl>
<div class="node">
<p><hr>
<a name="GHDL-warnings"></a>
Next: <a rel="next" accesskey="n" href="#Rebuilding-commands">Rebuilding commands</a>,
Previous: <a rel="previous" accesskey="p" href="#Passing-options-to-other-programs">Passing options to other programs</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.4 GHDL warnings</h3>
<p>Some contructions are not erroneous but dubious. Warnings are diagnostic
messages that report such constructions. Some warnings are reported only
during analysis, others during elaboration.
<p>You could disable a warning by using the <samp><span class="option">--warn-no-XXX</span></samp>
instead of <samp><span class="option">--warn-XXX</span></samp>.
<dl>
<dt><code>--warn-reserved</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dreserved_007d-switch-40"></a>Emit a warning if an identifier is a reserved word in a latter VHDL standard.
<br><dt><code>--warn-default-binding</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002ddefault_002dbinding_007d-switch-41"></a>During analyze, warns if a component instantiation has neither
configuration specification nor default binding. This may be usefull if you
want to detect during analyze possibly unbound component if you don't use
configuration. See <a href="#VHDL-standards">VHDL standards</a>, for more details about default binding
rules.
<br><dt><code>--warn-binding</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dbinding_007d-switch-42"></a>During elaboration, warns if a component instantiation is not bound
(and not explicitly left unbound). Also warns if a port of an entity
is not bound in a configuration specification or in a component
configuration. This warning is enabled by default, since default
binding rules are somewhat complex and an unbound component is most
often unexpected.
<p>However, warnings are even emitted if a component instantiation is
inside a generate statement. As a consequence, if you use conditionnal
generate statement to select a component according to the implementation,
you will certainly get warnings.
<br><dt><code>--warn-library</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dlibrary_007d-switch-43"></a>Warns if a design unit replaces another design unit with the same name.
<br><dt><code>--warn-vital-generic</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dvital_002dgeneric_007d-switch-44"></a>Warns if a generic name of a vital entity is not a vital generic name. This
is set by default.
<br><dt><code>--warn-delayed-checks</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002ddelayed_002dchecks_007d-switch-45"></a>Warns for checks that cannot be done during analysis time and are
postponed to elaboration time. This is because not all procedure
bodies are available during analysis (either because a package body
has not yet been analysed or because <code>GHDL</code> doesn't read not required
package bodies).
<p>These are checks for no wait statement in a procedure called in a
sensitized process and checks for pure rules of a function.
<br><dt><code>--warn-body</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dbody_007d-switch-46"></a>Emit a warning if a package body which is not required is analyzed. If a
package does not declare a subprogram or a deferred constant, the package
does not require a body.
<br><dt><code>--warn-specs</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dspecs_007d-switch-47"></a>Emit a warning if an all or others specification does not apply.
<br><dt><code>--warn-unused</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002dunused_007d-switch-48"></a>Emit a warning when a subprogram is never used.
<br><dt><code>--warn-error</code><dd><a name="index-g_t_0040option_007b_002d_002dwarn_002derror_007d-switch-49"></a>When this option is set, warnings are considered as errors.
</dl>
<div class="node">
<p><hr>
<a name="Rebuilding-commands"></a>
Next: <a rel="next" accesskey="n" href="#Library-commands">Library commands</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-warnings">GHDL warnings</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.5 Rebuilding commands</h3>
<p>Analyzing and elaborating a design consisting in severals files can be tricky,
due to dependences. GHDL has a few commands to rebuild a design.
<ul class="menu">
<li><a accesskey="1" href="#Import-command">Import command</a>
<li><a accesskey="2" href="#Make-command">Make command</a>
<li><a accesskey="3" href="#Generate-Makefile-command">Generate Makefile command</a>
</ul>
<div class="node">
<p><hr>
<a name="Import-command"></a>
Next: <a rel="next" accesskey="n" href="#Make-command">Make command</a>,
Previous: <a rel="previous" accesskey="p" href="#Rebuilding-commands">Rebuilding commands</a>,
Up: <a rel="up" accesskey="u" href="#Rebuilding-commands">Rebuilding commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.5.1 Import command</h4>
<p><a name="index-importing-files-50"></a><a name="index-g_t_0040option_007b_002di_007d-coomand-51"></a>Add files in the work design library.
<pre class="smallexample"> $ ghdl -i [<var>options</var>] <var>file</var>...
</pre>
<p>All the files specified in the command line are scanned, parsed and added in
the libraries but as not yet analyzed. No object files are created.
<p>The purpose of this command is to localize design units in the design files.
The make command will then be able to recursively build a hierarchy from
an entity name or a configuration name.
<p>Since the files are parsed, there must be correct files. However, since they
are not analyzed, many errors are tolerated by this command.
<p>Note that all the files are added in the work library. If you have many
libraries, you must use the command for each library.
<!-- Due to the LRM rules, there may be many analysis orders, producing -->
<!-- different results. For example, if an entity has several architectures, -->
<!-- the last architecture analyzed is the default one in default binding -->
<!-- indications. -->
<p>See <a href="#Make-command">Make command</a>, to actually build the design.
<div class="node">
<p><hr>
<a name="Make-command"></a>
Next: <a rel="next" accesskey="n" href="#Generate-Makefile-command">Generate Makefile command</a>,
Previous: <a rel="previous" accesskey="p" href="#Import-command">Import command</a>,
Up: <a rel="up" accesskey="u" href="#Rebuilding-commands">Rebuilding commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.5.2 Make command</h4>
<p><a name="index-make-52"></a><a name="index-g_t_0040option_007b_002dm_007d-command-53"></a>
<pre class="smallexample"> $ ghdl -m [<var>options</var>] <var>primary</var> [<var>secondary</var>]
</pre>
<p>Analyze automatically outdated files and elaborate a design.
<p>The primary unit denoted by the <var>primary</var> argument must already be
known by the system, either because you have already analyzed it (even
if you have modified it) or because you have imported it. GHDL analyzes
all outdated files. A file may be outdated because it has been modified
(e.g. you just have edited it), or because a design unit contained in
the file depends on a unit which is outdated. This rule is of course
recursive.
<p>With the <samp><span class="option">-f</span></samp> (force) option, GHDL analyzes all the units of the
work library needed to create the design hierarchy. Not outdated units
are recompiled. This is useful if you want to compile a design hierarch
with new compilation flags (for example, to add the <samp><span class="option">-g</span></samp>
debugging option).
<p>The make command will only re-analyze design units in the work library.
GHDL fails if it has to analyze an outdated unit from another library.
<p>The purpose of this command is to be able to compile a design without prior
knowledge of file order. In the VHDL model, some units must be analyzed
before others (e.g. an entity before its architecture). It might be a
nightmare to analyze a full design of several files, if you don't have
the ordered list of file. This command computes an analysis order.
<p>The make command fails when a unit was not previously parsed. For
example, if you split a file containing several design units into
several files, you must either import these new files or analyze them so
that GHDL knows in which file these units are.
<p>The make command imports files which have been modified. Then, a design
hierarchy is internally built as if no units are outdated. Then, all outdated
design units, using the dependences of the design hierarchy, are analyzed.
If necessary, the design hierarchy is elaborated.
<p>This is not perfect, since defaults architecture (the most recently
analyzed one) may change while outdated design files are analyzed. In
such a case, re-run the make command of GHDL.
<!-- does not exists: @section GHDL robust make command -->
<div class="node">
<p><hr>
<a name="Generate-Makefile-command"></a>
Previous: <a rel="previous" accesskey="p" href="#Make-command">Make command</a>,
Up: <a rel="up" accesskey="u" href="#Rebuilding-commands">Rebuilding commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.5.3 Generate Makefile command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dgen_002dmakefile_007d-command-54"></a>Generate a Makefile to build a design unit.
<pre class="smallexample"> $ ghdl --gen-makefile [<var>options</var>] <var>primary</var> [<var>secondary</var>]
</pre>
<p>This command works like the make command (see <a href="#Make-command">Make command</a>), but only a
makefile is generated on the standard output.
<div class="node">
<p><hr>
<a name="Library-commands"></a>
Next: <a rel="next" accesskey="n" href="#Cross_002dreference-command">Cross-reference command</a>,
Previous: <a rel="previous" accesskey="p" href="#Rebuilding-commands">Rebuilding commands</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.6 Library commands</h3>
<p>GHDL has a few commands which act on a library.
<!-- node-name, next, previous, up -->
<ul class="menu">
<li><a accesskey="1" href="#Directory-command">Directory command</a>
<li><a accesskey="2" href="#Clean-command">Clean command</a>
<li><a accesskey="3" href="#Remove-command">Remove command</a>
</ul>
<div class="node">
<p><hr>
<a name="Directory-command"></a>
Next: <a rel="next" accesskey="n" href="#Clean-command">Clean command</a>,
Previous: <a rel="previous" accesskey="p" href="#Library-commands">Library commands</a>,
Up: <a rel="up" accesskey="u" href="#Library-commands">Library commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.6.1 Directory command</h4>
<p><a name="index-displaying-library-55"></a><a name="index-g_t_0040option_007b_002dd_007d-command-56"></a>Display the name of the units contained in a design library.
<pre class="smallexample"> $ ghdl -d [<var>options</var>]
</pre>
<p>The directory command, selected with the <var>-d</var> command line argument
displays the content of the work design library. All options are
allowed, but only a few are meaningful: <samp><span class="option">--work=NAME</span></samp>,
<samp><span class="option">--workdir=PATH</span></samp> and <samp><span class="option">--std=VER</span></samp>.
<div class="node">
<p><hr>
<a name="Clean-command"></a>
Next: <a rel="next" accesskey="n" href="#Remove-command">Remove command</a>,
Previous: <a rel="previous" accesskey="p" href="#Directory-command">Directory command</a>,
Up: <a rel="up" accesskey="u" href="#Library-commands">Library commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.6.2 Clean command</h4>
<p><a name="index-cleaning-57"></a><a name="index-g_t_0040option_007b_002d_002dclean_007d-command-58"></a>Remove object and executable files but keep the library.
<pre class="smallexample"> $ ghdl --clean [<var>options</var>]
</pre>
<p>GHDL tries to remove any object, executable or temporary file it could
have created. Source files are not removed.
<p>There is no short command line form for this option to prevent accidental
clean up.
<div class="node">
<p><hr>
<a name="Remove-command"></a>
Previous: <a rel="previous" accesskey="p" href="#Clean-command">Clean command</a>,
Up: <a rel="up" accesskey="u" href="#Library-commands">Library commands</a>
</div>
<h4 class="subsection">3.6.3 Remove command</h4>
<p><a name="index-cleaning-all-59"></a><a name="index-g_t_0040option_007b_002d_002dremove_007d-command-60"></a>Do like the clean command but remove the library too.
<pre class="smallexample"> $ ghdl --remove [<var>options</var>]
</pre>
<p>There is no short command line form for this option to prevent accidental
clean up. Note that after removing a design library, the files are not
known anymore by GHDL.
<div class="node">
<p><hr>
<a name="Cross-reference-command"></a>
<a name="Cross_002dreference-command"></a>
Next: <a rel="next" accesskey="n" href="#File-commands">File commands</a>,
Previous: <a rel="previous" accesskey="p" href="#Library-commands">Library commands</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.7 Cross-reference command</h3>
<p>To easily navigate through your sources, you may generate cross-references.
<pre class="smallexample"> $ ghdl --xref-html [<var>options</var>] <var>file</var>...
</pre>
<p>This command generates an html file for each <var>file</var> given in the command
line, with syntax highlighting and full cross-reference: every identifier is
a link to its declaration. Besides, an index of the files is created too.
<p>The set of <var>file</var> are analyzed, and then, if the analyze is
successful, html files are generated in the directory specified by the
<samp><span class="option">-o </span><var>dir</var></samp> option, or <samp><span class="file">html/</span></samp> directory by default.
<p>If the <samp><span class="option">--format=html2</span></samp> is specified, then the generated html
files follow the HTML 2.0 standard, and colours are specified with
`<samp><span class="samp"><FONT></span></samp>' tags. However, colours are hard-coded.
<p>If the <samp><span class="option">--format=css</span></samp> is specified, then the generated html files
follow the HTML 4.0 standard, and use the CSS-1 file <samp><span class="file">ghdl.css</span></samp> to
specify colours. This file is generated only if it does not already exist (it
is never overwritten) and can be customized by the user to change colours or
appearance. Refer to a generated file and its comments for more informations.
<div class="node">
<p><hr>
<a name="File-commands"></a>
Next: <a rel="next" accesskey="n" href="#Misc-commands">Misc commands</a>,
Previous: <a rel="previous" accesskey="p" href="#Cross_002dreference-command">Cross-reference command</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.8 File commands</h3>
<p>The following commands act on one or severals files. They do not analysis
files, therefore, they work even if a file has semantic errors.
<ul class="menu">
<li><a accesskey="1" href="#Pretty-print-command">Pretty print command</a>
<li><a accesskey="2" href="#Find-command">Find command</a>
<li><a accesskey="3" href="#Chop-command">Chop command</a>
<li><a accesskey="4" href="#Lines-command">Lines command</a>
</ul>
<div class="node">
<p><hr>
<a name="Pretty-print-command"></a>
Next: <a rel="next" accesskey="n" href="#Find-command">Find command</a>,
Previous: <a rel="previous" accesskey="p" href="#File-commands">File commands</a>,
Up: <a rel="up" accesskey="u" href="#File-commands">File commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.8.1 Pretty print command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dpp_002dhtml_007d-command-61"></a><a name="index-pretty-printing-62"></a><a name="index-vhdl-to-html-63"></a>
Generate HTML on standard output from VHDL.
<pre class="smallexample"> $ ghdl --pp-html [<var>options</var>] <var>file</var>...
</pre>
<p>The files are just scanned and an html file, with syntax highlighting is
generated on standard output.
<p>Since the files are not even parsed, erroneous files or uncomplete designs
can be pretty printed.
<p>The style of the html file can be modified with the <samp><span class="option">--format=</span></samp> option.
By default or when the <samp><span class="option">--format=html2</span></samp> option is specified, the output
is an HTML 2.0 file, with colours set throught `<samp><span class="samp"><FONT></span></samp>' tags. When the
<samp><span class="option">--format=css</span></samp> option is specified, the output is an HTML 4.0 file,
with colours set through a CSS file, whose name is `<samp><span class="samp">ghdl.css</span></samp>'.
See <a href="#Cross_002dreference-command">Cross-reference command</a>, for more details about this CSS file.
<div class="node">
<p><hr>
<a name="Find-command"></a>
Next: <a rel="next" accesskey="n" href="#Chop-command">Chop command</a>,
Previous: <a rel="previous" accesskey="p" href="#Pretty-print-command">Pretty print command</a>,
Up: <a rel="up" accesskey="u" href="#File-commands">File commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.8.2 Find command</h4>
<p><a name="index-g_t_0040option_007b_002df_007d-command-64"></a>Display the name of the design units in files.
<pre class="smallexample"> $ ghdl -f <var>file</var>...
</pre>
<p>The files are scanned, parsed and the names of design units are displayed.
Design units marked with two stars are candidate to be at the apex of a
design hierarchy.
<div class="node">
<p><hr>
<a name="Chop-command"></a>
Next: <a rel="next" accesskey="n" href="#Lines-command">Lines command</a>,
Previous: <a rel="previous" accesskey="p" href="#Find-command">Find command</a>,
Up: <a rel="up" accesskey="u" href="#File-commands">File commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.8.3 Chop command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dchop_007d-command-65"></a>Chop (or split) files at design unit.
<pre class="smallexample"> $ ghdl --chop <var>files</var>
</pre>
<p><code>GHDL</code> reads files, and writes a file in the current directory for
every design unit.
<p>The file name of a design unit is build according to the unit. For an
entity declaration, a package declaration or a configuration the file
name is <samp><span class="file">NAME.vhdl</span></samp>, where <var>NAME</var> is the name of the design
unit. For a package body, the file name is <samp><span class="file">NAME-body.vhdl</span></samp>.
Finally, for an architecture <var>ARCH</var> of an entity <var>ENTITY</var>, the
file name is <samp><span class="file">ENTITY-ARCH.vhdl</span></samp>.
<p>Since the input files are parsed, this command aborts in case of syntax
error. The command aborts too if a file to be written already exists.
<p>Comments between design units are stored into the most adequate files.
<p>This command may be useful to split big files, if your computer has not
enough memory to compile such files. The size of the executable is
reduced too.
<div class="node">
<p><hr>
<a name="Lines-command"></a>
Previous: <a rel="previous" accesskey="p" href="#Chop-command">Chop command</a>,
Up: <a rel="up" accesskey="u" href="#File-commands">File commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.8.4 Lines command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dlines_007d-command-66"></a>Display on the standard output lines of files preceded by line number.
<pre class="smallexample"> $ ghdl --lines <var>files</var>
</pre>
<div class="node">
<p><hr>
<a name="Misc-commands"></a>
Next: <a rel="next" accesskey="n" href="#Installation-Directory">Installation Directory</a>,
Previous: <a rel="previous" accesskey="p" href="#File-commands">File commands</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.9 Misc commands</h3>
<p>There are a few GHDL commands which are seldom useful.
<ul class="menu">
<li><a accesskey="1" href="#Help-command">Help command</a>
<li><a accesskey="2" href="#Dispconfig-command">Dispconfig command</a>
<li><a accesskey="3" href="#Disp-standard-command">Disp standard command</a>
<li><a accesskey="4" href="#Version-command">Version command</a>
</ul>
<div class="node">
<p><hr>
<a name="Help-command"></a>
Next: <a rel="next" accesskey="n" href="#Dispconfig-command">Dispconfig command</a>,
Previous: <a rel="previous" accesskey="p" href="#Misc-commands">Misc commands</a>,
Up: <a rel="up" accesskey="u" href="#Misc-commands">Misc commands</a>
</div>
<h4 class="subsection">3.9.1 Help command</h4>
<p><a name="index-g_t_0040option_007b_002dh_007d-command-67"></a><a name="index-g_t_0040option_007b_002d_002dhelp_007d-command-68"></a>Display (on the standard output) a short description of the all the commands
available. If the help switch is followed by an command switch, then options
for this later command are displayed.
<pre class="smallexample"> $ ghdl --help
$ ghdl -h
$ ghdl -h <var>command</var>
</pre>
<div class="node">
<p><hr>
<a name="Dispconfig-command"></a>
Next: <a rel="next" accesskey="n" href="#Disp-standard-command">Disp standard command</a>,
Previous: <a rel="previous" accesskey="p" href="#Help-command">Help command</a>,
Up: <a rel="up" accesskey="u" href="#Misc-commands">Misc commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.9.2 Dispconfig command</h4>
<p><a name="index-g_t_0040option_007b_002d_002ddispconfig_007d-command-69"></a><a name="index-display-configuration-70"></a>Display the program pathes and options used by GHDL.
<pre class="smallexample"> $ ghdl --dispconfig [<var>options</var>]
</pre>
<p>This may be useful to track installation errors.
<div class="node">
<p><hr>
<a name="Disp-standard-command"></a>
Next: <a rel="next" accesskey="n" href="#Version-command">Version command</a>,
Previous: <a rel="previous" accesskey="p" href="#Dispconfig-command">Dispconfig command</a>,
Up: <a rel="up" accesskey="u" href="#Misc-commands">Misc commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.9.3 Disp standard command</h4>
<p><a name="index-g_t_0040option_007b_002d_002ddisp_002dstandard_007d-command-71"></a><a name="index-display-_0040samp_007bstd_002estandard_007d-72"></a>Display the `<samp><span class="samp">std.standard</span></samp>' package:
<pre class="smallexample"> $ ghdl --disp-standard [<var>options</var>]
</pre>
<div class="node">
<p><hr>
<a name="Version-command"></a>
Previous: <a rel="previous" accesskey="p" href="#Disp-standard-command">Disp standard command</a>,
Up: <a rel="up" accesskey="u" href="#Misc-commands">Misc commands</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">3.9.4 Version command</h4>
<p><a name="index-g_t_0040option_007b_002d_002dversion_007d-command-73"></a><a name="index-version-74"></a>Display the <code>GHDL</code> version and exit.
<pre class="smallexample"> $ ghdl --version
</pre>
<div class="node">
<p><hr>
<a name="Installation-Directory"></a>
Next: <a rel="next" accesskey="n" href="#IEEE-library-pitfalls">IEEE library pitfalls</a>,
Previous: <a rel="previous" accesskey="p" href="#Misc-commands">Misc commands</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.10 Installation Directory</h3>
<!-- @code{GHDL} is installed with the @code{std} and @code{ieee} libraries. -->
<p>During analysis and elaboration <code>GHDL</code> may read the <code>std</code>
and <code>ieee</code> files. The location of these files is based on the prefix,
which is (in priority order):
<ol type=1 start=1>
<li>the <samp><span class="option">--PREFIX=</span></samp> command line option
<li>the <var>GHDL_PREFIX</var> environment variable
<li>a built-in default path. It is an hard-coded path on GNU/Linux and the
value of the `<samp><span class="samp">HKLM\Software\Ghdl\Install_Dir</span></samp>' registry entry on Windows.
</ol>
<p>You should use the <samp><span class="option">--dispconfig</span></samp> command (see <a href="#Dispconfig-command">Dispconfig command</a> for details) to disp and debug installation problems.
<div class="node">
<p><hr>
<a name="IEEE-library-pitfalls"></a>
Previous: <a rel="previous" accesskey="p" href="#Installation-Directory">Installation Directory</a>,
Up: <a rel="up" accesskey="u" href="#Invoking-GHDL">Invoking GHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">3.11 IEEE library pitfalls</h3>
<p>When you use options <samp><span class="option">--ieee=synopsys</span></samp> or <samp><span class="option">--ieee=mentor</span></samp>,
the <code>IEEE</code> library contains non standard packages such as
`<samp><span class="samp">std_logic_arith</span></samp>'. <!-- FIXME: ref -->
<p>These packages are not standard because there are not described by an IEEE
standard, even if they have been put in the <code>IEEE</code> library. Furthermore,
they are not really de-facto standard, because there a slight differences
between the packages of Mentor and those of Synopsys.
<p>Furthermore, since they are not well-thought, their use have pitfalls. For
example, this description has error during compilation:
<pre class="example"> library ieee;
use ieee.std_logic_1164.all;
-- <span class="roman">A counter from 0 to 10</span>.
entity counter is
port (val : out std_logic_vector (3 downto 0);
ck : std_logic;
rst : std_logic);
end counter;
library ieee;
use ieee.std_logic_unsigned.all;
architecture bad of counter
is
signal v : std_logic_vector (3 downto 0);
begin
process (ck, rst)
begin
if rst = '1' then
v <= x"0";
elsif rising_edge (ck) then
if v = "1010" then -- <span class="roman">Error</span>
v <= x"0";
else
v <= v + 1;
end if;
end if;
end process;
val <= v;
end bad;
</pre>
<p>When you analyze this design, GHDL does not accept it (too long lines
have been split for readability):
<pre class="smallexample"> $ ghdl -a --ieee=synopsys bad_counter.vhdl
bad_counter.vhdl:13:14: operator "=" is overloaded
bad_counter.vhdl:13:14: possible interpretations are:
../../libraries/ieee/std_logic_1164.v93:69:5: implicit function "="
[std_logic_vector, std_logic_vector return boolean]
../../libraries/synopsys/std_logic_unsigned.vhdl:64:5: function "="
[std_logic_vector, std_logic_vector return boolean]
../translate/ghdldrv/ghdl: compilation error
</pre>
<p>Indeed, the <code>"="</code> operator is defined in both packages, and both
are visible at the place it is used. The first declaration is an
implicit one, which occurs when the <code>std_logic_vector</code> type is
declared and is a element to element comparaison, the second one is an
explicit declared function, with the semantic of an unsigned comparaison.
<p>With some analyser, the explicit declaration has priority on the implicit
declaration, and this design can be analyzed without error. However, this
is not the rule given by the VHDL LRM, and since GHDL follows these rules,
it emits an error.
<p>You can force GHDL to use this rule with the <samp><span class="option">-fexplicit</span></samp> option.
See <a href="#GHDL-options">GHDL options</a>, for more details.
<p>However it is easy to fix this error, by using a selected name:
<pre class="example"> library ieee;
use ieee.std_logic_unsigned.all;
architecture fixed_bad of counter
is
signal v : std_logic_vector (3 downto 0);
begin
process (ck, rst)
begin
if rst = '1' then
v <= x"0";
elsif rising_edge (ck) then
if ieee.std_logic_unsigned."=" (v, "1010") then
v <= x"0";
else
v <= v + 1;
end if;
end if;
end process;
val <= v;
end fixed_bad;
</pre>
<p>It is better to only use the standard packages defined by IEEE, which
provides the same functionnalities:
<pre class="example"> library ieee;
use ieee.numeric_std.all;
architecture good of counter
is
signal v : unsigned (3 downto 0);
begin
process (ck, rst)
begin
if rst = '1' then
v <= x"0";
elsif rising_edge (ck) then
if v = "1010" then
v <= x"0";
else
v <= v + 1;
end if;
end if;
end process;
val <= std_logic_vector (v);
end good;
</pre>
<div class="node">
<p><hr>
<a name="Simulation-and-run-time"></a>
Next: <a rel="next" accesskey="n" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>,
Previous: <a rel="previous" accesskey="p" href="#Invoking-GHDL">Invoking GHDL</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">4 Simulation and run time</h2>
<ul class="menu">
<li><a accesskey="1" href="#Simulation-options">Simulation options</a>
<li><a accesskey="2" href="#Debugging-VHDL-programs">Debugging VHDL programs</a>
</ul>
<div class="node">
<p><hr>
<a name="Simulation-options"></a>
Next: <a rel="next" accesskey="n" href="#Debugging-VHDL-programs">Debugging VHDL programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Simulation-and-run-time">Simulation and run time</a>,
Up: <a rel="up" accesskey="u" href="#Simulation-and-run-time">Simulation and run time</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">4.1 Simulation options</h3>
<p>In most system environments, it is possible to pass options while
invoking a program. Contrary to most programming language, there is no
standard method in VHDL to obtain the arguments or to set the exit
status.
<p>In GHDL, it is impossible to pass parameters to your design. A later version
could do it through the generics interfaces of the top entity.
<p>However, the GHDL run time behaviour can be modified with some options; for
example, it is possible to stop simulation after a certain time.
<p>The exit status of the simulation is `<samp><span class="samp">EXIT_SUCCESS</span></samp>' (0) if the
simulation completes, or `<samp><span class="samp">EXIT_FAILURE</span></samp>' (1) in case of error
(assertion failure, overflow or any constraint error).
<p>Here is the list of the most useful options. Some debugging options are
also available, but not described here. The `<samp><span class="samp">--help</span></samp>' options lists
all options available, including the debugging one.
<dl>
<dt><code>--assert-level=</code><var>LEVEL</var><dd><a name="index-g_t_0040option_007b_002d_002dassert_002dlevel_007d-option-75"></a>Select the assertion level at which an assertion violation stops the
simulation. <var>LEVEL</var> is the name from the <code>severity_level</code>
enumerated type defined in the <code>standard</code> package or the
`<samp><span class="samp">none</span></samp>' name.
<p>By default, only assertion violation of severity level `<samp><span class="samp">failure</span></samp>'
stops the simulation.
<p>For example, if <var>LEVEL</var> was `<samp><span class="samp">warning</span></samp>', any assertion violation
with severity level `<samp><span class="samp">warning</span></samp>', `<samp><span class="samp">error</span></samp>' or `<samp><span class="samp">failure</span></samp>' would
stop simulation, but the assertion violation at the `<samp><span class="samp">note</span></samp>' severity
level would only display a message.
<p>`<samp><span class="samp">--assert-level=none</span></samp>' prevents any assertion violation to stop
simulation.
<br><dt><code>--stop-time=</code><var>TIME</var><dd><a name="index-g_t_0040option_007b_002d_002dstop_002dtime_007d-option-76"></a>Stop the simulation after <var>TIME</var>. <var>TIME</var> is expressed as a time
value, <em>without</em> any space. The time is the simulation time, not
the real clock time.
<p>For examples:
<pre class="smallexample"> $ ./my_design --stop-time=10ns
$ ./my_design --stop-time=ps
</pre>
<br><dt><code>--stop-delta=</code><var>N</var><dd><a name="index-g_t_0040option_007b_002d_002dstop_002ddelta_007d-option-77"></a>Stop the simulation after <var>N</var> delta cycles in the same current time.
<!-- Delta cycles is a simulation technic used by VHDL to -->
<br><dt><code>--disp-time</code><dd><a name="index-g_t_0040option_007b_002d_002ddisp_002dtime_007d-option-78"></a><a name="index-display-time-79"></a>Display the time and delta cycle number as simulation advances.
<br><dt><code>--disp-tree[</code><var>=KIND</var><code>]</code><dd><a name="index-g_t_0040option_007b_002d_002ddisp_002dtree_007d-option-80"></a><a name="index-display-design-hierarchy-81"></a>Display the design hierarchy as a tree of instantiated design entities.
This may be useful to understand the structure of a complex
design. <var>KIND</var> is optional, but if set must be one of:
<dl>
<dt>`<samp><span class="samp">none</span></samp>'<dd>Do not display hierarchy. Same as if the option was not present.
<br><dt>`<samp><span class="samp">inst</span></samp>'<dd>Display entities, architectures, instances, blocks and generates statements.
<br><dt>`<samp><span class="samp">proc</span></samp>'<dd>Like `<samp><span class="samp">inst</span></samp>' but also display processes.
<br><dt>`<samp><span class="samp">port</span></samp>'<dd>Like `<samp><span class="samp">proc</span></samp>' but display ports and signals too.
</dl>
If <var>KIND</var> is not specified, the hierarchy is displayed with the
`<samp><span class="samp">port</span></samp>' mode.
<br><dt><code>--no-run</code><dd><a name="index-g_t_0040option_007b_002d_002dno_002drun_007d-option-82"></a>Do not simulate, only elaborate. This may be used with
<samp><span class="option">--disp-tree</span></samp> to display the tree without simulating the whole
design.
<br><dt><code>--vcd=</code><var>FILENAME</var><br><dt><code>--vcdgz=</code><var>FILENAME</var><dd><a name="index-g_t_0040option_007b_002d_002dvcd_007d-option-83"></a><a name="index-g_t_0040option_007b_002d_002dvcdgz_007d-option-84"></a><a name="index-vcd-85"></a><a name="index-value-change-dump-86"></a><a name="index-dump-of-signals-87"></a><samp><span class="option">--vcd</span></samp> dumps into the VCD file <var>FILENAME</var> the signal
values before each non-delta cycle. If <var>FILENAME</var> is `<samp><span class="samp">-</span></samp>',
then the standard output is used, otherwise a file is created or
overwritten.
<p>The <samp><span class="option">--vcdgz</span></samp> option is the same as the <samp><span class="option">--vcd</span></samp> option,
but the output is compressed using the <code>zlib</code> (<code>gzip</code>
compression). However, you can't use the `<samp><span class="samp">-</span></samp>' filename.
Furthermore, only one VCD file can be written.
<p><dfn>VCD</dfn> (value change dump) is a file format defined
by the <code>verilog</code> standard and used by virtually any wave viewer.
<p>Since it comes from <code>verilog</code>, only a few VHDL types can be dumped. GHDL
dumps only signals whose base type is of the following:
<ul>
<li>types defined in the `<samp><span class="samp">std.standard</span></samp>' package:
<ul>
<li>`<samp><span class="samp">bit</span></samp>'
<li>`<samp><span class="samp">bit_vector</span></samp>'
</ul>
<li>types defined in the `<samp><span class="samp">ieee.std_logic_1164</span></samp>' package:
<ul>
<li>`<samp><span class="samp">std_ulogic</span></samp>'
<li>`<samp><span class="samp">std_logic</span></samp>' (because it is a subtype of `<samp><span class="samp">std_ulogic</span></samp>')
<li>`<samp><span class="samp">std_ulogic_vector</span></samp>'
<li>`<samp><span class="samp">std_logic_vector</span></samp>'
</ul>
<li>any integer type
</ul>
<p>I have successfully used <code>gtkwave</code> to view VCD files.
<p>Currently, there is no way to select signals to be dumped: all signals are
dumped, which can generate big files.
<p>It is very unfortunate there is no standard or well-known wave file
format supporting VHDL types. If you are aware of such a free format,
please mail me (see <a href="#Reporting-bugs">Reporting bugs</a>).
<br><dt><code>--wave=</code><var>FILENAME</var><dd><a name="index-g_t_0040option_007b_002d_002dwave_007d-option-88"></a>Write the waveforms into a <code>ghw</code> (GHdl Waveform) file. Currently, all
the signals are dumped into the waveform file, you cannot select a hierarchy
of signals to be dumped.
<p>The format of this file was defined by myself and is not yet completly fixed.
It may change slightly.
<p>There is a patch against <code>gtkwave 1.3.72</code> on the ghdl website at
<a href="ghdl.free.fr">ghdl.free.fr</a>, so that it can read such files.
<p>Contrary to VCD files, any VHDL type can be dumped into a GHW file.
<br><dt><code>--sdf=</code><var>PATH</var><code>=</code><var>FILENAME</var><br><dt><code>--sdf=min=</code><var>PATH</var><code>=</code><var>FILENAME</var><br><dt><code>--sdf=typ=</code><var>PATH</var><code>=</code><var>FILENAME</var><br><dt><code>--sdf=max=</code><var>PATH</var><code>=</code><var>FILENAME</var><dd><a name="index-g_t_0040option_007b_002d_002dsdf_007d-option-89"></a>Do VITAL annotation on <var>PATH</var> with SDF file <var>FILENAME</var>.
<p><var>PATH</var> is a path of instances, separated with `<samp><span class="samp">.</span></samp>' or `<samp><span class="samp">/</span></samp>'.
Any separator can be used. Instances are component instantiation labels,
generate labels or block labels. Currently, you cannot use an indexed name.
<p>If the option contains a type of delay, that is <samp><span class="option">min=</span></samp>,
<samp><span class="option">typ=</span></samp> or <samp><span class="option">max=</span></samp>, the annotator use respectively minimum,
typical or maximum values. If the option does not contain a type of delay,
the annotator use the typical delay.
<p>See <a href="#Backannotation">Backannotation</a>, for more details.
<br><dt><code>--stack-max-size=</code><var>SIZE</var><dd><a name="index-g_t_0040option_007b_002d_002dstack_002dmax_002dsize_007d-option-90"></a>Set the maximum size in bytes of the non-sensitized processes stacks.
<p>If the value <var>SIZE</var> is followed (without any space) by the `<samp><span class="samp">k</span></samp>',
`<samp><span class="samp">K</span></samp>', `<samp><span class="samp">kb</span></samp>', `<samp><span class="samp">Kb</span></samp>', `<samp><span class="samp">ko</span></samp>' or `<samp><span class="samp">Ko</span></samp>' multiplier, then
the size is the numeric value multiplied by 1024.
<p>If the value <var>SIZE</var> is followed (without any space) by the `<samp><span class="samp">m</span></samp>',
`<samp><span class="samp">M</span></samp>', `<samp><span class="samp">mb</span></samp>', `<samp><span class="samp">Mb</span></samp>', `<samp><span class="samp">mo</span></samp>' or `<samp><span class="samp">Mo</span></samp>' multiplier, then
the size is the numeric value multiplied by 1024 * 1024 = 1048576.
<p>Each non-sensitized process has its own stack, while the sensitized processes
share the same and main stack. This stack is the stack created by the
operating system.
<p>Using too small stacks may result in simulation failure due to lack of memory.
Using too big stacks may reduce the maximum number of processes.
<br><dt><code>--stack-size=</code><var>SIZE</var><dd><a name="index-g_t_0040option_007b_002d_002dstack_002dsize_007d-option-91"></a>Set the initial size in bytes of the non-sensitized processes stack.
The <var>SIZE</var> value has the same format as the previous option.
<p>The stack of the non-sensitized processes grows until reaching the
maximum size limit.
<br><dt><code>--help</code><dd>Display a short description of the options accepted by the run time library.
</dl>
<div class="node">
<p><hr>
<a name="Debugging-VHDL-programs"></a>
Previous: <a rel="previous" accesskey="p" href="#Simulation-options">Simulation options</a>,
Up: <a rel="up" accesskey="u" href="#Simulation-and-run-time">Simulation and run time</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">4.2 Debugging VHDL programs</h3>
<p><a name="index-debugging-92"></a><a name="index-g_t_0040code_007b_005f_005fghdl_005ffatal_007d-93"></a>Debugging VHDL programs usign <code>GDB</code> is possible only on GNU/Linux systems.
<p><code>GDB</code> is a general purpose debugger for programs compiled by <code>GCC</code>.
Currently, there is no VHDL support for <code>GDB</code>. It may be difficult
to inspect variables or signals in <code>GDB</code>, however, <code>GDB</code> is
still able to display the stack frame in case of error or to set a breakpoint
at a specified line.
<p><code>GDB</code> can be useful to precisely catch a run-time error, such as indexing
an array beyond its bounds. All error check subprograms call the
<code>__ghdl_fatal</code> procedure. Therefore, to catch run-time error, set
a breakpoint like this:
<pre class="smallexample"> (gdb) break __ghdl_fatal
</pre>
<p>When the breakpoint is hit, use the <code>where</code> or <code>bt</code> command to
display the stack frames.
<div class="node">
<p><hr>
<a name="GHDL-implementation-of-VHDL"></a>
Next: <a rel="next" accesskey="n" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>,
Previous: <a rel="previous" accesskey="p" href="#Simulation-and-run-time">Simulation and run time</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">5 GHDL implementation of VHDL</h2>
<p>This chapter describes several implementation defined aspect of VHDL in GHDL.
<ul class="menu">
<li><a accesskey="1" href="#VHDL-standards">VHDL standards</a>
<li><a accesskey="2" href="#Source-representation">Source representation</a>
<li><a accesskey="3" href="#Library-database">Library database</a>
<li><a accesskey="4" href="#VHDL-files-format">VHDL files format</a>
<li><a accesskey="5" href="#Top-entity">Top entity</a>
<li><a accesskey="6" href="#Using-vendor-libraries">Using vendor libraries</a>
<li><a accesskey="7" href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">Using ieee.math_real or ieee.math_complex</a>
<li><a accesskey="8" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</ul>
<div class="node">
<p><hr>
<a name="VHDL-standards"></a>
Next: <a rel="next" accesskey="n" href="#Source-representation">Source representation</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.1 VHDL standards</h3>
<p><a name="index-VHDL-standards-94"></a><a name="index-IEEE-1076-95"></a><a name="index-IEEE-1076a-96"></a><a name="index-g_t1076-97"></a><a name="index-g_t1076a-98"></a><a name="index-v87-99"></a><a name="index-v93-100"></a><a name="index-v93c-101"></a><a name="index-v00-102"></a><a name="index-v02-103"></a>This is very unfortunate, but there are many versions of the VHDL language.
<p>The VHDL language was first standardized in 1987 by IEEE as IEEE 1076-1987, and
is commonly referred as VHDL-87. This is certainly the most important version,
since most of the VHDL tools are still based on this standard.
<p>Various problems of this first standard have been analyzed by experts groups
to give reasonable ways of interpreting the unclear portions of the standard.
<p>VHDL was revised in 1993 by IEEE as IEEE 1076-1993. This revision is still
well-known.
<p>Unfortunatly, VHDL-93 is not fully compatible with VHDL-87, ie some perfectly
valid VHDL-87 programs are invalid VHDL-93 programs. Here are some of the
reasons:
<ul>
<li>the syntax of file declaration has changed (this is the most visible source
of incompatibility),
<li>new keywords were introduced (group, impure, inertial, literal,
postponed, pure, reject, rol, ror, shared, sla, sll, sra, srl,
unaffected, xnor),
<li>some dynamic behaviours have changed (the concatenation is one of them),
<li>rules have been added.
</ul>
<p>Shared variables were replaced by protected types in the 2000 revision of
the VHDL standard. This modification is also known as 1076a. Note that this
standard is not fully backward compatible with VHDL-93, since the type of a
shared variable must now be a protected type (there was no such restriction
before).
<p>Minors corrections were added by the 2002 revision of the VHDL standard. This
revision is not fully backward compatible with VHDL-00 since, for example,
the value of the <code>'instance_name</code> attribute has slighly changed.
<p>You can select the VHDL standard expected by GHDL with the
`<samp><span class="samp">--std=VER</span></samp>' option, where <var>VER</var> is one of the left column of the
table below:
<dl>
<dt>`<samp><span class="samp">87</span></samp>'<dd>Select VHDL-87 standard as defined by IEEE 1076-1987. LRM bugs corrected by
later revisions are taken into account.
<br><dt>`<samp><span class="samp">93</span></samp>'<dd>Select VHDL-93; VHDL-87 file declarations are not accepted.
<br><dt>`<samp><span class="samp">93c</span></samp>'<dd>Select VHDL-93 standard with relaxed rules:
<ul>
<li>VHDL-87 file declarations are accepted;
<li>default binding indication rules of VHDL-02 are used. Default binding rules
are often used, but they are particulary obscure before VHDL-02.
</ul>
<br><dt>`<samp><span class="samp">00</span></samp>'<dd>Select VHDL-2000 standard, which adds protected types.
<br><dt>`<samp><span class="samp">02</span></samp>'<dd>Select VHDL-2002 standard (partially implemented).
</dl>
<p>You cannot mix VHDL-87 and VHDL-93 units. A design hierarchy must have been
completly analyzed using either the 87 or the 93 version of the VHDL standard.
<div class="node">
<p><hr>
<a name="Source-representation"></a>
Next: <a rel="next" accesskey="n" href="#Library-database">Library database</a>,
Previous: <a rel="previous" accesskey="p" href="#VHDL-standards">VHDL standards</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.2 Source representation</h3>
<p>According to the VHDL standard, design units (i.e. entities,
architectures, packages, package bodies and configurations) may be
independently analyzed.
<p>Several design units may be grouped into a design file.
<p>In GHDL, a system file represents a design file. That is, a file compiled by
GHDL may contain one or more design units.
<p>It is common to have several design units in a design file.
<p>GHDL does not impose any restriction on the name of a design file
(except that the file name may not contain any control character or
spaces).
<p>GHDL do not keep a binary representation of the design units analyzed like
other VHDL analyzers. The sources of the design units are re-read when
needed (for example, an entity is re-read when one of its architecture is
analyzed). Therefore, if you delete or modify a source file of a unit
analyzed, GHDL will refuse to use it.
<div class="node">
<p><hr>
<a name="Library-database"></a>
Next: <a rel="next" accesskey="n" href="#VHDL-files-format">VHDL files format</a>,
Previous: <a rel="previous" accesskey="p" href="#Source-representation">Source representation</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<h3 class="section">5.3 Library database</h3>
<p>Each design unit analyzed is placed into a design library. By default,
the name of this design library is `<samp><span class="samp">work</span></samp>'; however, this can be
changed with the <samp><span class="option">--work=NAME</span></samp> option of GHDL.
<p>To keep the list of design units in a design library, GHDL creates
library files. The name of these files is `<samp><span class="samp">NAME-objVER.cf</span></samp>', where
<var>NAME</var> is the name of the library, and <var>VER</var> the VHDL version (87
or 93) used to analyze the design units.
<p>You don't have to know how to read a library file. You can display it
using the <samp><span class="option">-d</span></samp> of <code>ghdl</code>. The file contains the name of the
design units, as well as the location and the dependences.
<p>The format may change with the next version of GHDL.
<div class="node">
<p><hr>
<a name="VHDL-files-format"></a>
Next: <a rel="next" accesskey="n" href="#Top-entity">Top entity</a>,
Previous: <a rel="previous" accesskey="p" href="#Library-database">Library database</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.4 VHDL files format</h3>
<p><a name="index-file-format-104"></a><a name="index-logical-name-105"></a>VHDL has features to handle files.
<p>GHDL associates a file logical name (the VHDL file name) to an operating
system file name. The logical name `<samp><span class="samp">STD_INPUT</span></samp>' is associated to
the standard input as defined by `<samp><span class="samp">stdin</span></samp>' stream of the C library,
while the logical name `<samp><span class="samp">STD_OUTPUT</span></samp>' is associated to the standard
output, as defined by the `<samp><span class="samp">stdout</span></samp>' stream of the C library. Other
logical name are directly mapped to a file name as defined by the first
(`<samp><span class="samp">path</span></samp>') argument of the `<samp><span class="samp">fopen</span></samp>' function of the C library.
For a binary file, the `<samp><span class="samp">b</span></samp>' character is appended to the mode argument
(binary mode).
<p>If multiple file objects are associated with the same external file, a stream
is created for each object, except for the standard input or output.
<p>GHDL has no internal restrictions on the number of file objects that are
associated at one time with a given external file, but the operating system
may restrict the maximum number of file open at the same time.
<p>For more details about these point, please refer to your operation system
documentation.
<!-- tell more about possible errors. -->
<p>There are two kinds of files: binary or text files.
<p>Text files are files of type `<samp><span class="samp">std.textio.text</span></samp>'. The format is the
same as the format of any ascii file. In VHDL-87, only the first 128
characters (7 bits) are allowed, since the character type has only 128
literals. The end of line is system dependent. Note that the stdio
functions with the text mode are used to handle text files: the fgets
function is used to read lines. Please, refer to the manual of your C
library for more information.
<p>There are two kind of binary files, according to the type mark of the
file. According to the VHDL standard, binary files must be read using
the same type they are written.
<p>If the type mark is a non-composite type (integer, floating type
enumeration, physical), the file is a raw stream:
elements are read or written using the same format as is used to represent
the data in memory. This is highly non-portable, but you should be able
to read file written by a non-<code>GHDL</code> program.
<p>If the type mark is a composite type (record or array), the file is composed
of a 2 lines signature, followed by a raw stream.
<div class="node">
<p><hr>
<a name="Top-entity"></a>
Next: <a rel="next" accesskey="n" href="#Using-vendor-libraries">Using vendor libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#VHDL-files-format">VHDL files format</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.5 Top entity</h3>
<p>There are some restrictions on the entity being at the apex of a design
hierarchy:
<ul>
<li>The generic must have a default value, and the value of a generic is its
default value;
<li>The ports type must be constrained.
</ul>
<div class="node">
<p><hr>
<a name="Using-vendor-libraries"></a>
Next: <a rel="next" accesskey="n" href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">Using ieee.math_real or ieee.math_complex</a>,
Previous: <a rel="previous" accesskey="p" href="#Top-entity">Top entity</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.6 Using vendor libraries</h3>
<p>Many vendors libraries have been analyzed with GHDL. There are
usually no problems. Be sure to use the <samp><span class="option">--work=</span></samp> option.
However, some problems have been encountered.
<p>GHDL follows the VHDL LRM (the manual which defines VHDL) more
strictly than other VHDL tools. You could try to relax the
restrictions by using the <samp><span class="option">--std=93c</span></samp>, <samp><span class="option">-fexplicit</span></samp> and
<samp><span class="option">--warn-no-vital-generic</span></samp>.
<p>Even with these relaxations, some broken libraries may fail.
<p>For example, <code>unisim_VITAL.vhd</code> from <code>Xilinx</code> can't be
compiled because lines such as:
<pre class="smallexample"> variable Write_A_Write_B : memory_collision_type := Write_A_Write_B;
variable Read_A_Write_B : memory_collision_type := Read_A_Write_B;
</pre>
<p>(there are 6 such lines).
According to VHDL visibility rules, `<samp><span class="samp">Write_A_Write_B</span></samp>' cannot be used
while it is defined. This is very logical because it prevents from silly
declarations such as
<pre class="smallexample"> constant k : natural := 2 * k;
</pre>
<p>This files must be modified. Fortunatly, in the example the variables
are never written. So it is enough to remove them.
<div class="node">
<p><hr>
<a name="Using-ieee.math_real-or-ieee.math_complex"></a>
<a name="Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex"></a>
Next: <a rel="next" accesskey="n" href="#Interfacing-to-other-languages">Interfacing to other languages</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-vendor-libraries">Using vendor libraries</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.7 Using ieee.math_real or ieee.math_complex</h3>
<p><a name="index-math_005freal-106"></a><a name="index-math_005fcomplex-107"></a>Contrary to other `<samp><span class="samp">ieee</span></samp>' libraries, the math packages sources are not
freely available. The sources provided with GHDL are based on an early draft
and use the C libraries. As a consequence, you should link your design
with the `<samp><span class="samp">libm.a</span></samp>' library using the <samp><span class="option">-Wl,</span></samp> option like:
<pre class="smallexample"> $ ghdl -e -Wl,-lm my_design
</pre>
<p>Please, refer to your system manual for more details.
<p>Please also note that the `<samp><span class="samp">ieee</span></samp>' libraries are not the same as the drafts.
<p>If you really need the `<samp><span class="samp">ieee</span></samp>' math libraries, they are available on the
web, but they cannot be included in GHDL.
<div class="node">
<p><hr>
<a name="Interfacing-to-other-languages"></a>
Previous: <a rel="previous" accesskey="p" href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">Using ieee.math_real or ieee.math_complex</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">5.8 Interfacing to other languages</h3>
<p><a name="index-interfacing-108"></a><a name="index-other-languages-109"></a><a name="index-foreign-110"></a><a name="index-VHPI-111"></a><a name="index-VHPIDIRECT-112"></a>Interfacing with foreign languages is possible only on GNU/Linux systems.
<p>You can define a subprogram in a foreign language (such as <code>C</code> or
<code>Ada</code>) and import it in a VHDL design.
<h4 class="subsection">5.8.1 Foreign declarations</h4>
<p>Only subprograms (functions or procedures) can be imported, using the foreign
attribute. In this example, the <code>sin</code> function is imported:
<pre class="example"> package math is
function sin (v : real) return real;
attribute foreign of sin : function is "VHPIDIRECT sin";
end math;
package body math is
function sin (v : real) return real is
begin
assert false severity failure;
end sin;
end math;
</pre>
<p>A subprogram is made foreign if the <var>foreign</var> attribute decorates
it. This attribute is declared in the 1993 revision of the
`<samp><span class="samp">std.standard</span></samp>' package. Therefore, you cannot use this feature in
VHDL 1987.
<p>The decoration is achived through an attribute specification. The
attribute specification must be in the same declarative part as the
subprogram and must be after it. This is a general rule for specifications.
The value of the specification must be a locally static string.
<p>Even when a subprogram is foreign, its body must be present. However, since
it won't be called, you can made it empty or simply but an assertion.
<p>The value of the attribute must start with `<samp><span class="samp">VHPIDIRECT </span></samp>' (an
upper-case keyword followed by one or more blanks). The linkage name of the
subprogram follows.
<ul class="menu">
<li><a accesskey="1" href="#Restrictions-on-foreign-declarations">Restrictions on foreign declarations</a>
<li><a accesskey="2" href="#Linking-with-foreign-object-files">Linking with foreign object files</a>
<li><a accesskey="3" href="#Starting-a-simulation-from-a-foreign-program">Starting a simulation from a foreign program</a>
<li><a accesskey="4" href="#Linking-with-Ada">Linking with Ada</a>
<li><a accesskey="5" href="#Using-GRT-from-Ada">Using GRT from Ada</a>
</ul>
<div class="node">
<p><hr>
<a name="Restrictions-on-foreign-declarations"></a>
Next: <a rel="next" accesskey="n" href="#Linking-with-foreign-object-files">Linking with foreign object files</a>,
Previous: <a rel="previous" accesskey="p" href="#Interfacing-to-other-languages">Interfacing to other languages</a>,
Up: <a rel="up" accesskey="u" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</div>
<h4 class="subsection">5.8.2 Restrictions on foreign declarations</h4>
<p>Any subprogram can be imported. GHDL puts no restrictions on foreign
subprograms. However, the representation of a type or of an interface in a
foreign language may be obscur. Most of non-composite types are easily imported:
<dl>
<dt>`<samp><span class="samp">integer types</span></samp>'<dd>They are represented on a 32 bits word. This generally corresponds to
<code>int</code> for <code>C</code> or <code>Integer</code> for <code>Ada</code>.
<br><dt>`<samp><span class="samp">physical types</span></samp>'<dd>They are represented on a 64 bits word. This generally corresponds to the
<code>long long</code> for <code>C</code> or <code>Long_Long_Integer</code> for <code>Ada</code>.
<br><dt>`<samp><span class="samp">floating point types</span></samp>'<dd>They are represented on a 64 bits floating point word. This generally
corresponds to <code>double</code> for <code>C</code> or <code>Long_Float</code> for <code>Ada</code>.
<br><dt>`<samp><span class="samp">enumeration types</span></samp>'<dd>They are represented on 8 bits or 32 bits word, if the number of literals is
greater than 256. There is no corresponding C types, since arguments are
not promoted.
</dl>
<p>Non-composite types are passed by value. For the <code>in</code> mode, this
corresponds to the <code>C</code> or <code>Ada</code> mechanism. The <code>out</code> and
<code>inout</code> interfaces of non-composite types are gathered in a record
and this record is passed by reference as the first argument to the
subprogram. As a consequence, you shouldn't use <code>in</code> and
<code>inout</code> modes in foreign subprograms, since they are not portable.
<p>Records are represented like a <code>C</code> structure and are passed by reference
to subprograms.
<p>Arrays with static bounds are represented like a <code>C</code> array, whose
length is the number of elements, and are passed by reference to subprograms.
<p>Unconstrained array are represented by a fat pointer. Do not use unconstrained
arrays in foreign subprograms.
<p>Accesses to an unconstrained array is a fat pointer. Other accesses corresponds a an address and are passed to a subprogram like other non-composite types.
<p>Files are represented by a 32 bits word, which corresponds to an index
in a table.
<div class="node">
<p><hr>
<a name="Linking-with-foreign-object-files"></a>
Next: <a rel="next" accesskey="n" href="#Starting-a-simulation-from-a-foreign-program">Starting a simulation from a foreign program</a>,
Previous: <a rel="previous" accesskey="p" href="#Restrictions-on-foreign-declarations">Restrictions on foreign declarations</a>,
Up: <a rel="up" accesskey="u" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</div>
<h4 class="subsection">5.8.3 Linking with foreign object files</h4>
<p>You may add additionnal files or options during the link using the
<samp><span class="option">-Wl,</span></samp> of <code>GHDL</code>, as described in <a href="#Elaboration-command">Elaboration command</a>.
For example:
<pre class="example"> $ ghdl -e -Wl,-lm math_tb
</pre>
<p>will create the <samp><span class="file">math_tb</span></samp> executable with the <samp><span class="file">lm</span></samp> (mathematical)
library.
<p>Note the <samp><span class="file">c</span></samp> library is always linked with an executable.
<div class="node">
<p><hr>
<a name="Starting-a-simulation-from-a-foreign-program"></a>
Next: <a rel="next" accesskey="n" href="#Linking-with-Ada">Linking with Ada</a>,
Previous: <a rel="previous" accesskey="p" href="#Linking-with-foreign-object-files">Linking with foreign object files</a>,
Up: <a rel="up" accesskey="u" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</div>
<h4 class="subsection">5.8.4 Starting a simulation from a foreign program</h4>
<p>You main run your design from an external program. You just have to call
the `<samp><span class="samp">ghdl_main</span></samp>' function which can be defined:
<p>in C:
<pre class="smallexample"> extern int ghdl_main (int argc, char **argv);
</pre>
<p>in Ada:
<pre class="smallexample"> with System;
...
function Ghdl_Main (Argc : Integer; Argv : System.Address)
return Integer;
pragma import (C, Ghdl_Main, "ghdl_main");
</pre>
<p>This function must be called once, and returns 0 at the end of the simulation.
In case of failure, this function does not return. This has to be fixed.
<div class="node">
<p><hr>
<a name="Linking-with-Ada"></a>
Next: <a rel="next" accesskey="n" href="#Using-GRT-from-Ada">Using GRT from Ada</a>,
Previous: <a rel="previous" accesskey="p" href="#Starting-a-simulation-from-a-foreign-program">Starting a simulation from a foreign program</a>,
Up: <a rel="up" accesskey="u" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</div>
<h4 class="subsection">5.8.5 Linking with Ada</h4>
<p>As explained previously in <a href="#Starting-a-simulation-from-a-foreign-program">Starting a simulation from a foreign program</a>,
you can start a simulation from an <code>Ada</code> program. However the build
process is not trivial: you have to elaborate your <code>Ada</code> program and your
<code>VHDL</code> design.
<p>First, you have to analyze all your design files. In this example, we
suppose there is only one design file, <samp><span class="file">design.vhdl</span></samp>.
<pre class="smallexample"> $ ghdl -a design.vhdl
</pre>
<p>Then, bind your design. In this example, we suppose the entity at the
design apex is `<samp><span class="samp">design</span></samp>'.
<pre class="smallexample"> $ ghdl --bind design
</pre>
<p>Finally, compile, bind your <code>Ada</code> program at link it with your <code>VHDL</code>
design:
<pre class="smallexample"> $ gnatmake my_prog -largs `ghdl --list-link design`
</pre>
<div class="node">
<p><hr>
<a name="Using-GRT-from-Ada"></a>
Previous: <a rel="previous" accesskey="p" href="#Linking-with-Ada">Linking with Ada</a>,
Up: <a rel="up" accesskey="u" href="#Interfacing-to-other-languages">Interfacing to other languages</a>
</div>
<!-- node-name, next, previous, up -->
<h4 class="subsection">5.8.6 Using GRT from Ada</h4>
<blockquote>
<b>Warning:</b> This topic is only for advanced users knowing how to use <code>Ada</code>
and <code>GNAT</code>. This is provided only for reference, I have tested
this once before releasing <code>GHDL</code> 0.19 but this is not checked at
each release.
</blockquote>
<p>The simulator kernel of <code>GHDL</code> named <dfn>GRT</dfn> is written in
<code>Ada95</code> and contains a very light and slighly adapted version
of <code>VHPI</code>. Since it is an <code>Ada</code> implementation it is
called <dfn>AVHPI</dfn>. Although being tough, you may interface to <code>AVHPI</code>.
<p>For using <code>AVHPI</code>, you need the sources of <code>GHDL</code> and to recompile
them (at least the <code>GRT</code> library). This library is usually compiled with
a <code>No_Run_Time</code> pragma, so that the user does not need to install the
<code>GNAT</code> run time library. However, you certainly want to use the usual
run time library and want to avoid this pragma. For this, reset the
<var>GRT_PRAGMA_FLAG</var> variable.
<pre class="smallexample"> $ make GRT_PRAGMA_FLAG= grt-all
</pre>
<p>Since <code>GRT</code> is a self-contained library, you don't want
<code>gnatlink</code> to fetch individual object files (furthermore this
doesn't always work due to tricks used in <code>GRT</code>). For this,
remove all the object files and make the <samp><span class="file">.ali</span></samp> files read-only.
<pre class="smallexample"> $ rm *.o
$ chmod -w *.ali
</pre>
<p>You may then install the sources files and the <samp><span class="file">.ali</span></samp> files. I have never
tested this step.
<p>You are now ready to use it.
<p>For example, here is an example, <samp><span class="file">test_grt.adb</span></samp> which displays the top
level design name.
<pre class="example"> with System; use System;
with Grt.Avhpi; use Grt.Avhpi;
with Ada.Text_IO; use Ada.Text_IO;
with Ghdl_Main;
procedure Test_Grt is
-- VHPI handle.
H : VhpiHandleT;
Status : Integer;
-- Name.
Name : String (1 .. 64);
Name_Len : Integer;
begin
-- Elaborate and run the design.
Status := Ghdl_Main (0, Null_Address);
-- Display the status of the simulation.
Put_Line ("Status is " & Integer'Image (Status));
-- Get the root instance.
Get_Root_Inst(H);
-- Disp its name using vhpi API.
Vhpi_Get_Str (VhpiNameP, H, Name, Name_Len);
Put_Line ("Root instance name: " & Name (1 .. Name_Len));
end Test_Grt;
</pre>
<p>First, analyze and bind your design:
<pre class="smallexample"> $ ghdl -a counter.vhdl
$ ghdl --bind counter
</pre>
<p>Then build the whole:
<pre class="smallexample"> $ gnatmake test_grt -aL<var>grt_ali_path</var> -aI<var>grt_src_path</var> -largs
`ghdl --list-link counter`
</pre>
<p>Finally, run your design:
<pre class="smallexample"> $ ./test_grt
Status is 0
Root instance name: counter
</pre>
<div class="node">
<p><hr>
<a name="GHDL-implementation-of-VITAL"></a>
Next: <a rel="next" accesskey="n" href="#Flaws-and-bugs-report">Flaws and bugs report</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-implementation-of-VHDL">GHDL implementation of VHDL</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">6 GHDL implementation of VITAL</h2>
<p><a name="index-VITAL-113"></a><a name="index-IEEE-1076_002e4-114"></a><a name="index-g_t1076_002e4-115"></a>This chapter describes how VITAL is implemented in GHDL. Support of VITAL is
really in a preliminary stage. Do not expect too much of it as now.
<ul class="menu">
<li><a accesskey="1" href="#VITAL-packages">VITAL packages</a>
<li><a accesskey="2" href="#VHDL-restrictions-for-VITAL">VHDL restrictions for VITAL</a>
<li><a accesskey="3" href="#Backannotation">Backannotation</a>
<li><a accesskey="4" href="#Negative-constraint-calculation">Negative constraint calculation</a>
</ul>
<div class="node">
<p><hr>
<a name="VITAL-packages"></a>
Next: <a rel="next" accesskey="n" href="#VHDL-restrictions-for-VITAL">VHDL restrictions for VITAL</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.1 VITAL packages</h3>
<p>The VITAL standard or IEEE 1076.4 was first published in 1995, and revised in
2000.
<p>The version of the VITAL packages depends on the VHDL standard. VITAL
1995 packages are used with the VHDL 1987 standard, while VITAL 2000
packages are used with other standards. This choice is based on the
requirements of VITAL: VITAL 1995 requires the models follow the VHDL
1987 standard, while VITAL 2000 requires the models follow VHDL 1993.
<p>The VITAL 2000 packages were slighly modified so that they conform to
the VHDL 1993 standard (a few functions are made pure and a few one
impure).
<div class="node">
<p><hr>
<a name="VHDL-restrictions-for-VITAL"></a>
Next: <a rel="next" accesskey="n" href="#Backannotation">Backannotation</a>,
Previous: <a rel="previous" accesskey="p" href="#VITAL-packages">VITAL packages</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.2 VHDL restrictions for VITAL</h3>
<p>The VITAL standard (partially) implemented is the IEEE 1076.4 standard
published in 1995.
<p>This standard defines restriction of the VHDL language usage on VITAL
model. A <dfn>VITAL model</dfn> is a design unit (entity or architecture)
decorated by the <code>VITAL_Level0</code> or <code>VITAL_Level1</code> attribute.
These attributes are defined in the <code>ieee.VITAL_Timing</code> package.
<p>Currently, only VITAL level 0 checks are implemented. VITAL level 1 models
can be analyzed, but GHDL doesn't check they comply with the VITAL standard.
<p>Moreover, GHDL doesn't check (yet) that timing generics are not read inside
a VITAL level 0 model prior the VITAL annotation.
<p>The analysis of a non-conformant VITAL model fails. You can disable the
checks of VITAL restrictions with the <samp><span class="option">--no-vital-checks</span></samp>. Even when
restrictions are not checked, SDF annotation can be performed.
<div class="node">
<p><hr>
<a name="Backannotation"></a>
Next: <a rel="next" accesskey="n" href="#Negative-constraint-calculation">Negative constraint calculation</a>,
Previous: <a rel="previous" accesskey="p" href="#VHDL-restrictions-for-VITAL">VHDL restrictions for VITAL</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.3 Backannotation</h3>
<p><a name="index-SDF-116"></a><dfn>Backannotation</dfn> is the process of setting VITAL generics with timing
information provided by an external files.
<p>The external files must be SDF (Standard Delay Format) files. GHDL
supports a tiny subset of SDF version 2.1, other version number can be
used, provided no features added by the next version are used.
<p>Hierarchical instance names are not supported. However you can use a list of
instances. If there is no instance, the top entity will be annotated and
the celltype must be the name of the top entity. If there is at least one
instance, the last instance name must be a component instantiation labe, and
the celltype must be the name of the component declaration instantiated.
<p>Instances being annotated are not required to be VITAL compliant. However
generics being annotated must follow rules of VITAL (eg, type must be a
suitable vital delay type).
<p>Currently, only timing constraints applying on a timing generic of type
<code>VitalDelayType01</code> has been implemented. This SDF annotator is
just a proof of concept. Features will be added with the following GHDL
release.
<div class="node">
<p><hr>
<a name="Negative-constraint-calculation"></a>
Previous: <a rel="previous" accesskey="p" href="#Backannotation">Backannotation</a>,
Up: <a rel="up" accesskey="u" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.4 Negative constraint calculation</h3>
<p>Negative constraint delay adjustement are necessary to handle negative
constraint such as a negative setup time. This step is defined in the VITAL
standard and should occurs after backannotation.
<p>GHDL does not do negative constraint calculation. It fails to handle models
with negative constraint. I hope to be able to add this phase soon.
<div class="node">
<p><hr>
<a name="Flaws-and-bugs-report"></a>
Next: <a rel="next" accesskey="n" href="#Copyrights">Copyrights</a>,
Previous: <a rel="previous" accesskey="p" href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">7 Flaws and bugs report</h2>
<p>The current version of GHDL is really a beta version. Some features of
VHDL have not been implemented or are only partially implemented. Besides,
GHDL has not been extensively tested yet.
<ul class="menu">
<li><a accesskey="1" href="#Deficiencies">Deficiencies</a>
<li><a accesskey="2" href="#Reporting-bugs">Reporting bugs</a>
<li><a accesskey="3" href="#Future-improvements">Future improvements</a>
</ul>
<div class="node">
<p><hr>
<a name="Deficiencies"></a>
Next: <a rel="next" accesskey="n" href="#Reporting-bugs">Reporting bugs</a>,
Previous: <a rel="previous" accesskey="p" href="#Flaws-and-bugs-report">Flaws and bugs report</a>,
Up: <a rel="up" accesskey="u" href="#Flaws-and-bugs-report">Flaws and bugs report</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">7.1 Deficiencies</h3>
<p>Here is the non-exhaustive list of flaws:
<ul>
<li>So far, <code>GHDL</code> has been compiled and tested only on `<samp><span class="samp">i386-linux</span></samp>' systems.
<li>Overflow detection is not yet implemented.
<li>Some contraint checks are missing.
<li>VHDL-93 is not completly implemented.
<li>There are no checks for elaboration order.
<li>This list is not exhaustive.
<li><small class="dots">...</small>
</ul>
<div class="node">
<p><hr>
<a name="Reporting-bugs"></a>
Next: <a rel="next" accesskey="n" href="#Future-improvements">Future improvements</a>,
Previous: <a rel="previous" accesskey="p" href="#Deficiencies">Deficiencies</a>,
Up: <a rel="up" accesskey="u" href="#Flaws-and-bugs-report">Flaws and bugs report</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">7.2 Reporting bugs</h3>
<p>In order to improve GHDL, we welcome bugs report and suggestions for
any aspect of GHDL. Please use the bug tracker on
<<code>http://gna.org/projects/ghdl</code>>. You may also send an
email to <a href="mailto:ghdl@free.fr">ghdl@free.fr</a>.
<p>If the compiler crashes, this is a bug. Reliable tools never crash.
<p>If your compiled VHDL executable crashes, this may be a bug at
run time or the code produced may be wrong. However, since VHDL
has a notion of pointers, an erroneous VHDL program (using invalid
pointers for example) may crash.
<p>If the compiler emits an error message for a perfectly valid input or
does not emit an error message for an invalid input, this may be a bug.
Please send the input file and what you expected. If you know the LRM
well enough, please specify the paragraph which has not been well
implemented. If you don't know the LRM, maybe your bug report will be
rejected simply because there is no bug. In the latter case, it may be
difficult to discuss the issue; and comparisons with other VHDL tools
is not a very strong argument.
<p>If a compiler message is not clear enough for you, please tell me. The
error messages can be improved, but I have not enough experience with
them.
<p>If you have found a mistake in the manual, please send a comment. If
you have not understood some parts of this manual, please tell me.
English is not my mother tongue, so this manual may not be well-written.
Again, rewriting part of it is a good way to improve it.
<p>If you send a <code>VHDL</code> file producing a bug, it is a good idea to try
to make it as short as possible. It is also a good idea to make it
looking like a test: write a comment which explains wether the file
should compile, and if yes, whether or not it should run successfully.
In the latter case, an assert statement should finish the test; the
severity level note indicates success, while a severity level failure
indicates failure.
<p>For bug reports, please include enough information for the maintainers to
reproduce the problem. This includes:
<ul>
<li>the version of <code>GHDL</code> (you can get it with `<samp><span class="samp">ghdl --version</span></samp>').
<li>the operating system
<li>whether you have built <code>GHDL</code> from sources or used the binary
distribution.
<li>the content of the input files
<li>a description of the problem and samples of any erroneous input
<li>anything else that you think would be helpful.
</ul>
<div class="node">
<p><hr>
<a name="Future-improvements"></a>
Previous: <a rel="previous" accesskey="p" href="#Reporting-bugs">Reporting bugs</a>,
Up: <a rel="up" accesskey="u" href="#Flaws-and-bugs-report">Flaws and bugs report</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">7.3 Future improvements</h3>
<p>I have several axes for <code>GHDL</code> improvements:
<ul>
<li>Documentation.
<li>Better diagnostics messages (warning and error).
<li>Full support of VHDL-87 and VHDL-93.
<li>Support of VHDL-02.
<li>Optimization (simulation speed).
<li>Graphical tools (to see waves and to debug)
<li>Style checks
<li>VITAL acceleration
</ul>
<!-- And without any order: -->
<!-- VHPI -->
<!-- FOREIGN -->
<!-- AMS -->
<!-- verilog -->
<div class="node">
<p><hr>
<a name="Copyrights"></a>
Next: <a rel="next" accesskey="n" href="#Index">Index</a>,
Previous: <a rel="previous" accesskey="p" href="#Flaws-and-bugs-report">Flaws and bugs report</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- node-name, next, previous, up -->
<h2 class="chapter">8 Copyrights</h2>
<p>The GHDL front-end, the `<samp><span class="samp">std.textio</span></samp>' package and the run-time
library (grt) are copyrighted Tristan Gingold, come with <em>absolutely
no warranty</em>, and are distributed under the conditions of the General
Public License.
<p>The `<samp><span class="samp">ieee.numeric_bit</span></samp>' and `<samp><span class="samp">ieee.numeric_std</span></samp>' packages are
copyrighted by the IEEE. The source files may be distributed without
change, except as permitted by the standard.
<!-- FIXME: this sounds strange -->
This source file may not be
sold or distributed for profit. See the source file and the IEEE 1076.3
standard for more information.
<p>The `<samp><span class="samp">ieee.std_logic_1164</span></samp>' package is copyrighted by the IEEE. See
source file and the IEEE 1164 standard for more information.
<p>The `<samp><span class="samp">ieee.VITAL_Primitives</span></samp>', `<samp><span class="samp">ieee.VITAL_Timing</span></samp>' and
`<samp><span class="samp">ieee.VITAL_Memory</span></samp>' packages are copyrighted by IEEE. See source
file and the IEEE 1076.4 standards for more information.
<p>The `<samp><span class="samp">ieee.Math_Real</span></samp>' and `<samp><span class="samp">ieee.Math_Complex</span></samp>' packages are
copyrighted by IEEE. These are draft versions which may used and distributed
without restriction. These packages cannot be sold or distributed for profit.
See source files for more information.
<p>The packages `<samp><span class="samp">std_logic_arith</span></samp>', <!-- @samp{std_logic_misc}, -->
`<samp><span class="samp">std_logic_signed</span></samp>', `<samp><span class="samp">std_logic_unsigned</span></samp>' and
`<samp><span class="samp">std_logic_textio</span></samp>' contained in the `<samp><span class="samp">synopsys</span></samp>' directory are
copyrighted by Synopsys, Inc. The source files may be used and
distributed without restriction provided that the copyright statements
are not removed from the files and that any derivative work contains the
copyright notice. See the source files for more information.
<p>The package `<samp><span class="samp">std_logic_arith</span></samp>' contained in the `<samp><span class="samp">mentor</span></samp>'
directory is copyrighted by Mentor Graphics. The source files may be
distributed in whole without restriction provided that the copyright
statement is not removed from the file and that any derivative work
contains this copyright notice. See the source files for more information.
<p>As a consequence of the run-time copyright, you may not be allowed to
distribute an executable produced by <code>GHDL</code> without the VHDL
sources. To my mind, this is not a real restriction, since there is no
points in distributing VHDL executable. Please, send a comment
(see <a href="#Reporting-bugs">Reporting bugs</a>) if you don't like this policy.
<div class="node">
<p><hr>
<a name="Index"></a>
Previous: <a rel="previous" accesskey="p" href="#Copyrights">Copyrights</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-g_t_0040option_007b_002d_002dassert_002dlevel_007d-option-75"><samp><span class="option">--assert-level</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dbind_007d-command-10"><samp><span class="option">--bind</span></samp> command</a>: <a href="#Bind-command">Bind command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dchop_007d-command-65"><samp><span class="option">--chop</span></samp> command</a>: <a href="#Chop-command">Chop command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dclean_007d-command-58"><samp><span class="option">--clean</span></samp> command</a>: <a href="#Clean-command">Clean command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddisp_002dstandard_007d-command-71"><samp><span class="option">--disp-standard</span></samp> command</a>: <a href="#Disp-standard-command">Disp standard command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddisp_002dtime_007d-option-78"><samp><span class="option">--disp-time</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddisp_002dtree_007d-option-80"><samp><span class="option">--disp-tree</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddispconfig_007d-command-69"><samp><span class="option">--dispconfig</span></samp> command</a>: <a href="#Dispconfig-command">Dispconfig command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002delab_002drun_007d-command-8"><samp><span class="option">--elab-run</span></samp> command</a>: <a href="#Elaborate-and-run-command">Elaborate and run command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dgen_002dmakefile_007d-command-54"><samp><span class="option">--gen-makefile</span></samp> command</a>: <a href="#Generate-Makefile-command">Generate Makefile command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGHLD1_007d-switch-36"><samp><span class="option">--GHLD1</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-command-68"><samp><span class="option">--help</span></samp> command</a>: <a href="#Help-command">Help command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dieee_007d-switch-26"><samp><span class="option">--ieee</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dlines_007d-command-66"><samp><span class="option">--lines</span></samp> command</a>: <a href="#Lines-command">Lines command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dlink_007d-command-12"><samp><span class="option">--link</span></samp> command</a>: <a href="#Link-command">Link command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dlist_002dlink_007d-command-13"><samp><span class="option">--list-link</span></samp> command</a>: <a href="#List-link-command">List link command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002drun_007d-option-82"><samp><span class="option">--no-run</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dvital_002dchecks_007d-switch-32"><samp><span class="option">--no-vital-checks</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dpp_002dhtml_007d-command-61"><samp><span class="option">--pp-html</span></samp> command</a>: <a href="#Pretty-print-command">Pretty print command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dPREFIX_007d-switch-35"><samp><span class="option">--PREFIX</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dremove_007d-command-60"><samp><span class="option">--remove</span></samp> command</a>: <a href="#Remove-command">Remove command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dsdf_007d-option-89"><samp><span class="option">--sdf</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dstack_002dmax_002dsize_007d-option-90"><samp><span class="option">--stack-max-size</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dstack_002dsize_007d-option-91"><samp><span class="option">--stack-size</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dstd_007d-switch-25"><samp><span class="option">--std</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dstop_002ddelta_007d-option-77"><samp><span class="option">--stop-delta</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dstop_002dtime_007d-option-76"><samp><span class="option">--stop-time</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dsyn_002dbinding_007d-switch-34"><samp><span class="option">--syn-binding</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dvcd_007d-option-83"><samp><span class="option">--vcd</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dvcdgz_007d-option-84"><samp><span class="option">--vcdgz</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-command-73"><samp><span class="option">--version</span></samp> command</a>: <a href="#Version-command">Version command</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dvital_002dchecks_007d-switch-33"><samp><span class="option">--vital-checks</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dbinding_007d-switch-42"><samp><span class="option">--warn-binding</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dbody_007d-switch-46"><samp><span class="option">--warn-body</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002ddefault_002dbinding_007d-switch-41"><samp><span class="option">--warn-default-binding</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002ddelayed_002dchecks_007d-switch-45"><samp><span class="option">--warn-delayed-checks</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002derror_007d-switch-49"><samp><span class="option">--warn-error</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dlibrary_007d-switch-43"><samp><span class="option">--warn-library</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dreserved_007d-switch-40"><samp><span class="option">--warn-reserved</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dspecs_007d-switch-47"><samp><span class="option">--warn-specs</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dunused_007d-switch-48"><samp><span class="option">--warn-unused</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwarn_002dvital_002dgeneric_007d-switch-44"><samp><span class="option">--warn-vital-generic</span></samp> switch</a>: <a href="#GHDL-warnings">GHDL warnings</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwave_007d-option-88"><samp><span class="option">--wave</span></samp> option</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dwork_007d-switch-22"><samp><span class="option">--work</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dworkdir_007d-switch-24"><samp><span class="option">--workdir</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-command-2"><samp><span class="option">-a</span></samp> command</a>: <a href="#Analysis-command">Analysis command</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-command-17"><samp><span class="option">-c</span></samp> command</a>: <a href="#Analyze-and-elaborate-command">Analyze and elaborate command</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-command-56"><samp><span class="option">-d</span></samp> command</a>: <a href="#Directory-command">Directory command</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-command-4"><samp><span class="option">-e</span></samp> command</a>: <a href="#Elaboration-command">Elaboration command</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-command-64"><samp><span class="option">-f</span></samp> command</a>: <a href="#Find-command">Find command</a></li>
<li><a href="#index-g_t_0040option_007b_002dfexplicit_007d-switch-31"><samp><span class="option">-fexplicit</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-command-67"><samp><span class="option">-h</span></samp> command</a>: <a href="#Help-command">Help command</a></li>
<li><a href="#index-g_t_0040option_007b_002di_007d-coomand-51"><samp><span class="option">-i</span></samp> coomand</a>: <a href="#Import-command">Import command</a></li>
<li><a href="#index-g_t_0040option_007b_002dm_007d-command-53"><samp><span class="option">-m</span></samp> command</a>: <a href="#Make-command">Make command</a></li>
<li><a href="#index-g_t_0040option_007b_002dP_007d-switch-30"><samp><span class="option">-P</span></samp> switch</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-command-6"><samp><span class="option">-r</span></samp> command</a>: <a href="#Run-command">Run command</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-command-15"><samp><span class="option">-s</span></samp> command</a>: <a href="#Check-syntax-command">Check syntax command</a></li>
<li><a href="#index-g_t_0040option_007b_002dW_007d-switch-37"><samp><span class="option">-W</span></samp> switch</a>: <a href="#Passing-options-to-other-programs">Passing options to other programs</a></li>
<li><a href="#index-g_t_0040option_007b_002dWa_007d-switch-38"><samp><span class="option">-Wa</span></samp> switch</a>: <a href="#Passing-options-to-other-programs">Passing options to other programs</a></li>
<li><a href="#index-g_t_0040option_007b_002dWl_007d-switch-39"><samp><span class="option">-Wl</span></samp> switch</a>: <a href="#Passing-options-to-other-programs">Passing options to other programs</a></li>
<li><a href="#index-g_t1076-97">1076</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-g_t1076_002e3-21">1076.3</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t1076_002e4-115">1076.4</a>: <a href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a></li>
<li><a href="#index-g_t1076a-98">1076a</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-g_t1164-19">1164</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-g_t_0040code_007b_005f_005fghdl_005ffatal_007d-93"><code>__ghdl_fatal</code></a>: <a href="#Debugging-VHDL-programs">Debugging VHDL programs</a></li>
<li><a href="#index-analysis-1">analysis</a>: <a href="#Analysis-command">Analysis command</a></li>
<li><a href="#index-Analyze-and-elaborate-command-16">Analyze and elaborate command</a>: <a href="#Analyze-and-elaborate-command">Analyze and elaborate command</a></li>
<li><a href="#index-binding-9">binding</a>: <a href="#Bind-command">Bind command</a></li>
<li><a href="#index-checking-syntax-14">checking syntax</a>: <a href="#Check-syntax-command">Check syntax command</a></li>
<li><a href="#index-cleaning-57">cleaning</a>: <a href="#Clean-command">Clean command</a></li>
<li><a href="#index-cleaning-all-59">cleaning all</a>: <a href="#Remove-command">Remove command</a></li>
<li><a href="#index-debugging-92">debugging</a>: <a href="#Debugging-VHDL-programs">Debugging VHDL programs</a></li>
<li><a href="#index-display-configuration-70">display configuration</a>: <a href="#Dispconfig-command">Dispconfig command</a></li>
<li><a href="#index-display-design-hierarchy-81">display design hierarchy</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-display-_0040samp_007bstd_002estandard_007d-72">display `<samp><span class="samp">std.standard</span></samp>'</a>: <a href="#Disp-standard-command">Disp standard command</a></li>
<li><a href="#index-display-time-79">display time</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-displaying-library-55">displaying library</a>: <a href="#Directory-command">Directory command</a></li>
<li><a href="#index-dump-of-signals-87">dump of signals</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-elaborate-and-run-7">elaborate and run</a>: <a href="#Elaborate-and-run-command">Elaborate and run command</a></li>
<li><a href="#index-elaboration-3">elaboration</a>: <a href="#Elaboration-command">Elaboration command</a></li>
<li><a href="#index-file-format-104">file format</a>: <a href="#VHDL-files-format">VHDL files format</a></li>
<li><a href="#index-foreign-110">foreign</a>: <a href="#Interfacing-to-other-languages">Interfacing to other languages</a></li>
<li><a href="#index-IEEE-1076-95">IEEE 1076</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-IEEE-1076_002e3-20">IEEE 1076.3</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-IEEE-1076_002e4-114">IEEE 1076.4</a>: <a href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a></li>
<li><a href="#index-IEEE-1076a-96">IEEE 1076a</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-IEEE-1164-18">IEEE 1164</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-ieee-library-27">ieee library</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-importing-files-50">importing files</a>: <a href="#Import-command">Import command</a></li>
<li><a href="#index-interfacing-108">interfacing</a>: <a href="#Interfacing-to-other-languages">Interfacing to other languages</a></li>
<li><a href="#index-linking-11">linking</a>: <a href="#Link-command">Link command</a></li>
<li><a href="#index-logical-name-105">logical name</a>: <a href="#VHDL-files-format">VHDL files format</a></li>
<li><a href="#index-make-52">make</a>: <a href="#Make-command">Make command</a></li>
<li><a href="#index-math_005fcomplex-107">math_complex</a>: <a href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">Using ieee.math_real or ieee.math_complex</a></li>
<li><a href="#index-math_005freal-106">math_real</a>: <a href="#Using-ieee_002emath_005freal-or-ieee_002emath_005fcomplex">Using ieee.math_real or ieee.math_complex</a></li>
<li><a href="#index-mentor-library-29">mentor library</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-other-languages-109">other languages</a>: <a href="#Interfacing-to-other-languages">Interfacing to other languages</a></li>
<li><a href="#index-pretty-printing-62">pretty printing</a>: <a href="#Pretty-print-command">Pretty print command</a></li>
<li><a href="#index-run-5">run</a>: <a href="#Run-command">Run command</a></li>
<li><a href="#index-SDF-116">SDF</a>: <a href="#Backannotation">Backannotation</a></li>
<li><a href="#index-synopsys-library-28">synopsys library</a>: <a href="#GHDL-options">GHDL options</a></li>
<li><a href="#index-v00-102">v00</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-v02-103">v02</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-v87-99">v87</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-v93-100">v93</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-v93c-101">v93c</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-value-change-dump-86">value change dump</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-vcd-85">vcd</a>: <a href="#Simulation-options">Simulation options</a></li>
<li><a href="#index-version-74">version</a>: <a href="#Version-command">Version command</a></li>
<li><a href="#index-VHDL-standards-94">VHDL standards</a>: <a href="#VHDL-standards">VHDL standards</a></li>
<li><a href="#index-vhdl-to-html-63">vhdl to html</a>: <a href="#Pretty-print-command">Pretty print command</a></li>
<li><a href="#index-VHPI-111">VHPI</a>: <a href="#Interfacing-to-other-languages">Interfacing to other languages</a></li>
<li><a href="#index-VHPIDIRECT-112">VHPIDIRECT</a>: <a href="#Interfacing-to-other-languages">Interfacing to other languages</a></li>
<li><a href="#index-VITAL-113">VITAL</a>: <a href="#GHDL-implementation-of-VITAL">GHDL implementation of VITAL</a></li>
<li><a href="#index-WORK-library-23">WORK library</a>: <a href="#GHDL-options">GHDL options</a></li>
</ul></body></html>
|