#man lpfcreformatting page. please wait ... DONE
DEVICES LPFC (7D)
Name LPFC - EMULEX LIGHTPULSE FIBRE CHANNEL FCP / SCSI Host Bus Adapter Driver
Synopsis PCI10DF, 1AE5 @ Slot PCI10DF, F700 @ Slot PCI10DF, F800 @ Slot PCI10DF, F900 @ Slot
Availability Sparc and x86 Edition
Description The LPFC HOST BUS Adapter Driver Provides An Interface Between The Emulex Lightpulse Family of Fibre Channel PCI Host Bus Adapters and Solaris Running on Platforms That Offer PCI Support.
The driver is composed of two parts. One part is lpfc, a Solaris SCSA driver providing both low level support for the host bus adapter and FCP support. The FCP protocol emulates SCSI-3 on top of Fibre Channel. Thus, FCP disk drives appear To Be SCSI Disk Drives from The Standpoint of a Host.
The Second Part of The Driver IS LPFN, WHICH Provides IP Networking Support. The IP Driver, LPFN, IS BRIEFLY MEN- TIONED IN THIS MANUAL PAGE
The lpfc driver can be loaded by itself;. Lpfn, which relies on functionality in lpfc, automatically loads lpfc The driver module as a whole, including both FCP and IP support, is referred to as lpfc The driver can be configured to support FCP. ITSelf, IP by Itself or FCP and IP TOGETHER. The Default During Installation IS To Support Both FCP and IP; This Choice Can Be Changed In The Driver's Configuration File (See Below).
Fibre Channel is an interconnect offering high throughput and low latency across copper and optical media at distances ranging up to 10 kilometers. Fibre Channel configurations include point-to-point, loop (up to 126 devices) and fabric (general switching network). Fibre Channel offers emulation modes for SCSI and IP; the former is called FCP and the latter is called IPP Note that SCSI disk drives can not be connected directly to a Fibre Channel;. a Fibre Channel interface is considerably different from a SCSI interface.The Emulex Lightpulse Mediates Between a host's pci bus and the fiber channel itself.
This Driver supports The Lightpulse Family, Running FCP AND IP.
Sunos 5.8 Last Change: 25 march 1999 1
DEVICES LPFC (7D)
FCP DRIVER The lpfc Host Bus Adapter driver is an SCSA compliant nexus driver for the LightPulse. The lpfc driver provides basic support for LightPulse hardware. Functions include adapter initialization, frame transmit and receive, and error recovery and reporting. Multiple LightPulse adapters installed within the system are supported by the driver. The lpfc driver supports the standard functions provided by the SCSA interface. The driver supports tagged and untagged queuing and auto request sense. Other SCSI proper- ties, such as fast and wide, are irrelevant to Fibre Channel and Hence Are Ignored. Linked Commands Are Not Supported.
FCP CONFIGURATION Most configuration options are addressed in the General Con- figuration section, below. However, the target driver may need to be configured to probe for additional targets on Fibre Channel. The following discussion applies only when using FCP functionality in lpfc.Solaris target drivers must be instructed which disks to probe for at boot time These instructions are contained in a configuration file specific to each target driver On SPARC, the target driver is called sd;.. on x86, the target driver is called cmdk The configuration files. Are, Respec- Tively, SD.conf and cmdk.conf and isually found in / ke ONE OF TO TARGET DRIVERS ON YOUR SYSTEM. See the driver.conf (4) Man Page for Additional Details .
Each disk drive on the Fibre Channel must have an entry in sd.conf or cmdk.conf. The system administrator may have to define additional targets and Logical Unit Numbers (LUNs) in these files. For FCP when using arbitrated loop, there can be . up to 126 targets, with a maximum of 32 LUNs per target The installation procedure for lpfc automatically updates sd.conf or cmdk.conf to search for Fibre Channel disk drives The instructions added to the configuration file look like this.:
Name = "sd" parent = "lpfc" target = 0 lun = 0;
(On x86, you will see name = "cmdk".)
The lpfc installation procedure adds one line to the target driver configuration file for the first 126 targets. Up to 512 targets can be supported. However, no lines were automatically added for every possible LUN, as 4032 entries would be required. Instead, the default Configuration Only Searches for Devices At Lun 0. Sunos 5.8 Last Change: 25 March 1999 2
DEVICES LPFC (7D)
If you want to use disks (eg, RAID arrays) with non-zero LUNs, or more then 126 targets, simply add lines to the target driver configuration file specifying the desired target ID and LUN (s). For example, including The Follwoing Lines in The System's Target Driver Configuration File:
Name = "sd" parent = "lpfc" target = 127 lun = 0; name = "sd" parent = "lpfc" target = 127 lun = 1; name = "sd" parent = "lpfc" target = 127 lun = 2 ; Name = "SD" parent = "lpfc" target = 127 lun = 3;
(On x86, you will see name = "cmdk".)
We use the parent keyword to ensure that Solaris specifi- cally probes the lpfc driver for the specified targets and LUNs. Note that changes to a target driver's configuration file will only take effect after the system has been rebooted.
Refer to scsi_hba_attach (9f) for details on setting indivi- Dual SCSI Properties.
GENERAL CONFIGURATION All the variables that control driver initialization may be found in a file called lpfc.conf. This file is located in the installation directory containing the binary for the driver itself, lpfc. Typically, this directory will be / kernel / drv. Other . information is obtained dynamically from probing the attached Fibre Channel The variables described in this section are the ones a system administrator is most likely to be concerned with.Important: These values are set per adapter; eg, setting num-iocbs to 300 allocates 300 I / O control blocks for every LightPulse present in the host machine. in the descriptions below, the annotation (F) means that the variable only has meaning when FCP functionality is enabled in lpfc. vari- ables lacking an annotation have meaning for the entire Driver. a Boolean Variable Should Be Set To Either 0 (true) OR 1 (True), Although Any .
ack0 If ack0 is 1, the adapter will try to use ACK0 when running Class 2 traffic to a device. If the device does not support ACK0, then the adapter will use ACK1. If ack0 is 0, only ACK1 will be used when running Class2 traffic.
Sunos 5.8 Last Change: 25 march 1999 3
DEVICES LPFC (7D)
automap If automap is 1, SCSI IDs for all FCP nodes without persistent bindings will be automatically generated. If FCP devices are added to or removed from the Fibre Channel network when the system is down, there is no guarantee that these SCSI IDs will remain the same when the system is booted again. If one of the FCP binding methods below is specified, then automap devices will use the same mapping to try to preserve SCSI IDs between link down and link up. If automap is 0, only devices with persistentbindings will be recognized by the system.check-cond-err The driver will treat ckeck condition 0x44, Internal Target Failure, check condition 0x25, Logical Unit Not Supported and check condition 0x20, Invalid Command Operation Code, as FCP RSP errors.
DELAY-RSP-ERR The Driver Will Delay FCP RSP Errors Being Returned to the Upper SCSI Layer Based On The No-Device-Delay Con- Figure Parameter.
dqfull-throttle This variable causes lpfc to decrement a LUNs throttle (maximum queue depth) if a queue full condition is received from the target. The queue depth will be decremented down to a minimum of 3. The only way to restore the queue depth ( .
. Fcp-bind-WWNN Setup persistent FCP binding based on a target device's WWNN THis binding guarantees that target assignments will be preserved between reboots The format for a bind entry is. "NNNNNNNNNNNNNNNN: lpfcXtY" where NNNNNNNNNNNNNNNN is a 16 digit representation of the targets WorldWide Node Name, X is the driver instance number and Y is the target assignment Multiple entries must be separated by a comma (,) with the last entry terminated with a semi-colon. (;) target assignments, with all supported LUNs must. Also be configured in sd.conf or st.conf. a sample entry follows: fcp-bind-wwn = "20000020370c396f: lpfc1t0", "20000020370C27F7: LPFC0T2";
Sunos 5.8 Last Change: 25 march 1999 4
DEVICES LPFC (7D)
. Fcp-bind-WWPN Setup persistent FCP binding based on a target device's WWPN THis binding guarantees that target assignments will be preserved between reboots The format for a bind entry is. "NNNNNNNNNNNNNNNN: lpfcXtY" where NNNNNNNNNNNNNNNN is a 16 digit representation of the targets WorldWide Port Name, X is the driver instance number and Y is the target assignment Multiple entries must be separated by a comma (,) with the last entry terminated with a semi-colon. (;) target assignments, with all supported LUNs must. Also be configured in sd.conf or st.conf. a sample entry Follows:
fcp-bind-WWPN =. "21000020370c396f: lpfc1t0"; fcp-bind-DID Setup persistent FCP binding based on a target device's Port ID THis binding guarantees that target assign- ments will be preserved between reboots The format for a bind entry is. . "NNNNNN: lpfcXtY" where NNNNNN is a 6 digit representation of the targets Port ID, X is the driver instance number and Y is the target assignment Multiple entries must be separated by a comma (,) with the last entry terminated with a semi -Colon (;). Target Assignments, WITH Supported Luns Must Also Be Con- Figure, A Sample Entry Foll & INTRY FOLLOWS:
FCP-BIND-DID = "0000EF: LPFC0T0";
FCP-CLASS The LPFC Driver IS Capable of Transmitting FCP Data IN Class 2 Or Class3. The LPFC Driver Defaults To Use Class 3 Transmission.
FCPFABRIC-TMO Extra Timeout Value, In Seconds, To BE Applied to Each FCP Command Sent. When Connecting Through a Large Fabric, Certain Devices May Require a Longer Timeout Value.
FCP-ON Enable The FCP FunctionAlity of LPFC. This Variable Is A Boolean; Zero Disables FCP While Non-Zero Enables IT.
Link-speted this causes lpfc to set the adapter link speed to auto-detect (0), 1 gigabit (1) or 2 gigabits (2). this setting only applies to the lightpulse 9002 adapter.
Sunos 5.8 Last Change: 25 march 1999 5
DEVICES LPFC (7D)
linkdown-tmo How long the driver will wait (1 to 255 seconds) before declaring the Fibre Channel link to be down. Commands waiting to be serviced will be aborted. For instance, FCP commands will be returned to the target driver. The lower this value is, the quicker the driver will fail commands back to the upper levels There is tradeoff here:. small vaules risk retrying commands when link is bouncing, while large values risk delaying failover in a redundant loop environment Setting linkdown-tmo to 0 will. cause all commands issued to the device driver to be held internally (never failed) until the link comes back up.lun-queue-depth The driver uses this value as the default limit for the number of simultaneous commands to issue to a single logical unit ON A Single Target on The loop. A Single Logical Unit Will Never B E SENT MORE Commands Than Allowed by Lun-Queue-Depth; However, Less May Be Sent When SD_MAX_THROTTLE OR TGT-Queue-Depth Is Reached for the Entire Target.
lpfcNtM-lun-throttle The maximum number of outstanding commands to permit for any logical unit on a specific target. This value overrides lun-queue-depth.
LPFCNTM-TGT-THROTTLE THE MAXIMUM NUMBER OF OUTSTANDING COMMAVANDS TO PERGET for Any TARGET, INCLUEUE OVERRIDES TGT-Queue-Depth.
. Network-on This variable controls whether lpfc provides IP networking functionality over Fibre Channel This variable is a Boolean: when zero, IP networking is dis- abled; when non-zero, IP networking is enabled.log-only When Set to 1, Log Messages Are Only Logged to Syslog. When Set To 0, Log Messages Are Also Printed on The Console.
log-verbose (bit mask) When set to non-zero this variable causes lpfc to generate additional messages concerning the state of the driver and the I / O operations it carries out. These messages may go to the system console and / or the system Log file, / var / adm / message.
Sunos 5.8 Last Change: 25 march 1999 6
DEVICES LPFC (7D)
no-device-delay This variable [0 to 30] - determines the length of the interval between deciding to fail an I / O because there is no way to communicate with its particular device (eg, due to device failure or device removal) and Actually Failing The Command. A Value of Zero Implies No delay whatsoever. This delay is specified in seconds. a minimum value of 1 (1 second) is recommanded when Communicating With Any Tachyon Based Device.
nodev-holdio This variable controls if I / O errors are held by the driver if a device on the loop disappears. If set, I / O errors will be held until the device returns back to the loop (potentially indefinitely). The upper sd Layer May Retry The Command Once The Error Is Returned.
nodev-tmo The variable controls how long I / O errors are held by the driver if a device on the loop disappears. If set, I / O errors will be held for the specified number of seconds. The upper sd layer may retry the command once the error is returned. num-bufs This variable specifies the number of ELS command buffers to allocate. These buffers are used for Fibre Channel Extended Link Services (ELS), and one for each FCP command issued in SLI-2 mode. If you . want to queue lots of FCP commands to the adapter, then you should increase num-bufs for better performance These buffers consume physical memory and are also used by the device driver to process loop initialization and re-discovery activities Important:. The driver must Always Be CON- Figured with at Least Several Dozen Els Command Buffers; We Recommend AT L east 256.num-iocbs This variable indicates the number of Input / Output con- trol block (IOCB) buffers to allocate. IOCBs are internal data structures used to send and receive I / O requests to and from the LightPulse Sbus hardware. Too few iOCBs can temporarily prevent the driver from com- municating with the adapter, thus lowering performance. (This condition is not fatal.) If you run heavy IP traffic, you should increase num-iocbs for better performance.
scan-down There are three scanning algorithms used to map an ALPA to a SCSI ID in a private loop. Refer to the "informa- tive annex" of the FC-AL profile, which describes the algorithm for this translation. Scan-down values 0 andSunos 5.8 Last Change: 25 March 1999 7
DEVICES LPFC (7D)
1 Do Not Apply if a loop map obtained. See The FC- Al Profile for the definition of a loop map. If the adapter is not attached to a fabric, these parameters do not appliff. If scan-down is 1, SCSI IDs are scanned starting from ALPA 0xEF through ALPA 0x01. If scan-down is 0, SCSI IDs are scanned starting fro ALPA 0x1 on up. If scan-down is 2 (default value), SCSI IDs are hard coded based On the alpa (0xEF = SCSI ID 0, 0xE * = SCSI ID 1 .....). This param- Eter is Userd to Maintain Backward Compatibility with the SCSI ID Assignments of The 2.05 Solaris Driver.
tgt-queue-depth The driver uses this value as the default limit for the number of simultaneous commands to issue to a single target on the loop. A value of 0 causes no target throttling to occur. A single target will never be send more commands Than allowed by TGT-Queue-Depth; However, Less May Be Sent When SD_MAX_THROTTLE IS Reached for the Entire Target.
topology This variable controls the Fibre Channel topology expected by lpfc at boot time Fibre Channel offers point-to-point, fabric, and arbitrated loop topologies This variables encodes these topologies as follows:.. 0 Attempt loop mode, if it fails attempt point- To-Point Mode 2 Attempt Point-to-Point Only 4 Attempt Loop Only 6 Attempt Point-To-Point Mode, IF IT Fails Attempt Loop Mode
To make the adapter operate as an N_Port, select point-to-point mode (used for N_Port to F_Port, and N_Port to N_Port connections). To make the adapter operate in a Fibre Channel loop as an NL_Port, select loop mode (used for private loop and public loop topo- logies). The driver will reject an attempt to set the topology to a value not in the above list. The auto- topology setting (0 and 6) will not work unless the adapter is using firmware version 3.20 OR HIGHER.
Use-adisc the variable controls the els commnd used for FCP Address Authentication During Discovery. IF Set, Adisc IS Used, OtherWise, Plogi is Used.
use-lomempages This variable applies only to x86 platforms. The set- ting of this variable can affect whether lpfc runs correctly on an x86 host. The Solaris DDI / DKI requires that kernel memory be allocated using special
Sunos 5.8 Last Change: 25 March 1999 8
DEVICES LPFC (7D)
primitives if that memory may be the target of a DMA operation. On the x86, this memory comes from a spe- cial low memory pool that is guaranteed to be safe for DMA operations across all x86 platforms. (Some platforms do not correctly handle DMA operations on physi- cal memory above the 16 megabyte boundary) Unfor- tunately, the size of the low memory pool is very lim- ited;. in fact, the standard Solaris releases default to a size of 36 pages in this pool. While the size of the pool can be increased, on most x86 systems a reasonable alternative is to not use this pool at all. On these systems, ordinary memory works correctly as a target for DMA operations. As lpfc is distributed, we set the value Of this variable to 0, disabling the use of the low memory pool. if you suspect what your x86 platform can't Handle Arbitrary DMA correctly above the 16MB boundary, set this variable to 1; you must also increase the size of the low memory pool Refer to the release notes for more information.zone-rscn If zone-rscn is 1, the driver will check the NameServer. data to see if an N_Port ID received in an RSCN is per- tinent to this adapter. This behavior is necessary when running soft zoning in a Brocade fabric. If zone-rscn is 0, the RSCN is assumed to apply to this adapter, and No Nameserver Query Is Performed.
Bugs Refer to the Release Notes for Information About Known Bugs.
Files / kernel / drv / lpfc ELF KERNEL MODULE 32B MODE / KERNEL / DRV / SPARCV9 / LPFC ELF KERNEL MODULE 64B MODE /KERNEL/DRV/LPFC.CONF Configuration File for the entire lpfc driver /kernel/drv/cmdk.conf (x86 ) Target Driver configura- tion file /kernel/drv/sd.conf (sparc) Target Driver confi- guration file / etc / system system-wide configuration fiesee also pronf (1m), driver.conf (4), SCSI_ABORT (9F) , SCSI_DEVICE (9S), SCSI_EXTENDED_SENSE (9S), SCSI_HBA_ATTACH (9F), SCSI_IFGETCAP (9F), SCSI_INQUIRY (9S), SCSI_PKT (9S) SCSI_RESET (9F), SCSI_TRANSPORT (9F), PKGADD (1M),
Writing Device Drivers
Openboot Command Reference
Sunos 5.8 Last Change: 25 march 1999 9
DEVICES LPFC (7D)
ANSI SMALL Computer System Interface-3 (SCSI-3)
Lightpulse PCI Host Adapter User Guide
Lightpulse Host Adapter Release Notes
LPFC: Lightpulse Solaris HBA Driver Release Notes
Sunos 5.8 Last Change: 25 March 1999 10
