©Copyright 2003-2004 Marvell®.
All rights reserved.


yukonundi.htm created 06-Feb-2004

Readme File for yukonundi.efi v2.00 alpha 01
UNDI driver for EFI32

This file contains




1  Overview

yukonundi.efi is the EFI UNDI driver for the Marvell(R) Yukon(TM) Gigabit 
Ethernet 10/100/1000Base-T Adapter. 

2  Configuration

The following table gives an overview of the possible configuration that
YUKONUNDI offers:


         Parameter           |       Possible Values
     +-----------------------+-------------------------------------+
       Speed Capabilities    |       Auto (default)
                             |       10 Mbps
                             |       100 Mbps
     +-----------------------+-------------------------------------+
       Duplex Capabilities   |       Both (default)
                             |       Half duplex
                             |       Full duplex
     +-----------------------+-------------------------------------+
       Test logging mode     |       Memory (default)
                             |       Console
     +-----------------------+-------------------------------------+
       Test logging depth    |       Standard (default)
                             |       Extended
                             |       Trace
     +-----------------------+-------------------------------------+

The configuration is stored in the VPD memory of the adapter, if there is 
enough space left. If the VPD memory is destroyed or YUKONUNDI can not 
read the configuration, it uses the default values (see table above). 

1) Speed capabilities

The speed capabilities '10 Mbps' or '100 Mbps' force the link speed to the
respective value. If 'Auto' is selected, the link speed will be
negotiated, which can result in a speed of 10, 100 or 1000 Mbps.


2) Duplex capabilities

The duplex capabilities 'Half duplex' and 'Full duplex' force the duplex
mode to the respective value. If 'Both' is selected, the duplex mode is
negotiated, which can result in a duplex mode of Full duplex or Half
duplex.


3) Test logging

This parameter is for controlling the output of status messages of the
diagnostic functions. The messages can be directed to a memory buffer as
required by the EFI specification or they can be printed directly to the
console. This is controlled by setting 'Test logging mode' to 'Memory' or
'Console'.
The depth of the status messages, i.e. the amount of status messages can
be controlled by setting 'Test logging depth' to 'Standard', 'Extended'
or 'Trace' The number of messages increases from 'Standard' over
'Extended' to 'Trace'.


Format and coding of the configuration
--------------------------------------

YUKONUNDI uses four bytes of the VPD memory to store the configuration:
- two bytes for the VPD keyword "VE",
- one byte for the length (4) of this VPD entry,
- one bytes for the configuration itself.

Coding of the configuration in the VPD memory:

           +---+---+---+---+---+---+---+---+
   Bit:    | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
           +---+---+---+---+---+---+---+---+
                 |   |   |   |   |   |   |
                 |   |   |   |   |   +---+---- Speed capabilities
                 |   |   |   +---+------------ Duplex capabilities
                 |   |   +-------------------- Logging mode (Mem/Con)
                 +---+------------------------ Logging depth (s/e/t)


The default values are all zeros, resulting in the following
configuration:

Link speed capability:  Auto.
Duplex capability:      Both.
Test logging mode:      Memory.
Test logging depth:     Standard.

3  Diagnostic tests

YUKONUNDI provides the following diagnostic tests:

- Configuration register test
- MAC register test
- RAM test
- Flash memory test
- ASIC test
- Checksum test
- Multicast test
- Rate control test
- DMA speed test
- Loop test

The diagnostic tests can be executed in three modes:

- Standard mode
- Extended mode
- Manufacturing mode

In every mode, all tests are executed, but with different parameters of
operation. Standard mode completes in far less than 60 seconds to give an
overview of the adapter's condition.
Extended and Manufacturing modes are practically the same, except that the
status messages in Manufacturing mode are by default more detailed. The
tests in these modes take several minutes and do a more intense testing of
the adapter.

4  Installation

1) Loading YUKONUNDI manually

Manual installation of the driver can be done by invoking the EFI shell
command 'load' with the name of the driver image as argument.

The EFI shell command 'unload' can be used to unload the driver from
memory.


2) Loading YUKONUNDI automatically

To load YUKONUNDI automatically, the driver image must reside on a
drive that is accessible from the EFI shell. To load YUKONUNDI
automatically during every boot, call the shell command 'bcfg':

bcfg driver add # [path]yukonundi.efi "desc"

#           Position in the additional driver list.
            Type 'bcfg driver dump' to see the current list.
[path]      Path to the driver image of YUKONUNDI.
            Example fs0:\efi\drivers 197
desc        Any description you like, preferably "UNDI" to give a hint of
            the driver's nature.

Again, the EFI shell command 'unload' can be used to unload the driver
from memory.

***End of Readme file***