1 /*******************************************************************************
4 Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2 of the License, or (at your option)
11 This program is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 You should have received a copy of the GNU General Public License along with
17 this program; if not, write to the Free Software Foundation, Inc., 59
18 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 The full GNU General Public License is included in this distribution in the
24 Linux NICS <linux.nics@intel.com>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
30 * Shared functions for accessing and configuring the MAC
35 static int32_t e1000_set_phy_type(struct e1000_hw *hw);
36 static void e1000_phy_init_script(struct e1000_hw *hw);
37 static int32_t e1000_setup_copper_link(struct e1000_hw *hw);
38 static int32_t e1000_setup_fiber_serdes_link(struct e1000_hw *hw);
39 static int32_t e1000_adjust_serdes_amplitude(struct e1000_hw *hw);
40 static int32_t e1000_phy_force_speed_duplex(struct e1000_hw *hw);
41 static int32_t e1000_config_mac_to_phy(struct e1000_hw *hw);
42 static void e1000_raise_mdi_clk(struct e1000_hw *hw, uint32_t *ctrl);
43 static void e1000_lower_mdi_clk(struct e1000_hw *hw, uint32_t *ctrl);
44 static void e1000_shift_out_mdi_bits(struct e1000_hw *hw, uint32_t data,
46 static uint16_t e1000_shift_in_mdi_bits(struct e1000_hw *hw);
47 static int32_t e1000_phy_reset_dsp(struct e1000_hw *hw);
48 static int32_t e1000_write_eeprom_spi(struct e1000_hw *hw, uint16_t offset,
49 uint16_t words, uint16_t *data);
50 static int32_t e1000_write_eeprom_microwire(struct e1000_hw *hw,
51 uint16_t offset, uint16_t words,
53 static int32_t e1000_spi_eeprom_ready(struct e1000_hw *hw);
54 static void e1000_raise_ee_clk(struct e1000_hw *hw, uint32_t *eecd);
55 static void e1000_lower_ee_clk(struct e1000_hw *hw, uint32_t *eecd);
56 static void e1000_shift_out_ee_bits(struct e1000_hw *hw, uint16_t data,
58 static int32_t e1000_write_phy_reg_ex(struct e1000_hw *hw, uint32_t reg_addr,
60 static int32_t e1000_read_phy_reg_ex(struct e1000_hw *hw,uint32_t reg_addr,
62 static uint16_t e1000_shift_in_ee_bits(struct e1000_hw *hw, uint16_t count);
63 static int32_t e1000_acquire_eeprom(struct e1000_hw *hw);
64 static void e1000_release_eeprom(struct e1000_hw *hw);
65 static void e1000_standby_eeprom(struct e1000_hw *hw);
66 static int32_t e1000_set_vco_speed(struct e1000_hw *hw);
67 static int32_t e1000_polarity_reversal_workaround(struct e1000_hw *hw);
68 static int32_t e1000_set_phy_mode(struct e1000_hw *hw);
69 static int32_t e1000_host_if_read_cookie(struct e1000_hw *hw, uint8_t *buffer);
70 static uint8_t e1000_calculate_mng_checksum(char *buffer, uint32_t length);
71 static uint8_t e1000_arc_subsystem_valid(struct e1000_hw *hw);
72 static int32_t e1000_check_downshift(struct e1000_hw *hw);
73 static int32_t e1000_check_polarity(struct e1000_hw *hw, uint16_t *polarity);
74 static void e1000_clear_hw_cntrs(struct e1000_hw *hw);
75 static void e1000_clear_vfta(struct e1000_hw *hw);
76 static int32_t e1000_commit_shadow_ram(struct e1000_hw *hw);
77 static int32_t e1000_config_dsp_after_link_change(struct e1000_hw *hw,
79 static int32_t e1000_config_fc_after_link_up(struct e1000_hw *hw);
80 static int32_t e1000_detect_gig_phy(struct e1000_hw *hw);
81 static int32_t e1000_get_auto_rd_done(struct e1000_hw *hw);
82 static int32_t e1000_get_cable_length(struct e1000_hw *hw,
84 uint16_t *max_length);
85 static int32_t e1000_get_hw_eeprom_semaphore(struct e1000_hw *hw);
86 static int32_t e1000_get_phy_cfg_done(struct e1000_hw *hw);
87 static int32_t e1000_id_led_init(struct e1000_hw * hw);
88 static void e1000_init_rx_addrs(struct e1000_hw *hw);
89 static boolean_t e1000_is_onboard_nvm_eeprom(struct e1000_hw *hw);
90 static int32_t e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int eerd);
91 static void e1000_put_hw_eeprom_semaphore(struct e1000_hw *hw);
92 static int32_t e1000_read_eeprom_eerd(struct e1000_hw *hw, uint16_t offset,
93 uint16_t words, uint16_t *data);
94 static int32_t e1000_set_d0_lplu_state(struct e1000_hw *hw, boolean_t active);
95 static int32_t e1000_set_d3_lplu_state(struct e1000_hw *hw, boolean_t active);
96 static int32_t e1000_wait_autoneg(struct e1000_hw *hw);
98 static void e1000_write_reg_io(struct e1000_hw *hw, uint32_t offset,
101 #define E1000_WRITE_REG_IO(a, reg, val) \
102 e1000_write_reg_io((a), E1000_##reg, val)
104 /* IGP cable length table */
106 uint16_t e1000_igp_cable_length_table[IGP01E1000_AGC_LENGTH_TABLE_SIZE] =
107 { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
108 5, 10, 10, 10, 10, 10, 10, 10, 20, 20, 20, 20, 20, 25, 25, 25,
109 25, 25, 25, 25, 30, 30, 30, 30, 40, 40, 40, 40, 40, 40, 40, 40,
110 40, 50, 50, 50, 50, 50, 50, 50, 60, 60, 60, 60, 60, 60, 60, 60,
111 60, 70, 70, 70, 70, 70, 70, 80, 80, 80, 80, 80, 80, 90, 90, 90,
112 90, 90, 90, 90, 90, 90, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100,
113 100, 100, 100, 100, 110, 110, 110, 110, 110, 110, 110, 110, 110, 110, 110, 110,
114 110, 110, 110, 110, 110, 110, 120, 120, 120, 120, 120, 120, 120, 120, 120, 120};
117 uint16_t e1000_igp_2_cable_length_table[IGP02E1000_AGC_LENGTH_TABLE_SIZE] =
118 { 0, 0, 0, 0, 0, 0, 0, 0, 3, 5, 8, 11, 13, 16, 18, 21,
119 0, 0, 0, 3, 6, 10, 13, 16, 19, 23, 26, 29, 32, 35, 38, 41,
120 6, 10, 14, 18, 22, 26, 30, 33, 37, 41, 44, 48, 51, 54, 58, 61,
121 21, 26, 31, 35, 40, 44, 49, 53, 57, 61, 65, 68, 72, 75, 79, 82,
122 40, 45, 51, 56, 61, 66, 70, 75, 79, 83, 87, 91, 94, 98, 101, 104,
123 60, 66, 72, 77, 82, 87, 92, 96, 100, 104, 108, 111, 114, 117, 119, 121,
124 83, 89, 95, 100, 105, 109, 113, 116, 119, 122, 124,
125 104, 109, 114, 118, 121, 124};
128 /******************************************************************************
129 * Set the phy type member in the hw struct.
131 * hw - Struct containing variables accessed by shared code
132 *****************************************************************************/
134 e1000_set_phy_type(struct e1000_hw *hw)
136 DEBUGFUNC("e1000_set_phy_type");
138 if(hw->mac_type == e1000_undefined)
139 return -E1000_ERR_PHY_TYPE;
142 case M88E1000_E_PHY_ID:
143 case M88E1000_I_PHY_ID:
144 case M88E1011_I_PHY_ID:
145 case M88E1111_I_PHY_ID:
146 hw->phy_type = e1000_phy_m88;
148 case IGP01E1000_I_PHY_ID:
149 if(hw->mac_type == e1000_82541 ||
150 hw->mac_type == e1000_82541_rev_2 ||
151 hw->mac_type == e1000_82547 ||
152 hw->mac_type == e1000_82547_rev_2) {
153 hw->phy_type = e1000_phy_igp;
158 /* Should never have loaded on this device */
159 hw->phy_type = e1000_phy_undefined;
160 return -E1000_ERR_PHY_TYPE;
163 return E1000_SUCCESS;
166 /******************************************************************************
167 * IGP phy init script - initializes the GbE PHY
169 * hw - Struct containing variables accessed by shared code
170 *****************************************************************************/
172 e1000_phy_init_script(struct e1000_hw *hw)
175 uint16_t phy_saved_data;
177 DEBUGFUNC("e1000_phy_init_script");
179 if(hw->phy_init_script) {
182 /* Save off the current value of register 0x2F5B to be restored at
183 * the end of this routine. */
184 ret_val = e1000_read_phy_reg(hw, 0x2F5B, &phy_saved_data);
186 /* Disabled the PHY transmitter */
187 e1000_write_phy_reg(hw, 0x2F5B, 0x0003);
191 e1000_write_phy_reg(hw,0x0000,0x0140);
195 switch(hw->mac_type) {
198 e1000_write_phy_reg(hw, 0x1F95, 0x0001);
200 e1000_write_phy_reg(hw, 0x1F71, 0xBD21);
202 e1000_write_phy_reg(hw, 0x1F79, 0x0018);
204 e1000_write_phy_reg(hw, 0x1F30, 0x1600);
206 e1000_write_phy_reg(hw, 0x1F31, 0x0014);
208 e1000_write_phy_reg(hw, 0x1F32, 0x161C);
210 e1000_write_phy_reg(hw, 0x1F94, 0x0003);
212 e1000_write_phy_reg(hw, 0x1F96, 0x003F);
214 e1000_write_phy_reg(hw, 0x2010, 0x0008);
217 case e1000_82541_rev_2:
218 case e1000_82547_rev_2:
219 e1000_write_phy_reg(hw, 0x1F73, 0x0099);
225 e1000_write_phy_reg(hw, 0x0000, 0x3300);
229 /* Now enable the transmitter */
230 e1000_write_phy_reg(hw, 0x2F5B, phy_saved_data);
232 if(hw->mac_type == e1000_82547) {
233 uint16_t fused, fine, coarse;
235 /* Move to analog registers page */
236 e1000_read_phy_reg(hw, IGP01E1000_ANALOG_SPARE_FUSE_STATUS, &fused);
238 if(!(fused & IGP01E1000_ANALOG_SPARE_FUSE_ENABLED)) {
239 e1000_read_phy_reg(hw, IGP01E1000_ANALOG_FUSE_STATUS, &fused);
241 fine = fused & IGP01E1000_ANALOG_FUSE_FINE_MASK;
242 coarse = fused & IGP01E1000_ANALOG_FUSE_COARSE_MASK;
244 if(coarse > IGP01E1000_ANALOG_FUSE_COARSE_THRESH) {
245 coarse -= IGP01E1000_ANALOG_FUSE_COARSE_10;
246 fine -= IGP01E1000_ANALOG_FUSE_FINE_1;
247 } else if(coarse == IGP01E1000_ANALOG_FUSE_COARSE_THRESH)
248 fine -= IGP01E1000_ANALOG_FUSE_FINE_10;
250 fused = (fused & IGP01E1000_ANALOG_FUSE_POLY_MASK) |
251 (fine & IGP01E1000_ANALOG_FUSE_FINE_MASK) |
252 (coarse & IGP01E1000_ANALOG_FUSE_COARSE_MASK);
254 e1000_write_phy_reg(hw, IGP01E1000_ANALOG_FUSE_CONTROL, fused);
255 e1000_write_phy_reg(hw, IGP01E1000_ANALOG_FUSE_BYPASS,
256 IGP01E1000_ANALOG_FUSE_ENABLE_SW_CONTROL);
262 /******************************************************************************
263 * Set the mac type member in the hw struct.
265 * hw - Struct containing variables accessed by shared code
266 *****************************************************************************/
268 e1000_set_mac_type(struct e1000_hw *hw)
270 DEBUGFUNC("e1000_set_mac_type");
272 switch (hw->device_id) {
273 case E1000_DEV_ID_82542:
274 switch (hw->revision_id) {
275 case E1000_82542_2_0_REV_ID:
276 hw->mac_type = e1000_82542_rev2_0;
278 case E1000_82542_2_1_REV_ID:
279 hw->mac_type = e1000_82542_rev2_1;
282 /* Invalid 82542 revision ID */
283 return -E1000_ERR_MAC_TYPE;
286 case E1000_DEV_ID_82543GC_FIBER:
287 case E1000_DEV_ID_82543GC_COPPER:
288 hw->mac_type = e1000_82543;
290 case E1000_DEV_ID_82544EI_COPPER:
291 case E1000_DEV_ID_82544EI_FIBER:
292 case E1000_DEV_ID_82544GC_COPPER:
293 case E1000_DEV_ID_82544GC_LOM:
294 hw->mac_type = e1000_82544;
296 case E1000_DEV_ID_82540EM:
297 case E1000_DEV_ID_82540EM_LOM:
298 case E1000_DEV_ID_82540EP:
299 case E1000_DEV_ID_82540EP_LOM:
300 case E1000_DEV_ID_82540EP_LP:
301 hw->mac_type = e1000_82540;
303 case E1000_DEV_ID_82545EM_COPPER:
304 case E1000_DEV_ID_82545EM_FIBER:
305 hw->mac_type = e1000_82545;
307 case E1000_DEV_ID_82545GM_COPPER:
308 case E1000_DEV_ID_82545GM_FIBER:
309 case E1000_DEV_ID_82545GM_SERDES:
310 hw->mac_type = e1000_82545_rev_3;
312 case E1000_DEV_ID_82546EB_COPPER:
313 case E1000_DEV_ID_82546EB_FIBER:
314 case E1000_DEV_ID_82546EB_QUAD_COPPER:
315 hw->mac_type = e1000_82546;
317 case E1000_DEV_ID_82546GB_COPPER:
318 case E1000_DEV_ID_82546GB_FIBER:
319 case E1000_DEV_ID_82546GB_SERDES:
320 case E1000_DEV_ID_82546GB_PCIE:
321 hw->mac_type = e1000_82546_rev_3;
323 case E1000_DEV_ID_82541EI:
324 case E1000_DEV_ID_82541EI_MOBILE:
325 hw->mac_type = e1000_82541;
327 case E1000_DEV_ID_82541ER:
328 case E1000_DEV_ID_82541GI:
329 case E1000_DEV_ID_82541GI_LF:
330 case E1000_DEV_ID_82541GI_MOBILE:
331 hw->mac_type = e1000_82541_rev_2;
333 case E1000_DEV_ID_82547EI:
334 hw->mac_type = e1000_82547;
336 case E1000_DEV_ID_82547GI:
337 hw->mac_type = e1000_82547_rev_2;
339 case E1000_DEV_ID_82571EB_COPPER:
340 case E1000_DEV_ID_82571EB_FIBER:
341 case E1000_DEV_ID_82571EB_SERDES:
342 hw->mac_type = e1000_82571;
344 case E1000_DEV_ID_82572EI_COPPER:
345 case E1000_DEV_ID_82572EI_FIBER:
346 case E1000_DEV_ID_82572EI_SERDES:
347 hw->mac_type = e1000_82572;
349 case E1000_DEV_ID_82573E:
350 case E1000_DEV_ID_82573E_IAMT:
351 case E1000_DEV_ID_82573L:
352 hw->mac_type = e1000_82573;
355 /* Should never have loaded on this device */
356 return -E1000_ERR_MAC_TYPE;
359 switch(hw->mac_type) {
363 hw->eeprom_semaphore_present = TRUE;
367 case e1000_82541_rev_2:
368 case e1000_82547_rev_2:
369 hw->asf_firmware_present = TRUE;
375 return E1000_SUCCESS;
378 /*****************************************************************************
379 * Set media type and TBI compatibility.
381 * hw - Struct containing variables accessed by shared code
382 * **************************************************************************/
384 e1000_set_media_type(struct e1000_hw *hw)
388 DEBUGFUNC("e1000_set_media_type");
390 if(hw->mac_type != e1000_82543) {
391 /* tbi_compatibility is only valid on 82543 */
392 hw->tbi_compatibility_en = FALSE;
395 switch (hw->device_id) {
396 case E1000_DEV_ID_82545GM_SERDES:
397 case E1000_DEV_ID_82546GB_SERDES:
398 case E1000_DEV_ID_82571EB_SERDES:
399 case E1000_DEV_ID_82572EI_SERDES:
400 hw->media_type = e1000_media_type_internal_serdes;
403 switch (hw->mac_type) {
404 case e1000_82542_rev2_0:
405 case e1000_82542_rev2_1:
406 hw->media_type = e1000_media_type_fiber;
409 /* The STATUS_TBIMODE bit is reserved or reused for the this
412 hw->media_type = e1000_media_type_copper;
415 status = E1000_READ_REG(hw, STATUS);
416 if (status & E1000_STATUS_TBIMODE) {
417 hw->media_type = e1000_media_type_fiber;
418 /* tbi_compatibility not valid on fiber */
419 hw->tbi_compatibility_en = FALSE;
421 hw->media_type = e1000_media_type_copper;
428 /******************************************************************************
429 * Reset the transmit and receive units; mask and clear all interrupts.
431 * hw - Struct containing variables accessed by shared code
432 *****************************************************************************/
434 e1000_reset_hw(struct e1000_hw *hw)
442 uint32_t extcnf_ctrl;
445 DEBUGFUNC("e1000_reset_hw");
447 /* For 82542 (rev 2.0), disable MWI before issuing a device reset */
448 if(hw->mac_type == e1000_82542_rev2_0) {
449 DEBUGOUT("Disabling MWI on 82542 rev 2.0\n");
450 e1000_pci_clear_mwi(hw);
453 if(hw->bus_type == e1000_bus_type_pci_express) {
454 /* Prevent the PCI-E bus from sticking if there is no TLP connection
455 * on the last TLP read/write transaction when MAC is reset.
457 if(e1000_disable_pciex_master(hw) != E1000_SUCCESS) {
458 DEBUGOUT("PCI-E Master disable polling has failed.\n");
462 /* Clear interrupt mask to stop board from generating interrupts */
463 DEBUGOUT("Masking off all interrupts\n");
464 E1000_WRITE_REG(hw, IMC, 0xffffffff);
466 /* Disable the Transmit and Receive units. Then delay to allow
467 * any pending transactions to complete before we hit the MAC with
470 E1000_WRITE_REG(hw, RCTL, 0);
471 E1000_WRITE_REG(hw, TCTL, E1000_TCTL_PSP);
472 E1000_WRITE_FLUSH(hw);
474 /* The tbi_compatibility_on Flag must be cleared when Rctl is cleared. */
475 hw->tbi_compatibility_on = FALSE;
477 /* Delay to allow any outstanding PCI transactions to complete before
478 * resetting the device
482 ctrl = E1000_READ_REG(hw, CTRL);
484 /* Must reset the PHY before resetting the MAC */
485 if((hw->mac_type == e1000_82541) || (hw->mac_type == e1000_82547)) {
486 E1000_WRITE_REG(hw, CTRL, (ctrl | E1000_CTRL_PHY_RST));
490 /* Must acquire the MDIO ownership before MAC reset.
491 * Ownership defaults to firmware after a reset. */
492 if(hw->mac_type == e1000_82573) {
495 extcnf_ctrl = E1000_READ_REG(hw, EXTCNF_CTRL);
496 extcnf_ctrl |= E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP;
499 E1000_WRITE_REG(hw, EXTCNF_CTRL, extcnf_ctrl);
500 extcnf_ctrl = E1000_READ_REG(hw, EXTCNF_CTRL);
502 if(extcnf_ctrl & E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP)
505 extcnf_ctrl |= E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP;
512 /* Issue a global reset to the MAC. This will reset the chip's
513 * transmit, receive, DMA, and link units. It will not effect
514 * the current PCI configuration. The global reset bit is self-
515 * clearing, and should clear within a microsecond.
517 DEBUGOUT("Issuing a global reset to MAC\n");
519 switch(hw->mac_type) {
525 case e1000_82541_rev_2:
526 /* These controllers can't ack the 64-bit write when issuing the
527 * reset, so use IO-mapping as a workaround to issue the reset */
528 E1000_WRITE_REG_IO(hw, CTRL, (ctrl | E1000_CTRL_RST));
530 case e1000_82545_rev_3:
531 case e1000_82546_rev_3:
532 /* Reset is performed on a shadow of the control register */
533 E1000_WRITE_REG(hw, CTRL_DUP, (ctrl | E1000_CTRL_RST));
536 E1000_WRITE_REG(hw, CTRL, (ctrl | E1000_CTRL_RST));
540 /* After MAC reset, force reload of EEPROM to restore power-on settings to
541 * device. Later controllers reload the EEPROM automatically, so just wait
542 * for reload to complete.
544 switch(hw->mac_type) {
545 case e1000_82542_rev2_0:
546 case e1000_82542_rev2_1:
549 /* Wait for reset to complete */
551 ctrl_ext = E1000_READ_REG(hw, CTRL_EXT);
552 ctrl_ext |= E1000_CTRL_EXT_EE_RST;
553 E1000_WRITE_REG(hw, CTRL_EXT, ctrl_ext);
554 E1000_WRITE_FLUSH(hw);
555 /* Wait for EEPROM reload */
559 case e1000_82541_rev_2:
561 case e1000_82547_rev_2:
562 /* Wait for EEPROM reload */
566 if (e1000_is_onboard_nvm_eeprom(hw) == FALSE) {
568 ctrl_ext = E1000_READ_REG(hw, CTRL_EXT);
569 ctrl_ext |= E1000_CTRL_EXT_EE_RST;
570 E1000_WRITE_REG(hw, CTRL_EXT, ctrl_ext);
571 E1000_WRITE_FLUSH(hw);
576 ret_val = e1000_get_auto_rd_done(hw);
578 /* We don't want to continue accessing MAC registers. */
582 /* Wait for EEPROM reload (it happens automatically) */
587 /* Disable HW ARPs on ASF enabled adapters */
588 if(hw->mac_type >= e1000_82540 && hw->mac_type <= e1000_82547_rev_2) {
589 manc = E1000_READ_REG(hw, MANC);
590 manc &= ~(E1000_MANC_ARP_EN);
591 E1000_WRITE_REG(hw, MANC, manc);
594 if((hw->mac_type == e1000_82541) || (hw->mac_type == e1000_82547)) {
595 e1000_phy_init_script(hw);
597 /* Configure activity LED after PHY reset */
598 led_ctrl = E1000_READ_REG(hw, LEDCTL);
599 led_ctrl &= IGP_ACTIVITY_LED_MASK;
600 led_ctrl |= (IGP_ACTIVITY_LED_ENABLE | IGP_LED3_MODE);
601 E1000_WRITE_REG(hw, LEDCTL, led_ctrl);
604 /* Clear interrupt mask to stop board from generating interrupts */
605 DEBUGOUT("Masking off all interrupts\n");
606 E1000_WRITE_REG(hw, IMC, 0xffffffff);
608 /* Clear any pending interrupt events. */
609 icr = E1000_READ_REG(hw, ICR);
611 /* If MWI was previously enabled, reenable it. */
612 if(hw->mac_type == e1000_82542_rev2_0) {
613 if(hw->pci_cmd_word & CMD_MEM_WRT_INVALIDATE)
614 e1000_pci_set_mwi(hw);
617 return E1000_SUCCESS;
620 /******************************************************************************
621 * Performs basic configuration of the adapter.
623 * hw - Struct containing variables accessed by shared code
625 * Assumes that the controller has previously been reset and is in a
626 * post-reset uninitialized state. Initializes the receive address registers,
627 * multicast table, and VLAN filter table. Calls routines to setup link
628 * configuration and flow control settings. Clears all on-chip counters. Leaves
629 * the transmit and receive units disabled and uninitialized.
630 *****************************************************************************/
632 e1000_init_hw(struct e1000_hw *hw)
637 uint16_t pcix_cmd_word;
638 uint16_t pcix_stat_hi_word;
643 DEBUGFUNC("e1000_init_hw");
645 /* Initialize Identification LED */
646 ret_val = e1000_id_led_init(hw);
648 DEBUGOUT("Error Initializing Identification LED\n");
652 /* Set the media type and TBI compatibility */
653 e1000_set_media_type(hw);
655 /* Disabling VLAN filtering. */
656 DEBUGOUT("Initializing the IEEE VLAN\n");
657 if (hw->mac_type < e1000_82545_rev_3)
658 E1000_WRITE_REG(hw, VET, 0);
659 e1000_clear_vfta(hw);
661 /* For 82542 (rev 2.0), disable MWI and put the receiver into reset */
662 if(hw->mac_type == e1000_82542_rev2_0) {
663 DEBUGOUT("Disabling MWI on 82542 rev 2.0\n");
664 e1000_pci_clear_mwi(hw);
665 E1000_WRITE_REG(hw, RCTL, E1000_RCTL_RST);
666 E1000_WRITE_FLUSH(hw);
670 /* Setup the receive address. This involves initializing all of the Receive
671 * Address Registers (RARs 0 - 15).
673 e1000_init_rx_addrs(hw);
675 /* For 82542 (rev 2.0), take the receiver out of reset and enable MWI */
676 if(hw->mac_type == e1000_82542_rev2_0) {
677 E1000_WRITE_REG(hw, RCTL, 0);
678 E1000_WRITE_FLUSH(hw);
680 if(hw->pci_cmd_word & CMD_MEM_WRT_INVALIDATE)
681 e1000_pci_set_mwi(hw);
684 /* Zero out the Multicast HASH table */
685 DEBUGOUT("Zeroing the MTA\n");
686 mta_size = E1000_MC_TBL_SIZE;
687 for(i = 0; i < mta_size; i++)
688 E1000_WRITE_REG_ARRAY(hw, MTA, i, 0);
690 /* Set the PCI priority bit correctly in the CTRL register. This
691 * determines if the adapter gives priority to receives, or if it
692 * gives equal priority to transmits and receives. Valid only on
693 * 82542 and 82543 silicon.
695 if(hw->dma_fairness && hw->mac_type <= e1000_82543) {
696 ctrl = E1000_READ_REG(hw, CTRL);
697 E1000_WRITE_REG(hw, CTRL, ctrl | E1000_CTRL_PRIOR);
700 switch(hw->mac_type) {
701 case e1000_82545_rev_3:
702 case e1000_82546_rev_3:
705 /* Workaround for PCI-X problem when BIOS sets MMRBC incorrectly. */
706 if(hw->bus_type == e1000_bus_type_pcix) {
707 e1000_read_pci_cfg(hw, PCIX_COMMAND_REGISTER, &pcix_cmd_word);
708 e1000_read_pci_cfg(hw, PCIX_STATUS_REGISTER_HI,
710 cmd_mmrbc = (pcix_cmd_word & PCIX_COMMAND_MMRBC_MASK) >>
711 PCIX_COMMAND_MMRBC_SHIFT;
712 stat_mmrbc = (pcix_stat_hi_word & PCIX_STATUS_HI_MMRBC_MASK) >>
713 PCIX_STATUS_HI_MMRBC_SHIFT;
714 if(stat_mmrbc == PCIX_STATUS_HI_MMRBC_4K)
715 stat_mmrbc = PCIX_STATUS_HI_MMRBC_2K;
716 if(cmd_mmrbc > stat_mmrbc) {
717 pcix_cmd_word &= ~PCIX_COMMAND_MMRBC_MASK;
718 pcix_cmd_word |= stat_mmrbc << PCIX_COMMAND_MMRBC_SHIFT;
719 e1000_write_pci_cfg(hw, PCIX_COMMAND_REGISTER,
726 /* Call a subroutine to configure the link and setup flow control. */
727 ret_val = e1000_setup_link(hw);
729 /* Set the transmit descriptor write-back policy */
730 if(hw->mac_type > e1000_82544) {
731 ctrl = E1000_READ_REG(hw, TXDCTL);
732 ctrl = (ctrl & ~E1000_TXDCTL_WTHRESH) | E1000_TXDCTL_FULL_TX_DESC_WB;
733 switch (hw->mac_type) {
740 ctrl |= E1000_TXDCTL_COUNT_DESC;
743 E1000_WRITE_REG(hw, TXDCTL, ctrl);
746 if (hw->mac_type == e1000_82573) {
747 e1000_enable_tx_pkt_filtering(hw);
750 switch (hw->mac_type) {
755 ctrl = E1000_READ_REG(hw, TXDCTL1);
756 ctrl &= ~E1000_TXDCTL_WTHRESH;
757 ctrl |= E1000_TXDCTL_COUNT_DESC | E1000_TXDCTL_FULL_TX_DESC_WB;
759 E1000_WRITE_REG(hw, TXDCTL1, ctrl);
765 if (hw->mac_type == e1000_82573) {
766 uint32_t gcr = E1000_READ_REG(hw, GCR);
767 gcr |= E1000_GCR_L1_ACT_WITHOUT_L0S_RX;
768 E1000_WRITE_REG(hw, GCR, gcr);
771 /* Clear all of the statistics registers (clear on read). It is
772 * important that we do this after we have tried to establish link
773 * because the symbol error count will increment wildly if there
776 e1000_clear_hw_cntrs(hw);
781 /******************************************************************************
782 * Adjust SERDES output amplitude based on EEPROM setting.
784 * hw - Struct containing variables accessed by shared code.
785 *****************************************************************************/
787 e1000_adjust_serdes_amplitude(struct e1000_hw *hw)
789 uint16_t eeprom_data;
792 DEBUGFUNC("e1000_adjust_serdes_amplitude");
794 if(hw->media_type != e1000_media_type_internal_serdes)
795 return E1000_SUCCESS;
797 switch(hw->mac_type) {
798 case e1000_82545_rev_3:
799 case e1000_82546_rev_3:
802 return E1000_SUCCESS;
805 ret_val = e1000_read_eeprom(hw, EEPROM_SERDES_AMPLITUDE, 1, &eeprom_data);
810 if(eeprom_data != EEPROM_RESERVED_WORD) {
811 /* Adjust SERDES output amplitude only. */
812 eeprom_data &= EEPROM_SERDES_AMPLITUDE_MASK;
813 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_EXT_CTRL, eeprom_data);
818 return E1000_SUCCESS;
821 /******************************************************************************
822 * Configures flow control and link settings.
824 * hw - Struct containing variables accessed by shared code
826 * Determines which flow control settings to use. Calls the apropriate media-
827 * specific link configuration function. Configures the flow control settings.
828 * Assuming the adapter has a valid link partner, a valid link should be
829 * established. Assumes the hardware has previously been reset and the
830 * transmitter and receiver are not enabled.
831 *****************************************************************************/
833 e1000_setup_link(struct e1000_hw *hw)
837 uint16_t eeprom_data;
839 DEBUGFUNC("e1000_setup_link");
841 /* In the case of the phy reset being blocked, we already have a link.
842 * We do not have to set it up again. */
843 if (e1000_check_phy_reset_block(hw))
844 return E1000_SUCCESS;
846 /* Read and store word 0x0F of the EEPROM. This word contains bits
847 * that determine the hardware's default PAUSE (flow control) mode,
848 * a bit that determines whether the HW defaults to enabling or
849 * disabling auto-negotiation, and the direction of the
850 * SW defined pins. If there is no SW over-ride of the flow
851 * control setting, then the variable hw->fc will
852 * be initialized based on a value in the EEPROM.
854 if (hw->fc == e1000_fc_default) {
855 switch (hw->mac_type) {
857 hw->fc = e1000_fc_full;
860 ret_val = e1000_read_eeprom(hw, EEPROM_INIT_CONTROL2_REG,
863 DEBUGOUT("EEPROM Read Error\n");
864 return -E1000_ERR_EEPROM;
866 if ((eeprom_data & EEPROM_WORD0F_PAUSE_MASK) == 0)
867 hw->fc = e1000_fc_none;
868 else if ((eeprom_data & EEPROM_WORD0F_PAUSE_MASK) ==
869 EEPROM_WORD0F_ASM_DIR)
870 hw->fc = e1000_fc_tx_pause;
872 hw->fc = e1000_fc_full;
877 /* We want to save off the original Flow Control configuration just
878 * in case we get disconnected and then reconnected into a different
879 * hub or switch with different Flow Control capabilities.
881 if(hw->mac_type == e1000_82542_rev2_0)
882 hw->fc &= (~e1000_fc_tx_pause);
884 if((hw->mac_type < e1000_82543) && (hw->report_tx_early == 1))
885 hw->fc &= (~e1000_fc_rx_pause);
887 hw->original_fc = hw->fc;
889 DEBUGOUT1("After fix-ups FlowControl is now = %x\n", hw->fc);
891 /* Take the 4 bits from EEPROM word 0x0F that determine the initial
892 * polarity value for the SW controlled pins, and setup the
893 * Extended Device Control reg with that info.
894 * This is needed because one of the SW controlled pins is used for
895 * signal detection. So this should be done before e1000_setup_pcs_link()
896 * or e1000_phy_setup() is called.
898 if(hw->mac_type == e1000_82543) {
899 ctrl_ext = ((eeprom_data & EEPROM_WORD0F_SWPDIO_EXT) <<
901 E1000_WRITE_REG(hw, CTRL_EXT, ctrl_ext);
904 /* Call the necessary subroutine to configure the link. */
905 ret_val = (hw->media_type == e1000_media_type_copper) ?
906 e1000_setup_copper_link(hw) :
907 e1000_setup_fiber_serdes_link(hw);
909 /* Initialize the flow control address, type, and PAUSE timer
910 * registers to their default values. This is done even if flow
911 * control is disabled, because it does not hurt anything to
912 * initialize these registers.
914 DEBUGOUT("Initializing the Flow Control address, type and timer regs\n");
916 E1000_WRITE_REG(hw, FCAL, FLOW_CONTROL_ADDRESS_LOW);
917 E1000_WRITE_REG(hw, FCAH, FLOW_CONTROL_ADDRESS_HIGH);
918 E1000_WRITE_REG(hw, FCT, FLOW_CONTROL_TYPE);
920 E1000_WRITE_REG(hw, FCTTV, hw->fc_pause_time);
922 /* Set the flow control receive threshold registers. Normally,
923 * these registers will be set to a default threshold that may be
924 * adjusted later by the driver's runtime code. However, if the
925 * ability to transmit pause frames in not enabled, then these
926 * registers will be set to 0.
928 if(!(hw->fc & e1000_fc_tx_pause)) {
929 E1000_WRITE_REG(hw, FCRTL, 0);
930 E1000_WRITE_REG(hw, FCRTH, 0);
932 /* We need to set up the Receive Threshold high and low water marks
933 * as well as (optionally) enabling the transmission of XON frames.
935 if(hw->fc_send_xon) {
936 E1000_WRITE_REG(hw, FCRTL, (hw->fc_low_water | E1000_FCRTL_XONE));
937 E1000_WRITE_REG(hw, FCRTH, hw->fc_high_water);
939 E1000_WRITE_REG(hw, FCRTL, hw->fc_low_water);
940 E1000_WRITE_REG(hw, FCRTH, hw->fc_high_water);
946 /******************************************************************************
947 * Sets up link for a fiber based or serdes based adapter
949 * hw - Struct containing variables accessed by shared code
951 * Manipulates Physical Coding Sublayer functions in order to configure
952 * link. Assumes the hardware has been previously reset and the transmitter
953 * and receiver are not enabled.
954 *****************************************************************************/
956 e1000_setup_fiber_serdes_link(struct e1000_hw *hw)
965 DEBUGFUNC("e1000_setup_fiber_serdes_link");
967 /* On 82571 and 82572 Fiber connections, SerDes loopback mode persists
968 * until explicitly turned off or a power cycle is performed. A read to
969 * the register does not indicate its status. Therefore, we ensure
970 * loopback mode is disabled during initialization.
972 if (hw->mac_type == e1000_82571 || hw->mac_type == e1000_82572)
973 E1000_WRITE_REG(hw, SCTL, E1000_DISABLE_SERDES_LOOPBACK);
975 /* On adapters with a MAC newer than 82544, SW Defineable pin 1 will be
976 * set when the optics detect a signal. On older adapters, it will be
977 * cleared when there is a signal. This applies to fiber media only.
978 * If we're on serdes media, adjust the output amplitude to value set in
981 ctrl = E1000_READ_REG(hw, CTRL);
982 if(hw->media_type == e1000_media_type_fiber)
983 signal = (hw->mac_type > e1000_82544) ? E1000_CTRL_SWDPIN1 : 0;
985 ret_val = e1000_adjust_serdes_amplitude(hw);
989 /* Take the link out of reset */
990 ctrl &= ~(E1000_CTRL_LRST);
992 /* Adjust VCO speed to improve BER performance */
993 ret_val = e1000_set_vco_speed(hw);
997 e1000_config_collision_dist(hw);
999 /* Check for a software override of the flow control settings, and setup
1000 * the device accordingly. If auto-negotiation is enabled, then software
1001 * will have to set the "PAUSE" bits to the correct value in the Tranmsit
1002 * Config Word Register (TXCW) and re-start auto-negotiation. However, if
1003 * auto-negotiation is disabled, then software will have to manually
1004 * configure the two flow control enable bits in the CTRL register.
1006 * The possible values of the "fc" parameter are:
1007 * 0: Flow control is completely disabled
1008 * 1: Rx flow control is enabled (we can receive pause frames, but
1009 * not send pause frames).
1010 * 2: Tx flow control is enabled (we can send pause frames but we do
1011 * not support receiving pause frames).
1012 * 3: Both Rx and TX flow control (symmetric) are enabled.
1016 /* Flow control is completely disabled by a software over-ride. */
1017 txcw = (E1000_TXCW_ANE | E1000_TXCW_FD);
1019 case e1000_fc_rx_pause:
1020 /* RX Flow control is enabled and TX Flow control is disabled by a
1021 * software over-ride. Since there really isn't a way to advertise
1022 * that we are capable of RX Pause ONLY, we will advertise that we
1023 * support both symmetric and asymmetric RX PAUSE. Later, we will
1024 * disable the adapter's ability to send PAUSE frames.
1026 txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_PAUSE_MASK);
1028 case e1000_fc_tx_pause:
1029 /* TX Flow control is enabled, and RX Flow control is disabled, by a
1030 * software over-ride.
1032 txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_ASM_DIR);
1035 /* Flow control (both RX and TX) is enabled by a software over-ride. */
1036 txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_PAUSE_MASK);
1039 DEBUGOUT("Flow control param set incorrectly\n");
1040 return -E1000_ERR_CONFIG;
1044 /* Since auto-negotiation is enabled, take the link out of reset (the link
1045 * will be in reset, because we previously reset the chip). This will
1046 * restart auto-negotiation. If auto-neogtiation is successful then the
1047 * link-up status bit will be set and the flow control enable bits (RFCE
1048 * and TFCE) will be set according to their negotiated value.
1050 DEBUGOUT("Auto-negotiation enabled\n");
1052 E1000_WRITE_REG(hw, TXCW, txcw);
1053 E1000_WRITE_REG(hw, CTRL, ctrl);
1054 E1000_WRITE_FLUSH(hw);
1059 /* If we have a signal (the cable is plugged in) then poll for a "Link-Up"
1060 * indication in the Device Status Register. Time-out if a link isn't
1061 * seen in 500 milliseconds seconds (Auto-negotiation should complete in
1062 * less than 500 milliseconds even if the other end is doing it in SW).
1063 * For internal serdes, we just assume a signal is present, then poll.
1065 if(hw->media_type == e1000_media_type_internal_serdes ||
1066 (E1000_READ_REG(hw, CTRL) & E1000_CTRL_SWDPIN1) == signal) {
1067 DEBUGOUT("Looking for Link\n");
1068 for(i = 0; i < (LINK_UP_TIMEOUT / 10); i++) {
1070 status = E1000_READ_REG(hw, STATUS);
1071 if(status & E1000_STATUS_LU) break;
1073 if(i == (LINK_UP_TIMEOUT / 10)) {
1074 DEBUGOUT("Never got a valid link from auto-neg!!!\n");
1075 hw->autoneg_failed = 1;
1076 /* AutoNeg failed to achieve a link, so we'll call
1077 * e1000_check_for_link. This routine will force the link up if
1078 * we detect a signal. This will allow us to communicate with
1079 * non-autonegotiating link partners.
1081 ret_val = e1000_check_for_link(hw);
1083 DEBUGOUT("Error while checking for link\n");
1086 hw->autoneg_failed = 0;
1088 hw->autoneg_failed = 0;
1089 DEBUGOUT("Valid Link Found\n");
1092 DEBUGOUT("No Signal Detected\n");
1094 return E1000_SUCCESS;
1097 /******************************************************************************
1098 * Make sure we have a valid PHY and change PHY mode before link setup.
1100 * hw - Struct containing variables accessed by shared code
1101 ******************************************************************************/
1103 e1000_copper_link_preconfig(struct e1000_hw *hw)
1109 DEBUGFUNC("e1000_copper_link_preconfig");
1111 ctrl = E1000_READ_REG(hw, CTRL);
1112 /* With 82543, we need to force speed and duplex on the MAC equal to what
1113 * the PHY speed and duplex configuration is. In addition, we need to
1114 * perform a hardware reset on the PHY to take it out of reset.
1116 if(hw->mac_type > e1000_82543) {
1117 ctrl |= E1000_CTRL_SLU;
1118 ctrl &= ~(E1000_CTRL_FRCSPD | E1000_CTRL_FRCDPX);
1119 E1000_WRITE_REG(hw, CTRL, ctrl);
1121 ctrl |= (E1000_CTRL_FRCSPD | E1000_CTRL_FRCDPX | E1000_CTRL_SLU);
1122 E1000_WRITE_REG(hw, CTRL, ctrl);
1123 ret_val = e1000_phy_hw_reset(hw);
1128 /* Make sure we have a valid PHY */
1129 ret_val = e1000_detect_gig_phy(hw);
1131 DEBUGOUT("Error, did not detect valid phy.\n");
1134 DEBUGOUT1("Phy ID = %x \n", hw->phy_id);
1136 /* Set PHY to class A mode (if necessary) */
1137 ret_val = e1000_set_phy_mode(hw);
1141 if((hw->mac_type == e1000_82545_rev_3) ||
1142 (hw->mac_type == e1000_82546_rev_3)) {
1143 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, &phy_data);
1144 phy_data |= 0x00000008;
1145 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, phy_data);
1148 if(hw->mac_type <= e1000_82543 ||
1149 hw->mac_type == e1000_82541 || hw->mac_type == e1000_82547 ||
1150 hw->mac_type == e1000_82541_rev_2 || hw->mac_type == e1000_82547_rev_2)
1151 hw->phy_reset_disable = FALSE;
1153 return E1000_SUCCESS;
1157 /********************************************************************
1158 * Copper link setup for e1000_phy_igp series.
1160 * hw - Struct containing variables accessed by shared code
1161 *********************************************************************/
1163 e1000_copper_link_igp_setup(struct e1000_hw *hw)
1169 DEBUGFUNC("e1000_copper_link_igp_setup");
1171 if (hw->phy_reset_disable)
1172 return E1000_SUCCESS;
1174 ret_val = e1000_phy_reset(hw);
1176 DEBUGOUT("Error Resetting the PHY\n");
1180 /* Wait 10ms for MAC to configure PHY from eeprom settings */
1183 /* Configure activity LED after PHY reset */
1184 led_ctrl = E1000_READ_REG(hw, LEDCTL);
1185 led_ctrl &= IGP_ACTIVITY_LED_MASK;
1186 led_ctrl |= (IGP_ACTIVITY_LED_ENABLE | IGP_LED3_MODE);
1187 E1000_WRITE_REG(hw, LEDCTL, led_ctrl);
1189 /* disable lplu d3 during driver init */
1190 ret_val = e1000_set_d3_lplu_state(hw, FALSE);
1192 DEBUGOUT("Error Disabling LPLU D3\n");
1196 /* disable lplu d0 during driver init */
1197 ret_val = e1000_set_d0_lplu_state(hw, FALSE);
1199 DEBUGOUT("Error Disabling LPLU D0\n");
1202 /* Configure mdi-mdix settings */
1203 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CTRL, &phy_data);
1207 if ((hw->mac_type == e1000_82541) || (hw->mac_type == e1000_82547)) {
1208 hw->dsp_config_state = e1000_dsp_config_disabled;
1209 /* Force MDI for earlier revs of the IGP PHY */
1210 phy_data &= ~(IGP01E1000_PSCR_AUTO_MDIX | IGP01E1000_PSCR_FORCE_MDI_MDIX);
1214 hw->dsp_config_state = e1000_dsp_config_enabled;
1215 phy_data &= ~IGP01E1000_PSCR_AUTO_MDIX;
1219 phy_data &= ~IGP01E1000_PSCR_FORCE_MDI_MDIX;
1222 phy_data |= IGP01E1000_PSCR_FORCE_MDI_MDIX;
1226 phy_data |= IGP01E1000_PSCR_AUTO_MDIX;
1230 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CTRL, phy_data);
1234 /* set auto-master slave resolution settings */
1236 e1000_ms_type phy_ms_setting = hw->master_slave;
1238 if(hw->ffe_config_state == e1000_ffe_config_active)
1239 hw->ffe_config_state = e1000_ffe_config_enabled;
1241 if(hw->dsp_config_state == e1000_dsp_config_activated)
1242 hw->dsp_config_state = e1000_dsp_config_enabled;
1244 /* when autonegotiation advertisment is only 1000Mbps then we
1245 * should disable SmartSpeed and enable Auto MasterSlave
1246 * resolution as hardware default. */
1247 if(hw->autoneg_advertised == ADVERTISE_1000_FULL) {
1248 /* Disable SmartSpeed */
1249 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG, &phy_data);
1252 phy_data &= ~IGP01E1000_PSCFR_SMART_SPEED;
1253 ret_val = e1000_write_phy_reg(hw,
1254 IGP01E1000_PHY_PORT_CONFIG,
1258 /* Set auto Master/Slave resolution process */
1259 ret_val = e1000_read_phy_reg(hw, PHY_1000T_CTRL, &phy_data);
1262 phy_data &= ~CR_1000T_MS_ENABLE;
1263 ret_val = e1000_write_phy_reg(hw, PHY_1000T_CTRL, phy_data);
1268 ret_val = e1000_read_phy_reg(hw, PHY_1000T_CTRL, &phy_data);
1272 /* load defaults for future use */
1273 hw->original_master_slave = (phy_data & CR_1000T_MS_ENABLE) ?
1274 ((phy_data & CR_1000T_MS_VALUE) ?
1275 e1000_ms_force_master :
1276 e1000_ms_force_slave) :
1279 switch (phy_ms_setting) {
1280 case e1000_ms_force_master:
1281 phy_data |= (CR_1000T_MS_ENABLE | CR_1000T_MS_VALUE);
1283 case e1000_ms_force_slave:
1284 phy_data |= CR_1000T_MS_ENABLE;
1285 phy_data &= ~(CR_1000T_MS_VALUE);
1288 phy_data &= ~CR_1000T_MS_ENABLE;
1292 ret_val = e1000_write_phy_reg(hw, PHY_1000T_CTRL, phy_data);
1297 return E1000_SUCCESS;
1301 /********************************************************************
1302 * Copper link setup for e1000_phy_m88 series.
1304 * hw - Struct containing variables accessed by shared code
1305 *********************************************************************/
1307 e1000_copper_link_mgp_setup(struct e1000_hw *hw)
1312 DEBUGFUNC("e1000_copper_link_mgp_setup");
1314 if(hw->phy_reset_disable)
1315 return E1000_SUCCESS;
1317 /* Enable CRS on TX. This must be set for half-duplex operation. */
1318 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, &phy_data);
1322 phy_data |= M88E1000_PSCR_ASSERT_CRS_ON_TX;
1325 * MDI/MDI-X = 0 (default)
1326 * 0 - Auto for all speeds
1329 * 3 - Auto for 1000Base-T only (MDI-X for 10/100Base-T modes)
1331 phy_data &= ~M88E1000_PSCR_AUTO_X_MODE;
1335 phy_data |= M88E1000_PSCR_MDI_MANUAL_MODE;
1338 phy_data |= M88E1000_PSCR_MDIX_MANUAL_MODE;
1341 phy_data |= M88E1000_PSCR_AUTO_X_1000T;
1345 phy_data |= M88E1000_PSCR_AUTO_X_MODE;
1350 * disable_polarity_correction = 0 (default)
1351 * Automatic Correction for Reversed Cable Polarity
1355 phy_data &= ~M88E1000_PSCR_POLARITY_REVERSAL;
1356 if(hw->disable_polarity_correction == 1)
1357 phy_data |= M88E1000_PSCR_POLARITY_REVERSAL;
1358 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, phy_data);
1362 /* Force TX_CLK in the Extended PHY Specific Control Register
1365 ret_val = e1000_read_phy_reg(hw, M88E1000_EXT_PHY_SPEC_CTRL, &phy_data);
1369 phy_data |= M88E1000_EPSCR_TX_CLK_25;
1371 if (hw->phy_revision < M88E1011_I_REV_4) {
1372 /* Configure Master and Slave downshift values */
1373 phy_data &= ~(M88E1000_EPSCR_MASTER_DOWNSHIFT_MASK |
1374 M88E1000_EPSCR_SLAVE_DOWNSHIFT_MASK);
1375 phy_data |= (M88E1000_EPSCR_MASTER_DOWNSHIFT_1X |
1376 M88E1000_EPSCR_SLAVE_DOWNSHIFT_1X);
1377 ret_val = e1000_write_phy_reg(hw, M88E1000_EXT_PHY_SPEC_CTRL, phy_data);
1382 /* SW Reset the PHY so all changes take effect */
1383 ret_val = e1000_phy_reset(hw);
1385 DEBUGOUT("Error Resetting the PHY\n");
1389 return E1000_SUCCESS;
1392 /********************************************************************
1393 * Setup auto-negotiation and flow control advertisements,
1394 * and then perform auto-negotiation.
1396 * hw - Struct containing variables accessed by shared code
1397 *********************************************************************/
1399 e1000_copper_link_autoneg(struct e1000_hw *hw)
1404 DEBUGFUNC("e1000_copper_link_autoneg");
1406 /* Perform some bounds checking on the hw->autoneg_advertised
1407 * parameter. If this variable is zero, then set it to the default.
1409 hw->autoneg_advertised &= AUTONEG_ADVERTISE_SPEED_DEFAULT;
1411 /* If autoneg_advertised is zero, we assume it was not defaulted
1412 * by the calling code so we set to advertise full capability.
1414 if(hw->autoneg_advertised == 0)
1415 hw->autoneg_advertised = AUTONEG_ADVERTISE_SPEED_DEFAULT;
1417 DEBUGOUT("Reconfiguring auto-neg advertisement params\n");
1418 ret_val = e1000_phy_setup_autoneg(hw);
1420 DEBUGOUT("Error Setting up Auto-Negotiation\n");
1423 DEBUGOUT("Restarting Auto-Neg\n");
1425 /* Restart auto-negotiation by setting the Auto Neg Enable bit and
1426 * the Auto Neg Restart bit in the PHY control register.
1428 ret_val = e1000_read_phy_reg(hw, PHY_CTRL, &phy_data);
1432 phy_data |= (MII_CR_AUTO_NEG_EN | MII_CR_RESTART_AUTO_NEG);
1433 ret_val = e1000_write_phy_reg(hw, PHY_CTRL, phy_data);
1437 /* Does the user want to wait for Auto-Neg to complete here, or
1438 * check at a later time (for example, callback routine).
1440 if(hw->wait_autoneg_complete) {
1441 ret_val = e1000_wait_autoneg(hw);
1443 DEBUGOUT("Error while waiting for autoneg to complete\n");
1448 hw->get_link_status = TRUE;
1450 return E1000_SUCCESS;
1454 /******************************************************************************
1455 * Config the MAC and the PHY after link is up.
1456 * 1) Set up the MAC to the current PHY speed/duplex
1457 * if we are on 82543. If we
1458 * are on newer silicon, we only need to configure
1459 * collision distance in the Transmit Control Register.
1460 * 2) Set up flow control on the MAC to that established with
1462 * 3) Config DSP to improve Gigabit link quality for some PHY revisions.
1464 * hw - Struct containing variables accessed by shared code
1465 ******************************************************************************/
1467 e1000_copper_link_postconfig(struct e1000_hw *hw)
1470 DEBUGFUNC("e1000_copper_link_postconfig");
1472 if(hw->mac_type >= e1000_82544) {
1473 e1000_config_collision_dist(hw);
1475 ret_val = e1000_config_mac_to_phy(hw);
1477 DEBUGOUT("Error configuring MAC to PHY settings\n");
1481 ret_val = e1000_config_fc_after_link_up(hw);
1483 DEBUGOUT("Error Configuring Flow Control\n");
1487 /* Config DSP to improve Giga link quality */
1488 if(hw->phy_type == e1000_phy_igp) {
1489 ret_val = e1000_config_dsp_after_link_change(hw, TRUE);
1491 DEBUGOUT("Error Configuring DSP after link up\n");
1496 return E1000_SUCCESS;
1499 /******************************************************************************
1500 * Detects which PHY is present and setup the speed and duplex
1502 * hw - Struct containing variables accessed by shared code
1503 ******************************************************************************/
1505 e1000_setup_copper_link(struct e1000_hw *hw)
1511 DEBUGFUNC("e1000_setup_copper_link");
1513 /* Check if it is a valid PHY and set PHY mode if necessary. */
1514 ret_val = e1000_copper_link_preconfig(hw);
1518 if (hw->phy_type == e1000_phy_igp ||
1519 hw->phy_type == e1000_phy_igp_2) {
1520 ret_val = e1000_copper_link_igp_setup(hw);
1523 } else if (hw->phy_type == e1000_phy_m88) {
1524 ret_val = e1000_copper_link_mgp_setup(hw);
1530 /* Setup autoneg and flow control advertisement
1531 * and perform autonegotiation */
1532 ret_val = e1000_copper_link_autoneg(hw);
1536 /* PHY will be set to 10H, 10F, 100H,or 100F
1537 * depending on value from forced_speed_duplex. */
1538 DEBUGOUT("Forcing speed and duplex\n");
1539 ret_val = e1000_phy_force_speed_duplex(hw);
1541 DEBUGOUT("Error Forcing Speed and Duplex\n");
1546 /* Check link status. Wait up to 100 microseconds for link to become
1549 for(i = 0; i < 10; i++) {
1550 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
1553 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
1557 if(phy_data & MII_SR_LINK_STATUS) {
1558 /* Config the MAC and PHY after link is up */
1559 ret_val = e1000_copper_link_postconfig(hw);
1563 DEBUGOUT("Valid link established!!!\n");
1564 return E1000_SUCCESS;
1569 DEBUGOUT("Unable to establish link!!!\n");
1570 return E1000_SUCCESS;
1573 /******************************************************************************
1574 * Configures PHY autoneg and flow control advertisement settings
1576 * hw - Struct containing variables accessed by shared code
1577 ******************************************************************************/
1579 e1000_phy_setup_autoneg(struct e1000_hw *hw)
1582 uint16_t mii_autoneg_adv_reg;
1583 uint16_t mii_1000t_ctrl_reg;
1585 DEBUGFUNC("e1000_phy_setup_autoneg");
1587 /* Read the MII Auto-Neg Advertisement Register (Address 4). */
1588 ret_val = e1000_read_phy_reg(hw, PHY_AUTONEG_ADV, &mii_autoneg_adv_reg);
1592 /* Read the MII 1000Base-T Control Register (Address 9). */
1593 ret_val = e1000_read_phy_reg(hw, PHY_1000T_CTRL, &mii_1000t_ctrl_reg);
1597 /* Need to parse both autoneg_advertised and fc and set up
1598 * the appropriate PHY registers. First we will parse for
1599 * autoneg_advertised software override. Since we can advertise
1600 * a plethora of combinations, we need to check each bit
1604 /* First we clear all the 10/100 mb speed bits in the Auto-Neg
1605 * Advertisement Register (Address 4) and the 1000 mb speed bits in
1606 * the 1000Base-T Control Register (Address 9).
1608 mii_autoneg_adv_reg &= ~REG4_SPEED_MASK;
1609 mii_1000t_ctrl_reg &= ~REG9_SPEED_MASK;
1611 DEBUGOUT1("autoneg_advertised %x\n", hw->autoneg_advertised);
1613 /* Do we want to advertise 10 Mb Half Duplex? */
1614 if(hw->autoneg_advertised & ADVERTISE_10_HALF) {
1615 DEBUGOUT("Advertise 10mb Half duplex\n");
1616 mii_autoneg_adv_reg |= NWAY_AR_10T_HD_CAPS;
1619 /* Do we want to advertise 10 Mb Full Duplex? */
1620 if(hw->autoneg_advertised & ADVERTISE_10_FULL) {
1621 DEBUGOUT("Advertise 10mb Full duplex\n");
1622 mii_autoneg_adv_reg |= NWAY_AR_10T_FD_CAPS;
1625 /* Do we want to advertise 100 Mb Half Duplex? */
1626 if(hw->autoneg_advertised & ADVERTISE_100_HALF) {
1627 DEBUGOUT("Advertise 100mb Half duplex\n");
1628 mii_autoneg_adv_reg |= NWAY_AR_100TX_HD_CAPS;
1631 /* Do we want to advertise 100 Mb Full Duplex? */
1632 if(hw->autoneg_advertised & ADVERTISE_100_FULL) {
1633 DEBUGOUT("Advertise 100mb Full duplex\n");
1634 mii_autoneg_adv_reg |= NWAY_AR_100TX_FD_CAPS;
1637 /* We do not allow the Phy to advertise 1000 Mb Half Duplex */
1638 if(hw->autoneg_advertised & ADVERTISE_1000_HALF) {
1639 DEBUGOUT("Advertise 1000mb Half duplex requested, request denied!\n");
1642 /* Do we want to advertise 1000 Mb Full Duplex? */
1643 if(hw->autoneg_advertised & ADVERTISE_1000_FULL) {
1644 DEBUGOUT("Advertise 1000mb Full duplex\n");
1645 mii_1000t_ctrl_reg |= CR_1000T_FD_CAPS;
1648 /* Check for a software override of the flow control settings, and
1649 * setup the PHY advertisement registers accordingly. If
1650 * auto-negotiation is enabled, then software will have to set the
1651 * "PAUSE" bits to the correct value in the Auto-Negotiation
1652 * Advertisement Register (PHY_AUTONEG_ADV) and re-start auto-negotiation.
1654 * The possible values of the "fc" parameter are:
1655 * 0: Flow control is completely disabled
1656 * 1: Rx flow control is enabled (we can receive pause frames
1657 * but not send pause frames).
1658 * 2: Tx flow control is enabled (we can send pause frames
1659 * but we do not support receiving pause frames).
1660 * 3: Both Rx and TX flow control (symmetric) are enabled.
1661 * other: No software override. The flow control configuration
1662 * in the EEPROM is used.
1665 case e1000_fc_none: /* 0 */
1666 /* Flow control (RX & TX) is completely disabled by a
1667 * software over-ride.
1669 mii_autoneg_adv_reg &= ~(NWAY_AR_ASM_DIR | NWAY_AR_PAUSE);
1671 case e1000_fc_rx_pause: /* 1 */
1672 /* RX Flow control is enabled, and TX Flow control is
1673 * disabled, by a software over-ride.
1675 /* Since there really isn't a way to advertise that we are
1676 * capable of RX Pause ONLY, we will advertise that we
1677 * support both symmetric and asymmetric RX PAUSE. Later
1678 * (in e1000_config_fc_after_link_up) we will disable the
1679 *hw's ability to send PAUSE frames.
1681 mii_autoneg_adv_reg |= (NWAY_AR_ASM_DIR | NWAY_AR_PAUSE);
1683 case e1000_fc_tx_pause: /* 2 */
1684 /* TX Flow control is enabled, and RX Flow control is
1685 * disabled, by a software over-ride.
1687 mii_autoneg_adv_reg |= NWAY_AR_ASM_DIR;
1688 mii_autoneg_adv_reg &= ~NWAY_AR_PAUSE;
1690 case e1000_fc_full: /* 3 */
1691 /* Flow control (both RX and TX) is enabled by a software
1694 mii_autoneg_adv_reg |= (NWAY_AR_ASM_DIR | NWAY_AR_PAUSE);
1697 DEBUGOUT("Flow control param set incorrectly\n");
1698 return -E1000_ERR_CONFIG;
1701 ret_val = e1000_write_phy_reg(hw, PHY_AUTONEG_ADV, mii_autoneg_adv_reg);
1705 DEBUGOUT1("Auto-Neg Advertising %x\n", mii_autoneg_adv_reg);
1707 ret_val = e1000_write_phy_reg(hw, PHY_1000T_CTRL, mii_1000t_ctrl_reg);
1711 return E1000_SUCCESS;
1714 /******************************************************************************
1715 * Force PHY speed and duplex settings to hw->forced_speed_duplex
1717 * hw - Struct containing variables accessed by shared code
1718 ******************************************************************************/
1720 e1000_phy_force_speed_duplex(struct e1000_hw *hw)
1724 uint16_t mii_ctrl_reg;
1725 uint16_t mii_status_reg;
1729 DEBUGFUNC("e1000_phy_force_speed_duplex");
1731 /* Turn off Flow control if we are forcing speed and duplex. */
1732 hw->fc = e1000_fc_none;
1734 DEBUGOUT1("hw->fc = %d\n", hw->fc);
1736 /* Read the Device Control Register. */
1737 ctrl = E1000_READ_REG(hw, CTRL);
1739 /* Set the bits to Force Speed and Duplex in the Device Ctrl Reg. */
1740 ctrl |= (E1000_CTRL_FRCSPD | E1000_CTRL_FRCDPX);
1741 ctrl &= ~(DEVICE_SPEED_MASK);
1743 /* Clear the Auto Speed Detect Enable bit. */
1744 ctrl &= ~E1000_CTRL_ASDE;
1746 /* Read the MII Control Register. */
1747 ret_val = e1000_read_phy_reg(hw, PHY_CTRL, &mii_ctrl_reg);
1751 /* We need to disable autoneg in order to force link and duplex. */
1753 mii_ctrl_reg &= ~MII_CR_AUTO_NEG_EN;
1755 /* Are we forcing Full or Half Duplex? */
1756 if(hw->forced_speed_duplex == e1000_100_full ||
1757 hw->forced_speed_duplex == e1000_10_full) {
1758 /* We want to force full duplex so we SET the full duplex bits in the
1759 * Device and MII Control Registers.
1761 ctrl |= E1000_CTRL_FD;
1762 mii_ctrl_reg |= MII_CR_FULL_DUPLEX;
1763 DEBUGOUT("Full Duplex\n");
1765 /* We want to force half duplex so we CLEAR the full duplex bits in
1766 * the Device and MII Control Registers.
1768 ctrl &= ~E1000_CTRL_FD;
1769 mii_ctrl_reg &= ~MII_CR_FULL_DUPLEX;
1770 DEBUGOUT("Half Duplex\n");
1773 /* Are we forcing 100Mbps??? */
1774 if(hw->forced_speed_duplex == e1000_100_full ||
1775 hw->forced_speed_duplex == e1000_100_half) {
1776 /* Set the 100Mb bit and turn off the 1000Mb and 10Mb bits. */
1777 ctrl |= E1000_CTRL_SPD_100;
1778 mii_ctrl_reg |= MII_CR_SPEED_100;
1779 mii_ctrl_reg &= ~(MII_CR_SPEED_1000 | MII_CR_SPEED_10);
1780 DEBUGOUT("Forcing 100mb ");
1782 /* Set the 10Mb bit and turn off the 1000Mb and 100Mb bits. */
1783 ctrl &= ~(E1000_CTRL_SPD_1000 | E1000_CTRL_SPD_100);
1784 mii_ctrl_reg |= MII_CR_SPEED_10;
1785 mii_ctrl_reg &= ~(MII_CR_SPEED_1000 | MII_CR_SPEED_100);
1786 DEBUGOUT("Forcing 10mb ");
1789 e1000_config_collision_dist(hw);
1791 /* Write the configured values back to the Device Control Reg. */
1792 E1000_WRITE_REG(hw, CTRL, ctrl);
1794 if (hw->phy_type == e1000_phy_m88) {
1795 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, &phy_data);
1799 /* Clear Auto-Crossover to force MDI manually. M88E1000 requires MDI
1800 * forced whenever speed are duplex are forced.
1802 phy_data &= ~M88E1000_PSCR_AUTO_X_MODE;
1803 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, phy_data);
1807 DEBUGOUT1("M88E1000 PSCR: %x \n", phy_data);
1809 /* Need to reset the PHY or these changes will be ignored */
1810 mii_ctrl_reg |= MII_CR_RESET;
1812 /* Clear Auto-Crossover to force MDI manually. IGP requires MDI
1813 * forced whenever speed or duplex are forced.
1815 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CTRL, &phy_data);
1819 phy_data &= ~IGP01E1000_PSCR_AUTO_MDIX;
1820 phy_data &= ~IGP01E1000_PSCR_FORCE_MDI_MDIX;
1822 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CTRL, phy_data);
1827 /* Write back the modified PHY MII control register. */
1828 ret_val = e1000_write_phy_reg(hw, PHY_CTRL, mii_ctrl_reg);
1834 /* The wait_autoneg_complete flag may be a little misleading here.
1835 * Since we are forcing speed and duplex, Auto-Neg is not enabled.
1836 * But we do want to delay for a period while forcing only so we
1837 * don't generate false No Link messages. So we will wait here
1838 * only if the user has set wait_autoneg_complete to 1, which is
1841 if(hw->wait_autoneg_complete) {
1842 /* We will wait for autoneg to complete. */
1843 DEBUGOUT("Waiting for forced speed/duplex link.\n");
1846 /* We will wait for autoneg to complete or 4.5 seconds to expire. */
1847 for(i = PHY_FORCE_TIME; i > 0; i--) {
1848 /* Read the MII Status Register and wait for Auto-Neg Complete bit
1851 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
1855 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
1859 if(mii_status_reg & MII_SR_LINK_STATUS) break;
1863 (hw->phy_type == e1000_phy_m88)) {
1864 /* We didn't get link. Reset the DSP and wait again for link. */
1865 ret_val = e1000_phy_reset_dsp(hw);
1867 DEBUGOUT("Error Resetting PHY DSP\n");
1871 /* This loop will early-out if the link condition has been met. */
1872 for(i = PHY_FORCE_TIME; i > 0; i--) {
1873 if(mii_status_reg & MII_SR_LINK_STATUS) break;
1875 /* Read the MII Status Register and wait for Auto-Neg Complete bit
1878 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
1882 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
1888 if (hw->phy_type == e1000_phy_m88) {
1889 /* Because we reset the PHY above, we need to re-force TX_CLK in the
1890 * Extended PHY Specific Control Register to 25MHz clock. This value
1891 * defaults back to a 2.5MHz clock when the PHY is reset.
1893 ret_val = e1000_read_phy_reg(hw, M88E1000_EXT_PHY_SPEC_CTRL, &phy_data);
1897 phy_data |= M88E1000_EPSCR_TX_CLK_25;
1898 ret_val = e1000_write_phy_reg(hw, M88E1000_EXT_PHY_SPEC_CTRL, phy_data);
1902 /* In addition, because of the s/w reset above, we need to enable CRS on
1903 * TX. This must be set for both full and half duplex operation.
1905 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, &phy_data);
1909 phy_data |= M88E1000_PSCR_ASSERT_CRS_ON_TX;
1910 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, phy_data);
1914 if((hw->mac_type == e1000_82544 || hw->mac_type == e1000_82543) &&
1916 (hw->forced_speed_duplex == e1000_10_full ||
1917 hw->forced_speed_duplex == e1000_10_half)) {
1918 ret_val = e1000_polarity_reversal_workaround(hw);
1923 return E1000_SUCCESS;
1926 /******************************************************************************
1927 * Sets the collision distance in the Transmit Control register
1929 * hw - Struct containing variables accessed by shared code
1931 * Link should have been established previously. Reads the speed and duplex
1932 * information from the Device Status register.
1933 ******************************************************************************/
1935 e1000_config_collision_dist(struct e1000_hw *hw)
1939 DEBUGFUNC("e1000_config_collision_dist");
1941 tctl = E1000_READ_REG(hw, TCTL);
1943 tctl &= ~E1000_TCTL_COLD;
1944 tctl |= E1000_COLLISION_DISTANCE << E1000_COLD_SHIFT;
1946 E1000_WRITE_REG(hw, TCTL, tctl);
1947 E1000_WRITE_FLUSH(hw);
1950 /******************************************************************************
1951 * Sets MAC speed and duplex settings to reflect the those in the PHY
1953 * hw - Struct containing variables accessed by shared code
1954 * mii_reg - data to write to the MII control register
1956 * The contents of the PHY register containing the needed information need to
1958 ******************************************************************************/
1960 e1000_config_mac_to_phy(struct e1000_hw *hw)
1966 DEBUGFUNC("e1000_config_mac_to_phy");
1968 /* 82544 or newer MAC, Auto Speed Detection takes care of
1969 * MAC speed/duplex configuration.*/
1970 if (hw->mac_type >= e1000_82544)
1971 return E1000_SUCCESS;
1973 /* Read the Device Control Register and set the bits to Force Speed
1976 ctrl = E1000_READ_REG(hw, CTRL);
1977 ctrl |= (E1000_CTRL_FRCSPD | E1000_CTRL_FRCDPX);
1978 ctrl &= ~(E1000_CTRL_SPD_SEL | E1000_CTRL_ILOS);
1980 /* Set up duplex in the Device Control and Transmit Control
1981 * registers depending on negotiated values.
1983 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_STATUS, &phy_data);
1987 if(phy_data & M88E1000_PSSR_DPLX)
1988 ctrl |= E1000_CTRL_FD;
1990 ctrl &= ~E1000_CTRL_FD;
1992 e1000_config_collision_dist(hw);
1994 /* Set up speed in the Device Control register depending on
1995 * negotiated values.
1997 if((phy_data & M88E1000_PSSR_SPEED) == M88E1000_PSSR_1000MBS)
1998 ctrl |= E1000_CTRL_SPD_1000;
1999 else if((phy_data & M88E1000_PSSR_SPEED) == M88E1000_PSSR_100MBS)
2000 ctrl |= E1000_CTRL_SPD_100;
2002 /* Write the configured values back to the Device Control Reg. */
2003 E1000_WRITE_REG(hw, CTRL, ctrl);
2004 return E1000_SUCCESS;
2007 /******************************************************************************
2008 * Forces the MAC's flow control settings.
2010 * hw - Struct containing variables accessed by shared code
2012 * Sets the TFCE and RFCE bits in the device control register to reflect
2013 * the adapter settings. TFCE and RFCE need to be explicitly set by
2014 * software when a Copper PHY is used because autonegotiation is managed
2015 * by the PHY rather than the MAC. Software must also configure these
2016 * bits when link is forced on a fiber connection.
2017 *****************************************************************************/
2019 e1000_force_mac_fc(struct e1000_hw *hw)
2023 DEBUGFUNC("e1000_force_mac_fc");
2025 /* Get the current configuration of the Device Control Register */
2026 ctrl = E1000_READ_REG(hw, CTRL);
2028 /* Because we didn't get link via the internal auto-negotiation
2029 * mechanism (we either forced link or we got link via PHY
2030 * auto-neg), we have to manually enable/disable transmit an
2031 * receive flow control.
2033 * The "Case" statement below enables/disable flow control
2034 * according to the "hw->fc" parameter.
2036 * The possible values of the "fc" parameter are:
2037 * 0: Flow control is completely disabled
2038 * 1: Rx flow control is enabled (we can receive pause
2039 * frames but not send pause frames).
2040 * 2: Tx flow control is enabled (we can send pause frames
2041 * frames but we do not receive pause frames).
2042 * 3: Both Rx and TX flow control (symmetric) is enabled.
2043 * other: No other values should be possible at this point.
2048 ctrl &= (~(E1000_CTRL_TFCE | E1000_CTRL_RFCE));
2050 case e1000_fc_rx_pause:
2051 ctrl &= (~E1000_CTRL_TFCE);
2052 ctrl |= E1000_CTRL_RFCE;
2054 case e1000_fc_tx_pause:
2055 ctrl &= (~E1000_CTRL_RFCE);
2056 ctrl |= E1000_CTRL_TFCE;
2059 ctrl |= (E1000_CTRL_TFCE | E1000_CTRL_RFCE);
2062 DEBUGOUT("Flow control param set incorrectly\n");
2063 return -E1000_ERR_CONFIG;
2066 /* Disable TX Flow Control for 82542 (rev 2.0) */
2067 if(hw->mac_type == e1000_82542_rev2_0)
2068 ctrl &= (~E1000_CTRL_TFCE);
2070 E1000_WRITE_REG(hw, CTRL, ctrl);
2071 return E1000_SUCCESS;
2074 /******************************************************************************
2075 * Configures flow control settings after link is established
2077 * hw - Struct containing variables accessed by shared code
2079 * Should be called immediately after a valid link has been established.
2080 * Forces MAC flow control settings if link was forced. When in MII/GMII mode
2081 * and autonegotiation is enabled, the MAC flow control settings will be set
2082 * based on the flow control negotiated by the PHY. In TBI mode, the TFCE
2083 * and RFCE bits will be automaticaly set to the negotiated flow control mode.
2084 *****************************************************************************/
2086 e1000_config_fc_after_link_up(struct e1000_hw *hw)
2089 uint16_t mii_status_reg;
2090 uint16_t mii_nway_adv_reg;
2091 uint16_t mii_nway_lp_ability_reg;
2095 DEBUGFUNC("e1000_config_fc_after_link_up");
2097 /* Check for the case where we have fiber media and auto-neg failed
2098 * so we had to force link. In this case, we need to force the
2099 * configuration of the MAC to match the "fc" parameter.
2101 if(((hw->media_type == e1000_media_type_fiber) && (hw->autoneg_failed)) ||
2102 ((hw->media_type == e1000_media_type_internal_serdes) && (hw->autoneg_failed)) ||
2103 ((hw->media_type == e1000_media_type_copper) && (!hw->autoneg))) {
2104 ret_val = e1000_force_mac_fc(hw);
2106 DEBUGOUT("Error forcing flow control settings\n");
2111 /* Check for the case where we have copper media and auto-neg is
2112 * enabled. In this case, we need to check and see if Auto-Neg
2113 * has completed, and if so, how the PHY and link partner has
2114 * flow control configured.
2116 if((hw->media_type == e1000_media_type_copper) && hw->autoneg) {
2117 /* Read the MII Status Register and check to see if AutoNeg
2118 * has completed. We read this twice because this reg has
2119 * some "sticky" (latched) bits.
2121 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
2124 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
2128 if(mii_status_reg & MII_SR_AUTONEG_COMPLETE) {
2129 /* The AutoNeg process has completed, so we now need to
2130 * read both the Auto Negotiation Advertisement Register
2131 * (Address 4) and the Auto_Negotiation Base Page Ability
2132 * Register (Address 5) to determine how flow control was
2135 ret_val = e1000_read_phy_reg(hw, PHY_AUTONEG_ADV,
2139 ret_val = e1000_read_phy_reg(hw, PHY_LP_ABILITY,
2140 &mii_nway_lp_ability_reg);
2144 /* Two bits in the Auto Negotiation Advertisement Register
2145 * (Address 4) and two bits in the Auto Negotiation Base
2146 * Page Ability Register (Address 5) determine flow control
2147 * for both the PHY and the link partner. The following
2148 * table, taken out of the IEEE 802.3ab/D6.0 dated March 25,
2149 * 1999, describes these PAUSE resolution bits and how flow
2150 * control is determined based upon these settings.
2151 * NOTE: DC = Don't Care
2153 * LOCAL DEVICE | LINK PARTNER
2154 * PAUSE | ASM_DIR | PAUSE | ASM_DIR | NIC Resolution
2155 *-------|---------|-------|---------|--------------------
2156 * 0 | 0 | DC | DC | e1000_fc_none
2157 * 0 | 1 | 0 | DC | e1000_fc_none
2158 * 0 | 1 | 1 | 0 | e1000_fc_none
2159 * 0 | 1 | 1 | 1 | e1000_fc_tx_pause
2160 * 1 | 0 | 0 | DC | e1000_fc_none
2161 * 1 | DC | 1 | DC | e1000_fc_full
2162 * 1 | 1 | 0 | 0 | e1000_fc_none
2163 * 1 | 1 | 0 | 1 | e1000_fc_rx_pause
2166 /* Are both PAUSE bits set to 1? If so, this implies
2167 * Symmetric Flow Control is enabled at both ends. The
2168 * ASM_DIR bits are irrelevant per the spec.
2170 * For Symmetric Flow Control:
2172 * LOCAL DEVICE | LINK PARTNER
2173 * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
2174 *-------|---------|-------|---------|--------------------
2175 * 1 | DC | 1 | DC | e1000_fc_full
2178 if((mii_nway_adv_reg & NWAY_AR_PAUSE) &&
2179 (mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE)) {
2180 /* Now we need to check if the user selected RX ONLY
2181 * of pause frames. In this case, we had to advertise
2182 * FULL flow control because we could not advertise RX
2183 * ONLY. Hence, we must now check to see if we need to
2184 * turn OFF the TRANSMISSION of PAUSE frames.
2186 if(hw->original_fc == e1000_fc_full) {
2187 hw->fc = e1000_fc_full;
2188 DEBUGOUT("Flow Control = FULL.\r\n");
2190 hw->fc = e1000_fc_rx_pause;
2191 DEBUGOUT("Flow Control = RX PAUSE frames only.\r\n");
2194 /* For receiving PAUSE frames ONLY.
2196 * LOCAL DEVICE | LINK PARTNER
2197 * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
2198 *-------|---------|-------|---------|--------------------
2199 * 0 | 1 | 1 | 1 | e1000_fc_tx_pause
2202 else if(!(mii_nway_adv_reg & NWAY_AR_PAUSE) &&
2203 (mii_nway_adv_reg & NWAY_AR_ASM_DIR) &&
2204 (mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE) &&
2205 (mii_nway_lp_ability_reg & NWAY_LPAR_ASM_DIR)) {
2206 hw->fc = e1000_fc_tx_pause;
2207 DEBUGOUT("Flow Control = TX PAUSE frames only.\r\n");
2209 /* For transmitting PAUSE frames ONLY.
2211 * LOCAL DEVICE | LINK PARTNER
2212 * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
2213 *-------|---------|-------|---------|--------------------
2214 * 1 | 1 | 0 | 1 | e1000_fc_rx_pause
2217 else if((mii_nway_adv_reg & NWAY_AR_PAUSE) &&
2218 (mii_nway_adv_reg & NWAY_AR_ASM_DIR) &&
2219 !(mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE) &&
2220 (mii_nway_lp_ability_reg & NWAY_LPAR_ASM_DIR)) {
2221 hw->fc = e1000_fc_rx_pause;
2222 DEBUGOUT("Flow Control = RX PAUSE frames only.\r\n");
2224 /* Per the IEEE spec, at this point flow control should be
2225 * disabled. However, we want to consider that we could
2226 * be connected to a legacy switch that doesn't advertise
2227 * desired flow control, but can be forced on the link
2228 * partner. So if we advertised no flow control, that is
2229 * what we will resolve to. If we advertised some kind of
2230 * receive capability (Rx Pause Only or Full Flow Control)
2231 * and the link partner advertised none, we will configure
2232 * ourselves to enable Rx Flow Control only. We can do
2233 * this safely for two reasons: If the link partner really
2234 * didn't want flow control enabled, and we enable Rx, no
2235 * harm done since we won't be receiving any PAUSE frames
2236 * anyway. If the intent on the link partner was to have
2237 * flow control enabled, then by us enabling RX only, we
2238 * can at least receive pause frames and process them.
2239 * This is a good idea because in most cases, since we are
2240 * predominantly a server NIC, more times than not we will
2241 * be asked to delay transmission of packets than asking
2242 * our link partner to pause transmission of frames.
2244 else if((hw->original_fc == e1000_fc_none ||
2245 hw->original_fc == e1000_fc_tx_pause) ||
2246 hw->fc_strict_ieee) {
2247 hw->fc = e1000_fc_none;
2248 DEBUGOUT("Flow Control = NONE.\r\n");
2250 hw->fc = e1000_fc_rx_pause;
2251 DEBUGOUT("Flow Control = RX PAUSE frames only.\r\n");
2254 /* Now we need to do one last check... If we auto-
2255 * negotiated to HALF DUPLEX, flow control should not be
2256 * enabled per IEEE 802.3 spec.
2258 ret_val = e1000_get_speed_and_duplex(hw, &speed, &duplex);
2260 DEBUGOUT("Error getting link speed and duplex\n");
2264 if(duplex == HALF_DUPLEX)
2265 hw->fc = e1000_fc_none;
2267 /* Now we call a subroutine to actually force the MAC
2268 * controller to use the correct flow control settings.
2270 ret_val = e1000_force_mac_fc(hw);
2272 DEBUGOUT("Error forcing flow control settings\n");
2276 DEBUGOUT("Copper PHY and Auto Neg has not completed.\r\n");
2279 return E1000_SUCCESS;
2282 /******************************************************************************
2283 * Checks to see if the link status of the hardware has changed.
2285 * hw - Struct containing variables accessed by shared code
2287 * Called by any function that needs to check the link status of the adapter.
2288 *****************************************************************************/
2290 e1000_check_for_link(struct e1000_hw *hw)
2297 uint32_t signal = 0;
2301 DEBUGFUNC("e1000_check_for_link");
2303 ctrl = E1000_READ_REG(hw, CTRL);
2304 status = E1000_READ_REG(hw, STATUS);
2306 /* On adapters with a MAC newer than 82544, SW Defineable pin 1 will be
2307 * set when the optics detect a signal. On older adapters, it will be
2308 * cleared when there is a signal. This applies to fiber media only.
2310 if((hw->media_type == e1000_media_type_fiber) ||
2311 (hw->media_type == e1000_media_type_internal_serdes)) {
2312 rxcw = E1000_READ_REG(hw, RXCW);
2314 if(hw->media_type == e1000_media_type_fiber) {
2315 signal = (hw->mac_type > e1000_82544) ? E1000_CTRL_SWDPIN1 : 0;
2316 if(status & E1000_STATUS_LU)
2317 hw->get_link_status = FALSE;
2321 /* If we have a copper PHY then we only want to go out to the PHY
2322 * registers to see if Auto-Neg has completed and/or if our link
2323 * status has changed. The get_link_status flag will be set if we
2324 * receive a Link Status Change interrupt or we have Rx Sequence
2327 if((hw->media_type == e1000_media_type_copper) && hw->get_link_status) {
2328 /* First we want to see if the MII Status Register reports
2329 * link. If so, then we want to get the current speed/duplex
2331 * Read the register twice since the link bit is sticky.
2333 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
2336 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
2340 if(phy_data & MII_SR_LINK_STATUS) {
2341 hw->get_link_status = FALSE;
2342 /* Check if there was DownShift, must be checked immediately after
2344 e1000_check_downshift(hw);
2346 /* If we are on 82544 or 82543 silicon and speed/duplex
2347 * are forced to 10H or 10F, then we will implement the polarity
2348 * reversal workaround. We disable interrupts first, and upon
2349 * returning, place the devices interrupt state to its previous
2350 * value except for the link status change interrupt which will
2351 * happen due to the execution of this workaround.
2354 if((hw->mac_type == e1000_82544 || hw->mac_type == e1000_82543) &&
2356 (hw->forced_speed_duplex == e1000_10_full ||
2357 hw->forced_speed_duplex == e1000_10_half)) {
2358 E1000_WRITE_REG(hw, IMC, 0xffffffff);
2359 ret_val = e1000_polarity_reversal_workaround(hw);
2360 icr = E1000_READ_REG(hw, ICR);
2361 E1000_WRITE_REG(hw, ICS, (icr & ~E1000_ICS_LSC));
2362 E1000_WRITE_REG(hw, IMS, IMS_ENABLE_MASK);
2366 /* No link detected */
2367 e1000_config_dsp_after_link_change(hw, FALSE);
2371 /* If we are forcing speed/duplex, then we simply return since
2372 * we have already determined whether we have link or not.
2374 if(!hw->autoneg) return -E1000_ERR_CONFIG;
2376 /* optimize the dsp settings for the igp phy */
2377 e1000_config_dsp_after_link_change(hw, TRUE);
2379 /* We have a M88E1000 PHY and Auto-Neg is enabled. If we
2380 * have Si on board that is 82544 or newer, Auto
2381 * Speed Detection takes care of MAC speed/duplex
2382 * configuration. So we only need to configure Collision
2383 * Distance in the MAC. Otherwise, we need to force
2384 * speed/duplex on the MAC to the current PHY speed/duplex
2387 if(hw->mac_type >= e1000_82544)
2388 e1000_config_collision_dist(hw);
2390 ret_val = e1000_config_mac_to_phy(hw);
2392 DEBUGOUT("Error configuring MAC to PHY settings\n");
2397 /* Configure Flow Control now that Auto-Neg has completed. First, we
2398 * need to restore the desired flow control settings because we may
2399 * have had to re-autoneg with a different link partner.
2401 ret_val = e1000_config_fc_after_link_up(hw);
2403 DEBUGOUT("Error configuring flow control\n");
2407 /* At this point we know that we are on copper and we have
2408 * auto-negotiated link. These are conditions for checking the link
2409 * partner capability register. We use the link speed to determine if
2410 * TBI compatibility needs to be turned on or off. If the link is not
2411 * at gigabit speed, then TBI compatibility is not needed. If we are
2412 * at gigabit speed, we turn on TBI compatibility.
2414 if(hw->tbi_compatibility_en) {
2415 uint16_t speed, duplex;
2416 e1000_get_speed_and_duplex(hw, &speed, &duplex);
2417 if(speed != SPEED_1000) {
2418 /* If link speed is not set to gigabit speed, we do not need
2419 * to enable TBI compatibility.
2421 if(hw->tbi_compatibility_on) {
2422 /* If we previously were in the mode, turn it off. */
2423 rctl = E1000_READ_REG(hw, RCTL);
2424 rctl &= ~E1000_RCTL_SBP;
2425 E1000_WRITE_REG(hw, RCTL, rctl);
2426 hw->tbi_compatibility_on = FALSE;
2429 /* If TBI compatibility is was previously off, turn it on. For
2430 * compatibility with a TBI link partner, we will store bad
2431 * packets. Some frames have an additional byte on the end and
2432 * will look like CRC errors to to the hardware.
2434 if(!hw->tbi_compatibility_on) {
2435 hw->tbi_compatibility_on = TRUE;
2436 rctl = E1000_READ_REG(hw, RCTL);
2437 rctl |= E1000_RCTL_SBP;
2438 E1000_WRITE_REG(hw, RCTL, rctl);
2443 /* If we don't have link (auto-negotiation failed or link partner cannot
2444 * auto-negotiate), the cable is plugged in (we have signal), and our
2445 * link partner is not trying to auto-negotiate with us (we are receiving
2446 * idles or data), we need to force link up. We also need to give
2447 * auto-negotiation time to complete, in case the cable was just plugged
2448 * in. The autoneg_failed flag does this.
2450 else if((((hw->media_type == e1000_media_type_fiber) &&
2451 ((ctrl & E1000_CTRL_SWDPIN1) == signal)) ||
2452 (hw->media_type == e1000_media_type_internal_serdes)) &&
2453 (!(status & E1000_STATUS_LU)) &&
2454 (!(rxcw & E1000_RXCW_C))) {
2455 if(hw->autoneg_failed == 0) {
2456 hw->autoneg_failed = 1;
2459 DEBUGOUT("NOT RXing /C/, disable AutoNeg and force link.\r\n");
2461 /* Disable auto-negotiation in the TXCW register */
2462 E1000_WRITE_REG(hw, TXCW, (hw->txcw & ~E1000_TXCW_ANE));
2464 /* Force link-up and also force full-duplex. */
2465 ctrl = E1000_READ_REG(hw, CTRL);
2466 ctrl |= (E1000_CTRL_SLU | E1000_CTRL_FD);
2467 E1000_WRITE_REG(hw, CTRL, ctrl);
2469 /* Configure Flow Control after forcing link up. */
2470 ret_val = e1000_config_fc_after_link_up(hw);
2472 DEBUGOUT("Error configuring flow control\n");
2476 /* If we are forcing link and we are receiving /C/ ordered sets, re-enable
2477 * auto-negotiation in the TXCW register and disable forced link in the
2478 * Device Control register in an attempt to auto-negotiate with our link
2481 else if(((hw->media_type == e1000_media_type_fiber) ||
2482 (hw->media_type == e1000_media_type_internal_serdes)) &&
2483 (ctrl & E1000_CTRL_SLU) && (rxcw & E1000_RXCW_C)) {
2484 DEBUGOUT("RXing /C/, enable AutoNeg and stop forcing link.\r\n");
2485 E1000_WRITE_REG(hw, TXCW, hw->txcw);
2486 E1000_WRITE_REG(hw, CTRL, (ctrl & ~E1000_CTRL_SLU));
2488 hw->serdes_link_down = FALSE;
2490 /* If we force link for non-auto-negotiation switch, check link status
2491 * based on MAC synchronization for internal serdes media type.
2493 else if((hw->media_type == e1000_media_type_internal_serdes) &&
2494 !(E1000_TXCW_ANE & E1000_READ_REG(hw, TXCW))) {
2495 /* SYNCH bit and IV bit are sticky. */
2497 if(E1000_RXCW_SYNCH & E1000_READ_REG(hw, RXCW)) {
2498 if(!(rxcw & E1000_RXCW_IV)) {
2499 hw->serdes_link_down = FALSE;
2500 DEBUGOUT("SERDES: Link is up.\n");
2503 hw->serdes_link_down = TRUE;
2504 DEBUGOUT("SERDES: Link is down.\n");
2507 if((hw->media_type == e1000_media_type_internal_serdes) &&
2508 (E1000_TXCW_ANE & E1000_READ_REG(hw, TXCW))) {
2509 hw->serdes_link_down = !(E1000_STATUS_LU & E1000_READ_REG(hw, STATUS));
2511 return E1000_SUCCESS;
2514 /******************************************************************************
2515 * Detects the current speed and duplex settings of the hardware.
2517 * hw - Struct containing variables accessed by shared code
2518 * speed - Speed of the connection
2519 * duplex - Duplex setting of the connection
2520 *****************************************************************************/
2522 e1000_get_speed_and_duplex(struct e1000_hw *hw,
2530 DEBUGFUNC("e1000_get_speed_and_duplex");
2532 if(hw->mac_type >= e1000_82543) {
2533 status = E1000_READ_REG(hw, STATUS);
2534 if(status & E1000_STATUS_SPEED_1000) {
2535 *speed = SPEED_1000;
2536 DEBUGOUT("1000 Mbs, ");
2537 } else if(status & E1000_STATUS_SPEED_100) {
2539 DEBUGOUT("100 Mbs, ");
2542 DEBUGOUT("10 Mbs, ");
2545 if(status & E1000_STATUS_FD) {
2546 *duplex = FULL_DUPLEX;
2547 DEBUGOUT("Full Duplex\r\n");
2549 *duplex = HALF_DUPLEX;
2550 DEBUGOUT(" Half Duplex\r\n");
2553 DEBUGOUT("1000 Mbs, Full Duplex\r\n");
2554 *speed = SPEED_1000;
2555 *duplex = FULL_DUPLEX;
2558 /* IGP01 PHY may advertise full duplex operation after speed downgrade even
2559 * if it is operating at half duplex. Here we set the duplex settings to
2560 * match the duplex in the link partner's capabilities.
2562 if(hw->phy_type == e1000_phy_igp && hw->speed_downgraded) {
2563 ret_val = e1000_read_phy_reg(hw, PHY_AUTONEG_EXP, &phy_data);
2567 if(!(phy_data & NWAY_ER_LP_NWAY_CAPS))
2568 *duplex = HALF_DUPLEX;
2570 ret_val = e1000_read_phy_reg(hw, PHY_LP_ABILITY, &phy_data);
2573 if((*speed == SPEED_100 && !(phy_data & NWAY_LPAR_100TX_FD_CAPS)) ||
2574 (*speed == SPEED_10 && !(phy_data & NWAY_LPAR_10T_FD_CAPS)))
2575 *duplex = HALF_DUPLEX;
2579 return E1000_SUCCESS;
2582 /******************************************************************************
2583 * Blocks until autoneg completes or times out (~4.5 seconds)
2585 * hw - Struct containing variables accessed by shared code
2586 ******************************************************************************/
2588 e1000_wait_autoneg(struct e1000_hw *hw)
2594 DEBUGFUNC("e1000_wait_autoneg");
2595 DEBUGOUT("Waiting for Auto-Neg to complete.\n");
2597 /* We will wait for autoneg to complete or 4.5 seconds to expire. */
2598 for(i = PHY_AUTO_NEG_TIME; i > 0; i--) {
2599 /* Read the MII Status Register and wait for Auto-Neg
2600 * Complete bit to be set.
2602 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
2605 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
2608 if(phy_data & MII_SR_AUTONEG_COMPLETE) {
2609 return E1000_SUCCESS;
2613 return E1000_SUCCESS;
2616 /******************************************************************************
2617 * Raises the Management Data Clock
2619 * hw - Struct containing variables accessed by shared code
2620 * ctrl - Device control register's current value
2621 ******************************************************************************/
2623 e1000_raise_mdi_clk(struct e1000_hw *hw,
2626 /* Raise the clock input to the Management Data Clock (by setting the MDC
2627 * bit), and then delay 10 microseconds.
2629 E1000_WRITE_REG(hw, CTRL, (*ctrl | E1000_CTRL_MDC));
2630 E1000_WRITE_FLUSH(hw);
2634 /******************************************************************************
2635 * Lowers the Management Data Clock
2637 * hw - Struct containing variables accessed by shared code
2638 * ctrl - Device control register's current value
2639 ******************************************************************************/
2641 e1000_lower_mdi_clk(struct e1000_hw *hw,
2644 /* Lower the clock input to the Management Data Clock (by clearing the MDC
2645 * bit), and then delay 10 microseconds.
2647 E1000_WRITE_REG(hw, CTRL, (*ctrl & ~E1000_CTRL_MDC));
2648 E1000_WRITE_FLUSH(hw);
2652 /******************************************************************************
2653 * Shifts data bits out to the PHY
2655 * hw - Struct containing variables accessed by shared code
2656 * data - Data to send out to the PHY
2657 * count - Number of bits to shift out
2659 * Bits are shifted out in MSB to LSB order.
2660 ******************************************************************************/
2662 e1000_shift_out_mdi_bits(struct e1000_hw *hw,
2669 /* We need to shift "count" number of bits out to the PHY. So, the value
2670 * in the "data" parameter will be shifted out to the PHY one bit at a
2671 * time. In order to do this, "data" must be broken down into bits.
2674 mask <<= (count - 1);
2676 ctrl = E1000_READ_REG(hw, CTRL);
2678 /* Set MDIO_DIR and MDC_DIR direction bits to be used as output pins. */
2679 ctrl |= (E1000_CTRL_MDIO_DIR | E1000_CTRL_MDC_DIR);
2682 /* A "1" is shifted out to the PHY by setting the MDIO bit to "1" and
2683 * then raising and lowering the Management Data Clock. A "0" is
2684 * shifted out to the PHY by setting the MDIO bit to "0" and then
2685 * raising and lowering the clock.
2687 if(data & mask) ctrl |= E1000_CTRL_MDIO;
2688 else ctrl &= ~E1000_CTRL_MDIO;
2690 E1000_WRITE_REG(hw, CTRL, ctrl);
2691 E1000_WRITE_FLUSH(hw);
2695 e1000_raise_mdi_clk(hw, &ctrl);
2696 e1000_lower_mdi_clk(hw, &ctrl);
2702 /******************************************************************************
2703 * Shifts data bits in from the PHY
2705 * hw - Struct containing variables accessed by shared code
2707 * Bits are shifted in in MSB to LSB order.
2708 ******************************************************************************/
2710 e1000_shift_in_mdi_bits(struct e1000_hw *hw)
2716 /* In order to read a register from the PHY, we need to shift in a total
2717 * of 18 bits from the PHY. The first two bit (turnaround) times are used
2718 * to avoid contention on the MDIO pin when a read operation is performed.
2719 * These two bits are ignored by us and thrown away. Bits are "shifted in"
2720 * by raising the input to the Management Data Clock (setting the MDC bit),
2721 * and then reading the value of the MDIO bit.
2723 ctrl = E1000_READ_REG(hw, CTRL);
2725 /* Clear MDIO_DIR (SWDPIO1) to indicate this bit is to be used as input. */
2726 ctrl &= ~E1000_CTRL_MDIO_DIR;
2727 ctrl &= ~E1000_CTRL_MDIO;
2729 E1000_WRITE_REG(hw, CTRL, ctrl);
2730 E1000_WRITE_FLUSH(hw);
2732 /* Raise and Lower the clock before reading in the data. This accounts for
2733 * the turnaround bits. The first clock occurred when we clocked out the
2734 * last bit of the Register Address.
2736 e1000_raise_mdi_clk(hw, &ctrl);
2737 e1000_lower_mdi_clk(hw, &ctrl);
2739 for(data = 0, i = 0; i < 16; i++) {
2741 e1000_raise_mdi_clk(hw, &ctrl);
2742 ctrl = E1000_READ_REG(hw, CTRL);
2743 /* Check to see if we shifted in a "1". */
2744 if(ctrl & E1000_CTRL_MDIO) data |= 1;
2745 e1000_lower_mdi_clk(hw, &ctrl);
2748 e1000_raise_mdi_clk(hw, &ctrl);
2749 e1000_lower_mdi_clk(hw, &ctrl);
2754 /*****************************************************************************
2755 * Reads the value from a PHY register, if the value is on a specific non zero
2756 * page, sets the page first.
2757 * hw - Struct containing variables accessed by shared code
2758 * reg_addr - address of the PHY register to read
2759 ******************************************************************************/
2761 e1000_read_phy_reg(struct e1000_hw *hw,
2767 DEBUGFUNC("e1000_read_phy_reg");
2769 if((hw->phy_type == e1000_phy_igp ||
2770 hw->phy_type == e1000_phy_igp_2) &&
2771 (reg_addr > MAX_PHY_MULTI_PAGE_REG)) {
2772 ret_val = e1000_write_phy_reg_ex(hw, IGP01E1000_PHY_PAGE_SELECT,
2773 (uint16_t)reg_addr);
2779 ret_val = e1000_read_phy_reg_ex(hw, MAX_PHY_REG_ADDRESS & reg_addr,
2786 e1000_read_phy_reg_ex(struct e1000_hw *hw,
2792 const uint32_t phy_addr = 1;
2794 DEBUGFUNC("e1000_read_phy_reg_ex");
2796 if(reg_addr > MAX_PHY_REG_ADDRESS) {
2797 DEBUGOUT1("PHY Address %d is out of range\n", reg_addr);
2798 return -E1000_ERR_PARAM;
2801 if(hw->mac_type > e1000_82543) {
2802 /* Set up Op-code, Phy Address, and register address in the MDI
2803 * Control register. The MAC will take care of interfacing with the
2804 * PHY to retrieve the desired data.
2806 mdic = ((reg_addr << E1000_MDIC_REG_SHIFT) |
2807 (phy_addr << E1000_MDIC_PHY_SHIFT) |
2808 (E1000_MDIC_OP_READ));
2810 E1000_WRITE_REG(hw, MDIC, mdic);
2812 /* Poll the ready bit to see if the MDI read completed */
2813 for(i = 0; i < 64; i++) {
2815 mdic = E1000_READ_REG(hw, MDIC);
2816 if(mdic & E1000_MDIC_READY) break;
2818 if(!(mdic & E1000_MDIC_READY)) {
2819 DEBUGOUT("MDI Read did not complete\n");
2820 return -E1000_ERR_PHY;
2822 if(mdic & E1000_MDIC_ERROR) {
2823 DEBUGOUT("MDI Error\n");
2824 return -E1000_ERR_PHY;
2826 *phy_data = (uint16_t) mdic;
2828 /* We must first send a preamble through the MDIO pin to signal the
2829 * beginning of an MII instruction. This is done by sending 32
2830 * consecutive "1" bits.
2832 e1000_shift_out_mdi_bits(hw, PHY_PREAMBLE, PHY_PREAMBLE_SIZE);
2834 /* Now combine the next few fields that are required for a read
2835 * operation. We use this method instead of calling the
2836 * e1000_shift_out_mdi_bits routine five different times. The format of
2837 * a MII read instruction consists of a shift out of 14 bits and is
2838 * defined as follows:
2839 * <Preamble><SOF><Op Code><Phy Addr><Reg Addr>
2840 * followed by a shift in of 18 bits. This first two bits shifted in
2841 * are TurnAround bits used to avoid contention on the MDIO pin when a
2842 * READ operation is performed. These two bits are thrown away
2843 * followed by a shift in of 16 bits which contains the desired data.
2845 mdic = ((reg_addr) | (phy_addr << 5) |
2846 (PHY_OP_READ << 10) | (PHY_SOF << 12));
2848 e1000_shift_out_mdi_bits(hw, mdic, 14);
2850 /* Now that we've shifted out the read command to the MII, we need to
2851 * "shift in" the 16-bit value (18 total bits) of the requested PHY
2854 *phy_data = e1000_shift_in_mdi_bits(hw);
2856 return E1000_SUCCESS;
2859 /******************************************************************************
2860 * Writes a value to a PHY register
2862 * hw - Struct containing variables accessed by shared code
2863 * reg_addr - address of the PHY register to write
2864 * data - data to write to the PHY
2865 ******************************************************************************/
2867 e1000_write_phy_reg(struct e1000_hw *hw,
2873 DEBUGFUNC("e1000_write_phy_reg");
2875 if((hw->phy_type == e1000_phy_igp ||
2876 hw->phy_type == e1000_phy_igp_2) &&
2877 (reg_addr > MAX_PHY_MULTI_PAGE_REG)) {
2878 ret_val = e1000_write_phy_reg_ex(hw, IGP01E1000_PHY_PAGE_SELECT,
2879 (uint16_t)reg_addr);
2885 ret_val = e1000_write_phy_reg_ex(hw, MAX_PHY_REG_ADDRESS & reg_addr,
2892 e1000_write_phy_reg_ex(struct e1000_hw *hw,
2898 const uint32_t phy_addr = 1;
2900 DEBUGFUNC("e1000_write_phy_reg_ex");
2902 if(reg_addr > MAX_PHY_REG_ADDRESS) {
2903 DEBUGOUT1("PHY Address %d is out of range\n", reg_addr);
2904 return -E1000_ERR_PARAM;
2907 if(hw->mac_type > e1000_82543) {
2908 /* Set up Op-code, Phy Address, register address, and data intended
2909 * for the PHY register in the MDI Control register. The MAC will take
2910 * care of interfacing with the PHY to send the desired data.
2912 mdic = (((uint32_t) phy_data) |
2913 (reg_addr << E1000_MDIC_REG_SHIFT) |
2914 (phy_addr << E1000_MDIC_PHY_SHIFT) |
2915 (E1000_MDIC_OP_WRITE));
2917 E1000_WRITE_REG(hw, MDIC, mdic);
2919 /* Poll the ready bit to see if the MDI read completed */
2920 for(i = 0; i < 640; i++) {
2922 mdic = E1000_READ_REG(hw, MDIC);
2923 if(mdic & E1000_MDIC_READY) break;
2925 if(!(mdic & E1000_MDIC_READY)) {
2926 DEBUGOUT("MDI Write did not complete\n");
2927 return -E1000_ERR_PHY;
2930 /* We'll need to use the SW defined pins to shift the write command
2931 * out to the PHY. We first send a preamble to the PHY to signal the
2932 * beginning of the MII instruction. This is done by sending 32
2933 * consecutive "1" bits.
2935 e1000_shift_out_mdi_bits(hw, PHY_PREAMBLE, PHY_PREAMBLE_SIZE);
2937 /* Now combine the remaining required fields that will indicate a
2938 * write operation. We use this method instead of calling the
2939 * e1000_shift_out_mdi_bits routine for each field in the command. The
2940 * format of a MII write instruction is as follows:
2941 * <Preamble><SOF><Op Code><Phy Addr><Reg Addr><Turnaround><Data>.
2943 mdic = ((PHY_TURNAROUND) | (reg_addr << 2) | (phy_addr << 7) |
2944 (PHY_OP_WRITE << 12) | (PHY_SOF << 14));
2946 mdic |= (uint32_t) phy_data;
2948 e1000_shift_out_mdi_bits(hw, mdic, 32);
2951 return E1000_SUCCESS;
2955 /******************************************************************************
2956 * Returns the PHY to the power-on reset state
2958 * hw - Struct containing variables accessed by shared code
2959 ******************************************************************************/
2961 e1000_phy_hw_reset(struct e1000_hw *hw)
2963 uint32_t ctrl, ctrl_ext;
2967 DEBUGFUNC("e1000_phy_hw_reset");
2969 /* In the case of the phy reset being blocked, it's not an error, we
2970 * simply return success without performing the reset. */
2971 ret_val = e1000_check_phy_reset_block(hw);
2973 return E1000_SUCCESS;
2975 DEBUGOUT("Resetting Phy...\n");
2977 if(hw->mac_type > e1000_82543) {
2978 /* Read the device control register and assert the E1000_CTRL_PHY_RST
2979 * bit. Then, take it out of reset.
2980 * For pre-e1000_82571 hardware, we delay for 10ms between the assert
2981 * and deassert. For e1000_82571 hardware and later, we instead delay
2982 * for 10ms after the deassertion.
2984 ctrl = E1000_READ_REG(hw, CTRL);
2985 E1000_WRITE_REG(hw, CTRL, ctrl | E1000_CTRL_PHY_RST);
2986 E1000_WRITE_FLUSH(hw);
2988 if (hw->mac_type < e1000_82571)
2993 E1000_WRITE_REG(hw, CTRL, ctrl);
2994 E1000_WRITE_FLUSH(hw);
2996 if (hw->mac_type >= e1000_82571)
2999 /* Read the Extended Device Control Register, assert the PHY_RESET_DIR
3000 * bit to put the PHY into reset. Then, take it out of reset.
3002 ctrl_ext = E1000_READ_REG(hw, CTRL_EXT);
3003 ctrl_ext |= E1000_CTRL_EXT_SDP4_DIR;
3004 ctrl_ext &= ~E1000_CTRL_EXT_SDP4_DATA;
3005 E1000_WRITE_REG(hw, CTRL_EXT, ctrl_ext);
3006 E1000_WRITE_FLUSH(hw);
3008 ctrl_ext |= E1000_CTRL_EXT_SDP4_DATA;
3009 E1000_WRITE_REG(hw, CTRL_EXT, ctrl_ext);
3010 E1000_WRITE_FLUSH(hw);
3014 if((hw->mac_type == e1000_82541) || (hw->mac_type == e1000_82547)) {
3015 /* Configure activity LED after PHY reset */
3016 led_ctrl = E1000_READ_REG(hw, LEDCTL);
3017 led_ctrl &= IGP_ACTIVITY_LED_MASK;
3018 led_ctrl |= (IGP_ACTIVITY_LED_ENABLE | IGP_LED3_MODE);
3019 E1000_WRITE_REG(hw, LEDCTL, led_ctrl);
3022 /* Wait for FW to finish PHY configuration. */
3023 ret_val = e1000_get_phy_cfg_done(hw);
3028 /******************************************************************************
3031 * hw - Struct containing variables accessed by shared code
3033 * Sets bit 15 of the MII Control regiser
3034 ******************************************************************************/
3036 e1000_phy_reset(struct e1000_hw *hw)
3041 DEBUGFUNC("e1000_phy_reset");
3043 /* In the case of the phy reset being blocked, it's not an error, we
3044 * simply return success without performing the reset. */
3045 ret_val = e1000_check_phy_reset_block(hw);
3047 return E1000_SUCCESS;
3049 switch (hw->mac_type) {
3050 case e1000_82541_rev_2:
3053 ret_val = e1000_phy_hw_reset(hw);
3058 ret_val = e1000_read_phy_reg(hw, PHY_CTRL, &phy_data);
3062 phy_data |= MII_CR_RESET;
3063 ret_val = e1000_write_phy_reg(hw, PHY_CTRL, phy_data);
3071 if(hw->phy_type == e1000_phy_igp || hw->phy_type == e1000_phy_igp_2)
3072 e1000_phy_init_script(hw);
3074 return E1000_SUCCESS;
3077 /******************************************************************************
3078 * Probes the expected PHY address for known PHY IDs
3080 * hw - Struct containing variables accessed by shared code
3081 ******************************************************************************/
3083 e1000_detect_gig_phy(struct e1000_hw *hw)
3085 int32_t phy_init_status, ret_val;
3086 uint16_t phy_id_high, phy_id_low;
3087 boolean_t match = FALSE;
3089 DEBUGFUNC("e1000_detect_gig_phy");
3091 /* The 82571 firmware may still be configuring the PHY. In this
3092 * case, we cannot access the PHY until the configuration is done. So
3093 * we explicitly set the PHY values. */
3094 if(hw->mac_type == e1000_82571 ||
3095 hw->mac_type == e1000_82572) {
3096 hw->phy_id = IGP01E1000_I_PHY_ID;
3097 hw->phy_type = e1000_phy_igp_2;
3098 return E1000_SUCCESS;
3101 /* Read the PHY ID Registers to identify which PHY is onboard. */
3102 ret_val = e1000_read_phy_reg(hw, PHY_ID1, &phy_id_high);
3106 hw->phy_id = (uint32_t) (phy_id_high << 16);
3108 ret_val = e1000_read_phy_reg(hw, PHY_ID2, &phy_id_low);
3112 hw->phy_id |= (uint32_t) (phy_id_low & PHY_REVISION_MASK);
3113 hw->phy_revision = (uint32_t) phy_id_low & ~PHY_REVISION_MASK;
3115 switch(hw->mac_type) {
3117 if(hw->phy_id == M88E1000_E_PHY_ID) match = TRUE;
3120 if(hw->phy_id == M88E1000_I_PHY_ID) match = TRUE;
3124 case e1000_82545_rev_3:
3126 case e1000_82546_rev_3:
3127 if(hw->phy_id == M88E1011_I_PHY_ID) match = TRUE;
3130 case e1000_82541_rev_2:
3132 case e1000_82547_rev_2:
3133 if(hw->phy_id == IGP01E1000_I_PHY_ID) match = TRUE;
3136 if(hw->phy_id == M88E1111_I_PHY_ID) match = TRUE;
3139 DEBUGOUT1("Invalid MAC type %d\n", hw->mac_type);
3140 return -E1000_ERR_CONFIG;
3142 phy_init_status = e1000_set_phy_type(hw);
3144 if ((match) && (phy_init_status == E1000_SUCCESS)) {
3145 DEBUGOUT1("PHY ID 0x%X detected\n", hw->phy_id);
3146 return E1000_SUCCESS;
3148 DEBUGOUT1("Invalid PHY ID 0x%X\n", hw->phy_id);
3149 return -E1000_ERR_PHY;
3152 /******************************************************************************
3153 * Resets the PHY's DSP
3155 * hw - Struct containing variables accessed by shared code
3156 ******************************************************************************/
3158 e1000_phy_reset_dsp(struct e1000_hw *hw)
3161 DEBUGFUNC("e1000_phy_reset_dsp");
3164 ret_val = e1000_write_phy_reg(hw, 29, 0x001d);
3166 ret_val = e1000_write_phy_reg(hw, 30, 0x00c1);
3168 ret_val = e1000_write_phy_reg(hw, 30, 0x0000);
3170 ret_val = E1000_SUCCESS;
3176 /******************************************************************************
3177 * Get PHY information from various PHY registers for igp PHY only.
3179 * hw - Struct containing variables accessed by shared code
3180 * phy_info - PHY information structure
3181 ******************************************************************************/
3183 e1000_phy_igp_get_info(struct e1000_hw *hw,
3184 struct e1000_phy_info *phy_info)
3187 uint16_t phy_data, polarity, min_length, max_length, average;
3189 DEBUGFUNC("e1000_phy_igp_get_info");
3191 /* The downshift status is checked only once, after link is established,
3192 * and it stored in the hw->speed_downgraded parameter. */
3193 phy_info->downshift = (e1000_downshift)hw->speed_downgraded;
3195 /* IGP01E1000 does not need to support it. */
3196 phy_info->extended_10bt_distance = e1000_10bt_ext_dist_enable_normal;
3198 /* IGP01E1000 always correct polarity reversal */
3199 phy_info->polarity_correction = e1000_polarity_reversal_enabled;
3201 /* Check polarity status */
3202 ret_val = e1000_check_polarity(hw, &polarity);
3206 phy_info->cable_polarity = polarity;
3208 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_STATUS, &phy_data);
3212 phy_info->mdix_mode = (phy_data & IGP01E1000_PSSR_MDIX) >>
3213 IGP01E1000_PSSR_MDIX_SHIFT;
3215 if((phy_data & IGP01E1000_PSSR_SPEED_MASK) ==
3216 IGP01E1000_PSSR_SPEED_1000MBPS) {
3217 /* Local/Remote Receiver Information are only valid at 1000 Mbps */
3218 ret_val = e1000_read_phy_reg(hw, PHY_1000T_STATUS, &phy_data);
3222 phy_info->local_rx = (phy_data & SR_1000T_LOCAL_RX_STATUS) >>
3223 SR_1000T_LOCAL_RX_STATUS_SHIFT;
3224 phy_info->remote_rx = (phy_data & SR_1000T_REMOTE_RX_STATUS) >>
3225 SR_1000T_REMOTE_RX_STATUS_SHIFT;
3227 /* Get cable length */
3228 ret_val = e1000_get_cable_length(hw, &min_length, &max_length);
3232 /* Translate to old method */
3233 average = (max_length + min_length) / 2;
3235 if(average <= e1000_igp_cable_length_50)
3236 phy_info->cable_length = e1000_cable_length_50;
3237 else if(average <= e1000_igp_cable_length_80)
3238 phy_info->cable_length = e1000_cable_length_50_80;
3239 else if(average <= e1000_igp_cable_length_110)
3240 phy_info->cable_length = e1000_cable_length_80_110;
3241 else if(average <= e1000_igp_cable_length_140)
3242 phy_info->cable_length = e1000_cable_length_110_140;
3244 phy_info->cable_length = e1000_cable_length_140;
3247 return E1000_SUCCESS;
3250 /******************************************************************************
3251 * Get PHY information from various PHY registers fot m88 PHY only.
3253 * hw - Struct containing variables accessed by shared code
3254 * phy_info - PHY information structure
3255 ******************************************************************************/
3257 e1000_phy_m88_get_info(struct e1000_hw *hw,
3258 struct e1000_phy_info *phy_info)
3261 uint16_t phy_data, polarity;
3263 DEBUGFUNC("e1000_phy_m88_get_info");
3265 /* The downshift status is checked only once, after link is established,
3266 * and it stored in the hw->speed_downgraded parameter. */
3267 phy_info->downshift = (e1000_downshift)hw->speed_downgraded;
3269 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_CTRL, &phy_data);
3273 phy_info->extended_10bt_distance =
3274 (phy_data & M88E1000_PSCR_10BT_EXT_DIST_ENABLE) >>
3275 M88E1000_PSCR_10BT_EXT_DIST_ENABLE_SHIFT;
3276 phy_info->polarity_correction =
3277 (phy_data & M88E1000_PSCR_POLARITY_REVERSAL) >>
3278 M88E1000_PSCR_POLARITY_REVERSAL_SHIFT;
3280 /* Check polarity status */
3281 ret_val = e1000_check_polarity(hw, &polarity);
3284 phy_info->cable_polarity = polarity;
3286 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_STATUS, &phy_data);
3290 phy_info->mdix_mode = (phy_data & M88E1000_PSSR_MDIX) >>
3291 M88E1000_PSSR_MDIX_SHIFT;
3293 if ((phy_data & M88E1000_PSSR_SPEED) == M88E1000_PSSR_1000MBS) {
3294 /* Cable Length Estimation and Local/Remote Receiver Information
3295 * are only valid at 1000 Mbps.
3297 phy_info->cable_length = ((phy_data & M88E1000_PSSR_CABLE_LENGTH) >>
3298 M88E1000_PSSR_CABLE_LENGTH_SHIFT);
3300 ret_val = e1000_read_phy_reg(hw, PHY_1000T_STATUS, &phy_data);
3304 phy_info->local_rx = (phy_data & SR_1000T_LOCAL_RX_STATUS) >>
3305 SR_1000T_LOCAL_RX_STATUS_SHIFT;
3307 phy_info->remote_rx = (phy_data & SR_1000T_REMOTE_RX_STATUS) >>
3308 SR_1000T_REMOTE_RX_STATUS_SHIFT;
3311 return E1000_SUCCESS;
3314 /******************************************************************************
3315 * Get PHY information from various PHY registers
3317 * hw - Struct containing variables accessed by shared code
3318 * phy_info - PHY information structure
3319 ******************************************************************************/
3321 e1000_phy_get_info(struct e1000_hw *hw,
3322 struct e1000_phy_info *phy_info)
3327 DEBUGFUNC("e1000_phy_get_info");
3329 phy_info->cable_length = e1000_cable_length_undefined;
3330 phy_info->extended_10bt_distance = e1000_10bt_ext_dist_enable_undefined;
3331 phy_info->cable_polarity = e1000_rev_polarity_undefined;
3332 phy_info->downshift = e1000_downshift_undefined;
3333 phy_info->polarity_correction = e1000_polarity_reversal_undefined;
3334 phy_info->mdix_mode = e1000_auto_x_mode_undefined;
3335 phy_info->local_rx = e1000_1000t_rx_status_undefined;
3336 phy_info->remote_rx = e1000_1000t_rx_status_undefined;
3338 if(hw->media_type != e1000_media_type_copper) {
3339 DEBUGOUT("PHY info is only valid for copper media\n");
3340 return -E1000_ERR_CONFIG;
3343 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
3347 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &phy_data);
3351 if((phy_data & MII_SR_LINK_STATUS) != MII_SR_LINK_STATUS) {
3352 DEBUGOUT("PHY info is only valid if link is up\n");
3353 return -E1000_ERR_CONFIG;
3356 if(hw->phy_type == e1000_phy_igp ||
3357 hw->phy_type == e1000_phy_igp_2)
3358 return e1000_phy_igp_get_info(hw, phy_info);
3360 return e1000_phy_m88_get_info(hw, phy_info);
3364 e1000_validate_mdi_setting(struct e1000_hw *hw)
3366 DEBUGFUNC("e1000_validate_mdi_settings");
3368 if(!hw->autoneg && (hw->mdix == 0 || hw->mdix == 3)) {
3369 DEBUGOUT("Invalid MDI setting detected\n");
3371 return -E1000_ERR_CONFIG;
3373 return E1000_SUCCESS;
3377 /******************************************************************************
3378 * Sets up eeprom variables in the hw struct. Must be called after mac_type
3381 * hw - Struct containing variables accessed by shared code
3382 *****************************************************************************/
3384 e1000_init_eeprom_params(struct e1000_hw *hw)
3386 struct e1000_eeprom_info *eeprom = &hw->eeprom;
3387 uint32_t eecd = E1000_READ_REG(hw, EECD);
3388 int32_t ret_val = E1000_SUCCESS;
3389 uint16_t eeprom_size;
3391 DEBUGFUNC("e1000_init_eeprom_params");
3393 switch (hw->mac_type) {
3394 case e1000_82542_rev2_0:
3395 case e1000_82542_rev2_1:
3398 eeprom->type = e1000_eeprom_microwire;
3399 eeprom->word_size = 64;
3400 eeprom->opcode_bits = 3;
3401 eeprom->address_bits = 6;
3402 eeprom->delay_usec = 50;
3403 eeprom->use_eerd = FALSE;
3404 eeprom->use_eewr = FALSE;
3408 case e1000_82545_rev_3:
3410 case e1000_82546_rev_3:
3411 eeprom->type = e1000_eeprom_microwire;
3412 eeprom->opcode_bits = 3;
3413 eeprom->delay_usec = 50;
3414 if(eecd & E1000_EECD_SIZE) {
3415 eeprom->word_size = 256;
3416 eeprom->address_bits = 8;
3418 eeprom->word_size = 64;
3419 eeprom->address_bits = 6;
3421 eeprom->use_eerd = FALSE;
3422 eeprom->use_eewr = FALSE;
3425 case e1000_82541_rev_2:
3427 case e1000_82547_rev_2:
3428 if (eecd & E1000_EECD_TYPE) {
3429 eeprom->type = e1000_eeprom_spi;
3430 eeprom->opcode_bits = 8;
3431 eeprom->delay_usec = 1;
3432 if (eecd & E1000_EECD_ADDR_BITS) {
3433 eeprom->page_size = 32;
3434 eeprom->address_bits = 16;
3436 eeprom->page_size = 8;
3437 eeprom->address_bits = 8;
3440 eeprom->type = e1000_eeprom_microwire;
3441 eeprom->opcode_bits = 3;
3442 eeprom->delay_usec = 50;
3443 if (eecd & E1000_EECD_ADDR_BITS) {
3444 eeprom->word_size = 256;
3445 eeprom->address_bits = 8;
3447 eeprom->word_size = 64;
3448 eeprom->address_bits = 6;
3451 eeprom->use_eerd = FALSE;
3452 eeprom->use_eewr = FALSE;
3456 eeprom->type = e1000_eeprom_spi;
3457 eeprom->opcode_bits = 8;
3458 eeprom->delay_usec = 1;
3459 if (eecd & E1000_EECD_ADDR_BITS) {
3460 eeprom->page_size = 32;
3461 eeprom->address_bits = 16;
3463 eeprom->page_size = 8;
3464 eeprom->address_bits = 8;
3466 eeprom->use_eerd = FALSE;
3467 eeprom->use_eewr = FALSE;
3470 eeprom->type = e1000_eeprom_spi;
3471 eeprom->opcode_bits = 8;
3472 eeprom->delay_usec = 1;
3473 if (eecd & E1000_EECD_ADDR_BITS) {
3474 eeprom->page_size = 32;
3475 eeprom->address_bits = 16;
3477 eeprom->page_size = 8;
3478 eeprom->address_bits = 8;
3480 eeprom->use_eerd = TRUE;
3481 eeprom->use_eewr = TRUE;
3482 if(e1000_is_onboard_nvm_eeprom(hw) == FALSE) {
3483 eeprom->type = e1000_eeprom_flash;
3484 eeprom->word_size = 2048;
3486 /* Ensure that the Autonomous FLASH update bit is cleared due to
3487 * Flash update issue on parts which use a FLASH for NVM. */
3488 eecd &= ~E1000_EECD_AUPDEN;
3489 E1000_WRITE_REG(hw, EECD, eecd);
3496 if (eeprom->type == e1000_eeprom_spi) {
3497 /* eeprom_size will be an enum [0..8] that maps to eeprom sizes 128B to
3498 * 32KB (incremented by powers of 2).
3500 if(hw->mac_type <= e1000_82547_rev_2) {
3501 /* Set to default value for initial eeprom read. */
3502 eeprom->word_size = 64;
3503 ret_val = e1000_read_eeprom(hw, EEPROM_CFG, 1, &eeprom_size);
3506 eeprom_size = (eeprom_size & EEPROM_SIZE_MASK) >> EEPROM_SIZE_SHIFT;
3507 /* 256B eeprom size was not supported in earlier hardware, so we
3508 * bump eeprom_size up one to ensure that "1" (which maps to 256B)
3509 * is never the result used in the shifting logic below. */
3513 eeprom_size = (uint16_t)((eecd & E1000_EECD_SIZE_EX_MASK) >>
3514 E1000_EECD_SIZE_EX_SHIFT);
3517 eeprom->word_size = 1 << (eeprom_size + EEPROM_WORD_SIZE_SHIFT);
3522 /******************************************************************************
3523 * Raises the EEPROM's clock input.
3525 * hw - Struct containing variables accessed by shared code
3526 * eecd - EECD's current value
3527 *****************************************************************************/
3529 e1000_raise_ee_clk(struct e1000_hw *hw,
3532 /* Raise the clock input to the EEPROM (by setting the SK bit), and then
3533 * wait <delay> microseconds.
3535 *eecd = *eecd | E1000_EECD_SK;
3536 E1000_WRITE_REG(hw, EECD, *eecd);
3537 E1000_WRITE_FLUSH(hw);
3538 udelay(hw->eeprom.delay_usec);
3541 /******************************************************************************
3542 * Lowers the EEPROM's clock input.
3544 * hw - Struct containing variables accessed by shared code
3545 * eecd - EECD's current value
3546 *****************************************************************************/
3548 e1000_lower_ee_clk(struct e1000_hw *hw,
3551 /* Lower the clock input to the EEPROM (by clearing the SK bit), and then
3552 * wait 50 microseconds.
3554 *eecd = *eecd & ~E1000_EECD_SK;
3555 E1000_WRITE_REG(hw, EECD, *eecd);
3556 E1000_WRITE_FLUSH(hw);
3557 udelay(hw->eeprom.delay_usec);
3560 /******************************************************************************
3561 * Shift data bits out to the EEPROM.
3563 * hw - Struct containing variables accessed by shared code
3564 * data - data to send to the EEPROM
3565 * count - number of bits to shift out
3566 *****************************************************************************/
3568 e1000_shift_out_ee_bits(struct e1000_hw *hw,
3572 struct e1000_eeprom_info *eeprom = &hw->eeprom;
3576 /* We need to shift "count" bits out to the EEPROM. So, value in the
3577 * "data" parameter will be shifted out to the EEPROM one bit at a time.
3578 * In order to do this, "data" must be broken down into bits.
3580 mask = 0x01 << (count - 1);
3581 eecd = E1000_READ_REG(hw, EECD);
3582 if (eeprom->type == e1000_eeprom_microwire) {
3583 eecd &= ~E1000_EECD_DO;
3584 } else if (eeprom->type == e1000_eeprom_spi) {
3585 eecd |= E1000_EECD_DO;
3588 /* A "1" is shifted out to the EEPROM by setting bit "DI" to a "1",
3589 * and then raising and then lowering the clock (the SK bit controls
3590 * the clock input to the EEPROM). A "0" is shifted out to the EEPROM
3591 * by setting "DI" to "0" and then raising and then lowering the clock.
3593 eecd &= ~E1000_EECD_DI;
3596 eecd |= E1000_EECD_DI;
3598 E1000_WRITE_REG(hw, EECD, eecd);
3599 E1000_WRITE_FLUSH(hw);
3601 udelay(eeprom->delay_usec);
3603 e1000_raise_ee_clk(hw, &eecd);
3604 e1000_lower_ee_clk(hw, &eecd);
3610 /* We leave the "DI" bit set to "0" when we leave this routine. */
3611 eecd &= ~E1000_EECD_DI;
3612 E1000_WRITE_REG(hw, EECD, eecd);
3615 /******************************************************************************
3616 * Shift data bits in from the EEPROM
3618 * hw - Struct containing variables accessed by shared code
3619 *****************************************************************************/
3621 e1000_shift_in_ee_bits(struct e1000_hw *hw,
3628 /* In order to read a register from the EEPROM, we need to shift 'count'
3629 * bits in from the EEPROM. Bits are "shifted in" by raising the clock
3630 * input to the EEPROM (setting the SK bit), and then reading the value of
3631 * the "DO" bit. During this "shifting in" process the "DI" bit should
3635 eecd = E1000_READ_REG(hw, EECD);
3637 eecd &= ~(E1000_EECD_DO | E1000_EECD_DI);
3640 for(i = 0; i < count; i++) {
3642 e1000_raise_ee_clk(hw, &eecd);
3644 eecd = E1000_READ_REG(hw, EECD);
3646 eecd &= ~(E1000_EECD_DI);
3647 if(eecd & E1000_EECD_DO)
3650 e1000_lower_ee_clk(hw, &eecd);
3656 /******************************************************************************
3657 * Prepares EEPROM for access
3659 * hw - Struct containing variables accessed by shared code
3661 * Lowers EEPROM clock. Clears input pin. Sets the chip select pin. This
3662 * function should be called before issuing a command to the EEPROM.
3663 *****************************************************************************/
3665 e1000_acquire_eeprom(struct e1000_hw *hw)
3667 struct e1000_eeprom_info *eeprom = &hw->eeprom;
3670 DEBUGFUNC("e1000_acquire_eeprom");
3672 if(e1000_get_hw_eeprom_semaphore(hw))
3673 return -E1000_ERR_EEPROM;
3675 eecd = E1000_READ_REG(hw, EECD);
3677 if (hw->mac_type != e1000_82573) {
3678 /* Request EEPROM Access */
3679 if(hw->mac_type > e1000_82544) {
3680 eecd |= E1000_EECD_REQ;
3681 E1000_WRITE_REG(hw, EECD, eecd);
3682 eecd = E1000_READ_REG(hw, EECD);
3683 while((!(eecd & E1000_EECD_GNT)) &&
3684 (i < E1000_EEPROM_GRANT_ATTEMPTS)) {
3687 eecd = E1000_READ_REG(hw, EECD);
3689 if(!(eecd & E1000_EECD_GNT)) {
3690 eecd &= ~E1000_EECD_REQ;
3691 E1000_WRITE_REG(hw, EECD, eecd);
3692 DEBUGOUT("Could not acquire EEPROM grant\n");
3693 e1000_put_hw_eeprom_semaphore(hw);
3694 return -E1000_ERR_EEPROM;
3699 /* Setup EEPROM for Read/Write */
3701 if (eeprom->type == e1000_eeprom_microwire) {
3702 /* Clear SK and DI */
3703 eecd &= ~(E1000_EECD_DI | E1000_EECD_SK);
3704 E1000_WRITE_REG(hw, EECD, eecd);
3707 eecd |= E1000_EECD_CS;
3708 E1000_WRITE_REG(hw, EECD, eecd);
3709 } else if (eeprom->type == e1000_eeprom_spi) {
3710 /* Clear SK and CS */
3711 eecd &= ~(E1000_EECD_CS | E1000_EECD_SK);
3712 E1000_WRITE_REG(hw, EECD, eecd);
3716 return E1000_SUCCESS;
3719 /******************************************************************************
3720 * Returns EEPROM to a "standby" state
3722 * hw - Struct containing variables accessed by shared code
3723 *****************************************************************************/
3725 e1000_standby_eeprom(struct e1000_hw *hw)
3727 struct e1000_eeprom_info *eeprom = &hw->eeprom;
3730 eecd = E1000_READ_REG(hw, EECD);
3732 if(eeprom->type == e1000_eeprom_microwire) {
3733 eecd &= ~(E1000_EECD_CS | E1000_EECD_SK);
3734 E1000_WRITE_REG(hw, EECD, eecd);
3735 E1000_WRITE_FLUSH(hw);
3736 udelay(eeprom->delay_usec);
3739 eecd |= E1000_EECD_SK;
3740 E1000_WRITE_REG(hw, EECD, eecd);
3741 E1000_WRITE_FLUSH(hw);
3742 udelay(eeprom->delay_usec);
3745 eecd |= E1000_EECD_CS;
3746 E1000_WRITE_REG(hw, EECD, eecd);
3747 E1000_WRITE_FLUSH(hw);
3748 udelay(eeprom->delay_usec);
3751 eecd &= ~E1000_EECD_SK;
3752 E1000_WRITE_REG(hw, EECD, eecd);
3753 E1000_WRITE_FLUSH(hw);
3754 udelay(eeprom->delay_usec);
3755 } else if(eeprom->type == e1000_eeprom_spi) {
3756 /* Toggle CS to flush commands */
3757 eecd |= E1000_EECD_CS;
3758 E1000_WRITE_REG(hw, EECD, eecd);
3759 E1000_WRITE_FLUSH(hw);
3760 udelay(eeprom->delay_usec);
3761 eecd &= ~E1000_EECD_CS;
3762 E1000_WRITE_REG(hw, EECD, eecd);
3763 E1000_WRITE_FLUSH(hw);
3764 udelay(eeprom->delay_usec);
3768 /******************************************************************************
3769 * Terminates a command by inverting the EEPROM's chip select pin
3771 * hw - Struct containing variables accessed by shared code
3772 *****************************************************************************/
3774 e1000_release_eeprom(struct e1000_hw *hw)
3778 DEBUGFUNC("e1000_release_eeprom");
3780 eecd = E1000_READ_REG(hw, EECD);
3782 if (hw->eeprom.type == e1000_eeprom_spi) {
3783 eecd |= E1000_EECD_CS; /* Pull CS high */
3784 eecd &= ~E1000_EECD_SK; /* Lower SCK */
3786 E1000_WRITE_REG(hw, EECD, eecd);
3788 udelay(hw->eeprom.delay_usec);
3789 } else if(hw->eeprom.type == e1000_eeprom_microwire) {
3790 /* cleanup eeprom */
3792 /* CS on Microwire is active-high */
3793 eecd &= ~(E1000_EECD_CS | E1000_EECD_DI);
3795 E1000_WRITE_REG(hw, EECD, eecd);
3797 /* Rising edge of clock */
3798 eecd |= E1000_EECD_SK;
3799 E1000_WRITE_REG(hw, EECD, eecd);
3800 E1000_WRITE_FLUSH(hw);
3801 udelay(hw->eeprom.delay_usec);
3803 /* Falling edge of clock */
3804 eecd &= ~E1000_EECD_SK;
3805 E1000_WRITE_REG(hw, EECD, eecd);
3806 E1000_WRITE_FLUSH(hw);
3807 udelay(hw->eeprom.delay_usec);
3810 /* Stop requesting EEPROM access */
3811 if(hw->mac_type > e1000_82544) {
3812 eecd &= ~E1000_EECD_REQ;
3813 E1000_WRITE_REG(hw, EECD, eecd);
3816 e1000_put_hw_eeprom_semaphore(hw);
3819 /******************************************************************************
3820 * Reads a 16 bit word from the EEPROM.
3822 * hw - Struct containing variables accessed by shared code
3823 *****************************************************************************/
3825 e1000_spi_eeprom_ready(struct e1000_hw *hw)
3827 uint16_t retry_count = 0;
3828 uint8_t spi_stat_reg;
3830 DEBUGFUNC("e1000_spi_eeprom_ready");
3832 /* Read "Status Register" repeatedly until the LSB is cleared. The
3833 * EEPROM will signal that the command has been completed by clearing
3834 * bit 0 of the internal status register. If it's not cleared within
3835 * 5 milliseconds, then error out.
3839 e1000_shift_out_ee_bits(hw, EEPROM_RDSR_OPCODE_SPI,
3840 hw->eeprom.opcode_bits);
3841 spi_stat_reg = (uint8_t)e1000_shift_in_ee_bits(hw, 8);
3842 if (!(spi_stat_reg & EEPROM_STATUS_RDY_SPI))
3848 e1000_standby_eeprom(hw);
3849 } while(retry_count < EEPROM_MAX_RETRY_SPI);
3851 /* ATMEL SPI write time could vary from 0-20mSec on 3.3V devices (and
3852 * only 0-5mSec on 5V devices)
3854 if(retry_count >= EEPROM_MAX_RETRY_SPI) {
3855 DEBUGOUT("SPI EEPROM Status error\n");
3856 return -E1000_ERR_EEPROM;
3859 return E1000_SUCCESS;
3862 /******************************************************************************
3863 * Reads a 16 bit word from the EEPROM.
3865 * hw - Struct containing variables accessed by shared code
3866 * offset - offset of word in the EEPROM to read
3867 * data - word read from the EEPROM
3868 * words - number of words to read
3869 *****************************************************************************/
3871 e1000_read_eeprom(struct e1000_hw *hw,
3876 struct e1000_eeprom_info *eeprom = &hw->eeprom;
3880 DEBUGFUNC("e1000_read_eeprom");
3882 /* A check for invalid values: offset too large, too many words, and not
3885 if((offset >= eeprom->word_size) || (words > eeprom->word_size - offset) ||
3887 DEBUGOUT("\"words\" parameter out of bounds\n");
3888 return -E1000_ERR_EEPROM;
3891 /* FLASH reads without acquiring the semaphore are safe */
3892 if (e1000_is_onboard_nvm_eeprom(hw) == TRUE &&
3893 hw->eeprom.use_eerd == FALSE) {
3894 switch (hw->mac_type) {
3896 /* Prepare the EEPROM for reading */
3897 if (e1000_acquire_eeprom(hw) != E1000_SUCCESS)
3898 return -E1000_ERR_EEPROM;
3903 if(eeprom->use_eerd == TRUE) {
3904 ret_val = e1000_read_eeprom_eerd(hw, offset, words, data);
3905 if ((e1000_is_onboard_nvm_eeprom(hw) == TRUE) ||
3906 (hw->mac_type != e1000_82573))
3907 e1000_release_eeprom(hw);
3911 if(eeprom->type == e1000_eeprom_spi) {
3913 uint8_t read_opcode = EEPROM_READ_OPCODE_SPI;
3915 if(e1000_spi_eeprom_ready(hw)) {
3916 e1000_release_eeprom(hw);
3917 return -E1000_ERR_EEPROM;
3920 e1000_standby_eeprom(hw);
3922 /* Some SPI eeproms use the 8th address bit embedded in the opcode */
3923 if((eeprom->address_bits == 8) && (offset >= 128))
3924 read_opcode |= EEPROM_A8_OPCODE_SPI;
3926 /* Send the READ command (opcode + addr) */
3927 e1000_shift_out_ee_bits(hw, read_opcode, eeprom->opcode_bits);
3928 e1000_shift_out_ee_bits(hw, (uint16_t)(offset*2), eeprom->address_bits);
3930 /* Read the data. The address of the eeprom internally increments with
3931 * each byte (spi) being read, saving on the overhead of eeprom setup
3932 * and tear-down. The address counter will roll over if reading beyond
3933 * the size of the eeprom, thus allowing the entire memory to be read
3934 * starting from any offset. */
3935 for (i = 0; i < words; i++) {
3936 word_in = e1000_shift_in_ee_bits(hw, 16);
3937 data[i] = (word_in >> 8) | (word_in << 8);
3939 } else if(eeprom->type == e1000_eeprom_microwire) {
3940 for (i = 0; i < words; i++) {
3941 /* Send the READ command (opcode + addr) */
3942 e1000_shift_out_ee_bits(hw, EEPROM_READ_OPCODE_MICROWIRE,
3943 eeprom->opcode_bits);
3944 e1000_shift_out_ee_bits(hw, (uint16_t)(offset + i),
3945 eeprom->address_bits);
3947 /* Read the data. For microwire, each word requires the overhead
3948 * of eeprom setup and tear-down. */
3949 data[i] = e1000_shift_in_ee_bits(hw, 16);
3950 e1000_standby_eeprom(hw);
3954 /* End this read operation */
3955 e1000_release_eeprom(hw);
3957 return E1000_SUCCESS;
3960 /******************************************************************************
3961 * Reads a 16 bit word from the EEPROM using the EERD register.
3963 * hw - Struct containing variables accessed by shared code
3964 * offset - offset of word in the EEPROM to read
3965 * data - word read from the EEPROM
3966 * words - number of words to read
3967 *****************************************************************************/
3969 e1000_read_eeprom_eerd(struct e1000_hw *hw,
3974 uint32_t i, eerd = 0;
3977 for (i = 0; i < words; i++) {
3978 eerd = ((offset+i) << E1000_EEPROM_RW_ADDR_SHIFT) +
3979 E1000_EEPROM_RW_REG_START;
3981 E1000_WRITE_REG(hw, EERD, eerd);
3982 error = e1000_poll_eerd_eewr_done(hw, E1000_EEPROM_POLL_READ);
3987 data[i] = (E1000_READ_REG(hw, EERD) >> E1000_EEPROM_RW_REG_DATA);
3994 /******************************************************************************
3995 * Writes a 16 bit word from the EEPROM using the EEWR register.
3997 * hw - Struct containing variables accessed by shared code
3998 * offset - offset of word in the EEPROM to read
3999 * data - word read from the EEPROM
4000 * words - number of words to read
4001 *****************************************************************************/
4003 e1000_write_eeprom_eewr(struct e1000_hw *hw,
4008 uint32_t register_value = 0;
4012 for (i = 0; i < words; i++) {
4013 register_value = (data[i] << E1000_EEPROM_RW_REG_DATA) |
4014 ((offset+i) << E1000_EEPROM_RW_ADDR_SHIFT) |
4015 E1000_EEPROM_RW_REG_START;
4017 error = e1000_poll_eerd_eewr_done(hw, E1000_EEPROM_POLL_WRITE);
4022 E1000_WRITE_REG(hw, EEWR, register_value);
4024 error = e1000_poll_eerd_eewr_done(hw, E1000_EEPROM_POLL_WRITE);
4034 /******************************************************************************
4035 * Polls the status bit (bit 1) of the EERD to determine when the read is done.
4037 * hw - Struct containing variables accessed by shared code
4038 *****************************************************************************/
4040 e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int eerd)
4042 uint32_t attempts = 100000;
4043 uint32_t i, reg = 0;
4044 int32_t done = E1000_ERR_EEPROM;
4046 for(i = 0; i < attempts; i++) {
4047 if(eerd == E1000_EEPROM_POLL_READ)
4048 reg = E1000_READ_REG(hw, EERD);
4050 reg = E1000_READ_REG(hw, EEWR);
4052 if(reg & E1000_EEPROM_RW_REG_DONE) {
4053 done = E1000_SUCCESS;
4062 /***************************************************************************
4063 * Description: Determines if the onboard NVM is FLASH or EEPROM.
4065 * hw - Struct containing variables accessed by shared code
4066 ****************************************************************************/
4068 e1000_is_onboard_nvm_eeprom(struct e1000_hw *hw)
4072 if(hw->mac_type == e1000_82573) {
4073 eecd = E1000_READ_REG(hw, EECD);
4075 /* Isolate bits 15 & 16 */
4076 eecd = ((eecd >> 15) & 0x03);
4078 /* If both bits are set, device is Flash type */
4086 /******************************************************************************
4087 * Verifies that the EEPROM has a valid checksum
4089 * hw - Struct containing variables accessed by shared code
4091 * Reads the first 64 16 bit words of the EEPROM and sums the values read.
4092 * If the the sum of the 64 16 bit words is 0xBABA, the EEPROM's checksum is
4094 *****************************************************************************/
4096 e1000_validate_eeprom_checksum(struct e1000_hw *hw)
4098 uint16_t checksum = 0;
4099 uint16_t i, eeprom_data;
4101 DEBUGFUNC("e1000_validate_eeprom_checksum");
4103 if ((hw->mac_type == e1000_82573) &&
4104 (e1000_is_onboard_nvm_eeprom(hw) == FALSE)) {
4105 /* Check bit 4 of word 10h. If it is 0, firmware is done updating
4106 * 10h-12h. Checksum may need to be fixed. */
4107 e1000_read_eeprom(hw, 0x10, 1, &eeprom_data);
4108 if ((eeprom_data & 0x10) == 0) {
4109 /* Read 0x23 and check bit 15. This bit is a 1 when the checksum
4110 * has already been fixed. If the checksum is still wrong and this
4111 * bit is a 1, we need to return bad checksum. Otherwise, we need
4112 * to set this bit to a 1 and update the checksum. */
4113 e1000_read_eeprom(hw, 0x23, 1, &eeprom_data);
4114 if ((eeprom_data & 0x8000) == 0) {
4115 eeprom_data |= 0x8000;
4116 e1000_write_eeprom(hw, 0x23, 1, &eeprom_data);
4117 e1000_update_eeprom_checksum(hw);
4122 for(i = 0; i < (EEPROM_CHECKSUM_REG + 1); i++) {
4123 if(e1000_read_eeprom(hw, i, 1, &eeprom_data) < 0) {
4124 DEBUGOUT("EEPROM Read Error\n");
4125 return -E1000_ERR_EEPROM;
4127 checksum += eeprom_data;
4130 if(checksum == (uint16_t) EEPROM_SUM)
4131 return E1000_SUCCESS;
4133 DEBUGOUT("EEPROM Checksum Invalid\n");
4134 return -E1000_ERR_EEPROM;
4138 /******************************************************************************
4139 * Calculates the EEPROM checksum and writes it to the EEPROM
4141 * hw - Struct containing variables accessed by shared code
4143 * Sums the first 63 16 bit words of the EEPROM. Subtracts the sum from 0xBABA.
4144 * Writes the difference to word offset 63 of the EEPROM.
4145 *****************************************************************************/
4147 e1000_update_eeprom_checksum(struct e1000_hw *hw)
4149 uint16_t checksum = 0;
4150 uint16_t i, eeprom_data;
4152 DEBUGFUNC("e1000_update_eeprom_checksum");
4154 for(i = 0; i < EEPROM_CHECKSUM_REG; i++) {
4155 if(e1000_read_eeprom(hw, i, 1, &eeprom_data) < 0) {
4156 DEBUGOUT("EEPROM Read Error\n");
4157 return -E1000_ERR_EEPROM;
4159 checksum += eeprom_data;
4161 checksum = (uint16_t) EEPROM_SUM - checksum;
4162 if(e1000_write_eeprom(hw, EEPROM_CHECKSUM_REG, 1, &checksum) < 0) {
4163 DEBUGOUT("EEPROM Write Error\n");
4164 return -E1000_ERR_EEPROM;
4165 } else if (hw->eeprom.type == e1000_eeprom_flash) {
4166 e1000_commit_shadow_ram(hw);
4168 return E1000_SUCCESS;
4171 /******************************************************************************
4172 * Parent function for writing words to the different EEPROM types.
4174 * hw - Struct containing variables accessed by shared code
4175 * offset - offset within the EEPROM to be written to
4176 * words - number of words to write
4177 * data - 16 bit word to be written to the EEPROM
4179 * If e1000_update_eeprom_checksum is not called after this function, the
4180 * EEPROM will most likely contain an invalid checksum.
4181 *****************************************************************************/
4183 e1000_write_eeprom(struct e1000_hw *hw,
4188 struct e1000_eeprom_info *eeprom = &hw->eeprom;
4191 DEBUGFUNC("e1000_write_eeprom");
4193 /* A check for invalid values: offset too large, too many words, and not
4196 if((offset >= eeprom->word_size) || (words > eeprom->word_size - offset) ||
4198 DEBUGOUT("\"words\" parameter out of bounds\n");
4199 return -E1000_ERR_EEPROM;
4202 /* 82573 writes only through eewr */
4203 if(eeprom->use_eewr == TRUE)
4204 return e1000_write_eeprom_eewr(hw, offset, words, data);
4206 /* Prepare the EEPROM for writing */
4207 if (e1000_acquire_eeprom(hw) != E1000_SUCCESS)
4208 return -E1000_ERR_EEPROM;
4210 if(eeprom->type == e1000_eeprom_microwire) {
4211 status = e1000_write_eeprom_microwire(hw, offset, words, data);
4213 status = e1000_write_eeprom_spi(hw, offset, words, data);
4217 /* Done with writing */
4218 e1000_release_eeprom(hw);
4223 /******************************************************************************
4224 * Writes a 16 bit word to a given offset in an SPI EEPROM.
4226 * hw - Struct containing variables accessed by shared code
4227 * offset - offset within the EEPROM to be written to
4228 * words - number of words to write
4229 * data - pointer to array of 8 bit words to be written to the EEPROM
4231 *****************************************************************************/
4233 e1000_write_eeprom_spi(struct e1000_hw *hw,
4238 struct e1000_eeprom_info *eeprom = &hw->eeprom;
4241 DEBUGFUNC("e1000_write_eeprom_spi");
4243 while (widx < words) {
4244 uint8_t write_opcode = EEPROM_WRITE_OPCODE_SPI;
4246 if(e1000_spi_eeprom_ready(hw)) return -E1000_ERR_EEPROM;
4248 e1000_standby_eeprom(hw);
4250 /* Send the WRITE ENABLE command (8 bit opcode ) */
4251 e1000_shift_out_ee_bits(hw, EEPROM_WREN_OPCODE_SPI,
4252 eeprom->opcode_bits);
4254 e1000_standby_eeprom(hw);
4256 /* Some SPI eeproms use the 8th address bit embedded in the opcode */
4257 if((eeprom->address_bits == 8) && (offset >= 128))
4258 write_opcode |= EEPROM_A8_OPCODE_SPI;
4260 /* Send the Write command (8-bit opcode + addr) */
4261 e1000_shift_out_ee_bits(hw, write_opcode, eeprom->opcode_bits);
4263 e1000_shift_out_ee_bits(hw, (uint16_t)((offset + widx)*2),
4264 eeprom->address_bits);
4268 /* Loop to allow for up to whole page write (32 bytes) of eeprom */
4269 while (widx < words) {
4270 uint16_t word_out = data[widx];
4271 word_out = (word_out >> 8) | (word_out << 8);
4272 e1000_shift_out_ee_bits(hw, word_out, 16);
4275 /* Some larger eeprom sizes are capable of a 32-byte PAGE WRITE
4276 * operation, while the smaller eeproms are capable of an 8-byte
4277 * PAGE WRITE operation. Break the inner loop to pass new address
4279 if((((offset + widx)*2) % eeprom->page_size) == 0) {
4280 e1000_standby_eeprom(hw);
4286 return E1000_SUCCESS;
4289 /******************************************************************************
4290 * Writes a 16 bit word to a given offset in a Microwire EEPROM.
4292 * hw - Struct containing variables accessed by shared code
4293 * offset - offset within the EEPROM to be written to
4294 * words - number of words to write
4295 * data - pointer to array of 16 bit words to be written to the EEPROM
4297 *****************************************************************************/
4299 e1000_write_eeprom_microwire(struct e1000_hw *hw,
4304 struct e1000_eeprom_info *eeprom = &hw->eeprom;
4306 uint16_t words_written = 0;
4309 DEBUGFUNC("e1000_write_eeprom_microwire");
4311 /* Send the write enable command to the EEPROM (3-bit opcode plus
4312 * 6/8-bit dummy address beginning with 11). It's less work to include
4313 * the 11 of the dummy address as part of the opcode than it is to shift
4314 * it over the correct number of bits for the address. This puts the
4315 * EEPROM into write/erase mode.
4317 e1000_shift_out_ee_bits(hw, EEPROM_EWEN_OPCODE_MICROWIRE,
4318 (uint16_t)(eeprom->opcode_bits + 2));
4320 e1000_shift_out_ee_bits(hw, 0, (uint16_t)(eeprom->address_bits - 2));
4322 /* Prepare the EEPROM */
4323 e1000_standby_eeprom(hw);
4325 while (words_written < words) {
4326 /* Send the Write command (3-bit opcode + addr) */
4327 e1000_shift_out_ee_bits(hw, EEPROM_WRITE_OPCODE_MICROWIRE,
4328 eeprom->opcode_bits);
4330 e1000_shift_out_ee_bits(hw, (uint16_t)(offset + words_written),
4331 eeprom->address_bits);
4334 e1000_shift_out_ee_bits(hw, data[words_written], 16);
4336 /* Toggle the CS line. This in effect tells the EEPROM to execute
4337 * the previous command.
4339 e1000_standby_eeprom(hw);
4341 /* Read DO repeatedly until it is high (equal to '1'). The EEPROM will
4342 * signal that the command has been completed by raising the DO signal.
4343 * If DO does not go high in 10 milliseconds, then error out.
4345 for(i = 0; i < 200; i++) {
4346 eecd = E1000_READ_REG(hw, EECD);
4347 if(eecd & E1000_EECD_DO) break;
4351 DEBUGOUT("EEPROM Write did not complete\n");
4352 return -E1000_ERR_EEPROM;
4355 /* Recover from write */
4356 e1000_standby_eeprom(hw);
4361 /* Send the write disable command to the EEPROM (3-bit opcode plus
4362 * 6/8-bit dummy address beginning with 10). It's less work to include
4363 * the 10 of the dummy address as part of the opcode than it is to shift
4364 * it over the correct number of bits for the address. This takes the
4365 * EEPROM out of write/erase mode.
4367 e1000_shift_out_ee_bits(hw, EEPROM_EWDS_OPCODE_MICROWIRE,
4368 (uint16_t)(eeprom->opcode_bits + 2));
4370 e1000_shift_out_ee_bits(hw, 0, (uint16_t)(eeprom->address_bits - 2));
4372 return E1000_SUCCESS;
4375 /******************************************************************************
4376 * Flushes the cached eeprom to NVM. This is done by saving the modified values
4377 * in the eeprom cache and the non modified values in the currently active bank
4380 * hw - Struct containing variables accessed by shared code
4381 * offset - offset of word in the EEPROM to read
4382 * data - word read from the EEPROM
4383 * words - number of words to read
4384 *****************************************************************************/
4386 e1000_commit_shadow_ram(struct e1000_hw *hw)
4388 uint32_t attempts = 100000;
4392 int32_t error = E1000_SUCCESS;
4394 /* The flop register will be used to determine if flash type is STM */
4395 flop = E1000_READ_REG(hw, FLOP);
4397 if (hw->mac_type == e1000_82573) {
4398 for (i=0; i < attempts; i++) {
4399 eecd = E1000_READ_REG(hw, EECD);
4400 if ((eecd & E1000_EECD_FLUPD) == 0) {
4406 if (i == attempts) {
4407 return -E1000_ERR_EEPROM;
4410 /* If STM opcode located in bits 15:8 of flop, reset firmware */
4411 if ((flop & 0xFF00) == E1000_STM_OPCODE) {
4412 E1000_WRITE_REG(hw, HICR, E1000_HICR_FW_RESET);
4415 /* Perform the flash update */
4416 E1000_WRITE_REG(hw, EECD, eecd | E1000_EECD_FLUPD);
4418 for (i=0; i < attempts; i++) {
4419 eecd = E1000_READ_REG(hw, EECD);
4420 if ((eecd & E1000_EECD_FLUPD) == 0) {
4426 if (i == attempts) {
4427 return -E1000_ERR_EEPROM;
4434 /******************************************************************************
4435 * Reads the adapter's part number from the EEPROM
4437 * hw - Struct containing variables accessed by shared code
4438 * part_num - Adapter's part number
4439 *****************************************************************************/
4441 e1000_read_part_num(struct e1000_hw *hw,
4444 uint16_t offset = EEPROM_PBA_BYTE_1;
4445 uint16_t eeprom_data;
4447 DEBUGFUNC("e1000_read_part_num");
4449 /* Get word 0 from EEPROM */
4450 if(e1000_read_eeprom(hw, offset, 1, &eeprom_data) < 0) {
4451 DEBUGOUT("EEPROM Read Error\n");
4452 return -E1000_ERR_EEPROM;
4454 /* Save word 0 in upper half of part_num */
4455 *part_num = (uint32_t) (eeprom_data << 16);
4457 /* Get word 1 from EEPROM */
4458 if(e1000_read_eeprom(hw, ++offset, 1, &eeprom_data) < 0) {
4459 DEBUGOUT("EEPROM Read Error\n");
4460 return -E1000_ERR_EEPROM;
4462 /* Save word 1 in lower half of part_num */
4463 *part_num |= eeprom_data;
4465 return E1000_SUCCESS;
4468 /******************************************************************************
4469 * Reads the adapter's MAC address from the EEPROM and inverts the LSB for the
4470 * second function of dual function devices
4472 * hw - Struct containing variables accessed by shared code
4473 *****************************************************************************/
4475 e1000_read_mac_addr(struct e1000_hw * hw)
4478 uint16_t eeprom_data, i;
4480 DEBUGFUNC("e1000_read_mac_addr");
4482 for(i = 0; i < NODE_ADDRESS_SIZE; i += 2) {
4484 if(e1000_read_eeprom(hw, offset, 1, &eeprom_data) < 0) {
4485 DEBUGOUT("EEPROM Read Error\n");
4486 return -E1000_ERR_EEPROM;
4488 hw->perm_mac_addr[i] = (uint8_t) (eeprom_data & 0x00FF);
4489 hw->perm_mac_addr[i+1] = (uint8_t) (eeprom_data >> 8);
4491 switch (hw->mac_type) {
4495 case e1000_82546_rev_3:
4497 if(E1000_READ_REG(hw, STATUS) & E1000_STATUS_FUNC_1)
4498 hw->perm_mac_addr[5] ^= 0x01;
4502 for(i = 0; i < NODE_ADDRESS_SIZE; i++)
4503 hw->mac_addr[i] = hw->perm_mac_addr[i];
4504 return E1000_SUCCESS;
4507 /******************************************************************************
4508 * Initializes receive address filters.
4510 * hw - Struct containing variables accessed by shared code
4512 * Places the MAC address in receive address register 0 and clears the rest
4513 * of the receive addresss registers. Clears the multicast table. Assumes
4514 * the receiver is in reset when the routine is called.
4515 *****************************************************************************/
4517 e1000_init_rx_addrs(struct e1000_hw *hw)
4522 DEBUGFUNC("e1000_init_rx_addrs");
4524 /* Setup the receive address. */
4525 DEBUGOUT("Programming MAC Address into RAR[0]\n");
4527 e1000_rar_set(hw, hw->mac_addr, 0);
4529 rar_num = E1000_RAR_ENTRIES;
4531 /* Reserve a spot for the Locally Administered Address to work around
4532 * an 82571 issue in which a reset on one port will reload the MAC on
4533 * the other port. */
4534 if ((hw->mac_type == e1000_82571) && (hw->laa_is_present == TRUE))
4536 /* Zero out the other 15 receive addresses. */
4537 DEBUGOUT("Clearing RAR[1-15]\n");
4538 for(i = 1; i < rar_num; i++) {
4539 E1000_WRITE_REG_ARRAY(hw, RA, (i << 1), 0);
4540 E1000_WRITE_REG_ARRAY(hw, RA, ((i << 1) + 1), 0);
4545 /******************************************************************************
4546 * Updates the MAC's list of multicast addresses.
4548 * hw - Struct containing variables accessed by shared code
4549 * mc_addr_list - the list of new multicast addresses
4550 * mc_addr_count - number of addresses
4551 * pad - number of bytes between addresses in the list
4552 * rar_used_count - offset where to start adding mc addresses into the RAR's
4554 * The given list replaces any existing list. Clears the last 15 receive
4555 * address registers and the multicast table. Uses receive address registers
4556 * for the first 15 multicast addresses, and hashes the rest into the
4558 *****************************************************************************/
4560 e1000_mc_addr_list_update(struct e1000_hw *hw,
4561 uint8_t *mc_addr_list,
4562 uint32_t mc_addr_count,
4564 uint32_t rar_used_count)
4566 uint32_t hash_value;
4568 uint32_t num_rar_entry;
4569 uint32_t num_mta_entry;
4571 DEBUGFUNC("e1000_mc_addr_list_update");
4573 /* Set the new number of MC addresses that we are being requested to use. */
4574 hw->num_mc_addrs = mc_addr_count;
4576 /* Clear RAR[1-15] */
4577 DEBUGOUT(" Clearing RAR[1-15]\n");
4578 num_rar_entry = E1000_RAR_ENTRIES;
4579 /* Reserve a spot for the Locally Administered Address to work around
4580 * an 82571 issue in which a reset on one port will reload the MAC on
4581 * the other port. */
4582 if ((hw->mac_type == e1000_82571) && (hw->laa_is_present == TRUE))
4585 for(i = rar_used_count; i < num_rar_entry; i++) {
4586 E1000_WRITE_REG_ARRAY(hw, RA, (i << 1), 0);
4587 E1000_WRITE_REG_ARRAY(hw, RA, ((i << 1) + 1), 0);
4591 DEBUGOUT(" Clearing MTA\n");
4592 num_mta_entry = E1000_NUM_MTA_REGISTERS;
4593 for(i = 0; i < num_mta_entry; i++) {
4594 E1000_WRITE_REG_ARRAY(hw, MTA, i, 0);
4597 /* Add the new addresses */
4598 for(i = 0; i < mc_addr_count; i++) {
4599 DEBUGOUT(" Adding the multicast addresses:\n");
4600 DEBUGOUT7(" MC Addr #%d =%.2X %.2X %.2X %.2X %.2X %.2X\n", i,
4601 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad)],
4602 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad) + 1],
4603 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad) + 2],
4604 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad) + 3],
4605 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad) + 4],
4606 mc_addr_list[i * (ETH_LENGTH_OF_ADDRESS + pad) + 5]);
4608 hash_value = e1000_hash_mc_addr(hw,
4610 (i * (ETH_LENGTH_OF_ADDRESS + pad)));
4612 DEBUGOUT1(" Hash value = 0x%03X\n", hash_value);
4614 /* Place this multicast address in the RAR if there is room, *
4615 * else put it in the MTA
4617 if (rar_used_count < num_rar_entry) {
4619 mc_addr_list + (i * (ETH_LENGTH_OF_ADDRESS + pad)),
4623 e1000_mta_set(hw, hash_value);
4626 DEBUGOUT("MC Update Complete\n");
4630 /******************************************************************************
4631 * Hashes an address to determine its location in the multicast table
4633 * hw - Struct containing variables accessed by shared code
4634 * mc_addr - the multicast address to hash
4635 *****************************************************************************/
4637 e1000_hash_mc_addr(struct e1000_hw *hw,
4640 uint32_t hash_value = 0;
4642 /* The portion of the address that is used for the hash table is
4643 * determined by the mc_filter_type setting.
4645 switch (hw->mc_filter_type) {
4646 /* [0] [1] [2] [3] [4] [5]
4651 /* [47:36] i.e. 0x563 for above example address */
4652 hash_value = ((mc_addr[4] >> 4) | (((uint16_t) mc_addr[5]) << 4));
4655 /* [46:35] i.e. 0xAC6 for above example address */
4656 hash_value = ((mc_addr[4] >> 3) | (((uint16_t) mc_addr[5]) << 5));
4659 /* [45:34] i.e. 0x5D8 for above example address */
4660 hash_value = ((mc_addr[4] >> 2) | (((uint16_t) mc_addr[5]) << 6));
4663 /* [43:32] i.e. 0x634 for above example address */
4664 hash_value = ((mc_addr[4]) | (((uint16_t) mc_addr[5]) << 8));
4668 hash_value &= 0xFFF;
4673 /******************************************************************************
4674 * Sets the bit in the multicast table corresponding to the hash value.
4676 * hw - Struct containing variables accessed by shared code
4677 * hash_value - Multicast address hash value
4678 *****************************************************************************/
4680 e1000_mta_set(struct e1000_hw *hw,
4681 uint32_t hash_value)
4683 uint32_t hash_bit, hash_reg;
4687 /* The MTA is a register array of 128 32-bit registers.
4688 * It is treated like an array of 4096 bits. We want to set
4689 * bit BitArray[hash_value]. So we figure out what register
4690 * the bit is in, read it, OR in the new bit, then write
4691 * back the new value. The register is determined by the
4692 * upper 7 bits of the hash value and the bit within that
4693 * register are determined by the lower 5 bits of the value.
4695 hash_reg = (hash_value >> 5) & 0x7F;
4696 hash_bit = hash_value & 0x1F;
4698 mta = E1000_READ_REG_ARRAY(hw, MTA, hash_reg);
4700 mta |= (1 << hash_bit);
4702 /* If we are on an 82544 and we are trying to write an odd offset
4703 * in the MTA, save off the previous entry before writing and
4704 * restore the old value after writing.
4706 if((hw->mac_type == e1000_82544) && ((hash_reg & 0x1) == 1)) {
4707 temp = E1000_READ_REG_ARRAY(hw, MTA, (hash_reg - 1));
4708 E1000_WRITE_REG_ARRAY(hw, MTA, hash_reg, mta);
4709 E1000_WRITE_REG_ARRAY(hw, MTA, (hash_reg - 1), temp);
4711 E1000_WRITE_REG_ARRAY(hw, MTA, hash_reg, mta);
4715 /******************************************************************************
4716 * Puts an ethernet address into a receive address register.
4718 * hw - Struct containing variables accessed by shared code
4719 * addr - Address to put into receive address register
4720 * index - Receive address register to write
4721 *****************************************************************************/
4723 e1000_rar_set(struct e1000_hw *hw,
4727 uint32_t rar_low, rar_high;
4729 /* HW expects these in little endian so we reverse the byte order
4730 * from network order (big endian) to little endian
4732 rar_low = ((uint32_t) addr[0] |
4733 ((uint32_t) addr[1] << 8) |
4734 ((uint32_t) addr[2] << 16) | ((uint32_t) addr[3] << 24));
4736 rar_high = ((uint32_t) addr[4] | ((uint32_t) addr[5] << 8) | E1000_RAH_AV);
4738 E1000_WRITE_REG_ARRAY(hw, RA, (index << 1), rar_low);
4739 E1000_WRITE_REG_ARRAY(hw, RA, ((index << 1) + 1), rar_high);
4742 /******************************************************************************
4743 * Writes a value to the specified offset in the VLAN filter table.
4745 * hw - Struct containing variables accessed by shared code
4746 * offset - Offset in VLAN filer table to write
4747 * value - Value to write into VLAN filter table
4748 *****************************************************************************/
4750 e1000_write_vfta(struct e1000_hw *hw,
4756 if((hw->mac_type == e1000_82544) && ((offset & 0x1) == 1)) {
4757 temp = E1000_READ_REG_ARRAY(hw, VFTA, (offset - 1));
4758 E1000_WRITE_REG_ARRAY(hw, VFTA, offset, value);
4759 E1000_WRITE_REG_ARRAY(hw, VFTA, (offset - 1), temp);
4761 E1000_WRITE_REG_ARRAY(hw, VFTA, offset, value);
4765 /******************************************************************************
4766 * Clears the VLAN filer table
4768 * hw - Struct containing variables accessed by shared code
4769 *****************************************************************************/
4771 e1000_clear_vfta(struct e1000_hw *hw)
4774 uint32_t vfta_value = 0;
4775 uint32_t vfta_offset = 0;
4776 uint32_t vfta_bit_in_reg = 0;
4778 if (hw->mac_type == e1000_82573) {
4779 if (hw->mng_cookie.vlan_id != 0) {
4780 /* The VFTA is a 4096b bit-field, each identifying a single VLAN
4781 * ID. The following operations determine which 32b entry
4782 * (i.e. offset) into the array we want to set the VLAN ID
4783 * (i.e. bit) of the manageability unit. */
4784 vfta_offset = (hw->mng_cookie.vlan_id >>
4785 E1000_VFTA_ENTRY_SHIFT) &
4786 E1000_VFTA_ENTRY_MASK;
4787 vfta_bit_in_reg = 1 << (hw->mng_cookie.vlan_id &
4788 E1000_VFTA_ENTRY_BIT_SHIFT_MASK);
4791 for (offset = 0; offset < E1000_VLAN_FILTER_TBL_SIZE; offset++) {
4792 /* If the offset we want to clear is the same offset of the
4793 * manageability VLAN ID, then clear all bits except that of the
4794 * manageability unit */
4795 vfta_value = (offset == vfta_offset) ? vfta_bit_in_reg : 0;
4796 E1000_WRITE_REG_ARRAY(hw, VFTA, offset, vfta_value);
4801 e1000_id_led_init(struct e1000_hw * hw)
4804 const uint32_t ledctl_mask = 0x000000FF;
4805 const uint32_t ledctl_on = E1000_LEDCTL_MODE_LED_ON;
4806 const uint32_t ledctl_off = E1000_LEDCTL_MODE_LED_OFF;
4807 uint16_t eeprom_data, i, temp;
4808 const uint16_t led_mask = 0x0F;
4810 DEBUGFUNC("e1000_id_led_init");
4812 if(hw->mac_type < e1000_82540) {
4814 return E1000_SUCCESS;
4817 ledctl = E1000_READ_REG(hw, LEDCTL);
4818 hw->ledctl_default = ledctl;
4819 hw->ledctl_mode1 = hw->ledctl_default;
4820 hw->ledctl_mode2 = hw->ledctl_default;
4822 if(e1000_read_eeprom(hw, EEPROM_ID_LED_SETTINGS, 1, &eeprom_data) < 0) {
4823 DEBUGOUT("EEPROM Read Error\n");
4824 return -E1000_ERR_EEPROM;
4826 if((eeprom_data== ID_LED_RESERVED_0000) ||
4827 (eeprom_data == ID_LED_RESERVED_FFFF)) eeprom_data = ID_LED_DEFAULT;
4828 for(i = 0; i < 4; i++) {
4829 temp = (eeprom_data >> (i << 2)) & led_mask;
4831 case ID_LED_ON1_DEF2:
4832 case ID_LED_ON1_ON2:
4833 case ID_LED_ON1_OFF2:
4834 hw->ledctl_mode1 &= ~(ledctl_mask << (i << 3));
4835 hw->ledctl_mode1 |= ledctl_on << (i << 3);
4837 case ID_LED_OFF1_DEF2:
4838 case ID_LED_OFF1_ON2:
4839 case ID_LED_OFF1_OFF2:
4840 hw->ledctl_mode1 &= ~(ledctl_mask << (i << 3));
4841 hw->ledctl_mode1 |= ledctl_off << (i << 3);
4848 case ID_LED_DEF1_ON2:
4849 case ID_LED_ON1_ON2:
4850 case ID_LED_OFF1_ON2:
4851 hw->ledctl_mode2 &= ~(ledctl_mask << (i << 3));
4852 hw->ledctl_mode2 |= ledctl_on << (i << 3);
4854 case ID_LED_DEF1_OFF2:
4855 case ID_LED_ON1_OFF2:
4856 case ID_LED_OFF1_OFF2:
4857 hw->ledctl_mode2 &= ~(ledctl_mask << (i << 3));
4858 hw->ledctl_mode2 |= ledctl_off << (i << 3);
4865 return E1000_SUCCESS;
4868 /******************************************************************************
4869 * Prepares SW controlable LED for use and saves the current state of the LED.
4871 * hw - Struct containing variables accessed by shared code
4872 *****************************************************************************/
4874 e1000_setup_led(struct e1000_hw *hw)
4877 int32_t ret_val = E1000_SUCCESS;
4879 DEBUGFUNC("e1000_setup_led");
4881 switch(hw->mac_type) {
4882 case e1000_82542_rev2_0:
4883 case e1000_82542_rev2_1:
4886 /* No setup necessary */
4890 case e1000_82541_rev_2:
4891 case e1000_82547_rev_2:
4892 /* Turn off PHY Smart Power Down (if enabled) */
4893 ret_val = e1000_read_phy_reg(hw, IGP01E1000_GMII_FIFO,
4894 &hw->phy_spd_default);
4897 ret_val = e1000_write_phy_reg(hw, IGP01E1000_GMII_FIFO,
4898 (uint16_t)(hw->phy_spd_default &
4899 ~IGP01E1000_GMII_SPD));
4904 if(hw->media_type == e1000_media_type_fiber) {
4905 ledctl = E1000_READ_REG(hw, LEDCTL);
4906 /* Save current LEDCTL settings */
4907 hw->ledctl_default = ledctl;
4909 ledctl &= ~(E1000_LEDCTL_LED0_IVRT |
4910 E1000_LEDCTL_LED0_BLINK |
4911 E1000_LEDCTL_LED0_MODE_MASK);
4912 ledctl |= (E1000_LEDCTL_MODE_LED_OFF <<
4913 E1000_LEDCTL_LED0_MODE_SHIFT);
4914 E1000_WRITE_REG(hw, LEDCTL, ledctl);
4915 } else if(hw->media_type == e1000_media_type_copper)
4916 E1000_WRITE_REG(hw, LEDCTL, hw->ledctl_mode1);
4920 return E1000_SUCCESS;
4923 /******************************************************************************
4924 * Restores the saved state of the SW controlable LED.
4926 * hw - Struct containing variables accessed by shared code
4927 *****************************************************************************/
4929 e1000_cleanup_led(struct e1000_hw *hw)
4931 int32_t ret_val = E1000_SUCCESS;
4933 DEBUGFUNC("e1000_cleanup_led");
4935 switch(hw->mac_type) {
4936 case e1000_82542_rev2_0:
4937 case e1000_82542_rev2_1:
4940 /* No cleanup necessary */
4944 case e1000_82541_rev_2:
4945 case e1000_82547_rev_2:
4946 /* Turn on PHY Smart Power Down (if previously enabled) */
4947 ret_val = e1000_write_phy_reg(hw, IGP01E1000_GMII_FIFO,
4948 hw->phy_spd_default);
4953 /* Restore LEDCTL settings */
4954 E1000_WRITE_REG(hw, LEDCTL, hw->ledctl_default);
4958 return E1000_SUCCESS;
4961 /******************************************************************************
4962 * Turns on the software controllable LED
4964 * hw - Struct containing variables accessed by shared code
4965 *****************************************************************************/
4967 e1000_led_on(struct e1000_hw *hw)
4969 uint32_t ctrl = E1000_READ_REG(hw, CTRL);
4971 DEBUGFUNC("e1000_led_on");
4973 switch(hw->mac_type) {
4974 case e1000_82542_rev2_0:
4975 case e1000_82542_rev2_1:
4977 /* Set SW Defineable Pin 0 to turn on the LED */
4978 ctrl |= E1000_CTRL_SWDPIN0;
4979 ctrl |= E1000_CTRL_SWDPIO0;
4982 if(hw->media_type == e1000_media_type_fiber) {
4983 /* Set SW Defineable Pin 0 to turn on the LED */
4984 ctrl |= E1000_CTRL_SWDPIN0;
4985 ctrl |= E1000_CTRL_SWDPIO0;
4987 /* Clear SW Defineable Pin 0 to turn on the LED */
4988 ctrl &= ~E1000_CTRL_SWDPIN0;
4989 ctrl |= E1000_CTRL_SWDPIO0;
4993 if(hw->media_type == e1000_media_type_fiber) {
4994 /* Clear SW Defineable Pin 0 to turn on the LED */
4995 ctrl &= ~E1000_CTRL_SWDPIN0;
4996 ctrl |= E1000_CTRL_SWDPIO0;
4997 } else if(hw->media_type == e1000_media_type_copper) {
4998 E1000_WRITE_REG(hw, LEDCTL, hw->ledctl_mode2);
4999 return E1000_SUCCESS;
5004 E1000_WRITE_REG(hw, CTRL, ctrl);
5006 return E1000_SUCCESS;
5009 /******************************************************************************
5010 * Turns off the software controllable LED
5012 * hw - Struct containing variables accessed by shared code
5013 *****************************************************************************/
5015 e1000_led_off(struct e1000_hw *hw)
5017 uint32_t ctrl = E1000_READ_REG(hw, CTRL);
5019 DEBUGFUNC("e1000_led_off");
5021 switch(hw->mac_type) {
5022 case e1000_82542_rev2_0:
5023 case e1000_82542_rev2_1:
5025 /* Clear SW Defineable Pin 0 to turn off the LED */
5026 ctrl &= ~E1000_CTRL_SWDPIN0;
5027 ctrl |= E1000_CTRL_SWDPIO0;
5030 if(hw->media_type == e1000_media_type_fiber) {
5031 /* Clear SW Defineable Pin 0 to turn off the LED */
5032 ctrl &= ~E1000_CTRL_SWDPIN0;
5033 ctrl |= E1000_CTRL_SWDPIO0;
5035 /* Set SW Defineable Pin 0 to turn off the LED */
5036 ctrl |= E1000_CTRL_SWDPIN0;
5037 ctrl |= E1000_CTRL_SWDPIO0;
5041 if(hw->media_type == e1000_media_type_fiber) {
5042 /* Set SW Defineable Pin 0 to turn off the LED */
5043 ctrl |= E1000_CTRL_SWDPIN0;
5044 ctrl |= E1000_CTRL_SWDPIO0;
5045 } else if(hw->media_type == e1000_media_type_copper) {
5046 E1000_WRITE_REG(hw, LEDCTL, hw->ledctl_mode1);
5047 return E1000_SUCCESS;
5052 E1000_WRITE_REG(hw, CTRL, ctrl);
5054 return E1000_SUCCESS;
5057 /******************************************************************************
5058 * Clears all hardware statistics counters.
5060 * hw - Struct containing variables accessed by shared code
5061 *****************************************************************************/
5063 e1000_clear_hw_cntrs(struct e1000_hw *hw)
5065 volatile uint32_t temp;
5067 temp = E1000_READ_REG(hw, CRCERRS);
5068 temp = E1000_READ_REG(hw, SYMERRS);
5069 temp = E1000_READ_REG(hw, MPC);
5070 temp = E1000_READ_REG(hw, SCC);
5071 temp = E1000_READ_REG(hw, ECOL);
5072 temp = E1000_READ_REG(hw, MCC);
5073 temp = E1000_READ_REG(hw, LATECOL);
5074 temp = E1000_READ_REG(hw, COLC);
5075 temp = E1000_READ_REG(hw, DC);
5076 temp = E1000_READ_REG(hw, SEC);
5077 temp = E1000_READ_REG(hw, RLEC);
5078 temp = E1000_READ_REG(hw, XONRXC);
5079 temp = E1000_READ_REG(hw, XONTXC);
5080 temp = E1000_READ_REG(hw, XOFFRXC);
5081 temp = E1000_READ_REG(hw, XOFFTXC);
5082 temp = E1000_READ_REG(hw, FCRUC);
5083 temp = E1000_READ_REG(hw, PRC64);
5084 temp = E1000_READ_REG(hw, PRC127);
5085 temp = E1000_READ_REG(hw, PRC255);
5086 temp = E1000_READ_REG(hw, PRC511);
5087 temp = E1000_READ_REG(hw, PRC1023);
5088 temp = E1000_READ_REG(hw, PRC1522);
5089 temp = E1000_READ_REG(hw, GPRC);
5090 temp = E1000_READ_REG(hw, BPRC);
5091 temp = E1000_READ_REG(hw, MPRC);
5092 temp = E1000_READ_REG(hw, GPTC);
5093 temp = E1000_READ_REG(hw, GORCL);
5094 temp = E1000_READ_REG(hw, GORCH);
5095 temp = E1000_READ_REG(hw, GOTCL);
5096 temp = E1000_READ_REG(hw, GOTCH);
5097 temp = E1000_READ_REG(hw, RNBC);
5098 temp = E1000_READ_REG(hw, RUC);
5099 temp = E1000_READ_REG(hw, RFC);
5100 temp = E1000_READ_REG(hw, ROC);
5101 temp = E1000_READ_REG(hw, RJC);
5102 temp = E1000_READ_REG(hw, TORL);
5103 temp = E1000_READ_REG(hw, TORH);
5104 temp = E1000_READ_REG(hw, TOTL);
5105 temp = E1000_READ_REG(hw, TOTH);
5106 temp = E1000_READ_REG(hw, TPR);
5107 temp = E1000_READ_REG(hw, TPT);
5108 temp = E1000_READ_REG(hw, PTC64);
5109 temp = E1000_READ_REG(hw, PTC127);
5110 temp = E1000_READ_REG(hw, PTC255);
5111 temp = E1000_READ_REG(hw, PTC511);
5112 temp = E1000_READ_REG(hw, PTC1023);
5113 temp = E1000_READ_REG(hw, PTC1522);
5114 temp = E1000_READ_REG(hw, MPTC);
5115 temp = E1000_READ_REG(hw, BPTC);
5117 if(hw->mac_type < e1000_82543) return;
5119 temp = E1000_READ_REG(hw, ALGNERRC);
5120 temp = E1000_READ_REG(hw, RXERRC);
5121 temp = E1000_READ_REG(hw, TNCRS);
5122 temp = E1000_READ_REG(hw, CEXTERR);
5123 temp = E1000_READ_REG(hw, TSCTC);
5124 temp = E1000_READ_REG(hw, TSCTFC);
5126 if(hw->mac_type <= e1000_82544) return;
5128 temp = E1000_READ_REG(hw, MGTPRC);
5129 temp = E1000_READ_REG(hw, MGTPDC);
5130 temp = E1000_READ_REG(hw, MGTPTC);
5132 if(hw->mac_type <= e1000_82547_rev_2) return;
5134 temp = E1000_READ_REG(hw, IAC);
5135 temp = E1000_READ_REG(hw, ICRXOC);
5136 temp = E1000_READ_REG(hw, ICRXPTC);
5137 temp = E1000_READ_REG(hw, ICRXATC);
5138 temp = E1000_READ_REG(hw, ICTXPTC);
5139 temp = E1000_READ_REG(hw, ICTXATC);
5140 temp = E1000_READ_REG(hw, ICTXQEC);
5141 temp = E1000_READ_REG(hw, ICTXQMTC);
5142 temp = E1000_READ_REG(hw, ICRXDMTC);
5145 /******************************************************************************
5146 * Resets Adaptive IFS to its default state.
5148 * hw - Struct containing variables accessed by shared code
5150 * Call this after e1000_init_hw. You may override the IFS defaults by setting
5151 * hw->ifs_params_forced to TRUE. However, you must initialize hw->
5152 * current_ifs_val, ifs_min_val, ifs_max_val, ifs_step_size, and ifs_ratio
5153 * before calling this function.
5154 *****************************************************************************/
5156 e1000_reset_adaptive(struct e1000_hw *hw)
5158 DEBUGFUNC("e1000_reset_adaptive");
5160 if(hw->adaptive_ifs) {
5161 if(!hw->ifs_params_forced) {
5162 hw->current_ifs_val = 0;
5163 hw->ifs_min_val = IFS_MIN;
5164 hw->ifs_max_val = IFS_MAX;
5165 hw->ifs_step_size = IFS_STEP;
5166 hw->ifs_ratio = IFS_RATIO;
5168 hw->in_ifs_mode = FALSE;
5169 E1000_WRITE_REG(hw, AIT, 0);
5171 DEBUGOUT("Not in Adaptive IFS mode!\n");
5175 /******************************************************************************
5176 * Called during the callback/watchdog routine to update IFS value based on
5177 * the ratio of transmits to collisions.
5179 * hw - Struct containing variables accessed by shared code
5180 * tx_packets - Number of transmits since last callback
5181 * total_collisions - Number of collisions since last callback
5182 *****************************************************************************/
5184 e1000_update_adaptive(struct e1000_hw *hw)
5186 DEBUGFUNC("e1000_update_adaptive");
5188 if(hw->adaptive_ifs) {
5189 if((hw->collision_delta * hw->ifs_ratio) > hw->tx_packet_delta) {
5190 if(hw->tx_packet_delta > MIN_NUM_XMITS) {
5191 hw->in_ifs_mode = TRUE;
5192 if(hw->current_ifs_val < hw->ifs_max_val) {
5193 if(hw->current_ifs_val == 0)
5194 hw->current_ifs_val = hw->ifs_min_val;
5196 hw->current_ifs_val += hw->ifs_step_size;
5197 E1000_WRITE_REG(hw, AIT, hw->current_ifs_val);
5201 if(hw->in_ifs_mode && (hw->tx_packet_delta <= MIN_NUM_XMITS)) {
5202 hw->current_ifs_val = 0;
5203 hw->in_ifs_mode = FALSE;
5204 E1000_WRITE_REG(hw, AIT, 0);
5208 DEBUGOUT("Not in Adaptive IFS mode!\n");
5212 /******************************************************************************
5213 * Adjusts the statistic counters when a frame is accepted by TBI_ACCEPT
5215 * hw - Struct containing variables accessed by shared code
5216 * frame_len - The length of the frame in question
5217 * mac_addr - The Ethernet destination address of the frame in question
5218 *****************************************************************************/
5220 e1000_tbi_adjust_stats(struct e1000_hw *hw,
5221 struct e1000_hw_stats *stats,
5227 /* First adjust the frame length. */
5229 /* We need to adjust the statistics counters, since the hardware
5230 * counters overcount this packet as a CRC error and undercount
5231 * the packet as a good packet
5233 /* This packet should not be counted as a CRC error. */
5235 /* This packet does count as a Good Packet Received. */
5238 /* Adjust the Good Octets received counters */
5239 carry_bit = 0x80000000 & stats->gorcl;
5240 stats->gorcl += frame_len;
5241 /* If the high bit of Gorcl (the low 32 bits of the Good Octets
5242 * Received Count) was one before the addition,
5243 * AND it is zero after, then we lost the carry out,
5244 * need to add one to Gorch (Good Octets Received Count High).
5245 * This could be simplified if all environments supported
5248 if(carry_bit && ((stats->gorcl & 0x80000000) == 0))
5250 /* Is this a broadcast or multicast? Check broadcast first,
5251 * since the test for a multicast frame will test positive on
5252 * a broadcast frame.
5254 if((mac_addr[0] == (uint8_t) 0xff) && (mac_addr[1] == (uint8_t) 0xff))
5255 /* Broadcast packet */
5257 else if(*mac_addr & 0x01)
5258 /* Multicast packet */
5261 if(frame_len == hw->max_frame_size) {
5262 /* In this case, the hardware has overcounted the number of
5269 /* Adjust the bin counters when the extra byte put the frame in the
5270 * wrong bin. Remember that the frame_len was adjusted above.
5272 if(frame_len == 64) {
5275 } else if(frame_len == 127) {
5278 } else if(frame_len == 255) {
5281 } else if(frame_len == 511) {
5284 } else if(frame_len == 1023) {
5287 } else if(frame_len == 1522) {
5292 /******************************************************************************
5293 * Gets the current PCI bus type, speed, and width of the hardware
5295 * hw - Struct containing variables accessed by shared code
5296 *****************************************************************************/
5298 e1000_get_bus_info(struct e1000_hw *hw)
5302 switch (hw->mac_type) {
5303 case e1000_82542_rev2_0:
5304 case e1000_82542_rev2_1:
5305 hw->bus_type = e1000_bus_type_unknown;
5306 hw->bus_speed = e1000_bus_speed_unknown;
5307 hw->bus_width = e1000_bus_width_unknown;
5311 hw->bus_type = e1000_bus_type_pci_express;
5312 hw->bus_speed = e1000_bus_speed_2500;
5313 hw->bus_width = e1000_bus_width_pciex_1;
5316 hw->bus_type = e1000_bus_type_pci_express;
5317 hw->bus_speed = e1000_bus_speed_2500;
5318 hw->bus_width = e1000_bus_width_pciex_4;
5321 status = E1000_READ_REG(hw, STATUS);
5322 hw->bus_type = (status & E1000_STATUS_PCIX_MODE) ?
5323 e1000_bus_type_pcix : e1000_bus_type_pci;
5325 if(hw->device_id == E1000_DEV_ID_82546EB_QUAD_COPPER) {
5326 hw->bus_speed = (hw->bus_type == e1000_bus_type_pci) ?
5327 e1000_bus_speed_66 : e1000_bus_speed_120;
5328 } else if(hw->bus_type == e1000_bus_type_pci) {
5329 hw->bus_speed = (status & E1000_STATUS_PCI66) ?
5330 e1000_bus_speed_66 : e1000_bus_speed_33;
5332 switch (status & E1000_STATUS_PCIX_SPEED) {
5333 case E1000_STATUS_PCIX_SPEED_66:
5334 hw->bus_speed = e1000_bus_speed_66;
5336 case E1000_STATUS_PCIX_SPEED_100:
5337 hw->bus_speed = e1000_bus_speed_100;
5339 case E1000_STATUS_PCIX_SPEED_133:
5340 hw->bus_speed = e1000_bus_speed_133;
5343 hw->bus_speed = e1000_bus_speed_reserved;
5347 hw->bus_width = (status & E1000_STATUS_BUS64) ?
5348 e1000_bus_width_64 : e1000_bus_width_32;
5354 /******************************************************************************
5355 * Reads a value from one of the devices registers using port I/O (as opposed
5356 * memory mapped I/O). Only 82544 and newer devices support port I/O.
5358 * hw - Struct containing variables accessed by shared code
5359 * offset - offset to read from
5360 *****************************************************************************/
5362 e1000_read_reg_io(struct e1000_hw *hw,
5365 unsigned long io_addr = hw->io_base;
5366 unsigned long io_data = hw->io_base + 4;
5368 e1000_io_write(hw, io_addr, offset);
5369 return e1000_io_read(hw, io_data);
5373 /******************************************************************************
5374 * Writes a value to one of the devices registers using port I/O (as opposed to
5375 * memory mapped I/O). Only 82544 and newer devices support port I/O.
5377 * hw - Struct containing variables accessed by shared code
5378 * offset - offset to write to
5379 * value - value to write
5380 *****************************************************************************/
5382 e1000_write_reg_io(struct e1000_hw *hw,
5386 unsigned long io_addr = hw->io_base;
5387 unsigned long io_data = hw->io_base + 4;
5389 e1000_io_write(hw, io_addr, offset);
5390 e1000_io_write(hw, io_data, value);
5394 /******************************************************************************
5395 * Estimates the cable length.
5397 * hw - Struct containing variables accessed by shared code
5398 * min_length - The estimated minimum length
5399 * max_length - The estimated maximum length
5401 * returns: - E1000_ERR_XXX
5404 * This function always returns a ranged length (minimum & maximum).
5405 * So for M88 phy's, this function interprets the one value returned from the
5406 * register to the minimum and maximum range.
5407 * For IGP phy's, the function calculates the range by the AGC registers.
5408 *****************************************************************************/
5410 e1000_get_cable_length(struct e1000_hw *hw,
5411 uint16_t *min_length,
5412 uint16_t *max_length)
5415 uint16_t agc_value = 0;
5416 uint16_t cur_agc, min_agc = IGP01E1000_AGC_LENGTH_TABLE_SIZE;
5417 uint16_t max_agc = 0;
5418 uint16_t i, phy_data;
5419 uint16_t cable_length;
5421 DEBUGFUNC("e1000_get_cable_length");
5423 *min_length = *max_length = 0;
5425 /* Use old method for Phy older than IGP */
5426 if(hw->phy_type == e1000_phy_m88) {
5428 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_STATUS,
5432 cable_length = (phy_data & M88E1000_PSSR_CABLE_LENGTH) >>
5433 M88E1000_PSSR_CABLE_LENGTH_SHIFT;
5435 /* Convert the enum value to ranged values */
5436 switch (cable_length) {
5437 case e1000_cable_length_50:
5439 *max_length = e1000_igp_cable_length_50;
5441 case e1000_cable_length_50_80:
5442 *min_length = e1000_igp_cable_length_50;
5443 *max_length = e1000_igp_cable_length_80;
5445 case e1000_cable_length_80_110:
5446 *min_length = e1000_igp_cable_length_80;
5447 *max_length = e1000_igp_cable_length_110;
5449 case e1000_cable_length_110_140:
5450 *min_length = e1000_igp_cable_length_110;
5451 *max_length = e1000_igp_cable_length_140;
5453 case e1000_cable_length_140:
5454 *min_length = e1000_igp_cable_length_140;
5455 *max_length = e1000_igp_cable_length_170;
5458 return -E1000_ERR_PHY;
5461 } else if(hw->phy_type == e1000_phy_igp) { /* For IGP PHY */
5462 uint16_t agc_reg_array[IGP01E1000_PHY_CHANNEL_NUM] =
5463 {IGP01E1000_PHY_AGC_A,
5464 IGP01E1000_PHY_AGC_B,
5465 IGP01E1000_PHY_AGC_C,
5466 IGP01E1000_PHY_AGC_D};
5467 /* Read the AGC registers for all channels */
5468 for(i = 0; i < IGP01E1000_PHY_CHANNEL_NUM; i++) {
5470 ret_val = e1000_read_phy_reg(hw, agc_reg_array[i], &phy_data);
5474 cur_agc = phy_data >> IGP01E1000_AGC_LENGTH_SHIFT;
5476 /* Array bound check. */
5477 if((cur_agc >= IGP01E1000_AGC_LENGTH_TABLE_SIZE - 1) ||
5479 return -E1000_ERR_PHY;
5481 agc_value += cur_agc;
5483 /* Update minimal AGC value. */
5484 if(min_agc > cur_agc)
5488 /* Remove the minimal AGC result for length < 50m */
5489 if(agc_value < IGP01E1000_PHY_CHANNEL_NUM * e1000_igp_cable_length_50) {
5490 agc_value -= min_agc;
5492 /* Get the average length of the remaining 3 channels */
5493 agc_value /= (IGP01E1000_PHY_CHANNEL_NUM - 1);
5495 /* Get the average length of all the 4 channels. */
5496 agc_value /= IGP01E1000_PHY_CHANNEL_NUM;
5499 /* Set the range of the calculated length. */
5500 *min_length = ((e1000_igp_cable_length_table[agc_value] -
5501 IGP01E1000_AGC_RANGE) > 0) ?
5502 (e1000_igp_cable_length_table[agc_value] -
5503 IGP01E1000_AGC_RANGE) : 0;
5504 *max_length = e1000_igp_cable_length_table[agc_value] +
5505 IGP01E1000_AGC_RANGE;
5506 } else if (hw->phy_type == e1000_phy_igp_2) {
5507 uint16_t agc_reg_array[IGP02E1000_PHY_CHANNEL_NUM] =
5508 {IGP02E1000_PHY_AGC_A,
5509 IGP02E1000_PHY_AGC_B,
5510 IGP02E1000_PHY_AGC_C,
5511 IGP02E1000_PHY_AGC_D};
5512 /* Read the AGC registers for all channels */
5513 for (i = 0; i < IGP02E1000_PHY_CHANNEL_NUM; i++) {
5514 ret_val = e1000_read_phy_reg(hw, agc_reg_array[i], &phy_data);
5518 /* Getting bits 15:9, which represent the combination of course and
5519 * fine gain values. The result is a number that can be put into
5520 * the lookup table to obtain the approximate cable length. */
5521 cur_agc = (phy_data >> IGP02E1000_AGC_LENGTH_SHIFT) &
5522 IGP02E1000_AGC_LENGTH_MASK;
5524 /* Remove min & max AGC values from calculation. */
5525 if (e1000_igp_2_cable_length_table[min_agc] > e1000_igp_2_cable_length_table[cur_agc])
5527 if (e1000_igp_2_cable_length_table[max_agc] < e1000_igp_2_cable_length_table[cur_agc])
5530 agc_value += e1000_igp_2_cable_length_table[cur_agc];
5533 agc_value -= (e1000_igp_2_cable_length_table[min_agc] + e1000_igp_2_cable_length_table[max_agc]);
5534 agc_value /= (IGP02E1000_PHY_CHANNEL_NUM - 2);
5536 /* Calculate cable length with the error range of +/- 10 meters. */
5537 *min_length = ((agc_value - IGP02E1000_AGC_RANGE) > 0) ?
5538 (agc_value - IGP02E1000_AGC_RANGE) : 0;
5539 *max_length = agc_value + IGP02E1000_AGC_RANGE;
5542 return E1000_SUCCESS;
5545 /******************************************************************************
5546 * Check the cable polarity
5548 * hw - Struct containing variables accessed by shared code
5549 * polarity - output parameter : 0 - Polarity is not reversed
5550 * 1 - Polarity is reversed.
5552 * returns: - E1000_ERR_XXX
5555 * For phy's older then IGP, this function simply reads the polarity bit in the
5556 * Phy Status register. For IGP phy's, this bit is valid only if link speed is
5557 * 10 Mbps. If the link speed is 100 Mbps there is no polarity so this bit will
5558 * return 0. If the link speed is 1000 Mbps the polarity status is in the
5559 * IGP01E1000_PHY_PCS_INIT_REG.
5560 *****************************************************************************/
5562 e1000_check_polarity(struct e1000_hw *hw,
5568 DEBUGFUNC("e1000_check_polarity");
5570 if(hw->phy_type == e1000_phy_m88) {
5571 /* return the Polarity bit in the Status register. */
5572 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_STATUS,
5576 *polarity = (phy_data & M88E1000_PSSR_REV_POLARITY) >>
5577 M88E1000_PSSR_REV_POLARITY_SHIFT;
5578 } else if(hw->phy_type == e1000_phy_igp ||
5579 hw->phy_type == e1000_phy_igp_2) {
5580 /* Read the Status register to check the speed */
5581 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_STATUS,
5586 /* If speed is 1000 Mbps, must read the IGP01E1000_PHY_PCS_INIT_REG to
5587 * find the polarity status */
5588 if((phy_data & IGP01E1000_PSSR_SPEED_MASK) ==
5589 IGP01E1000_PSSR_SPEED_1000MBPS) {
5591 /* Read the GIG initialization PCS register (0x00B4) */
5592 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PCS_INIT_REG,
5597 /* Check the polarity bits */
5598 *polarity = (phy_data & IGP01E1000_PHY_POLARITY_MASK) ? 1 : 0;
5600 /* For 10 Mbps, read the polarity bit in the status register. (for
5601 * 100 Mbps this bit is always 0) */
5602 *polarity = phy_data & IGP01E1000_PSSR_POLARITY_REVERSED;
5605 return E1000_SUCCESS;
5608 /******************************************************************************
5609 * Check if Downshift occured
5611 * hw - Struct containing variables accessed by shared code
5612 * downshift - output parameter : 0 - No Downshift ocured.
5613 * 1 - Downshift ocured.
5615 * returns: - E1000_ERR_XXX
5618 * For phy's older then IGP, this function reads the Downshift bit in the Phy
5619 * Specific Status register. For IGP phy's, it reads the Downgrade bit in the
5620 * Link Health register. In IGP this bit is latched high, so the driver must
5621 * read it immediately after link is established.
5622 *****************************************************************************/
5624 e1000_check_downshift(struct e1000_hw *hw)
5629 DEBUGFUNC("e1000_check_downshift");
5631 if(hw->phy_type == e1000_phy_igp ||
5632 hw->phy_type == e1000_phy_igp_2) {
5633 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_LINK_HEALTH,
5638 hw->speed_downgraded = (phy_data & IGP01E1000_PLHR_SS_DOWNGRADE) ? 1 : 0;
5639 } else if(hw->phy_type == e1000_phy_m88) {
5640 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_SPEC_STATUS,
5645 hw->speed_downgraded = (phy_data & M88E1000_PSSR_DOWNSHIFT) >>
5646 M88E1000_PSSR_DOWNSHIFT_SHIFT;
5649 return E1000_SUCCESS;
5652 /*****************************************************************************
5654 * 82541_rev_2 & 82547_rev_2 have the capability to configure the DSP when a
5655 * gigabit link is achieved to improve link quality.
5657 * hw: Struct containing variables accessed by shared code
5659 * returns: - E1000_ERR_PHY if fail to read/write the PHY
5660 * E1000_SUCCESS at any other case.
5662 ****************************************************************************/
5665 e1000_config_dsp_after_link_change(struct e1000_hw *hw,
5669 uint16_t phy_data, phy_saved_data, speed, duplex, i;
5670 uint16_t dsp_reg_array[IGP01E1000_PHY_CHANNEL_NUM] =
5671 {IGP01E1000_PHY_AGC_PARAM_A,
5672 IGP01E1000_PHY_AGC_PARAM_B,
5673 IGP01E1000_PHY_AGC_PARAM_C,
5674 IGP01E1000_PHY_AGC_PARAM_D};
5675 uint16_t min_length, max_length;
5677 DEBUGFUNC("e1000_config_dsp_after_link_change");
5679 if(hw->phy_type != e1000_phy_igp)
5680 return E1000_SUCCESS;
5683 ret_val = e1000_get_speed_and_duplex(hw, &speed, &duplex);
5685 DEBUGOUT("Error getting link speed and duplex\n");
5689 if(speed == SPEED_1000) {
5691 e1000_get_cable_length(hw, &min_length, &max_length);
5693 if((hw->dsp_config_state == e1000_dsp_config_enabled) &&
5694 min_length >= e1000_igp_cable_length_50) {
5696 for(i = 0; i < IGP01E1000_PHY_CHANNEL_NUM; i++) {
5697 ret_val = e1000_read_phy_reg(hw, dsp_reg_array[i],
5702 phy_data &= ~IGP01E1000_PHY_EDAC_MU_INDEX;
5704 ret_val = e1000_write_phy_reg(hw, dsp_reg_array[i],
5709 hw->dsp_config_state = e1000_dsp_config_activated;
5712 if((hw->ffe_config_state == e1000_ffe_config_enabled) &&
5713 (min_length < e1000_igp_cable_length_50)) {
5715 uint16_t ffe_idle_err_timeout = FFE_IDLE_ERR_COUNT_TIMEOUT_20;
5716 uint32_t idle_errs = 0;
5718 /* clear previous idle error counts */
5719 ret_val = e1000_read_phy_reg(hw, PHY_1000T_STATUS,
5724 for(i = 0; i < ffe_idle_err_timeout; i++) {
5726 ret_val = e1000_read_phy_reg(hw, PHY_1000T_STATUS,
5731 idle_errs += (phy_data & SR_1000T_IDLE_ERROR_CNT);
5732 if(idle_errs > SR_1000T_PHY_EXCESSIVE_IDLE_ERR_COUNT) {
5733 hw->ffe_config_state = e1000_ffe_config_active;
5735 ret_val = e1000_write_phy_reg(hw,
5736 IGP01E1000_PHY_DSP_FFE,
5737 IGP01E1000_PHY_DSP_FFE_CM_CP);
5744 ffe_idle_err_timeout = FFE_IDLE_ERR_COUNT_TIMEOUT_100;
5749 if(hw->dsp_config_state == e1000_dsp_config_activated) {
5750 /* Save off the current value of register 0x2F5B to be restored at
5751 * the end of the routines. */
5752 ret_val = e1000_read_phy_reg(hw, 0x2F5B, &phy_saved_data);
5757 /* Disable the PHY transmitter */
5758 ret_val = e1000_write_phy_reg(hw, 0x2F5B, 0x0003);
5765 ret_val = e1000_write_phy_reg(hw, 0x0000,
5766 IGP01E1000_IEEE_FORCE_GIGA);
5769 for(i = 0; i < IGP01E1000_PHY_CHANNEL_NUM; i++) {
5770 ret_val = e1000_read_phy_reg(hw, dsp_reg_array[i], &phy_data);
5774 phy_data &= ~IGP01E1000_PHY_EDAC_MU_INDEX;
5775 phy_data |= IGP01E1000_PHY_EDAC_SIGN_EXT_9_BITS;
5777 ret_val = e1000_write_phy_reg(hw,dsp_reg_array[i], phy_data);
5782 ret_val = e1000_write_phy_reg(hw, 0x0000,
5783 IGP01E1000_IEEE_RESTART_AUTONEG);
5789 /* Now enable the transmitter */
5790 ret_val = e1000_write_phy_reg(hw, 0x2F5B, phy_saved_data);
5795 hw->dsp_config_state = e1000_dsp_config_enabled;
5798 if(hw->ffe_config_state == e1000_ffe_config_active) {
5799 /* Save off the current value of register 0x2F5B to be restored at
5800 * the end of the routines. */
5801 ret_val = e1000_read_phy_reg(hw, 0x2F5B, &phy_saved_data);
5806 /* Disable the PHY transmitter */
5807 ret_val = e1000_write_phy_reg(hw, 0x2F5B, 0x0003);
5814 ret_val = e1000_write_phy_reg(hw, 0x0000,
5815 IGP01E1000_IEEE_FORCE_GIGA);
5818 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_DSP_FFE,
5819 IGP01E1000_PHY_DSP_FFE_DEFAULT);
5823 ret_val = e1000_write_phy_reg(hw, 0x0000,
5824 IGP01E1000_IEEE_RESTART_AUTONEG);
5830 /* Now enable the transmitter */
5831 ret_val = e1000_write_phy_reg(hw, 0x2F5B, phy_saved_data);
5836 hw->ffe_config_state = e1000_ffe_config_enabled;
5839 return E1000_SUCCESS;
5842 /*****************************************************************************
5843 * Set PHY to class A mode
5844 * Assumes the following operations will follow to enable the new class mode.
5845 * 1. Do a PHY soft reset
5846 * 2. Restart auto-negotiation or force link.
5848 * hw - Struct containing variables accessed by shared code
5849 ****************************************************************************/
5851 e1000_set_phy_mode(struct e1000_hw *hw)
5854 uint16_t eeprom_data;
5856 DEBUGFUNC("e1000_set_phy_mode");
5858 if((hw->mac_type == e1000_82545_rev_3) &&
5859 (hw->media_type == e1000_media_type_copper)) {
5860 ret_val = e1000_read_eeprom(hw, EEPROM_PHY_CLASS_WORD, 1, &eeprom_data);
5865 if((eeprom_data != EEPROM_RESERVED_WORD) &&
5866 (eeprom_data & EEPROM_PHY_CLASS_A)) {
5867 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x000B);
5870 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, 0x8104);
5874 hw->phy_reset_disable = FALSE;
5878 return E1000_SUCCESS;
5881 /*****************************************************************************
5883 * This function sets the lplu state according to the active flag. When
5884 * activating lplu this function also disables smart speed and vise versa.
5885 * lplu will not be activated unless the device autonegotiation advertisment
5886 * meets standards of either 10 or 10/100 or 10/100/1000 at all duplexes.
5887 * hw: Struct containing variables accessed by shared code
5888 * active - true to enable lplu false to disable lplu.
5890 * returns: - E1000_ERR_PHY if fail to read/write the PHY
5891 * E1000_SUCCESS at any other case.
5893 ****************************************************************************/
5896 e1000_set_d3_lplu_state(struct e1000_hw *hw,
5901 DEBUGFUNC("e1000_set_d3_lplu_state");
5903 if(hw->phy_type != e1000_phy_igp && hw->phy_type != e1000_phy_igp_2)
5904 return E1000_SUCCESS;
5906 /* During driver activity LPLU should not be used or it will attain link
5907 * from the lowest speeds starting from 10Mbps. The capability is used for
5908 * Dx transitions and states */
5909 if(hw->mac_type == e1000_82541_rev_2 || hw->mac_type == e1000_82547_rev_2) {
5910 ret_val = e1000_read_phy_reg(hw, IGP01E1000_GMII_FIFO, &phy_data);
5914 ret_val = e1000_read_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT, &phy_data);
5920 if(hw->mac_type == e1000_82541_rev_2 ||
5921 hw->mac_type == e1000_82547_rev_2) {
5922 phy_data &= ~IGP01E1000_GMII_FLEX_SPD;
5923 ret_val = e1000_write_phy_reg(hw, IGP01E1000_GMII_FIFO, phy_data);
5927 phy_data &= ~IGP02E1000_PM_D3_LPLU;
5928 ret_val = e1000_write_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT,
5934 /* LPLU and SmartSpeed are mutually exclusive. LPLU is used during
5935 * Dx states where the power conservation is most important. During
5936 * driver activity we should enable SmartSpeed, so performance is
5938 if (hw->smart_speed == e1000_smart_speed_on) {
5939 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
5944 phy_data |= IGP01E1000_PSCFR_SMART_SPEED;
5945 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
5949 } else if (hw->smart_speed == e1000_smart_speed_off) {
5950 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
5955 phy_data &= ~IGP01E1000_PSCFR_SMART_SPEED;
5956 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
5962 } else if((hw->autoneg_advertised == AUTONEG_ADVERTISE_SPEED_DEFAULT) ||
5963 (hw->autoneg_advertised == AUTONEG_ADVERTISE_10_ALL ) ||
5964 (hw->autoneg_advertised == AUTONEG_ADVERTISE_10_100_ALL)) {
5966 if(hw->mac_type == e1000_82541_rev_2 ||
5967 hw->mac_type == e1000_82547_rev_2) {
5968 phy_data |= IGP01E1000_GMII_FLEX_SPD;
5969 ret_val = e1000_write_phy_reg(hw, IGP01E1000_GMII_FIFO, phy_data);
5973 phy_data |= IGP02E1000_PM_D3_LPLU;
5974 ret_val = e1000_write_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT,
5980 /* When LPLU is enabled we should disable SmartSpeed */
5981 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG, &phy_data);
5985 phy_data &= ~IGP01E1000_PSCFR_SMART_SPEED;
5986 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG, phy_data);
5991 return E1000_SUCCESS;
5994 /*****************************************************************************
5996 * This function sets the lplu d0 state according to the active flag. When
5997 * activating lplu this function also disables smart speed and vise versa.
5998 * lplu will not be activated unless the device autonegotiation advertisment
5999 * meets standards of either 10 or 10/100 or 10/100/1000 at all duplexes.
6000 * hw: Struct containing variables accessed by shared code
6001 * active - true to enable lplu false to disable lplu.
6003 * returns: - E1000_ERR_PHY if fail to read/write the PHY
6004 * E1000_SUCCESS at any other case.
6006 ****************************************************************************/
6009 e1000_set_d0_lplu_state(struct e1000_hw *hw,
6014 DEBUGFUNC("e1000_set_d0_lplu_state");
6016 if(hw->mac_type <= e1000_82547_rev_2)
6017 return E1000_SUCCESS;
6019 ret_val = e1000_read_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT, &phy_data);
6024 phy_data &= ~IGP02E1000_PM_D0_LPLU;
6025 ret_val = e1000_write_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT, phy_data);
6029 /* LPLU and SmartSpeed are mutually exclusive. LPLU is used during
6030 * Dx states where the power conservation is most important. During
6031 * driver activity we should enable SmartSpeed, so performance is
6033 if (hw->smart_speed == e1000_smart_speed_on) {
6034 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
6039 phy_data |= IGP01E1000_PSCFR_SMART_SPEED;
6040 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
6044 } else if (hw->smart_speed == e1000_smart_speed_off) {
6045 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
6050 phy_data &= ~IGP01E1000_PSCFR_SMART_SPEED;
6051 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG,
6060 phy_data |= IGP02E1000_PM_D0_LPLU;
6061 ret_val = e1000_write_phy_reg(hw, IGP02E1000_PHY_POWER_MGMT, phy_data);
6065 /* When LPLU is enabled we should disable SmartSpeed */
6066 ret_val = e1000_read_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG, &phy_data);
6070 phy_data &= ~IGP01E1000_PSCFR_SMART_SPEED;
6071 ret_val = e1000_write_phy_reg(hw, IGP01E1000_PHY_PORT_CONFIG, phy_data);
6076 return E1000_SUCCESS;
6079 /******************************************************************************
6080 * Change VCO speed register to improve Bit Error Rate performance of SERDES.
6082 * hw - Struct containing variables accessed by shared code
6083 *****************************************************************************/
6085 e1000_set_vco_speed(struct e1000_hw *hw)
6088 uint16_t default_page = 0;
6091 DEBUGFUNC("e1000_set_vco_speed");
6093 switch(hw->mac_type) {
6094 case e1000_82545_rev_3:
6095 case e1000_82546_rev_3:
6098 return E1000_SUCCESS;
6101 /* Set PHY register 30, page 5, bit 8 to 0 */
6103 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, &default_page);
6107 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0005);
6111 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, &phy_data);
6115 phy_data &= ~M88E1000_PHY_VCO_REG_BIT8;
6116 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, phy_data);
6120 /* Set PHY register 30, page 4, bit 11 to 1 */
6122 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0004);
6126 ret_val = e1000_read_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, &phy_data);
6130 phy_data |= M88E1000_PHY_VCO_REG_BIT11;
6131 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, phy_data);
6135 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, default_page);
6139 return E1000_SUCCESS;
6143 /*****************************************************************************
6144 * This function reads the cookie from ARC ram.
6146 * returns: - E1000_SUCCESS .
6147 ****************************************************************************/
6149 e1000_host_if_read_cookie(struct e1000_hw * hw, uint8_t *buffer)
6152 uint32_t offset = E1000_MNG_DHCP_COOKIE_OFFSET;
6153 uint8_t length = E1000_MNG_DHCP_COOKIE_LENGTH;
6155 length = (length >> 2);
6156 offset = (offset >> 2);
6158 for (i = 0; i < length; i++) {
6159 *((uint32_t *) buffer + i) =
6160 E1000_READ_REG_ARRAY_DWORD(hw, HOST_IF, offset + i);
6162 return E1000_SUCCESS;
6166 /*****************************************************************************
6167 * This function checks whether the HOST IF is enabled for command operaton
6168 * and also checks whether the previous command is completed.
6169 * It busy waits in case of previous command is not completed.
6171 * returns: - E1000_ERR_HOST_INTERFACE_COMMAND in case if is not ready or
6173 * - E1000_SUCCESS for success.
6174 ****************************************************************************/
6176 e1000_mng_enable_host_if(struct e1000_hw * hw)
6181 /* Check that the host interface is enabled. */
6182 hicr = E1000_READ_REG(hw, HICR);
6183 if ((hicr & E1000_HICR_EN) == 0) {
6184 DEBUGOUT("E1000_HOST_EN bit disabled.\n");
6185 return -E1000_ERR_HOST_INTERFACE_COMMAND;
6187 /* check the previous command is completed */
6188 for (i = 0; i < E1000_MNG_DHCP_COMMAND_TIMEOUT; i++) {
6189 hicr = E1000_READ_REG(hw, HICR);
6190 if (!(hicr & E1000_HICR_C))
6195 if (i == E1000_MNG_DHCP_COMMAND_TIMEOUT) {
6196 DEBUGOUT("Previous command timeout failed .\n");
6197 return -E1000_ERR_HOST_INTERFACE_COMMAND;
6199 return E1000_SUCCESS;
6202 /*****************************************************************************
6203 * This function writes the buffer content at the offset given on the host if.
6204 * It also does alignment considerations to do the writes in most efficient way.
6205 * Also fills up the sum of the buffer in *buffer parameter.
6207 * returns - E1000_SUCCESS for success.
6208 ****************************************************************************/
6210 e1000_mng_host_if_write(struct e1000_hw * hw, uint8_t *buffer,
6211 uint16_t length, uint16_t offset, uint8_t *sum)
6214 uint8_t *bufptr = buffer;
6216 uint16_t remaining, i, j, prev_bytes;
6218 /* sum = only sum of the data and it is not checksum */
6220 if (length == 0 || offset + length > E1000_HI_MAX_MNG_DATA_LENGTH) {
6221 return -E1000_ERR_PARAM;
6224 tmp = (uint8_t *)&data;
6225 prev_bytes = offset & 0x3;
6230 data = E1000_READ_REG_ARRAY_DWORD(hw, HOST_IF, offset);
6231 for (j = prev_bytes; j < sizeof(uint32_t); j++) {
6232 *(tmp + j) = *bufptr++;
6235 E1000_WRITE_REG_ARRAY_DWORD(hw, HOST_IF, offset, data);
6236 length -= j - prev_bytes;
6240 remaining = length & 0x3;
6241 length -= remaining;
6243 /* Calculate length in DWORDs */
6246 /* The device driver writes the relevant command block into the
6248 for (i = 0; i < length; i++) {
6249 for (j = 0; j < sizeof(uint32_t); j++) {
6250 *(tmp + j) = *bufptr++;
6254 E1000_WRITE_REG_ARRAY_DWORD(hw, HOST_IF, offset + i, data);
6257 for (j = 0; j < sizeof(uint32_t); j++) {
6259 *(tmp + j) = *bufptr++;
6265 E1000_WRITE_REG_ARRAY_DWORD(hw, HOST_IF, offset + i, data);
6268 return E1000_SUCCESS;
6272 /*****************************************************************************
6273 * This function writes the command header after does the checksum calculation.
6275 * returns - E1000_SUCCESS for success.
6276 ****************************************************************************/
6278 e1000_mng_write_cmd_header(struct e1000_hw * hw,
6279 struct e1000_host_mng_command_header * hdr)
6285 /* Write the whole command header structure which includes sum of
6288 uint16_t length = sizeof(struct e1000_host_mng_command_header);
6290 sum = hdr->checksum;
6293 buffer = (uint8_t *) hdr;
6298 hdr->checksum = 0 - sum;
6301 /* The device driver writes the relevant command block into the ram area. */
6302 for (i = 0; i < length; i++)
6303 E1000_WRITE_REG_ARRAY_DWORD(hw, HOST_IF, i, *((uint32_t *) hdr + i));
6305 return E1000_SUCCESS;
6309 /*****************************************************************************
6310 * This function indicates to ARC that a new command is pending which completes
6311 * one write operation by the driver.
6313 * returns - E1000_SUCCESS for success.
6314 ****************************************************************************/
6316 e1000_mng_write_commit(
6317 struct e1000_hw * hw)
6321 hicr = E1000_READ_REG(hw, HICR);
6322 /* Setting this bit tells the ARC that a new command is pending. */
6323 E1000_WRITE_REG(hw, HICR, hicr | E1000_HICR_C);
6325 return E1000_SUCCESS;
6329 /*****************************************************************************
6330 * This function checks the mode of the firmware.
6332 * returns - TRUE when the mode is IAMT or FALSE.
6333 ****************************************************************************/
6335 e1000_check_mng_mode(
6336 struct e1000_hw *hw)
6340 fwsm = E1000_READ_REG(hw, FWSM);
6342 if((fwsm & E1000_FWSM_MODE_MASK) ==
6343 (E1000_MNG_IAMT_MODE << E1000_FWSM_MODE_SHIFT))
6350 /*****************************************************************************
6351 * This function writes the dhcp info .
6352 ****************************************************************************/
6354 e1000_mng_write_dhcp_info(struct e1000_hw * hw, uint8_t *buffer,
6358 struct e1000_host_mng_command_header hdr;
6360 hdr.command_id = E1000_MNG_DHCP_TX_PAYLOAD_CMD;
6361 hdr.command_length = length;
6366 ret_val = e1000_mng_enable_host_if(hw);
6367 if (ret_val == E1000_SUCCESS) {
6368 ret_val = e1000_mng_host_if_write(hw, buffer, length, sizeof(hdr),
6370 if (ret_val == E1000_SUCCESS) {
6371 ret_val = e1000_mng_write_cmd_header(hw, &hdr);
6372 if (ret_val == E1000_SUCCESS)
6373 ret_val = e1000_mng_write_commit(hw);
6380 /*****************************************************************************
6381 * This function calculates the checksum.
6383 * returns - checksum of buffer contents.
6384 ****************************************************************************/
6386 e1000_calculate_mng_checksum(char *buffer, uint32_t length)
6394 for (i=0; i < length; i++)
6397 return (uint8_t) (0 - sum);
6400 /*****************************************************************************
6401 * This function checks whether tx pkt filtering needs to be enabled or not.
6403 * returns - TRUE for packet filtering or FALSE.
6404 ****************************************************************************/
6406 e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
6408 /* called in init as well as watchdog timer functions */
6410 int32_t ret_val, checksum;
6411 boolean_t tx_filter = FALSE;
6412 struct e1000_host_mng_dhcp_cookie *hdr = &(hw->mng_cookie);
6413 uint8_t *buffer = (uint8_t *) &(hw->mng_cookie);
6415 if (e1000_check_mng_mode(hw)) {
6416 ret_val = e1000_mng_enable_host_if(hw);
6417 if (ret_val == E1000_SUCCESS) {
6418 ret_val = e1000_host_if_read_cookie(hw, buffer);
6419 if (ret_val == E1000_SUCCESS) {
6420 checksum = hdr->checksum;
6422 if ((hdr->signature == E1000_IAMT_SIGNATURE) &&
6423 checksum == e1000_calculate_mng_checksum((char *)buffer,
6424 E1000_MNG_DHCP_COOKIE_LENGTH)) {
6426 E1000_MNG_DHCP_COOKIE_STATUS_PARSING_SUPPORT)
6435 hw->tx_pkt_filtering = tx_filter;
6439 /******************************************************************************
6440 * Verifies the hardware needs to allow ARPs to be processed by the host
6442 * hw - Struct containing variables accessed by shared code
6444 * returns: - TRUE/FALSE
6446 *****************************************************************************/
6448 e1000_enable_mng_pass_thru(struct e1000_hw *hw)
6451 uint32_t fwsm, factps;
6453 if (hw->asf_firmware_present) {
6454 manc = E1000_READ_REG(hw, MANC);
6456 if (!(manc & E1000_MANC_RCV_TCO_EN) ||
6457 !(manc & E1000_MANC_EN_MAC_ADDR_FILTER))
6459 if (e1000_arc_subsystem_valid(hw) == TRUE) {
6460 fwsm = E1000_READ_REG(hw, FWSM);
6461 factps = E1000_READ_REG(hw, FACTPS);
6463 if (((fwsm & E1000_FWSM_MODE_MASK) ==
6464 (e1000_mng_mode_pt << E1000_FWSM_MODE_SHIFT)) &&
6465 (factps & E1000_FACTPS_MNGCG))
6468 if ((manc & E1000_MANC_SMBUS_EN) && !(manc & E1000_MANC_ASF_EN))
6475 e1000_polarity_reversal_workaround(struct e1000_hw *hw)
6478 uint16_t mii_status_reg;
6481 /* Polarity reversal workaround for forced 10F/10H links. */
6483 /* Disable the transmitter on the PHY */
6485 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0019);
6488 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, 0xFFFF);
6492 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0000);
6496 /* This loop will early-out if the NO link condition has been met. */
6497 for(i = PHY_FORCE_TIME; i > 0; i--) {
6498 /* Read the MII Status Register and wait for Link Status bit
6502 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
6506 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
6510 if((mii_status_reg & ~MII_SR_LINK_STATUS) == 0) break;
6511 msec_delay_irq(100);
6514 /* Recommended delay time after link has been lost */
6515 msec_delay_irq(1000);
6517 /* Now we will re-enable th transmitter on the PHY */
6519 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0019);
6523 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, 0xFFF0);
6527 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, 0xFF00);
6531 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_GEN_CONTROL, 0x0000);
6535 ret_val = e1000_write_phy_reg(hw, M88E1000_PHY_PAGE_SELECT, 0x0000);
6539 /* This loop will early-out if the link condition has been met. */
6540 for(i = PHY_FORCE_TIME; i > 0; i--) {
6541 /* Read the MII Status Register and wait for Link Status bit
6545 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
6549 ret_val = e1000_read_phy_reg(hw, PHY_STATUS, &mii_status_reg);
6553 if(mii_status_reg & MII_SR_LINK_STATUS) break;
6554 msec_delay_irq(100);
6556 return E1000_SUCCESS;
6559 /***************************************************************************
6561 * Disables PCI-Express master access.
6563 * hw: Struct containing variables accessed by shared code
6567 ***************************************************************************/
6569 e1000_set_pci_express_master_disable(struct e1000_hw *hw)
6573 DEBUGFUNC("e1000_set_pci_express_master_disable");
6575 if (hw->bus_type != e1000_bus_type_pci_express)
6578 ctrl = E1000_READ_REG(hw, CTRL);
6579 ctrl |= E1000_CTRL_GIO_MASTER_DISABLE;
6580 E1000_WRITE_REG(hw, CTRL, ctrl);
6584 /***************************************************************************
6586 * Enables PCI-Express master access.
6588 * hw: Struct containing variables accessed by shared code
6592 ***************************************************************************/
6594 e1000_enable_pciex_master(struct e1000_hw *hw)
6598 DEBUGFUNC("e1000_enable_pciex_master");
6600 if (hw->bus_type != e1000_bus_type_pci_express)
6603 ctrl = E1000_READ_REG(hw, CTRL);
6604 ctrl &= ~E1000_CTRL_GIO_MASTER_DISABLE;
6605 E1000_WRITE_REG(hw, CTRL, ctrl);
6609 /*******************************************************************************
6611 * Disables PCI-Express master access and verifies there are no pending requests
6613 * hw: Struct containing variables accessed by shared code
6615 * returns: - E1000_ERR_MASTER_REQUESTS_PENDING if master disable bit hasn't
6616 * caused the master requests to be disabled.
6617 * E1000_SUCCESS master requests disabled.
6619 ******************************************************************************/
6621 e1000_disable_pciex_master(struct e1000_hw *hw)
6623 int32_t timeout = MASTER_DISABLE_TIMEOUT; /* 80ms */
6625 DEBUGFUNC("e1000_disable_pciex_master");
6627 if (hw->bus_type != e1000_bus_type_pci_express)
6628 return E1000_SUCCESS;
6630 e1000_set_pci_express_master_disable(hw);
6633 if(!(E1000_READ_REG(hw, STATUS) & E1000_STATUS_GIO_MASTER_ENABLE))
6641 DEBUGOUT("Master requests are pending.\n");
6642 return -E1000_ERR_MASTER_REQUESTS_PENDING;
6645 return E1000_SUCCESS;
6648 /*******************************************************************************
6650 * Check for EEPROM Auto Read bit done.
6652 * hw: Struct containing variables accessed by shared code
6654 * returns: - E1000_ERR_RESET if fail to reset MAC
6655 * E1000_SUCCESS at any other case.
6657 ******************************************************************************/
6659 e1000_get_auto_rd_done(struct e1000_hw *hw)
6661 int32_t timeout = AUTO_READ_DONE_TIMEOUT;
6663 DEBUGFUNC("e1000_get_auto_rd_done");
6665 switch (hw->mac_type) {
6673 if (E1000_READ_REG(hw, EECD) & E1000_EECD_AUTO_RD) break;
6679 DEBUGOUT("Auto read by HW from EEPROM has not completed.\n");
6680 return -E1000_ERR_RESET;
6685 /* PHY configuration from NVM just starts after EECD_AUTO_RD sets to high.
6686 * Need to wait for PHY configuration completion before accessing NVM
6688 if (hw->mac_type == e1000_82573)
6691 return E1000_SUCCESS;
6694 /***************************************************************************
6695 * Checks if the PHY configuration is done
6697 * hw: Struct containing variables accessed by shared code
6699 * returns: - E1000_ERR_RESET if fail to reset MAC
6700 * E1000_SUCCESS at any other case.
6702 ***************************************************************************/
6704 e1000_get_phy_cfg_done(struct e1000_hw *hw)
6706 int32_t timeout = PHY_CFG_TIMEOUT;
6707 uint32_t cfg_mask = E1000_EEPROM_CFG_DONE;
6709 DEBUGFUNC("e1000_get_phy_cfg_done");
6711 switch (hw->mac_type) {
6718 if (E1000_READ_REG(hw, EEMNGCTL) & cfg_mask)
6726 DEBUGOUT("MNG configuration cycle has not completed.\n");
6727 return -E1000_ERR_RESET;
6732 /* PHY configuration from NVM just starts after EECD_AUTO_RD sets to high.
6733 * Need to wait for PHY configuration completion before accessing NVM
6735 if (hw->mac_type == e1000_82573)
6738 return E1000_SUCCESS;
6741 /***************************************************************************
6743 * Using the combination of SMBI and SWESMBI semaphore bits when resetting
6744 * adapter or Eeprom access.
6746 * hw: Struct containing variables accessed by shared code
6748 * returns: - E1000_ERR_EEPROM if fail to access EEPROM.
6749 * E1000_SUCCESS at any other case.
6751 ***************************************************************************/
6753 e1000_get_hw_eeprom_semaphore(struct e1000_hw *hw)
6758 DEBUGFUNC("e1000_get_hw_eeprom_semaphore");
6760 if(!hw->eeprom_semaphore_present)
6761 return E1000_SUCCESS;
6764 /* Get the FW semaphore. */
6765 timeout = hw->eeprom.word_size + 1;
6767 swsm = E1000_READ_REG(hw, SWSM);
6768 swsm |= E1000_SWSM_SWESMBI;
6769 E1000_WRITE_REG(hw, SWSM, swsm);
6770 /* if we managed to set the bit we got the semaphore. */
6771 swsm = E1000_READ_REG(hw, SWSM);
6772 if(swsm & E1000_SWSM_SWESMBI)
6780 /* Release semaphores */
6781 e1000_put_hw_eeprom_semaphore(hw);
6782 DEBUGOUT("Driver can't access the Eeprom - SWESMBI bit is set.\n");
6783 return -E1000_ERR_EEPROM;
6786 return E1000_SUCCESS;
6789 /***************************************************************************
6790 * This function clears HW semaphore bits.
6792 * hw: Struct containing variables accessed by shared code
6796 ***************************************************************************/
6798 e1000_put_hw_eeprom_semaphore(struct e1000_hw *hw)
6802 DEBUGFUNC("e1000_put_hw_eeprom_semaphore");
6804 if(!hw->eeprom_semaphore_present)
6807 swsm = E1000_READ_REG(hw, SWSM);
6808 swsm &= ~(E1000_SWSM_SWESMBI);
6809 E1000_WRITE_REG(hw, SWSM, swsm);
6812 /******************************************************************************
6813 * Checks if PHY reset is blocked due to SOL/IDER session, for example.
6814 * Returning E1000_BLK_PHY_RESET isn't necessarily an error. But it's up to
6815 * the caller to figure out how to deal with it.
6817 * hw - Struct containing variables accessed by shared code
6819 * returns: - E1000_BLK_PHY_RESET
6822 *****************************************************************************/
6824 e1000_check_phy_reset_block(struct e1000_hw *hw)
6827 if(hw->mac_type > e1000_82547_rev_2)
6828 manc = E1000_READ_REG(hw, MANC);
6829 return (manc & E1000_MANC_BLK_PHY_RST_ON_IDE) ?
6830 E1000_BLK_PHY_RESET : E1000_SUCCESS;
6834 e1000_arc_subsystem_valid(struct e1000_hw *hw)
6838 /* On 8257x silicon, registers in the range of 0x8800 - 0x8FFC
6839 * may not be provided a DMA clock when no manageability features are
6840 * enabled. We do not want to perform any reads/writes to these registers
6841 * if this is the case. We read FWSM to determine the manageability mode.
6843 switch (hw->mac_type) {
6847 fwsm = E1000_READ_REG(hw, FWSM);
6848 if((fwsm & E1000_FWSM_MODE_MASK) != 0)