origen_memory_image 0.6.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: caf8c439a35b5f220e8274b6626673ee7525271a
-  data.tar.gz: ec7fbf5149451f4ec2f92f4f9e9cbb4757ffd897
+SHA256:
+  metadata.gz: 2d9b91a3a905b3801a9d96ee96fe7494baf3c201d1b3ee34107599923ff0763a
+  data.tar.gz: d66b83fcd77afac1ed13754871d9fab2952760f2ad5fc17b6709904ef6a48c6d
 SHA512:
-  metadata.gz: 94959863f2afed01b3300650b793209631118c11fca988b89b30bdc162497974a53423c87c2538c84569448f98f1ed7ba77f198983c24b11e67f27fc5e0b929d
-  data.tar.gz: feb360c36844b949e4463956ab81d69e5e0dfee76b094fee1acf149ef946cb27b3f0c79ec77748dc6003be23bbe918d7bb35fa77665a7e40a7c0eb528a7f2553
+  metadata.gz: f6fedde88b97b4661fb9773d6780497ba995f07114661ba3c94b5ca842c818dc59592e40758c387ce7f8361b1cf68977c40aba88c0a864a3a3ab751a9a118e0b
+  data.tar.gz: 7a712d8374d57ae31dd11454cc7985084988ca90e3d883205b3738bc1ac48c2e45bb89054c6a9a816efd1b57096e17220da099508a634eb915af9760a7114a8d

data/config/version.rb

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

data/lib/origen_memory_image.rb

@@ -6,6 +6,7 @@ module OrigenMemoryImage
   autoload :SRecord, 'origen_memory_image/s_record'
   autoload :Hex, 'origen_memory_image/hex'
   autoload :Binary, 'origen_memory_image/binary'
+  autoload :IntelHex, 'origen_memory_image/intel_hex'
 
   def self.new(file, options = {})
     unless options[:source] == String
@@ -20,7 +21,7 @@ module OrigenMemoryImage
     if options[:source] == String
       snippet = file.split("\n")
     else
-      snippet = File.foreach(file.to_s).first(1)
+      snippet = File.foreach(file.to_s).first(10)
     end
     case
     # Always do the binary first since the others won't be able to process
@@ -31,6 +32,8 @@ module OrigenMemoryImage
       Binary
     when options[:type] == :srecord || SRecord.match?(snippet)
       SRecord
+    when options[:type] == :intel_hex || IntelHex.match?(snippet)
+      IntelHex
     when options[:type] == :hex || Hex.match?(snippet)
       Hex
     else

data/lib/origen_memory_image/base.rb

@@ -8,6 +8,7 @@ module OrigenMemoryImage
       else
         @file = file
       end
+      @ljust_partial_data = options[:ljust_partial_data]
     end
 
     # Returns the code execution start address as an int
@@ -15,6 +16,13 @@ module OrigenMemoryImage
       fail "#{self.class} has not implemented the start_address method!"
     end
 
+    # Returns true if a start (jump address) record exists
+    def has_start_record
+      start_address unless @start_address
+      @start_record_found = false if @start_record_found.nil?
+      @start_record_found
+    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
@@ -50,7 +58,7 @@ module OrigenMemoryImage
 
       if options[:flip_endianness] || options[:endianness_change]
         data.map do |v|
-          [v[0], flip_endianness(v[1], 4)]
+          [v[0], flip_endianness(v[1], options[:data_width_in_bytes])]
         end
       else
         data

data/lib/origen_memory_image/binary.rb

@@ -1,12 +1,12 @@
-require 'ptools'
-
 module OrigenMemoryImage
   class Binary < Base
     def self.match?(file, snippet = false)
       if snippet
         file.all? { |l| l.strip =~ /^[01]*$/ }
       else
-        File.binary?(file)
+        # detect whether the data is mostly not alpha numeric
+        filedata = (File.read(file, 256) || '')
+        (filedata.gsub(/\s+/, '').gsub(/\w/, '').length.to_f / filedata.length.to_f) > 0.3
       end
     end
 

data/lib/origen_memory_image/hex.rb

@@ -46,7 +46,11 @@ module OrigenMemoryImage
           end
           # If a partial word is left over
           if (remainder = data.length % (2 * options[:data_width_in_bytes])) > 0
-            result << [@address, data[data.length - remainder..data.length].to_i(16)]
+            if @ljust_partial_data
+              result << [@address, data[data.length - remainder..data.length].ljust(options[:data_width_in_bytes] * 2, '0').to_i(16)]
+            else
+              result << [@address, data[data.length - remainder..data.length].to_i(16)]
+            end
           end
         end
       end

data/lib/origen_memory_image/intel_hex.rb

@@ -0,0 +1,98 @@
+module OrigenMemoryImage
+  class IntelHex < Base
+    def self.match?(snippet)
+      snippet.all? do |line|
+        line.empty? || line =~ /^:[0-9A-Fa-f]{6}0[0-5]/
+      end
+    end
+
+    def start_address
+      @start_address ||= begin
+        addrs = []
+        lines.each do |line|
+          line = line.strip
+          if start_linear_address?(line)
+            addrs << decode(line)[:data].to_i(16)
+          end
+        end
+        addrs.last || 0
+      end
+    end
+
+    private
+
+    def decode(line)
+      d = {}
+      if line =~ /^:([0-9A-Fa-f]{2})([0-9A-Fa-f]{4})(\d\d)([0-9A-Fa-f]+)([0-9A-Fa-f]{2})$/
+        d[:byte_count] = Regexp.last_match(1).to_i(16)
+        d[:address] = Regexp.last_match(2).to_i(16)
+        d[:record_type] = Regexp.last_match(3).to_i(16)
+        d[:data] = Regexp.last_match(4)
+        d[:checksum] = Regexp.last_match(5).to_i(16)
+      else
+        fail "Invalid line encountered in Intel Hex formatted file: #{line}"
+      end
+      d
+    end
+
+    def data?(line)
+      !!(line =~ /^:[0-9A-Fa-f]{6}00/)
+    end
+
+    def extended_segment_address?(line)
+      !!(line =~ /^:[0-9A-Fa-f]{6}02/)
+    end
+
+    def extended_linear_address?(line)
+      !!(line =~ /^:[0-9A-Fa-f]{6}04/)
+    end
+
+    def start_linear_address?(line)
+      !!(line =~ /^:[0-9A-Fa-f]{6}05/)
+    end
+
+    def upper_addr
+      @upper_addr || 0
+    end
+
+    def segment_address
+      @segment_address || 0
+    end
+
+    # Returns an array containing all address/data from the given s-record
+    # No address manipulation is performed, that is left to the caller to apply
+    # any scrambling as required by the target system
+    def extract_addr_data(options = {})
+      options = {
+        data_width_in_bytes: 4
+      }.merge(options)
+
+      result = []
+      lines.each do |line|
+        line = line.strip
+        if extended_segment_address?(line)
+          @segment_address = decode(line)[:data].to_i(16) * 16
+
+        elsif extended_linear_address?(line)
+          @upper_addr = (decode(line)[:data].to_i(16)) << 16
+
+        elsif data?(line)
+          d = decode(line)
+          addr = d[:address] + segment_address + upper_addr
+
+          data = d[:data]
+          data_matcher = '\w\w' * options[:data_width_in_bytes]
+          data.scan(/#{data_matcher}/).each do |data_packet|
+            result << [addr, data_packet.to_i(16)]
+            addr += options[:data_width_in_bytes]
+          end
+          # If a partial word is left over
+          if (remainder = data.length % (2 * options[:data_width_in_bytes])) > 0
+            result << [addr, data[data.length - remainder..data.length].to_i(16)]
+          end
+        end
+      end
+      result
+    end
+  end
+end

data/lib/origen_memory_image/s_record.rb

@@ -156,9 +156,16 @@ module OrigenMemoryImage
     end
 
     def start_address
+      if @call_order_warn
+        Origen.log.warn 'Previously srec.start_address returned the lowest address when to_a was called first. Now the start record is always returned if present.'
+        @call_order_warn = false
+      end
+
+      lowest_address = nil
       @start_address ||= begin
         lines.each do |line|
           if line =~ /^S([789])(.*)/
+            @start_record_found = true
             type = Regexp.last_match[1]
             case type
             when '7'
@@ -169,7 +176,19 @@ module OrigenMemoryImage
               return line.slice(4, 4).to_i(16)
             end
           end
+          if line =~ /^S([1-3])/
+            type = Regexp.last_match[1].to_i(16)    # S-record type, 1-3
+            # Set the matcher to capture x number of bytes dependent on the s-rec type
+            addr_matcher = '\w\w' * (1 + type)
+            line.strip =~ /^S\d\w\w(#{addr_matcher})(\w*)\w\w$/   # $1 = address, $2 = data
+            addr = Regexp.last_match[1].to_i(16)
+            lowest_address ||= addr
+            lowest_address = addr if addr < lowest_address
+          end
         end
+        # if no start_address record is found, return lowest address
+        @start_record_found = false
+        lowest_address
       end
     end
 
@@ -183,6 +202,12 @@ module OrigenMemoryImage
         data_width_in_bytes: 4
       }.merge(options)
 
+      # guarantee that the start_address will be the jump address if provided
+      if @start_address.nil?
+        start_address
+        @call_order_warn = @start_record_found ? true : false
+      end
+
       result = []
       lines.each do |line|
         # Only if the line is an s-record with data...
@@ -192,8 +217,6 @@ module OrigenMemoryImage
           addr_matcher = '\w\w' * (1 + type)
           line.strip =~ /^S\d\w\w(#{addr_matcher})(\w*)\w\w$/   # $1 = address, $2 = data
           addr = Regexp.last_match[1].to_i(16)
-          @start_address ||= addr
-          @start_address = addr if addr < @start_address
           data = Regexp.last_match[2]
           data_matcher = '\w\w' * options[:data_width_in_bytes]
           data.scan(/#{data_matcher}/).each do |data_packet|
@@ -202,7 +225,11 @@ module OrigenMemoryImage
           end
           # If a partial word is left over
           if (remainder = data.length % (2 * options[:data_width_in_bytes])) > 0
-            result << [addr, data[data.length - remainder..data.length].to_i(16)]
+            if @ljust_partial_data
+              result << [addr, data[data.length - remainder..data.length].ljust(options[:data_width_in_bytes] * 2, '0').to_i(16)]
+            else
+              result << [addr, data[data.length - remainder..data.length].to_i(16)]
+            end
           end
         end
       end

data/templates/web/index.md.erb

@@ -58,6 +58,25 @@ my_srec = OrigenMemoryImage.new("source_files/test_atd.abs.S19")
 my_hex  = OrigenMemoryImage.new("source_files/math.hex")
 ~~~
 
+By default any partial data words are right justified. Change this behavior to left justified like this:
+
+~~~ruby
+my_srec = OrigenMemoryImage.new("source_files/test_atd.abs.S19", ljust_partial_data: true)
+my_hex  = OrigenMemoryImage.new("source_files/math.hex", ljust_partial_data: true)
+~~~
+
+Partial data example:
+
+~~~
+0304FE
+
+# Default interpretation into 32-bit word:
+0x0003_04FE
+
+# Left justified interpretation into 32-bit word:
+0x0304_FE00
+~~~
+
 Memory images can also be created directly from a string:
 
 ~~~ruby
@@ -72,10 +91,14 @@ my_hex = OrigenMemoryImage.new(str, source: String)
 
 Every memory image object then supports a common API.
 
-The <code>start_address</code> method returns the start (execution start) address:
+The <code>start_address</code> method returns the start (execution start) address. If the memory image
+ contains an indication of the execution start address that record value will be returned. If there is
+ no start address record, the lowest address will be returned. The <code>has_start_record</code> method
+ indicates whether a start address record was found:
 
 ~~~ruby
-my_srec.start_address   # => 0x3000_F000
+my_srec.start_address         # => 0x3000_F000
+my_srec.has_start_record      # => true
 ~~~
 
 The <code>to_a</code> method returns the file content as an array of address/data pairs,
@@ -146,6 +169,21 @@ A binary file:
 00000100000000110000010100000110
 ~~~
 
+#### Intel Hex
+
+Any valid Intel Hex file:
+
+~~~text
+:020000040022D8
+:10010000214601360121470136007EFE09D2190140
+:100110002146017E17C20001FF5F16002148011928
+:020000040023D7
+:10012000194E79234623965778239EDA3F01B2CAA7
+:100130003F0156702B5E712B722B732146013421C7
+:0400000500000000F7
+:00000001FF
+~~~
+
 ### How To Setup a Development Environment
 
 [Clone the repository from Github](https://github.com/Origen-SDK/origen_memory_image).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_memory_image
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.2
-- !ruby/object:Gem::Dependency
-  name: ptools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: origen_doc_helpers
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +53,7 @@ files:
 - lib/origen_memory_image/base.rb
 - lib/origen_memory_image/binary.rb
 - lib/origen_memory_image/hex.rb
+- lib/origen_memory_image/intel_hex.rb
 - lib/origen_memory_image/s_record.rb
 - templates/web/index.md.erb
 - templates/web/layouts/_basic.html.erb
@@ -90,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Provides a standard API for consuming memory image files in any format e.g.