origen_ahb 0.2.0.pre2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6aaf5011cdd5d3328aef9c3feeebffcf324d4a9
+  data.tar.gz: 76f66169b9bead42f206a0d84d92597fb13f4628
+SHA512:
+  metadata.gz: 436df5b100adc4d4e645c1c819e48690c8050558c61dbf4d59b4de33e024dd935f25833d823e4bc7cee48495a7f42b8c0214f59e571874c5f1bf113bb06baf48
+  data.tar.gz: f330f2d3b46a976d132a4ef74ed961b345748869287bd02f87622eaeb50c9462559184c83107e8da9cf636252172fd9c00da09ac2a5f43e3477335ad266118fa

data/config/application.rb

@@ -0,0 +1,59 @@
+class OrigenAhbApplication < Origen::Application
+
+  # This information is used in headers and email templates, set it specific
+  # to your application
+  config.name     = "origen ahb"
+  config.initials = "OrigenAhb"
+
+  self.name = "origen_ahb"
+  self.namespace = "OrigenAhb"
+  config.rc_url = "git@github.com:Origen-SDK/origen_ahb.git"
+  config.release_externally = true
+
+  # 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/ahb"
+  config.web_domain = "http://origen-sdk.org/ahb"
+  
+  config.semantically_version = true
+
+  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"], 
+  } 
+  
+  # Ensure that all tests pass before allowing a release to continue 
+  def validate_release 
+    if !system("origen examples") || !system("origen specs") 
+      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 
+  
+  # Run code coverage when deploying the web site 
+  def before_deploy_site 
+    Dir.chdir Origen.root do 
+      system "origen examples -c" 
+      dir = "#{Origen.root}/web/output/coverage"        
+      FileUtils.remove_dir(dir, true) if File.exists?(dir)  
+      system "mv #{Origen.root}/coverage #{dir}" 
+    end 
+  end 
+ 
+  # Deploy the website automatically after a production 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 
+
+end

data/config/commands.rb

@@ -0,0 +1,81 @@
+# This file should be used to extend the rgen command line tool with tasks 
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/rgen/commands.rb in your RGen core workspace for more examples and 
+# inspiration.
+#
+# Also see the official docs on adding commands:
+#   http://rgen.freescale.net/rgen/latest/guides/custom/commands/
+
+# Map any command aliases here, for example to allow 'rgen 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
+
+# Here is an example of how to implement a command, the logic can go straight
+# in here or you can require an external file if preferred.
+when "my_command"
+  puts "Doing something..."
+  require "commands/my_command"    # Would load file lib/commands/my_command.rb
+  # You must always exit upon successfully capturing a command to prevent 
+  # control flowing back to RGen
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+#when "specs"
+#  ARGV.unshift "spec"
+#  require "rspec"
+#  require "rspec/autorun"
+#  exit 0 # This will never be hit on a fail, RSpec will automatically exit 1
+
+## Example of how to make a command to run diff-based tests
+when "examples"  
+#  RGen.load_application
+  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "rgen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{RGen.top}/lib/rgen/commands/generate.rb"
+#
+#  if RGen.app.stats.changed_files == 0 &&
+#     RGen.app.stats.new_files == 0 &&
+#     RGen.app.stats.changed_patterns == 0 &&
+#     RGen.app.stats.new_patterns == 0
+#
+#    RGen.app.stats.report_pass
+#  else
+#    RGen.app.stats.report_fail
+#    status = 1
+#  end
+#  puts
+  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
+# RGen command handler.
+#else
+  # You probably want to also add the your commands to the help shown via
+  # rgen -h, you can do this be assigning the required text to @application_commands
+  # before handing control back to RGen. Un-comment the example below to get started.
+#  @application_commands = <<-EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+#  EOT
+
+
+when "specs"
+  status = 0
+  exit status
+
+end #case

data/config/development.rb

@@ -0,0 +1,12 @@
+# This file is similar to environment.rb and will be loaded
+# automatically at the start of each invocation of RGen.
+#
+# However the major difference is that it will not be loaded
+# if the application is imported by a 3rd party app - in that
+# case only environment.rb is loaded.
+#
+# Therefore this file should be used to load anything you need
+# to setup a development environment for this app, normally
+# this would be used to load some dummy classes to instantiate
+# your objects so that they can be tested and/or interacted with
+# in the console.

data/config/environment.rb

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

data/config/users.rb

@@ -0,0 +1,29 @@
+# This file defines the users associated with your project, it is basically the 
+# mailing list for release notes.
+#
+# You can split your users into "admin" and "user" groups, the main difference 
+# between the two is that admin users will get all tag emails, users will get
+# emails on external/official releases only.
+#
+# Users are also prohibited from running the "rgen rc tag" command, but this is 
+# really just to prevent a casual user from executing it inadvertently and is
+# not intended to be a serious security gate.
+module RGen
+  module Users
+    def users
+      @users ||= [
+
+        # Admins - Notified on every tag
+        User.new("Chris P Nappi", "ra5809", :admin),
+
+        # Users - Notified on official release tags only
+        #User.new("Stephen McGinty", "r49409"),
+        # The r-number attribute can be anything that can be prefixed to an 
+        # @freescale.com email address, so you can add mailing list references
+        # as well like this:
+        #User.new("RGen Users", "rgen"),  # The RGen mailing list
+        
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/lib/origen_ahb/driver.rb

@@ -0,0 +1,56 @@
+module OrigenAhb
+  class Driver
+    attr_reader :owner
+
+    def initialize(owner, options = {})
+      @owner = owner
+    end
+
+    def read_register(reg_or_val, options = {})
+      options = {
+        haddr:     reg_or_val.address,
+        hdata:     reg_or_val.data,
+        hwrite:    0,
+        hsize:     get_hsize(reg_or_val.size),
+        hburst:    0,
+        hmastlock: 0,
+        hprot:     0xF
+      }.merge(options)
+      $dut.ahb_trans(options)
+    end
+
+    def write_register(reg_or_val, options = {})
+      options = {
+        haddr:     reg_or_val.address,
+        hdata:     reg_or_val.data,
+        hwrite:    1,
+        hsize:     get_hsize(reg_or_val.size),
+        hburst:    0,
+        hmastlock: 0,
+        hprot:     0xF
+      }.merge(options)
+      $dut.ahb_trans(options)
+    end
+
+    def get_hsize(size)
+      if size <= 8
+        hsize = 0
+      elsif size > 8 and size <= 16
+        hsize = 1
+      elsif size > 16 and size <= 32
+        hsize = 2
+      elsif size > 32 and size <= 64
+        hsize = 3
+      elsif size > 64 and size <= 128
+        hsize = 4
+      elsif size > 128 and size <= 256
+        hsize = 5
+      elsif size > 256 and size <= 512
+        hsize = 6
+      elsif size > 512 and size <= 1024
+        hsize = 7
+      end
+      get_hsize = hsize
+    end
+  end
+end

data/lib/origen_ahb/interface.rb

@@ -0,0 +1,4 @@
+module OrigenAhb
+  class Interface
+  end
+end

data/lib/origen_ahb/top_level.rb

@@ -0,0 +1,12 @@
+module OrigenAhb
+  class TopLevel
+    # A simple method to get you going, to see this in action run a console session like this:
+    #
+    #   rgen i
+    #
+    #   > $dut.hi
+    def hi
+      puts 'Hello master!'
+    end
+  end
+end

data/lib/origen_ahb.rb

@@ -0,0 +1,22 @@
+require 'origen_testers'
+require 'origen'
+require_relative '../config/application.rb'
+module OrigenAhb
+  # Load all files in the lib directory via a wildcard, if your project becomes
+  # large or load order dependencies start to creep in then you may need to
+  # start taking control of this manually as described above.
+  # 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 up front
+  # you can do that one manually and the let the wildcard take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").sort.each do |file|
+    require file
+  end
+
+  # Returns an instance of the OrigenAhb::Driver
+  def ahb
+    @origen_ahb ||= Driver.new(self)
+  end
+end
+
+# Add some aliases to handle common typos
+# AHB = ahb

data/lib/tasks/origen_ahb.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/program/prb1.rb

@@ -0,0 +1,9 @@
+Flow.create interface: 'OrigenAhb::Interface' do
+
+  if_job :p1 do
+    functional :test1, bin: 10, id: :t1
+
+    functional :test2, bin: 15, if_failed: :t1
+  end
+
+end

data/templates/web/archive.md.erb

@@ -0,0 +1,11 @@
+% render "layouts/basic.html", tab: :archive do
+
+## Archive
+
+Documentation from previous releases is available via the links below:
+
+% RGen.app.versions.reverse_each do |version|
+* [<%= version %>](<%= RGen.app.config.web_domain %>/<%= version.gsub(".", "_") %>)
+% end
+
+% end

data/templates/web/contact.md.erb

@@ -0,0 +1,36 @@
+% render "layouts/basic.html", tab: :contact do
+
+## Contact Us
+
+The following engineers can be contacted about this application:
+
+% RGen.app.developers.each do |user|
+* [<%= user.name %>](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\<%= user.r_number %>) 
+% end
+
+%# An example of how to manually write a more detailed contact page:
+%#Please use PDM For any bug reports or change/feature requests:
+%#
+%#* [C90TFS_NVM_tester on PDM](http://designpdm.freescale.net/Agile/PLMServlet?fromPCClient=true&module=PartFamilyHandler&requestUrl=module%3DPartFamilyHandler%26opcode%3DdisplayObject%26classid%3D2000004409%26objid%3D17718323%26tabid%3D2%26)
+%#
+%#For test related issues you can contact:
+%#
+%#* [Stephen McGinty](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\r49409) 
+%#* [Thao Huynh](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\R6AANF) 
+%#
+%#For product/yield issues contact:
+%#
+%#* [Andrew Hardell](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\R12635)
+%#* [Eddie Lepore](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\B06626)
+%#
+%#The manager of this project is:
+%#
+%#* [Wendy Malloch](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\TTZ231)
+%#
+%#
+%#Finally if you are not sure who to contact, or if your question may have device/reliability
+%#implications, then you can use the Split Gate Flash Test and Reliability mailing list:
+%#
+%#* [Email SGFTANDR](mailto:SGFTANDR@freescale.com)
+
+% end

data/templates/web/index.md.erb

@@ -0,0 +1,60 @@
+% 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><%= RGen.app.namespace %> <span style="font-size: 14px">(<%= RGen.app.version %>)</span></h1>
+
+### Purpose
+
+This plugin provides...
+
+### How To Import
+
+##### To use in an application:
+
+Add the following to your application's <code>Gemfile</code>:
+
+~~~ruby
+gem '<%= RGen.app.name %>', '<%= RGen.app.version %>'
+~~~
+
+##### To use in a plugin:
+
+Add the following to your plugin's gemspec:
+
+~~~ruby
+spec.add_runtime_dependency '<%= RGen.app.name %>', '~> <%= RGen.app.version.major %>', '>= <%= RGen.app.version %>'
+~~~
+
+and require the gem in your code:
+
+~~~ruby
+require '<%= RGen.app.name %>'
+~~~
+
+
+### How To Use
+
+Give some quick start description here on how to use your plugin, providing
+links to the API documents where necessary for further details.
+
+Here is an example integration:
+
+~~~ruby
+# Include some code examples here
+~~~
+
+### How To Setup a Development Environment
+
+~~~text
+mkdir <%= RGen.app.name %>
+cd <%= RGen.app.name %>
+dssc setvault <%= RGen.app.config.vault %> .
+dssc pop -rec -get .
+~~~
+
+Follow the instructions here if you want to make a 3rd party app
+workspace use your development copy of the <%= RGen.app.name %> plugin:
+[Setting up a Plugin Development Environment](http://rgen.freescale.net/rgen/latest/guides/libraries/environment)
+
+% end

data/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,14 @@
+---
+layout: bootstrap
+title: <%= options[:title] || RGen.app.namespace %>
+---
+<%= render "templates/web/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,22 @@
+<div class="navbar navbar-inverse navbar-fixed-top">
+  <div class="navbar-inner">
+    <div class="container">
+      <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </a>
+      <a class="brand" href="<%= path "/" %>">Home</a>
+      <div class="nav-collapse collapse">
+        <ul class="nav">
+          <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+          <li class="<%= options[:tab] == :coverage ? 'active' : '' %>"><a href="<%= path "/coverage" %>">Coverage</a></li>
+          <li class="<%= options[:tab] == :archive ? 'active' : '' %>"><a href="<%= path "/archive" %>">Archive</a></li>
+          <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+          <li class="<%= options[:tab] == :contact ? 'active' : '' %>"><a href="<%= path "/contact" %>">Contact</a></li>
+        </ul>
+        <%= import "rgen/web/logo.html" %>
+      </div><!--/.nav-collapse -->
+    </div>
+  </div>
+</div>

data/templates/web/release_notes.md.erb

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

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: origen_ahb
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre2
+platform: ruby
+authors:
+- Chris P Nappi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: origen_testers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ra5809@freescale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/commands.rb
+- config/development.rb
+- config/environment.rb
+- config/users.rb
+- config/version.rb
+- lib/origen_ahb.rb
+- lib/origen_ahb/driver.rb
+- lib/origen_ahb/interface.rb
+- lib/origen_ahb/top_level.rb
+- lib/tasks/origen_ahb.rake
+- program/prb1.rb
+- templates/web/archive.md.erb
+- templates/web/contact.md.erb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: http://rgen.freescale.net/origen_ahb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Protocol layer for AHB protocol (AMBA AHB-lite)
+test_files: []
+has_rdoc: