fcmsutil(1M)fcmsutil(1M)NAMEfcmsutil - Fibre Channel Mass Storage Utility Command for Fibre Channel
Host Bus Adapters
SYNOPSIS
device_file [options]
The device_file specifies the Fibre Channel device special file associ‐
ated with the Fibre Channel HBA port.
The device file has the format /FC_driverX, where X is the instance
number of the Fibre Channel HBA port, as reported by the output.
The [options] that follow the device file are the ones listed in the
display usage for each type of Fibre Channel driver. The usage of can
be seen by running the command alone. Options listed under the usage
for different HBAs are supported for that HBA.
In case an invalid device file is specified, that is, if the device
file does not belong to the fc class, the command will return an error
and display the usage options of
Note: For all options that take remote-N-Port-ID as an argument,
remote-N-Port-ID can be replaced with (in Private Loop), or wwn.
SECURITY RESTRICTIONS
The usage of command is restricted to processes having super user priv‐
ileges. Some of the options require detailed knowledge of the device
specific adapter. See privileges(5) for more information about privi‐
leged access on systems that support fine-grained privileges.
DESCRIPTION
For a list of all supported Fibre Channel HBAs, please refer to the HP-
UX Fibre Channel Driver Release Notes for your hardware product.
The command is a common diagnostic tool used for all Fibre Channel Host
Bus Adapters supported on HP-UX. This command provides the ability to
perform Fibre Channel Test and Echo functionality, read the card's reg‐
isters, and so on. This command requires the use of a device file to
indicate the interface over which the requested command needs to be
performed.
Options
options are described below. Some options are HBA-specific and, there‐
fore, are not supported by all Fibre Channel HBAs.
The list of options supported by each HBA may be obtained by running
without specifying any arguments.
All keywords are case-insensitive and are position dependent.
device_file Can be used alone or with other options.
When used without any options it provides information
such as the N_Port ID, Node World Wide Name and Port
World Wide Name of the HBA and the switch (when applica‐
ble), Topology, the negotiated Link Speed, Vendor ID,
Device ID, the Driver State, Hardware Path, Maximum
Frame Size, and Driver Version.
As per the FC protocol, Node WWN will be numerically one
more than the Port WWN.
The following topologies are defined:
There is no connectivity to the host bus adapter port or
the
topology could not be determined.
The Fibre Channel driver has returned a topology code
that the utility
does not understand.
The host bus adapter is attached to a loop/loopback
hood.
The host adapter is attached to a loop connected to a
Fibre Channel switch.
The host bus adapter has come up in a point to point
topology.
This topology can be an error if the card was
expected to come up in loop topology. Not legal
in most cases.
The host bus adapter has come up in a point to point
topology when connected
through a Fibre Channel switch. This topology
can be an error if the card was expected to come
up in loop topology.
The following driver states are defined:
The host bus adapter is in the loop back test phase.
The host bus adapter is not participating on the loop.
This state is the result of user disabling the
card through the disable option in or the Fibre
Channel driver being unable to recover from an
error.
The driver is up and functional.
The host bus adapter is being reset.
The driver has been suspended by the user.
The driver is waiting for the Fibre Channel link to come
up.
There is no connectivity to the HBA port.
All other states are only transient and should not con‐
tinue for long. If the transient state persists, there
might be a problem in the hardware connectivity or con‐
figuration.
The following link speeds are defined:
The host bus adapter could not converge to a common link
speed or adapter
is not connected.
The link is online and the operating speed is 1 gigabits
per second.
The link is online and the operating speed is 2 gigabits
per second.
The link is online and the operating speed is 4 gigabits
per second.
The link is online and the operating speed is 8 gigabits
per second.
The following Fibre Channel controller port types are
defined:
The HBA port is a Physical FC controller port.
The HBA port is a Virtual FC controller port.
This option is used to display "Vital Product Data" information of the
HBA.
It includes information such as the product description,
part number, engineering date code, part serial number,
and so on. This option is not supported by the TACHYON
TL HBAs.
This option is used to send an ECHO ELS frame on the wire.
It requires two parameters, the remote-N-Port-ID and
data-size (size of packet to send). An optional third
argument (count) can be specified for the number of echo
packets to be sent. If the count option is not speci‐
fied, one packet will be sent.
Fibre Channel Echo packets of the specified size are
sent to the remote node. The command completes success‐
fully when an echo response is received from the remote
node and matches the data sent, for all packets sent.
The command times out if a response is not received in
twice RA_TOV time. Echo packets cannot be sent in a
PUBLIC_LOOP topology.
Note: Packet size specified must be a multiple of 4.
This option is used to send an RLS (Request Link Status) ELS frame on
the wire.
It requires one parameter, the remote-N-Port-ID. The
ELS is sent to this remote-N-Port-ID and the response
data is displayed.
This option is used to send a TEST ELS on the wire.
It requires two parameters, the remote-N-Port-ID and
data-size (size of packet to send). An optional third
argument (count) can be specified for the number of echo
packets to be sent. If the count option is not speci‐
fied, one packet will be sent.
The command completes successfully and immediately on
sending all the test packets.
Note: Packet size specified must be a multiple of 4.
This option is used to read from HBA's internal registers.
It requires one parameter, the offset of the register to
read from. The offset can be specified in either hex or
in decimal format. The offset specified is an offset
from the base of the Memory Map. The user of this com‐
mand is therefore expected to have internal knowledge of
the chip. Reading from the TACHYON frame manager status
register (0x01c8) is restricted.
An optional second argument can be specified for Fibre
Channel HBAs, to read from the PCI config space. If no
second argument is specified, it reads from the chip
register space.
This option is used to write into HBA's regis‐
ters.
It requires two parameters, the offset of the register
to write to and the value to be written.
An optional third argument can be specified for the
Fibre Channel HBAs, to write into the PCI config space.
If no third argument is specified, it writes into the
chip register space.
This option is used to perform loopback tests on the port.
Warning: This is a DESTRUCTIVE test, and DATA LOSS dur‐
ing the execution of this test may occur.
The option can be used to suppress the warning message
displayed by the Fibre Channel driver utility.
For TL and XL2 HBAs, this option requires one parameter
and an optional count:
} [count]
Here refers to physical link module or gigabit link mod‐
ule, which builds the default payload for the loopback
frame. If either or is used, then the card builds spe‐
cific payloads based on the recommendations in These
patterns are designed to generate bit patterns which
stress the transmit and receive channels of the card.
The self test then involves sending a packet and receiv‐
ing back the packet within the adapter and checking its
integrity. Since this self test is at the adapter
level, no packet goes on the fibre link.
All Fibre Channel HBAs (except TL and XL2) need to spec‐
ify two parameters. Here is the syntax:
[count]
The first parameter should be either or to specify
whether the loopback should be external or internal,
respectively. The second parameter specifies the loop‐
back pattern. Only and options are supported for these
cards. Frames are looped back at the single bit inter‐
face in the Internal loopback mode. For external loop‐
back, frames are sent out and received from the wire.
External loopback mode is supported only in Loop topol‐
ogy.
NOTE: In the internal loopback mode, frames are also
sent out on the wire even though they are internally
looped back at the 1 Bit interface. The receiver, how‐
ever, is turned off during this operation. Therefore,
it is not safe to run Internal loopback tests when the
fiber is connected to a Switch or Hub, as the transmit‐
ted loopback frames can disrupt operation on the SAN.
An optional third argument (count) can be specified for
the number of loopback packets to be sent. If the count
option is not specified, one packet will be sent.
This option is used to obtain Fibre
Channel login parameters of either
the
port, the port, or a port. The Fibre
Channel HBAs do not support the option.
If the argument is specified for the
option, login parameters and current
states of all N_Ports that the initiator
is aware of, are displayed.
This option is used to reset the HBA (or a single FC port
in case of
multi-port HBAs).
WARNING: This is a DESTRUCTIVE test. The
reset operation will result in aborting
communication to all nodes till the
process is completed.
The option can be used to suppress the
warning message displayed by the Fibre
Channel driver utility.
NOTE: This option is only supported by
Physical FC (PFC) ports.
This option is used to issue a Bus
Device Reset to device.
WARNING: This is a DESTRUCTIVE test.
The option can be used to suppress the
warning message displayed by the Fibre
Channel driver utility.
This option resets the target, clearing
all commands, without doing any checks.
This option can be used to read all of the readable reg‐
isters on the card and
format the detailed information.
This option is used to obtain detailed statistics main‐
tained by the driver.
An optional argument can be specified to
obtain a shortened version of the statis‐
tics maintained by the driver. Generally,
the link statistics for the HBA port is
displayed.
This option is used to clear the statistics maintained by
the driver.
This option is used to obtain detailed nameserver statis‐
tics maintained by the
driver.
This option is used to clear the nameserver statistics
maintained by the
driver.
This option is used to display the contents of FlexFC
NVRAM table on the
adapter.
This option is used to obtain detailed statistics associ‐
ated with each
N_Port that this N_Port has communicated
with.
If the remote-N-Port-ID is specified, then
the statistics associated with that N_Port
are displayed. If the option is speci‐
fied, statistics associated with all
N_Ports that the initiator has been able
to communicate with are displayed. Along
with the statistics for each N_Port, it
also displays the loop_id (in Private
Loop) and the nport_id (in Fabric).
This option is used to clear the statistics associated
with a target.
If the remote-N-Port-ID is specified, then
the statistics associated with that N_Port
are cleared. If the option is specified,
statistics associated with all valid
N_Port_IDs are cleared.
OBSOLETED. Starting with HP-UX 11i Version 3, this
option is no longer supported.
On releases prior to HP-UX 11i Version 3,
the Fibre Channel Tachyon TL, Tachyon TL2
and FCD drivers implemented an authentica‐
tion mechanism to protect against acciden‐
tal data corruption in case of the
replacement of devices. This mechanism
prevented I/O transfer when the target
port Worldwide name (WWN) changed for the
same remote N-Port-Id. The option was
used to validate replacement of the disk
by associating the new WWN with the remote
N-Port-Id. Starting with HP-UX 11i Ver‐
sion 3, this authentication mechanism has
been replaced by an enhanced mechanism
based on the LUN Worldwide Identifier
(WWID). Instead of the command, use the
commands, and to validate the replacement
of devices. See the scsimgr(1M) manpage
for more information.
This option is used to disable the card.
WARNING: This is a DESTRUCTIVE test and
communication to all nodes will be termi‐
nated.
The option can be used to suppress the
warning message displayed by the Fibre
Channel driver utility.
This option is typically used when a hard‐
ware problem cannot be resolved and is
interfering with system performance.
NOTE: This option is only supported by
Physical FC (PFC) ports.
This option is used to enable the card, typically when a
previous
hardware problem has been resolved.
NOTE: This option is only supported by
Physical FC (PFC) ports.
This option is used to query the name server and get the
list of nports
for the Fibre Channel driver.
The option is used to get the list of
nports cached in the driver query buffer.
The name server will not be queried in
this case.
This option is used to force the driver and firmware to
dump their current
state information and other data struc‐
tures.
WARNING: This is a DESTRUCTIVE operation.
This might result in failure of current
I/O requests.
The option can be used to suppress the
warning message displayed by the Fibre
Channel driver utility.
The dump data will be saved in the direc‐
tory. The firmware dump will be stored in
a file named FC-driverand the driver dump
will be saved in a file named FC-driver
This option is used to retrieve firmware and driver dump
saved
in the driver memory. The driver initi‐
ates a dump when an internal error is
encountered. Internal errors could be
either due to firmware hang or to an
irrecoverable error in the firmware or
hardware. The dump files will be saved in
the directory. The firmware dump will be
stored in a file named FC-driverand the
driver dump will be saved in a file named
FC-driverThese dumps should be sent to HP
for further analysis of the problem.
NOTE: The driver does not save any new
dumps, until the previously saved dump is
retrieved with this option. The avail‐
ability of a saved dump can be checked by
running device_file.
This option is used to display the contents of NVRAM on
the adapter.
This option is used to update the ROM firmware stored in
card's FLASH ROM.
WARNING: This is a DESTRUCTIVE operation.
Using this option may result in failure of
current I/O requests.
This option requires the name of a binary
image file that contains the updated
firmware. This operation should only be
performed by qualified personnel. Failure
to successfully complete the firmware
update may result in adapter and/or system
failure in case the boot disks are
accessed through this card.
This option is used to update the EFI driver stored in
card's FLASH ROM.
WARNING: This is a DESTRUCTIVE operation.
Using this option may result in failure of
current IO requests.
This option requires the name of a binary
image file that contains the EFI driver.
This operation should only be performed by
qualified personnel. Failure to success‐
fully complete the EFI driver update may
result in adapter and/or system boot up
failure if the boot disks are accessed
through this card.
This option is used to set the interrupt delay mode and
value,
or to turn off interrupt delay. Settings
made using this option are not persistent
across reboots.
WARNING: This is a DESTRUCTIVE operation
and will abort communication to all target
devices until the process is completed.
The complete syntax for this command is:
value}
The option can be used to suppress the
warning message.
The option turns off interrupt delay.
The interrupt delay mode, also known as
Zero Interrupt Operation (ZIO) mode, is
set using the option. There are two
interrupt delay modes available: 5 and 6.
Mode 5 delays every interrupt by the
interrupt delay period. Mode 6 delays an
interrupt unless there are no active I/Os
in the HBA port, in which case the inter‐
rupt is generated immediately. If the
option is not specified, then mode 6 is
used by default. The interrupt delay
period is calculated from the interrupt
delay value using the formula:
value * 200 microseconds
This option displays the current interrupt delay settings
for the HBA port.
This option is used to display diagnostics information
from the card's
optical transceiver. It includes informa‐
tion from the SFF-8472 specification such
as cable lengths, current temperature,
voltage, transmit and receive power, TX
bias, as well as other data.
NOTE: This option is only supported by
4Gb/s capable Fibre Channel cards.
This option is used to display available N_Port ID Virtu‐
alization information
for the Physical FC (PFC) port. For Phys‐
ical FC (PFC) port, this option displays
all associated VFC(s) device ports.
NOTE: This option is only supported by
QLogic Fibre Channel cards.
EXAMPLES
Print the remote port parameters using the option if the
driver is idle. In this example, is the device file and
is the respective raw disk file.
Print a short listing of the statistics maintained by the
driver, with as the device file.
Send 5 echo packets of 200 bytes each to a remote N_Port
with loop_id 4, with as the device file.
Print a short listing of the statistics of the device
whose remote-N-Port-ID is 0x02ae4 and with as the device
file.
Clear the device statistics of the device whose wwn is
0x100000e002219f45 and with as the device file.
Perform a Internal loopback test, sending 1000 packets
with as the device file.
Display diagnostics information from the HBA's optical
transceiver with as the device file.
Display available N_Port ID Virtualization information
for the HBA port with as the device file.
SEE ALSOioscan(1M), privileges(5).
AUTHOR
was developed by HP.
fcmsutil(1M)
