NVM Update Package
==================
May 19, 2015


Contents
========
  Overview
  Limitations and Prerequisites
  Updating Your NVM Using Interactive Mode
  Updating Using a Script
  Results
  Link Mode and Breakout Cable Support
  Legal / Disclaimers

  
Overview
========
This package contains all the required files to update the NVM on the Intel(R)
Ethernet* adapters in your system. It contain the NVMUpdate utility,
configuration file, updated NVM binaries, and required driver files.


Limitations and Prerequisites
=============================
This package should only be used on Intel branded adapters. Please contact your
OEM vendor for an appropriate package.
This package only updates the NVM image. It does not update the preboot image. 
To update your preboot image, please download the appropriate package.

DO NOT
 - Power down your system during the NVM Update. 
 - Remove the NIC before the NVM Update completes.
 - Interrupt the NVM Update in any other way.
Doing so may make your device unusable.

Linux requirements
------------------
The base driver for your NIC must already be installed.

UEFI Requirements
-----------------
Create a bootable disk or other media and extract the update package onto the media.
Boot your system from the media and run the tool from there.


Updating Your NVM Using Interactive Mode
========================================  
1. Extract the update package into a temporary folder. 
2. Start the nvmupdate utility by running the executable.
   For example, on an x64 Microsoft* Windows* system, type:

   nvmupdatew64e

   On an x64 Linux* system, type:

   nvmupdate64e

3. Follow the prompts to update the NVM image on the desired device.
 

Using a Script
==============
You can use a script to perform an inventory of all the Intel Ethernet devices 
in the system or update the Intel Ethernet devices in the system. 

Update script example:

  nvmupdate64e –u –l –o update.xml –b  –c nvmupdate.cfg

This causes NVMUpdate to check the installed Intel Ethernet devices against 
those contained in nvmupdate.cfg. If a device contains an NVM version older than 
that specified in the config file, the utility will update the device's NVM. It 
will create an xml file containing the results of the update. Note that –b is 
optional. Specifying –b will create a backup of the current NVM image(s). This 
may add about 30% to the tools execution time.

Inventory script example:

  nvmupdate64e –i –l –o inventory.xml

This causes NVMUpdate to perform an inventory of all the Intel Ethernet devices 
in the system and creates an output file (called inventory.xml) of the results 
of the inventory.


Results
=======
NVMUpdate will return an exit code of zero if the update completed successfully.


Link Mode and Breakout Cable Support
====================================
With the upgrade of NVM package 4.42 and above, users can change the Link Mode from the
standard Link Mode of 1x40Gb with the AXX1P40FRTIOM or 2x40Gb with the AXX2P40FRTIOM to 
one of the following using the QCU application located in the Release 20-rev2 and newer driver package:

AXX1P40FRTIOM (1x40GbE QSFP+ to 1x40GbE QSFP+ default, 1x40GbE QSFP+ to 4x10GbE SFP+ via breakout cable)

AXX2P40FRTIOM (2x40GbE QSFP+ to 2x40GbE QSFP+ default, 2x40GbE QSFP+ to 4x10GbE SFP+ via breakout cable, 2nd QSFP+ port not used)
AXX2P40FRTIOM (2x40GbE QSFP+ to 2x2x10GbE SFP+ via 2x breakout cables, only 2 SFP+ cables from each QSFP+ used in this mode )
Driver package contains QCU usage guide.


Legal / Disclaimers
===================

Copyright (C) 2015, 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 is a trademark of Intel Corporation in the U.S. and/or other 
countries.

* Other product and corporate names may be trademarks of other companies and
are used only for explanation and to the owners' benefit, without intent to
infringe.

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.