ruby-vpi 7.0.0

data/ext/verilog.h

@@ -0,0 +1,59 @@
+/*
+  Copyright 2006 Suraj N. Kurapati
+
+  This file is part of Ruby-VPI.
+
+  Ruby-VPI is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  Ruby-VPI is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with Ruby-VPI; if not, write to the Free Software Foundation,
+  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+/**\file
+  A proxy for all Verilog headers of interest to us.
+*/
+
+#ifndef VERILOG_H
+#define	VERILOG_H
+
+  // Use our verbatim copy of the official IEEE Std. 1364-2005 header file, which was obtained from this URL: <http://www.boydtechinc.com/ptf/archive/ptf_2005/0737.html>
+  #include "vpi_user.h"
+
+
+  // Adjust for the peculiarities of the Verilog simulator being used.
+  #ifdef SYNOPSYS_VCS
+    #define VERILOG_LENIENT
+  #endif
+
+  // Do we want to enforce strict compliance with IEEE Std. 1364-2001? If so, Ruby-VPI might not work with Synopsys VCS, but that's not our fault. ;-)
+  #define verilog_tf_funcPtr_strict(aPtrName)	\
+    PLI_INT32 (*aPtrName)(PLI_BYTE8*)
+
+  #ifdef VERILOG_LENIENT
+    #define verilog_tf_funcPtr(aPtrName)	\
+      void (*aPtrName)(void)
+
+    #define verilog_tf_funcSig(aFuncName)	\
+      void aFuncName(void)
+
+    #define verilog_tf_funcReturn(aReturnVal) \
+      ;
+  #else
+    #define verilog_tf_funcPtr verilog_tf_funcPtr_strict
+
+    #define verilog_tf_funcSig(aFuncName)	\
+      static PLI_INT32 aFuncName(PLI_BYTE8* aDummy)
+
+    #define verilog_tf_funcReturn(aReturnVal)	\
+      return aReturnVal
+  #endif
+
+#endif

data/ext/vlog.cin

@@ -0,0 +1,92 @@
+/*
+  Copyright 2006 Suraj N. Kurapati
+  Copyright 1999 Kazuhiro HIWADA
+
+  This file is part of Ruby-VPI.
+
+  Ruby-VPI is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  Ruby-VPI is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with Ruby-VPI; if not, write to the Free Software Foundation,
+  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+#ifndef VLOG_CIN
+#define VLOG_CIN
+
+  #include <assert.h>
+  #include "common.h"
+  #include "relay.hin"
+  #include "vlog.hin"
+
+
+  verilog_tf_funcSig(vlog_ruby_relay) {
+    // transfer control to ruby
+    relay_ruby();
+
+
+    // transfer control to verilog
+    verilog_tf_funcReturn(0);
+  }
+
+  verilog_tf_funcSig(vlog_ruby_init) {
+    // setup control transfer mechanism
+    relay_init();
+
+
+    // start ruby interpreter and transfer control to it
+    relay_ruby_run();
+
+
+    // transfer control to verilog
+    verilog_tf_funcReturn(0);
+  }
+
+  #ifndef SYNOPSYS_VCS
+    static void vlog_bind_task(PLI_BYTE8* apTaskName, verilog_tf_funcPtr(apTaskDef)) {
+      s_vpi_systf_data tf;
+
+      tf.type = vpiSysTask;
+      tf.sysfunctype = 0;
+      tf.tfname = apTaskName;
+      tf.calltf = (verilog_tf_funcPtr_strict())apTaskDef;
+      tf.compiletf = NULL;
+      tf.sizetf = NULL;
+      tf.user_data = NULL;
+
+      vpi_register_systf(&tf);
+    }
+
+    /**
+      Binds the default VPI tasks (provided by Ruby-VPI) before the Verilog simulator begins to simulate.
+    */
+    static void vlog_startup() {
+      vlog_bind_task("$ruby_init", vlog_ruby_init);
+      vlog_bind_task("$ruby_relay", vlog_ruby_relay);
+    }
+
+    void (*vlog_startup_routines[])() = { vlog_startup, 0 };
+
+    #ifdef PRAGMATIC_CVER
+      /**
+        Invokes each routine specified in the vlog_startup_routines array.
+
+        This code was originally taken from GPL Cver 2.11a: Copyright (c) 1991-2005 Pragmatic C Software Corp.
+      */
+      void vlog_startup_routines_bootstrap() {
+        uint i;
+        for (i = 0; vlog_startup_routines[i] != NULL; i++)
+          vlog_startup_routines[i]();
+      }
+    #endif
+  #endif
+
+#endif

data/ext/vlog.hin

@@ -0,0 +1,57 @@
+/*
+  Copyright 2006 Suraj N. Kurapati
+  Copyright 1999 Kazuhiro HIWADA
+
+  This file is part of Ruby-VPI.
+
+  Ruby-VPI is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  Ruby-VPI is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with Ruby-VPI; if not, write to the Free Software Foundation,
+  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+/**\file
+  Interface between C and Verilog code.
+*/
+
+#ifndef VLOG_HIN
+#define VLOG_HIN
+
+  #include "verilog.h"
+
+
+  /**
+    Callback for the $ruby_relay VPI task. Transfers control from Verilog to Ruby code.
+  */
+  verilog_tf_funcSig(vlog_ruby_relay);
+
+  /**
+    Callback for the $ruby_init VPI task. Initializes and starts the Ruby interpreter with the same arguments as those given to the VPI task-call.
+
+    For example, to start the Ruby interpreter with the "-w" option and with the "hello_world.rb" script, the Verilog code would have a statement like this:
+      - <tt>$ruby_init("-w", "hello_world.rb");</tt>
+  */
+  verilog_tf_funcSig(vlog_ruby_init);
+
+  #ifndef SYNOPSYS_VCS
+    /**
+      Binds a C function to a VPI task, so that Verilog code can invoke the C function by calling the VPI task.
+
+      For example, if we bound a VPI task named "$hello_world" to the C function hello_world(), then the hello_world() function would be invoked whenever Verilog code called the "$hello_world" VPI task.
+
+      @param	apTaskName	Name of the VPI task. For example, "$hello_world".
+
+      @param	apTaskDef	The C function which you want to associate with the given VPI task. For example, hello_world().
+    */
+    static void vlog_bind_task(PLI_BYTE8* apTaskName, verilog_tf_funcPtr(apTaskDef));
+  #endif
+
+#endif