iverilog-vpi.man

   1 .TH iverilog-vpi 1 "$Date: 2004/10/04 01:10:53 $" Version "$Date: 2004/10/04 01:10:53 $"
   2 .SH NAME
   3 iverilog-vpi - Compile front end for VPI modules
   4
   5 .SH SYNOPSIS
   6 .B iverilog-vpi
   7 [--name=\fIname\fP]
   8 \fIsourcefile\fP...
   9
  10 .SH DESCRIPTION
  11 .PP
  12 \fIiverilog-vpi\fP is a tool to simplify the compilation of VPI
  13 modules for use with Icarus Verilog. It takes on the command line a
  14 list of C or C++ source files, and generates as output a linked VPI
  15 module. See the \fBvvp\fP(1) man page for a description of how the
  16 linked module is loaded by a simulation.
  17
  18 The output is named after the first source file. For example, if the
  19 first source file is named \fIfoo.c\fP, the output becomes
  20 \fIfoo.vpi\fP.
  21
  22 .SH OPTIONS
  23 .l
  24 \fIiverilog-vpi\fP accepts the following options:
  25 .TP 8
  26 .B -l\fIlibrary\fP
  27 Include the named library in the link of the VPI module. This allows
  28 VPI modules to further reference external libraries.
  29
  30 .TP 8
  31 .B -I\fIdirectory\fP
  32 Add \fIdirectory\fP to the list of directories that will be search for
  33 header files.
  34
  35 .TP 8
  36 .B -D\fIdefine\fP
  37 Define a macro named \fIdefine\fP.
  38
  39 .TP 8
  40 .B --name=\fIname\fP
  41 Normally, the output VPI module will be named after the first source
  42 file passed to the command. This flag sets the name (without the .vpi
  43 suffix) of the output vpi module.
  44
  45 .TP 8
  46 .B --install-dir
  47 This flag causes the program to print the install directory for VPI
  48 modules, then exit. It is a convenience for makefiles or automated
  49 plug-in installers.
  50
  51 .TP 8
  52 .B --cflags, --ldflags and -ldlibs
  53 These flags provide compile time information.
  54
  55 .SH "PC-ONLY OPTIONS"
  56
  57 The PC port of \fIiverilog-vpi\fP includes two special flags needed to
  58 support the more intractable development environment. These flags help
  59 the program locate parts that it needs.
  60
  61 .TP 8
  62 .B -mingw=\fIpath\fP
  63 Tell the program the root of the Mingw compiler tool suite. The
  64 \fBvvp\fP runtime is compiled with this compiler, and this is the
  65 compiler that \fIiverilog-vpi\fP expects to use to compile your source
  66 code. This is normally not needed, and if you do use it, it is only
  67 needed once. The compiler will save the \fIpath\fP in the registry for
  68 use later.
  69
  70 .TP 8
  71 .B -ivl=\fIpath\fP
  72 Set for the use during compilation the root if the Icarus Verilog
  73 install. This is the place where you installed Icarus Verilog when you
  74 ran the installer. This flag is also only needed once, and the path is
  75 stored in the registry for future use.
  76
  77 .SH "UNIX-ONLY OPTIONS"
  78
  79 The UNIX version of \fIiverilog-vpi\fP includes additional flags to
  80 let Makefile gurus peek at the configuration of the \fIiverilog\fP
  81 installation.  This way, Makefiles can be written that handle complex VPI
  82 builds natively, and without hard-coding values that depend on the
  83 system and installation.  If used at all, these options must be
  84 used one at a time, and without any other options or directives.
  85
  86 .TP 8
  87 .B --cflags
  88 Print the compiler flags (CFLAGS or CXXFLAGS) needed to compile source
  89 code destined for a VPI module.
  90
  91 .TP 8
  92 .B --ldflags
  93 Print the linker flags (LDFLAGS) needed to link a VPI module.
  94
  95 .TP 8
  96 .B --ldlibs
  97 Print the libraries (LDLIBS) needed to link a VPI module.
  98
  99 .TP 8
 100 .B -m32
 101 On 64bit systems that support it (and support vvp32) this flag
 102 requests a 32bit vpi binary instead of the default 64bit binary.
 103
 104 .P
 105 Example GNU makefile that takes advantage of these flags:
 106 .IP "" 4
 107 CFLAGS = -Wall -O $(CFLAGS_$@)
 108 .br
 109 VPI_CFLAGS := $(shell iverilog-vpi --cflags)
 110 .br
 111 CFLAGS_messagev.o = $(VPI_CFLAGS)
 112 .br
 113 CFLAGS_fifo.o = $(VPI_CFLAGS)
 114 .br
 115 messagev.o fifo.o: transport.h
 116 .br
 117 messagev.vpi: messagev.o fifo.o
 118 .br
 119         iverilog-vpi $^
 120
 121 .SH "AUTHOR"
 122 .nf
 123 Steve Williams (steve@icarus.com)
 124
 125 .SH SEE ALSO
 126 iverilog(1), vvp(1),
 127 .BR "<http://www.icarus.com/eda/verilog/>",
 128 .BR "<http://www.mingw.org>",
 129
 130 .SH COPYRIGHT
 131 .nf
 132 Copyright \(co  2002 Stephen Williams
 133
 134 This document can be freely redistributed according to the terms of the
 135 GNU General Public License version 2.0