origen_doc_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d89354a4f13aed042c3fdbb0fb42ef325db4612f
+  data.tar.gz: 19c9c7af0631ba313222d0d485b8e8707b7bdf0f
+SHA512:
+  metadata.gz: 278a9668b54e8a4bd8243be6e994bc168c23130d5b31025c3c26b28051ab521c6d843e6c52337895f80b2d98dce79725400c24dea783f368907e37a3d45b17bc
+  data.tar.gz: 4ec1d7913206ac96248ebe5cc602d7c8c5d1be984dedf28f316c2ffa880c350833be4fb768830a82a442da689a5658a79b5f3ff5aa553abf58d6c89ace470c8e

data/config/application.rb

@@ -0,0 +1,34 @@
+require "origen"
+class OrigenDocHelpersApplication < Origen::Application
+
+  config.name     = "Origen Documentation Helpers"
+  config.initials = "OrigenDocHelpers"
+  config.rc_url   = "git@github.com:Origen-SDK/origen_doc_helpers"
+  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/doc_helpers"
+  config.web_domain = "http://origen-sdk.org/doc_helpers"
+
+  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"],
+  }
+
+  # To automatically deploy your documentation after every tag use this code
+  def after_release_email(tag, note, type, selector, options)
+    command = "origen web compile --remote"
+    Dir.chdir Origen.root do
+      system command
+    end
+  end
+
+end

data/config/commands.rb

@@ -0,0 +1,42 @@
+# 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 -x to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "-x" => "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 "execute"
+  puts "Executing something..."
+  require "commands/execute"    # Would load file lib/commands/execute.rb
+  # You must always exit upon successfully capturing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+# You probably want to also add the command details 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.
+else
+#  @application_commands = <<-EOT
+# execute      Execute something I guess
+#  EOT
+
+end 

data/config/development.rb

@@ -0,0 +1,16 @@
+# 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.
+module OrigenDocHelpers
+  autoload :DUT, "origen_doc_helpers/dut"
+end
+require "origen_doc_helpers/doc_interface"

data/config/environment.rb

@@ -0,0 +1,30 @@
+# This file will be required by Origen before your target is loaded, you 
+# can use this to require all of your files, which is the easiest way
+# to get started. As your experience grows you may wish to require only the
+# minimum files required to allow the target to be initialized and let 
+# each class require its own dependencies.
+#
+# It is recommended that you keep all of your application logic in lib/
+# The lib directory has already been added to the search path and so any files
+# in there can be referenced from here with a relative path.
+#
+# Note that pattern files do not need to be referenced from here and these
+# will be located automatically by origen.
+
+# This says load the file "lib/pioneer.rb" the first time anyone makes a 
+# reference to the class name 'Pioneer'.
+#autoload :Pioneer,   "pioneer"
+# This is generally preferable to using require which will load the file
+# regardless of whether it is needed by the current target or not:
+#require "pioneer"
+# Sometimes you have to use require however:-
+#   1. When defining a test program interface:
+#require "interfaces/j750"
+#   2. If you want to extend a class defined by an imported application, in
+#      this case your must use required and supply a full path (to distinguish
+#      it from the one in the parent application):
+#require "#{Origen.root}/c90_top_level/p2"
+module OrigenDocHelpers
+  autoload :PDF, "origen_doc_helpers/pdf"
+end
+require "helpers"

data/config/users.rb

@@ -0,0 +1,19 @@
+# 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 tag" task, 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 ||= [
+
+      ]
+    end
+  end
+end

data/config/version.rb

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

data/lib/helpers.rb

@@ -0,0 +1,234 @@
+module Origen
+  class Generator
+    class Compiler
+      module DocHelpers
+        # Helpers to create Yammer widgets
+        module Yammer
+          def yammer_comments(options = {})
+            options = {
+              prompt: 'Comment on this page'
+            }.merge(options)
+
+            options[:group_id] ||= Origen.app.config.yammer_group
+
+            <<END
+<div style="position: relative">
+  <hr>
+  <h4>Comments</h4>
+
+  <div id="embedded-follow" style="position:absolute; top: 18px; left: 100px;"></div>
+  <div id="embedded-feed" style="height:800px;width:600px;"></div>
+</div>
+
+<script type="text/javascript" src="https://c64.assets-yammer.com/assets/platform_embed.js"></script>
+
+<script>
+  yam.connect.actionButton({
+   container: "#embedded-follow",
+   network: "freescale.com",
+   action: "follow"
+  });
+</script>
+
+<script>
+  yam.connect.embedFeed({
+    container: "#embedded-feed",
+    feedType: "open-graph",
+    config: {
+      header: false,
+      footer: false,
+      defaultGroupId: '#{options[:group_id]}',
+      promptText: '#{options[:prompt]}'
+    },
+    objectProperties: {
+      type: 'page',
+      url: '#{current_latest_url}'
+    }
+  });
+</script>
+END
+          end
+        end
+        include Yammer
+
+        # Helpers for the register diagrams
+        module RegisterHelpers
+          # Returns true if some portion of the given bits falls
+          # within the given range
+          def _bit_in_range?(bits, max, min)
+            upper = bits.position + bits.size - 1
+            lower = bits.position
+            !((lower > max) || (upper < min))
+          end
+
+          # Returns the number of bits from the given bits that
+          # fall within the given range
+          def _num_bits_in_range(bits, max, min)
+            upper = bits.position + bits.size - 1
+            lower = bits.position
+            [upper, max].min - [lower, min].max + 1
+          end
+
+          # Returns true if the given number is is the
+          # given range
+          def _index_in_range?(i, max, min)
+            !((i > max) || (i < min))
+          end
+
+          def _bit_rw(bits)
+            str = ''
+            if bits.readable?
+              str += 'readable'
+            else
+              str += 'not-readable'
+            end
+            if bits.writable?
+              str += ' writable'
+            else
+              str += ' not-writable'
+            end
+            str.strip
+          end
+
+          def _max_bit_in_range(bits, max, _min)
+            upper = bits.position + bits.size - 1
+            [upper, max].min - bits.position
+          end
+
+          def _min_bit_in_range(bits, _max, min)
+            lower = bits.position
+            [lower, min].max - bits.position
+          end
+        end
+        include RegisterHelpers
+
+        # Helpers for the test flow documentation
+        module TestFlowHelpers
+          def _test_to_local_link(test)
+            name = _test_name(test)
+            number = _test_number(test)
+            "<a href='##{name}_#{number}'>#{name}</a>"
+          end
+
+          def _test_name(test)
+            test[:flow][:name] || test[:instance].first[:name]
+          end
+
+          def _test_number(test)
+            flow = test[:flow]
+            flow[:number] || flow[:test_number] || flow[:tnum]
+          end
+
+          def _bin_number(test)
+            flow = test[:flow]
+            flow[:bin] || flow[:hard_bin] || flow[:hardbin] || flow[:soft_bin] || flow[:softbin]
+          end
+
+          def _sbin_number(test)
+            flow = test[:flow]
+            flow[:soft_bin] || flow[:softbin]
+          end
+
+          def _start_accordion(heading, _options = {})
+            @_accordion_index ||= 0
+            @_accordion_index += 1
+            <<-END
+<div class="panel panel-default">
+<a href="#_" class="expandcollapse btn btn-xs pull-right btn-default" state="0"><i class='fa fa-plus'></i></a>
+<div class="panel-heading clickable" style="background:whitesmoke" data-toggle="collapse" data-parent="#blah2" href="#collapseAccordion#{@_accordion_index}">
+<a class="no-underline">
+#{heading}
+</a>
+</div>
+<div id="collapseAccordion#{@_accordion_index}" class="panel-collapse collapse">
+<div class="panel-body" markdown="1">
+
+            END
+          end
+
+          def _stop_accordion
+            <<-END
+
+</div>
+</div>
+</div>
+            END
+          end
+
+          def _start_test_flow_table
+            if @_test_flow_table_open
+              ''
+            else
+              @_test_flow_table_open = true
+              <<-END
+<table class="table table-condensed table-bordered flow-table">
+
+<thead>
+<tr>
+<th class="col1">Test</th>
+<th class="col2">Number</th>
+<th class="col3">HBin</th>
+<th class="col3">SBin</th>
+<th class="col5">Attributes</th>
+<th class="col6">Description</th>
+</tr>
+</thead>
+
+<tbody>
+              END
+            end
+          end
+
+          def _stop_test_flow_table
+            if @_test_flow_table_open
+              @_test_flow_table_open = false
+              <<-END
+
+</tbody>
+</table>
+              END
+            else
+              ''
+            end
+          end
+        end
+        include TestFlowHelpers
+
+        # Helpers for the searchable doc layout
+        module SearchableHelpers
+          def _doc_root_dir(options)
+            f = options[:root]
+            @_doc_root_dirs ||= {}
+            return @_doc_root_dirs[f] if @_doc_root_dirs[f]
+            unless File.exist?(f)
+              f = Pathname.new("#{Origen.root}/templates/web/#{f}")
+              unless f.exist?
+                fail "#{options[:root]} does not exist!"
+              end
+            end
+            f = Pathname.new(f) if f.is_a?(String)
+            @_doc_root_dirs[options[:root]] = f
+          end
+
+          def _resolve_tab(options)
+            tab = tab.to_s.downcase
+            active = false
+            if options[:tab]
+              options[:tab]
+            else
+              rel = options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
+              rel.gsub(/(\/|\\)/, '_').downcase.to_sym
+            end
+          end
+
+          def _root_path(options)
+            root = Pathname.new("#{Origen.root}/templates/web")
+            _doc_root_dir(options).relative_path_from(root)
+          end
+        end
+        include SearchableHelpers
+      end
+      include DocHelpers
+    end
+  end
+end

data/lib/origen_doc_helpers.rb

@@ -0,0 +1,2 @@
+require_relative '../config/application.rb'
+require_relative '../config/environment.rb'

data/lib/origen_doc_helpers/doc_interface.rb

@@ -0,0 +1,74 @@
+module OrigenDocHelpers
+  class DocInterface
+    include Origen::Tester::Doc::Generator
+
+    def initialize(_options = {})
+    end
+
+    def log(_msg)
+    end
+
+    def instance_name(name, options = {})
+      name = pattern_name(name)
+      if options[:vdd] || options[:vdd] != :nom
+        name += "_#{options[:vdd]}"
+      end
+      name
+    end
+
+    def pattern_name(name, _options = {})
+      name.to_s
+    end
+
+    def vdd_loop(options)
+      [options[:vdd]].flatten.each do |vdd|
+        yield options.merge(vdd: vdd)
+      end
+    end
+
+    def func(name, options = {})
+      options = {
+        vdd:  [:min, :max],
+        type: :functional
+      }.merge(options)
+      vdd_loop(options) do |options|
+        test = add_test name, options
+        add_flow_entry(test, options)
+      end
+    end
+
+    def para(name, options = {})
+      options = {
+        vdd:  [:min, :max],
+        type: :parametric
+      }.merge(options)
+      vdd_loop(options) do |options|
+        test = add_test name, options
+        add_flow_entry(test, options)
+      end
+    end
+
+    def add_pattern(name, options = {})
+      options[:pattern] = pattern_name(name, options)
+      options
+    end
+
+    def add_test(name, options)
+      options = {
+      }.merge(options)
+      # Delete any keys that we don't want to assign to the instance, this keeps
+      # the attributes efficient, flow control keys will be screened by Origen
+      [:bin, :tnum, :tname, :continue
+      ].each { |k| options.delete(k) }
+      tests.add(instance_name(name, options), add_pattern(name, options))
+    end
+
+    def add_flow_entry(test, options)
+      options = {
+        number:   options[:bin] * 1000,
+        soft_bin: options[:bin]
+      }.merge(options)
+      flow.test test, options
+    end
+  end
+end