            OS/2 USB Resource Manager version 0.9 (beta)
           ----------------------------------------------

Contents
========
1    Description
2    Features
3    History
4    Requirements
5    Installation/uninstall
6    Usage
7    File listing
8    ToDo
9    Contacting the author
10   Warranty

1 Description
=============
The purpose of this driver is to show all connected USB devices
with exception of USB-hubs connected to the system.
It allows to view the USB Device Report and can thereby help
a developer to see how a device registers at the system and
try to find reasons why a certain device which should run with
installed drivers doesn't or in the development of new drivers.

2 Features
==========
Driver:
 - Driver lets Apps register to get notified of device insertion or
   removal
 - Get number of USB devices
 - Get Device report of device

Application:
 - Show connected devices
 - Show Devies contained in the USB.IDS file

3 History
=========
Driver:
 V 0.8 Inital version
 V 0.9 Added support to get the device Report
 V 0.9.6 Support for Device Strings.

Application
 V 0.8   Inital version
 V 0.8.1 Use Linux USB.IDS file to get names for vendor/device
 V 0.9   Added support to display the device report
 V 0.9.5 Better parsinf for COM-class device endpoints.
 V 0.9.6 Support for new driver features and an easier to understand
         devicereport
 V 0.9.7 Cleanup and Bugfixes updated usb.ids

4 Requirements
==============
- OS/2 Warp 4 or Warp Server for e-Business
  (Warp 3 not tested)
- IBMs USB base drivers (usbuhcd.sys and usbd.sys)


5 Installation/uninstall
========================
To install the USB Resource Manager package:
- Unzip driver archive
- Add the driver to the config.sys (DEVICE=x:\installpath\usbresmg.sys)
- Reboot
To uninstall remove the line form the config.sys and delete the files.

6 Usage
=======
Simply start the application (USBRES.EXE). It shows 2 Notebook pages:
- System
  This page shows the devices connected to the system. Hubs are not
  shown as the usbd.sys manages them itseld and doesn't forward their
  attachment to registered drivers.
- Devices
  This pages shows the devices the app can recognize. Mainly that
  what is listed in the USB.IDS file.

To view the report of a device select the device on the system page
and right click on it to invoke the contextmenu the click on
"View device report".

7 File listing
==============
USB driver
  usbresmg.sys
Application
  USBRES.exe
Database with vendor/device IDs
  USB.IDS
  Current versions of the USB.IDS file can be found at
  http://www.linux-usb.org/usb.ids
8 Todo
======
Driver
 - Add support to get Strings from devices
 - Enhance notification of USB bus changes
 - Add access to devices from ring 3 (control/Bulk transport)
 - Make a WPI install
 - Integrate USBRESMG.SYS into USBD to be able to show hubs and
   allow access only to devices not managed by other drivers.

Application
 - Replace USBRES.EXE with WPS object
 - Support HID reports.

9 Contacting the author
=======================
The author can be contacted at usbguy@netlabs.org
If you use this package to check why an USB device doesn't work even
you have the right USB drivers installed, include the following information:
- Config.sys
- Device report
- Timestamp of the USB drivers (creation date size)

Bug reports should include the following information:
- OS/2 version + fixpack level
- Description of the procedure to reproduce the bug
- Trap description (register contents) (if you're reporting a crash)

The auther will try to help on a best efforts basis.

10 Warranty
===========
EXCEPT AS OTHERWISE RESTRICTED BY LAW, THIS WORK IS PROVIDED
WITHOUT ANY EXPRESSED OR IMPLIED WARRANTIES OF ANY KIND, INCLUDING
BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF FITNESS FOR A
PARTICULAR PURPOSE, MERCHANTABILITY OR TITLE.  EXCEPT AS
OTHERWISE PROVIDED BY LAW, NO AUTHOR, COPYRIGHT HOLDER OR
LICENSOR SHALL BE LIABLE TO YOU FOR DAMAGES OF ANY KIND, EVEN IF
THEY HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

