5-21-03 File efiutil.txt
Using the Qlogic Utility
Table of Contents
Title
Revision History
Introduction
Batch Mode
Default file names
Parameters
/i
/a
/e
/h
/n
CLI Mode
Starting Efiutil
CLI Commands
Adapter info - a
Compare - c
Directory - d
Help - h
Image download - i
Upload image - u
adapter Number - n
Remove image - r
Quit - q
write nvram - x
read nvram - y
verify nvram - z
Revision History
Date Rev Reason By Comments
3-21-03 1.0 Initial T. Leonard
4-03-03 1.1 Added batch mode commands T. Leonard
4-14-03 1.2 Added nvram support T. Leonard
4-21-03 1.3 Fixed nvram option letters T. Leonard
5-21=03 1.4 Remove references to RISC, VPD T. Leonard
Add /i option
Add /d option
Change qlcflash.efi to qlaux.drv
Introduction
The Qlogic efiutil Utility is used to access and modify the contents of the
flash ROM on a Qlogic Host Bus Adapter. This utility is an EFI application that
is run from the EFI shell. It consists of the program efiutil.efi and an auxiliary
driver, qlaux.drv. The auxiliary driver is used if efiutil.efi is unable to
detect a Qlogic EFI driver capable of supporting the flash ROM protocol.
The utility may be run in batch mode or in interactive mode (CLI mode).
The mode of operation is determined by the number of parameters entered on the command line used to start efiutil.efi. If no parameters are entered, then efiutil.efi starts in CLI mode. Otherwise, it starts in Batch mode.
Batch Mode
A number of parameters may be specified on the command line when efiutil.efi is started.
The command format is:
efiutil /i /a /e /n /h /d
Each parameter is preceded by a slash, /, and consists of a single letter.
All parameters except a are commands. Associated with each command is a subcommand.
A subcommand is specified by a single letter following the command. For example,
the command to write a driver image to flash image is /ew. The /e is the command to
access an efi driver image. The w sub command is a write to flash.
In addition, some commands allow the specification of a file name.
Filenames are indicated by an equal sign followed by the filename. For example,
the command to read a RISC image and store is in the file abc.bin is /rr=abc.bin.
Please note that no spaces are allowed in any portion of the command.
Default file names
Commands that accept filenames have a default name assigned to them. The current defaults are:
ql23efi.bin - efi driver for ISP2300
ql2312ef.bin - efi driver for ISP2312
nvram23.def - nvram definition file for ISP2300 / ISP2312
nvram23.dat - nvram data file for ISP2300 / ISP2312
efiutil.efi determines the correct default file name using the command and the type of
adapter currently selected.
For batch mode, nvram definition file is determined in the following manner. If the /d
option is not found on the command line, then the .def file name is extracted from the
nvram data file name. The nvram data filename string is truncated at the first period
found. The suffix .def is appended to this string.
For CLI mode, the program prompts for a .def filename.
Parameters
In the following section, optional parameters are enclosed in [].
Portions of a parameter for which a selection from a set must be made are enclosed in {}.
/a
The a parameter is required for all commands. It specifies the adapter or adapters to
which this command is to be applied.
The format of the command is
/a[=AN]
where AN is the optional adapter number. If no adapter number is specified, then
all adapters in the command line is to be performed on all Qlogic adapters in the computer.
Examples:
efiutil /a
- perform the command on all adapters
efiutil /a=0
- perform the command on adapter 0
/d
The optional d parameter specifies the nvram definition file name. If the d parameter
is not specified, the utility creates the .def file from the data filename specified
by the /n option as defined in the default filenames section above.
The format of the command is
/d=FN
where FN is the filename.
Examples:
efiutil /a /nw /d=afile.def
- perform the command on all adapters
efiutil /a=0 /nr=nvram.sav /d=nvram23.def
- perform the command on adapter 0
/e
The e parameter is used to access EFI driver images in flash.
One of three possible operations may be performed on the EFI driver
image: read, write, or verify. Additionally, the default filename may be
overridden by specifying a filename. Note that overriding the default filename
causes it to be applied to the adapter or adapters selected by the /a options,
regardless of the adapter type.
The format of the parameter is:
/e{rwv}[=FN]
Examples
efiutil /a /ew
- write a new EFI driver image using the default filename to all
adapters in the computer.
efiutil /a=0 /er=abc.bin
- read the EFI driver image in adapter 0 and save it to file abc.bin
efiutil /a=1 /ev=abc.bin
- verify that the EFI driver image in adapter 1 matches the image in file
abc.bin
/h
The h parameter returns the list of command line parameter list along
with a list of Qlogic adapters found in the system. This switch overrides
all other switches on the command line. Use it to obtain information on
the adapters available in your system.
Example:
efiutil /h
/i
The i parameter is used to override the checking of the SSID during adapter
enumeration. The parameter MUST be the first parameter after the program name.
It may be used with either batch or interactive mode, however it is strongly
recommended that this option be used only in interactive mode.
Example:
efiutil /i – enumerate all Qlogic Fibre Channel adapters in the system
and enter interactive mode.
efiutil /i /a=1 nw=nvram2312.dat – enumerate all Qlogic Fibre Channel
adapters in the system, program the
nvram on the second adapter using the files
nvram2312.dat and nvram2312.def.
If a system contains of mixture of detected and undetected adapters, any existing
EFI drivers loaded by EFI should be unloaded using the EFI Shell “drivers”, “dh”,
and “unload” commands. After this is completed, run efiutil /i to start the utility.
This procedure ensures that the default utility driver, qlaux.drv, will load and
detect all adapters correctly.
/n
The n parameter is used to access HBA Nvram. One of three possible operations
may be performed on the HBA Nvram: read, write, or verify. Additionally, the
default filename may be overridden by specifying a filename. Note that
overriding the default filename causes it to be applied to the adapter or
adapters selected by the /a options, regardless of the adapter type.
The format of the parameter is:
/n{rwv}[=FN]
Examples
efiutil /a /nw
- write Nvram using the default filename to all
adapters in the computer.
efiutil /a=0 /nr=abc.bin
- read the HBA Nvram in adapter 0 and save it to file abc.bin
efiutil /a=1 /nv=abc.bin
- verify that the Nvram in adapter 1 matches the image in file
abc.bin
/v
The v parameter is used to access VPD images in flash. One of three possible
operations may be performed on the VPD image: read, write, or verify. Additionally,
the default filename may be overridden by specifying a filename. Note that
overriding the default filename causes it to be applied to the adapter or adapters
selected by the /a options, regardless of the adapter type.
The format of the parameter is:
/v{rwv}[=FN]
Examples
efiutil /a /vw
- write a new VPD image using the default filename to all adapters.
efiutil /a=0 /vr=abc.bin
- read the VPD image in adapter 0 and save it to file abc.bin
efiutil /a=1 /vv=abc.bin
- verify that the VPD image in flash matches the image in file
abc.bin
Note verifying the VPD image with a file will only be successful if there are
no other images in flash. When other images are written to flash ROM, the VPD
image may also be modified as part of this process.
CLI Mode
Starting efiutil
The efiutil utility is started by entering the command:
efiutil
at the EFI shell prompt. The program loads and presents the prompt:
EfiUtil>
to the user. At any time, the menu of available command may be displayed
by simply typing h followed by a Return.
CLI Commands
The menu of available commands is:
a - Adapter info
c - Compare image with file
d - Directory
h - help
i - Image download
u - Upload image
n - adapter Number
r - remove image
q - quit
w - Write Nvram
x - Read Nvram
y - Verify Nvram
Adapter info - a
This command displays the number of adapters found in the system. In addition,
it displays the adapter number and it corresponding EFI path name.
Compare - c
This command is used to compare a ROM image to a file for verification purposes.
The command prompts for a ROM image number and a file name.
Directory - d
This command displays a list of images in the flash ROM. The list consists
of the Image number, flash ROM address, image size and image type. Drivers have
type 2300, 2312, etc. RISC firmware for ISP23xx hardware has type 03.
VPD data has type 01.
Help - h
This command displays a list of the available commands
Image download - i
Download and flash the image with the file name specified by the Filename command.
The image must reside in the same directory as the efiutil utility.
Upload image - u
Upload an image from flash Rom to a file.
adapter Number - n
Use this command to open an adapter for flash ROM and Nvram access. Changing
the adapter number closes the current adapter and opens the new one. This may take
some time depending on the number and type of devices attached to the HBA.
Remove image - r
This command deletes an image from the flash ROM. The command prompts for
the image to remove.
Quit - q
This command exits efiutil and returns to the EFI shell. It closes the current
adapter and performs an EFI disconnect / connect sequence to restart the adapter
and reconnect the drives to EFI.
write nvram - w
This command writes the Nvram on a selected HBA. The command prompts for a
filename containing the data to be written to the adapter. The file must be
the standard Qlogic Ascii .def.
read nvram - x
This command reads the Nvram on a selected HBA. The command prompts for a
filename to receive the data. The format of the file is the standard Qlogic
Ascii .def.
verify nvram - y
This command compares the contents of the Nvram on a selected HBA with that a
file. The command prompts for a filename. The format of the file is the
standard Qlogic Ascii .def.
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.