rsrec 0.0.2

data/History.txt

@@ -0,0 +1,10 @@
+=== 0.0.2 / 2013-05-18
+* Minor cleanup
+  * Updated gem dependencies
+  * Added coverage analysis in the tests
+  * Increased test coverage
+  * split the version in it's own file
+
+=== 0.0.1 / 2012-06-19
+* Initial release
+  * Parses SREC files and does all the checks

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+lib/rsrec.rb
+lib/rsrec/version.rb
+test/test_rsrec.rb

data/README.txt

@@ -0,0 +1,48 @@
+= rsrec
+
+https://github.com/damphyr/rsrec
+
+== DESCRIPTION:
+
+Parser for the Motorola S-Record format
+
+== REQUIREMENTS:
+
+None, this is pure Ruby man!
+
+== INSTALL:
+
+* sudo gem install rsrec
+
+== What the hell is SREC?
+It's a hex text encoding for binary data. Really something you would use in embedded systems.
+
+For more on the format check http://en.wikipedia.org/wiki/SREC_(file_format)
+
+== Why?
+Cause we need to parse these things and peek and poke at specific addresses before flashing. And it's a text format, which makes Ruby ideal.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Vassilis Rizopoulos
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/rsrec.rb

@@ -0,0 +1,154 @@
+require 'rsrec/version'
+module S19
+  class SRecordError < RuntimeError
+  end
+
+  #Represents a line in the S-Record format
+  #
+  #http://en.wikipedia.org/wiki/SREC_%28file_format%29
+  class SRecord
+    attr_reader :binary,:data,:record_type,:byte_count,:address
+    def initialize rtype,addr,data
+      self.record_type= rtype
+      @address = addr
+      self.data=data
+    end
+
+    def to_s
+      "S#{@record_type}#{"%02x"% @byte_count}#{format_address}#{@data}#{crc}".upcase
+    end
+    #Returns the S-Record CRC 
+    def crc
+      SRecord.calculate_crc("#{"%02x"% @byte_count}#{format_address}#{@data}")
+    end
+    #Parses a single line in SREC format and returns an SRecord instance
+    def self.parse text_data
+      text_data.chomp!
+      #duplicate because we're slicing and dicing and throwing stuff away
+      line=text_data.dup
+      #the (0..0) is for 1.8.7 compatibility, in 1.9 it gives the sliced char back
+      if line.slice!(0..0)=='S'
+        record_type = line.slice!(0..0).to_i
+        #convert everything to hex
+        #take out the byte count
+        line.slice!(0..1).to_i(16)
+        address = calculate_address(record_type,line)
+        #take out the crc
+        line.slice!(-2..-1)
+        data = line
+        check_crc(text_data)
+        return SRecord.new(record_type,address,data)
+      else
+        raise SRecordError,"Line without leading S"
+      end
+    end
+    #True if the record is of type 1,2 or 3
+    def data_record?
+      [1,2,3].include?(@record_type)
+    end
+    private
+    #Set the data.
+    #
+    #pld is just the payload in hex text format (2nhex digits pro byte)
+    def data= pld
+      @data=pld
+      @binary=SRecord.extract_data(pld)
+      #number of bytes in address+data+checksum (checksum is 1 byte)
+      @byte_count=format_address.size/2+@binary.size+1
+    end
+    #Raises SRecordError if supplied with an invalid record type
+    def record_type= rtype
+      case rtype
+      when 0,1,2,3,4,5,6,7,8,9
+        @record_type=rtype
+      else
+        raise SRecordError,"Invalid record type: '#{rtype}'. Should be a number"
+      end
+    end
+    #String representation of the address left padded with 0s
+    def format_address 
+      case @record_type
+        when 0,1,5,9
+          return "%04x"% @address
+        when 2,8
+          return "%06x"% @address
+        when 3,7
+          return "%08x"% @address
+      end
+    end
+    #Gets 2n chars and converts them to hex
+    #
+    #n depends on the record type
+    def self.calculate_address record_type,line
+      case record_type
+        when 0,1,5,9
+        #2 character pairs
+          address=line.slice!(0..3).to_i(16)
+        when 2,8
+        #3 character pairs
+          address=line.slice!(0..5).to_i(16)
+        when 3,7
+        #4 character pairs
+          address=line.slice!(0..7).to_i(16)
+      else
+          raise SRecordError,"Cannot calculate address. Unknown record type #{@record_type}"
+      end
+      return address
+    end
+    #From an SREC text line calculate the CRC and check it against the embedded CRC
+    def self.check_crc raw_data
+      line = raw_data.dup
+      #chop of the S, the record type and the crc
+      line.slice!(0..1)
+      crc=line.slice!(-2..-1)
+      calculated_crc=calculate_crc(line)
+      if calculated_crc.upcase == crc.upcase
+        return crc
+      else
+        raise SRecordError, "CRC failure: #{calculated_crc} instead of #{crc}"
+      end
+    end
+    
+    def self.calculate_crc line_data
+      data=extract_data(line_data)
+      data_sum=data.inject(0){|sum,item| sum + item}
+      #least significant byte is
+      lsb=data_sum & 0xFF
+      #1's complement of lsb and in hex string format
+      ("%02x"% (lsb^0xFF)).upcase
+    end
+    #Converts 2n hex characters in n bytes
+    def self.extract_data data_string
+      line=data_string.dup
+      binary=[]
+      while !line.empty?
+        data_chars = line.slice!(0..1)
+        binary<<data_chars.to_i(16)
+      end
+      return binary
+    end
+  end
+
+  class MotFile
+    attr_reader :records
+    def initialize records=[]
+      @records=records
+    end
+    def to_s
+      @records.each_with_object(""){|record,msg| msg<<"#{record}\n"}
+    end
+    #Just the data records
+    def data_records
+      @records.select{|rec| rec.data_record?}.compact
+    end
+    #The total size of the image in bytes
+    def image_size
+      data_records.last.address+data_records.last.binary.size-data_records.first.address
+    end
+    #Parses a .mot file in memory, returns MotFile
+    def self.from_file filename
+      records=File.readlines(filename).map{|line| SRecord.parse(line)}
+      MotFile.new(records)
+    end
+  end
+end

data/lib/rsrec/version.rb

@@ -0,0 +1,8 @@
+module S19
+  module Version
+    MAJOR = 0
+    MINOR = 0 
+    TINY = 2
+    STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
+  end
+end

data/test/test_rsrec.rb

@@ -0,0 +1,57 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require 'simplecov'
+SimpleCov.start
+require "test/unit"
+require "rsrec"
+
+class TestRsrec < Test::Unit::TestCase
+  def test_version
+    assert_equal(S19::Version::STRING, "#{S19::Version::MAJOR}.#{S19::Version::MINOR}.#{S19::Version::TINY}")
+  end
+  
+  def test_srecord
+    test_record="S00E00005065726675736F726D6F744B"
+    srec=nil
+    assert_nothing_raised(S19::SRecordError) { srec=S19::SRecord.parse(test_record) }
+    assert_not_nil(srec)
+    assert_equal(test_record, srec.to_s)
+    assert_equal(0, srec.record_type)
+    assert_equal(14, srec.byte_count)
+    assert_equal("4B", srec.crc)
+    assert(!srec.data_record?, "Not a data record")
+  end
+  
+  def test_srecord_crc
+    test_record="S00E00005065726675736F726D6F744A"
+    srec=nil
+    assert_raise(S19::SRecordError) { srec=S19::SRecord.parse(test_record) }
+  end
+  
+  def test_trimming
+    test_record="S00E00005065726675736F726D6F744B\n"
+    assert_nothing_raised(S19::SRecordError) { S19::SRecord.parse(test_record) }
+    test_record="S00E00005065726675736F726D6F744B\r"
+    assert_nothing_raised(S19::SRecordError) { S19::SRecord.parse(test_record) }
+    test_record="S00E00005065726675736F726D6F744B\r\n"
+    assert_nothing_raised(S19::SRecordError) { S19::SRecord.parse(test_record) }
+  end
+
+  def test_format_checks
+    test_record="BF00726D6F744A"
+    assert_raise(S19::SRecordError) { S19::SRecord.parse(test_record) }
+    assert_raise(S19::SRecordError) { S19::SRecord.new(15,0x0405,"FOO") }
+  end
+
+  def test_data_records
+    test_record="S11F001C4BFFFFE5398000007D83637880010014382100107C0803A64E800020E9"
+    srec=nil
+    assert_nothing_raised(S19::SRecordError) { srec=S19::SRecord.parse(test_record) }
+    assert(srec.data_record?, "A data record")
+    test_record="S5030003F9"
+    assert_nothing_raised(S19::SRecordError) { srec=S19::SRecord.parse(test_record) }
+    assert(!srec.data_record?, "Not a data record")
+    test_record="S9030000FC"
+    assert_nothing_raised(S19::SRecordError) { srec=S19::SRecord.parse(test_record) }
+    assert(!srec.data_record?, "Not a data record")
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rsrec
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Vassilis Rizopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: ! 'https://github.com/damphyr/rsrec
+
+
+  == DESCRIPTION:
+
+
+  Parser for the Motorola S-Record format
+
+
+  == REQUIREMENTS:
+
+
+  None, this is pure Ruby man!'
+email:
+- vassilisrizopoulos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- lib/rsrec.rb
+- lib/rsrec/version.rb
+- test/test_rsrec.rb
+- .gemtest
+homepage: http://github.com/damphyr/rsrec
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -639295409136969064
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rsrec
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: rsrec provides classes for parsing Motorola's S-Record format
+test_files:
+- test/test_rsrec.rb