origen 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 164ff1785465c05f948cea646a845c30d9501318
-  data.tar.gz: 572cfdfd8d006b70e8b447789530284d99a1d391
+  metadata.gz: acdfacb78dd1389f6c42d6e77b8b311f44a424c0
+  data.tar.gz: 91c007f2243274a27202049375088256448d9b53
 SHA512:
-  metadata.gz: c5bb8de8859693e4ba457f555709dca46200ddccccbde5ea382b6099ba2ee22e8e90d72c9ddc7aaa1fb5dd2e54bb535925df9455017c7ad5dc889eacbfd40afe
-  data.tar.gz: 6a96a68b9d08642282b489d0f6d08596fcee33fed04c41264b66bdaa836ad21130b370213b564fac1fe3db842feb8985b3f82c421417d28114a351602f0beb9d
+  metadata.gz: 29c5b7ca4267fe59b675b2250805dfeaa361601ca64f34b36ac3c68244cff7600b9e37477dd645c02f53930672ad2daf78ef648021bcb8759a1ec2a6f0e68835
+  data.tar.gz: 77a5dc8760bcad34b0b356796ad722269dbe4396c3e888d8f3330ef768dcf168d7fde8ccfac28fb644f896f20e977527f05dc786adbfd80d791fd727f3c2a386

data/config/version.rb

@@ -1,7 +1,7 @@
 module Origen
   MAJOR = 0
-  MINOR = 25
-  BUGFIX = 1
+  MINOR = 26
+  BUGFIX = 0
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen.rb

@@ -62,6 +62,8 @@ unless defined? RGen::ORIGENTRANSITION
     autoload :LSF,           'origen/application/lsf'
     autoload :LSFManager,    'origen/application/lsf_manager'
     autoload :Fuses,     'origen/fuses'
+    autoload :Tests,     'origen/tests'
+    autoload :PowerDomains, 'origen/power_domains'
 
     attr_reader :switch_user
 

data/lib/origen/chip_mode.rb

@@ -17,8 +17,9 @@ module Origen
     alias_method :typ_voltage, :typical_voltage
 
     def initialize(name, options = {})
-      @name = name
       options.each { |k, v| instance_variable_set("@#{k}", v) }
+      (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
+      @name = name
       validate_args
     end
 
@@ -65,12 +66,23 @@ module Origen
     # Implements methods like:
     #
     #     if $dut.mode.rambist?
-    def method_missing(method_name, *arguments)
+    def method_missing(method_name, *arguments, &block)
+      ivar = "@#{method_name.to_s.gsub('=', '')}"
+      ivar_sym = ":#{ivar}"
       if method_name[-1] == '?'
         id == method_name[0..-2].to_sym
+      elsif method_name[-1] == '='
+        define_singleton_method(method_name) do |val|
+          instance_variable_set(ivar, val)
+        end
+      elsif instance_variables.include? ivar_sym
+        instance_variable_get(ivar)
       else
-        super
+        define_singleton_method(method_name) do
+          instance_variable_get(ivar)
+        end
       end
+      send(method_name, *arguments, &block)
     end
 
     def to_s

data/lib/origen/core_ext/string.rb

@@ -56,7 +56,7 @@ class String
   # cased symbol version of the string
   def symbolize
     @@symbolize ||= {}
-    @@symbolize[self] ||= gsub(/(\n|\s|\(|\)|\.|\[|\]|-|{|})/, '_').downcase.to_sym
+    @@symbolize[self] ||= gsub(/(\?|\!|\-|\/|\\|\n|\s|\(|\)|\.|\[|\]|-|{|})/, '_').downcase.to_sym
   end
 
   # acronyms

data/lib/origen/generator/compiler.rb

@@ -134,6 +134,9 @@ module Origen
       def run_erb(file, opts = {}, &block)
         # Refresh the target to start all settings from scratch each time
         # This is an easy way to reset all registered values
+        if opts[:preserve_target]
+          options[:preserve_target] = opts.delete(:preserve_target)
+        end
         Origen.app.reload_target! unless options[:preserve_target]
         # Record the current file, this can be used to resolve any relative path
         # references in the file about to be compiled

data/lib/origen/model.rb

@@ -26,6 +26,8 @@ module Origen
       include Origen::Memory
       include Origen::Errata
       include Origen::Fuses
+      include Origen::Tests
+      include Origen::PowerDomains
     end
 
     module ClassMethods

data/lib/origen/parameters/set.rb

@@ -30,6 +30,11 @@ module Origen
       end
       alias_method :current_context, :context
 
+      def available_contexts
+        owner._parameter_sets.keys
+      end
+      alias_method :contexts, :available_contexts
+
       def copy_defaults_from(set)
         set.each do |name, val|
           if val.is_a?(Set)

data/lib/origen/power_domains.rb

@@ -0,0 +1,23 @@
+require 'colorize'
+require_relative './power_domains/power_domain'
+require_relative './power_domains/power_domains_collection'
+module Origen
+  module PowerDomains
+    def power_domains(expr = nil)
+      @_power_domains ||= PowerDomainsCollection.new
+      if expr.nil?
+        @_power_domains
+      else
+        @_power_domains.recursive_find_by_key(expr)
+      end
+    end
+
+    def add_power_domain(id, options = {}, &block)
+      if power_domains.include?(id)
+        Origen.log.error("Cannot create power domain '#{id}', it already exists!")
+        fail
+      end
+      power_domains[id] = PowerDomain.new(id, options, &block)
+    end
+  end
+end

data/lib/origen/power_domains/power_domain.rb

@@ -0,0 +1,209 @@
+module Origen
+  module PowerDomains
+    class PowerDomain
+      attr_accessor :id, :description, :voltage_range, :nominal_voltage, :setpoint
+
+      # Generic Power Domain Name
+      # This is the power supply that can be blocked off to multiple power supplies
+      # For example, Power Domain for DDR blocks could be GVDD, then the actual
+      # power supplies can be different for each DDR block.
+      #  DDR1 --> G1VDD
+      #  DDR2 --> G2VDD
+      attr_accessor :generic_name
+
+      # Actual Power Domain Name
+      attr_accessor :actual_name
+
+      # Allowed Voltage Points
+      # Some power supplies can be at different levels, e.g. 1.8V or 3.3V
+      # Could be a signal voltage or an array of voltages
+      attr_accessor :voltages
+
+      # Display Names
+      # Hash of display names
+      # display_name = {
+      #   input:  Input voltage name, e.g. V<sub>IN</sub>
+      #   output:  Output voltage name, e.g. V<sub>OUT</sub>
+      #   default: Regular Voltage name, e.g. V<sub>DD</sub>
+      attr_accessor :display_name
+
+      def initialize(id, options = {}, &block)
+        @id = id
+        @description = ''
+        @display_name = {}
+        @id = @id.symbolize unless @id.is_a? Symbol
+        options.each { |k, v| instance_variable_set("@#{k}", v) }
+        (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
+        fail unless attrs_ok?
+      end
+
+      def name
+        @id
+      end
+
+      # Sets setpoint equal to nominal_voltage
+      def setpoint_to_nominal
+        @setpoint = @nominal_voltage
+      end
+
+      # Returns an Array of all pins that reference the power domain
+      def pins
+        signal_pins + ground_pins + power_pins
+      end
+
+      # Returns an Array of signal pin IDs that match the power domain ID
+      def signal_pins
+        Origen.top_level.pins.select { |_pin_id, p| p.supply == id }.keys
+      end
+
+      # Returns an Array of ground pin IDs that match the power domain ID
+      def ground_pins
+        Origen.top_level.ground_pins.select { |_pin_id, p| p.supply == id }.keys
+      end
+
+      # Returns an Array of ground pin IDs that match the power domain ID
+      def power_pins
+        Origen.top_level.power_pins.select { |_pin_id, p| p.supply == id }.keys
+      end
+
+      # Checks for the existence of a signal pin that references the power domain
+      def has_signal_pin?(pin)
+        signal_pins.include?(pin) ? true : false
+      end
+
+      # Checks for the existence of a signal pin that references the power domain
+      def has_ground_pin?(pin)
+        ground_pins.include?(pin) ? true : false
+      end
+
+      # Checks for the existence of a signal pin that references the power domain
+      def has_power_pin?(pin)
+        power_pins.include?(pin) ? true : false
+      end
+
+      # Checks if a pin references the power domain, regardless of type
+      def has_pin?(pin)
+        pins.include? pin
+      end
+
+      # Checks for a pin type, returns nil if it is not found
+      def pin_type(pin)
+        if self.has_pin?(pin) == false
+          nil
+        else
+          [:signal, :ground, :power].each do |pintype|
+            return pintype if send("has_#{pintype}_pin?", pin)
+          end
+        end
+      end
+
+      # Nominal voltage
+      def nominal_voltage
+        @nominal_voltage
+      end
+      alias_method :nominal, :nominal_voltage
+      alias_method :nom, :nominal_voltage
+
+      # Current setpoint, defaults top nil on init
+      def setpoint
+        @setpoint
+      end
+      alias_method :curr_value, :setpoint
+      alias_method :value, :setpoint
+
+      # Acceptable voltage range
+      def voltage_range
+        @voltage_range
+      end
+      alias_method :range, :voltage_range
+
+      # Setter for setpoint
+      def setpoint=(val)
+        unless setpoint_ok?(val)
+          Origen.log.warn("Setpoint (#{setpoint_string(val)}) for power domain '#{name}' is not within the voltage range (#{voltage_range_string})!")
+        end
+        @setpoint = val
+      end
+
+      # Checks if the setpoint is valid
+      def setpoint_ok?(val = nil)
+        if val.nil?
+          voltage_range.include?(setpoint) ? true : false
+        else
+          voltage_range.include?(val) ? true : false
+        end
+      end
+      alias_method :value_ok?, :setpoint_ok?
+      alias_method :val_ok?, :setpoint_ok?
+
+      def display_names(default_name)
+        @display_name[:default] = default_name
+        @display_name[:input] = change_subscript('IN')
+        @display_name[:output] = change_subscript('OUT')
+      end
+
+      def method_missing(m, *args, &block)
+        ivar = "@#{m.to_s.gsub('=', '')}"
+        ivar_sym = ":#{ivar}"
+        if m.to_s =~ /=$/
+          define_singleton_method(m) do |val|
+            instance_variable_set(ivar, val)
+          end
+        elsif instance_variables.include? ivar_sym
+          instance_variable_get(ivar)
+        else
+          define_singleton_method(m) do
+            instance_variable_get(ivar)
+          end
+        end
+        send(m, *args, &block)
+      end
+
+      private
+
+      def attrs_ok?
+        return_value = true
+        unless description.is_a? String
+          Origen.log.error("Power domain attribute 'description' must be a String!")
+          return_value = false
+        end
+        return_value = false unless voltages_ok?
+        return_value
+      end
+
+      def setpoint_string(val = nil)
+        if val.nil?
+          setpoint.as_units('V')
+        else
+          val.as_units('V')
+        end
+      end
+
+      def voltages_ok?
+        if nominal_voltage.nil?
+          false
+        elsif voltage_range.nil?
+          Origen.log.error("PPEKit: Missing voltage range for power domain '#{name}'!")
+          false
+        elsif voltage_range.is_a? Range
+          if voltage_range.include?(nominal_voltage)
+            true
+          else
+            Origen.log.error("PPEKit: Nominal voltage #{nominal_voltage} is not inbetween the voltage range #{voltage_range} for power domain '#{name}'!")
+            false
+          end
+        else
+          Origen.log.error("Power domain attribute 'voltage_range' must be a Range!")
+          return_value = false
+        end
+      end
+
+      def change_subscript(new_subscript)
+        tmp = @display_name[:default].dup
+        sub_input = tmp.at_css 'sub'
+        sub_input.content = new_subscript unless sub_input.nil?
+        tmp
+      end
+    end
+  end
+end

data/lib/origen/power_domains/power_domains_collection.rb

@@ -0,0 +1,53 @@
+module Origen
+  module PowerDomains
+    class PowerDomainsCollection < Hash
+      def inspect(options = {})
+        options = {
+          fancy_output: true
+        }.update(options)
+        headers = []
+        output_power_domain_list = []
+        column_widths = {}.tap do |colhash|
+          each do |domain_name, domain|
+            output_attr_list = {}
+            domain.instance_variables.each do |attr|
+              attr_getter = attr.to_s[/\@(\S+)/, 1].to_sym
+              attr_val = domain.send attr_getter
+              next unless [String, Numeric, Float, Integer, Symbol, Range].include? attr_val.class
+              headers << attr_getter unless headers.include?(attr_getter)
+              str = case attr_val
+              when Numeric
+                attr_val.as_V
+              when Range
+                start_voltage = attr_val.first
+                end_voltage = attr_val.last
+                "#{start_voltage.as_V}\.\.#{end_voltage.as_V}"
+              else
+                attr_val.to_s
+              end
+              curr_longest = [attr_getter, str].max_by(&:length).size + 2 # Add 3 for the whitespace
+              if colhash[attr].nil? || (colhash[attr] < curr_longest)
+                colhash[attr] = curr_longest
+              end
+              output_attr_list[attr_getter] = str
+            end
+            output_power_domain_list << output_attr_list
+          end
+        end
+        if options[:fancy_output]
+          puts '╔' + column_widths.values.each.map { |i| '═' * i }.join('╤') + '╗'
+          puts '║' + headers.each_with_index.map { |col_val, i| " #{col_val} ".ljust(column_widths.values[i]) }.join('│') + '║'
+          puts '╟' + column_widths.values.each.map { |i| '─' * i }.join('┼') + '╢'
+          puts output_power_domain_list.each.map { |attributes| '║' + headers.each_with_index.map { |value, attr_idx| " #{attributes[value]} ".ljust(column_widths.values[attr_idx]) }.join('│') + '║' }
+          puts '╚' + column_widths.values.each.map { |i| '═' * i }.join('╧') + '╝'
+        else
+          puts '.' + column_widths.values.each.map { |i| '-' * i }.join('-') + '.'
+          puts '|' + headers.each_with_index.map { |col_val, i| " #{col_val} ".ljust(column_widths.values[i]) }.join('|') + '|'
+          puts '|' + column_widths.values.each.map { |i| '-' * i }.join('+') + '|'
+          puts output_power_domain_list.each.map { |attributes| '|' + headers.each_with_index.map { |value, attr_idx| " #{attributes[value]} ".ljust(column_widths.values[attr_idx]) }.join('|') + '|' }
+          puts '`' + column_widths.values.each.map { |i| '-' * i }.join('-') + '\''
+        end
+      end
+    end
+  end
+end

data/lib/origen/specs/power_supply.rb

@@ -35,6 +35,7 @@ module Origen
 
       # Initialize the variables
       def initialize(gen, act)
+        Origen.deprecate 'Origen::Specs::Power_Supply is deprecated, use Origen::PowerDomains::PowerDomain instead'
         @generic = gen
         @actual = act
         @voltages = []

data/lib/origen/sub_blocks.rb

@@ -243,6 +243,14 @@ module Origen
     end
     alias_method :has_regs?, :owns_registers?
 
+    def has_fuses?
+      fuses.empty? ? false : true
+    end
+
+    def has_tests?
+      tests.empty? ? false : true
+    end
+
     def sub_block(name, options = {})
       if i = options.delete(:instances)
         a = []

data/lib/origen/tests.rb

@@ -0,0 +1,31 @@
+require_relative './tests/test'
+module Origen
+  module Tests
+    def tests(expr = nil)
+      if expr.nil?
+        if @_tests.nil?
+          @_tests = {}
+        elsif @_tests.is_a? Hash
+          if @_tests.empty?
+            @_tests
+          else
+            @_tests.ids
+          end
+        else
+          @_tests = {}
+        end
+      else
+        @_tests.recursive_find_by_key(expr)
+      end
+    end
+
+    def add_test(id, options = {}, &block)
+      @_tests ||= {}
+      if @_tests.include?(id)
+        Origen.log.error("Cannot create test '#{id}', it already exists!")
+        fail
+      end
+      @_tests[id] = Test.new(id, options, &block)
+    end
+  end
+end

data/lib/origen/tests/test.rb

@@ -0,0 +1,55 @@
+module Origen
+  module Tests
+    class Test
+      attr_accessor :id, :owner, :description, :conditions, :platforms
+
+      def initialize(id, options = {}, &block)
+        @id = id
+        @description = ''
+        @conditions, @platforms = [], []
+        @id = @id.symbolize unless @id.is_a? Symbol
+        options.each { |k, v| instance_variable_set("@#{k}", v) }
+        (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
+        fail unless attrs_ok?
+      end
+
+      def name
+        @id
+      end
+
+      def method_missing(m, *args, &block)
+        ivar = "@#{m.to_s.gsub('=', '')}"
+        ivar_sym = ":#{ivar}"
+        if m.to_s =~ /=$/
+          define_singleton_method(m) do |val|
+            instance_variable_set(ivar, val)
+          end
+        elsif instance_variables.include? ivar_sym
+          instance_variable_get(ivar)
+        else
+          define_singleton_method(m) do
+            instance_variable_get(ivar)
+          end
+        end
+        send(m, *args, &block)
+      end
+
+      private
+
+      def attrs_ok?
+        return_value = true
+        [:conditions, :platforms].each do |attr|
+          unless instance_variable_get("@#{attr}").is_a? Array
+            Origen.log.error("Test attribute '#{attr}' should be an Array!")
+            return_value = false
+          end
+        end
+        unless @description.is_a? String
+          Origen.log.error("Test attribute 'description' must be a String!")
+          return_value = false
+        end
+        return_value
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -352,6 +352,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -513,6 +527,9 @@ files:
 - lib/origen/ports/port.rb
 - lib/origen/ports/port_collection.rb
 - lib/origen/ports/section.rb
+- lib/origen/power_domains.rb
+- lib/origen/power_domains/power_domain.rb
+- lib/origen/power_domains/power_domains_collection.rb
 - lib/origen/registers.rb
 - lib/origen/registers/bit.rb
 - lib/origen/registers/bit_collection.rb
@@ -543,6 +560,8 @@ files:
 - lib/origen/specs/spec_features.rb
 - lib/origen/specs/version_history.rb
 - lib/origen/sub_blocks.rb
+- lib/origen/tests.rb
+- lib/origen/tests/test.rb
 - lib/origen/top_level.rb
 - lib/origen/undefined.rb
 - lib/origen/users.rb
@@ -604,7 +623,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: The Semiconductor Developer's Kit