origen_app_generators 1.2.0 → 2.0.0

data/bin/fix_my_workspace

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-$VERBOSE = nil  # Don't care about world writable dir warnings and the like
-
-if $_fix_my_workspace_version_check
-  $_fix_my_workspace_version = '0.7.0'
-else
-  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
-    # If this script is being run from within an origen-core workspace, use that Origen-core,
-    # not the system-installed origen-core version.
-    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-    require 'origen'
-  else
-    # Use system-installed Origen (the gem in system Ruby)
-    require 'origen'
-  end
-
-  if !Origen.site_config.gem_manage_bundler
-    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
-    puts 'that I cannot make certain assumptions about how your workspace is configured.'
-    puts 'You will need to either resolve this problem yourself, or else change the value of'
-    puts 'gem_mange_bundler to true.'
-    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
-
-  else
-    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
-    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
-    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
-
-    # Force copy system gems to local gems
-    if Origen.site_config.gem_use_from_system
-      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
-      gem_dir = Pathname.new(Gem.dir)
-
-      Origen.site_config.gem_use_from_system.each do |gem, version|
-        begin
-          # This will raise an error if the system doesn't have this gem installed, that
-          # will be rescued below
-          spec = Gem::Specification.find_by_name(gem, version)
-
-          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
-          FileUtils.mkdir_p local_dir
-          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.cache_file, local_file)
-
-          if spec.extension_dir && File.exist?(spec.extension_dir)
-            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
-            FileUtils.mkdir_p local_dir
-            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
-          end
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.spec_file, local_file)
-
-        rescue Gem::LoadError
-          # This just means that one of the gems that should be copied from the system
-          # was not actually installed in the system, so nothing we can do about that here
-        end
-      end
-    end
-
-    # Delete lbin
-    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
-
-    # Run bundler with correct switches
-    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
-    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
-    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
-    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
-
-    # Try again, this time updating the bundle
-    if system(cmd)
-      fixed = true
-    elsif system 'bundle update'
-      fixed = true
-    end
-
-    if File.exist?(ENV['BUNDLE_BIN'])
-      `chmod o-w #{ENV['BUNDLE_BIN']}`
-
-      # Make .bat versions of all executables, Bundler should really be doing this when running
-      # on windows
-      if Origen.os.windows?
-        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
-          unless bin =~ /.bat$/
-            bat = "#{bin}.bat"
-            unless File.exist?(bat)
-              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
-            end
-          end
-        end
-      end
-    end
-
-    system 'origen -v' if fixed
-  end
-end

data/lib/origen_app_generators/sub_block_parser.rb

@@ -1,81 +0,0 @@
-module OrigenAppGenerators
-  require 'strscan'
-  # Responsible for parsing something like this:
-  #
-  #   "ram, osc, pll, atd(2), comms[ram(2), osc](3)"
-  #
-  # into this:
-  #
-  #   {
-  #     "RAM"=>{}, "Osc"=>{}, "PLL"=>{}, "ATD"=> {:instances=>2},
-  #     "Comms"=>{:instances=>3, :children=>{"RAM"=>{:instances=>2}, "Osc"=>{}}}
-  #   }
-  #
-  class SubBlockParser
-    def parse(str)
-      r = {}
-      split(str).each do |tag|
-        tag, i = extract_instances(tag)
-        name, children = extract_children(tag)
-        name = camelize(name)
-        r[name] = {}
-        r[name][:instances] = i if i
-        r[name][:children] = children if children
-      end
-      r
-    end
-
-    private
-
-    # Splits the given string by comma, but understands that nested
-    # commas should not be split on
-    def split(str)
-      r = []
-      str = StringScanner.new(str)
-      r << next_tag(str) until str.eos?
-      r
-    end
-
-    def next_tag(str)
-      v = str.scan_until(/,|\[|$/)
-      if v[-1] == ','
-        v.chop.strip
-      elsif v[-1] == '['
-        open = 1
-        while open > 0
-          v += str.scan_until(/\[|\]/)
-          if v[-1] == '['
-            open += 1
-          else
-            open -= 1
-          end
-        end
-        v += next_tag(str)
-      # End of line
-      else
-        v.strip
-      end
-    end
-
-    def extract_children(tag)
-      # http://rubular.com/r/plGILY2e2U
-      if tag.strip =~ /([^\[]*)\[(.*)\]/
-        [Regexp.last_match(1), parse(Regexp.last_match(2))]
-      else
-        [tag.strip, nil]
-      end
-    end
-
-    def extract_instances(tag)
-      if tag.strip =~ /(.*)\((\d+)\)$/
-        [Regexp.last_match(1), Regexp.last_match(2).to_i]
-      else
-        [tag.strip, nil]
-      end
-    end
-
-    def camelize(val)
-      val.strip.gsub(/\s+/, '_').camelize
-    end
-  end
-end

data/lib/tasks/app_generators.rake

@@ -1,6 +0,0 @@
-# You can define any Rake tasks to support your application here (or in any file
-# ending in .rake in this directory).
-#
-# Rake (Ruby Make) is very useful for creating build scripts, see this short video
-# for a quick introduction:
-# http://railscasts.com/episodes/66-custom-rake-tasks

data/templates/app_generators/application/lib/app.rake

@@ -1,6 +0,0 @@
-# You can define any Rake tasks to support your application here (or in any file
-# ending in .rake in this directory).
-#
-# Rake (Ruby Make) is very useful for creating build scripts, see this short video
-# for a quick introduction:
-# http://railscasts.com/episodes/66-custom-rake-tasks

data/templates/app_generators/application/lib/module.rb

@@ -1,22 +0,0 @@
-require 'origen'
-<% if @type == :plugin -%>
-require_relative '../config/application.rb'
-<% end -%>
-module <%= @namespace %>
-<% if @type == :plugin -%>
-  # THIS FILE SHOULD ONLY BE USED TO LOAD RUNTIME DEPENDENCIES
-  # If this plugin has any development dependencies (e.g. dummy DUT or other models that are only used
-  # for testing), then these should be loaded from config/boot.rb
-
-<% end -%>
-  # Example of how to explicitly require a file
-  # require "<%= @name %>/my_file"
-
-  # Load all files in the lib/<%= @name %> 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__)}/<%= @name %>/**/*.rb").sort.each do |file|
-    require file
-  end
-end

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,23 +0,0 @@
-<% 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/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