ruby-vpi 18.0.2 → 19.0.0

data/doc/rss.xml

@@ -5,21 +5,182 @@
   <link>http://ruby-vpi.rubyforge.org</link>
   <description>Ruby-VPI is a Ruby interface to IEEE 1364-2005 Verilog VPI and a platform for unit testing, rapid prototyping, and systems integration of Verilog modules through Ruby. It lets you create complex Verilog test benches easily and wholly in Ruby.</description>
   <item>
-    <title>Version 18.0.2 released</title>
-    <link>http://ruby-vpi.rubyforge.org/doc/history.html#a18.0.2</link>
-    <guid>http://ruby-vpi.rubyforge.org/doc/history.html#a18.0.2</guid>
-    <description>&lt;h1 id=&quot;18.0.2&quot;&gt;Version 18.0.2 (2007-08-03)&lt;/h1&gt;
+    <title>Version 19.0.0 released</title>
+    <link>http://ruby-vpi.rubyforge.org/doc/history.html#a19.0.0</link>
+    <guid>http://ruby-vpi.rubyforge.org/doc/history.html#a19.0.0</guid>
+    <description>&lt;h1 id=&quot;19.0.0&quot;&gt;Version 19.0.0 (2007-08-27)&lt;/h1&gt;
 
-	&lt;p&gt;This release fixes a bug in error reporting.&lt;/p&gt;
+	&lt;p&gt;This release restores support for Cadence NC-Sim, breaks support for Mentor Modelsim, adds support for concurrent processes which simplify implementing Ruby prototypess, and offers numerous other improvements.&lt;/p&gt;
+
+
+	&lt;p&gt;&lt;strong&gt;Mentor Modelsim users, take note&lt;/strong&gt;: this release does not work very well with Mentor Modelsim, so do not upgrade until compatibility is restored in a future release. In the mean time, consider using this release with another simulator, such as &lt;a href=&quot;http://www.pragmatic-c.com/gpl-cver/&quot;&gt;GPL Cver&lt;/a&gt;.&lt;/p&gt;
+
+
+	&lt;h2&gt;Thanks&lt;/h2&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Calvin Wong &lt;a href=&quot;http://rubyforge.org/pipermail/ruby-vpi-discuss/2007-August/000046.html&quot;&gt;requested the concurrent processes feature&lt;/a&gt;, helped test it, and provided useful feedback.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;h2&gt;Caution&lt;/h2&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Prototypes no longer have a &lt;code class=&quot;code&quot;&gt;feign!&lt;/code&gt; method.  Instead, they emulate the behavior of the real Verilog DUT using the new &lt;a href=&quot;manual.html#usage.concurrency&quot;&gt;concurrency model&lt;/a&gt;.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;All &amp;#8220;initial&amp;#8221; blocks in Verilog code are now evaluated &lt;em&gt;before&lt;/em&gt; the specification begins executing. This allows you to set the initial value of registers in Verilog before the specification interacts with them.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;The &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Vpi&lt;/span&gt;&lt;/code&gt; module has been renamed to &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;&lt;/code&gt; for consistency with the project name.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;The &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::simulation_time&lt;/code&gt; method has been renamed to &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::current_time&lt;/code&gt;.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;The &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Handle&lt;/span&gt;.value_forced?&lt;/code&gt; method has been renamed to &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Handle&lt;/span&gt;.force?&lt;/code&gt;&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;The &lt;tt&gt;samp/&lt;/tt&gt; directory has been renamed to &lt;tt&gt;examples/&lt;/tt&gt;.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Code coverage analysis results are now produced only in plain-text format.&lt;/li&gt;
+	&lt;/ul&gt;
 
 
 	&lt;h2&gt;Repairs&lt;/h2&gt;
 
 
 	&lt;ul&gt;
-	&lt;li&gt;Unhandled Ruby exceptions and errors were not being printed to the screen because Ruby-VPI unconditionally gave control back to the Verilog simulator before it exited.&lt;/li&gt;
+	&lt;li&gt;You can now access VPI constants using their original uncapitalized names.  For example, you can now write &amp;#8220;vpiIntVal&amp;#8221; instead of having to write &amp;#8220;VpiIntVal&amp;#8221;.  However, note that the capitalized names are still supported, so you are not required to change your code.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Value change / edge detection for VPI handles was previously incorrect:  if you called the &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Handle&lt;/span&gt;.posedge?&lt;/code&gt; function twice in the same time step, it would give you two different answers.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;The problem of not being able to write values to nets in Cadence NC-Sim has been fixed.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;h2&gt;Additions&lt;/h2&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Added support for &lt;a href=&quot;manual.html#usage.concurrency&quot;&gt;concurrent processes&lt;/a&gt;, which make Ruby prototypes appear more like Verilog code and also give the ability to write parallel tests.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Added support for performance profiling using the &lt;a href=&quot;http://ruby-prof.rubyforge.org&quot;&gt;ruby-prof&lt;/a&gt; project. The profiler can be enabled by setting the &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;PROFILER&lt;/span&gt;&lt;/code&gt; environment variable to &amp;#8220;1&amp;#8221; before running a Ruby-VPI test.&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Added new method aliases to &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Handle&lt;/span&gt;&lt;/code&gt; for value detection. The complete list of aliases is now:
+	&lt;ul&gt;
+	&lt;li&gt;Tests if the logic value of this handle is unknown (x).
+	&lt;ul&gt;
+	&lt;li&gt;x?&lt;/li&gt;
+		&lt;li&gt;unknown?&lt;/li&gt;
+		&lt;li&gt;dont_care?&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Sets the logic value of this handle to unknown (x).
+	&lt;ul&gt;
+	&lt;li&gt;x!&lt;/li&gt;
+		&lt;li&gt;unknown!&lt;/li&gt;
+		&lt;li&gt;dont_care!&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Tests if the logic value of this handle is high impedance (z).
+	&lt;ul&gt;
+	&lt;li&gt;z?&lt;/li&gt;
+		&lt;li&gt;hi_z?&lt;/li&gt;
+		&lt;li&gt;high_z?&lt;/li&gt;
+		&lt;li&gt;high_impedance?&lt;/li&gt;
+		&lt;li&gt;tri_state?&lt;/li&gt;
+		&lt;li&gt;floating?&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Sets the logic value of this handle to high impedance (z).
+	&lt;ul&gt;
+	&lt;li&gt;z!&lt;/li&gt;
+		&lt;li&gt;hi_z!&lt;/li&gt;
+		&lt;li&gt;high_z!&lt;/li&gt;
+		&lt;li&gt;high_impedance!&lt;/li&gt;
+		&lt;li&gt;tri_state!&lt;/li&gt;
+		&lt;li&gt;floating!&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Tests if the logic value of this handle is at &amp;#8220;logic high&amp;#8221; level.
+	&lt;ul&gt;
+	&lt;li&gt;high?&lt;/li&gt;
+		&lt;li&gt;one?&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Sets the logic value of this handle to &amp;#8220;logic high&amp;#8221; level.
+	&lt;ul&gt;
+	&lt;li&gt;high!&lt;/li&gt;
+		&lt;li&gt;one!&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Tests if the logic value of this handle is at &amp;#8220;logic low&amp;#8221; level.
+	&lt;ul&gt;
+	&lt;li&gt;low?&lt;/li&gt;
+		&lt;li&gt;zero?&lt;/li&gt;
+	&lt;/ul&gt;
+	&lt;/li&gt;
+		&lt;li&gt;Sets the logic value of this handle to &amp;#8220;logic low&amp;#8221; level.
+	&lt;ul&gt;
+	&lt;li&gt;low!&lt;/li&gt;
+		&lt;li&gt;zero!&lt;/li&gt;
+	&lt;/ul&gt;&lt;/li&gt;
+	&lt;/ul&gt;&lt;/li&gt;
+	&lt;/ul&gt;
+
+
+	&lt;ul&gt;
+	&lt;li&gt;Added new methods to &lt;code class=&quot;code&quot;&gt;&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;VPI&lt;/span&gt;::&lt;span style=&quot;color:#036; font-weight:bold&quot;&gt;Handle&lt;/span&gt;&lt;/code&gt; for value change / edge detection:
+	&lt;ul&gt;
+	&lt;li&gt;edge? &amp;#8211; detects positive and negative edges&lt;/li&gt;
+		&lt;li&gt;change? &amp;#8211; detects any kind of value change&lt;/li&gt;
+		&lt;li&gt;change_00? &amp;#8211; detects a value change from 0 to 0&lt;/li&gt;
+		&lt;li&gt;change_01? &amp;#8211; detects a value change from 0 to 1&lt;/li&gt;
+		&lt;li&gt;change_0x? &amp;#8211; detects a value change from 0 to unknown&lt;/li&gt;
+		&lt;li&gt;change_0z? &amp;#8211; detects a value change from 0 to high-Z&lt;/li&gt;
+		&lt;li&gt;change_10? &amp;#8211; detects a value change from 1 to 0&lt;/li&gt;
+		&lt;li&gt;change_11? &amp;#8211; detects a value change from 1 to 1&lt;/li&gt;
+		&lt;li&gt;change_1x? &amp;#8211; detects a value change from 1 to unknown&lt;/li&gt;
+		&lt;li&gt;change_1z? &amp;#8211; detects a value change from 1 to high-Z&lt;/li&gt;
+		&lt;li&gt;change_x0? &amp;#8211; detects a value change from unknown to 0&lt;/li&gt;
+		&lt;li&gt;change_x1? &amp;#8211; detects a value change from unknown to 1&lt;/li&gt;
+		&lt;li&gt;change_xx? &amp;#8211; detects a value change from unknown to unknown&lt;/li&gt;
+		&lt;li&gt;change_xz? &amp;#8211; detects a value change from unknown to high-Z&lt;/li&gt;
+		&lt;li&gt;change_z0? &amp;#8211; detects a value change from high-Z to 0&lt;/li&gt;
+		&lt;li&gt;change_z1? &amp;#8211; detects a value change from high-Z to 1&lt;/li&gt;
+		&lt;li&gt;change_zx? &amp;#8211; detects a value change from high-Z to unknown&lt;/li&gt;
+		&lt;li&gt;change_zz? &amp;#8211; detects a value change from high-Z to high-Z&lt;/li&gt;
+	&lt;/ul&gt;&lt;/li&gt;
 	&lt;/ul&gt;</description>
-    <pubDate>Fri, 03 Aug 2007 00:00:00 PDT</pubDate>
+    <pubDate>Mon, 27 Aug 2007 00:00:00 PDT</pubDate>
   </item>
 </channel>
 </rss>

data/doc/screen.css

@@ -0,0 +1,146 @@
+@import 'common.css';
+
+body {
+  margin: 0;
+  background-color: snow;
+}
+
+#body {
+  max-width: 37em;
+  width: expression("37em"); /* for IE */
+
+  background-color: white;
+  border-right: thick solid salmon;
+  padding: 1em;
+}
+
+
+/* headings */
+
+h1, h2, h3, h4, h5, h6, th, .title {
+  font-family: serif;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-weight: lighter;
+  padding-bottom: 2px;
+  border-bottom: 3px solid cornflowerblue;
+}
+
+h1 a,
+h2 a,
+h3 a,
+h4 a,
+h5 a,
+h6 a {
+  text-decoration: none;
+}
+
+
+/* table of contents */
+
+#menu {
+  top: 1em;
+  left: 41em;
+  position: absolute;
+
+  position: expression("static"); /* for IE */
+  float: expression("right"); /* for IE */
+}
+
+#menu h1 {
+  padding-top: 0;
+}
+
+#menu ul,
+#menu ol {
+  padding-bottom: 1em;
+}
+
+#menu li {
+  margin-left: -1em;
+}
+
+#toc-contents {
+  padding-top: 1em;
+}
+
+
+/* latex */
+
+.front_cover h1,
+.front_cover h2,
+.front_cover h3,
+.front_cover h4,
+.front_cover h5,
+.front_cover h6 {
+  border: none;
+  text-align: center;
+}
+
+.part > .title,
+.chapter > .title {
+  border: none;
+}
+
+.part > .title {
+  border-bottom: thick solid salmon;
+}
+
+.paragraph > .title,
+.admonition .title {
+  font-family: serif;
+  font-size: larger;
+}
+
+
+/* admonitions */
+
+.admonition {
+  border: thin solid seagreen;
+  background-color: honeydew;
+}
+
+
+/* source code */
+
+pre {
+  overflow: auto;
+}
+
+code {
+  padding: 0.125em;
+  padding-left: 0.25em;
+  padding-right: 0.25em;
+}
+
+
+/* emphasis */
+
+body {
+  font-family: sans-serif;
+}
+
+em, blockquote {
+  font-family: serif;
+}
+
+blockquote {
+  border: thin solid salmon;
+  border-left-width: thick;
+  padding-left: 1em;
+  background: snow;
+}
+
+hr {
+  background-color: red;
+  border: none;
+}
+
+big {
+  font-size: larger;
+}
+
+a:hover {
+  color: red;
+}

data/doc/spacing.css

@@ -0,0 +1,57 @@
+h1, h2, h3, h4, h5, h6 {
+  padding-top: 2em;
+}
+
+
+/* latex */
+
+.front_cover > .title {
+  padding-top: 0;
+}
+
+.front_cover > .author {
+  padding-top: 2em;
+}
+
+.front_cover > .date {
+  padding-top: 1em;
+}
+
+.part,
+.chapter {
+  padding-top: 3em;
+}
+
+.part > .title,
+.chapter > .title {
+  padding-bottom: 1em;
+}
+
+.paragraph > .title {
+  padding-top: 1em;
+}
+
+
+/* admonitions */
+
+.admonition {
+  padding: 1em;
+  margin-top: 1em;
+  margin-bottom: 1em;
+  min-height: 150px;
+}
+
+
+/* source code */
+
+pre {
+  padding: 1em;
+}
+
+
+/* formal blocks */
+
+.formal {
+  padding-top: 1em;
+  padding-bottom: 1em;
+}

data/examples/counter/RSpec/counter_proto.rb

@@ -0,0 +1,9 @@
+always do
+  wait until clock.posedge?
+
+  if reset.high?
+    count.intVal = 0
+  else
+    count.intVal += 1
+  end
+end

data/examples/counter/xUnit/counter_proto.rb

@@ -0,0 +1,9 @@
+always do
+  wait until clock.posedge?
+
+  if reset.high?
+    count.intVal = 0
+  else
+    count.intVal += 1
+  end
+end

data/{samp → examples}/pipelined_alu/hw5_unit_design.rb

@@ -8,13 +8,6 @@ end
 
 # Brings the design under test into a blank state.
 def reset!
-  clk.x!
-  reset.x!
-  in_databits.x!
-  a.x!
-  b.x!
-  in_op.x!
-
   reset.high!
   5.times { cycle! }
   reset.low!

data/examples/pipelined_alu/hw5_unit_proto.rb

@@ -0,0 +1,2 @@
+warn "Woe is me! Nobody implemented a Ruby prototype for this design. :-("
+exit

data/examples/register_file/register_file_proto.rb

@@ -0,0 +1,11 @@
+always do
+  wait until rdReg.change? or wtReg.change? or rw.change? or enable.change?
+
+  if rw.low?
+    targetReg        = register.memoryWord_a[rdReg.intVal]
+    outBus.intVal    = targetReg.intVal
+  elsif enable.high?
+    targetReg        = register.memoryWord_a[wtReg.intVal]
+    targetReg.intVal = inBus.intVal
+  end
+end

data/ext/main.c

@@ -19,14 +19,14 @@ void main_init() {
   ruby_init_loadpath();
 
   // load the VPI interface for Ruby
-    Init_vpi();
-    rb_define_module_function(mVpi, "relay_verilog", main_relay_verilog, 0);
-    rb_define_module_function(mVpi, "relay_ruby_reason", main_relay_ruby_reason, 0);
+    Init_VPI();
+    rb_define_module_function(mVPI, "__extension__relay_verilog", main_relay_verilog, 0);
+    rb_define_module_function(mVPI, "__extension__relay_ruby_reason", main_relay_ruby_reason, 0);
 
     // some compilers have trouble with pointers to the va_list
     // type.  See ext/Rakefile and the user manual for details
-    rb_define_alias(mVpi, "vpi_vprintf", "vpi_printf");
-    rb_define_alias(mVpi, "vpi_mcd_vprintf", "vpi_mcd_printf");
+    rb_define_alias(mVPI, "vpi_vprintf", "vpi_printf");
+    rb_define_alias(mVPI, "vpi_mcd_vprintf", "vpi_mcd_printf");
 
 
   char* bootLoader = getenv("RUBYVPI_BOOT_LOADER");

data/ext/swig_vpi.i

@@ -1,4 +1,4 @@
-%module vpi
+%module VPI
 
 /* Parse the header file to generate wrappers */
 %{
@@ -6,7 +6,11 @@
 %}
 %include "swig_vpi.h"
 
-/* allows us to set S_cb_data.cb_rtn = Vpi::Vlog_relay_ruby in Ruby */
+/* Allows us set the VPI callback handler in Ruby:
+
+    data        = S_cb_data.new
+    data.cb_rtn = VPI::Vlog_relay_ruby
+*/
 %{
 #include "vlog.h"
 %}