origen_memory_image 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d364a5cedbccf382fae2a6bf7732604387fbdaf1
+  data.tar.gz: 87baaf7587ea2ee10562844104638ccc1bc46252
+SHA512:
+  metadata.gz: d6873cb75247b6fbc0924706c982f6b0d7edf980b8137d791e48c7a3344336254f85b5e352a6ced1170c9b3a112614cc47a0375d6d9dcfdf0e3496cba3a7d218
+  data.tar.gz: c4afd730adea6589dce1bb53cf243283c39a66b6257681db1888c4e84274abdd3704453b74de010b647ba97b9acec4ef31d12d26041e9b1f10c952f606bbc1c8

data/config/application.rb

@@ -0,0 +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

data/config/commands.rb

@@ -0,0 +1,107 @@
+# This file should be used to extend the origen command line tool with tasks 
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/origen/commands.rb in your Origen core workspace for more examples and 
+# inspiration.
+#
+# Also see the official docs on adding commands:
+#   http://origen.freescale.net/origen/latest/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
+
+# Smome helper methods to enable test coverage, these will eventually be
+# added to Origen Core, but they need to be here for now
+def path_to_coverage_report
+  require 'pathname'
+  Pathname.new("#{Origen.root}/coverage/index.html").relative_path_from(Pathname.pwd)
+end
+
+def enable_coverage(name, merge=true)
+  if ARGV.delete("-c") || ARGV.delete("--coverage")
+    require 'simplecov'
+    SimpleCov.start do
+      command_name name
+      add_filter "DO_NOT_HAND_MODIFY"  # Exclude all imports
+
+      at_exit do
+        SimpleCov.result.format!
+        puts ""
+        puts "To view coverage report:"
+        puts "  firefox #{path_to_coverage_report} &"
+        puts ""
+      end
+    end
+    yield
+  else
+    yield
+  end
+end
+
+# Now branch to the specific task code
+case @command
+
+# Run the unit tests  
+when "specs"
+  enable_coverage("specs") do 
+    ARGV.unshift "spec"
+    require "rspec"
+    # For some unidentified reason Rspec does not autorun on this version
+    if RSpec::Core::Version::STRING && RSpec::Core::Version::STRING == "2.11.1"
+      RSpec::Core::Runner.run ARGV
+    else
+      require "rspec/autorun"
+    end
+  end
+  exit 0 # This will never be hit on a fail, RSpec will automatically exit 1
+
+# Run the example-based (diff) tests
+#when "examples"  
+#  Origen.load_application
+#  status = 0
+#  enable_coverage("examples") do 
+#
+#    # 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 ""
+#  end
+#  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
+
+  # Uncomment the following and update the path with the file
+  # that handles the commands that are shared from this plugin
+  #require "#{Origen.app_root}/config/shared_commands"
+
+end 

data/config/development.rb

@@ -0,0 +1,12 @@
+# This file is similar to environment.rb and will be loaded
+# automatically at the start of each invocation of Origen.
+#
+# However the major difference is that it will not be loaded
+# if the application is imported by a 3rd party app - in that
+# case only environment.rb is loaded.
+#
+# Therefore this file should be used to load anything you need
+# to setup a development environment for this app, normally
+# this would be used to load some dummy classes to instantiate
+# your objects so that they can be tested and/or interacted with
+# in the console.

data/config/environment.rb

@@ -0,0 +1,40 @@
+# 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.
+#
+# Examples
+# --------
+# 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 plugin, 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"
+
+# Plugins should not use a wildcard import of the lib directory to help
+# prevent long start up times, only require what is necessary to boot and
+# use autoload for everything else.
+module OrigenMemoryImage
+  autoload :Base, "origen_memory_image/base"
+  autoload :SRecord, "origen_memory_image/s_record"
+  autoload :Hex, "origen_memory_image/hex"
+end
+require "origen_memory_image"

data/config/users.rb

@@ -0,0 +1,18 @@
+# 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/config/version.rb

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

data/lib/origen_memory_image/base.rb

@@ -0,0 +1,71 @@
+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
+      }.merge(options)
+      data = extract_addr_data(options)
+      if options[:flip_endianness] || options[:endianness_change]
+        data.map do |v|
+          [v[0], flip_endianness(v[1], 4)]
+        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

data/lib/origen_memory_image/hex.rb

@@ -0,0 +1,56 @@
+module OrigenMemoryImage
+  class Hex < Base
+    def self.match?(snippet)
+      snippet.any? do |line|
+        # Match a line like:
+        # @180000F0
+        line =~ /^@[0-9a-fA-F]+\s?$/
+      end
+    end
+
+    # The first in the file will be taken as the start address
+    def start_address
+      @start_address ||= begin
+        lines.each do |line|
+          if line =~ /^@([0-9a-fA-F]+)\s?$/
+            return Regexp.last_match[1].to_i(16)
+          end
+        end
+      end
+    end
+
+    private
+
+    # 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|
+        # Only if the line is an s-record with data...
+        if line =~ /^@([0-9a-fA-F]+)\s?$/
+          @address = Regexp.last_match[1].to_i(16)
+        elsif line =~ /^[0-9A-F]/
+          unless @address
+            fail "Hex data found before an @address line in #{file_name}"
+          end
+          data = line.strip.gsub(/\s/, '')
+          data_matcher = '\w\w' * options[:data_width_in_bytes]
+          data.scan(/#{data_matcher}/).each do |data_packet|
+            result << [@address, data_packet.to_i(16)]
+            @address += 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 << [@address, data[data.length - remainder..data.length].to_i(16)]
+          end
+        end
+      end
+      result
+    end
+  end
+end

data/lib/origen_memory_image/s_record.rb

@@ -0,0 +1,212 @@
+module OrigenMemoryImage
+  # An S-record file consists of a sequence of specially formatted ASCII character strings. An S-record will
+  # be less than or equal to 78 bytes in length.
+  # The order of S-records within a file is of no significance and no particular order may be assumed.
+  #
+  # The general format of an S-record follows:
+  #
+  #   +-------------------//------------------//-----------------------+
+  #   | type | count | address  |            data           | checksum |
+  #   +-------------------//------------------//-----------------------+
+  #
+  # type
+  # : A char[2] field. These characters describe the type of record (S0, S1, S2, S3, S5, S7, S8, or S9).
+  #
+  # count
+  # : A char[2] field. These characters when paired and interpreted as a hexadecimal value, display
+  # the count of remaining character pairs in the record.
+  #
+  # address
+  # : A char[4,6, or 8] field. These characters grouped and interpreted as a hexadecimal value,
+  # display the address at which the data field is to be loaded into memory. The length of the field depends
+  # on the number of bytes necessary to hold the address. A 2-byte address uses 4 characters, a 3-byte
+  # address uses 6 characters, and a 4-byte address uses 8 characters.
+  #
+  # data
+  # : A char [0-64] field. These characters when paired and interpreted as hexadecimal values represent
+  # the memory loadable data or descriptive information.
+  #
+  # checksum
+  # : A char[2] field. These characters when paired and interpreted as a hexadecimal value display
+  # the least significant byte of the ones complement of the sum of the byte values represented by the pairs
+  # of characters making up the count, the address, and the data fields.
+  #
+  # Each record is terminated with a line feed. If any additional or different record terminator(s) or delay
+  # characters are needed during transmission to the target system it is the responsibility of the
+  # transmitting program to provide them.
+  #
+  # #### S0 Record
+  #
+  # The type of record is 'S0' (0x5330). The address field is unused and will be filled with zeros
+  # (0x0000). The header information within the data field is divided into the following subfields.
+  #
+  # * mname is char[20] and is the module name.
+  # * ver is char[2] and is the version number.
+  # * rev is char[2] and is the revision number.
+  # * description is char[0-36] and is a text comment.
+  #
+  # Each of the subfields is composed of ASCII bytes whose associated characters, when paired, represent one
+  # byte hexadecimal values in the case of the version and revision numbers, or represent the hexadecimal
+  # values of the ASCII characters comprising the module name and description.
+  #
+  # #### S1 Record
+  #
+  # The type of record field is 'S1' (0x5331). The address field is intrepreted as a 2-byte
+  # address. The data field is composed of memory loadable data.
+  #
+  # #### S2 Record
+  #
+  # The type of record field is 'S2' (0x5332). The address field is intrepreted as a 3-byte
+  # address. The data field is composed of memory loadable data.
+  #
+  # #### S3 Record
+  #
+  # The type of record field is 'S3' (0x5333). The address field is intrepreted as a 4-byte
+  # address. The data field is composed of memory loadable data.
+  #
+  # #### S5 Record
+  #
+  # The type of record field is 'S5' (0x5335). The address field is intrepreted as a 2-byte value
+  # and contains the count of S1, S2, and S3 records previously transmitted. There is no data field.
+  #
+  # #### S7 Record
+  #
+  # The type of record field is 'S7' (0x5337). The address field contains the starting execution
+  # address and is intrepreted as 4-byte address. There is no data field.
+  #
+  # #### S8 Record
+  #
+  # The type of record field is 'S8' (0x5338). The address field contains the starting execution
+  # address and is intrepreted as 3-byte address. There is no data field.
+  #
+  # #### S9 Record
+  #
+  # The type of record field is 'S9' (0x5339). The address field contains the starting execution
+  # address and is intrepreted as 2-byte address. There is no data field.
+  #
+  # ### Example
+  #
+  # Shown below is a typical S-record format file.
+  #
+  #   S00600004844521B
+  #   S1130000285F245F2212226A000424290008237C2A
+  #   S11300100002000800082629001853812341001813
+  #   S113002041E900084E42234300182342000824A952
+  #   S107003000144ED492
+  #   S5030004F8
+  #   S9030000FC
+  #
+  # The file consists of one S0 record, four S1 records, one S5 record and an S9 record.
+  #
+  # The S0 record is comprised as follows:
+  #
+  # * S0 S-record type S0, indicating it is a header record.
+  # * 06 Hexadecimal 06 (decimal 6), indicating that six character pairs (or ASCII bytes) follow.
+  # * 00 00 Four character 2-byte address field, zeroes in this example.
+  # * 48 44 52 ASCII H, D, and R - "HDR".
+  # * 1B The checksum.
+  #
+  # The first S1 record is comprised as follows:
+  #
+  # * S1 S-record type S1, indicating it is a data record to be loaded at a 2-byte address.
+  # * 13 Hexadecimal 13 (decimal 19), indicating that nineteen character pairs, representing a 2 byte address,
+  # * 16 bytes of binary data, and a 1 byte checksum, follow.
+  # * 00 00 Four character 2-byte address field; hexidecimal address 0x0000, where the data which follows is to
+  #   be loaded.
+  # * 28 5F 24 5F 22 12 22 6A 00 04 24 29 00 08 23 7C Sixteen character pairs representing the actual binary
+  #   data.
+  # * 2A The checksum.
+  # * The second and third S1 records each contain 0x13 (19) character pairs and are ended with checksums of 13
+  #   and 52, respectively. The fourth S1 record contains 07 character pairs and has a checksum of 92.
+  #
+  # The S5 record is comprised as follows:
+  #
+  # * S5 S-record type S5, indicating it is a count record indicating the number of S1 records
+  # * 03 Hexadecimal 03 (decimal 3), indicating that three character pairs follow.
+  # * 00 04 Hexadecimal 0004 (decimal 4), indicating that there are four data records previous to this record.
+  # * F8 The checksum.
+  #
+  # The S9 record is comprised as follows:
+  #
+  # * S9 S-record type S9, indicating it is a termination record.
+  # * 03 Hexadecimal 03 (decimal 3), indicating that three character pairs follow.
+  # * 00 00 The address field, hexadecimal 0 (decimal 0) indicating the starting execution address.
+  # * FC The checksum.
+  #
+  # ### Additional Notes
+  #
+  # There isn't any evidence that Motorola ever has made use of the header information within the data field
+  # of the S0 record, as described above. This must have been used by some third party vendors.
+  # This is the only place that a 78-byte limit on total record length or 64-byte limit on data length is
+  # documented. These values shouldn't be trusted for the general case.
+  #
+  # The count field can have values in the range of 0x3 (2 bytes of address + 1 byte checksum = 3, a not
+  # very useful record) to 0xff; this is the count of remaining character pairs, including checksum.
+  # If you write code to convert S-Records, you should always assume that a record can be as long as 514
+  # (decimal) characters in length (255 * 2 = 510, plus 4 characters for the type and count fields), plus
+  # any terminating character(s).
+  #
+  # That is, in establishing an input buffer in C, you would declare it to be
+  # an array of 515 chars, thus leaving room for the terminating null character.
+  class SRecord < Base
+    def self.match?(snippet)
+      snippet.all? do |line|
+        line.empty? || line =~ /^S[01235789]/
+      end
+    end
+
+    def start_address
+      @start_address ||= begin
+        lines.each do |line|
+          if line =~ /^S([789])(.*)/
+            type = Regexp.last_match[1]
+            case type
+            when '7'
+              return line.slice(4, 8).to_i(16)
+            when '8'
+              return line.slice(4, 6).to_i(16)
+            when '9'
+              return line.slice(4, 4).to_i(16)
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    # 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|
+        # Only if the line is an s-record with data...
+        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)
+          @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|
+            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.rb

@@ -0,0 +1,30 @@
+require 'origen'
+require_relative '../config/application.rb'
+require_relative '../config/environment.rb'
+
+module OrigenMemoryImage
+  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
+    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/templates/web/index.md.erb

@@ -0,0 +1,147 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# formatting like this, but in most cases that is not required.
+<h1><%= Origen.config.name %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Purpose
+
+This plugin provides a common API for easily reading memory image files in any format
+so that their contained data can then be used in Origen:
+
+~~~ruby
+# Read in an s-record
+srec = OrigenMemoryImage.new("srecs/test_atd.abs.S19")
+
+# Write it to the DUT, or otherwise work with it, however you like
+srec.to_a.each do |addr, data|
+  $dut.write_memory data, address: addr
+end
+~~~
+
+### How To Import
+
+##### To use in an application:
+
+Add the following to your application's <code>Gemfile</code>:
+
+~~~ruby
+gem 'origen_memory_image', '<%= Origen.app.version %>'
+~~~
+
+##### To use in a plugin:
+
+Add the following to your plugin's gemspec:
+
+~~~ruby
+spec.add_runtime_dependency 'origen_memory_image', '~> <%= Origen.app.version.major %>', '>= <%= Origen.app.version %>'
+~~~
+
+and require the gem in your code:
+
+~~~ruby
+require 'origen_memory_image'
+~~~
+
+
+### How To Use
+
+Create a memory map object that points to a specific source file, note that
+you do not need to supply the format.
+Also note that the format is detected by looking at the file content and the naming
+and extension of the file has no relevance (so it can be called anything).
+
+The path to the file can be absolute or relative to <code>Origen.root</code>:
+
+~~~ruby
+my_srec = OrigenMemoryImage.new("source_files/test_atd.abs.S19")
+my_hex  = OrigenMemoryImage.new("source_files/math.hex")
+~~~
+
+Memory images can also be created directly from a string:
+
+~~~ruby
+str = <<-END
+@2D100E00
+0D 15 0F 13 0E 14 10 12
+00 00 04 17 04 03 05 06
+END
+
+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:
+
+~~~ruby
+my_srec.start_address   # => 0x3000_F000
+~~~
+
+The <code>to_a</code> method returns the file content as an array of address/data pairs,
+this method supports options to set the data width and to flip the data endianness:
+
+~~~ruby
+my_srec.to_a                          # => [[0x3000_F000, 0x11223344], [0x3000_F004, 0x55667788], ...]
+
+my_srec.to_a(flip_endianness: true)   # => [[0x3000_F000, 0x44332211], [0x3000_F004, 0x88776655], ...]
+
+my_srec.to_a(data_width_in_bytes: 2)  # => [[0x3000_F000, 0x1122], [0x3000_F002, 0x3344], [0x3000_F004, 0x5566], ...]
+~~~
+
+Such an array can be iterated on like this to separate the address and data:
+
+~~~ruby
+my_srec.to_a.each do |address, data|
+  # Process as required
+end
+~~~
+
+### Currently Supported Formats
+
+#### S-Records
+
+Any valid S-record:
+
+~~~text
+S017000068656C6C6F5F776F726C645F6576622E73726563D6
+S3153F00002018F09FE518F09FE518F09FE518F09FE55B
+S3153F00003018F09FE500F020E314F09FE514F09FE5EC
+S3113F000270F406003F102100407800003FDC
+S3153F0005B05FF0FF301B4908605FF0FF301A49086063
+S3093F0006F0704700000A
+S7053F000410A7
+~~~
+
+#### Hex Files
+
+The data lines can be grouped into any size:
+
+~~~text
+@18000000
+1E E0 02 1C 22 40 1B E0 02 1C 22 43 18 E0 02 1C 
+5A 78 0A 43 03 E0 03 4B F7 21 5A 78 0A 40 00 20 
+22 E0 84 42 22 D3 1F E0 84 42 1F D9 1C E0 84 42 
+@180000E0
+002B20D1 03E0012A 01D1002B 1BD00223 
+2340022A 02D1002B 15D103E0 032A01D1 
+@180001F0
+780000187C0000188200001888000018 
+~~~
+
+### How To Setup a Development Environment
+
+[Clone the repository from Github](https://github.com/Origen-SDK/origen_memory_image).
+
+Follow the instructions here if you want to make a 3rd party app
+workspace use your development copy of the <%= Origen.app.config.initials %> plugin:
+[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/latest/guides/plugins)
+
+This plugin also contains a test suite, makes sure this passes before committing
+any changes!
+
+~~~text
+origen specs
+~~~
+
+% end

data/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,16 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+analytics: UA-64455560-1
+---
+<%= render "templates/web/partials/navbar.html", tab: options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+<%= disqus_comments %>
+
+</div>
+</div>

data/templates/web/partials/_navbar.html.erb

@@ -0,0 +1,22 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :coverage ? 'active' : '' %>"><a href="<%= path "/coverage" %>">Coverage</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+        <li><a href="https://github.com/Origen-SDK/origen_memory_image">Github</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+% end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: origen_memory_image
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: origen_doc_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- stephen.f.mcginty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/commands.rb
+- config/development.rb
+- config/environment.rb
+- config/users.rb
+- config/version.rb
+- lib/origen_memory_image.rb
+- lib/origen_memory_image/base.rb
+- lib/origen_memory_image/hex.rb
+- lib/origen_memory_image/s_record.rb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: http://origen-sdk.org/memory_image
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a standard API for consuming memory image files in any format e.g.
+  s-record, hex
+test_files: []
+has_rdoc: