USB Mass Storage Device README

September 23, 2004

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

This README contains information on the Universal Serial Bus (USB) 
Mass Storage Device Support for the following version of OS/2:

	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-Removable Media and CDROM Support
	2.1  Prerequisite Requirements
	2.2  USB-Removable Media and CDROM Installation Instructions
	2.3  Additional Parameters
	2.4  Uninstall Instructions
	2.5  Using a USB Floppy Drive or USB CDROM drive
	     when using the OS/2 Installation disks or Utility Diskette 
	2.6  Tested USB-Removable Media and CDROM Devices
	2.7  Requirements for Functionality 
	2.8  Known Limitations
	2.9  Removable Device Monitoring Utility User Instructions
3.0  Copyright and Trademark Information


1.0  Introduction
_________________

The USB Mass Storage Driver Package (USBMSD.EXE) provides the latest support 
for Universal Serial Bus (USB) Removable Media and CDROM devices for OS/2.

1.1  The USBMSD.EXE package contains the following files 
     in a self-extracting compressed format.

      -  TSTUSBC.EXE   Tests USB Base Stack
      -  TSTUSBC.SYM   Debug symbol file for TSTUSBC.EXE
      -  USBCDROM.ADD  USB CDROM Device Driver
      -  USBCDROM.SYM  Debug symbol file for USBCDROM.ADD
      -  USBICON.CMD   Removable device monitoring utility icon installation
                       command file
      -  USBMON.EXE    Removable device monitoring utility
      -  USBMON.ICO    Icon file for the Removable Device Monitor (USBMON.EXE)
      -  USBMON.INI    Sample configuration file for the Removable Device
                       Monitor (USBMON.EXE)
      -  USBMON.SYM    Debug symbol file for USBMON.EXE
      -  USBMSD.ADD    USB Removable Media Device Driver
      -  USBMSD.DDP    Device driver profile
      -  USBMSD.SYM    Debug symbol file for USBMSD.ADD
      -  USBMSD.TXT    This readme file
      -  USBWARN.EXE   Removable device warning utility
      -  USBWARN.MSG   Removable device warning utility messages


2.0  USB-Removable and CDROM Support
___________________________________


2.1  Prerequisite Requirements
________________________________

The USB Base Stack package (USBBASIC) is a prerequisite for this package.
Please install the USBBASIC package on your system if it is not already
installed on your system.

2.2  USB-Removable and CDROM Installation Instructions
_______________________________________________________

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

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

2.2.3 Change the Source directory to current (where the 11 component files
      reside) by pressing 'Change..." button.

2.2.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 USBMSD.EXE.

2.2.5 If the previous steps were competed without errors, change
      directory by typing "cd \os2\boot" at the OS/2 command prompt. 
      Then type "usbicon" to install the removable device monitoring utility
      icon in the OS/2 startup folder. If you don't want to activate the
      removable device monitoring utility, you can skip this step.

2.2.6 This completes the installation procedure. You can install
      other USB device drivers at this time and when complete you must
      reboot your system.


2.3  Additional Parameters
__________________________

After installation, the USB-Removable Media / CDROM drivers
by default support 1 floppy device (including LS-120 Super Disk devices),
1 removable media device (like an IOMEGA ZIP drive) and 1 CD-ROM/CD-RW 
device type.


Additional Driver Parameters for BASEDEV=USBCDROM.ADD

PARAMETER 	FUNCTION

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

  /CDS:n    Number of CD-ROM/CD-RW devices to be served (by default 1).
            To remove service the key value must be set to 0.


Additional Driver Parameters for BASEDEV=USBMSD.ADD

PARAMETER 	FUNCTION

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

  /A_USAGE:n  Parameter controls usage of 'A' drive flag for the 1st
              floppy device. The following values of n can be used:
                     0 - 'A' drive flag is not used;
                     1 - 'A' drive flag is used;
                     2 (default value) - 'A' drive flag is used
                           only if there is no other device driver
                           using this flag.

  /MAX_FLOPPY Parameter forces driver to report floppy device geometry
              with maximal sector count as floppy device physical
              geometry. With this parameter driver supports LS-120 media
              formatting but does not support XDF floppy filter features
              and vice versa.

  /FLOPPIES:n   Number of floppy devices to be served (by default 1). 
                In order to remove service the key value must be set to 0.

  /REMOVABLES:n Number of removable media devices to be served 
                (by default 1). For example, the statement
 
		         BASEDEV=USBMSD.ADD /FLOPPIES:2 /REMOVABLES:3

                serves 2 floppy devices (including LS-120 Super Disk
                devices) and 3 removable media devices (like IOMEGA ZIP
                drive) or one removable multiple lun device with 3 media
                slots in it. The parameter /REMOVABLES:3 must be defined to
                access a media inserted to the last device slot. In common
                case /REMOVABLES:n should be the sum of all logical devices
                the user expects to use. For example in a system with 1 USBZIP
                drive and 1 flash card reader with 4 slots the count of
                removable devices has to be equal 5. In order to remove
                service the key value must be set to 0.
  /REMOVABLE_AS_FLOPPY  System uses removable disks as Large Floppies.


Additional Driver Parameters for BASEDEV=OS2DASD.DMD

PARAMETER 	FUNCTION

  /MP: (device_number, partition_count)
                Number of partitions for device number (by default 1).


2.4  Uninstall Instructions
___________________________

Open the "OS/2 System/Startup" folder, press the right mouse
button on the "Removable Device Monitor" icon and choose "Delete"
option from the menu.

Delete the following lines from the CONFIG.SYS file

            BASEDEV=USBMSD.ADD
            BASEDEV=USBCDROM.ADD

and delete the following files in the \os2\boot directory:

            USBMSD.ADD
            USBCDROM.ADD
            USBMON.EXE
            USBWARN.EXE
            USBWARN.MSG
            USBMON.INI
            USBMON.LOG
            USBMON.ICO
            USBICON.CMD

Shutdown and reboot your system in order to have this take affect
and remove the USB Mass Storage drivers from the system. 	


2.5 Using a USB Floppy Drive or USB CDROM drive
    when using the OS/2 Installation disks or Utility Diskette
_______________________________________________________________

The use of USB floppy diskette or USB CDROM devices require that the 
USB Basic Device Support package first be added to the Installation or
Utility diskettes. Refer to the USB Basic Device Support package readme
for instructions. It also requires the BIOS to support booting from USB 
devices. You should verify your BIOS setting provide and are configured 
for this support.  

Once the Installation or Utility diskettes are updated 
with the necessary USB Basic Device Support, 
you can proceed with the USB Mass Storage Device Driver updates.

Add the following statement to the CONFIG.SYS file
on Diskette 1 after the last USB statement:

    BASEDEV=USBMSD.ADD

Copy the USB Mass Storage Device Driver, USBMSD.ADD, from this package
to Diskette 1.

If you are using USB Floppy Diskette Drive for OS/2 Warp Installation, 
disable installation of the legacy floppy diskette driver. Remark the 
BASEDEV=IBM1FLPY.ADD
statement in the CONFIG.SYS file on Diskette 1:

    REM BASEDEV=IBM1FLPY.ADD

If you are using USB CDROM for OS/2 Warp installation, add the following
statement to the CONFIG.SYS file after the statement BASEDEV=USBMSD.ADD:

    BASEDEV=USBCDROM.ADD

Copy the USB CDROM Device Driver, USBCDROM.ADD, from this package to Diskette 1. 


2.6 Tested USB-Removable Media and CDROM Devices
__________________________________________________

			
	HP CDWriter Plus 8200 USB
	IBM 64MB USB 2.0 Memory Key
	IBM 256MB USB 2.0 Memory Key	
	IBM USB floppy drive (FRU P/N 05K9283)
	IBM USB floppy drive (FRU P/N 06P5223)	
	Imation Super Disk Drive
	IOMEGA USB CD-RW 
	IOMEGA USB PocketZip drive
	IOMEGA ZIP-100 USB drive
	IOMEGA ZIP-250 USB drive
	IOMEGA ZIP-750 USB 2.0 drive
	KanguruMicro 64MB KanguruMicro Drive
	Newer Technology USB Floppy Drive
	SCSI to USB converter with Iomega JAZ drive
	Sony Spressa CRX100E/X
	USB compact FLASH Reader/Writer
	VST USB Floppy Drive
	Winstation USB Super Disk Drive
        Belkin Hi-Speed USB 2.0 8-in-1 Media Reader & Writer

NOTE: USB Floppy boot support has only been tested on
      UHCI (Universal Host Controller Interface) compliant USB host
      controllers.


2.7 Requirements for Functionality
___________________________________

2.7.1  Hardware
       Removable media/CDROM drivers are designed to work with all devices
       that are manufactured and function according to the USB mass storage
       device specifications.

2.7.2  Software from OS/2 Device Driver Pak Online
       (a.) USB Basic Device Support
       (b.) DVD/UDF Support.
       (c.) Enhanced IDE Support.


2.8 Known Limitations
______________________

2.8.1  Only USB Memory Keys sized 16MB or larger are supported.

2.8.2  IBM 32MB USB Memory Key and Iomega PocketZip USB drive do not 
       suspend and resume properly. These devices must be ejected and
       Detached before you start the suspend mode.
       
2.8.3  Eject must always be executed for USB removable device prior to
       detaching or switching them off from a booted system. This is
       necessary for data integrity and correct drive operation after
       reattaching the drive.

2.8.4  USB Basic support must be at the latest version before
       installing the removable device monitoring utility.

2.8.5  Because it can take up to 20 seconds for the system to
       identify some USB ZIP drives, when the drive is empty and 
       after the media is inserted into the drive, 
       a message that the drive has been attached to the system may
       appear when the media refresh is performed or when the
       media is accessed for the first time.

2.8.6  USB Pocket ZIP device may not be detected correctly by the
       removable device monitoring utility when attached or detached
       from the system, when the system  is in the suspended state.

2.8.7  The time interval between when a device is attached and when it
       appears as an icon in the system depends on the device. The time
       can reach up to 60 seconds per device for devices with multiple
       LUNs. The time depends primarily on the  number of
       empty slots. The more empty slots there are in a device,
       the longer the time out interval.

2.8.8  'Write with verify' option support relies on hardware feature and will fail
       on devices without this support.


2.9 Removable Device Monitoring Utility User Instructions
_________________________________________________________

2.9.1  To stop the removable device monitoring utility:

          - click on the "Switch to another application" button on
            the WarpCenter status bar;
          - select "Removable Device Monitor" application from the pop-up
            menu;
          - when the removable device monitoring utility application window
            appears on the screen, click on the "Close Application" button
            in the upper right corner.

2.9.2  To restart the previously stopped removable device monitoring
          utility:

          - double click on the "OS/2 System" icon, which is located on the
            main OS/2 desktop;
          - double click on the "Startup" icon in the "OS/2 System" window;
          - double click on the "Removable Device Monitor" icon in the
            "Startup" window.

2.9.3  To disable the removable device monitoring utility:

          - stop the removable device monitoring utility according to p.
            2.9.1;
          - double click on the "OS/2 System" icon, which is located on the
            main OS/2 desktop;
          - double click on the "Startup" icon in the "OS/2 System" window;
          - click the right mouse button on the "Removable Device Monitor"
            icon in the "Startup" window;
          - select the "Delete" command from the pop-up menu;
          - press the "Delete" button in the "Delete Object(s)" dialog box;
          - press "Yes" button in the "Confirm on Program Delete" message
            box;

2.9.4  To re-enable the previously disabled removable device monitoring
       utility:

          - enter command "cd \os2\boot" at the OS/2 command prompt;
          - enter "usbicon" command;
          - restart the removable device monitoring utility according to p.2.9.2.


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, 2004. All rights reserved.
U.S. Government Users Restricted Rights -- Use, duplication or 
disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
