origen 0.44.0 → 0.50.0

data/origen_app_generators/templates/app_generators/application/config/application.rb

@@ -1,20 +1,19 @@
 require 'origen'
 class <%= @namespace %>Application < 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       = "<%= @name %>"
-  self.namespace  = "<%= @namespace %>"
-  config.name     = "<%= @name %>"
-  config.initials = "<%= @namespace %>"
+  self.name       = '<%= @name %>'
+  self.namespace  = '<%= @namespace %>'
+  config.name     = '<%= @name %>'
+  config.initials = '<%= @namespace %>'
   # Change this to point to the revision control repository for this <%= @type %>
 <% if @audience == :external -%>
-  #config.rc_url   = "ssh://git@github.com:myaccount/<%= @name %>.git" 
+  # config.rc_url   = "ssh://git@github.com:myaccount/<%= @name %>.git"
 <% else -%>
-  #config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
+  # config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
 <% end -%>
 <% if @audience == :external -%>
   config.release_externally = true
@@ -23,11 +22,11 @@ class <%= @namespace %>Application < Origen::Application
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
 <% if @audience == :external -%>
-  #config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/<%= @name %>"
-  #config.web_domain = "http://origen-sdk.org/<%= @name %>"
+  # config.web_directory = 'git@github.com:Origen-SDK/Origen-SDK.github.io.git/<%= @name %>'
+  # config.web_domain = 'http://origen-sdk.org/<%= @name %>'
 <% else -%>
-  #config.web_directory = "/path/to/server/<%= @name %>"
-  #config.web_domain = "http://origen.mycompany.net/<%= @name %>"
+  # config.web_directory = '/path/to/server/<%= @name %>'
+  # config.web_domain = 'http://origen.mycompany.net/<%= @name %>'
 <% end -%>
 
   # When false Origen will be less strict about checking for some common coding errors,
@@ -38,76 +37,74 @@ class <%= @namespace %>Application < Origen::Application
   # 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,
+    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,
+    auto_correct: true,
     # Run on these directories/files by default
-    #files: ["lib", "config/application.rb"],
+    files:        ['app', 'config/application.rb']
   }
 
   config.semantically_version = true
 
   # An example of how to set application specific LSF parameters
-  #config.lsf.project = "msg.te"
-  
+  # config.lsf.project = "msg.te"
+
   # An example of how to specify a prefix to add to all generated patterns
-  #config.pattern_prefix = "nvm"
+  # 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
+  # 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
+  # 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
- 
+  # 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
-<% if @validate_release_tests %>  
+  # def after_release_email(tag, note, type, selector, options)
+  #   command = "origen web compile --remote --api"
+  #   Dir.chdir Origen.root do
+  #     system command
+  #   end
+  # end
+<% if @validate_release_tests -%>
   # Ensure that all tests pass before allowing a release to continue
   def validate_release
     if <%= Array(@validate_release_tests).map { |t| "!system('#{t}')" }.join(' || ') %>
       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!"
+      puts 'All tests passing, proceeding with release process!'
     end
   end
-<% else %>
+<% else -%>
   # 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
+  # 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
 <% 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
+  # 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:
@@ -115,11 +112,10 @@ class <%= @namespace %>Application < Origen::Application
   #
   # 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 
+  # 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
-
+  # config.pattern_name_translator do |name|
+  #   name.gsub(/_b\d/, "_bx")
+  # end
 end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/config/load_generators.rb

@@ -2,5 +2,5 @@
 # 'origen new' command, it must not be removed or modified
 require 'origen_app_generators'
 require "<%= @name %>"
-template_dir = File.expand_path('../../templates/app_generators', __FILE__)
+template_dir = File.expand_path('../../app/templates/app_generators', __FILE__)
 OrigenAppGenerators.add_generators(<%= @namespace %>::AVAILABLE, template_dir: template_dir)

data/origen_app_generators/templates/app_generators/plugin/Gemfile

@@ -13,14 +13,17 @@ source 'https://rubygems.org'
 # your application's test coverage
 gem 'coveralls', require: false
 <% end -%>
-gem 'byebug', '<9.1.0' # This version restriction required if you need Ruby < 2.2, otherwise you can remove it
+gem 'byebug', '~>8'  # You can remove this version constraint if you don't care about your app
+                     # supporting earlier versions of Ruby 2
 gem 'ripper-tags'
 gem 'origen_doc_helpers'
-gem 'origen_updater'
+
 # Uncomment these if you want to use a visual debugger (e.g. Visual Studio Code) to debug your app
 #gem 'ruby-debug-ide'
 #gem 'debase'
 
+gem 'origen', git: 'https://github.com/Origen-SDK/origen.git', branch: 'app_dir'
+
 # Specify your gem's runtime dependencies in <%= @name %>.gemspec
 # THIS LINE SHOULD BE LEFT AT THE END
 gemspec

data/origen_app_generators/templates/app_generators/plugin/gemspec.rb

@@ -21,11 +21,12 @@ Gem::Specification.new do |spec|
   # packaged gem, the default should hit everything in most cases but this will
   # need to be added to if you have any custom directories
   spec.files         = Dir["lib/<%= @name %>.rb", "lib/<%= @name %>/**/*.rb", "templates/**/*", "config/**/*.rb",
-                           "bin/*", "lib/tasks/**/*.rake", "pattern/**/*.rb",
-                           "program/**/*.rb"
+                           "bin/*", "lib/tasks/**/*.rake", "pattern/**/*.rb", "program/**/*.rb",
+                           "app/lib/**/*.rb", "app/templates/**/*",
+                           "app/patterns/**/*.rb", "app/flows/**/*.rb", "app/blocks/**/*.rb"
                           ]
   spec.executables   = []
-  spec.require_paths = ["lib"]
+  spec.require_paths = ["lib", "app/lib"]
 
   # Add any gems that your plugin needs to run within a host application
   spec.add_runtime_dependency "origen", ">= <%= @latest_origen_version %>"

data/origen_site_config.yml

@@ -50,13 +50,6 @@ centralized_site_config_verify_ssl: true
 # user (recommended)
 gem_manage_bundler: true
 
-# Use the bootsnap gem (https://github.com/Shopify/bootsnap) to speed up the boot time of
-# your Origen applications. 
-# This creates an offline cache in your app's tmp/cache directory and it can also increase
-# the memory consumption of your app. As a reward, your app will load Ruby files significantly
-# faster, often taking many seconds off the time it takes your app to start up.
-use_bootsnap: false
-
 # WORKSPACE DIRECTORY SETUP
 
 # Defines where the home directory is

data/templates/code_generators/attributes.rb

@@ -0,0 +1,20 @@
+# ********************************************************************************
+# Any attributes defined in this file be added to <%= @fullname %>
+<% unless @nested -%>
+# and all of its derivatives (if any).
+<% end -%>
+# ********************************************************************************
+
+# To define an attribute simply declare instance variables and assign their
+# values as shown below.
+# Derivative classes will automatically inherit the values defined here unless
+# they are overridden by a derivative attribute file.
+#
+# @address_width = 32
+# @has_feature_x = true
+#
+# Accessors will automatically be created for any attributes defined in this file:
+#
+#   dut.address_width   # => 32
+#   dut.has_feature_x   # => true
+#   dut.has_feature_x?  # => true  <attribute>? methods are also added for booleans

data/templates/code_generators/class.rb

@@ -0,0 +1,9 @@
+# If this class gets too big you may want to split it up into modules, run the following
+# command to add a module to it:
+#
+#   origen new module my_module_name <%= Pathname.new(resource_path_to_lib_file(@resource_path)).relative_path_from(Origen.root) %>
+#
+class <%= @namespaces.map { |n| camelcase(n[1]) }.join('::') %>::<%= camelcase(@name) %><%= @parent_class ? " < #{@parent_class}" : '' %>
+  def initialize(options = {})
+  end
+end

data/templates/code_generators/controller.rb

@@ -0,0 +1,87 @@
+# If this class gets too big you may want to split it up into modules, run the following
+# command to add a module to it:
+#
+<% if @block -%>
+#   origen new module <%= Pathname.new(resource_path_to_blocks_dir(@resource_path)).relative_path_from(Origen.root) %>/controller.rb my_module_name
+<% else -%>
+#   origen new module <%= Pathname.new(resource_path_to_lib_file(@resource_path)).relative_path_from(Origen.root) %> my_module_name
+<% end -%>
+#
+class <%= @namespaces.map { |n| camelcase(n[1]) }.join('::') %>::<%= camelcase(@name) %>Controller<%= @parent_class ? " < #{@parent_class}Controller" : '' %>
+<% if @root_class -%>
+  include Origen::Controller
+
+<% end -%>
+
+  # If implemented, this method will be called automatically at the start of every pattern.
+<% if @top_level -%>
+  # Since this is the top-level/DUT controller, it will be called first and it is normally used
+  # to define a mode entry sequence.
+<% else-%>
+  # Since this is a sub-block controller, it will be called after the top-level/DUT controller's
+  # startup method, though the calling order with relation to other sub-blocks is undefined.
+<% end -%>
+  # Any option arguments passed into Pattern.create will be passed into here.
+  # def startup(options = {})
+  #   tester.set_timeset('func', 100)
+  # end
+<% if @top_level -%>
+
+  # If implemented, this method will be called automatically at the start of every simulation.
+  # If the simulation run contains multiple patterns run back to back, then this method will
+  # be called only once at the very start, and then the startup method will be called multiple
+  # as it is invoked before each individual pattern.
+  # def simulation_startup(options = {})
+  #   tester.set_timeset('func', 100)
+  # end
+
+  # If implemented, this method will be called automatically at the start of every interactive
+  # console session (origen i). It is commonly used to startup the simulator if the tester is
+  # an OrigenSim driver as shown in the example below.
+  # def interactive_startup(options = {})
+  #   tester.start if tester.sim?
+  # end
+<% end -%>
+
+  # All requests to read a register will be passed in here, this is where you define
+  # how registers should be read (e.g. via JTAG) for this particular DUT
+  def read_register(reg, options = {})
+<% if @root_class -%>
+<% if @top_level -%>
+    Origen.log.error "A request was made to read register #{reg.name}, but the controller method has not been implemented yet!"
+<% else-%>
+    # Pass this to the DUT by default, if you need a special implementation or if you wish
+    # to pass some meta-data to the DUT about how to handle registers from this sub-block
+    # then you can do so here
+    dut.read_register(reg, options)
+<% end -%>
+<% else-%>
+    # super means that the read register request will get passed onto the parent class's
+    # read_register method - i.e. the one defined in <%= @parent_class %>Controller.
+    # If you want to override that and add a specific implementation for this DUT type,
+    # then simply delete the super below and add the code you wish to handle the request.
+    super
+<% end -%>
+  end
+
+  # All requests to write a register will be passed in here, this is where you define
+  # how registers should be written (e.g. via JTAG) for this particular DUT
+  def write_register(reg, options = {})
+<% if @root_class -%>
+<% if @top_level -%>
+    Origen.log.error "A request was made to write register #{reg.name}, but the controller method has not been implemented yet!"
+<% else -%>
+    # Pass this to the DUT by default, if you need a special implementation or if you wish
+    # to pass some meta-data to the DUT about how to handle registers from this sub-block
+    # then you can do so here
+    dut.write_register(reg, options)
+<% end -%>
+<% else-%>
+    # super means that the write register request will get passed onto the parent class's
+    # write_register method - i.e. the one defined in <%= @parent_class %>Controller.
+    # If you want to override that and add a specific implementation for this DUT type,
+    # then simply delete the super below and add the code you wish to handle the request.
+    super
+<% end -%>
+  end
+end

data/templates/code_generators/model.rb

@@ -0,0 +1,21 @@
+# If this class gets too big you may want to split it up into modules, run the following
+# command to add a module to it:
+#
+<% if @block -%>
+#   origen new module <%= Pathname.new(resource_path_to_blocks_dir(@resource_path)).relative_path_from(Origen.root) %>/model.rb my_module_name
+<% else -%>
+#   origen new module <%= Pathname.new(resource_path_to_lib_file(@resource_path)).relative_path_from(Origen.root) %> my_module_name
+<% end -%>
+#
+class <%= @namespaces.map { |n| camelcase(n[1]) }.join('::') %>::<%= camelcase(@name) %><%= @parent_class ? " < #{@parent_class}" : '' %>
+<% if @root_class -%>
+<% if @top_level -%>
+  include Origen::TopLevel
+<% else -%>
+  include Origen::Model
+<% end -%>
+
+<% end -%>
+  def initialize(options = {})
+  end
+end

data/templates/code_generators/module.rb

@@ -0,0 +1,4 @@
+module <%= @namespaces.map { |n| camelcase(n[1]) }.join('::') %>::<%= camelcase(@name) %>
+  # def my_method
+  # end
+end

data/templates/code_generators/parameters.rb

@@ -0,0 +1,19 @@
+# ********************************************************************************
+# Any parameters defined in this file be added to <%= @fullname %>
+# and all of its derivatives (if any).
+# ********************************************************************************
+
+# For more examples see: https://origen-sdk.org/origen/guides/models/parameters/
+
+# Example of how to define a default parameters set
+# define_params :default do |params|
+#   params.tread = 40.nS
+#   params.tprog = 20.uS
+#   params.terase = 100.mS
+# end
+
+# Example of how to inherit and modify the defaults to create an alternative parameters set
+# define_params :probe, inherit: :default do |params, parent|
+#   params.tprog = parent.tprog / 2
+#   params.terase = 20.mS
+# end

data/templates/code_generators/pins.rb

@@ -0,0 +1,28 @@
+# ********************************************************************************
+# Any pins defined in this file will be added to <%= @fullname %>
+# and all of its derivatives (if any).
+# ********************************************************************************
+
+# For more examples see: https://origen-sdk.org/origen/guides/models/pins/
+
+# Example of how to import a pins file extracted by 'origen sim:build' and copied to your app's
+# vendor/ directory (my_file_name will be the name of the file without the .rb extension)
+# import 'my_file_name', dir: "#{Origen.root!}/vendor/wherever/i/like", namespace: nil
+
+# Examples of how to add pins
+# add_pin :tck, reset: :drive_hi, meta: { max_freq: 15.Mhz }
+# add_pin :tdi, direction: :input
+# add_pin :tdo, direction: :output
+# add_pin :tms
+
+# Examples of how to add sized pin groups
+# add_pins :porta, size: 32
+# add_pins :portb, size: 16, endian: :little
+
+# Example of how to declare ad-hoc pin groups (the pins themselves must already have been added)
+# add_pin_group :jtag, :tdi, :tdo, :tck, :tms
+#
+# Examples of how to create pin aliases
+# add_pin_alias :old_name, :new_name
+# add_pin_group_alias :old_name, :new_name
+# add_pin_group_alias :data_byte0, :porta, pins: [7..0]

data/templates/code_generators/registers.rb

@@ -0,0 +1,20 @@
+# ********************************************************************************
+# Any registers defined in this file will be added to <%= @fullname %>
+<% unless @nested -%>
+# and all of its derivatives (if any).
+<% end -%>
+# ********************************************************************************
+
+# For more examples see: https://origen-sdk.org/origen/guides/models/registers/
+
+# Example of basic definition of a register at address 0x1000 with all bits R/W
+# add_reg :data, 0x1000             # 32-bit by default
+# add_reg :data, 0x1000, size: 16
+
+# Example of a regular definition which defines individual bits
+# reg :ctrl, 0x0024, size: 16 do |reg|
+#   reg.bit 7, :coco, access: :ro
+#   reg.bit 6, :aien
+#   reg.bit 5, :diff
+#   reg.bit 4..0, :adch, reset: 0x1F
+# end

data/templates/code_generators/sub_blocks.rb

@@ -0,0 +1,24 @@
+# ********************************************************************************
+# Any sub-blocks defined in this file will be added to <%= @fullname %>
+<% unless @nested -%>
+# and all of its derivatives (if any).
+<% end -%>
+# ********************************************************************************
+
+# If you want to add a nested sub-block to this block then run the following command,
+# replacing my_sub_block_name with the name of your sub-block:
+#   origen new block <%= Pathname.new(resource_path_to_blocks_dir(@resource_path)).relative_path_from(Origen.root) %> my_sub_block_name
+#
+# If instead you want to add a primary sub-block (one which supports derivatives and
+# inheritance then create one using the following command and then instantiate it
+# manually below:
+#   origen new block my_sub_block_type/my_sub_block_name
+
+# For more examples see: https://origen-sdk.org/origen/guides/models/defining/#Adding_Sub_Blocks
+
+# Examples
+# sub_block :nvm                                      # An empty sub-block
+# sub_block :nvm, base_address: 0x1000_0000           # How to define the sub-block's address
+# sub_block :nvm, load_block: 'features/memory'       # Add the definitions from the given block(s)
+# sub_block :nvm, load_block: ['features/memory', 'features/testable']
+# sub_block :nvm, class_name: 'MyApp::NVM::Flash2K'   # Instantiate it as an instance of the given class

data/templates/code_generators/timesets.rb

@@ -0,0 +1,24 @@
+# ********************************************************************************
+# Any timesets defined in this file will be added to <%= @fullname %>
+# and all of its derivatives (if any).
+# ********************************************************************************
+
+# For more examples see: https://origen-sdk.org/origen/guides/pattern/timing/#Complex_Timing
+
+# By default, all pins will drive for the whole period on drive cycles and strobe at 50%
+# of the period on compare cycles, this can be overridden for all or specific pins as shown
+# in the examples below.
+
+# Example definition, defines an alternative default compare wave for all pins and specific
+# drive timing for :tck
+# timeset :func do |t|
+#   t.compare_wave do |w|
+#     w.compare :data, at: "period / 4"
+#   end
+#
+#   t.drive_wave :tck do |w|
+#      w.drive :data, at: 0
+#      w.drive 0, at: 25
+#      w.dont_care at: "period - 10"  # Just to show that dont_care can be used
+#   end
+# end

data/templates/code_generators/version.rb

@@ -3,6 +3,5 @@ module <%= Origen.app.namespace %>
   MINOR = <%= @version.minor %>
   BUGFIX = <%= @version.bugfix %>
   DEV = <%= @version.pre || "nil" %>
-
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end