Intel(R) NVM Integrity Verification Tool Release Notes
======================================================
April 26, 2017

Contents
========
- OVERVIEW
- RUNNING THE UTILITY
  - OPTIONS
  - BASIC USAGE GUIDELINES
- INSTALLATION
- CUSTOMER SUPPORT
-LEGAL INFORMATION


OVERVIEW
========
Intel(R) NVM Integrity Verification Tool (NVMCHECK) verifies that the NVM
image is an authentic image.


Supported Operating Systems
---------------------------
Microsoft* Windows 7* and later
Microsoft Windows Server* 2008 R2 and later
Linux* Kernel 2.6/3.x and later
Red Hat* Enterprise Linux* 6.5 and later
SUSE* Linux Enterprise Server 10 SP4 and later
UEFI 2.1 and later
VMWare* ESXi* 5.5 and later
FreeBSD 10.1 and later

Notes:
  - On systems running Linux, FreeBSD, or ESXi, the base driver must be
    present for NVMCHECK to function correctly.
  - On Microsoft Windows systems, if the driver required to run the tool is not
    present on the system, it will automatically be installed when NVMCHECK
    is run.


RUNNING THE UTILITY
===================
Using the "/?" option will display a list of supported command line options.


OPTIONS:
--------
NVMCHECK can be run with any of the following command line options:

  /HELP or /?
	Displays command line help.
  /VERSION
	Displays the tool version and Quartzville SDK information.
  /DEVICES
	Displays the device list.
  /NIC=XX
	Selects a specific device (1-32).
  /VERIFY
	Verifies the NVM signature of the selected device.

Technical support options:
  /HEADER
	Displays the NVM header of the selected device.
  /KEY
	Displays the NVM key of the selected device.


BASIC USAGE GUIDELINES
----------------------
To display a list of installed adapters call NVMCHECK using the /DEVICES option.

NVMCHECK will display a list of network adapters installed in the system similar
to the following:

NIC B/D/F    Ven-Dev   MAC          ENA Branding string
=== ======== ========= ============ === ======================================
1)  01/00/00 8086-15D1 341278560000 NO  Intel(R) Ethernet Controller X550-T1
2)  02/00/00 8086-1583 000000000100 YES Intel(R) Ethernet Converged Network Ada
3)  04/00/00 8086-1533 94DE80A0381C YES Intel(R) I210 Gigabit Network Connectio

To perform an operation on an installed network adapter you must specify the
"/NIC=" parameter. For example, to verify the NVM on NIC 1 from the list above
call NVMCHECK like this:

NVMCHECK/NIC=1 /VERIFY

The tool will return:
  NVM Integrity verification [PASSED/FAILED]


Installation
=============


INSTALLING THE TOOL ON MICROSOFT* WINDOWS*
===========================================

To install the tools' drivers on Windows, run install.bat from the appropriate
directory of the install package.

Although the tool are not installed with install.bat, the driver that the tool
requires is copied into the local machine Windows driver directory. To run the
tool, launch a Command Prompt window from the Windows Start Menu. Go to the
media and directory where the tool is located and run the utility. The readme
files for each tool are found in the same directory as the tool. These tools
can be manually installed on the local hard drive in any directory.

The tool uses its own driver file (not the same as the system network driver).
If the driver sys file already exists in the drivers directory, install.bat may
fail to copy. Using the /y switch with install.bat will override and copy the
driver file regardless. However, this can be dangerous if an older version of
the driver is being used by another application such as Intel(R) PROSet for
Windows Device Manager. If a driver is already present in the drivers directory,
try running the tool from the command prompt. If it runs, then the driver is
fine. The tool will not run if the driver version present does not match the
driver version expected.

Note that you must have access to the %systemroot%\system32\drivers
directory. Only the administrator account has these privileges. You must be
logged in as administrator or the tools must be run as administrator.

Note that on Windows, any device that is disabled in device manager will not be
accessible by tools due to no memory resources. You would get an error code
0xC86A800E. To solve this problem, you can do one of the following:
1) Re-enable the device in device manager. Never disable this device when
   using tools.
2) Install an NDIS device driver for the device and make sure that it does
   not have a yellow or red bang by it in device manager.
3) Delete the device from device manager and restart the system. The install
   new hardware wizard should appear on next reboot. Do not cancel this. Just
   move the window aside and run the tool(s). Generally, you can click "cancel"
   on the wizard but there are some cases where Windows will disable the memory
   resources causing you to get back into the same state.


INSTALLING THE TOOLS ON MICROSOFT* WINDOWS SERVER* NANO SERVER
==============================================================

To install the tools on systems running Nano Server, you must use Microsoft*
Windows PowerShell* to copy the tools and their driver files from a host system
running a version of Windows other than Nano Server to the target system
running Nano Server. The tools and their driver files are available from the
installation media in the \TOOLS\Nanox64\SVTools folder.

This is the installation procedure:
  1. On the host system, open the installation media and copy the folder
     \TOOLS\Nanox64\SVTools to the target system running Nano Server.
  2. Open a Windows PowerShell session to the target system.
  3. Navigate to the location of the files you copied in Step 1 above.
  4. Run install.bat.


INSTALLING THE TOOLS ON EFI
===========================

There is no installation required for EFI tools. The tools can simply be copied
from the appropriate directory to the drive that they will run from. The EFI2
binaries are for use with the UEFI Shell 2.X with the UEFI 2.3 HII protocol.
EFI2 tools will not run on the EFI Shell 1.X or if the UEFI 2.3 HII protocol is
not present.

Note that while EFI supports USB drives, there may be issues running tools
from the USB drive. Whether or not there are issues are BIOS specific. If you
experience issues, run the tool from hard disk instead.


INSTALLING THE TOOLS ON DOS
===========================

The tools support various DOS versions. There is no installation required for
DOS tools. The tools can simply be copied from the DOS directory on the CD to
the drive that they will run from. It is expected that the tools have a clean
boot environment. The tools will not run with memory managers and/or DOS
networking drivers loaded. The tools expect that they have full, unlimited
control of the hardware. The tools *WILL NOT* run properly if EMM386 is present. 
The tools run in protected mode, 32-bit DOS. Therefore, they will not be
compatible with any TSR programs.


INSTALLING THE TOOL ON LINUX*
=============================

In order to run this tool on Linux*, the base driver must be installed on
the system. 


INSTALLING THE TOOL ON VMWare* ESXi* 
===================================

In order to run this tool on VMWare* ESXi*, the base driver must be installed on
the system. 

Note that there are two versions of the utility. For ESXi 6.0 and later, use nvmcheckn64e. For
prior versions of ESXi, use nvmcheck64e.


INSTALLING THE TOOL ON FreeBSD*
===============================

In order to run this tool on FreeBSD*, the base driver must be installed on
the system. 


CUSTOMER SUPPORT
================
- Main Intel web support site: http://support.intel.com

- Network products information: http://www.intel.com/network


Legal / Disclaimers
===================
Copyright (C) 2002-2017, Intel Corporation. All rights reserved.

Intel Corporation assumes no responsibility for errors or omissions in this
document. Nor does Intel make any commitment to update the information
contained herein.

Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries
in the U.S. and/or other countries.

*Other names and brands may be claimed as the property of others.

This software is furnished under license and may only be used or copied
in accordance with the terms of the license. The information in this
manual is furnished for informational use only, is subject to change
without notice, and should not be construed as a commitment by Intel
Corporation. Intel Corporation assumes no responsibility or liability
for any errors or inaccuracies that may appear in this document or any
software that may be provided in association with this document. Except
as permitted by such license, no part of this document may be reproduced,
stored in a retrieval system, or transmitted in any form or by any means
without the express written consent of Intel Corporation.
