origen 0.0.1 → 0.0.2

data/config/users.rb

@@ -0,0 +1,20 @@
+# This file defines the users associated with your project, it is basically the
+# mailing list for release notes.
+# This module must define a method named "users" which returns an array of user
+# objects.
+# You can split your users into "admin" and "user" groups, the main difference
+# between the two is that admin users will get all tag emails, users will get
+# emails on external/official releases only.
+# Users are also prohibited from running the tag_project script, but this is
+# really just to prevent a casual user from executing it inadvertently and it is
+# not intended to be a serious security gate.
+module Origen
+  module Users
+    def users
+      @users ||= [
+        # Admins
+        User.new('Stephen McGinty', 'stephen.f.mcginty@gmail.com', :admin),
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/helpers/url.rb

@@ -0,0 +1,68 @@
+module Origen
+  class Generator
+    class Compiler # :nodoc: all
+      # Helper methods that are available to all templates
+      module Helpers
+
+        def current_path
+          path(options[:top_level_file].to_s.sub(/^.*\/templates\/web/, '').sub(/\..*$/, ''))
+        end
+
+        def current_url
+          "#{domain_minus_root_path}#{current_path}"
+        end
+
+        # Like current_url except always returns the latest version of the url and
+        # not one with an embedded production version
+        def current_latest_url
+          current_url.sub(_version, 'latest')
+        end
+
+        def path(p)
+          p = "/#{p}" unless p =~ /^\//
+          
+          if Origen.development?
+            "#{p}"   # dev mode used for local website generation
+          else          
+            "#{root_path}/#{_version}#{p}"
+          end
+        end
+
+        def url(p)
+          "#{domain_minus_root_path}#{path(p)}"
+        end
+
+        def domain
+          Origen.config.web_domain
+        end
+
+        def domain_minus_root_path
+          domain.sub /#{root_path}$/, ''
+        end
+
+        def _version
+          # Special case for Origen core..
+          if Origen.top == Origen.root
+            version = Origen.version
+          else
+            version = Origen.app.version
+          end
+          if version.development?
+            'latest'
+          else
+            version.to_s.gsub(".", "_")
+          end
+        end
+
+        # Returns any path attached to the domain, for example will return "/tfs"
+        # for "http://origen.freescale.net/tfs"
+        def root_path # :nodoc:
+          if domain =~ /\/\/[^\/]*(\/.*)/  # http://rubular.com/r/UY06Z6DXUS
+            $1
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/c99/doc_interface.rb

@@ -0,0 +1,56 @@
+module C99
+  class DocInterface
+    include Origen::Tester::Doc::Generator
+
+    # Options passed to Flow.create and Library.create will be passed in here, use as
+    # desired to configure your interface
+    def initialize(_options = {})
+    end
+
+    def resources_filename=(*_args)
+    end
+
+    def log(_msg)
+    end
+
+    def func(name, options = {})
+      options = {
+        duration: :static
+      }.merge(options)
+
+      block_loop(name, options) do |_block, i, group|
+        ins = tests.add(name, options)
+        if group
+          flow.test(group, options) if i == 0
+        else
+          flow.test(ins, options)
+        end
+      end
+    end
+
+    def block_loop(name, options)
+      if options[:by_block]
+        tests.group do |group|
+          group.name = name
+          $nvm.blocks.each_with_index do |block, i|
+            yield block, i, group
+          end
+        end
+      else
+        yield
+      end
+    end
+
+    def por(_options = {})
+    end
+
+    def para(name, options = {})
+      options = {
+        high_voltage: false
+      }.merge(options)
+      ins = tests.add(name, options)
+      ins.dc_category = 'NVM_PARA'
+      flow.test(ins, options)
+    end
+  end
+end

data/lib/c99/j750_interface.rb

@@ -0,0 +1,85 @@
+module C99
+  module J750BaseInterface
+    # Options passed to Flow.create and Library.create will be passed in here, use as
+    # desired to configure your interface
+    def initialize(_options = {})
+    end
+
+    def log(msg)
+      flow.logprint(msg)
+    end
+
+    def func(name, options = {})
+      options = {
+        duration: :static
+      }.merge(options)
+
+      block_loop(name, options) do |_block, i, group|
+        ins = test_instances.functional(name)
+        ins.set_wait_flags(:a) if options[:duration] == :dynamic
+        ins.pin_levels = options.delete(:pin_levels) if options[:pin_levels]
+        if group
+          pname = "#{name}_b#{i}_pset"
+          patsets.add(pname, [{ pattern: "#{name}_b#{i}.PAT" },
+                              { pattern: 'nvm_global_subs.PAT', start_label: 'subr' }])
+          ins.pattern = pname
+          flow.test(group, options) if i == 0
+        else
+          pname = "#{name}_pset"
+          patsets.add(pname, [{ pattern: "#{name}.PAT" },
+                              { pattern: 'nvm_global_subs.PAT', start_label: 'subr' }])
+          ins.pattern = pname
+          if options[:cz_setup]
+            flow.cz(ins, options[:cz_setup], options)
+          else
+            flow.test(ins, options)
+          end
+        end
+      end
+    end
+
+    def block_loop(name, options)
+      if options[:by_block]
+        test_instances.group do |group|
+          group.name = name
+          $nvm.blocks.each_with_index do |block, i|
+            yield block, i, group
+          end
+        end
+      else
+        yield
+      end
+    end
+
+    def por(options = {})
+      options = {
+        instance_not_available: true
+      }.merge(options)
+      flow.test('por_ins', options)
+    end
+
+    def para(name, options = {})
+      options = {
+        high_voltage: false
+      }.merge(options)
+      if options.delete(:high_voltage)
+        ins = test_instances.bpmu(name)
+      else
+        ins = test_instances.ppmu(name)
+      end
+      ins.dc_category = 'NVM_PARA'
+      flow.test(ins, options)
+      patsets.add("#{name}_pset", pattern: "#{name}.PAT")
+    end
+  end
+
+  class J750Interface
+    include J750BaseInterface
+    include Origen::Tester::J750::Generator
+  end
+
+  # class TestersJ750Interface
+  #  include J750BaseInterface
+  #  include Testers::J750::Generator
+  # end
+end

data/lib/c99/nvm.rb

@@ -0,0 +1,89 @@
+module C99
+  # Most of the definition for this lives in core_support
+  class NVM
+    attr_accessor :attribute_x
+
+    def override_method
+      :overridden
+    end
+
+    def added_method
+      :added
+    end
+
+    def add_multi_split_reg
+      reg :multi_group, 0x0070, size: 16 do |reg|
+        reg.bits 15,   :mike,  reset: 1
+        reg.bits 14,   :bill,  reset: 0
+        reg.bits 13,   :robert,  reset: 1
+        reg.bits 12,   :james,  reset: 0
+        reg.bits 11,   :james, reset: 1
+        reg.bits 10,   :james, reset: 0
+        reg.bits 9,    :paul,  reset: 1
+        reg.bits 8,    :peter,  reset: 0
+        reg.bits 7,    :mike,  reset: 1
+        reg.bits 6,    :mike,  reset: 0
+        reg.bits 5,    :paul,  reset: 1
+        reg.bits 4,    :paul,  reset: 0
+        reg.bits 3,    :mike, reset: 1
+        reg.bits 2,    :robert, reset: 0
+        reg.bits 1,    :bill,  reset: 0
+        reg.bits 0,    :ian,  reset: 1
+      end
+    end
+
+    def add_proth_reg
+      reg :proth, 0x0024, size: 32 do |reg|
+        reg.bits 31..24,   :fprot7,  reset: 0xFF
+        reg.bits 23..16,   :fprot6,  reset: 0xEE
+        reg.bits 15..8,    :fprot5,  reset: 0xDD
+        reg.bits 7..0,     :fprot4,  reset: 0x11
+      end
+    end
+  end
+
+  class NVMSub < NVM
+    def redefine_data_reg
+      add_reg :data,      0x40,   16,  d: { pos: 0, bits: 16 }
+    end
+
+    # Tests that the block format for defining registers works
+    def add_reg_with_block_format
+      # ** Data Register 3 **
+      # This is dreg
+      add_reg :dreg, 0x1000, size: 16 do |reg|
+        # This is dreg bit 15
+        reg.bit 15,    :bit15, reset: 1
+        # **Bit 14** - This does something cool
+        #
+        # 0 | Coolness is disabled
+        # 1 | Coolness is enabled
+        reg.bits 14,    :bit14
+        # This is dreg bit upper
+        reg.bits 13..8, :upper
+        # This is dreg bit lower
+        # This is dreg bit lower line 2
+        reg.bit 7..0,  :lower, writable: false, reset: 0x55
+      end
+
+      # This is dreg2
+      reg :dreg2, 0x1000, size: 16 do
+        # This is dreg2 bit 15
+        bit 15,    :bit15, reset: 1
+        # This is dreg2 bit upper
+        bits 14..8, :upper
+        # This is dreg2 bit lower
+        # This is dreg2 bit lower line 2
+        bit 7..0,  :lower, writable: false, reset: 0x55
+      end
+
+      # Finally a test that descriptions can be supplied via the API
+      reg :dreg3, 0x1000, size: 16, description: "** Data Register 3 **\nThis is dreg3" do
+        bit 15,    :bit15, reset: 1, description: 'This is dreg3 bit 15'
+        bit 14, :bit14, description: "**Bit 14** - This does something cool\n\n0 | Coolness is disabled\n1 | Coolness is enabled"
+        bits 13..8, :upper, description: 'This is dreg3 bit upper'
+        bit 7..0,  :lower, writable: false, reset: 0x55, description: "This is dreg3 bit lower\nThis is dreg3 bit lower line 2"
+      end
+    end
+  end
+end

data/lib/c99/target/mock2.rb

@@ -0,0 +1 @@
+$tester = 'found in symlinked subdir'

data/lib/c99/target/subdir/mock3.rb

@@ -0,0 +1 @@
+$tester = 'found in subdir of a symlinked subdir!'

data/lib/option_parser/optparse.rb

@@ -0,0 +1,12 @@
+require 'optparse'
+class OptionParser
+  alias_method :orig_parse!, :parse!
+  # Extend this method to save all original options so that they can
+  # be later appended to any LSF submissions
+  def parse!(*args)
+    lsf_options = ARGV.dup
+    orig_parse!(*args)
+    lsf_options -= ARGV  # Now contains all original options
+    Origen.app.lsf_manager.command_options = lsf_options
+  end
+end

data/lib/origen/acronyms.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/string/inflections'
+# This helps the String inflection methods work correctly with our acronyms
+#
+#   "MPGBOMApp".underscore    # => "mpg_bom_app"
+#   "mpg_bom_app".camelcase   # => "MPGBOMApp"
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym 'Origen'
+  inflect.acronym 'SVN'
+
+  inflect.acronym 'MPG'
+  inflect.acronym 'AMPG'
+  inflect.acronym 'DNG'     # Digital Networking Group
+  inflect.acronym 'NVM'
+
+  inflect.acronym 'C90TFS'
+  inflect.acronym 'C40TFS'
+  inflect.acronym 'C28TFS'
+  inflect.acronym 'C90'
+  inflect.acronym 'C40'
+  inflect.acronym 'C28'
+
+  inflect.acronym 'TFS'
+  inflect.acronym 'SGF'
+
+  inflect.acronym 'BOM'     # Bill of Materials
+  inflect.acronym 'CATI'
+  inflect.acronym 'RTL'
+  inflect.acronym 'FSL'     # Freescale
+  inflect.acronym 'PDM'
+
+  inflect.acronym 'IP'      # Intellectual Property
+  inflect.acronym 'SoC'     # System on Chip
+  inflect.acronym 'SOC'     # System on Chip
+  inflect.acronym 'DUT'     # Device Under Test
+  inflect.acronym 'ADC'
+  inflect.acronym 'ATD'
+  inflect.acronym 'RAM'
+  inflect.acronym 'PLL'     # Phase Locked Loop
+  inflect.acronym 'ATX'
+  inflect.acronym 'BIST'    # Built-In Self Test
+  inflect.acronym 'FSLBIST' # Freescale Built-In Self Test
+  inflect.acronym 'MBIST'   # Memory BIST
+  inflect.acronym 'ARM'
+  inflect.acronym 'DFT'     # Design for Test
+  inflect.acronym 'VCO'
+  inflect.acronym 'DDR'
+  inflect.acronym 'JTAG'
+  inflect.acronym 'LTG'     # Lynx Test Guide
+  inflect.acronym 'DTG'     # DDR Test Guide
+  inflect.acronym 'DIB'     # Device Interface Board
+
+  inflect.acronym 'S08'
+  inflect.acronym 'LAU'     # Least Addressible Unit
+  inflect.acronym 'LSB0'    # Least Significant Bit 0
+  inflect.acronym 'MSB0'    # Most Significant Bit 0
+  inflect.acronym 'PDE'     # Product Development Engineering
+  inflect.acronym 'NPI'     # New Product Introduction
+
+  inflect.acronym 'ML'  # Markup Language
+end

data/lib/origen/application/command_dispatcher.rb

@@ -0,0 +1,12 @@
+module Origen
+  class Application
+    class CommandDispatcher
+      # Returns true if some pre-built workspace snaphots
+      # exist. The location of these is defined by the configuration
+      # attribute config.snapshots_directory
+      def snapshots_exist?
+        File.exist?(Origen.config.snapshots_directory)
+      end
+    end
+  end
+end

data/lib/origen/application/configuration.rb

@@ -0,0 +1,206 @@
+module Origen
+  class Application
+    class Configuration
+      require 'pathname'
+
+      # Returns the configuration's application instance
+      attr_reader :app
+
+      attr_accessor :name, :initials, :instructions, :required_origen_version,
+                    :min_required_origen_version, :max_required_origen_version,
+                    :history_file, :release_directory, :release_email_subject,
+                    :production_targets, :mode,
+                    :vault, :output_directory, :reference_directory,
+                    :semantically_version, :log_directory, :pattern_name_translator,
+                    :pattern_directory, :pattern_output_directory, :pattern_prefix, :pattern_postfix,
+                    :pattern_header, :default_lsf_action, :release_instructions, :proceed_with_pattern,
+                    :test_program_output_directory, :erb_trim_mode, :test_program_source_directory,
+                    :test_program_template_directory, :referenced_pattern_list, :program_prefix,
+                    :copy_command, :diff_command, :compile_only_dot_erb_files, :web_directory,
+                    :web_domain, :imports, :imports_dev,
+                    :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
+
+      # 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
+      # instantiated (a concern for Origen core developers only).
+      #
+      # These attributes will also receive an enhanced accessor that accepts a block, see
+      # below for more details on this.
+      ATTRS_THAT_DEPEND_ON_TARGET = [
+        :output_directory, :reference_directory, :pattern_postfix, :pattern_prefix,
+        :pattern_header, :release_directory, :pattern_name_translator, :pattern_directory, :pattern_output_directory,
+        :proceed_with_pattern, :test_program_output_directory, :test_program_source_directory,
+        :test_program_template_directory, :referenced_pattern_list, :program_prefix, :web_directory,
+        :web_domain
+      ]
+
+      # Any attributes that want to accept a block, but not necessarily require the target
+      # can be added here
+      ATTRS_THAT_ACCEPT_A_BLOCK = ATTRS_THAT_DEPEND_ON_TARGET +
+                                  [:release_instructions, :history_file, :log_directory, :copy_command,
+                                   :diff_command, :imports, :imports_dev, :remotes,
+                                   :external_app_dirs
+                                  ]
+
+      # If a current plugin is present then its value for these attributes will be
+      # used instead of that from the current application
+      ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE = [
+        :pattern_prefix, :pattern_postfix, :program_prefix, :pattern_header, :pattern_output_directory,
+        :output_directory, :reference_directory, :test_program_output_directory,
+        :test_program_template_directory, :referenced_pattern_list
+      ]
+
+      def log_deprecations
+        unless imports.empty?
+          Origen.deprecate "App #{app.name} uses config.imports this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
+        end
+        unless imports_dev.empty?
+          Origen.deprecate "App #{app.name} uses config.imports_dev this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
+        end
+        if required_origen_version
+          Origen.deprecate "App #{app.name} uses config.required_origen_version this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
+        end
+        if min_required_origen_version
+          Origen.deprecate "App #{app.name} uses config.min_required_origen_version this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
+        end
+        if max_required_origen_version
+          Origen.deprecate "App #{app.name} uses config.max_required_origen_version this will be removed in Origen V3 and a Gemfile/.gemspec should be used instead"
+        end
+      end
+
+      def initialize(app)
+        @app = app
+        @mode = Origen::Mode.new
+        @name = 'Unknown'
+        @initials = 'NA'
+        @semantically_version = false
+        @compile_only_dot_erb_files = true
+        # Functions used here since Origen.root is not available when this is first instantiated
+        @output_directory = -> { "#{Origen.root}/output" }
+        @reference_directory = -> { "#{Origen.root}/.ref" }
+        @release_directory = -> { Origen.root }
+        @release_email_subject = false
+        @log_directory = -> { "#{Origen.root}/log" }
+        @pattern_name_translator = ->(name) { name }
+        @pattern_directory = -> { "#{Origen.root}/pattern" }
+        @pattern_output_directory = -> { "#{Origen.root}/output/patterns" }
+        @history_file = -> { "#{Origen.root}/doc/history" }
+        @default_lsf_action = :clear
+        @proceed_with_pattern = ->(_name) { true }
+        @erb_trim_mode = '%'
+        @referenced_pattern_list = -> { "#{Origen.root}/list/referenced.list" }
+        @copy_command = -> { Origen.running_on_windows? ? 'copy' : 'cp' }
+        @diff_command = -> { Origen.running_on_windows? ? 'start winmerge' : 'tkdiff' }
+        @imports = []
+        @imports_dev = []
+        @external_app_dirs = []
+        @unmanaged_dirs = []
+        @unmanaged_files = []
+        @remotes = []
+        @lint_test = {}
+        @user_aliases = {}
+      end
+
+      # This defines an enhanced accessor for these attributes that allows them to be assigned
+      # to an annonymous function to calculate the value based on some property of the target
+      # objects.
+      #
+      # Without this the objects frome the target could not be referenced in config/application.rb
+      # because they don't exist yet, for example this will not work because $dut has not yet
+      # been instantiated:
+      #   # config/application.rb
+      #
+      #   config.output_directory = "#{Origen.root}/output/#{$dut.class}"
+      #
+      # However this accessor provides a way to do that via the following syntax:
+      #   # config/application.rb
+      #
+      #   config.output_directory do
+      #     "#{Origen.root}/output/#{$dut.class}"
+      #   end
+      #
+      # Or on one line:
+      #   # config/application.rb
+      #
+      #   config.output_directory { "#{Origen.root}/output/#{$dut.class}" }
+      #
+      # Or if you prefer the more explicit:
+      #   # config/application.rb
+      #
+      #   config.output_directory = ->{ "#{Origen.root}/output/#{$dut.class}" }
+      ATTRS_THAT_ACCEPT_A_BLOCK.each do |name|
+        define_method name do |override = true, &block|
+          if block # _given?
+            instance_variable_set("@#{name}".to_sym, block)
+          else
+            if override && ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE.include?(name) &&
+               app.current? && Origen.current_plugin.name
+              var = Origen.current_plugin.instance.config.send(name, override: false)
+            end
+            var ||= instance_variable_get("@#{name}".to_sym)
+            if var.respond_to?('call')
+              if ATTRS_THAT_DEPEND_ON_TARGET.include?(name)
+                # If an attempt has been made to access this attribute before the target has
+                # been instantiated raise an error
+                # Note Origen.app here instead of just app to ensure we are talking to the top level application,
+                # that is the only one that has a target
+                unless Origen.app.target_instantiated?
+                  fail "You have attempted to access Origen.config.#{name} before instantiating the target"
+                end
+              end
+              var.call
+            else
+              var
+            end
+          end
+        end
+      end
+
+      (ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE - ATTRS_THAT_ACCEPT_A_BLOCK).each do |name|
+        if override && ATTRS_THAT_CURRENT_PLUGIN_CAN_OVERRIDE.include?(name) &&
+           app.current? && Origen.current_plugin.name
+          var = Origen.current_plugin.instance.config.send(name, override: false)
+        end
+        var || instance_variable_get("@#{name}".to_sym)
+      end
+
+      def pattern_name_translator(name = nil, &block)
+        if block
+          @pattern_name_translator = block
+        else
+          @pattern_name_translator.call(name)
+        end
+      end
+
+      def proceed_with_pattern(name = nil, &block)
+        if block
+          @proceed_with_pattern = block
+        else
+          @proceed_with_pattern.call(name)
+        end
+      end
+
+      # Add a new pattern iterator
+      def pattern_iterator
+        yield Origen.generator.create_iterator
+      end
+
+      def mode=(val)
+        @mode.set(val)
+      end
+
+      def lsf
+        app.lsf.configuration
+      end
+
+      # Prevent a new attribute from a future version of Origen from dying before the
+      # user can be prompted to upgrade
+      def method_missing(method, *_args, &_block)
+        method = method.to_s.sub('=', '')
+        puts "WARNING - unknown configuration attribute: #{method}"
+      end
+    end
+  end
+end