cross_origen 0.7.0 → 1.0.0

data/templates/web/index.md.erb

@@ -32,8 +32,8 @@ spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version
 Currently the following formats are supported:
 
 * IP-XACT - Import and Export registers and hierarchy
+* CMSIS-SVD - Import 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...
@@ -41,17 +41,17 @@ 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.
+to a <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
+a 3rd party repository 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
+class MyDevice
 
   include CrossOrigen
 
@@ -61,14 +61,31 @@ class D_IP_ANA_TEST_ANNEX_SYN
     # 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.
+The given file(s) will be parsed the first time the model is instantiated, which could take some time
+depending on the amount of data being imported.
+
+During the import process, the data from the files will be converted to Origen native format and stored
+to the application's `vendor` directory. You should check these generated files into your revision control
+system, although you should refrain from modifying them by hand since edits will be lost if the import
+process is repeated in future.
+
+On subsequent model instantiations, the `cr_import` method will recognize that the data has already been
+imported and it will load directly from the `vendor` dir. Generally speaking, this will make the model
+instantiation time instant, regardless of how much data was originally imported.
+
+If you obtain a new version of the 3rd party source file, it can be re-imported by passing a
+`refresh` option to `cr_import`:
+
+~~~ruby
+cr_import(path: "#{Origen.root}/imports/test-annex-Block-registers.xml", refresh: true)
+~~~
+
+Or, a global refresh (meaning every `cr_import` that is encountered with a given Origen command) can be
+invoked by passing the `--refresh` option to any Origen command which will instantiate the model you
+wish to refresh.
 
 #### Data Export
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cross_origen
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.32'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -47,22 +47,18 @@ extra_rdoc_files: []
 files:
 - bin/fix_my_workspace
 - config/application.rb
+- config/boot.rb
 - config/commands.rb
-- config/development.rb
-- config/environment.rb
 - config/shared_commands.rb
-- config/users.rb
 - config/version.rb
 - lib/cross_origen.rb
 - lib/cross_origen/cmsis_svd.rb
-- lib/cross_origen/commands/import.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
+- lib/cross_origen_dev/dut.rb
 - templates/headers/default.h.erb
 - templates/ralf/_register.ralf.erb
 - templates/ralf/default.ralf.erb
@@ -91,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -99,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Translators for importing and exporting Origen data to/from 3rd party formats

data/config/environment.rb

@@ -1,36 +0,0 @@
-# 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 CrossOrigen
-  autoload :XMLDoc,       "cross_origen/xml_doc"
-  autoload :Headers,      "cross_origen/headers"
-  autoload :Ralf,         "cross_origen/ralf"
-  autoload :IpXact,       "cross_origen/ip_xact"
-  autoload :DesignSync,   "cross_origen/design_sync"
-  autoload :OrigenFormat, "cross_origen/origen_format"
-  autoload :CMSISSVD,     "cross_origen/cmsis_svd"
-end
-require "cross_origen"

data/config/users.rb

@@ -1,18 +0,0 @@
-# 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/lib/cross_origen/commands/import.rb

@@ -1,32 +0,0 @@
-options = {}
-opt_parser = OptionParser.new do |opts|
-  opts.banner = <<-END
-Usage: origen cr:import FILE [options]
-
-Import the given file into Origen format.
-This will output a Ruby module that can then be included in an Origen model
-to add the contained registers, sub-blocks, etc.
-
-END
-  opts.on('-o', '--output PATH', String, 'Override the default output file') { |t| options[:output] = t }
-end
-opt_parser.parse! ARGV
-
-file = ARGV[0]
-unless file
-  puts 'You must supply a file to import!'
-  exit
-end
-
-unless File.exist?(file)
-  puts 'That file does not exist!'
-  exit
-end
-
-snippet = IO.read(file, 2000)  # Read first 2000 characters
-case snippet
-when /CMSIS-SVD.xsd/
-  CrossOrigen::CMSISSVD.new(nil).import(file, options)
-else
-  puts 'Unknown file format!'
-end