atp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31ba0f5ad78ad309c007c6051c63abc61869d515
+  data.tar.gz: 1506ab571ab5b6e8fe5c992bb95e81a7d866c8a7
+SHA512:
+  metadata.gz: 457369eaa2650117fd6477073cf192368c7041782001852498119363e5940cd4048923b93194d072400dc4430f4f05eb5b67f40da5115994c7e57e495c971a5b
+  data.tar.gz: 28f04f8b24bb72b32b0816d97833dfeb70809562967f7b13f1cfb096c0e9dd0b2affa38f7f0e4ad43f64a4a95c66ccfa8c1c363fbff0eb2560ff68c1d139c19d

data/config/application.rb

@@ -0,0 +1,102 @@
+require 'origen'
+class ATPApplication < Origen::Application
+
+  # See http://origen-sdk.org/origen/latest/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       = "atp"
+  self.namespace  = "ATP"
+  config.name     = "atp"
+  config.initials = "ATP"
+  config.rc_url    = "ssh://git@github.com:ginty/atp.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 = "/proj/.web_origen/html/atp"
+  config.web_domain = "http://origen-sdk.org/atp"
+
+  # 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/commands.rb

@@ -0,0 +1,76 @@
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/origen/commands.rb in your Origen core workspace for more examples and 
+# inspiration.
+#
+# Also see the official docs on adding commands:
+#   http://origen.freescale.net/origen/latest/guides/custom/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
+
+# 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 Origen
+  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"  
+#  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
+#  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 be assigning the required text to @application_commands
+  # before handing control back to Origen. 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
+
+end 

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 Origen.
+#
+# 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 Origen to boot your application, just leave it as
+# is and modify lib/atp.rb to load the additional resources that your
+# application requires
+require "atp"

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 "origen 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 Origen
+  module Users
+    def users
+      @users ||= [
+
+        # Admins - Notified on every tag
+        User.new("stephen", "stephen", :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("Origen Users", "origen"),  # The Origen mailing list
+        
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/lib/atp/top_level.rb

@@ -0,0 +1,12 @@
+module ATP
+  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/lib/atp.rb

@@ -0,0 +1,15 @@
+require 'origen'
+require_relative '../config/application.rb'     
+module ATP
+
+  # 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
+
+end

data/lib/tasks/atp.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/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:
+
+% Origen.app.versions.reverse_each do |version|
+* [<%= version %>](<%= Origen.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:
+
+% Origen.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><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.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 '<%= Origen.app.name %>', '<%= Origen.app.version %>'
+~~~
+
+##### To use in a plugin:
+
+Add the following to your plugin's gemspec:
+
+~~~ruby
+spec.add_runtime_dependency '<%= Origen.app.name %>', '~> <%= Origen.app.version.major %>', '>= <%= Origen.app.version %>'
+~~~
+
+and require the gem in your code:
+
+~~~ruby
+require '<%= Origen.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 <%= Origen.app.name %>
+cd <%= Origen.app.name %>
+dssc setvault <%= Origen.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 <%= Origen.app.name %> plugin:
+[Setting up a Plugin Development Environment](http://origen.freescale.net/origen/latest/guides/libraries/environment)
+
+% end

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

@@ -0,0 +1,14 @@
+---
+layout: bootstrap
+title: <%= options[:title] || Origen.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 "origen/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 "#{Origen.root}/doc/history" %>
+
+% end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: atp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: 
+email:
+- stephen.f.mcginty@gmail.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/atp.rb
+- lib/atp/top_level.rb
+- lib/tasks/atp.rake
+- 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://origen.freescale.net/atp
+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.4.8
+signing_key: 
+specification_version: 4
+summary: An abstract test program model for Origen
+test_files: []
+has_rdoc: