SCSI Compliance test

Article
09/14/2012

Note This content applies to the Windows Logo Kit (WLK). For the latest information using the new Windows Hardware Certification Kit (HCK), see Windows HCK User's Guide on the Windows Hardware Dev Center.

Type: Automated Test

Overview

The SCSI Compliance test verifies that a block storage device (RAID adapter or disk target) that is supported by the operating system fully complies with the SCSI standards described in the SCSI-3 Primary Commands-2 (SPC-2) or later, and SCSI Block Commands (SBC) or later specifications. To obtain these specifications, see the T10 Technical Committee Web site at T10 Technical Committee. Ensuring that the block device and the operating system maintain compliance with these standards makes for a more robust and reliable system. Although some block devices might not be using a SCSI transport, the operating system communicates with them using SCSI commands (the exception is individual ATA disk drives that are not part of a RAID set).

The test uses SCSI pass-through requests (IOCTL_SCSI_PASS_THROUGH) to construct and send SCSI command descriptor blocks (CDB) to the device. The test evaluates the results of the commands to verify compliance.

Note If you are running this test as a part of Storage RAID Hardware-based RAID (Storage Array) submission, and your storage array supports Multi-Path I/O (MPIO), you must configure your MPIO to use Fail-Over Only policy, and set the target storage disk to use the same active path for all MPIO'ed disks.

Note If you are running this test as a part of a Storage RAID Hardware-based RAID (Storage Array) submission, please make sure that LUN0 is configured as the largest size non-boot LUN.

Details

The SCSI Compliance test consists of several phases: setup, device enumeration, execution, and results reporting. The test operates in two modes:

A non-destructive test run against one or more devices.
A destructive (allows WRITE commands) test that targets one or more specified disks.

A number of tests are performed for each command to test compliance. The program stores the test results in a matrix, indicating the results for each command on each device. When the test is completed, a summary report of the results is generated. For debugging purposes, the level of output verbosity can be increased when the test is run interactively. It is designed to provide complete information for the submitter so that they can address command issues.

Functionality Testing

The test sends the following commands to the device. The test runs a variety of tests for each command descriptor block (CDB) to ensure full and complete compliance. Commands that are indicated as optional must still perform correctly if a vendor chooses to implement the command. Each command may have many subtests.

INQUIRY

REQUEST SENSE

MODE SENSE (6)

MODE SENSE (10) [Optional, except if MODE SENSE (6) can return > 255 bytes of information]

MODE SELECT (6) [Optional]

MODE SELECT (10) [Optional]

RESERVE (6) [prior to Vista only]

RELEASE (6) [prior to Vista only]

READ CAPACITY

LONGLBA Support [Optional]

READ (6) [Optional]

READ (10)

READ (16) [Optional]

WRITE (6) [Optional]

WRITE (10)

WRITE (10) with FUA bit

WRITE (16) [Optional]

WRITE (16) with FUA bit [Optional]

REPORT LUNS [required except for PCI RAID adapters]

PERSISTENT RESERVE IN / OUT

Robustness and Reliability Testing

To validate robustness and reliability, the test completes the following tasks:

Checks for valid return codes for each IOCTL_SCSI_PASS_THROUGH request.
Checks adherence to data buffer length.
If the buffer size is insufficient, the test verifies that the IOCTL returns with the correct required length.
Verifies that non-destructive tests do not change any system configuration or data.
Verifies that repeated calls return the same or similar data.

Run Time: 5 minutes*

Log File:

System Restart Required: No

Test Category:

Supported operating systems for Logo or Signature testing:

Windows Vista
Windows Server 2003
Windows XP

Program:

Requirements

Software Requirements

The test tool requires the following software:

Supported operating system (see list above)
Software components included with the device that is being tested
Microsoft Windows XP Professional with Service Pack 2 (SP2); Microsoft Windows Server 2003, Enterprise Edition; or Microsoft Windows Server 2003, Datacenter Edition
Any drivers that are not shipped with the Microsoft Windows operating system
The current release of the Microsoft Windows Driver Kit
The latest version of the Microsoft iSCSI software initiator. To download the iSCSI software initiator, search for "iSCSI software initiator" at the Microsoft Download Center. The latest version of the Microsoft iSNS server.To download the Microsoft iSNS server, search for "iSNS" at the Microsoft Download Center.

Hardware Requirements

The test tool requires the following hardware:

Device to be tested
Computer that meets the minimum software requirements
Windows keyboard
Two-button pointing device
Color display monitor capable of at least 1024 by 768 resolution, 32-bits per pixel, 60 Hz
Hard drive with a minimum of 20 GB available on partition C:
The system requires one or more SCSI, iSCSI, or Fibre Channel disks attached to the test system.
Microsoft Windows XP Professional with Service Pack 2 (SP2); Microsoft Windows Server 2003, Enterprise Edition; or Microsoft Windows Server 2003, Datacenter Edition. Any drivers that are not shipped with the Microsoft Windows operating system. The current release of the Microsoft Windows Driver Kit. The latest version of the Microsoft iSCSI software initiator. To download the iSCSI software initiator, search for "iSCSI software initiator" at the Microsoft Download Center. The latest version of the Microsoft iSNS server. To download the Microsoft iSNS server, search for "iSNS" at the Microsoft Download Center.

Processor

The test tool runs on the following processor architectures:

Running SCSI Compliance test

Run the test as a DTM job.

Command Syntax

Command option	Description
ScsiComplianceTest.exe -hct [PhysicalDeviceObjectLink] or Drive Letter	ScsiComplianceTest [-v [level]] [-full] [-hct][-iscsi] [-mi device] [device \| -alldevices]OptionDescription-v [level] Sets the logging verbosity level. Level can be specified as 0, 1, or 2. 0 = List assertions tested and results.1 = Show assertion details (default).2 = Show CDBs sent to device, data, and sense data returned.-fullSpecify that the destructive tests should also be run.-hctRun as part of an HCT test pass.-iscsiTest iSCSI compliance.-mi deviceRun the multi-initiator tests on the specified device, where the device points to the device under test by way of a second initiator.deviceThe device to test (for example: \\.\physicaldrive1, \\.\d:).-alldevicesTo test all devices.-?Show usage.

ScsiComplianceTest.exe -hct [PhysicalDeviceObjectLink] or Drive Letter

ScsiComplianceTest [-v [level]] [-full] [-hct][-iscsi] [-mi device] [device | -alldevices]OptionDescription-v [level] Sets the logging verbosity level. Level can be specified as 0, 1, or 2. 0 = List assertions tested and results.1 = Show assertion details (default).2 = Show CDBs sent to device, data, and sense data returned.-fullSpecify that the destructive tests should also be run.-hctRun as part of an HCT test pass.-iscsiTest iSCSI compliance.-mi deviceRun the multi-initiator tests on the specified device, where the device points to the device under test by way of a second initiator.deviceThe device to test (for example: \\.\physicaldrive1, \\.\d:).-alldevicesTo test all devices.-?Show usage.

Troubleshooting

The test writes the results to the log files Scsicompliance.log.xml and Scsicompliance.log.txt. Use the results to determine:

If a device is compliant with the SCSI specification.
The optional SCSI commands that are supported by a device.

To pass, the SCSI device must support every mandatory command and must be fully compliant with those commands. Each command has a different threshold for pass or fail, and the expectations are specified explicitly in the test and in the log file.

Optional commands are also tested. If a device supports the optional commands and the commands are found to be non-compliant, the test fails. If the device does not support optional commands, the test passes.

Reference Documentation

SPC-2 (SCSI Primary Commands - 2) Specification, Revision 20SPC-3 (SCSI Primary Commands - 3)SCSI Block Commands - 2 (SBC-2)SCSI Architecture Model - 3 (SAM-3)

Code Tour

File Manifest

File	Location
scsicompliancetest.exe	...\tests\%ARCHITECTURE%\nttest\driverstest\storage\wdk