origen 0.38.0 → 0.40.0

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/application.rb

@@ -0,0 +1,54 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your application generators, it provides a place
+  # to add anything that you want to be added to all of your applications
+  class Application < OrigenAppGenerators::Application
+    include Base
+
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your application generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your application
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your applications.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # Example of how to add a file, in this case the file will be compiled and copied to
+        # the same location in the new app
+        # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+        # Alternatively specifying a different destination, typically you would do this when
+        # the final location is dynamic
+        # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        # Example of how to recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/base.rb

@@ -0,0 +1,55 @@
+module <%= @namespace %>
+  # This is a mixin that is included in both the application and plugin
+  # generators, it provides a place to add things that should apply to
+  # all of your applications and plugins
+  module Base
+    # Any helper methods added to this base module will not be automatically invoked,
+    # you must call them from either the top-level application or plugin generators,
+    # or from a child generator.
+
+    protected
+
+    # Here you can modify the default list of files that are included in all of your
+    # applications AND plugins.
+    #
+    # See here for the default list of files:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # If the child generator is a plugin, then this list is then modified by the base plugin generator which
+    # you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new application.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generators, this means that your generator will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # Example of how to add a file, in this case the file will be compiled and copied to
+        # the same location in the new app
+        # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+        # Alternatively specifying a different destination, typically you would do this when
+        # the final location is dynamic
+        # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        # Example of how to recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                           dest:   'target/default.rb', # Relative to destination_root
+        #                           type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/module.rb

@@ -0,0 +1,28 @@
+require 'origen_app_generators'
+require '<%= @name %>/base'
+require '<%= @name %>/application'
+require '<%= @name %>/plugin'
+
+module <%= @namespace %>
+  # Define test sets of inputs to test your generators. The last item in each array is
+  # required and always indicates what action should be taken once the application has
+  # been built. nil means take no action, :default means to run a default set of test
+  # operations, and an array of Origen command strings gives you control of exactly
+  # what to run.
+  #
+  # These inputs can be executed individually by running 'origen app_gen:test -i INDEX',
+  # where INDEX is the index number of the set you want to execute from the TEST_INPUTS
+  # array.
+  #
+  # You can also execute all sets of test inputs by running: 'origen app_gen:test -r'
+  TEST_INPUTS = [
+  ] # END_OF_TEST_INPUTS Don't remove this comment, it is used by the app_gen:new command!
+
+  # As you add new generators to this app they will be entered here, this enables the
+  # mechanism to register them with the 'origen new' command.
+  # You should generally not modify this by hand, instead use the 'origen app_gen:new'
+  # command every time you want to create a new generator, and this will be filled in
+  # for you.
+  AVAILABLE = {
+  }
+end

data/origen_app_generators/templates/app_generators/origen_infrastructure/app_generator_plugin/lib/plugin.rb

@@ -0,0 +1,64 @@
+module <%= @namespace %>
+  # This will be the parent class of all of your plugin generators, it provides a place
+  # to add anything that you want to be added to all of your plugins
+  class Plugin < OrigenAppGenerators::Plugin
+    include Base
+
+    def initialize(*args)
+      # This makes all of your plugins be configured for internal distribution, i.e. rather
+      # than via rubygems.org
+      @audience = :internal
+      super
+    end
+
+    # Any methods added above the protected line will get automatically invoked
+    # at the start of *all* of your plugin generators.
+
+    protected
+
+    # You can add helper methods that you want to make available to all of your plugin
+    # generators here, these will not get called unless a child generator calls them.
+
+    # Here you can modify the default list of files that are included in all of your plugins.
+    #
+    # Since this is a plugin generator, the default list of files comprises the application list,
+    # which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+    # And this is then modified by the base plugin generator which you can see here:
+    # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb
+    #
+    # The filelist can contain references to generate files, directories or symlinks in the
+    # new plugin.
+    #
+    # To make your generators more maintainable, try and re-use as much as possible
+    # from the parent generator, this means that your generators will automatically stay up
+    # to date with the latest conventions.
+    #
+    # Additional files can be added or removed from the filelist as shown below.
+    def filelist
+      @filelist ||= begin
+        list = super  # Always pick up the parent list
+        # Example of how to remove a file from the parent list
+        # list.delete(:web_doc_layout)
+        # Example of how to add a file, in this case the file will be compiled and copied to
+        # the same location in the new app
+        # list[:config_shared_commands] = { source: 'config/shared_commands.rb' }
+        # Alternatively specifying a different destination, typically you would do this when
+        # the final location is dynamic
+        # list[:gemspec] = { source: 'gemspec.rb', dest: "#{@name}.gemspec" }
+        # Example of how to recursively copy a directory
+        # list[:copy_dir] = { source: 'src_dir', dest: 'dest_dir', type: :directory, copy: true }
+        # Example of how to create a directory
+        # list[:pattern_dir] = { dest: "pattern", type: :directory }
+        # By default, directories created in this way will contain a .keep file, to inhibit this:
+        # list[:pattern_dir] = { dest: "pattern", type: :directory, nokeep: true }
+        # Example of how to create a symlink
+        # list[:target_default] = { source: 'debug.rb',          # Relative to the file being linked to
+        #                          dest:   'target/default.rb', # Relative to destination_root
+        #                          type:   :symlink }
+        # Remember to return the final list
+        list
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/plugin/Gemfile

@@ -0,0 +1,26 @@
+<% if (@audience != :external) && Origen.site_config.gem_server -%>
+<%   Array(Origen.site_config.gem_server).each do |server| -%>
+source '<%= server %>'
+<%   end -%>
+<% else %>
+source 'https://rubygems.org'
+<% end -%>
+
+# Only development dependencies (things your plugin needs only when it is running in its own workspace)
+# should be listed here in the Gemfile
+<% if @audience == :external -%>
+# This gem provides integration with https://coveralls.io/ to monitor
+# 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 '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'
+
+# 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/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/<%= @name %>.rake, and they will automatically
+# be available to Rake.
+#
+# Any task files found in lib/tasks/shared/*.rake will be made available to 3rd party
+# apps that use this plugin
+require "bundler/setup"
+require "origen"
+
+Origen.app.load_tasks

data/origen_app_generators/templates/app_generators/plugin/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/<%= @name %>.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 "<%= @name %>"
+
+module <%= @namespace %>Dev
+  # Example of how to explicitly require a file
+  # require "<%= @name %>_dev/my_file"
+    
+  # Load all files in the lib/<%= @name %>_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/<%= @name %>_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

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

@@ -0,0 +1,42 @@
+# coding: utf-8
+config = File.expand_path('../config', __FILE__)
+require "#{config}/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "<%= @name %>"
+  spec.version       = <%= @namespace %>::VERSION
+  spec.authors       = ["<%= User.current.name %>"]
+  spec.email         = ["<%= User.current.email %>"]
+  spec.summary       = "<%= @summary %>"
+<% if @audience == :external -%>
+  #spec.homepage      = "http://origen-sdk.org/<%= @name %>"
+<% else -%>
+  #spec.homepage      = "http://origen.mycompany.net/<%= @name %>"
+<% end -%>
+
+  spec.required_ruby_version     = '>= 2'
+  spec.required_rubygems_version = '>= 1.8.11'
+
+  # Only the files that are hit by these wildcards will be included in the
+  # 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"
+                          ]
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  # Add any gems that your plugin needs to run within a host application
+  spec.add_runtime_dependency "origen", ">= <%= @latest_origen_version %>"
+<% if @runtime_dependencies -%>  
+  <% @runtime_dependencies.each do |dep| -%>
+spec.add_runtime_dependency <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+  <% end -%>
+<% end -%>
+<% if @post_runtime_dependency_comments -%>  
+  <% @post_runtime_dependency_comments.each do |line| -%>
+# <%= line %>
+  <% end -%>
+<% end -%>
+end

data/origen_app_generators/templates/app_generators/plugin/lib/README

@@ -0,0 +1,4 @@
+This directory should include all of the code that will be required by this plugin whenever
+it is used within a 3rd party application.
+
+Any code that is only for testing, should be placed in lib/<%= @name %>_dev instead.

data/origen_app_generators/templates/app_generators/plugin/lib_dev/README

@@ -0,0 +1,5 @@
+This directory should include any code related to testing, documentation, etc., but which
+will not be required whenever this plugin is actually used within a 3rd party application.
+
+Any code that will be required when used within a 3rd party application, should be placed
+in lib/<%= @name %> instead.

data/origen_app_generators/templates/app_generators/plugin/templates/web/index.md.erb

@@ -0,0 +1,37 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# formatting like this, but in most cases that is not required.
+<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Purpose
+
+This plugin...
+
+### How To Install
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>"
+~~~
+
+or if your application is a plugin, then add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__  In the case of a plugin, you will also need to <code>require '<%= Origen.app.name %>'</code> somewhere in your environment.
+
+
+### How To Use
+
+Add quickstart documentation here...
+
+
+### How To Setup a Development Environment
+
+Describe how a developer would setup a new workspace for this plugin...
+
+% end

data/origen_app_generators/templates/app_generators/plugin/templates/web/partials/_navbar_external.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/origen_app_generators/templates/app_generators/plugin/templates/web/partials/_navbar_internal.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/Gemfile

@@ -0,0 +1,23 @@
+<% if (@audience != :external) && Origen.site_config.gem_server -%>
+<%   Array(Origen.site_config.gem_server).each do |server| -%>
+source '<%= server %>'
+<%   end -%>
+<% else %>
+source 'https://rubygems.org'
+<% end -%>
+
+gem 'origen', '>= <%= @latest_origen_version %>'
+
+gem 'origen_testers'
+
+gem 'origen_debuggers'
+
+gem 'origen_doc_helpers'
+
+gem 'byebug'
+
+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'

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/environment/j750.rb

@@ -0,0 +1 @@
+OrigenTesters::J750.new

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/environment/jlink.rb

@@ -0,0 +1 @@
+OrigenDebuggers::JLink.new

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/environment/uflex.rb

@@ -0,0 +1 @@
+OrigenTesters::UltraFLEX.new

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/environment/v93k.rb

@@ -0,0 +1 @@
+OrigenTesters::V93K.new

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block.rb

@@ -0,0 +1,23 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>
+    include Origen::Model
+
+    def initialize(options = {})
+      instantiate_registers(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_registers(options = {})
+    end
+
+    def instantiate_sub_blocks(options = {})
+<% @options[:sub_blocks].each do |name, attrs| -%>
+<%   if attrs[:instances] -%>
+      sub_block :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+<%   else -%>
+      sub_block :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+<%   end -%>
+<% end -%>
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block_controller.rb

@@ -0,0 +1,5 @@
+module <%= @namespace %>
+  class ATDController
+    include Origen::Controller
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/lib/top_level.rb

@@ -0,0 +1,33 @@
+module <%= @namespace %>
+  class <%= @options[:name] || 'TopLevel' %>
+    include Origen::TopLevel
+
+    def initialize(options = {})
+      instantiate_pins(options)
+      instantiate_registers(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_pins(options = {})
+      add_pin :tclk
+      add_pin :tdi
+      add_pin :tdo
+      add_pin :tms
+      add_pin :resetb
+      add_pins :port_a, size: 8
+    end
+
+    def instantiate_registers(options = {})
+    end
+
+    def instantiate_sub_blocks(options = {})
+<% @options[:sub_blocks].each do |name, attrs| -%>
+<%   if attrs[:instances] -%>
+      sub_block :<%= name.underscore %>, instances: <%= attrs[:instances] %>, class_name: '<%= name.camelize %>'
+<%   else -%>
+      sub_block :<%= name.underscore %>, class_name: '<%= name.camelize %>'
+<%   end -%>
+<% end -%>
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb

@@ -0,0 +1,21 @@
+module <%= @namespace %>
+  class <%= @options[:name] || 'TopLevel' %>Controller
+    include Origen::Controller
+
+    def startup(options)
+      pp 'Enter test mode' do
+        tester.set_timeset('func_25mhz', 40)   # Where 40 is the period in ns
+        pin(:tclk).drive!(1)
+        pin(:resetb).drive!(1)
+        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
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/pattern/example.rb

@@ -0,0 +1,4 @@
+Pattern.create do
+  # Call controller methods from here...
+  # $dut.atd.convert
+end

data/origen_app_generators/templates/app_generators/test_engineering/stand_alone_application/target/top_level.rb

@@ -0,0 +1,4 @@
+# The target file is run before *every* Origen operation and is used to instantiate
+# the runtime environment - usually this means instantiating a top-level SoC or
+# IP model.
+<%= @namespace %>::<%= @options[:name] || "TopLevel" %>.new   # Instantiate a DUT instance

data/origen_app_generators/templates/app_generators/test_engineering/test_block/environment/j750.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::J750.new

data/origen_app_generators/templates/app_generators/test_engineering/test_block/environment/ultraflex.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::UltraFLEX.new

data/origen_app_generators/templates/app_generators/test_engineering/test_block/environment/v93k.rb

@@ -0,0 +1,2 @@
+# Instantiate a tester driver, this will be globally available as 'tester'
+OrigenTesters::V93K.new

data/origen_app_generators/templates/app_generators/test_engineering/test_block/lib/controller.rb

@@ -0,0 +1,12 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>Controller
+    include Origen::Controller
+
+    def do_something
+      # The config register is defined in the corresponding model
+      config.mode.write!(0x14)
+      tester.wait(time_in_us: 100)
+      config.secure.read!(0)
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/test_block/lib/interface.rb

@@ -0,0 +1,21 @@
+module <%= @namespace %>
+  class Interface
+    include OrigenTesters::ProgramGenerators
+
+    # This will be called at the start of every flow or sub-flow (whenever Flow.create
+    # is called).
+    # Any options passed to Flow.create will be passed in here.
+    # The options will contain top_level: true, whenever this is called at the start of
+    # a new top-level flow.
+    def startup(options = {})
+    end
+
+    # This will be called at the end of every flow or sub-flow (at the end of every
+    # Flow.create block).
+    # Any options passed to Flow.create will be passed in here.
+    # The options will contain top_level: true, whenever this is called at the end of a
+    # top-level flow file.
+    def shutdown(options = {})
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/test_block/lib/model.rb

@@ -0,0 +1,18 @@
+module <%= @namespace %>
+  class <%= @options[:name] %>
+    include Origen::Model
+
+    def initialize(options = {})
+      instantiate_registers(options)
+    end
+
+    def instantiate_registers(options)
+      # Define your IP's registers here
+      reg :config, 0x0, size: 32 do |reg|
+        reg.bits 15..8, :mode
+        reg.bit 1, :ext_clk, reset: 1
+        reg.bit 0, :secure, access: :ro
+      end
+    end
+  end
+end

data/origen_app_generators/templates/app_generators/test_engineering/test_block/lib_dev/dut.rb

@@ -0,0 +1,27 @@
+module <%= @namespace %>Dev
+  # This is a dummy DUT class that should be used to test that your test module can
+  # integrate into a top-level app
+  class DUT
+    include Origen::TopLevel
+    include OrigenJTAG
+    include OrigenARMDebug
+
+    def initialize(options = {})
+      instantiate_pins(options)
+      instantiate_sub_blocks(options)
+    end
+
+    def instantiate_pins(options)
+      add_pin :tclk
+      add_pin :tdi
+      add_pin :tdo
+      add_pin :tms
+      add_pin :resetb
+    end
+
+    def instantiate_sub_blocks(options)
+      sub_block :arm_debug, class_name: 'OrigenARMDebug::DAP', mem_aps: { mem_ap: 0x0, mdmap: 0x0100_0000 }
+      sub_block :<%= options[:sub_block_name] %>, class_name: '<%= @namespace %>::<%= options[:class_name] %>', base_address: 0x1000_0000
+    end
+  end
+end