msp430_bsl 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5ed6ae2b592007808e73255f2f1de59c096f5b2e5702ad86fb7dea7c586981
-  data.tar.gz: 6c289eaece5e0fe084ddba9f5847c87da017c51db2825c44d4463a6a10db7e7f
+  metadata.gz: 04be185fd24cfefaaf6f4d2ca3c0aa5fc919b912aebd0db25e0ac71a4308d10e
+  data.tar.gz: 228d4f5fe568b5d22e1072d169f8e5292803639b994a407872ed05ef93ad8ee5
 SHA512:
-  metadata.gz: 327080fb207aabed5bdd0df53f84555268eaf251118c935ee9414547bd437df954b8704cfdd969e0a2cf60e296d9b01a9bf600222fd7a2c96a4f8ca423bf43bd
-  data.tar.gz: 3e8b706fc043fa9048b191e44a5deab69790202418dbbeb51ce93e1ea388637b61847c8cc79129ac6ab1d0a5d0cf4f79f4941263f408e975e9d6341058ea1fec
+  metadata.gz: f3597deabec5b77da55ae9d5d89f577c09d351fe4bf376178927c3b8d90f957d3e64e6b8d8a0430a6249c1fb0cc27d9ff0c62d1d3620ee34c4c09aa57d3f8060
+  data.tar.gz: 88c10187a3049aa22a9a3083341399b683d5ad0475e4bbb6d292430f2fdf7ead9b5e723f359442e4706f31d828912a4ae8d5d1f105c19d09e5b5ee38cfb034cf

data/README.md

@@ -20,19 +20,19 @@ Or install it yourself as:
     
 ## Compatibility
 
-Although it's not tested, this library should be compatibile with Ruby 2.7.0 or higher.
+This Gem has been developed with Ruby 3, but has been tested down to Ruby 2.5.0
 
 ## Usage
 
 **Help is appreciated to write some good USAGE**
 
-In the `bin` folder there's the `upload_hex` executable. 
+In the `bin` folder there's the `upload_hex` executable. By installing the gem you'll have it available to use.
+Just run `upload_hex -h` to show available options.
 
-TL;DR: the script can upload a .hex file to the target through a normal UART connection (`rts` and `dtr` pins required). 
+TL;DR: the script can upload a `.hex` file to the target through a normal UART connection (`rts` and `dtr` pins required). 
 
-**The script has been tested only with CC430F5137**
+**The script has been tested only with CC430F5137 - contributions for other chips are welcome**
 
-Just run `bin/upload_hex -h` to show available options.
 
 ## TODO
 

data/bin/upload_hex

@@ -5,13 +5,23 @@ Bundler.require
 require 'slop'
 require_relative '../lib/msp430_bsl'
 
+# Force sync on STDOUT write. This way the logger flushes its output after every write
+STDOUT.sync = true
+
+include Msp430Bsl::Utils
+
+HIGH_SPEED_UART_BAUD = 115200.freeze
+MAX_WRITE_ATTEMPTS = 3
+
+@opts = {}
 begin
-  opts = Slop.parse help: true do |o|
+  @opts = Slop.parse help: true do |o|
     o.string '-d', '--device', 'Mandatory: Path to serial programmer device', required: true
     o.string '-f', '--hexfile', 'Mandatory: Path to HEX file to load', required: true
     o.string '-g', '--logfile', 'Path to logfile'
     o.string '-l', '--loglevel', "Logger level. One of ['fatal', 'error', 'warn', 'info', 'debug']. Defaults to 'debug'", default: :debug
-    o.bool '-c', '--check', 'Verify flash content after upload', default: true
+    o.bool '-e', '--erase_info', 'Erase info memory', default: false  # TODO: implement
+    o.bool '-c', '--check', 'Verify flash content after each data block write', default: true
     o.bool '-h', '--help', 'Print this help' do
       puts "#{o}\n"
       exit
@@ -25,11 +35,9 @@ rescue Slop::UnknownOption => e
   exit
 end
 
-include Msp430Bsl::Utils
+logger = build_logger_from @opts
 
-logger = build_logger_from opts
-
-@board = Msp430Bsl::Uart::Connection.new opts[:device], logger: logger
+@board = Msp430Bsl::Uart::Connection.new @opts[:device], logger: logger
 
 # Enter BSL
 @board.enter_bsl
@@ -37,19 +45,49 @@ logger = build_logger_from opts
 logger.info 'Mass erasing FLASH'
 @board.send_command :mass_erase
 # Unlock BSL protected commands
-logger.info "'Unlocking BSL's password protected commands'"
+logger.info "Unlocking BSL's password protected commands"
 @board.send_command :rx_password, data: Msp430Bsl::Configs::CMD_RX_PASSWORD
 # Switch UART to max speed
 logger.info 'Changing UART BAUD to 115200'
-@board.send_command :change_baud_rate, data: Msp430Bsl::Configs::BAUD_RATES[115200]
-@board.set_uart_speed 115200
+@board.send_command :change_baud_rate, data: Msp430Bsl::Configs::BAUD_RATES[HIGH_SPEED_UART_BAUD]
+@board.set_uart_speed HIGH_SPEED_UART_BAUD
 
 # If everything has gone well so far...
-hexfile = Msp430Bsl::HexFile.new opts[:hexfile]
+hexfile = Msp430Bsl::HexFile.new @opts[:hexfile]
 
 # Group lines by contiguous memory addr
-logger.info 'Writing data into FLASH'
+logger.info 'Writing data to FLASH'
 line_groups = hexfile.data_lines_grouped_by_contiguous_addr
+
+def write_data_packet(lines_packet, check: true)
+  attempts = 0
+  loop do
+    # Write data to FLASH
+    resp = @board.send_command :rx_data_block, addr: lines_packet.first.addr, data: lines_packet.map { |line| line.data }.reduce(:+)
+
+    break resp unless check
+    # Check written data
+    data = lines_packet.map { |line| line.data }.flatten
+    start_addr = lines_packet.first.addr
+    data_len = data.size
+    our_crc = crc16(data)
+
+    resp = @board.send_command :crc_check, addr: start_addr, data: [data_len & 0xFF, (data_len >> 8) & 0xFF]
+    bsl_crc = resp.data[0] | resp.data[1] << 8
+
+    break resp if our_crc == bsl_crc
+
+    attempts += 1
+
+    logger.error "CRC mismatch at addr '0x#{start_addr.to_hex_str}' - Trying again"
+
+    if attempts >= MAX_WRITE_ATTEMPTS
+      logger.fatal "Tried #{attempts} times to write data at addr: 0x#{start_addr.to_hex_str}, but CRC keeps mismatching. Exiting"
+      exit
+    end
+  end
+end
+
 # Try to optimize BSL writes
 # For each lines group, append as many lines as possible, given the BSL Core Commands buffer size
 line_groups.each do |group|
@@ -67,7 +105,7 @@ line_groups.each do |group|
       curr_data_size += line.data_length
     else
       # No room left, send packet
-      @board.send_command :rx_data_block, addr: curr_data_packet.first.addr, data: curr_data_packet.map { |line| line.data }.reduce(:+)
+      write_data_packet curr_data_packet, check: @opts[:check]
       curr_data_packet = []
       curr_data_size = 0
       redo  # Handle current line than would otherwise be skipped
@@ -76,7 +114,7 @@ line_groups.each do |group|
 
   # Send residual lines before handling next group
   if curr_data_packet.any?
-    @board.send_command :rx_data_block, addr: curr_data_packet.first.addr, data: curr_data_packet.map { |line| line.data }.reduce(:+)
+    write_data_packet curr_data_packet, check: @opts[:check]
   end
 end
 

data/lib/msp430_bsl/hex_line.rb

@@ -4,7 +4,7 @@ module Msp430Bsl
   class HexLine
     include Utils
 
-    attr_reader :raw_data, :data_length, :addr, :type, :data, :crc, :number
+    attr_reader :raw_data, :data_length, :addr, :type, :data, :crc, :number, :end_addr
 
     RECORD_TYPES = {
       data: 0x00,
@@ -27,12 +27,13 @@ module Msp430Bsl
       @data = raw_data.slice 4, data_length
       @crc = raw_data[-1]
       @number = num
+      @end_addr = addr + data_length
     end
 
     # Checks if this line's address is contiguous with the one of the given line
     # Obviously this can be true only if the given line has an address that precedes this line's one
     def has_addr_contiguous_to?(another_line)
-      another_line.addr + another_line.data_length == addr
+      another_line.end_addr == addr
     end
 
     def crc_ok?

data/lib/msp430_bsl/response.rb

@@ -27,7 +27,7 @@ module Msp430Bsl
     end
 
     def is_data?
-      kind == Configs::CMD_KINDS[:data]
+      kind == Configs::CMD_KINDS[:data][:code]
     end
 
     def is_message?

data/lib/msp430_bsl/uart/connection.rb

@@ -127,6 +127,7 @@ module Msp430Bsl
         test_pin_go :low
         sleep 5.millis
         reset_pin_go :high
+        sleep 5.millis
       end
 
       private

data/lib/msp430_bsl/version.rb

@@ -1,3 +1,3 @@
 module Msp430Bsl
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/msp430_bsl.rb

@@ -1,11 +1,11 @@
 require 'zeitwerk'
 require 'serialport'
 
-loader = Zeitwerk::Loader.new
-loader.push_dir File.expand_path(__dir__)
+@loader = Zeitwerk::Loader.new
+@loader.push_dir File.expand_path(__dir__)
 core_ext = File.expand_path('core_ext', __dir__)
-loader.ignore core_ext
-loader.setup
+@loader.ignore core_ext
+@loader.setup
 
 # Require core_ext files
 Dir["#{core_ext}/**/*.rb"].each { |file| require file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msp430_bsl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Alessandro Verlato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -105,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="