IBAUTIL - for DOS systems
Intel(R) PCI NIC Boot ROM/WOL Flash Upgrade Utility
February 19, 2002
=========================================================================

DISCLAIMER:
-----------

This IBAUTIL.TXT as well as the software described in it is furnished under
license and may only be used or copied in accordance with the terms of the
license. The information in this manual is furnished for informational
use only, is subject to change without notice, and should not be construed
as a commitment by Intel Corporation. Intel Corporation assumes no
responsibility or liability for any errors or inaccuracies that may appear
in this document or any software that may be provided in association with
this document.
Except as permitted by such license, no part of this document may be
reproduced, stored in a retrieval system, or transmitted in any form or
by any means without the express written consent of Intel Corporation.


INTRODUCTION:
-------------

IBAUTIL is a utility program that changes the default settings of your
Intel WfM-compatible adapter.

IBAUTIL can be used to enable or disable the Wake-on-LAN and Boot Agent
capabilities, as well as enable or disable some settings used by the
Boot Agent.

IBAUTIL also allows for in-the-field upgrades to the image stored in the Flash
component of the NIC.

Wake-On-LAN: When enabled, the adapter can react to special 'wake up' packets
and power up the computer without end user intervention.
However, there is a higher power draw when the system is in the suspended
state once this is enabled.  It is strongly recommended that no more than 2
adapters should have this feature enabled per machine.

Intel Boot Agent: When enabled, the computer can initiate PXE/RPL boot if
a valid flash image is present on the NIC.

NOTE: The PRO/1000 T Desktop Adapter is shipped with the Boot Agent enabled
        for both WOL and PXE.
      The PRO/1000 XT Server Adapter is shipped with the Boot Agent disabled
        for both WOL and PXE.
      The PRO/100 S family of adapters is shipped with the Boot Rom enabled
        for both WOL and PXE.

To enable or disable these features you MUST use IBAUTIL.  Other tools,
like PROSet, can only be used to upgrade the Boot Agent image and change
Boot Agent configuration settings.

IBAUTIL is not intended as a utility for LAN-On-Motherboard (LOM)
implementations.  While IBAUTIL may be able to adjust the EEPROM settings
on LOM implementations, those changes may not affect how the adapter operates.

If the Boot Agent on the NIC is currently disabled, use the IBAUTIL
utility to enable the Boot Agent before using IBAUTIL or PROSet to
upgrade the image stored in the NIC.

If IBAUtil reports the Boot Agent as Invalid, run IBAUTIL with the -UPGRADE
option to refresh the image stored in the NIC.

A reboot is required for any changes to take effect.

IBAUTIL supports both the PRO/100 and PRO/1000 family of adapters.

Always check at http://support.intel.com for the latest Boot Agent
information and images. (Search for Boot Agent).

RUNNING IBAUTIL:
----------------

DOS:
	IBAUTIL [-option]...

NOTE: IBAUTIL (for DOS) must be run with the computer booted to DOS only.
This utility cannot be run in a DOS window in any Microsoft* Windows
product or in DOS compatibility mode in IBM* OS/2.

Command Line Parameters:
------------------------
IBAUTIL accepts up to 16 simultaneous parameters and does not perform both
operations if orthogonal parameters (like the commands -FLASHENABLE
-FLASHDISABLE used together) are supplied.   If opposing parameters are
specified, IBAUTIL will exit with an error.

The parameters are grouped with its orthogonal pair, if alone it has
no opposite.  Note that -HELP, -EXITCODES and -IMAGEVERSION have special
overriding characteristics.  Unless noted all other parameters may be used in
conjunction with all other parameters.

If you run IBAUTIL without any command line options, it will display a listing
of all of the Intel Network adapters found in your system.

   -HELP or -?
        Displays command line help and exits.  When -HELP is set,
        all other parameters are ignored.
   -EXITCODES
        Displays exit code help.  When -EXITCODES are set, all
        other parameters except -HELP are ignored.
   -IMAGEVERSION or -IV
        Displays the PXE versions stored within the IBAUTIL.  When
        -IMAGEVERSION is set, all other parameters except -EXITCODES and -HELP
        are ignored.

   -ALL
        Selects all adapters found in system, works for both EEPROM
        and Flash activity.
   -NIC=XX
        Selects a specific adapter (1-16).

   -AUTO or -QUIET
        Runs IBAUTIL without asking for user intervention.  It will NOT create
        a backup image.  This parameter must be used with -NIC or -ALL if
        there is more than one NIC in the system.  It will run without -ALL or
        -NIC=xx if there is only one NIC in the system..

   -BLINK
        Provides a method for identifying an adapter.  This feature is
        currently only supported on the PRO/1000 product line.

   -UPGRADE or -UP
        Downloads the Boot Agent stored within IBAUTIL to the
        adapters in the system.  User intervention is required to answer
        questions about backups and to select the appropriate NIC unless -AUTO
        is used.  IBAUTIL contains Boot Agent images for both the PRO/1000
        line of adapters as well as the PRO/100 line of adapters.  Note that
        some 82557 based NICs may not have a big enough Flash to receive the
        upgrade.  Consult your adapter documentation for more details.

   -DEFAULTCONFIG or -DEFCFG
        Resets Configuration and Control words in the EEPROM back to default
        settings.

   -FLASHENABLE or -FE
        Enables Boot ROM.
   -FLASHDISABLE or -FD
        Disables Boot ROM.

   -WOLDISABLE or -WOLD
        Disables WOL bit on Fast Ethernet and disables APMPME and APME
        EEPROM bits on Gigabit.
   -WOLENABLE or -WOLE
        Enables WOL bit on Fast Ethernet and enables APMPME and APME
        EEPROM bits on Gigabit.

   -SETUPENABLE or -STE
        Enables Setup Menu.
   -SETUPDISABLE OR -STD
        Disables Setup Menu.

   -TITLEENABLE OR -TLE
        Enables Initial Title Message.
   -TITLEDISABLE OR -TLD
        Disables Initial Title Message.

   -PROTOCOLENABLE OR -PROE
        Enables Changing the Boot Protocol Option.
   -PROTOCOLDISABLE OR -PROD
        Disables Changing the Boot Protocol Option.

   -ORDERENABLE OR -ORDE
        Enables Changing the Boot Order Option.
   -ORDERDISABLE OR -ORDD
        Disables Changing the Boot Order Option.

   -LWSENABLE OR -LWSE
        Enables Changing the Legacy OS Wakeup Support Option.
   -LWSDISABLE OR -LWSD
        Disables Changing the Legacy OS Wakeup Support Option.

   -SETWAITTIME=X or -SWT=X
        Set the setup delay time for the NIC to X seconds.
        Valid delay times are 0, 2, 3, and 5.  Only the first instance of
        this parameter will be valid.  All other instances of the
        parameter will generate an error.

   -RPL
        Sets the network boot protocol to RPL.
   -PXE
        Sets the network boot protocol to PXE.

   -MODE=X
        Sets the Customization Control word in the EEPROM to the value
        specified by X.  No range checking or validation will be done.  X must
        be in hexadecimal format.  This should only be used under direction of
        Intel Customer Support.

All other parameters will generate an error.

ERROR CODES (DOS):
------------------
IBAUTIL returns error codes to the DOS command line, a description of the
error codes is found below.

CODE NAME                     VALUE
SUCCESS                    	0
OPERATOR TERMINATION            1
INVALID NIC                     2
BAD COMMAND LINE PARAM          3
EEPROM CHECKSUM FAILURE 	4
EEPROM READ FAILURE             5
EEPROM WRITE FAILURE            6
EEPROM DUMP FAILURE             7
(Not used)                 	8
NO MEMORY                       9
NO NICS FOUND                   10


UPGRADE NOTE:
-------------
As part of the UPGRADE code path, IBAUTIL will save the backup image to the
current directory if the user elects to make a backup.  If that directory
is on a RAM drive, the backup image will not be available after the
machine reboots.  IBAUTIL will make no effort to warn the user about this.

EXAMPLES:
---------

Example 1:
To Disable WOL on all Intel Network Adapters, call IBAUTIL like this:
        IBAUTIL -ALL -WOLDISABLE

Example 2:
To Enable WOL on a the second Intel Network Adapter found in your
system, call IBAUTIL like this:
        IBAUTIL -NIC=2 -WOLENABLE

Example 3:
To Update the Boot Agent image on all Intel Network Adapters, call
IBAUTIL like this:
        IBAUTIL -ALL -UPGRADE

Example 4:
To Enable the Boot ROM on the first Intel Network Adapter
found in your system, call IBAUTIL like this:
        IBAUTIL -NIC=1 -BOOTENABLE

SUPPORTED FLASH DEVICES:
------------------------
Please note that even though a part may be listed here, it may not work on all
the hardware supported by IBAUTIL.  Some Flash listed here are for PRO/100
line use only, and can not be used on PRO/1000 adapters.  Please consult the
appropriate hardware design documentation to find out which flash devices will
work with what controllers.

VENDOR:     PART#:
-------     ---------
AMD         28F020
ATMEL       AT49BV512
ATMEL       AT29LV512
ATMEL       AT49LV010
ATMEL       AT49LV020
ATMEL       AT49LV040
ATMEL       AT49LV001N
CATALYST    28F256
CATALYST    28F512
CATALYST    28F010
CATALYST    28F020
INTEL       28F010
INTEL       28F020
SGS         28F512
SST         29LE512
SST         39SF512
SST         39VF512
SST	    39VF010
SST         39VF020
ST MICRO    28F512
ST MICRO    29W512B

Copyright (c) 2002 Intel Corporation
All rights reserved.

* Other names and brands may be claimed as the property of others.
---End of IBAUTIL.TXT---
