Emulex® Drivers For Windows For LightPulse® Adapters - User Guide R12.0
Emulex® Drivers For Windows For LightPulse® Adapters - User Guide R12.0
User Guide
Release 12.0
Broadcom DRVWin-LPE-UG120-100
July 5. 2018
Broadcom, the pulse logo, Connecting everything, Avago Technologies, Avago, and the A logo are among the trademarks
of Broadcom and/or its affiliates in the United States, certain other countries, and/or the EU.
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. For more information, please visit www.broadcom.com.
Broadcom reserves the right to make changes without further notice to any products or data herein to improve reliability,
function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom does
not assume any liability arising out of the application or use of this information, nor the application or use of any product or
circuit described herein, neither does it convey any license under its patent rights nor the rights of others.
Emulex Drivers for Windows for LightPulse Adapters User Guide
Table of Contents
Broadcom DRVWin-LPE-UG120-100
3
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
4
Emulex Drivers for Windows for LightPulse Adapters User Guide
Chapter 1: Introduction
This product supports the following Emulex® LightPulse® adapters:
LPe12000-series adapters
LPe16000-series adapters
LPe31000-series adapters
LPe32000-series adapters
1.2 Abbreviations
1GbE 1 Gigabit Ethernet
10GbE 10 Gigabit Ethernet
AL_PA arbitrated loop physical address
ARM Advanced RISC Machines
BIOS basic input-output system
CPU central processing unit
CRC cyclic redundancy check
DCBX Data Center Bridging Capabilities Exchange
DPC deferred procedure call
DHCP Dynamic Host Control Protocol
DID device ID
DIMM dual inline memory module
DMA direct memory access
DNS Domain Name Server
DOS disk operating system
ETS Enhanced Transmission Selection
FA-PWWN Fabric Assigned Port World Wide Name
FC Fibre Channel
FC-AL Fibre Channel Arbitrated Loop
FCP Fibre Channel Protocol
FDMI Fabric-Device Management Interface
FLOGI fabric login
FSB front-side bus
GB gigabyte
Gb/s gigabits per second
GUI graphical user interface
Broadcom DRVWin-LPE-UG120-100
5
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
6
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
7
Emulex Drivers for Windows for LightPulse Adapters User Guide
Chapter 2: Installation
Install the Windows drivers for LightPulse adapters in one of two ways:
OneInstall Installer contains the Emulex Storport Miniport driver, Emulex PLUS (ElxPlus) driver, and the
OneCommand® Manager application for LightPulse Adapters in a single download package.
Driver kits and AutoPilot Installer provide installation options ranging from simple installations with a few mouse clicks to
unattended installations that use predefined script files and text-only installations.
NOTE: Windows 8 x64 and Windows 8.1 x64 drivers are Emulex signed. You must accept the Emulex certificate to install
these kits. Support is provided by Broadcom®, but not by Microsoft.
NOTE: Check the Broadcom website for required updates to the Windows operating system or the Emulex drivers.
NOTE: OneInstall Installer does not allow you to perform preinstallation tasks or text-only installations. For these tasks,
use the driver kits.
OneInstall Installer is a self-extracting executable file that installs the following software on your system:
FC driver
Emulex PLUS (ElxPlus) driver (supports the OneCommand Manager application, persistent binding, logical unit
numbering (LUN) mapping and masking, and virtual port creation)
OneCommand Manager application
NOTE: The Enterprise kit for the OneCommand Manager application does not operate locally on Windows Server Core.
You must install the OneCommand Manager Core Kit (command line interface only) to the Windows Server Core.
Refer to the Emulex OneCommand Manager Application for LightPulse Adapters User Guide for installation
instructions.
Broadcom DRVWin-LPE-UG120-100
8
Emulex Drivers for Windows for LightPulse Adapters User Guide
If you run OneInstall Installer from a batch file or from a command line prompt, the default Windows behavior starts
OneInstall, then immediately continues with the next command. It does not wait until OneInstall has finished.
As a result, the value of %ERRORLEVEL% will always be 0 because Windows successfully started OneInstall. It does not
reflect an accurate OneInstall exit code.
The START /wait ensures that the command does not return until setup has exited. The value of %ERRORLEVEL% now
accurately reflects the OneInstall Installer exit code.
Where:
NOTE: On a Windows Server Core system, this installs all drivers and the OneCommand Manager Core Kit.
ALLCORE=1 – Installs the FC driver and the OneCommand Manager Core Kit.
FC=1 – Installs the FC driver only.
OCM=1 – Installs the OneCommand Manager Enterprise Kit only.
NOTE: On a Windows Server Core system, this installs the OneCommand Manager Core Kit.
OMCORE=1 – Installs the OneCommand Manager Core Kit only.
Broadcom DRVWin-LPE-UG120-100
9
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: This procedure does not install drivers, and no driver changes are made until you run AutoPilot Installer.
Broadcom DRVWin-LPE-UG120-100
10
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: Refer to the Emulex Software Kit Migration User Guide for information about installing drivers on a system
containing a mix of OneConnect® and LightPulse adapters.
Driver diagnostics – Determines whether the driver is operating properly.
Silent installation mode – Suppresses all screen output (necessary for unattended installation).
NOTE: AutoPilot Installer does not allow you to install the driver if the minimum Windows service pack or Microsoft Storport
driver update is not installed.
You can install the driver by using any of the following methods:
NOTE: Complete driver and utilities documentation can be downloaded from the Broadcom website.
For additional information on command line installation and configuration parameters, see Appendix B, AutoPilot Installer
Command Line and Configuration File Parameters.
Broadcom DRVWin-LPE-UG120-100
11
Emulex Drivers for Windows for LightPulse Adapters User Guide
After the driver kit loading is complete, change the configuration in one of two ways:
Change the configuration file.
Supply parameters on the command line.
NOTE: See Appendix B, AutoPilot Installer Command Line and Configuration File Parameters, for additional information
on either of these configuration methods.
After you have finished this step, you can run AutoPilot Installer at a later time.
4. Run AutoPilot Installer using the following command:
C:\Program Files\Emulex\AutoPilot Installer\APInstall.exe
NOTE: The location of APInstall.exe might differ on your system, depending on your system's Program Files location.
You can also specify a different location when you install the driver package.
Broadcom DRVWin-LPE-UG120-100
12
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: To update the Emulex protocol drivers, begin this procedure at Step 2.
NOTE: If there are multiple adapters in the system, the Windows Found New Hardware wizard is displayed multiple
times. Click Cancel to exit the wizard each time it is displayed.
2. Run AutoPilot Installer using one of the two options listed in Section 2.3.2, Running a Software Installation Interactively.
Consider the following:
– If you are updating the driver, the existing port settings are used, unless otherwise specified in the configuration file.
These settings are pre-selected but can be changed. Set or change the settings, then click Next.
– If you are initially installing a vendor-specific version of the Emulex driver installation program, a Driver
Configuration window might be displayed. This window includes one or more windows with questions that you must
answer before continuing the installation process. In this case, answer each question and click Next on each window
to continue.
3. Click Next. The installation is completed automatically.
A dialog is displayed if Windows requires a reboot. After the installation is successful, a Finish window is displayed.
4. View or print a report, if desired.
– View Installation Report – The installation report is a text file with current Emulex adapter inventory, configuration
information, and task results.
– Print Installation Report – The Windows Print dialog is displayed to select options for printing the installation
report.
5. Click Finish to exit AutoPilot Installer.
6. If the system must be rebooted, you are prompted to do so as indicated in Step 3. You must reboot before using the
drivers or utilities.
Broadcom DRVWin-LPE-UG120-100
13
Emulex Drivers for Windows for LightPulse Adapters User Guide
2. Click OK.
A Welcome window is displayed.
3. Click Next. The installation automatically progresses.
After the installation is successful, the Finish window is displayed.
4. View or print a report, if desired.
– View Installation Report – The installation report is a text file with current Emulex adapter inventory, configuration
information, and task results.
– Print Installation Report – The Windows Print dialog is displayed to select options for printing the installation
report.
5. Click Finish to exit AutoPilot Installer.
Whether AutoPilot Installer is launched from the command line or run as a program, Windows always starts AutoPilot
Installer as a separate stand-alone task. This means that AutoPilot Installer has its own command prompt window and cannot
access other windows.
Broadcom DRVWin-LPE-UG120-100
14
Emulex Drivers for Windows for LightPulse Adapters User Guide
Copies the driver parameters from the configuration file into the registry for the driver's co-installer
Installs or updates the driver
Rediscovers adapters and records the updated adapter inventory in the report file
Records the final results and closes the report file
NOTE: The name of the driver kit depends on the current version identifier. For other command line options, see Appendix
B, AutoPilot Installer Command Line and Configuration File Parameters.
Broadcom DRVWin-LPE-UG120-100
15
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTEThe ElxPlus driver must be installed before you install the Emulex protocol drivers.
2.4.1 Installing the Emulex PLUS (ElxPlus) Driver for the First Time
NOTEOnly one instance of the ElxPlus driver must be installed, even if you have multiple
adapter ports installed in your system.
To install the ElxPlus driver from the desktop, perform these steps:
1. Run the driver kit installer, but do not run AutoPilot Installer. See Section 2.3.2, Running a Software Installation
Interactively, for instructions.
2. Select Start > Settings > Control Panel > Add Hardware. The Add Hardware Wizard window is displayed. Click
Next.
3. Select Yes, I have already connected the hardware and click Next.
4. Select Add a new hardware device and click Next.
5. Select Install the hardware that I manually select from a list (Advanced) and click Next.
6. Select Show All Devices and click Next.
7. Click Have Disk and direct the Device Wizard to the location of elxplus.inf. If you have installed the driver
installer kit in the default folder and C:\ is your Windows system drive, the path is:
C:\Program Files\Emulex\AutoPilot Installer\FC\Drivers\Storport\x64\<OS>
8. Click OK.
9. Select elxplus. Click Next and click Next again to install the driver.
10. Click Finish.
The initial ElxPlus driver installation has completed. Continue with manual installation of the Storport Miniport
Driver. See Section 2.4.3, Installing or Updating the Storport Miniport Drivers, for this procedure.
NOTEOnly one instance of the ElxPlus driver must be installed, even if you have multiple
adapter ports installed in your system.
To update an existing ElxPlus driver from the desktop, perform these steps:
1. Run the driver kit installer, but do not run AutoPilot Installer. See Section 2.3.2, Running a Software Installation
Interactively, for instructions.
Broadcom DRVWin-LPE-UG120-100
16
Emulex Drivers for Windows for LightPulse Adapters User Guide
2. Select Start > Settings > Control Panel > Administrative Tools > Computer Management.
3. Click Device Manager (left pane).
4. Click Emulex PLUS class (right pane) to show the ElxPlus driver entry.
5. Right-click the ElxPlus driver entry and select Update Driver from the menu.
6. Select No, not this time. Click Next on the Welcome to the Hardware Update Wizard window. Click Next.
7. Select Install from a list or specific location (Advanced) and click Next.
8. Select Don’t Search. I will choose the driver to install.
9. Click Have Disk and direct the Device Wizard to the location of the driver’s distribution kit. If you have installed
the driver installer kit in the default folder, the path is:
C:\Program Files\Emulex\AutoPilot Installer\FC\Drivers\Storport\x64<OS>
10. Click OK. Select Emulex PLUS.
11. Click Next to install the driver.
12. Click Finish.
The ElxPlus driver update is finished. Continue with the manual installation of the Storport Miniport Driver.
NOTE: The driver affects only the selected adapter. If there are other adapters in the system, you must repeat this process
for each adapter. All dual-channel adapter models are displayed in Device Manager as two adapters, and each
adapter must be updated.
6. Select the Driver tab.
7. Click Update Driver. The Update Driver wizard starts.
8. Select No, not this time. Click Next on the Welcome to the Hardware Update Wizard window.
9. Select Install from a list or specific location (Advanced) and click Next.
10. Select Don't search. I will choose the driver to install and click Next.
11. Click Have Disk and direct the Device Wizard to the location of oemsetup.inf. If you have installed the driver installer
kit in the default folder, the path is:
C:\Program Files\Emulex\AutoPilot Installer\FC\Drivers\Storport\x64\<OS>
12. Click OK. Select Emulex LightPulse LPX000, PCI Slot X, Storport Miniport Driver (your adapter model is displayed
here).
13. Click Next.
14. Click Finish.
The driver installation has completed. The driver will start automatically. If the adapter is connected to a SAN or data
storage device, a blinking yellow light on the back of the adapter indicates a link-up condition.
Broadcom DRVWin-LPE-UG120-100
17
Emulex Drivers for Windows for LightPulse Adapters User Guide
On all platforms, the reports folder in the Emulex\AutoPilot Installer folder is not removed, so you can still view
installation history and the drivers that have been installed on the system. You can delete the reports folder at any time.
Broadcom DRVWin-LPE-UG120-100
18
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: On Windows 2012 and Windows 2012 R2, after the message Warning – you are about to uninstall
this device from your system is displayed, you must select the checkbox Delete the software for this
device to uninstall the driver.
Broadcom DRVWin-LPE-UG120-100
19
Emulex Drivers for Windows for LightPulse Adapters User Guide
Chapter 3: Configuration
NOTE: If you are creating custom unattended installation scripts, any driver parameter can be modified and included in
the script.
NOTE: When a new WWPN is assigned using FA-PWWN, persistently stored configuration information associated with
the original WWPN, such as driver parameters and LUN frame priority settings, is not applied to the newly assigned
WWPN. The configuration information associated with the original WWPN must be reconfigured for the new
WWPN.
Activation
Parameter Definitions Requirement Notes
AutoMap AutoMap controls the way targets are assigned SCSI IDs. Reboot –
Discovered targets are assigned persistent SCSI IDs according to
the selected binding method. Persistent bindings do not take effect
with the driver in stand-alone mode.
0 = Automap is disabled. The OneCommand Manager
application persistently sets the SCSI address of a discovered
FCP-capable FC node (target).
1 = Automap by WWNN.
2 =Automap by WWPN.
3 = Automap by DID.
Value: 03
Default = 2
Broadcom DRVWin-LPE-UG120-100
20
Emulex Drivers for Windows for LightPulse Adapters User Guide
Activation
Parameter Definitions Requirement Notes
BBCRRecovery If set to 1, BBCRRecovery enables Buffer-to-buffer credit Reset LPe16000-series and
recovery. Buffer-to-buffer credit recovery also requires adapter LPe32000-series
firmware and switch firmware support. adapters only.
Values: 0 to 1
Default = 1
Class Class selects the class of service on FCP commands. Dynamic Supported on
If set to 2, class of service is 2. LPe12000-series
If set to 3, class of service is 3. adapters only.
Value: 2 to 3
Default = 3
CoalesceMsCnt CoalesceMsCnt specifies wait time in milliseconds to generate Reset Supported on
an interrupt response if CoalesceRspCnt has not been satisfied. LPe12000-series
Zero specifies an immediate interrupt response notification. A adapters only.
nonzero value enables response coalescing at the specified
interval in milliseconds.
Value: 0 to 63 (decimal) or 0x0–0x3F (hexadecimal)
Default = 0 (0x0)
CoalesceRspCnt CoalesceRspCnt specifies the number of response entries that Reset Supported on
trigger an interrupt response. LPe12000-series
Value: 0 to 255 (decimal) or 0x1–0xFF (hexadecimal) adapters only.
Default = 8 (0x8)
ConfigScale ConfigScale sets the memory footprint profile in accord with the Reboot Not supported on
anticipated use case on a per-port basis. ConfigScale is always LPe12000-series
set at 4. The maximum transfer size is set according to the value of adapters.
the ExtTransferSize parameter.
Default = 4
DriverTraceMask The DriverTraceMask parameter is only available on operating Dynamic –
systems that support extended system event logging.
If set to 0 = The parameter is disabled.
If set to 1 = Error events logging is enabled.
If set to 4 = Warning events logging is enabled.
If set to 8 = Informational events logging is enabled.
The values can be masked to generate multiple levels of event
logging.
Values: 0, 1, 4, and 8.
Default = 0.
EnableAck0 Set to 1 to force sequence rather than frame level Reset Supported on
acknowledgement for class 2 traffic over an exchange. This applies LPe12000-series
to FCP data exchanges on IREAD and IWRITE commands. adapters only.
Value: 0 to 1 (decimal)
Default = 1
Broadcom DRVWin-LPE-UG120-100
21
Emulex Drivers for Windows for LightPulse Adapters User Guide
Activation
Parameter Definitions Requirement Notes
EnableFDMI If set to 1, enables management server logon on fabric discovery, Reset –
which allows FDMI to operate on switches that have FDMI-capable
firmware. FDMI operates as FDMI-1.
If set to 2, FDMI operates as FDMI-2.
If set to 0, FDMI is disabled.
Value: 0 to 2 (decimal)
Default = 2
EnableMDSD If set to 1, Cisco Multilayer Director Switch (MDS) diagnostics are Reset –
enabled.
Value: 0 to 1
Default = 0
The parameter should be disabled (set to 0) after diagnostics are
complete.
Broadcom DRVWin-LPE-UG120-100
22
Emulex Drivers for Windows for LightPulse Adapters User Guide
Activation
Parameter Definitions Requirement Notes
LimTransferSize Limits the maximum transfer size to selectable values if this Reboot –
parameter is nonzero.
Values:
0 = Port (default)
1 = 64 KB
2 = 128 KB
3 = 256 KB
LinkSpeed LinkSpeed has significance only if the adapter supports speeds Reset Supported on
other than 1 Gb/s. LPe12000-series
Value: Auto-select, 2 Gb/s, 4 Gb/s, and adapters only.
8 Gb/s
Default = Auto-select
NOTE: Setting this option incorrectly can cause the adapter to fail
to initialize.
NOTE: If you configure the link speed in a BIOS utility, the link
speed might be overridden by the Emulex driver for Windows
according to its LinkSpeed setting. To avoid this issue, configure
the link speed in both the Emulex driver for Windows and the Boot
BIOS or UEFI driver.
LinkTimeOut A timer is started on all mapped targets using the LinkTimeOut Dynamic –
value when a link down event is detected. If the timer expires
before link up discovery is resolved, commands issued to timed-out
devices return a SELECTION_TIMEOUT. The Storport driver is
notified of a bus change event, which leads to the removal of all
LUNs on the timed-out devices.
Value: 2 to 255 seconds or 0x0 to 0xFF (hexadecimal)
Default = 30 (0x1E)
LogErrors LogErrors determine the minimum severity level required to Dynamic –
enable entry of a logged error into the system event log. Errors are
classified as severe, malfunction, or command level.
A severe error requires user intervention to correct a firmware or
adapter issue. An invalid link speed selection is an example of a
severe error.
A malfunction error indicates a system problem, but user
intervention is not required. An invalid fabric command type is an
example of a malfunction error.
An object allocation failure is an example of a command error.
If set to 0 = All errors are logged.
If set to 1 = Command level errors are logged.
If set to 2 = Malfunction errors are logged.
If set to 3 = Severe errors are logged.
Value: 0 to 3
Default = 3
Broadcom DRVWin-LPE-UG120-100
23
Emulex Drivers for Windows for LightPulse Adapters User Guide
Activation
Parameter Definitions Requirement Notes
MaxIODepth MaxIODepth limits the maximum number of outstanding I/Os Reboot LPe16000-series and
handled by the driver. MaxIODepth allows the maximum number LPe32000-series
of outstanding I/Os to be constrained by increments of 256 from adapters only.
256 (1) to 4096 (16) if the value is smaller than the driver limit. (The
driver limit is derived from the adapter and driver resources.) If
MaxIODepth is set to 0, the maximum number of outstanding I/
Os is the driver limit.
Values: 0 to 16
Default = 0
NodeTimeout The node timer starts when a node (that is, a discovered target or Dynamic –
adapter) becomes unavailable. If the node fails to become
available before the NodeTimeout interval expires, the operating
system is notified so that any associated devices (if the node is a
target) can be removed. If the node becomes available before the
NodeTimeout interval expires, the timer is canceled and no
notification is made.
Value: 1 to 255 seconds or 0x0 to 0xFF (hexadecimal)
Default = 30 (0x1E)
QueueDepth QueueDepth requests per LUN/target (see the QueueTarget Dynamic –
parameter). If you expect the number of outstanding I/Os per
device to exceed 32, you must increase to a value greater than the
number of expected I/Os per device (up to a value of 254). If the
QueueDepth value is set too low, a performance degradation can
occur due to driver throttling of its device queue. QueueDepth
supports more than 1000 outstanding commands per port.
Value: 1 to 254 or 0x1 to 0xFE (hexadecimal)
Default = 32 (0x20)
QueueTarget QueueTarget controls I/O depth limiting on a per-target or per- Dynamic –
LUN basis.
If set to 0 = Depth limitation is applied to individual LUNs.
If set to 1 = Depth limitation is applied across the entire target.
Value: 0 to 1 or 0x0 to 0x1 (hexadecimal)
Default = 0 (0x0)
RmaDepth RmaDepth sets the remote management buffer queue depth. The Reboot –
greater the depth, the more concurrent management controls can
be handled by the local node.
Value: 8 to 64, or 0x8 to 0x40 (hexadecimal)
Default = 16 (0x10)
NOTE: The RmaDepth driver parameter pertains to the
functionality of the OneCommand Manager application.
Broadcom DRVWin-LPE-UG120-100
24
Emulex Drivers for Windows for LightPulse Adapters User Guide
Activation
Parameter Definitions Requirement Notes
SLIMode If set to 0 = Autoselect firmware, use the latest firmware Reboot Supported on
installed. LPe12000-series
If set to 2 = Implies running the adapter firmware in SLI-2 adapters only.
mode.
If set to 3 = Implies running the adapter firmware in SLI-3
mode.
Value: 0, 2, and 3
Default = 0
SrbTimeout SrbTimeout limits the SCSI timeout value to –
60 seconds if set to 1 or enabled. This parameter is a non-
displayed parameter that must be set manually in the registry. This
parameter alters the I/O timeout behavior, where an I/O will be
returned in a maximum timeout of 60 seconds on long I/O timeouts.
If set to 1 = Enabled
If set to 0 = Disabled
Values: 0 to1
Default = 0
Topology If set to 0 (0x0) = FC-AL. Reset Supported on
If set to 1 (0x1) = PT-PT fabric. LPe12000-series and
If set to 2 (0x2) = *FC-AL first, then attempt PT-PT. LPe16000-series
If set to 3 (0x3) = *PT-PT fabric first, then attempt FC-AL. adapters only.
NOTE: Topology fail-over requires firmware version v3.20 or
higher. If the firmware does not support topology failover, options Not supported on
0,2 and 1,3 are analogous. LPe16202 adapters.
Value: 0 to 3
Default = 2 (0x2)
TraceBufSiz TraceBufSiz sets the size in bytes for the internal driver trace Reboot –
buffer, which acts as an internal log of the driver's activity.
Value: 250000 to 2000000 or 0x3D090 to 0x1E8480
(hexadecimal).
Default = 250000 (0x3D090)
XLanePriority XLanePriority sets the frame priority level for the LUN. Refer to Dynamic Not Supported on
the switch vendor administration guide to set the value. LPe12000-series
Value: 0 to 7F (hexadecimal) adapters.
Default = 0
Broadcom DRVWin-LPE-UG120-100
25
Emulex Drivers for Windows for LightPulse Adapters User Guide
With I/O Coalescing turned off (the default setting), each I/O processes immediately, one CPU interrupt per I/O. For systems
with light loads, the default setting provides better throughput. Table 2 shows recommendations based upon the number of
I/Os per adapter.
3.1.2.1.1 CoalesceMsCnt
The CoalesceMsCnt parameter controls the maximum elapsed time in milliseconds that the adapter waits before it
generates a CPU interrupt. The value range is 0 to 63 (decimal) or 0x0 to 0x3F (hexadecimal). The default is 0 and disables
I/O Coalescing.
3.1.2.1.2 CoalesceRspCnt
The CoalesceRspCnt parameter controls the maximum number of responses to batch before an interrupt generates. If
CoalesceRspCnt expires, an interrupt generates for all responses collected up to that point. With CoalesceRspCnt set
to less than 2, response coalescing is disabled, and an interrupt triggers for each response. The value range for
CoalesceRspCnt is 1 to 255 (decimal) or 0x1 to 0xFF (hexadecimal). The default value is 8.
3.1.2.2.1 QueueDepth
If the number of outstanding I/Os per device is expected to exceed 32, increase this parameter to a value greater than the
number of expected I/Os per device, to a maximum of 254. The QueueDepth parameter defaults to 32. If the default setting
is not a high enough value, performance degradation might occur due to Storport throttling its device queue.
3.1.2.2.2 CoalesceMsCnt
CoalesceMsCnt defaults to 0. If you are using a performance evaluation tool, such as IOMETER, and if you expect the
I/O activity to be greater than 8000 I/Os per second, set CoalesceMsCnt to 1 and reset the adapter or reboot the system.
Broadcom DRVWin-LPE-UG120-100
26
Emulex Drivers for Windows for LightPulse Adapters User Guide
3.1.2.2.3 CoalesceRspCnt
CoalesceRspCnt defaults to 8. For all other values up to the maximum of 63, the adapter does not interrupt the host with
a completion until either CoalesceMsCnt milliseconds has elapsed or CoalesceRspCnt responses are pending. The
values of these two driver parameters reduces the number of interrupts per second, which improves overall CPU utilization.
However, a point exists where the number of I/Os per second is small relative to CoalesceMsCnt, and this situation will
slow down the completion process, causing performance degradation.
3.1.2.2.4 Examples
Test scenario 1:
IOMETER runs with an I/O depth of 1 I/O per device in a small-scale configuration (16 devices). In this case, the test
does not exceed the adapter's performance limits, and the number of I/Os per second are in the low thousands.
Recommendation: Set CoalesceMsCnt to 0 (or use the default value).
Test scenario 2:
IOMETER runs with an I/O depth of 48 I/Os per device in a small-scale configuration (16 devices).
Recommendation: Set QueueDepth to be greater than 48 (for example, 64).
If the number of outstanding I/Os per device is expected to exceed 32, increase this parameter to a value greater than the
number of expected I/Os per device, to a maximum of 254. The QueueDepth parameter defaults to 32. If the default setting
is not a high enough value, performance degradation might occur due to Storport throttling its device queue.
Test scenario:
IOMETER is running with an I/O depth of 48 I/Os per device in a small-scale configuration (16 devices).
Recommendation: Set QueueDepth to be greater than 48 (for example, 64).
Broadcom DRVWin-LPE-UG120-100
27
Emulex Drivers for Windows for LightPulse Adapters User Guide
Chapter 4: Troubleshooting
Your system may operate in an unexpected manner in certain circumstances. This section contains reference tables on
event codes and error messages and provides information regarding unusual situations.
Issue Answer/Solution
The operating system fails to install or Verify that the operating system is supported by the driver.
does not successfully install the driver.
The AutoPilot Installer fails. If the AutoPilot Installer fails, the Diagnostics window shows that the adapter failed. If the
adapter fails, perform these steps:
1. Select the adapter to view the reason why the adapter failed. The reason and suggested
corrective action are displayed.
2. Perform the suggested corrective action and run AutoPilot Installer again.
NOTE: You can run AutoPilot Installer again from the Start menu (Programs > Emulex >
AutoPilot Installer), or you can run APInstall.exe from a command prompt.
The OneInstall Installer fails. If OneInstall Installer fails, it may be because of one of the following reasons:
The operating system prerequisites have not been met.
The individual kit installation failed. To check, run the installation interactively. If you
encounter error messages when you run the installation interactively, those issues would
also apply to an unattended installation.
If an individual package failed to install properly, run that package's installer directly. This
method displays status and error messages that can be used to diagnose the issue. (The
OneInstall Installer does not provide these displays because each package is installed
silently.)
Windows Device Manager shows a The firmware image does not match the installed device drivers, or the firmware is corrupt.
code 10 or code 39 with a yellow or red Using the OneCommand Manager application or one of the Windows PE offline or online
exclamation point on the device. utilities, install a version of firmware that is compatible with the driver.
The firmware is corrupt or non- Using the OneCommand Manager application or one of the Windows PE offline or online
responsive. utilities, install a version of firmware that is compatible with the driver.
Port names might differ for adapter This is a display issue that does not affect functionality. Run the AutoPilot Installer to correct this
ports, although they are running the issue.
same driver binary. Example: Run elxdrvr-fc-11.x.xxx.xx.exe and reinstall the driver kit.
NOTE: A reboot may be required after the installation to see the correct names in Device
Manager.
Broadcom DRVWin-LPE-UG120-100
28
Emulex Drivers for Windows for LightPulse Adapters User Guide
byte 0x10 = 9b, byte 0x11 = 00, byte 0x12 = 29, and byte 0x13 = 00
Broadcom DRVWin-LPE-UG120-100
29
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: Set LogError to 1 if you are troubleshooting SAN connectivity or device discovery issues.
Broadcom DRVWin-LPE-UG120-100
30
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
31
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
32
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
33
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
34
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
35
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
36
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: For troubleshooting SAN connectivity or device discovery issues, set the LogErrors to 1.
The Emulex event code is found in byte 0010 and supplementary data is in byte offsets 0011 through 0013.
Code Explanation
0x2 Remote Stop – Remote port sent an ABTS
0x3 Local Reject – Local Reject error detail
0x9 LS_RJT Received – Remote port sent LS_RJT
0xA A_RJT Received – Remote port sent BA_RJT
Code Explanation
0x8001 FC Common Transport Reject
0x8002 FC Common Transport Accept
Broadcom DRVWin-LPE-UG120-100
37
Emulex Drivers for Windows for LightPulse Adapters User Guide
Code Explanation
0x01 Invalid command code
0x02 Invalid version level
0x05 Logical busy
0x07 Protocol error
Code Explanation
0x01 Link Service Reject (LS_RJT)
0x02 Accept (ACC)
0x03 N_Port Login (PLOGI)
0x04 Fabric Login (FLOGI
0x05 N_Port Logout (LOGO)
0x20 Process Login (PRLI)
0x21 Process Logout (PRLO)
0x51 Discover F_Port Service Params (FDISC)
0x52 Discover Address (ADISC)
0x61 Register State Change Notify (RSCN)
Code Explanation
0x00 Good
0x02 Check condition
0x08 Busy
0x18 Reservation conflict
0x28 Queue full
Broadcom DRVWin-LPE-UG120-100
38
Emulex Drivers for Windows for LightPulse Adapters User Guide
Code Explanation
0x02 Sequence timeout – Possible bad cable/link noise
0x04 Invalid RPI – Occurs if the link goes down
0x05 NO XRI – Possible host or SAN problem
0x0D TX DMA Failed – Possible host system issue
0x0E RX DMA Failed – Possible host system issue
0x0F Illegal Frame – Possible bad cable/link noise
0x11 No resources – Port out of exchanges or logons
0x18 Loop open failure – FC_AL port not responding
0x1A Link down – Queued cmds returned at link down
0x1D Out of order data – Possible bad cable or noise
Code Explanation
0x04 Error
0x05 Busy
0x09 Timeout
0x0A Selection timeout
0x0B Command timeout
0x0E BUS reset
0x12 Data overun
A.1.2.3 ASC/ASCQ
Additional Sense Code/Additional Sense Code Qualifier information can be found in any SCSI specification document; these
codes contain detailed information about the status or condition of the SCSI device in question.
NOTE: The nomenclature of 0x is used as the prefix for the byte code fields because those are hexadecimal values.
Broadcom DRVWin-LPE-UG120-100
39
Emulex Drivers for Windows for LightPulse Adapters User Guide
A.1.2.4.2 SCSI Command Error (Code 0xAB) and SCSI Check Condition (Code 0xAA)
Code 0x9A indicates that the SCSI command to a particular device was responded to with an error condition (the target and
LUN information, along with the SCSI status, are provided).
In the specific case of code 0x9B, this code indicates that the device responded with the specific status of Check Condition
– the ASC/ASCQ information provided in bytes 0x12 and 0x13 allows you to find out the status being reported by the target
and to determine if there is an action that can be performed to return the device to functional status.
Broadcom DRVWin-LPE-UG120-100
40
Emulex Drivers for Windows for LightPulse Adapters User Guide
If you specify the /q switch with the driver kit installer command, the driver kit installer runs in unattended mode and
automatically invokes APInstall.exe with its /silent switch. See Section 2.3.6, Unattended Driver Installation, for
additional information.
B.1 AParg Driver Kit Parameter and Appending to the APInstall.exe File
If you specify a value for the APargs driver kit parameter, this value is appended to the APInstall.exe command line.
For example, if you execute this installer file as:
elxdrv-fc-<version>.exe /q APargs=SilentRebootEnable=True
After installing the AutoPilot Installer, the driver kit automatically executes it as:
APInstall.exe /silent SilentRebootEnable=True
To specify more than one parameter, separate the settings by one or more spaces and put quotes around the entire APargs
expression. For example, type the following command on one line:
elxdrv-fc-<version>.exe "APargs=SilentRebootEnable=True localDriverLocation =
"d:\drivers\new\Storport"
Parameter values that contain spaces, such as path names, must be enclosed in double quotation marks. To add such a
setting to APargs, you must insert backslashes before the quotes around the value, and then add double quotation marks
around the entire APargs expression. For example, the command line (all on one line):
elxdrv-fc-<version>.exe "APargs=ReportLocation=\"C:\Documents and Settings\Administrator\My
Documents\reports\""
To pass multiple parameters to the AutoPilot Installer and minimize errors, you can run the utility kit installer interactively,
delay AutoPilot Installer execution, and then run the AutoPilot Installer command. The procedure is described in
Section 2.3.2.2, Option 2: Run AutoPilot Installer Separately, and Section 2.3.6, Unattended Driver Installation.
You can specify a non-default directory for the driver kit by specifying an installation folder on the command line. For
example:
elxdrv-fc-<version>.exe install:"C:\Emulex"
Broadcom DRVWin-LPE-UG120-100
41
Emulex Drivers for Windows for LightPulse Adapters User Guide
The /silent switch and parameter settings can occur in any order. One or more spaces must separate the switch and each
parameter setting.
Double quotation marks are required only around values that contain spaces. Spaces can separate parameters, equal signs,
and values. Parameter names and values are not case-sensitive.
The APInstall command can contain the settings listed below. Each setting, except ConfigFileLocation, can also be
specified in the AutoPilot configuration file. For descriptions of each parameter, see Section B.2.3, Software Configuration
Parameters.
Settings specified in the APInstall command override those specified in the configuration file.
ConfigFileLocation = path-specifier
NoSoftwareFirstInstalls = { TRUE | FALSE }
SilentRebootEnable = { TRUE | FALSE }
ForceDriverUpdate = { TRUE | FALSE }
ForceDriverTypeChange = { TRUE | FALSE }
SkipDriverInstall = { TRUE | FALSE }
InstallWithoutQFE = { TRUE | FALSE }
ForceRegUpdate = { TRUE | FALSE }
LocalDriverLocation = path-specifier
ReportLocation = path-specifier
Example:
APInstall /silent SkipDriverInstall=True configFileLocation=MyConfiguration.cfg
Broadcom DRVWin-LPE-UG120-100
42
Emulex Drivers for Windows for LightPulse Adapters User Guide
Default: True
By default, AutoPilot Installer runs its diagnostics after all driver installation tasks have been completed. To disable this
function, set this parameter to False.
When installing a driver, set this parameter to True to cause Silent mode installations to update or install the Storport Miniport
driver on each adapter in the system, without regard for the currently installed driver type (replacing any installation of the
SCSIport Miniport or FC Port driver).
By default, if the same version of the driver is already installed, an unattended installation proceeds with installing only the
utilities. To force a driver update even if the same version of the driver is installed, set this parameter to True.
NOTE: ForceDriverUpdate applies only to unattended installations; in interactive installations, this parameter is
ignored and you are asked if the driver should be updated.
The ForceRegUpdate driver parameter setting determines whether existing driver parameters are retained or changed
when you update the driver. By default, all existing driver parameter settings are retained. The ForceRegUpdate parameter
does not affect any existing persistent bindings. To set up an installation to remove the existing driver parameters from the
registry and replace them with parameters specified in the AutoPilot configuration file, set this parameter to True.
NOTE: You can use this setting for attended installations with the AutoPilot Installer wizard if you modify the AutoPilot
configuration file in AutoPilot Installer.
You can specify a local location that is to be searched for drivers during unattended installations. The location can be a local
hard drive or a network shared drive. Removable media are not searched.
Example:
LocalDriverLocation = "d:\drivers\new\Storport"
Broadcom DRVWin-LPE-UG120-100
43
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: On x64 and 32-bit systems, the path specified by LocalDriverLocation must contain at least one instance of
an FC driver. AutoPilot Installer automatically selects the most recent revisions that it finds.
If this parameter is set to True, AutoPilot Installer prevents unattended installations from performing software-first
installations. This way you can run an automated installation on multiple machines in your network, but only machines with
Emulex adapters actually have Emulex drivers updated or installed.
If this parameter is omitted from the configuration file or explicitly set to True, the page is not displayed. AutoPilot Installer
uses configuration file parameters to determine the appropriate management mode.
where mm is the month number, dd is the day, and yy indicates the year.
You can change only the installation report folder; the file name is auto-generated. In the following example, x could be any
available drive:
ReportLocation = "x:\autopilot\reports\installs\"
Default: False
Setting this parameter to True causes AutoPilot Installer to operate with no user interaction.
AutoPilot Installer's default behavior in unattended installations does not restart the system. AutoPilot Installer continues with
the installation. Restarts often require you to log on as part of the Windows start up process. If there is no logon, the
installation process would stop if the system is restarted. However, Windows can be configured to start up without requiring
you to log on. You must ensure that it is safe to restart the system during unattended installations if you set this parameter
to True.
AutoPilot Installer checks for Microsoft’s QFEs, also known as KB updates, based on the checks you have specified in the
[STORPORT.QFES] section. By default, the installation terminates if the QFE check fails. To enable a driver installation to
proceed even if a check for QFEs fails, set this parameter to True.
Broadcom DRVWin-LPE-UG120-100
44
Emulex Drivers for Windows for LightPulse Adapters User Guide
Each section begins with a heading. The heading is required even if there are no settings in the section. The only section
not required is the Configuration Prompts section, which has the heading [STORPORT.CONFIGURATION]. That section
cannot exist if AutoPilot Installer runs in Silent mode. You must delete or comment-out that entire section for unattended
installation.
Lines that begin with a semicolon (;) are comments. Some of the comments are sample settings. To use the setting, remove
the semicolon.
NOTE: The contents of the %ProgramFiles% environment variable is not terminated with a slash, so you must provide
one in the string. Windows environment variables are not case-sensitive.
Broadcom DRVWin-LPE-UG120-100
45
Emulex Drivers for Windows for LightPulse Adapters User Guide
A [STORPORT.CONFIGURATION] section can exist in the AutoPilot configuration file. The first items in this section are the
driver parameters to be used regardless of how the questions are answered. These items are followed by a subsection that
contains questions (these may be vendor-specific questions). A line containing [QUESTIONS] marks the start of the
subsection, and the end of it is marked by a line containing [ENDQUESTIONS]. Within the question subsection there can be
as many questions as needed. Each question uses the format:
question= “question?”, “explanation”, “answer0”, “answer1”, “answer2”,.... , “answern”
Where:
“question?” contains the text of the question to be asked.
“explanation” contains brief text to help explain the question. The explanation displays below the question in a
smaller font. If there is no explanatory text, empty quotation marks must be used in its place.
“answer0” contains the first answer to be displayed in the drop-down list.
“answer1” contains the second answer to be displayed in the drop-down list.
“answern” contains the nth answer to be displayed in the drop-down list.
For each question there can be as many answers as needed. For each answer, there must be a corresponding “answer
=” section with its corresponding driver parameters listed beneath it. The answer uses the format:
answer = 0
DriverParameter="Param1=value; Param2=value;"
answer = 1
DriverParameter="Param1=value; Param2=value;"
....
answer = n
DriverParameter="Param1=value; Param2=value;"
[STORPORT.CONFIGURATION]
;The first section contains the driver parameters common to all configurations, no matter what answers
are given.
DriverParameter="EmulexOption=0;"
[QUESTIONS]
question = "What is your link speed?", "Note: select 'Auto-detect' if you are unsure about the answer.",
"4GB", "2GB", "1GB", "Auto-detect"
ANSWER = 0
DriverParameter = "LinkSpeed=4;" ;4 GB
ANSWER = 1
DriverParameter = "LinkSpeed=2;" ;2 GB
ANSWER = 2
DriverParameter = "LinkSpeed=1;" ;1 GB
ANSWER = 3
DriverParameter = "LinkSpeed=0;" ;Auto-detect question = "Describe the topology of your storage
network.", "Note: Select 'Arbitrated Loop' when directly connected to the array (no fibre switch).
Select 'Point-to-Point' when connected to a SAN (fibre switch).", "Arbitrated Loop", "Point-to-Point"
ANSWER = 0
DriverParameter = "Topology=2;"
Broadcom DRVWin-LPE-UG120-100
46
Emulex Drivers for Windows for LightPulse Adapters User Guide
ANSWER = 1
DriverParameter = "Topology=3;"
[ENDQUESTIONS]
[END.STORPORT.CONFIGURATION]
For example:
[STORPORT.QFES]
qfe = "QFE 83896", "\system32\drivers\storport.sys", "5.2.1390.176","Win2012"
For example:
Driver Parameter = "LinkTimeout = 45"
See Table 1, Storport Miniport Driver Parameters, for a listing of driver parameters, defaults, and valid values.
Broadcom DRVWin-LPE-UG120-100
47
Emulex Drivers for Windows for LightPulse Adapters User Guide
For example, you can adjust the operating system’s global disk timeout. The timeout is stored in the registry under the key
HKML\CurrentControlSet\Services\disk and is specified with the following string:
TimeOutValue = 0x3C
Broadcom DRVWin-LPE-UG120-100
48
Emulex Drivers for Windows for LightPulse Adapters User Guide
NOTE: If you cancel AutoPilot Installer, that fact is recorded along with the time you cancelled the installation. The contents
of any error dialogs that are displayed are also recorded.
Broadcom DRVWin-LPE-UG120-100
49
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
50
Emulex Drivers for Windows for LightPulse Adapters User Guide
Broadcom DRVWin-LPE-UG120-100
51