Intel 8 LAN User Manual

205.9 Kb
Loading...

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

January 2008

316234-006 Revision 2.8

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 documents and other materials and information does not provide any license, 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 before using any Intel® pre-release product, including any evaluation, development or reference hardware and/or software product (collectively, “Pre-Release Product”). By using the Pre-Release Product, you indicate your acceptance of these terms, which constitute the agreement (the “Agreement”) between you and Intel Corporation (“Intel”). 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.” Intel 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 performance. Processor numbers differentiate 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 contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.

Hyper-Threading Technology requires a computer system with an Intel® Pentium® 4 processor supporting HT Technology and a HT Technology enabled 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 additional information.

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 America 1-800-548-4725, Europe 44-0-1793-431-155, France 44-0-1793-421-777, Germany 44-0-1793-421-333, other Countries 708- 296-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 Corporation. All Rights Reserved.

2

NVM Information Guide—ICH8

Contents

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® Platform LAN Connects ...............................................................

12

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

3

ICH8—NVM Information Guide

14

Extended Configuration 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 Customization Options (Word 31h)..........................................

20

20

Boot Agent Configuration Customization Options (Word 32h)..........................................

21

21

IBA Capabilities........................................................................................................

22

22

LAN NVM Contents....................................................................................................

23

Revision History

Rev

Rev Date

Description

 

 

 

2.8

Jan 2008

Updated bit descriptions for words 0Fh, 13h, 14h, 15h, 16h, 32h, and 33h.

Updated NVM images in Appendix A.

 

 

 

 

 

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

Removed all references to ICH9. Minor edit all sections.

 

 

 

2.4

Jan 2007

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).

 

 

 

 

 

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.

 

 

 

 

 

Initial public release.

2.0

June 2006

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.

 

 

 

1.75

April 2006

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

 

 

 

 

 

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

1.5

Feb 2006

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 (Word 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

1.0

Dec 2005

Ext Pwr Polarity bit.

 

 

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

 

 

 

0.75

July 2005

Initial release (Intel Secret).

 

 

 

4

ICH8—NVM Information Guide

1.0Non-Volatile Memory (NVM)

1.1Introduction

The document is intended for designs using the 10/100/1000 Mb/s LAN controller that is integrated into the Intel® I/O Control Hub 8 (ICH8) device.

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 specified, all numbers in this document use the following 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).

1.2NVM 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 combined image is shown 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® Active Management Technology, ASF, and Advanced Fan Speed Control. The system BIOS is contained in the BIOS Region. The ME Region and BIOS Region are beyond the scope of this document and a more detailed explanation of these areas can be found in the Intel® I/O Controller Hub 8 (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.

5

NVM Information Guide—ICH8

BIOS

Region 1

ME

Region 2

GbE

Region 3

Flash Descriptor

Region 0

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 FTOOL.exe utility provides the easiest

method of configuring this descriptor region. This process is described in detail in the Intel® Active Management Technology OEM Bring-Up Guide.

FTOOL.exe and the Intel® Active Management Technology OEM Bring-Up Guide can be obtained as part of the Intel Active Client Manager kit on ARMS (https://platformsw.intel.com/) or by contacting your local Intel representative.

2.The GbE region must be part of the 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 register of the GbE LAN Memory Mapped Configuration 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). For the 82562V, this bit can be set to 0b, since it does not use the GLCI bus.

6

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 256-byte sector 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 Checksum. This file can be created in a simple text editor and follows the format shown in Appendix A, which provides examples of GbE Region NVM maps for ICH8-based designs. Fast Ethernet (82562V) images are also provided.

1.3EEUPDATE Utility

Intel has created an EEUPDATE utility that can be used to update the GbE region images during in-circuit programming. The tool uses two basic data files outlined in the following section (static data file and IA address 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 eeupdate.txt file that is included with the EEUPDATE utility.

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

1.3.1Command 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 Ethernet Individual Address. Parameter_2 = filename

In Example 1, Parameter_2 is file1.eep, which contains the complete NVM image in a specific format used to update the complete GbE region. All comments in the .eep file must be preceded by a semicolon (;).

Example 1. EEUPDATE /D file1.eep

In Example 1, Parameter 2 is file2.dat, which contains a list of IA addresses. The 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 address, a log file called eelog.dat is updated with that address. This updated file should be used as the .dat file for the next update.

Appendix A provides an example of the raw GbE region contents. Fast Ethernet (82562V) images are also provided.

7

NVM Information Guide—ICH8

1.4LAN NVM Format and Contents

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

Table 1. LAN NVM Address Map

LAN

NVM

 

 

 

Image

Word

Byte

HIgh Byte (Bits 15:8)

Low Byte (Bits 7:0)

Used By

Value

Offset

Offset

 

 

 

 

 

 

 

 

 

 

 

 

 

00h

00

Ethernet Individual Address

Ethernet Individual Address

HW-

IA (2,1)

Byte 2

Byte 1

Shared

 

 

 

 

 

 

 

 

 

01h

02

Ethernet Individual Address

Ethernet Individual Address

HW-

IA (4,3)

Byte 4

Byte 3

Shared

 

 

 

 

 

 

 

 

 

02h

04

Ethernet Individual Address

Ethernet Individual Address

HW-

IA (6,5)

Byte 6

Byte 5

Shared

 

 

 

 

 

 

 

 

 

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

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

14h

28h

Extended Configuration Word 1

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

15h

2Ah

Extended Configuration Word 2

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

16h

2Ch

Extended Configuration Word 3

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

17h

2Eh

LEDCTL 1

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

18h

30h

LEDCTL 0 2

HW-

 

Shared

 

 

 

 

 

 

 

 

 

 

 

 

19h

32h

Future Initialization Word 1

HW-

0000h

Shared

 

 

 

 

 

 

 

 

 

 

 

1Ah

34h

Future Initialization Word 2

HW-

0000h

Shared

 

 

 

 

 

 

 

 

 

 

 

8

ICH8—NVM Information Guide

LAN

NVM

 

 

 

 

Image

Word

Byte

HIgh Byte (Bits 15:8)

 

Low Byte (Bits 7:0)

Used By

 

Value

Offset

Offset

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1Bh to

32h to

 

Reserved

 

 

2Fh

5Eh

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

30h to

60h to

PXE Software Region

PXE

 

3Eh

7Ch

 

 

 

 

 

 

 

 

 

 

 

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.

1.4.1Ethernet 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 A0 C9 for Intel products.) The last three bytes must be unique for each copy of the NVM. OEM versions of the product might be required to have non-Intel ID’s in the first three byte positions. 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

 

 

 

 

 

 

 

 

Manufacturer

MAC Address

Byte

Byte

Byte

Byte

Byte

Byte

2

1

4

3

6

5

 

 

 

 

 

 

 

 

 

 

Intel (original)

00AA00XXYYZZh

AAh

00h

XXh

00h

ZZh

YYh

 

 

 

 

 

 

 

 

Intel (new)

00A0C9XXYYZZh

A0h

00h

XXh

C9h

ZZh

YYh

 

 

 

 

 

 

 

 

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 command is issued by software. The IA defined by the IA Setup command overrides the IA read from the NVM.

1.4.2Reserved (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.

 

 

 

 

 

9

+ 19 hidden pages