origen_standard_subblocks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ceb70165c121842f71b42652b909105622390bcf753df908b514a91cb7490686
+  data.tar.gz: ed0759a994c88e9a12d48103442ac4dc229a6674e67bcb5e1bbe314588b58dd7
+SHA512:
+  metadata.gz: bc3f9f243b91f9318898528bb3a7b86984cbd9047dc3ad442b6b139dab830d66b2587cd686f79ef6ab055bee0432a5326373515cb2b5bf951d546a08677204c1
+  data.tar.gz: 1bb270eb04677c3a3f652ef051506e4648520e2edb8e68f07c393975c7616eb158e803f65aebcaf74a24a7e81a53410d37e85b4f3957cd3d0de849ad0eec8735

data/config/application.rb

@@ -0,0 +1,104 @@
+require 'origen'
+class OrigenStandardSubblocksApplication < 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       = "origen_standard_subblocks"
+  self.namespace  = "OrigenStandardSubblocks"
+  config.name     = "origen_standard_subblocks"
+  config.initials = "OrigenStandardSubblocks"
+  config.rc_url   = "git@github.com:Origen-SDK/origen_standard_subblocks.git"
+  config.release_externally = true
+  config.gem_name = "origen_standard_subblocks"
+
+
+  # To enable deployment of your documentation to a web server (via the 'origen web'
+  # command) fill in these attributes.
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/standard_subblocks"
+  config.web_domain = "http://origen-sdk.org/standard_subblocks"
+
+  # 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, 
+    # Limit the testing for large legacy applications
+    #level: :easy,
+    # Run on these directories/files by default
+    #files: ["lib", "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
+
+  # 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
+
+  # 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/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/origen_standard_subblocks.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 "origen_standard_subblocks"
+
+module OrigenStandardSubblocksDev
+  # Example of how to explicitly require a file
+  # require "origen_standard_subblocks_dev/my_file"
+    
+  # Load all files in the lib/origen_standard_subblocks_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/origen_standard_subblocks_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/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 "origen_standard_subblocks/commands/my_command"    # Would load file lib/origen_standard_subblocks/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/config/version.rb

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

data/lib/origen_standard_subblocks.rb

@@ -0,0 +1,10 @@
+require 'origen_testers'
+require 'origen'
+require_relative '../config/application.rb'
+
+module OrigenStandardSubblocks
+  # Load the subblocks.
+  Dir.glob("#{File.dirname(__FILE__)}/origen_standard_subblocks/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/lib/origen_standard_subblocks/RAM/ram.rb

@@ -0,0 +1,59 @@
+module OrigenStandardSubblocks
+  # Simple subblock for modeling RAM.
+  # @note This currently assumes 32-bit addresses.
+  # @note This currently assumes Big-Endian address space (e.g., the RAM grows upwards).
+  class RAM
+    include Origen::Model
+
+    # Create a new <code>OrigenStandardSubblocks::RAM</code> object.
+    # @param [Hash] options Initializaton options.
+    # @option options [Fixnum] :length The length of the RAM, in bytes.
+    # @note The <code>length</code> option is a required option.
+    # @raise [Origen::Error] When <code>length</code> is not given as an option.
+    def initialize(options = {})
+      @length = options[:length]
+
+      if @length.nil?
+        Origen.app.fail(message: 'RAM subblock requires a :length option to be given!')
+      end
+    end
+
+    # Returns the start address (frst usable address) in the RAM.
+    # @return [Fixnum] Indicating the start address of the RAM.
+    def start_addr
+      base_address
+    end
+    alias_method :start_address, :start_addr
+    alias_method :start, :start_addr
+    alias_method :first_addr, :start_addr
+    alias_method :first_address, :start_addr
+    alias_method :first, :start_addr
+
+    # Returns the length of the RAM
+    # @return [Fixnum] Indicating the length of the RAM.
+    def length
+      @length
+    end
+    alias_method :size, :length
+
+    # Returns the total number of RAM addresses available.
+    # @note This assumes 32-bit addresses
+    # @note This also functions as the number of 32-bit words.
+    # @return [Fixnum] Indicating the number of RAM addresses available.
+    def size
+      @length / 4
+    end
+
+    # Returns the end address: i.e., the last usable address (not the length).
+    # @note This assume 32-bit addresses
+    # @return [Fixnum] Indicating the last usable address.
+    def end_addr
+      start_addr + length - 4
+    end
+    alias_method :end_address, :end_addr
+    alias_method :end, :end_addr
+    alias_method :last_addr, :end_addr
+    alias_method :last_address, :end_addr
+    alias_method :last, :end_addr
+  end
+end

data/lib/origen_standard_subblocks/RAM/ram_controller.rb

@@ -0,0 +1,38 @@
+module OrigenStandardSubblocks
+  class RAMController
+    include Origen::Controller
+
+    # Shortcut for <code>mem</code>, where the base address is added to the index.
+    # @param [Fixnum] index Offset index in the RAM. Note that standard index notation is used.
+    #   I.e., an index of 0 corresponds to the first usable address and an
+    #   index of 1 corresponds to the second usable address.
+    # @return [Origen:Registers::Reg]
+    # @example Get a <code>Origen::Registers::Reg</code> object for the first usable memory location (indexes start at 0)
+    #   r = dut.ram[0]
+    #   r.class #=> Origen::Registers::Reg
+    #   r.address.to_hex #=> '0x100'
+    # @example Get a <code>Origen::Registers::Reg</code> object for the second usable memory location (indexes start at 0)
+    #   # Assume base address is 0x100 and the length is 0x10
+    #   r = dut.ram[1]
+    #   r.class #=> Origen::Registers::Reg
+    #   r.address.to_hex #=> '0x104'
+    # @todo Add support for negative index notation & ranges.
+    # @todo Add support for bounds checking.
+    def [](index)
+      dut.mem(start_addr + (4 * index))
+    end
+
+    # Shortcut for <code>mem.write!</code>, where the base address is added to the index.
+    # @param [Fixnum] index Offset index in the RAM. Note that standard index notation is used.
+    #   I.e., an index of 0 corresponds to the first usable address and an
+    #   index of 1 corresponds to the second usable address.
+    # @param [Fixnum] data Data to write to the RAM location indicated by the index.
+    #   Or: <code>RAM[index] <= data</code>
+    # @return [Origen::Registers::BitCollection]
+    # @todo Add support for negative index notation & ranges.
+    # @todo Add support for bounds checking.
+    def []=(index, data)
+      self[index].write!(data)
+    end
+  end
+end

data/lib/tasks/origen_standard_subblocks.rake

@@ -0,0 +1,6 @@
+# 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/pattern/example.rb

@@ -0,0 +1,5 @@
+Pattern.create do
+  # Registers should never be written directly from here, always call API methods
+  # that are defined by your controllers
+  dut.ram.do_something
+end

data/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/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/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/templates/web/release_notes.md.erb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: origen_standard_subblocks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corey Engelken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+- !ruby/object:Gem::Dependency
+  name: origen_testers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+description: 
+email:
+- coreyengelken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/origen_standard_subblocks.rb
+- lib/origen_standard_subblocks/RAM/ram.rb
+- lib/origen_standard_subblocks/RAM/ram_controller.rb
+- lib/tasks/origen_standard_subblocks.rake
+- pattern/example.rb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: https://origen-sdk.org/arm/standard_subblocks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Simple, elementary, pre-defined subblocks to easily model common SoC blocks.
+test_files: []