svi 0.2.9

data/bin/system_reset

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby19
+
+require 'svi/svi'
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+USAGE = "Usage: system_reset [options]"
+ARGS_NUM = 0
+
+def parse_options(args)
+    options = OpenStruct.new
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = USAGE
+      options.vid = 0x3241
+      options.pid = 0x9372
+      options.svi_if = 2
+      options.sbi_if = 3
+      options.sbi_if_ep_out = 0x3
+      options.sbi_if_ep_in  = 0x3
+      options.svi_if_ep_out = 0x4
+      options.svi_if_ep_in  = 0x4
+      options.timeout = 1000
+      options.devnum = 0
+      options.devnum_mod = nil
+      options.verbose = false
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      opts.on("-D", "--device vid:pid", String, "Use appropriate VID/PID") do |vidpid|
+        vidpid = vidpid.split ':' 
+        options.vid = vidpid[0].hex
+        options.pid = vidpid[1].hex
+      end
+
+      opts.on("-N", "--device-number N", Integer, "Use device number N (see device list by --list option)") do |devnum|
+        options.devnum = devnum
+        options.devnum_mod = true
+      end
+
+      opts.on("-T", "--timeout milliseconds", Integer, "Timeout for transfers on both interfaces") do |timeout|
+        options.timeout = timeout
+      end
+
+      opts.on("--svi-if ifnum:epout:epin", String, "Define interface for SVI") do |args|
+        args = args.split ':' 
+        options.svi_if = args[0].hex
+        options.svi_if_ep_out = args[1].hex
+        options.svi_if_ep_in = args[2].hex
+      end
+
+      opts.on("--verbose", "Print maximum information") do
+        options.verbose = true
+      end
+
+      opts.on("--sbi-if ifnum:epout:epin", String, "Define interface for SBI") do |args|
+        args = args.split ':' 
+        options.sbi_if = args[0].hex
+        options.sbi_if_ep_out = args[1].hex
+        options.sbi_if_ep_in = args[2].hex
+      end
+
+      opts.on_tail("-l", "--list", "Show devices list only") do
+        USB.new(options.vid, options.pid).svi_devices.each_with_index { |dev, i|
+          puts "#%d %s %s" % [i, dev.manufacturer, dev.product]
+        }
+        exit
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("--version", "Show version") do
+        puts SVI_VERSION
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+    [options, opt_parser]
+  end
+
+res = parse_options(ARGV)
+options = res[0]
+opt_parser = res[1]
+
+if ARGV.count != ARGS_NUM
+  p opt_parser 
+  exit 1
+end
+
+devs = USB.new(options.vid, options.pid).svi_devices
+
+if devs.count == 0
+  puts 'Device not found'
+  exit 1
+end
+
+if devs.count > 1 and options.devnum_mod.nil?
+  puts 'There are more than one devices, using device #%d.' % options.devnum
+  puts 'Use option -N to define necessary device.'
+  puts "To view list of devices use -l option.\n\n"
+end
+
+dev = devs[options.devnum]
+
+dev.svi_if = options.svi_if
+dev.svi_if_ep_out = options.svi_if_ep_out
+dev.svi_if_ep_in = options.svi_if_ep_in
+
+dev.sbi_if = options.sbi_if
+dev.sbi_if_ep_out = options.sbi_if_ep_out
+dev.sbi_if_ep_in = options.sbi_if_ep_in
+
+dev.svi_timeout = options.timeout
+dev.sbi_timeout = options.timeout
+
+if options.verbose
+  puts "Configuration:"
+  puts "Device # = %d" % options.devnum
+  puts "idVendor = 0x%04x" % options.vid
+  puts "idProduct = 0x%04x" % options.pid
+  puts "Interface number SVI = %d" % options.svi_if
+  puts "OUT endpoint for SVI = 0x%02x" % options.svi_if_ep_out
+  puts "IN endpoint for SVI = 0x%02x" % (options.svi_if_ep_in | 0x80)
+  puts "Interface number SBI = %d" % options.sbi_if
+  puts "OUT endpoint for SBI = 0x%02x" % options.sbi_if_ep_out
+  puts "IN endpoint for SBI = 0x%02x" % (options.sbi_if_ep_in | 0x80)
+  puts "Timeout for IN operations = %d msec" % options.timeout
+  puts "\n\n"
+end
+
+if options.verbose
+end
+
+res = dev.system_reset
+
+if options.verbose
+end
+
+p res[0].to_i
+
+# vim: sw=2 sts=2 ts=8:
+

data/bin/usb_reconnect

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby19
+
+require 'svi/svi'
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+USAGE = "Usage: usb_reconnect [options]"
+ARGS_NUM = 0
+
+def parse_options(args)
+    options = OpenStruct.new
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = USAGE
+      options.vid = 0x3241
+      options.pid = 0x9372
+      options.svi_if = 2
+      options.sbi_if = 3
+      options.sbi_if_ep_out = 0x3
+      options.sbi_if_ep_in  = 0x3
+      options.svi_if_ep_out = 0x4
+      options.svi_if_ep_in  = 0x4
+      options.timeout = 1000
+      options.devnum = 0
+      options.devnum_mod = nil
+      options.verbose = false
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      opts.on("-D", "--device vid:pid", String, "Use appropriate VID/PID") do |vidpid|
+        vidpid = vidpid.split ':' 
+        options.vid = vidpid[0].hex
+        options.pid = vidpid[1].hex
+      end
+
+      opts.on("-N", "--device-number N", Integer, "Use device number N (see device list by --list option)") do |devnum|
+        options.devnum = devnum
+        options.devnum_mod = true
+      end
+
+      opts.on("-T", "--timeout milliseconds", Integer, "Timeout for transfers on both interfaces") do |timeout|
+        options.timeout = timeout
+      end
+
+      opts.on("--svi-if ifnum:epout:epin", String, "Define interface for SVI") do |args|
+        args = args.split ':' 
+        options.svi_if = args[0].hex
+        options.svi_if_ep_out = args[1].hex
+        options.svi_if_ep_in = args[2].hex
+      end
+
+      opts.on("--verbose", "Print maximum information") do
+        options.verbose = true
+      end
+
+      opts.on("--sbi-if ifnum:epout:epin", String, "Define interface for SBI") do |args|
+        args = args.split ':' 
+        options.sbi_if = args[0].hex
+        options.sbi_if_ep_out = args[1].hex
+        options.sbi_if_ep_in = args[2].hex
+      end
+
+      opts.on_tail("-l", "--list", "Show devices list only") do
+        USB.new(options.vid, options.pid).svi_devices.each_with_index { |dev, i|
+          puts "#%d %s %s" % [i, dev.manufacturer, dev.product]
+        }
+        exit
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("--version", "Show version") do
+        puts SVI_VERSION
+        exit
+      end
+    end
+
+    opt_parser.parse!(args)
+    [options, opt_parser]
+  end
+
+res = parse_options(ARGV)
+options = res[0]
+opt_parser = res[1]
+
+if ARGV.count != ARGS_NUM
+  p opt_parser 
+  exit 1
+end
+
+devs = USB.new(options.vid, options.pid).svi_devices
+
+if devs.count == 0
+  puts 'Device not found'
+  exit 1
+end
+
+if devs.count > 1 and options.devnum_mod.nil?
+  puts 'There are more than one devices, using device #%d.' % options.devnum
+  puts 'Use option -N to define necessary device.'
+  puts "To view list of devices use -l option.\n\n"
+end
+
+dev = devs[options.devnum]
+
+dev.svi_if = options.svi_if
+dev.svi_if_ep_out = options.svi_if_ep_out
+dev.svi_if_ep_in = options.svi_if_ep_in
+
+dev.sbi_if = options.sbi_if
+dev.sbi_if_ep_out = options.sbi_if_ep_out
+dev.sbi_if_ep_in = options.sbi_if_ep_in
+
+dev.svi_timeout = options.timeout
+dev.sbi_timeout = options.timeout
+
+if options.verbose
+  puts "Configuration:"
+  puts "Device # = %d" % options.devnum
+  puts "idVendor = 0x%04x" % options.vid
+  puts "idProduct = 0x%04x" % options.pid
+  puts "Interface number SVI = %d" % options.svi_if
+  puts "OUT endpoint for SVI = 0x%02x" % options.svi_if_ep_out
+  puts "IN endpoint for SVI = 0x%02x" % (options.svi_if_ep_in | 0x80)
+  puts "Interface number SBI = %d" % options.sbi_if
+  puts "OUT endpoint for SBI = 0x%02x" % options.sbi_if_ep_out
+  puts "IN endpoint for SBI = 0x%02x" % (options.sbi_if_ep_in | 0x80)
+  puts "Timeout for IN operations = %d msec" % options.timeout
+  puts "\n\n"
+end
+
+if options.verbose
+end
+
+res = dev.usb_reconnect
+
+if options.verbose
+end
+
+p res[0].to_i
+
+# vim: sw=2 sts=2 ts=8:
+

data/lib/svi/api.generated.rb

@@ -0,0 +1,31 @@
+$svi_api_desc =  {
+  :lun_get_seccount  => { :response => [Integer],                                :args => []                          },
+  :lun_get_count     => { :response => [Integer],                                :args => []                          },
+  :lun_set_count     => { :response => [Integer],                                :args => [Integer]                   },
+  :lun_set_table     => { :response => [Integer],                                :args => [LUNDesc]                   },
+  :lun_get_table     => { :response => [Integer, LUNDesc],                       :args => [Integer]                   },
+  :lun_set_mode      => { :response => [Integer],                                :args => [Integer, Integer]          },
+  :lun_format_ao     => { :response => [Integer],                                :args => [Integer, Integer]          },
+  :lun_save_table    => { :response => [Integer],                                :args => []                          },
+  :firmware_program  => { :response => [Integer],                                :args => [Integer, Integer]          },
+  :nvm_write         => { :response => [Integer],                                :args => [Integer, Integer, String]  },
+  :nvm_read          => { :response => [String, Integer],                        :args => [Integer, Integer, Integer] },
+  :nvm_open          => { :response => [Integer],                                :args => [Integer]                   },
+  :nvm_close         => { :response => [Integer],                                :args => [Integer]                   },
+  :led_set           => { :response => [],                                       :args => [Integer, Integer]          },
+  :usb_reconnect     => { :response => [],                                       :args => []                          },
+  :system_reset      => { :response => [],                                       :args => []                          },
+  :system_get_serial => { :response => [String],                                 :args => [String]                    },
+  :system_get_sysver => { :response => [String],                                 :args => [String]                    },
+  :firmware_get_ver  => { :response => [String, String, String, String, String], :args => []                          },
+  :system_get_appver => { :response => [String],                                 :args => [String]                    },
+  :random            => { :response => [Integer],                                :args => []                          },
+  :gettime           => { :response => [Integer],                                :args => []                          },
+  :settime           => { :response => [Integer],                                :args => [Integer]                   },
+  :app_exist         => { :response => [Integer],                                :args => []                          },
+  :app_length        => { :response => [Integer],                                :args => []                          },
+  :app_checksum      => { :response => [Integer],                                :args => []                          },
+  :app_start         => { :response => [Integer],                                :args => []                          },
+  :app_stop          => { :response => [Integer],                                :args => []                          },
+  :app_state         => { :response => [Integer],                                :args => []                          },
+}

data/lib/svi/api.rb

@@ -0,0 +1,111 @@
+require 'pathname'
+
+class Integer 
+  def self.scan_from_svipack buf 
+    [ buf[0..3].unpack('L')[0], buf[4..-1] ]
+  end
+
+  def self.put_to_svipack val
+    [val].pack('L')
+  end
+end
+
+class String
+  def self.scan_from_svipack buf 
+    len, buf = Integer.scan_from_svipack buf
+
+    [ buf[0..len-1], buf[len..-1] ]
+  end
+
+  def self.put_to_svipack val
+    res = ''
+    res << Integer.put_to_svipack(val.length)
+    res << val
+  end
+end
+
+module SelfString
+  @len
+
+  def scan_from_svipack buf
+    raise UndefinedError, self unless @len
+
+    [ buf[0..@len-1], buf[@len..-1] ]
+  end
+
+  def len= length
+    raise ArgumentError unless length.kind_of? Integer
+
+    @len = length
+  end
+end
+
+class LUNDesc < Array
+  def self.scan_from_svipack buf 
+    count, buf = Integer.scan_from_svipack buf
+
+    luns = []
+
+    # TODO: Kill Constant «8»
+    raise ArgumentError, "LUNDesc: error count #{count}" unless count <= 8 and count > 0
+
+    count.times do
+      start, buf = Integer.scan_from_svipack buf
+      len, buf   = Integer.scan_from_svipack buf
+      mode, buf  = Integer.scan_from_svipack buf
+      flags, buf = Integer.scan_from_svipack buf
+
+      luns << start << len << mode << flags
+    end
+
+    [ luns, buf ]
+  end
+
+  def self.put_to_svipack val
+    raise "LUNDesc elements array.count%4 shall be 0" unless val.count%4 == 0
+    res = ''
+
+    res << Integer.put_to_svipack(val.count/4)
+
+    val.each do |elem|
+      res << Integer.put_to_svipack(elem)
+    end
+
+    res
+  end
+end
+
+module SVISubsystemNVM
+  def nvm_load_file bank, offset, path
+    raise ArgumentError, 'file (%s) is not readable' % path.to_s unless Pathname.new(path).readable_real?
+
+    data = IO.binread(path).unpack 'C*'
+    data = data + [0]*(data.length % 1024 > 0 ? (1024 - data.length%1024) : 0)
+    data = data.each_slice(1024).to_a
+
+    data.each_with_index do |packet, i|
+      nvm_write bank, offset + i*1024, packet.pack('C*')
+    end
+
+    [0]
+  end
+
+  def nvm_verify_file bank, offset, path
+    raise ArgumentError, 'file (%s) is not readable' % path.to_s unless Pathname.new(path).readable_real?
+
+    data = IO.binread(path).unpack 'C*'
+    data = data + [0]*(data.length % 1024 > 0 ? (1024 - data.length%1024) : 0)
+    data = data.each_slice(1024).to_a
+
+    data.each_with_index do |packet, i|
+      res = nvm_read(bank, offset + i*1024, 1024)[0]
+
+      return [1, res, packet.pack('C*')] if res != packet.pack('C*')
+    end
+
+    [0]
+  end
+end
+
+# vim: sw=2 sts=2 ts=8:
+

data/lib/svi/svi.rb

@@ -0,0 +1,135 @@
+require 'libusb'
+
+require 'svi/api'
+require 'svi/api.generated'
+
+
+class USB < LIBUSB::Context
+  @vidpids
+
+  def initialize(vid, pid)
+    @vidpids = [
+      {:idVendor => vid, :idProduct => pid}
+    ]
+
+    super()
+  end
+
+  def svi_devices
+    devs = []
+    @vidpids.each { |vidpid|
+      devs = devs + devices(vidpid)
+    }
+
+    devs.each { |dev| dev.extend SVIDevice  }
+
+    devs
+  end
+end
+
+module SVICall
+  SVI_PACKET_SIZE = 2048
+
+  def call(*_args)
+    args = _args.reverse
+    noreturn = false
+    resp = nil
+    packet = ""
+
+    raise ArgumentError, 'Wrong arguments count' if args.count == 0
+
+    if args[-1] == :noreturn
+      noreturn = true
+      args.pop
+    end
+
+    name = args.pop
+
+    raise ArgumentError, "Invalid syscall name #{name}" unless $svi_api_desc.has_key? name
+    raise ArgumentError, 'SVI is not configured' unless svi_configured?
+
+    packet << name.to_s << "\0"
+
+    args.reverse!
+
+    $svi_api_desc[name][:args].each_with_index do |arg, i|
+      packet << arg.put_to_svipack(args[i])
+    end
+
+    raise ArgumentError, 'Too long svc call' if packet.length > SVI_PACKET_SIZE
+
+    packet << ([0]*(SVI_PACKET_SIZE-packet.length)).pack('C*')
+
+    res = nil
+
+    open_interface(svi_if) do |handle|
+      res = handle.bulk_transfer(:endpoint => svi_if_ep_out, :dataOut => packet)
+
+      raise IOError, 'Sending failed' unless res == SVI_PACKET_SIZE
+
+      resp = []
+
+      res = handle.bulk_transfer(:endpoint => svi_if_ep_in | 0x80, :dataIn => SVI_PACKET_SIZE, :timeout => @svi_timeout) unless $svi_api_desc[name][:response].empty? || noreturn
+    end
+
+    unless $svi_api_desc[name][:response].empty? || noreturn
+      $svi_api_desc[name][:response].each do |resptype|
+        resp_token, res = resptype.scan_from_svipack res
+        resp << resp_token
+      end
+    else
+      resp << 0
+    end
+
+    resp
+  end
+
+  def method_missing *args
+    call *args
+  end
+end
+
+module SBITxRx
+  attr_accessor :sbi_if
+  attr_accessor :sbi_if_ep_out
+  attr_accessor :sbi_if_ep_in
+  attr_accessor :sbi_timeout
+
+  def sbi_configured?
+    !(@sbi_if.nil? or @sbi_if_ep_out.nil? or @sbi_if_ep_in.nil?)
+  end
+
+  def sbi_send data
+    raise ArgumentError unless sbi_configured? 
+
+    open_interface(sbi_if) { |handle|
+      res = handle.bulk_transfer(:endpoint => sbi_if_ep_out, :dataOut => data)
+    }
+  end
+
+  def sbi_receive length
+    raise ArgumentError if @sbi_if.nil? or @sbi_if_ep_out.nil? or @sbi_if_ep_in.nil?
+
+    open_interface(sbi_if) { |handle|
+      res = handle.bulk_transfer(:endpoint => sbi_if_ep_in | 0x80, :dataIn => length, :timeout => @sbi_timeout) 
+    }
+  end
+end
+
+module SVIDevice
+  attr_accessor :svi_if
+  attr_accessor :svi_if_ep_out
+  attr_accessor :svi_if_ep_in
+  attr_accessor :svi_timeout
+
+  include SVICall
+  include SBITxRx
+  include SVISubsystemNVM
+
+  def svi_configured?
+    !(@svi_if.nil? or @svi_if_ep_out.nil? or @svi_if_ep_in.nil? or @svi_timeout.nil?)
+  end
+end
+
+# vim: sw=2 sts=2 ts=8:
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: svi
+version: !ruby/object:Gem::Version
+  version: 0.2.9
+platform: ruby
+authors:
+- Levenkov Artem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libusb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: Service Interface
+email: alev@mcs51.ru
+executables:
+- usb_reconnect
+- lun_set_mode
+- random
+- system_reset
+- lun_get_count
+- lun_set_count
+- lun_set_table
+- svi
+- svirb
+- lun_save_table
+- settime
+- dfu
+- lun_format_ao
+- gettime
+- led_set
+- lun_get_table
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dfu
+- bin/gettime
+- bin/led_set
+- bin/lun_format_ao
+- bin/lun_get_count
+- bin/lun_get_table
+- bin/lun_save_table
+- bin/lun_set_count
+- bin/lun_set_mode
+- bin/lun_set_table
+- bin/random
+- bin/settime
+- bin/svi
+- bin/svirb
+- bin/system_reset
+- bin/usb_reconnect
+- lib/svi/api.generated.rb
+- lib/svi/api.rb
+- lib/svi/svi.rb
+homepage: http://www.mcs51.ru/svi-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Service Interface for MCS51
+test_files: []