origen_app_generators 1.1.4 → 2.2.0

data/templates/app_generators/plugin/lib/README

@@ -1,4 +0,0 @@
-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/templates/app_generators/plugin/lib_dev/README

@@ -1,5 +0,0 @@
-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/templates/app_generators/test_engineering/stand_alone_application/Gemfile

@@ -1,20 +0,0 @@
-source 'https://rubygems.org'
-<% if (@audience != :external) && Origen.site_config.gem_server -%>
-source '<%= Origen.site_config.gem_server %>'
-<% 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/templates/app_generators/test_engineering/stand_alone_application/environment/jlink.rb

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

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

@@ -1,23 +0,0 @@
-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/templates/app_generators/test_engineering/stand_alone_application/lib/ip_block_controller.rb

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

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

@@ -1,33 +0,0 @@
-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/templates/app_generators/test_engineering/stand_alone_application/lib/top_level_controller.rb

@@ -1,21 +0,0 @@
-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/templates/app_generators/test_engineering/stand_alone_application/pattern/example.rb

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

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

@@ -1,4 +0,0 @@
-# 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/templates/app_generators/test_engineering/test_block/environment/j750.rb

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

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

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

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

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

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

@@ -1,12 +0,0 @@
-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/templates/app_generators/test_engineering/test_block/lib/interface.rb

@@ -1,21 +0,0 @@
-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/templates/app_generators/test_engineering/test_block/lib/model.rb

@@ -1,18 +0,0 @@
-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/templates/app_generators/test_engineering/test_block/lib_dev/dut.rb

@@ -1,27 +0,0 @@
-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

data/templates/app_generators/test_engineering/test_block/lib_dev/dut_controller.rb

@@ -1,26 +0,0 @@
-module <%= @namespace %>Dev
-  # This is a dummy DUT controller that should be used to test that your test module can
-  # integrate into a top-level app
-  class DUTController
-    def startup(options = {})
-      tester.set_timeset('func_25', 40)
-      ss 'Startup the SoC'
-      pin(:resetb).drive!(0)
-      100.cycles
-      pin(:resetb).dont_care
-    end
-
-    def shutdown(options = {})
-      ss 'Shutdown the SoC'
-      pin(:resetb).drive!(0)
-    end
-
-    def write_register(reg, options = {})
-      arm_debug.mem_ap.write_register(reg, options)
-    end
-
-    def read_register(reg, options = {})
-      arm_debug.mem_ap.read_register(reg, options)
-    end
-  end
-end

data/templates/app_generators/test_engineering/test_block/pattern/example.rb

@@ -1,5 +0,0 @@
-Pattern.create do
-  # Registers should never be written directly from here, always call API methods
-  # that are defined by your controllers
-  dut.<%= options[:sub_block_name] %>.do_something
-end

data/templates/app_generators/test_engineering/test_block/program/prb1.rb

@@ -1,11 +0,0 @@
-Flow.create interface: '<%= @namespace %>::Interface' do
-
-  if_job :p1 do
-    test :test1, bin: 10, id: :t1
-
-    test :test2, bin: 15, if_failed: :t1
-  end
-
-  pass 1, softbin: 55
-
-end

data/templates/app_generators/test_engineering/test_block/target/default.rb

@@ -1,2 +0,0 @@
-# Instantiate a DUT instance, this will be globally available as 'dut'
-<%= @namespace %>Dev::DUT.new