origen_memory_image 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f929c547d4a00df7450faf892f6f4ebed1c56d18b64e9315d810dd7774f55c
-  data.tar.gz: e209715c41348a5975f549f27babdc1d4e2c0473f6e935fff12148d2f2e7a5f0
+  metadata.gz: 2d9b91a3a905b3801a9d96ee96fe7494baf3c201d1b3ee34107599923ff0763a
+  data.tar.gz: d66b83fcd77afac1ed13754871d9fab2952760f2ad5fc17b6709904ef6a48c6d
 SHA512:
-  metadata.gz: 2319ac1964ce679181d45b9b79343604a90aad3149d3015ab1e8daf3e1edaf2045bf41aaba40680f371131f6278a363187caf2407b60fd7508cb4ecdc3792cdc
-  data.tar.gz: c8dae0921e4490b7a108cfbbb0a1ef0d93585fe8191c8e61dd2ef3debf624bd6333771d2f7ee24de638cb265f33653729e8def0e7bcc6812eeac689470f89a90
+  metadata.gz: f6fedde88b97b4661fb9773d6780497ba995f07114661ba3c94b5ca842c818dc59592e40758c387ce7f8361b1cf68977c40aba88c0a864a3a3ab751a9a118e0b
+  data.tar.gz: 7a712d8374d57ae31dd11454cc7985084988ca90e3d883205b3738bc1ac48c2e45bb89054c6a9a816efd1b57096e17220da099508a634eb915af9760a7114a8d

data/config/version.rb

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

data/lib/origen_memory_image/base.rb

@@ -16,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

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|

data/templates/web/index.md.erb

@@ -91,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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_memory_image
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen