ruby-vpi 13.0.0 → 14.0.0

data/ref/ruby/classes/Vpi.html

@@ -76,6 +76,16 @@
 
    </div>
 
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000032">advance_time</a>&nbsp;&nbsp;
+      <a href="#M000031">simulate</a>&nbsp;&nbsp;
+      <a href="#M000033">simulation_time</a>&nbsp;&nbsp;
+      <a href="#M000030">vpi_register_cb</a>&nbsp;&nbsp;
+      </div>
+    </div>
 
   </div>
 
@@ -96,21 +106,160 @@
 
       <div class="name-list">
         <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">INTEGER_BITS</td>
+          <td>=</td>
+          <td class="context-item-value">32</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Number of bits in PLI_INT32.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">INTEGER_LIMIT</td>
+          <td>=</td>
+          <td class="context-item-value">2 ** INTEGER_BITS</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Lowest upper bound of PLI_INT32.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">INTEGER_MASK</td>
+          <td>=</td>
+          <td class="context-item-value">INTEGER_LIMIT - 1</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Bit-mask capable of capturing PLI_INT32.
+
+</td>
+        </tr>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">Handle</td>
           <td>=</td>
           <td class="context-item-value">SWIG::TYPE_p_unsigned_int</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+handles
+
+</td>
         </tr>
         </table>
       </div>
     </div>
 
+    <div id="aliases-list">
+      <h3 class="section-bar">External Aliases</h3>
+
+      <div class="name-list">
+                        <table summary="aliases">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">vpi_register_cb</td>
+          <td>-></td>
+          <td class="context-item-value">vpi_register_cb_old</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">vpi_remove_cb</td>
+          <td>-></td>
+          <td class="context-item-value">vpi_remove_cb_old</td>
+        </tr>
+                        </table>
+      </div>
+    </div>
 
 
       
 
 
     <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
+
+        <div class="method-heading">
+          <a href="Vpi.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('Vpi.src/M000032.html');return false;">
+          <span class="method-name">advance_time</span><span class="method-args">(aNumSteps = 1)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Advances the simulation by the given number of steps.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+
+        <div class="method-heading">
+          <a href="Vpi.src/M000031.html" target="Code" class="method-signature"
+            onclick="popupCode('Vpi.src/M000031.html');return false;">
+          <span class="method-name">simulate</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Simulates the design under test according to <a
+href="RubyVpi.html#M000029">RubyVpi.init_bench</a>.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+
+        <div class="method-heading">
+          <a href="Vpi.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('Vpi.src/M000033.html');return false;">
+          <span class="method-name">simulation_time</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the current simulation time as a 64-bit integer.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+
+        <div class="method-heading">
+          <a href="Vpi.src/M000030.html" target="Code" class="method-signature"
+            onclick="popupCode('Vpi.src/M000030.html');return false;">
+          <span class="method-name">vpi_register_cb</span><span class="method-args">(aData {|Vpi::S_cb_data| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This is a Ruby version of the <a
+href="Vpi.html#M000030">vpi_register_cb</a> C function. It is identical to
+the C function, except for the following differences:
+</p>
+<ul>
+<li>This method accepts a block (callback handler) which is executed whenever
+the callback occurs.
+
+</li>
+<li>This method overwrites the <tt>cb_rtn</tt> and <tt>user_data</tt> fields of
+the given <tt>S_cb_data</tt> object.
+
+</li>
+</ul>
+        </div>
+      </div>
+
+
+    </div>
 
 
   </div>

data/ref/ruby/classes/Vpi.src/M000030.html

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>vpi_register_cb (Vpi)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/ruby-vpi/vpi.rb, line 383</span>
+383:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">vpi_register_cb</span> <span class="ruby-identifier">aData</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">aHandler</span> <span class="ruby-comment cmt"># :yields: Vpi::S_cb_data</span>
+384:     <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;block must be given&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
+385: 
+386:     <span class="ruby-identifier">key</span> = <span class="ruby-identifier">aHandler</span>.<span class="ruby-identifier">object_id</span>.<span class="ruby-identifier">to_s</span>
+387: 
+388:     <span class="ruby-comment cmt"># register the callback with Verilog</span>
+389:       <span class="ruby-identifier">aData</span>.<span class="ruby-identifier">user_data</span> = <span class="ruby-identifier">key</span>
+390:       <span class="ruby-identifier">aData</span>.<span class="ruby-identifier">cb_rtn</span> = <span class="ruby-constant">Vlog_relay_ruby</span>
+391:       <span class="ruby-identifier">token</span> = <span class="ruby-identifier">vpi_register_cb_old</span>(<span class="ruby-identifier">aData</span>)
+392: 
+393:     <span class="ruby-ivar">@@callbacks</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">Callback</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">aHandler</span>, <span class="ruby-identifier">token</span>)
+394:     <span class="ruby-identifier">token</span>
+395:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/ref/ruby/classes/Vpi.src/M000031.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>simulate (Vpi)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/ruby-vpi/vpi.rb, line 430</span>
+430:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">simulate</span>
+431:     <span class="ruby-comment cmt"># this is a dummy method!</span>
+432:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/ref/ruby/classes/Vpi.src/M000032.html

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>advance_time (Vpi)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/ruby-vpi/vpi.rb, line 435</span>
+435:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">advance_time</span> <span class="ruby-identifier">aNumSteps</span> = <span class="ruby-value">1</span>
+436:     <span class="ruby-comment cmt"># schedule wake-up callback from verilog</span>
+437:       <span class="ruby-identifier">time</span> = <span class="ruby-constant">S_vpi_time</span>.<span class="ruby-identifier">new</span>
+438:       <span class="ruby-identifier">time</span>.<span class="ruby-identifier">low</span> = <span class="ruby-identifier">aNumSteps</span> <span class="ruby-operator">&amp;</span> <span class="ruby-constant">INTEGER_MASK</span>
+439:       <span class="ruby-identifier">time</span>.<span class="ruby-identifier">high</span> = (<span class="ruby-identifier">aNumSteps</span> <span class="ruby-operator">&gt;&gt;</span> <span class="ruby-constant">INTEGER_BITS</span>) <span class="ruby-operator">&amp;</span> <span class="ruby-constant">INTEGER_MASK</span>
+440:       <span class="ruby-identifier">time</span>.<span class="ruby-identifier">type</span> = <span class="ruby-constant">VpiSimTime</span>
+441: 
+442:       <span class="ruby-identifier">value</span> = <span class="ruby-constant">S_vpi_value</span>.<span class="ruby-identifier">new</span>
+443:       <span class="ruby-identifier">value</span>.<span class="ruby-identifier">format</span> = <span class="ruby-constant">VpiSuppressVal</span>
+444: 
+445:       <span class="ruby-identifier">alarm</span> = <span class="ruby-constant">S_cb_data</span>.<span class="ruby-identifier">new</span>
+446:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">reason</span> = <span class="ruby-constant">CbAfterDelay</span>
+447:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">cb_rtn</span> = <span class="ruby-constant">Vlog_relay_ruby</span>
+448:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">obj</span> = <span class="ruby-keyword kw">nil</span>
+449:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">time</span> = <span class="ruby-identifier">time</span>
+450:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>
+451:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">index</span> = <span class="ruby-value">0</span>
+452:       <span class="ruby-identifier">alarm</span>.<span class="ruby-identifier">user_data</span> = <span class="ruby-keyword kw">nil</span>
+453: 
+454:       <span class="ruby-identifier">vpi_free_object</span>(<span class="ruby-identifier">vpi_register_cb_old</span>(<span class="ruby-identifier">alarm</span>))
+455: 
+456:     <span class="ruby-comment cmt"># relay to verilog</span>
+457:       <span class="ruby-identifier">relay_verilog_proxy</span>
+458:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/ref/ruby/classes/Vpi.src/M000033.html

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>simulation_time (Vpi)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/ruby-vpi/vpi.rb, line 464</span>
+464:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">simulation_time</span>
+465:     <span class="ruby-identifier">t</span> = <span class="ruby-constant">S_vpi_time</span>.<span class="ruby-identifier">new</span>
+466:     <span class="ruby-identifier">t</span>.<span class="ruby-identifier">type</span> = <span class="ruby-constant">VpiSimTime</span>
+467: 
+468:     <span class="ruby-identifier">vpi_get_time</span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">t</span>
+469:     (<span class="ruby-identifier">t</span>.<span class="ruby-identifier">high</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">INTEGER_BITS</span>) <span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">low</span>
+470:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/ref/ruby/created.rid

@@ -1 +1 @@
-Wed Dec 27 22:29:46 PST 2006
+Sat Dec 30 19:26:26 PST 2006

data/ref/ruby/files/lib/ruby-vpi/vpi_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Dec 27 19:14:41 PST 2006</td>
+      <td>Fri Dec 29 15:08:37 PST 2006</td>
     </tr>
     </table>
   </div>

data/ref/ruby/files/lib/ruby-vpi_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Dec 27 22:02:52 PST 2006</td>
+      <td>Fri Dec 29 15:04:26 PST 2006</td>
     </tr>
     </table>
   </div>
@@ -73,12 +73,12 @@
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
+      ruby-vpi/vpi&nbsp;&nbsp;
       ruby-vpi/rcov&nbsp;&nbsp;
       test/unit&nbsp;&nbsp;
       spec&nbsp;&nbsp;
       test/spec&nbsp;&nbsp;
       ruby-debug&nbsp;&nbsp;
-      ruby-vpi/vpi&nbsp;&nbsp;
       </div>
     </div>
 

data/ref/ruby/fr_method_index.html

@@ -20,47 +20,51 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Vpi/Handle.html#M000037">[] (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000041">[] (Vpi::Handle)</a><br />
+    <a href="classes/Vpi.html#M000032">advance_time (Vpi)</a><br />
     <a href="classes/FileUtils.html#M000028">collect_args (FileUtils)</a><br />
     <a href="classes/Integer.html#M000017">ensure_max (Integer)</a><br />
     <a href="classes/Integer.html#M000016">ensure_min (Integer)</a><br />
     <a href="classes/Integer.html#M000020">extend_sign (Integer)</a><br />
-    <a href="classes/Vpi/Handle.html#M000035">get_value (Vpi::Handle)</a><br />
-    <a href="classes/Vpi/Handle.html#M000034">get_value_wrapper (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000039">get_value (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000038">get_value_wrapper (Vpi::Handle)</a><br />
     <a href="classes/RubyVpi.html#M000029">init_bench (RubyVpi)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000004">input? (VerilogParser::Module::Port)</a><br />
-    <a href="classes/Vpi/Handle.html#M000038">inspect (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000042">inspect (Vpi::Handle)</a><br />
     <a href="classes/Integer.html#M000009">length (Integer)</a><br />
     <a href="classes/Integer.html#M000010">limit (Integer)</a><br />
     <a href="classes/Integer.html#M000008">log2 (Integer)</a><br />
     <a href="classes/Float.html#M000022">mantissa (Float)</a><br />
     <a href="classes/Integer.html#M000012">mask (Integer)</a><br />
     <a href="classes/Integer.html#M000014">max (Integer)</a><br />
-    <a href="classes/Vpi/Handle.html#M000040">method_missing (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000044">method_missing (Vpi::Handle)</a><br />
     <a href="classes/VerilogParser.html#M000001">new (VerilogParser)</a><br />
-    <a href="classes/VerilogParser/Module/Port.html#M000003">new (VerilogParser::Module::Port)</a><br />
+    <a href="classes/ERB.html#M000026">new (ERB)</a><br />
     <a href="classes/VerilogParser/Module.html#M000002">new (VerilogParser::Module)</a><br />
     <a href="classes/VerilogParser/Module/Parameter.html#M000007">new (VerilogParser::Module::Parameter)</a><br />
-    <a href="classes/ERB.html#M000026">new (ERB)</a><br />
+    <a href="classes/VerilogParser/Module/Port.html#M000003">new (VerilogParser::Module::Port)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000005">output? (VerilogParser::Module::Port)</a><br />
     <a href="classes/Integer.html#M000018">pack (Integer)</a><br />
-    <a href="classes/Vpi/Handle.html#M000036">put_value (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000040">put_value (Vpi::Handle)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000006">reg? (VerilogParser::Module::Port)</a><br />
     <a href="classes/FileUtils.html#M000027">sh (FileUtils)</a><br />
+    <a href="classes/Vpi.html#M000031">simulate (Vpi)</a><br />
+    <a href="classes/Vpi.html#M000033">simulation_time (Vpi)</a><br />
     <a href="classes/Integer.html#M000021">split (Integer)</a><br />
     <a href="classes/String.html#M000023">to_f (String)</a><br />
     <a href="classes/Integer.html#M000011">to_limit (Integer)</a><br />
     <a href="classes/Integer.html#M000013">to_mask (Integer)</a><br />
     <a href="classes/Integer.html#M000015">to_max (Integer)</a><br />
     <a href="classes/String.html#M000025">to_ruby_const_name (String)</a><br />
-    <a href="classes/Vpi/Handle.html#M000039">to_s (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000043">to_s (Vpi::Handle)</a><br />
     <a href="classes/Integer.html#M000019">unpack (Integer)</a><br />
-    <a href="classes/RDoc.html#M000041">usage_from_file (RDoc)</a><br />
+    <a href="classes/RDoc.html#M000045">usage_from_file (RDoc)</a><br />
     <a href="classes/String.html#M000024">verilog_to_ruby (String)</a><br />
-    <a href="classes/Vpi/Handle.html#M000031">x! (Vpi::Handle)</a><br />
-    <a href="classes/Vpi/Handle.html#M000030">x? (Vpi::Handle)</a><br />
-    <a href="classes/Vpi/Handle.html#M000033">z! (Vpi::Handle)</a><br />
-    <a href="classes/Vpi/Handle.html#M000032">z? (Vpi::Handle)</a><br />
+    <a href="classes/Vpi.html#M000030">vpi_register_cb (Vpi)</a><br />
+    <a href="classes/Vpi/Handle.html#M000035">x! (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000034">x? (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000037">z! (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000036">z? (Vpi::Handle)</a><br />
   </div>
 </div>
 </body>

data/samp/counter/counter_rspec_bench.rb

@@ -3,4 +3,84 @@
 require 'rubygems'
 require 'ruby-vpi'
 
-RubyVpi.init_bench :Counter, :rSpec
+RubyVpi.init_bench :Counter, :rSpec do
+  ##
+  # This block is executed whenever Vpi::simulate is invoked.
+  #
+  # It simulates the design under test. This is typically done
+  # by toggling the clock signal, as demonstrated below.
+  ##
+
+  ##
+  # We are currently here (marked by the ! signs):
+  #
+  #    !
+  #    !
+  #    ! ____      ____      ____      ____
+  # ___!/    \____/    \____/    \____/    \
+  #    !
+  #    !
+  #
+  ##
+
+  Counter.clock.intVal = 1
+
+  ##
+  # After setting the clock signal to high, we are here:
+  #
+  #      !
+  #      !
+  #      !____      ____      ____      ____
+  # ____/!    \____/    \____/    \____/    \
+  #      !
+  #      !
+  #
+  ##
+
+  advance_time
+
+  ##
+  # After advancing the time, we are here:
+  #
+  #          !
+  #          !
+  #      ____!      ____      ____      ____
+  # ____/    !\____/    \____/    \____/    \
+  #          !
+  #          !
+  #
+  ##
+
+  Counter.clock.intVal = 0
+
+  ##
+  # After setting the clock signal to low, we are here:
+  #
+  #           !
+  #           !
+  #      ____ !     ____      ____      ____
+  # ____/    \!____/    \____/    \____/    \
+  #           !
+  #           !
+  #
+  ##
+
+  advance_time
+
+  ##
+  # After advancing the time, we are here:
+  #
+  #
+  #               !
+  #               !
+  #      ____     ! ____      ____      ____
+  # ____/    \____!/    \____/    \____/    \
+  #               !
+  #               !
+  #
+  ##
+
+  ##
+  # This process repeats when Vpi::simulate is invoked again.
+  ##
+end

data/samp/counter/counter_rspec_bench.v

@@ -1,16 +1,9 @@
 // This file is the Verilog side of the bench.
 module counter_rspec_bench;
+  parameter Size = 5;
+  reg  clock;
+  reg  reset;
+  wire [Size - 1 : 0] count;
 
-  // instantiate the design under test
-    parameter Size = 5;
-    reg  clock;
-    reg  reset;
-    wire [Size - 1 : 0] count;
-
-    counter #(.Size(Size)) counter_rspec_bench_design(.clock(clock), .reset(reset), .count(count));
-
-  // generate clock for the design under test
-    initial clock = 0;
-    always #5 clock = !clock;
-
+  counter #(.Size(Size)) counter_rspec_bench_design(.clock(clock), .reset(reset), .count(count));
 endmodule

data/samp/counter/counter_rspec_design.rb

@@ -2,8 +2,7 @@
 
 # This method resets the design under test.
 def Counter.reset!
-  # assert the reset signal for two clock cycles
   reset.intVal = 1
-  2.times {relay_verilog}
+  simulate
   reset.intVal = 0
 end

data/samp/counter/counter_rspec_proto.rb

@@ -1,6 +1,6 @@
 # This is a prototype of the design under test.
 
-# When prototyping is enabled, relay_verilog invokes this method
+# When prototyping is enabled, Vpi::simulate invokes this method
 # instead of transferring control to the Verilog simulator.
 def Counter.simulate!
   if reset.intVal == 1

data/samp/counter/counter_rspec_spec.rb

@@ -18,7 +18,7 @@ context "A resetted counter's value" do
   specify "should increment by one count upon each rising clock edge" do
     LIMIT.times do |i|
       Counter.count.intVal.should == i
-      relay_verilog # increment the counter
+      simulate # increment the counter
     end
   end
 end
@@ -28,12 +28,12 @@ context "A counter with the maximum value" do
     Counter.reset!
 
     # increment the counter to maximum value
-    MAX.times {relay_verilog}
+    MAX.times {simulate}
     Counter.count.intVal.should == MAX
   end
 
   specify "should overflow upon increment" do
-    relay_verilog # increment the counter
+    simulate # increment the counter
     Counter.count.intVal.should == 0
   end
 end

data/samp/counter/counter_xunit_bench.rb

@@ -3,4 +3,84 @@
 require 'rubygems'
 require 'ruby-vpi'
 
-RubyVpi.init_bench :Counter, :xUnit
+RubyVpi.init_bench :Counter, :xUnit do
+  ##
+  # This block is executed whenever Vpi::simulate is invoked.
+  #
+  # It simulates the design under test. This is typically done
+  # by toggling the clock signal, as demonstrated below.
+  ##
+
+  ##
+  # We are currently here (marked by the ! signs):
+  #
+  #    !
+  #    !
+  #    ! ____      ____      ____      ____
+  # ___!/    \____/    \____/    \____/    \
+  #    !
+  #    !
+  #
+  ##
+
+  Counter.clock.intVal = 1
+
+  ##
+  # After setting the clock signal to high, we are here:
+  #
+  #      !
+  #      !
+  #      !____      ____      ____      ____
+  # ____/!    \____/    \____/    \____/    \
+  #      !
+  #      !
+  #
+  ##
+
+  advance_time
+
+  ##
+  # After advancing the time, we are here:
+  #
+  #          !
+  #          !
+  #      ____!      ____      ____      ____
+  # ____/    !\____/    \____/    \____/    \
+  #          !
+  #          !
+  #
+  ##
+
+  Counter.clock.intVal = 0
+
+  ##
+  # After setting the clock signal to low, we are here:
+  #
+  #           !
+  #           !
+  #      ____ !     ____      ____      ____
+  # ____/    \!____/    \____/    \____/    \
+  #           !
+  #           !
+  #
+  ##
+
+  advance_time
+
+  ##
+  # After advancing the time, we are here:
+  #
+  #
+  #               !
+  #               !
+  #      ____     ! ____      ____      ____
+  # ____/    \____!/    \____/    \____/    \
+  #               !
+  #               !
+  #
+  ##
+
+  ##
+  # This process repeats when Vpi::simulate is invoked again.
+  ##
+end