Intel(R) EEUpdate Release Notes ================================ April 12, 2011 DISCLAIMER ========== This software 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. Contents ======== - OVERVIEW - RUNNING THE UTILITY - OPTIONS - BASIC USAGE GUIDELINES - EEPROM IMAGE FILE FORMAT - MAC ADDRESS FILE FORMAT - EELOG.DAT - EXAMPLES - ERROR CODES - INSTALLATION - CUSTOMER SUPPORT -LEGAL OVERVIEW ======== EEUpdate is the EEPROM Update Utility. Allows manufacturing programming of EEPROMs, in cases where EEPROM is not preprogrammed, or programmed at In-circuit test. RUNNING THE UTILITY =================== Using the "/?" option will display a list of supported command line options. NOTE: EEPROM checksums and CRCs are automatically updated with any command that modifies the EEPROM contents. OPTIONS: -------- EEUPDATE can be run with any of the following command line options: /HELP or /? Displays command line help. /EXITCODES Displays exit code help. /ALL Selects all adapters found in the system. /NIC=XX Selects a specific adapter (1-32). /BUS=XX Selects PCI bus of adapter to program. Must be used with the DEV parameter to specify an adapter. /DEV=XX Selects PCI device of the adapter to program. Must be used with the BUS parameter to specify an adapter. /FUN=XX Selects PCI function of the adapter to program. Must be used with both the BUS and DEV parameters to specify an adapter. /DEVICE=<pci device id> 4 hex digit device id of card to program. /SUBDEVICE=<pci subsystem device ID> 4 hex digit subsystem device id of card to program. /DUMP Dumps EEPROM memory contents to file. /MAC_DUMP_FILE Dumps the MAC address to a file usable by the /A command. /MAC_DUMP Displays the adapter LAN MAC address. /CB <offset> <bitmask> Clears bits in the EEPROM, specified in <bitmask>. /SB <offset> <bitmask> Sets bits in the EEPROM, specified in <bitmask>. /RW <word> Reads <word> from the EEPROM. /WW <word> <value> Writes <value> into <word> in EEPROM. /MAC=macaddr Programs the EEPROM with only the MAC address of macaddr without changing the rest of the EEPROM. /A <addrfile> or /address <addrfile> Programs the EEPROM with only the MAC address from the <addrfile> without changing the rest of the EEPROM. /D <imagefile> or /DATA <imagefile> Programs the EEPROM with the contents of <imagefile> without changing the MAC address. /CALCCHKSUM Forces the EEPROM checksum and CRCs to be updated. /EEPROMVER Displays the version of the EEPROM image. /PCIINFO Displays the PCI information of the adapter. /TEST Checks the EEPROM checksum and size. /IDFLASH Displays the flash ID and its protected status. /VERSION Displays version and the diagnostic library information. /GUI Brings up GUI mode. /GUI /HELP Displays GUI help. /NOPROT When programming an image for devices that support NVM protection, prevents protection from being enabled. This switch must be used with the /DATA command and has no effect on NVM devices that are already protected. /DEBUGLOG <debugfile> Log debug messages into the debugfile. /VERIFY <targetfile> Verifies the eeprom image in eeprom to the target file specified in <targetfile>. /ADAPTERRESET Reset the adapter. *CAUTION* This will unload the driver for this device if present. /SANMAC_DUMP Displays the dedicated MAC address for the SAN. /SANMAC=macaddr Programs the dedicated SAN MAC address without changing the rest of the EEPROM. /SANADDRESS <addrfile> Programs the dedicated SAN MAC address with the MAC address from <addrfile>. BASIC USAGE GUIDELINES ---------------------- To display a list of installed adapters call EEUPDATE without any parameters as follows: EEUPDATE EEUPDATE will display a list of network adapters installed in the system similar to the following: [EEUPDATE ver 5.0.1.0] - Intel PCI NIC EEPROM Utility Copyright (C) 1995 - 2004 Intel Corporation Intel (R) Confidential and not for general distribution. Warning: No Adapter Selected NIC Bus Dev Fun Vendor-Device Branding string === === === === ============= ================================================= 1 1 00 00 8086-1008 Intel(R) PRO/1000 XT Server Adapter 2 1 08 00 8086-1039 Intel(R) PRO/100 VE Network Connection To perform an operation on an installed network adapter you must specify the "/NIC=" parameter. For example, to perform an EEPROM dump on NIC 3 from the list above call EEUPDATE like this: EEUPDATE /NIC=3 /DUMP Alternatively you may specify the "/BUS=" and "/DEV=" parameters instead of the "/NIC=" parameter to specify which network adapter to select. For example to program NIC 1 from the list above with the EEPROM image file "image.eep" call EEUPDATE.EXE as follows: EEUPDATE /BUS=0 /DEV=0 /DATA image.eep EEPROM IMAGE FILE FORMAT ------------------------ The <imagefile> parameter designates a text file which contains hexadecimal values with which to program the EEPROM. Each value should consist of up to four hex digits separated by a space or newline. The data contained in <imagefile> must be formatted the same as the EEPROM imagefile produced by the "/dump" parameter. An imagefile produced by the "/dump" parameter may be used to program the EEPROM. Comments may be added to the EEPROM image file as long as they are preceded by a semicolon ';'. NOTE: When programming the EEPROM using the "/DATA" parameter, EEupdate will ignore the MAC Address (first 6 bytes), and EEPROM checksum (last 2 bytes). However, the MAC Address and checksum locations in the EEPROM image file must be filled with valid hexadecimal values. MAC ADDRESS FILE FORMAT ----------------------- The <addrfile> parameter designates a text file which contains MAC addresses to be programmed to the NIC. This file should contain a list of one or more legal MAC addresses, one per line. Each MAC address contains exactly 12 hexadecimal digits: Example: 000AC45D7800 000AC45D7801 000AC45D7802 A special "count" syntax may also be used. When a decimal integer in square brackets follows the mac address on the line, it is interpreted as a count of consecutive MAC addresses to be programmed. Example: 000AC45D7800 [3] The two examples above are the same. Both represent three consecutive MAC addresses starting at 000AC45D7800. Note: Every line in the address file must end with a carriage return. When EEUPDATE is executed with the <addrfile>, it will sequentially program each selected NIC with MAC addresses from the address file, starting with the first entry. A file, EELOG.DAT, is generated with a record of which MAC addresses were used and which remain available. To program the remaining MAC addresses, EEUPDATE must be run again with the EELOG.DAT specified for the <addrfile>. This is necessary because only EELOG.DAT contains the information on which MAC addresses have been programmed and which still remain available. Alternatively, the EELOG.DAT file may be copied over to the previous address file to eliminate the possibility of MAC Address reuse. (See Example 1 and 2). If EEUPDATE is run again using the same address file (without copying EELOG.DAT), it will program MAC addresses starting back at the first entry in the address file. Please use caution to always use the EELOG.DAT file in order to not program two different NIC ports with the same MAC address. Dual port adapters: When programming the MAC address and EEPROM from a file on a dual port adapter, the recommended method to only select the 1st port of the dual port adapter for programming. The MAC address file should therefore contain only the 1st port MAC addresses. This method is more efficient, as the EEPROM is only programmed once. 82580, 82598, 82599 adapters: These adapters require per port MAC address programming. Each port of the adapter must be selected and the desired MAC address programmed on each port. When programming the EEPROM image, only one port needs to be selected in order to program the EEPROM image file. (See Example 9) EELOG.DAT --------- When <addrfile> is used as a source for MAC addresses, EEUPDATE generates a file named EELOG.DAT which contains a record of which MAC addresses in <addrfile> were used and which remain available. Those addresses use...
Alek_NGI