IBAUTIL
Intel(R) PCI NIC Boot ROM/WOL Flash Upgrade Utility
April 22, 2005
=========================================================================

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: Desktop adapters are normally shipped with both WOL and the Boot
        Agent (configured to use PXE) enabled.
      Server adapters are normally shipped with both WOL and the Boot
        Agent disabled.
      LOM implementations will vary.

To enable or disable these features you MUST use IBAUTIL. Other tools, 
such as 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.

Older adapters should be upgraded using the -UPGRADE option before trying  
to use any other IBAUtil function.

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, PRO/1000 and PRO/10GbE families of 
adapters.

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

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

IBAUtil accepts up to 16 simultaneous parameters. If conflicting 
parameters (such as the commands FLASHENABLE -FLASHDISABLE used together) 
are supplied, IBAUtil will exit with an error.

Where applicable, the parameters listed below are listed in logical 
groups. Note that -HELP, -EXITCODES and -IMAGEVERSION have special 
overriding characteristics. Unless noted otherwise, any parameter may be 
used in conjunction with any other parameter.

If IBAUtil is run without any command line options, it displays a listing 
of all of the Intel network adapters found in the system.

GENERAL OPTIONS

   -HELP or -?
        Displays command line help and exits. When -HELP is used, all 
        other parameters are ignored. 

   -EXITCODES
        Displays exit code help. When -EXITCODES is used, all other 
        parameters are ignored.

   -IMAGEVERSION or -IV
        Displays the PXE versions stored within IBAUTIL. When 
        -IMAGEVERSION is used, all other parameters are ignored.

   NOTE: The precedence of these parameters is as listed above. If two or 
         more of the above parameters are specified, the first one in the 
         list is used and the others are ignored.

ADAPTER SELECTION OPTIONS

   -ALL
        Selects all adapters found in system; works for both EEPROM and 
        FLASH activity.

   -NIC=XX
        Selects a specific adapter (1-16).

   NOTE: If there is more than one NIC in the system, one of these 
         options MUST be specified, or IBAUtil generates an error. If 
         there is only one NIC in the system, then all requested 
         operations will be performed on that NIC.

IMAGE PROGRAMMING OPTIONS

   -UP, -UPGRADE or -INSTALL { PXE | RPL }
        Programs an Intel Boot Agent image into the FLASH on the selected  
        NIC. 

        If the user specifies -UPGRADE or -INSTALL with one or more 
        additional keywords, IBAUtil will attempt to install the 
        requested image or images into the NIC's FLASH. The PXE and RPL 
        keywords may be used singly or in combination.

        If -AUTO is not specified and -SAVE is not specified, and the 
        FLASH is not blank, the user is prompted to save the existing 
        image before upgrading.

   -SAVE
        Saves the existing Intel Boot Agent flash image to a disk file. 

        The file will be named based on the PCI Vendor and Device ID of 
        the NIC. If this is specified on the same command line as 
        -UPGRADE, the save is performed before the upgrade.

   -RESTORE
        Restores a previously-saved Intel Boot Agent image. IBAUtil will 
        look for a file name based on the PCI Vendor and Device ID of the 
        NIC. If -RESTORE is specified on the same command line as 
        -UPGRADE, an error is generated.

UTILITY OPTIONS

   -AUTO or -QUIET
        Runs IBAUTIL without asking for user intervention. If used with 
        the -UPGRADE parameter IBAUtil 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 if 
        there is only one NIC in the system.

   -BLINK
	Blinks the LED on the selected adapter for ten seconds. 

   -FLASHENABLE or -FE
        Enables the Boot ROM.

   -FLASHDISABLE or -FD
        Disables the Boot ROM.


EEPROM SETTING OPTIONS

   -DEFAULTCONFIG or -DEFCFG
        Resets configuration and control words in the EEPROM back to 
        default settings. Specifically, word 30h in the EEPROM is set to 
        0100h and word 31h is set to 4000h. On dual-port adapters, words 
        34h and 35h are also set to these values. The checksum in the 
        EEPROM is updated to account for these new values. No other words 
        in the EEPROM are modified.

   -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 the Setup Menu.

   -SETUPDISABLE OR -STD
        Disables the Setup Menu.

   -TITLEENABLE OR -TLE
        Enables display of the initial title message.

   -TITLEDISABLE OR -TLD
        Disables display of the 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.

  -MESSAGEENABLE OR -MSE
	Enables the Control-S Setup Menu message.

  -MESSAGEDISABLE OR -MSD
	Enables the Control-S Setup Menu message.

   -LWSENABLE OR -LWSE
        Enables changing the Legacy OS Wakeup Support option.

   -LWSDISABLE OR -LWSD
        Disables changing the Legacy OS Wakeup Support option.

   -RPLBOOT
        Sets the boot protocol to RPL.

   -PXEBOOT
        Sets the boot protocol to PXE.

   -SETWAITTIME=X or -SWT=X
        Sets the Setup Menu wait time for the NIC to X seconds. Valid 
        wait 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.


All other parameters will generate an error.

ERROR CODES
------------------
IBAUTIL returns error codes to the OS environment. A description
of the error codes is found below.

ERROR CODE                      
==================================
SUCCESS                         0
BAD PARAMETER                   1
NO SUPPORTED ADAPTERS           2
INVALID ADAPTER SELECTED        3
FLASH OPERATION FAILED          4
EEPROM READ FAILED              5
EEPROM WRITE FAILED             6
IMAGE MISSING OR CORRUPT        7
OPERATOR TERMINATION            8
LOM NOT SUPPORTED               9
PORT NOT BOOTABLE               10
FLASH DISABLED                  11
FLASH TOO SMALL                 12
PROTOCOL NOT SUPPORTED          13
NOT CURRENTLY USED              14
NOT CURRENTLY USED              15
RPL NOT SUPPORTED               16
PXE NOT SUPPORTED               17


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 found in your system, 
    call IBAUTIL like this:

        IBAUTIL -ALL -WOLDISABLE

Example 2:
    To enable WOL on 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 -FLASHENABLE




Copyright (c) 2002-2005, Intel Corporation
All rights reserved.

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