USBBASIC README

January 20, 2003

	OS/2 Device Driver Development
	IBM Solution Technologies
	Austin, TX

This README contains information
for the Universal Serial Bus (USB) Basic Device Driver Support for
OS/2 Warp 3,
OS/2 Warp 4,
OS/2 Warp Server for e-business,
OS/2 Warp 4 Convenience Pack 1,
OS/2 Warp 4 Convenience Pack 2,
OS/2 Warp Server for e-business Convenience Pack 1,
OS/2 Warp Server for e-business Convenience Pack 2.


CONTENTS
________

1.0  Introduction
2.0  USB-Basic Support
	2.1  USB-Basic Installation Instructions
	2.2  Adding the USB stack to the OS/2 Installation or Utility Diskettes
		2.2.1	Modifying Diskette 1
	2.3  USB-Basic Driver Additional Parameters
	2.4  USB-Basic Un-Install Instructions
	2.5  Recomendations
	2.6  List of Tested UHCI Adapters
	2.7  List of Tested OHCI Adapters
	2.8  List of Tested EHCI Adapters
	2.9  Requirements
3.0  Copyright and Trademark Information


1.0  Introduction
_________________

This USBBASIC.EXE driver package provides you with IBM's most current support
for Universal Serial Bus (USB) devices on the OS/2 Operating System. It contains 
support for three types of host controller interfaces:
	Open Host Controller Interface (OHCI)
	Universal Host Controller Interface (UHCI).
	Enhanced Host Controller Interface (EHCI).
This package provides the basic
support required for any supported USB device.

1.1  The USBBASIC.EXE file that you received contains the following 7 USB
     files in a self-extracting compressed format.

	-  USBBASIC.TXT	This file that you are reading

	-  USBD.SYS	USB Driver
	-  USBHID.SYS	USB Human Interface Driver
	-  USBOHCD.SYS	OHCI compliant USB host controller driver
	-  USBUHCD.SYS	UHCI compliant USB host controller driver
	-  USBEHCD.SYS	EHCI compliant USB host controller driver

	-  HCIMONIT.EXE	Host Controller adapter(s) monitor utility


2.0  USB-Basic Support
______________________

2.1  USB-Basic Installation Instructions
========================================

2.1.1	To use these USB driver files, you must expand the USBBASIC.EXE
	file into its 7 component files by
	        (a.) opening an OS/2 window and
		(b.) changing to the temporary directory where USBBASIC.EXE is
		     stored and
        	(c.) typing USBBASIC at the OS/2 command prompt.
     	Once the USBBASIC.EXE file is expanded, please continue with the
     	USB Installation Instructions.

2.1.2	Start HCIMONIT.EXE utility. It reports the number of UHCI, OHCI and
	the number of EHCI controllers on your system. If no UHCI, OHCI or EHCI
	controllers are reported, do not proceed.

2.1.3	At the OS/2 command prompt, type USBINST. This program will install or refresh USB
	support on your PC.

2.1.4	On IBM 365 systems add parameter /FS to USBUHCD entry in CONFIG.SYS
	(for parameter explanation see section 2.3).

2.1.5	This completes the USBBASIC installation procedure. You can install any
	other USB device drivers and after that you must REBOOT the system.


2.2 Adding the USB stack to the OS/2 Installation or Utility Diskettes
======================================================================

The USB stack must first be added to the OS/2 Installation or Ulitily diskettes
if you wish to use USB devices ( floppy diskette drive, mouse, keyboard ) when
booting from diskette. Refer to the READMEs with each USB device package for
instructions on updating the diskettes for the device.


2.2.1 Modifying Diskette 1
--------------------------
Determine the number and type of USB host controllers on your system
by following the instructions in section 2.1.2.

Add the following sequence of statements
to the CONFIG.SYS file on the Diskette:

    SET SAVECONNECT=1
    SET COPYFROMFLOPPY=1
    BASEDEV=USBD.SYS /I13

    BASEDEV=USBUHCD.SYS(one copy of this statement for each UHCI controller reported by HCIMONIT)

    BASEDEV=USBOHCD.SYS(one copy of this statement for each OHCI controller reported by HCIMONIT)

    BASEDEV=USBEHCD.SYS(one copy of this statement for each EHCI controller reported by HCIMONIT)

    BASEDEV=USBHID.SYS

Copy the following USB Device Drivers to Diskette:

    USB Driver (USBD.SYS)
    USB UHCI Host Controller Driver (USBUHCD.SYS)
    USB OHCI Host Controller Driver (USBOHCD.SYS)
    USB EHCI Host Controller Driver (USBEHCD.SYS)
    USB Human Interface Driver (USBHID.SYS)

If there is not enough space on boot diskettes to contain the
additional drivers, follow the instructions README.TXT in the root directory
of your OS/2 system to make additional space.

For Warp 4 and Warp 3 IDEDASD package from DDPak also should be applied
if installing OS/2 on HDD larger than 8.4GB.

Note: After installation from modified diskettes remove parameter /I13 from
      the statement BASEDEV=USBD.SYS and reorder statements to be in the following order:
         1. USB Host Controller Driver statements (BASEDEV=USBUHCD.SYS, BASEDEV=USBOHCD.SYS and BASEDEV=USBEHCD.SYS)
         2. USB Driver statement (BASEDEV=USBD.SYS)
         3. Other USB Drivers statements


2.3 USB-Basic Driver Additional Parameters
==========================================

BASEDEV=USBD.SYS
PARAMETER	 	   FUNCTION

   /V		           Verbose Mode, displays driver information
			   during OS/2 initialization.

   /I13			   /I13 parameter could be used to delay USB host
			   overtaking by USB driver stack until other device
			   driver finishes required initialization operations
			   and then send request to USBD driver to start USB
			   service. It could be used to boot from USB floppy
			   drive.

			   /REQ parameter controlls USBD driver initialization:
			   driver at initalization time checks for listed host
			   controller drivers and fails to install if none of
                           listed drivers is loaded. Current version of USB stack
                           supports the following parameter codings:

  /REQ:USBUHCD$		   USBD driver is loaded only if UHCI compliant host driver is loaded
  /REQ:USBOHCD$		   USBD driver is loaded only if OHCI compliant host driver is loaded
  /REQ:USBEHCD$		   USBD driver is loaded only if EHCI compliant host driver is loaded
  /REQ:USBUHCD$,USBOHCD$,USBEHCD$
			   USBD driver is loaded only if one of OHCI/UHCI/EHCI compliant
			   host drivers is loaded. This most general form of parameter
			   and must be used in most cases. If you are using /REQ parameter
			   all statements "BASEDEV=USBUHCD.SYS", "BASEDEV=USBOHCD.SYS"
			   and "BASEDEV=USBEHCD.SYS" must be first in the sequence of USB statements.

BASEDEV=USBHID.SYS
PARAMETER	 	   FUNCTION

   /V		           Verbose Mode, displays driver information
			   during OS/2 initialization.

BASEDEV=USBOHCD.SYS
PARAMETER 	FUNCTION

  /V		Verbose Mode, displays driver information during OS/2
		initialization.

  /FS		Forces driver to stop USB host during OS/2 shutdown process.
		This parameter can be used to prevent POST (power on system
		test) failure on some hardware with legacy keyboard.

BASEDEV=USBUHCD.SYS
PARAMETER 	FUNCTION

  /V		Verbose Mode, displays driver information during OS/2
		initialization.

  /FS		Forces driver to stop USB host during OS/2 shutdown process.
		This parameter can be used to prevent POST (power on system
                test) failure on some hardware with legacy keyboard.

BASEDEV=USBEHCD.SYS
PARAMETER 	FUNCTION

  /V		Verbose Mode, displays driver information during OS/2
		initialization.

  /FS		Forces driver to stop USB host during OS/2 shutdown process.
		This parameter can be used to prevent POST (power on system
		test) failure on some hardware with legacy keyboard.


2.4  USB-Basic Un-Install Instructions
======================================

2.4.1  Delete from CONFIG.SYS file lines starting with
	BASEDEV=USBD.SYS
	BASEDEV=USBHID.SYS
	BASEDEV=USBOHCD.SYS
	BASEDEV=USBEHCD.SYS
	BASEDEV=USBUHCD.SYS
         and files from \os2\boot directory:
	USBD.SYS
	USBHID.SYS
	USBOHCD.SYS
	USBUHCD.SYS
	USBEHCD.SYS

2.4.2  Safely shut down and then re-boot your system.


2.5 Recommendations
===================
If you are running OS/2 on an IBM ThinkPad or other notebook system and you
do not use any USB devices then you may want to "remark" the USB device driver
statements in your CONFIG.SYS file.  This action may lower your notebook
system's power requirements and may extend your battery's operating life.
Battery life will vary based on many factors including screen brightness,
applications, features, power management settings, battery conditioning, and
other customer preferences.


2.6 List of Tested UHCI Adapters or Controllers
===============================================

  2.6.1.  D-Link DU-A2 PCI USB controller

  2.6.2.  Intel 82371AB/EB PCI to USB Universal Host Controller

  2.6.3.  Intel 82801AA USB Universal Host Controller

  2.6.4.  Intel 82801CA/CAM USB Universal Host Controller


2.7 List of Tested OHCI Adapters
================================

  2.7.1.  Entrega PCI4U 4Port USB Upgrade

  2.7.2.  Belkin USB BusPort F5U005

  2.7.3.  Sis 7001 PCI to USB Open Host Controller


2.8 List of Tested EHCI Adapters
================================

  2.8.1.  Adaptec USB2Connect Adapter Card AUA-3100LP

  2.8.2.  USB 2.0 Hi-Speed PCI Card F5U220

  2.8.3.  Intel 845 based motherboard with built-in USB 2.0 chipset


2.9  Requirements
=================

2.9.1  Hardware
	Any PCI to USB Host Controller compatible with
	USB 1.1 or USB 2.0 specification and using
	UHCI, OHCI or EHCI interface.


3.0  Copyright and Trademark Information
________________________________________

The following terms, are registered trademarks of the International 
Business Machines Corporation in the United States, or other countries,
or both:
o IBM
o OS/2
o Warp

Other company, product, and service names may be trademarks or service
marks of others.

THE INFORMATION PROVIDED IN THIS README IS PROVIDED "AS IS" WITHOUT 
WARRANTY OF ANY KIND.  IBM DISCLAIMS ALL WARRANTIES, WHETHER 
EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED 
WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY 
WITH RESPECT TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING
THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS.

(C) Copyright IBM Corporation, 2001. All rights reserved.
U.S. Government Users Restricted Rights -- Use, duplication or 
disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
