Command Line Parameters for the Storage Device Block Driver API Test

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/27/2008

The Storage Device Block Driver Application Programming Interface (API) Test assesses the functionality of mass storage block drivers. It includes test cases that verify that a block driver is working correctly so that you can mount a file system on the disk.

The Storage Device Block Driver API Test runs the tux –o –d disktest command on default execution. With the default command line, the test runs on the first enumerated mass storage device that matches the BLOCK_DRIVER_GUID interface and supports the IOCTL_DISK_GETINFO I/O control code (IOCTL) or the DISK_IOCTL_GETINFO IOCTL.

Syntax

tux –o –d disktest -zorch [-disk DSKX:] [-profile <profile>] 
[-oldioctls] [-sectors <count>] [-store]

Parameters

  • -o
    This parameter sends all Kato output to the debugger.
  • -d disktest
    This parameter allows the Tux client to load one or more default test modules. When you pass in the disktest option, the Tux client loads disktest module and immediately begins to execute the specified tests for disktest.
  • -disk DSK X :
    Specifies the device name of the disk to be tested.

    If you do not specify this parameter, the test probes for a mass storage disk on devices DSK1-DSK9. Specifying this parameter overrides the automatic detection process and forces the test to use the disk that you specify.

  • -profile < profile >
    Specifies the storage profile and limits testing to the devices with the specified storage profile.

    The default storage profile is "all profiles".

  • -oldioctls
    Forces the test to use the previous disk I/O control codes (IOCTLs) instead of the current set of IOCTLs. The previous IOCTLs are prefixed with "DISK_IOCTL_" and are not Windows Embedded CE IOCTLs. The current set of IOCTLs are prefixed with "IOCTL_DISK_". Many block drivers support both previous and current IOCTLs.

    You can use this parameter to verify that current and previous IOCTLs work correctly.

  • -sectors < count >
    Sets the maximum number of sectors per read/write transaction.

    You can use this parameter for a storage device to set the physical limit on the number of sectors that are transferred by the storage device at one time.

    The default value is 128 sectors.

  • -store
    Specifies that the test opens a handle to the disk by using the OpenStore function instead of the CreateFile function.

    Notice that you are not required to open a handle by using OpenStore to test block driver functionality. However, it is useful for testing a storage device that Filesys.exe loads automatically if you cannot open the storage device. For example, you can open a handle to a flash driver for ROM by using the OpenStore function.

  • -zorch
    Enables the functionality of the test. Without this parameter, the test will fail. With this parameter, the test will run and destroy all data on the storage device.

Remarks

During the test, all information on the storage device is destroyed. The test writes to and reads from sectors on the storage device without preserving the contents of the sectors. Microsoft recommends that you back up data on all cards and disks that are attached to the tested device before running the test.

If you run the unmodified test, it will fail. In the results file you will see a message warning you to back up data on all cards and disks that are attached to the testing device before running the test. It then instructs you to modify the command line by right clicking on the test in the Windows Embedded CE 6.0 Test Kit (CETK) tree control, choosing Edit Command Line, and adding the following switch to the command line:

-zorch

After saving this change, you can run the test successfully. You can also pass this parameter in with Tux's -c command line parameter, as described below.

You can modify the test by editing the command line. To specify one or more of the following optional command line parameters for this test, use the –c command line parameter, which forces Tux to pass the specified string into the test module. For more information about how to edit the command line for a test, see Editing the Command-Line for a Test.

See Also

Other Resources

Storage Device Block Driver API Test