libusb 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a70a49c54714bfac3447b6dea8c1d93e6921985c
-  data.tar.gz: 54d453912040ca5b2c65e1b6aa129ce9b2b559c6
+  metadata.gz: 5e5f9e0c5d8b081434798fc6043348862276ed6c
+  data.tar.gz: d7d1324fd8f0718c83abd011cf2840b8259cfda5
 SHA512:
-  metadata.gz: 3a0e00959b7d17f590d8ffc8708f6cf5da93d365efb922a668135047650a8278f77dcb8484066def32af7237dc90a02a24d1d1b9cb280cbb9d21f3d7399f2be4
-  data.tar.gz: d4518a07a200486947377e19a69a4710bc83dae8d088d1ba4fe336f0d917876eb5c4d9560decef13b1aac9f8d6efc961faf58a57f9a1c6f51f0559f9b755e7ac
+  metadata.gz: bcff1f67a785ea9b9605c031153fec3c457bb5b33c283ac3c0228a1d78c20050922cf798fb2d3dc75c3676702f9e97c99a4a5fae0f036e0fbce1e138f5527155
+  data.tar.gz: d11ed544f2813e8c221b232e19b6ad393c94a31dc9d0e66995c0f5dc28cb4261cb61b391bfd8e1096fe47ae681066cf5bf668e71f717106717233b573bb0d40b

data/.travis.yml

@@ -1,11 +1,17 @@
 language: ruby
 sudo: false
 rvm:
-  - "1.8.7"
   - "1.9.3"
   - "2.0.0"
   - "2.1"
   - "2.2"
-  - jruby
+  - "2.3.1"
+  - "2.3.1-clang"
+  - jruby-1.7.26
+  - jruby-9.1.5.0
   - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: "2.3.1-clang"
 script: bundle exec rake travis

data/Gemfile

@@ -7,3 +7,5 @@ group :test do
   gem 'eventmachine'
   gem 'minitest'
 end
+
+gem 'rake-compiler-dock', git: 'http://github.com/rake-compiler/rake-compiler-dock'

data/History.md

@@ -1,3 +1,15 @@
+0.6.0 / 2016-12-09
+------------------
+* Update bundled libusb version to 1.0.21.
+* Set minimum Ruby version requirement to 1.9.3.
+* Add binary gems for Linux in addition to Windows.
+* Switch to mini_portile2 for (cross-) builing the libusb library.
+* Add Context#interrupt_event_handler new in libusb-1.0.21
+* Add support for persistent/zerocopy device memory for transfers.
+  It is new in libusb-1.0.21 and enabled by default for DevHandle#*_transfer methods.
+* Raise a more meaningful exception in case of bulk stream transfers on too old libusb versions.
+* Prefer the bundled libusb-dll over installed system library.
+
 0.5.1 / 2015-09-29
 ------------------
 * Add ability to force use of the system or builtin libusb-1.0 library.

data/README.md

@@ -1,6 +1,7 @@
 <!-- -*- coding: utf-8 -*- -->
 
 [![Build Status](https://travis-ci.org/larskanis/libusb.svg)](https://travis-ci.org/larskanis/libusb)
+[![Build Status](https://ci.appveyor.com/api/projects/status/mdfnfdwu4mil42o3?svg=true)](https://ci.appveyor.com/project/larskanis/libusb)
 
 Access USB devices from Ruby
 ============================
@@ -23,15 +24,13 @@ Features
 
 Synopsis
 --------
-See [the documentation](http://rubydoc.info/gems/libusb/frames) for a full API description.
-
 ```ruby
 require "libusb"
 
 usb = LIBUSB::Context.new
-device = usb.devices(:idVendor => 0x04b4, :idProduct => 0x8613).first
+device = usb.devices(idVendor: 0x04b4, idProduct: 0x8613).first
 device.open_interface(0) do |handle|
-  handle.control_transfer(:bmRequestType => 0x40, :bRequest => 0xa0, :wValue => 0xe600, :wIndex => 0x0000, :dataOut => 1.chr)
+  handle.control_transfer(bmRequestType: 0x40, bRequest: 0xa0, wValue: 0xe600, wIndex: 0x0000, dataOut: 1.chr)
 end
 ```
 {LIBUSB::Context#devices} is used to get all or only particular devices.
@@ -55,18 +54,20 @@ Each {LIBUSB::Setting} specifies it's own set of communication endpoints.
 Each {LIBUSB::Endpoint} specifies the type of transfer, direction, polling interval and
 maximum packet size.
 
+See [the documentation](http://rubydoc.info/gems/libusb/frames) for a full API description.
 
 Prerequisites
 -------------
 
-* Linux, MacOSX or Windows system with Ruby MRI 1.8.7/1.9/2.0, JRuby or recent version of Rubinius
-* Optionally: [libusb](http://libusb.info) or [libusbx](http://libusbx.org) library version 1.0.8+ :
+* Linux, MacOS or Windows system with Ruby MRI 1.9/2.x, JRuby or recent version of Rubinius
+* Optionally: [libusb](http://libusb.info) C-library version 1.0.8 or any newer version.
+  The system libusb library can be installed like so:
   * Debian or Ubuntu:
 
       ```
       $ sudo apt-get install libusb-1.0-0-dev
       ```
-  * OS-X: install with homebrew:
+  * MacOS: install with homebrew:
 
       ```
       $ brew install libusb
@@ -83,7 +84,7 @@ Install
 
     $ gem install libusb
 
-While ```gem install``` the system is checked for a usable libusb(x) library installation.
+While ```gem install``` the system is checked for a usable libusb library installation.
 If none could be found, a bundled libusb version is built and used, instead.
 
 Latest code can be used in this way:
@@ -92,11 +93,21 @@ Latest code can be used in this way:
     $ bundle
     $ rake install_gem
 
+Troubleshooting
+------------------------
+In order to implement a driver for a USB device, it's essential to have a look at the packets that are send to and received back from the USB device. [Wireshark](https://www.wireshark.org) has builtin capabilities to sniff USB traffic. On Linux you possibly need to load the usbmon kernel module before start:
+```
+    sudo modprobe usbmon
+```
+On Windows it's possible to sniff USB, if the USB kernel driver was installed by the Wireshark setup.
+
+![Wireshark](wireshark-usb-sniffer.png?raw=true "Wireshark sniffing USB packets")
+
 Device hotplug support
 ----------------------
 
 Support for device hotplugging can be used, if ```LIBUSB.has_capability?(:CAP_HAS_HOTPLUG)``` returns ```true```.
-This requires libusb(x)-1.0.16 or newer on Linux or OS-X. Windows support is [still on the way](https://github.com/libusbx/libusbx/issues/9).
+This requires libusb-1.0.16 or newer on Linux or MacOS. Windows support is [still on the way](https://github.com/libusbx/libusbx/issues/9).
 
 A hotplug event handler can be registered with {LIBUSB::Context#on_hotplug_event}.
 You then need to call {LIBUSB::Context#handle_events} in order to receive any events.
@@ -109,21 +120,21 @@ Usage on Windows
 
 In contrast to Linux, any access to an USB device by LIBUSB on Windows requires a proper driver
 installed in the system. Fortunately creating such a driver is quite easy with
-[Zadig](http://sourceforge.net/projects/libwdi/files/zadig/). Select the interesting USB device,
+[Zadig](http://zadig.akeo.ie/). Select the interesting USB device,
 choose WinUSB driver and press "Install Driver". That's it. You may take the generated output directory
-with it's INI-file and use it for driver installation on other 32 or 64 bit Windows
+with it's INI-file and use it for driver installations on other 32 or 64 bit Windows
 systems.
 
 
 Cross compiling for Windows
 ---------------------------
 
-Libusb-gem can be cross built for the win32 platform, using the [rake-compiler-dock](https://github.com/larskanis/rake-compiler-dock) .
+Libusb-gem can be cross built for Windows and Linux operating systems, using the [rake-compiler-dock](https://github.com/larskanis/rake-compiler-dock) .
 Just run:
 
-    $ rake gem:windows
+    $ rake gem:native
 
-If everything works, there should be `libusb-VERSION-x86-mingw32.gem` in the pkg
+If everything works, there are several platform specific gem files (like `libusb-VERSION-x64-mingw32.gem`) in the pkg
 directory.
 
 EventMachine integration

data/Rakefile

@@ -8,10 +8,11 @@ require 'uri'
 require 'ostruct'
 require 'rake/clean'
 require 'rake_compiler_dock'
+require_relative 'ext/libusb_recipe'
 
 task :gem => :build
 task :compile do
-  sh "ruby ext/extconf.rb"
+  sh "ruby ext/extconf.rb --disable-system-libusb"
 end
 
 task :test=>:compile do
@@ -24,110 +25,64 @@ task :travis=>:compile do
 end
 task :default => :test
 
-task 'gem:windows' do
-  RakeCompilerDock.sh "bundle && rake cross gem"
-end
-
-COMPILE_HOME               = Pathname( "./tmp" ).expand_path
-STATIC_SOURCESDIR          = COMPILE_HOME + 'sources'
-
-# Fetch tarball from sourceforge
-LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '1.0.20'
-LIBUSB_SOURCE_URI         = URI( "http://downloads.sourceforge.net/project/libusb/libusb-1.0/libusb-#{LIBUSB_VERSION}/libusb-#{LIBUSB_VERSION}.tar.bz2" )
-LIBUSB_TARBALL            = STATIC_SOURCESDIR + File.basename( LIBUSB_SOURCE_URI.path )
-
-# Fetch tarball from git repo
-# LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '295c9d1'
-# LIBUSB_SOURCE_URI         = URI( "http://git.libusb.org/?p=libusb.git;a=snapshot;h=#{LIBUSB_VERSION};sf=tbz2" )
-# LIBUSB_TARBALL            = STATIC_SOURCESDIR + "libusb-#{LIBUSB_VERSION}.tar.bz2"
+task "release:tag" do
+  hfile = "History.md"
+  version = LIBUSB::VERSION
+  reldate = Time.now.strftime("%Y-%m-%d")
+  headline = '([^\w]*)(\d+\.\d+\.\d+)([^\w]+)([2Y][0Y][0-9Y][0-9Y]-[0-1M][0-9M]-[0-3D][0-9D])([^\w]*|$)'
 
-# Fetch tarball from libusbx
-# LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '1.0.17'
-# LIBUSB_SOURCE_URI         = URI( "http://downloads.sourceforge.net/project/libusbx/releases/#{LIBUSB_VERSION[/^\d+\.\d+\.\d+/]}/source/libusbx-#{LIBUSB_VERSION}.tar.bz2" )
-# LIBUSB_TARBALL            = STATIC_SOURCESDIR + File.basename( LIBUSB_SOURCE_URI.path )
-
-# Fetch tarball from Pete Batard's git repo
-# LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '4cc72d0'
-# LIBUSB_SOURCE_URI         = URI( "http://git.libusb.org/?p=libusb-pbatard.git;a=snapshot;h=#{LIBUSB_VERSION};sf=tbz2" )
-# LIBUSB_TARBALL            = STATIC_SOURCESDIR + "libusb-pbatard-#{LIBUSB_VERSION}.tar.bz2"
+  hin = File.read(hfile)
+  hout = hin.sub(/#{headline}/) do
+    raise "#{hfile} isn't up-to-date for version #{version}" unless $2==version
+    $1 + $2 + $3 + reldate + $5
+  end
+  if hout != hin
+    Bundler.ui.confirm "Updating #{hfile} for release."
+    File.write(hfile, hout)
+    sh "git", "commit", hfile, "-m", "Update release date in #{hfile}"
+  end
 
-EXT_BUILDDIR              = Pathname( "./ext" ).expand_path
-EXT_LIBUSB_BUILDDIR       = EXT_BUILDDIR + LIBUSB_TARBALL.basename(".tar.bz2")
+  Bundler.ui.confirm "Tag release with annotation:"
+  m = hout.match(/(?<annotation>#{headline}.*?)#{headline}/m) || raise("Unable to find release notes in #{hfile}")
+  Bundler.ui.info(m[:annotation].gsub(/^/, "    "))
+  IO.popen(["git", "tag", "--file=-", version], "w") do |fd|
+    fd.write m[:annotation]
+  end
+end
 
-directory STATIC_SOURCESDIR.to_s
+task "release:guard_clean" => "release:tag"
 
-# libusb source file should be stored there
-file LIBUSB_TARBALL => STATIC_SOURCESDIR do |t|
-  # download the source file using wget or curl
-  chdir File.dirname(t.name) do
-    url = LIBUSB_SOURCE_URI
-    sh "wget '#{url}' -O #{LIBUSB_TARBALL}"
+task "release:rubygem_push" => "gem:native" do
+  CrossLibraries.each do |ruby_platform, _|
+    gh = Bundler::GemHelper.new
+    gh.send(:rubygem_push, "pkg/#{gh.gemspec.name}-#{gh.gemspec.version}-#{ruby_platform}.gem")
   end
 end
 
+task 'gem:native' do
+  sh "bundle package"
+  RakeCompilerDock.sh <<-EOT
+    sudo apt-get update &&
+    sudo apt-get -y install libudev-dev libudev-dev:i386 &
+    bundle --local &&
+    rake cross gem
+  EOT
+end
 
 class CrossLibrary < OpenStruct
   include Rake::DSL
 
-  def initialize(ruby_platform, host_platform)
+  def initialize(ruby_platform, host_platform, libusb_dllname)
     super()
 
-    self.ruby_platform              = ruby_platform
-    self.host_platform              = host_platform
-
-    self.static_builddir            = COMPILE_HOME + 'builds' + ruby_platform
-    self.ruby_build                 = RbConfig::CONFIG["host"]
-
-    # Static libusb build vars
-    self.static_libusb_builddir    = static_builddir + LIBUSB_TARBALL.basename(".tar.bz2")
-    self.libusb_configure          = static_libusb_builddir + 'configure'
-    self.libusb_makefile           = static_libusb_builddir + 'Makefile'
-    self.libusb_dll                = static_libusb_builddir + 'libusb/.libs/libusb-1.0.dll'
-
-    #
-    # Static libusb build tasks
-    #
-    CLEAN.include static_libusb_builddir.to_s
-
-    directory static_libusb_builddir.to_s
+    self.ruby_platform = ruby_platform
+    self.recipe = LibusbRecipe.new
+    recipe.host = host_platform
+    recipe.configure_options << "--host=#{recipe.host}"
+    self.libusb_dll = Pathname.new(recipe.path) + libusb_dllname
 
-    # Extract the libusb builds
-    file static_libusb_builddir => LIBUSB_TARBALL do |t|
-      sh 'tar', '-xjf', LIBUSB_TARBALL.to_s, '-C', static_libusb_builddir.parent.to_s
-      libusb_makefile.unlink if libusb_makefile.exist?
-    end
-
-    file libusb_configure => static_libusb_builddir do |t|
-      Dir.chdir( static_libusb_builddir ) do
-        sh "sh autogen.sh && make distclean"
-      end
-    end
-
-    libusb_env = [
-      "CFLAGS='-fno-omit-frame-pointer'",
-      "LDFLAGS='-static-libgcc'",
-      "CC='#{host_platform}-gcc -static-libgcc'", # hack libtool, since it doesn't support -static-libgcc yet.
-    ]
-
-    # generate the makefile in a clean build location
-    file libusb_makefile => libusb_configure do |t|
-      Dir.chdir( static_libusb_builddir ) do
-        options = [
-          "--target=#{host_platform}",
-          "--host=#{host_platform}",
-          "--build=#{ruby_build}",
-        ]
-
-        configure_path = static_libusb_builddir + 'configure'
-        sh "env #{[libusb_env, configure_path.to_s, *options].join(" ")}"
-      end
-    end
-
-    # make libusb-1.0.dll
-    task libusb_dll => [ libusb_makefile ] do |t|
-      Dir.chdir( static_libusb_builddir ) do
-        sh 'make'
-      end
+    file libusb_dll do
+      recipe.cook
     end
 
     task "libusb_dll:#{ruby_platform}" => libusb_dll
@@ -137,9 +92,17 @@ class CrossLibrary < OpenStruct
       spec = Gem::Specification::load("libusb.gemspec").dup
       spec.platform = Gem::Platform.new(ruby_platform)
       spec.extensions = []
+
+      # Remove files unnecessary for native gems
       spec.files -= `git ls-files ext`.split("\n")
+      spec.files.reject!{|f| f.start_with?('ports') }
       spec_text_files = spec.files.dup
-      spec.files << "lib/#{File.basename(libusb_dll)}"
+
+      # Add native libusb-dll
+      spec.files << "lib/#{libusb_dll.basename}"
+
+      # MiniPortile isn't required for native gems
+      spec.dependencies.reject!{|d| d.name=="mini_portile2" }
 
       # Generate a package for this gem
       pkg = Gem::PackageTask.new(spec) do |pkg|
@@ -161,32 +124,24 @@ class CrossLibrary < OpenStruct
         end
 
         # copy libusb.dll to pkg directory
-        f = "#{pkg.package_dir_path}/lib/#{File.basename(libusb_dll)}"
+        f = "#{pkg.package_dir_path}/lib/#{libusb_dll.basename}"
         mkdir_p File.dirname(f)
         rm_f f
-        safe_ln libusb_dll, f
+        safe_ln libusb_dll.realpath, f
       end
 
-      file "lib/#{File.basename(libusb_dll)}" => [libusb_dll]
+      file "lib/#{libusb_dll.basename}" => [libusb_dll]
     end
   end
 end
 
 CrossLibraries = [
-  ['i386-mingw32', 'i686-w64-mingw32'],
-  ['x64-mingw32', 'x86_64-w64-mingw32'],
-].map do |ruby_platform, host_platform|
-  CrossLibrary.new ruby_platform, host_platform
-end
-
-desc "Download and update bundled libusb"
-task :update_libusb => LIBUSB_TARBALL do
-  sh 'rm', '-r', (EXT_BUILDDIR + "libusb-*").to_s do end
-  sh 'git', 'rm', '-rfq', (EXT_BUILDDIR + "libusb-*").to_s do end
-  sh 'tar', '-xjf', LIBUSB_TARBALL.to_s, '-C', EXT_LIBUSB_BUILDDIR.parent.to_s
-  drops = %w[msvc].map{|f| (EXT_LIBUSB_BUILDDIR+f).to_s }
-  sh 'rm', '-r', '-f', *drops
-  sh 'git', 'add', EXT_LIBUSB_BUILDDIR.to_s
+  ['x86-mingw32', 'i686-w64-mingw32', 'bin/libusb-1.0.dll'],
+  ['x64-mingw32', 'x86_64-w64-mingw32', 'bin/libusb-1.0.dll'],
+  ['x86-linux', 'i686-linux-gnu', 'lib/libusb-1.0.so'],
+  ['x86_64-linux', 'x86_64-linux-gnu', 'lib/libusb-1.0.so'],
+].each do |ruby_platform, host_platform, libusb_dll|
+  CrossLibrary.new ruby_platform, host_platform, libusb_dll
 end
 
 # vim: syntax=ruby

data/appveyor.yml

@@ -0,0 +1,23 @@
+init:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - SET PATH=C:\MinGW\msys\1.0\bin;%PATH%
+  - SET RAKEOPT=-rdevkit
+install:
+  - ruby --version
+  - gem --version
+  - bundle install
+build_script:
+  - bundle exec rake compile
+test_script:
+  - bundle exec rake travis
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"

data/ext/extconf.rb

@@ -2,6 +2,9 @@
 
 require 'rubygems'
 require 'ffi'
+require 'fileutils'
+
+include FileUtils
 
 if RUBY_PLATFORM =~ /java/
   # JRuby's C extension support is disabled by default, so we can not easily test
@@ -50,7 +53,7 @@ def libusb_usable?
       prefix = FFI::Platform::LIBPREFIX.empty? ? 'lib' : FFI::Platform::LIBPREFIX
       bundled_dll = File.join(root_path, "lib/#{prefix}usb-1.0.#{ext}")
       bundled_dll_cygwin = File.join(root_path, "bin/#{prefix}usb-1.0.#{ext}")
-      ffi_lib(["#{prefix}usb-1.0", bundled_dll, bundled_dll_cygwin])
+      ffi_lib([bundled_dll, bundled_dll_cygwin, "#{prefix}usb-1.0"])
     end
     true
   rescue LoadError
@@ -59,23 +62,18 @@ def libusb_usable?
 end
 
 def build_bundled_libusb(have_udev)
-  libusb_dir = Dir[File.expand_path('../../ext/libusb-*', __FILE__)].first
-  root_dir = File.expand_path('../..', __FILE__)
-  raise "could not find embedded libusb sources" unless libusb_dir
-
   # Enable udev for hot-plugging when it is available.
   # This is the same check that is done in libusb's configure.ac file
   # but we don't abort in case it's not available, but continue
   # without hot-plugging.
   have_udev &&= have_header('libudev.h') && have_library('udev', 'udev_new')
 
-  old_dir = Dir.pwd
-  Dir.chdir libusb_dir
-  cmd = "sh configure #{'--disable-udev' unless have_udev} --prefix=#{root_dir} && make && make install"
-  puts cmd
-  system cmd
-  raise "libusb build exited with #{$?.exitstatus}" if $?.exitstatus!=0
-  Dir.chdir old_dir
+  require_relative 'libusb_recipe'
+  recipe = LibusbRecipe.new
+  recipe.configure_options << "--disable-udev" unless have_udev
+  recipe.cook_and_activate
+
+  cp_r File.join(recipe.path, '.'), '.', verbose: true, remove_destination: true
 end
 
 unless enable_config('system-libusb', libusb_usable?)