****************************************************************************
****************************************************************************
*                                                                          *
*       PIIX Bus Master IDE Drivers for OS/2*                              *
*       Installation, Usage, and Release Note Information                  *
*                                                                          *
*       NOTE:                                                              *
*            In this document, the term "PIIX" refers to any/all of the    *
*            following Intel PCIset devices:                               *
*            82371FB (PIIX1) or 82371SB (PIIX3) in conjunction with        *
*            the following Intel PCIsets:                                  *
*            430FX, 430HX, 430VX and 440FX                                 *
*                                                                          *
*            Also, the term "processor" refers to the Intel Pentium(R)     *
*            and Pentium(R) Pro devices ONLY.                              *
*                                                                          *
****************************************************************************
****************************************************************************

***     Document Header Revision Information:
***         $Revision:   1.3  $
***         $Date:   Apr 26 1996 $
        
****************************************************************************
*       INTRODUCTION                                                       *
****************************************************************************
This document describes the installation procedure and usage information
for the PIIX Bus Master IDE Drivers for OS/2. Also included 
are release notes describing any problems or issues with the software which 
were known at the time of shipment.

****************************************************************************
*       CONTENTS OF THIS DOCUMENT                                          *
****************************************************************************
This document contains the following sections:

    System Requirements
    Installing the Software
    Command Line Switches
    Un-installing the Software
    Troubleshooting
    Identifying the Software Version Number
    Contents of the Distribution Package
    Storage Devices Supported
    Release Notes

****************************************************************************
*       SYSTEM REQUIREMENTS                                                *
****************************************************************************
Hardware:

1.  The system must contain a supported processer and PIIX device as specified 
    by the NOTE at the beginning of this document.

2.  Ensure that a mouse is connected to the system.

3.  Do not use any other add-in IDE (PCI or ISA) card in the system during 
    installation.

Operating System:

1.  IBM OS/2 2.x or Warp* 3.x must be installed on the system prior to
    installing the driver.

2.  Perform installation off of the on-board primary PIIX IDE interface.


BIOS:

The BIOS must properly initialize the PIIX IDE interface for bus master
operation.

****************************************************************************
*       INSTALLING THE SOFTWARE                                            *
****************************************************************************
The following procedures for the installation of the PIIX Bus Master IDE
Drivers for OS/2 (PIIXIDE.ADD and PIIXIDE.FLT) are specific only to the
version of the drivers currently contained within this package.  

The following procedures assume that the OS/2 operating system was installed 
properly on the target system, and that the standard PIIX IDE driver, 
IBM1S506.ADD, and ATAPI CD-ROM filter driver, IBMIDECD.FLT, were used.
If IBM1S506.ADD or IBMIDECD.FLT were not used, the drivers which replaced them
should be un-installed before installing PIIXIDE.ADD and PIIXIDE.FLT.
Furthermore, if IBM1S506.ADD and IBMIDECD.FLT were not originally installed
on the target system, they should be installed first, and the system re-tested
with them, before installing PIIXIDE.ADD and PIIXIDE.FLT.

By default, bus mastering is disabled on ATAPI CD-ROM devices.  For DMA capable
CD-ROM devices, it should be enabled using command line parameters on the
PIIXIDE.ADD line in CONFIG.SYS.  For example, if the CD-ROM device is
connected as slave on the secondary IDE cable, bus mastering can be enabled
by installing PIIXIDE.ADD as follows:

    BASEDEV=PIIXIDE.ADD /A:1 /U:1 /BM

Note: For special conditions that may apply to your system, please review the
      RELEASE NOTES section, before installing the PIIX Bus Master IDE Drivers
      for OS/2.

Automatic Install Procedure:
****************************

1.  Run the install utility (INSTALL.EXE).  INSTALL.EXE copies PIIXIDE.ADD 
    and PIIXIDE.FLT from the source directory to the target directory,
    and changes the CONFIG.SYS file to install them.

    Command line format:   install [options]

    Command line options:

    /s:<source path>   Specifies the path to the directory containing
	       PIIXIDE.ADD.  The default source is the directory 
	       containing INSTALL.EXE.

    /t:<target path>   Specifies the path to the directory where 
	       INSTALL.EXE will copy PIIXIDE.ADD.  The default 
	       target is the \OS2 directory on the boot drive.

    /tu:<boot path>    Specifies the path to the directory containing
	       the CONFIG.SYS file.  The default directory is 
	       the root of the boot drive.

    /l:<logfile>       Specifies an optional log file.  If this option 
	       is used, the output will be redirected to the 
	       specified file, and INSTALL.EXE will run 
	       unattended.

    /p:<option>        Specifies a command line parameter for PIIXIDE.ADD.
	       The command line parameters will be inserted in the
	       PIIXIDE.ADD command line in the same order as the
	       corresponding /p:<option> parameters on the INSTALL
	       command line.

    /fp:<option>       Specifies a command line parameter for PIIXIDE.FLT.
	       The only command line parameter parameter supported
	       by the ATAPI CD-ROM filter driver is /v (verbose).
    
    All command line parameters are optional.  The install utility will not 
    install the PIIX Bus Master IDE drivers if it cannot detect one of the
    supported Intel PCIsets.

2.  Shutdown and reboot the system.


Manual Install Procedure:
*************************

1.  Copy PIIXIDE.ADD and PIIXIDE.FLT to the \OS2 directory on the boot drive.

2.  Make the following changes to the CONFIG.SYS file:

    Replace:
	BASEDEV=IBM1S506.ADD

    with:
	BASEDEV=PIIXIDE.ADD

    Replace:
	BASEDEV=IBMIDECD.ADD

    with:
	BASEDEV=PIIXIDE.FLT

3.  Shutdown and reboot the system.


Note: PIIXIDE.ADD auto-detects DMA capable hard disk drives and configures
      them and the Intel PCIset for bus master DMA transfers.

****************************************************************************
*       PIIXIDE.ADD COMMAND LINE SWITCHES                                  *
****************************************************************************

1.  Adapter Switch:            /A:x       where x is 0, 1, 2, or 3.

    This selects the adapter that will be referenced by subsequent
    switches.

2.  Unit Switch:               /U:x       where x is 0, 1, 2, or 3.

    This selects the unit that will be referenced by subsequent switches.

3.  Bus Master Disable Switch: /!BM

    This will disable the bus master DMA feature.  This capability is fully
    auto-detected by the driver.  If for any reason it is desirable to
    disable bus master DMA transfers, this switch can be used on a per
    adapter or per unit basis.  If used after a /A:x switch but prior to
    any /U:x or /UNIT:x switch, then bus master DMA transfers will be 
    disabled for all units on the adapter.  If the bus master disable switch 
    follows both /A:x and /U:x (or /UNIT:x) switches, then bus master DMA 
    transfers will be disabled only on the specified unit.

4.  All other option switches are same as for the "IBM1S506.ADD" driver.

****************************************************************************
*       PIIXIDE.FLT COMMAND LINE SWITCHES                                  *
****************************************************************************

    All option switches are the same as for the "IBMIDECD.FLT" driver.

****************************************************************************
*     UN-INSTALLING THE SOFTWARE                                           *
****************************************************************************
The following procedures are specific only to the version of the drivers 
currently contained within this package.  These procedures assume that the 
OS/2 operating system was installed properly on the target system, and that 
the PIIX Bus Master IDE drivers, PIIXIDE.ADD and PIIXIDE.FLT, were properly
installed according to the procedure described above.  

Automatic Un-install Procedure:
*******************************

1.  Run the un-install utility (UNINST.EXE).  UNINST.EXE removes 
    PIIXIDE.ADD and PIIXIDE.FLT from the target directory, and changes the
    CONFIG.SYS file to re-install IBM1S506.ADD and IBMIDECD.FLT.

    Command line format:   uninst [options]

    Command line options:

    /t:<target path>   Specifies the path to the directory containing
	       PIIXIDE.ADD.  The default target is the \OS2 
	       directory on the boot drive.

    /tu:<boot path>    Specifies the path to the directory containing
	       the CONFIG.SYS file.  The default directory is the
	       root of the boot drive.

    /l:<logfile>       Specifies an optional log file.  If this option is
	       used, the output will be redirected to the 
	       specified file, and UNINST.EXE will run 
	       unattended.

    All command line parameters are optional.

2.  Shutdown and reboot the system.


Manual Un-install Procedure:
****************************

1.  Make the following changes to the CONFIG.SYS file:

    Replace:
	BASEDEV=PIIXIDE.ADD

    with:
	BASEDEV=IBM1S506.ADD

    Replace:
	BASEDEV=PIIXIDE.FLT

    with:
	BASEDEV=IBMIDECD.FLT

2.  Delete PIIXIDE.ADD and PIIXIDE.FLT from the \OS2 directory on the boot 
    drive.

3.  Shutdown and reboot the system.

****************************************************************************
*       TROUBLESHOOTING                                                    *
****************************************************************************

Common Problems:
****************

1.  Some ATAPI CD-ROM devices require vendor-specific filter drivers.  These
    drivers should be loaded in conjuction with the PIIX Bus Master IDE
    driver, PIIXIDE.ADD.

2.  Verify the length of the cables that are being used to connect the IDE or
    ATAPI devices to the primary and secondary PIIX IDE interfaces.  The
    length of these cables from END-TO-END should not exceed 18 inches
    (0.46 m).  Furthermore, the capacitance of the cable should not exceed
    35 pF.

****************************************************************************
*        IDENTIFYING THE SOFTWARE VERSION NUMBER                           *
****************************************************************************
The following procedure uses the SEEVER.EXE utility to identify the version
number and build date of the PIIX Bus Master IDE drivers.  This procedure
assumes that the SEEVER.EXE utility and the driver files (PIIXIDE.ADD and 
PIIXIDE.FLT) are in the same working directory.

1.  From within OS/2, open the folder containing the PIIX Bus Master IDE
    driver.

2.  Double click on the SEEVER.EXE icon.

By defalult, SEEVER will display the version and build information of
PIIXIDE.ADD. To dispaly the version and build information of the ATAPI CD-ROM
filter driver, it must be explicitely specified on the SEEVER command line.
Open an OS/2 Window and from within the directroy containing the PIIX Bus
Master IDE Drivers kit, enter the following command:

    SEEVER PIIXIDE.FLT

****************************************************************************
*       CONTENTS OF THE DISTRIBUTION PACKAGE                               *
****************************************************************************
The distribution package contains the following items:

1.  Driver Software:
	PIIXIDE.ADD
	PIIXIDE.FLT

2.  Install Utility:
	INSTALL.EXE

3.  Un-install Utility:
	UNINST.EXE

4.  Readme File:
	README.TXT

5.  Version Identification Utility:
	SEEVER.EXE

****************************************************************************
*       STORAGE DEVICE SUPPORT                                             *
****************************************************************************
In general, bus mastering is possible for ATA fixed disk and ATAPI devices
that support the following DMA timing modes:

    Multi-Word DMA Mode 1
    Multi-Word DMA Mode 2

These devices will be accessed by the driver in either a bus mastering or a
PIO-fashion, depending on the specific transfer conditions.

Devices that do not support the DMA timing modes listed above, or whose PIO
timings are faster than their DMA timings, will be accessed in a PIO-fashion
ONLY.

For more information and a list of tested devices, see the RELEASE NOTES
section of this document.

****************************************************************************
*       RELEASE NOTES                                                      *
****************************************************************************

****************************************************************************
*       RELEASE NOTE OVERVIEW                                              *
****************************************************************************
The release notes describe the current, known state of the PIIX Bus Master 
IDE Driver for IBM OS/2.  The release notes are divided into three sections:

        General Release Information
        Release-Specific Troubleshooting Information
        Release Testing Information

****************************************************************************
*       GENERAL RELEASE INFORMATION                                        *
****************************************************************************

ATAPI tape drives have not been tested with this driver and are not supported
in the current release of this driver.

****************************************************************************
*       RELEASE-SPECIFIC TROUBLESHOOTING INFORMATION                       *
****************************************************************************
Verifying the installation of the driver and other generic troubleshooting is
discussed in the "TROUBLESHOOTING" section above.  This section describes
release-specific troubleshooting.

This section contains a list of known problems with certain system
configurations discovered during testing of the driver.  A list of all
storage devices tested with the driver is given below in the "RELEASE
TESTING INFORMATION" section of this document.
 
If the solution given to any of the problems listed below is to un-install the
driver, follow the un-installation instructions outlined above in the
section "UN-INSTALLING THE SOFTWARE".


    Issue:      If four devices are connected to the PIIX IDE controller, and 
		the verbose switch is present on the PIIXIDE.ADD command line
		in CONFIG.SYS, the system may hang during boot.

    Solution:   Do not use the verbose switch on the PIIXIDE.ADD command line
		if four devices are connected to PIIX IDE.


    Issue:      If two ATAPI CD-ROM devices are connected on the same cable
		and the BM command line switch is used to turn on bus mastering
		on both of them, bus mastering will be enabled only on the slave
		CD-ROM drive if the following command line is used:

		BASEDEV=PIIXIDE.ADD /A:? /U:0 /BM /U:1 /BM
 
    Solution:   Whenever two DMA capable ATAPI CD-ROM devices are connected
		on the same cable, use the following command line syntax to
		enable bus mastering on both devices:

		BASEDEV=PIIXIDE.ADD /A:? /U:1 /BM /U:0 /BM


    Issue:      The driver is not compatible with EZ-Drive floppy boot
                protection option. 
 
    Solution:   If EZ-Drive is installed on the boot drive, the floppy boot
                protection option must be disabled prior to installing the
                PIIX Bus Master IDE Drivers for OS/2.  If, for any reason,
                the floppy boot protection can not be disabled, the PIIX
                Bus Master IDE Drivers for OS/2 should not be installed.
                                

    Issue:      The system does not operate reliably or fails to boot when the
                driver is installed. 
 
    Solution:   Un-install the driver.
                                

    Issue:      The driver does not support the following fixed disk drives:

                    Maxtor 7245AV
                    Maxtor 71626AP
                    Maxtor 71260AT
				
    Solution:   Do not install the driver in configurations equipped with
                these fixed disk drives.


    Issue:      The driver does not support Quantum Maverick drives in DMA
                mode.

    Solution:   Force the drive into PIO-mode operation by using PIIXIDE.ADD
                command line parameters in the CONFIG.SYS.  For example, if
                this drive is set up as a slave on the primary cable, the
                following command line should be used to load the driver:

                BASEDEV=PIIXIDE.ADD /A:0 /U:1 /!BM

                NOTE: For a description of the command line parameters see the
                      above section titled "Command Line Switches".


    Issue:      The driver does not support Maxtor 7850AV and 7840AV drives
                with the multi-sector option enabled.

    Solution:   Turn off the multi-sector feature using PIIXIDE.ADD command
                line parameters in the CONFIG.SYS.  For example, if the drive
                is the master on the secondary cable, the following command
                line should be used:

                BASEDEV=PIIXIDE.ADD /A:1 /U:0 /!SMS

                NOTE: For a description of the command line parameters see the
                      above section titled "Command Line Switches".


    Issue:      The driver does not support the Conner CFS425A drive in DMA
                mode.

    Solution:   Force the drive into PIO-mode operation by using PIIXIDE.ADD
                command line parameters in the CONFIG.SYS.  For example, if
                this drive is set up as a slave on the primary cable, the
                following command line should be used to load the driver:

                BASEDEV=PIIXIDE.ADD /A:0 /U:1 /!BM

                NOTE: For a description of the command line parameters see the
                      above section titled "Command Line Switches".

    Issue:      The system does not recognize the CDD44E TEAC CD-ROM drive.

    Solution:   Prevent the driver from changing device settings by using
                PIIXIDE.ADD command line parameters in the CONFIG.SYS.
                For example, if this drive is connected to the secondary cable,
                the following command line should be used to load PIIXIDE.ADD:

                BASEDEV=PIIXIDE.ADD /A:1 /!BM

                NOTE: This workaround will disable bus mastering for the
                      devices connected on the same cable with the CD-ROM drive.

                      For a description of the command line parameters see the
                      above section titled "Command Line Switches".

****************************************************************************
*       RELEASE TESTING INFORMATION                                        *
****************************************************************************
This section contains information on how the driver was tested, including a
list of storage devices used in testing.  If any problems are encountered
running the driver with devices listed below, refer to the
"RELEASE-SPECIFIC TROUBLESHOOTING INFORMATION" section above for more
detailed information.

The following fixed disk drives were tested with the PIIX Bus Master IDE
Driver:

Conner*:

    CFA540A
    CFA850A 
    CFA1275A
    CFS425A
    CFS850A
    CFS1275A

IBM*:

    DALA-3540
    DALA-31080

Maxtor*:

    7245AT
    7540AV
    71260AT 
    71626AP 

Quantum*:

    FB540A
    FB640A
    FB1080A
    FB1280A
    LPS270A
    TRB420A
    TRB850A

Seagate*:

    ST5660A
    ST5850A
    ST51080A
    ST31220A
    ST31270A
    ST32140A

Western Digital*:

    AC2420
    AC2510
    AC2700
    AC2850
    AC31000
    AC31600
    AC21000


The following ATAPI CD-ROM drives were tested with the PIIX Bus Master IDE
Driver:

Gallant*:

    GCD-R542B 

Hitachi*:

    7730

Matshita*:
    CR581

Mitsumi*:

    FX001DE
    FX400 
    FX400B
    FX400C
    FX600S
    FX600T

NEC*:

    CDR260R
    CDR271
    CDR272

Panasonic*:

    CD-574B

Philips*:

    CM207

Sanyo*:
    
    CRD-S54P

Sony*:

    CDU55E
    CDU76E
    CDU77E

TEAC*:

    CD44E
    CD56E

Torisan*:

    S1G 
    C3G 

Toshiba*:

    XM5302B

Vertos*:

    V300HPD

Wearnes*:

    CDD-120
    CDD-220 
