Mellanox Technologies
=====================

================================================================
=   Mellanox Mini Tools Package for VMWare(R) ESX(TM) 4.0 GA   =
=                          Release Notes                       =
=                 Rev 2.6.0.222 ; Jan 6, 2009                  =
================================================================

Contents:
=========
1. Overview
   1.1 Main Features Overview
   1.2 Package Content
2. Revision Compatibility
3. Software
   3.1 Installing the Tools
   3.2 Removing the Tools
   3.3 Using mlxburn
   3.4 Using mstflint
   3.4 Using ibstat
4. Known Issues


1. Overview
===========
This document provides instructions for installing tools for Mellanox
Technologies ConnectX(R) and InfiniHost(R) III InfiniBand (IB) adapter cards
in a VMware(R) ESX Server environment. The tools are at Beta stage.

1.1 Main Features Overview
--------------------------
- Query FW version or FW properties using mstflint/mlxburn
- Burn FW on HCA using mstflint
- Burn/Read FW on HCA using mlxburn
- Create a FW image using mlxburn
- Check IB link status using ib_stat


2. Revision Compatibility
=============================================
- This package is compatible with ESX40 GA and above.
- This package is compatible with CX, CX2 and InfiniHost HW.


3. Software
===========
3.1 Installing the Tools
------------------------
1. Log into the VMware ESX Server machine as root.

2. Install libperl.so
 a. The library libperl.so is required for mlxburn. If you do not intend to use
    mlxburn (but only use mstflint), you can skip this section.
 b. Install the perl-lib binary rpm supplied with the tools bundle. Run:
    #> rpm -Uvh perl-libs-5.8.8-41.fc8.i386.rpm
 c. If you already have libperl.so installed, you can use the installed package
    by configuring the library path to point to your current libperl.so
    package. One way to do this is to add the path of libperl.so into
    /etc/ld.so.conf and run ldconfig.

3. Install mlx_tools-bundle.zip on ESX Server. Run:
   #> esxupdate --bundle mlx_tools-bundle.zip --nodeps update

3.2 Removing the Tools
-----------------------
1. To remove the tools package from the VMware ESX Server machine, run: 
   #> esxupdate -b <bundle name to remove> remove
2. To find the bundle name, run:
   #> esxupdate query
3. To remove the libperl rpm, run:
   #> rpm -e <libperl rpm name>
4. To find the rpm name, run:
   #> rpm -qa | grep libperl

NOTE: If you only wish to update to a new tools package, you do not have to
      remove libperl.

3.3 Using mlxburn (Common Operations)
-------------------------------------
1. To get help for mlxburn refer to the tools user's manual at
   http://www.mellanox.com/pdf/MFT/MFT_user_manual.pdf. Alternatively, run:
   #> mlxburn --help
2. Most mlxburn commands use the HCA device ID. Use the pciid read from 
   'vmkchdev -l' (with hex numbers) or 'lspci'. The following examples assume
   00a:00.0 for the pciid.
3. Query the FW:
   #> mlxburn -dev 00a:00.0 -query
4. Burn new FW:http://www.mellanox.com/pdf/MFT/MFT_user_manual.pdf
   #> mlxburn -dev 00a:00.0 -fw fw-25408-rel.mlx
5. Create a binary FW file to burn with mstflint:
   #> mlxburn -wrimage <result file name> -fw fw-25408-rel.mlx 
      -conf <.ini configuration file>
6. Read VPD information from the HCA. VPD information is programmed on the 
   Flash device during HCA production and it identifies the HCA properties.
   VPD information can be very useful if there is a chance that the wrong FW
   has been burned on the HCA. Run the following command to read VPD info:
   #> mlxburn -dev 00a:00.0 -vpd

3.4 Using mstflint (Common Operations)
-------------------------------------
1. To get help for mstflint, run:
    mstflint --help
2. Most mstflint commands use the HCA device id. Use the pciid read
   from 'vmkchdev -l' (with hex numbers). The following examples assume
   00a:00.0 for the pciid.
3. Query the FW:
    mstflint -d 004:00.0 q
4. Query the FW configuration:
    mstflint -d 004:00.0 dc
5. Burn new FW binary:
    mstflint -d 004:00.0 -i <binary image file> b
6. Make sure to burn only compatible image files.

3.5 Using ibstat
-------------------------------------
1. ibstat can be used to query IB device status.
2. To obtain the IB status, the ibstat utility queries /proc entries exported
   by IPoIB and SRP. As a result, ibstat requires IPoIB to be already  loaded.
3. Please note that ibstat outputs information for IB ports only. ibstat does
   not output information for ports configured as Ethernet.


4. Notes and Known Issues:
==========================
N/A