aboutsummaryrefslogtreecommitdiffstats
path: root/libraries/vendors/README.md
blob: 81a3306bc8fc18bda357abfa5547971dde724d3c (plain)
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
## Compile Scripts for Vendor VHDL Libraries

Vendors like Altera and Xilinx have there own simulation libraries, especially for primitives, soft or hard macros. These libraries can not be shipped with GHDL, but we offer prepared compile scripts to pre-compile a vendor library, if the vendor tool is present on the computer.

There are also popular simulation and verification libraries like [OSVVM][osvvm] and [VUnit][vunit], which can be pre-compile.

The compilation scripts are writen in shell languages: PowerShell for Windows and Bash for Linux. The compile scripts can colorize the GHDL warning and error lines with the help of grc ([generic colourizer][grc]).

 [osvvm]: http://osvvm.org/
 [vunit]: https://github.com/LarsAsplund/vunit
 [grc]: http://kassiopeia.juls.savba.sk/~garabik/software/grc.html

##### Supported Vendors Libraries

 - Altera Quartus-II (15.x):
     - lpm, sgate
     - altera, altera_mf, altera_lnsim
     - arriaii, arriaii_pcie_hip, arriaiigz
     - arriav, arriavgz, arriavgz_pcie_hip
     - cycloneiv, cycloneiv_pcie_hip, cycloneive
     - cyclonev
     - max, maxii, maxv
     - stratixiv, stratixiv_pcie_hip
     - stratixv, stratixv_pcie_hip
     - fiftyfivenm, twentynm
 - Xilinx ISE (14.7):
     - unisim (incl. secureip)
     - unimacro
     - simprim (incl. secureip)
 - Xilinx Vivado (2015.x):
     - unisim (incl. secureip)
     - unimacro

##### Supported Simulation and Verification Libraries

 - OSVVM (for VHDL-2008)
     - osvvm
 - VUnit (for VHDL-2008)
     - vunit_lib

---------------------------------------------------------------------
### Compiling on Linux

 - **Step 1 - Configure the scripts**
    Please open the `config.sh` file and set the dictionary entries for the installed
    vendor tools to the appropriate directory to your tool's installation folder.

    `config.sh`:
    ```Bash
    declare -A InstallationDirectory
    InstallationDirectory[AlteraQuartusII]="/opt/Altera/15.0"
    InstallationDirectory[XilinxISE]="/opt/Xilinx/14.7"
    InstallationDirectory[XilinxVivado]="/opt/Xilinx/Vivado/2015.2"
    InstallationDirectory[OSVVM]="/home/<user>/git/GitHub/osvvm"
    InstallationDirectory[VUnit]="/home/<user>/git/GitHub/vunit"
    ```

 - **Step 2 - Browse to your simulation working directory**
    ```Bash
    $ cd <MySimulationFolder>
    ```

 - **Step 3 - Start the compilation script(s)**
    ```Bash
    $ <GHDL>\libraries\vendors\compile-altera.sh --all
    $ <GHDL>\libraries\vendors\compile-xilinx-ise.sh --all
    $ <GHDL>\libraries\vendors\compile-xilinx-vivado.sh --all
    $ <GHDL>\libraries\vendors\compile-osvvm.sh --all
    $ <GHDL>\libraries\vendors\compile-vunit.sh --all
    ```

 - **Step 4 - Viewing the result**
    This creates vendor directories in your current working directory and compiles the vendor files into them.

    ```Bash
    $ ls -ahl
    ...
    drwxr-xr-x  2 <user> <group>  56K Nov 30 17:41 altera
    drwxr-xr-x  2 <user> <group>  56K Nov 30 17:48 osvvm
    drwxr-xr-x  2 <user> <group>  56K Nov 30 17:48 vivado
    drwxr-xr-x  2 <user> <group>  56K Nov 30 17:58 vunit
    drwxr-xr-x  2 <user> <group>  56K Nov 30 17:58 xilinx
    ```

---------------------------------------------------------------------
### Compiling on Windows

 - **Step 1 - Configure the scripts**
    Please open the `config.psm1` file and set the dictionary entries for the installed
    vendor tools to the appropriate directory to your tool's installation folder.

    `config.psm1`:
    ```PowerShell
    $InstallationDirectory = @{
      "AlteraQuartusII" = "C:\Altera\15.0";
      "XilinxISE" =       "C:\Xilinx\14.7";
      "XilinxVivado" =    "C:\Xilinx\Vivado\2015.3";
      "OSVVM" =           "D:\git\GitHub\osvvm";
      "VUnit" =           "D:\git\GitHub\vunit"
    }
    ```

 - **Step 2 - Browse to your simulation working directory**
    ```PowerShell
    PS> cd <MySimulationFolder>
    ```

 - **Step 3 - Start the compilation script(s)**
    ```PowerShell
    PS> <GHDL>\libraries\vendors\compile-altera.ps1 -All
    PS> <GHDL>\libraries\vendors\compile-xilinx-ise.ps1 -All
    PS> <GHDL>\libraries\vendors\compile-xilinx-vivado.ps1 -All
    PS> <GHDL>\libraries\vendors\compile-osvvm.ps1 -All
    PS> <GHDL>\libraries\vendors\compile-vunit.ps1 -All
    ```

 - **Step 4 - Viewing the result**
    This creates vendor directories in your current working directory and compiles the vendor files into them.

    ```PowerShell
    PS> dir
        Directory: D:\temp\ghdl

    Mode           LastWriteTime       Length Name
    ----           -------------       ------ ----
    d----    20.11.2015    19:33        <DIR> altera
    d----    20.11.2015    19:38        <DIR> osvvm
    d----    20.11.2015    19:40        <DIR> vivado
    d----    20.11.2015    19:45        <DIR> vunit
    d----    20.11.2015    19:06        <DIR> xilinx
    ```

### Selectable Options for the Bash Scripts:

*First I should translate the scripts before writing the docu...*

 - Common parameters to all scripts:

        -h --help             Print the embedded help page(s).
        -a --all              Compile all libraries, including common libraries, packages and device libraries.
        -c --clean            Cleanup directory before analyzing.
        -n --no-warnings	  Don't show warnings. Report errors only.
        -s --skip-existing    Skip already compiled files (an *.o file exists).
        -S --skip-largefiles  Don't compile large entities like DSP and PCIe primitives.
        -H --halt-on-error    Stop compiling if an error occured.
 - `compile-altera.sh`

        --altera              Compile base libraries like 'altera' and 'altera_mf'
        --max                 Compile device libraries for Max CPLDs
        --arria               Compile device libraries for Arria FPGAs
        --cyclone             Compile device libraries for Cyclone FPGAs
        --stratix             Compile device libraries for Stratix FPGAs
 - `compile-xilinx-ise.sh`

        --unisim              Compile the unisim primitives
        --unimacro            Compile the unimacro macros
        --simprim             Compile the simprim primitives
        --secureip            Compile the secureip primitives
 - `compile-xilinx-vivado.sh`

        --unisim              Compile the unisim primitives
        --unimacro            Compile the unimacro macros
        --secureip            Compile the secureip primitives
 - `compile-osvvm.sh`
 - `compile-vunit.sh`

### Selectable Options for the PowerShell Scripts:

 - Common parameters to all scripts:

        -Help                 Print the embedded help page(s).
        -All                  Compile all libraries, including common libraries, packages and device libraries.
        -Clean                Cleanup directory before analyzing.
        -SuppressWarnings     Don't show warnings. Report errors only.
 - `compile-altera.ps1`

        -Altera               Compile base libraries like 'altera' and 'altera_mf'
        -Max                  Compile device libraries for Max CPLDs
        -Arria                Compile device libraries for Arria FPGAs
        -Cyclone              Compile device libraries for Cyclone FPGAs
        -Stratix              Compile device libraries for Stratix FPGAs
 - `compile-xilinx-ise.ps1`

        -Unisim               Compile the unisim primitives
        -Unimacro             Compile the unimacro macros
        -Simprim              Compile the simprim primitives
        -Secureip             Compile the secureip primitives
 - `compile-xilinx-vivado.ps1`

        -Unisim               Compile the unisim primitives
        -Unimacro             Compile the unimacro macros
        -Secureip             Compile the secureip primitives
 - `compile-osvvm.ps1`
 - `compile-vunit.ps1`

------------------------
Author: Patrick Lehmann (30.11.2015)