origen_sim 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fa5d90e78e17efb1942f6da11e1af57944e4ae1
+  data.tar.gz: 5ef919794ccbe8c54762dc87b1f461821ecdb031
+SHA512:
+  metadata.gz: ba5ee81d6b23bc3ca5c910cf12c491938e87fb7cd1140142744cc4610f1058ac09c7196e9161291c852aaa3eb7e5516fdf5940463b4e7fb6a839e580bf1df022
+  data.tar.gz: 8fccdf6043048f57802489a64631bb1e8c6b757cba3c909690dd4e96582b71cca2b96a85f87f168f63c9aceff60ae62dfab5976af42ae4543b890b809dbed2e1

data/config/application.rb

@@ -0,0 +1,109 @@
+require 'origen'
+class OrigenSimApplication < Origen::Application
+
+  # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
+  # for a full list of the configuration options available
+
+  # These attributes should never be changed, the duplication here will be resolved in future
+  # by condensing these attributes that do similar things
+  self.name       = "origen_sim"
+  self.namespace  = "OrigenSim"
+  config.name     = "origen_sim"
+  config.initials = "OrigenSim"
+  config.rc_url   = "git@github.com:Origen-SDK/origen_sim.git"
+  config.release_externally = true
+
+  # To enable deployment of your documentation to a web server (via the 'origen web'
+  # command) fill in these attributes.
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/sim"
+  config.web_domain = "http://origen-sdk.org/sim"
+
+  # When false Origen will be less strict about checking for some common coding errors,
+  # it is recommended that you leave this to true for better feedback and easier debug.
+  # This will be the default setting in Origen v3.
+  config.strict_errors = true
+
+  config.shared = {
+    #:patterns => "pattern",
+    #:templates => "templates",
+    #:programs => "program",
+    :command_launcher => "config/shared_commands.rb"
+  }
+
+  # See: http://origen-sdk.org/origen/latest/guides/utilities/lint/
+  config.lint_test = {
+    # Require the lint tests to pass before allowing a release to proceed
+    run_on_tag: true,
+    # Auto correct violations where possible whenever 'origen lint' is run
+    auto_correct: true, 
+    # Limit the testing for large legacy applications
+    #level: :easy,
+    # Run on these directories/files by default
+    #files: ["lib", "config/application.rb"],
+  }
+
+  config.semantically_version = true
+
+  # An example of how to set application specific LSF parameters
+  #config.lsf.project = "msg.te"
+  
+  # An example of how to specify a prefix to add to all generated patterns
+  #config.pattern_prefix = "nvm"
+
+  # An example of how to add header comments to all generated patterns
+  #config.pattern_header do
+  #  cc "This is a pattern created by the example origen application"
+  #end
+
+  # By default all generated output will end up in ./output.
+  # Here you can specify an alternative directory entirely, or make it dynamic such that
+  # the output ends up in a setup specific directory. 
+  #config.output_directory do
+  #  "#{Origen.root}/output/#{$dut.class}"
+  #end
+
+  # Similarly for the reference files, generally you want to setup the reference directory
+  # structure to mirror that of your output directory structure.
+  #config.reference_directory do
+  #  "#{Origen.root}/.ref/#{$dut.class}"
+  #end
+ 
+  # This will automatically deploy your documentation after every tag
+  #def after_release_email(tag, note, type, selector, options)
+  #  command = "origen web compile --remote --api"
+  #  Dir.chdir Origen.root do
+  #    system command
+  #  end
+  #end
+
+  # Ensure that all tests pass before allowing a release to continue
+  #def validate_release
+  #  if !system("origen specs") || !system("origen examples")
+  #    puts "Sorry but you can't release with failing tests, please fix them and try again."
+  #    exit 1
+  #  else
+  #    puts "All tests passing, proceeding with release process!"
+  #  end
+  #end
+
+  # To enabled source-less pattern generation create a class (for example PatternDispatcher)
+  # to generate the pattern. This should return false if the requested pattern has been
+  # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.
+  #def before_pattern_lookup(requested_pattern)
+  #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
+  #end
+
+  # If you use pattern iterators you may come across the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # However it cannot be found by Origen since the pattern name is actually example_pat_bx.atp
+  # In the case where the pattern cannot be found Origen will pass the name to this translator
+  # if it exists, and here you can make any substitutions to help Origen find the file you 
+  # want. In this example any instances of _b\d, where \d means a number, are replaced by
+  # _bx.
+  #config.pattern_name_translator do |name|
+  #  name.gsub(/_b\d/, "_bx")
+  #end
+
+end

data/config/boot.rb

@@ -0,0 +1,24 @@
+# This file is used to boot your plugin when it is running in standalone mode
+# from its own workspace - i.e. when the plugin is being developed.
+#
+# It will not be loaded when the plugin is imported by a 3rd party app - in that
+# case only lib/origen_sim.rb is loaded.
+#
+# Therefore this file can be used to load anything extra that you need to boot
+# the development environment for this app. For example, this is typically used
+# to load some additional test classes to use your plugin APIs so that they can
+# be tested and/or interacted with in the console.
+require "origen_sim"
+
+module OrigenSimDev
+  # Example of how to explicitly require a file
+  # require "origen_sim_dev/my_file"
+    
+  # Load all files in the lib/origen_sim_dev directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/../lib/origen_sim_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/config/commands.rb

@@ -0,0 +1,74 @@
+# This file should be used to extend the origen with application specific commands
+
+# Map any command aliases here, for example to allow 'origen ex' to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "ex" => "execute",
+}
+
+# The requested command is passed in here as @command, this checks it against
+# the above alias table and should not be removed.
+@command = aliases[@command] || @command
+
+# Now branch to the specific task code
+case @command
+
+# Here is an example of how to implement a command, the logic can go straight
+# in here or you can require an external file if preferred.
+when "my_command"
+  puts "Doing something..."
+  #require "commands/my_command"    # Would load file lib/commands/my_command.rb
+  # You must always exit upon successfully capturing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+#when "specs"
+#  require "rspec"
+#  exit RSpec::Core::Runner.run(['spec'])
+
+## Example of how to make a command to run diff-based tests
+#when "examples", "test"
+#  Origen.load_application
+#  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "origen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{Origen.top}/lib/origen/commands/generate.rb"
+#
+#  if Origen.app.stats.changed_files == 0 &&
+#     Origen.app.stats.new_files == 0 &&
+#     Origen.app.stats.changed_patterns == 0 &&
+#     Origen.app.stats.new_patterns == 0
+#
+#    Origen.app.stats.report_pass
+#  else
+#    Origen.app.stats.report_fail
+#    status = 1
+#  end
+#  puts
+#  if @command == "test"
+#    Origen.app.unload_target!
+#    require "rspec"
+#    result = RSpec::Core::Runner.run(['spec'])
+#    status = status == 1 ? 1 : result
+#  end
+#  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+else
+  # You probably want to also add the your commands to the help shown via
+  # origen -h, you can do this be assigning the required text to @application_commands
+  # before handing control back to Origen. Un-comment the example below to get started.
+#  @application_commands = <<-EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
+#  EOT
+
+end 

data/config/shared_commands.rb

@@ -0,0 +1,12 @@
+# The requested command is passed in here as @command
+case @command
+
+when "origen_sim:build", "sim:build"
+  require "origen_sim/commands/build"
+  exit 0
+else
+  @plugin_commands << <<-EOT
+ sim:build       Build the simulation object for the current/given target
+  EOT
+
+end

data/config/version.rb

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

data/lib/origen_sim/commands/build.rb

@@ -0,0 +1,105 @@
+require 'optparse'
+require 'origen_sim'
+
+options = {}
+
+# App options are options that the application can supply to extend this command
+app_options = @application_options || []
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<-EOT
+Compile an RTL design into an object that Origen can simulate.
+
+All configuration apart from target selection should be done when instantiating the
+OrigenSim::Tester in an environment file. This encourages the configuration to be
+checked in, enabling repeatable builds in future.
+
+Usage: origen origen_sim:build [options]
+  EOT
+  opts.on('-e', '--environment NAME', String, 'Override the default environment, NAME can be a full path or a fragment of an environment file name') { |e| options[:environment] = e }
+  opts.on('-t', '--target NAME', String, 'Override the default target, NAME can be a full path or a fragment of a target file name') { |t| options[:target] = t }
+  opts.on('-pl', '--plugin PLUGIN_NAME', String, 'Set current plugin') { |pl_n|  options[:current_plugin] = pl_n }
+  opts.on('--testrun', 'Displays the commands that will be generated but does not execute them') { options[:testrun] = true }
+  opts.on('-i', '--incremental', 'Preserve existing compiled files to do an incremental build instead of starting from scratch') { options[:incremental] = true }
+  opts.on('-d', '--debugger', 'Enable the debugger') {  options[:debugger] = true }
+  app_options.each do |app_option|
+    opts.on(*app_option) {}
+  end
+  opts.separator ''
+  opts.on('-h', '--help', 'Show this message') { puts opts; exit 0 }
+end
+
+opt_parser.parse! ARGV
+Origen.app.plugins.temporary = options[:current_plugin] if options[:current_plugin]
+Origen.environment.temporary = options[:environment] if options[:environment]
+Origen.target.temporary = options[:target] if options[:target]
+Origen.app.load_target!
+
+unless tester.is_a?(OrigenSim::Tester)
+  puts 'The target/environment does not instantiate an OrigenSim::Tester instance!'
+  exit
+end
+
+simulator = OrigenSim.simulator
+config = simulator.configuration
+tmp_dir = simulator.tmp_dir
+
+unless options[:testrun]
+  FileUtils.rm_rf(tmp_dir) unless options[:incremental]
+  FileUtils.mkdir_p(tmp_dir)
+  FileUtils.rm_rf(simulator.compiled_dir) unless options[:incremental]
+  FileUtils.mkdir_p(simulator.compiled_dir)
+  FileUtils.rm_rf(simulator.artifacts_dir)
+  FileUtils.mkdir_p(simulator.artifacts_dir)
+  Array(config[:artifacts] || config[:artifact]).each do |f|
+    FileUtils.cp(f, simulator.artifacts_dir)
+  end
+
+  # Create the testbench for the current Origen target and simulator vendor
+  Origen.app.runner.launch action:            :compile,
+                           files:             "#{Origen.root!}/templates/rtl_v/origen.v.erb",
+                           output:            tmp_dir,
+                           check_for_changes: false,
+                           options:           { vendor: config[:vendor], top: config[:rtl_top] }
+end
+
+case config[:vendor]
+when :icarus
+  # Compile the VPI extension first
+  Dir.chdir tmp_dir do
+    system "iverilog-vpi #{Origen.root!}/ext/*.c -DICARUS --name=origen"
+    system "mv origen.vpi #{simulator.compiled_dir}"
+  end
+  # Build the object containing the DUT and testbench
+  cmd = "iverilog -o #{simulator.compiled_dir}/dut.vvp"
+  Array(config[:rtl_dir] || config[:rtl_dirs]).each do |dir|
+    cmd += " -I #{dir}"
+  end
+  Array(config[:rtl_file] || config[:rtl_files]).each do |f|
+    cmd += " #{f}"
+  end
+  cmd += " #{tmp_dir}/origen.v"
+
+when :cadence
+  cmd = config[:irun] || 'irun'
+  Array(config[:rtl_file] || config[:rtl_files]).each do |f|
+    cmd += " #{f}"
+  end
+  Array(config[:lib_file] || config[:lib_files]).each do |f|
+    cmd += " -v #{f}"
+  end
+  Array(config[:rtl_dir] || config[:rtl_dirs]).each do |dir|
+    cmd += " -incdir #{dir}"
+  end
+  cmd += " #{tmp_dir}/origen.v -top origen -timescale 1ns/1ns"
+  cmd += " -nclibdirpath #{simulator.compiled_dir}"
+  cmd += " #{Origen.root!}/ext/*.c -ccargs \"-std=gnu99\""
+  cmd += ' -elaborate -snapshot origen -access +rw'
+  cmd += " #{config[:explicit].strip.gsub(/\s+/, ' ')}" if  config[:explicit]
+end
+
+puts cmd
+unless options[:testrun]
+  Dir.chdir tmp_dir do
+    system cmd
+  end
+end

data/lib/origen_sim/flow.rb

@@ -0,0 +1,13 @@
+module OrigenSim
+  class Flow
+    include OrigenTesters::Flow
+
+    def test(name, options = {})
+      pattern = (options[:pattern] || name.try(:pattern) || name).to_s
+
+      Origen.interface.referenced_patterns << pattern
+
+      Origen.app.runner.launch action: :generate, files: pattern
+    end
+  end
+end

data/lib/origen_sim/generator.rb

@@ -0,0 +1,35 @@
+require 'origen_sim/flow'
+module OrigenSim
+  module Generator
+    extend ActiveSupport::Concern
+
+    included do
+      include OrigenTesters::Interface  # adds the interface helpers/Origen hook-up
+    end
+
+    def flow(filename = nil)
+      if filename || Origen.file_handler.current_file
+        filename ||= Origen.file_handler.current_file.basename('.rb').to_s
+        # DH here need to reset the flow!!
+        f = filename.to_sym
+        return flow_sheets[f] if flow_sheets[f] # will return flow if already existing
+        p = OrigenSim::Flow.new
+        p.inhibit_output if Origen.interface.resources_mode?
+        p.filename = f
+        flow_sheets[f] = p
+      end
+    end
+
+    def flow_sheets
+      @@flow_sheets ||= {}
+    end
+
+    def reset_globals
+      @@flow_sheets = nil
+    end
+
+    def sheet_generators
+      []
+    end
+  end
+end

data/lib/origen_sim/origen/pins/pin.rb

@@ -0,0 +1,93 @@
+require 'origen/pins/pin'
+module Origen
+  module Pins
+    # Override the Origen pin model so we can hook into all changes to pin states
+    class Pin
+      # The index number that is used to refer to the pin within the simulation
+      attr_accessor :simulation_index
+      # When generating a testbench the top-level signal will be tied off to the given
+      # logic level if this is set to 0 or 1
+      attr_accessor :tie_off
+
+      alias_method :_orig_initialize, :initialize
+      def initialize(id, owner, options = {})
+        @tie_off = options[:tie_off]
+        _orig_initialize(id, owner, options)
+      end
+
+      def rtl_name
+        if primary_group
+          (@rtl_name || primary_group.id).to_s
+        else
+          (@rtl_name || id).to_s
+        end
+      end
+
+      alias_method :_orig_set_value, :set_value
+      def set_value(val)
+        ret = _orig_set_value(val)
+        update_simulation if simulation_running?
+        ret
+      end
+
+      alias_method :_orig_set_state, :set_state
+      def set_state(val)
+        ret = _orig_set_state(val)
+        update_simulation if simulation_running?
+        ret
+      end
+
+      alias_method :_orig_state=, :state=
+      def state=(val)
+        ret = _orig_state = (val)
+        update_simulation if simulation_running?
+        ret
+      end
+
+      def simulation_running?
+        tester && tester.is_a?(OrigenSim::Tester)
+      end
+
+      def simulator
+        OrigenSim.simulator
+      end
+
+      # Returns true if the current pin state is different to that last given to the simulator
+      def simulator_needs_update?
+        return false if state == :dont_care && @simulator_state == :dont_care
+        state != @simulator_state || value != @simulator_value
+      end
+
+      def reset_simulator_state
+        @simulator_state = nil
+        @simulator_value = nil
+      end
+
+      # Applies the current pin state to the simulation, this is triggered everytime
+      # the pin state or value changes
+      def update_simulation
+        return if tie_off || !simulation_index || !tester.timeset || !simulator_needs_update?
+        case state
+          when :drive
+            @simulator_state = :drive
+            @simulator_value = value
+            simulator.put("2^#{simulation_index}^#{value}")
+          when :compare
+            @simulator_state = :compare
+            @simulator_value = value
+            simulator.put("4^#{simulation_index}^#{value}")
+          when :dont_care
+            @simulator_state = :dont_care
+            simulator.put("5^#{simulation_index}")
+          when :capture
+            @simulator_state = :capture
+            simulator.put("e^#{simulation_index}")
+          when :drive_very_high, :drive_mem, :expect_mem, :compare_midband
+            fail "Simulation of pin state #{state} is not implemented yet!"
+          else
+            fail "Simulation of pin state #{state} is not implemented yet!"
+        end
+      end
+    end
+  end
+end

data/lib/origen_sim/origen/top_level.rb

@@ -0,0 +1,22 @@
+require 'origen/top_level'
+module Origen
+  module TopLevel
+    # Like pins, except removes any pins which have their rtl_name
+    # attribute set to 'nc'
+    def rtl_pins
+      @rtl_pins ||= begin
+        p = []
+        pins.each do |name, pin|
+          options = {}
+          unless pin.rtl_name.to_s.downcase == 'nc'
+            if pin.primary_group
+              options[:group] = true
+            end
+            p << [name, pin, options]
+          end
+        end
+        p
+      end
+    end
+  end
+end

data/lib/origen_sim/origen_testers/api.rb

@@ -0,0 +1,11 @@
+require 'origen_testers/api'
+module OrigenTesters
+  module API
+    # Returns true if the tester is an instance of OrigenSim::Tester,
+    # otherwise returns false
+    def sim?
+      is_a?(OrigenSim::Tester)
+    end
+    alias_method :simulator?, :sim?
+  end
+end