Emulex® Drivers for Windows User Guide Release 12.
Broadcom, the pulse logo, Connecting everything, Avago Technologies, Avago, the A logo, Emulex, LightPulse, OneCommand, and OneConnect are among the trademarks of Broadcom and/or its affiliates in the United States, certain other countries, and/or the EU. The PowerPC name and logo are registered trademarks of IBM Corp. and used under license therefrom. Copyright © 2003–2019 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
Emulex Drivers for Windows User Guide Table of Contents Chapter 1: Introduction ...................................................................................................................... 5 1.1 Abbreviations ............................................................................................................................................................5 Chapter 2: Installation .............................................................................................................
Emulex Drivers for Windows User Guide Appendix B: AutoPilot Installer Command Line and Configuration File Parameters ................ 41 B.1 AParg Driver Kit Parameter and Appending to the APInstall.exe File ..............................................................41 B.2 AutoPilot Installer Syntax .....................................................................................................................................42 B.2.1 Path Specifiers .................................................
Emulex Drivers for Windows User Guide Chapter 1: Introduction This document explains how to install the Emulex® drivers for Windows on your system and configure the drivers’ capabilities. This product supports the following Emulex adapters: LPe12000-series adapters LPe16000-series adapters LPe31000-series adapters LPe32000-series adapters LPe35000-series adapters 1.
Emulex Drivers for Windows User Guide PLOGI port login PT-PT point-to-point QFE Quick Fix Engineering RCMD Remote Command Service RSCN registered state change notification RX receive SAN storage area network SLI Service Level Interface TX transmit UEFI Unified Extensible Firmware Interface WWN World Wide Name WWNN World Wide Node Name WWPN World Wide Port Name XRI extensible resource indicator Broadcom DRVWin-LPE-UG124-100 6
Emulex Drivers for Windows User Guide Chapter 2: Installation Install the Windows drivers in one of two ways: OneInstall Installer contains the Emulex Storport Miniport driver and the OneCommand® Manager application 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.
Emulex Drivers for Windows User Guide 2.1.2 Loading OneInstall Installer Using Silent Mode Silent mode installation must be run from a batch file or from the command line. 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 Installer has finished.
Emulex Drivers for Windows User Guide The following are examples of Silent mode commands: Start Start Start Start Start /wait /wait /wait /wait /wait OneInstall-Setup-.exe OneInstall-Setup-.exe OneInstall-Setup-.exe OneInstall-Setup-.exe OneInstall-Setup-.exe /q2 /q2 /q2 /q2 /q2 ALL=1 FC=1 OCM=1 ALLCORE=1 OCMCORE=1 2.2 Driver Kit Installer Each driver kit contains and loads the Windows driver package elxdrvr-fc-.exe. 2.2.
Emulex Drivers for Windows 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).
Emulex Drivers for Windows User Guide 2.3.2.1 Option 1: Automatically Run AutoPilot Installer Use this option unless you have specific configuration requirements. 1. Double-click the driver kit or run it from a command line. The command line parameter APargs allows you to specify arguments that are automatically passed to the AutoPilot Installer command.
Emulex Drivers for Windows User Guide 2.3.3 Hardware-First Installation or Driver Update The driver kit installer must be downloaded from the Broadcom website and installed before performing this installation. NOTE: To update the Emulex protocol drivers, begin this procedure at Step 2. To perform a hardware-first installation, perform these steps: 1. Install a new Emulex adapter and power on the system.
Emulex Drivers for Windows User Guide Figure 1: AutoPilot Installer Popup (Software-First Installation) 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 the current Emulex adapter inventory, configuration information, and task results.
Emulex Drivers for Windows 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 An unattended installation can be performed in two ways: Installs the driver silently Runs the driver kit installer separately 2.3.6.
Emulex Drivers for Windows User Guide 2.3.7.2 OneInstall Installer Failure OneInstall Installer might fail for any of the following reasons: The operating system prerequisites have not been met. The individual kit installation failed. To check the installation, run the installation interactively. If you encounter error messages when you run the installation interactively, those issues would also apply to an unattended installation.
Emulex Drivers for Windows User Guide 2.5 Removing the Emulex Driver Kits and Drivers This section details procedures to uninstall the driver kits. 2.5.1 Uninstalling the Emulex Driver Kits NOTE: If you uninstall the Emulex driver kit, AutoPilot Installer is automatically uninstalled. 2.5.1.1 Uninstalling an Emulex Driver Kit on Windows Server 2012, Windows Server 2016, and Windows Server 2019.
Emulex Drivers for Windows User Guide 2.5.2 Uninstalling the Emulex Drivers The Emulex Storport Miniport driver is uninstalled using the Device Manager. 2.5.2.1 Uninstalling an Emulex Storport Miniport Driver To uninstall the Emulex Storport Miniport driver, perform these steps: 1. Select Start > All Programs > Administrative Tools > Computer Management. 2. Click Device Manager. 3. Double-click the adapter from which you want to remove the Storport Miniport driver.
Emulex Drivers for Windows User Guide Chapter 3: Configuration 3.1 Driver Configuration The Emulex Storport Miniport driver has many options that you can modify to provide different behavior. You can set Storport Miniport driver parameters using the OneCommand Manager application. Refer to the Emulex OneCommand Manager Application User Guide for information on using this utility to configure the driver. 3.1.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters Parameter Definitions Activation 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.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Definitions Activation Requirement Notes 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.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Definitions Activation Requirement Notes ExtTransferSize ExtTransferSize is an initialization-time parameter that affects Reboot the maximum SGL that the driver can handle, which determines the maximum I/O size that a port will support. If set to 0 = The maximum default transfer size is 512 KB for all controller models. If set to 1, the maximum transfer size is 1 MB.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Definitions Activation Requirement Notes LinkSpeed LinkSpeed has significance only if the adapter supports speeds Reset other than 1 Gb/s. Value: Auto-select, 2 Gb/s, 4 Gb/s, and 8 Gb/s Default: Auto-select NOTE: Setting this option incorrectly can cause the adapter to fail to initialize.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Definitions Activation Requirement Notes 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.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Definitions Activation Requirement Notes NVMEKATimeInt NVMEKATimeInt specifies the number of 5-second time intervals Reboot that the NVMe Keep Alive command is sent for each NVMe subsystem association. The Keep Alive timeout is set to three times the value of NVMEKATimeInt, in seconds. Values: 1 to 12 Default: 3 NvmeMode The NVMe configuration bitmask.
Emulex Drivers for Windows User Guide Table 1: Storport Miniport Driver Parameters (Continued) Parameter Activation Requirement Definitions SLIMode If set to 0, autoselect firmware, use the latest firmware installed. If set to 2, runs the adapter firmware in SLI-2 mode. If set to 3, runs the adapter firmware in SLI-3 mode. Values: 0, 2, and 3 Default: 0 Topology If set to 0 (0x0), FC-AL. Reset If set to 1 (0x1), PT-PT fabric. If set to 2 (0x2), *FC-AL first, then attempt PT-PT.
Emulex Drivers for Windows User Guide 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. NOTE: A port reset is required to make changes to CoalesceMsCnt and CoalesceRspCnt. 3.1.2.1.
Emulex Drivers for Windows User Guide 3.1.3 Server Performance with FC Drivers 3.1.3.1 Performance Testing The QueueDepth parameter must be considered (and perhaps changed from the default) for better performance testing. 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.
Emulex Drivers for Windows User Guide Chapter 4: Troubleshooting Your system can 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. 4.1 General Troubleshooting The following table describes issues you might encounter and their solutions.
Emulex Drivers for Windows User Guide Appendix A: Error and Event Log Information A.1 Error and Event Logs A.1.1 Viewing the Error Log The system event log is a standard feature of Windows Server software. All events logged by the Emulex Storport Miniport will be Event ID 11 with source ELXFC. To view the error log: 1. Open the Event Viewer window by doing one of the following: – Click Start > Programs > Administrative Tools > Event Viewer.
Emulex Drivers for Windows User Guide A.1.1.1 Severity Scheme When the Event Viewer is launched, there are three branches: Application, Security, and System. All ELXFC/LP error log entries are found under the System branch, and all ELXFC/LP error log entries have the Event Viewer severity level of error. A severe error code indicates that the driver, firmware, or adapter is behaving abnormally, and your intervention is required to correct the issue.
Emulex Drivers for Windows User Guide Table 4: Severe Errors (Continued) Byte 0x10 Interpretation 0x06 READ_CONFIG_failed 0x07 CONFIG_RING 0 failed 0x08 CONFIG_RING 2 failed 0x09 CONFIG_RING 1 failed 0x0A CONFIG_RING 3 failed 0x0B INIT_LINK failed (SLI2-3 mode) 0x0C INIT_LINK failed (SLI2-3 mode) 0x0D READ_REV failed (SLI2-3 mode) 0x0E Invalid adapter type (SLI2-3 mode) 0x0F Invalid adapter type (SLI2-3 mode) 0x10 CONFIG_PORT failed (reinitialization) 0x12 READ_CONFIG command faile
Emulex Drivers for Windows User Guide Table 4: Severe Errors (Continued) Byte 0x10 Interpretation 0X3A Trunking error detected 0x11: Port fault value 0x42 Re-simulate FCF after exhausted retries on FLOGI 0x51 ABTS timeout on path and target 0x11: Path id 0x12: Target id 0x7C Menlo initialization error 0x7D Menlo initialization error 0x7E Menlo initialization error 0x80 NVMe Keep Alive feature failure 0x12: Target id 0x11: Path id 0xA0 Failed to initialize adapter port (OneConnect
Emulex Drivers for Windows User Guide Table 4: Severe Errors (Continued) Byte 0x10 Interpretation 0xF5 ULP unrecoverable error: high part (SLI4 mode) 0xF6 ARM unrecoverable error (SLI4 mode) 0xF7 READ_NV failed (SLI4 mode) 0xF8 READ_NV failed (SLI4 mode) 0xF9 READ_REV failed (SLI4 mode) 0xFA READ_CONFIG failed (SLI4 mode) 0xFB Failed to post header templates (SLI4 mode) 0xFC Invalid completion queue entry (SLI4 mode) 0xFD Invalid completion queue entry (SLI4 mode) 0xFE Invalid completi
Emulex Drivers for Windows User Guide Table 5: Malfunction Errors (Continued) Byte 0x10 Interpretation 0x4F World Wide Node Name mismatch on ADISC 0x50 ADISC response failure 0x55 LOGO response failure 0x57 PRLI to nonexistent node 0x5A PRLI response error 0x5F CT command error 0x62 Name server response error 0x66 State Change Notification registration failure 0x6A Unrecognized ELS command received 0x6F Received PRLI from untyped source 0x73 Failed to pend PRLI for authentication 0x
Emulex Drivers for Windows User Guide Table 6: Command Errors (Continued) Byte 0x10 Interpretation 0x47 Exhausted retries on ELS command 0x4A PLOGI accepted 0x56 LOGO accepted 0x59 PRLI accepted 0x63 Fabric name server response 0x6B ELS RSCN processed 0x71 LOGO received from fabric 0x79 FDISC accepted 0x81 The indicated IOQ is not available.
Emulex Drivers for Windows User Guide Table 7: Event Indicators (Continued) Byte 0x10 Interpretation 0x1B Port in offline state (SLI2 to SLI3 mode) 0xA7 Data underrun 0xD0 NPIV Virtual Port creation success (Virtual Port DID 0x11 to 0x13) 0xD1 NPIV Virtual Port creation failed (Virtual Port index 0x11 to 0x13) 0xD2 NPIV Virtual Port FDISC failed (Virtual Port index 0x11to 0x13) 0xD4 Exceeded maximum Virtual Ports supported (Virtual Port index 0x11 to 0x13) 0xD5 NPIV Virtual Port removal (Vir
Emulex Drivers for Windows User Guide Table 7: Event Indicators (Continued) Byte 0x10 Interpretation 0xED Same passed were set for both local and remote entities (remote DID 0x11 to 0x13) 0xEE Authenticated successfully (remote DID 0x11 to 0x13) 0xEF Failed to authenticate (remote DID 0x11 to 0x13) 0xF1 Port shutdown event (SLI4 mode) 0xF2 Port in offline state (SLI4 mode) 0xF3 Port in online state (SLI4 mode) A.1.2 Viewing the Event Log This section provides information on the event logs.
Emulex Drivers for Windows User Guide A.1.2.2.3 FC-CT Reject Reason Codes Table 10 lists the codes that indicate the reason a CT command was rejected. Table 10: FC-CT Reject Reason Codes Code Explanation 0x01 Invalid command code 0x02 Invalid version level 0x05 Logical busy 0x07 Protocol error A.1.2.2.4 ELS Command Codes Table 11 lists the FC protocol codes that describe the Extended Link Services commands that were sent.
Emulex Drivers for Windows User Guide A.1.2.2.6 Local Reject Status Codes Table 13 list the codes supplied by the Emulex adapter firmware that indicate why a command was failed by the adapter.
Emulex Drivers for Windows User Guide A.1.2.4.2 SCSI Command Error (Code 0x9A) and SCSI Check Condition (Code 0x9B) 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.
Emulex Drivers for Windows User Guide Appendix B: AutoPilot Installer Command Line and Configuration File Parameters AutoPilot Installer can initiate an installation from a command prompt or script. You can run the AutoPilot Installer manually from the command line or a script, or you can run it automatically through the driver kit. When run manually from the command line or script, the command line parameters can be passed.
Emulex Drivers for Windows User Guide B.2 AutoPilot Installer Syntax The syntax used to run AutoPilot Installer silently from a command line or script is: APInstall [/silent] [parameter setting][parameter setting...] The /silent switch and parameter settings can occur in any order. One or more spaces must separate the switch and each parameter setting. The syntax of a parameter setting is: parameter_name =["]value["] Double quotation marks are required only around values that contain spaces.
Emulex Drivers for Windows User Guide B.2.3 Software Configuration Parameters B.2.3.1 DiagEnable (Running Diagnostics) NOTE: The DiagEnable parameter cannot be specified on the command line; it must be specified within the configuration file. 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. B.2.3.
Emulex Drivers for Windows 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. B.2.3.6 NoSoftwareFirstInstalls (Prohibiting Software First Installations) Default: False If this parameter is set to True, AutoPilot Installer prevents unattended installations from performing software-first installations.
Emulex Drivers for Windows User Guide B.3 AutoPilot Configuration File The AutoPilot configuration file is organized into sections, grouped according to related commands. Six main sections exist: [AUTOPILOT.ID] – Configuration Identification [AUTOPILOT.CONFIG] – Software Configuration [STORPORT.CONFIGURATION] – Configuration Prompts and Vendor-Specific Questions [STORPORT.QFES] – QFE Checks [STORPORT.PARAMS] – Setting Up FC Driver Parameters [SYSTEM.
Emulex Drivers for Windows User Guide B.3.4 Configuration Prompts and Vendor-Specific Questions [STORPORT.CONFIGURATION] NOTE: You must remove or comment-out the entire [STORPORT.CONFIGURATION] section for an unattended installation. 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.
Emulex Drivers for Windows User Guide ANSWER = 1 DriverParameter = "Topology=3;" [ENDQUESTIONS] [END.STORPORT.CONFIGURATION] B.3.5 QFE Checks [STORPORT.QFES] This section specifies an additional QFE check, also known as KB updates, during installation. To add a Windows QFE check to the configuration file, edit the [STORPORT.QFES] section in the AutoPilot configuration file. You can place this section anywhere within the file as long as it is not contained within another section.
Emulex Drivers for Windows User Guide B.3.7 Setting Up System Parameters [SYSTEM.PARAMS] To change the system parameters, create a [SYSTEM.PARAMS] section in the APInstall.cfg file. Create this section under the Optional Configuration File Changes heading in the [AUTOPILOT.CONFIG] section. 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 =
Emulex Drivers for Windows User Guide B.5 AutoPilot Installer Installation Reports During each installation, AutoPilot Installer produces a report describing events that occurred during the installation.
Emulex Drivers for Windows User Guide echo AutoPilot reported an error upgrading Server 2. if not errorlevel 2147483650 goto unsupported echo Configuration file missing. goto server2ok :unsupported if not errorlevel 2147483649 goto older echo Unsupported operating system detected. :older2 if not errorlevel 2001 goto none2 echo The driver found is the same or older than the existing driver. goto server2ok :none2 if not errorlevel 1248 goto noreport2 echo No adapter found.
Emulex Drivers for Windows User Guide Appendix C: License Notices C.1 Secure Hash Algorithm (SHA-1) Notice /* * Written by Aaron D. Gifford * * Copyright 1998, 2000 Aaron D. Gifford. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer.
