USBKEYBD README

December 2, 2005

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

This README contains information for the Universal Serial Bus (USB) Keyboard
Device Driver Support for OS/2. The following versions of OS/2 are supported
by this package:

  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-Keyboard Support
	2.1  USB-Keyboard Installation
	2.2  Using USB Keyboard with the OS/2 Installation or Utility Diskettes
		2.2.1  Boot Diskettes Modifications
	2.3  USB-Keyboard Driver Additional Parameters
	2.4  USB-Keyboard Un-Install Instructions
	2.5  List of Tested USB-Keyboards
	2.6  Requirements
3.0  Copyright and Trademark Information


1.0  Introduction
_________________

This USBKEYBD.EXE driver package provides you with IBM's most current support
for Universal Serial Bus (USB) keyboard devices on the OS/2 Operating System.

1.1  The USBKEYBD.EXE file that you received contains the following 5
     files in a self-extracting compressed format.

        -  USBKEYBD.TXT  This file that you are reading
        -  USBKBD.DDP    Device driver profile file
        -  USBKBD.SYS    USB Keyboard Driver
        -  IBMKBD.SYS    Keyboard Driver with USB support
        -  TSTUSBC.EXE   Tests USB Stack


2.0  USB-Keyboard Support
_________________________

The USB Base Stack package (USBBASIC) is a pre-requisite for
USB Keyboard Support. Please install it first.


2.1  USB-Keyboard Installation Instructions
===========================================

2.1.1	To use these USB driver files, you must expand the USBKEYBD.EXE
	file into its 5 component files by
 		(a.) opening an OS/2 window and
        	(b.) typing USBKEYBD at the OS/2 command prompt.
	Once the USBKEYBD.EXE file is expanded, please continue with the
        USB Installation Instructions.

2.1.2	At the OS/2 command prompt, type DDINSTAL. This command will open
	Device Driver Installation dialog.

2.1.3	Change Source directory to current (where 5 component files reside)
	by pressing 'Change..." button.

2.1.4	Press "Install..." button to perform actual installation and "Exit"
	button installation utility.

	If USBBASIC stack was not installed on the system you will see the message
	"The file, TSTUSBC.EXE, returned a non-zero return code.This DDP file
	did not run." You have to install USBBASIC before installing USBKEYBD.EXE.

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


2.2 Using USB Keyboard with the OS/2 Installation or Utility Diskettes
======================================================================

The USB Stack must be added to the Installation or Utility diskettes
first. See the USBBASIC package for details.


2.2.1 Boot Diskettes Modifications
----------------------------------

Add the following statement to the CONFIG.SYS file
on Diskette 1 after the string BASEDEV=USBHID.SYS

    DEVICE=\USBKBD.SYS

Copy the following USB Device Driver to Diskette 2:

    USB KeyBoard Driver (USBKBD.SYS)

Copy the following USB Device Driver to Diskette1:

    KeyBoard Driver (IBMKBD.SYS)


2.3 USB-Keyboard Driver Additional Parameters
=============================================

DEVICE=drive:\OS2\BOOT\USBKBD.SYS

       Where drive: is the drive letter of the OS/2 boot partition on your
       system.

PARAMETER 	FUNCTION

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

  /DEVICE:n     Parameter is added to select which USB device to serve in
		multidevice configurations (several keyboards devices
		attached to USB bus).


2.4  USB-Keyboard Un-Install Instructions
=========================================

2.4.1  Delete from CONFIG.SYS file line configuring USBKBD.SYS device driver
       (line starting with DEVICE=drive:\OS2\BOOT\USBKBD.SYS) and file
       USBKBD.SYS from \os2\boot directory.

2.4.2  Safely shut down and then re-boot your system in order to re-load the
       original (non-USB) keyboard driver properly.


2.5 List of Tested USB-Keyboards
================================

Microsoft Natural Keyboard Elite
Belkin USB Classic Keyboard
Cherry G81-3504LAAUS
BTC combined USB keyboard
IBM (made by Chicony) USB keyboard (prototype)


2.6 Requirements
================

2.6.1  Hardware
	USBKBD.SYS driver is designed to work with any standard USB keyboard.

2.6.2  Software
       (a.) USB Basic support


3.0  Copyright and Trademark Information
________________________________________

The  following  terms  are  trademarks of  International  Business  Machines
Corporation in the United States and/or other countries:
      IBM
      OS/2
      ThinkPad
      Ultrabay
      Warp
      Warp Server
      Warp Server for e-business
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, 2005. All rights reserved.
U.S. Government  Users Restricted Rights  -- Use, duplication  or disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.

