Intel® Virtual RAID on CPU (Intel® VROC) VMD NVMe* RAID Pre-OS Components

The Intel® VROC production package for Windows* is broken into Pre-OS components, F6 (or Load Driver) components, an operating system installer (Intel® VROC Installation Utility) and a Command Line Interface (CLI) component (Intel® VROC CLI Utility). Whereas the operating system installer and the CLI components are common for all Intel® VROC sub-products, there are specific Pre-OS and F6 components for the Intel® VROC (VMD NVMe* RAID) environment.

The Pre-OS components for the Intel® VROC (VMD NVMe* RAID) environment are described below. To learn about the Pre-OS components for Intel® VROC (SATA RAID), refer to Intel® Virtual RAID on CPU (Intel® VROC) SATA RAID Pre-OS Components.

Intel® VROC Package Components

The Intel® VROC Pre-OS components are part of the Intel® VROC software package for Windows*. Learn about other package components in the Intel® Virtual RAID on CPU (Intel® VROC) Technical Product Specification for Windows*.

VMDVROC_1.efi and VMDVROC_2.efi

These two UEFI device driver files are to be included in the platform BIOS. Both files are required and work together to properly support the Intel® Volume Management Device (Intel® VMD) controller when enabled. When these files are properly incorporated into the platform BIOS, the BIOS setup will have the ability to manage NVMe* drives (create/delete RAID volumes) connected to the Intel® VMD controller. Other features include:

• Seeing and reporting (to the BIOS) any NVMe* Solid-State Drive (SSD) attached to the Intel® VMD controller.
• Installing an operating system onto a drive (or RAID volume) managed by the Intel® VMD controller.
• Recognizing of Intel® VROC hardware upgrade keys.
• Proper configuration of the system based on the Intel® VROC hardware upgrade key seen.

HWKeyCheckVROC.efi

This utility can be used by platform manufacturers to test the Intel® VROC hardware upgrade key configuration via a UEFI shell environment. This helps to make sure the system can properly see the Intel® VROC hardware upgrade key plugged into the system. This utility must be copied to and executed from a USB key in a UEFI shell.

This tool must match the major release version of the Intel® VROC (VMD NVMe* RAID) UEFI driver. To find the release version:

1. Boot to the EFI shell.
2. Run the command: drivers -sfo.
3. Note the major release version which is the first number (capital X). Look for the text: Intel(R) VROC with VMD Technology AA.BB.CC.DDDD.
4. Compare this value to what is reported in the Intel® Virtual RAID on CPU (Intel® VROC) Release Notes for Windows* associated with the latest release.

By using a FAT32 formatted USB device, users can download any release of this tool that matches the major release of Intel® VROC (VMD NVMe* RAID) UEFI driver found in the previous steps:

1. Attach the USB device to the system under test.
2. Navigate to the file system of the FAT32 formatted USB disk.
3. Run the command map –r to find the corresponding FS# for the USB device.
4. Type the respective FS# for the USB device.
5. Run the EFI tool, for example: HWKeyCheckVROC.efi.

The output from this EFI tool can also be saved in a text file (such as HWKeyCheckVROC.efi > HWKeyCheckVROC_Output.txt).

RCfgVROC.efi

This utility can be used by platform manufacturers to manage/test Intel® VROC capabilities from a UEFI shell environment. This utility must be copied to and executed from a USB key in a UEFI shell.

This tool must match the major release version of the Intel® VROC (VMD NVMe* RAID) UEFI driver. By using a FAT32 formatted USB device, users can download any release of this tool that matches the major release of Intel® VROC (VMD NVMe* RAID) UEFI driver found in the section above:

1. Attach the USB device to the system under test.
2. Navigate to the file system of the FAT32 formatted USB disk.
3. Run the command map –r to find the corresponding FS# for the USB device.
4. Type the respective FS# for the USB device.
5. Run the EFI tool, for example: RCfgVROC.efi.

The output from this EFI tool can also be saved in a text file (such as RCfgVROC.efi /I > RCfgVROC_Output.txt).

RCmpVROC.efi

This is a debug utility to help verify that the two EFI drivers (VMDVROC_1.efi and VMDVROC_2.efi) have been properly configured/incorporated into the BIOS. When reporting an issue to Intel, the output from this file will most likely be asked by the Intel representative. This utility must be copied to and executed from a USB key in a UEFI shell.

This tool must match the major release version of the Intel® VROC (VMD NVMe* RAID) UEFI driver. By using a FAT32 formatted USB device, users can download any release of this tool that matches the major release of Intel® VROC (VMD NVMe* RAID) UEFI driver found in the section above:

1. Attach the USB device to the system under test.
2. Navigate to the file system of the FAT32 formatted USB disk.
3. Run the command map –r to find the corresponding FS# for the USB device.
4. Type the respective FS# for the USB device.
5. Run the EFI tool, for example: RCmpVROC.efi.

The output from this EFI tool can also be saved in a text file (such as RCmpVROC.efi /I > RCmpVROC_Output.txt).

LedToolVMDVROC.efi

This is a UEFI based tool that can be used to test LED connectivity to determine if the hardware is setup correctly. The tool provides the ability to simulate a Locate, Fault or Rebuild signal to the enclosure. This utility must be copied to and executed from a USB key in a UEFI shell.

This tool must match the major release version of the Intel® VROC (VMD NVMe* RAID) UEFI driver. By using a FAT32 formatted USB device, users can download any release of this tool that matches the major release of Intel® VROC (VMD NVMe* RAID) UEFI driver found in the section above:

1. Attach the USB device to the system under test.
2. Navigate to the file system of the FAT32 formatted USB disk.
3. Run the command map –r to find the corresponding FS# for the USB device.
4. Type the respective FS# for the USB device.
5. Run the EFI tool, for example: LedToolVMDVROC.efi /D1 1 /TIMEOUT 2. This command will generate a Locate signal for 2 seconds.

The tool syntax is described below. Each parameter is described in the following table.

• LedToolVMDVROC.efi [/?] [/HELP] [/L] [/Dn state-number] [/TIMEOUT time]

Parameter	Description
/?, /HELP	Displays the help screen. Other options are ignored.
/L	Lists all detected disks.
/Dn	Sends the specified state [0-3] to device selected by n. Valid state numbers are from 0 to 3 and they are interpreted as follow: 0 = LED_OFF, 1 = LOCATE, 2 = FAULT, 3 = REBUILD.
/TIMEOUT	After sending the state, it waits the specified number of seconds and then turns all LEDs off.

An example command is the following:

• LedtoolVMDVROC.efi /D1 2 /D2 1 /TIMEOUT 2

This command will set the state FAULT on device 1 and the state LOCATE on device 2. After a 2-seconds delay, messages will be reset.