msp430_bsl 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35aba075d912b2875eecabcebfc4325f54af1cd3085d23249e9e54949797fe89
-  data.tar.gz: 18e8e770e7259aac7c1585f38f94adaeba67689589363ba12f8a143b5fd1b66b
+  metadata.gz: fdfa8cabae9d6f5217854970766871bafec9efb729f1bba0d312e55065d3dfc2
+  data.tar.gz: 25dfc816f5e59d87b5df402c395248a0c09003e54be108608ec65bbf26715c11
 SHA512:
-  metadata.gz: 95a9fd34842399eb965857bb83284d82d4f3a8b72f8912459c92f3dd57402c2d4599f9671b95c7bb91ad82595bc1326151f8bcdda0787aab069eb1bbaf58051f
-  data.tar.gz: c24a4ba28dffbda9f6404c7bcbdfc2155cfe3a17c6f2c49d39a33c1c8fcdeb5e625c18f254d376e74e425b23d3c092c09bc912ffaecb4ff5ed16316371c599db
+  metadata.gz: 52ad0b1653f522000fafc6553e100beeff336e560ca9608fd91d804cfd124c334ebe60b4a70aebb19d358373b9d31b6efb11a5629f9659db43c04334d5d268a8
+  data.tar.gz: 671065d4376b40a99f9716e091cac284375f3bac2402b4300d16e6c19d741307a954b5dc6161728f0f682c1028eb3ba2100ef7ba218ca314acbd6dc416e17c07

data/bin/dump_flash

@@ -0,0 +1,171 @@
+#!/usr/bin/env ruby
+
+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
+
+MAX_WRITE_ATTEMPTS = 3
+SUPPORTED_OUTPUT_FORMATS = %w(hex raw_data)
+EXTRACT_PASS_FROM_FILE_REGEX = /\:10FFE000(.{32})|\:10FFF000(.{32})/.freeze
+
+@opts = {}
+begin
+  @opts = Slop.parse help: true do |o|
+    o.string  '-d', '--device', 'Mandatory: Path to serial programmer device', required: true
+    o.string  '-o', '--outfile', 'Path to file where to save flash content. Default STDOUT', required: false
+    o.string  '-g', '--logfile', 'Path to logfile'
+    o.string  '-p', '--password', '32 bytes password string needed to unlock BSL. Defaults to 32 times 0xFF', default: Msp430Bsl::Configs::CMD_RX_PASSWORD
+    o.string  '-t', '--extract_pass_from', 'Hex file path from where to extract the BSL password. Looks for the 32 words from 0xFFE0 to 0xFFFF'
+    o.array   '-r', '--memrange', 'Memory range to read'
+    o.string  '-s', '--memstartaddr', "Memory's starting address to read from. Defaults to 0x8000", default: 0x8000
+    o.string  '-e', '--memendaddr', "Memory's last address to read. Defaults to 0xFFFF", default: 0x10000
+    o.string  '-l', '--loglevel', "Logger level. One of ['fatal', 'error', 'warn', 'info', 'debug']. Default: 'info'", default: :info
+    o.string  '-f', '--out_format', "Format of output. Supported formats: [hex, raw_data]. Default 'hex' (Intel hex)", default: 'hex'
+    o.integer '-b', '--baud', 'BAUD rate with which communicate to BSL. Default: 115200', default: 115200
+    o.bool    '-h', '--help', 'Print this help' do
+      puts "#{o}\n"
+      exit
+    end
+  end
+rescue Slop::MissingArgument => e
+  puts "Error: #{e}. Maybe you specified an empty argument?"
+  exit
+rescue Slop::UnknownOption => e
+  puts "Error: #{e}"
+  exit
+end
+
+def logger
+  @logger ||= build_logger_from @opts
+end
+
+def outfile
+  @outfile ||= if @opts[:outfile]
+                 File.open(File.expand_path(@opts[:outfile]), 'w')
+               else
+                 STDOUT
+               end
+end
+
+# Validations
+unless SUPPORTED_OUTPUT_FORMATS.include? @opts[:out_format]
+  logger.error "Output file format '#{@opts[:out_format]} is not supported. Supported formats: #{SUPPORTED_OUTPUT_FORMATS.join ','}'"
+  exit 1
+end
+
+unless Msp430Bsl::Configs::BAUD_RATES.include? @opts[:baud]
+  logger.error "BAUD rate #{@opts[:baud]} not supported. Available BAUD rates: #{ Msp430Bsl::Configs::BAUD_RATES.join ', ' }"
+  exit 2
+end
+
+if @opts[:memrange].any? && @opts[:memrange].size.odd?
+  logger.error "Memory ranges must be provided in pairs. Provided 'memrange' argument with #{@opts[:memrange].size} values => #{@opts[:memrange]}"
+  exit 3
+end
+
+
+# Conversions, normalizations, etc...
+@opts[:memstartaddr] = @opts[:memstartaddr].to_i(16) rescue @opts[:memstartaddr]
+@opts[:memendaddr] = @opts[:memendaddr].to_i(16) rescue @opts[:memendaddr]
+
+# If memrange has been provided, convert values to integers parsing as hex
+# else set memrange as [memstartaddr, memendaddr]
+if @opts[:memrange].any?
+  @opts[:memrange].map! { |el| el.to_i(16) }
+else
+  @opts[:memrange] = [ @opts[:memstartaddr], @opts[:memendaddr] ]
+end
+
+# If password param has been provided, convert given string
+if @opts[:password] && !@opts[:password].eql?(Msp430Bsl::Configs::CMD_RX_PASSWORD)
+  @opts[:password] = @opts[:password].scan(EXTRACT_PASS_FROM_FILE_REGEX).flatten.compact.join.to_hex_ary
+  unless @opts[:password].any?
+    logger.error "Wrong password provided. Please copy entirely hex file rows staring with :10FFE0 and :10FFF0"
+    exit
+  end
+end
+# If extract_pass_from param has been provided, extract BSL password from given file path
+if @opts[:extract_pass_from]
+  logger.info "Extracting BSL password from #{@opts[:extract_pass_from]}"
+  file_content = File.read @opts[:extract_pass_from]
+  lines = file_content.scan(EXTRACT_PASS_FROM_FILE_REGEX).flatten.compact
+  @opts[:password] = lines.map { |line| line.scan(/.{2}/).map { |el| el.to_i 16 }}.flatten
+  logger.debug "BSL pass: #{@opts[:password].to_hex.join}"
+end
+
+# Handy methods
+
+# def can_we_ask_another_line?(already_asked_count:, from_addr: , to_addr:,  line_size:)
+#   # We can't exceed Msp430Bsl::Configs::PURE_DATA_MAX_SIZE
+#   return false if (Msp430Bsl::Configs::PURE_DATA_MAX_SIZE - (already_asked_count * line_size)) < line_size
+#
+#   # We can't ask lines beyond memendaddr memory address
+#   return false if (from_addr + ((already_asked_count + 1) * line_size)) >= to_addr
+#
+#   true
+# end
+
+def num_of_bytes_to_fetch(from_addr, to_addr)
+  [Msp430Bsl::Configs::PURE_DATA_MAX_SIZE, (to_addr - from_addr)].min
+end
+
+
+### Core
+
+# Build UART Connection
+@board = Msp430Bsl::Uart::Connection.new @opts[:device], logger: logger
+
+# Enter BSL
+@board.enter_bsl
+logger.info "Unlocking BSL's password protected commands"
+@board.send_command :rx_password, data: @opts[:password]
+@board.send_command :lock_unlock_info
+# Switch UART to max speed
+logger.info "Changing UART BAUD to #{@opts[:baud]}"
+@board.send_command :change_baud_rate, data: Msp430Bsl::Configs::BAUD_RATES[@opts[:baud]]
+@board.set_uart_speed @opts[:baud]
+
+data_file = case @opts[:out_format]
+            when 'hex', :hex
+              Msp430Bsl::HexFile.new
+            when 'raw_data', :raw_data
+              Msp430Bsl::RawDataFile.new
+            else
+              Msp430Bsl::HexFile.new
+            end
+
+logger.info "Reading flash content..."
+
+@opts[:memrange].each_slice(2) do |range|
+  current_addr = range[0]
+  endaddr = range[1]
+  fetched_data = []
+  while current_addr < endaddr
+    num_bytes = num_of_bytes_to_fetch current_addr, endaddr
+
+    logger.debug "fetching #{num_bytes} bytes from addr 0x#{current_addr.to_hex_str} to addr 0x#{(current_addr + num_bytes).to_hex_str}"
+    resp = @board.send_command :tx_data_block, addr: current_addr, data: num_bytes.to_bytes_ary
+    fetched_data << resp.data
+    current_addr += num_bytes
+  end
+
+  data_file.add_new_lines_from(fetched_data.flatten, range[0])
+end
+
+outfile.write data_file
+outfile.write "\n\n"
+
+# Reset board if requested to
+if @opts[:reset]
+  logger.info "Resetting board"
+  @board.trigger_reset
+end
+logger.info "Closing connection"
+@board.close_connection
+if outfile != STDOUT
+  logger.info "Flash content dumped to #{outfile.path}"
+end

data/bin/upload_hex

@@ -9,6 +9,7 @@ STDOUT.sync = true
 include Msp430Bsl::Utils
 
 MAX_WRITE_ATTEMPTS = 3
+EXTRACT_PASS_FROM_FILE_REGEX = /\:10FFE000(.{32})|\:10FFF000(.{32})/.freeze
 
 @opts = {}
 begin
@@ -16,9 +17,13 @@ begin
     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']. Default: 'debug'", default: :debug
+    o.string '-l', '--loglevel', "Logger level. One of ['fatal', 'error', 'warn', 'info', 'debug']. Default: 'info'", default: :info
     o.integer '-b', '--baud', 'BAUD rate with which communicate to BSL. Default: 115200', default: 115200
+    o.string  '-p', '--password', '32 bytes password string needed to unlock BSL. Defaults to 32 times 0xFF', default: Msp430Bsl::Configs::CMD_RX_PASSWORD
+    o.string  '-t', '--extract_pass_from', 'Hex file path from where to extract the BSL password. Looks for the 32 words from 0xFFE0 to 0xFFFF'
+    o.bool '-r', '--reset', 'Reset board after a successful upload', default: false
     o.bool '-e', '--erase_info', 'Erase info memory. Default: false', default: false  # TODO: implement
+    o.bool '-n', '--no_mass_erase', 'Skip mass erase. Default: false (By default flash gets totally erased)', default: false 
     o.bool '-c', '--check', 'Verify flash content after each data block write. Default: true', default: true
     o.bool '-h', '--help', 'Print this help' do
       puts "#{o}\n"
@@ -33,41 +38,83 @@ rescue Slop::UnknownOption => e
   exit
 end
 
-logger = build_logger_from @opts
+def logger
+  @logger ||= build_logger_from @opts
+end
 
 unless Msp430Bsl::Configs::BAUD_RATES.include? @opts[:baud]
   logger.error "BAUD rate #{@opts[:baud]} not supported. Available BAUD rates: #{ Msp430Bsl::Configs::BAUD_RATES.join ', ' }"
   exit
 end
 
+# If password param has been provided, convert given string
+if @opts[:password] && !@opts[:password].eql?(Msp430Bsl::Configs::CMD_RX_PASSWORD)
+  @opts[:password] = @opts[:password].scan(EXTRACT_PASS_FROM_FILE_REGEX).flatten.compact.join.to_hex_ary
+  unless @opts[:password].any?
+    logger.error "Wrong password provided. Please copy entirely hex file rows staring with :10FFE0 and :10FFF0"
+    exit
+  end
+end
+
+# If extract_pass_from param has been provided, extract BSL password from given file path
+if @opts[:extract_pass_from]
+  logger.info "Extracting BSL password from #{@opts[:extract_pass_from]}"
+  file_content = File.read @opts[:extract_pass_from]
+  lines = file_content.scan(EXTRACT_PASS_FROM_FILE_REGEX).flatten.compact
+  @opts[:password] = lines.map { |line| line.scan(/.{2}/).map { |el| el.to_i 16 }}.flatten
+  logger.debug "BSL pass: #{@opts[:password].to_hex.join}"
+end
+
 # Build UART Connection
 @board = Msp430Bsl::Uart::Connection.new @opts[:device], logger: logger
 
 # Enter BSL
 @board.enter_bsl
 # Mass erase FLASH
-logger.info 'Mass erasing FLASH'
-@board.send_command :mass_erase
-# Unlock BSL protected commands
+if !@opts[:no_mass_erase]
+  logger.info 'Mass erasing FLASH'
+  @board.send_command :mass_erase
+end
 logger.info "Unlocking BSL's password protected commands"
-@board.send_command :rx_password, data: Msp430Bsl::Configs::CMD_RX_PASSWORD
+@board.send_command :rx_password, data: @opts[:password]
+
 # Switch UART to max speed
 logger.info "Changing UART BAUD to #{@opts[:baud]}"
 @board.send_command :change_baud_rate, data: Msp430Bsl::Configs::BAUD_RATES[@opts[:baud]]
 @board.set_uart_speed @opts[:baud]
 
 # If everything has gone well so far...
-hexfile = Msp430Bsl::HexFile.new @opts[:hexfile]
+hexfile = Msp430Bsl::HexFile.load @opts[:hexfile]
 
 # Group lines by contiguous memory addr
 logger.info 'Writing data to FLASH'
 line_groups = hexfile.data_lines_grouped_by_contiguous_addr
 
+@erased_segments = []
 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(:+)
+    addr = lines_packet.first.addr
+    data = lines_packet.map { |line| line.data }.reduce(:+)
+    if @opts[:no_mass_erase]
+      starting_segment_addr = (addr / 0x200) * 0x200
+      ending_segment_addr = ((addr + data.size - 1) / 0x200) * 0x200
+      logger.debug "Starting segment addr: #{starting_segment_addr.to_hex_str} - Must erase: #{!@erased_segments.include? starting_segment_addr }"
+      logger.debug "Ending segment addr: #{ending_segment_addr.to_hex_str} - Must erase: #{!@erased_segments.include? ending_segment_addr}"
+      if !@erased_segments.include? starting_segment_addr
+        @board.send_command(:erase_segment, addr: starting_segment_addr)
+      end
+      if !@erased_segments.include? ending_segment_addr
+        @board.send_command(:erase_segment, addr: ending_segment_addr)
+      end
+
+      @erased_segments << starting_segment_addr
+      @erased_segments << ending_segment_addr
+      @erased_segments.uniq!
+    end
+    
+    # Write data to FLASH*
+    resp = @board.send_command :rx_data_block, addr: addr, data: data
 
     break resp unless check
     # Check written data
@@ -92,26 +139,32 @@ def write_data_packet(lines_packet, check: true)
   end
 end
 
+def is_there_still_room_for?(next_line, into:)  # :into must be the curr_data_packet
+  pure_data_length = into.sum { |line| line.data_length } + next_line.data_length
+  return false if pure_data_length > Msp430Bsl::Configs::PURE_DATA_MAX_SIZE
+
+  total_packet_length = pure_data_length + Msp430Bsl::Uart::PeripheralInterface::TOTAL_SIZE
+  return false if total_packet_length > Msp430Bsl::Configs::CORE_COMMANDS_BUFFER_SIZE
+
+  true
+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|
   curr_data_packet = []
-  curr_data_size = 0
   # Cycle lines in a group
   group.each do |line|
     if curr_data_packet.empty?
       # Use current line's addr as packet addr
       curr_data_packet << line
-      curr_data_size += line.data_length + Msp430Bsl::Uart::PeripheralInterface::TOTAL_SIZE
-    elsif (curr_data_size + line.data_length) <= Msp430Bsl::Uart::Connection::CORE_COMMANDS_BUFFER_SIZE
+    elsif is_there_still_room_for?(line, into: curr_data_packet)
       # If there's still room, append the line data
       curr_data_packet << line
-      curr_data_size += line.data_length
     else
       # No room left, send packet
       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
     end
   end
@@ -122,8 +175,11 @@ line_groups.each do |group|
   end
 end
 
-# TODO: Verify CRC or read entire flash and compare to hex lines?
-
+# Reset board if requested to
+if @opts[:reset]
+  logger.info "Resetting board"
+  @board.trigger_reset
+end
 logger.info 'Closing connection'
 @board.close_connection
 logger.info 'Upload done!'

data/lib/core_ext/number.rb

@@ -7,9 +7,16 @@ class Numeric
     n
   end
 
-  def to_bytes_ary
+  def to_bytes_ary(le: true, padding: 2)
     res = []
     to_hex_str.chars.each_slice(2) { |byte| res << byte.join().to_i(16) }
+    if res.size < padding
+      res.prepend Array.new(padding - res.size) { 0 }
+      res.flatten!
+    end
+    if le
+      res.reverse!
+    end
     res
   end
 

data/lib/msp430_bsl/command.rb

@@ -33,14 +33,11 @@ module Msp430Bsl
       @packet = [code, splitted_addr, data].flatten.compact
     end
 
-    def length
-      code.to_bytes_ary.length
-    end
-
     # Split address to [low, middle, high] bytes
     def splitted_addr
       if addr
-        [ (addr & 0xFF), ((addr >> 8) & 0xFF), ((addr >> 16) & 0xFF) ]
+        # [ (addr & 0xFF), ((addr >> 8) & 0xFF), ((addr >> 16) & 0xFF) ]
+        addr.to_bytes_ary padding: 3
       end
     end
 

data/lib/msp430_bsl/configs.rb

@@ -44,5 +44,13 @@ module Msp430Bsl
       57600 => 0x05,
       115200 => 0x06
     }.freeze
+
+    CORE_COMMANDS_BUFFER_SIZE = 260
+    PURE_DATA_MAX_SIZE = 250
+
+    def self.reponse_reason_by_code(code)
+      message = RESPONSE_MESSAGES.find { |message, data| data[:code] == code }
+      message && message.last[:reason]
+    end
   end
 end

data/lib/msp430_bsl/data_file.rb

@@ -0,0 +1,32 @@
+module Msp430Bsl
+  class DataFile
+
+    LINE_DATA_SIZE = Configs::PURE_DATA_MAX_SIZE
+
+    attr_reader :path, :raw_data, :lines
+
+    def initialize
+      @lines = []
+    end
+
+    def add_new_lines_from(data, starting_addr)
+      curr_addr = starting_addr
+      data.each_slice(line_data_size) do |slice|
+        @lines << new_line_from(slice, curr_addr)
+        curr_addr += line_data_size
+      end
+    end
+
+    def <<(line)
+      @lines << line
+    end
+
+    def line_data_size
+      self.class::LINE_DATA_SIZE
+    end
+
+    def new_line_from(data, addr, type: :data)
+      raise NotImplementedError, 'You must implement this method in a subclass'
+    end
+  end
+end

data/lib/msp430_bsl/hex_file.rb

@@ -1,19 +1,16 @@
 module Msp430Bsl
-  class HexFile
+  class HexFile < DataFile
 
-    attr_reader :path, :raw_data
+    LINE_DATA_SIZE = 0x10.freeze
 
-    def initialize(path)
-      @path = File.expand_path path
-      @raw_data = File.read path
-    end
-
-    def lines
-      return @lines if @lines
-
-      @lines = []
-      raw_data.each_line.with_index { |line, i| @lines << HexLine.new(line, num: i) }
-      @lines
+    class << self
+      def load(path)
+        path = File.expand_path path
+        raw_data = File.read path
+        hexfile = new
+        hexfile.load_lines_from raw_data
+        hexfile
+      end
     end
 
     def data_lines_grouped_by_contiguous_addr
@@ -47,5 +44,28 @@ module Msp430Bsl
 
       @grouped_lines
     end
+
+    def load_lines_from(raw_data)
+      raw_data.each_line.with_index do |line, i|
+        line.strip!
+        next if line.empty?
+
+        @lines << HexLine.new(line, num: i)
+      end
+    end
+
+    def raw_data
+      @lines.map { |l| l.data.to_hex }.join("\n")
+    end
+
+    def new_line_from(data, addr, type: :data)
+      data_str = "#{data.size.to_hex_str}#{addr.to_hex_str}#{HexLine::RECORD_TYPES[type].to_hex_str}#{data.to_hex.join}"
+      data_str = ":#{data_str}#{crc8(data_str.to_hex_ary).to_hex_str}"
+      HexLine.new data_str
+    end
+
+    def to_s
+      @lines.map(&:to_s).join("\n")
+    end
   end
 end

data/lib/msp430_bsl/hex_line.rb

@@ -3,6 +3,7 @@
 module Msp430Bsl
   class HexLine
     include Utils
+    extend Utils
 
     attr_reader :raw_data, :data_length, :addr, :type, :data, :crc, :number, :end_addr
 
@@ -19,12 +20,21 @@ module Msp430Bsl
       raise StandardError, 'raw_data must be a String' unless data.is_a?(String)
 
       # Strip String, remove first char i.e. ':' and convert char couples to its hex value.
-      @raw_data = data.strip[1..-1].to_hex_ary
+      if data[0] == ':'
+        @raw_data = data.strip[1..-1]
+      end
+      # Convert raw data to hex array
+      @raw_data = @raw_data.to_hex_ary
 
+      # Extract data length
       @data_length = raw_data[0]
+      # Extract addr
       @addr = (raw_data[1] << 8) | raw_data[2]
+      # Extract line type
       @type = raw_data[3]
+      # Extract data
       @data = raw_data.slice 4, data_length
+      # Extract CRC
       @crc = raw_data[-1]
       @number = num
       @end_addr = addr + data_length
@@ -44,5 +54,9 @@ module Msp430Bsl
       ty = ty.to_sym
       type == RECORD_TYPES[ty]
     end
+
+    def to_s
+      ":#{@data_length.to_hex_str}#{@addr.to_hex_str}#{@type.to_hex_str}#{data.to_hex.join}#{@crc.to_hex_str}"
+    end
   end
 end

data/lib/msp430_bsl/raw_data_file.rb

@@ -0,0 +1,12 @@
+module Msp430Bsl
+  class RawDataFile < DataFile
+
+    def to_s
+      @lines.map { |l| l.to_hex }.join
+    end
+
+    def new_line_from(data, addr, type: :data)
+      data
+    end
+  end
+end

data/lib/msp430_bsl/response.rb

@@ -53,11 +53,15 @@ module Msp430Bsl
       if is_message?
         success_code = Configs::RESPONSE_MESSAGES[:success][:code]
         if data[0] != success_code  # First (and only) data byte is message code
-          @errors << [:message_code, "Message code NOK. Expected message code '#{success_code}', got '#{data[0]}'"]
+          @errors << [:message_code, "Message code NOK. Expected message code '#{success_code}', got '#{data[0]}' that should mean: '#{Configs.reponse_reason_by_code(data[0])}'"]
         end
       end
 
       @errors.empty?
     end
+
+    def inspect
+      data.to_hex
+    end
   end
 end

data/lib/msp430_bsl/uart/connection.rb

@@ -11,19 +11,15 @@ module Msp430Bsl
       WAIT_FOR_ACK_MAX      = 1000.millis
       WAIT_FOR_RESPONSE_MAX = 1000.millis
 
-      MEM_START_MAIN_FLASH      = 0x8000
-
-      CORE_COMMANDS_BUFFER_SIZE = 260
-
       attr_reader :serial_port, :device_path, :logger, :cmd_buff_size
 
       def initialize(device_path, opts = {})
         @device_path = device_path
         @logger = opts.fetch :logger, Logger.new(STDOUT)
-        @cmd_buff_size = opts.fetch :cmd_buf_size, CORE_COMMANDS_BUFFER_SIZE
+        @cmd_buff_size = opts.fetch :cmd_buf_size, Configs::CORE_COMMANDS_BUFFER_SIZE
 
         @serial_port = SerialPort.new @device_path
-        @serial_port.flow_control = SerialPort::NONE
+        @serial_port.flow_control = SerialPort::SOFT
       end
 
       def close_connection
@@ -92,7 +88,7 @@ module Msp430Bsl
         response
       end
 
-      def send_command(cmd_name, addr: nil, data: nil, log_only: false)
+      def send_command(cmd_name, addr: nil, data: nil)
         command = Command.new cmd_name, addr: addr, data: data
         pi = PeripheralInterface.wrap command
         logger.debug "Sending command '#{command.name}' over UART"
@@ -102,18 +98,17 @@ module Msp430Bsl
 
         unless pi.valid?
           logger.error "PeripheralInterface not valid. Errors: #{pi.errors}"
-          return nil
+          raise Exceptions::PeripheralInterface::NotValid, pi.errors
         end
 
         logger.debug "OUT -> (#{pi.packet.size} bytes) #{pi.to_hex_ary_str}"
-        unless log_only
-          serial_port.write pi.to_uart
-          read_response_for command
-        end
+
+        serial_port.write pi.to_uart
+        read_response_for command
       end
 
       def set_uart_speed(baud)
-        raise StandardError, "BAUD not supported. Supported BAUD: #{Configs::BAUD_RATES.keys}" unless Configs::BAUD_RATES.keys.include?(baud)
+        raise StandardError, "BAUD not supported. Supported BAUDs: #{Configs::BAUD_RATES.keys}" unless Configs::BAUD_RATES.keys.include?(baud)
 
         logger.debug "Setting serial port BAUD to #{baud} bps"
 
@@ -123,7 +118,7 @@ module Msp430Bsl
       end
 
       def trigger_reset
-        # slau319 pag. 5 - Fig. 1-1
+        # slau319af.pdf - pag. 5 - Fig. 1-1
         reset_pin_go :low
         test_pin_go :low
         sleep 5.millis

data/lib/msp430_bsl/uart/exceptions.rb

@@ -24,35 +24,41 @@ module Msp430Bsl
       end
 
       module PeripheralInterface
-        class InterfaceWrapNotACommand < StandardError
+        class NotValid < StandardError
+          def initialize(errors)
+            message = "PeripheralInterface not valid. Errors: '#{errors}'"
+            super(message)
+          end
+        end
+        class DoesNotWrapACommand < StandardError
           def initialize(arg)
             message = "Given argument '#{arg}' must be a Msp430Bsl::Command"
             super(message)
           end
         end
 
-        class InterfaceParseRawDataNotArray < StandardError
+        class ParsedRawDataAreNotAnArray < StandardError
           def initialize
             message = "PeripheralInterface#parse argument must be an Array"
             super(message)
           end
         end
 
-        class InterfaceDataNotArray < StandardError
+        class DataAreNotAnArray < StandardError
           def initialize
             message = "Peripheral Interface 'data' argument must be an Array"
             super(message)
           end
         end
 
-        class InterfaceSize < StandardError
+        class DataSizeError < StandardError
           def initialize(received_size)
             message = "Peripheral Interface size error. Required packet's min size is '#{PeripheralInterface::MIN_PACKET_SIZE}' bytes, given raw_data size is '#{received_size}' bytes"
             super(message)
           end
         end
 
-        class InterfaceHeaderNOK < StandardError
+        class HeaderNOK < StandardError
           def initialize(received_header)
             message = "Peripheral interface header NOK. Received '0x#{received_header.to_hex_str}' instead of 0x#{PeripheralInterface::OK_HEADER.to_hex_str}"
             super(message)
@@ -60,7 +66,7 @@ module Msp430Bsl
 
         end
 
-        class InterfaceCRCMismatch < StandardError
+        class CRCMismatch < StandardError
           def initialize
             message = 'Peripheral Interface CRC mismatch'
             super(message)

data/lib/msp430_bsl/uart/peripheral_interface.rb

@@ -18,15 +18,15 @@ module Msp430Bsl
 
         def wrap(command)
           unless command.is_a?(Command)
-            raise Exceptions::PeripheralInterfaceWrapNotACommand, command
+            raise Exceptions::PeripheralInterface::DoesNotWrapACommand, command
           end
 
           new header: OK_HEADER, data_len: command.packet.size, data: command.packet
         end
 
         def parse(raw_data)
-          raise Exceptions::PeripheralInterfaceParseRawDataNotArray unless raw_data.is_a?(Array)
-          raise Exceptions::PeripheralInterfaceSize, raw_data.size unless raw_data.size >= MIN_PACKET_SIZE
+          raise Exceptions::PeripheralInterface::ParsedRawDataAreNotAnArray unless raw_data.is_a?(Array)
+          raise Exceptions::PeripheralInterface::DataSizeError, raw_data.size unless raw_data.size >= MIN_PACKET_SIZE
 
           header = raw_data[0]
           data_len = raw_data[2] << 8 | raw_data[1]
@@ -40,7 +40,7 @@ module Msp430Bsl
       attr_reader :header, :data_len, :data, :crc, :errors, :packet, :cmd_kind
 
       def initialize(header: nil, data_len: nil, data: nil, crc: nil)
-        raise Exceptions::PeripheralInterfaceDataNotArray if (data && !data.is_a?(Array))
+        raise Exceptions::PeripheralInterface::DataAreNotAnArray if (data && !data.is_a?(Array))
 
         @header = header
         @data_len = data_len

data/lib/msp430_bsl/version.rb

@@ -1,3 +1,3 @@
 module Msp430Bsl
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: msp430_bsl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Alessandro Verlato
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -59,23 +58,24 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.14.2
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.14.2
-description:
 email:
 - averlato@gmail.com
 executables:
+- dump_flash
 - upload_hex
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- bin/dump_flash
 - bin/upload_hex
 - lib/core_ext/array.rb
 - lib/core_ext/number.rb
@@ -83,9 +83,11 @@ files:
 - lib/msp430_bsl.rb
 - lib/msp430_bsl/command.rb
 - lib/msp430_bsl/configs.rb
+- lib/msp430_bsl/data_file.rb
 - lib/msp430_bsl/exceptions.rb
 - lib/msp430_bsl/hex_file.rb
 - lib/msp430_bsl/hex_line.rb
+- lib/msp430_bsl/raw_data_file.rb
 - lib/msp430_bsl/response.rb
 - lib/msp430_bsl/uart/ack.rb
 - lib/msp430_bsl/uart/connection.rb
@@ -97,7 +99,6 @@ homepage: https://github.com/madAle/msp430_bsl
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Texas Instrument MSP430 BSL Ruby library
 test_files: []