Intel 8 LAN User Manual

Intel® I/O Controller Hub 8 LAN NVM Map and Information Guide

January 2008

316234-006

Revision 2.8

Legal Lines and Disclaim er s

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL® PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. Intel products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications.

Intel may make changes to specifications and product descriptions at any time, without notice. Intel Corporation may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the

presented subject matter. The furnishing of docu ments and other materials and in formation d oes not prov ide any li cense, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights.

IMPORTANT - PLEASE READ BEFORE INSTALLING OR USING INTEL® PRE-RELEASE PRODUCTS. Please review the terms at http://www.intel.com/netcomms/prerelease_terms.htm carefully befo re us ing any Intel® pr e-r elease product, including any

evaluation, development or reference hardware and/or sof t ware product (collectively, “Pre-Release Product”). By using the Pre-Release Product, you indicate your acceptan ce of these term s , whi ch cons titute the agreement (the “Agreement”) between you and In tel Corporation (“I ntel”). In the event that you do not agree with any of these terms and conditions, do not use or install the Pre-Release Product and promptly return it unused to Intel.

Designers must not rely on the absence or characteristics of any features or instructions marked “reserved” or “undefined.” In tel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them.

Intel processor numbers are not a measure of perfor manc e. Pro ces so r num be r s differ entiate features within each processor family, not across different processor families. See http://www.intel.com/products/processor_number for details.

This document contains information on products in the design phase of development. The information here is subject to change without notice. Do not finalize a design with this information.

The I/O Control Hub (ICH8 ) may c ontai n des ign de fects o r er rors kno wn as er r ata whi ch ma y caus e the p ro duct to d evia te from p ub lished specifications. Current characterized errata are available on request.

Hyper-Threading Technology requir es a computer syste m with an Intel chipset, BIOS and operating system. Performance will vary depending on the specific hardware and software you use. See http://www.intel.com/

products/ht/Hyperthreading_more.htm for addition a l information.

Pentium® 4 processor supporting HT T echnology and a HT Technology enabled

Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order. Copies of documents which have an ordering number and are referenced in this document, or other Intel literature, may be obtained from: Intel Corporation

P.O. Box 5937 Denver, CO 80217-9808

or call in North Amer ica 1-800-548-4725, Europe 44-0-1793-431-155, France 44-0-1793-421-777, Germany 44-0-1793-421-333, other Countries 708296-9333.

Intel and Intel logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. *Other names and brands may be claimed as the property of others. Copyright © 2008, Intel Corporati on. All Rig ht s R es er ve d .

NVM Information Guide—ICH8

1.0 Non-Volatile Memory (NVM)......................................................................................5

1.1 Introduction .......................................................................................................5

1.2 NVM Programming Procedure Overview.................... .... ........................... ...............5

1.3 EEUPDATE Utility.................................................................................................7

1.3.1 Command Line Parameters....................... ... ........................... ...................7

1.4 LAN NVM Format and Contents..............................................................................8

1.4.1 Ethernet Individual Address (Words 00h - 02h) .......... .......................... ........9

1.4.2 Reserved (Word 03h)................................................................................9

1.4.3 Reserved (Word 04h).............................................................................. 10

1.4.4 Image Version Information (Word 05h) ..................................................... 10

1.4.5 Reserved (Word 06h).............................................................................. 10

1.4.6 Reserved (Word 07h).............................................................................. 10

1.4.7 PBA Low, PBA High (Words 08h and 09h) .................................................. 10

1.4.8 PCI Initialization Control (Word 0Ah)......................................................... 11

1.4.9 Subsystem ID (Word 0Bh).......................................................................11

1.4.10 Subsystem Vendor ID (Word 0Ch)............................................................ 11

1.4.11 Device ID (Word 0Dh)............................................................................. 12

1.4.12 Vendor ID (Word 0Eh) ................................ ........................... ................. 12

1.4.13 Device Rev ID (word 0Fh) .......................................................................12

1.4.14 LAN Power Consumption (Word 10h) ........................................................ 12

1.4.15 Shared Initialization Control (Word 13h).................................................... 13

1.4.16 Extended Configuration Word 1 (Word 14h) ............................................... 14

1.4.17 Extended Configuration Word 2 (Word 15h) ............................................... 14

1.4.18 Extended Configuration Word 3 (Word 16h) ............................................... 14

1.4.19 LED 1 Configuration and Power Management (Word 17h)............................. 15

1.4.20 LED 0 and 2 Configuration Defaults (Word 18h).......................................... 16

1.4.21 Future Initialization Word 1 (Words 19h) ................................................... 17

1.4.22 Future Init Word 2 (Word 1Ah)................................................................. 17

1.4.23 PXE Words (Words 30h - 3Eh)..................................................................18

1.4.24 Checksum (Word 3Fh) ............................................................................ 22

A ICH8 NVM Contents and Sample Images.................................................................. 23

A.1 82566DM NVM Image with ICH8 ......................................................................... 24

A.2 82566MM NVM Image with ICH8M ....................................................................... 25

A.3 82566MC NVM Image with ICH8.... .... .......................... ........................... ............. 26

A.4 82562V NVM Image with ICH8 ............................................................................ 27

Tables

1 LAN NVM Address Map................ ........................... .... .......................... .... ...................8

2 Ethernet Individual Address (Words 00h - 02h)..............................................................9

3 Reserved (Word 03h) .......... ... ........................... ........................... ... ...........................9

4 Reserved (Word 04h) .......... ... ........................... ........................... ... ......................... 10

5 Image Version Information (Word 05h)...................................................................... 10

6 Reserved (Word 06h) .......... ... ........................... ........................... ... ......................... 10

7 Reserved (Word 07h) .......... ... ........................... ........................... ... ......................... 10

8 PCI Initialization Control Word (Word 0Ah) .................................................................. 11

9 Device IDs for Intel

10 LAN Power Consumption (Word 10h) ................... ........................... ... ......................... 12

11 Shared Initialization Control (Word 13h) ..................................................................... 13

12 Extended Configuration Word 1 (Word 14h)................................................................. 14

13 Extended Configuration Word 2 (Word 15h)................................................................ 14

Platform LAN Connects ............................................................... 12

ICH8—NVM Information Guide

14 Extended Con fi gur ati on Word 3 (Word 16h) .................................. .... ..........................14

15 LED 1 Configuration and Power Management (Word 17h)...............................................15

16 LED Modes ..............................................................................................................16

17 LED 0 and 2 Configuration Defaults (Word 18h)............................................................16

18 Boot Agent Main Setup Options ..................................................................................18

19 Boot Agent Configuration Custo m iz ati on Optio ns (Word 31h)............ .......................... ....20

20 Boot Agent Configuration Custo m iz ati on Optio ns (Word 32h)............ .......................... ....21

21 IBA Capabilities........................................................................................................22

22 LAN NVM Contents....................................................................................................23

Revision History

Rev Rev Date Description

2.8 Jan 2008

2.7 Oct 2007 Updated word 19h bit descriptions. Removed section 1.5.

2.6 April 2007 Updated Table 15 (bits 13:12 description) and Table 24 (word 0Fh).

2.5 April 2007 R emov ed all references to ICH9. Minor edit all sections.

2.4 Jan 2007

2.3 Jan 2007 Added ICH9 and 82567 NVM information.

2.2 Oct 2006 Added device IDs for the 82562G and 82562GT 10/100 Mb/s Platform LAN Connects.

2.1 July 2006 Changed bit 1 of word 13h to 0b.

2.0 June 2006

1.75 April 2006 Updated bit descriptions for words 13h, 14h, and 19h.

1.5 Feb 2006

1.0 Dec 2005

0.75 July 2005 Initial release (Intel Secret).

Updated bit descriptions for words 0Fh, 13h, 14h, 15h, 16h, 32h, and 33h. Updated NVM images in Appendix A.

Updated sections 1.2, 1.4.6, 1.4.13, 1.4.14, 1.4.19, and 1.4.20. Added sections 1.4.25.1 through 1.4.25.4 (PXE words 30h through 33h).

Initial public release. Added new LAN Word Offset 19h description to Tables 1 and 17. Added new EEPROM images to Appendix A. Updated bit defaults and descriptions to Tables 9, 10, 13, 15, and 16.

Initial Intel Confidential release. Converted this to a stand-alone document. Previously, it was AP-478 Addendum. Added Section 1.1, ”NVM Programming Procedure Overview,” and Section 1.2,

”EEUPDATE Utility.” Updated the following sections: Section 2.12, ”Shared Initialization Control (Word 13h),” bits 10 and 0 Section 2.13, ”Extended Configuration Word 1 (Word 14h),” bits 15, 14, and 11:0 Section 2.14, ”Extended Configuration Word 2 (Word 15h),” bits 15:8 Section 2.15, ”Extended Configuration Word 3 (Word 16h)” Section 2.16, ”LED 1 Configuration and Power Management (Wo rd 17h),” bit 7 Section 2.17, ”LED 0 and 2 Configuration Defaults (Word 18h),” bit 7 Section 2.18, ”Future Initialization Word 1 (Words 19h)” Section 2.20, ”Checksum (Word 3Fh)” Appendix A.1 ”82566DM NVM Image with ICH8” Appendix A.3 ”82562V NVM Image with ICH8”

Updated Section 2.12, ”Shared Initialization Control (Word 13h),” Table 9 to add the Ext Pwr Polarity bit.

Added the 82566 NVM image to A.1 ”82566DM NVM Image with ICH8.”

ICH8—NVM Information Guide

1.0 Non-Volatile Memory (NVM)

1.1 Introduction

The document is intended for designs using the 10/100/1000 Mb/s LAN controller that is integrated into the Intel

The NVM space is used for hardware and software configuration. It is also read by software to determine and configure specific design features.

Unless otherwise sp ec ified, all numbers in this document use the f ollowing numbering convention:

• Numbers that do not have a suffix are decimal (base 10).

• Numbers with a suffix of “h” are hexadecimal (base 16).

• Numbers with a suffix of “b” are binary (base 2).

I/O Control Hub 8 (ICH8) device.

1.2 NVM Programming Procedure Overview

The LAN NVM shares space on an SPI Flash device (or devices) along with the BIOS, Manageability Firmware, and a Flash Descriptor Region. It is programmed through the ICH8. This combi ned image is show n in Figure 1. The Flash Descriptor Region is used to define vendor specific information and the location, allocated space, and read and write permissions for each region. The Manageability (ME) Region contains the code and configuration data for ME functions such as Intel and Advanced Fan Speed Control. The system BIOS is contained in the BIOS Region. The ME Region and BIOS Region are beyond t he scope of this document and a more detailed explanation of these areas can be found in the Intel (ICH8) Family External Design Specification (ICH8 EDS) . This document describes the LAN image contained in the Gigabit Ethernet (GbE) region. Fast Ethernet (82562V) images are also described.

Active Management Technology , ASF,

I/O Controller Hub 8

Flash Descriptor

Region

BIOS

Region

GbE

NVM Information Guide—ICH8

Figure 1. LAN NVM Regions

To access the NVM, it is essential to correctly setup the following:

1. A valid Flash Descriptor Region must be present. Details for the Flash Descriptor Region are contained in the ICH8 EDS. The method of configuring this descriptor region. This process is described in detail in the Intel

FTOOL.exe and the Intel

can be obtained as part of the Intel A c tive Client Manager kit on ARMS (https://platformsw.intel.com/) or by contacting your local Intel representative.

2. The GbE region must be part of th e original image flashed onto the part.

3. For Intel LAN tools and drivers to work correctly, the BIOS must set the VSCC register(s) correctly. This information is described in ICH8 EDS, section 24.1.

4. The GbE region of the NVM must be accessible. To keep this region accessible, the Protected Range reg ister of the GbE LAN Memory Mapped Con fi guration registers must be set to their default value of 0000 0000h. (The GbE Protected Range registers are described in the ICH8 EDS).

5. If you are using the 82566, the ICH8 soft strap for the GLCI interface must be set correctly . Bit 19 of STRP0 must be set to 1b (as described in the ICH8 EDS). F or the 82562V, this bit can be set to 0b, since it does not us e the GLCI bus.

Active Management Technology OEM Bring-Up Guide.

Active Manageme nt Technology OEM Bring-Up Gu ide

FTOOL.exe utility provi des the easiest

ICH8—NVM Information Guide

6. The sector size of the NVM must equal 256 bytes, 4 KB, or 64 KB. When a Flash device that uses a 64 KB sector erase is used, the GbE region size must equal 128 KB. If the Flash part uses a 4 KB or 25 6-byte sect or erase, then the GbE region size must be set to 8 KB.

The NVM image contains both static and dynamic data. The static data is the basic platform configuration, and includes OEM specific configuration bits as well as the unique Printed Circuit Board Assembly (PBA). The dynamic data holds the product’s Ethernet Individual Address (IA ) and C he c ksum. This file can be created in a simple text editor and follows the format shown in Appendix A, whic h provides examples of GbE Region NVM maps for ICH8-based designs. Fast Ethernet (82562V) images are also provided.

1.3 EEUPDATE Utility

Intel has created an EEUPD ATE utility that can be us ed to up date the GbE region images during in -circu it pro gr amming. T he too l uses t wo b asic d ata fil es outli ned i n the following sect io n ( sta tic data file and IA addres s file). The EEUPDATE utility is flexible and can be used to update the entire GbE region image or only the IA address of the LAN controller. In addition, it also corrects the GbE component checksum field after the region is modified (FTOOL does not have this ability). For more information on how to use EEUPDATE, refer to the utility.

eeupdate.txt file that is included with the EEUPDATE

To obtain a copy of this program, contact your Intel repres entative.

1.3.1 Command Line Parameters

The DOS command format is as follows:

EEUPDATE Parameter_1 Parameter_2

where:

Parameter_1 = /D or /A

/D is used to update the entire GbE region image. /A is used to update just the Et hernet Individual Address.

Parameter_2 = filename

In Example 1, Pa rameter_2 is a specific format used to update the complete GbE region. All comments in the file must be preceded by a semicolon (;).

Example 1. EEUPDATE /D file1.eep

In Example 1, Parameter 2 is EEUPDATE utility finds the first unused address from this file and uses it to update the NVM. An address is marked used if it is followed by a date stamp. When the utility uses a specific ad dress, a log file c alled eelog .dat is updat ed with that addre ss. This update d file should be used as the

Appendix A provides an example of the raw GbE region contents. F a s t Ethernet

(82562V) images are also provided.

file1.eep, which c ontains the complete NVM im age in

file2.dat, which contains a list of IA addresses. The

.dat file for the next update.

.eep

1.4 LAN NVM Format and Contents

Table 1 lists the NVM maps for the LAN region. Each word listed is described in detail in

the following sec tions.

Table 1. LAN NVM Address Map

NVM Information Guide—ICH8

LAN

Word

Offset

00h 00

01h 02

02h 04

03h 06 Reserved SW 0800h 04h 08 Reserved SW FFFFh 05h 0A Image Version Information 1 SW 06h 0Ch Reserved SW FFFFh 07h 0Eh Reserved SW FFFFh 08h 10h PBA Low SW 09h 12h PBA High SW 0Ah 14h PCI Initialization Control Word HW-PCI 0Bh 16h Subsystem ID HW-PCI 0Ch 18h Subsystem Vendor ID HW-PCI 0Dh 1Ah Device ID HW-PCI 0Eh 1Ch Vendor ID HW-PCI 0Fh 1Eh Device REV ID HW-PCI 10h 20h LAN Power Consumption HW-PCI 11h 22h Reserved 12h 24h Reserved

13h 26h Shared Initialization Control Word

14h 28h Extended Configuration Word 1

15h 2Ah Extended Configuration Word 2

16h 2Ch Extended Configuration Wo rd 3

17h 2Eh LEDCTL 1

18h 30h LEDCTL 0 2

19h 32h Future Initialization Word 1

1Ah 34h Future Initialization Word 2

NVM Byte

Offset

HIgh Byte (Bits 15:8) Low Byte (Bits 7:0) Used By

Ethernet Individual Address

Byte 2

Ethernet Individual Address

Byte 4

Ethernet Individual Address

Byte 6

Ethernet Individual Address

Byte 1

Ethernet Individual Address

Byte 3

Ethernet Individual Address

Byte 5

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

HW-

Shared

Image

Value

IA (2,1)

IA (4,3)

IA (6,5)

0000h

ICH8—NVM Information Guide

LAN

Word

Offset

1Bh to

2Fh

30h to

3Eh 3Fh 7Eh Software Checksum (bytes 00h through 7Dh) SW

Notes:

1. SW = Software: This is access from the network configuration tools and drivers.

2. PXE = PXE Boot Agent: This is access from the PXE Option ROM code in BIOS.

3. HW-Shared = Hardware - Shared: This is read on when the Shared Configuration is reset.

4. HW-PCI = Hardware - PCI: This is read when the PCI Configuration is reset.

NVM Byte

Offset

32h to

5Eh

60h to

7Ch

HIgh Byte (Bits 15:8) Low Byte (Bits 7:0) Used By

Reserved

PXE Software Region PXE

1.4.1 Ethernet Individual Address (Words 00h - 02h)

The Ethernet Individual Address (IA) is a six-byte field that must be unique for each adapter card or LOM and unique for each copy of the NVM image. The first three bytes are vendor specific . (For example, these bytes equal 00 AA 00 or 00 A 0 C9 for Intel products.) The last three bytes must be unique for each copy of the NVM. OEM versions of the product m ight be requ ired t o ha ve non- Inte l ID’ s in th e fi rst thr ee by te po sitio ns. The value from this field is loaded into the Receive Address Register 0 (RAL0/RAH0). The Intel default is listed in Table 2.

Table 2. Ethernet Individual Address (Words 00h - 02h)

Individual Address Byte

Word 00 Word 01 Word 02

Image

Value

Manufacturer MAC Address

Intel (original) 00AA00XXYYZZh AAh 00h XXh 00h ZZh YYh Intel (new) 00A0C9XXYYZZh A0h 00h XXh C9h ZZh YYh

Byte 2Byte 1Byte 4Byte 3Byte 6Byte

Note: The Ethernet IA is byte swapped, as listed in Table 2.

The IA bytes read from the NVM are used by the ICH8 until an IA Setup comm a nd is issued by software. The IA defined by the IA Setup command overrides the IA read from the NVM.

1.4.2 Reserved (Word 03h)

Table 3. Reserved (Word 03h)

Bit Name Default Description

15:12 Reserved 0000b These bits are reserved and should be set to 0000b. 11 IBA LOM 1b Must be set to 1b for Intel Boot Agent (IBA) to function correctly. 10:0 Reserved 0h These bits are reserved and should be set to 0h.

+ 19 hidden pages