origen 0.27.0 → 0.28.0

data/lib/origen/registers.rb

@@ -41,6 +41,7 @@ module Origen
     end
 
     def method_missing(method, *args, &block) # :nodoc:
+      orig_method = method
       if method[-1] == '!'
         bang = true
         method = method.to_s.chop.to_sym
@@ -50,11 +51,11 @@ module Origen
         r.sync if bang
         r
       else
-        super
+        super(orig_method, *args, &block)
       end
     end
 
-    def respond_to?(sym) # :nodoc:
+    def respond_to?(sym, include_private = false) # :nodoc:
       if sym[-1] == '!'
         r = sym.to_s.chop.to_sym
         _registers.key?(r) || super(sym)
@@ -249,8 +250,8 @@ module Origen
         materialize.send(method, *args, &block)
       end
 
-      def respond_to?(method)
-        materialize.respond_to?(method)
+      def respond_to?(method, include_private = false)
+        materialize.respond_to?(method, include_private)
       end
 
       def materialize

data/lib/origen/registers/bit_collection.rb

@@ -502,13 +502,16 @@ module Origen
         result.to_s
       end
 
-      # Write the bit value on silicon<br>
+      # Write the bit value on silicon.
       # This method will update the data value of the bits and then call $top.write_register
-      # passing the owngin register as the first argument.<br>
+      # passing the owning register as the first argument.
       # This method is expected to handle writing the current state of the register to silicon.
       def write!(value = nil, options = {})
         value, options = nil, value if value.is_a?(Hash)
         write(value, options) if value
+        if block_given?
+          yield size == @reg.size ? @reg : self
+        end
         @reg.request(:write_register, options)
         self
       end
@@ -521,8 +524,10 @@ module Origen
       #   reg(:data).read!(0x5555) # Read register :data, expecting 0x5555
       def read!(value = nil, options = {})
         value, options = nil, value if value.is_a?(Hash)
-        read(value, options)
-        # launch a read reg
+        read(value, options) unless block_given?
+        if block_given?
+          yield size == @reg.size ? @reg : self
+        end
         @reg.request(:read_register, options)
         self
       end

data/lib/origen/registers/reg.rb

@@ -126,17 +126,53 @@ module Origen
         @updating_bound_bits
       end
 
-      def inspect
+      def inspect(options = {})
+        # This fancy_output option is passed in via option hash
+        #  Even better, the output could auto-detect 7-bit vs 8-bit terminal output and adjust the parameter, but that's for another day
+        fancy_output = options[:fancy_output].nil? ? true : options[:fancy_output]
+        if fancy_output
+          horiz_double_line = '═'
+          horiz_double_tee_down = '╤'
+          horiz_double_tee_up = '╧'
+          corner_double_up_left = '╒'
+          corner_double_up_right = '╕'
+          horiz_single_line = '─'
+          horiz_single_tee_down = '┬'
+          horiz_single_tee_up = '┴'
+          horiz_single_cross = '┼'
+          horiz_double_cross = '╪'
+          corner_single_down_left = '└'
+          corner_single_down_right = '┘'
+          vert_single_line = '│'
+          vert_single_tee_left = '┤'
+          vert_single_tee_right = '├'
+        else
+          horiz_double_line = '='
+          horiz_double_tee_down = '='
+          horiz_double_tee_up = '='
+          corner_double_up_left = '.'
+          corner_double_up_right = '.'
+          horiz_single_line = '-'
+          horiz_single_tee_down = '-'
+          horiz_single_tee_up = '-'
+          horiz_single_cross = '+'
+          horiz_double_cross = '='
+          corner_single_down_left = '`'
+          corner_single_down_right = '\''
+          vert_single_line = '|'
+          vert_single_tee_left = '<'
+          vert_single_tee_right = '>'
+        end
         bit_width = 13
         desc = ["\n0x%X - :#{name}" % address]
         r = size % 8
         if r == 0 || (size > 8 && bit_order == :msb0)
-          desc << ('   ' + ('=' * (bit_width + 1) * 8)).chop
+          desc << ('  ' + corner_double_up_left + ((horiz_double_line * bit_width + horiz_double_tee_down) * 8)).chop + corner_double_up_right
         else
           if bit_order == :lsb0
-            desc << ('   ' + (' ' * (bit_width + 1) * (8 - r)) + ('=' * (bit_width + 1) * r)).chop
+            desc << ('  ' + (' ' * (bit_width + 1) * (8 - r)) + corner_double_up_left + ((horiz_double_line * bit_width + horiz_double_tee_down) * r)).chop + corner_double_up_right
           else
-            desc << ('   ' + ('=' * (bit_width + 1) * r)).chop
+            desc << ('  ' + corner_double_up_left + ((horiz_double_line * bit_width + horiz_double_tee_down) * r)).chop + corner_double_up_right
           end
         end
 
@@ -164,16 +200,16 @@ module Origen
             end
             if bit_num > size - 1
               if bit_order == :msb0 && bit_num == size
-                line += '|'
+                line += vert_single_line
                 line_complete = true
               else
-                line << ' ' + ''.center(bit_width)
+                line << ' ' + ''.center(bit_width) unless line_complete
               end
             else
-              line << '|' + "#{bit_num}".center(bit_width)
+              line << vert_single_line + "#{bit_num}".center(bit_width)
             end
           end
-          line += '|' unless line_complete
+          line += vert_single_line unless line_complete
           desc << line
 
           # BIT NAME ROW
@@ -213,15 +249,15 @@ module Origen
                   end
                   width = (bit_width * bit_span) + bit_span - 1
                   if bit_name.length > width
-                    line << '|' + "#{bit_name[0..width - 2]}*"
+                    line << vert_single_line + "#{bit_name[0..width - 2]}*"
                   else
-                    line << '|' + bit_name.center(width)
+                    line << vert_single_line + bit_name.center(width)
                   end
 
                 else
                   bit.shift_out_left do |bit|
                     if _index_in_range?(bit.position, max_bit, min_bit)
-                      line << '|' + ''.center(bit_width)
+                      line << vert_single_line + ''.center(bit_width)
                     end
                   end
                 end
@@ -237,12 +273,12 @@ module Origen
                 else
                   txt = ''
                 end
-                line << '|' + txt.center(bit_width)
+                line << vert_single_line + txt.center(bit_width)
               end
             end
             first_done = true
           end
-          line += '|'
+          line += vert_single_line
           desc << line
 
           # BIT STATE ROW
@@ -272,11 +308,11 @@ module Origen
                   value += _state_desc(bit)
                   bit_span = _num_bits_in_range(bit, max_bit, min_bit)
                   width = bit_width * bit_span
-                  line << '|' + value.center(width + bit_span - 1)
+                  line << vert_single_line + value.center(width + bit_span - 1)
                 else
                   bit.shift_out_left do |bit|
                     if _index_in_range?(bit.position, max_bit, min_bit)
-                      line << '|' + ''.center(bit_width)
+                      line << vert_single_line + ''.center(bit_width)
                     end
                   end
                 end
@@ -292,31 +328,37 @@ module Origen
                     end
                   end
                   value = "#{val}" + _state_desc(bit)
-                  line << '|' + value.center(bit_width)
+                  line << vert_single_line + value.center(bit_width)
                 else
-                  line << '|' + ''.center(bit_width)
+                  line << vert_single_line + ''.center(bit_width)
                 end
               end
             end
             first_done = true
           end
-          line += '|'
+          line += vert_single_line
           desc << line
 
           if size >= 8
             r = size % 8
             if byte_index == 0 && r != 0 && bit_order == :lsb0
-              desc << ('   ' + ('=' * (bit_width + 1) * (8 - r)).chop + ' ' + ('-' * (bit_width + 1) * r)).chop
+              desc << ('  ' + corner_double_up_left + ((horiz_double_line * bit_width + horiz_double_tee_down) * (8 - r)).chop + horiz_double_cross + (horiz_single_line * (bit_width + 1) * r)).chop + vert_single_tee_left
             elsif (byte_index == num_bytes - 1) && r != 0 && bit_order == :msb0
-              desc << ('   ' + ('-' * (bit_width + 1) * r)).chop
+              desc << ('  ' + corner_single_down_left + ((horiz_single_line * bit_width + horiz_single_tee_up) * r)).chop + corner_single_down_right
+            elsif (byte_index == num_bytes - 2) && r != 0 && bit_order == :msb0
+              desc << '  ' + vert_single_tee_right + ((horiz_single_line * bit_width + horiz_single_cross) * r) + ((horiz_single_line * bit_width + horiz_single_tee_up) * (8 - r)).chop + corner_single_down_right
             else
-              desc << ('   ' + ('-' * (bit_width + 1) * 8)).chop
+              if byte_index == num_bytes - 1
+                desc << ('  ' + corner_single_down_left + ((horiz_single_line * bit_width + horiz_single_tee_up) * 8)).chop + corner_single_down_right
+              else
+                desc << ('  ' + vert_single_tee_right + ((horiz_single_line * bit_width + horiz_single_cross) * 8)).chop + vert_single_tee_left
+              end
             end
           else
             if bit_order == :lsb0
-              desc << ('   ' + (' ' * (bit_width + 1) * (8 - size)) + ('-' * (bit_width + 1) * size)).chop
+              desc << ('  ' + (' ' * (bit_width + 1) * (8 - size)) + corner_single_down_left + ((horiz_single_line * bit_width + horiz_single_tee_up) * size)).chop + corner_single_down_right
             else
-              desc << ('   ' + ('-' * (bit_width + 1) * size)).chop
+              desc << ('  ' + corner_single_down_left + ((horiz_single_line * bit_width + horiz_single_tee_up) * size)).chop + corner_single_down_right
             end
           end
         end
@@ -435,7 +477,7 @@ module Origen
           if line =~ /^\s*#(.*)/
             desc << Regexp.last_match[1].strip
           #              http://rubular.com/r/D8lg2P5kK1                     http://rubular.com/r/XP4ydPV8Fd
-          elsif line =~ /^\s*reg\(?\s*[:"'](\w+)["']?\s*,.*\sdo/ || line =~ /^\s*add_reg\(?\s*[:"'](\w+)["']?\s*,.*/
+          elsif line =~ /^\s*reg\(?\s*[:"'](\w+)["']?\s*,.*\sdo/ || line =~ /^\s*.*add_reg\(?\s*[:"'](\w+)["']?\s*,.*/
             @current_reg_name = Regexp.last_match[1].to_sym
             description_lookup[define_file] ||= {}
             description_lookup[define_file][@current_reg_name] ||= {}

data/lib/origen/site_config.rb

@@ -56,7 +56,7 @@ module Origen
         elsif FALSE_VALUES.include?(val)
           return false
         end
-        config
+        val
       else
         config = configs.find { |c| c.key?(val) }
         config ? config[val] : nil

data/lib/origen/sub_blocks.rb

@@ -212,7 +212,7 @@ module Origen
     end
     alias_method :children, :sub_blocks
 
-    # Delete all sub_blocks by emptyig the Hash
+    # Delete all sub_blocks by emptying the Hash
     def delete_sub_blocks
       @sub_blocks = {}
     end
@@ -265,47 +265,22 @@ module Origen
         end
         a
       else
-        class_name = options.delete(:class_name)
-        if class_name
-          if eval("defined? ::#{namespace}::#{class_name}")
-            klass = eval("::#{namespace}::#{class_name}")
+        block = Placeholder.new(self, name, options)
+        if sub_blocks[name]
+          # Allow additional attributes to be added to an existing sub-block if it hasn't
+          # been instantiated yet. This is not supported yet for instantiated sub-blocks since
+          # there are probably a lot more corner-cases to consider, and hopefully no one will
+          # really need this anyway.
+          if sub_blocks[name].is_a?(Placeholder)
+            sub_blocks[name].add_attributes(options)
           else
-            if eval("defined? #{class_name}")
-              klass = eval(class_name)
-            else
-              if eval("defined? #{self.class}::#{class_name}")
-                klass = eval("#{self.class}::#{class_name}")
-              else
-                puts "Could not find class: #{class_name}"
-                fail 'Unknown sub block class!'
-              end
-            end
+            fail "You have already defined a sub-block named #{name} within class #{self.class}"
           end
-        else
-          klass = Origen::SubBlock
-        end
-        unless klass.respond_to?(:includes_origen_model)
-          puts 'Any class which is to be instantiated as a sub_block must include Origen::Model,'
-          puts "add this to #{klass}:"
-          puts ''
-          puts '  include Origen::Model'
-          puts ''
-          fail 'Sub block does not include Origen::Model!'
-        end
-        block = klass.new(options.merge(parent: self, name: name))
-        if sub_blocks[name]
-          fail "You have already defined a sub-block named #{name} within class #{self.class}"
         else
           sub_blocks[name] = block
-          if respond_to?(name)
-            # puts "Tried to create a sub-block named #{name} in #{self.class}, but it already has a method with this name!"
-            # puts "To avoid confusion rename one of them and try again!"
-            # raise "Non-unique sub-block name!"
-          else
-            define_singleton_method name do
-              sub_blocks[name]
-            end
-          end
+        end
+        define_singleton_method name do
+          get_sub_block(name)
         end
         block
       end
@@ -314,6 +289,116 @@ module Origen
     def namespace
       self.class.to_s.sub(/::[^:]*$/, '')
     end
+
+    private
+
+    def get_sub_block(name)
+      sub_blocks[name]
+    end
+
+    def instantiate_sub_block(name, klass, options)
+      return sub_blocks[name] unless sub_blocks[name].is_a?(Placeholder)
+      sub_blocks[name] = klass.new(options.merge(parent: self, name: name))
+    end
+
+    class Placeholder
+      attr_reader :name, :owner, :attributes
+
+      def initialize(owner, name, attributes)
+        @owner = owner
+        @name = name
+        @attributes = attributes
+      end
+
+      def add_attributes(attrs)
+        @attributes = @attributes.merge(attrs)
+      end
+
+      # Make this appear like a sub-block to any application code
+      def is_a?(klass)
+        klass == self.klass || klass == self.class
+      end
+
+      # Make it look like a sub-block in the console to avoid confusion
+      def inspect
+        "<SubBlock: #{name}>"
+      end
+
+      def method_missing(method, *args, &block)
+        materialize.send(method, *args, &block)
+      end
+
+      def respond_to?(method, include_private = false)
+        materialize.respond_to?(method, include_private)
+      end
+
+      def materialize
+        file = attributes.delete(:file)
+        block = owner.send(:instantiate_sub_block, name, klass, attributes)
+        if file
+          require File.join(owner.send(:export_dir), file)
+          block.extend owner.send(:export_module_names_from_path, file).join('::').constantize
+        end
+        block
+      end
+
+      def ==(obj)
+        materialize == obj
+      end
+
+      def !=(obj)
+        materialize != obj
+      end
+
+      def freeze
+        materialize.freeze
+      end
+
+      def clone
+        materialize.clone
+      end
+
+      def dup
+        materialize.dup
+      end
+
+      def to_json(*args)
+        materialize.to_json(*args)
+      end
+
+      def klass
+        @klass ||= begin
+          class_name = attributes.delete(:class_name)
+          if class_name
+            if eval("defined? ::#{owner.namespace}::#{class_name}")
+              klass = eval("::#{owner.namespace}::#{class_name}")
+            else
+              if eval("defined? #{class_name}")
+                klass = eval(class_name)
+              else
+                if eval("defined? #{owner.class}::#{class_name}")
+                  klass = eval("#{owner.class}::#{class_name}")
+                else
+                  puts "Could not find class: #{class_name}"
+                  fail 'Unknown sub block class!'
+                end
+              end
+            end
+          else
+            klass = Origen::SubBlock
+          end
+          unless klass.respond_to?(:includes_origen_model)
+            puts 'Any class which is to be instantiated as a sub_block must include Origen::Model,'
+            puts "add this to #{klass}:"
+            puts ''
+            puts '  include Origen::Model'
+            puts ''
+            fail 'Sub block does not include Origen::Model!'
+          end
+          klass
+        end
+      end
+    end
   end
 
   # A simple class that will be instantiated by default when a sub block is
@@ -328,6 +413,8 @@ module Origen
     # On first call of a missing method a method is generated to avoid the missing lookup
     # next time, this should be faster for repeated lookups of the same method, e.g. reg
     def method_missing(method, *args, &block)
+      super
+    rescue NoMethodError
       return regs(method) if self.has_reg?(method)
       return ports(method) if self.has_port?(method)
       if method.to_s =~ /=$/

data/lib/origen/top_level.rb

@@ -63,7 +63,12 @@ module Origen
     #
     # This allows different pin configurations to be specified by package.
     def current_package=(val)
-      @current_package_id = val.is_a?(ChipPackage) ? val.id : val
+      @current_package_id = case val
+      when ChipPackage
+        val.id
+      else
+        packages.include?(val) ? val : nil
+      end
     end
     alias_method :package=, :current_package=