ruby-vpi 13.0.0 → 14.0.0

data/ref/c/structt__vpi__value.html

@@ -197,7 +197,7 @@
 </div><p>
 <hr>The documentation for this struct was generated from the following file:<ul>
 <li><a class="el" href="vpi__user_8h.html">vpi_user.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/structt__vpi__vecval.html

@@ -59,7 +59,7 @@
 </div><p>
 <hr>The documentation for this struct was generated from the following file:<ul>
 <li><a class="el" href="vpi__user_8h.html">vpi_user.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/structt__vpi__vlog__info.html

@@ -93,7 +93,7 @@
 </div><p>
 <hr>The documentation for this struct was generated from the following file:<ul>
 <li><a class="el" href="vpi__user_8h.html">vpi_user.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/verilog_8h.html

@@ -26,13 +26,13 @@
 
 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#6e8374d012a82e20b7e93415b95cf33d">verilog_tf_funcPtr</a>&nbsp;&nbsp;&nbsp;verilog_tf_funcPtr_strict</td></tr>
 
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#d3ce96438bf5e9101337a49bac4507f7">verilog_tf_funcSig</a>(aFuncName)&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="vpi__user_8h.html#c32f73779a5a02871976ab2d1b2fbedb">PLI_BYTE8</a>* aArg)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#d3ce96438bf5e9101337a49bac4507f7">verilog_tf_funcSig</a>(aFuncName)&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="vpi__user_8h.html#c32f73779a5a02871976ab2d1b2fbedb">PLI_BYTE8</a>* aCallbackData)</td></tr>
 
 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#0895cc43ee6708ed1a7fa8b9829665ba">verilog_tf_funcReturn</a>(aReturnVal)&nbsp;&nbsp;&nbsp;return aReturnVal</td></tr>
 
 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#2d7416b20fad644f9f4730ca02fad66c">verilog_cb_funcPtr</a>(aPtrName)&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> (*aPtrName)(<a class="el" href="structt__cb__data.html">p_cb_data</a>)</td></tr>
 
-<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#284b72fb83989cced485586b82bc6aa5">verilog_cb_funcSig</a>(aFuncName)&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="structt__cb__data.html">p_cb_data</a> aArg)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#284b72fb83989cced485586b82bc6aa5">verilog_cb_funcSig</a>(aFuncName)&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="structt__cb__data.html">p_cb_data</a> aCallbackData)</td></tr>
 
 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="verilog_8h.html#cfb4343c14a167b7428be1b4c1f35240">verilog_cb_funcReturn</a>(aReturnVal)&nbsp;&nbsp;&nbsp;return aReturnVal</td></tr>
 
@@ -91,7 +91,7 @@ A proxy for all Verilog headers of interest to us.
           <td class="paramtype">aFuncName&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="structt__cb__data.html">p_cb_data</a> aArg)</td>
+          <td width="100%">&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="structt__cb__data.html">p_cb_data</a> aCallbackData)</td>
         </tr>
       </table>
 </div>
@@ -166,7 +166,7 @@ A proxy for all Verilog headers of interest to us.
           <td class="paramtype">aFuncName&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
-          <td width="100%">&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="vpi__user_8h.html#c32f73779a5a02871976ab2d1b2fbedb">PLI_BYTE8</a>* aArg)</td>
+          <td width="100%">&nbsp;&nbsp;&nbsp;<a class="el" href="vpi__user_8h.html#4a478dfb1ea580b36c39dcec9fc8d53c">PLI_INT32</a> aFuncName(<a class="el" href="vpi__user_8h.html#c32f73779a5a02871976ab2d1b2fbedb">PLI_BYTE8</a>* aCallbackData)</td>
         </tr>
       </table>
 </div>
@@ -176,7 +176,7 @@ A proxy for all Verilog headers of interest to us.
 
 </div>
 </div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/vlog_8c.html

@@ -21,16 +21,20 @@
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#be4b6bc16960d97061b4eea00cf1f1cf">verilog_cb_funcSig</a> (vlog_relay_main)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#ca3f06abdb27a0fc0a81633d8960f50f">verilog_cb_funcSig</a> (vlog_relay_init)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relays control to the main layer.  <a href="#be4b6bc16960d97061b4eea00cf1f1cf"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#c74c587b2501362f8225b8ada1f8b0c0">verilog_cb_funcSig</a> (vlog_relay_ruby)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relays control from Verilog to Ruby.  <a href="#c74c587b2501362f8225b8ada1f8b0c0"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structt__cb__data.html">s_cb_data</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#d6adf9454678287bd05e9df18859f2a5">vlog_relay_ruby_reason</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the data corresponding to the callback that caused the relay from Verilog to Ruby.  <a href="#d6adf9454678287bd05e9df18859f2a5"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#dc9eaadf567421f239b8b647a3ea0eb2">vlog_startup</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Registers a callback at start of simulation to vlog_relay_main();.  <a href="#dc9eaadf567421f239b8b647a3ea0eb2"></a><br></td></tr>
 <tr><td colspan="2"><br><h2>Variables</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structt__cb__data.html">s_cb_data</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#18eaa93bf30b318a70eb68473d7597b1">vlog__relayReason</a> = NULL</td></tr>
+
 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*[])&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8c.html#c1228ec9528d9c9be4de1c8e42cd3835">vlog_startup_routines</a> () = { vlog_startup, 0 }</td></tr>
 
 </table>
@@ -57,14 +61,33 @@ Relays control from Verilog to Ruby.
 
 </div>
 </div><p>
-<a class="anchor" name="be4b6bc16960d97061b4eea00cf1f1cf"></a><!-- doxytag: member="vlog.c::verilog_cb_funcSig" ref="be4b6bc16960d97061b4eea00cf1f1cf" args="(vlog_relay_main)" -->
+<a class="anchor" name="ca3f06abdb27a0fc0a81633d8960f50f"></a><!-- doxytag: member="vlog.c::verilog_cb_funcSig" ref="ca3f06abdb27a0fc0a81633d8960f50f" args="(vlog_relay_init)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">verilog_cb_funcSig           </td>
           <td>(</td>
-          <td class="paramtype">vlog_relay_main&nbsp;</td>
+          <td class="paramtype">vlog_relay_init&nbsp;</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="d6adf9454678287bd05e9df18859f2a5"></a><!-- doxytag: member="vlog.c::vlog_relay_ruby_reason" ref="d6adf9454678287bd05e9df18859f2a5" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="structt__cb__data.html">s_cb_data</a>* vlog_relay_ruby_reason           </td>
+          <td>(</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
           <td width="100%"></td>
@@ -74,7 +97,7 @@ Relays control from Verilog to Ruby.
 <div class="memdoc">
 
 <p>
-Relays control to the main layer. 
+Returns the data corresponding to the callback that caused the relay from Verilog to Ruby. 
 <p>
 
 </div>
@@ -101,6 +124,21 @@ Registers a callback at start of simulation to vlog_relay_main();.
 </div>
 </div><p>
 <hr><h2>Variable Documentation</h2>
+<a class="anchor" name="18eaa93bf30b318a70eb68473d7597b1"></a><!-- doxytag: member="vlog.c::vlog__relayReason" ref="18eaa93bf30b318a70eb68473d7597b1" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="structt__cb__data.html">s_cb_data</a>* <a class="el" href="vlog_8c.html#18eaa93bf30b318a70eb68473d7597b1">vlog__relayReason</a> = NULL          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
 <a class="anchor" name="c1228ec9528d9c9be4de1c8e42cd3835"></a><!-- doxytag: member="vlog.c::vlog_startup_routines" ref="c1228ec9528d9c9be4de1c8e42cd3835" args="()" -->
 <div class="memitem">
 <div class="memproto">
@@ -116,7 +154,7 @@ Registers a callback at start of simulation to vlog_relay_main();.
 
 </div>
 </div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/vlog_8h.html

@@ -23,12 +23,12 @@
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8h.html#be4b6bc16960d97061b4eea00cf1f1cf">verilog_cb_funcSig</a> (vlog_relay_main)</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relays control to the main layer.  <a href="#be4b6bc16960d97061b4eea00cf1f1cf"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8h.html#c74c587b2501362f8225b8ada1f8b0c0">verilog_cb_funcSig</a> (vlog_relay_ruby)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relays control from Verilog to Ruby.  <a href="#c74c587b2501362f8225b8ada1f8b0c0"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structt__cb__data.html">s_cb_data</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vlog_8h.html#d6adf9454678287bd05e9df18859f2a5">vlog_relay_ruby_reason</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the data corresponding to the callback that caused the relay from Verilog to Ruby.  <a href="#d6adf9454678287bd05e9df18859f2a5"></a><br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
 Interface between C and Verilog code. 
@@ -56,14 +56,13 @@ Relays control from Verilog to Ruby.
 
 </div>
 </div><p>
-<a class="anchor" name="be4b6bc16960d97061b4eea00cf1f1cf"></a><!-- doxytag: member="vlog.h::verilog_cb_funcSig" ref="be4b6bc16960d97061b4eea00cf1f1cf" args="(vlog_relay_main)" -->
+<a class="anchor" name="d6adf9454678287bd05e9df18859f2a5"></a><!-- doxytag: member="vlog.h::vlog_relay_ruby_reason" ref="d6adf9454678287bd05e9df18859f2a5" args="()" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">verilog_cb_funcSig           </td>
+          <td class="memname"><a class="el" href="structt__cb__data.html">s_cb_data</a>* vlog_relay_ruby_reason           </td>
           <td>(</td>
-          <td class="paramtype">vlog_relay_main&nbsp;</td>
           <td class="paramname">          </td>
           <td>&nbsp;)&nbsp;</td>
           <td width="100%"></td>
@@ -73,12 +72,12 @@ Relays control from Verilog to Ruby.
 <div class="memdoc">
 
 <p>
-Relays control to the main layer. 
+Returns the data corresponding to the callback that caused the relay from Verilog to Ruby. 
 <p>
 
 </div>
 </div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/c/vpi__user_8h.html

@@ -8732,7 +8732,7 @@ alias 1364-1995 system function subtypes to 1364-2001 function subtypes
 
 </div>
 </div><p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 27 22:29:46 2006 for Ruby-VPI by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Sat Dec 30 19:26:26 2006 for Ruby-VPI by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
 </body>

data/ref/ruby/classes/RDoc.html

@@ -80,7 +80,7 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000041">usage_from_file</a>&nbsp;&nbsp;
+      <a href="#M000045">usage_from_file</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -102,12 +102,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000041" class="method-detail">
-        <a name="M000041"></a>
+      <div id="method-M000045" class="method-detail">
+        <a name="M000045"></a>
 
         <div class="method-heading">
-          <a href="RDoc.src/M000041.html" target="Code" class="method-signature"
-            onclick="popupCode('RDoc.src/M000041.html');return false;">
+          <a href="RDoc.src/M000045.html" target="Code" class="method-signature"
+            onclick="popupCode('RDoc.src/M000045.html');return false;">
           <span class="method-name">usage_from_file</span><span class="method-args">(input_file, *args)</span>
           </a>
         </div>

data/ref/ruby/classes/RubyVpi.html

@@ -143,56 +143,38 @@
         <div class="method-heading">
           <a href="RubyVpi.src/M000029.html" target="Code" class="method-signature"
             onclick="popupCode('RubyVpi.src/M000029.html');return false;">
-          <span class="method-name">init_bench</span><span class="method-args">(aDesignId, aSpecFormat {|clock_signal| ...}</span>
+          <span class="method-name">init_bench</span><span class="method-args">(aDesignId, aSpecFormat, &amp;aSimulationCycle)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Initializes the bench by loading:
+Initializes the bench by setting up code coverage, the interactive
+debugger, and so on:
 </p>
 <ol>
-<li>the design.rb file
+<li>loads the design.rb file
 
 </li>
-<li>the proto.rb file if prototyping is enabled
+<li>loads the proto.rb file if prototyping is enabled
 
 </li>
-<li>the spec.rb file
+<li>loads the spec.rb file
 
 </li>
 </ol>
 <table>
-<tr><td valign="top">aDesignId:</td><td>The name of the Ruby design object.
+<tr><td valign="top">aDesignId:</td><td>The name of the Ruby object which gives access to the design under test.
 
 </td></tr>
-<tr><td valign="top">aSpecFormat:</td><td>The format being used by the specification.
+<tr><td valign="top">aSpecFormat:</td><td>The name of the format being used by the specification.
 
 </td></tr>
-<tr><td valign="top">aClockTrigger:</td><td>When the return value of this block is <tt>true</tt>, then the
-relay_verilog method returns. This block is given one argument: a handle to
-the clock signal that drives the design under test. If this block is not
-specified, relay_verilog will always return upon the next positive edge of
-the clock signal.
+<tr><td valign="top">aSimulationCycle:</td><td>A block that simulates the design under test by, for example, toggling the
+clock signal.
 
 </td></tr>
 </table>
-<pre>
-  # return upon positive edge
-  RubyVpi.init_bench ... |clk|
-    clk.intVal == 1
-  end
-
-  # return upon negative edge
-  RubyVpi.init_bench ... do |clk|
-    clk.intVal == 0
-  end
-
-  # return whenever clock changes
-  RubyVpi.init_bench ... do |clk|
-    true
-  end
-</pre>
         </div>
       </div>