Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP-UX Reference > f

fcmsutil(1M)

HP-UX 11i Version 1.6: June 2002
» 

Technical documentation

» Feedback
Content starts here

 » Table of Contents

 » Index

NAME

fcmsutil — Fibre Channel Mass Storage Utility Command for the TACHYON TL A5158A and TACHYON XL2 A6795A Fibre Channel Host Bus Adapters.

SYNOPSIS

/opt/fcms/bin/fcmsutil device_file

/opt/fcms/bin/fcmsutil device_file vpd

/opt/fcms/bin/fcmsutil device_file echo remote-N-Port-ID [data-size] [count]

/opt/fcms/bin/fcmsutil device_file rls remote-N-Port-ID

/opt/fcms/bin/fcmsutil device_file test remote-N-Port-ID [data-size] [count]

/opt/fcms/bin/fcmsutil device_file read offset [pci]

/opt/fcms/bin/fcmsutil device_file write offset value [pci]

/opt/fcms/bin/fcmsutil device_file [-f] lb [plm|crpat|cjtpat ]

/opt/fcms/bin/fcmsutil device_file get local|fabric

/opt/fcms/bin/fcmsutil device_file get remote {all|remote-N-Port-ID}

/opt/fcms/bin/fcmsutil device_file get_lgn N-Port-ID

/opt/fcms/bin/fcmsutil device_file reset

/opt/fcms/bin/fcmsutil device_file [-f] bdr target-device_file

/opt/fcms/bin/fcmsutil device_file read_cr

/opt/fcms/bin/fcmsutil device_file stat [-s]

/opt/fcms/bin/fcmsutil device_file clear_stat

/opt/fcms/bin/fcmsutil device_file nsstat

/opt/fcms/bin/fcmsutil device_file clear_nsstat

/opt/fcms/bin/fcmsutil device_file devstat {all|remote-N-Port-ID}

/opt/fcms/bin/fcmsutil device_file clear_devstat {all|remote-N-Port-ID}

/opt/fcms/bin/fcmsutil device_file replace_dsk remote-N-Port-ID

/opt/fcms/bin/fcmsutil device_file [-f] disable

/opt/fcms/bin/fcmsutil device_file enable

/opt/fcms/bin/fcmsutil device_file [-k] ns_query_ports

Note: The remote-N-port-ID can be substituted with -l loop_id (in Private Loop), or -w wwn for all options that take remote-N-port-ID as an argument. The devstat all option displays the loop_id (in Private Loop) and the nport_id (in Fabric) along with the statistics for all N_Ports the initiator was able to communicate with.

DESCRIPTION

The fcmsutil command is a diagnostic tool to be used for the TACHYON TL A5158A and TACHYON XL2 A6795A Fibre Channel Host Bus Adapters. This command provides the ability to perform Fibre Channel Test and Echo functionality, read the card's registers, etc. This command requires the use of a device file to indicate the interface over which the requested command needs to be performed.

The options that are available only for the TACHYON XL2 A6795A are indicated by a "XL" in the description for the option.

All other options (which do not have the "XL" indication) are supported by both HBAs. fcmsutil can be used only by users who have an effective user ID of 0. Some of the options require detailed knowledge of the device specific adapter.

Options

fcmsutil recognizes the following options as indicated in SYNOPSIS. 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, Topology, Vendor ID,the Chip Revision Number, Device ID, the Driver State, Hardware path, number of Assisted IOs and number of Active Logins, Presence of Dino bus bridge, Maximum frame size and Driver version. As per the FC protocol, Node WWN will be numerically one more than the Port WWN. For TACHYON XL2 card (A6795A), in addition to the above, Negotiated Link Speed is also indicated.

The following topologies are defined:

UNKNOWN. The host bus adapter is not attached to a loop/loopback hood or has connection problems and could not come up in a valid topology.

PRIVATE_LOOP. The host bus adapter is attached to a loop/loopback hood.

PUBLIC_LOOP. Supported by TACHYON TL and TACHYON XL2 cards. The host adapter is attached to a loop connected to a Fibre Channel switch.

PTTOPT_FABRIC. 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. Not legal in most cases.

The following are the driver states:

LOOPBACK_STATE. The host bus adapter is in the loop back test phase.

OFFLINE. The host bus adapter is not participating on the loop.

ONLINE. The driver is up and functional.

RESETTING. The host bus adapter is being reset.

All other states are only "transient" and should not continue for long. If the "transient" state persists, there might be a problem in the hardware connectivity or configuration.

.IP

The following link speeds are defined:

UNINITIALIZED. The host bus adapter not could converge to a common link speed or adapter is not connected.

1Gb. The link is online and the operating speed is 1 Gigabytes.

2Gb. The link is online and the operating speed is 2 Gigabytes.

vpd (XL)

This option gives the "Vital Product Data" of the HBA. The vpd option provides information such as the Product description, Part number, Engineering Date Code, Part serial number, etc. This option is supported only by TACHYON XL2 A6795A cards.

echo

This option 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 specified, one packet will be sent.

Fibre Channel Echo packet(s) of the specified size is sent to the remote node. The command completes successfully 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.

rls

This option requires one parameter, the remote-N-Port-ID. A Fibre Channel Request Link Status (RLS) ELS is sent to the remote-N-Port-ID and the response data is displayed.

test

This option 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 specified, one packet will be sent.

A Fibre Channel Test packet of the specified size is sent to the remote node. The command completes successfully and immediately on sending all the test packets.

Note: Packet size specified must be a multiple of 4.

read

This option 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 command 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 (pci) can be specified, to read from the PCI config space. If no second argument is specified, it reads from the chip register space.

write

This option requires two parameters, the offset of the register to write to and the value to be written.

An optional third argument (pci) can be specified to write into the PCI config space. If no third argument is specified, it writes into the chip register space.

lb

WARNING: This is a DESTRUCTIVE test, and DATA LOSS can occur during execution of this test.

-f lb

The -f option can be used to suppress the warning message.

This option requires one parameter, plm, crpat, or cjtpat.

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 command performs an external loopback test when one of the plm, crpat, and cjtpat options is specified. The fibre channel chip is programmed into external loopback mode. Here plm refers to physical link module or gigabit link module, which builds the default payload for the loopback frame. If the crpat or the cjtpat option is used, then the card builds specific payloads based on the recommendations in "Fibre Channel - Methodologies for Jitter Specifications." 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 receiving 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.

get

The get option is used to obtain Fibre Channel login parameters of either the local port, the fabric port or of a remote port. TACHYON TL and TACHYON XL2 cards do not support the local option. If the all argument is specified for the remote option, login parameters and current states of all N_ports that the initiator is aware of, are displayed.

reset

WARNING: This is a DESTRUCTIVE test. This option resets the fibre channel card. This is a destructive test and communication to all nodes will be terminated till the reset process is completed. This option only results in a soft reset for the TACHYON TL and TACHYON XL2 cards and does not result in termination of communication.

bdr

WARNING: This is a DESTRUCTIVE test.

-f bdr

The -f option can be used to suppress the warning message displayed.

This option resets the target, clearing all commands, without doing any checks.

read_cr

This option can be used to read all of the readable registers on the card and format the detailed information.

stat

This option is used to obtain detailed statistics maintained by the driver. An optional argument (-s) can be specified, to obtain a shortened version of the statistics maintained by the driver.

clear_stat

This option is used to clear the statistics maintained by the driver.

nsstat

This option is used to obtain detailed nameserver statistics maintained by the driver.

clear_nsstat

This option is used to clear the nameserver statistics maintained by the driver.

devstat

The devstat option is used to obtain detailed statistics associated 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 all option is specified, statistics associated with all N_ports that the initiator has been able to communicate with, are displayed.

clear_devstat

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 all option is specified, statistics associated with all valid N_Port_IDs are cleared.

replace_dsk

This option is used to specify that no authentication should be performed the next time we communicate with the device. This option is to be used by system administrators for replacing a disk, with another (with the same N_Port_ID). Note that this is not required, if the new disk acquires a new N_Port_ID.

disable

WARNING: This is a DESTRUCTIVE test and communication to all nodes will be terminated.

-f disable

The -f option can be used to suppress the warning message displayed.

This option is used to disable a card, typically because of a hardware problem which cannot be resolved and is interfering with system performance.

enable

This option is used to enable a card, typically when a previous hardware problem has been resolved.

ns_query_ports

This option is used to query the name server and get the list of nports. -k option can be used to get the list of nports cached by the driver.

EXAMPLES

Print the remote port parameters using the get remote option if the driver is idle. /dev/fcms1 is the device file and /dev/rdsk/c27t0d0 is the respective raw disk file.

fcmsutil /dev/fcms1 get remote 0x98 < /dev/rdsk/c27t0d0

Print a short listing of the statistics maintained by the driver, with /dev/td1 as the device file.

fcmsutil /dev/td1 stat -s

Send 5 echo packets of 200 bytes each to a remote N_Port with loop_id 4, with /dev/td1 as the device file

fcmsutil /dev/td1 echo -l 4 200 5

Print a short listing of the statistics of the device whose remote-N-Port-ID is 0x02ae4 and with /dev/td1 as the device file

fcmsutil /dev/td1 devstat 0x02ae4

Clear the device statistics of the device whose wwn is 0x100000e002219f45 and with /dev/td1 as the device file

fcmsutil /dev/td1 clear_devstat -w 0x100000e002219f45

AUTHOR

/opt/fcms/bin/fcmsutil was developed by HP.

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 1983-2002 Hewlett-Packard Development Company, L.P.