mlxup - Mellanox Firmware
UtilityUser Guide
Rev 1.4

www.mellanox.com

Mellanox Technologies

NOTE:THIS HARDWARE, SOFTWARE OR TEST SUITE PRODUCT (“PRODUCT(S)”) AND ITS RELATEDDOCUMENTATION ARE PROVIDED BY MELLANOX TECHNOLOGIES “AS-IS” WITH ALL FAULTS OF ANYKIND AND SOLELY FOR THE PURPOSE OF AIDING THE CUSTOMER IN TESTING APPLICATIONS THATUSE THE PRODUCTS IN DESIGNATED SOLUTIONS. THE CUSTOMER'S MANUFACTURING TESTENVIRONMENT HAS NOT MET THE STANDARDS SET BY MELLANOX TECHNOLOGIES TO FULLYQUALIFY THE PRODUCT(S) AND/OR THE SYSTEM USING IT. THEREFORE, MELLANOX TECHNOLOGIESCANNOT AND DOES NOT GUARANTEE OR WARRANT THAT THE PRODUCTS WILL OPERATE WITH THEHIGHEST QUALITY. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL MELLANOX BE LIABLE TO CUSTOMER ORANY THIRD PARTIES FOR ANY DIRECT, INDIRECT, SPECIAL, EXEMPLARY, OR CONSEQUENTIALDAMAGES OF ANY KIND (INCLUDING, BUT NOT LIMITED TO, PAYMENT FOR PROCUREMENT OFSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY FROM THE USE OF THE
PRODUCT(S) AND RELATED DOCUMENTATION EVEN IF ADVISED OF THE POSSIBILITY OF SUCHDAMAGE.

Mellanox Technologies
350 Oakmead Parkway Suite 100
Sunnyvale, CA 94085
U.S.A.
www.mellanox.com
Tel: (408) 970-3400
Fax: (408) 970-3403© Copyright 2016. Mellanox Technologies Ltd. All Rights Reserved.
Mellanox®, Mellanox logo, Accelio®, BridgeX®, CloudX logo, CompustorX®, Connect-IB®, ConnectX®,
CoolBox®, CORE-Direct®, EZchip®, EZchip logo, EZappliance®, EZdesign®, EZdriver®, EZsystem®,
GPUDirect®, InfiniHost®, InfiniBridge®, InfiniScale®, Kotura®, Kotura logo, Mellanox CloudRack®, Mellanox
CloudXMellanox®, Mellanox Federal Systems®, Mellanox HostDirect®, Mellanox Multi-Host®, Mellanox Open
Ethernet®, Mellanox OpenCloud®, Mellanox OpenCloud Logo®, Mellanox PeerDirect®, Mellanox ScalableHPC®,
Mellanox StorageX®, Mellanox TuneX®, Mellanox Connect Accelerate Outperform logo, Mellanox Virtual Modular
Switch®, MetroDX®, MetroX®, MLNX-OS®, NP-1c®, NP-2®, NP-3®, Open Ethernet logo, PhyX®, PlatformX®,
PSIPHY®, SiPhy®, StoreX®, SwitchX®, Tilera®, Tilera logo, TestX®, TuneX®, The Generation of Open Ethernetlogo, UFM®, Unbreakable Link®, Virtual Protocol Interconnect®, Voltaire® and Voltaire logo are registeredtrademarks of Mellanox Technologies, Ltd.
All other trademarks are property of their respective owners.
For the most updated list of Mellanox trademarks, visit http://www.mellanox.com/page/trademarks

Document Number: MLNX-15-5399

Rev 1.4

Mellanox

Technologies

2

Table of ContentsDocument Revision History.................................................................................................................. 612Rev 1.4

Overview .......................................................................................................................................... 7
1.1

Downloading mlxup ................................................................................................................ 7

1.2

mlxup Synopsis....................................................................................................................... 7

1.3

Updating Firmware ................................................................................................................. 8
1.3.1

Querying for Adapters ............................................................................................... 8

1.3.2

Updating Firmware Using an Embedded Image....................................................... 9

1.3.3

Updating Firmware Using a Specific Image ........................................................... 10

1.3.4

Updating Firmware from a Directory ....................................................................... 11

1.3.5Online Firmware Update ......................................................................................... 11

Frequently Asked Questions (FAQ) ............................................................................................ 12Mellanox Technologies

3List of Figures
Figure 1: Single Adapter Update Specification ........................................................................................ 9Figure 2: Embedded Firmware Image - Single Adapter........................................................................... 9Figure 3: Embedded Firmware Image - Multiple Adapters ................................................................... 10Figure 4: Updating Firmware Using a Specific Image ............................................................................ 10
Figure 5: Updating from a Directory ..................................................................................................... 11
Figure 6: Online Firmware Update ........................................................................................................ 11

Rev 1.4

Mellanox Technologies

4List of Tables
Table 1: Document Revision History ....................................................................................................... 6

Rev 1.4

Mellanox Technologies

5Document Revision History
Table 1: Document Revision History
Revision

DateDescription

1.4

November 24, 2016

No changes were made to this version.

1.3

June 2016

No changes were made to this version.

1.2

March 2016

No changes were made to this version.

1.1

October 2015

Updated the following sections:• 1.1• 1.3.2

1.0

Rev 1.4

August 2015

Mellanox Technologies

First release6

1Overview
mlxup is a Mellanox firmware update and query utility used to update the firmware on eachrelevant adapter.
mlxup can use a firmware binary image placed at one of the following locations:
1. Embedded in the mlxup utility (default)
2. At an exact user-specified path to the image file (--image-file flag)
3. In a user-specified directory which may contain more than a single binary (--image-dirflag)
4. On www.mellanox.com that the utility accesses online

1.1

Downloading mlxup
Download the utility from the mlxup Download Center available at www.mellanox.com >Products > Software > Firmware Utilities.
The utility is a binary executable that does not require installation.
NOTE: In Linux and FreeBSD: Downloading mlxup using the wget application
removes file attributes, therefore, there is a need to add execute permission by running:
chmod +x mlxup

1.2

mlxup Synopsis
mlxup [options]mlxup Usage Options:

Rev 1.4-d|--dev <DeviceName>

Perform operation for specified PCI (using theformat <Bus>:<Device>.<Function>) or IB
device(s).
Multiple devices can be specified delimited bysemicolons.
A device list containing semicolons must bequoted.

-h|--help

Show this message and exit-v|--version

Show the executable version and exit--query

Query device(s) info--query-format Format

Query | Online query) output format, XML | Text default Text

-u|--update

Update firmware image(s) on the device(s)-i|--image-file FileName

Specified image file to use-D|--image-dir
DirectoryName

Specified directory instead of default to locate
image files-f|--force

Force image update

Mellanox Technologies7-y|--yes

Answer is yes in prompts--noAnswer is no in prompts--clear-semaphore

Force clear the flash semaphore on the device, Nocommand is allowed when this flag is used.
NOTE: May result in system instability or flash
corruption if the device or another application
is currently using the flash. Exercise caution.

--exe-rel-path

Use paths relative to the location of theexecutable--log

Create log file

-L|--log-file
LogFileName

Use specified log file--no-progress

Do not show progress-o|--outfile
OutputFileName

Write to specified output file--online

Fetch required FW images online from Mellanox
server--online-query-psidPSIDs

Query FW info, PSID(s) are comma separated--key key

Key for custom download/update--download DirectoryName

Download files from server to a specified
directory--download-default

Use Default values for download--download-device Device

Options are: ConnectX, Connect-IB, ConnectX-4 default All--download-os OS

FBSD10_1_64, FBSD11_64 - default All--download-type Type

MFA | self_extractor - default All--ssl-certificate
Certificate

SSL certificate For secure connection--sfx-extract-dir <dir>

Use <dir> for temporary files during execution

1.3

Updating Firmware

1.3.1

Querying for Adapters
In order to query for all installed Mellanox adapters, run the following command:# mlxup --query

The above command provides query results about each found adapter device in text andXML format.
NOTE: By default, running the firmware update command using mlxup will update
firmware for all Mellanox adpaters on the machine.
However, you can use the '-d <PCI Device Name>' option to specify a single
adapter for update (see figure Figure 1 below).

Rev 1.4

Mellanox Technologies

8Figure 1: Single Adapter Update Specification

1.3.2

Updating Firmware Using an Embedded Image
By default, mlxup updates the firmware of all Mellanox adapter cards installed on yourmachine. The utility first queries for available devices and indicates whether an update isrequired. Then it prompts the user to confirm or reject the firmware update. Figure 2 andFigure 3 below illustrate the performed steps.
NOTE: In order to load firmware on ConnectX-4, ConnectX-4 Lx and Connect-IB, areboot must be performed after upgrading the firmware.

Figure 2: Embedded Firmware Image - Single Adapter

Rev 1.4

Mellanox Technologies

9Figure 3: Embedded Firmware Image - Multiple Adapters

1.3.3

Updating Firmware Using a Specific Image
In order to update the firmware of all Mellanox adapter cards using a specific firmware
image, run the following command:# mlxup -i <file path>

Figure 4: Updating Firmware Using a Specific Image

Rev 1.4

Mellanox Technologies

101.3.4

Updating Firmware from a Directory
In order to update the firmware of all Mellanox adapter cards using firmware images locatedunder a specific directory, run the following command:# mlxup –D <directory path>

Figure 5: Updating from a Directory

1.3.5

Online Firmware Update
mlxup can also update the device using the latest firmware published on
www.mellanox.com. In order to complete the update online, run the following command:# mlxup –online

Figure 6: Online Firmware Update

Rev 1.4

Mellanox Technologies

112

Frequently Asked Questions (FAQ) What is the connection between MFT tools and mlxup?

mlxup is a self-extracting executable that contains a set of Mellanox firmware binary
images and the mlxfwmanager tool with limited features. mlxfwmanager is part of theMFT package.
For further information on how to generate mlxup, please refer to the “Update Package
for Mellanox Firmware” section in MFT User Manual.
 Why can’t mlxup recognize my card?

This may occur for two reasons:•The mlxup version might not be the latest and therefore does not support this specificcard type. In this case, an mlxup update is required.

•The device might not be working properly, therefore it might not be listed in the PCI
devices list. In this case, device functionality needs to be verified.

 Why does the available firmware version on my server appear as “N/A”?

mlxup might not contain a firmware suitable for the card you are attempting to update. In
this case, you may get the latest mlxup version by running mlxup –online or using
any of the methods explained above.
 “Device FW is up to date” message popped up while I was trying to burn the device.

What does it mean?
This means that the firmware version in the mlxup package is older or identical to thecurrent firmware version on the device. In this case, you can force the burning by using
the “--force” flag.
 “Failed to open device” message popped up while I was trying to query/burn the device.

What does it mean?
This means that there was a failure in the -read from the PCI device. To resolve the issue,
try to reboot the system.

Rev 1.4

Mellanox Technologies

12