libusb 0.1.0-x86-mingw32

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/History.txt

@@ -0,0 +1,15 @@
+=== 0.1.0 / 2011-04-xx
+
+* add test suite based on mass storage devices
+* usable async transfers
+* migration to rake-compiler and hoe
+* cross compiled Windows gems
+* distinct exception classes
+* new compatibility layer for ruby-usb.gem
+* many helper methods for different USB descriptors
+* add LIBUSB constants
+* downcase methods names
+
+=== 0.0.1 / 2009-06-23
+
+* first public release

data/Manifest.txt

@@ -0,0 +1,15 @@
+.autotest
+.gemtest
+COPYING
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/libusb.rb
+lib/libusb/compat.rb
+test/test_libusb_compat.rb
+test/test_libusb_compat_mass_storage.rb
+test/test_libusb_descriptors.rb
+test/test_libusb_gc.rb
+test/test_libusb_iso_transfer.rb
+test/test_libusb_mass_storage.rb

data/README.rdoc

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+
+= Access USB devices from Ruby via libusb-1.0.
+
+* http://github.com/larskanis/libusb
+* API documentation: http://libusb.rubyforge.org/libusb
+
+== DESCRIPTION:
+
+LIBUSB is a Ruby binding that gives a Ruby programmer access to all functionality of libusb[http://www.libusb.org], version 1.0.
+
+* libusb is a library that gives full access to devices connected via the USB bus. No special kernel driver is thus necessary for accessing USB devices.
+* This Ruby binding supports the API version 1.0 of libusb. Note that the old "legacy" version 0.1.x of libusb uses a completely different API that is covered by the ruby extension ruby-usb[http://www.a-k-r.org/ruby-usb/] . LIBUSB has a compatibility API to ruby-usb[http://www.a-k-r.org/ruby-usb/].
+
+
+LIBUSB for Ruby is covered by the GNU Lesser General Public License version 3.
+
+== FEATURES:
+* Access to descriptors of devices, configurations, interfaces, settings and endpoints
+* Synchronous and asynchronous communication for bulk, control and interrupt transfers
+* Compatibility layer for ruby-usb[http://www.a-k-r.org/ruby-usb/] (API based on libusb-0.1). See {::USB} for description.
+
+== SYNOPSIS:
+
+  require "libusb"
+
+  usb = LIBUSB::Context.new
+  device = usb.devices(:idVendor => 0x04b4, :idProduct => 0x8613).first
+  device.open do |handle|
+    handle.claim_interface(0)
+    handle.control_transfer(:bmRequestType => 0x40, :bRequest => 0xa0, :wValue => 0xe600, :wIndex => 0x0000, :dataOut => 1.chr)
+    handle.release_interface(0)
+  end
+{LIBUSB::Context#devices} is used to get all or only particular devices.
+After opening the {LIBUSB::Device} the resulting {LIBUSB::DevHandle} can be
+used to communicate with the connected USB device
+by {LIBUSB::DevHandle#control_transfer}, {LIBUSB::DevHandle#bulk_transfer},
+{LIBUSB::DevHandle#interrupt_transfer} or by using the {LIBUSB::Transfer} classes.
+
+A {LIBUSB::Device} can also be used to retrieve information about it,
+by using the device descriptor attributes.
+A {LIBUSB::Device} could have several configurations. You can then decide of which
+configuration to enable. You can only enable one configuration at a time.
+
+Each {LIBUSB::Configuration} has one or more interfaces. This can be seen as functional group
+performing a single feature of the device.
+
+Each {LIBUSB::Interface} has at least one {LIBUSB::Setting}. The first setting is always default.
+An alternate setting can be used independent on each interface.
+
+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.
+
+
+== REQUIREMENTS:
+
+* libusb version 1.0 or greater
+* FFI-gem[http://github.com/ffi/ffi]
+* Linux, MacOSX or Windows system
+
+== INSTALL:
+
+  gem install libusb
+
+In order to use LIBUSB, you need the libusb-1.0 library (but not its header files).
+* On Debian and Ubuntu system, install the +libusb-1.0-0+ package.
+* The gem for Windows comes with a precompiled +libusb.dll+ and can be used
+  together with a precompiled FFI-gem, so there is no need for a compiler.
+
+Latest code can be used in this way:
+
+  git clone git://github.com/larskanis/libusb.git
+  rake install_gem
+
+
+== 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/apps/mediawiki/libwdi/index.php?title=Main_Page]. Select the interesting USB device
+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
+systems.
+
+
+== Cross compiling for mswin32
+
+Libusb-gem can be build on a linux or darwin host for the win32 platform,
+using the mingw cross compiler collection. Libusb is downloaded from source
+git repo, cross compiled and included in the generated libusb.gem.
+
+Install mingw32. On a debian based system this should work:
+
+  apt-get install mingw32
+
+On MacOS X, if you have MacPorts installed:
+
+  port install i386-mingw32-gcc
+
+Download and cross compile libusb for win32:
+
+  rake cross gem
+
+If everything works, there should be libusb-VERSION-x86-mswin32.gem in the pkg
+directory.
+
+== Todo
+
+* add proper handling for polling and timing: http://libusb.sourceforge.net/api-1.0/group__poll.html

data/Rakefile

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'pathname'
+require 'uri'
+require 'rake/extensiontask'
+require 'rake/extensioncompiler'
+
+
+# Cross-compilation constants
+COMPILE_HOME               = Pathname( "./tmp" ).expand_path
+STATIC_SOURCESDIR          = COMPILE_HOME + 'sources'
+STATIC_BUILDDIR            = COMPILE_HOME + 'builds'
+
+# Fetch tarball from sourceforge
+# LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '1.0.8'
+# 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"
+
+# Fetch tarball from Pete Batard's git repo
+LIBUSB_VERSION            = ENV['LIBUSB_VERSION'] || '52a0e18'
+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"
+
+# Static libusb build vars
+STATIC_LIBUSB_BUILDDIR    = STATIC_BUILDDIR + LIBUSB_TARBALL.basename(".tar.bz2")
+LIBUSB_CONFIGURE          = STATIC_LIBUSB_BUILDDIR + 'configure'
+LIBUSB_MAKEFILE           = STATIC_LIBUSB_BUILDDIR + 'Makefile'
+LIBUSB_DLL                  = STATIC_LIBUSB_BUILDDIR + 'libusb/.libs/libusb-1.0.dll'
+
+
+hoe = Hoe.spec 'libusb' do
+  developer('Lars Kanis', 'kanis@comcard.de')
+
+  extra_deps << ['ffi', '>= 1.0']
+  extra_dev_deps << ['rake-compiler', '>= 0.6']
+
+  self.url = 'http://github.com/larskanis/libusb'
+  self.summary = 'Access USB devices from Ruby via libusb-1.0'
+  self.description = 'LIBUSB is a Ruby binding that gives Ruby programmers access to all functionality of libusb, version 1.0'
+
+  self.readme_file = 'README.rdoc'
+  spec_extras[:rdoc_options] = ['--main', readme_file, "--charset=UTF-8"]
+  self.extra_rdoc_files << self.readme_file
+
+  # clean intermediate files and folders
+  self.clean_globs << STATIC_BUILDDIR.to_s
+end
+
+
+#####################################################################
+### C R O S S - C O M P I L A T I O N - T A S K S
+#####################################################################
+
+directory STATIC_SOURCESDIR.to_s
+
+#
+# Static libusb build tasks
+#
+directory STATIC_LIBUSB_BUILDDIR.to_s
+
+# 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}"
+  end
+end
+
+# 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
+
+# generate the makefile in a clean build location
+file LIBUSB_MAKEFILE => LIBUSB_CONFIGURE do |t|
+  Dir.chdir( STATIC_LIBUSB_BUILDDIR ) do
+    options = [
+      '--target=i386-mingw32',
+      "--host=#{Rake::ExtensionCompiler.mingw_host}",
+    ]
+    build_host = `sh config.guess`.chomp
+    options << "--build=#{build_host}" unless build_host.to_s.empty?
+
+    configure_path = STATIC_LIBUSB_BUILDDIR + 'configure'
+    cmd = [ configure_path.to_s, *options ]
+    sh *cmd
+  end
+end
+
+# make libusb-1.0.a
+task LIBUSB_DLL => [ LIBUSB_MAKEFILE ] do |t|
+  Dir.chdir( STATIC_LIBUSB_BUILDDIR ) do
+    sh 'make'
+  end
+end
+
+# copy binary from temporary location to final lib
+task "copy:libusb_dll" => ['lib', LIBUSB_DLL] do
+  install LIBUSB_DLL, "lib/#{File.basename(LIBUSB_DLL)}"
+end
+
+desc "compile static libusb libraries"
+task :libusb_dll => [ "copy:libusb_dll" ]
+
+desc 'Cross compile libusb for win32'
+task :cross => [ :mingw32, :libusb_dll ] do |t|
+  spec = hoe.spec.dup
+  spec.instance_variable_set(:"@cache_file", nil) if spec.respond_to?(:cache_file)
+  spec.platform = Gem::Platform.new('i386-mingw32')
+  spec.files << "lib/#{File.basename(LIBUSB_DLL)}"
+
+  # Generate a package for this gem
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+task :mingw32 do
+  # Use Rake::ExtensionCompiler helpers to find the proper host
+  unless Rake::ExtensionCompiler.mingw_host then
+    warn "You need to install mingw32 cross compile functionality to be able to continue."
+    warn "Please refer to your distribution/package manager documentation about installation."
+    fail
+  end
+end
+
+# vim: syntax=ruby