Cross Reference: /test/stcnv/usr/src/suites/storage/fwflash/README

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README	1.1	09/02/23 SMI"
#

DESCRIPTION
===========
This is a test suite for fwflash(1m) utility.

PREREQUISITES
============
1. fwflash(1) utility on Solaris or OpenSolaris.
2. The test harness package SUNWstc-tetlite is required to be installed.
You can find the package on OpenSolaris Test Consolidation:
http://www.opensolaris.org/os/community/testing/testsuites/ctifortet/
3. At least one InfiniBand (IB) device or SCSI Enclosure Services (ses or sgen)
devices was connected to test host.

CTI-TET PACKAGE INSTALLATION
===========================
To install CTI-TET, obtain the SUNWstc-tetlite package and, as root,
do the following:
	# pkgadd -d <package_location>  SUNWstc-tetlite
where <package_location> is the path containing the SUNWstc-tetlite
package directory.

TEST SUITE INSTALLATION
=======================
In the majority of cases, the test suite can be installed from packages.
The package is called SUNWstc-storage-fwflash and it installs into "/opt"
by default.  Alternatively, you may choose to download the test suite
source and build the binaries in the source tree.  Both methods are
equally acceptable.

I.  Using the test suite package

Test suite package installation and uninstallation must be done as root.
Follow these steps:

1.  Obtain the SUNWstc-storage-fwflash package
2.  Use the pkgadd(1M) command to install it:

	root# pkgadd -d <package_location> SUNWstc-storage-fwflash

where <package_location> is the path to the test suite package
directory.

o It is recommended that the test suite package be installed from
  scratch, rather than on top of an existing installation.  Thus,
  if a version of SUNWstc-storage-fwflash is already installed, first
  remove it:

	# pkgrm SUNWstc-storage-fwflash


II. Using the source code of this test suite

Test suite source code compilation does not need to be done as root.
Follow these steps:

1. Obtain the fwflash source code.
2. Set up your environment and invoke 'make'

$ export CTI_ROOT=/opt/SUNWstc-tetlite/contrib/ctitools
$ export PATH=$CTI_ROOT/bin:$PATH
$ /usr/ccs/bin/make

The build can also install binaries into a proto directory below the
workspace root.  The workspace root is the directory under which the
usr/src directory resides (in the example above, the workspace root
is "/export/STC").  To install binaries into the proto area, do:

user$ /usr/ccs/bin/make install

In addition, test suite binary packages can be constructed using the
contents of the proto directory.  To build test suite packages, do:

user$ /usr/ccs/bin/make package

This can be done instead of, or in addition to, 'make install'.  The
package thus constructed will be placed in the 'packages' directory
under the workspace root. And you can install the package from 'packages'
directory.

TEST SUITE CONFIGURATION
========================
Test suite configuration is required to be done as root.

I.  Using fwflash package.

Set the following environment variables:

	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin

II. Using fwflash source code.

Set the following environment variables:

	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin

2. To configure the test suite

Assume the flashable device is /devices/pci@0,0/pci8086,25e3/pci1000,30a0@0/
ses@74,0:0 and the firmware is /export/fwimage.sw, then user can run following
command to configure the test suite firstly.

# run_test -v FWIMAGE=/export/fwimage.sw -v FWDEV1=/devices/pci@0,0/
pci8086,25e3/pci1000,30a0@0/ses@74,0:0 fwflash configure

Another variable that can be set in the configuration line:

debug		- [ TRUE || FALSE ] default FALSE

Following is an example to enable debug:
# run_test -v FWIMAGE=/export/fwimage.sw -v FWDEV1=/devices/pci@0,0/
pci8086,25e3/pci1000,30a0@0/ses@74,0:0 -v debug=TRUE fwflash configure

TEST SUITE EXECUTION
====================
The test suite must be executed as root.

If not already available from the configuration phase, set the
required environment variables:

I.  Using fwflash package:
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin

II. Using fwflash source code:
	export CTI_ROOT=$TET_ROOT/contrib/ctitools
	export PATH=$PATH:$CTI_ROOT/bin

To run all fwflash regression tests, do the following:
	root# run_test fwflash
	(this will run all test purposes of the list and operate
	cases)

To execute individual scenarios (list,operate):
	root# run_test fwflash <scenario>
For example:
	root# run_test fwflash operate

To execute a Test Purpose within a scenario operate:
	root# run_test fwflash operate:<test purpose number>
For example:
	root# run_test fwflash operate:1

NOTE: You can define customized test scenarios by adding entries to
the test scenario file: $CTI_SUITE/tet_scen.

For how to edit the test scenario file, refer to the TET user guide at:
	http://tetworks.opengroup.org/tet/

TEST SUITE UNCONFIGURATION
==========================

# run_test fwflash unconfigure