
Copyright (c) 2001-2007 SureSaveFC.
Versions TSDK 4.0.x, 05.0x

=============================================================================
Installation instructions for SureSaveFC Fibre Channel miniport initiator 
driver for Windows 2003/IA64/amd64
=============================================================================

This README contains the following information:

(1)  Diskette contents
(2)  Hardware support
(3)  Operating system support
(4)  Installation instructions 
(5)  How to modify driver parameters in the registry 
(6)  Driver registry parameters  
(7)  Known caveats

The rest of this file contains a detailed description for each of these items.
All references to Windows in this file refers to one of the following Windows
versions: Windows 2003/IA64. 


======================
(1) Diskette Contents
======================

The SureSaveFC (Fibre Channel) Driver for Microsoft 
Windows 2003/IA64 contains the following files:

Directory/File name        Description
----------------------     -----------------------------------------------------
\SureSaveFC                  Identifier for Windows installation
\SureSaveFC.sys              The Windows 2003/IA64FC driver
\SureSaveFC.inf              Installation script for Windows 2003/IA64 setup
\readme_win_fc_stor.txt   (this file) installation instructions for Windows

=====================
(2) Hardware Support
=====================

The SureSaveFC Fibre Channel driver currently supports the SureSaveFC FC
development platform. 


=============================
(3) Operating System Support
=============================

Microsoft Windows 2003/IA64 Server


==============================
(4) Installation Instructions
==============================

The SureSaveFC.SYS Windows 2003/IA64FC driver installation is done through the standard 
Windows 2003/IA64 PnP driver installation. The driver installation can be done multiple 
ways using the Windows 2003/IA64 PnP hardware detection, the Hardware Wizard, the Device 
Manager, etc.. 

Before installing the driver, copy the SureSaveFC.SYS and SureSaveFC.INF files
to a floppy diskette (or other removeable media). 
 
The following instructions can be used for the Windows "Found New Hardware" 
wizard: 

    1. When "Found New Hardware" wizard's window is displayed, click "Next".
     
    2. Select "Display a list of the known drivers for this device so that I 
    can choose a specific driver" and then click "Next". 

    3. Select a Device Driver window then click "Have Disk".

    4. Insert the floppy disk with the driver and when "SureSaveFC PCI Fibre 
    Channel Controller" appears, click "Next".

    5. When "Digital Signature Not Found" appears, click "Yes". 

    6. When "Found New Hardware" wizard completes, click "Finish".


====================================================
(5) How to Modify Driver Parameters in the Registry
====================================================

The following provides minimal information on how to modify the registry.
For detailed information on using the registry editor, please refer to  
Windows 2003/IA64 documentation. 

    WARNING: Use extreme care when making changes to the Windows registry. 
    Improper changes can cause the system to become unstable. 

To set driver parameters in the Windows Registry, follow these 
basic steps:

   1. Click on the "Start" button from the Windows taskbar and 
   select "Run". 
    
   2. Type "regedit" at the prompt and press "ENTER". 
    
   3. Open the registry at the following location:      
      "\HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\<service name>\Parameters\Device"

   4. Double-Click on the device "Parameter" key that you want to modify and a
   "REG_SZ" editor text box will appear. 

   5. Enter the parameter value in the text box, then click "OK".


===============================
(6) Driver Registry Parameters
===============================

The SureSaveFC.SYS supports several registry parameters that are described in this 
section. 

    Note: All entries pertinent to the driver are of type SZ_STRING. 

See section (6) "How to Modify Driver Parameters in the Registry" for 
information on how to change the registry setting. 

    WARNING: Use extreme care when making changes to the Windows registry. 
    Improper changes can cause the system to become unstable. 

There are two types of registry entries described in this section: 
driver-specific in Section 6.1 and kernel-specific in Section 6.2. All the
registry entries listed in this section appear in the registry at: 
 
    "\HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\<service name>\Parameters\Device"

which, herein, is simply referenced as:

    "...\Parameters\Device"


--------------------------------------
6.1  Driver-Specific Registry Entries
--------------------------------------

    Note: All the <PortWWN> MUST be specified in uppercase.

---------------------------
6.1.0 OSParms\OsDebugLevel
---------------------------
This registry value is used by the SureSaveFC driver to set 
the verbosity of the debug messages being printed on the debug console. 
The higher the number, the more verbose the debugging message. This 
entry is relevant to a "checked build" driver and is not used by a 
"free build" driver.

Registry key location:

    ...\Parameters\Device\OSParms\OsDebugLevel

This subkey is a REG_SZ value specifying levels from 0 to 9. 
    0 - DISABLE LOGGING
    1 - LOG ERROR EVENTS             (minimal verbosity)
    2 - LOG WARNING EVENTS	
    3 - LOG INFORMATIONAL EVENTS		
    4 - LOG DEBUG L1 EVENTS		
    5 - LOG DEBUG L2 EVENTS		
    6 - LOG DEBUG L3 EVENTS		
    7 - LOG DEBUG L4 EVENTS		
    8 - LOG DEBUG L5 EVENTS
    9 - LOG DEBUG L6 EVENTS          (maximum verbosity)

---------------------------
6.1.1 OSParms\TiDebugLevel
---------------------------
This registry value is used by the SureSaveFC driver to set the verbosity of 
the debug messages from the TD Layer being printed on the debug console. 
The higher the number, the more verbose the debugging message. This entry is 
relevant to a "checked build" driver and is not used by a "free build" driver.

Registry key location:

    ...\Parameters\Device\OSParms\TiDebugLevel

This subkey is a REG_SZ with a value specifying levels from 0 to 9. 
    0 - DISABLE LOGGING
    1 - LOG ERROR EVENTS             (minimal verbosity)
    2 - LOG WARNING EVENTS	
    3 - LOG INFORMATIONAL EVENTS		
    4 - LOG DEBUG L1 EVENTS		
    5 - LOG DEBUG L2 EVENTS		
    6 - LOG DEBUG L3 EVENTS		
    7 - LOG DEBUG L4 EVENTS		
    8 - LOG DEBUG L5 EVENTS
    9 - LOG DEBUG L6 EVENTS          (maximum verbosity)

-----------------------------
6.2.1 Global\PortParms\Speed
-----------------------------
This registry value is used by the SureSaveFC driver to set the link speed for  
all ports. 

Registry key location:

    ...\Parameters\Device\Global\PortParms\Speed

This subkey is a REG_SZ. Valid values are 0-4 that denote the following: 
    0 = Auto   (default)
    1 = 1Gb/s  QE8 does not support this speed
    2 = 2Gb/s   
    3 = 4Gb/s
    4 = 8Gb/s  QE8 only

--------------------------------
6.2.2 Global\PortParms\Topology
--------------------------------
This registry value is used by the SureSaveFC driver to determine the topology 
being supported by all ports. 

Registry key location:

    ...\Parameters\Device\Global\PortParms\Topology

This subkey is a REG_SZ.
    1 = Point to point
    2 = Private loop
    5 = Fabric
    6 = Public loop (Default)

-------------------------------
6.2.3 Global\PortParms\LoopMap
-------------------------------
This registry value is used by the SureSaveFC driver to enable/disable Loopmap
support for all ports. 

Registry key location:

    ...\Parameters\Device\Global\PortParms\LoopMap

This subkey is a REG_SZ. Valid numbers are 0 or 1 that denote: 
    0 = Off
    1 = On (default)

------------------------------
6.2.4 Global\PortParms\NumIMQ
------------------------------
This registry value is used by the SureSaveFC driver to program the number of 
IMQ (Inbound Message Queue) for all ports. Through completion messages the IMQ
notifies the driver of inbound and outbound transaction information and 
status information. 

Registry key location:
    ...\Parameters\Device\Global\PortParms\NumIMQ

This subkey is a REG_SZ. Valid numbers are 32,64,128,256,512,1024,2048,4096.
    512 = default 

-------------------------------
6.2.5 Global\PortParms\NumSEST
-------------------------------
This registry value is used by the SureSaveFC driver to program the number of 
SEST (SCSI Exchange State Table) on all ports. Each entry in the SEST 
corresponds to an active SCSI exchange (IO Operation).

Registry key location:
    ...\Parameters\Device\Global\PortParms\NumSEST

This subkey is a REG_SZ. Valid numbers are 16...32767. 
    512 = default

------------------------------
6.2.6 Global\PortParms\NumERQ
------------------------------
This registry value is used by the SureSaveFC driver to program the number of 
ERQ (Exchange Request Queue) for all ports. The driver uses the ERQ to issue 
all IO requests to the hardware. 

Registry key location:
    ...\Parameters\Device\Global\PortParms\NumERQ

This subkey is a REG_SZ. Valid numbers are 32,64,128,256,512,1024,2048,4096.
    256 = default

--------------------------------------
6.2.8 Global\PortParms\InterruptDelay
--------------------------------------
This registry value is used by the SureSaveFC driver to program the value for 
all ports of the interrupt delay register timer of the hardware. When an 
interrupt condition is reached, this value indicates the amount of time to 
delay the assertion of the PCI interrupt signal. 

Each unit of this value forces the hardware to delay the PCI interrupts by 
125us. 

Registry key location:
    ...\Parameters\Device\Global\PortParms\InterruptDelay

This subkey is a REG_SZ. Valid values are 0-f that denote: 
    0 = no interrupt delay (default)
    1 = 125 us
    2 = 250 us
    ... 
    e = 1.750 ms
    f = 1.875 ms

----------------------------------------------------
6.2.9 Global\InitiatorParms\LoginParms\InFrameSize
----------------------------------------------------
This Registry value is used by the SureSaveFC driver to determine frame size 
during login for all ports.

Registry key location:

    ...\Parameters\Device\Global\InitiatorParms\LoginParms\InFrameSize

This subkey is a REG_SZ. Valid values are 128,512,1024,2048.
    1024 = default

-----------------------------------------------------
6.2.10 Global\InitiatorParms\LoginParms\OutFrameSize
-----------------------------------------------------
This Registry value is used by the SureSaveFC driver to determine frame size in 
programming SEST for all ports.

Registry key location:

    ...\Parameters\Devic\Global\InitiatorParms\LoginParms\OutFrameSize

This subkey is a REG_SZ. Valid values are 128,512,1024,2048.
    1024 = default

----------------------------------------
6.2.11 Global\InitiatorParms\MaxTargets
----------------------------------------
This Registry value is used by the SureSaveFC driver to specify the maximum 
number of targets supported.  This requires memory resources and must be less 
than the available memory pool.

Registry key location:

    ...\Parameters\Device\Global\InitiatorParms\MaxTargets

This subkey is a REG_SZ. Valid values are 1-1024.

---------------------------------
6.2.12 <PortWWN>\PortParms\Speed
---------------------------------
This Registry value is used by the SureSaveFC driver to set the link speed for 
the specified WWN port.

Registry key location:

    ...\Parameters\Device\<PortWWN>\PortParms\Speed

This subkey is a REG_SZ. Valid numbers are: 0-3.
    0 = Auto   (default)
    1 = 1Gb/s  QE8 does not support this speed
    2 = 2Gb/s   
    3 = 4Gb/s
    4 = 8Gb/s  QE8 only

------------------------------------
6.2.13 <PortWWN>\PortParms\Topology
------------------------------------
This Registry value is used by the SureSaveFC driver to determine the topology 
being supported by a specific WWN port.

Registry key location:

    ...\Parameters\Device\<PortWWN>\PortParms\Topology

This subkey is a REG_SZ. Valid numbers are: 1,3,5,7.
    1 = Point to point
    2 = Private loop
    5 = Fabric
    6 = Public loop (Default)

-----------------------------------
6.2.14 <PortWWN>\PortParms\LoopMap
-----------------------------------
This Registry value is used by the SureSaveFC driver to enable/disable Loopmap 
support to a specific WWN port.

Registry key location:

    ...\Parameters\Device\<PortWWN>\PortParms\LoopMap

This subkey is a REG_SZ. Valid numbers are: 0,1.
    0 = Off
    1 = On (default)

-------------------------------------------------------
6.2.15 <PortWWN>\InitiatorParms\LoginParms\InFrameSize
-------------------------------------------------------
This Registry value is used by the SureSaveFC driver to determine frame size 
during login to a specific WWN port.

Registry key location:

    ...\Parameters\Device\<PortWWN>\InitiatorParms\LoginParms\InFrameSize

This subkey is a REG_SZ. Valid values are 128,512,1024,2048.
    1024 = default

--------------------------------------------------------
6.2.16 <PortWWN>\InitiatorParms\LoginParms\OutFrameSize
--------------------------------------------------------
This Registry value is used by the SureSaveFC driver to determine frame size in 
programming SEST specific to a particular WWN port.

Registry key location:

    ...\Parameters\Device\<PortWWN>\InitiatorParms\LoginParms\OutFrameSize

This subkey is a REG_SZ. Valid values are 128,512,1024,2048.
    1024 = default

--------------------------------------------------------------
Note: Please refer to code for new and additional parameters.
--------------------------------------------------------------


==================
7. Known caveats
==================

 

