HDLRuby 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c150464dc8c76fe2fdcf37ee752a8662c8d6128b
-  data.tar.gz: 16facc5e58f5545cf85586f541c61638ecd78733
+  metadata.gz: 184d23d99443c8b8dbfe750f4cbfc05322be054f
+  data.tar.gz: 54030243baadbc7999a265122edac715c17f8f9b
 SHA512:
-  metadata.gz: 8402087045e3f64a50e0553a69b36dcce5b752bb16c58a0f75ffa37bddeea9b3e366f65d94abdc5abae4f9ee0532d0e8e85e8b2a254e9f18484033b17e31fa47
-  data.tar.gz: 406803e4c457b43b52a71eec5d121d8fa09902c7943b7611c5ffd22cca5207bfb3647ee642bdbc869a7d4aff9d07d2d69d8f29878a1fdae06fbb6d650f3257bc
+  metadata.gz: 3bd71ebfa372f55deef0a675b64a8de523e3b12bf56a8e67a1c111de0136821c69a835b6ddf91d294e9ad145f89a3a9caa639b2bcddae2278d64b6607eeaba1b
+  data.tar.gz: aa617a1cf9ea4054644e484dff24b00cab51e5f3f618c9140abfd53fb682dfafd468bbd81734364e3961c9dc4b22de7c6b5e6ecd060cde15ca6d6790e6b3d5e0

data/HDLRuby.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ["README.md"]
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  # spec.require_paths = ["lib"]
+  spec.require_paths = ["lib","lib/HDLRuby"]
 
   spec.required_ruby_version = '>= 2.0'
   spec.add_development_dependency "bundler", "~> 2.0.1"

data/README.md

@@ -1923,11 +1923,7 @@ For example, the following code describes an empty system with two generic param
 system(:nothing) { |a,b| }
 ```
 
-The generic parameters can be anything: values, data types, systems, Ruby variables, and so on.  For example, the following system uses generic argument
-`t` as a type for an input signal, generic argument `w` as a bit range for an
-output signal and generic argument `s` as a system used for creating instance
-`sI` whose input and output signals `i` and `o` are connected respectively to
-signals `isig` and `osig`.
+The generic parameters can be anything: values, data types, signals, systems, Ruby variables, and so on.  For example, the following system uses generic argument `t` as a type for an input signal, generic argument `w` as a bit range for an output signal and generic argument `s` as a system used for creating instance `sI` whose input and output signals `i` and `o` are connected respectively to signals `isig` and `osig`.
 
 ```ruby
 system :something do |t,w,s|
@@ -1995,7 +1991,7 @@ end
 
 __Note:__
 
-- In the example above, generic parameter `param` of `sybsys_gen` is used for specializing system `sys`.
+- In the example above, generic parameter `param` of `subsys_gen` is used for specializing system `sys`.
 
 
 ##### Specializing generic types
@@ -2009,6 +2005,27 @@ A generic type is specialized by invoking its name and passing as argument the v
 If less values are provided than the number of generic arguments, the type is partially specialized. However, only a fully specialized type can be used for declaring signals.
 
 
+##### Use of signals as generic parameters
+
+Signals passed as generic arguments to systems can be used for making generic connections to the instance of the system. For that purpose, the generic argument has to be declared as input, output or inout port in the body of the system as follows:
+
+```ruby
+system :<system_name> do |sig|
+   sig.input :my_sig
+   ...
+end
+```
+
+In the code above, `sig` is a generic argument assumed to be a signal. The second line declares the port to which sig will connected to when instantiating. From there, port `my_sig` can be used like any other port of the system. Such a system is them instantiated as follows:
+
+```ruby
+system_name(some_sig) :<instance_name>
+```
+
+In the code above, `some_sig` is a signal available in the current context. This instantiation automatically connects `some_sig` to the instance.
+
+
+
 ### Inheritance
 <a name="inherit"></a>
 
@@ -2715,8 +2732,11 @@ This library provides a unified interface to complex communication protocols thr
 
 A channel is used similarly to a pipe: it has an input where data can be written and an output where data can be read. The ordering of the data and the synchronization depend on the internals of the channel, e.g., a channel can be FIFO or LIFO. The interaction with the channel is done using the following methods:
  
- * `writer_ports`: generate ports in the system for writing to the channel. This method is used without any argument.
- * `reader_ports`: generate ports in the system for reading from the channel. This method is used without any argument.
+ * `output <name>`: generate ports in the system for writing to the channel and associate them to `name`
+ * `input <name>`: generate ports in the system for reading from the channel amd associate them to `name`
+
+When the channel ports are declared, they can be accessed using the following methods depending on whether they are writing or reading ports:
+
  * `write(<value>) <block>`: write `value` to the channel and execute `block` when `write` completes. Both `value` and `block` may be omitted depending on the kind of channel.
  * `read(<target>) <block>`: read the channel, assign the result to signal `target` and execute `block` when the read completes. Both `target` and `block` may be omitted depending on the kind of channel.
 
@@ -2727,7 +2747,7 @@ system :producer8 do |channel|
     # Inputs of the producer: clock and reset.
     input :clk, :rst
     # Instantiate the channel ports
-    channel.writer_ports
+    channel.output :chi
     # Inner 8-bit counter for generating values.
     [8].inner :counter
 
@@ -2735,7 +2755,7 @@ system :producer8 do |channel|
     par(clk.posedge) do
         hif(rst) { counter <= 0 }
         helse do
-            channel.write(counter) { counter <= counter + 1 }
+            chi.write(counter) { counter <= counter + 1 }
         end
     end
 end
@@ -2814,17 +2834,12 @@ And in case there are generic parameter, the instantiation procedure is as follo
 <channel name>(:<instance name>).(<generic parameters>)
 ```
 
-After a channel is instantiated, it must be linked to the circuits that will communicate through it. This is done when instantiating these circuits. If a circuit reads on the channel, it will be instantiated as follows:
+After a channel is instantiated, it must be linked to the circuits that will communicate through it. This is done when instantiating these circuits. If a circuit reads or writes on the channel, it will be instantiated as follows:
 
 ```ruby
-<system name>(<channel instance>).(:<instance name>).(<circuit standard connections>,*<channel instance>.reader_signals)
+<system name>(<channel instance>).(:<instance name>).(<circuit standard connections>)
 ```
 
-If the circuit writes on the channel, it must be instantiated as follows:
-
-```ruby
-<system name>(<channel instance>).(:<instance name>).(<circuit standard connections>,*<channel instance>.writer_signals)
-```
 
 __Notes__:
 
@@ -2846,10 +2861,10 @@ system :producer_consumer8 do
    regchI.reset.at(rst.posedge)
 
    # Instantiate the producer.
-   producer8(regch).(:producerI).(clk,rst,*regch.writer_signals)
+   producer8(regch).(:producerI).(clk,rst)
 
    # Instantiate the consumer.
-   consumer8(regch).(:consumerI).(clk.rst,*regch.reader_signals)
+   consumer8(regch).(:consumerI).(clk.rst)
 end
 ```
 

data/lib/HDLRuby/hdr_samples/calculator.rb

@@ -1,4 +1,4 @@
-require '../std/fsm.rb'
+require 'std/fsm.rb'
 
 include HDLRuby::High::Std
 

data/lib/HDLRuby/hdr_samples/mei8.rb

@@ -1,5 +1,5 @@
-require '../std/fsm.rb'
-require '../std/decoder.rb'
+require 'std/fsm.rb'
+require 'std/decoder.rb'
 include HDLRuby::High::Std
 
 # A simple implementation of the MEI8 processor.

data/lib/HDLRuby/hdr_samples/mei8_bench.rb

@@ -1,5 +1,5 @@
-require '../std/fsm.rb'
-require '../std/decoder.rb'
+require 'std/fsm.rb'
+require 'std/decoder.rb'
 include HDLRuby::High::Std
 
 # A simple implementation of the MEI8 processor.

data/lib/HDLRuby/hdr_samples/multer_seq.rb

@@ -1,4 +1,4 @@
-require '../std/fsm.rb'
+require 'std/fsm.rb'
 include HDLRuby::High::Std
 
 # A sequential 16x16 -> 32 multer

data/lib/HDLRuby/hdr_samples/with_channel.rb

@@ -1,5 +1,4 @@
-
-require '../std/channel.rb'
+require 'std/channel.rb'
 
 include HDLRuby::High::Std
 

data/lib/HDLRuby/hdr_samples/with_decoder.rb

@@ -1,4 +1,4 @@
-require '../std/decoder.rb'
+require 'std/decoder.rb'
 include HDLRuby::High::Std
 
 # Implementation of a decoder.

data/lib/HDLRuby/hdr_samples/with_fsm.rb

@@ -1,4 +1,4 @@
-require '../std/fsm.rb'
+require 'std/fsm.rb'
 
 include HDLRuby::High::Std
 

data/lib/HDLRuby/hdr_samples/with_reconf.rb

@@ -1,4 +1,4 @@
-require '../std/reconf.rb'
+require 'std/reconf.rb'
 
 include HDLRuby::High::Std
 

data/lib/HDLRuby/hdrcc.rb

@@ -54,6 +54,14 @@ module HDLRuby
             @dir = dir.to_s
             @params = params
 
+            # The list of the standard library files to exclude for
+            # checking.
+            # Get the directory of the HDLRuby and Ruby standard libraries.
+            @std_dirs = $LOAD_PATH
+            # @std_dirs << File.dirname(__FILE__) + "/std"
+            # # Gather the files with their path to std.
+            # @std_files = Dir[@std_dir + "/*"]
+
             # The list of required files.
             @requires = []
 
@@ -70,19 +78,45 @@ module HDLRuby
 
         # Loads a single +file+.
         def read(file)
-            @texts << File.read(File.join(@dir,file) )
-            @checks << Checker.new(@texts[-1],file)
+            # Resolve the file.
+            found = File.join(@dir,file)
+            unless File.exist?(found) then
+                founds = Dir.glob(@std_dirs.map {|path| File.join(path,file) })
+                if founds.empty? then
+                    # No standard file with this name, this is an error.
+                    raise "Unknown required file: #{file}."
+                else
+                    # A standard file is found, skip it since it does not
+                    # need to be read.
+                    # puts "Standard files: #{founds}"
+                    return false
+                end
+            end
+            # Load the file.
+            # @texts << File.read(File.join(@dir,file) )
+            @texts << File.read(found)
+            # @checks << Checker.new(@texts[-1],file)
+            @checks << Checker.new(@texts[-1],found)
+            return true
         end
 
         # Loads all the files from +file+.
         def read_all(file = @top_file)
             # puts "read_all with file=#{file}"
             # Read the file
-            read(file)
+            # read(file)
+            unless read(file) then
+                # The file is to skip.
+                return
+            end
             # Get its required files.
             requires = @checks[-1].get_all_requires
             requires.each do |file|
-                read_all(file) if file != "HDLRuby"
+                # if file != "HDLRuby" &&
+                #         !@std_files.find { |std| std.include?(file) } then
+                #     read_all(file)
+                # end
+                read_all(file)
             end
             @requires += requires
             @requires.uniq!

data/lib/HDLRuby/version.rb

@@ -1,3 +1,3 @@
 module HDLRuby
-  VERSION = "2.1.0"
+  VERSION = "2.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Lovic Gauthier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -280,6 +280,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/HDLRuby
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="