Myri-10G NIC Tool Kit

Myri-10G NIC Tool Kit

Myricom provides a 10G NIC Tool Kit for Myri-10G NICs to obtain diagnostic information about the operation of the NIC and to reprogram its EEPROM firmware and PCI-ROM. A self-test procedure for the NIC is also included (for Linux only).

Do I need to upgrade the EEPROM firmware on the Myri-10G NIC?
CHANGES log for EEPROM firmware revisions

The 10G NIC Tool Kit is available for the following OSes:

Linux:
http://www.myri.com/ftp/pub/10g-tools/myri-tools-linux.tar.gz
FreeBSD:
http://www.myri.com/ftp/pub/10g-tools/myri-pcie-tool-1.14a-freebsd.tar.gz
64-bit Windows (ia64 and x86_64):
http://www.myri.com/ftp/pub/10g-tools/myritoolSetup64-1.14.exe
32-bit Windows (i386):
http://www.myri.com/ftp/pub/10g-tools/myritoolSetup-1.14.exe

On Linux, download the Myri-10G Tool Kit and change to the top-level directory. E.g.,

     $ gunzip -c myri-tools-linux.tar.gz | tar xvf - 
     $ cd myri-tools-<version>-linux

On FreeBSD, download the Myri-10G Tool Kit and change to the top-level directory. E.g.,

     $ gunzip -c myri-pcie-tool-freebsd.tar.gz | tar xvf - 
     $ cd myri-pcie-tool-<version>-freebsd

On Windows, the self-extracting exe file will create a top-level directory:

     cd \Program Files\myritool [ or \Program Files (x86)\myritool on 64bit systems]

This directory contains the following tools which must be run as root. Example Linux command-line usage scenarios are provided.

myri_info

NIC information
```
Usage:  myri_info [ -b <board-num>]
                  [ -v ]            -- verbose output
                  [ -n ]
                  [ -c ]
```
To view information about the version of EEPROM firmware and PCI-ROM in use on the NIC(s) in the host, as well as the product code and serial number, execute:
```
     # ./myri_info -v
```
For a detailed explanation of the output, refer to this FAQ entry.
user_upgrade_z8e (or mcp2-upgrade)

EEPROM upgrade
```
Linux Usage:  user_upgrade_z8e-<firmware_version> [ -h ] usage message
                                                  [ --no-pxe ] disable PXE Boot
```
```
FreeBSD and Windows usage:  mcp2-upgrade-<firmware_version>
                            mcp2-upgrade-<firmware_version>-nopxe
```
To upgrade the EEPROM firmware and PCI-ROM for all 10G-PCIE-8A* NICS found in the host, execute the command:
```
     # ./user_upgrade_z8e-<firmware_version>
     [reboot]
```
The new firmware will only be run after the next reboot. Some machines might require a power-cycle to switch to the new firmware (if a simple reset or reboot does not necessarily send a fundamental reset signal to the card).

The upgrade will be visible through the new contents in the MCP2 slot in the output of myri_info -v.

EEPROM upgrade (disabling PXE Boot)

If the host will not boot with the NIC installed, the temporary solution is to disable etherboot (also known as PXE). To update the firmware to use a blank PCI-ROM insert the NIC in a host that will boot and execute:
```
     # ./user_upgrade_z8e-<firmware_version> --no-pxe
     [reboot]
```
Then the NIC can be moved back to the original host which did not boot. The new firmware will only be run after the next reboot. Some machines might require a power-cycle to switch to the new firmware (if a simple reset or reboot does not necessarily send a fundamental reset signal to the card).

Please notify help@myri.com if you see this condition.

mdio_rw

XFP data

Linux Usage:  mdio_rw [ -b<board_num> ] [ -n ] <dev>,<reg> -- display a PHY reg
              mdio_rw [ -b<board_num> ] [ -n ] <dev>.<reg> <val> -- write <val> into PHY reg
              mdio_rw [ -b<board_num> ] [ -n ] -v                -- dump a bunch of PHY regs
                      -- <reg> is parsed as base 10 unless prefixed with 0x

This command (available for Linux only) retrieves information about the XFP module that is plugged into the 10GBase-R NIC, and can be run as:

     # ./mdio_rw -x

This will return the following information:

XFP:
         status=0x0 Present Ready Signal-OK TX-ENABLED
         Latched status:
            +rx-not-ready +rx-loss-of-signal +rx-cdr-not-locked +not-ready
         Temp = 40.0625 Celsius
         TX bias = 6.564 mA
         TX power = 5.146 mW
         RX power = 5.675 mW
         Type = XFP (6)
         Connector = LC (7)
         Compliance = 10GBASE-SR (136)
         Wavelength = 850 nm
         Vendor = JDS Uniphase
         PN = 64P0194
         Vendor = 64P0194
         SN = F632604000E4
         Date = 2006/08/21 (  )

Help for this command:

     # ./mdio_rw -h

lmesg

Usage: lmesg [ -r<rabbit> | -b<unit>] [ -c ] [ -s ]
             -r<rabbit>  get message log using rabbit at IP <rabbit>
             -b<unit>    get message log using using PIO from NIC <unit> (default=0)
             -c          clear the message log
             -s          get all messages (even those already seen)

Firmware Initialization

To see details of the initialization of the firmware on the NIC, run

     # ./lmesg -s

myri_pcie_conf

Usage: myri-pcie-conf [ -b<num> ] [ -p <psize> ]
         -b <num>            -- 10g board instance number
         -p <payload-size> ] -- set pcie max payload size
         -E                  -- Use mmcfg pci access method
         -e                  -- display error status bits
         -c                  -- display and clear error status bits
         -N                  -- Assume Nvidia AER cap at offset 0x160 (with -e)
         -f                  -- print pcie virtual channels FC information

PCIe Max Payload

To check and modify the PCIe Max Payload setting, execute:

     # ./myri_pcie_conf
     Looking myri-10g-nic=05:00.0, bridge=00:08.0
     10G NIC:Max Payload Size = (128/max-supported=4096), Read Req Size=4096
     Bridge:Max Payload Size = (128/max-supported=512), Read Req Size=128

Usually the default max payload size will be reported as 128. On a host using the Serverworks HT2000 chipset, setting it to 256 might give better performance:

     # ./myri_pcie_conf -p 256
     ...
     10G NIC:Max Payload Size = (256/max-supported=4096), Read Req Size=4096
     Bridge:Max Payload Size = (256/max-supported=512), Read Req Size=128

myrige-test.sh (myri_loop_test)

NIC self-test (Linux only)

This program is a self-test for Myri-10GE NICs, as described in the README.myrige-test file.

For a detailed explanation of the testing procedure, refer to this FAQ entry.
Additional Commands
Other commands in this tool kit are normally only useful to diagnose specific problems. In this case, Myricom Technical Support, help@myri.com will provide specific instructions on their usage.

Last updated: 22 April 2008