origen_link 0.1.0.pre0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e1bcf6176e63bcb31f823ec75e8171d5f41f678
+  data.tar.gz: b8773221ecda2487be4b458341b07260f3298a38
+SHA512:
+  metadata.gz: e5f8bb591f2113d737a4e2ec9adcb035aab944e61558e7927004ef3ed6327c4438f9a0619c1ab181a41d124505aa1e6fe0e47238af876a26d1c4b88740b0f19f
+  data.tar.gz: 5a345ff111d0fe9779bff83d317878addc8baec9551c546c471dcda03f65534d9360679e56b5d6519b66d22560975349921bc9e4bfc6b3a96f423c256e8acd3e

data/config/application.rb

@@ -0,0 +1,105 @@
+require 'origen'
+class OrigenLinkApplication < 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_link"
+  self.namespace  = "OrigenLink"
+  config.name     = "origen_link"
+  config.initials = "OrigenLink"
+  # Change this to point to the revision control repository for this application
+  config.rc_url   = "git@github.com:Origen-SDK/OrigenLink.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 = "/path/to/server/origen_link"
+  #config.web_domain = "http://origen.mycompany.net/origen_link"
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/OrigenLink"
+  config.web_domain = "http://origen-sdk.org/OrigenLink"
+
+  # 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
+
+  # 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,7 @@
+# This file will be loaded by Origen to boot your application, just leave it as
+# is and modify lib/origen_link.rb to load the additional resources that your
+# application requires
+require "origen_link"
+
+require "origen_link/test/test_dut"
+require "origen_link/test/test_dut_controller"

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/version.rb

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

data/lib/origen_link/includes_vector_based.rb

@@ -0,0 +1,76 @@
+module OrigenLink
+  class VectorBased
+    include OrigenTesters::VectorBasedTester
+
+    # send_cmd(cmdstr, argstr)
+    #   cmdstr is a valid command.  <category>_<command>
+    #     Ex: 'pin_assign'
+    #   argstr is a valid comma separated, no white space argument string.
+    #     Ex: 'tclk,26,tms,19,tdi,16,tdo,23'
+    #
+    #   returns: response from server
+    #
+    #   This method connects to the socket being served by the debugger, sends
+    #   the command and arguments separated by a semicolon (Ex: 'pin_cycle:110H'),
+    #   then waits for a response.  The response is returned to the caller.
+    #
+    #   In addition, this method also keeps track of time elapsed transfering data
+    #   and waiting for a response.
+    def send_cmd(cmdstr, argstr)
+      # objects have to be created outside of the block
+      # to be accessible outside of the block
+      t2 = 0
+      t3 = 0
+      t4 = 0
+      t5 = 0
+      response = ''
+      t1 = Time.now
+
+      # open a connection to the server, send the command and wait for a response
+      TCPSocket.open(@address, @port) do |link|
+        t2 = Time.now
+        link.puts(cmdstr + ':' + argstr)
+        t3 = Time.now
+        response = link.gets
+        t4 = Time.now
+      end
+
+      t5 = Time.now
+      @total_comm_time += (t5 - t1)
+      if @max_packet_time < (t5 - t1)
+        @max_packet_time = (t5 - t1)
+        @longest_packet = cmdstr + ':' + argstr
+      end
+      @total_connect_time += (t2 - t1)
+      @total_xmit_time += (t3 - t2)
+      @total_recv_time += (t4 - t3)
+      @max_receive_time = (t4 - t3) if @max_receive_time < (t4 - t3)
+      @total_packets += 1
+      Origen.log.error 'nil reponse from server (likely died) for command(' + cmdstr + ':' + argstr + ')' if response.nil?
+      response	# ensure the response is passed along
+    end
+
+    # setup_cmd_response_logger
+    #   There are several setup commands that initialize the debugger device with
+    #   information about how to interact with the dut.  All of the setup commands
+    #   return pass or fail.  This method exists so that the code doesn't have to
+    #   be duplicated by every setup method.
+    def setup_cmd_response_logger(command, response)
+      if !response.nil?
+        # if the server died (which hopefully it never will) response is nil
+        case response.chr
+        when 'P'
+          Origen.log.info command + ' setup was successful'
+        when 'F'
+          Origen.log.error command + ' setup FAILED with the following message:'
+          Origen.log.error response.chomp
+        else
+          Origen.log.error 'Non standard response from ' + command + ' setup: ' + response
+        end
+      else
+        # response was nil.  The server died
+        Origen.log.error command + ' caused a nil response.  The server likely died.'
+      end
+    end
+  end
+end

data/lib/origen_link/test/regression_tests.rb

@@ -0,0 +1,68 @@
+require_relative '..\vector_based'
+require_relative 'vector_based_redefs'
+require 'test/unit'
+
+class DummyTset
+  attr_accessor :name
+
+  def initialize
+    @name = 'default'
+  end
+end
+
+class TestVectorBased < Test::Unit::TestCase
+  def test_stuff
+    timeset_sim_obj = DummyTset.new
+
+    test_obj = OrigenLink::VectorBased.new('localhost', 12_777)
+    # setup pinmap
+    test_obj.pinmap = 'tck, 5, tdo, 8, tms, 10, tdi, 15'
+    assert_equal('pin_assign:tck,5,tdo,8,tms,10,tdi,15', test_obj.message)
+
+    # setup pin order  ---- notice there's currently no error checking to see if pinmap and pinorder have the same pins !!!
+    test_obj.pinorder = 'tck,tdo, tdi, extal'
+    assert_equal('pin_patternorder:tck,tdo,tdi,extal', test_obj.message)
+
+    assert_equal(true, test_obj.link?)
+    assert_equal('OrigenLink::VectorBased', test_obj.to_s)
+
+    test_obj.message = ''
+    test_obj.push_vector(timeset: timeset_sim_obj, pin_vals: '1100')
+    # check that pin values are being accumulated and not sent
+    assert_equal('', test_obj.message)
+    assert_equal(1, test_obj.vector_repeatcount)
+
+    # check that different vector data causes previous to be sent
+    test_obj.microcodestr = ''
+    test_obj.test_response = 'P:1100'
+    test_obj.push_vector(timeset: timeset_sim_obj, pin_vals: '1000')
+    assert_equal('pin_cycle:1100', test_obj.message)
+    assert_equal('P:1100', test_obj.microcodestr)
+
+    # check that repeat count accumulates
+    test_obj.microcodestr = ''
+    test_obj.push_vector(timeset: timeset_sim_obj, pin_vals: '1000')
+    assert_equal(2, test_obj.vector_repeatcount)
+
+    # check that repeat count is correctly sent
+    test_obj.test_response = 'P:repeat2,1000'
+    test_obj.flush_vector
+    assert_equal('pin_cycle:repeat2,1000', test_obj.message)
+
+    # check pin format setup
+    test_obj.test_response = 'P:'
+    test_obj.pinformat = 'func_25mhz, tck, rl'
+    assert_equal('pin_format:1,tck,rl', test_obj.message)
+
+    # check timing setup
+    test_obj.pintiming = 'func_25mhz, tdi, 0, tdo, 1, tms, 0'
+    assert_equal('pin_timing:1,tdi,0,tdo,1,tms,0', test_obj.message)
+
+    # check pin_cycle works correctly with tsets programmed
+    test_obj.test_response = 'P:tset0,1000'
+    timeset_sim_obj.name = 'func_25mhz'
+    test_obj.push_vector(timeset: timeset_sim_obj, pin_vals: '1000')
+    test_obj.flush_vector
+    assert_equal('pin_cycle:tset1,1000', test_obj.message)
+  end
+end

data/lib/origen_link/test/test_dut.rb

@@ -0,0 +1,46 @@
+module TestDut
+  class TopLevel
+    include Origen::TopLevel
+
+    def initialize(options = {})
+      instantiate_pins(options)
+      instantiate_registers(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_pins(options = {})
+      options = {
+        jtag_comm_config:			     false,
+        invalid_pin_number_test:	false,
+        missing_pinmap_test:		   false
+      }.merge(options)
+      add_pin :tclk
+      add_pin :tdi
+      add_pin :tdo
+      add_pin :tms
+      add_pin :resetb
+      add_pins :port_a, size: 8
+
+      pin_pattern_order :tclk, :tms, :tdi, :tdo, only: true if options[:jtag_comm_config]
+
+      # if tester.link? #.to_s == 'OrigenLink::VectorBased'
+      if tester.to_s == 'OrigenLink::VectorBased'
+        if options[:invalid_pin_number_test]
+          tester.pinmap = 'tclk,119,tms,1900,tdi,116,tdo,124'
+        else
+          tester.pinmap = 'tclk,119,tms,6,tdi,116,tdo,124' unless options[:missing_pinmap_test]
+        end
+        tester.pinorder = 'tclk,tms,tdi,tdo'
+      end
+    end
+
+    def instantiate_registers(options = {})
+      reg :testreg, 0 do |reg|
+        reg.bits 31..0,		:value
+      end
+    end
+
+    def instantiate_sub_blocks(options = {})
+    end
+  end
+end

data/lib/origen_link/test/test_dut_controller.rb

@@ -0,0 +1,42 @@
+module TestDut
+  class TopLevelController
+    include Origen::Controller
+
+    include OrigenJTAG
+
+    JTAG_CONFIG = {
+      #:tclk_format => :rl,
+      tclk_format:     :rh,
+      #:tclk_multiple => 1,
+      tclk_multiple:   4,
+      tdo_strobe:      :tclk_high,
+      tdo_store_cycle: 3,
+      init_state:      :idle
+    }
+
+    def startup(options)
+      pp 'Enter test mode' do
+        # if tester.link?
+        if tester.to_s == 'OrigenLink::VectorBased'
+          tester.initialize_pattern
+          # below is for testing return format timing, requires tclk to be rl and multiple of 1
+          # tester.pinformat = 'func_25mhz,tclk,rl'
+          # tester.pintiming = 'func_25mhz,tdi,0,tms,0,tdo,1'
+        end
+        tester.set_timeset('func_25mhz', 40)   # Where 40 is the period in ns
+        tester.wait time_in_us: 100
+      end
+    end
+
+    def shutdown(options)
+      pp 'Reset the device' do
+        pin(:resetb).drive!(0)
+        pin(:tclk).drive!(0)
+      end
+      # if tester.link?
+      if tester.to_s == 'OrigenLink::VectorBased'
+        tester.finalize_pattern
+      end
+    end
+  end
+end

data/lib/origen_link/test/vector_based_redefs.rb

@@ -0,0 +1,17 @@
+module OrigenLink
+  class VectorBased
+    attr_accessor :message, :microcodestr, :test_response
+
+    def send_cmd(cmdstr, argstr)
+      @message = cmdstr + ':' + argstr
+      @test_response
+    end
+
+    def setup_cmd_response_logger(command, response)
+    end
+
+    def microcode(msg)
+      @microcodestr = @microcodestr + msg
+    end
+  end
+end