origen 0.52.3 → 0.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b900b1cea172703c5a4057a93b35ccb5f85305972b05b1939fa4a793553a98d
-  data.tar.gz: 5bc67cfa0fd368351600ec6e11f7ad927825ad604e1ed02c555441c1ffde8ddb
+  metadata.gz: 97f6380df23c488d06f774bd1b58f625b84fa270d83431c82bff7a51c1c39672
+  data.tar.gz: 212e6637822e9cbb64f7fa503c05cef9eb9c43dd28301686d129b335c05685c8
 SHA512:
-  metadata.gz: ab397dafe249184e5d64115f06451a5ff3dab3a6688dc243e85e23a55075d8b14685cac0f7f2cea62827aa2bbd9abd69232697e121833ad060b4c0ff4d421ac6
-  data.tar.gz: 878c11b33cbfa5f9e0a4d584a7a7058dddf905168a1f54397f2e5e8967875f558430a9cce744bf0e25a80998d9911ea1194be151e82be2f27e4d38429af51916
+  metadata.gz: f624165d1f99e3614f56fd872f804b9605b6481266dd5a633ecfddb99a9c8533ff219934341c253fa9146fb68cb23ed73a7cf1a126c017ed6b873b345364cf4a
+  data.tar.gz: 6f3886f8ed80c5032ee8009b8072203eded3cec774a017c6425fbd722c9bee0ce653879fa547e51630a087dc4beb9fcaef7b3986fb9b685dd57edbc0548b0dab

data/config/version.rb

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

data/lib/origen/application/configuration.rb

@@ -19,7 +19,8 @@ module Origen
                     :web_domain,
                     :strict_errors, :unmanaged_dirs, :unmanaged_files, :remotes,
                     :external_app_dirs, :lint_test, :shared, :yammer_group, :rc_url, :rc_workflow,
-                    :user_aliases, :release_externally, :gem_name, :disqus_shortname
+                    :user_aliases, :release_externally, :gem_name, :disqus_shortname,
+                    :default_plugin
 
       # Mark any attributes that are likely to depend on properties of the target here,
       # this will raise an error if they are ever accessed before the target has been

data/lib/origen/application/plugins.rb

@@ -38,16 +38,24 @@ module Origen
       def current
         return nil if @temporary == :none
         return nil if @disabled
-        name = @temporary || @current ||= Origen.app.session.origen_core[:default_plugin]
+        name = @temporary || @current ||= begin
+          if Origen.app.session.origen_core[:default_plugin]
+            Origen.app.session.origen_core[:default_plugin]
+          elsif Origen.app.config.default_plugin && !Origen.app.session.origen_core[:default_plugin_cleared_by_user]
+            Origen.app.config.default_plugin
+          end
+        end
         find { |p| p.name.to_sym == name } if name
       end
 
       def current=(name)
         name = name.to_sym if name
-        Origen.app.session.origen_core[:default_plugin] = name
-        if name == :none
+        if name == :none || name.nil?
           @current = nil
+          Origen.app.session.origen_core[:default_plugin] = nil
+          Origen.app.session.origen_core[:default_plugin_cleared_by_user] = true
         else
+          Origen.app.session.origen_core[:default_plugin] = name
           @current = name
         end
       end

data/lib/origen/core_ext/integer.rb

@@ -22,6 +22,11 @@ module Origen
 end
 
 class Integer
+  class << self
+    attr_accessor :width
+  end
+  @width = 32
+
   if RUBY_VERSION >= '2.4.0'
     prepend Origen::IntegerExtension
   end
@@ -72,6 +77,19 @@ class Integer
   alias_method :to_xls_col, :to_spreadsheet_column
   alias_method :to_xlsx_col, :to_spreadsheet_column
   alias_method :to_spreadsheet_col, :to_spreadsheet_column
+
+  def twos_complement(width = nil)
+    _width = width || Integer.width
+    if self > 2**(_width - 1) - 1
+      fail(RangeError, "Integer #{self} cannot fit into #{_width} bits with 2s complement encoding")
+    elsif self < -1 * (2**(_width - 1))
+      fail(RangeError, "Integer #{self} cannot fit into #{_width} bits with 2s complement encoding")
+    end
+
+    self < 0 ? ((-1 * self) ^ (2**_width - 1)) + 1 : self
+  end
+  alias_method :twos_comp, :twos_complement
+  alias_method :twos_compliment, :twos_complement
 end
 
 if RUBY_VERSION <= '2.4.0'

data/lib/origen/core_ext/object.rb

@@ -10,4 +10,18 @@ class Object
     end
     nil
   end
+
+  # Indicates whether the object is or can be used as an Origen subblock, where
+  # being an Origen subblock is defined as inheriting from either {Origen::Model} or
+  # {Origen::Controller}.
+  # @return [True/False]
+  # @example Subblock NVM (from the Origen guides)
+  #   dut.nvm.origen_subblock? #=> true
+  # @example Non-subblocks
+  #   'hi'.origen_subblock? #=> false
+  # @see https://origen-sdk.org/origen/guides/models/defining/#Adding_Sub_Blocks
+  def origen_subblock?
+    self.is_a?(Origen::Model) || self.is_a?(Origen::Controller) || self.is_a?(Origen::SubBlocks::Placeholder)
+  end
+  alias_method :origen_sub_block?, :origen_subblock?
 end

data/lib/origen/generator/pattern_sequence.rb

@@ -18,9 +18,19 @@ module Origen
 
       # Execute the given pattern
       def run(pattern_name)
-        pattern = Origen.generator.pattern_finder.find(pattern_name.to_s, {})
-        pattern = pattern[:pattern] if pattern.is_a?(Hash)
-        load pattern
+        name = Pathname.new(pattern_name).basename
+        ss "START OF PATTERN: #{name}"
+        # Give the app a chance to handle pattern dispatch
+        skip = false
+        Origen.app.listeners_for(:before_pattern_lookup).each do |listener|
+          skip ||= !listener.before_pattern_lookup(pattern_name.to_s)
+        end
+        unless skip
+          pattern = Origen.generator.pattern_finder.find(pattern_name.to_s, {})
+          pattern = pattern[:pattern] if pattern.is_a?(Hash)
+          load pattern
+        end
+        ss "END OF PATTERN: #{name}"
       end
       alias_method :call, :run
 

data/lib/origen/parameters.rb

@@ -117,13 +117,18 @@ module Origen
           _parameter_sets[name] = Origen::Parameters::Set.new(top_level: true, owner: self)
         end
         if options[:inherit]
-          kontext = _validate_parameter_set_name(options[:inherit])
-          parent = kontext[:obj]._parameter_sets[kontext[:context]]
-          if Origen::Parameters.transaction_open && !Origen::Parameters.transaction_redefine
-            define_params_transaction[kontext[:obj]][kontext[:context]][:children] << [self, name]
+          parents = {}
+          Array(options[:inherit]).each do |inherit|
+            kontext = _validate_parameter_set_name(inherit)
+            parent = kontext[:obj]._parameter_sets[kontext[:context]]
+            parents[inherit] = parent
+            if Origen::Parameters.transaction_open && !Origen::Parameters.transaction_redefine
+              define_params_transaction[kontext[:obj]][kontext[:context]][:children] << [self, name]
+            end
+            _parameter_sets[name].copy_defaults_from(parent) unless defaults_already_set
           end
-          _parameter_sets[name].copy_defaults_from(parent) unless defaults_already_set
-          _parameter_sets[name].define(parent, &block)
+          parents = parents.values.first if parents.size == 1
+          _parameter_sets[name].define(parents, &block)
         else
           _parameter_sets[name].define(&block)
         end
@@ -131,6 +136,7 @@ module Origen
           redefine_children.each { |model, set_name| Origen::Parameters.redefine(model, set_name) }
         end
       end
+      _parameter_sets[name]
     end
     alias_method :define_parameters, :define_params
 

data/lib/origen/pins.rb

@@ -693,27 +693,78 @@ If you meant to define the virtual_pin_group then use the add_virtual_pin_group
     end
     alias_method :virtual_pin_group, :virtual_pin_groups
 
+    def all_pin_ids(type: nil, **options)
+      case type
+      when :power_pin, :power_pins
+        dut.pins(power_pin: true).map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.power_pin(n)] }.to_h
+      when :ground_pin, :ground_pins
+        dut.pins(ground_pin: true).map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.ground_pin(n)] }.to_h
+      when :virtual_pin, :virtual_pins
+        dut.pins(virtual_pin: true).map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.virtual_pin(n)] }.to_h
+      when :other_pin, :other_pins
+        dut.pins(other_pin: true).map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.other_pin(n)] }.to_h
+      else
+        # Maintain the legacy lookup of power_pin: true, ground_pin: true, etc.
+        if options[:power_pin]
+          all_pin_ids(type: :power_pin)
+        elsif options[:ground_pin]
+          all_pin_ids(type: :ground_pin)
+        elsif options[:virtual_pin]
+          all_pin_ids(type: :virtual_pin)
+        elsif options[:other_pin]
+          all_pin_ids(type: :other_pin)
+        else
+          dut.pins.map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.pin(n)] }.to_h
+        end
+      end
+    end
+
     # Permits access via object.pin(x), returns a hash of all pins if no id
     # is specified.
     # ==== Examples
     #   $top.pin(:done)
     #   $soc.pin(:port_a1)
     #   pin(:fail)          # Access directly from within the module
-    def pins(id = nil, options = {}, &_block)
-      id, options = nil, id if id.is_a?(Hash)
-      if id
-        pin = Origen.pin_bank.find(id, options)
-        unless pin
-          puts <<-END
+    def pins(*ids, &_block)
+      options = (ids.pop if ids.last.is_a?(Hash)) || {}
+
+      # Methods may give an ID of nil, which would previously gloss over
+      # the pin lookup. To maintain backwards compability, reject any nils in the input,
+      # then proceed as normal.
+      ids.reject!(&:nil?)
+      if !ids.empty? || block_given?
+        pins = []
+
+        if block_given?
+          pins += all_pin_ids(options).select { |n, p| yield(n, p) }.values.uniq
+        end
+
+        ids.each do |id|
+          if id.is_a?(Regexp)
+            pins += all_pin_ids(options).select { |n, p| n.to_s =~ id }.values.uniq
+          else
+            pin = Origen.pin_bank.find(id, options)
+            unless pin
+              puts <<-END
 You have tried to reference pin :#{id} within #{self.class} but it does not exist, this could be
 because the pin has not been defined yet or it is an alias that is not available in the current context.
 
 If you meant to define the pin then use the add_pin method instead.
 
-          END
-          fail 'Pin not found'
+              END
+              fail 'Pin not found'
+            end
+            pins << pin
+          end
+        end
+
+        # Maintain return value of a single pin object if only given a single identifier
+        if ids.size == 1 && !ids.first.is_a?(Regexp)
+          pins.first
+        else
+          options[:keep_duplicates] ? pins : pins.uniq!
+          PinCollection.new(self, *pins, options)
         end
-        pin
       else
         if options[:power_pin]
           Origen.pin_bank.power_pins
@@ -741,12 +792,13 @@ If you meant to define the pin then use the add_pin method instead.
     alias_method :power_pin, :power_pins
 
     # Equivalent to the pins method but considers ground pins rather than regular pins
-    def ground_pins(id = nil, options = {}, &block)
-      id, options = nil, id if id.is_a?(Hash)
+    def ground_pins(*ids, &block)
+      options = (ids.pop if ids.last.is_a?(Hash)) || {}
+
       options = {
         ground_pin: true
       }.merge(options)
-      pins(id, options, &block)
+      pins(*ids, options, &block)
     end
     alias_method :ground_pin, :ground_pins
 

data/lib/origen/pins/pin.rb

@@ -1072,6 +1072,85 @@ module Origen
         end
       end
 
+      def index?(context: nil)
+        !!index(context: context).nil?
+      end
+
+      def index(context: nil)
+        if context.is_a?(Symbol)
+          # Context pin group provided
+          group = groups[context].instance_variable_get(:@store)
+          if group
+            group.index(self)
+          end
+        elsif context.is_a?(Array)
+          # Anonymous pin group given
+          context.map { |p| p.is_a?(Symbol) ? owner.pin(p) : p }.index(self)
+        else
+          # Try an index based off of the pin name.
+          # Only works if the pin ends in a decimal. Otherwise, returns nil.
+          i = name.to_s.index(/\d+$/)
+          if i
+            name.to_s[i..-1].to_i
+          end
+        end
+      end
+
+      def mask(context: nil)
+        index = context.is_a?(Integer) ? context : self.index(context: context)
+
+        if index.nil? && context.nil?
+          # If the index is nil and no context was given, no implicit index could be resolved
+          fail("Could not discern pin :#{name}'s implicit index!")
+        elsif index.nil?
+          # If the index is nil and some context was given, then the pin is not in the given context
+          fail("Pin :#{name} is not a member of the given context!")
+        end
+
+        2**index
+      end
+      alias_method :set_mask, :mask
+      alias_method :smask, :mask
+
+      def clear_mask(context: nil, size: nil)
+        index = context.is_a?(Integer) ? context : self.index(context: context)
+
+        if index.nil? && context.nil?
+          # If the index is nil and no context was given, no implicit index could be resolved
+          fail("Could not discern pin :#{name}'s implicit index!")
+        elsif index.nil?
+          # If the index is nil and some context was given, then the pin is not in the given context
+          fail("Pin :#{name} is not a member of the given context!")
+        end
+
+        if size && context && !context.is_a?(Integer)
+          # A context was given, that was not just an Integer, and size was given
+          # Raise an exception as these two conflict.
+          fail('Both a sized context (e.g. pin group) and a :size option cannot be used simultaneously!')
+        elsif size
+          # A size option was given. Use that.
+          ((2**size) - 1) ^ (1 << index)
+        elsif context.is_a?(Symbol)
+          ((2**groups[context].instance_variable_get(:@store).size) - 1) ^ (1 << index)
+        elsif context.respond_to?(:size) && !context.is_a?(Integer)
+          # PinCollection or Array
+          ((2**context.size) - 1) ^ (1 << index)
+        else
+          # No size option was given. Use the implicit index instead.
+          (2**index) - 1
+        end
+      end
+      alias_method :clr_mask, :clear_mask
+      alias_method :cmask, :clear_mask
+
+      def named?(n)
+        if n.is_a?(Regexp)
+          [name.to_s, *aliases.keys].any? { |na| na =~ n }
+        else
+          [name.to_s, *aliases.keys.map(&:to_s)].include?(n.to_s)
+        end
+      end
+
       def method_missing(m, *args, &block)
         if meta.include? m
           meta[m]

data/lib/origen/registers/reg.rb

@@ -476,6 +476,9 @@ module Origen
       # @api private
       def parse_descriptions
         desc = []
+        unless File.exist?(define_file)
+          return desc
+        end
         File.readlines(define_file).each do |line|
           if line =~ /^\s*#(.*)/
             desc << Regexp.last_match[1].strip

data/lib/origen/sub_blocks.rb

@@ -274,6 +274,13 @@ module Origen
     def sub_block(name = nil, options = {})
       name, options = nil, name if name.is_a?(Hash)
       return sub_blocks unless name
+
+      if name.is_a?(Class)
+        return sub_blocks.select { |n, s| s.is_a?(name) }
+      elsif name.origen_sub_block?
+        return sub_block(name.class)
+      end
+
       if i = options.delete(:instances)
         # permit creating multiple instances of a particular sub_block class
         # can pass array for base_address, which will be processed above

data/lib/origen/users/user.rb

@@ -3,6 +3,9 @@ module Origen
     class User
       require 'openssl'
       require 'digest/sha1'
+      # Required for STDIN.noecho to work
+      # https://stackoverflow.com/questions/9324697/why-cannot-use-instance-method-noecho-of-class-io
+      require 'io/console'
 
       attr_reader :role
       attr_writer :name, :email
@@ -45,7 +48,9 @@ module Origen
       end
 
       def id(options = {})
-        @id.to_s.downcase
+        # Way to force Origen to use the new user ID in case of WSL where the core ID might not match the WSL login name
+        # User needs to setup the environment variable in their .bashrc or .tcshrc file
+        ENV['ORIGEN_USER_ID'] || @id.to_s.downcase
       end
       alias_method :core_id, :id
       alias_method :username, :id
@@ -67,7 +72,7 @@ module Origen
       end
 
       def name
-        @name ||= ENV['ORIGEN_NAME'] || name_from_rc || @id
+        @name ||= ENV['ORIGEN_NAME'] || ENV['ORIGEN_USER_NAME'] || name_from_rc || @id
       end
 
       def name_from_rc
@@ -76,7 +81,7 @@ module Origen
 
       def email(options = {})
         if current?
-          @email ||= ENV['ORIGEN_EMAIL'] || email_from_rc || begin
+          @email ||= ENV['ORIGEN_EMAIL'] || ENV['ORIGEN_USER_EMAIL'] || email_from_rc || begin
             if Origen.site_config.email_domain
               "#{id}@#{Origen.site_config.email_domain}"
             end

data/origen_app_generators/origen_app_generators.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.8.11".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Stephen McGinty".freeze]
-  s.date = "2019-07-30"
+  s.date = "2019-09-13"
   s.email = ["stephen.f.mcginty@gmail.com".freeze]
   s.files = ["bin/boot.rb".freeze, "config/application.rb".freeze, "config/boot.rb".freeze, "config/commands.rb".freeze, "config/shared_commands.rb".freeze, "config/version.rb".freeze, "lib/origen_app_generators.rb".freeze, "lib/origen_app_generators/application.rb".freeze, "lib/origen_app_generators/base.rb".freeze, "lib/origen_app_generators/empty_application.rb".freeze, "lib/origen_app_generators/empty_plugin.rb".freeze, "lib/origen_app_generators/new.rb".freeze, "lib/origen_app_generators/new_app_tests.rb".freeze, "lib/origen_app_generators/origen_infrastructure/app_generator_plugin.rb".freeze, "lib/origen_app_generators/plugin.rb".freeze, "lib/origen_app_generators/test_engineering/common.rb".freeze, "lib/origen_app_generators/test_engineering/stand_alone_application.rb".freeze, "lib/origen_app_generators/test_engineering/test_block.rb".freeze, "templates/app_generators".freeze, "templates/app_generators/application".freeze, "templates/app_generators/application/.gitignore".freeze, "templates/app_generators/application/.irbrc".freeze, "templates/app_generators/application/.rspec".freeze, "templates/app_generators/application/.travis.yml".freeze, "templates/app_generators/application/Gemfile".freeze, "templates/app_generators/application/Rakefile".freeze, "templates/app_generators/application/app".freeze, "templates/app_generators/application/app/blocks".freeze, "templates/app_generators/application/app/blocks/top_level.rb".freeze, "templates/app_generators/application/app/lib".freeze, "templates/app_generators/application/app/lib/module.rb".freeze, "templates/app_generators/application/app/templates".freeze, "templates/app_generators/application/app/templates/web".freeze, "templates/app_generators/application/app/templates/web/index.md.erb".freeze, "templates/app_generators/application/app/templates/web/layouts".freeze, "templates/app_generators/application/app/templates/web/layouts/_basic.html.erb".freeze, "templates/app_generators/application/app/templates/web/partials".freeze, "templates/app_generators/application/app/templates/web/partials/_navbar.html.erb".freeze, "templates/app_generators/application/app/templates/web/release_notes.md.erb".freeze, "templates/app_generators/application/config".freeze, "templates/app_generators/application/config/application.rb".freeze, "templates/app_generators/application/config/boot.rb".freeze, "templates/app_generators/application/config/commands.rb".freeze, "templates/app_generators/application/config/maillist_dev.txt".freeze, "templates/app_generators/application/config/maillist_prod.txt".freeze, "templates/app_generators/application/config/version.rb".freeze, "templates/app_generators/application/doc".freeze, "templates/app_generators/application/doc/history".freeze, "templates/app_generators/application/dot_keep".freeze, "templates/app_generators/application/origen_core_session".freeze, "templates/app_generators/application/spec".freeze, "templates/app_generators/application/spec/spec_helper.rb".freeze, "templates/app_generators/application/target".freeze, "templates/app_generators/application/target/debug.rb".freeze, "templates/app_generators/application/target/default.rb".freeze, "templates/app_generators/application/target/production.rb".freeze, "templates/app_generators/new".freeze, "templates/app_generators/new/generator.rb".freeze, "templates/app_generators/new/info.md.erb".freeze, "templates/app_generators/origen_infrastructure".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/application.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/base.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/module.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/app/lib/plugin.rb".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/config".freeze, "templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb".freeze, "templates/app_generators/plugin".freeze, "templates/app_generators/plugin/Gemfile".freeze, "templates/app_generators/plugin/Rakefile".freeze, "templates/app_generators/plugin/app".freeze, "templates/app_generators/plugin/app/templates".freeze, "templates/app_generators/plugin/app/templates/web".freeze, "templates/app_generators/plugin/app/templates/web/index.md.erb".freeze, "templates/app_generators/plugin/app/templates/web/partials".freeze, "templates/app_generators/plugin/app/templates/web/partials/_navbar_external.html.erb".freeze, "templates/app_generators/plugin/app/templates/web/partials/_navbar_internal.html.erb".freeze, "templates/app_generators/plugin/config".freeze, "templates/app_generators/plugin/config/boot.rb".freeze, "templates/app_generators/plugin/gemspec.rb".freeze, "templates/app_generators/test_engineering".freeze, "templates/app_generators/test_engineering/environment".freeze, "templates/app_generators/test_engineering/environment/j750.rb".freeze, "templates/app_generators/test_engineering/environment/uflex.rb".freeze, "templates/app_generators/test_engineering/environment/v93k.rb".freeze, "templates/app_generators/test_engineering/stand_alone_application".freeze, "templates/app_generators/test_engineering/stand_alone_application/.keep".freeze, "templates/app_generators/test_engineering/test_block".freeze, "templates/app_generators/test_engineering/test_block/.keep".freeze]
   s.homepage = "http://origen-sdk.org/origen_app_generators".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.52.3
+  version: 0.54.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,14 +70,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency