| Line 1... |
Line 1... |
# $Id: INSTALL.txt 467 2013-01-02 19:49:05Z mueller $
|
# $Id: INSTALL.txt 504 2013-04-13 15:37:24Z mueller $
|
|
|
Guide to install and build w11a systems, test benches and support software
|
Guide to install and build w11a systems, test benches and support software
|
|
|
Table of content:
|
Table of content:
|
|
|
| Line 20... |
Line 20... |
b. Available test benches
|
b. Available test benches
|
8. Building systems
|
8. Building systems
|
a. General instructions
|
a. General instructions
|
b. Configuring FPGAs
|
b. Configuring FPGAs
|
c. Available systems
|
c. Available systems
|
|
9. Generate Doxygen based source code view
|
|
|
1. Download ---------------------------------------------------------------
|
1. Download ---------------------------------------------------------------
|
|
|
All instructions below assume that the project files reside in a
|
All instructions below assume that the project files reside in a
|
working directory with the name represented as
|
working directory with the name represented as
|
| Line 73... |
Line 74... |
|
|
- for VHDL simulations one needs
|
- for VHDL simulations one needs
|
- ghdl
|
- ghdl
|
-> see INSTALL_ghdl.txt for the unfortunately gory details
|
-> see INSTALL_ghdl.txt for the unfortunately gory details
|
|
|
|
- for doxygen documentation an up-to-date installation of doxygen is
|
|
required, version 1.8.3.1 or later
|
|
|
- optional but very useful is:
|
- optional but very useful is:
|
- gtkwave
|
- gtkwave
|
-> package: gtkwave
|
-> package: gtkwave
|
|
|
3. Setup system environment -----------------------------------------------
|
3. Setup system environment -----------------------------------------------
|
| Line 87... |
Line 91... |
(Xilinx xst based) as well as the support software (mainly the rlink backend
|
(Xilinx xst based) as well as the support software (mainly the rlink backend
|
server) requires
|
server) requires
|
|
|
- the definition of the environment variables:
|
- the definition of the environment variables:
|
- RETROBASE: must refer to the installation root directory
|
- RETROBASE: must refer to the installation root directory
|
- BOOSTINC: pathname for includes of boost library
|
|
- TCLINC: pathname for includes of Tcl runtime library
|
- TCLINC: pathname for includes of Tcl runtime library
|
- RETRO_FX2_VID and RETRO_FX2_PID: default USB VID/PID, see below
|
- RETRO_FX2_VID and RETRO_FX2_PID: default USB VID/PID, see below
|
- that the tools binary directory is in the path
|
- that the tools binary directory is in the path
|
- that the tools library directory is in the library path
|
- that the tools library directory is in the library path
|
|
- optional environment variables:
|
|
- BOOSTINC: pathname for includes of boost library
|
|
- BOOSTLIB: pathname for libraries of boost library
|
|
{Note: Either both must be undefined, or both must be defined}
|
|
|
For bash and alike use
|
For bash and alike use
|
|
|
export RETROBASE=
|
export RETROBASE=
|
export PATH=$PATH:$RETROBASE/tools/bin
|
export PATH=$PATH:$RETROBASE/tools/bin
|
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RETROBASE/tools/lib
|
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RETROBASE/tools/lib
|
|
|
In most cases the boost library version coming with the distribution will
|
In most cases the boost library version coming with the distribution will
|
work, similar for Tcl, in those cases simply use
|
work, similar for Tcl, in those cases simply use
|
|
|
export BOOSTINC=/usr/include
|
|
export TCLINC=/usr/include/tcl8.5
|
export TCLINC=/usr/include/tcl8.5
|
|
|
|
and don't setup BOOSTINC and BOOSTLIB.
|
|
|
After that building functional model based test benches will work. If you
|
After that building functional model based test benches will work. If you
|
want to also build post-xst or post-par test benches read next section.
|
want to also build post-xst or post-par test benches read next section.
|
|
|
If the Cypress USB controller available on Digilent Nexys2, Nexys3 and
|
If the Cypress USB controller available on Digilent Nexys2, Nexys3 and
|
Atlys boards is used the default USB VID and PID is defined by two
|
Atlys boards is used the default USB VID and PID is defined by two
|
| Line 376... |
Line 383... |
|
|
c. for Digilent Nexys3 board
|
c. for Digilent Nexys3 board
|
|
|
cd $RETROBASE/rtl/sys_gen/w11a/nexys3
|
cd $RETROBASE/rtl/sys_gen/w11a/nexys3
|
make sys_w11a_n3.bit
|
make sys_w11a_n3.bit
|
|
|
|
9. Generate Doxygen based source code view --------------------------------
|
|
|
|
Currently there is not much real documentation included in the source
|
|
files. The doxygen generated html output is nevertheless very useful
|
|
to browse the code. C++, Tcl and Vhdl source are covered by setup files
|
|
contained in the project files.
|
|
|
|
To generate the html files
|
|
|
|
cd $RETROBASE/tools/dox
|
|
export RETRODOXY
|
|
./make_doxy
|
|
|
|
If RETRODOXY is not defined '/tmp' is used. To view the docs use
|
|
|
|
firefox $RETRODOXY/w11/cpp/html/index.html &
|
|
firefox $RETRODOXY/w11/tcl/html/index.html &
|
|
firefox $RETRODOXY/w11/vhd/html/index.html &
|
