cross_origen 0.5.0

data/templates/web/examples/origen_export.md.erb

@@ -0,0 +1,96 @@
+% render "layouts/basic.html", tab: :examples do
+
+## Origen Export
+
+This page shows how to create static read-only Ruby files from
+models created by importing 3rd party data (e.g. IP-XACT). The Ruby files can then be
+used for day-day running of your application and this will significantly improve
+the boot up speed vs. re-importing the data every time.
+
+The Ruby files can be periodically refreshed as new versions of the master
+data are released.
+
+The user only need provide the output path where they want the
+Ruby files to be written.
+
+### Implementation
+
+Here is an example of how to create the static Ruby files.
+
+~~~ruby
+$dut.to_origen(path: "#{Origen.root}/output/exported")
+~~~
+
+### Output
+
+At the output path the following files are created:
+
+* top_level.rb: The top-level object, this is the one that should be instantiated
+
+~~~ruby
+# This file is created by Origen, CrossOrigen::OrigenFormat#export, and is read-only
+require_relative 'sub_blocks'
+module CrossOrigen
+  module Test
+    class DUT
+      include Origen::Model
+
+      def initialize(options = {})
+        sub_block :atx, base_address: 0xDEADBEEF, class_name: 'ATX'
+        sub_block # ...
+      end
+    end
+  end
+end
+~~~
+
+* sub_blocks.rb: include file for the sub_block class files
+
+~~~ruby
+# This file is created by Origen, CrossOrigen::OrigenFormat#export, and is read-only
+require_relative 'import/atx.rb'
+require_relative # ...
+~~~
+
+* import/\<sub_block\>.rb: models the individual sub_block object
+
+~~~ruby
+# -*- encoding : utf-8 -*-
+# This file is created by Origen, CrossOrigen::OrigenFormat#export, and is read-only.
+# If you need to make changes, re-open the class
+module CrossOrigen
+  module Test
+    class DUT
+      class ATX # rubocop:disable ClassLength
+        include Origen::Model
+
+        def initialize(options = {})
+          instantiate_registers(options)
+        end
+
+        # rubocop:disable LineLength
+        # rubocop:disable StringLiterals
+        def instantiate_registers(options = {}) # rubocop:disable MethodLength
+          # ** MGATE Clock Divider Register **
+          # The MCLKDIV register is used to divide down the frequency of the HBOSCCLK input. If the MCLKDIV
+          # register is set to value "N", then the output (beat) frequency of the clock divider is OSCCLK / (N+1). The
+          # resulting beats are, in turn, counted by the PTIMER module to control the duration of Flash high-voltage
+          # operations.
+          reg :mclkdiv, 0x0, size: 16 do |reg|
+            # **Oscillator (Hi)** - Firmware FMU clk source selection. (Note that in addition to this firmware-controlled bit, the
+            # FMU clock source is also dependent on test and power control discretes).
+            # 
+            # 0 | FMU clock is the externally supplied bus clock ipg_clk
+            # 1 | FMU clock is the internal oscillator from the TFS hardblock
+            reg.bit 15, :osch, reset: 0b1, access: :rw
+            # ...
+          end
+          # ...
+        end
+      end
+    end
+  end
+end
+~~~
+
+% end

data/templates/web/examples/ralf_export.md.erb

@@ -0,0 +1,18 @@
+% render "layouts/basic.html", tab: :examples do
+
+## RALF Export
+
+This page shows RALF (Synopsys) formatted output that has been generated from an Origen
+representation of a module.
+
+The code to generate this page was simply:
+
+~~~eruby
+<%= "<" + "%= $dut.to_ralf %" + ">" %>
+~~~
+
+~~~text
+<%= $dut.to_ralf %>
+~~~
+
+% end

data/templates/web/examples.md.erb

@@ -0,0 +1,13 @@
+% render "layouts/basic.html", tab: :examples do
+
+# Examples
+
+The following examples are available which are used for testing but
+also provide some code examples of how to use the plugin for the various
+supported formats:
+
+* [IP-XACT Export](<%= path "examples/ip_xact_export" %>)
+* [RALF Export](<%= path "examples/ralf_export" %>)
+* [Origen Export](<%= path "examples/origen_export" %>)
+
+% end

data/templates/web/index.md.erb

@@ -0,0 +1,104 @@
+% 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.config.name %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Purpose
+
+In an ideal world everyone would use Origen, but in reality there are many different
+'standards' used to represent design data. This plugin
+provides APIs and templates to import and export data to formats supported by 3rd
+party tools.
+
+### How To Import
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+or if your application is a plugin add this to your .gemspec
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+### How To Use
+
+#### Supported Formats
+
+Currently the following formats are supported:
+
+* IP-XACT - Import and Export registers and hierarchy
+* RALF (Synopsys format) - Export registers
+* Origen - Export registers and hierarchy
+
+See the [examples](<%= path "examples" %>) for format specific documentation, but
+most formats should follow this basic structure...
+
+#### Data Import  
+
+When the <code>CrossOrigen</code> module is included in a class it gets access
+to an <code>cr_import</code> method.
+This will automatically detect the type of the given file and select the appropriate
+import rules.
+
+The file to be imported must exist locally or it can be pulled automatically from
+a 3rd party respository in which case the file will be fetched the first time Origen
+is invoked and then cached locally for future invocations.
+Supported repositories are shown in the example below.
+
+~~~ruby
+class D_IP_ANA_TEST_ANNEX_SYN
+
+  include CrossOrigen
+
+  def initialize
+    # Import from a local file
+    cr_import(path: "#{Origen.root}/imports/test-annex-Block-registers.xml")
+    # Import from Design Sync
+    cr_import(vault: "sync://sync-15040:15040/Projects/nvm_c90tfsn2w/ftf2/rtl_v/kx2_4m/.regs", version: "ftf2_kx2_4096k2_256_128k_64_4k.00.00.01.00") 
+  end
+
+end
+~~~
+
+The plugin will add attribute getter and setter methods to the top-level object and to registers and bits
+to contain any metadata information which does not have a direct equivalent within Origen. Generally
+the name given to such data will be the lower cased and underscored (following std Ruby
+conventions) version of the attribute name.
+
+#### Data Export
+
+The <code>CrossOrigen</code> module adds some methods to export the given object
+as a string in the given format, for example a <code>to_ip_xact</code> method is available
+to generate an IP-XACT XML representation of an object.
+
+To create an actual XML file a simple template would be setup as shown below
+and then compiled through Origen:
+
+~~~eruby
+<%= "<" + "%= $dut.to_ip_xact %" + ">" %>
+~~~
+
+In future support may be added to export directly to a 3rd party tool if
+it provides such an API.
+
+### How To Setup a Development Environment
+
+[Clone the repository from Github](https://github.com/Origen-SDK/cross_origen).
+
+Follow the instructions here if you want to make a 3rd party app
+workspace use your development copy of the <%= Origen.app.config.initials %> plugin:
+[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/latest/guides/plugins)
+
+This plugin also contains a test suite, make sure this passes before committing
+any changes!
+
+~~~text
+origen test
+~~~
+
+% end

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

@@ -0,0 +1,13 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= 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/layouts/_doc.html.erb

@@ -0,0 +1,61 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "templates/web/partials/navbar.html", tab: :docs %>
+
+%# Add/edit sections here, the code below will expand this with the correct markup, 
+%# pass in the topic you want selected via the :tab option.
+% s = {}
+% s["Environment"] = {
+%   environment_introduction: "Introduction",
+%   environment_installation: "Installation",
+%   environment_definitions: "Definitions and Acronyms",
+% }
+% s["Targets"] = {
+%   targets_introduction: "Introduction",
+%   targets_supported: "Supported",
+% }
+% s["Developers"] = {
+%   developers_branching: "Making Branches",
+% }
+
+
+
+<div class="row">
+  <div class="span3">
+    <div class="well sidebar-nav">
+        <div class="accordion" id="sidebar-accordion">
+
+% s.each_with_index do |(subject, sections), i|          
+          <div class="accordion-group">
+            <div class="accordion-heading">
+              <a class="accordion-toggle" data-toggle="collapse" data-parent="#sidebar-accordion" href="#sidebar-collapse-<%= i %>">
+                <%= subject %>
+              </a>
+            </div>
+            <div id="sidebar-collapse-<%= i %>" class="accordion-body collapse <%= sections.has_key?(options[:tab]) ? 'in' : '' %>">
+              <div class="accordion-inner">
+                <ul class="nav nav-list">
+%   sections.each do |tab, section|
+% paths = tab.to_s.split("_")
+<li class="<%= tab == options[:tab] ? 'active' : '' %>"><a href="<%= path "/docs/#{paths[0]}/#{paths[1]}" %>"><%= section %></a></li>
+%   end          
+                </ul>
+              </div>
+            </div>
+          </div>
+% end          
+
+        </div>
+
+    </div>
+  </div>
+
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span9" markdown="1">
+<%= yield %>    
+%# Also important to avoid indentation on return here, since otherwise it could be interpreted
+%# as mardown code
+</div>
+</div>

data/templates/web/partials/_navbar.html.erb

@@ -0,0 +1,23 @@
+<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] == :examples ? 'active' : '' %>"><a href="<%= path "/examples" %>">Examples</a></li>
+        <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] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+        <li><a href="https://github.com/Origen-SDK/origen_jtag">Github</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,117 @@
+--- !ruby/object:Gem::Specification
+name: cross_origen
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 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: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: origen_doc_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+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/cross_origen.rb
+- lib/cross_origen/design_sync.rb
+- lib/cross_origen/headers.rb
+- lib/cross_origen/ip_xact.rb
+- lib/cross_origen/origen_format.rb
+- lib/cross_origen/ralf.rb
+- lib/cross_origen/test/dut.rb
+- lib/cross_origen/xml_doc.rb
+- templates/headers/default.h.erb
+- templates/ralf/_register.ralf.erb
+- templates/ralf/default.ralf.erb
+- templates/test/default.ralf.erb
+- templates/test/headers_default.h.erb
+- templates/test/ip_xact.xml.erb
+- templates/web/_history.md
+- templates/web/example.md.erb
+- templates/web/examples.md.erb
+- templates/web/examples/ip_xact_export.md.erb
+- templates/web/examples/origen_export.md.erb
+- templates/web/examples/ralf_export.md.erb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/layouts/_doc.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: http://origen-sdk.org/cross_origen
+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: Translators for importing and exporting Origen data to/from 3rd party formats
+test_files: []
+has_rdoc: