origen 0.34.3 → 0.52.0

data/origen_app_generators/templates/app_generators/application/Gemfile

@@ -0,0 +1,34 @@
+<% if (@audience != :external) && (Origen.site_config.gem_server_pull || Origen.site_config.gem_server) -%>
+<%   Array(Origen.site_config.gem_server_pull || Origen.site_config.gem_server).each do |server| -%>
+source '<%= server %>'
+<%   end -%>
+<% else %>
+source 'https://rubygems.org'
+<% end -%>
+
+gem 'origen', '>= <%= @latest_origen_version %>'
+
+gem 'origen_doc_helpers'
+<% if @development_dependencies -%>  
+  <% @development_dependencies.each do |dep| -%>
+gem <%= dep.map{ |d| "\"#{d}\"" }.join(', ') %>
+  <% end -%>
+<% end -%>
+
+gem 'byebug', '~>8'  # You can remove this version constraint if you don't care about your app
+                     # supporting earlier versions of Ruby 2
+<% if RUBY_VERSION < "2.3.0" -%>
+
+# Lock this version of nokogiri to enable compatibility with Ruby 2.2, if you don't need
+# that then you can remove this line
+gem 'nokogiri', '1.8.5'
+<% end -%>
+<% if (@audience != :external) && Origen.site_config.gem_push_plugins -%>
+<%   Array(Origen.site_config.gem_push_plugins).each do |plugin| -%>
+gem <%= plugin.map{ |d| "\"#{d}\"" }.join(', ') %>
+<%   end -%>
+<% end -%>
+
+# 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/application/Rakefile

@@ -0,0 +1,7 @@
+# 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.
+require "bundler/setup"
+require "origen"
+
+Origen.app.load_tasks

data/origen_app_generators/templates/app_generators/application/app/blocks/top_level.rb

@@ -0,0 +1,12 @@
+module <%= @namespace %>
+  class TopLevel
+    # A simple method to get you going, to see this in action run a console session like this:
+    #
+    #   origen i
+    #
+    #   > dut.hi
+    def hi
+      puts "Hello master!"
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+require 'origen'
+<% if @type == :plugin -%>
+require_relative '../../config/application.rb'
+<% end -%>
+module <%= @namespace %>
+end

data/origen_app_generators/templates/app_generators/application/app/templates/web/index.md.erb

@@ -0,0 +1,19 @@
+% 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 application...
+
+### How To Use
+
+Add quickstart documentation here...
+
+### How To Setup the Application Environment
+
+Describe how a user would setup a new workspace for this application...
+
+% end

data/origen_app_generators/templates/app_generators/application/app/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,13 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "partials/navbar.html", tab: options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+</div>
+</div>

data/origen_app_generators/templates/app_generators/application/app/templates/web/partials/_navbar.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/application/app/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+% end

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

@@ -0,0 +1,121 @@
+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 %>'
+  # 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"
+<% else -%>
+  # config.rc_url   = "ssh://git@sw-stash.mycompany.net/myproject/<%= @name %>.git"
+<% end -%>
+<% if @audience == :external -%>
+  config.release_externally = true
+<% end -%>
+
+  # 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 %>'
+<% else -%>
+  # 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,
+  # it is recommended that you leave this to true for better feedback and easier debug.
+  # This will be the default setting in Origen v3.
+  config.strict_errors = true
+
+  # 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,
+    # Auto correct violations where possible whenever 'origen lint' is run
+    auto_correct: true,
+    # Run on these directories/files by default
+    files:        ['app', 'config/application.rb']
+  }
+
+  config.semantically_version = true
+
+  # 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
+
+  # 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 -%>
+  # 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!'
+    end
+  end
+<% 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
+<% 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
+
+  # If you use pattern iterators you may come across the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # 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
+  # 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
+end

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

@@ -0,0 +1,4 @@
+# This file will be loaded by Origen to boot your application, just leave it as
+# is and modify lib/<%= @name %>.rb to load the additional resources that your
+# application requires
+require "<%= @name %>"

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

@@ -0,0 +1,79 @@
+# This file should be used to extend the origen with application specific commands
+
+# Map any command aliases here, for example to allow 'origen ex' to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "ex" => "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
+
+# (Working) example of how to create an application specific comment, here to generate
+# a tags file for you application to enable method definition lookup and similar within
+# editors/IDEs
+when "tags"  
+  # Here the logic is just written in-line, alternatively it could be written in a
+  # dedicated file and required here, e.g.
+  #require "<%= @name %>/commands/my_command"    # Would load file lib/<%= @name %>/commands/my_command.rb
+  Dir.chdir Origen.root do
+    system("ripper-tags -R")
+  end
+  # You must always exit upon successfully capturing and executing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+#when "specs"
+#  require "rspec"
+#  exit RSpec::Core::Runner.run(['spec'])
+
+## Example of how to make a command to run diff-based tests
+#when "examples", "test"
+#  Origen.load_application
+#  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "origen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{Origen.top}/lib/origen/commands/generate.rb"
+#
+#  if Origen.app.stats.changed_files == 0 &&
+#     Origen.app.stats.new_files == 0 &&
+#     Origen.app.stats.changed_patterns == 0 &&
+#     Origen.app.stats.new_patterns == 0
+#
+#    Origen.app.stats.report_pass
+#  else
+#    Origen.app.stats.report_fail
+#    status = 1
+#  end
+#  puts
+#  if @command == "test"
+#    Origen.app.unload_target!
+#    require "rspec"
+#    result = RSpec::Core::Runner.run(['spec'])
+#    status = status == 1 ? 1 : result
+#  end
+#  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+else
+  # You probably want to also add the your commands to the help shown via
+  # origen -h, you can do this by assigning the required text to @application_commands
+  # before handing control back to Origen.
+  @application_commands = <<-EOT
+ tags         Build a tags file for this app
+  EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
+end 

data/origen_app_generators/templates/app_generators/application/config/maillist_dev.txt

@@ -0,0 +1,4 @@
+# Any email addresses listed here will be automatically sent an email whenever you
+# run 'origen rc tag'
+# See here for more info: http://origen-sdk.org/origen/guides/misc/users/#Maillists
+<%= User.current.email %>

data/origen_app_generators/templates/app_generators/application/config/maillist_prod.txt

@@ -0,0 +1,3 @@
+# Any email addresses listed here will be automatically sent an email whenever you
+# run 'origen rc tag' and select a PRODUCTION release
+# See here for more info: http://origen-sdk.org/origen/guides/misc/users/#Maillists

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

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

data/origen_app_generators/templates/app_generators/application/origen_core_session

@@ -0,0 +1,2 @@
+{: refresh_interval_in_minutesiA:	modeI"
+debug:EF

data/origen_app_generators/templates/app_generators/application/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$VERBOSE=nil  # Don't care about world writable dir warnings and the like
+
+require 'pathname'
+if File.exist? File.expand_path("../Gemfile", Pathname.new(__FILE__).realpath)
+  require 'rubygems'
+  require 'bundler/setup'
+else
+  # If running on windows, can't use Origen helpers 'till we load it...
+  if RUBY_PLATFORM == 'i386-mingw32'
+    `where origen`.split("\n").find do |match|
+      match =~ /(.*)\\bin\\origen$/
+    end
+    origen_top = $1.gsub("\\", "/")
+  else
+    origen_top = `which origen`.strip.sub("/bin/origen", "")
+  end
+
+  $LOAD_PATH.unshift "#{origen_top}/lib"
+end
+
+require "origen"
+
+require "rspec/legacy_formatters"
+require "#{Origen.top}/spec/format/origen_formatter"
+require "byebug"
+require 'pry'
+
+def load_target(target="default")
+  Origen.target.switch_to target
+  Origen.target.load!
+end
+
+RSpec.configure do |config|
+  config.formatter = OrigenFormatter
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :should
+  end
+end

data/origen_app_generators/templates/app_generators/application/target/debug.rb

@@ -0,0 +1,8 @@
+# Production mode will require that there are no modified files in the workspace
+# and any other conditions that you add to your application.
+# Normally production targets define the target and then debug targets
+# are setup to load the production target before switching Origen to debug
+# mode as shown below.
+load "#{Origen.root}/target/production.rb"
+
+Origen.mode = :debug

data/origen_app_generators/templates/app_generators/application/target/default.rb

@@ -0,0 +1 @@
+# Use this file to instantiate the device model you are targeting

data/origen_app_generators/templates/app_generators/application/target/production.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 %>::TopLevel.new   # Instantiate a DUT instance

data/origen_app_generators/templates/app_generators/new/generator.rb

@@ -0,0 +1,102 @@
+module <%= @namespace %>
+  module <%= @domain_namespace %>
+    # Generates a generic application shell
+    class <%= @classname %> < <%= @parentclass %>
+
+      desc "<%= @summary %>"
+
+      # Any methods that are not protected will get invoked in the order that they are
+      # defined when the generator is run, method naming is irrelevant unless you want
+      # to override a method that is defined by the parent class
+      
+      def get_user_input
+        # The methods to get the common user input that applies to all applications will
+        # get called at the start automatically, you have a chance here to ask any additional
+        # questions that are specific to the type of application being generated.
+        # See the following links for some examples of how to ask questions:
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/base.rb#L94
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/plugin.rb#L44
+      end
+
+      def generate_files
+        # Calling this will build all files, directories and symlinks contained in the
+        # hash returned by the filelist method below
+        build_filelist 
+      end
+
+      def modify_files
+        # Here you can add or remove things post-generation.
+        # Alternatively, you can copy any master file to the equivalent sub-directory of
+        # templates/app_generators/<%= @domain_namespace.underscore %>/<%= @classname.underscore %>
+        # and this will override the version in the master directory.
+        #
+        # However, post generation modification is recommended when possible since it means that your
+        # generated applications will automatically stay up to date with any improvements made to the
+        # master file.
+        # The downside is that creating a post-generation modification takes a bit more effort to create
+        # compared to simply copying and modifying the file manually.
+        # To help with creating modifications, you have access to all of the Thor Action methods described here:
+        # http://www.rubydoc.info/github/wycats/thor/Thor/Actions
+        # See the enable method for an example of using these here:
+        # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/new.rb#L25
+      end
+
+      def conclude
+        # Print out anything you think the user should know about their new application at the end
+        puts "New app created at: #{destination_root}"
+      end
+
+      protected
+
+      # Defines the filelist for the generator, the default list is inherited from the
+      # parent class (<%= @namespace %>::<%= @parentclass %>).
+      # <% if @parentclass == 'Plugin' -%>  
+      # 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
+      # Additionally, this application could have made further modifications to the default list
+      # within lib/<%= @namespace.underscore %>/plugin.rb
+<% else %>
+      # See here for the default list of files included in an application:
+      # https://github.com/Origen-SDK/origen_app_generators/blob/master/lib/origen_app_generators/application.rb
+      # Additionally, this application could have made further modifications to the default list
+      # within lib/<%= @namespace.underscore %>/application.rb
+<% end -%>
+      #
+      # The filelist can contain references to generate files, directories or symlinks in the
+      # new application.
+      #
+      # To make your generator 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 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
+end