1 /*******************************************************************************
3 Intel PRO/10GbE Linux driver
4 Copyright(c) 1999 - 2006 Intel Corporation.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
23 Linux NICS <linux.nics@intel.com>
24 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
30 * Shared functions for accessing and configuring the adapter
36 /* Local function prototypes */
38 static uint32_t ixgb_hash_mc_addr(struct ixgb_hw *hw, uint8_t * mc_addr);
40 static void ixgb_mta_set(struct ixgb_hw *hw, uint32_t hash_value);
42 static void ixgb_get_bus_info(struct ixgb_hw *hw);
44 static boolean_t ixgb_link_reset(struct ixgb_hw *hw);
46 static void ixgb_optics_reset(struct ixgb_hw *hw);
48 static void ixgb_optics_reset_bcm(struct ixgb_hw *hw);
50 static ixgb_phy_type ixgb_identify_phy(struct ixgb_hw *hw);
52 static void ixgb_clear_hw_cntrs(struct ixgb_hw *hw);
54 static void ixgb_clear_vfta(struct ixgb_hw *hw);
56 static void ixgb_init_rx_addrs(struct ixgb_hw *hw);
58 static uint16_t ixgb_read_phy_reg(struct ixgb_hw *hw,
61 uint32_t device_type);
63 static boolean_t ixgb_setup_fc(struct ixgb_hw *hw);
65 static boolean_t mac_addr_valid(uint8_t *mac_addr);
67 static uint32_t ixgb_mac_reset(struct ixgb_hw *hw)
71 ctrl_reg = IXGB_CTRL0_RST |
72 IXGB_CTRL0_SDP3_DIR | /* All pins are Output=1 */
76 IXGB_CTRL0_SDP3 | /* Initial value 1101 */
81 /* Workaround for 82597EX reset errata */
82 IXGB_WRITE_REG_IO(hw, CTRL0, ctrl_reg);
84 IXGB_WRITE_REG(hw, CTRL0, ctrl_reg);
87 /* Delay a few ms just to allow the reset to complete */
88 msleep(IXGB_DELAY_AFTER_RESET);
89 ctrl_reg = IXGB_READ_REG(hw, CTRL0);
91 /* Make sure the self-clearing global reset bit did self clear */
92 ASSERT(!(ctrl_reg & IXGB_CTRL0_RST));
95 if (hw->subsystem_vendor_id == SUN_SUBVENDOR_ID) {
96 ctrl_reg = /* Enable interrupt from XFP and SerDes */
102 IXGB_WRITE_REG(hw, CTRL1, ctrl_reg);
103 ixgb_optics_reset_bcm(hw);
106 if (hw->phy_type == ixgb_phy_type_txn17401)
107 ixgb_optics_reset(hw);
112 /******************************************************************************
113 * Reset the transmit and receive units; mask and clear all interrupts.
115 * hw - Struct containing variables accessed by shared code
116 *****************************************************************************/
118 ixgb_adapter_stop(struct ixgb_hw *hw)
123 DEBUGFUNC("ixgb_adapter_stop");
125 /* If we are stopped or resetting exit gracefully and wait to be
126 * started again before accessing the hardware.
128 if(hw->adapter_stopped) {
129 DEBUGOUT("Exiting because the adapter is already stopped!!!\n");
133 /* Set the Adapter Stopped flag so other driver functions stop
134 * touching the Hardware.
136 hw->adapter_stopped = TRUE;
138 /* Clear interrupt mask to stop board from generating interrupts */
139 DEBUGOUT("Masking off all interrupts\n");
140 IXGB_WRITE_REG(hw, IMC, 0xFFFFFFFF);
142 /* Disable the Transmit and Receive units. Then delay to allow
143 * any pending transactions to complete before we hit the MAC with
146 IXGB_WRITE_REG(hw, RCTL, IXGB_READ_REG(hw, RCTL) & ~IXGB_RCTL_RXEN);
147 IXGB_WRITE_REG(hw, TCTL, IXGB_READ_REG(hw, TCTL) & ~IXGB_TCTL_TXEN);
148 msleep(IXGB_DELAY_BEFORE_RESET);
150 /* Issue a global reset to the MAC. This will reset the chip's
151 * transmit, receive, DMA, and link units. It will not effect
152 * the current PCI configuration. The global reset bit is self-
153 * clearing, and should clear within a microsecond.
155 DEBUGOUT("Issuing a global reset to MAC\n");
157 ctrl_reg = ixgb_mac_reset(hw);
159 /* Clear interrupt mask to stop board from generating interrupts */
160 DEBUGOUT("Masking off all interrupts\n");
161 IXGB_WRITE_REG(hw, IMC, 0xffffffff);
163 /* Clear any pending interrupt events. */
164 icr_reg = IXGB_READ_REG(hw, ICR);
166 return (ctrl_reg & IXGB_CTRL0_RST);
170 /******************************************************************************
171 * Identifies the vendor of the optics module on the adapter. The SR adapters
172 * support two different types of XPAK optics, so it is necessary to determine
173 * which optics are present before applying any optics-specific workarounds.
175 * hw - Struct containing variables accessed by shared code.
177 * Returns: the vendor of the XPAK optics module.
178 *****************************************************************************/
179 static ixgb_xpak_vendor
180 ixgb_identify_xpak_vendor(struct ixgb_hw *hw)
183 uint16_t vendor_name[5];
184 ixgb_xpak_vendor xpak_vendor;
186 DEBUGFUNC("ixgb_identify_xpak_vendor");
188 /* Read the first few bytes of the vendor string from the XPAK NVR
189 * registers. These are standard XENPAK/XPAK registers, so all XPAK
190 * devices should implement them. */
191 for (i = 0; i < 5; i++) {
192 vendor_name[i] = ixgb_read_phy_reg(hw,
193 MDIO_PMA_PMD_XPAK_VENDOR_NAME
194 + i, IXGB_PHY_ADDRESS,
198 /* Determine the actual vendor */
199 if (vendor_name[0] == 'I' &&
200 vendor_name[1] == 'N' &&
201 vendor_name[2] == 'T' &&
202 vendor_name[3] == 'E' && vendor_name[4] == 'L') {
203 xpak_vendor = ixgb_xpak_vendor_intel;
205 xpak_vendor = ixgb_xpak_vendor_infineon;
208 return (xpak_vendor);
211 /******************************************************************************
212 * Determine the physical layer module on the adapter.
214 * hw - Struct containing variables accessed by shared code. The device_id
215 * field must be (correctly) populated before calling this routine.
217 * Returns: the phy type of the adapter.
218 *****************************************************************************/
220 ixgb_identify_phy(struct ixgb_hw *hw)
222 ixgb_phy_type phy_type;
223 ixgb_xpak_vendor xpak_vendor;
225 DEBUGFUNC("ixgb_identify_phy");
227 /* Infer the transceiver/phy type from the device id */
228 switch (hw->device_id) {
229 case IXGB_DEVICE_ID_82597EX:
230 DEBUGOUT("Identified TXN17401 optics\n");
231 phy_type = ixgb_phy_type_txn17401;
234 case IXGB_DEVICE_ID_82597EX_SR:
235 /* The SR adapters carry two different types of XPAK optics
236 * modules; read the vendor identifier to determine the exact
238 xpak_vendor = ixgb_identify_xpak_vendor(hw);
239 if (xpak_vendor == ixgb_xpak_vendor_intel) {
240 DEBUGOUT("Identified TXN17201 optics\n");
241 phy_type = ixgb_phy_type_txn17201;
243 DEBUGOUT("Identified G6005 optics\n");
244 phy_type = ixgb_phy_type_g6005;
247 case IXGB_DEVICE_ID_82597EX_LR:
248 DEBUGOUT("Identified G6104 optics\n");
249 phy_type = ixgb_phy_type_g6104;
251 case IXGB_DEVICE_ID_82597EX_CX4:
252 DEBUGOUT("Identified CX4\n");
253 xpak_vendor = ixgb_identify_xpak_vendor(hw);
254 if (xpak_vendor == ixgb_xpak_vendor_intel) {
255 DEBUGOUT("Identified TXN17201 optics\n");
256 phy_type = ixgb_phy_type_txn17201;
258 DEBUGOUT("Identified G6005 optics\n");
259 phy_type = ixgb_phy_type_g6005;
263 DEBUGOUT("Unknown physical layer module\n");
264 phy_type = ixgb_phy_type_unknown;
268 /* update phy type for sun specific board */
269 if (hw->subsystem_vendor_id == SUN_SUBVENDOR_ID)
270 phy_type = ixgb_phy_type_bcm;
275 /******************************************************************************
276 * Performs basic configuration of the adapter.
278 * hw - Struct containing variables accessed by shared code
280 * Resets the controller.
281 * Reads and validates the EEPROM.
282 * Initializes the receive address registers.
283 * Initializes the multicast table.
284 * Clears all on-chip counters.
285 * Calls routine to setup flow control settings.
286 * Leaves the transmit and receive units disabled and uninitialized.
289 * TRUE if successful,
290 * FALSE if unrecoverable problems were encountered.
291 *****************************************************************************/
293 ixgb_init_hw(struct ixgb_hw *hw)
299 DEBUGFUNC("ixgb_init_hw");
301 /* Issue a global reset to the MAC. This will reset the chip's
302 * transmit, receive, DMA, and link units. It will not effect
303 * the current PCI configuration. The global reset bit is self-
304 * clearing, and should clear within a microsecond.
306 DEBUGOUT("Issuing a global reset to MAC\n");
308 ctrl_reg = ixgb_mac_reset(hw);
310 DEBUGOUT("Issuing an EE reset to MAC\n");
312 /* Workaround for 82597EX reset errata */
313 IXGB_WRITE_REG_IO(hw, CTRL1, IXGB_CTRL1_EE_RST);
315 IXGB_WRITE_REG(hw, CTRL1, IXGB_CTRL1_EE_RST);
318 /* Delay a few ms just to allow the reset to complete */
319 msleep(IXGB_DELAY_AFTER_EE_RESET);
321 if (ixgb_get_eeprom_data(hw) == FALSE) {
325 /* Use the device id to determine the type of phy/transceiver. */
326 hw->device_id = ixgb_get_ee_device_id(hw);
327 hw->phy_type = ixgb_identify_phy(hw);
329 /* Setup the receive addresses.
330 * Receive Address Registers (RARs 0 - 15).
332 ixgb_init_rx_addrs(hw);
335 * Check that a valid MAC address has been set.
336 * If it is not valid, we fail hardware init.
338 if (!mac_addr_valid(hw->curr_mac_addr)) {
339 DEBUGOUT("MAC address invalid after ixgb_init_rx_addrs\n");
343 /* tell the routines in this file they can access hardware again */
344 hw->adapter_stopped = FALSE;
346 /* Fill in the bus_info structure */
347 ixgb_get_bus_info(hw);
349 /* Zero out the Multicast HASH table */
350 DEBUGOUT("Zeroing the MTA\n");
351 for(i = 0; i < IXGB_MC_TBL_SIZE; i++)
352 IXGB_WRITE_REG_ARRAY(hw, MTA, i, 0);
354 /* Zero out the VLAN Filter Table Array */
357 /* Zero all of the hardware counters */
358 ixgb_clear_hw_cntrs(hw);
360 /* Call a subroutine to setup flow control. */
361 status = ixgb_setup_fc(hw);
363 /* 82597EX errata: Call check-for-link in case lane deskew is locked */
364 ixgb_check_for_link(hw);
369 /******************************************************************************
370 * Initializes receive address filters.
372 * hw - Struct containing variables accessed by shared code
374 * Places the MAC address in receive address register 0 and clears the rest
375 * of the receive addresss registers. Clears the multicast table. Assumes
376 * the receiver is in reset when the routine is called.
377 *****************************************************************************/
379 ixgb_init_rx_addrs(struct ixgb_hw *hw)
383 DEBUGFUNC("ixgb_init_rx_addrs");
386 * If the current mac address is valid, assume it is a software override
387 * to the permanent address.
388 * Otherwise, use the permanent address from the eeprom.
390 if (!mac_addr_valid(hw->curr_mac_addr)) {
392 /* Get the MAC address from the eeprom for later reference */
393 ixgb_get_ee_mac_addr(hw, hw->curr_mac_addr);
395 DEBUGOUT3(" Keeping Permanent MAC Addr =%.2X %.2X %.2X ",
396 hw->curr_mac_addr[0],
397 hw->curr_mac_addr[1], hw->curr_mac_addr[2]);
398 DEBUGOUT3("%.2X %.2X %.2X\n",
399 hw->curr_mac_addr[3],
400 hw->curr_mac_addr[4], hw->curr_mac_addr[5]);
403 /* Setup the receive address. */
404 DEBUGOUT("Overriding MAC Address in RAR[0]\n");
405 DEBUGOUT3(" New MAC Addr =%.2X %.2X %.2X ",
406 hw->curr_mac_addr[0],
407 hw->curr_mac_addr[1], hw->curr_mac_addr[2]);
408 DEBUGOUT3("%.2X %.2X %.2X\n",
409 hw->curr_mac_addr[3],
410 hw->curr_mac_addr[4], hw->curr_mac_addr[5]);
412 ixgb_rar_set(hw, hw->curr_mac_addr, 0);
415 /* Zero out the other 15 receive addresses. */
416 DEBUGOUT("Clearing RAR[1-15]\n");
417 for(i = 1; i < IXGB_RAR_ENTRIES; i++) {
418 /* Write high reg first to disable the AV bit first */
419 IXGB_WRITE_REG_ARRAY(hw, RA, ((i << 1) + 1), 0);
420 IXGB_WRITE_REG_ARRAY(hw, RA, (i << 1), 0);
426 /******************************************************************************
427 * Updates the MAC's list of multicast addresses.
429 * hw - Struct containing variables accessed by shared code
430 * mc_addr_list - the list of new multicast addresses
431 * mc_addr_count - number of addresses
432 * pad - number of bytes between addresses in the list
434 * The given list replaces any existing list. Clears the last 15 receive
435 * address registers and the multicast table. Uses receive address registers
436 * for the first 15 multicast addresses, and hashes the rest into the
438 *****************************************************************************/
440 ixgb_mc_addr_list_update(struct ixgb_hw *hw,
441 uint8_t *mc_addr_list,
442 uint32_t mc_addr_count,
447 uint32_t rar_used_count = 1; /* RAR[0] is used for our MAC address */
449 DEBUGFUNC("ixgb_mc_addr_list_update");
451 /* Set the new number of MC addresses that we are being requested to use. */
452 hw->num_mc_addrs = mc_addr_count;
454 /* Clear RAR[1-15] */
455 DEBUGOUT(" Clearing RAR[1-15]\n");
456 for(i = rar_used_count; i < IXGB_RAR_ENTRIES; i++) {
457 IXGB_WRITE_REG_ARRAY(hw, RA, (i << 1), 0);
458 IXGB_WRITE_REG_ARRAY(hw, RA, ((i << 1) + 1), 0);
462 DEBUGOUT(" Clearing MTA\n");
463 for(i = 0; i < IXGB_MC_TBL_SIZE; i++) {
464 IXGB_WRITE_REG_ARRAY(hw, MTA, i, 0);
467 /* Add the new addresses */
468 for(i = 0; i < mc_addr_count; i++) {
469 DEBUGOUT(" Adding the multicast addresses:\n");
470 DEBUGOUT7(" MC Addr #%d =%.2X %.2X %.2X %.2X %.2X %.2X\n", i,
471 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad)],
472 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad) +
474 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad) +
476 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad) +
478 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad) +
480 mc_addr_list[i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad) +
483 /* Place this multicast address in the RAR if there is room, *
484 * else put it in the MTA
486 if(rar_used_count < IXGB_RAR_ENTRIES) {
489 (i * (IXGB_ETH_LENGTH_OF_ADDRESS + pad)),
491 DEBUGOUT1("Added a multicast address to RAR[%d]\n", i);
494 hash_value = ixgb_hash_mc_addr(hw,
497 (IXGB_ETH_LENGTH_OF_ADDRESS
500 DEBUGOUT1(" Hash value = 0x%03X\n", hash_value);
502 ixgb_mta_set(hw, hash_value);
506 DEBUGOUT("MC Update Complete\n");
510 /******************************************************************************
511 * Hashes an address to determine its location in the multicast table
513 * hw - Struct containing variables accessed by shared code
514 * mc_addr - the multicast address to hash
518 *****************************************************************************/
520 ixgb_hash_mc_addr(struct ixgb_hw *hw,
523 uint32_t hash_value = 0;
525 DEBUGFUNC("ixgb_hash_mc_addr");
527 /* The portion of the address that is used for the hash table is
528 * determined by the mc_filter_type setting.
530 switch (hw->mc_filter_type) {
531 /* [0] [1] [2] [3] [4] [5]
533 * LSB MSB - According to H/W docs */
535 /* [47:36] i.e. 0x563 for above example address */
537 ((mc_addr[4] >> 4) | (((uint16_t) mc_addr[5]) << 4));
539 case 1: /* [46:35] i.e. 0xAC6 for above example address */
541 ((mc_addr[4] >> 3) | (((uint16_t) mc_addr[5]) << 5));
543 case 2: /* [45:34] i.e. 0x5D8 for above example address */
545 ((mc_addr[4] >> 2) | (((uint16_t) mc_addr[5]) << 6));
547 case 3: /* [43:32] i.e. 0x634 for above example address */
548 hash_value = ((mc_addr[4]) | (((uint16_t) mc_addr[5]) << 8));
551 /* Invalid mc_filter_type, what should we do? */
552 DEBUGOUT("MC filter type param set incorrectly\n");
561 /******************************************************************************
562 * Sets the bit in the multicast table corresponding to the hash value.
564 * hw - Struct containing variables accessed by shared code
565 * hash_value - Multicast address hash value
566 *****************************************************************************/
568 ixgb_mta_set(struct ixgb_hw *hw,
571 uint32_t hash_bit, hash_reg;
574 /* The MTA is a register array of 128 32-bit registers.
575 * It is treated like an array of 4096 bits. We want to set
576 * bit BitArray[hash_value]. So we figure out what register
577 * the bit is in, read it, OR in the new bit, then write
578 * back the new value. The register is determined by the
579 * upper 7 bits of the hash value and the bit within that
580 * register are determined by the lower 5 bits of the value.
582 hash_reg = (hash_value >> 5) & 0x7F;
583 hash_bit = hash_value & 0x1F;
585 mta_reg = IXGB_READ_REG_ARRAY(hw, MTA, hash_reg);
587 mta_reg |= (1 << hash_bit);
589 IXGB_WRITE_REG_ARRAY(hw, MTA, hash_reg, mta_reg);
594 /******************************************************************************
595 * Puts an ethernet address into a receive address register.
597 * hw - Struct containing variables accessed by shared code
598 * addr - Address to put into receive address register
599 * index - Receive address register to write
600 *****************************************************************************/
602 ixgb_rar_set(struct ixgb_hw *hw,
606 uint32_t rar_low, rar_high;
608 DEBUGFUNC("ixgb_rar_set");
610 /* HW expects these in little endian so we reverse the byte order
611 * from network order (big endian) to little endian
613 rar_low = ((uint32_t) addr[0] |
614 ((uint32_t)addr[1] << 8) |
615 ((uint32_t)addr[2] << 16) |
616 ((uint32_t)addr[3] << 24));
618 rar_high = ((uint32_t) addr[4] |
619 ((uint32_t)addr[5] << 8) |
622 IXGB_WRITE_REG_ARRAY(hw, RA, (index << 1), rar_low);
623 IXGB_WRITE_REG_ARRAY(hw, RA, ((index << 1) + 1), rar_high);
627 /******************************************************************************
628 * Writes a value to the specified offset in the VLAN filter table.
630 * hw - Struct containing variables accessed by shared code
631 * offset - Offset in VLAN filer table to write
632 * value - Value to write into VLAN filter table
633 *****************************************************************************/
635 ixgb_write_vfta(struct ixgb_hw *hw,
639 IXGB_WRITE_REG_ARRAY(hw, VFTA, offset, value);
643 /******************************************************************************
644 * Clears the VLAN filer table
646 * hw - Struct containing variables accessed by shared code
647 *****************************************************************************/
649 ixgb_clear_vfta(struct ixgb_hw *hw)
653 for(offset = 0; offset < IXGB_VLAN_FILTER_TBL_SIZE; offset++)
654 IXGB_WRITE_REG_ARRAY(hw, VFTA, offset, 0);
658 /******************************************************************************
659 * Configures the flow control settings based on SW configuration.
661 * hw - Struct containing variables accessed by shared code
662 *****************************************************************************/
665 ixgb_setup_fc(struct ixgb_hw *hw)
668 uint32_t pap_reg = 0; /* by default, assume no pause time */
669 boolean_t status = TRUE;
671 DEBUGFUNC("ixgb_setup_fc");
673 /* Get the current control reg 0 settings */
674 ctrl_reg = IXGB_READ_REG(hw, CTRL0);
676 /* Clear the Receive Pause Enable and Transmit Pause Enable bits */
677 ctrl_reg &= ~(IXGB_CTRL0_RPE | IXGB_CTRL0_TPE);
679 /* The possible values of the "flow_control" parameter are:
680 * 0: Flow control is completely disabled
681 * 1: Rx flow control is enabled (we can receive pause frames
682 * but not send pause frames).
683 * 2: Tx flow control is enabled (we can send pause frames
684 * but we do not support receiving pause frames).
685 * 3: Both Rx and TX flow control (symmetric) are enabled.
688 switch (hw->fc.type) {
689 case ixgb_fc_none: /* 0 */
690 /* Set CMDC bit to disable Rx Flow control */
691 ctrl_reg |= (IXGB_CTRL0_CMDC);
693 case ixgb_fc_rx_pause: /* 1 */
694 /* RX Flow control is enabled, and TX Flow control is
697 ctrl_reg |= (IXGB_CTRL0_RPE);
699 case ixgb_fc_tx_pause: /* 2 */
700 /* TX Flow control is enabled, and RX Flow control is
701 * disabled, by a software over-ride.
703 ctrl_reg |= (IXGB_CTRL0_TPE);
704 pap_reg = hw->fc.pause_time;
706 case ixgb_fc_full: /* 3 */
707 /* Flow control (both RX and TX) is enabled by a software
710 ctrl_reg |= (IXGB_CTRL0_RPE | IXGB_CTRL0_TPE);
711 pap_reg = hw->fc.pause_time;
714 /* We should never get here. The value should be 0-3. */
715 DEBUGOUT("Flow control param set incorrectly\n");
720 /* Write the new settings */
721 IXGB_WRITE_REG(hw, CTRL0, ctrl_reg);
724 IXGB_WRITE_REG(hw, PAP, pap_reg);
727 /* Set the flow control receive threshold registers. Normally,
728 * these registers will be set to a default threshold that may be
729 * adjusted later by the driver's runtime code. However, if the
730 * ability to transmit pause frames in not enabled, then these
731 * registers will be set to 0.
733 if(!(hw->fc.type & ixgb_fc_tx_pause)) {
734 IXGB_WRITE_REG(hw, FCRTL, 0);
735 IXGB_WRITE_REG(hw, FCRTH, 0);
737 /* We need to set up the Receive Threshold high and low water
738 * marks as well as (optionally) enabling the transmission of XON
740 if(hw->fc.send_xon) {
741 IXGB_WRITE_REG(hw, FCRTL,
742 (hw->fc.low_water | IXGB_FCRTL_XONE));
744 IXGB_WRITE_REG(hw, FCRTL, hw->fc.low_water);
746 IXGB_WRITE_REG(hw, FCRTH, hw->fc.high_water);
751 /******************************************************************************
752 * Reads a word from a device over the Management Data Interface (MDI) bus.
753 * This interface is used to manage Physical layer devices.
755 * hw - Struct containing variables accessed by hw code
756 * reg_address - Offset of device register being read.
757 * phy_address - Address of device on MDI.
759 * Returns: Data word (16 bits) from MDI device.
761 * The 82597EX has support for several MDI access methods. This routine
762 * uses the new protocol MDI Single Command and Address Operation.
763 * This requires that first an address cycle command is sent, followed by a
765 *****************************************************************************/
767 ixgb_read_phy_reg(struct ixgb_hw *hw,
768 uint32_t reg_address,
769 uint32_t phy_address,
770 uint32_t device_type)
774 uint32_t command = 0;
776 ASSERT(reg_address <= IXGB_MAX_PHY_REG_ADDRESS);
777 ASSERT(phy_address <= IXGB_MAX_PHY_ADDRESS);
778 ASSERT(device_type <= IXGB_MAX_PHY_DEV_TYPE);
780 /* Setup and write the address cycle command */
781 command = ((reg_address << IXGB_MSCA_NP_ADDR_SHIFT) |
782 (device_type << IXGB_MSCA_DEV_TYPE_SHIFT) |
783 (phy_address << IXGB_MSCA_PHY_ADDR_SHIFT) |
784 (IXGB_MSCA_ADDR_CYCLE | IXGB_MSCA_MDI_COMMAND));
786 IXGB_WRITE_REG(hw, MSCA, command);
788 /**************************************************************
789 ** Check every 10 usec to see if the address cycle completed
790 ** The COMMAND bit will clear when the operation is complete.
791 ** This may take as long as 64 usecs (we'll wait 100 usecs max)
792 ** from the CPU Write to the Ready bit assertion.
793 **************************************************************/
795 for(i = 0; i < 10; i++)
799 command = IXGB_READ_REG(hw, MSCA);
801 if ((command & IXGB_MSCA_MDI_COMMAND) == 0)
805 ASSERT((command & IXGB_MSCA_MDI_COMMAND) == 0);
807 /* Address cycle complete, setup and write the read command */
808 command = ((reg_address << IXGB_MSCA_NP_ADDR_SHIFT) |
809 (device_type << IXGB_MSCA_DEV_TYPE_SHIFT) |
810 (phy_address << IXGB_MSCA_PHY_ADDR_SHIFT) |
811 (IXGB_MSCA_READ | IXGB_MSCA_MDI_COMMAND));
813 IXGB_WRITE_REG(hw, MSCA, command);
815 /**************************************************************
816 ** Check every 10 usec to see if the read command completed
817 ** The COMMAND bit will clear when the operation is complete.
818 ** The read may take as long as 64 usecs (we'll wait 100 usecs max)
819 ** from the CPU Write to the Ready bit assertion.
820 **************************************************************/
822 for(i = 0; i < 10; i++)
826 command = IXGB_READ_REG(hw, MSCA);
828 if ((command & IXGB_MSCA_MDI_COMMAND) == 0)
832 ASSERT((command & IXGB_MSCA_MDI_COMMAND) == 0);
834 /* Operation is complete, get the data from the MDIO Read/Write Data
835 * register and return.
837 data = IXGB_READ_REG(hw, MSRWD);
838 data >>= IXGB_MSRWD_READ_DATA_SHIFT;
839 return((uint16_t) data);
842 /******************************************************************************
843 * Writes a word to a device over the Management Data Interface (MDI) bus.
844 * This interface is used to manage Physical layer devices.
846 * hw - Struct containing variables accessed by hw code
847 * reg_address - Offset of device register being read.
848 * phy_address - Address of device on MDI.
849 * device_type - Also known as the Device ID or DID.
850 * data - 16-bit value to be written
854 * The 82597EX has support for several MDI access methods. This routine
855 * uses the new protocol MDI Single Command and Address Operation.
856 * This requires that first an address cycle command is sent, followed by a
858 *****************************************************************************/
860 ixgb_write_phy_reg(struct ixgb_hw *hw,
861 uint32_t reg_address,
862 uint32_t phy_address,
863 uint32_t device_type,
867 uint32_t command = 0;
869 ASSERT(reg_address <= IXGB_MAX_PHY_REG_ADDRESS);
870 ASSERT(phy_address <= IXGB_MAX_PHY_ADDRESS);
871 ASSERT(device_type <= IXGB_MAX_PHY_DEV_TYPE);
873 /* Put the data in the MDIO Read/Write Data register */
874 IXGB_WRITE_REG(hw, MSRWD, (uint32_t)data);
876 /* Setup and write the address cycle command */
877 command = ((reg_address << IXGB_MSCA_NP_ADDR_SHIFT) |
878 (device_type << IXGB_MSCA_DEV_TYPE_SHIFT) |
879 (phy_address << IXGB_MSCA_PHY_ADDR_SHIFT) |
880 (IXGB_MSCA_ADDR_CYCLE | IXGB_MSCA_MDI_COMMAND));
882 IXGB_WRITE_REG(hw, MSCA, command);
884 /**************************************************************
885 ** Check every 10 usec to see if the address cycle completed
886 ** The COMMAND bit will clear when the operation is complete.
887 ** This may take as long as 64 usecs (we'll wait 100 usecs max)
888 ** from the CPU Write to the Ready bit assertion.
889 **************************************************************/
891 for(i = 0; i < 10; i++)
895 command = IXGB_READ_REG(hw, MSCA);
897 if ((command & IXGB_MSCA_MDI_COMMAND) == 0)
901 ASSERT((command & IXGB_MSCA_MDI_COMMAND) == 0);
903 /* Address cycle complete, setup and write the write command */
904 command = ((reg_address << IXGB_MSCA_NP_ADDR_SHIFT) |
905 (device_type << IXGB_MSCA_DEV_TYPE_SHIFT) |
906 (phy_address << IXGB_MSCA_PHY_ADDR_SHIFT) |
907 (IXGB_MSCA_WRITE | IXGB_MSCA_MDI_COMMAND));
909 IXGB_WRITE_REG(hw, MSCA, command);
911 /**************************************************************
912 ** Check every 10 usec to see if the read command completed
913 ** The COMMAND bit will clear when the operation is complete.
914 ** The write may take as long as 64 usecs (we'll wait 100 usecs max)
915 ** from the CPU Write to the Ready bit assertion.
916 **************************************************************/
918 for(i = 0; i < 10; i++)
922 command = IXGB_READ_REG(hw, MSCA);
924 if ((command & IXGB_MSCA_MDI_COMMAND) == 0)
928 ASSERT((command & IXGB_MSCA_MDI_COMMAND) == 0);
930 /* Operation is complete, return. */
933 /******************************************************************************
934 * Checks to see if the link status of the hardware has changed.
936 * hw - Struct containing variables accessed by hw code
938 * Called by any function that needs to check the link status of the adapter.
939 *****************************************************************************/
941 ixgb_check_for_link(struct ixgb_hw *hw)
946 DEBUGFUNC("ixgb_check_for_link");
948 xpcss_reg = IXGB_READ_REG(hw, XPCSS);
949 status_reg = IXGB_READ_REG(hw, STATUS);
951 if ((xpcss_reg & IXGB_XPCSS_ALIGN_STATUS) &&
952 (status_reg & IXGB_STATUS_LU)) {
954 } else if (!(xpcss_reg & IXGB_XPCSS_ALIGN_STATUS) &&
955 (status_reg & IXGB_STATUS_LU)) {
956 DEBUGOUT("XPCSS Not Aligned while Status:LU is set.\n");
957 hw->link_up = ixgb_link_reset(hw);
960 * 82597EX errata. Since the lane deskew problem may prevent
961 * link, reset the link before reporting link down.
963 hw->link_up = ixgb_link_reset(hw);
965 /* Anything else for 10 Gig?? */
968 /******************************************************************************
969 * Check for a bad link condition that may have occured.
970 * The indication is that the RFC / LFC registers may be incrementing
971 * continually. A full adapter reset is required to recover.
973 * hw - Struct containing variables accessed by hw code
975 * Called by any function that needs to check the link status of the adapter.
976 *****************************************************************************/
977 boolean_t ixgb_check_for_bad_link(struct ixgb_hw *hw)
979 uint32_t newLFC, newRFC;
980 boolean_t bad_link_returncode = FALSE;
982 if (hw->phy_type == ixgb_phy_type_txn17401) {
983 newLFC = IXGB_READ_REG(hw, LFC);
984 newRFC = IXGB_READ_REG(hw, RFC);
985 if ((hw->lastLFC + 250 < newLFC)
986 || (hw->lastRFC + 250 < newRFC)) {
988 ("BAD LINK! too many LFC/RFC since last check\n");
989 bad_link_returncode = TRUE;
991 hw->lastLFC = newLFC;
992 hw->lastRFC = newRFC;
995 return bad_link_returncode;
998 /******************************************************************************
999 * Clears all hardware statistics counters.
1001 * hw - Struct containing variables accessed by shared code
1002 *****************************************************************************/
1004 ixgb_clear_hw_cntrs(struct ixgb_hw *hw)
1006 volatile uint32_t temp_reg;
1008 DEBUGFUNC("ixgb_clear_hw_cntrs");
1010 /* if we are stopped or resetting exit gracefully */
1011 if(hw->adapter_stopped) {
1012 DEBUGOUT("Exiting because the adapter is stopped!!!\n");
1016 temp_reg = IXGB_READ_REG(hw, TPRL);
1017 temp_reg = IXGB_READ_REG(hw, TPRH);
1018 temp_reg = IXGB_READ_REG(hw, GPRCL);
1019 temp_reg = IXGB_READ_REG(hw, GPRCH);
1020 temp_reg = IXGB_READ_REG(hw, BPRCL);
1021 temp_reg = IXGB_READ_REG(hw, BPRCH);
1022 temp_reg = IXGB_READ_REG(hw, MPRCL);
1023 temp_reg = IXGB_READ_REG(hw, MPRCH);
1024 temp_reg = IXGB_READ_REG(hw, UPRCL);
1025 temp_reg = IXGB_READ_REG(hw, UPRCH);
1026 temp_reg = IXGB_READ_REG(hw, VPRCL);
1027 temp_reg = IXGB_READ_REG(hw, VPRCH);
1028 temp_reg = IXGB_READ_REG(hw, JPRCL);
1029 temp_reg = IXGB_READ_REG(hw, JPRCH);
1030 temp_reg = IXGB_READ_REG(hw, GORCL);
1031 temp_reg = IXGB_READ_REG(hw, GORCH);
1032 temp_reg = IXGB_READ_REG(hw, TORL);
1033 temp_reg = IXGB_READ_REG(hw, TORH);
1034 temp_reg = IXGB_READ_REG(hw, RNBC);
1035 temp_reg = IXGB_READ_REG(hw, RUC);
1036 temp_reg = IXGB_READ_REG(hw, ROC);
1037 temp_reg = IXGB_READ_REG(hw, RLEC);
1038 temp_reg = IXGB_READ_REG(hw, CRCERRS);
1039 temp_reg = IXGB_READ_REG(hw, ICBC);
1040 temp_reg = IXGB_READ_REG(hw, ECBC);
1041 temp_reg = IXGB_READ_REG(hw, MPC);
1042 temp_reg = IXGB_READ_REG(hw, TPTL);
1043 temp_reg = IXGB_READ_REG(hw, TPTH);
1044 temp_reg = IXGB_READ_REG(hw, GPTCL);
1045 temp_reg = IXGB_READ_REG(hw, GPTCH);
1046 temp_reg = IXGB_READ_REG(hw, BPTCL);
1047 temp_reg = IXGB_READ_REG(hw, BPTCH);
1048 temp_reg = IXGB_READ_REG(hw, MPTCL);
1049 temp_reg = IXGB_READ_REG(hw, MPTCH);
1050 temp_reg = IXGB_READ_REG(hw, UPTCL);
1051 temp_reg = IXGB_READ_REG(hw, UPTCH);
1052 temp_reg = IXGB_READ_REG(hw, VPTCL);
1053 temp_reg = IXGB_READ_REG(hw, VPTCH);
1054 temp_reg = IXGB_READ_REG(hw, JPTCL);
1055 temp_reg = IXGB_READ_REG(hw, JPTCH);
1056 temp_reg = IXGB_READ_REG(hw, GOTCL);
1057 temp_reg = IXGB_READ_REG(hw, GOTCH);
1058 temp_reg = IXGB_READ_REG(hw, TOTL);
1059 temp_reg = IXGB_READ_REG(hw, TOTH);
1060 temp_reg = IXGB_READ_REG(hw, DC);
1061 temp_reg = IXGB_READ_REG(hw, PLT64C);
1062 temp_reg = IXGB_READ_REG(hw, TSCTC);
1063 temp_reg = IXGB_READ_REG(hw, TSCTFC);
1064 temp_reg = IXGB_READ_REG(hw, IBIC);
1065 temp_reg = IXGB_READ_REG(hw, RFC);
1066 temp_reg = IXGB_READ_REG(hw, LFC);
1067 temp_reg = IXGB_READ_REG(hw, PFRC);
1068 temp_reg = IXGB_READ_REG(hw, PFTC);
1069 temp_reg = IXGB_READ_REG(hw, MCFRC);
1070 temp_reg = IXGB_READ_REG(hw, MCFTC);
1071 temp_reg = IXGB_READ_REG(hw, XONRXC);
1072 temp_reg = IXGB_READ_REG(hw, XONTXC);
1073 temp_reg = IXGB_READ_REG(hw, XOFFRXC);
1074 temp_reg = IXGB_READ_REG(hw, XOFFTXC);
1075 temp_reg = IXGB_READ_REG(hw, RJC);
1079 /******************************************************************************
1080 * Turns on the software controllable LED
1082 * hw - Struct containing variables accessed by shared code
1083 *****************************************************************************/
1085 ixgb_led_on(struct ixgb_hw *hw)
1087 uint32_t ctrl0_reg = IXGB_READ_REG(hw, CTRL0);
1089 /* To turn on the LED, clear software-definable pin 0 (SDP0). */
1090 ctrl0_reg &= ~IXGB_CTRL0_SDP0;
1091 IXGB_WRITE_REG(hw, CTRL0, ctrl0_reg);
1095 /******************************************************************************
1096 * Turns off the software controllable LED
1098 * hw - Struct containing variables accessed by shared code
1099 *****************************************************************************/
1101 ixgb_led_off(struct ixgb_hw *hw)
1103 uint32_t ctrl0_reg = IXGB_READ_REG(hw, CTRL0);
1105 /* To turn off the LED, set software-definable pin 0 (SDP0). */
1106 ctrl0_reg |= IXGB_CTRL0_SDP0;
1107 IXGB_WRITE_REG(hw, CTRL0, ctrl0_reg);
1111 /******************************************************************************
1112 * Gets the current PCI bus type, speed, and width of the hardware
1114 * hw - Struct containing variables accessed by shared code
1115 *****************************************************************************/
1117 ixgb_get_bus_info(struct ixgb_hw *hw)
1119 uint32_t status_reg;
1121 status_reg = IXGB_READ_REG(hw, STATUS);
1123 hw->bus.type = (status_reg & IXGB_STATUS_PCIX_MODE) ?
1124 ixgb_bus_type_pcix : ixgb_bus_type_pci;
1126 if (hw->bus.type == ixgb_bus_type_pci) {
1127 hw->bus.speed = (status_reg & IXGB_STATUS_PCI_SPD) ?
1128 ixgb_bus_speed_66 : ixgb_bus_speed_33;
1130 switch (status_reg & IXGB_STATUS_PCIX_SPD_MASK) {
1131 case IXGB_STATUS_PCIX_SPD_66:
1132 hw->bus.speed = ixgb_bus_speed_66;
1134 case IXGB_STATUS_PCIX_SPD_100:
1135 hw->bus.speed = ixgb_bus_speed_100;
1137 case IXGB_STATUS_PCIX_SPD_133:
1138 hw->bus.speed = ixgb_bus_speed_133;
1141 hw->bus.speed = ixgb_bus_speed_reserved;
1146 hw->bus.width = (status_reg & IXGB_STATUS_BUS64) ?
1147 ixgb_bus_width_64 : ixgb_bus_width_32;
1152 /******************************************************************************
1153 * Tests a MAC address to ensure it is a valid Individual Address
1155 * mac_addr - pointer to MAC address.
1157 *****************************************************************************/
1159 mac_addr_valid(uint8_t *mac_addr)
1161 boolean_t is_valid = TRUE;
1162 DEBUGFUNC("mac_addr_valid");
1164 /* Make sure it is not a multicast address */
1165 if (IS_MULTICAST(mac_addr)) {
1166 DEBUGOUT("MAC address is multicast\n");
1169 /* Not a broadcast address */
1170 else if (IS_BROADCAST(mac_addr)) {
1171 DEBUGOUT("MAC address is broadcast\n");
1174 /* Reject the zero address */
1175 else if (mac_addr[0] == 0 &&
1181 DEBUGOUT("MAC address is all zeros\n");
1187 /******************************************************************************
1188 * Resets the 10GbE link. Waits the settle time and returns the state of
1191 * hw - Struct containing variables accessed by shared code
1192 *****************************************************************************/
1194 ixgb_link_reset(struct ixgb_hw *hw)
1196 boolean_t link_status = FALSE;
1197 uint8_t wait_retries = MAX_RESET_ITERATIONS;
1198 uint8_t lrst_retries = MAX_RESET_ITERATIONS;
1201 /* Reset the link */
1202 IXGB_WRITE_REG(hw, CTRL0,
1203 IXGB_READ_REG(hw, CTRL0) | IXGB_CTRL0_LRST);
1205 /* Wait for link-up and lane re-alignment */
1207 udelay(IXGB_DELAY_USECS_AFTER_LINK_RESET);
1209 ((IXGB_READ_REG(hw, STATUS) & IXGB_STATUS_LU)
1210 && (IXGB_READ_REG(hw, XPCSS) &
1211 IXGB_XPCSS_ALIGN_STATUS)) ? TRUE : FALSE;
1212 } while (!link_status && --wait_retries);
1214 } while (!link_status && --lrst_retries);
1219 /******************************************************************************
1220 * Resets the 10GbE optics module.
1222 * hw - Struct containing variables accessed by shared code
1223 *****************************************************************************/
1225 ixgb_optics_reset(struct ixgb_hw *hw)
1227 if (hw->phy_type == ixgb_phy_type_txn17401) {
1230 ixgb_write_phy_reg(hw,
1234 MDIO_PMA_PMD_CR1_RESET);
1236 mdio_reg = ixgb_read_phy_reg( hw,
1245 /******************************************************************************
1246 * Resets the 10GbE optics module for Sun variant NIC.
1248 * hw - Struct containing variables accessed by shared code
1249 *****************************************************************************/
1251 #define IXGB_BCM8704_USER_PMD_TX_CTRL_REG 0xC803
1252 #define IXGB_BCM8704_USER_PMD_TX_CTRL_REG_VAL 0x0164
1253 #define IXGB_BCM8704_USER_CTRL_REG 0xC800
1254 #define IXGB_BCM8704_USER_CTRL_REG_VAL 0x7FBF
1255 #define IXGB_BCM8704_USER_DEV3_ADDR 0x0003
1256 #define IXGB_SUN_PHY_ADDRESS 0x0000
1257 #define IXGB_SUN_PHY_RESET_DELAY 305
1260 ixgb_optics_reset_bcm(struct ixgb_hw *hw)
1262 u32 ctrl = IXGB_READ_REG(hw, CTRL0);
1263 ctrl &= ~IXGB_CTRL0_SDP2;
1264 ctrl |= IXGB_CTRL0_SDP3;
1265 IXGB_WRITE_REG(hw, CTRL0, ctrl);
1267 /* SerDes needs extra delay */
1268 msleep(IXGB_SUN_PHY_RESET_DELAY);
1270 /* Broadcom 7408L configuration */
1271 /* Reference clock config */
1272 ixgb_write_phy_reg(hw,
1273 IXGB_BCM8704_USER_PMD_TX_CTRL_REG,
1274 IXGB_SUN_PHY_ADDRESS,
1275 IXGB_BCM8704_USER_DEV3_ADDR,
1276 IXGB_BCM8704_USER_PMD_TX_CTRL_REG_VAL);
1277 /* we must read the registers twice */
1278 ixgb_read_phy_reg(hw,
1279 IXGB_BCM8704_USER_PMD_TX_CTRL_REG,
1280 IXGB_SUN_PHY_ADDRESS,
1281 IXGB_BCM8704_USER_DEV3_ADDR);
1282 ixgb_read_phy_reg(hw,
1283 IXGB_BCM8704_USER_PMD_TX_CTRL_REG,
1284 IXGB_SUN_PHY_ADDRESS,
1285 IXGB_BCM8704_USER_DEV3_ADDR);
1287 ixgb_write_phy_reg(hw,
1288 IXGB_BCM8704_USER_CTRL_REG,
1289 IXGB_SUN_PHY_ADDRESS,
1290 IXGB_BCM8704_USER_DEV3_ADDR,
1291 IXGB_BCM8704_USER_CTRL_REG_VAL);
1292 ixgb_read_phy_reg(hw,
1293 IXGB_BCM8704_USER_CTRL_REG,
1294 IXGB_SUN_PHY_ADDRESS,
1295 IXGB_BCM8704_USER_DEV3_ADDR);
1296 ixgb_read_phy_reg(hw,
1297 IXGB_BCM8704_USER_CTRL_REG,
1298 IXGB_SUN_PHY_ADDRESS,
1299 IXGB_BCM8704_USER_DEV3_ADDR);
1301 /* SerDes needs extra delay */
1302 msleep(IXGB_SUN_PHY_RESET_DELAY);