Intel 82545GM/EM manual

PCI/PCI-X Family of Gigabit Ethernet Controllers Sof tware Developer ’ s Manual 82540EP/EM, 82541xx, 82544GC/EI, 82545GM/EM, 82546GB/EB, and 82547xx 317453006EN.PDF Revision 4.0[...]

ii Software De veloper’s Manual Legal Notice INFORMA TION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WI TH INTEL® PRODUCTS. NO LICE NSE, EXPRESS OR IMPLIED, BY ESTOPPEL O R OTHERWISE, T O ANY INTELLECTUAL PROPERTY RIGHTS IS G RANTED BY THIS DOCUMENT . EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUME[...]

Software Developer’s Manua l iii Revision History Date V ersion Comme nts Mar 2009 4.0 Updated Section 5 (added T able 5-15 “LED Configuration Defaults). Oct 2008 3.9 Updated section 8.7.4 “Discard P AUSE Frames and Pass MAC Control Frames”. June 2008 3.8 Updated EEPROM Word 21h bit descriptions (section 5.6.18). June 2008 3.7 Updated Secti[...]

iv Software De veloper’s Manual Note: This page is intentionally left blank.[...]

Software Developer’s Manua l v Contents Contents 1 Introduction ............... ............. ............. ................ ............. ............. ............. ................ .. 1 1.1 Scope ........ ............. ............ ............. ................. ............ ............. ................ ............ 1 1.2 Overview .........[...]

vi Software De veloper’s Manual Contents 3.2.5 Receive Descriptor Write-Back ................................ ... .... ... ............. ... 26 3.2.6 Receive Descriptor Queue St ructure..... ................ ............. ................ 26 3.2.7 Receive Interrupts .... ... ... ... .... ............. ... ... ... ... .... ............. ... ... ..[...]

Software Developer’s Manua l vii Contents 5.5 EEUPDATE Utility .. ... ... ... ............. ... .... ... ... ... ............. ... .... ... ... ... ............. ... .... ... ... 97 5.5.1 Command Line Parameters ............... ................ ............. ................ ... 97 5.6 EEPROM Address Map...... ................. ................ .[...]

viii Software De veloper’s Manual Contents 6 Power Management ....... ............ ................. ............. ............ ............. ................ ..... 131 6.1 Introduction to Power Management ....... ...... ............. ................ ............. ........... 131 6.2 Assumptions ....................... ............. ............[...]

Software Developer’s Manua l ix Contents 10.1.3 Blink Control ... ................ .......... ... ............. ............. ................ ........... 184 11 PHY Functionality and Features .............. ............. ............. ................ ............. . 1 87 11.1 Auto-Negotiation. ................ ............. ................. ..[...]

x Software De veloper’s Manual Contents 12 Dual Port Characteristics ........ ............. ............. ................ ............. ............. ........ 207 12.1 Introduction ........... ............. ................ ............. ................ ............. ................ ..... 207 12.2 Features of Each MAC .......... ............. [...]

Software Developer’s Manua l xi Contents 13.4.25 Receive Descriptor Base Address Low ....... .... ......... ............. ........... 306 13.4.26 Receive Descriptor Base Address High .......... ... ............. ............. .... 306 13.4.27 Receive Descriptor Length .... ...... ....... ............. ................ ............. .... 3 07 13.4[...]

xii Software De veloper’s Manual Contents 13.7.10 Collision Count .. ................ ............. ................ ............. ................ ..... 345 13.7.11 Defer Count .......... ................. ............. ............ ................. ............ ..... 346 13.7.12 Transmit with No CRS ....... ............. ................ .....[...]

Software Developer’s Manua l xiii Contents 13.8.5 Receive Data FIFO Packet Count ... ............ ............. ............. ........... 370 13.8.6 Transmit Data FIFO Head Regist er ................. ............. ............ ........ 370 13.8.7 Transmit Data FIFO Tail Regist er ............... ............. ............. ........... 371 13.8.8[...]

xiv Software De veloper’s Manual Contents Note: This page intentionally left blank.[...]

Introduction Software Developer’s Manua l 1 Introduction 1 1.1 Scope This document serves as a soft ware develope r ’ s manual for 82546GB/EB , 82545GM/E M , 82544GC/EI , 82541(PI/GI/EI) , 8254 1ER , 82547GI/EI , and 82540 EP/EM Gigabit Ether net Controllers. Throughout this manual references are m ade to the PCI/PCI-X Family of Gigabit Etherne[...]

Introduction 2 Software De veloper’s Manual For the 82544GC/EI , when connecte d to an appropriate SerDes, it can alternatively provi de an Ethernet interface for 1000 Base-SX or LX applicati ons (IEEE 802.3z). Note: The 82546EB/82545EM is SerDes PICMG 2.16 compliant. The 82546GB/82545GM is SerDes PICMG 3.1 compli ant. 82546GB/EB Ethernet control[...]

Introduction Software Developer’s Manua l 3 • IEEE 802.3x compliant flow control support — Enables control of the transmission of Pa use packets through software or hardware triggering — Provides indications of receive FIFO status • State-of-the-art internal transceiver (P HY) with DSP archit ecture implementation — Digital adaptive equ[...]

Introduction 4 Software De veloper’s Manual 1.3.5 Additional Performance Features • Provides adaptive Inter Frame Spacing (IFS) cap ability , en abling collision reduction in half duplex networks ( 82 544GC/EI ) • Programmable host memory receive buf fers (256 B to 16 KB) • Programmable cache line size from 16 B to 128 B for ef ficient usag[...]

Introduction Software Developer’s Manua l 5 1.3.6 Manageability Features (Not Ap plicable to the 82544GC/EI or 82541ER) • Manageability support fo r ASF 1.0 and AoL 2.0 by way of SMBus 2.0 interface and either: — TCO mode SMBus-based management packet transmit / receive support — Internal ASF- co mpliant TCO controll er 1.3.7 Additional Eth[...]

Introduction 6 Software De veloper’s Manual 1.4 Conventions This document uses notes that cal l attention to important comments: Note: Indicates details about the hardware’ s operations that are not immediat ely obvious. Read these notes to get information about exception s, unusual situations, and addi tional explanations of some PCI/PCI-X Fam[...]

Software Developer’s Manua l 7 Architectural Ov erview Architectural Overview 2 2.1 Introduction This section provides an overview of th e PCI/PC I-X Family of Gigabit Ethernet Controllers. The following sections give detailed informat ion about the Ethernet controller ’ s functionality , register description, and initialization seque n ce. All[...]

8 Software De veloper’s Manual Architectural Overview 2.2 External Architecture Figure 2-1 shows the external interfaces to the 82546GB/EB . Figure 2-1. 82546GB/EB Ex ternal Interface Figure 2-2 shows the external interfaces to the 82545GM/EM , 82544GC/E I , 82540EP/EM , and 82541xx . Figure 2-2. 82545GM/EM, 82544GC/EI, 82 540EP/EM, and 82541xx E[...]

Software Developer’s Manua l 9 Architectural Ov erview Figure 2-3 shows the external interfaces to the 82547GI/EI . Figure 2-3. 8254 7GI(EI) External In terface VLA N PCI Core EEPROM FLASH Slave Access Logic DMA Function Descriptor Management Control Status Logic Statistics TX/RX MAC CSMA/CD 40KB Packet RAM RX Filters (Perfect, Multicast, VLAN) M[...]

10 Software De veloper’s Manual Architectural Overview 2.3 Microarchitecture Compared to its predecessors, the PCI/PCI-X Family of Gigabit Ethernet Controller ’ s MAC adds improved receive-packet filt ering to support SMBus-based manageab ility , as well as the ability to transmit SMBus-based manageab ility packets. In addition, an ASF-compl ia[...]

Software Developer’s Manua l 11 Architectural Ov erview When the Ethernet controller serves as a PCI targ et, it follows the PC I co nfiguration specification, which allows all accesses to it to be automati cally mapped into free memory and I/O space at initialization of the PCI system. When processing transmit and receive frames, the Et hernet c[...]

12 Software De veloper’s Manual Architectural Overview • Offloading the receiving and transmitting IP and TCP/UDP checksums • Directly retransmitting from the transmit FIFO an y transmissions resulting in errors (col lision detection, data underrun ), thus eliminating the need to re-access this data from host memory 2.3.4 10/100/1000 Mb/s Rec[...]

Software Developer’s Manua l 13 Architectural Ov erview Note: Refer to the Extended Devi ce Control Regist er (bits 23:22) fo r mode selection (see Sect ion 13.4.6 ). The link can be configured by several methods. Software can force the l ink setting to Auto - Negotiation by setting either the MAC in TBI m ode (i nternal SerDes for the 825 46GB/E[...]

14 Software De veloper’s Manual Architectural Overview 2.3.8 FLASH Memory Interface The Ethernet controller provides an external para llel interface to a FLAS H device. Accesses to the FLASH are controlled by the Ethe rnet controller and a re accessible to software as normal PCI reads or writ es to the FLAS H memory mapping area. The Ethernet con[...]

Software Developer’s Manua l 15 Architectural Ov erview 2.5 Ethernet Addressing Several registers store Ethernet addresses in the Ethernet controller . T wo 32-bit registers make up the address: one is called “high”, and the other is called “low”. For example, the Receive Address Register is comprised of Receive Address High (RAH) and Rec[...]

16 Software De veloper’s Manual Architectural Overview 2.6 Interrupt s The Ethernet controller provides a complete set of inte rrupts that allow for efficient software management. The interrupt structure is designed to accompli sh the following: • Make accesses “thread-safe” by using ‘set’ and ‘cle ar -on-read’ rather than ‘read-m[...]

Software Developer’s Manua l 17 Architectural Ov erview 2.7 Hardware Acceleration Cap ability The Ethernet controller provides the ability to of fload IP , TCP , and UDP checksum for transmit. The functionality p rovided by these features can significantl y reduce processor utili zation by shifting the burden of th e function s from the driver to[...]

18 Software De veloper’s Manual Architectural Overview Descriptors store the following information about the buffers: • The physical address • The length • Status and command information about the referenced buffer Descriptors contain an end-of-packet field that indicates the last buf f er for a packet. Descriptors also contain packet-speci[...]

Software Developer’s Manua l 19 Receive and T ransmit Description Receive and T ransmit Description 3 3.1 Introduction This section describes the packet reception, packet transmission, tran smit descriptor ring structure, TCP segmentation, and transmit checksum offloading for the PC I/PCI-X Family of Gigabit Ethernet Controllers. Note: The 82544G[...]

Receive and Transmit Descript ion 20 Software De veloper’s Manual If manageability is enabled and if RCMCP is en abled then ARP request packets can be directed over the SMBus or processed intern ally by the ASF controller rather than delivered to host memory (not applicable to the 82544G C/EI or 82541ER . 3.2.2 Receive Dat a Storage Memory buffer[...]

Receive and T ransmit Description Software De ve loper’s Manual 21 layers. The packet checksum is always reported in t he first descriptor (even in the case of multi- descriptor packets). Upon receipt of a packet for Ethern et controllers, hardware stores the packet data into the indicated buffer and writes the length, Packet Checksum, status, er[...]

Receive and Transmit Descript ion 22 Software De veloper’s Manual Note: See T able 3-5 for a description of sup ported packet types for r eceive checksum offloading. Unsupported packet types eit her hav e the IXSM bit set, or they don’t have the TCPCS bit set. 3.2.3.2 Receive Descriptor Errors Field Most error inform ati on a ppears only when t[...]

Receive and T ransmit Description Software De ve loper’s Manual 23 T able 3-3. Receive Errors (RDESC.ERRORS) Layout 76 5 4321 0 RXE IPE TCPE RSV CXE a a. 82544GC/EI only. RSV SEQ RSV b b. 82541xx , 82547GI/EI , and 82540EP/EM only. SE RSV b CE Receive Descri ptor Err or bit s Description RXE (bit 7) RX Data Error Indicates that a data error occur[...]

Receive and Transmit Descript ion 24 Software De veloper’s Manual 3.2.3.3 Receive Descriptor S pecial Field Hardware stores additional information in the receive descriptor fo r 802.1q packets. If the packet type is 802.1q, determined when a packet type field m atches the VLAN 1 Ethernet Register (VET) and RCTL.VME = 1b, then the special field re[...]

Receive and T ransmit Description Software De ve loper’s Manual 25 3.2.4 Receive Descriptor Fetching The descriptor fetching strategy is designed to support large bursts across the PCI bus. This is made possible by using 64 on-chip receive descriptors and an optimized fe tching algorithm. The fetching algorithm attempts to make the best use of PC[...]

Receive and Transmit Descript ion 26 Software De veloper’s Manual 3.2.5 Receive Descriptor Write-Back Processors have cache line sizes that are larger than the receive desc riptor size (16 bytes). Consequently , writin g back descriptor informat ion for each received packet would cause expensive partial cache line updates. T wo mechanisms mini mi[...]

Receive and T ransmit Description Software De ve loper’s Manual 27 The receive descriptor head and ta il pointers reference 16-byte bloc ks of memory . Shaded boxes in the figure represent descriptors that have stored incoming packets but have not yet been recognized by software. Software can determine if a receive buf fer is valid by reading des[...]

Receive and Transmit Descript ion 28 Software De veloper’s Manual • Receive Descriptor T ail register (RDT) This register holds a value that is an of fset fr om the base, and identifies the location beyond the last descrip tor hardware can proc ess. Note that ta il should still point to an area in the descriptor ring (somewhere between RDBA and[...]

Receive and T ransmit Description Software De ve loper’s Manual 29 Figure 3- 3. Packet D elay Timer Operation (St ate Diagram) 3.2.7.1.2 Receive Interrupt Absolute Delay T imer (RADV) The Absolute T imer ensures that a receive interrupt is generated at some pr edefined interval after the first packet is received. The ab solute timer is started on[...]

Receive and Transmit Descript ion 30 Software De veloper’s Manual The diagrams below show how the Packet T ime r and Absolute Timer can be used together: 3.2.7.2 Small Receive Packet Detect A Small Receive Packet Detect in terrupt (ICR.SRPD) is asserted wh en small-packet detection is enabled (RSRPD is set with a non- zero value) and a packet of [...]

Receive and T ransmit Description Software De ve loper’s Manual 31 3.2.7.3 Receive Descriptor Minimum Threshold (ICR.RXDMT) The minimum descriptor threshold helps avoid d escriptor under-run by generating an i nterrupt when the number of free descriptors becomes equal to the minim um amoun t defined in RCTL.RDMTS (measured as a fraction of the re[...]

Receive and Transmit Descript ion 32 Software De veloper’s Manual The Packet checksum is the one’ s complement over the receive packet, starting from the byte indicated by RXCSUM.PCSS (0b corresponds to the fi rst byte of the packet ), after stri ppin g. For example, for an Ethern et II frame encapsulated as an 802.3 ac VLAN packet and with RXC[...]

Receive and T ransmit Description Software De ve loper’s Manual 33 T able 3-6. 82544GC/EI Supporte d Receive Checksum Capabilities T able 3-5 lists the general details about what packets ar e processed. In more detail, the packets are passed through a series of filters ( Section 3.2.9.1 t hrough Section 3.2.9.5 ) to determine if a receive checksu[...]

Receive and Transmit Descript ion 34 Software De veloper’s Manual 3.2.9.2 SNAP/VLAN Filter This filter checks the next headers looking for an IP header . It is capable of decoding Ethernet II, Ethernet SNAP , and IEEE 802.3ac headers. It skip s past any of thes e intermediate headers and looks for the IP header . The r eceive configuration settin[...]

Receive and T ransmit Description Software De ve loper’s Manual 35 • The protocol stack calculates the number of packets required to transmit this block based on the MTU size of the media and required packet headers. • For each packet of the data block: — Ethernet, IP and TCP/UDP head ers are prepared by the stack. — The stack interfaces [...]

Receive and Transmit Descript ion 36 Software De veloper’s Manual T able 3-7. T ransmit Descriptor (TDESC) Layout 3.3.3 Legacy T r ansmit Descriptor Format T o select legacy mode operatio n, bit 29 (TDESC. D EXT) should be set to 0b . In this case, the descriptor format is defined as sho wn in T able 3 -8 . The address and length must be suppli e[...]

Receive and T ransmit Description Software De ve loper’s Manual 37 Notes: 1. Even though CSO and CSS are in units of bytes, th e checksum calcu lation typically works on 16-bit words. Hardware does not enforce even byte alignment. 2. Hardware does not add the 802.1Q EtherT ype or the VLAN field following the 802.1Q EtherT ype to the checksum. So [...]

Receive and Transmit Descript ion 38 Software De veloper’s Manual 3.3.3.1 T ransmit Descriptor Command Field Format The CMD byte stores the applicable command and has fields shown in T able 3-10 . T able 3-10. T ransmit Command (T DESC.CMD) Layout 7 6 5 4 3 2 1 0 IDE VLE DEXT RSV RPS a a. 82544GC/EI only. RS IC IFCS EOP TDESC.CMD Description IDE [...]

Receive and T ransmit Description Software De ve loper’s Manual 39 Notes: 1. VLE, IFCS, and IC are qualified by EOP . That is, hardware interprets these b its ONL Y when EOP is set. 2. Hardware only sets the DD bit for descriptors wit h RS set. 3. Descriptors with the null address (0b) or zero le ngth transfer no data. If they have the RS bit set[...]

Receive and Transmit Descript ion 40 Software De veloper’s Manual Note: The DD bit reflects status of all descriptors up to and including the one with the RS bit set (or RPS for the 82544GC/EI ). 3.3.4 T ransmit Descriptor Special Field Format The SPECIAL field is used to provide the 802.1q/802.1ac tagg ing in form ation. When CTRL.VME is set to [...]

Receive and T ransmit Description Software De ve loper’s Manual 41 3.3.5 TCP/IP Context T ransmit Descriptor Format The TCP/IP context transmit desc riptor provides access to the enha nced checksum of fload facility available in the Ethernet controller . This featur e allows TCP and UDP pack et types to be handled more efficiently by performing a[...]

Receive and Transmit Descript ion 42 Software De veloper’s Manual 3.3.6 TCP/IP Context Descriptor Layout The following section describes the layout of th e TCP/IP context transmi t descrip tor . T o se le ct t hi s de sc rip to r fo rm at , bi t 2 9 (T DE SC .DE XT ) m ust be set to 1b a nd TD ESC .D TY P mu st be set to 0000b. In this case, the [...]

Receive and T ransmit Description Software De ve loper’s Manual 43 T able 3-14. T ransmit Descriptor (TDESC) Layout T ransmit Descriptor Offload Description TUCSE TCP/UDP Checksum Ending Defines the ending byte for the TCP/UDP checksum offload feature. Setting TUCSE field to 0b indicates that the checksum covers fr om TUCCS to the end of the pack[...]

Receive and Transmit Descript ion 44 Software De veloper’s Manual Notes: 1. A number of the fields are ignored if the TCP Segmentation enable bit (TDESC.TSE) is cleared, denoting that the descriptor does not refer to the TCP segmentati on cont ext. 2. Maximum limits for the HDRLEN and MSS fields are dictated by the lengths variables. How- ever , [...]

Receive and T ransmit Description Software De ve loper’s Manual 45 T able 3-15. Command Field (TDESC.TUCMD) Layout Note: 1. The IDE, DEXT , and RS bits are v alid regardless of the state of TSE. All other bits are i gnored if TSE = 0b. 2. The TCP Segmentation f eature also provides access to a gene ric block send function and may be useful for pe[...]

Receive and Transmit Descript ion 46 Software De veloper’s Manual 3.3.6.2 TCP/UDP Offload T ransmit Descriptor St atus Field Four bits are reserved to provide transmit status , althoug h only one is currently assigned for this specific descriptor type. The status word is only written back to host mem ory in cases where the RS is set in the comman[...]

Receive and T ransmit Description Software De ve loper’s Manual 47 T able 3-17. T ransmit Descriptor (TDESC) Layout – (T ype = 0001b) 0 Address [63:0] 8 Spec ial P OPTS RSV ST A DCMD DTYP DT ALEN 0 63 48 47 40 39 36 35 32 31 24 23 20 19 0 T ransmit Descripto r Description Address Data buffer address Address of the data buffer in the host memory[...]

Receive and Transmit Descript ion 48 Software De veloper’s Manual 3.3.7.1 TCP/IP Dat a Descriptor Command Field The Command field provid es op tions that control checks um offloading and TCP segmentat ion features along with some of the gene ric descriptor processing features. T able 3-18. Command Field (TDESC.DCMD) Layout 7 6 5 4 3 2 1 0 IDE VLE[...]

Receive and T ransmit Description Software De ve loper’s Manual 49 Note: The VLE, IFCS, and VLAN fields ar e only va lid in certain descriptors. If TSE is enabled, the VLE, IFCS, and VLAN fields are only valid i n the first data descriptor of the TCP segmen tation context. If TSE is not enabled, then these fields are only val id in the last descr[...]

Receive and Transmit Descript ion 50 Software De veloper’s Manual 3.3.7.3 TCP/IP Dat a Descriptor Option Field The POPTS field provides a number of options which control the handling of this packet. This field is ignored except on the first da ta descriptor of a packet. T able 3-20. Packet Options Field (TDESC.POPTS) La yout 3.3.7.4 TCP/IP Dat a [...]

Receive and T ransmit Description Software De ve loper’s Manual 51 When CTRL.VME is set to 1b, all packets transm itted from the Ethernet controller that has VLE set in the DCMD field is sent with an 802.1Q header added to the packet. The conten ts of the header come from the transmit descriptor special field and fr om the VLAN type register . Th[...]

Receive and Transmit Descript ion 52 Software De veloper’s Manual Figure 3-4. T ransmit Descriptor Ring Structure Shaded boxes in Figure 3 -4 represent descriptors that have b een transmitted but not yet reclaimed by software. Reclaiming involves freeing up buffers associated with the descriptors. The transmit descriptor ring is described by the [...]

Receive and T ransmit Description Software De ve loper’s Manual 53 Once activated, hardware fetches the descriptor indicated by the hardware head register . The hardware tail register points one beyond the last valid descri pto r . Software can determine if a packet has been se nt by setting the RS bit (or the RPS bit for the 82544GC/EI only) in [...]

Receive and Transmit Descript ion 54 Software De veloper’s Manual Since the benefit of delaying and then bursting transm i t descriptor write-backs is small at best, it is likely that the threshold are left at the defau lt va lue (0b) to force immediat e write-back of transmit descriptors and to preserve backward compatibi lity . Descriptors are [...]

Receive and T ransmit Description Software De ve loper’s Manual 55 • Link status change (LSC) - Set when the link st atus changes . When using the internal PHY , link status changes are determined and indicat ed by the PHY via a change in its LINK indication. When using an exte rnal TBI device ( 8254 4GC/EI only), the device might indicate a li[...]

Receive and Transmit Descript ion 56 Software De veloper’s Manual 3.5.1 Assumptions The following assumption applies to the TCP Segm entation implementation in the Ethernet controller: • The RS bit operation is not changed. Interrupts are set after data in buffers pointed to by individual descriptors is transferred to hardware. • Checksums ar[...]

Receive and T ransmit Description Software De ve loper’s Manual 57 3.5.2.1 TCP Segment ation Data Fe tch Control T o perform TCP Segm entatio n in th e Ethern et cont roller , the DMA unit must ensure that the entire payload of the segmented packet fits into the available space in the on-c hip Packet Buffer . The segmentation process is perform e[...]

Receive and Transmit Descript ion 58 Software De veloper’s Manual • TCP with options • UDP with limitatio ns. UDP (unlike TCP) is not a “reliable protocol”, and fragm e ntat ion is not supported at the UDP level. UDP messages that are larger than the MT U size of t he given network medi um are normally fragmented at the IP layer . This is[...]

Receive and T ransmit Description Software De ve loper’s Manual 59 • IPv4 Header — Length should be set to zero — Identification Field should be set as appropr iate for fi rst packet of send (if not already) — Header Checksum should be zero ed out unless some adjustment is n eeded by the driver • IPv6 Header — Length should be set to [...]

Receive and Transmit Descript ion 60 Software De veloper’s Manual Note: It is recommended that the entir e header sectio n, as described by the TCP Context Descriptor HDRLEN field, be coalesced into a single buffer and described using a single data descriptor . 3.5.7 IP and TCP/UDP Headers This section outlines the format and cont ent fo r the IP[...]

Receive and T ransmit Description Software De ve loper’s Manual 61 Figure 3- 9. IPv4 Head er (Littl e-Endian O rder) Flags Field Definition: The Flags field is defined below . Note that ha rdware does not evaluate or change these bit s. • MF More Fragments • NF No Fragments • Reserved Note: The IPv6 header is first shown in the tradi tional[...]

Receive and Transmit Descript ion 62 Software De veloper’s Manual The TCP header is first shown in the traditiona l (RFC 793) representation. Because byte and bit ordering is confusing in that representation, the TCP header is also shown in little-endi an format. The actual data is fetched from memory in little-endian format. Figure 3-1 1. TCP He[...]

Receive and T ransmit Description Software De ve loper’s Manual 63 TCP Lengt h = Payload + HDRLEN - TUCSS “Payload” is normally MSS except for the last packet where it represents the remainder of the payload. Figure 3-13. TCP Pseudo Header Cont ent (T raditional Represent ation) Figure 3-14. TCP PseudoHea der Content fo r IPv6 Note: The IP De[...]

Receive and Transmit Descript ion 64 Software De veloper’s Manual UDP pseudo header has the same format as the TCP pseudo header . The IPv4 pseudo header conceptually prefixed to the UD P header contains the IPv4 sour ce address, the IPv4 destination address, the IP v4 protoc ol field, and the UDP le ngth (same as the TCP Len gth discussed above)[...]

Receive and T ransmit Description Software De ve loper’s Manual 65 Three specific types of checksu m are supported by the hardware in the context of the TCP Segmentation offload feature: • IPv4 checksum (IPv6 does not have a checksum) • TCP checksum • UDP checksum Each packet that is sent via the TCP segmenta tion offload feature optionally[...]

Receive and Transmit Descript ion 66 Software De veloper’s Manual Figure 3-19. Overall Dat a Flow I P/ TCP H eader P acket Da ta P acket Da ta P acket Da ta HO S T M emo ry PC I F I F O H eader U pdat e C hec k sum C alculat ion T X Pa cket FIFO IP /T CP He ad er Bu f f er T C P S eg me n ta ti o n D ata F lo w De scr ip tor s f e tch IP /TC P H [...]

Receive and T ransmit Description Software De ve loper’s Manual 67 3.5.9.1 TCP/IP/UDP Header for the First Frame The hardware makes the following changes to the head ers of th e first packet that is derived from each TCP segmentation context. • IPv4 Header — IP T otal Length = MSS + HDRLEN – IPCSS — IP Checksum — IPv6 Header — Payload[...]

Receive and Transmit Descript ion 68 Software De veloper’s Manual 3.5.9.3 TCP/IP/UDP Header for the Last Frame The controller makes the following changes to the headers for the last frame of a TCP segmentation context: Note: Last frame payload bytes = P A YLEN – (N * MSS) • IPv4 Header — IP T otal Length = (last frame payload bytes + HDRLEN[...]

Receive and T ransmit Description Software De ve loper’s Manual 69 Three fields in the TCP/IP Cont ext Descriptor set the context of the IP checksum offloading feature: • IPCSS This field specifies the byte of fset form the start of the transferred data to the first byte to be included in the checksum. Setting this value to 0b mean s that the f[...]

Receive and Transmit Descript ion 70 Software De veloper’s Manual Note: This page intentionally left blank.[...]

Software Developer’s Manua l 71 PCI Local Bus Interface PCI Local Bus Interface 4 The PCI/PCI-X Family of Gigabit Ethernet Con tro llers are PCI 2.2 or 2.3 compliant devices and implement the PCI-X Addendum to the PCI Local Bus Sp eci fication, Revision 1.0. Note: The 82540EP/EM , 8254 1xx , and 82547GI/EI do no t su pport PCI-X mode. 4.1 PCI Con[...]

72 Software De veloper’s Manual PCI Local Bus Interface The following list provides ex planations of the various PCI registers and their bit fields: V endor ID This uniquely iden tifies all Int e l PCI products. This field may be auto -loaded from the EEPROM at power on or upon the assertion of PCI_R ST#. A value of 8086h is the default for this [...]

Software Developer’s Manua l 73 PCI Local Bus Interface Cache Line Size 1 Used to store the cache line size. The value is in units of 4 bytes. A system with a cache line size of 64 bytes sets the value of this register to 10h. The only si zes that are supported are 16, 32 , 64, and 128 bytes. All othe r sizes are treated as 0b. See the informatio[...]

74 Software De veloper’s Manual PCI Local Bus Interface All base address registers have the followin g fields: Field Bit(s ) Read/ Wri te Initial Va l u e Descript ion Mem 0 R 0b for mem 1b for I/O 0b indicates memory space. 1b indicates I/O. T ype 2:1 R 00b for 32- bit 10b for 64- bit Indicates the address space size. 00b = 32-bit 10b = 64-bit P[...]

Software Developer’s Manua l 75 PCI Local Bus Interface Expansion ROM Base Address This register is used to define the address and size information for boot- time access to the optional Flash memory . CardBus CIS Pointer (82541PI/GI/EI and 82540EP On ly) When the Enable CLK_R UN# bit of the EEPROM’ s Initialization Control W ord 2 and the 64/32[...]

76 Software De veloper’s Manual PCI Local Bus Interface Subsystem ID This value can be loaded automatically from the EEPROM upon power-up or PCI reset. A value of 1008h is the default for thi s field upon po wer-up if the EEPROM does not respond or is not programmed. Subsystem V endor ID This value can be loaded automatically from th e EEPROM upo[...]

Software Developer’s Manua l 77 PCI Local Bus Interface Max_Lat/Min_Gnt 1 The Ethernet controller places a very high load on the PCI bus during peak transmit and receive traffic. In full duplex mode, it has a peak throughput demand of 250 MB/sec. The peak delivered bandwidth on a 64-b it PCI bus at 33 MHz is 264 MB/sec, so the bus is fully satura[...]

78 Software De veloper’s Manual PCI Local Bus Interface T able 4-4. St atus Register Layout 40 b Memory Write and Invalidate Enable (not applicable to the 82547GI/EI ). 5 0b Palette Snoop Enable. 60 b Parity Error Response (not applicable to the 82547GI/EI ). 7 0b W ait Cycle Enable. 8 0b SERR# Enable ( not applicable to the 82547GI/EI ). 9 0b Fa[...]

Software Developer’s Manua l 79 PCI Local Bus Interface 4.1.1 PCI-X Confi guration Registers The Ethernet controller supports addi tion al configur ation registers that ar e specific to PCI-X. These registers are visible in conventional PCI an d PCI-X modes, although they only affect the operation of PCI-X mode. The PCI-X registers are linked int[...]

80 Software De veloper’s Manual PCI Local Bus Interface 4.1.1.3 PCI-X Com mand 15 7 6 4 3 2 1 0 Reserved Max. S plit Trans- actions Read Count RO DP Bits Read Wri te Initial Va l ue Description 0R W 0 b Data Parity Error Recovery Enable. If this bit is 1b, the Ethernet controller attempts to recover from Parity errors. If this bit is 0b, the Ethe[...]

Software Developer’s Manua l 81 PCI Local Bus Interface 4.1.1.4 PCI-X St atus 31 29 28 26 25 23 22 21 20 19 18 17 16 15 8 7 3 2 0 Res. Read Size Max. S plit Rd Byte Cplx USC SCD 133 64b Bus Number Device Number Func. Num. Bits Read/ Writ e Intial Va l u e Descripti on 2:0 R 0b Fu nction Number. This number forms p art of the Requester and Complet[...]

82 Software De veloper’s Manual PCI Local Bus Interface 4.1.2 Reserved and Undefined Addresses Any PCI or PCI-X register addres s space not explicitly declared in this specification should be considered to be reserved, and should not be written . W riting to reserved or undefined configuration register addresses can caus e in determinate behavior[...]

Software Developer’s Manua l 83 PCI Local Bus Interface 4.1.3 Message Signaled Interrupts 1 Message Signaled Interrupt (MSI) capabil ity is optional for PCI 2 .2 or 2.3, but required for PCI-X. When Message Signaled Interrupts are enabled, instead of asserting an interrupt pin, the Ethernet controller generates an i nterrupt using a mem ory write[...]

84 Software De veloper’s Manual PCI Local Bus Interface 4.1.3.1.3 Message Control 15 8 7 6 4 3 1 0 Reserved 64b Multiple Enable Multiple Capable En Bits Read/ Writ e Initial Va l u e Descript ion 0R 0 b MSI Enable. If 1b, Message Signaled Interrupts a are enabled and the Ethernet controller generates Message Signaled Interrupts instead of asserti[...]

Software Developer’s Manua l 85 PCI Local Bus Interface 4.1.3.1.4 Message Address 4.1.3.1.5 Message Upper Address 4.1.3.1.6 Message Dat a 4.2 Commands The Ethernet controller is capable of decoding and encoding com mands for both PCI and PCI-X modes. The difference between PCI and PCI-X commands is noted in T a ble 4-5 . Bit s Read/ Writ e Initia[...]

86 Software De veloper’s Manual PCI Local Bus Interface As a target, the Ethernet cont roller only accepts transactions that address its BARs or a configuration transaction in which its IDSEL inp ut is asserted. In PCI-X mode, the Ethernet controller also accepts split completion for an outstanding memory re ad command that it has requested. The [...]

Software Developer’s Manua l 87 PCI Local Bus Interface Following are a few specific rules: • For descriptor fetches, the burst length is always equal to the multiple of cache line sizes set by the transmit and receive descript or fetch threshold fields. (See Sect ion 3.2.4 and Section 3.4.1 ) For descriptor writes, the transfer size ranges fro[...]

88 Software De veloper’s Manual PCI Local Bus Interface Figure 4-4. Mast er W rite Command Usage Algorithm 4.3.1.1 M WI Bursts • If there is at least one cache line of data remaining, then the Ethernet controller continues the MWI burst. • If there is not at least one cache line of data re maining, then the Ethernet controller terminates the [...]

Software Developer’s Manua l 89 PCI Local Bus Interface 4.3.1.2 MW Burst s • The Ethernet controller always continues the burst until th e end. If the system is concerned about MWI usage, it disconnects at the cache line boundary . The Ethernet controller then restarts the transaction and re-evaluates command usage. Note: The algorithm describe[...]

90 Software De veloper’s Manual PCI Local Bus Interface Outstanding Memory Read When the Ethernet controller masters a memory read and is responded to wi th a split resp onse it waits for the completion of the data as a target. The Ethernet controller allows one outstanding memory read command at any time. The Ethernet controller continues to mas[...]

Software Developer’s Manua l 91 PCI Local Bus Interface 4.4.1 T arget T rans action T ermination When the Ethernet controller accepts a transaction as a target it always di sconnects the transaction after a single data phase by following the “Master Completion T ermination” in PCI 2.2, 2.3, or “Single data phase disconnect terminati on” i[...]

92 Software De veloper’s Manual PCI Local Bus Interface 4.7 CardBus Application (82541PI/GI/EI Only) The 82541PI/GI/EI has some features to facilitate its use in a CardBus application , following revision 7 of the PC Card specification. To u s e t h e 82541PI/GI/EI on CardBus, an external flash memo ry is requ ired . Con figure the Base Address R[...]

Software Developer’s Manua l 93 EEPROM Interface EEPROM Interface 5 5.1 General Overview The PCI/PCI-X Family of Gigabit Ethernet Controllers uses an EEPROM devi ce for storing product configurat ion informatio n. The EEPR OM is divided into four general regions: • Hardware accessed – loaded by the Ethernet contro ller after power-up, PCI Res[...]

94 Software De veloper’s Manual EEPROM Interface 5.2 Component Identification Via Programming Interface Ethernet controller stepping is identified by the following register contents. T able 5-1. Component Identificat ion Stepping V endor ID Device ID Descript ion 82547EI-A0 8086h 1019h Copper 82547EI-A1 8086h 1019h Copper 82547EI-B0 8086h 1019h C[...]

Software Developer’s Manua l 95 EEPROM Interface Note: These Ethernet controllers also provide identification data through the T est Access Port (T AP). 5.3 EEPROM Device and Interface The EEPROM access algorithm, progra mmed into the Ethernet controll er , is compatible with most, but not all, commer ically available 3.3 V dc Microwire* interfac[...]

96 Software De veloper’s Manual EEPROM Interface The EEPROM interface trace routing is not critical because the interf ace runs at a very slow speed. Note: For the 82544GC/EI , 82540EP/EM , 82541xx , and 82547 GI/EI , the EEPROM access algorithm drives extra pulses on the shift cloc k at the beginnin gs and ends of read and write cycles. the extr[...]

Software Developer’s Manua l 97 EEPROM Interface In ASF Mode 1 , the Ethernet controller's ASF function reads the ASF CRC word to determine if the EEPROM is valid. If the CRC is not valid, the AS F Configuration register s retain their default value. This CRC does not affect any of the remainin g Ethernet controller's c onfiguration, in[...]

98 Software De veloper’s Manual EEPROM Interface 5.6 EEPROM Address Map 1 T able 5-2 lists the EEPROM address map for the Ethe rnet controllers. E ach word listed is described in the sections that follow . Note: The “LAN A/B” column in T able 5-2 is only applicable to the 82546GB/EB . 1. Refer to T able 5-3 for the 82544GC/EI and 8254 1ER EEP[...]

Software Developer’s Manua l 99 EEPROM Interface Wor d Used By Bit 15 - 8 Bit 7 - 0 Image Va lu e LAN A/B 0Dh HW Device ID see Ta b l e 5-1 for specific image values LAN A 0Eh HW V endor ID 8086h both 0Fh HW Init C ontrol 2 3040h for the 82545GM/ EM and 82540EP/ EM B080h for the 82541xx and 82547GI/EI both 10h 11 h SW PHY Registers 82541xx and 82[...]

100 Software Deve loper’s Manual EEPROM Interface Wor d Used By Bit 15 - 8 Bit 7 - 0 Image Va l u e LAN A/B 17h 18h 19h 1Ah 1Bh 1Ch 1Dh 1Eh HW IPv6 Address Byte 2 IPv6 Address Byte 4 IPv6 Address Byte 6 IPv6 Address Byte 8 IPv6 Address Byte 10 IPv6 Address Byte 12 IPv6 Address Byte 14 IPv6 Address Byte 16 IPv6 Address Byte 1 IPv6 Address Byte 3 I[...]

Software Developer’s Manua l 101 EEPROM Interface Wor d Used By Bit 15 - 8 Bit 7 - 0 Image Va lu e LAN A/B 25h 26h HW IPv4 Address Byte 2 IPv4 Address Byte 4 IPv4 Address Byte 1 IPv4 Address Byte 3 IP(2,1) IP(4,3) LAN A 27h 28h 29h 2Ah 2Bh 2Ch 2Dh 2Eh HW IPv6 Address Byte 2 IPv6 Address Byte 4 IPv6 Address Byte 6 IPv6 Address Byte 8 IPv6 Address [...]

102 Software Deve loper’s Manual EEPROM Interface T able 5-3. 82544GC/EI and 82541ER EEPROM Address Map Word Address HW Access Description (Hi Byte) Description (Low Byte) Default Image V alue (hex) 00h Y es IA Byte 2 IA Byte 1 IA(2,1) 01h Y es IA Byte 4 IA Byte 3 IA(4,3) 02h Y es IA Byte 6 IA Byte 5 IA(6,5) 03h No Compatibility high Compatibilit[...]

Software Developer’s Manua l 103 EEPROM Interface 5.6.1 Ethernet Address (Words 00h-02h) The Ethernet Individual Address (IA) is a six-byte field that must be unique for each Ethernet port (and unique for each copy of the EEPROM image ) . The first three bytes ar e vendor specific. The value from this field is loaded into the Receive Address Regi[...]

104 Software Deve loper’s Manual EEPROM Interface 5.6.3 SerDes Configuration (W ord 04h) If this word has a value of other than FFFFh, software programs its value into the Extended PHY Specific Control Register 2, located at address 26d in the PHY register space (see T able 13-47 ). Note: SerDe s Configuratio n (W ord 04h) is a reserved area for [...]

Software Developer’s Manua l 105 EEPROM Interface 5.6.7 Initialization Control W ord 1 (W ord 0Ah) The first word read by the Ethernet contro ller contains initiali zation values that: • Sets defaults for some internal regist ers • Enables/disables specific features • Determines which PCI configuration space values are loaded from the EEPRO[...]

106 Software Deve loper’s Manual EEPROM Interface 5.6.8 Subsystem ID (W ord 0Bh) If the signature bits (15:14) and bit 1 (Load Subsys tem IDs) of word 0Ah are valid, this word is read in to initialize the Subsystem ID. 5.6.9 Subsystem V endor ID (Word 0Ch) If the signature bits (15:14) and bit 1 (Load Subsys tem IDs) of word 0Ah are valid, this w[...]

Software Developer’s Manua l 107 EEPROM Interface 5.6.10 Device ID (Word 0Dh, 1 1h 1 ) If the si gnature bits (15:14) and bit 1 ( Load Subsy stem IDs) of word 0Ah are valid, this word i s read in to initialize the Subsystem ID. For the 82546GB , the Device ID must be forced to 10 7Bh for SerDes-SerDes interface operation. For the 82545GM , the De[...]

108 Software Deve loper’s Manual EEPROM Interface Bit Name Description 8 MAC Clock S peed 82541PI/GI Only . 0b = MAC runs at full speed. 1b = MAC runs at 1/4 speed on any drop from 1000 Mb/s. Note: Reserved bit for all other Ethernet controllers (set to 0b ). Formally FLASH Disable, now located in Initialization Control Word 3, bit 3. 7 MSI Disab[...]

Software Developer’s Manua l 109 EEPROM Interface 5.6.13 PHY Register Address Dat a (W ords 10h, 1 1h, and 13h - 1Eh) These settings are specific to individu al platform configurations for the 8 2541xx and 82547GI/EI and should not be altered from the reference design unless instructed to do so. Futur e Intel Ethern et controllers might use this [...]

110 Software Deve loper’s Manual EEPROM Interface T able 5-8. Sof t ware Defined Pins Control (Word 10h, 20h) Bit Name D escription 15 SDPDIR[7] SDPDIR[3] for the 82541xx and 82547GI/EI SDP7(3) Pin - I n itial Direction. Set this bit to 0b (default) to configure the initial hardware va lue of the SDP7(3)_IODIR bit in the Extended Device Co ntrol [...]

Software Developer’s Manua l 111 EEPROM Interface Note: Since the 82546GB/EB is a dual-port device, the SDP con tro l in 10h corresponds to LAN B, and the SDP control in 20h corresponds to LAN A. 5.6.18 CSA Port Configuration 2 (Word 21h) For the 82547GI/EI on ly , this wo rd controls the CSA port configu ration and must be programm ed to 93A7h f[...]

112 Software Deve loper’s Manual EEPROM Interface 5.6.19 Circuit Control (Word 21h) This word is loaded into the C ircuit Control Register (CIRC) fo r setting PCI-X dri ver strength. See T able 5-2 and T able 5-3 for sug gested values. Note: PCI-X is not applicable to the 82540EP/EM , 82541 xx , and 82547GI/ EI . 5.6.20 D0 Power (Word 22h high by[...]

Software Developer’s Manua l 113 EEPROM Interface 5.6.24 Management Control (Word 13h 1 , 23h 2 ) The following table lists the initial settings for the Manageme nt Control Regi ster as well as valid bits for the IPv4 Address and the IPv6 Address. 1. Applicable to the 82546GB/EB only . 2. Not applicable to the 82544GC/EI or 82541ER . T able 5-10.[...]

114 Software Deve loper’s Manual EEPROM Interface Note: Since the 82546GB/EB is a dual-port device, the Management Control i n 13h corresponds to LAN B, and the Management Control in 23h corresponds to LA N A. 5.6.25 SMBus Slave Address (Word 14h 1 low byte, 24h low byte) The following table lists the SM Bus slave address for TCO mode. Note: This[...]

Software Developer’s Manua l 115 EEPROM Interface 5.6.26 Initialization Control 3 (Word 14h 1 high byte, 24h high byte) This word controls the general initializatio n valu es. Note: Since the 82546GB/EB is a dual -port device, the Initiali zation Control W o rd 3 bit assignm ents are port specific. 1. Applicable to the 82546GB/EB only . T able 5-[...]

116 Software Deve loper’s Manual EEPROM Interface 5.6.27 IPv4 Address (Words 15h - 16h 1 and 25h - 26h) The following table lists the initi al valu es for the IPv4 addresses. Note: Since the 82546GB/EB is a dual-port device, the IPv4 Address in 15 h-16h corresponds to LAN B, and the IPv4 Address in 25h-26h corresp onds to LAN A. 5.6.28 IPv6 Addre[...]

Software Developer’s Manua l 117 EEPROM Interface 5.6.29 LED Configuration Default s (Word 2Fh) 1 This EEPROM word specifies the hardware defaults for the LEDCTL register fields controlling the LED0/(LINK_UP#) and LED2/LINK100 output beha vio rs. Refer to T able 13-6 0 for the LED Control bit descriptions an d T able 13 -61 for the Mode En coding[...]

118 Software Deve loper’s Manual EEPROM Interface T able 5-16. Boot Agent Main Setup Options Bit Name Description 15 PPB PXE Presence. Setting this bit to 0b Indicates that the image in the FLASH contains a PXE image. Setting this bit to 1b indicates that no PXE image is contained. The default for this bit is 0b in order t o be backwards compatib[...]

Software Developer’s Manua l 119 EEPROM Interface 5.6.31 Boot Agent Configuration Customization Options (Word 31h) W ord 31h contains set tin gs that can be prog rammed by an OEM or network ad ministrator to customize the operation of the software. These set tings cannot b e changed from with in the Control - S setup menu or the IBA Intel Boot Ag[...]

120 Software Deve loper’s Manual EEPROM Interface . T able 5-17. Boot Agent Configurat ion Customization Opti ons ( Word 31h) Bit Name Description 15:14 SIG Signatu re. These bits must be set to 1b to indicate that this word has been programmed by the agent or other configuration software. 13:1 1 Reserved Reserved for future use. Set these bits t[...]

Software Developer’s Manua l 121 EEPROM Interface 5.6.32 Boot Agent Configuration Customization Options (Word 32h) W ord 32h is used to st ore the version of the boot agent that is stored in the FLASH image. When the Boot Agent lo ads, it can check t his value to d etermine if any first-time configuratio n needs to be performed. The agent then up[...]

122 Software Deve loper’s Manual EEPROM Interface 5.6.33 IBA Cap abilities (Word 33h) W ord 33h is used to enumerate th e boot technolog ies that have been programmed int o the FLASH. It is updated by IBA configuration tools and is not updated o r read by IBA. 5.6.34 IBA Secondary Po rt Configuration (Words 34h-35h) These words provide a unique c[...]

Software Developer’s Manua l 123 EEPROM Interface 5.6.35 Checksum Word Calculation (W ord 3Fh) The Checksum word (3Fh) should be calculated su ch that after adding all the words (00h-3Fh), including the Checksum word itself, the sum shoul d be BABAh. The initial value in the 16-bit summing register should be 0000h and the carry bit should be ig n[...]

124 Software Deve loper’s Manual EEPROM Interface 5.7 Parallel FLASH Memory All Ethernet controllers except the 82540EP/EM provide an external parallel interface to an optional FLASH or boot EEPROM device. Accesses to the FLASH memory are controlled by the Ethernet controllers, but are accessible to host so ftware as normal PCI reads or writes to[...]

Software Developer’s Manua l 125 EEPROM Interface Note: This page inten tionally left blank.[...]

126 Software Deve loper’s Manual EEPROM Interface[...]

Software Developer’s Manua l 127 FLASH Memory Interface FLASH Memory Interface 7 All Ethernet controllers (except the 82540EP/EM ) provide an external parallel interface to a FLASH, or boot ROM, device such as the Atmel A T49L V010 1 . All accesses to this device are managed by the Ethernet controller and are accessibl e to software as normal PCI[...]

128 Software Deve loper’s Manual FLASH Memory Interfa ce 7.2.1 Read Accesses Upon reads to the FLASH address space, the Ethernet controller uses the TRDY# signal to insert target wait states until valid data can be read from the FLASH device and presented on the data lines. When TRDY# is asserted, the Ethernet controller drives vali d data on th [...]

Software Developer’s Manua l 129 FLASH Memory Interface Figure 7- 2. FLASH B uffer Write Cycl e FRAME# AD CBE# I RDY# TRD Y# DEVSEL# STOP# ADDRESS DATA MEM- W R BE#s CLK 1 2 3 7 8 9 10 11 12 13 14[...]

130 Software Deve loper’s Manual FLASH Memory Interfa ce Note: This page is intentionally left blank.[...]

Software Developer’s Manua l 131 Power Management Power Management 6 6.1 Introduction to Power Ma nagement The PCI/PCI-X Family of Gigabit Ethernet Controllers sup port the Adv anced Configuration and Power Interface (ACPI) specificat ion as well as Advanced Power Management (APM). This section describes how Power Management is implemented in the[...]

132 Software Deve loper’s Manual Power Management 6.3 D3 cold support If the AUX pin is co nnected to logic 1b, the Ethernet controller advertises D3 cold W akeup sup port. The amount of power required for this function (w hich includes the entire Ethernet port circuitry) is advertised in the Power Management Data Register which is loaded from th[...]

Software Developer’s Manua l 133 Power Management 6.3.1.1 Dr St ate At initial boot-up, once LAN_PWR_GOOD is a sserted, the Ethernet controller reads the EEPROM. If the APM Mode bit in the EEPROM’ s Initialization Control W o rd 2 is set then APM W akeup is enabled. The system may maintain RST# asse rted for an arbitrary time. During this time,[...]

134 Software Deve loper’s Manual Power Management 6.3.1.3 D0a (D0 active) Once memory space is enabled, all in ternal clocks are activated, the Ethernet controller enters an active state, and can then transmit and receive packets if properly config ured by the software driver . The controller also sign als the PHY (if using the internal PHY) to i[...]

Software Developer’s Manua l 135 Power Management 6.3.2.1 Power Up (Off to Dr to D0u to D0a) Figure 6-2. S tartup T iming Power LAN_POWER_GOOD CLK# RST# DState PWR_STATE[1:0] D0u Reading EEPROM Read EEPROM D0a 00b if wakeup is disabled, 10b if wakeup is enabled 11b Memory Access 1 PCI Pins Running Wakeup Enabled Dr 2 00b APM Wakeup APM Wakeup 4 5[...]

136 Software Deve loper’s Manual Power Management 6.3.2.2 T ransition From D0a to D3 and Back Without PCI Reset Figure 6-3. T ransition from D0a to D3 and Back Without PCI Reset I_P CI_ CL K RST# PCI Pins PW R_STATE[1:0] Readi ng EE PROM Read EEPROM 11b 11b DState D3 D0u D0 Wak eu p En ab led Memory Access Enabl e Running D3 write APM only Any mo[...]

Software Developer’s Manua l 137 Power Management 6.3.2.3 T ransition From D0a to D3 and Back with PCI Reset Figure 6-4. T ransition From D0a to D3 and Back with PCI Reset CLK# RST# DSta te PW R_STATE[1:0] D0u Reading EEPR OM Read EEPR OM D0a 00b if wakeup is disabled, 01b if wakeup is enabled 11b Memor y Acces s Enable PCI Pin s W akeup Enabled [...]

138 Software Deve loper’s Manual Power Management 6.3.2.4 PCI Reset W ithout T ransition to D3 Figure 6-5. PCI Reset Sequence CLK# RST# DSta te PW R_STATE[1:0] D0u Reading EEPR OM Read EEPR OM D0a 00b if wakeup is disabled, 01b if wakeup is enabled 11b Memor y Acces s Enable PCI Pins Runn ing W akeup Enabled Dr 6 Any mode APM W akeup 11b D0a Runn[...]

Software Developer’s Manua l 139 Power Management 6.3.3 PCI Power Mana gement Registers Power Management registers are p art of the capabil ities linked list poin ted to by the Capabilities Pointer (Cap_Ptr) in the PCI configuration space. Refer to Section 4.1 . All fields are reset by LAN_PWR_GOOD. All of the fields except PME_En and PME_S tatus[...]

140 Software Deve loper’s Manual Power Management 6.3.3.3 Power Management Cap abilities - (PMC) 2 Bytes Offset = 2 (RO) Bit s Default R/W Description 15:1 1 See text Read Only PME_Support – This 5-bit field indicates the power states in which the function may assert PME# a . A value of 0b for any bit indicates that the function is not capable [...]

Software Developer’s Manua l 141 Power Management 6.3.3.4 Power Management Control / St atus Register - (PMCSR) 2 Bytes Offset = 4 (RO) This register is used to control and monitor power manageme nt events in the Ethernet controller . If auxiliary power is present, as indicated by AUX_POWER = 1b, a PCI reset does not clear PME_En and PME_S tatus [...]

142 Software Deve loper’s Manual Power Management 6.3.3.5 PMCSR_BSE Bridge Support Extensio ns 1 Byte Off set = 6 (RO ) This register indicates supp ort for PCI bridge spec ific functions. Note that these functions are not implemented in the Ethernet controller an d the valu es are set to 00h. 6.3.3.6 Dat a Register 1 Byte Off set = 7 (RO ) This [...]

Software Developer’s Manua l 143 Power Management If power management is not disabled and when the Data_Select field is program m ed to 0 or 4, the Ethernet controller sets the Data Register to the D0 Power value in the EEPROM. When the Data_Select field is program med to 3 or 7, th e Ethernet controller sets the Data Register to the D3 Power val[...]

144 Software Deve loper’s Manual Power Management • Maintains the first magic pack et received in the W akeup Packet Memory (WPM) until the driver writes a 0b to the Magic Packet Received MAG bit in the W akeup Status Register (WUS). “APM W akeup” is supported in all power states and only disabled if a su bsequent EEPROM read results in the[...]

Software Developer’s Manua l 145 Power Management After receiving a wakeup packet, the Ethernet controller ignores any subsequent wakeup packets until the driver clears all of th e “Received” bits in the W akeup St atus Register (WUS). It also ignores link change events until the driver clears the Link S tatus Changed (LNKC) bit in the W akeu[...]

146 Software Deve loper’s Manual Power Management The Ethernet controller generates a wakeup ev ent after receiving any p acket whose destination address matches one of the 16 valid programmed Receive Addresses if the Dir ected Exact W akeup Enable bit is set in the W akeup Filter Control Regist er (W UFC.EX). 6.4.3.1. 2 Directed Multicast Packe [...]

Software Developer’s Manua l 147 Power Management A Magic Packet’ s destination address must match th e address filtering enable d in the configuration registers with the exception that broadcast packets are consid ered to match even if the Br oadcast Accept bit of the Receive Control Register (RCTL. BAM) is 0b. If APM W akeup is enabled in the[...]

148 Software Deve loper’s Manual Power Management 6.4.3.1.5 ARP/IPv4 Request Pa cket 1 The Ethernet controller supports r eceiving ARP Request packets for wa keup if the ARP bit is set in the W akeup Filter Control Register (W UFC). Fo ur IPv4 addresses are supported whi ch are programmed in the IPv4 Address T a b le (IPv 4A T) 2 . A successfully[...]

Software Developer’s Manua l 149 Power Management 6.4.3.1.6 Directed IPv4 Packet 1 The Ethernet controller suppo rts receiving Directed IPv4 2 packets for wakeup if the IPv4 bit is set in the W akeUp Filter Control Register (WU FC) . Four IPv4 addresses are supported which are programmed in the IPv4 Address T able (IPv4A T). A successfully ma tch[...]

150 Software Deve loper’s Manual Power Management 6.4.3.2 Directed IPv6 Packet 1 The Ethernet controller suppor ts receiving Directed IPv6 packets for wakeup if the IP v6 bit is set in the W akeup Fi lter Control Register (WUFC). One IP v6 address is supported and it is programmed in the IPv6 Ad dress T able (IPv6A T). A successfully matched pack[...]

Software Developer’s Manua l 151 Power Management 6.4.3.3 Flexible Filter The Ethernet controller supports a total of four fl ex ible filters. Each filter i s configured to recognize any arbitrary pattern with in the first 128 bytes of the p acket. T o configure the flexible filter , the software driver must mask valu es into the Flexible Filter [...]

152 Software Deve loper’s Manual Power Management 6.4.3.3.2 Directed IPX Packet Example A valid Directed IPX Packet contains the station’ s MAC address, a Protocol T ype of 8137h, and an IPX Node Address that equals to the station’ s MAC address. It can include LLC/SNAP Head ers and VLAN T ags . Since filtering thi s packet relies on the flex[...]

Software Developer’s Manua l 153 Power Management 6.4.3.5 W akeup Packet Storage The Ethernet controller saves the fi rst 128 bytes of the wakeup packet in its intern al buffer , which can be read through t he W akeup Packet Memory (WUPM) after system wakeup. 18+D+S 2 Payload Length - Ignore 20+D+S 1 Next Header 3Ah, 00h, 2Bh, or 3Ch Check ICMP ,[...]

154 Software Deve loper’s Manual Power Management Note: This page intentionally left blank.[...]

Software Developer’s Manua l 155 Ethernet Interface Ethernet Interface 8 8.1 Introduction The PCI/PCI-X Family of Gigabit Ethernet Co n tro llers provi de a compl ete CSMA/CD function supporting IEEE 802.3 (10Mb/s) , 802.3u (100Mb/s), 802.3z and 802.3ab (1000Mb/s) implementations. They perform all of the functions required for transmission, recep[...]

156 Software Deve loper’s Manual Ethernet Interface 8.2.1 Internal SerDes Interface/TBI Mode– 1Gb/s 1 The 82546GB/EB and 8254 5GM/EM Ethernet controllers contain one or two int e rn al Se rD es devices (depending whether or not they support one or tw o ports). The MAC communicates with the SerDes over a TBI interface. Normally , this interface [...]

Software Developer’s Manua l 157 Ethernet Interface 8.2.1.3 Code Group s and Ordered Sets Code group and ordered set definitions are defined in clause 36 of the IEEE 802.3z standard. These represent special symbols used in the en capsulation of Gigabit Ethernet packets. T able 8-1 lists a brief description of defined ordered set s for informat io[...]

158 Software Deve loper’s Manual Ethernet Interface 8.2.3 MII – 10/100 Mb/s The internal MII implementation fo r the Ethernet controller provides full IEEE 802.3 and IEEE 802.3u compliant operation for 10Mb/s and 100Mb /s operation in conjunction with the onb oard MII compliant PHY . The MII uses a clocked, nibble-wide (4-bit) data path in each[...]

Software Developer’s Manua l 159 Ethernet Interface Configuration of the duplex operation of the Ethern et controller can be forced or determined via the Auto-Negotiation process. See Section 8.6 for details on link configuration setup and resolution. 8.4.1 Full Duplex All aspects of the IEEE 802.3, 802.3u, 802.3z, and 802.3ab specification s are[...]

160 Software Deve loper’s Manual Ethernet Interface For receives, the Ethernet cont roller supports carrier extended packets and packets generated during packet burstin g operations (see Section 8.4.2.1 and Section 8.4.2. 2 ). The Ethernet controller can be configured to tran smit in packet burst mode via the TCTL.PBE bit in the Transmit Control [...]

Software Developer’s Manua l 161 Ethernet Interface The normal ru les for IPG are followed during packet bursting after the first packet has met the minimum slot ti me req u ir ements, with the exception that the Inter Frame Content (IFC) is extension symbols rath er than IDLEs. Under some circumst ances, it might be desirable to extend this IPG [...]

162 Software Deve loper’s Manual Ethernet Interface The following section describes the link confi gur ation process in the In ternal Serdes for the 82546GB/EB an d 82545GM/EM (TBI mode for the 82544GC/EI ) and internal PHY modes. 8.6.1 Link Configuration in Internal Serdes/TBI Mode 1 Internal Serdes for the 82546GB/EB and 82545GM/EM (TBI for the[...]

Software Developer’s Manua l 163 Ethernet Interface A set of registers is provided to facili tate either hardware or software Aut o-Negotiation. The hardware supports both hardware and software Auto-Negotiation m etho ds for determining link configuration as well as allo wing for manual configuration to force the link. The IEEE 802.3z specificati[...]

164 Software Deve loper’s Manual Ethernet Interface Figure 8-3. 802.3z Advertised Base Page Ma pping T able 8-2. Bit s Content in TXCW .txConfigWord The reserved bits should be writte n as zero. The remote fault bits [1 3 :12] can be set by software t o indicate remote fault t ype to the link partner if desired. The AS and PS bits are used for ad[...]

Software Developer’s Manua l 165 Ethernet Interface 8.6.1.5 Forcing Link In cases where the Ethernet controller is conn ected to a non-Au to-Negotiating link partner, the hardware allows for manual configuration of th e link via the Device Cont rol regi st er (CTRL). Forcing link can be accomplished by software writing a 1b to CTRL.SLU which forc[...]

166 Software Deve loper’s Manual Ethernet Interface Once PHY Auto-Negotiation is complete, the PHY asserts the link indi cation signal. Softw are MUST set th e “set link up” bit in the Device Control Register (C TRL.SLU) before the Ether net controller recognizes the link. Setting the SLU bit permits the MAC to recognize th e LINK signal from[...]

Software Developer’s Manua l 167 Ethernet Interface ST A TUS.ASDV [9:8], provi des the results of sp eed status indication for diagnostics purposes regardless of whether the Auto-Speed Detection feature is enabled. Th is function is in itiated with a write to the CTRL_EXT .ASDCHK bit. See Section 13.4.6 for d etails. 8.6.2.2.3 Automatic Detection[...]

168 Software Deve loper’s Manual Ethernet Interface 8.6.3 Internal SerDes Mode 1 Control Bit Resolution Ta b l e s 8-3 , 8-4 , and 8-5 2 list how on-chip Aut o-Negotiation affects control bits i n the Ethernet controller . Ta b l e 8 - 5 lists the case where software Auto-Neg otiation is not performed and link is forced. T able 8-3. Internal Serd[...]

Software Developer’s Manua l 169 Ethernet Interface T able 8-5. Internal Serdes Mode 1 – Auto-Negotia tion Skipped TXCW .ANE = 0b 8.6.4 Internal PHY Mode Control Bit Resolution Ta b l e s 8-6 , 8-7 , 8-8 , and 8-9 list how Auto-Negotiation affects control bits in the Ethernet Controller . Refer to IEEE 802.3z, clause 37 for information related [...]

170 Software Deve loper’s Manual Ethernet Interface T able 8-7. GMII/MII Mode – Auto-S peed Detection CTRL.FRCSPD = CTRL.FRCDPLX = 0b; CTRL.ASDE = 1b T able 8-8. GMII/MII Mode – Force Speed CTRL.FRCSPD = 1b; CTRL.FRCD PLX = 0b; CTRL.ASDE = X Control Bit Effect on Control Bits CTRL.FD Duplex is set per internal duplex indication after link up [...]

Software Developer’s Manua l 171 Ethernet Interface T able 8-9. GMII/MII Mode – Force Link CTRL.FRCSPD = CTRL.FRCD PLX = CTRL.SLU = 1b 8.6.5 Loss of Signal/Link S t atus Indication For the 82546GB/E B and 82545GM/EM , the internal LOS signal allows for indication of physical link status to the Ethernet controller ’ s MAC. For the 82544GC/EI ,[...]

172 Software Deve loper’s Manual Ethernet Interface 8.7 10/100 Mb/s S pecific Performance Enhancements 8.7.1 Adaptive IFS 1 The Ethernet controller supports back-to-back transmit Inter -Frame-Spacing (IFS) of 960 ns in 100 Mb/s operatio n and 9.6  s in 10 Mb/s operation. Although back-to-back transmission is normally desirable, sometimes it ca[...]

Software Developer’s Manua l 173 Ethernet Interface 8.7.2 Flow Control Flow control as defined in IEEE specificatio n 8 02.3x, as well as the specific operation of asymmetrical flow control de fin ed by 802.3z, ar e supported. The following registers are defined for the implementation of flow control: Flow control is implemented as a means of red[...]

174 Software Deve loper’s Manual Ethernet Interface The final check for a valid P AUS E fram e is the MAC Control Op code. At thi s time onl y the P AUSE control frame opcode is defined. It has a value of 0001h. Frame based flow control diff er entiates XOFF from XON based on the value of the P AUSE timer field. Non-zero values constitute XOFF fr[...]

Software Developer’s Manua l 175 Ethernet Interface Flow control capabilit y must be neg otiated between link partners via the Auto-Neg otiation process. The Auto-Negotiation process can m odify the value of th ese bits ba sed on the resolved capability between the local devi ce and the link partner . Once the receiver has validated the reception[...]

176 Software Deve loper’s Manual Ethernet Interface 8.7.5 T ransmission of P AUSE Frames T ransmitting P A USE frames is enabled by so ftware writing a 1b to the CTRL.TFCE bit. This bit is mapped to bit 8 of the TXCW txConfigW ord field. (ASM_DIR bit). Similar to the reception flow cont rol packets described earlier , XO FF packets can be transmi[...]

Software Developer’s Manua l 177 Ethernet Interface When the XOFF signal is asserted high, the device transmits a single XOFF frame. The assertion of I_XON (after deassertion of XOFF) initiate s an XON frame transmis sion if enabled by FCR TL.XONE. The assertion/deassertion of XON is required between asserti ons of XOFF in order to send another X[...]

178 Software Deve loper’s Manual Ethernet Interface Note: This page intentionally left blank.[...]

Software Developer’s Manua l 179 802.1q VLAN Support 802.1q VLAN Support 9 The PCI/PCI-X Family of Gigabit Ethernet Con t rollers provide several specific mechanisms to support 802.1q VLANs: • Optional adding (for transmit s) and stripping (for receives) of IEEE 802.1q VLAN tags • Optional ability to filter packets belongin g to certain 802.1[...]

180 Software Deve loper’s Manual 802.1q VLAN Suppor t T able 9-2. 802.1q T agged Frames 9.2 T ransmitting and Receiving 802.1q Packet s Since the 802.1q tag is only four bytes, adding a nd stripp ing of tags can done com pletely in software. (For transmits, software inserts the tag into packet data before it builds the transmit descriptor list, a[...]

Software Developer’s Manua l 181 802.1q VLAN Support In summary , the 4096 bit vect or is composed of 1 28 32-bit registers. Match ing to this bit vector follows the same algorithm as indicated in Section 13.5.1 for Multicast Address filtering. The VLAN Identifier (VID) field consists of 12 bits. Th e upper 7 bits of this field are decoded to det[...]

182 Software Deve loper’s Manual 802.1q VLAN Suppor t Note: This page intentionally left blank.[...]

Software Developer’s Manua l 183 Configurable LED Outputs Configurable LED Outputs 10 10.1 Configurable LED Output s 1 The PCI/PCI-X Family of Gigabit Ethernet Controller ’ s MAC implements fo ur output drivers intended for driving external LED circuits. Each MAC’ s fo ur LED outp uts can be individually configured to select the particular ev[...]

184 Software Deve loper’s Manual Configurable LED Outputs LED outputs can be based on the following expressions: • LINK_UP is asserted while lin k of any speed is maintained • LINK_10 indicates l ink at 10 Mb ps • LINK_100 indicates link at 100 Mbp s • LINK_1000 indicates li nk at 100 0 Mbps • LINK_100/1000 indicat es link at either 100[...]

Software Developer’s Manua l 185 Configurable LED Outputs Note: It is especially important to note wit h respect to the blink- control circuit that: • the blink circuit, when enabled, exists as the LAST stage of the LED circuitry , after any (optional) signal inv ersion • the blink sequence occurs when the circuit input is asserted low As a r[...]

186 Software Deve loper’s Manual Configurable LED Outputs Note: This page is intentionally left blank.[...]

Software Developer’s Manua l 187 PHY Functionality and Feature s PHY Functionality and Features 11 1 1.1 Auto-Negotiation Auto-Negotiation b etween the PCI/PCI-X Family of Gigabit Ethernet Controllers and i ts link partner is performed by the PHY . Under norm al, expected operatin g condi tions, the MAC automatically establishes comm on speed and[...]

188 Software Deve loper’s Manual PHY Functionality and Features 1 1.1.2 Next Page Exchanges If 1000BASE-T mode is advertised, then the Et hernet controller PHY automati cal ly send s the appropriate next pages to advertis e the capability and negotiate master /slave mode of operation. If a developer does not wan t to transmit addi tional ne xt pa[...]

Software Developer’s Manua l 189 PHY Functionality and Feature s 1 1.1.4 S t atus Once the PHY completes auto-negoti a tion , it upda tes the various statuses in the PHY Status Register , Link Partner Ability Register (Base Page), Auto-Negoti ation Expansion Register, and 1000BASE-T Status Register . For 1000BASE-T operat ion, the Auto-Negotiatio[...]

190 Software Deve loper’s Manual PHY Functionality and Features 1 1.2.1 Polarity Correction (copper only) The Ethernet controller PHY auto matically corrects for polarity er rors on the receive pairs in 1000BASE-T and 10BASE-T modes. In 100BAS E-TX mode, the polarity d oes not matter . In 1000BASE-T mode, receive polarity errors are automatically[...]

Software Developer’s Manua l 191 PHY Functionality and Feature s 1 1.3 Cable Length Detection (copper only) In 100/1000 Mbps operation, the Et hernet cont roller PHY attempts to indicat e the approxim ate length of the CA T 5 cable attached. The estimated cab le length is reported as one of the following ranges: • <= 50 m • 50 – 80 m •[...]

192 Software Deve loper’s Manual PHY Functionality and Features 1 1.4.2 D3 St ate, No Link Required (copper only) Each time the MAC transitions to a D3 or D0u power-state with no link requ ired (wakeup d isabled and no manageability enabled), the PHY enters its IEEE power -d own mode, consuming the least amount of power possible. When pow ered-do[...]

Software Developer’s Manua l 193 PHY Functionality and Feature s 1 1.5 Initialization Note: Section 1 1.5 through Section 11.14 appl y only to the 82541xx and 82547GI/EI Ethernet controlle rs. At power-up or reset, the PHY core performs the initialization as shown in Figure 1 1-1 . The software driver has access to the PHY register 0d, bits 15 an[...]

194 Software Deve loper’s Manual PHY Functionality and Features 1 1.6 Determining Link S t ate The PHY and its link partner determine th e type of link establ ished throu gh one of three methods: • Auto-Negotiation • Parallel Detection • Forced Operation Auto-Negotiation is the only method allowed by the 802.3ab standard for establishing a [...]

Software Developer’s Manua l 195 PHY Functionality and Feature s 1 1.6.1 False Link When the PHY is first powered on, reset, or encoun ters a link down state, it must determ ine the line speed and operating co nditions to use for the network lin k. The PHY first checks the MDIO regi sters (initialized via the Hard ware Control Interface or writte[...]

196 Software Deve loper’s Manual PHY Functionality and Features 1 1.6.3 Auto Negotiation The PHY supports the IEEE 802.3u Auto-Negotiat ion scheme with next page capability . Next Page exchange uses PHY register 7d to send informat ion and PHY register 8d to receive them. Next Page exchange can only occur if both ends of the link ad vertise their[...]

Software Developer’s Manua l 197 PHY Functionality and Feature s 1 1.7.3 10BASE-T For 10BASE-T links, the PHY and its link partner begin exchangi ng No rmal Link Pulses (NLPs). The PHY transmits an NLP every 16 ms, and expects to receive one every 10 to 20 ms. The link is maintained as long as no rmal link pulses are received. 1 1.8 Link Enhancem[...]

198 Software Deve loper’s Manual PHY Functionality and Features T able 10-2 lists the intended operation for th e various settings of ASM_DIR and Pause. This information is provided fo r reference on ly; it is the responsibility of the MAC to impl ement the correct function. The PHY merely enables the tw o M ACs to communicate their abilities to [...]

Software Developer’s Manua l 199 PHY Functionality and Feature s 1 1.10.1 Powerdown via the PHY Register The PHY can be powered down using the control bit found in PHY register 0d, bit 1 1. This bit powers down a significant portion of th e po rt but cloc ks to the regist er section remain act ive. This enables the PHY management interface to rem[...]

200 Software Deve loper’s Manual PHY Functionality and Features Figure 1 1-3. 1000 Base- T PHY Functions Overview Side-stre am Scrambler / Descrambler Trellis Viterbi Encoder/ Decoder 8 8 4 4 MAC Interface AGC, A/D, Timing Reco very 4DPA M5 Encoder ECHO, NEXT, FEXT Cancellers Line Interfac e Pul se Sha per, DAC, Filte r Hybr id Line Driver DSP[...]

Software Developer’s Manua l 201 PHY Functionality and Feature s 1 1.1 1.2 T ransmit Functions This section describes functions used when th e Media Access Controller (MAC) transmits data through the PHY and out onto the twisted-pair connection . 1 1.1 1.2.1 Scrambler The scrambler randomizes the transmit ted data. The purpose of scrambling is tw[...]

202 Software Deve loper’s Manual PHY Functionality and Features 1 1.1 1.3.4 Spectral Shaper This function causes the 4DP AM5 waveform to have a spectral signature that is very close to that of the ML T3 waveform used by 100BASE-TX. Th is enables 1000BASE-T to take advantage of infrastructure (cables, magnetics) designed for 100BASE-TX . The shape[...]

Software Developer’s Manua l 203 PHY Functionality and Feature s Figure 1 1-5. 1000BASE-T Receiv e Flow 1 1.1 1.4 Receive Functions This section describes function blocks that are used when th e PHY receives data from the twisted pair interface and passes it back to the MAC. 1 1.1 1.4.1 Hybrid The hybrid subtracts the transmi tted signal from the[...]

204 Software Deve loper’s Manual PHY Functionality and Features • Far-end crosstalk (FEXT) • Propagation delay variation s between chann els of up to 120 ns. • Extraneous tones that have been coupled into the receive path. The adaptive filter coef ficients are initially set during the training phase. They are con tinuously adjusted (adaptiv[...]

Software Developer’s Manua l 205 PHY Functionality and Feature s 1 1.13.1 Link T est In 10 Mbps mode, the PHY always transmits link pulses. If the Link T est Functi on is enabl ed, it monitors the connection for link pulses. Once it de tects 2 to 7 link pulses, data transmissi o n is enabled and remains enabled as long as the link pulses or data [...]

206 Software Deve loper’s Manual PHY Functionality and Features Note: This page is intentionally left blank.[...]

Software Developer’s Manua l 207 Dual Port Characteristics Dual Port Characteristics 12 12.1 Introduction 1 The 82546GB/EB architecture includes two instances of both the MAC and PHY (see Figure 2-1 ). W ith both MAC/PHY pai rs operating , the Ethernet controller appears as a multi-function PCI device containing two identica lly-functioning devic[...]

208 Software Deve loper’s Manual Dual Port Characteristics Many of the fields of the PCI h eader space contain hardware default values that are either fixed or can be overridden using EEPROM, but cannot be independently specified for each logical LAN device. The following fields are consider ed to be common to both LAN devices: 24h Base Address 5[...]

Software Developer’s Manua l 209 Dual Port Characteristics The following fields are implemented unique to each LAN device: 12.2.2 MAC Configuration Register Sp ace All device control/status registers detailed in Section 13.4 , Main Register Descriptions, are implemented per-LAN device. Each LAN device can be accessed using memory or I/O cycles, d[...]

210 Software Deve loper’s Manual Dual Port Characteristics 12.3 Shared EEPROM The Ethernet controller uses a single EEPROM device to configure hardware default parameters for both LAN devices, including Ethernet Individual Addresses (IA), LED behaviors, receive packet-filters for manageability and wakeup capability , etc. Ce rtain EEPROM words ar[...]

Software Developer’s Manua l 211 Dual Port Characteristics The result of mul tiple LAN devices’ reading EEPROM is that power-on and reset-initiated EEPROM read sequences might appear slightly di fferently from the sequen ces illustrated during the discussion of powe r-state transitions ( Section 6.3.2 ). Those illustrations indicate EEPROM read[...]

212 Software Deve loper’s Manual Dual Port Characteristics Note: Access contention to FLASH by both LAN devices is more than likely to result in indeterminate data results (during read transactions), corrup ted FLA SH (during write tr ansactions), or other unpredictable behavior . T o avoid this contention, accesse s from both LAN devi ces MUST b[...]

Software Developer’s Manua l 213 Dual Port Characteristics 12.5.3 Multi-Function Advertisement If one of the LAN devices is disabled, the Ethernet controller no longer is a multi-function device. It normally reports a 01h in the PCI Configuration Header fiel d Header T ype , indicating multi- function capability . However, if a LAN id disabled, i[...]

214 Software Deve loper’s Manual Dual Port Characteristics 12.5.6 Summary The following t able lists the vario us LAN enabled/disabled confi gurations possible: CVDR values sampled-on- reset LAN device Enable d/ Disabled PCI functio n Interrupt Line Used FLSH_DA T A[1] FLSH_DA T A[0] 11 A  (enabled) 0 INT A# or INTB# (specified by LAN A EEPROM[...]

Software Developer’s Manua l 215 Register Descriptions Register Descriptions 13 13.1 Introduction This section details the state inside the PCI/PCI-X Famil y of Gigabit Ethern et Controllers that are visible to the programmer . In some cases, it descri bes hardware structures invisible to software in order to clarify a concept. The address space [...]

216 Software Deve loper’s Manual Register Desc rip tio n s • Reserved and/or undefined addresses. Any register not explic itly declared in this specification should be considered to b e reserved and should not be written . W rit ing to reserved or undefined register addresses can cause indeterminate behavior . Reads from reserved or undefined c[...]

Software Developer’s Manua l 217 Register Descriptions 13.2.2 I/O-Mapped Internal Regis ter , Internal Memory , and Flash 1 T o suppo rt pre-bo ot operation (prio r to th e allo cation of physical memory base addresses), all internal registers, memories, and Flash can be accessed using I/O operations. I/O accesses are supported only if an I/O Bas[...]

218 Software Deve loper’s Manual Register Desc rip tio n s The IODA T A register can be written as a byte, word, or Dword access when the IOADDR register contains a value for the Flash (80000h - FFFFFh). In this case, the valu e in IOA DDR m ust be properly aligned to the data value. Additionally , the lower 2 bits of the IODA T A PCI-X access mu[...]

Software Developer’s Manua l 219 Register Descriptions T able 13 -2 . Eth e rn e t Cont rol ler Regist er Sum m ary Category Offset Abbreviation Name R/W Page General 00000h CTRL Device Control R/W 224 General 00008h ST A TUS Device S tatus R 229 General 00010h EECD EEPROM/Flash Control/Dat a R/W 232 General 00014h EERD EEPROM Read (not applicabl[...]

220 Software Deve loper’s Manual Register Desc rip tio n s Categor y Offset Abbrevi ation Name R/W Page TX DMA 03000h TXDMAC TX DMA Control (applicable to the 82544GC/ EI only) R/W 319 TX DMA 03828h TXDCTL T ransmit Descriptor Control R/W 319 TX DMA 0282Ch T ADV Transmit Absolute Interrupt Delay T imer (not applicable to the 82544GC/EI ) R/W 321 [...]

Software Developer’s Manua l 221 Register Descriptions Category Offset Abb reviation Name R/W Page S tatistics 04054h X OFFTXC XOFF Transmitted Count R 349 S tatistics 04058h FCRUC FC Received Unsupported Count R/W 350 S tatistics 0405Ch PRC64 Packets Received (64 Bytes) Count R/W 350 S tatistics 04060h P RC127 Packets Received (65-127 Bytes) Cou[...]

222 Software Deve loper’s Manual Register Desc rip tio n s Note: The PHY registers are accesse d indirectly thro ugh the MDI/O interface described in Sectio n 8. 2 . Categor y Offset Abbrevi ation Name R/W Page Diagnostic 03418h TDFT Transmit Data FIFO T ail R/W 371 Diagnostic 03420h TDFHS T ransmit Data FIFO Head Saved Register R/W 371 Diagnosti[...]

Software Developer’s Manua l 223 Register Descriptions 13.3 PCI-X Register Access Split 1 The PCI-X specification states that accesses to internal device memory spaces must complete within a specific tar get initial latency , or else the device should signal that it completes the transaction later using a split-co mpletion operation. Due to inter[...]

224 Software Deve loper’s Manual Register Desc rip tio n s The EEPROM configuration bit “Force CSR Read Sp lit” (Initialization Cont rol W ord 2, word 0Fh) provides the ability to configure the de vice to split all internal re gister accesses, rather than providing non-split behavior for the registers listed. 13.4 Main Register Descriptions T[...]

Software Developer’s Manua l 225 Register Descriptions T able 13-3. CTRL Regi ster Bit Description 31 0 Device Control Bits Field Bit(s) Initial Va l u e Descripti on FD 0 1b 0b 1 Full-Duplex Enables software to override the hardware Auto-Negotiation function. The FD sets the duplex mode only if CTRL.FRCDPLX is set. When cleared, the Ethernet con[...]

226 Software Deve loper’s Manual Register Desc rip tio n s SLU 6 0b Set Link Up In TBI mode/internal SerDes, provides man ual link configuration. When set, the Link Up signal is forced high once receiver synchronization is achi eved (LOS not asse rted) using CTRL.FD to determine the duplex mode. This operation bypasses the link configuration proc[...]

Software Developer’s Manua l 227 Register Descriptions FRCDPLX 12 0b Force Duplex When set, software can override t he duplex indication from the PHY which is in internal PHY mode. When set the CTRL .FD bit sets duplex. When cleared, the CTRL.FD is ignored. Reserved 17:13 0b Reserved Should be written with 0b to ensure future compatibility . Read[...]

228 Software Deve loper’s Manual Register Desc rip tio n s RST 26 0 b Device Res et 0b = normal; 1b = reset. Self clearing. When set, it globally resets the entire Ethernet controller with the exception of the PCI configur atio n registers. All registers (receive, transmit, interrupt, statis tics, etc.), and state machines are set to their power-[...]

Software Developer’s Manua l 229 Register Descriptions The ADVD3WUC bit (Advertise D3Cold W akeup Capability Enable control ) allows the AUX_PWR pin to determine whether D3C old supp ort is adverti sed. If full 1 Gb/s operation in D3 state is desired but the system’ s power require ments in this mode would exceed the D3Cold W akeup-Enabled spec[...]

230 Software Deve loper’s Manual Register Desc rip tio n s T able 13-5. St atus Register Bit Description 31 13 12 0 Reserved S tatus Field Bit(s) Initial Va lu e Description FD 0 X Link Full Duplex c onfiguration Indication When cleared, the Ethernet controller operates in half-duplex; when set, the Ethernet controller operates in Full duplex. Th[...]

Software Developer’s Manua l 231 Register Descriptions SPEED 7:6 X Link speed setting Indicates the configured speed of the link. These bits are either forced by software when forcing the link speed through the CTRL.SPEED control bits, automatically set by hardware when Auto-Speed Detection is enabled or reflect the internal indication inputs fro[...]

232 Software Deve loper’s Manual Register Desc rip tio n s 13.4.3 EEPROM/Flash Control & Dat a Register EECD (00010h; R/W) This register provides a simp lified interface for software acces ses to the EEPROM. Software controls the EEPROM by successive writes to this register . Data and address information is clocked into the EEPROM by software[...]

Software Developer’s Manua l 233 Register Descriptions This register provides software direct access to the EEPROM. Software can control the EEPROM by successive writes to this register . Data & ad dress information is cloc ked into the EEPROM by software toggling the EESK bi t (2) of this register with EECS set to 1b. Data output from the EE[...]

234 Software Deve loper’s Manual Register Desc rip tio n s 13.4.4 EEPROM Read Register 1 EERD (00014h; R W) T able 13-7. EEPROM Read Register Bit Description 1. Not applicable to the 82544GC/EI . 31 16 15 8 7 5 4 3 1 0 Data Addr ess RSV . DONE R SV . ST ART Field Bit(s) I nitial Va l u e Description ST ART 0 0b S tart Read Writing a 1b to this bi[...]

Software Developer’s Manua l 235 Register Descriptions T able 13-8. EEPROM Read Register Bit Description (82541xx and 82547GI/EI) This register is used by s oftware to cause the Et hernet controller to read individual words in the EEPROM. T o read a word, softwa re writes the address to the Read Address field and simultane- ously writes a 1b to t[...]

236 Software Deve loper’s Manual Register Desc rip tio n s 13.4.5 Flash Access 1 FLA (0001Ch; R/W) This register provides software direct access to the Flash me mory . Software can control the Flash device by successive writes to this register . Data and address information is clocked into the Flash memory by software t oggling the FL_SCK bit (0)[...]

Software Developer’s Manua l 237 Register Descriptions 13.4.6 Extended Device Control Register CTRL_EXT (00018h, R/W) This register and the Device Control register (CTRL) control s the major operational modes for the Ethernet controller . CTRL_EXT pr ovides extended control of the Ethernet controller function alit y over the Device Control regist[...]

238 Software Deve loper’s Manual Register Desc rip tio n s SDP6_IODIR SDP2_IODIR ( 82541xx and 82547GI/EI ) 10 0b 1 SDP6[2] Pin Directionality . Controls whether software-controllable pin SDP6[2] is configured as an input or output (0b = input, 1b = output). Initial value is EEPROM-configurable. This bit is not affected by software or system rese[...]

Software Developer’s Manua l 239 Register Descriptions The Ethernet controller allows for up to two ex t ernal ly cont rolled interrupts. The upper two software-definable pins, SDP[7: 6] (SDP[3 :2] for the 82541xx and 8 2547GI/EI ), can be mapped for use as GPI interrupt bits. These mappings ar e enabled by the SDPx_GPIEN bits only when these sig[...]

240 Software Deve loper’s Manual Register Desc rip tio n s T able 13-12. 82544GC/EI CTRL_EXT Register Bit Description 31 16 15 0 Reserved Extended Device Control Bits Field B it(s) Initial Va l u e Descripti on GPI_EN 3:0 0 General Purpose Interrupt Enables These bits determine whether the upper three software definable pins SDP[7:6] and SDP[4] a[...]

Software Developer’s Manua l 241 Register Descriptions T able 13-13. 82544GC/EI GPI to SDP Bit Mapping SPD_BY PS 15 0 S peed Select Bypass When set to 1b, all speed detection mecha nisms are bypassed, and the Ethernet controller is immedia tely set to the speed indicated by CTRL.SPEED. This might be used to override the hardware clock switching c[...]

242 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7 MDI Control Register MDIC (00020h; R/W) Software uses this register to read or write Management Data Interface (MDI) registers in the internal PHY . T o read a location in the PHY , first perform an MDI write cycle with the fol low ing bit settings: • Ready = 0b • Interrupt Ena[...]

Software Developer’s Manua l 243 Register Descriptions T able 13-14. MDI Control Register Bit Descr iption 31 30 29 28 27 26 25 21 20 16 15 0 RSV E I R OP PHY REG DA T A Field Bit(s) Initial Va l u e Description DA T A 15:0 X Data In a Write command, software places the dat a bits and the Ethernet controller shifts them out to the PHY . In a Read[...]

244 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1 PHY Registers This document uses a special nomenclature to define the read/write mode of individual bits in each register . See Ta b l e 1 3 - 1 5 . For all binary equations appearing i n the register map, the symbol “| ” is equivalent to a binary OR operation. T able 13-15. [...]

Software Developer’s Manua l 245 Register Descriptions 13.4.7.1. 1 PHY Control Registe r PCTRL (00d; R/W) T able 13-16. PHY Control Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst Reserved 5:0 These bits are reserved and should be set to 000000b. RO RW 1 Always 000000b S peed Selection (MSB) 6 S peed Selection is determined b[...]

246 Software Deve loper’s Manual Register Desc rip tio n s Power Down 11 1b = Power down. 0b = Normal operation. Power down shuts down the Ethernet controller except for the MAC interface if the MAC interface power down bit is set to 1b. If it equals 0b, then the MAC interface also shuts down. For the 82544GC/EI , power down has no effect on the [...]

Software Developer’s Manua l 247 Register Descriptions Auto-Negotiation Enable 12 1b = Enable Auto-Negotiation Process. 0b = Disable Auto-Negotiation Process. A write to this bit does not take effect until a software reset is asserted, Restart Auto-Negotiation is asserted, or Power Down transitions from power down to normal operation. When the po[...]

248 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.2 PHY St atus Register PST A TUS (01d; R) T able 13-17. PHY St atus Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst Extended Capability 0 1b = Extended register capabilities. RO Always 1b Jabber Detect 1 1b = Jabber condition detected. 0b = Jabber condition n[...]

Software Developer’s Manua l 249 Register Descriptions 10 Mb/s Full Duplex 12 1b = PHY able to perform full duplex 10BASE-T . 0b = PHY not able to perform full duplex 10BASE-T . 82544GC/EI only: Bit 14 = Bit 13 = Bit 12 = Bit 1 1 = (MODE[3:0] is not any of xx01b, 1x00b, 001xb, 01 1 1b). RO RO 1b MODE[3:0] 100BASE-X Half Duplex 13 1b = PHY able to[...]

250 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.3 PHY Identifi er Regis ter (LSB) PID (02d; R) 13.4.7.1.4 Extended PHY Identifier Regist er (M SB) EPID (03d; R) T able 13-18. PHY Identifier Bit Description Field Bit(s) Description Mode HW Rst SW Rst Organizationally Unique Identifier Bit 18:3 1 1. PHY ID number for the 82541x [...]

Software Developer’s Manua l 251 Register Descriptions 13.4.7.1.5 Auto-Negotiation Advertisement Register ANA (04d; R/W) T able 13-20. Auto-Negotiation Advert isement Register Bit Desc ription Field Bit(s) Description Mod e HW Rst S W Rst Selector Field 4:0 00001b = 802.3 For the 82541xx and 82547GI/EI : Other combinations are reserved. Unspecifi[...]

252 Software Deve loper’s Manual Register Desc rip tio n s 100BASE-TX Half Duplex 100Base-TX ( 82541xx and 82547GI/EI ) 7 1b = Advertise. 0b = Not advertised. V alues programmed in the Auto- Negotiation advertisement register have no effect unless Auto- Negotiation is restarted (PHY Control Register) or link goes down. This bit can be overridden [...]

Software Developer’s Manua l 253 Register Descriptions Asymmetric Pause ASM_DIR for the ( 82541xx and 82547GI/EI ) 11 1b = Asymmetric Pause. 0b = No asymmetric Pause. V alues prog rammed in the Auto- Negotiation advertisement register have no effect unless Auto- Negotiation is restarted (PHY Control Register) or link goes down. 82541xx and 82547G[...]

254 Software Deve loper’s Manual Register Desc rip tio n s 82544GC/EI Only: T able 13-21. Auto-Negotiat ion Advertisement Register Bit Description (MODE[3:0] is one of 001xb , 01 1 1b) Field Bit(s) Description Mode HW Rst SW Rst Reserved 4:0 V alues programmed in this register have no effect unless Auto-Negotiation is restarted (PHY Control Regis[...]

Software Developer’s Manua l 255 Register Descriptions 13.4.7.1.6 Link Partner Ab ility Register (Base Page) LP A (05d; R) Next Page 15 0b = Not advertised V alues programmed in this register have no effect unless Auto-Negotiation is restarted (PHY Control Register) or th e link goes down. Next Page is not supported in 1000BASE-X mode. RO Always [...]

256 Software Deve loper’s Manual Register Desc rip tio n s 82544GC/EI Only: T able 13-23. Link Partne r Ability Register (B ase Page) Bit Description 1 1. (MODE[3:0] is one of 001 xb, 0111b). Field Bit(s) Description Mode HW Rst SW Rst Reserved 4:0 Reserved. Should be set to 00000b. RO 00000b 00000b 10BASE-TX Half Duplex 5 1b = 10 Base-TX half du[...]

Software Developer’s Manua l 257 Register Descriptions 82541xx and 82547GI/EI Only: T able 13-24. PHY Link Page Ability Bit Description 1 1. PHY register 8d st ores th e Auto-Negot iation Link Partner Re ce ive d Next P ages. PHY re gister 5d is n ot used t o store Next Pages. It contains the informatio n from the last Base Page correctly receive[...]

258 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.7 Auto-Negotia tion Exp a nsion Register ANE (06d; R) NOTE: The ANE Register is not valid until the Auto-Negot iation complete bit in the PHY S tatus Register indicates completion of the Auto-Negotiation process. T able 13 -2 5 . Aut o-Ne g ot ia ti on Expansion Regi st er Bit De[...]

Software Developer’s Manua l 259 Register Descriptions 13.4.7.1 . 8 Next Page T ransmit Register NPT (07d; R/W) T able 13-26. Next Page T ransmit Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst Message/ Unformatted Field 10:0 T ransmit Code Word Bit 10:0. 82541xx and 82547GI/EI only: 1 1 -bit message code field. R/W 001h 001h[...]

260 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.9 Link Partne r Next Page Register LPN (08d; R) T able 13-27. Link Partner Next Page Register Bit Description Bit(s) Field Description Mode HW Rst SW Rst 10:0 Message/ Unformatted Field Received Code Word Bit 10:0. 82541xx and 82547GI/EI only: 1 1- bit message code field. RO 000h[...]

Software Developer’s Manua l 261 Register Descriptions 13.4.7.1.10 1000BASE-T Control Register GCON (09d; R/W) T able 13-28. 1000BASE-T Contr o l Register Bi t Description Bit(s) Field Des cription Mode HW Rst SW Rst 7:0 Reserved Reserved. Should be set to 00000000b. R/W 0b 0b 8 1000BASE-T Half Duplex 1b = Advertise. 0b = Not advertised. 82544GC/[...]

262 Software Deve loper’s Manual Register Desc rip tio n s NOTES: 1. V alues programmed in bits 12:8 of the 1000BASE-T Co ntrol Register have no effect unless Auto-Negotiation is restarted (PHY Control Register , bit 9) or the link goes down. These bits can also be overridden by the PHY Contro l Regis ter . 2. The symbol “!” is equivalent to [...]

Software Developer’s Manua l 263 Register Descriptions 13.4.7.1.12 Extended PHY S t atus Register EPST A TUS (15d; R) NOTES: 1. 1000BASE-X Half Duplex only applicable to the 8 2544GC/EI . 2. Bit 12 = bit 13 = 1b if MODE[3:0] does not = 001xb or 01 1 1b. 3. Bit 14 = bit 15 = 1b if MODE[3:0] = 001xb or 01 1 1b. Local Receiver St atus 13 1b = Local [...]

264 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.13 PHY Specif ic Control Register PSCON (16d; R/W) T able 13-31. PHY Spec ific Control Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst 1000BASE-T 10/100BASE-T Disable Jabber 0 1b = Disable jabber function. 0b = Enable jabber function. Jabber has effect only i[...]

Software Developer’s Manua l 265 Register Descriptions PHY Port Configuration Register (82541xx an d 82547GI/EI Only) PPCONF (16d; R/W) Energy Detect 9:8 Energy Detect. 0xb = Off. 10b = Sense only on receive. 1 1 b = Sense and periodically transmit NLP . R/W 0b Retain Force Link Good 10 1b = Force link good. 0 b = Normal operation. If link is for[...]

266 Software Deve loper’s Manual Register Desc rip tio n s Auto MDIX Parallel Detect Bypass 4 Auto_MDIX Parallel Detect Bypass. Bypasses the fix to IEEE auto-MDIX algorithm for the case where the PHY is in forced-speed mode and the link partner is auto-negotiating. 1b = S trict 802 .3 Auto-MDIX algorithm. 0b = Auto-MDIX algorithm handles Auto-Neg[...]

Software Developer’s Manua l 267 Register Descriptions 13.4.7.1.14 PHY Specific S tat us Regist er PSST A T (17d; R) T able 13- 33. PHY Specific Status Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst Jabber (real time) 0 1b = Jabber . 0 = No jabber . RO 0b Retain Polarity (real time) 1 1b = Reverse d. 0b = Normal. RO 0b 0b Re[...]

268 Software Deve loper’s Manual Register Desc rip tio n s S peed and Duplex Resolved 11 1b = Resolved. 0b = Not resolved. S peed, Duplex, MDI Crossover Status, T r ansmit Pause Enable, and R eceive Pause Enable bits are valid only after the S peed and Duplex Reso lved bit (1 1) is set. This occurs when Auto- Negotiation is completed or Auto- Neg[...]

Software Developer’s Manua l 269 Register Descriptions PHY Port St atus 1 Regi st er (825 41 x x and 8254 7G I/EI Onl y) PPST A T (17d; R) T able 13-34. PHY St atus 1 Register Bit Description Field Bit(s) Description Mode HW Rst SW Rst LFIT Indicator 0 S tatus bit indicating the Auto- Negotiation Link Fail Inhibit Timer has expired. This indicate[...]

270 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.15 PHY Interr upt Enable Regist er PINTE (18d; R/W) T r ansmit S tatus 13 1b = PHY currently transmitting a packet. 0b = PHY transmitter is IDLE. When in loopback, this bit reads as 0b. RO 0b 0b Data Rate 15:14 00b = Reserved. 01b = PHY operating in 10BASE-T mode. 10b = PHY opera[...]

Software Developer’s Manua l 271 Register Descriptions PHY Port Control Register (82541x x and 82547GI/EI Only) PPCONT (18d; R/W) Page Received Interrupt Enable 12 1b = Interru pt enable. 0b = Interrupt disable. R/W 0b Retain Duplex Changed Interrupt Enable 13 1b = Interru pt enable. 0b = Interrupt disable. R/W 0b Retain S peed Cha nged Interrupt[...]

272 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.16 PHY Interr upt St at u s Re gi st er PINTS (19d; R) MDI-X Mode 13 Force MDI-X mode. V alid only when operating in manual mode. (PHY register 18, bit 12 = 0b. 1b = MDI-X (cross over). 0b = MDI (no cross over). R/W 0b 0b Reserved 14 Always read as 0b. Write to 0b for normal oper[...]

Software Developer’s Manua l 273 Register Descriptions PHY Link Health Register (82541xx and 82 547GI/EI Only) PLINK (19d; R) FIFO Over/Underflow 7 1b = Over/Underflow Error . 0b = No FIFO Error . RO, LH 0b 0b False Carr ier 8 1b = False carrier. 0b = No false carrier . RO , LH 0b 0b Symbol Error 9 1b = Symbol error . 0b = No symbol error . RO, L[...]

274 Software Deve loper’s Manual Register Desc rip tio n s Auto-Negotiation Fault 6 Auto-Negotiate Fault: This is the logical OR of PHY register 1, bit 4, PHY register 6, bit 4, and PHY register 10, bit 15. RO 0b 0b Reserved 7 Always read as 0b. RO 0b 0b Data Err[0] 8 Mode: 10: 10 Mbps polarity error . 100: Symbol error . 1000: Gig idle error . L[...]

Software Developer’s Manua l 275 Register Descriptions 13.4.7.1.17 Extended PHY S pecific Control Register 1 1 EPSCON1 (20d; R/W) 1. Extended PHY Specific Control Register - EPSCON for the 82544GC/EI only . T able 13-39. Extended PHY Specific Control 1 Bit Descript ion 1 Field Bit(s) Description Mode HW Rst SW Rst Reserved 1:0 00b R/W 00b Retain [...]

276 Software Deve loper’s Manual Register Desc rip tio n s GMII FIFO Register (82541x x and 82547GI/EI Only) PFIFO (20d; R/W) NOTES: 1. The default is determined by EEPROM bit SPD_EN. 2. The default is determined by EEPROM bit ADV10LU . T able 13-40. GMII FIFO Register Bit Descr iption Field Bit(s) Description Mode HW Rst SW Rst Buffer Size 3:0 A[...]

Software Developer’s Manua l 277 Register Descriptions 13.4.7.1. 18 PHY Receive Error Counter PREC (21d; R) NOTE: The counter stops at FFFFh and does not roll ove r . PHY Channel Quality Register (82541xx and 82547GI/EI Only) PCHAN (21d; R) 13.4.7.1. 19 SPEED_TEN_LED and LINK_ACT_LED Cont rol (82541xx and 82 547GI/EI Only) (23d; R/W) T able 13-41[...]

278 Software Deve loper’s Manual Register Desc rip tio n s LED S tretch Disab le 5 Disable the SPEED_TEN_LED Extension Logic. 0b = Enable logic. 1b = Disable logic. Note: Only when both the stretch and blink are disabled the input bypasses the blink logic and is muxed out with no sampling (only combinational logic). R/W 1b 1b LED Source Select 9:[...]

Software Developer’s Manua l 279 Register Descriptions 13.4.7.1 .20 PHY Global S t atus (82544GC/EI On ly) PGST A T (23d; R) NOTE: Bits 3:0 remain high until the active correspondin g interrupt bits are cleared on a read of the PHY Interrupt S tatus Register . 13.4.7.1.21 SPEED_100 _LED and SPEED_1000_LE D Control (82541xx a nd 82547GI/EI Only) ([...]

280 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.22 PHY LED Control Regist er (82544G C/EI Only) PLED (24d; R/W) LED S tretch Disab le 11 Disable the SPEED_1000_LED Extension Logic. 0b = Enable logic. 1b = Disable logic. Note: Only when both the stretch and blink are disabled the input bypasses the blink logic and is muxed out [...]

Software Developer’s Manua l 281 Register Descriptions 13.4.7.1.23 Extended PHY S pecific Control Register 2 EPSCON2 (26d; R/W) NOTE: Not applicable to the 82540EP/EM , 82544GC/EI , 82541xx , or 82547GI/EI . 13.4.7.1.24 Extended PHY Spec ific St atus Register (82544GC/EI Only) EPSST A T (27d; R) 13.4.7.1. 25 MDI Register 30 Page Sele ct 1 R30PS ([...]

282 Software Deve loper’s Manual Register Desc rip tio n s 13.4.7.1.26 MDI Register 30 Access Window 1 R30A W (30d; R/W) 13.4.7.1.27 Documented MD I Register 3 0 Operatio ns 1 Unless otherwise specified, no reset operations are re quired in order for the following operati ons to take effect. NOTE: Any time the PHY is reset it returns to Class AB [...]

Software Developer’s Manua l 283 Register Descriptions 13.4.7.1.28 PHY Page Select Register (82541xx and 8254 7GI/EI Only) PP AGE (31d; R/W) 13.4.8 Flow Control Address Low FCAL (00028h; R/W) Flow control packets are defined by IEEE 802.3x to be either a unique multicast address or the station address with the EtherT ype field indi cating P AUSE.[...]

284 Software Deve loper’s Manual Register Desc rip tio n s T able 13-54. FCAH Register Bit Description 13.4.10 Flow Control T ype FCT (00030h; R/W) This register contains the type fi eld that hardw are matches to r ecognize a flow control packet and that hardware uses when transmit ting a P AUSE packet to its rem ote node. Only the lower 16 bits [...]

Software Developer’s Manua l 285 Register Descriptions T able 13-56. VET R egister Bit Description 13.4.12 Flow Control T ransmit Timer V alue FCTTV (00170h; R/W) Provides the Pause slot time value to be in cluded in the transmitted XOFF Pause packets. The slot time value that is used is a fixe d slot of 64-byte time. T able 13-57. FCTTV Register[...]

286 Software Deve loper’s Manual Register Desc rip tio n s 13.4.13 T ransmit Configuration W ord Register 1 TXCW (00178h; R/W) This register is applicable to the TBI mode/int ernal SerDes mode of operatio n. For internal PHY operation, program the register to 0000h. Fo r example, clear this register in MMI mode. This register has two meanings, de[...]

Software Developer’s Manua l 287 Register Descriptions Note: Careful attention to the IEEE 802.3z standard is requir ed in or der to meet specified timing requirements for timin g during a soft ware negotiated link. 13.4.14 Receive Config uration Word Register 1 RXCW (00180h; R) This register has meaning only in TBI/internal SerDes mode of operat[...]

288 Software Deve loper’s Manual Register Desc rip tio n s T able 13-59. RXCW Register Bit Description Field Bit(s) Initial Va l u e Descript ion RxConfigWord 15:0 X Data received during Auto-Negotiation process. When performing hardware Auto-Negotiation (TXCW .ANE = 1b), the “A N link partner ability base page register” is recorded in the Rx[...]

Software Developer’s Manua l 289 Register Descriptions 13.4.15 LED Control 1 LEDCTL (00E00h; RW) RxConfig 29 0b /C/ order set reception indication 0b = Receive idle/data stream. 1b = Receiving /C/ orde r sets. Provides an indication as to whether the interface is receiving /C/ order set, or n ormal idle/data stream. 82544GC/EI only: V alid only i[...]

290 Software Deve loper’s Manual Register Desc rip tio n s T able 13-60. LED Control Bit Description 1 13.4.15.1 MODE Encodings for LED Output s 1 The T able 13 -61 lists the MODE encodings used to sel ect the des ired LED signal source for each LED output. Refer to Section 10.1.1 to ensu re proper understanding of expression polarity and resulti[...]

Software Developer’s Manua l 291 Register Descriptions T able 13-61. Mode Encodings for LED Output s 1 Mode Pneumonic State / Event Indicated 0000b LINK_10/1000 Asserted when eit her 10 or 1000 Mbps link is established and maintained. 0001b LINK_100/1000 Asserted when eit her 100 or 1000 Mbps link is established and maintained. 0010b LINK_UP Asse[...]

292 Software Deve loper’s Manual Register Desc rip tio n s 13.4.16 Packet Buffer Allocation PBA (01000H; R/W) This register sets the on-chip receive and transmit storage alloca tion ratio. The receive allocation value is read/write for the lower seven bits. The r eceive allocation value must be a multiple of eight (multiple of two for the 82547GI[...]

Software Developer’s Manua l 293 Register Descriptions 13.4.17 Interrupt Ca use Read Register ICR (000C0H; R) This register contains all interrupt conditi ons fo r the Ethernet controller . Each time an interrupt causing event occurs, the corresponding interru pt bit is set in this register . A PCI interrupt is generated each time one of the bits[...]

294 Software Deve loper’s Manual Register Desc rip tio n s RXT0 7 0b Receiver Timer Interrupt Set when the receiver timer expires. The receiver timer is used for receiver descriptor packing. Timer expiration flushes any accumulate d descriptor s and sets an interrupt event when enabled. Reserved 8 0b Reserved Reads as 0b. MDAC 9 0b MDI/O Access C[...]

Software Developer’s Manua l 295 Register Descriptions Note: The 82547GI/EI signals interrup ts over th e CSA port, not a dedicated int e rrupt pi n. 13.4.18 Interrupt Throttling Registe r 1 ITR (000C4h; R/W) Software can use this register to pace (or even out) the delivery of interrupts to the host CPU. This register provides a guaranteed inter-[...]

296 Software Deve loper’s Manual Register Desc rip tio n s 13.4.19 Interrupt Cause Set Register ICS (000C8h; W) Software uses this register to s et an interrup t condition. Any bit written wit h a 1b sets the corresponding interrupt. This resu lts in the corresponding b it being set in the Interrup t Cause Read Register (see Sectio n 13.4.17 ). A[...]

Software Developer’s Manua l 297 Register Descriptions 13.4.20 Interrupt Mask Set/Read Register IMS (000D0h; R/W) An interrupt is enabled if its correspondin g mask bi t is set to 1b, and d isabled if its correspon ding mask bit is set to 0b. A PCI interrupt is generated each time one of the bits in this register is set and the corresponding inte[...]

298 Software Deve loper’s Manual Register Desc rip tio n s 13.4.21 Interrupt Mask Clear Register IMC (000D8h; W) Software uses this register to disable an interr upt. Interrupts are presented to the bus interface only when the mask bit is set to 1b and the cause bit set to 1b. The status of the mask bit is reflected in the Interrupt Mask Set/Read[...]

Software Developer’s Manua l 299 Register Descriptions Software should write a 1b to the reserved bits to ensure future compatibility . Since this register masks interrupts when 1b is written to the corresponding (d efin ed) bits, then writing 1b to th e reserved bits ensures that the software is neve r called to handle an interrupt that the soft[...]

300 Software Deve loper’s Manual Register Desc rip tio n s 13.4.22 Receive Control Register RCTL (00100h; R/W) This register controls all Ethern et controller receiver functions. T able 13-67. RCTL Register Bit De scription TXD_LOW 15 X Clears the mask for Transmit Desc riptor Low Threshold hit (not applicable to the 82544GC/EI ). SRPD 16 X Clear[...]

Software Developer’s Manua l 301 Register Descriptions MPE 4 0b Multicast Pr omiscuous Ena bled 0b = Disabled. 1b = Enabled. When set, passes without filtering out all rece ived multicast packets. Otherwise, the Ethernet controller accepts or rejects a multicast packet based on its 4096-bit vector multicast filtering table. LPE 5 0b Long Packet R[...]

302 Software Deve loper’s Manual Register Desc rip tio n s BAM 15 0b Broadcast Accept Mode. 0 = ignore broadcast; 1 = accept broadcast packets. When set, passes and does not filt er out all received broadcast packets. Otherwise, the Ethernet controller accepts, or rejects a broadcast packet only if it matches through perfect or imperfect filters.[...]

Software Developer’s Manua l 303 Register Descriptions PMCF 23 0b Pass MAC Control Frames 0b = Do not (specially) pass MAC control frames. 1b = Pass any MAC control frame (type field value of 8808h) that does not contain the pause opcode of 0001h. PMCF controls the DMA function of MAC control frames ( other than flow control). A MAC control frame[...]

304 Software Deve loper’s Manual Register Desc rip tio n s 13.4.23 Flow Control Receive Threshold Low FCRTL (02160h; R/W) This register contains the receive threshold used to determine when to send an XON packet. It counts in units of bytes. Each time the recei ve FIFO crosses the r eceive high threshold FCR T H.R TH (filling up), and then crosse[...]

Software Developer’s Manua l 305 Register Descriptions 13.4.24 Flow Control Receive Threshold High FCRTH (02168h; R/W) This register contains the receive threshold used to determine when to send an XOFF packet. It counts in units of bytes. Each time the receive FIFO reaches the fullness indicated by FCR TH, hardware transmits a P AUSE frame if th[...]

306 Software Deve loper’s Manual Register Desc rip tio n s 13.4.25 Receive Descriptor Base Address Low RDBAL (02800h;R/W) This register contains the lower bits of th e 64-b it descriptor base address. The four low-order register bits are always ignored. The Receive De scriptor Base Address must point to a 16-byte aligned block of d ata. T able 13[...]

Software Developer’s Manua l 307 Register Descriptions 13.4.27 Receive Descriptor Length RDLEN (02808h; R/W) This register determines the number of bytes allocated to the circular receive descriptor buffer . This value must be 128-byte aligned (t he maximum cache line size). Since each descriptor is 16 bytes in length, the total number of receive[...]

308 Software Deve loper’s Manual Register Desc rip tio n s 13.4.29 Receive Descriptor T ail RDT (02818h;R/W) This register contains the tail pointers for the recei ve descriptor buffer . The register points to a 16- byte datum. Software writes the ta il register to add receive descriptors to the hardware fre e list for the ring. T able 13-74. RDT[...]

Software Developer’s Manua l 309 Register Descriptions This feature operates by initiating a countdown timer upon successfully receiving each packet to system memory . If a subsequent packet is received BEFORE the time r expires, the timer is re- initialized to the programmed value and re-starts its countdow n. If the timer ex pires due to NOT ha[...]

310 Software Deve loper’s Manual Register Desc rip tio n s When this timer is enabled, a separate absolu te countdown timer is initiated upon successfully receiving each packet to system memory . When this absolute timer expires, pending receive descriptor writebacks are flushed and a receive timer interrupt is generated. Setting this register to[...]

Software Developer’s Manua l 311 Register Descriptions T able 13-76. TCTL Register Bit Description 31 26 25 22 21 12 1 1 4 3 0 Reserved CNTL Bits COLD CT CNTL Bits Field Bit(s) Initial Va l u e Descriptio n Reserved 0 0b Reserved Write as 0b for future compatibility . EN 1 0b T r ansmit Enable The transmitter is enabled when this bit is set to 1b[...]

312 Software Deve loper’s Manual Register Desc rip tio n s For the 82541xx and 82547GI/EI , carrier extens ion (through the TCTL COLD field) provides a method to increase the duration of the carrier event to a minimum us able duration in orde r to meet a 200 m collision domain objective, even thou gh ha lf-duplex operation is impractical at Gigab[...]

Software Developer’s Manua l 313 Register Descriptions T able 13-77. TIPG Register Bit Descr iption 31 30 29 20 19 10 9 0 Reserved IPGR2 IPGR1 IPGT Field Bit(s) Initial Va l u e Description IPGT 9:0 X IPG T ransmit T ime S pecifies the IPG time for back-to-back packet transmissions Measured in increments of the MAC clock: • 8 ns MAC clock when [...]

314 Software Deve loper’s Manual Register Desc rip tio n s 13.4.35 Adaptive IFS Throttle - AIT AIFS (00458;R/W) This register throttles back-to-b ack transmissions in the transmit packet buf fer and delays their transfer to the CSMA/CD transmit function. As a resu lt, it can be used to delay the transmission of back-to-back packets on the wire. F[...]

Software Developer’s Manua l 315 Register Descriptions T able 13-78. AIFS Register Bit Description 13.4.36 T ransmit Descriptor Base Address Low TDBAL (03800h; R/W) This register contains the lower bits of the 64- bit transmit Descriptor base address. The base register indicates the start of the circular transmit descript or queue. Since each de [...]

316 Software Deve loper’s Manual Register Desc rip tio n s 13.4.37 T ran smit Descri ptor Base Address High TDBAH (03804h; R/W) This register co nt ains the upper 32 bits of the 64-bit transmit Descriptor base address. T able 13-80. TDBAH Regi ster Bit Description 13.4.38 T ransmit Descriptor Le ngth TDLEN (03808h; R/W) This register determines t[...]

Software Developer’s Manua l 317 Register Descriptions 13.4.39 T ransmit Descriptor Head TDH (03810h; R/W) This register contains the head pointer for the transmit descriptor ring. It holds a value that is an offset from the base, and indicates the in–progr ess descriptor . It points to a 16 -by te datum. Hardware controls this pointer . The on[...]

318 Software Deve loper’s Manual Register Desc rip tio n s 13.4.40 T ransmit Descriptor T ail TDT (03818h; R/W) This register contains the tail point er for the transmit descriptor ri ng. It holds a value that is an offset from the base, and indicates the location beyond the last descriptor hardware can process. This is the location where softwar[...]

Software Developer’s Manua l 319 Register Descriptions T able 13-84. TIDV Register Bit Description 13.4.42 TX DMA Contro l (82544GC/EI only) TXDMAC (03000h; R/W) This register controls the transmit DMA pre-fetching and preemption abilities. T able 1 1-85. TXDMAC R egister Bit Description 13.4.43 T ransmit Descriptor Control TXDCTL (03828h; R/W) T[...]

320 Software Deve loper’s Manual Register Desc rip tio n s T able 13-86. TXDCTL Register Bit Descrip tion 31 25 24 23 22 21 16 15 14 13 8 7 6 5 0 L WTHRESH RSV 1 1. 82544GC/EI only. GRAN RSV WTHRESH RSV HTHRESH RSV PTHRESH Field Bit(s) Initial Va l u e Description PTHRESH 5:0 0b Prefetch Threshold Used to control when a pre-fetch of descr iptors [...]

Software Developer’s Manua l 321 Register Descriptions Since write back of transmit descriptors is opt ional (under the control of RS bit in the descriptor), not all processed descriptors ar e counted with respect to WTHR ESH. Descriptors start accumu- lating after a descriptor with RS (or RPS for the 82544GC/EI ) is set. Fu rt hermore, with tran[...]

322 Software Deve loper’s Manual Register Desc rip tio n s The transmit interrupt delay timer (TIDV) can be used to coalesce transmit interrupts. However , it might be necessary to ensure that no com pleted transmit rem ains unnoticed for too long an i nterval in order ensure timely release of transmit buffers . This regis ter can be used to ENSU[...]

Software Developer’s Manua l 323 Register Descriptions When performing TCP segmentation, the packet prot otype header initially transferred by DMA is stored internally and updated as each packet of the TCP segmentation operation is composed. As data for subsequent TCP segments is DMA ’d into the Ethernet controller , the frame header for each s[...]

324 Software Deve loper’s Manual Register Desc rip tio n s 13.4.46 Receive Descriptor Control RXDCTL (02828h; R/W) This register controls the fetching and write-back of receive descriptors. Th e three threshold values are used to determine when descriptors are read from and written to host memory . The values can be in units of cache lines or des[...]

Software Developer’s Manua l 325 Register Descriptions 13.4.47 Receive Checksum Control RXCSUM (05000h; R/W) The Receive Checksum Control regi ster controls the receive check sum of floading features of the Ethernet controller . The Ethernet controller supports the offloa ding of three receive checksum calculations: the Packet Checksum, the IP He[...]

326 Software Deve loper’s Manual Register Desc rip tio n s Field Bit (s) Initial Va l ue D escription PCSS 7:0 0b Packet Checksum S tart Controls the starting byte for the Packet Checksum calculation. The Packet Checksum is the one’s complement over the receive packet, starting from the byte indicated by RXCSUM.PCSS (0b corresponds to the first[...]

Software Developer’s Manua l 327 Register Descriptions 13.5 Filter Registers This section contains detailed descriptions for those registers asso ciated with the Ethernet controller ’ s address filter capabilities. 13.5.1 Multicast T a ble Array MT A[127:0] (05200h-053FCh; R/W) The multicast table array is a way to extend addr ess filtering bey[...]

328 Software Deve loper’s Manual Register Desc rip tio n s Of the 16 bits, look at bits 1 1:5, starting from zero. These seven bits corresponds to the row within the MT A table (the MT A has 128 rows which require seven bits to define). In the example, bits 1 1:5 are 1011 110b . This corresponds to row 94. Of these 16 bits, count out the first fi[...]

Software Developer’s Manua l 329 Register Descriptions 13.5.2 Receive Address Low RAL (05400h + 8*n; R/W) 16 registers contain the lower bits of the 48-bit Et he rnet address. All 32 bits are valid. Software can access the High and Low registers as a register pair if it can perform a 64-bit access to the PCI bus. The addresses stored in these reg[...]

330 Software Deve loper’s Manual Register Desc rip tio n s T able 13-91. RAH Register Bit Description 13.5.4 VLAN Filter T a ble Array 1 VFT A[127:0] (05600h – 057FCh; R/W) The Ethernet controller provides a 4096-bit vector VLAN Filter table array . There is one register per 32 bits of the VLAN Filter T able, for a total of 128 registers (thus [...]

Software Developer’s Manua l 331 Register Descriptions T able 13-92. VFT A[127:0] Bit Desc ription 13.6 W akeup Registers 13.6.1 W akeup Control Register WUC (05800h; R/W) This register is reset any tim e LAN_PWR_GOOD is set to 0b. When AUX_POWER equals 0b, this register is also reset by de-asserting (rising edge) RST#. 31 0 VLAN Filter Bit V ect[...]

332 Software Deve loper’s Manual Register Desc rip tio n s 13.6.2 W akeup Filter Control Register WUFC (05808h; R/W) This register is used to enable each of the pre- defined and flexible filt ers for wakeup support. A value of 1b means the filter is turned on, and a value of 0b means the filter is turned off. This regist er is reset an y time LAN[...]

Software Developer’s Manua l 333 Register Descriptions 13.6.3 W akeup St atus Register WUS (05810h; R) This register is used to record statistics abou t all wakeup packets received. If a packet matches multiple criteria then mul tip le bits could be set. W r it ing a 1b to any bit clears that bit. This register is not cleared when RST# is asse rt[...]

334 Software Deve loper’s Manual Register Desc rip tio n s 31 20 19 18 17 16 15 8 7 6 5 4 3 2 1 0 Reserved FLX3 FLX2 FLX1 FLX0 Reserved IPv6 1 IP v4 2 ARP BC MC EX MAG LNK C 1. Not applicable to the 82 544GC/EI . 2. IP for the 82544GC/EI . Field Bit(s) Init ial V alue Description LNKC 0 0b Link S tatus Change. MAG 1 0b Magic Packet Received. EX 2[...]

Software Developer’s Manua l 335 Register Descriptions 13.6.4 IP Address V alid IP A V (5838h; R/W) The IP Address V alid indicates whether the IP addresses in th e IP Address T able are valid. The valid bits are reset any time LAN_PWR_G OOD is 0b. When A UX_POWER equals 0b, the valid bits are also reset by deasserting (rising edge) RST#. 3 1 1 7[...]

336 Software Deve loper’s Manual Register Desc rip tio n s 13.6.5 IPv4 Address T a ble 1 IP4A T (05840h - 05858h; R/W) 2 The IPv4 Address T able is used to store the four IP addresses for ARP Request packet and Directed IP packet wakeup for IPv4. Note: This table is not cleared by any reset. 1. IP Address T able for the 82544GC /EI . 2. IP A T fo[...]

Software Developer’s Manua l 337 Register Descriptions 13.6.6 IPv6 Address T a ble 1 IP6A T (05880h - 0588Ch; R/W) The IPv6 Address T able is used to store the IPv6 addresses for ARP Request packet and Directed IP packet wakeup for IPv6. Note: This table is not cleared by any reset. 1. Not applicable to the 82544GC/EI . DWORD# Address 31 0 0 5880[...]

338 Software Deve loper’s Manual Register Desc rip tio n s 13.6.7 W akeup Packet Length WUPL (05900h; R/W) This register indicates the length of the first wakeup packet received. It is valid if one of the bits in the W akeup Status Register (WUSR) is set. It can be wri tten for diagnostic purposes and is not cleared by any reset. 13.6.8 W akeup P[...]

Software Developer’s Manua l 339 Register Descriptions Before writing to the Flexible Filter Length T able th e driver must first disable the flexible filters by writing 0b’ s to the Flexible Filter Enable bits of the W akeup Filt er Cont rol Register (WUFC. FLXn). 13.6.10 Flexible Filter Mask T able FFMT (09000h - 093F8h; R/W) The Flexible Fil[...]

340 Software Deve loper’s Manual Register Desc rip tio n s 13.6.1 1 Flexible Filter V alue T able FFVT (09800h - 09BF8h; R/W) The Flexible Filter V alue and T able is used to store the one value for each byte location in a packet for each flexible filter . If the co rresponding mask bi t is set to 1b, the Flexible Filter compares the incoming dat[...]

Software Developer’s Manua l 341 Register Descriptions All Statistics registers reset when read. 64-bit registers reset whenever the upper 32 bits are read. In addition, they stick at FFFFh_FFFFh when the maximum value is reached. The Statistics registers are not hardware initialized. Their default value is unknown. Software should read the conte[...]

342 Software Deve loper’s Manual Register Desc rip tio n s T able 13-94. ALGNERRC Register Bit Description 13.7.3 Symbol Error Count SYMERRS (04008h; R) Counts the number of sym bol errors between reads. The count increases for every bad symbol received, whether or not a packet is currently bein g received and whether or not the link is up. This [...]

Software Developer’s Manua l 343 Register Descriptions T able 13-96. RXERRC Regi ster Bit Description 13.7.5 Missed Packet s Count MPC (04010h; R) Counts the number of missed packets. Packets are missed when the receive FIFO has insufficient space to store the incoming packet. This can be caused because of too few buffers allocated, or because th[...]

344 Software Deve loper’s Manual Register Desc rip tio n s T able 13-98. SCC Regist er Bit Description 13.7.7 Excessive Collisions Count ECOL (04018h; R) When 16 or more collisions have occurred on a p acket, this register increm ents, rega rdless of t he value of collision threshold . If colli si on threshol d is set below 16, this counter won?[...]

Software Developer’s Manua l 345 Register Descriptions T able 13-100. MCC Regist er Bit Description 13.7.9 Late Collisions Count LA TECOL (04020h; R) Late collisions are collisions that occur after 64-byte time into the transmission of the packet while working in 10-100 Mb/s data rate, and 512 byte time into the transmission of the packet whil e [...]

346 Software Deve loper’s Manual Register Desc rip tio n s 13.7.1 1 Defer Count DC (04030h; R) This register counts defer events. A defer eve n t occurs when the transm itter cannot immediately send a packet due to the medium being busy either because anothe r device is transm itting, the IPG timer has not expired, half-duplex deferral events, re[...]

Software Developer’s Manua l 347 Register Descriptions 13.7.13 Sequence Error Count SEC (04038h; R) This register counts sequen ce error events. The p r oper sequence of 8b/10b sy mbols is as follows: idle, start-of-frame (SOF), data, pad (opti onal), en d-of-frame (EOF), fill (opt ional), idle. Hardware increments this counter for any ill egal s[...]

348 Software Deve loper’s Manual Register Desc rip tio n s 13.7.15 Receive Length Error Count RLEC (04040h; R) This register counts receive length error events. A length error occurs if an incoming packet passes the filter criteria but is undersized or oversized. Packets less th an 64 byt es are undersized. Packets over 1522 bytes are oversized i[...]

Software Developer’s Manua l 349 Register Descriptions 13.7.17 XON T ransmitted Count XONTXC (0404Ch; R) This register counts the number of XON packets transmitted. These can be either due to a full queue or due to software initiated action (using TC TL.SWXOFF). This register only increments if transmits are enabled. T able 13-109. XONTXC Registe[...]

350 Software Deve loper’s Manual Register Desc rip tio n s T able 13-1 1 1. XOFFTXC Re gister Bit Desc ription 13.7.20 FC Received Unsupported Count FCRUC (04058h; R) This register counts the number of unsuppo rted flow control fram es that are received. The FCRUC counter increments when a flow contro l packet is received that matches either the [...]

Software Developer’s Manua l 351 Register Descriptions T able 13 -1 13 . PRC6 4 Reg ist e r Bit Des cript io n 13.7.22 Packet s Received (65-127 Bytes) Count PRC127 (04060h; R) This register counts the number of good packets received that are 65-127 bytes (from <Destination Address> through <CRC>, inclusively) in length. Packets that [...]

352 Software Deve loper’s Manual Register Desc rip tio n s T able 13-1 15. PRC225 Register Bit Descrip t ion 13.7.24 Packets Received (256-51 1 Bytes) Count PRC51 1 (04068h ; R) This register counts the number of good p ackets received that ar e 256-51 1 bytes (from <Destination Address> thro ugh <CRC>, incl usively) in length. Packet[...]

Software Developer’s Manua l 353 Register Descriptions T able 13-1 17. PRC1023 Register Bit Description 13.7.26 Packet s Received (10 24 to Max Bytes) Count PRC1522 (04070h; R) This register counts th e number of good packets received that are from 1024 bytes to the maximum (from <Destination Address> through <C RC>, incl usively) i n[...]

354 Software Deve loper’s Manual Register Desc rip tio n s T able 13-1 19. GPRC Register Bit Description 13.7.28 Broadcast Packets Received Count BPRC (04078h; R) This register counts the number of good (no errors ) broadcast packets received. This register does not count broadcast packets receive d when the broadcast address filt er is disabled.[...]

Software Developer’s Manua l 355 Register Descriptions T able 13 -1 2 1. MP RC Reg i st er Bit De sc rip tion 13.7.30 Good Packets T ransmitted Count GPTC (04080h; R) This register counts the n umber of good (no errors) packets tran smitted. A good transmit packet is considered one that is 64 or more bytes in le ngt h (from <Destination Addres[...]

356 Software Deve loper’s Manual Register Desc rip tio n s T able 13-123. GORCL and GORCH Register Bit Description 13.7.32 Good Octets T ransmitted Count GOTCL (04090h; R)/ GOTCH (04094; R) These registers make up a 64-bit regist er that counts the number of good (n o errors) octets transmitted. This register resets each ti me the upper 32 bits a[...]

Software Developer’s Manua l 357 Register Descriptions This register does not increment when flow control packets are received. T able 13-125. RNBC Regi ster Bit Description 13.7.34 Receive Undersize Count RUC (040A4h; R) This register counts the number of received frames that passed addr ess filtering, and were less than minimum size (64 bytes f[...]

358 Software Deve loper’s Manual Register Desc rip tio n s T able 13-127. RFC Register Bit Description 13.7.36 Receive Oversize Count ROC (040ACh; R) This register counts the number of received fr ames with valid CRC field that passed address filtering, and were greater than maximum size. Packets over 1522 bytes are oversized if LongPack- etEnabl[...]

Software Developer’s Manua l 359 Register Descriptions T able 13-129. RJC Register Bit Descr iption 13.7.38 Management Pack et s Received Count 1 MGTPRC (040B4h; R) This register counts the total nu mber of packets received that pass the management filters as described in the appropriate T otal Cost of Ow nership (TCO) System Management Bus Inter[...]

360 Software Deve loper’s Manual Register Desc rip tio n s 13.7.39 Managem ent Packet s D ropped Count 1 MGTPDC (040B8h; R) This register counts the total number of packet s received that pass the management fi lters as described in the appropriate T otal Cost of Ow nership (TCO) System Management Bus Interface Application Notes and then are drop[...]

Software Developer’s Manua l 361 Register Descriptions All packets received have their octe ts summed into this register , re gardless of their length, whether they are erred, or whether they ar e flow control packets. This regi ster includes by tes received in a packet from the <Destination Address> field through the <CRC> fiel d, in[...]

362 Software Deve loper’s Manual Register Desc rip tio n s 13.7.43 T ot al Packet s Received TPR (040D0h; R) This register counts the total number of all pack ets received. All packets received are counted in this register , regardless of their length, whether th ey have errors, or whether they are flow control packets. This register only in crem[...]

Software Developer’s Manua l 363 Register Descriptions 13.7.45 Packet s T ransmit ted (64 Bytes) Count PTC64 (040D8h; R) This register counts the number of packets transm itted that are ex actly 64 bytes (from <Destin ation Address> through <CRC>, inclusively) in length. Pa rtial pa cket transmission s (collisions in half- duplex mode[...]

364 Software Deve loper’s Manual Register Desc rip tio n s 13.7.47 Packets T ransmi tted (128-255 Bytes) Count PTC255 (040E0h; R) This register counts the number of packets transmitted that ar e 128-255 bytes (from <Destination Address> through <CRC>, inclusiv ely) in length. Partial packet transmissions (co llisions in half- duplex m[...]

Software Developer’s Manua l 365 Register Descriptions 13.7.49 Packet s T ransmitted (512-1023 B ytes) Count PTC1023 (040E8h; R) This register counts the number of packets transm itted that are 512-1023 b ytes (from <Destination Address> through <CRC>, inclusively) in length. Pa rtial pa cket transmission s (collisions in half- duplex[...]

366 Software Deve loper’s Manual Register Desc rip tio n s 13.7.51 Multicast Packet s T ransmitted Count MPTC (040F0h; R) This register counts the number of multicast packets transmitted. This register does not include flow control packets and increments only if transmits are enable d. Counts clear as well as secure traffic. T able 13-140. MPTC R[...]

Software Developer’s Manua l 367 Register Descriptions 13.7.53 TCP Segmentation Context T ransmitted Count TSCTC (040F8h; R) This register counts the n umber of TCP segmentation offload transmissions and increments once the last portion of the TCP segmentation co ntext payl oad is seg mented and load ed as a packet into the Ethernet controller ?[...]

368 Software Deve loper’s Manual Register Desc rip tio n s 13.8 Diagnostics Registers The Ethernet controller contains several diagnostic registers. T h es e registers enable software to directly access the contents of the Ethernet controller ’ s internal P acket Buf fer Memory (PBM), also referred to as FIFO space. These registers also give so[...]

Software Developer’s Manua l 369 Register Descriptions T able 13-143. RDFT Register Bit Descrip tion 13.8.3 Receive Dat a FIFO Head Saved Register RDFHS (02420h; R/W) This register stores a copy of the Receive Data FIFO Head register in case the internal register needs to be restored. This register is availabl e for di agnostic purposes only , an[...]

370 Software Deve loper’s Manual Register Desc rip tio n s T able 13-145. RDFTS Regi ster Bit Description 13.8.5 Receive Dat a FIFO Packet Count RDFPC (02430h; R/W) This register reflects the number of receive packets that are curr ently in the Receive FIFO. This register is available for di agnostic purposes on ly , and should no t be wri tten d[...]

Software Developer’s Manua l 371 Register Descriptions T able 13-147. TDFH Register Bit Descrip tion) 13.8.7 T ransmit Data FIFO T ail Register TDFT (03418h; R/W) This register stores the head of the Ethernet c ontroller ’ s on–chip transmit data FIFO. Since the internal FIFO is organized in units of 64-bit words, this field contains the 64-b[...]

372 Software Deve loper’s Manual Register Desc rip tio n s T able 13-149. TDFHS Regi ster Bit Desc ription 13.8.9 T ransmit Data FIFO T a il Saved Register TDFTS (03428h; R/W) This register stores a copy of th e T ransmit Data FIFO T ail regist er in case the internal register needs to be restored. This register is availabl e for diagnostic purp [...]

Software Developer’s Manua l 373 Register Descriptions T able 13-151. TDFPC Register Bit Descr iption 13.8.1 1 Packet Buffer Memory PBM (10000h - 1FFFCh; R/W) All PBM (FIFO) data is available to diagnostic s. Locations can be acce ssed as 32-bit or 64-bit words. The internal PBM is 64 KB (40 KB for the 82547GI/EI ) in size. Software can configure[...]

374 Software Deve loper’s Manual Register Desc rip tio n s Note: This page intentionally left blank.[...]

Software Developer’s Manua l 375 General Initialization and Reset Operati on General Initialization and Reset Operation 14 14.1 Introduction This section list s all necessary i nitializations and describes the reset commands for the PCI/PCI-X Family of Gigabit Ethernet Controllers. Note: TBI mode is used by the 82544GC/EI . Internal SerDes is use[...]

376 Software Deve loper’s Manual General Initialization and Reset Operation • PHY Reset (CTRL.PHY_RST) should be set to 0b. Setting this bit to 1b resets the PH Y without accessing the PHY registers. This b it is ignored in internal SerDes mode. • CTRL.ILOS should be set to 0b (not applicable to the 82541xx and 82547GI/EI ). • If Flow Contr[...]

Software Developer’s Manua l 377 General Initialization and Reset Operati on Program the Receive Control (RCTL) register w ith appropriate values for desired operation to include the following: • Set the receiver Enable (RCTL.EN) bit to 1b for no rmal operation. However , it is best to leave the Ethernet controller rece ive logic disabled (RCTL[...]

378 Software Deve loper’s Manual General Initialization and Reset Operation • Configure the Collision Threshold (TCTL.CT) to th e desired val ue. Ethernet standard i s 10h. This setting only has meaning in half duplex mo de. • Configure the Collision Distan ce (TCTL.COLD) to its expect ed value. For full duplex operation, this value should be[...]

Software Developer’s Manua l 379 General Initialization and Reset Operati on Note: IPGR1 and IPGR2 are not needed in full duplex, but are easier to always program to th e values shown. T able 14-1. Signal Descriptions Signal Ball Name and Funct ion LOS / LINK A10 Loss of Signal (TBI) / Link I ndication. Loss of signal (high for lost signal) from [...]

380 Software Deve loper’s Manual General Initialization and Reset Operation 14.5.1 Signal Interface The external GMII/MII interface is similar in function to the interface used to communicate between the MAC and internal PHY . As with use of the internal PHY , the external GMII/MII interface supports 10/100/1000 Mbps operation, wi th both half- a[...]

Software Developer’s Manua l 381 General Initialization and Reset Operati on T able 14-2. Signal Functions 14.5.2 GMII/MII Features not Supported T able 14-3 lists the signals and functions not provided by this interface. Signal Function Pin GMII (1000 Mbps) Operations CRS Carrier Sense CRS COL Collision Detect COL TX_ER Transmit Code Error TX_DA[...]

382 Software Deve loper’s Manual General Initialization and Reset Operation T able 14-3. Signal Functions Not Supported 14.5.3 A voiding GMII T est Mode(s) Note that the Ethernet co ntroller contains a set of test mode s that use this in terface for component manufacturing and/or diagnostic test. T o avoid accidental engagement of unexpected test[...]

Software Developer’s Manua l 383 General Initialization and Reset Operati on 14.5.5 Link Setup The following examples are provided as suggesti ons for configuring comm on settings between the MAC and an Ethernet controller attached in the GMII/MII mode.  MAC duplex and speed settings forced by software based on resolution of PH Y (CTRL.FRCD[...]

384 Software Deve loper’s Manual General Initialization and Reset Operation  MAC/PHY duplex and speed settings both forced by software (ful ly-forced link setup) (CTRL.FRCDPLX = 1b, CTRL.FRCS PD = 1b, CTRL.S LU = 1b) CTRL.FD ............ .......Set by software to desired full/half duplex operation (must match duplex settin g of PHY) CTRL.SL[...]

Software Developer’s Manua l 385 General Initialization and Reset Operati on Once link is achieved by the PHY , software is notified when a Link Status Change (LSC) interrupt is generated by the Ethernet controller . This onl y occurs if software en abled the LSC bit in the Interrupt Mask Set/Read (MS) Register . 14.7 Reset Operation The followin[...]

386 Software Deve loper’s Manual General Initialization and Reset Operation RST#: When asserted, all PCI signals are forced to a high impedance stat e. Upon d eassertion, the Ethernet controller ’ s internal registers, excludi ng the following ex ceptions, are reset. General Registers: Reset to power-on values. Interrupt Registers: Reset to pow[...]

Software Developer’s Manua l 387 General Initialization and Reset Operati on Default values for certain bi ts of the Device Cont rol Register must be read out of the EEPROM and appropriately set by software if an EEPROM is used. Global Reset does NOT aff ect the direction of the software programmable pins. Link_Reset: When LRST (bit 3 of the Devi[...]

388 Software Deve loper’s Manual General Initialization and Reset Operation Driver accessible W akeup S tatus registers are excluded from all resets except for LAN_PWR_GOOD. This includes: • W akeup Status Register . • W akeup Packet Length. • W akeup Packet Memory . Finally , the “W akeup Context” as defined in the PCI Bus Power Manage[...]

Software Developer’s Man ual 389 Diagnostics and T estability Diagnostics and T estability 15 15.1 Diagnostics This section explains the regi sters provided fo r diagnostic access. These registers enable system level integration and debugging, including the ability to access all internal memories. This information i s often critical i n determini[...]

390 Software Deve loper’s Manual Diagnostics and T estability 15.1.3.1 Internal Loopback This loopback mode internally l oops back the transmit to receive path in the PHY , exercising the internal GMII/MII bus. Programming both MAC and PH Y is required. Fol low ing is the flow: /* Auto-MDI/MDIX Off */ e1000_write_phy_reg(16, 0x08 08); /* reset to[...]

Software Developer’s Man ual 391 Diagnostics and T estability 15.2.1 EXTEST Instruction This instruction allows testing of off-chip circuitry and board level interconnection s. Data is typically loaded onto the latched paral lel ou tput s of the boundary-scan shift register stages usin g the SAMPLE/PRELOAD instruct ion prior to selection of the E[...]

392 Software Deve loper’s Manual Diagnostics and T estability Note: This page intentionally left blank.[...]

Software Developer’s Man ual 393 Appendix (Changes From 8254 4EI/82544GC) Appendix (Changes From 82544EI/82544GC) A A.1 Introduction This section describes the new feat ures that hav e been added to th e PCI/PCI-X Family of Gig abit Ethernet Controllers from its predecessor, the 82544EI/82544GC and highligh ts its registers that have been changed[...]

394 Software Deve loper’s Manual Appendix (Changes From 82544EI/82 544GC) A.3 Register Changes Ta b l e A - 1 lists the registers that have been adde d or changed in the Ethernet controller . T able A-1. Register Changes Register Offset CTRL 00000h ST A TUS 0 0008h EEC 00010h EERD 00014h CTRL_EXT 00018h LEDCTL 00E00h ICR 000C0h ITR 000C4h ICS 000[...]

Software Developer’s Man ual 395 Appendix (82540 EP/EM and 82545GM/EM Dif ferences) Appendix (82540EP/EM and 82545GM/EM Dif ferences) B B.1 Introduction This section describes t h e differences be tween the 82546GB/EB , the 82540EP/EM and the 82545GM/EM . All three of these Ethernet controllers come from the same fam ily so their register sets ar[...]

396 Software Deve loper’s Manual Appendix (82540EP/EM and 82545GM / EM Difference s) Note: Though the 82540EP/EM supports devices with up to 512 KB of memory , smaller devices may also be used. Accesses to memo ry beyond the FLASH device size results in access wrapping as only the lower address bits are utilized by the FLASH. The 82540EP/EM does [...]