cross_origen 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aa045609ddda2f3de9f4fe4851f7ab31201e2b1bfcf2021caffabe3b0f0a3bd
-  data.tar.gz: a34da76233dad5ad6110c6632a0061b9b5092f380922effc4ad537c998adf6cf
+  metadata.gz: 35a60a3e6d7c885124b967554e3a15c32a7d8ea620d2aacd34e36b1ce099ef43
+  data.tar.gz: f6741edebdbd6550bab8daeeeefcda732d888ad3375607adb8e39ab0a4d34f2b
 SHA512:
-  metadata.gz: ac3d2456ce9fa735d504a76640a5cd6b68901eb7d1c669bef46057d3f404c06186f3da57f2c47ad0dc2993180dcf892c874a12db6d7f0bc2a28a5bb2d1707035
-  data.tar.gz: 58941b7e05d5c9e82eaccf8057d823e6ddb5380c24aaf2e97cbaa2788a935f29b52d215b2035941b24135ed70768094bc9d169874605ac391d6ba83574181c15
+  metadata.gz: 15a36522acdd01ff0f5511257a086a86bd4c88e34dac9519a07a0e8d60d6eccb2cc9dffe26c95a5c861a0c76f569bb0e7643e6ec4c33c77fc74fb8535156f990
+  data.tar.gz: 1c55b07316700190e8b4cc6dbe03171dbaf94722429c667115cc1ac4d738edba2df75b3c8da465baac0b4fbbc6bb375e4170b9e9078c6ed595c93554ea39bc02

data/config/version.rb

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

data/lib/cross_origen/ip_xact.rb

@@ -137,7 +137,7 @@ module CrossOrigen
         end
       end
       model.export(filename, include_timestamp: CrossOrigen.include_timestamp?)
-      owner.import(filename)
+      owner.import(filename, options)
     end
 
     def doc(path, options = {})
@@ -168,6 +168,7 @@ xsi:schemaLocation="$REGMEM_HOME/builder/ipxact/schema/ipxact
     #   :bus_interface      = only 'AMBA3' supported at this time
     #   :mmap_name          = Optionally set the memoryMap name to something other than the module name
     #   :mmap_ref           = memoryMapRef name, ex: 'UserMap'
+    #   :addr_block_name    = addressBlock -> Name, ex: 'ATX'
     def owner_to_xml(options = {})
       require 'nokogiri'
 
@@ -257,7 +258,11 @@ xsi:schemaLocation="$REGMEM_HOME/builder/ipxact/schema/ipxact
                   spirit.addressBlock do
                     # When registers reside at the top level, do not assign an address block name
                     if sub_block == owner
-                      spirit.name nil
+                      if options[:addr_block_name].nil?
+                        spirit.name nil
+                      else
+                        spirit.name options[:addr_block_name]
+                      end
                     else
                       spirit.name address_block_name(domain_name, sub_block)
                     end
@@ -324,9 +329,8 @@ xsi:schemaLocation="$REGMEM_HOME/builder/ipxact/schema/ipxact
                             # greatly between devices, allow the user to provide an abs_path value
                             # and define "full_reg_path" to assist.
                             #
-                            # When registers reside at the top level of the memory map, assume "top"
-                            # for the register path name.  (Need to improve this process in the future.)
-                            if reg.owner.top_level? == true
+                            # When registers reside at the top level without a specified path, use 'top'.
+                            if reg.owner.path.nil? || reg.owner.path.empty?
                               regpath = 'top'
                             else
                               regpath = reg.owner.path
@@ -406,7 +410,11 @@ xsi:schemaLocation="$REGMEM_HOME/builder/ipxact/schema/ipxact
                 end
                 # Assume byte addressing if not specified
                 if owner.methods.include?(:lau) == false
-                  spirit.addressUnitBits 8
+                  if methods.include?(:lau) == true
+                    spirit.addressUnitBits lau
+                  else
+                    spirit.addressUnitBits 8
+                  end
                 else
                   spirit.addressUnitBits owner.lau
                 end
@@ -423,7 +431,6 @@ xsi:schemaLocation="$REGMEM_HOME/builder/ipxact/schema/ipxact
       #
       builder.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS |
                                 Nokogiri::XML::Node::SaveOptions::FORMAT)
-      # builder.to_xml
     end
 
     private

data/lib/cross_origen_dev/dut.rb

@@ -70,6 +70,10 @@ module CrossOrigenDev
           # 0 | Clock is the externally supplied bus clock bus_clk
           # 1 | Clock is the internal oscillator from the hardblock
           bit 15, :osch, reset: 1, access: :rw
+          # **Divider Value**
+          #
+          # Used to set clock divider value and test multi-bit import in CrossOrigen
+          bits 3..0, :div
         end
 
         # **Access Type Test Register**

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

@@ -1,6 +1,6 @@
 % render "layouts/basic.html", tab: :examples do
 
-## IP-XACT Export
+## IP-XACT Export (Spirit 1.4)
 
 This page shows IP-XACT formatted XML that has been generated from an Origen
 representation of a module.

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

@@ -0,0 +1,32 @@
+% render "layouts/basic.html", tab: :examples do
+
+## IP-XACT Export (IEEE 1685-2009)
+
+This page shows IEEE 1685-2009 IP-XACT formatted XML that has been generated from an Origen
+representation of a module.
+
+The exporter has the following options:
+
+* **:format** - nil by default, can be set to :uvm to include the associated vendor
+  extentions
+* **:include_bit_field_values** - true by default, when false the bit field values 
+  fields will not be output
+* **:schema** - nil by default, which assumes a Spirit 1.4 format. '1685-2009' is also supported.
+* **:mmap_name** - nil by default, can be set to any string name for the memory map name.
+* **:mmap_ref** - nil by default, can be set to any string name for the memory map reference used by a downstream tool.
+* **:vendor** - nil by default, can be set to any string name for the company name.
+* **:library** - nil by default, can be set to any string name for the library used by a downstream tool (ex: Magillem XML -> UVM conversion)
+%#* **:name** - nil by default, can be set to any string name for the an overall device/model name.
+%#* **:bus_interface** - nil by default, can be set to 'AMBA3' for an AMBA3 bus interface.
+
+For this example, targeting CrossOrigen's target/debug.rb, the code to generate this page is:
+
+~~~eruby
+<%= "<" + "%= $dut.to_ip_xact :format => :uvm, :schema=> '1685-2009', :mmap_name => 'RegisterMap', :vendor => 'origen-sdk.org', :library => 'id', :mmap_ref => 'test' %" + ">" %>
+~~~
+
+~~~xml
+<%= $dut.to_ip_xact :format => :uvm, :schema=> '1685-2009', :mmap_name => 'RegisterMap', :vendor => 'origen-sdk.org', :library => 'id', :mmap_ref => 'test' %>
+~~~
+
+% end

data/templates/web/examples.md.erb

@@ -6,7 +6,8 @@ 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" %>)
+* [Spirit 1.4 IP-XACT Export](<%= path "examples/ip_xact_export" %>)
+* [IEEE 1685-2009 IP-XACT Export](<%= path "examples/ip_xact_export_1685_2009" %>)
 * [RALF Export](<%= path "examples/ralf_export" %>)
 * [Origen Export](<%= path "examples/origen_export" %>)
 

data/templates/web/index.md.erb

@@ -35,7 +35,7 @@ Currently the following formats are supported:
 * CMSIS-SVD - Import registers and hierarchy
 * RALF (Synopsys format) - Export registers
 
-See the [examples](<%= path "examples" %>) for format specific documentation, but
+See the [Examples](<%= path "examples" %>) for format specific documentation, but
 most formats should follow this basic structure...
 
 #### Data Import  
@@ -100,7 +100,9 @@ and then compiled through Origen:
 <%= "<" + "%= $dut.to_ip_xact %" + ">" %>
 ~~~
 
-In future support may be added to export directly to a 3rd party tool if
+Please explore the [Examples](<%= path "examples" %>) page to see the differences between Spirit 1.4 and IEEE 1685-2009 IP-XACT export settings.
+
+In the 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cross_origen
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: 0.59.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: 0.59.7
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 description: 
@@ -45,7 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
@@ -72,6 +71,7 @@ files:
 - templates/web/example.md.erb
 - templates/web/examples.md.erb
 - templates/web/examples/ip_xact_export.md.erb
+- templates/web/examples/ip_xact_export_1685_2009.md.erb
 - templates/web/examples/origen_export.md.erb
 - templates/web/examples/ralf_export.md.erb
 - templates/web/index.md.erb
@@ -96,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Translators for importing and exporting Origen data to/from 3rd party formats

data/bin/fix_my_workspace

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-$VERBOSE = nil  # Don't care about world writable dir warnings and the like
-
-if $_fix_my_workspace_version_check
-  $_fix_my_workspace_version = '0.7.0'
-else
-  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
-    # If this script is being run from within an origen-core workspace, use that Origen-core,
-    # not the system-installed origen-core version.
-    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-    require 'origen'
-  else
-    # Use system-installed Origen (the gem in system Ruby)
-    require 'origen'
-  end
-
-  if !Origen.site_config.gem_manage_bundler
-    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
-    puts 'that I cannot make certain assumptions about how your workspace is configured.'
-    puts 'You will need to either resolve this problem yourself, or else change the value of'
-    puts 'gem_mange_bundler to true.'
-    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
-
-  else
-    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
-    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
-    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
-
-    # Force copy system gems to local gems
-    if Origen.site_config.gem_use_from_system
-      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
-      gem_dir = Pathname.new(Gem.dir)
-
-      Origen.site_config.gem_use_from_system.each do |gem, version|
-        begin
-          # This will raise an error if the system doesn't have this gem installed, that
-          # will be rescued below
-          spec = Gem::Specification.find_by_name(gem, version)
-
-          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
-          FileUtils.mkdir_p local_dir
-          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.cache_file, local_file)
-
-          if spec.extension_dir && File.exist?(spec.extension_dir)
-            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
-            FileUtils.mkdir_p local_dir
-            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
-          end
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.spec_file, local_file)
-
-        rescue Gem::LoadError
-          # This just means that one of the gems that should be copied from the system
-          # was not actually installed in the system, so nothing we can do about that here
-        end
-      end
-    end
-
-    # Delete lbin
-    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
-
-    # Run bundler with correct switches
-    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
-    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
-    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
-    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
-
-    # Try again, this time updating the bundle
-    if system(cmd)
-      fixed = true
-    elsif system 'bundle update'
-      fixed = true
-    end
-
-    if File.exist?(ENV['BUNDLE_BIN'])
-      `chmod o-w #{ENV['BUNDLE_BIN']}`
-
-      # Make .bat versions of all executables, Bundler should really be doing this when running
-      # on windows
-      if Origen.os.windows?
-        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
-          unless bin =~ /.bat$/
-            bat = "#{bin}.bat"
-            unless File.exist?(bat)
-              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
-            end
-          end
-        end
-      end
-    end
-
-    system 'origen -v' if fixed
-  end
-end