©Copyright 2002-2003 Marvell®.
All rights reserved
yukonx86.htm created 17-Oct-2003
Readme File for YUKONX86.sys v6.27
Marvell Yukon Gigabit Ethernet Adapter
NDIS5.1 Miniport Driver for Windows .NET (x86)
This file contains
YUKONX86.sys is the NDIS5.1 32-bit Miniport driver for the
Marvell Yukon Gigabit Ethernet Adapter.
This driver supports only Windows .NET (x86).
This README file explains how to install the Miniport driver on a machine
running Windows .NET (x86).
This YUKONX86 NDIS5.1 Miniport driver cannot be used with other
Windows versions than Windows .NET (x86).
To install the driver, the following files are required:
YUKONX86.sys Marvell Yukon Gigabit Ethernet Adapter
NDIS5.1 Miniport driver
yukonx86.inf installation setup script
YUKONX86.CAT digital signature
3.1 Installing the driver
Read the installation instructions in the adapter manual carefully.
Follow these instructions to install the adapter in your computer.
With PCI adapters, due to the plug & play facility of PCI, the Windows .NET
(x86) system is able to find, identify, and configure an adapter
automatically.
If the adapter is not detected during boot by Windows .NET (x86) the
operating system will ask you for the driver. Insert the installation disk
and follow the instructions from Windows .NET (x86).
If the adapter is not detected during installation by Windows .NET (x86) the
adapter is installed as "Ethernet Controller" under "Other Devices".
To install the driver you have to perform a driver update as described
in the next section.
3.2 Updating the driver
To update the driver, proceed as follows:
1. On the desktop right click on MY COMPUTER.
2. Select MANAGE.
3. In the "Device Manager" select the adapter you wish to update.
4. Double click.
5. Select DRIVER.
6. Click UPDATE DRIVER ... .
7. Follow the instructions given by Windows .NET (x86) to locate the driver.
8. If the driver which is found to be the latest is not the one you want
to install, select the checkbox "Install one of the other drivers".
9. Click NEXT.
10. Select the driver to be installed in the next listbox.
11. Click NEXT.
If a message is displayed saying that the driver is not digitally signed
by Microsoft, click YES.
12. The message "Windows has finished installing the software for this
device" is displayed.
13. Click FINISH to complete the installation.
Please note that the latest version of the YUKONX86 driver is
available for download from our web site.
The YUKONX86.sys driver allows you to modify several options in order to
optimize the operation of your Marvell Yukon Gigabit Ethernet Adapter.
1. In "Network Connections" right click on the adapter you
want to configure.
2. Select "Properties".
3. Click "Configure".
4. Click "Advanced".
5. In the "Property" box, select the option that you want to change.
6. Enter the desired value in the "Value" box.
7. When finished, click OK .
Windows .NET (x86) will reload the driver with the changed settings.
The parameters supported by the driver are described below.
Network Address
---------------
Registry Name: "NetworkAddress"
Default value: burned-in adapter address
Valid range: 0y-00-00-00-00-01 to FE-FF-FF-FF-FF-FF (hexadecimal),
where at least the "multicast" bit must not be set
(it indicates that the address field contains an
individual address)and the "locally administered" bit
is set (the address has been assigned by a local
administrator). These two bits are first and second
bits transmitted on the LAN medium.
CAUTION: Each individual network MAC address can only be used once in a
network. Assigning the same address to more than one adapter in
the same network is not allowed and can cause serious network
problems.
To use a network MAC address other than the one burned into the adapter,
enter the network address in the following hexadecimal format:
XX-XX-XX-XX-XX-XX (e.g. 02-00-5A-98-12-34).
If the network address field blank is left blank (or a different number of
digits is specified), the network address burned into the adapter will
be used.
Maximum Frame Size
------------------
Registry Name: "MaxFrameSize"
Default value: 1514 (decimal)
Valid range: 12..9014 (decimal)
This parameter specifies the maximum frame size in bytes that the driver
will support. The performance of your network usually increases when
a large packet size is used. Do not use values larger than 1514 if you
are not sure if your network supports jumbo frames.
Hardware Checksumming
---------------------
Registry Name: "HwChecksum"
Default value: 1(On)
Valid values: 1 = "On"
0 = "Off"
This parameter is used to disable the hardware checksum offload for
TCP/IP. There should be no need to disable checksum offload.
Wake Up Capabilities
--------------------
Registry Name: "WakeUpModeCap_<n>" <n> = port designator (A or B)
Default value: 15 (OS Controlled)
Valid values: 0 = "None"
15 = "OS Controlled"
25 = "Magic Packet"
26 = "Pattern Match"
27 = "Magic Packet and Pattern Match"
28 = "Link Change"
- "None" wake on LAN capabilities are disabled
- "OS Controlled" wake up with the default settings
provided through the OS from Hibernate or Standby
state
- "Magic Packet" wake up with MagicPacket from ShutDown state,
OS Controlled from Hibernate or Standby state
- "Pattern Match" wake up with a packet containing a special pattern
from ShutDown state, OS Controlled from Hibernate
or Standby state
- "Magic Packet
and Pattern Match" wake up with both from ShutDown state, OS Controlled
from Hibernate or Standby state
- "Link Change" wake up with link change from ShutDown state,
OS Controlled from Hibernate or Standby state
This parameter is only available for V2.0 copper versions of the Marvell
Yukon Gigabit Ethernet Adapter.
Link Speed
----------
Registry Name: "Speed_<n>" <n> = port designator (A or B)
Default value: 1 (Auto)
Valid values: 1 = "Auto"
2 = "10"
3 = "100"
4 = "1000"
- "Auto" Auto-negotiate Speed
- "10" Force Speed to 10 MBit
- "100" Force Speed to 100 MBit
- "1000" Force Speed to 1000 MBit
This parameter is only available for V2.0 copper versions of the Marvell
Yukon Gigabit Ethernet Adapter.
Number of Receive Buffers
-------------------------
Registry Name: "MaxReceives"
Default value: 50 (decimal)
Valid range: 3..500 (decimal)
This parameters defines the number of receive buffers allocated by the
driver. If the system does not have enough resources the driver will fail
to load. Increasing this value may improve performance.
Number of Transmit Buffers
--------------------------
Registry Name: "MaxTransmits"
Default value: 50 (decimal)
Valid range: 4..200 (decimal)
This parameters defines the number of transmit buffers allocated by the
driver. If the system does not have enough resources the driver will
fail to load. Increasing this value may improve performance.
Interrupt Moderation
--------------------
Registry Name: "Moderate"
Default value: 1 (On)
Valid values: 1 = "On"
0 = "Off"
If more than the specified rate of interrupts occur, the function
Interrupt Moderation groups these interrupts so that several data packets
can be handled per interrupt. This will lead to lower CPU utilization
but may increase the latency.
Max IRQ per Sec
---------------
Registry Name: "FixedIntMod"
Default value: 5000 (decimal)
Valid range: 1000..30000 (decimal)
This parameter specifies the interrupt rate for Interrupt Moderation. If
Interrupt Moderation is set to "Off" it will be ignored.
Log Status Messages
-------------------
Registry Name: "MessageLog"
Default value: 1 (Status Messages)
Valid values: 0 = "All Messages"
1 = "Status Messages"
2 = "Warnings"
3 = "Errors"
4 = "None"
This parameter specifies the messages, which are to be logged in the
Event Log.
- "All Messages": This option should only be used for test purposes.
- "Status Messages": In this mode the driver will generate an event log
entry every time the link status changes.
- "Warnings": In this mode you will only receive warning or error
messages.
- "Errors": In this mode you will only receive error messages.
- "None": All driver messages will be suppressed. It is not
recommended to use this value.
AutoNegotiation
---------------
Registry Name: "AutoNegotiation_<n>" <n> = port designator (A or B)
Default value: 1 (On)
Valid range: 0 = "Off"
1 = "On"
2 = "Auto-Sense"
NOTE: If this parameter is set to "Off" and 'DuplexCapabilities' is
set to "half and full duplex" the driver will override the
setting and use "On" instead.
NOTE: Copper adapters do not support "auto-sense". This setting will be
treated like "On".
This parameter defines the auto-negotiation mode and can be set for each
port individually, which is helpful if the port at the other end of the
cable is limited in its capabilities. Using the default setting, the
Marvell Yukon Gigabit Ethernet Adapter should
automatically detect the capabilities of the peer port.
DuplexCapabilities
------------------
Registry Name: "DuplexCapabilities_<n>" <n> = port designator (A or B)
Default value: 3 (half and full duplex)
Valid range: 1 = "half duplex"
2 = "full duplex"
3 = "half and full duplex"
NOTE: This parameter is ignored if 'AutoNegotiation' is set to "auto-sense".
This parameter can be used to limit the duplex capabilities the port
reports during auto-negotiation. This parameter can be set for each port
individually, which is helpful if the port at the other end of the cable
cannot handle all possible combinations. Using the default setting, the
Marvell Yukon Gigabit Ethernet Adapter should
automatically detect the capabilities of the peer port.
FlowControl
-----------
Registry Name: "FlowControl_<n>" <n> = port designator (A or B)
Default value: 3 (Asymmetrical and Symmetrical Flow Control)
Valid range: 0 = "No Flow Control"
1 = "Asymmetrical Flow Control"
2 = "Symmetrical Flow Control"
3 = "Asymmetrical and Symmetrical Flow Control"
Modes:
- Symmetrical Flow Control: Both link partners are allowed to send
PAUSE frames.
- Asymmetrical and Symmetrical Flow Control: Both or only the remote
link partner are allowed
to send PAUSE frames.
- Asymmetrical Flow Control: Only the local link partner is allowed
to send PAUSE frames.
- No Flow Control: No link partner is allowed to send PAUSE frames.
NOTE: This parameter is ignored if 'AutoNegotiation' is set to "Off".
This parameter can be used to set the flow control capabilities the port
reports during auto-negotiation. This parameter can be set for each port
individually, which is helpful if the port at the other end of the cable
cannot handle all possible combinations. Using the default setting, the
Marvell Yukon Gigabit Ethernet Adapter should
automatically detect the capabilities of the peer port.
Role
----
Registry Name: "Role_<n>" <n> = port designator (A or B)
Default value: 0 (Auto)
Valid range: 0 = "Auto"
2 = "Master"
3 = "Slave"
NOTE: This parameter will be used only for copper adapters.
For two 1000Base-T ports to communicate, one must take the role of the
master (providing timing information), while the other must be slave.
Usually, this is negotiated between the two ports during link
establishment. If this fails, a port can be forced to a specific setting
with this parameter.
Preferred Port
--------------
Registry Name: "PreferredPort"
Default value: 1 (A)
Valid range: 1 = "A"
2 = "B"
NOTE: This parameter is only available for dual link adapters.
Use this parameter to set the preferred port the RLMT (Redundant
Link Management Technology) will use for all network traffic, if more than
one port has an active link to the network.
RLMT Mode
---------
Registry Name: "RlmtMode"
Default value: 1 (CLS)
Valid range: 1 = "CLS"
3 = "CLP"
7 = "CLPSS"
NOTE: This parameter is only available for dual link adapters.
Use this parameter to set the operational mode for the RLMT:
- "CLS" (Check Link State): RLMT uses the link state reported by the
adapter hardware for each individual port to determine whether a
port can be used for all network traffic or not.
- "CLP" (Check Local Port): In this mode, RLMT monitors the network path
between the two ports of an adapter by regularly exchanging packets
between them. This mode requires a network configuration in which
the two ports "see" each other (i.e. there must not be any router
between the ports).
- "CLPSS" (Check Local Ports and Segmentation Status): This mode supports
the same functions as the CLP mode and additionally checks network
segmentation by sending BPDU hello packets. Thus, this mode is only
to be used if Gigabit Ethernet switches are installed on the network
that have been configured to use the Spanning Tree protocol.
NOTE: RLMT modes "CLP" and "CLPSS" are designed to operate in
configurations where a network path between the ports on one adapter
exists. Moreover, they are not designed to work where adapters are
connected back-to-back.
If you should encounter any problems with your Marvell Yukon Gigabit
Ethernet Adapter, please re-read the instructions above and the
documentation supplied with the operating system.
Also refer to your system event log file (using the Event Viewer) and
check it for entries from YUKONX86.
If your particular problem is not listed or the error persists, please send
your system event log file or at least the event id number and the logging
data (as WORDs) of the entries made by YUKONX86 to our technical support.
*** End of Readme File ***