BNX2X: usability fixups
[akaros.git] / kern / drivers / net / e1000 / e1000_mac.c
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2008 Intel Corporation.
5
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.
9
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
13   more details.
14
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.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
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
26
27 *******************************************************************************/
28
29 #include <vfs.h>
30 #include <kfs.h>
31 #include <slab.h>
32 #include <kmalloc.h>
33 #include <kref.h>
34 #include <string.h>
35 #include <stdio.h>
36 #include <assert.h>
37 #include <error.h>
38 #include <cpio.h>
39 #include <pmap.h>
40 #include <smp.h>
41 #include <ip.h>
42 #include "e1000_api.h"
43 #include "e1000_mac.h"
44 #include "e1000_nvm.h"
45
46 static int32_t e1000_validate_mdi_setting_generic(struct e1000_hw *hw);
47 static void e1000_set_lan_id_multi_port_pcie(struct e1000_hw *hw);
48
49 /**
50  *  e1000_init_mac_ops_generic - Initialize MAC function pointers
51  *  @hw: pointer to the HW structure
52  *
53  *  Setups up the function pointers to no-op functions
54  **/
55 void e1000_init_mac_ops_generic(struct e1000_hw *hw)
56 {
57         struct e1000_mac_info *mac = &hw->mac;
58         printd("e1000_init_mac_ops_generic");
59
60         /* General Setup */
61         mac->ops.init_params = e1000_null_ops_generic;
62         mac->ops.init_hw = e1000_null_ops_generic;
63         mac->ops.reset_hw = e1000_null_ops_generic;
64         mac->ops.setup_physical_interface = e1000_null_ops_generic;
65         mac->ops.get_bus_info = e1000_null_ops_generic;
66         mac->ops.set_lan_id = e1000_set_lan_id_multi_port_pcie;
67         mac->ops.read_mac_addr = e1000_read_mac_addr_generic;
68         mac->ops.config_collision_dist = e1000_config_collision_dist_generic;
69         mac->ops.clear_hw_cntrs = e1000_null_mac_generic;
70         /* LED */
71         mac->ops.cleanup_led = e1000_null_ops_generic;
72         mac->ops.setup_led = e1000_null_ops_generic;
73         mac->ops.blink_led = e1000_null_ops_generic;
74         mac->ops.led_on = e1000_null_ops_generic;
75         mac->ops.led_off = e1000_null_ops_generic;
76         /* LINK */
77         mac->ops.setup_link = e1000_null_ops_generic;
78         mac->ops.get_link_up_info = e1000_null_link_info;
79         mac->ops.check_for_link = e1000_null_ops_generic;
80         mac->ops.wait_autoneg = e1000_wait_autoneg_generic;
81 #if 0
82         /* Management */
83         mac->ops.check_mng_mode = e1000_null_mng_mode;
84         mac->ops.mng_host_if_write = e1000_mng_host_if_write_generic;
85         mac->ops.mng_write_cmd_header = e1000_mng_write_cmd_header_generic;
86         mac->ops.mng_enable_host_if = e1000_mng_enable_host_if_generic;
87 #endif
88         /* VLAN, MC, etc. */
89         mac->ops.update_mc_addr_list = e1000_null_update_mc;
90         mac->ops.clear_vfta = e1000_null_mac_generic;
91         mac->ops.write_vfta = e1000_null_write_vfta;
92         mac->ops.mta_set = e1000_null_mta_set;
93         mac->ops.rar_set = e1000_rar_set_generic;
94         mac->ops.validate_mdi_setting = e1000_validate_mdi_setting_generic;
95 }
96
97 /**
98  *  e1000_null_ops_generic - No-op function, returns 0
99  *  @hw: pointer to the HW structure
100  **/
101 int32_t e1000_null_ops_generic(struct e1000_hw *hw)
102 {
103         printd("e1000_null_ops_generic");
104         return E1000_SUCCESS;
105 }
106
107 /**
108  *  e1000_null_mac_generic - No-op function, return void
109  *  @hw: pointer to the HW structure
110  **/
111 void e1000_null_mac_generic(struct e1000_hw *hw)
112 {
113         printd("e1000_null_mac_generic");
114         return;
115 }
116
117 /**
118  *  e1000_null_link_info - No-op function, return 0
119  *  @hw: pointer to the HW structure
120  **/
121 int32_t e1000_null_link_info(struct e1000_hw * hw, uint16_t * s, uint16_t * d)
122 {
123         printd("e1000_null_link_info");
124         return E1000_SUCCESS;
125 }
126
127 /**
128  *  e1000_null_mng_mode - No-op function, return false
129  *  @hw: pointer to the HW structure
130  **/
131 bool e1000_null_mng_mode(struct e1000_hw * hw)
132 {
133         printd("e1000_null_mng_mode");
134         return false;
135 }
136
137 /**
138  *  e1000_null_update_mc - No-op function, return void
139  *  @hw: pointer to the HW structure
140  **/
141 void e1000_null_update_mc(struct e1000_hw *hw, uint8_t * h, uint32_t a)
142 {
143         printd("e1000_null_update_mc");
144         return;
145 }
146
147 /**
148  *  e1000_null_write_vfta - No-op function, return void
149  *  @hw: pointer to the HW structure
150  **/
151 void e1000_null_write_vfta(struct e1000_hw *hw, uint32_t a, uint32_t b)
152 {
153         printd("e1000_null_write_vfta");
154         return;
155 }
156
157 /**
158  *  e1000_null_set_mta - No-op function, return void
159  *  @hw: pointer to the HW structure
160  **/
161 void e1000_null_mta_set(struct e1000_hw *hw, uint32_t a)
162 {
163         printd("e1000_null_mta_set");
164         return;
165 }
166
167 /**
168  *  e1000_null_rar_set - No-op function, return void
169  *  @hw: pointer to the HW structure
170  **/
171 void e1000_null_rar_set(struct e1000_hw *hw, uint8_t * h, uint32_t a)
172 {
173         printd("e1000_null_rar_set");
174         return;
175 }
176
177 /**
178  *  e1000_get_bus_info_pci_generic - Get PCI(x) bus information
179  *  @hw: pointer to the HW structure
180  *
181  *  Determines and stores the system bus information for a particular
182  *  network interface.  The following bus information is determined and stored:
183  *  bus speed, bus width, type (PCI/PCIx), and PCI(-x) function.
184  **/
185 int32_t e1000_get_bus_info_pci_generic(struct e1000_hw * hw)
186 {
187 #if 0
188         struct e1000_mac_info *mac = &hw->mac;
189         struct e1000_bus_info *bus = &hw->bus;
190         u32 status = E1000_READ_REG(hw, E1000_STATUS);
191         s32 ret_val = E1000_SUCCESS;
192
193         DEBUGFUNC("e1000_get_bus_info_pci_generic");
194
195         /* PCI or PCI-X? */
196         bus->type = (status & E1000_STATUS_PCIX_MODE)
197                 ? e1000_bus_type_pcix : e1000_bus_type_pci;
198
199         /* Bus speed */
200         if (bus->type == e1000_bus_type_pci) {
201                 bus->speed = (status & E1000_STATUS_PCI66)
202                         ? e1000_bus_speed_66 : e1000_bus_speed_33;
203         } else {
204                 switch (status & E1000_STATUS_PCIX_SPEED) {
205                         case E1000_STATUS_PCIX_SPEED_66:
206                                 bus->speed = e1000_bus_speed_66;
207                                 break;
208                         case E1000_STATUS_PCIX_SPEED_100:
209                                 bus->speed = e1000_bus_speed_100;
210                                 break;
211                         case E1000_STATUS_PCIX_SPEED_133:
212                                 bus->speed = e1000_bus_speed_133;
213                                 break;
214                         default:
215                                 bus->speed = e1000_bus_speed_reserved;
216                                 break;
217                 }
218         }
219
220         /* Bus width */
221         bus->width = (status & E1000_STATUS_BUS64)
222                 ? e1000_bus_width_64 : e1000_bus_width_32;
223
224         /* Which PCI(-X) function? */
225         mac->ops.set_lan_id(hw);
226
227         return ret_val;
228 #endif
229         return 0;
230 }
231
232 /**
233  *  e1000_get_bus_info_pcie_generic - Get PCIe bus information
234  *  @hw: pointer to the HW structure
235  *
236  *  Determines and stores the system bus information for a particular
237  *  network interface.  The following bus information is determined and stored:
238  *  bus speed, bus width, type (PCIe), and PCIe function.
239  **/
240 int32_t e1000_get_bus_info_pcie_generic(struct e1000_hw * hw)
241 {
242 #if 0
243         struct e1000_mac_info *mac = &hw->mac;
244         struct e1000_bus_info *bus = &hw->bus;
245
246         s32 ret_val;
247         u16 pcie_link_status;
248
249         DEBUGFUNC("e1000_get_bus_info_pcie_generic");
250
251         bus->type = e1000_bus_type_pci_express;
252         bus->speed = e1000_bus_speed_2500;
253
254         ret_val = e1000_read_pcie_cap_reg(hw, PCIE_LINK_STATUS, &pcie_link_status);
255         if (ret_val)
256                 bus->width = e1000_bus_width_unknown;
257         else
258                 bus->width = (enum e1000_bus_width)((pcie_link_status &
259                                                                                          PCIE_LINK_WIDTH_MASK) >>
260                                                                                         PCIE_LINK_WIDTH_SHIFT);
261
262         mac->ops.set_lan_id(hw);
263
264         return E1000_SUCCESS;
265 #endif
266         return 0;
267 }
268
269 /**
270  *  e1000_set_lan_id_multi_port_pcie - Set LAN id for PCIe multiple port devices
271  *
272  *  @hw: pointer to the HW structure
273  *
274  *  Determines the LAN function id by reading memory-mapped registers
275  *  and swaps the port value if requested.
276  **/
277 static void e1000_set_lan_id_multi_port_pcie(struct e1000_hw *hw)
278 {
279         struct e1000_bus_info *bus = &hw->bus;
280         uint32_t reg;
281
282         /*
283          * The status register reports the correct function number
284          * for the device regardless of function swap state.
285          */
286         reg = E1000_READ_REG((int)hw, E1000_STATUS);
287         bus->func = (reg & E1000_STATUS_FUNC_MASK) >> E1000_STATUS_FUNC_SHIFT;
288 }
289
290 /**
291  *  e1000_set_lan_id_multi_port_pci - Set LAN id for PCI multiple port devices
292  *  @hw: pointer to the HW structure
293  *
294  *  Determines the LAN function id by reading PCI config space.
295  **/
296 void e1000_set_lan_id_multi_port_pci(struct e1000_hw *hw)
297 {
298         struct e1000_bus_info *bus = &hw->bus;
299         uint16_t pci_header_type;
300         uint32_t status;
301
302         e1000_read_pci_cfg(hw, PCI_HEADER_TYPE_REGISTER, &pci_header_type);
303         if (pci_header_type & PCI_HEADER_TYPE_MULTIFUNC) {
304                 status = E1000_READ_REG((int)hw, E1000_STATUS);
305                 bus->func = (status & E1000_STATUS_FUNC_MASK)
306                         >> E1000_STATUS_FUNC_SHIFT;
307         } else {
308                 bus->func = 0;
309         }
310 }
311
312 /**
313  *  e1000_set_lan_id_single_port - Set LAN id for a single port device
314  *  @hw: pointer to the HW structure
315  *
316  *  Sets the LAN function id to zero for a single port device.
317  **/
318 void e1000_set_lan_id_single_port(struct e1000_hw *hw)
319 {
320         struct e1000_bus_info *bus = &hw->bus;
321
322         bus->func = 0;
323 }
324
325 /**
326  *  e1000_clear_vfta_generic - Clear VLAN filter table
327  *  @hw: pointer to the HW structure
328  *
329  *  Clears the register array which contains the VLAN filter table by
330  *  setting all the values to 0.
331  **/
332 void e1000_clear_vfta_generic(struct e1000_hw *hw)
333 {
334         uint32_t offset;
335
336         printd("e1000_clear_vfta_generic");
337
338         for (offset = 0; offset < E1000_VLAN_FILTER_TBL_SIZE; offset++) {
339                 E1000_WRITE_REG_ARRAY(hw, E1000_VFTA, offset, 0);
340                 E1000_WRITE_FLUSH(hw);
341         }
342 }
343
344 /**
345  *  e1000_write_vfta_generic - Write value to VLAN filter table
346  *  @hw: pointer to the HW structure
347  *  @offset: register offset in VLAN filter table
348  *  @value: register value written to VLAN filter table
349  *
350  *  Writes value at the given offset in the register array which stores
351  *  the VLAN filter table.
352  **/
353 void e1000_write_vfta_generic(struct e1000_hw *hw, uint32_t offset,
354                                                           uint32_t value)
355 {
356         printd("e1000_write_vfta_generic");
357
358         E1000_WRITE_REG_ARRAY(hw, E1000_VFTA, offset, value);
359         E1000_WRITE_FLUSH(hw);
360 }
361
362 /**
363  *  e1000_init_rx_addrs_generic - Initialize receive address's
364  *  @hw: pointer to the HW structure
365  *  @rar_count: receive address registers
366  *
367  *  Setups the receive address registers by setting the base receive address
368  *  register to the devices MAC address and clearing all the other receive
369  *  address registers to 0.
370  **/
371 void e1000_init_rx_addrs_generic(struct e1000_hw *hw, uint16_t rar_count)
372 {
373         uint32_t i;
374         uint8_t mac_addr[ETH_ADDR_LEN] = { 0 };
375
376         printd("e1000_init_rx_addrs_generic");
377
378         /* Setup the receive address */
379         DEBUGOUT("Programming MAC Address into RAR[0]\n");
380
381         hw->mac.ops.rar_set(hw, hw->mac.addr, 0);
382
383         /* Zero out the other (rar_entry_count - 1) receive addresses */
384         DEBUGOUT1("Clearing RAR[1-%u]\n", rar_count - 1);
385         for (i = 1; i < rar_count; i++)
386                 hw->mac.ops.rar_set(hw, mac_addr, i);
387 }
388
389 /**
390  *  e1000_check_alt_mac_addr_generic - Check for alternate MAC addr
391  *  @hw: pointer to the HW structure
392  *
393  *  Checks the nvm for an alternate MAC address.  An alternate MAC address
394  *  can be setup by pre-boot software and must be treated like a permanent
395  *  address and must override the actual permanent MAC address. If an
396  *  alternate MAC address is found it is programmed into RAR0, replacing
397  *  the permanent address that was installed into RAR0 by the Si on reset.
398  *  This function will return SUCCESS unless it encounters an error while
399  *  reading the EEPROM.
400  **/
401 int32_t e1000_check_alt_mac_addr_generic(struct e1000_hw *hw)
402 {
403         uint32_t i;
404         int32_t ret_val = E1000_SUCCESS;
405         uint16_t offset, nvm_alt_mac_addr_offset, nvm_data;
406         uint8_t alt_mac_addr[ETH_ADDR_LEN];
407
408         printd("e1000_check_alt_mac_addr_generic");
409
410         ret_val = hw->nvm.ops.read(hw, NVM_ALT_MAC_ADDR_PTR, 1,
411                                                            &nvm_alt_mac_addr_offset);
412         if (ret_val) {
413                 DEBUGOUT("NVM Read Error\n");
414                 goto out;
415         }
416
417         if (nvm_alt_mac_addr_offset == 0xFFFF) {
418                 /* There is no Alternate MAC Address */
419                 goto out;
420         }
421
422         if (hw->bus.func == E1000_FUNC_1)
423                 nvm_alt_mac_addr_offset += E1000_ALT_MAC_ADDRESS_OFFSET_LAN1;
424         for (i = 0; i < ETH_ADDR_LEN; i += 2) {
425                 offset = nvm_alt_mac_addr_offset + (i >> 1);
426                 ret_val = hw->nvm.ops.read(hw, offset, 1, &nvm_data);
427                 if (ret_val) {
428                         DEBUGOUT("NVM Read Error\n");
429                         goto out;
430                 }
431
432                 alt_mac_addr[i] = (uint8_t) (nvm_data & 0xFF);
433                 alt_mac_addr[i + 1] = (uint8_t) (nvm_data >> 8);
434         }
435
436         /* if multicast bit is set, the alternate address will not be used */
437         if (alt_mac_addr[0] & 0x01) {
438                 DEBUGOUT("Ignoring Alternate Mac Address with MC bit set\n");
439                 goto out;
440         }
441
442         /*
443          * We have a valid alternate MAC address, and we want to treat it the
444          * same as the normal permanent MAC address stored by the HW into the
445          * RAR. Do this by mapping this address into RAR0.
446          */
447         hw->mac.ops.rar_set(hw, alt_mac_addr, 0);
448
449 out:
450         return ret_val;
451 }
452
453 /**
454  *  e1000_rar_set_generic - Set receive address register
455  *  @hw: pointer to the HW structure
456  *  @addr: pointer to the receive address
457  *  @index: receive address array register
458  *
459  *  Sets the receive address array register at index to the address passed
460  *  in by addr.
461  **/
462 void e1000_rar_set_generic(struct e1000_hw *hw, uint8_t * addr, uint32_t index)
463 {
464         uint32_t rar_low, rar_high;
465
466         printd("e1000_rar_set_generic");
467
468         /*
469          * HW expects these in little endian so we reverse the byte order
470          * from network order (big endian) to little endian
471          */
472         rar_low = ((uint32_t) addr[0] |
473                            ((uint32_t) addr[1] << 8) |
474                            ((uint32_t) addr[2] << 16) | ((uint32_t) addr[3] << 24));
475
476         rar_high = ((uint32_t) addr[4] | ((uint32_t) addr[5] << 8));
477
478         /* If MAC address zero, no need to set the AV bit */
479         if (rar_low || rar_high)
480                 rar_high |= E1000_RAH_AV;
481
482         /*
483          * Some bridges will combine consecutive 32-bit writes into
484          * a single burst write, which will malfunction on some parts.
485          * The flushes avoid this.
486          */
487         E1000_WRITE_REG(hw, E1000_RAL(index), rar_low);
488         E1000_WRITE_FLUSH(hw);
489         E1000_WRITE_REG(hw, E1000_RAH(index), rar_high);
490         E1000_WRITE_FLUSH(hw);
491 }
492
493 /**
494  *  e1000_mta_set_generic - Set multicast filter table address
495  *  @hw: pointer to the HW structure
496  *  @hash_value: determines the MTA register and bit to set
497  *
498  *  The multicast table address is a register array of 32-bit registers.
499  *  The hash_value is used to determine what register the bit is in, the
500  *  current value is read, the new bit is OR'd in and the new value is
501  *  written back into the register.
502  **/
503 void e1000_mta_set_generic(struct e1000_hw *hw, uint32_t hash_value)
504 {
505         uint32_t hash_bit, hash_reg, mta;
506
507         printd("e1000_mta_set_generic");
508         /*
509          * The MTA is a register array of 32-bit registers. It is
510          * treated like an array of (32*mta_reg_count) bits.  We want to
511          * set bit BitArray[hash_value]. So we figure out what register
512          * the bit is in, read it, OR in the new bit, then write
513          * back the new value.  The (hw->mac.mta_reg_count - 1) serves as a
514          * mask to bits 31:5 of the hash value which gives us the
515          * register we're modifying.  The hash bit within that register
516          * is determined by the lower 5 bits of the hash value.
517          */
518         hash_reg = (hash_value >> 5) & (hw->mac.mta_reg_count - 1);
519         hash_bit = hash_value & 0x1F;
520
521         mta = E1000_READ_REG_ARRAY(hw, E1000_MTA, hash_reg);
522
523         mta |= (1 << hash_bit);
524
525         E1000_WRITE_REG_ARRAY(hw, E1000_MTA, hash_reg, mta);
526         E1000_WRITE_FLUSH(hw);
527 }
528
529 /**
530  *  e1000_update_mc_addr_list_generic - Update Multicast addresses
531  *  @hw: pointer to the HW structure
532  *  @mc_addr_list: array of multicast addresses to program
533  *  @mc_addr_count: number of multicast addresses to program
534  *
535  *  Updates entire Multicast Table Array.
536  *  The caller must have a packed mc_addr_list of multicast addresses.
537  **/
538 void e1000_update_mc_addr_list_generic(struct e1000_hw *hw,
539                                                                            uint8_t * mc_addr_list,
540                                                                            uint32_t mc_addr_count)
541 {
542         uint32_t hash_value, hash_bit, hash_reg;
543         int i;
544
545         printd("e1000_update_mc_addr_list_generic");
546
547         /* clear mta_shadow */
548         memset(&hw->mac.mta_shadow, 0, sizeof(hw->mac.mta_shadow));
549
550         /* update mta_shadow from mc_addr_list */
551         for (i = 0; (uint32_t) i < mc_addr_count; i++) {
552                 hash_value = e1000_hash_mc_addr_generic(hw, mc_addr_list);
553
554                 hash_reg = (hash_value >> 5) & (hw->mac.mta_reg_count - 1);
555                 hash_bit = hash_value & 0x1F;
556
557                 hw->mac.mta_shadow[hash_reg] |= (1 << hash_bit);
558                 mc_addr_list += (ETH_ADDR_LEN);
559         }
560
561         /* replace the entire MTA table */
562         for (i = hw->mac.mta_reg_count - 1; i >= 0; i--)
563                 E1000_WRITE_REG_ARRAY(hw, E1000_MTA, i, hw->mac.mta_shadow[i]);
564         E1000_WRITE_FLUSH(hw);
565 }
566
567 /**
568  *  e1000_hash_mc_addr_generic - Generate a multicast hash value
569  *  @hw: pointer to the HW structure
570  *  @mc_addr: pointer to a multicast address
571  *
572  *  Generates a multicast address hash value which is used to determine
573  *  the multicast filter table array address and new table value.  See
574  *  e1000_mta_set_generic()
575  **/
576 uint32_t e1000_hash_mc_addr_generic(struct e1000_hw *hw, uint8_t * mc_addr)
577 {
578         uint32_t hash_value, hash_mask;
579         uint8_t bit_shift = 0;
580
581         printd("e1000_hash_mc_addr_generic");
582
583         /* Register count multiplied by bits per register */
584         hash_mask = (hw->mac.mta_reg_count * 32) - 1;
585
586         /*
587          * For a mc_filter_type of 0, bit_shift is the number of left-shifts
588          * where 0xFF would still fall within the hash mask.
589          */
590         while (hash_mask >> bit_shift != 0xFF)
591                 bit_shift++;
592
593         /*
594          * The portion of the address that is used for the hash table
595          * is determined by the mc_filter_type setting.
596          * The algorithm is such that there is a total of 8 bits of shifting.
597          * The bit_shift for a mc_filter_type of 0 represents the number of
598          * left-shifts where the MSB of mc_addr[5] would still fall within
599          * the hash_mask.  Case 0 does this exactly.  Since there are a total
600          * of 8 bits of shifting, then mc_addr[4] will shift right the
601          * remaining number of bits. Thus 8 - bit_shift.  The rest of the
602          * cases are a variation of this algorithm...essentially raising the
603          * number of bits to shift mc_addr[5] left, while still keeping the
604          * 8-bit shifting total.
605          *
606          * For example, given the following Destination MAC Address and an
607          * mta register count of 128 (thus a 4096-bit vector and 0xFFF mask),
608          * we can see that the bit_shift for case 0 is 4.  These are the hash
609          * values resulting from each mc_filter_type...
610          * [0] [1] [2] [3] [4] [5]
611          * 01  AA  00  12  34  56
612          * LSB                 MSB
613          *
614          * case 0: hash_value = ((0x34 >> 4) | (0x56 << 4)) & 0xFFF = 0x563
615          * case 1: hash_value = ((0x34 >> 3) | (0x56 << 5)) & 0xFFF = 0xAC6
616          * case 2: hash_value = ((0x34 >> 2) | (0x56 << 6)) & 0xFFF = 0x163
617          * case 3: hash_value = ((0x34 >> 0) | (0x56 << 8)) & 0xFFF = 0x634
618          */
619         switch (hw->mac.mc_filter_type) {
620                 default:
621                 case 0:
622                         break;
623                 case 1:
624                         bit_shift += 1;
625                         break;
626                 case 2:
627                         bit_shift += 2;
628                         break;
629                 case 3:
630                         bit_shift += 4;
631                         break;
632         }
633
634         hash_value = hash_mask & (((mc_addr[4] >> (8 - bit_shift)) |
635                                                            (((uint16_t) mc_addr[5]) << bit_shift)));
636
637         return hash_value;
638 }
639
640 /**
641  *  e1000_pcix_mmrbc_workaround_generic - Fix incorrect MMRBC value
642  *  @hw: pointer to the HW structure
643  *
644  *  In certain situations, a system BIOS may report that the PCIx maximum
645  *  memory read byte count (MMRBC) value is higher than than the actual
646  *  value. We check the PCIx command register with the current PCIx status
647  *  register.
648  **/
649 void e1000_pcix_mmrbc_workaround_generic(struct e1000_hw *hw)
650 {
651         uint16_t cmd_mmrbc;
652         uint16_t pcix_cmd;
653         uint16_t pcix_stat_hi_word;
654         uint16_t stat_mmrbc;
655
656         printd("e1000_pcix_mmrbc_workaround_generic");
657
658         /* Workaround for PCI-X issue when BIOS sets MMRBC incorrectly */
659         if (hw->bus.type != e1000_bus_type_pcix)
660                 return;
661
662         e1000_read_pci_cfg(hw, PCIX_COMMAND_REGISTER, &pcix_cmd);
663         e1000_read_pci_cfg(hw, PCIX_STATUS_REGISTER_HI, &pcix_stat_hi_word);
664         cmd_mmrbc = (pcix_cmd & PCIX_COMMAND_MMRBC_MASK) >>
665                 PCIX_COMMAND_MMRBC_SHIFT;
666         stat_mmrbc = (pcix_stat_hi_word & PCIX_STATUS_HI_MMRBC_MASK) >>
667                 PCIX_STATUS_HI_MMRBC_SHIFT;
668         if (stat_mmrbc == PCIX_STATUS_HI_MMRBC_4K)
669                 stat_mmrbc = PCIX_STATUS_HI_MMRBC_2K;
670         if (cmd_mmrbc > stat_mmrbc) {
671                 pcix_cmd &= ~PCIX_COMMAND_MMRBC_MASK;
672                 pcix_cmd |= stat_mmrbc << PCIX_COMMAND_MMRBC_SHIFT;
673                 e1000_write_pci_cfg(hw, PCIX_COMMAND_REGISTER, &pcix_cmd);
674         }
675 }
676
677 /**
678  *  e1000_clear_hw_cntrs_base_generic - Clear base hardware counters
679  *  @hw: pointer to the HW structure
680  *
681  *  Clears the base hardware counters by reading the counter registers.
682  **/
683 void e1000_clear_hw_cntrs_base_generic(struct e1000_hw *hw)
684 {
685         printd("e1000_clear_hw_cntrs_base_generic");
686
687 #if 0
688         E1000_READ_REG(hw, E1000_CRCERRS);
689         E1000_READ_REG(hw, E1000_SYMERRS);
690         E1000_READ_REG(hw, E1000_MPC);
691         E1000_READ_REG(hw, E1000_SCC);
692         E1000_READ_REG(hw, E1000_ECOL);
693         E1000_READ_REG(hw, E1000_MCC);
694         E1000_READ_REG(hw, E1000_LATECOL);
695         E1000_READ_REG(hw, E1000_COLC);
696         E1000_READ_REG(hw, E1000_DC);
697         E1000_READ_REG(hw, E1000_SEC);
698         E1000_READ_REG(hw, E1000_RLEC);
699         E1000_READ_REG(hw, E1000_XONRXC);
700         E1000_READ_REG(hw, E1000_XONTXC);
701         E1000_READ_REG(hw, E1000_XOFFRXC);
702         E1000_READ_REG(hw, E1000_XOFFTXC);
703         E1000_READ_REG(hw, E1000_FCRUC);
704         E1000_READ_REG(hw, E1000_GPRC);
705         E1000_READ_REG(hw, E1000_BPRC);
706         E1000_READ_REG(hw, E1000_MPRC);
707         E1000_READ_REG(hw, E1000_GPTC);
708         E1000_READ_REG(hw, E1000_GORCL);
709         E1000_READ_REG(hw, E1000_GORCH);
710         E1000_READ_REG(hw, E1000_GOTCL);
711         E1000_READ_REG(hw, E1000_GOTCH);
712         E1000_READ_REG(hw, E1000_RNBC);
713         E1000_READ_REG(hw, E1000_RUC);
714         E1000_READ_REG(hw, E1000_RFC);
715         E1000_READ_REG(hw, E1000_ROC);
716         E1000_READ_REG(hw, E1000_RJC);
717         E1000_READ_REG(hw, E1000_TORL);
718         E1000_READ_REG(hw, E1000_TORH);
719         E1000_READ_REG(hw, E1000_TOTL);
720         E1000_READ_REG(hw, E1000_TOTH);
721         E1000_READ_REG(hw, E1000_TPR);
722         E1000_READ_REG(hw, E1000_TPT);
723         E1000_READ_REG(hw, E1000_MPTC);
724         E1000_READ_REG(hw, E1000_BPTC);
725 #endif
726 }
727
728 /**
729  *  e1000_check_for_copper_link_generic - Check for link (Copper)
730  *  @hw: pointer to the HW structure
731  *
732  *  Checks to see of the link status of the hardware has changed.  If a
733  *  change in link status has been detected, then we read the PHY registers
734  *  to get the current speed/duplex if link exists.
735  **/
736 int32_t e1000_check_for_copper_link_generic(struct e1000_hw *hw)
737 {
738         struct e1000_mac_info *mac = &hw->mac;
739         int32_t ret_val;
740         bool link;
741
742         printd("e1000_check_for_copper_link");
743
744         /*
745          * We only want to go out to the PHY registers to see if Auto-Neg
746          * has completed and/or if our link status has changed.  The
747          * get_link_status flag is set upon receiving a Link Status
748          * Change or Rx Sequence Error interrupt.
749          */
750         if (!mac->get_link_status) {
751                 ret_val = E1000_SUCCESS;
752                 goto out;
753         }
754
755         /*
756          * First we want to see if the MII Status Register reports
757          * link.  If so, then we want to get the current speed/duplex
758          * of the PHY.
759          */
760         ret_val = e1000_phy_has_link_generic(hw, 1, 0, &link);
761         if (ret_val)
762                 goto out;
763
764         if (!link)
765                 goto out;       /* No link detected */
766
767         mac->get_link_status = false;
768
769         /*
770          * Check if there was DownShift, must be checked
771          * immediately after link-up
772          */
773         e1000_check_downshift_generic(hw);
774
775         /*
776          * If we are forcing speed/duplex, then we simply return since
777          * we have already determined whether we have link or not.
778          */
779         if (!mac->autoneg) {
780                 ret_val = -E1000_ERR_CONFIG;
781                 goto out;
782         }
783
784         /*
785          * Auto-Neg is enabled.  Auto Speed Detection takes care
786          * of MAC speed/duplex configuration.  So we only need to
787          * configure Collision Distance in the MAC.
788          */
789         e1000_config_collision_dist_generic(hw);
790
791         /*
792          * Configure Flow Control now that Auto-Neg has completed.
793          * First, we need to restore the desired flow control
794          * settings because we may have had to re-autoneg with a
795          * different link partner.
796          */
797         ret_val = e1000_config_fc_after_link_up_generic(hw);
798         if (ret_val)
799                 DEBUGOUT("Error configuring flow control\n");
800
801 out:
802         return ret_val;
803 }
804
805 /**
806  *  e1000_check_for_fiber_link_generic - Check for link (Fiber)
807  *  @hw: pointer to the HW structure
808  *
809  *  Checks for link up on the hardware.  If link is not up and we have
810  *  a signal, then we need to force link up.
811  **/
812 int32_t e1000_check_for_fiber_link_generic(struct e1000_hw * hw)
813 {
814         struct e1000_mac_info *mac = &hw->mac;
815         uint32_t rxcw;
816         uint32_t ctrl;
817         uint32_t status;
818         int32_t ret_val = E1000_SUCCESS;
819
820         printd("e1000_check_for_fiber_link_generic");
821
822         ctrl = E1000_READ_REG(hw, E1000_CTRL);
823         status = E1000_READ_REG(hw, E1000_STATUS);
824         rxcw = E1000_READ_REG(hw, E1000_RXCW);
825
826         /*
827          * If we don't have link (auto-negotiation failed or link partner
828          * cannot auto-negotiate), the cable is plugged in (we have signal),
829          * and our link partner is not trying to auto-negotiate with us (we
830          * are receiving idles or data), we need to force link up. We also
831          * need to give auto-negotiation time to complete, in case the cable
832          * was just plugged in. The autoneg_failed flag does this.
833          */
834         /* (ctrl & E1000_CTRL_SWDPIN1) == 1 == have signal */
835         if ((ctrl & E1000_CTRL_SWDPIN1) && (!(status & E1000_STATUS_LU)) &&
836                 (!(rxcw & E1000_RXCW_C))) {
837                 if (mac->autoneg_failed == 0) {
838                         mac->autoneg_failed = 1;
839                         goto out;
840                 }
841                 DEBUGOUT("NOT RXing /C/, disable AutoNeg and force link.\n");
842
843                 /* Disable auto-negotiation in the TXCW register */
844                 E1000_WRITE_REG(hw, E1000_TXCW, (mac->txcw & ~E1000_TXCW_ANE));
845
846                 /* Force link-up and also force full-duplex. */
847                 ctrl = E1000_READ_REG(hw, E1000_CTRL);
848                 ctrl |= (E1000_CTRL_SLU | E1000_CTRL_FD);
849                 E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
850
851                 /* Configure Flow Control after forcing link up. */
852                 ret_val = e1000_config_fc_after_link_up_generic(hw);
853                 if (ret_val) {
854                         DEBUGOUT("Error configuring flow control\n");
855                         goto out;
856                 }
857         } else if ((ctrl & E1000_CTRL_SLU) && (rxcw & E1000_RXCW_C)) {
858                 /*
859                  * If we are forcing link and we are receiving /C/ ordered
860                  * sets, re-enable auto-negotiation in the TXCW register
861                  * and disable forced link in the Device Control register
862                  * in an attempt to auto-negotiate with our link partner.
863                  */
864                 DEBUGOUT("RXing /C/, enable AutoNeg and stop forcing link.\n");
865                 E1000_WRITE_REG(hw, E1000_TXCW, mac->txcw);
866                 E1000_WRITE_REG(hw, E1000_CTRL, (ctrl & ~E1000_CTRL_SLU));
867
868                 mac->serdes_has_link = true;
869         }
870
871 out:
872         return ret_val;
873 }
874
875 /**
876  *  e1000_check_for_serdes_link_generic - Check for link (Serdes)
877  *  @hw: pointer to the HW structure
878  *
879  *  Checks for link up on the hardware.  If link is not up and we have
880  *  a signal, then we need to force link up.
881  **/
882 int32_t e1000_check_for_serdes_link_generic(struct e1000_hw * hw)
883 {
884         struct e1000_mac_info *mac = &hw->mac;
885         uint32_t rxcw;
886         uint32_t ctrl;
887         uint32_t status;
888         int32_t ret_val = E1000_SUCCESS;
889
890         printd("e1000_check_for_serdes_link_generic");
891
892         ctrl = E1000_READ_REG(hw, E1000_CTRL);
893         status = E1000_READ_REG(hw, E1000_STATUS);
894         rxcw = E1000_READ_REG(hw, E1000_RXCW);
895
896         /*
897          * If we don't have link (auto-negotiation failed or link partner
898          * cannot auto-negotiate), and our link partner is not trying to
899          * auto-negotiate with us (we are receiving idles or data),
900          * we need to force link up. We also need to give auto-negotiation
901          * time to complete.
902          */
903         /* (ctrl & E1000_CTRL_SWDPIN1) == 1 == have signal */
904         if ((!(status & E1000_STATUS_LU)) && (!(rxcw & E1000_RXCW_C))) {
905                 if (mac->autoneg_failed == 0) {
906                         mac->autoneg_failed = 1;
907                         goto out;
908                 }
909                 DEBUGOUT("NOT RXing /C/, disable AutoNeg and force link.\n");
910
911                 /* Disable auto-negotiation in the TXCW register */
912                 E1000_WRITE_REG(hw, E1000_TXCW, (mac->txcw & ~E1000_TXCW_ANE));
913
914                 /* Force link-up and also force full-duplex. */
915                 ctrl = E1000_READ_REG(hw, E1000_CTRL);
916                 ctrl |= (E1000_CTRL_SLU | E1000_CTRL_FD);
917                 E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
918
919                 /* Configure Flow Control after forcing link up. */
920                 ret_val = e1000_config_fc_after_link_up_generic(hw);
921                 if (ret_val) {
922                         DEBUGOUT("Error configuring flow control\n");
923                         goto out;
924                 }
925         } else if ((ctrl & E1000_CTRL_SLU) && (rxcw & E1000_RXCW_C)) {
926                 /*
927                  * If we are forcing link and we are receiving /C/ ordered
928                  * sets, re-enable auto-negotiation in the TXCW register
929                  * and disable forced link in the Device Control register
930                  * in an attempt to auto-negotiate with our link partner.
931                  */
932                 DEBUGOUT("RXing /C/, enable AutoNeg and stop forcing link.\n");
933                 E1000_WRITE_REG(hw, E1000_TXCW, mac->txcw);
934                 E1000_WRITE_REG(hw, E1000_CTRL, (ctrl & ~E1000_CTRL_SLU));
935
936                 mac->serdes_has_link = true;
937         } else if (!(E1000_TXCW_ANE & E1000_READ_REG(hw, E1000_TXCW))) {
938                 /*
939                  * If we force link for non-auto-negotiation switch, check
940                  * link status based on MAC synchronization for internal
941                  * serdes media type.
942                  */
943                 /* SYNCH bit and IV bit are sticky. */
944                 usec_delay(10);
945                 rxcw = E1000_READ_REG(hw, E1000_RXCW);
946                 if (rxcw & E1000_RXCW_SYNCH) {
947                         if (!(rxcw & E1000_RXCW_IV)) {
948                                 mac->serdes_has_link = true;
949                                 DEBUGOUT("SERDES: Link up - forced.\n");
950                         }
951                 } else {
952                         mac->serdes_has_link = false;
953                         DEBUGOUT("SERDES: Link down - force failed.\n");
954                 }
955         }
956
957         if (E1000_TXCW_ANE & E1000_READ_REG(hw, E1000_TXCW)) {
958                 status = E1000_READ_REG(hw, E1000_STATUS);
959                 if (status & E1000_STATUS_LU) {
960                         /* SYNCH bit and IV bit are sticky, so reread rxcw. */
961                         usec_delay(10);
962                         rxcw = E1000_READ_REG(hw, E1000_RXCW);
963                         if (rxcw & E1000_RXCW_SYNCH) {
964                                 if (!(rxcw & E1000_RXCW_IV)) {
965                                         mac->serdes_has_link = true;
966                                         DEBUGOUT("SERDES: Link up - autoneg "
967                                                          "completed sucessfully.\n");
968                                 } else {
969                                         mac->serdes_has_link = false;
970                                         DEBUGOUT("SERDES: Link down - invalid"
971                                                          "codewords detected in autoneg.\n");
972                                 }
973                         } else {
974                                 mac->serdes_has_link = false;
975                                 DEBUGOUT("SERDES: Link down - no sync.\n");
976                         }
977                 } else {
978                         mac->serdes_has_link = false;
979                         DEBUGOUT("SERDES: Link down - autoneg failed\n");
980                 }
981         }
982
983 out:
984         return ret_val;
985 }
986
987 /**
988  *  e1000_setup_link_generic - Setup flow control and link settings
989  *  @hw: pointer to the HW structure
990  *
991  *  Determines which flow control settings to use, then configures flow
992  *  control.  Calls the appropriate media-specific link configuration
993  *  function.  Assuming the adapter has a valid link partner, a valid link
994  *  should be established.  Assumes the hardware has previously been reset
995  *  and the transmitter and receiver are not enabled.
996  **/
997 int32_t e1000_setup_link_generic(struct e1000_hw * hw)
998 {
999         int32_t ret_val = E1000_SUCCESS;
1000
1001         printd("e1000_setup_link_generic");
1002
1003         /*
1004          * In the case of the phy reset being blocked, we already have a link.
1005          * We do not need to set it up again.
1006          */
1007         if (hw->phy.ops.check_reset_block)
1008                 if (hw->phy.ops.check_reset_block(hw))
1009                         goto out;
1010
1011         /*
1012          * If requested flow control is set to default, set flow control
1013          * based on the EEPROM flow control settings.
1014          */
1015         if (hw->fc.requested_mode == e1000_fc_default) {
1016                 ret_val = e1000_set_default_fc_generic(hw);
1017                 if (ret_val)
1018                         goto out;
1019         }
1020
1021         /*
1022          * Save off the requested flow control mode for use later.  Depending
1023          * on the link partner's capabilities, we may or may not use this mode.
1024          */
1025         hw->fc.current_mode = hw->fc.requested_mode;
1026
1027         DEBUGOUT1("After fix-ups FlowControl is now = %x\n", hw->fc.current_mode);
1028
1029         /* Call the necessary media_type subroutine to configure the link. */
1030         ret_val = hw->mac.ops.setup_physical_interface(hw);
1031         if (ret_val)
1032                 goto out;
1033
1034         /*
1035          * Initialize the flow control address, type, and PAUSE timer
1036          * registers to their default values.  This is done even if flow
1037          * control is disabled, because it does not hurt anything to
1038          * initialize these registers.
1039          */
1040         DEBUGOUT("Initializing the Flow Control address, type and timer regs\n");
1041         E1000_WRITE_REG(hw, E1000_FCT, FLOW_CONTROL_TYPE);
1042         E1000_WRITE_REG(hw, E1000_FCAH, FLOW_CONTROL_ADDRESS_HIGH);
1043         E1000_WRITE_REG(hw, E1000_FCAL, FLOW_CONTROL_ADDRESS_LOW);
1044
1045         E1000_WRITE_REG(hw, E1000_FCTTV, hw->fc.pause_time);
1046
1047         ret_val = e1000_set_fc_watermarks_generic(hw);
1048
1049 out:
1050         return ret_val;
1051 }
1052
1053 /**
1054  *  e1000_setup_fiber_serdes_link_generic - Setup link for fiber/serdes
1055  *  @hw: pointer to the HW structure
1056  *
1057  *  Configures collision distance and flow control for fiber and serdes
1058  *  links.  Upon successful setup, poll for link.
1059  **/
1060 int32_t e1000_setup_fiber_serdes_link_generic(struct e1000_hw * hw)
1061 {
1062         uint32_t ctrl;
1063         int32_t ret_val = E1000_SUCCESS;
1064
1065         printd("e1000_setup_fiber_serdes_link_generic");
1066
1067         ctrl = E1000_READ_REG(hw, E1000_CTRL);
1068
1069         /* Take the link out of reset */
1070         ctrl &= ~E1000_CTRL_LRST;
1071
1072         e1000_config_collision_dist_generic(hw);
1073
1074         ret_val = e1000_commit_fc_settings_generic(hw);
1075         if (ret_val)
1076                 goto out;
1077
1078         /*
1079          * Since auto-negotiation is enabled, take the link out of reset (the
1080          * link will be in reset, because we previously reset the chip). This
1081          * will restart auto-negotiation.  If auto-negotiation is successful
1082          * then the link-up status bit will be set and the flow control enable
1083          * bits (RFCE and TFCE) will be set according to their negotiated value.
1084          */
1085         DEBUGOUT("Auto-negotiation enabled\n");
1086
1087         E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
1088         E1000_WRITE_FLUSH(hw);
1089         msec_delay(1);
1090
1091         /*
1092          * For these adapters, the SW definable pin 1 is set when the optics
1093          * detect a signal.  If we have a signal, then poll for a "Link-Up"
1094          * indication.
1095          */
1096         if (hw->phy.media_type == e1000_media_type_internal_serdes ||
1097                 (E1000_READ_REG(hw, E1000_CTRL) & E1000_CTRL_SWDPIN1)) {
1098                 ret_val = e1000_poll_fiber_serdes_link_generic(hw);
1099         } else {
1100                 DEBUGOUT("No signal detected\n");
1101         }
1102
1103 out:
1104         return ret_val;
1105 }
1106
1107 /**
1108  *  e1000_config_collision_dist_generic - Configure collision distance
1109  *  @hw: pointer to the HW structure
1110  *
1111  *  Configures the collision distance to the default value and is used
1112  *  during link setup. Currently no func pointer exists and all
1113  *  implementations are handled in the generic version of this function.
1114  **/
1115 void e1000_config_collision_dist_generic(struct e1000_hw *hw)
1116 {
1117         uint32_t tctl;
1118
1119         printd("e1000_config_collision_dist_generic");
1120
1121         tctl = E1000_READ_REG(hw, E1000_TCTL);
1122
1123         tctl &= ~E1000_TCTL_COLD;
1124         tctl |= E1000_COLLISION_DISTANCE << E1000_COLD_SHIFT;
1125
1126         E1000_WRITE_REG(hw, E1000_TCTL, tctl);
1127         E1000_WRITE_FLUSH(hw);
1128 }
1129
1130 /**
1131  *  e1000_poll_fiber_serdes_link_generic - Poll for link up
1132  *  @hw: pointer to the HW structure
1133  *
1134  *  Polls for link up by reading the status register, if link fails to come
1135  *  up with auto-negotiation, then the link is forced if a signal is detected.
1136  **/
1137 int32_t e1000_poll_fiber_serdes_link_generic(struct e1000_hw *hw)
1138 {
1139         struct e1000_mac_info *mac = &hw->mac;
1140         uint32_t i, status;
1141         int32_t ret_val = E1000_SUCCESS;
1142
1143         printd("e1000_poll_fiber_serdes_link_generic");
1144
1145         /*
1146          * If we have a signal (the cable is plugged in, or assumed true for
1147          * serdes media) then poll for a "Link-Up" indication in the Device
1148          * Status Register.  Time-out if a link isn't seen in 500 milliseconds
1149          * seconds (Auto-negotiation should complete in less than 500
1150          * milliseconds even if the other end is doing it in SW).
1151          */
1152         for (i = 0; i < FIBER_LINK_UP_LIMIT; i++) {
1153                 msec_delay(10);
1154                 status = E1000_READ_REG(hw, E1000_STATUS);
1155                 if (status & E1000_STATUS_LU)
1156                         break;
1157         }
1158         if (i == FIBER_LINK_UP_LIMIT) {
1159                 DEBUGOUT("Never got a valid link from auto-neg!!!\n");
1160                 mac->autoneg_failed = 1;
1161                 /*
1162                  * AutoNeg failed to achieve a link, so we'll call
1163                  * mac->check_for_link. This routine will force the
1164                  * link up if we detect a signal. This will allow us to
1165                  * communicate with non-autonegotiating link partners.
1166                  */
1167                 ret_val = hw->mac.ops.check_for_link(hw);
1168                 if (ret_val) {
1169                         DEBUGOUT("Error while checking for link\n");
1170                         goto out;
1171                 }
1172                 mac->autoneg_failed = 0;
1173         } else {
1174                 mac->autoneg_failed = 0;
1175                 DEBUGOUT("Valid Link Found\n");
1176         }
1177
1178 out:
1179         return ret_val;
1180 }
1181
1182 /**
1183  *  e1000_commit_fc_settings_generic - Configure flow control
1184  *  @hw: pointer to the HW structure
1185  *
1186  *  Write the flow control settings to the Transmit Config Word Register (TXCW)
1187  *  base on the flow control settings in e1000_mac_info.
1188  **/
1189 int32_t e1000_commit_fc_settings_generic(struct e1000_hw * hw)
1190 {
1191         struct e1000_mac_info *mac = &hw->mac;
1192         uint32_t txcw;
1193         int32_t ret_val = E1000_SUCCESS;
1194
1195         printd("e1000_commit_fc_settings_generic");
1196
1197         /*
1198          * Check for a software override of the flow control settings, and
1199          * setup the device accordingly.  If auto-negotiation is enabled, then
1200          * software will have to set the "PAUSE" bits to the correct value in
1201          * the Transmit Config Word Register (TXCW) and re-start auto-
1202          * negotiation.  However, if auto-negotiation is disabled, then
1203          * software will have to manually configure the two flow control enable
1204          * bits in the CTRL register.
1205          *
1206          * The possible values of the "fc" parameter are:
1207          *      0:  Flow control is completely disabled
1208          *      1:  Rx flow control is enabled (we can receive pause frames,
1209          *          but not send pause frames).
1210          *      2:  Tx flow control is enabled (we can send pause frames but we
1211          *          do not support receiving pause frames).
1212          *      3:  Both Rx and Tx flow control (symmetric) are enabled.
1213          */
1214         switch (hw->fc.current_mode) {
1215                 case e1000_fc_none:
1216                         /* Flow control completely disabled by a software over-ride. */
1217                         txcw = (E1000_TXCW_ANE | E1000_TXCW_FD);
1218                         break;
1219                 case e1000_fc_rx_pause:
1220                         /*
1221                          * Rx Flow control is enabled and Tx Flow control is disabled
1222                          * by a software over-ride. Since there really isn't a way to
1223                          * advertise that we are capable of Rx Pause ONLY, we will
1224                          * advertise that we support both symmetric and asymmetric RX
1225                          * PAUSE.  Later, we will disable the adapter's ability to send
1226                          * PAUSE frames.
1227                          */
1228                         txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_PAUSE_MASK);
1229                         break;
1230                 case e1000_fc_tx_pause:
1231                         /*
1232                          * Tx Flow control is enabled, and Rx Flow control is disabled,
1233                          * by a software over-ride.
1234                          */
1235                         txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_ASM_DIR);
1236                         break;
1237                 case e1000_fc_full:
1238                         /*
1239                          * Flow control (both Rx and Tx) is enabled by a software
1240                          * over-ride.
1241                          */
1242                         txcw = (E1000_TXCW_ANE | E1000_TXCW_FD | E1000_TXCW_PAUSE_MASK);
1243                         break;
1244                 default:
1245                         DEBUGOUT("Flow control param set incorrectly\n");
1246                         ret_val = -E1000_ERR_CONFIG;
1247                         goto out;
1248                         break;
1249         }
1250
1251         E1000_WRITE_REG(hw, E1000_TXCW, txcw);
1252         mac->txcw = txcw;
1253
1254 out:
1255         return ret_val;
1256 }
1257
1258 /**
1259  *  e1000_set_fc_watermarks_generic - Set flow control high/low watermarks
1260  *  @hw: pointer to the HW structure
1261  *
1262  *  Sets the flow control high/low threshold (watermark) registers.  If
1263  *  flow control XON frame transmission is enabled, then set XON frame
1264  *  transmission as well.
1265  **/
1266 int32_t e1000_set_fc_watermarks_generic(struct e1000_hw * hw)
1267 {
1268         int32_t ret_val = E1000_SUCCESS;
1269         uint32_t fcrtl = 0, fcrth = 0;
1270
1271         printd("e1000_set_fc_watermarks_generic");
1272
1273         /*
1274          * Set the flow control receive threshold registers.  Normally,
1275          * these registers will be set to a default threshold that may be
1276          * adjusted later by the driver's runtime code.  However, if the
1277          * ability to transmit pause frames is not enabled, then these
1278          * registers will be set to 0.
1279          */
1280         if (hw->fc.current_mode & e1000_fc_tx_pause) {
1281                 /*
1282                  * We need to set up the Receive Threshold high and low water
1283                  * marks as well as (optionally) enabling the transmission of
1284                  * XON frames.
1285                  */
1286                 fcrtl = hw->fc.low_water;
1287                 if (hw->fc.send_xon)
1288                         fcrtl |= E1000_FCRTL_XONE;
1289
1290                 fcrth = hw->fc.high_water;
1291         }
1292         E1000_WRITE_REG(hw, E1000_FCRTL, fcrtl);
1293         E1000_WRITE_REG(hw, E1000_FCRTH, fcrth);
1294
1295         return ret_val;
1296 }
1297
1298 /**
1299  *  e1000_set_default_fc_generic - Set flow control default values
1300  *  @hw: pointer to the HW structure
1301  *
1302  *  Read the EEPROM for the default values for flow control and store the
1303  *  values.
1304  **/
1305 int32_t e1000_set_default_fc_generic(struct e1000_hw * hw)
1306 {
1307         int32_t ret_val = E1000_SUCCESS;
1308         uint16_t nvm_data;
1309
1310         printd("e1000_set_default_fc_generic");
1311
1312         /*
1313          * Read and store word 0x0F of the EEPROM. This word contains bits
1314          * that determine the hardware's default PAUSE (flow control) mode,
1315          * a bit that determines whether the HW defaults to enabling or
1316          * disabling auto-negotiation, and the direction of the
1317          * SW defined pins. If there is no SW over-ride of the flow
1318          * control setting, then the variable hw->fc will
1319          * be initialized based on a value in the EEPROM.
1320          */
1321         ret_val = hw->nvm.ops.read(hw, NVM_INIT_CONTROL2_REG, 1, &nvm_data);
1322
1323         if (ret_val) {
1324                 DEBUGOUT("NVM Read Error\n");
1325                 goto out;
1326         }
1327
1328         if ((nvm_data & NVM_WORD0F_PAUSE_MASK) == 0)
1329                 hw->fc.requested_mode = e1000_fc_none;
1330         else if ((nvm_data & NVM_WORD0F_PAUSE_MASK) == NVM_WORD0F_ASM_DIR)
1331                 hw->fc.requested_mode = e1000_fc_tx_pause;
1332         else
1333                 hw->fc.requested_mode = e1000_fc_full;
1334
1335 out:
1336         return ret_val;
1337 }
1338
1339 /**
1340  *  e1000_force_mac_fc_generic - Force the MAC's flow control settings
1341  *  @hw: pointer to the HW structure
1342  *
1343  *  Force the MAC's flow control settings.  Sets the TFCE and RFCE bits in the
1344  *  device control register to reflect the adapter settings.  TFCE and RFCE
1345  *  need to be explicitly set by software when a copper PHY is used because
1346  *  autonegotiation is managed by the PHY rather than the MAC.  Software must
1347  *  also configure these bits when link is forced on a fiber connection.
1348  **/
1349 int32_t e1000_force_mac_fc_generic(struct e1000_hw * hw)
1350 {
1351         uint32_t ctrl;
1352         int32_t ret_val = E1000_SUCCESS;
1353
1354         printd("e1000_force_mac_fc_generic");
1355
1356         ctrl = E1000_READ_REG(hw, E1000_CTRL);
1357
1358         /*
1359          * Because we didn't get link via the internal auto-negotiation
1360          * mechanism (we either forced link or we got link via PHY
1361          * auto-neg), we have to manually enable/disable transmit an
1362          * receive flow control.
1363          *
1364          * The "Case" statement below enables/disable flow control
1365          * according to the "hw->fc.current_mode" parameter.
1366          *
1367          * The possible values of the "fc" parameter are:
1368          *      0:  Flow control is completely disabled
1369          *      1:  Rx flow control is enabled (we can receive pause
1370          *          frames but not send pause frames).
1371          *      2:  Tx flow control is enabled (we can send pause frames
1372          *          frames but we do not receive pause frames).
1373          *      3:  Both Rx and Tx flow control (symmetric) is enabled.
1374          *  other:  No other values should be possible at this point.
1375          */
1376         DEBUGOUT1("hw->fc.current_mode = %u\n", hw->fc.current_mode);
1377
1378         switch (hw->fc.current_mode) {
1379                 case e1000_fc_none:
1380                         ctrl &= (~(E1000_CTRL_TFCE | E1000_CTRL_RFCE));
1381                         break;
1382                 case e1000_fc_rx_pause:
1383                         ctrl &= (~E1000_CTRL_TFCE);
1384                         ctrl |= E1000_CTRL_RFCE;
1385                         break;
1386                 case e1000_fc_tx_pause:
1387                         ctrl &= (~E1000_CTRL_RFCE);
1388                         ctrl |= E1000_CTRL_TFCE;
1389                         break;
1390                 case e1000_fc_full:
1391                         ctrl |= (E1000_CTRL_TFCE | E1000_CTRL_RFCE);
1392                         break;
1393                 default:
1394                         DEBUGOUT("Flow control param set incorrectly\n");
1395                         ret_val = -E1000_ERR_CONFIG;
1396                         goto out;
1397         }
1398
1399         E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
1400
1401 out:
1402         return ret_val;
1403 }
1404
1405 /**
1406  *  e1000_config_fc_after_link_up_generic - Configures flow control after link
1407  *  @hw: pointer to the HW structure
1408  *
1409  *  Checks the status of auto-negotiation after link up to ensure that the
1410  *  speed and duplex were not forced.  If the link needed to be forced, then
1411  *  flow control needs to be forced also.  If auto-negotiation is enabled
1412  *  and did not fail, then we configure flow control based on our link
1413  *  partner.
1414  **/
1415 int32_t e1000_config_fc_after_link_up_generic(struct e1000_hw * hw)
1416 {
1417         struct e1000_mac_info *mac = &hw->mac;
1418         int32_t ret_val = E1000_SUCCESS;
1419         uint16_t mii_status_reg, mii_nway_adv_reg, mii_nway_lp_ability_reg;
1420         uint16_t speed, duplex;
1421
1422         printd("e1000_config_fc_after_link_up_generic");
1423
1424         /*
1425          * Check for the case where we have fiber media and auto-neg failed
1426          * so we had to force link.  In this case, we need to force the
1427          * configuration of the MAC to match the "fc" parameter.
1428          */
1429         if (mac->autoneg_failed) {
1430                 if (hw->phy.media_type == e1000_media_type_fiber ||
1431                         hw->phy.media_type == e1000_media_type_internal_serdes)
1432                         ret_val = e1000_force_mac_fc_generic(hw);
1433         } else {
1434                 if (hw->phy.media_type == e1000_media_type_copper)
1435                         ret_val = e1000_force_mac_fc_generic(hw);
1436         }
1437
1438         if (ret_val) {
1439                 DEBUGOUT("Error forcing flow control settings\n");
1440                 goto out;
1441         }
1442
1443         /*
1444          * Check for the case where we have copper media and auto-neg is
1445          * enabled.  In this case, we need to check and see if Auto-Neg
1446          * has completed, and if so, how the PHY and link partner has
1447          * flow control configured.
1448          */
1449         if ((hw->phy.media_type == e1000_media_type_copper) && mac->autoneg) {
1450                 /*
1451                  * Read the MII Status Register and check to see if AutoNeg
1452                  * has completed.  We read this twice because this reg has
1453                  * some "sticky" (latched) bits.
1454                  */
1455                 ret_val = hw->phy.ops.read_reg(hw, PHY_STATUS, &mii_status_reg);
1456                 if (ret_val)
1457                         goto out;
1458                 ret_val = hw->phy.ops.read_reg(hw, PHY_STATUS, &mii_status_reg);
1459                 if (ret_val)
1460                         goto out;
1461
1462                 if (!(mii_status_reg & MII_SR_AUTONEG_COMPLETE)) {
1463                         DEBUGOUT("Copper PHY and Auto Neg " "has not completed.\n");
1464                         goto out;
1465                 }
1466
1467                 /*
1468                  * The AutoNeg process has completed, so we now need to
1469                  * read both the Auto Negotiation Advertisement
1470                  * Register (Address 4) and the Auto_Negotiation Base
1471                  * Page Ability Register (Address 5) to determine how
1472                  * flow control was negotiated.
1473                  */
1474                 ret_val = hw->phy.ops.read_reg(hw, PHY_AUTONEG_ADV, &mii_nway_adv_reg);
1475                 if (ret_val)
1476                         goto out;
1477                 ret_val = hw->phy.ops.read_reg(hw, PHY_LP_ABILITY,
1478                                                                            &mii_nway_lp_ability_reg);
1479                 if (ret_val)
1480                         goto out;
1481
1482                 /*
1483                  * Two bits in the Auto Negotiation Advertisement Register
1484                  * (Address 4) and two bits in the Auto Negotiation Base
1485                  * Page Ability Register (Address 5) determine flow control
1486                  * for both the PHY and the link partner.  The following
1487                  * table, taken out of the IEEE 802.3ab/D6.0 dated March 25,
1488                  * 1999, describes these PAUSE resolution bits and how flow
1489                  * control is determined based upon these settings.
1490                  * NOTE:  DC = Don't Care
1491                  *
1492                  *   LOCAL DEVICE  |   LINK PARTNER
1493                  * PAUSE | ASM_DIR | PAUSE | ASM_DIR | NIC Resolution
1494                  *-------|---------|-------|---------|--------------------
1495                  *   0   |    0    |  DC   |   DC    | e1000_fc_none
1496                  *   0   |    1    |   0   |   DC    | e1000_fc_none
1497                  *   0   |    1    |   1   |    0    | e1000_fc_none
1498                  *   0   |    1    |   1   |    1    | e1000_fc_tx_pause
1499                  *   1   |    0    |   0   |   DC    | e1000_fc_none
1500                  *   1   |   DC    |   1   |   DC    | e1000_fc_full
1501                  *   1   |    1    |   0   |    0    | e1000_fc_none
1502                  *   1   |    1    |   0   |    1    | e1000_fc_rx_pause
1503                  *
1504                  * Are both PAUSE bits set to 1?  If so, this implies
1505                  * Symmetric Flow Control is enabled at both ends.  The
1506                  * ASM_DIR bits are irrelevant per the spec.
1507                  *
1508                  * For Symmetric Flow Control:
1509                  *
1510                  *   LOCAL DEVICE  |   LINK PARTNER
1511                  * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
1512                  *-------|---------|-------|---------|--------------------
1513                  *   1   |   DC    |   1   |   DC    | E1000_fc_full
1514                  *
1515                  */
1516                 if ((mii_nway_adv_reg & NWAY_AR_PAUSE) &&
1517                         (mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE)) {
1518                         /*
1519                          * Now we need to check if the user selected Rx ONLY
1520                          * of pause frames.  In this case, we had to advertise
1521                          * FULL flow control because we could not advertise RX
1522                          * ONLY. Hence, we must now check to see if we need to
1523                          * turn OFF  the TRANSMISSION of PAUSE frames.
1524                          */
1525                         if (hw->fc.requested_mode == e1000_fc_full) {
1526                                 hw->fc.current_mode = e1000_fc_full;
1527                                 DEBUGOUT("Flow Control = FULL.\r\n");
1528                         } else {
1529                                 hw->fc.current_mode = e1000_fc_rx_pause;
1530                                 DEBUGOUT("Flow Control = " "RX PAUSE frames only.\r\n");
1531                         }
1532                 }
1533                 /*
1534                  * For receiving PAUSE frames ONLY.
1535                  *
1536                  *   LOCAL DEVICE  |   LINK PARTNER
1537                  * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
1538                  *-------|---------|-------|---------|--------------------
1539                  *   0   |    1    |   1   |    1    | e1000_fc_tx_pause
1540                  */
1541                 else if (!(mii_nway_adv_reg & NWAY_AR_PAUSE) &&
1542                                  (mii_nway_adv_reg & NWAY_AR_ASM_DIR) &&
1543                                  (mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE) &&
1544                                  (mii_nway_lp_ability_reg & NWAY_LPAR_ASM_DIR)) {
1545                         hw->fc.current_mode = e1000_fc_tx_pause;
1546                         DEBUGOUT("Flow Control = TX PAUSE frames only.\r\n");
1547                 }
1548                 /*
1549                  * For transmitting PAUSE frames ONLY.
1550                  *
1551                  *   LOCAL DEVICE  |   LINK PARTNER
1552                  * PAUSE | ASM_DIR | PAUSE | ASM_DIR | Result
1553                  *-------|---------|-------|---------|--------------------
1554                  *   1   |    1    |   0   |    1    | e1000_fc_rx_pause
1555                  */
1556                 else if ((mii_nway_adv_reg & NWAY_AR_PAUSE) &&
1557                                  (mii_nway_adv_reg & NWAY_AR_ASM_DIR) &&
1558                                  !(mii_nway_lp_ability_reg & NWAY_LPAR_PAUSE) &&
1559                                  (mii_nway_lp_ability_reg & NWAY_LPAR_ASM_DIR)) {
1560                         hw->fc.current_mode = e1000_fc_rx_pause;
1561                         DEBUGOUT("Flow Control = RX PAUSE frames only.\r\n");
1562                 } else {
1563                         /*
1564                          * Per the IEEE spec, at this point flow control
1565                          * should be disabled.
1566                          */
1567                         hw->fc.current_mode = e1000_fc_none;
1568                         DEBUGOUT("Flow Control = NONE.\r\n");
1569                 }
1570
1571                 /*
1572                  * Now we need to do one last check...  If we auto-
1573                  * negotiated to HALF DUPLEX, flow control should not be
1574                  * enabled per IEEE 802.3 spec.
1575                  */
1576                 ret_val = mac->ops.get_link_up_info(hw, &speed, &duplex);
1577                 if (ret_val) {
1578                         DEBUGOUT("Error getting link speed and duplex\n");
1579                         goto out;
1580                 }
1581
1582                 if (duplex == HALF_DUPLEX)
1583                         hw->fc.current_mode = e1000_fc_none;
1584
1585                 /*
1586                  * Now we call a subroutine to actually force the MAC
1587                  * controller to use the correct flow control settings.
1588                  */
1589                 ret_val = e1000_force_mac_fc_generic(hw);
1590                 if (ret_val) {
1591                         DEBUGOUT("Error forcing flow control settings\n");
1592                         goto out;
1593                 }
1594         }
1595
1596 out:
1597         return ret_val;
1598 }
1599
1600 /**
1601  *  e1000_get_speed_and_duplex_copper_generic - Retrieve current speed/duplex
1602  *  @hw: pointer to the HW structure
1603  *  @speed: stores the current speed
1604  *  @duplex: stores the current duplex
1605  *
1606  *  Read the status register for the current speed/duplex and store the current
1607  *  speed and duplex for copper connections.
1608  **/
1609 int32_t e1000_get_speed_and_duplex_copper_generic(struct e1000_hw * hw,
1610                                                                                                   uint16_t * speed,
1611                                                                                                   uint16_t * duplex)
1612 {
1613         uint32_t status;
1614
1615         printd("e1000_get_speed_and_duplex_copper_generic");
1616
1617         status = E1000_READ_REG(hw, E1000_STATUS);
1618         if (status & E1000_STATUS_SPEED_1000) {
1619                 *speed = SPEED_1000;
1620                 DEBUGOUT("1000 Mbs, ");
1621         } else if (status & E1000_STATUS_SPEED_100) {
1622                 *speed = SPEED_100;
1623                 DEBUGOUT("100 Mbs, ");
1624         } else {
1625                 *speed = SPEED_10;
1626                 DEBUGOUT("10 Mbs, ");
1627         }
1628
1629         if (status & E1000_STATUS_FD) {
1630                 *duplex = FULL_DUPLEX;
1631                 DEBUGOUT("Full Duplex\n");
1632         } else {
1633                 *duplex = HALF_DUPLEX;
1634                 DEBUGOUT("Half Duplex\n");
1635         }
1636
1637         return E1000_SUCCESS;
1638 }
1639
1640 /**
1641  *  e1000_get_speed_and_duplex_fiber_generic - Retrieve current speed/duplex
1642  *  @hw: pointer to the HW structure
1643  *  @speed: stores the current speed
1644  *  @duplex: stores the current duplex
1645  *
1646  *  Sets the speed and duplex to gigabit full duplex (the only possible option)
1647  *  for fiber/serdes links.
1648  **/
1649 int32_t e1000_get_speed_and_duplex_fiber_serdes_generic(struct e1000_hw * hw,
1650                                                                                                                 uint16_t * speed,
1651                                                                                                                 uint16_t * duplex)
1652 {
1653         printd("e1000_get_speed_and_duplex_fiber_serdes_generic");
1654
1655         *speed = SPEED_1000;
1656         *duplex = FULL_DUPLEX;
1657
1658         return E1000_SUCCESS;
1659 }
1660
1661 /**
1662  *  e1000_get_hw_semaphore_generic - Acquire hardware semaphore
1663  *  @hw: pointer to the HW structure
1664  *
1665  *  Acquire the HW semaphore to access the PHY or NVM
1666  **/
1667 int32_t e1000_get_hw_semaphore_generic(struct e1000_hw * hw)
1668 {
1669 #if 0
1670         u32 swsm;
1671         s32 ret_val = E1000_SUCCESS;
1672         s32 timeout = hw->nvm.word_size + 1;
1673         s32 i = 0;
1674
1675         DEBUGFUNC("e1000_get_hw_semaphore_generic");
1676
1677         /* Get the SW semaphore */
1678         while (i < timeout) {
1679                 swsm = E1000_READ_REG(hw, E1000_SWSM);
1680                 if (!(swsm & E1000_SWSM_SMBI))
1681                         break;
1682
1683                 usec_delay(50);
1684                 i++;
1685         }
1686
1687         if (i == timeout) {
1688                 DEBUGOUT("Driver can't access device - SMBI bit is set.\n");
1689                 ret_val = -E1000_ERR_NVM;
1690                 goto out;
1691         }
1692
1693         /* Get the FW semaphore. */
1694         for (i = 0; i < timeout; i++) {
1695                 swsm = E1000_READ_REG(hw, E1000_SWSM);
1696                 E1000_WRITE_REG(hw, E1000_SWSM, swsm | E1000_SWSM_SWESMBI);
1697
1698                 /* Semaphore acquired if bit latched */
1699                 if (E1000_READ_REG(hw, E1000_SWSM) & E1000_SWSM_SWESMBI)
1700                         break;
1701
1702                 usec_delay(50);
1703         }
1704
1705         if (i == timeout) {
1706                 /* Release semaphores */
1707                 e1000_put_hw_semaphore_generic(hw);
1708                 DEBUGOUT("Driver can't access the NVM\n");
1709                 ret_val = -E1000_ERR_NVM;
1710                 goto out;
1711         }
1712
1713 out:
1714         return ret_val;
1715 #endif
1716         return 0;
1717 }
1718
1719 /**
1720  *  e1000_put_hw_semaphore_generic - Release hardware semaphore
1721  *  @hw: pointer to the HW structure
1722  *
1723  *  Release hardware semaphore used to access the PHY or NVM
1724  **/
1725 void e1000_put_hw_semaphore_generic(struct e1000_hw *hw)
1726 {
1727 #if 0
1728         u32 swsm;
1729
1730         DEBUGFUNC("e1000_put_hw_semaphore_generic");
1731
1732         swsm = E1000_READ_REG(hw, E1000_SWSM);
1733
1734         swsm &= ~(E1000_SWSM_SMBI | E1000_SWSM_SWESMBI);
1735
1736         E1000_WRITE_REG(hw, E1000_SWSM, swsm);
1737 #endif
1738 }
1739
1740 /**
1741  *  e1000_get_auto_rd_done_generic - Check for auto read completion
1742  *  @hw: pointer to the HW structure
1743  *
1744  *  Check EEPROM for Auto Read done bit.
1745  **/
1746 int32_t e1000_get_auto_rd_done_generic(struct e1000_hw *hw)
1747 {
1748         int32_t i = 0;
1749         int32_t ret_val = E1000_SUCCESS;
1750
1751         printd("e1000_get_auto_rd_done_generic");
1752
1753         while (i < AUTO_READ_DONE_TIMEOUT) {
1754                 if (E1000_READ_REG(hw, E1000_EECD) & E1000_EECD_AUTO_RD)
1755                         break;
1756                 msec_delay(1);
1757                 i++;
1758         }
1759
1760         if (i == AUTO_READ_DONE_TIMEOUT) {
1761                 DEBUGOUT("Auto read by HW from NVM has not completed.\n");
1762                 ret_val = -E1000_ERR_RESET;
1763                 goto out;
1764         }
1765
1766 out:
1767         return ret_val;
1768 }
1769
1770 /**
1771  *  e1000_valid_led_default_generic - Verify a valid default LED config
1772  *  @hw: pointer to the HW structure
1773  *  @data: pointer to the NVM (EEPROM)
1774  *
1775  *  Read the EEPROM for the current default LED configuration.  If the
1776  *  LED configuration is not valid, set to a valid LED configuration.
1777  **/
1778 int32_t e1000_valid_led_default_generic(struct e1000_hw * hw, uint16_t * data)
1779 {
1780         int32_t ret_val;
1781
1782         printd("e1000_valid_led_default_generic");
1783
1784         ret_val = hw->nvm.ops.read(hw, NVM_ID_LED_SETTINGS, 1, data);
1785         if (ret_val) {
1786                 DEBUGOUT("NVM Read Error\n");
1787                 goto out;
1788         }
1789
1790         if (*data == ID_LED_RESERVED_0000 || *data == ID_LED_RESERVED_FFFF)
1791                 *data = ID_LED_DEFAULT;
1792
1793 out:
1794         return ret_val;
1795 }
1796
1797 /**
1798  *  e1000_id_led_init_generic -
1799  *  @hw: pointer to the HW structure
1800  *
1801  **/
1802 int32_t e1000_id_led_init_generic(struct e1000_hw * hw)
1803 {
1804 #if 0
1805         struct e1000_mac_info *mac = &hw->mac;
1806         s32 ret_val;
1807         const u32 ledctl_mask = 0x000000FF;
1808         const u32 ledctl_on = E1000_LEDCTL_MODE_LED_ON;
1809         const u32 ledctl_off = E1000_LEDCTL_MODE_LED_OFF;
1810         u16 data, i, temp;
1811         const u16 led_mask = 0x0F;
1812
1813         DEBUGFUNC("e1000_id_led_init_generic");
1814
1815         ret_val = hw->nvm.ops.valid_led_default(hw, &data);
1816         if (ret_val)
1817                 goto out;
1818
1819         mac->ledctl_default = E1000_READ_REG(hw, E1000_LEDCTL);
1820         mac->ledctl_mode1 = mac->ledctl_default;
1821         mac->ledctl_mode2 = mac->ledctl_default;
1822
1823         for (i = 0; i < 4; i++) {
1824                 temp = (data >> (i << 2)) & led_mask;
1825                 switch (temp) {
1826                         case ID_LED_ON1_DEF2:
1827                         case ID_LED_ON1_ON2:
1828                         case ID_LED_ON1_OFF2:
1829                                 mac->ledctl_mode1 &= ~(ledctl_mask << (i << 3));
1830                                 mac->ledctl_mode1 |= ledctl_on << (i << 3);
1831                                 break;
1832                         case ID_LED_OFF1_DEF2:
1833                         case ID_LED_OFF1_ON2:
1834                         case ID_LED_OFF1_OFF2:
1835                                 mac->ledctl_mode1 &= ~(ledctl_mask << (i << 3));
1836                                 mac->ledctl_mode1 |= ledctl_off << (i << 3);
1837                                 break;
1838                         default:
1839                                 /* Do nothing */
1840                                 break;
1841                 }
1842                 switch (temp) {
1843                         case ID_LED_DEF1_ON2:
1844                         case ID_LED_ON1_ON2:
1845                         case ID_LED_OFF1_ON2:
1846                                 mac->ledctl_mode2 &= ~(ledctl_mask << (i << 3));
1847                                 mac->ledctl_mode2 |= ledctl_on << (i << 3);
1848                                 break;
1849                         case ID_LED_DEF1_OFF2:
1850                         case ID_LED_ON1_OFF2:
1851                         case ID_LED_OFF1_OFF2:
1852                                 mac->ledctl_mode2 &= ~(ledctl_mask << (i << 3));
1853                                 mac->ledctl_mode2 |= ledctl_off << (i << 3);
1854                                 break;
1855                         default:
1856                                 /* Do nothing */
1857                                 break;
1858                 }
1859         }
1860
1861 out:
1862         return ret_val;
1863 #endif
1864         return 0;
1865 }
1866
1867 /**
1868  *  e1000_setup_led_generic - Configures SW controllable LED
1869  *  @hw: pointer to the HW structure
1870  *
1871  *  This prepares the SW controllable LED for use and saves the current state
1872  *  of the LED so it can be later restored.
1873  **/
1874 int32_t e1000_setup_led_generic(struct e1000_hw * hw)
1875 {
1876 #if 0
1877         u32 ledctl;
1878         s32 ret_val = E1000_SUCCESS;
1879
1880         DEBUGFUNC("e1000_setup_led_generic");
1881
1882         if (hw->mac.ops.setup_led != e1000_setup_led_generic) {
1883                 ret_val = -E1000_ERR_CONFIG;
1884                 goto out;
1885         }
1886
1887         if (hw->phy.media_type == e1000_media_type_fiber) {
1888                 ledctl = E1000_READ_REG(hw, E1000_LEDCTL);
1889                 hw->mac.ledctl_default = ledctl;
1890                 /* Turn off LED0 */
1891                 ledctl &= ~(E1000_LEDCTL_LED0_IVRT |
1892                                         E1000_LEDCTL_LED0_BLINK | E1000_LEDCTL_LED0_MODE_MASK);
1893                 ledctl |= (E1000_LEDCTL_MODE_LED_OFF << E1000_LEDCTL_LED0_MODE_SHIFT);
1894                 E1000_WRITE_REG(hw, E1000_LEDCTL, ledctl);
1895         } else if (hw->phy.media_type == e1000_media_type_copper) {
1896                 E1000_WRITE_REG(hw, E1000_LEDCTL, hw->mac.ledctl_mode1);
1897         }
1898
1899 out:
1900         return ret_val;
1901 #endif
1902         return 0;
1903 }
1904
1905 /**
1906  *  e1000_cleanup_led_generic - Set LED config to default operation
1907  *  @hw: pointer to the HW structure
1908  *
1909  *  Remove the current LED configuration and set the LED configuration
1910  *  to the default value, saved from the EEPROM.
1911  **/
1912 int32_t e1000_cleanup_led_generic(struct e1000_hw * hw)
1913 {
1914 #if 0
1915         s32 ret_val = E1000_SUCCESS;
1916
1917         DEBUGFUNC("e1000_cleanup_led_generic");
1918
1919         if (hw->mac.ops.cleanup_led != e1000_cleanup_led_generic) {
1920                 ret_val = -E1000_ERR_CONFIG;
1921                 goto out;
1922         }
1923
1924         E1000_WRITE_REG(hw, E1000_LEDCTL, hw->mac.ledctl_default);
1925
1926 out:
1927         return ret_val;
1928 #endif
1929         return 0;
1930 }
1931
1932 /**
1933  *  e1000_blink_led_generic - Blink LED
1934  *  @hw: pointer to the HW structure
1935  *
1936  *  Blink the LEDs which are set to be on.
1937  **/
1938 int32_t e1000_blink_led_generic(struct e1000_hw * hw)
1939 {
1940 #if 0
1941         u32 ledctl_blink = 0;
1942         u32 i;
1943
1944         DEBUGFUNC("e1000_blink_led_generic");
1945
1946         if (hw->phy.media_type == e1000_media_type_fiber) {
1947                 /* always blink LED0 for PCI-E fiber */
1948                 ledctl_blink = E1000_LEDCTL_LED0_BLINK |
1949                         (E1000_LEDCTL_MODE_LED_ON << E1000_LEDCTL_LED0_MODE_SHIFT);
1950         } else {
1951                 /*
1952                  * set the blink bit for each LED that's "on" (0x0E)
1953                  * in ledctl_mode2
1954                  */
1955                 ledctl_blink = hw->mac.ledctl_mode2;
1956                 for (i = 0; i < 4; i++)
1957                         if (((hw->mac.ledctl_mode2 >> (i * 8)) & 0xFF) ==
1958                                 E1000_LEDCTL_MODE_LED_ON)
1959                                 ledctl_blink |= (E1000_LEDCTL_LED0_BLINK << (i * 8));
1960         }
1961
1962         E1000_WRITE_REG(hw, E1000_LEDCTL, ledctl_blink);
1963
1964         return E1000_SUCCESS;
1965 #endif
1966         return 0;
1967 }
1968
1969 /**
1970  *  e1000_led_on_generic - Turn LED on
1971  *  @hw: pointer to the HW structure
1972  *
1973  *  Turn LED on.
1974  **/
1975 int32_t e1000_led_on_generic(struct e1000_hw * hw)
1976 {
1977 #if 0
1978         u32 ctrl;
1979
1980         DEBUGFUNC("e1000_led_on_generic");
1981
1982         switch (hw->phy.media_type) {
1983                 case e1000_media_type_fiber:
1984                         ctrl = E1000_READ_REG(hw, E1000_CTRL);
1985                         ctrl &= ~E1000_CTRL_SWDPIN0;
1986                         ctrl |= E1000_CTRL_SWDPIO0;
1987                         E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
1988                         break;
1989                 case e1000_media_type_copper:
1990                         E1000_WRITE_REG(hw, E1000_LEDCTL, hw->mac.ledctl_mode2);
1991                         break;
1992                 default:
1993                         break;
1994         }
1995
1996         return E1000_SUCCESS;
1997 #endif
1998         return 0;
1999 }
2000
2001 /**
2002  *  e1000_led_off_generic - Turn LED off
2003  *  @hw: pointer to the HW structure
2004  *
2005  *  Turn LED off.
2006  **/
2007 int32_t e1000_led_off_generic(struct e1000_hw * hw)
2008 {
2009 #if 0
2010         u32 ctrl;
2011
2012         DEBUGFUNC("e1000_led_off_generic");
2013
2014         switch (hw->phy.media_type) {
2015                 case e1000_media_type_fiber:
2016                         ctrl = E1000_READ_REG(hw, E1000_CTRL);
2017                         ctrl |= E1000_CTRL_SWDPIN0;
2018                         ctrl |= E1000_CTRL_SWDPIO0;
2019                         E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
2020                         break;
2021                 case e1000_media_type_copper:
2022                         E1000_WRITE_REG(hw, E1000_LEDCTL, hw->mac.ledctl_mode1);
2023                         break;
2024                 default:
2025                         break;
2026         }
2027
2028         return E1000_SUCCESS;
2029 #endif
2030         return 0;
2031 }
2032
2033 /**
2034  *  e1000_set_pcie_no_snoop_generic - Set PCI-express capabilities
2035  *  @hw: pointer to the HW structure
2036  *  @no_snoop: bitmap of snoop events
2037  *
2038  *  Set the PCI-express register to snoop for events enabled in 'no_snoop'.
2039  **/
2040 void e1000_set_pcie_no_snoop_generic(struct e1000_hw *hw, uint32_t no_snoop)
2041 {
2042         uint32_t gcr;
2043
2044         printd("e1000_set_pcie_no_snoop_generic");
2045
2046         if (hw->bus.type != e1000_bus_type_pci_express)
2047                 goto out;
2048
2049         if (no_snoop) {
2050                 gcr = E1000_READ_REG(hw, E1000_GCR);
2051                 gcr &= ~(PCIE_NO_SNOOP_ALL);
2052                 gcr |= no_snoop;
2053                 E1000_WRITE_REG(hw, E1000_GCR, gcr);
2054         }
2055 out:
2056         return;
2057 }
2058
2059 /**
2060  *  e1000_disable_pcie_master_generic - Disables PCI-express master access
2061  *  @hw: pointer to the HW structure
2062  *
2063  *  Returns 0 (E1000_SUCCESS) if successful, else returns -10
2064  *  (-E1000_ERR_MASTER_REQUESTS_PENDING) if master disable bit has not caused
2065  *  the master requests to be disabled.
2066  *
2067  *  Disables PCI-Express master access and verifies there are no pending
2068  *  requests.
2069  **/
2070 int32_t e1000_disable_pcie_master_generic(struct e1000_hw * hw)
2071 {
2072         uint32_t ctrl;
2073         int32_t timeout = MASTER_DISABLE_TIMEOUT;
2074         int32_t ret_val = E1000_SUCCESS;
2075
2076         printd("e1000_disable_pcie_master_generic");
2077
2078         if (hw->bus.type != e1000_bus_type_pci_express)
2079                 goto out;
2080
2081         ctrl = E1000_READ_REG(hw, E1000_CTRL);
2082         ctrl |= E1000_CTRL_GIO_MASTER_DISABLE;
2083         E1000_WRITE_REG(hw, E1000_CTRL, ctrl);
2084
2085         while (timeout) {
2086                 if (!(E1000_READ_REG(hw, E1000_STATUS) &
2087                           E1000_STATUS_GIO_MASTER_ENABLE))
2088                         break;
2089                 usec_delay(100);
2090                 timeout--;
2091         }
2092
2093         if (!timeout) {
2094                 DEBUGOUT("Master requests are pending.\n");
2095                 ret_val = -E1000_ERR_MASTER_REQUESTS_PENDING;
2096                 goto out;
2097         }
2098
2099 out:
2100         return ret_val;
2101 }
2102
2103 /**
2104  *  e1000_reset_adaptive_generic - Reset Adaptive Interframe Spacing
2105  *  @hw: pointer to the HW structure
2106  *
2107  *  Reset the Adaptive Interframe Spacing throttle to default values.
2108  **/
2109 void e1000_reset_adaptive_generic(struct e1000_hw *hw)
2110 {
2111         struct e1000_mac_info *mac = &hw->mac;
2112
2113         printd("e1000_reset_adaptive_generic");
2114
2115         if (!mac->adaptive_ifs) {
2116                 DEBUGOUT("Not in Adaptive IFS mode!\n");
2117                 goto out;
2118         }
2119
2120         mac->current_ifs_val = 0;
2121         mac->ifs_min_val = IFS_MIN;
2122         mac->ifs_max_val = IFS_MAX;
2123         mac->ifs_step_size = IFS_STEP;
2124         mac->ifs_ratio = IFS_RATIO;
2125
2126         mac->in_ifs_mode = false;
2127         E1000_WRITE_REG(hw, E1000_AIT, 0);
2128 out:
2129         return;
2130 }
2131
2132 /**
2133  *  e1000_update_adaptive_generic - Update Adaptive Interframe Spacing
2134  *  @hw: pointer to the HW structure
2135  *
2136  *  Update the Adaptive Interframe Spacing Throttle value based on the
2137  *  time between transmitted packets and time between collisions.
2138  **/
2139 void e1000_update_adaptive_generic(struct e1000_hw *hw)
2140 {
2141         struct e1000_mac_info *mac = &hw->mac;
2142
2143         printd("e1000_update_adaptive_generic");
2144
2145         if (!mac->adaptive_ifs) {
2146                 DEBUGOUT("Not in Adaptive IFS mode!\n");
2147                 goto out;
2148         }
2149
2150         if ((mac->collision_delta * mac->ifs_ratio) > mac->tx_packet_delta) {
2151                 if (mac->tx_packet_delta > MIN_NUM_XMITS) {
2152                         mac->in_ifs_mode = true;
2153                         if (mac->current_ifs_val < mac->ifs_max_val) {
2154                                 if (!mac->current_ifs_val)
2155                                         mac->current_ifs_val = mac->ifs_min_val;
2156                                 else
2157                                         mac->current_ifs_val += mac->ifs_step_size;
2158                                 E1000_WRITE_REG(hw, E1000_AIT, mac->current_ifs_val);
2159                         }
2160                 }
2161         } else {
2162                 if (mac->in_ifs_mode && (mac->tx_packet_delta <= MIN_NUM_XMITS)) {
2163                         mac->current_ifs_val = 0;
2164                         mac->in_ifs_mode = false;
2165                         E1000_WRITE_REG(hw, E1000_AIT, 0);
2166                 }
2167         }
2168 out:
2169         return;
2170 }
2171
2172 /**
2173  *  e1000_validate_mdi_setting_generic - Verify MDI/MDIx settings
2174  *  @hw: pointer to the HW structure
2175  *
2176  *  Verify that when not using auto-negotiation that MDI/MDIx is correctly
2177  *  set, which is forced to MDI mode only.
2178  **/
2179 static int32_t e1000_validate_mdi_setting_generic(struct e1000_hw *hw)
2180 {
2181         int32_t ret_val = E1000_SUCCESS;
2182
2183         printd("e1000_validate_mdi_setting_generic");
2184
2185         if (!hw->mac.autoneg && (hw->phy.mdix == 0 || hw->phy.mdix == 3)) {
2186                 DEBUGOUT("Invalid MDI setting detected\n");
2187                 hw->phy.mdix = 1;
2188                 ret_val = -E1000_ERR_CONFIG;
2189                 goto out;
2190         }
2191
2192 out:
2193         return ret_val;
2194 }