docs/wiki/geda-icarus_vpi_mp.html

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