origen_memory_image 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 156973c1439c8b4c9c52c513e13844f72fbf5eb0
-  data.tar.gz: d2242a10853a388d3ef02858efb7002788c33004
+  metadata.gz: 8fec944c638cdeb76b9e37fdf83ae317ec7e9f53
+  data.tar.gz: bc3297a56990c9cc90c56703d85fb02580ff6c8d
 SHA512:
-  metadata.gz: 493474925808d5ace7cbb726265178b3d228f509d42362cce5eb22446e97661c575b3ae4e701946cbd14dc188de36d022041c9716d77e12bdaf3dba7f829650c
-  data.tar.gz: ee145f067f12cfa4dcf1d17cfd9b2c89f28a2f3a70fd3f18684f60e5043b3f6e1a1a450512d11589265a1297fb2a099b1485d461684d8dc48d2704129c39dc10
+  metadata.gz: 26ec0c6e32abc1bdbd96201a5a5f6806f264f433da79a7e9bee20ab0f559d4459f64cfa11118423de7611030fda8592d6ba7ccd2975e39ea1bcd89ec0324d553
+  data.tar.gz: 6942c9160474094178f968a800104a13f5392f3abd34befc00bbdf55c9046e05738a8bb4d459428825b0dc1292bca745fdbf1620fc0cba6f98283b28b245a9eb

data/config/application.rb

@@ -1,87 +1,87 @@
-class OrigenMemoryImageApplication < Origen::Application
-  
-  # To share resources with the apps that import this plugin uncomment the following attribute:
-  #config.shared = {
-  # Add the dir/file of patterns that needs to be shared 
-  #  patterns: "pattern/shared",
-  # Add the file which includes all commands that needs the be shared with the app that imports
-  # this plugin in :command_launcher attribute
-  #  command_launcher: "config/shared_commands.rb",
-  # Shared templates go in the :templates attribute
-  #  templates: "templates/shared_templates",
-  # Shared programs go in the :programs attributes
-  #  programs: "programs/shared"
-  #}
-
-  # This information is used in headers and email templates, set it specific
-  # to your application
-  config.name     = "Origen Memory Image"
-  config.initials = "OrigenMemoryImage"
-  config.rc_url   = "git@github.com:Origen-SDK/origen_memory_image.git"
-  config.release_externally = true
-
-  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/memory_image"
-  config.web_domain = "http://origen-sdk.org/memory_image"
-
-  # 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.freescale.net/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
-
-  # 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
-
-  # Similary 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
-
-  # Run the tests before deploying to generate test coverage numbers
-  def before_deploy_site
-    Dir.chdir Origen.root do
-      #system "origen examples -c"
-      system "origen specs -c"
-      dir = "#{Origen.root}/web/output/coverage"       
-      FileUtils.remove_dir(dir, true) if File.exists?(dir) 
-      system "mv #{Origen.root}/coverage #{dir}"
-    end
-  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
-
-end
+class OrigenMemoryImageApplication < Origen::Application
+  
+  # To share resources with the apps that import this plugin uncomment the following attribute:
+  #config.shared = {
+  # Add the dir/file of patterns that needs to be shared 
+  #  patterns: "pattern/shared",
+  # Add the file which includes all commands that needs the be shared with the app that imports
+  # this plugin in :command_launcher attribute
+  #  command_launcher: "config/shared_commands.rb",
+  # Shared templates go in the :templates attribute
+  #  templates: "templates/shared_templates",
+  # Shared programs go in the :programs attributes
+  #  programs: "programs/shared"
+  #}
+
+  # This information is used in headers and email templates, set it specific
+  # to your application
+  config.name     = "Origen Memory Image"
+  config.initials = "OrigenMemoryImage"
+  config.rc_url   = "git@github.com:Origen-SDK/origen_memory_image.git"
+  config.release_externally = true
+
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/memory_image"
+  config.web_domain = "http://origen-sdk.org/memory_image"
+
+  # 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.freescale.net/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
+
+  # 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
+
+  # Similary 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
+
+  # Run the tests before deploying to generate test coverage numbers
+  def before_deploy_site
+    Dir.chdir Origen.root do
+      #system "origen examples -c"
+      system "origen specs -c"
+      dir = "#{Origen.root}/web/output/coverage"       
+      FileUtils.remove_dir(dir, true) if File.exists?(dir) 
+      system "mv #{Origen.root}/coverage #{dir}"
+    end
+  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
+
+end

data/config/boot.rb

@@ -1 +1 @@
-require "origen_memory_image"
+require "origen_memory_image"

data/config/commands.rb

@@ -1,62 +1,62 @@
-# This file should be used to extend the origen command line tool with tasks 
-# specific to your application.
-#
-# Also see the official docs on adding commands:
-#   http://origen-sdk.org/origen/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
-
-# Run the unit tests  
-when "specs"
-  require "rspec"
-  exit RSpec::Core::Runner.run(['spec'])
-
-# Run the example-based (diff) 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.
-# 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
- specs        Run the specs (tests), -c will enable coverage
-  EOT
-# examples     Run the examples (tests), -c will enable coverage
-
-end 
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+#
+# Also see the official docs on adding commands:
+#   http://origen-sdk.org/origen/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
+
+# Run the unit tests  
+when "specs"
+  require "rspec"
+  exit RSpec::Core::Runner.run(['spec'])
+
+# Run the example-based (diff) 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.
+# 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
+ specs        Run the specs (tests), -c will enable coverage
+  EOT
+# examples     Run the examples (tests), -c will enable coverage
+
+end 

data/config/version.rb

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

data/lib/origen_memory_image.rb

@@ -1,40 +1,40 @@
-require 'origen'
-require_relative '../config/application.rb'
-
-module OrigenMemoryImage
-  autoload :Base, 'origen_memory_image/base'
-  autoload :SRecord, 'origen_memory_image/s_record'
-  autoload :Hex, 'origen_memory_image/hex'
-  autoload :Binary, 'origen_memory_image/binary'
-
-  def self.new(file, options = {})
-    unless options[:source] == String
-      file = Origen.file_handler.clean_path_to(file)
-    end
-    find_type(file, options).new(file, options)
-  end
-
-  # Returns the class of the image manager for the given file
-  def self.find_type(file, options = {})
-    # Read first 10 lines
-    if options[:source] == String
-      snippet = file.split("\n")
-    else
-      snippet = File.foreach(file.to_s).first(1)
-    end
-    case
-    # Always do the binary first since the others won't be able to process
-    # a binary snippet
-    when options[:type] == :binary || (options[:source] != String && Binary.match?(file))
-      Binary
-    when options[:source] == String && Binary.match?(snippet, true)
-      Binary
-    when options[:type] == :srecord || SRecord.match?(snippet)
-      SRecord
-    when options[:type] == :hex || Hex.match?(snippet)
-      Hex
-    else
-      fail "Unknown format for image file: #{file}"
-    end
-  end
-end
+require 'origen'
+require_relative '../config/application.rb'
+
+module OrigenMemoryImage
+  autoload :Base, 'origen_memory_image/base'
+  autoload :SRecord, 'origen_memory_image/s_record'
+  autoload :Hex, 'origen_memory_image/hex'
+  autoload :Binary, 'origen_memory_image/binary'
+
+  def self.new(file, options = {})
+    unless options[:source] == String
+      file = Origen.file_handler.clean_path_to(file)
+    end
+    find_type(file, options).new(file, options)
+  end
+
+  # Returns the class of the image manager for the given file
+  def self.find_type(file, options = {})
+    # Read first 10 lines
+    if options[:source] == String
+      snippet = file.split("\n")
+    else
+      snippet = File.foreach(file.to_s).first(1)
+    end
+    case
+    # Always do the binary first since the others won't be able to process
+    # a binary snippet
+    when options[:type] == :binary || (options[:source] != String && Binary.match?(file))
+      Binary
+    when options[:source] == String && Binary.match?(snippet, true)
+      Binary
+    when options[:type] == :srecord || SRecord.match?(snippet)
+      SRecord
+    when options[:type] == :hex || Hex.match?(snippet)
+      Hex
+    else
+      fail "Unknown format for image file: #{file}"
+    end
+  end
+end

data/lib/origen_memory_image/base.rb

@@ -1,88 +1,88 @@
-module OrigenMemoryImage
-  class Base
-    attr_reader :file, :source
-
-    def initialize(file, options = {})
-      if options[:source] == String
-        @source = file
-      else
-        @file = file
-      end
-    end
-
-    # Returns the code execution start address as an int
-    def start_address
-      fail "#{self.class} has not implemented the start_address method!"
-    end
-
-    # Returns the s-record as an array of addresses and data
-    #
-    # @param [hash] options, allows the selection of endianness swapping - ie the output will have the endianness changed
-    #
-    # The output is a 2D array, with each element being an array with element zero being the
-    # address of the data and element one being one word of data
-    # like this [[ADDR0, DATA0], [ADDR1, DATA1], [ADDR2, DATA2]...]
-    #
-    # The block header data and end of block value are not interpreted in any way and
-    # the checksum bits are disregarded
-    def to_a(options = {})
-      options = {
-        flip_endianness:     false,
-        data_width_in_bytes: 4,
-        crop:                []
-      }.merge(options)
-      data = extract_addr_data(options)
-
-      if options[:crop].count > 0
-        cropped_data = []
-        data.each do |addr, data|
-          case options[:crop].count
-            when 1
-              cropped_data.push([addr, data]) if addr >= options[:crop][0]
-            when 2
-              cropped_data.push([addr, data]) if addr >= options[:crop][0] && addr <= options[:crop][1]
-            else
-              fail 'crop option can only be array of size 1 or 2'
-          end
-        end
-        data = cropped_data
-      end
-
-      if options[:flip_endianness] || options[:endianness_change]
-        data.map do |v|
-          [v[0], flip_endianness(v[1], options[:data_width_in_bytes])]
-        end
-      else
-        data
-      end
-    end
-    alias_method :to_array, :to_a
-
-    # Reverse the endianness of the given data value, the width of it in bytes must
-    # be supplied as the second argument
-    #
-    # @example
-    #   flip_endianness(0x12345678, 4)  # => 0x78563412
-    def flip_endianness(data, width_in_bytes)
-      v = 0
-      width_in_bytes.times do |i|
-        # data[7:0] => data[15:8]
-        start = 8 * i
-        v += data[(start + 7)..start] << ((width_in_bytes - i - 1) * 8)
-      end
-      v
-    end
-
-    def file_name
-      file || 'From source string'
-    end
-
-    def lines
-      if file
-        File.readlines(file)
-      else
-        source.split("\n")
-      end
-    end
-  end
-end
+module OrigenMemoryImage
+  class Base
+    attr_reader :file, :source
+
+    def initialize(file, options = {})
+      if options[:source] == String
+        @source = file
+      else
+        @file = file
+      end
+    end
+
+    # Returns the code execution start address as an int
+    def start_address
+      fail "#{self.class} has not implemented the start_address method!"
+    end
+
+    # Returns the s-record as an array of addresses and data
+    #
+    # @param [hash] options, allows the selection of endianness swapping - ie the output will have the endianness changed
+    #
+    # The output is a 2D array, with each element being an array with element zero being the
+    # address of the data and element one being one word of data
+    # like this [[ADDR0, DATA0], [ADDR1, DATA1], [ADDR2, DATA2]...]
+    #
+    # The block header data and end of block value are not interpreted in any way and
+    # the checksum bits are disregarded
+    def to_a(options = {})
+      options = {
+        flip_endianness:     false,
+        data_width_in_bytes: 4,
+        crop:                []
+      }.merge(options)
+      data = extract_addr_data(options)
+
+      if options[:crop].count > 0
+        cropped_data = []
+        data.each do |addr, data|
+          case options[:crop].count
+            when 1
+              cropped_data.push([addr, data]) if addr >= options[:crop][0]
+            when 2
+              cropped_data.push([addr, data]) if addr >= options[:crop][0] && addr <= options[:crop][1]
+            else
+              fail 'crop option can only be array of size 1 or 2'
+          end
+        end
+        data = cropped_data
+      end
+
+      if options[:flip_endianness] || options[:endianness_change]
+        data.map do |v|
+          [v[0], flip_endianness(v[1], options[:data_width_in_bytes])]
+        end
+      else
+        data
+      end
+    end
+    alias_method :to_array, :to_a
+
+    # Reverse the endianness of the given data value, the width of it in bytes must
+    # be supplied as the second argument
+    #
+    # @example
+    #   flip_endianness(0x12345678, 4)  # => 0x78563412
+    def flip_endianness(data, width_in_bytes)
+      v = 0
+      width_in_bytes.times do |i|
+        # data[7:0] => data[15:8]
+        start = 8 * i
+        v += data[(start + 7)..start] << ((width_in_bytes - i - 1) * 8)
+      end
+      v
+    end
+
+    def file_name
+      file || 'From source string'
+    end
+
+    def lines
+      if file
+        File.readlines(file)
+      else
+        source.split("\n")
+      end
+    end
+  end
+end