File Name: Readme.txt This README file contains the latest information about installing the IBM FAStT Host Adapter Device Driver version 8.00.09.14 on a Windows NT 4.0 platform. Refer to the IBM Support Web site or CD for the IBM FAStT Host Bus Adapter Installation and User's guide, the latest information, and updated readme file (see Section 6.1 below). Last Update: 11/08/01 CONTENTS ------------------ 1.0 Overview 2.0 Change History 3.0 Installation and Setup Instructions 4.0 Configuration Information 5.0 Unattended Mode 6.0 Web Sites and Support Phone Number 7.0 Trademarks and Notices 8.0 Disclaimer 1.0 Overview =========== 1.1 IBM FAStT Host Adapter Device Driver overview The IBM FAStT Host Adapter Device Driver supports point-to-point F-port, FL-port, N-port, and Arbitrated Loop configurations, bandwidth to 200 MB per second (full-duplex), reaches distances through 20KM, and supports critical San-enabled features. 1.2 Limitations: N/A 1.3 Enhancements: - Support for Enhanced loop ID support (251 Loop IDs) in F port configuration - Support for Full-duplex operation in loop configuration - Support for Extended LUN - Support for Scan attached target device by port name - Support for Dynamic LUN Masking - Support for 2200G adapter - Support for IBM Hot Swap - Support for diagnostic loopback test - Support for QLogic Internet Protocol (IP) driver - Support for Fibre Channel Tape =========================================================== 1.4 Prerequiesites for the update: ----------------------------------------------- - Update IBM FAStT Host Adapter BIOS to 1.76. The adapter bios can be updated by booting the server to the IBM FAStT Host Adapter bios update diskette, available from the IBM Support website, then run the following command: flastuil /f /l This will update all of the IBM FAStT Host Adapters in this server to the 1.76 bios level. 2.0 Change History ================ The IBM FAStT Host Adapter Device Driver version 8.00.09.06 to version 8.00.09.14 changes consist of the following: * Includes RISC code 2.1.36 TP/IP * Retracted the change: Use NT4 & W2K consistent version number to version string * Close 173565: Driver will not create crash dump file * Use NT4 & W2K consistent version number to version string * Close 38222: WW1.2 System lost paths (connection time out) to the storage when running HCT Phase 1 * Close 38296: tr skipped with cluster=1 * Close 37700: fatal error while running cluster arb test, fabric hung w/ Engineering 2200 risc - 231.1.35 * Close not issueing global TPLO * Close not seeing partner in cluster environment * Close DFCT35942: boot from SAN hosts crash * Close DFCT37197: miniport driver only sees one path * Close DFCT37019: Stop A at SCSIPort.sys with B9 driver installed * Close DFCT36892: device entries moving from the fabric port summary over to the known port summary without appling a configuration during a port update even * Cleanup exchange after port down retry count expires * Fixed pass through IOCTL * Fix cluster=2 problem * Add support for dynamic update of execution throttle parameter (requires risc v2.01.35) * Add support for cluster=2 * Close DFCT34732: Pseudo drives are visible in disk admin. * Close DFCT34594: QMSJ install says "pseudo=2" must be set but QLA2200 driver does not set this * Fix issues with pass through IOCTLs * Remove the loop down recovery and mark local device offline after port down retry expires 3.0 Installation and Setup Instructions ============================= This section is divided into the following five sections. 3.1 Initial OS installation with the IBM FAStT Host Adapter as Boot 3.2 Adding the IBM FAStT Host Adapter to the Existing OS 3.3 Updating the existing IBM FAStT Host Adapter Driver 3.4 Removing the IBM FAStT Host Adapter Driver. =========================================================== 3.1. Install Windows NT initially with the IBM FAStT Host Adapter as Boot. ----------------------------------------------------------------------------------------------------- Contact IBM Support for supported configurations and instructions for configuring IBM FAStT Host Adapter as boot devices. =========================================================== 3.2 Adding the IBM FAStT Host Adapter Driver to an Existing system running Windows NT. ----------------------------------------------------------------------------------------------------------- To add the IBM FAStT Host Adapter miniport driver on an existing Windows NT system, use the following procedure: 1. Click Start. 2. Under Settings, click Control Panel. 3. Select SCSI Adapters. 4. Select the Drivers tab and then click Add. 5. Click Have Disk. 6. Insert the IBM FAStT Host Adapter miniport driver software diskette. 7.Type A:\NT for the path to the NT driver and click OK. 8. Choose QLogic QLA2200 PCI Fibre Channel Adapter and click OK. 9. Select Yes to restart system. =========================================================== 3.3 Updating the IBM FAStT Host Adapter driver -------------------------------------------------------------------- Perform the following steps if the driver is already installed and you want to install an updated version of the driver. 1. Open a DOS Command Prompt window. 2. Change the current directory to the Windows NT driver directory: CD %SystemRoot%\SYSTEM32\DRIVERS 3. Make a backup copy of the old driver. At the command prompt, type: COPY QL2200.SYS QL2200.SAV 4. Insert the IBM FAStT Host Adapter driver installation diskette and copy it over the old driver. At the command prompt, type: COPY A:\NT\QL2200.SYS 5. Shutdown and reboot the system to use the updated driver. =========================================================== 3.4 Removing the IBM FAStT Host Adapter Driver. ----------------------------------------------------------------------- Perform the following steps to uninstall the IBM FAStT Host Adapter driver from Windows NT: 1. Click Start. 2. Under Settings, click Control Panel. 3. Select SCSI Adapters. 4. Select the Drivers tab and then click on QLogic QLA2200 PCI Fibre Channel Adapter. 5. Click Remove. 6. Select Yes to restart system. =========================================================== 4.0 Configuration Information 4.1 Hard Loop ID -------------------------- It is recommended that you set different Hard Loop IDs for each IBM FAStT Host Adapter in a single Host or in each Node in a cluster. For example, in Host Adapter Settings, set the Hard Loop ID to 125 for the first host in a cluster and set the Hard Loop ID to 124 for the other host in the cluster. You can configure the adapter using the Fast!UTIL utility. Access Fast!UTIL by pressing Alt+Q during host BIOS initialization. Refer to the IBM FAStT Host Adapter Installation and User's Guide for additional information on setting the Hard Loop ID. If you do not assign different Hard Loop IDs, the Fibre Channel protocol will automatically assign Loop IDs when their is a conflict. =========================================================== 4.2 Qlogic QLA2200 Adapter ------------------------------------------ If you are installing the IBM FAStT Host Adapter in a system that had a previously installed Qlogic QLA2200 Adapter, you will need to use the Updating the IBM FAStT Host Adapter Driver procedure to ensure that the correct device driver qla2200.sys is loaded for the IBM FAStT Host Adapter. =========================================================== 4.3 Port Down Retry Count -------------------------------------- From the Advanced Adapter Settings, change the Port Down Retry Count to 70 (if you have more than 5 devices on the fibre channel loop attached to the IBM FAStT Host Adapter). Fibre Channel Host Adapters and Storage Subsystems are counted as fiber channel devices. You can configure the adapter using the Fast!UTIL utility. Access Fast!UTIL by pressing Alt+Q during host BIOS initialization. Refer to the IBM FAStT Host Adapter Installation and User's Guide for additional information on setting the Port Down Retry Count. =========================================================== 4.4 Driver Parameters --------------------------------- The driver parameters are divided into System Registry Parameters and NVRAM Parameters sections. 4.4.1 System Registry Parameters ------------------------------------------------ Below is a description of the registry parameters used by the driver: - MaximumSGList Windows NT includes an enhanced scatter/gather list support for doing very large SCSI I/O transfers. Windows NT supports up to 256 scatter/gather segments of 4096 bytes each, allowing transfers up to 1048576 bytes. NOTE: the oemsetup.inf file has been updated to automatically update the registry to support 65 scatter/gather segments. Normally, no additional changes will be necessary as this results in the best overall performance. If you wish to change this value, use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: MaximumSGList:REG_DWORD:0x21 4. Enter a value from 16 to 255 (0x10 hex to 0xFF). A value of 255 (0xFF) enables the maximum 1 MByte transfer size. Setting a value higher than 255 results with the default of 64K transfers. The default value is 33 (0x21). 5. Click OK. 6. Exit the Registry Editor, then shutdown and reboot the system. - Number Of Requests Windows NT supports the "NumberOfRequests" registry parameter to specify the maximum number of outstanding requests per adapter. When the IBM driver is installed, the registry will be automatically updated with this parameter set to a value of 150 (0x96). CAUTION: DO NOT increase this parameter above 150. Doing so can result in a system failure. ------------------------------------------------- - Fabric Supported By default, the driver supports Fibre Channel fabric (switch). Should you wish to disable fabric support please use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: DriverParameters:REG_SZ:MSCS=2;UseSameNN=1 4. If the string "FabricSupported=" does not exist, append to end of string; FabricSupported=0 5. If the string "FabricSupported=1" exists, change the value from 1 to 0. 6. Click OK. 7. Exit the Registry Editor, then shutdown and reboot the system. - LargeLuns - Support for more than 8 LUNs To support more than 8 LUNs it is recommended that the Windows NT Service Pack 4 or higher be installed. The oemsetup.inf file has been changed to automatically update the registry to enable up to 255 LUNs using NT 4.0 Service Pack 4 or higher. This is done via the 'LargeLuns' parameter in the registry. IMPORTANT! If the operating system support for large luns is enabled, the miniport's extended LUN support MUST be disabled. To disable the miniport's entended LUN support, run the Host Adapter's embedded FastUtil and set the 'Luns per Target' parameter to 0. ------------------------------------------------- Should you wish to disable operating system support for more than 8 LUNs, use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Doubl- click: "LargeLuns:REG_DWORD:0x01" 4. Change the data value from 1 to 0. 5. Exit the Registry Editor, then shutdown and reboot the system. ------------------------------------------------- - Portname By default, the driver track devices by their port names. To configure the driver to track devices by node names, use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: DriverParameters:REG_SZ:MSCS=2;UseSameNN=1 4. If the string "Portname=" does not exist, append to end of string; Portname=0 5. If the string "Portname=1" exists, change the value from 1 to 0. 6. Click OK. 7. Exit the Registry Editor, then shutdown and reboot the system. ------------------------------------------------- - Fibre Channel Tape To configure the driver to support Fibre Channel tape, use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: DriverParameters:REG_SZ:MSCS=2;UseSameNN=1 4. If the string "FCTape=" does not exist, append to end of string; FCTape=1 5. If the string "FCTape=0" exists, change the value from 0 to 1. 6. Click OK. 7. Exit the Registry Editor, then shutdown and reboot the system. ------------------------------------------------- - MSCS In SAN configuration, the driver is required to handle RSCN efficiently to avoid disruption of I/O because of unnecessary re-logins. However, in Microsoft Cluster environment, it is necessary for the driver performs re-logins because the shared storage subsystems may be reseted by other initiators through a ResetBus operation. The driver parameter MSCS is designed to accommodate the conflicting needs on how to handle RSCN in both environments. It accepts three values: Value RSCN Handling Environment -------- ------------------------------------------- 0 Upon receiving RSCN, performs logins to SAN devices only if necessary 1 Upon receiving RSCN, always performs logins Cluster 2 Upon receiving RSCN, attempts to detect whether the system is running in the Cluster SAN/Cluster environment during boot. If yes, always performs logins upon receiving RSCN. If not, performs logins only if necessary By default, the Oemsetup.inf file is set up to have MSCS set to 2. To change the driver to handle RSCN differently, use the following procedure: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: DriverParameters:REG_SZ:MSCS=2;UseSameNN=1 4. If the string "MSCS=" does not exist, append to end of string; MSCS=n where n = 0, 1, or 2. 5. If the string "MSCS=" exists, change the value to the desired value. 6. Click OK. 7. Exit the Registry Editor, then shutdown and reboot the system. ------------------------------------------------- - UseSameNN By default, if you have multiple Fibre Channel HBAs on the same system, the driver will assign the world wide node name obtained from the first HBA to the rest of the HBAs. If you wish to have each HBAs to assume the world wide node name based on its own NVRAM content, you need to disable this feature by setting the UseSameNN parameter to 0. Please use the following procedure to change the UseSameNN parameter: 1. Click "Start", select "Run", and open the REGEDT32 program. 2. Select HKEY_LOCAL_MACHINE and follow the tree structure down to the IBM driver as follows: HKEY_LOCAL_MACHINE -> SYSTEM -> CurrentControlSet -> Services -> Ql2200 -> Parameters -> Device 3. Double-click: DriverParameters:REG_SZ:MSCS=2;UseSameNN=1 4. If the string "UseSameNN=" does not exist, append to end of string; UseSameNN=0 5. If the string "UseSameNN=1" exists, change the value from 1 to 0. 6. Click OK. 7. Exit the Registry Editor, then shutdown and reboot the system. ------------------------------------------------- 4.4.2 NVRAM Parameters The NVRAM features described below are hard-coded in the driver. The changes made for the particular NVRAM feature in the Fast!Util do not take effect unless otherwise noted. - None. =========================================================== 4.5 Configuration Notes ----------------------------------- - When using LUN masking, masking off LUN 0 for a target will cause Disk Administrator to report an offline device representing LUN 0. This is because LUN 0 must be reported to Windows NT to allow NT to scan for the remaining LUNs on the target. The LUN masking code in thedriver will allow this, but mask off all other access to LUN 0. NT will interpret this as LUN 0 being online for some period of time, then going offline. Disk Administrator will show this as a device that now reports "Configuration information not available". - When attaching more than 19 devices to an adapter, the "SCSI Adapters" control panel application fails to list the adapter and the attached devices. The devices are correctly displayed by the Registry Editor and by the Disk Administrator. NOTE: This problem has been fixed in the Service Pack 6 or above. - Missing LUNs if more than 64 LUNs are connected to the HBA with NT4.0 SP5 and SP6 When a system is configured with LARGE LUN Support, for example, on a Fibre Channel HBA, some of the LUNs assigned to disks or other devices are not visible to other system drivers and as a result are not available to the system. Of 256 possible LUNs, only 231 LUNs are visible. The missing LUNs include the following ranges: 64 to 71 128 to 135 192 to 199 255 A SP6 hot fix is available to address this issue. - Duplicate LUN 0 when LargeLuns Registry Key Enabled When the LargeLuns registry value is enabled for a SCSI adapter and the device supports the SCSI Report LUNs command, LUN 0 may incorrectly be reported multiple times. For example, if Bus 0, Target ID (TID) 3, LUN 0 supports Report LUNs, IOCTL_SCSI_GET_INQUIRY_DATA might display information similar to this: Bus TID LUN Claimed Inquiry String Unique or Duplicate ------ ----- ------- ---------- ------------------- --------------------------- 0 3 0 Y SEAGATE ST1255N Unique 0 3 0 Y SEAGATE ST1255N Duplicate 0 3 3 Y SEAGATE ST1255N Unique This is caused by the way ScsiPort.sys parses the returned Report LUNs Data. The driver incorrectly saves multiple structures representing LUN 0 internally, and this information is passed to the SCSI class drivers or applications through OCTL_SCSI_GET_INQUIRY_DATA. The Windows NT 4.0 Service Pack 5 fixes this issue. - Enhanced Loop ID Of 0 - FFh Loop Ids, some are preallocated for special functions and are not available for use by devices: Loop IDs Functions ------------- --------------- 7Eh FL_Port (S_ID=FFFFFEh) 7Fh Switch Fabric Controller (S_ID=FFFFFDh) 80h Switch Name Server (S_ID=FFFFFCh) 81h Switch Embedded Port (FFFc4xh) used for FC-4 probing (Brocade only) FFh IP Broadcast - Point-to-point connection options The following point-to-point connection options are supported: Value Connection --------- ----------------- 00 Loop only 01 Point-to-point only 02 Loop preferred, otherwise point-to-point 03 Point-to-point preferred, otherwise loop The conection option is currently being stored in the "Connection Options Bits" (Bits 6-4) of the "Additional Firmware Options" field of the NVRAM. The default value of the connection option is 3. Since the connection option 3 is tailored to point-to-point environment, it may not work well with loop devices that does not fully support point-to-point primitives. It is recommended to use connection option 0 for loop only environments, especially for loop environments that involve Microsoft Cluster. ------------------------------------------------- - Fibre Channel Tape support There are two ways to enable Fibre Channel (FC) tape support, the first method is to set/clear the following bits in the Firmware Options and Additional Firmware Options fields in the NVRAM: Field Bit Description Value -------- ---- ----------------- --------- Firmware Options 15 Extended Control Block 1 Firmware Options 14 Name Option 1 Additional Firmware Options 15 No Logo on Link Down 1 Additional Firmware Options 13 Enable FC Confirm 1 Additional Firmware Options 12 Enable FC Tape 1 The NVRAM can be changed using IBM supplied utility. The second way is to set the Fibre Channel Tape Driver Parameters in the registry to 1. - To ensure the driver function properly, the driver changes some of the system related registry entries such as the disk timeout value of the system disk driver during driver installation through the use of the oemsetup.inf file. Those values are not being restored upon driver removal. - Notes on LUN 0 issue: In order for NT4.0 to see the device properly, LUN 0 has to be configured. =========================================================== 4.6 Using Fast!UTIL to change the connection options: ---------------------------------------------------------------------------- The connection option of the IBM FAStT Host Adapter is stored in the NVRAM of the Adapter. It defines the type of connection (loop or point-to-point) or connection preference with which the ISP2200 RISC processor use during the initialization process. To change the connection option using the Fast!UTIL, please follow the steps below: 1. Reboot the system. 2. When you see the QLogic QLA2200 BIOS banner and the message: Press for Fast!UTIL Press and the QLogic Fast!UTIL menu will come up. 3. If you have more than one IBM FAStT Host Adapter in the system, the "Select Host Adapter" menu will appear. Use the Up Arrow or Down Arrow keys to select the HBA you like the connection option to be changed (each HBA in the list is differentiated by its unique I/O Address) and press Enter. The "Fast!UTIL Options" menu will open. If you have only one IBM FAStT Host Adapter in the system, the "Fast Util Options" menu will open. 4. Select "Configuration Settings" from the Fast!UTIL Options menu by using the Up Arrow or Down Arrow keys and press Enter. The "Configuration Settings" option should be hightlighted by default. 5. On the "Configuration Settings" menu, use the Down Arrow key to move the cursor to the "Extended Firmware Settings" and press Enter. 6. The "Extended Firmware Settings" menu will appear. The "Connection Options" field of the menu shows the current connection option value the HBA has. On the "Extended Firmware Settings" menu, use the Down Arrow key to move the cursor to the "Connection Options" and press Enter. A menu with the available connection options will appear. 7. Use the Up Arrow or Down Arrow keys to move the cursor to the desired option. The available options are as follows: Option Type of Connection ---------- ----------------------------- 0 Loop only 1 Point to point only 2 Loop preferred, otherwise point to point 3 Point to point perferred, otherwise loop (default) If the current setting is 3, the default setting and you would like to change it to 0, just use the Up Arrow key to select option 0 and press Enter. If the current setting is 0 and you would like to change it to 3, just use the Down Arrow key to select option 3 and press Enter. Note: if you do not want to make any change, just press Esc to exit this menu. 8. The "Extended Firmware Settings" menu should re-appear and the value shown for the "Connection Options" field should display the value you just selected. Press Esc to exit the "Extended Firmware Settings" menu. 9. Press Esc again to go back to the "Configuration Settings" screen. 10. Press Esc again and the "Configuration settings modified" menu will appear, if you have made any changes. The "Save changes" option should already be highlighted. If not, select the the "Save changes" option and press Enter. This will save the connection option you just changed for the selected HBA. 11. The "Fast!UTIL Options" screen will appear after the changes have been saved. If you have more than one HBAs in the system, and would like to change the connection option for the other HBA, move the cursor to the "Select Host Adapter" option and press Enter. This will allow you to go back to the "Select Host Adapter" menu to select another HBA. Go back to step 3 to repeat the process of changing the connection options for the next HBA. Press Esc to exit the Fast!UTIL if there is only one HBA in the system, or there is no need to make addtional changes. 12. The "Exit Fast!UTIL" will pop up. The "Reboot System" option should be highlighted. If not, select the "Reboot System" option. Press Enter to reboot the system. 13. The system will reboot and the new connection option will be effective when the system comes up. =========================================================== 5.0 Unattended Mode -------------------------------- 5.1 The driver supports the Unattended Mode. Please follow the instructions provided by Microsoft to create necessary files and prepare systems for unattended installation. =========================================================== 6.0 WEB Sites and Support Phone Number ---------------------------------------------------------------- 6.1 IBM Support Web Site: http://www.ibm.com/pc/support 6.2 IBM eServer xSeries Marketing Web Site: http://www.ibm.com/pc/us/eserver/xseries/index.html 6.3 If you have any questions about this update, or problem applying the update go to the following Help Center World Telephone Numbers URL: http://www.ibm.com/planetwide =========================================================== 7.0 Trademarks and Notices ------------------------------------------- 7.1 The following terms are tradmarks of the IBM Corporation in the United States or other countries or both: IBM Qlogic is a registered trademark of QLogic Corporation. Microsoft and Windows are trademarks or registered trademarks of Microsoft Corporation. Other company, product, and service names may be trademarks or service marks of others. =========================================================== 8.0 Disclaimer ----------------------- 8.1 THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS 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. 8.2 Note to U.S. Government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corporation.