origen_core_support 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 450f254bcce1cbb983a3e312dfcbe9bf8d987cbc
+  data.tar.gz: dd5d7cd86dbde165b06ad48550e47c23d4662947
+SHA512:
+  metadata.gz: 6a9104bff352b49212e88736de8b1bde67872ab75d17d6f63fc6566ec4a6a7d148eab62d54e59cd99a41bd938575c5f13d0c49b1f8c4f4da8464058bf27671f9
+  data.tar.gz: 7c04b014230c5e038d50d1180cda80975cf14e8a3c7bf8d8fa38a13237a5f19e5ef10fc78224fc78bf76e370d7f60a4a0e2914d07de101509628f4b7eb2739cc

data/config/application.rb

@@ -0,0 +1,55 @@
+class OrigenCoreSupportApplication < Origen::Application
+  config.semantically_version = true
+
+  # This information is used in headers and email templates, set it specific
+  # to your application
+  config.name     = "Origen Core Support"
+  config.initials = "OrigenCoreSupport"
+  config.rc_url   = "ssh://git@github.com:Origen-SDK/origen_core_support.git"
+  config.shared   = {
+    :patterns => "pattern/shared",
+    :command_launcher => "config/shared_commands.rb",
+    #:templates => "templates",
+    #:programs => "program"
+  }
+
+  # Versioning is based on a timestamp by default, if you would rather use semantic
+  # versioning, i.e. v1.0.0 format, then set this to true.
+  # In parallel go and edit config/version.rb to enable the semantic version code.
+  #config.semantically_version = true
+
+  # You can map moo numbers to targets here, this allows targets to be selected via
+  # origen t <moo>
+  #config.production_targets = {
+  #  "1m79x" => "pioneer_1_production",
+  #}
+
+  # Specify a specific version of origen that must be used with this application, origen
+  # will then enforce that every user's origen version is correct at runtime
+  #config.required_origen_version = "v2.0.0"
+
+  # 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
+
+end

data/config/commands.rb

@@ -0,0 +1,39 @@
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/origen/commands.rb in your Origen core workspace for more examples and 
+# inspiration.
+
+# Map any command aliases here, for example to allow origen -x to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "-x" => "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 "execute"
+  puts "Executing something..."
+  require "commands/execute"    # Would load file lib/commands/execute.rb
+  # You must always exit upon successfully capturing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+# You probably want to also add the command details 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.
+else
+#  @application_commands = <<-EOT
+# execute      Execute something I guess
+#  EOT
+  require "#{Origen.app_root}/config/shared_commands"
+end 

data/config/environment.rb

@@ -0,0 +1,19 @@
+# This file will be required by Origen before your target is loaded, you 
+# can use this to require all of your files, which is the easiest way
+# to get started. As your experience grows you may wish to require only the
+# minimum files required to allow the target to be initialized and let 
+# each class require its own dependencies.
+#
+# It is recommended that you keep all of your application logic in lib/
+# The lib directory has already been added to the search path and so any files
+# in there can be referenced from here with a relative path.
+#
+# Note that pattern files do not need to be referenced from here and these
+# will be located automatically by origen.
+
+#autoload :Pioneer,   "pioneer"   # Only loads the file whenever Pioneer is referenced
+#require "pioneer"                # Loads the file always
+
+require "c99/soc"
+require "c99/nvm"
+require "c99/block"

data/config/shared_commands.rb

@@ -0,0 +1,32 @@
+# This file is created to share commands of this plugin to any app that imports it.
+
+# Map any command aliases here, for example to allow origen -x to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+
+}
+
+# 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
+# in here or you can require an external file if preferred.
+when "test"
+  require "commands/test_command"
+  exit 0
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+# You probably want to also add the command details 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.
+else
+  @plugin_commands ||= []
+  @plugin_commands = @plugin_commands + 
+  [
+" test         Test command from plugin core_support plugin"
+  ]
+end 
+

data/config/users.rb

@@ -0,0 +1,22 @@
+# This file defines the users associated with your project, it is basically the
+# mailing list for release notes.
+#
+# 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 "origen tag" task, but this is
+# really just to prevent a casual user from executing it inadvertently and is
+# not intended to be a serious security gate.
+module Origen
+  module Users
+    def users
+      @users ||= [
+
+       # Admins
+        User.new("Stephen McGinty", "r49409", :admin),
+
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/lib/c99/block.rb

@@ -0,0 +1,19 @@
+module C99
+  class Block
+    attr_accessor :id, :selected
+
+    def initialize(id, owner)
+      @id = id
+      @selected = false
+      @owner = owner
+    end
+
+    def select
+      @selected = true
+    end
+
+    def owner
+      @owner
+    end
+  end
+end

data/lib/c99/nvm.rb

@@ -0,0 +1,37 @@
+module C99
+  class NVM
+
+    attr_accessor :blocks
+
+    include Origen::Pins
+    include Origen::Registers
+
+    def initialize
+
+      add_reg :mclkdiv,   0x03,  16,  :osch       => { :pos => 15 },
+                                      :asel       => { :pos => 14 },
+                                      :failctl    => { :pos => 13 },
+                                      :parsel     => { :pos => 12 },
+                                      :eccen      => { :pos => 11 },
+                                      :cmdloc     => { :pos => 8, :bits => 3, :res => 0b001 },
+                                      :clkdiv     => { :pos => 0, :bits => 8, :res => 0x18 }
+
+      add_reg :data,      0x4,   16,  :d          => { :pos => 0, :bits => 16 }
+
+      @blocks = [Block.new(0, self), Block.new(1, self), Block.new(2, self)]
+    end
+
+    def find_block_by_id(id)
+      @blocks.select{ |block| block.id == id }.first
+    end
+
+    def override_method
+      :original
+    end
+
+    def reg_owner_alias
+      ["flash", "fmu"]
+    end
+
+  end
+end

data/lib/c99/soc.rb

@@ -0,0 +1,80 @@
+module C99
+  class SOC
+    include Origen::Callbacks
+    include Origen::Pins
+    include Origen::TopLevel
+
+    def initialize
+
+      add_pin  :reset,   :reset => :drive_hi,  :name => "nvm_reset"
+      add_pin  :clk,     :reset => :drive_hi,  :name => "nvm_clk"
+      add_pin  :clk_mux, :reset => :drive_hi,  :name => "nvm_clk_mux"
+      add_port :porta,   :reset => :drive_lo,  :size => 8
+      add_port :portb,   :reset => :drive_lo,  :size => 8, :endian => :little
+      add_pin  :invoke,  :reset => :drive_lo,  :name => "nvm_invoke"
+      add_pin  :done,    :reset => :expect_hi, :name => "nvm_done"
+      add_pin  :fail,    :reset => :expect_lo, :name => "nvm_fail"
+      add_pin  :alvtst,  :reset => :dont_care, :name => "nvm_alvtst"
+      add_pin  :ahvtst,  :reset => :dont_care, :name => "nvm_ahvtst"
+      add_pin  :dtst,    :reset => :dont_care, :name => "nvm_dtst"
+
+      add_pin :tclk, :reset => :drive_lo
+      add_pin :trst, :reset => :drive_hi
+
+      add_pin_alias :extal,     :clk
+      add_pin_alias :extal_mux, :clk_mux
+      add_pin_alias :tms,       :done
+      add_pin_alias :tdo,       :fail
+      add_pin_alias :tdi,       :invoke
+      add_pin_alias :resetb,    :ahvtst
+
+      add_pin_alias :pa5, :porta, :pin => 5
+      add_pin_alias :pa_lower, :porta, :pins => [3..0]
+      add_pin_alias :pa_upper, :porta, :pins => [7,6,5,4]
+      add_port_alias :porta_alias, :porta
+
+      @a = 2
+    end
+
+    def startup(options)
+      if options[:add_additional_pins]
+        add_pin :late_added_pin, :reset => :drive_hi
+      else
+        # Test that rendering some vectors from a template works...
+        if $tester.is_a?(Origen::Tester::J750) || $tester.is_a?(Testers::J750)
+          $tester.render("#{Origen.root}/pattern/j750/_mode_entry.atp.erb", :hold_cycles => 5)
+        end
+      end
+      $tester.set_timeset("nvmbist", 40) if $tester.is_vector_based?
+    end
+
+    def has_margin0_bug?
+      false
+    end
+
+    def write_register(reg, options={})
+      reg
+    end
+
+    def read_register(reg, options={})
+      reg
+    end
+
+    def base_address(reg, options={})
+      if reg.owned_by?(:nvm)
+        0x4000_0000
+      else
+        0
+      end
+    end
+
+    def origen_dot_root
+      Origen.root
+    end
+
+    def origen_dot_root!
+      Origen.root!
+    end
+
+  end
+end

data/lib/commands/test_command.rb

@@ -0,0 +1,18 @@
+puts <<-EOT
+This is a test command to test the command sharing capability of plugins.
+
+You can now write commands in plugins which can be called from any app that
+includes the plugin.
+
+For the app to add your command in it's own command list, share your shared_commands.rb file in
+config.shared hash as follows:
+
+config.shared = {
+
+  :command_launcher => "config/shared_commands.rb"
+
+}
+
+EOT
+
+

data/lib/origen_core_support.rb

@@ -0,0 +1,2 @@
+require_relative "../config/application.rb"
+require_relative "../config/environment.rb"

data/pattern/shared/j750/j750_halt.rb

@@ -0,0 +1,159 @@
+# This pattern exercises the methods in the Origen::Tester::J750 class
+Pattern.create(:end_with_halt => true) do
+
+  ss "Test that basic cycling works"
+  $tester.cycle
+  10.times do
+    $nvm.pin(:invoke).drive(1)
+    $tester.cycle
+  end
+  10.times do |i|
+    $nvm.pin(:invoke).drive(i.even? ? 0 : 1)
+    $tester.cycle
+  end
+
+  ss "Test that basic port manipulation works"
+  if !$tester.respond_to?('hpt_mode')
+  $nvm.port(:porta).drive(0x55)
+  $tester.cycle
+  $nvm.port(:porta).expect(0xAA)
+  $tester.cycle
+  $nvm.port(:porta)[1].dont_care
+  $tester.cycle
+  end
+
+  ss "Test that the store method works"
+  cc "This vector should be stored"
+  $tester.cycle
+  $tester.store
+  $tester.cycle
+  cc "This vector should be stored"
+  $tester.cycle
+  $tester.cycle
+  $tester.cycle
+  $tester.store(:offset => -2)
+
+  ss "Test calling a subroutine"
+  cc "This vector should call subroutine 'sub1'"
+  $tester.cycle
+  $tester.call_subroutine("sub1")
+  cc "This vector should call subroutine 'sub2'"
+  $tester.cycle
+  $tester.cycle
+  $tester.call_subroutine("sub2", :offset => -1)
+  cc "This vector should call subroutine 'sub3', however because"
+  cc "it is local it should not appear in the imports in the header"
+  $tester.cycle
+  $tester.call_subroutine("sub3")
+
+  ss "Test generating a handshake inside a subroutine"
+  cc "The next line should have a global label 'sub3', but no vector"
+  $tester.start_subroutine("sub3")
+  $tester.handshake
+  cc "This vector should have a return statement"
+  $tester.cycle
+  $tester.end_subroutine
+
+  ss "Test generating a handshake with a readcode"
+  $tester.handshake(:readcode => 10)
+
+  ss "Test frequency counter"
+  $tester.freq_count($nvm.pin(:dtst), :readcode => 33)
+
+  ss "Test a single pin match loop"
+  $tester.wait(:match => true, :time_in_us => 5000, :pin => $nvm.pin(:done), :state => :high)
+
+  ss "Test a two pin match loop"
+  $tester.wait(:match => true, :time_in_us => 5000,
+               :pin => $nvm.pin(:done), :state => :high,
+               :pin2 => $nvm.pin(:fail), :state2 => :low)
+
+  ss "Test adding an arbitrary label"
+  $tester.cycle
+  $tester.label "a_test_label"  
+  $tester.cycle
+
+  ss "Test calling a match loop"
+  $tester.cycle
+  $tester.call_match
+  $tester.cycle
+  $tester.call_match
+
+  ss "Test setting the readcode to 100"
+  $tester.set_code(100)
+
+  ss "Test explicit branching"
+  $tester.branch_to("somewhere")
+
+  if !$tester.respond_to?('hpt_mode')
+  ss "Test looping, these vectors should be executed once"
+  $tester.loop_vector("test_loop_1", 1) do
+    $nvm.port(:porta).drive(0xAA)
+    $tester.cycle
+    $nvm.port(:porta).drive(0x55)
+    $tester.cycle
+  end
+
+  ss "Test looping, these vectors should be executed 3 times"
+  $tester.loop_vector("test_loop_2", 3) do
+    $nvm.port(:porta).drive(0xAA)
+    $tester.cycle
+    $nvm.port(:porta).drive(0x55)
+    $tester.cycle
+    end
+  else
+    ss "Test looping, these vectors should be executed once"
+    $tester.loop_vector("test_loop_1", 1) do
+      $nvm.pin(:clk).drive(1)
+      $tester.cycle
+      $nvm.pin(:clk).drive(0)
+      $tester.cycle
+    end
+  
+    ss "Test looping, these vectors should be executed 3 times"
+    $tester.loop_vector("test_loop_2", 3) do
+      $nvm.pin(:clk).drive(1)
+      $tester.cycle
+      $nvm.pin(:clk).drive(0)
+      $tester.cycle
+    end
+  end
+
+  ss "Test repeat_previous"
+  $tester.cycle
+  cc "Invoke should repeat previous for 10 cycles"
+  $nvm.pin(:invoke).repeat_previous = true
+  10.cycles
+  $nvm.pin(:invoke).repeat_previous = false
+  cc "All pins should repeat previous for 10 cycles, except the clk pin"
+  $tester.repeat_previous do
+    $nvm.pin(:clk).drive(1)
+    10.cycles
+  end
+  cc "All should return to the original state"
+  $tester.cycle
+
+  ss "Test suspend compares"
+  $nvm.pin(:fail).assert!(1)
+  cc "The fail pin should not be compared on these vectors"
+  $tester.ignore_fails($nvm.pin(:fail)) do
+    10.cycles
+  end
+  cc "And now it should"
+  $tester.cycle
+
+  ss "Test inhibit vectors and comments"
+  cc "The invoke pin should be driving high on this cycle"
+  $nvm.pin(:invoke).drive!(1)
+  cc "This should be the last thing you see until 'Inhibit complete!'"
+  $tester.inhibit_vectors_and_comments do
+    cc "This should not be in the output file, or the following vectors"
+    $tester.cycle
+    $nvm.pin(:invoke).drive!(0)
+    10.cycles
+  end
+  cc "Inhibit complete!"
+  cc "The invoke pin should be driving low on this cycle"
+  $tester.cycle
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: origen_core_support
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stephen.f.mcginty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/commands.rb
+- config/environment.rb
+- config/shared_commands.rb
+- config/users.rb
+- config/version.rb
+- lib/c99/block.rb
+- lib/c99/nvm.rb
+- lib/c99/soc.rb
+- lib/commands/test_command.rb
+- lib/origen_core_support.rb
+- pattern/shared/j750/j750_halt.rb
+homepage: 
+licenses:
+- LGPL-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple plugin that is used to test the Origen SDK plugin system
+test_files: []