Skip to content

Commit

Permalink
Misc: Revert all references to libusb/libusb.info
Browse files Browse the repository at this point in the history
  • Loading branch information
hjelmn authored and pbatard committed Jan 8, 2014
1 parent 85e118a commit 1eff220
Show file tree
Hide file tree
Showing 78 changed files with 455 additions and 1,316 deletions.
2 changes: 1 addition & 1 deletion .private/README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This directory contains private internal scripts used by the libusbx
This directory contains private internal scripts used by the libusb
project maintainers.

These scripts are not intended for general usage and will not be
Expand Down
4 changes: 2 additions & 2 deletions .private/bm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ PWD=`pwd`
cd ..
date=`date +%Y.%m.%d`
target=e:/dailies/$date
mkdir -p $target/include/libusbx-1.0
mkdir -p $target/include/libusb-1.0
cp -v libusb/libusb-1.0.def $target
cp -v libusb/libusb.h $target/include/libusbx-1.0
cp -v libusb/libusb.h $target/include/libusb-1.0

#
# 32 bit binaries
Expand Down
6 changes: 3 additions & 3 deletions .private/bwince.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ set WINCE_TARGET_DIR=%WINCE_TARGET_DIR_BASE%\%DATE:/=-%
set MSBUILD_CMD=msbuild.exe
set MSBUILD_TARGET=Rebuild
set MSBUILD_CONFIGURATION=Release
set WINCE_SLN=msvc\libusbx_wince.sln
set WINCE_SLN=msvc\libusb_wince.sln
set PLATFORM_PREFIX=STANDARDSDK_500 (
set PLATFORM_POSTFIX=)

Expand All @@ -21,9 +21,9 @@ set PWD=%~dp0
cd ..

mkdir %WINCE_TARGET_DIR%
mkdir %WINCE_TARGET_DIR%\include\libusbx-1.0
mkdir %WINCE_TARGET_DIR%\include\libusb-1.0
copy libusb\libusb-1.0.def %WINCE_TARGET_DIR%
copy libusb\libusb.h %WINCE_TARGET_DIR%\include\libusbx-1.0
copy libusb\libusb.h %WINCE_TARGET_DIR%\include\libusb-1.0
for %%A in (%WINCE_TARGET_ARCHES%) do mkdir %WINCE_TARGET_DIR%\%%A
for %%A in (%WINCE_TARGET_ARCHES%) do mkdir %WINCE_TARGET_DIR%\%%A\static
for %%A in (%WINCE_TARGET_ARCHES%) do mkdir %WINCE_TARGET_DIR%\%%A\dll
Expand Down
2 changes: 1 addition & 1 deletion .private/post-rewrite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# fi
#
# NOTE: These versioning hooks are intended to be used *INTERNALLY* by the
# libusbx development team and are NOT intended to solve versioning for any
# libusb development team and are NOT intended to solve versioning for any
# derivative branch, such as one you would create for private development.
#

Expand Down
4 changes: 2 additions & 2 deletions .private/pre-commit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
# fi
#
# NOTE: These versioning hooks are intended to be used *INTERNALLY* by the
# libusbx development team and are NOT intended to solve versioning for any
# libusb development team and are NOT intended to solve versioning for any
# derivative branch, such as one you would create for private development.
#
# Should you wish to reuse these scripts for your own versioning, in your own
# private branch, we kindly ask you to first set BRANCH_OFFSET to 60000, or
# higher, as any offset below below 60000 is *RESERVED* for libusbx official
# higher, as any offset below below 60000 is *RESERVED* for libusb official
# usage.

################################################################################
Expand Down
30 changes: 15 additions & 15 deletions .private/wbs.txt
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
libusbx 1.0 Windows binary snapshot - README
libusb 1.0 Windows binary snapshot - README

*********************************************************************
* The latest version of this snapshot can always be downloaded at: *
* https://sourceforge.net/projects/libusbx/files/ *
* https://sourceforge.net/projects/libusb/files/ *
*********************************************************************

o Visual Studio:
- Open existing or create a new project for your application
- Copy libusb.h, from the include\libusbx-1.0\ directory, into your project and
- Copy libusb.h, from the include\libusb-1.0\ directory, into your project and
make sure that the location where the file reside appears in the 'Additional
Include Directories' section (Configuration Properties -> C/C++ -> General).
- Copy the relevant .lib file from MS32\ or MS64\ and add 'libusb-1.0.lib' to
your 'Additional Dependencies' (Configuration Properties -> Linker -> Input)
Also make sure that the directory where libusb-1.0.lib resides is added to
'Additional Library Directories' (Configuration Properties -> Linker
-> General)
- If you use the static version of the libusbx library, make sure that
- If you use the static version of the libusb library, make sure that
'Runtime Library' is set to 'Multi-threaded DLL (/MD)' (Configuration
Properties -> C/C++ -> Code Generation).
NB: If your application requires /MT (Multi-threaded/libCMT), you need to
recompile a static libusbx 1.0 library from source.
recompile a static libusb 1.0 library from source.
- Compile and run your application. If you use the DLL version of libusb-1.0,
remember that you need to have a copy of the DLL either in the runtime
directory or in system32

o WDK/DDK:
- The following is an example of a sources files that you can use to compile
a libusbx 1.0 based console application. In this sample ..\libusbx\ is the
a libusb 1.0 based console application. In this sample ..\libusb\ is the
directory where you would have copied libusb.h as well as the relevant
libusb-1.0.lib

TARGETNAME=your_app
TARGETTYPE=PROGRAM
USE_MSVCRT=1
UMTYPE=console
INCLUDES=..\libusbx;$(DDK_INC_PATH)
TARGETLIBS=..\libusbx\libusb-1.0.lib
INCLUDES=..\libusb;$(DDK_INC_PATH)
TARGETLIBS=..\libusb\libusb-1.0.lib
SOURCES=your_app.c

- Note that if you plan to use libCMT instead of MSVCRT (USE_LIBCMT=1 instead
of USE_MSVCRT=1), you will need to recompile libusbx to use libCMT. This can
of USE_MSVCRT=1), you will need to recompile libusb to use libCMT. This can
easily be achieved, in the DDK environment, by running 'ddk_build /MT'

o MinGW/cygwin
- Copy libusb.h, from include/libusbx-1.0/ to your default include directory,
- Copy libusb.h, from include/libusb-1.0/ to your default include directory,
and copy the MinGW32/ or MinGW64/ .a files to your default library directory.
Or, if you don't want to use the default locations, make sure that you feed
the relevant -I and -L options to the compiler.
- Add the '-lusb-1.0' linker option when compiling.

o Additional information:
- The libusbx 1.0 API documentation can be accessed at:
http://api.libusbx.org
- The libusb 1.0 API documentation can be accessed at:
http://api.libusb.info
- For some libusb samples (including source), please have a look in examples/
- For additional information on the libusbx 1.0 Windows backend please visit:
http://windows.libusbx.org
- For additional information on the libusb 1.0 Windows backend please visit:
http://windows.libusb.info
- The MinGW and MS generated DLLs are fully interchangeable, provided that you
use the import libs provided or generate one from the .def also provided.
- If you find any issue, please visit http://libusbx.org/ and check the
- If you find any issue, please visit http://libusb.info/ and check the
Support section
22 changes: 11 additions & 11 deletions .private/wbs_wince.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
libusbx 1.0 Windows CE binary snapshot - README
libusb 1.0 Windows CE binary snapshot - README

*********************************************************************
* The latest version of this snapshot can always be downloaded at: *
* https://sourceforge.net/projects/libusbx/files/ *
* https://sourceforge.net/projects/libusb/files/ *
*********************************************************************

The binaries contained in this snapshot are licensed under the
Expand All @@ -12,31 +12,31 @@ is available for download at the same location as this binary snapshot.

o Visual Studio:
- Open existing or create a new project for your application
- Copy libusb.h, from the include\libusbx-1.0\ directory, into your project and
- Copy libusb.h, from the include\libusb-1.0\ directory, into your project and
make sure that the location where the file reside appears in the 'Additional
Include Directories' section (Configuration Properties -> C/C++ -> General).
- Copy the relevant .lib file from ARMV4I, MIPSII, MIPSII_FP, MIPSIV, MIPSIV_FP,
SH4 or x86 and add 'libusb-1.0.lib' to your 'Additional Dependencies'
(Configuration Properties -> Linker -> Input). Also make sure that the
directory where libusb-1.0.lib resides is added to 'Additional Library
Directories' (Configuration Properties -> Linker -> General)
- If you use the static version of the libusbx library, make sure that
- If you use the static version of the libusb library, make sure that
'Runtime Library' is set to 'Multi-threaded DLL (/MD)' (Configuration
Properties -> C/C++ -> Code Generation).
NB: If your application requires /MT (Multi-threaded/libCMT), you need to
recompile a static libusbx 1.0 library from source.
recompile a static libusb 1.0 library from source.
- Compile and run your application. If you use the DLL version of libusb-1.0,
remember that you need to have a copy of the DLL either in the runtime
directory or in system32

o Additional information:
- The libusbx 1.0 API documentation can be accessed at:
http://api.libusbx.org
- The libusb 1.0 API documentation can be accessed at:
http://api.libusb.info
- For some libusb samples (including source), please have a look in examples/
- For additional information on the libusbx 1.0 Windows backend please visit:
http://windows.libusbx.org
- It is necessary to install the CE USB Kernel Wrapper driver for libusbx to
- For additional information on the libusb 1.0 Windows backend please visit:
http://windows.libusb.info
- It is necessary to install the CE USB Kernel Wrapper driver for libusb to
function on a device. This is obtainable from:
https://github.com/RealVNC/CEUSBKWrapper
- If you find any issue, please visit http://libusbx.org/ and check the
- If you find any issue, please visit http://libusb.info/ and check the
Support section
18 changes: 9 additions & 9 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
For detailed information about the changes below, please see the git log or
visit: http://log.libusbx.org
visit: http://log.libusb.info

2013-09-06: v1.0.17
* Hotplug callbacks now always get passed a libusb_context, even if it is
Expand All @@ -11,11 +11,11 @@ visit: http://log.libusbx.org
* Darwin: Add Xcode project
* Darwin: Fix crash on unplug (#121)
* Linux: Fix hang (deadlock) on libusb_exit
* Linux: Fix libusbx build failure with --disable-udev (#124)
* Linux: Fix libusb build failure with --disable-udev (#124)
* Linux: Fix libusb_get_device_list() hang with --disable-udev (#130)
* OpenBSD: Update OpenBSD backend with support for control transfers to
non-ugen(4) devices and make get_configuration() no longer generate I/O.
Note that using this libusbx version on OpenBSD requires using
Note that using this libusb version on OpenBSD requires using
OpenBSD 5.3-current or later. Users of older OpenBSD versions are advised
to stay with the libusb shipped with OpenBSD (mpi)
* Windows: fix libusb_dll_2010.vcxproj link errors (#129)
Expand Down Expand Up @@ -62,7 +62,7 @@ https://github.com/libusbx/libusbx/issues/9
* Reverts the previous API change with regards to bMaxPower.
If this doesn't matter to you, you are encouraged to keep using v1.0.13,
as it will use the same attribute as v2.0, to be released soon.
* Note that LIBUSBX_API_VERSION is *decreased* to 0x010000FF and the previous
* Note that LIBUSB_API_VERSION is *decreased* to 0x010000FF and the previous
guidelines with regards to concurrent use of MaxPower/bMaxPower still apply.

2012-09-20: v1.0.13
Expand All @@ -73,11 +73,11 @@ https://github.com/libusbx/libusbx/issues/9
* Fix broken support for the 0.1 -> 1.0 libusb-compat layer
* Fix unwanted cancellation of pending timeouts as well as major timeout related bugs
* Fix handling of HID and composite devices on Windows
* Introduce LIBUSBX_API_VERSION macro
* Introduce LIBUSB_API_VERSION macro
* Add Cypress FX/FX2 firmware upload sample, based on fxload from
http://linux-hotplug.sourceforge.net
* Add libusb0 (libusb-win32) and libusbK driver support on Windows. Note that while
the drivers allow it, isochronous transfers are not supported yet in libusbx. Also
the drivers allow it, isochronous transfers are not supported yet in libusb. Also
not supported yet is the use of libusb-win32 filter drivers on composite interfaces
* Add support for the new get_capabilities ioctl on Linux and avoid unnecessary
splitting of bulk transfers
Expand Down Expand Up @@ -178,18 +178,18 @@ https://github.com/libusbx/libusbx/issues/9
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

APPENDIX A - How to maintain code compatibility with versions of libusb and
libusbx that use MaxPower:
libusb that use MaxPower:

If you must to maintain compatibility with versions of the library that aren't
using the bMaxPower attribute in struct libusb_config_descriptor, the
recommended way is to use the new LIBUSBX_API_VERSION macro with an #ifdef.
recommended way is to use the new LIBUSB_API_VERSION macro with an #ifdef.
For instance, if your code was written as follows:

if (dev->config[0].MaxPower < 250)

Then you should modify it to have:

#if defined(LIBUSBX_API_VERSION) && (LIBUSBX_API_VERSION >= 0x01000100)
#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000100)
if (dev->config[0].bMaxPower < 250)
#else
if (dev->config[0].MaxPower < 250)
Expand Down
12 changes: 6 additions & 6 deletions INSTALL_WIN.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ If you are compiling for MinGW or cygwin, please refer to the INSTALL file.

If you are using Microsoft Visual Studio:
- Open the relevant solution file in /msvc:
libusb.dsw for MSVC6, libusbx_2005.sln for Visual Studio 2005 or 2008,
libusbx_2010.sln for Visual Studio 2010,
libusbx_2012.sln for Visual Studio 2012 or later,
libusbx_wince.sln for Windows CE support in Visual Studio 2005.
libusb.dsw for MSVC6, libusb_2005.sln for Visual Studio 2005 or 2008,
libusb_2010.sln for Visual Studio 2010,
libusb_2012.sln for Visual Studio 2012 or later,
libusb_wince.sln for Windows CE support in Visual Studio 2005.
- If you want to debug the library, uncomment the ENABLE_DEBUG_LOGGING define
in msvc\config.h
- Select your configuration and compile the project
Expand Down Expand Up @@ -51,13 +51,13 @@ If needed, these libraries can be obtained by installing either the latest
Windows SDK or the DDK (Links provided at the end of this file).

For Windows CE it is necessary to install the CE USB Kernel Wrapper driver for
libusbx to function on a device.
libusb to function on a device.

Links
*****

Additional information related to the Windows backend:
http://windows.libusbx.org
http://windows.libusb.info

Latest Windows Driver (Development) Kit (WDK):
http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=36a2630f-5d56-43b5-b996-7633f2ec14ff
Expand Down
4 changes: 2 additions & 2 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
For the latest libusbx news, please refer to the ChangeLog file, or visit:
http://libusbx.org
For the latest libusb news, please refer to the ChangeLog file, or visit:
http://libusb.info
26 changes: 13 additions & 13 deletions PORTING
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
PORTING LIBUSBX TO OTHER PLATFORMS
PORTING LIBUSB TO OTHER PLATFORMS

Introduction
============

This document is aimed at developers wishing to port libusbx to unsupported
platforms. I believe the libusbx API is OS-independent, so by supporting
This document is aimed at developers wishing to port libusb to unsupported
platforms. I believe the libusb API is OS-independent, so by supporting
multiple operating systems we pave the way for cross-platform USB device
drivers.

Implementation-wise, the basic idea is that you provide an interface to
libusbx's internal "backend" API, which performs the appropriate operations on
libusb's internal "backend" API, which performs the appropriate operations on
your target platform.

In terms of USB I/O, your backend provides functionality to submit
Expand All @@ -27,16 +27,16 @@ e.g. setting configuration, obtaining descriptors, etc.
File descriptors for I/O polling
================================

For libusbx to work, your event handling function obviously needs to be called
For libusb to work, your event handling function obviously needs to be called
at various points in time. Your backend must provide a set of file descriptors
which libusbx and its users can pass to poll() or select() to determine when
which libusb and its users can pass to poll() or select() to determine when
it is time to call the event handling function.

On Linux, this is easy: the usbfs kernel interface exposes a file descriptor
which can be passed to poll(). If something similar is not true for your
platform, you can emulate this using an internal library thread to reap I/O as
necessary, and a pipe() with the main library to raise events. The file
descriptor of the pipe can then be provided to libusbx as an event source.
descriptor of the pipe can then be provided to libusb as an event source.


Interface semantics and documentation
Expand All @@ -46,7 +46,7 @@ Documentation of the backend interface can be found in libusbi.h inside the
usbi_os_backend structure definition.

Your implementations of these functions will need to call various internal
libusbx functions, prefixed with "usbi_". Documentation for these functions
libusb functions, prefixed with "usbi_". Documentation for these functions
can be found in the .c files where they are implemented.

You probably want to skim over *all* the documentation before starting your
Expand All @@ -72,18 +72,18 @@ right usbi_backend for your platform.

4. Produce and test your implementation.

5. Send your implementation to libusbx-devel mailing list.
5. Send your implementation to libusb-devel mailing list.


Implementation difficulties? Questions?
=======================================

If you encounter difficulties porting libusbx to your platform, please raise
these issues on the libusbx-devel mailing list. Where possible and sensible, I
am interested in solving problems preventing libusbx from operating on other
If you encounter difficulties porting libusb to your platform, please raise
these issues on the libusb-devel mailing list. Where possible and sensible, I
am interested in solving problems preventing libusb from operating on other
platforms.

The libusbx-devel mailing list is also a good place to ask questions and
The libusb-devel mailing list is also a good place to ask questions and
make suggestions about the internal API. Hopefully we can produce some
better documentation based on your questions and other input.

Expand Down
Loading

0 comments on commit 1eff220

Please sign in to comment.