©Copyright 1998-2007 Marvell®. All rights reserved.

yukondg.htm created 09-Jul-2007

Readme File for YUKONDG.EXE v6.41.1.3
Diagnostics Utility for the 
Marvell Yukon Ethernet Adapter Family



This file contains




1  Overview

This README file explains how to use the program YUKONDG.EXE to test
your network adapter or to maintain the Flash PROM contents of the adapter.

Chapter 2 contains a list of all network adapters that are supported by
this program.

Chapter 3 describes the command line options that can be used when
starting the diagnostics program.

Chapter 4 explains how to use the diagnostics program to test your network
adapter.

Chapter 5 explains how to use the repeater mode.

Chapter 6 describes the test result messages.

2  Supported Adapters

The program YUKONDG.EXE supports the Marvell Yukon Ethernet Adapter Family.

3  Command Line Options

The following two lists show the optional parameters supported by YUKONDG.EXE.
You can obtain a list of all available command line options by typing the
following:

	YUKONDG -?


OPTIONS THAT SPECIFY THE NETWORK ADAPTER TO BE TESTED
-----------------------------------------------------
-b  <bus>       PCI bus number.
-d  <dev>       PCI device number of the network adapter.
-v  <ID:<id>&R:<rev>[-<rev>][+ID:<id>&R:<rev>[-<rev>]]>
                Check the chip ID and revision of the network adapter.
-y  <YYYY>      Additional PCI vendor ID to search for.
-z  <ZZZZ>      Additional PCI device ID to search for.

OPTIONS THAT INFLUENCE THE TESTS TO BE PERFORMED
------------------------------------------------
-?              Display this help screen.
-l              List all Ethernet adapters installed.
-t <seconds>    Set time limit (in seconds).
-o <file>       Output file. This option generates an output file.
-x              Use an output file with the name based on the MAC address.
PLEASE USE THE NEXT OPTIONS ONLY IF INSTRUCTED BY SERVICE PERSONNEL!
-a              Advanced mode of operation.
-f              Suspend advanced tests on error (Script file is mandatory).
-r              Do tests for all found devices in advanced mode.
                Script and output file parameters are mandatory.
-c <file>       Script file (LOM/NIC, -m overwrites -c for NIC).
-m <file>       Script file (NIC only, tests on LOM are skipped).
-p <file>       Parameter file.
-i              Invoke PXE Patch Tool.


NOTE: The file name <file> is limited to 13 characters.

4  How to use the Diagnostics Program

In order to test your adapter, proceed as follows:
1. Start the DOS-based utility program YUKONDG.EXE using any of
   the available options to correctly specify the network adapter
   if required.


NOTE: The options '-b', and '-d' may be combined as required in order to
specify exactly the network adapter, which is to be tested.
All specified options are checked against the list of network adapters.
You can also force a list of all installed Marvell Yukon Ethernet adapters by
using the '-l' option.

2. Select the action you want to carry out.
   For testing the network adapter, 4(3) options are available:
	- "Diagnostics",
	- "Loopb. Wrap Plug",
        - "Loopb. ext. Repeater",
	- "Loopb. Port to Port" (available for dual link adapters only).

	"Diagnostics":
	Select this option if no wrap plug or port-to-port loopback
	cable is available.

	"Loopb. Wrap Plug":
	To run tests in this mode, wrap plug(s) must be installed 
        before this test starts.

        NOTE: Wrap plugs are not available for all copper-based adapters.
              Please use another station in repeater mode instead.
              For further information on the repeater mode, refer to the 
              next section.

	"Loopb. ext. Repeater":
	To run tests in this mode, another station must be connected 
	back-to-back to the test station with diagnostics software started 
	and running in repeater mode, before this test starts.

        NOTE: Please ensure that adapter in the repeater station meets the
	      speed requirement (10/100/1000Mbit) of the device under test.

	      To run this test on a dual port adapter, both ports must be 
	      connected to the different test stations in repeater mode, 
	      before this test starts.


        "Loopb. Port to Port":
        To run tests in this mode, both ports of one dual-port adapter
        must be connected through a cable, before this test starts.

        NOTE: Single port adapters cannot be tested this way.

   To display additional information about the network adapter,
   two options are available:
	- "Show Configuration",
	- "Show Sensors".

	"Show Configuration":
	Select this option to get the configuration of the network adapter.

	"Show Sensors":
	Select this option to get the sensor values of the network adapter.

3. If you want to maintain your Flash PROM contents
   select the menu item "Flash PROM ...".
   A new menu will appear.
   Now, you can
	- save your Flash PROM contents to a file
	   ("Save Flash PROM to File")
        - write a file into the Flash PROM (max. size 124 kB)
	  ("Load Flash PROM from File")
	- erase the first sector of the Flash PROM to destroy a Boot Code.
	  ("Clear Boot Code").

4. If you want to maintain the VPD Data contents
   select the menu item "VPD Data ...".
   The VPD menu will appear.
   Now, you can
	- display the adapter's VPD data
	  ("Display VPD Data")
	- clear error log entries
	  ("Clear Error Logs")
	- modify VPD data
	  ("Add/Modify VPD Data")
	- remove VPD keywords
	  ("Delete VPD Keywords").

NOTE: During the adapter tests, the diagnostics program must have
      exclusive rights to use that network adapter. All drivers
      running on the adapter will be stopped!

5  How to use the Repeater Mode

The repeater mode is intended to simulate a 'Wrap Plug' when
1000BASE-T adapters without 'Wrap Plug' support are tested. 
To run a "Loopb. Wrap Plug" test, the device under test
must be connected to an adapter running in repeater mode before 
the test starts.

Although the repeater mode is also available for fiber adapters, it is
not advisable to perform loopback tests with a repeater station 
because the link establishment for fiber adapters is different
and is not fully implemented in the diagnostics loopback tests.

To enable the repeater mode, proceed as follows:

1. Choose the option "Repeater Mode" from the main menu.
2. Select a port number.
   The repeater window appears. All incoming frames except pause frames
   are looped on the transmit side without modifications.

The following table shows the configuration parameters and
statistic counters displayed in the repeater mode window.


Parameter/Counter       Start Value       Description
---------------------------------------------------------------------------
Link State              Down              This parameter indicates the link 
                                          state that may be down or up.
                                          If up, frames can be received and
                                          transmitted.
---------------------------------------------------------------------------
Link Master/Slave       Slave             This parameter indicates if the
Config                                    adapter is working as master or
                                          slave.
                                          The parameter is only supported
                                          for 1000BASE-T adapters.
---------------------------------------------------------------------------
Link Estimate          	1E-15             This parameter indicates the
                                          the estimated link error rate.
                                          The parameter is only supported
                                          for 1000BASE-T adapters.
---------------------------------------------------------------------------
Link Changes            0                 This counter indicates the number
                                          of link operational changes since
                                          the repeater mode started.
---------------------------------------------------------------------------
False Carrier           0                 This counter is only valid for
Sense Counter                             1000BASE-T adapters. It shows the
                                          number of false carrier sense
                                          counters occurred since the
                                          repeater mode started.
---------------------------------------------------------------------------
FCS Errors              0                 This counter indicates the number
                                          of Frame Check Sequence (FCS) 
                                          errors occurred since the last link
                                          operational change.
---------------------------------------------------------------------------
Frames Received         0                 This counter indicates the number
                                          of received frames. Received pause
                                          frames are neglected.
---------------------------------------------------------------------------
Frames Transmitted      0                 This counter indicates the number
                                          of transmitted frames. Transmitted
                                          pause frames are neglected.
---------------------------------------------------------------------------
Pause Frames Received   0                 This counter indicates the number
                                          of received pause frames.
---------------------------------------------------------------------------
Pause Frames            0                 This counter indicates the number
Transmitted                               of transmitted pause frames.
---------------------------------------------------------------------------
Received Overflows      0                 This counter indicates the number
                                          of received overflow events.
---------------------------------------------------------------------------

6  Error Handling

If no error occurs, the diagnostics program exits with code 0 and emits 
the DOS screen message "Test Result: PASSED". In case of an error, the exit 
code is not 0, the message on the DOS screen is "Test Result: FAILED", 
and a short description of the last error is given.
***End of Readme file***