***************************************************************************** 
                         Solaris_Sparc_FC10_ReadMe.TXT  
***************************************************************************** 

Installation Guide for the LSI Logic itmptfc Solaris SPARC driver and utility 
package. 
 
This driver supports:

o  LSI Fibrechannel HBAs for the Solaris 10 Operating System

                                                 
This file contains these sections:   

Introduction for Solaris SPARC 
     Driver Features
     Devices Supported
     Device Mapping
     Fibre Channel Persistent Binding
     Configuration Options
     
Installing the Driver in Existing Systems

Installing the Driver in an New System
     
 


1.0 Introduction for Solaris SPARC 
................................ 

The LSI Logic driver, itmptfc, allows the Solaris SPARC operating system
to interface with the devices connected to the LSI Fibre Channel host 
adapters. The driver is optimized for low CPU overhead and high I/O 
throughput, making use of the LSI Logic Fusion-MPT architecture.  The
driver conforms to the Sun FCA driver standard. 


1.1 Driver Features
................... 

The Solaris SPARC driver supports these features:

o  Fibre Channel protocol
o  PCI, PCI-X and PCIe bus protocols
o  LSI Logic MPT common software interface 
o  Multiple host adapters 
o  Multiple Logical Unit Numbers (LUNs) 
o  Scatter-Gather 
o  SCSI pass-through functionality 
o  Disk array configurations with no LUN 0 
o  Disk array configurations with non-contiguous LUNs 
o  Auto request sense 
o  Multiprocessor environments.


1.2 LSI Logic Devices Supported 
...............................

The LSI Solaris SPARC driver supports all LSI Fibre Channel adapters.
   

1.3 Device Mapping
..................

The itmptfc driver reads the /kernel/drv/ssd.conf file to determine
configuration options. The driver automatically probes all Fibre Channel
targets attached to the link, and no longer requires explicit device entries
conf file to determine which devices to probe.

Root Boot persistent target ID selection is configurable through the BIOS. 


1.4 Fibre Channel Persistent Binding
.....................................

The /kernel/drv/itmptfc.conf configuration file may be optionally used to 
configure Fibre Channel persistent bindings. Note that the default behavior
is to map targets by World Wide Name. It is important to use the "port" wwn
for the device you want to map, rather than the "node" wwn, or only part 
of the wwn.

The wwn displayed in the boot log or displayed by probe-scsi-all
at the OBP (ok) prompt is the correct wwn to use (i.e. the port wwn).

If the device was connected to the Fibre Channel bus via port A,
the port wwn for that device would generally be:

      2100002037102d0f

If the device was connected to the Fibre Channel bus via port B,
the port wwn for that device would generally be:

      2200002037102d0f

Many times the wwn printed on the physical device is only part of
the full wwn.  For example, for the wwn used in the preceeding
example, the wwn listed on the disk case itself is:

      002037102d0f

Optionally, targets may be mapped by their Port ID. To map according 
to the Port ID, the firmware must be reconfigured. You can use the 
'lsiutil' utility to make this change.  Run the utility, choose 
the adapter to work on, then choose menu item number 13 (Change FC port 
settings).  When asked the question:

       Assignment of Bus and Target IDs:

enter a '1' to "sort by DID" rather than "sort by WWN".


- To persistently map a Fibre Channel World Wide Name (wwn) to a target
  device, use this syntax:  

    target-X-wwn="port wwn"

  For example:
     target-4-wwn="2200002037102d0f"

  will persistently map the wwn 2200002037102d0f to target 4 across all
  HBA ports.

- To restrict the mapping to a single bus, use the syntax:
    
    hba-X-target-Y-wwn="port wwn"

  For example:
    hba-1-target-4-wwn="2200002037102d0f"

  will persistently map wwn 2200002037102d0f to target 4 on bus itmptfc1 only


- To persistently map a Fibre Channel Port ID to a given target, use the 
  following syntax:

     target-X-did="port id"

  For example:
     target-4-did="0000ca"

  will persistently map the port id 0000ca to target 4 on all
  itmptfc busses.
 

1.5 Configuration Options
.........................

The /kernel/drv/itmptfc.conf configuration file may be used to configure optional
driver parameters.  The itmptfc.conf file includes options for SCSI, SAS and
Fibre Channel. The following parameters are specific to Fibre Channel:

SYM_ADAPTER_FLAGS_ENABLE_ABORT_TASK 
    
    When set, use Abort Task to abort timed-out I/Os, instead of using
    Bus Reset and/or Target Reset.

SYM_ADAPTER_FLAGS_LOOP_ID_NAMING        

    When set, use LoopIdNaming when possible for fibre channel targets.
    For targets on a private loop, the AL_PA is converted to a Loop ID,
    and that Loop ID is used as a target number.  For targets not on a
    local loop, target numbers are assigned starting with 128.

scsi-reset-delay 

    This is the amount of time to delay after a bus reset and is reported 
    in milliseconds.  The default is 250ms.  

scsi-watchdog-tick 

    This is how often the timeout handler is executed to walk the active 
    I/O queue looking for I/O's that have timed out.  The value is in 
    seconds, default is 5.

max-queue-depth 

    This is the maximum number of active I/O's that can be sent to a target
    at a given time.  The default is 32.  The minimum settable value is 4 
    and the maximum is 256.

coalesce-count 

    This is the number of I/O's to hold off before interrupting the driver.
    The minimum count is 0 (turns off coalescing) and the maximum is 128 
    I/O's.  If set to -1, the default value of the firmware is used.

coalesce-time

    This is the time in microseconds to hold off before interrupting the
    driver.  The minimum time is 0 (turns off coalescing) and the
    maximum settable time is 1000 microseconds.  If set to -1, the default
    value of the firmware is used.


2.0 Installing the Driver in an Existing System 
................................................ 

This section provides installation instructions for existing systems.

NOTE: You must be logged on as root to perform the installation.

The driver installation is performed using the standard Solaris
'pkgadd' utility.  


Starting with the itmptfc_install.tar.Z file:

1. Uncompress and un-tar the itmptfc_install.tar.Z file by typing the
   following commands to create a directory named install:

         uncompress itmptfc_install.tar.Z
         tar -xvf itmptfc_install.tar
         cd install

2. Start the installation by invoking the pkgadd command as:

           pkgadd -d .

3. Follow the prompts to perform the installation.

4. The itmptfc device driver is now installed.  Reboot the
   machine to reconfigure the system and to recognize the new devices.

NOTE: If you change the disk drive configuration of your machine, it
      may be necessary to issue the command: 

             touch /reconfigure

      and then reboot the system in order for the system to detect and
      correctly install your new disks.

