Initial import of binutils 2.22 on the new vendor branch
[dragonfly.git] / sys / dev / netif / e1000 / e1000_api.c
1 /******************************************************************************
2
3   Copyright (c) 2001-2010, Intel Corporation 
4   All rights reserved.
5   
6   Redistribution and use in source and binary forms, with or without 
7   modification, are permitted provided that the following conditions are met:
8   
9    1. Redistributions of source code must retain the above copyright notice, 
10       this list of conditions and the following disclaimer.
11   
12    2. Redistributions in binary form must reproduce the above copyright 
13       notice, this list of conditions and the following disclaimer in the 
14       documentation and/or other materials provided with the distribution.
15   
16    3. Neither the name of the Intel Corporation nor the names of its 
17       contributors may be used to endorse or promote products derived from 
18       this software without specific prior written permission.
19   
20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   POSSIBILITY OF SUCH DAMAGE.
31
32 ******************************************************************************/
33 /*$FreeBSD$*/
34
35 #include "e1000_api.h"
36
37 /**
38  *  e1000_init_mac_params - Initialize MAC function pointers
39  *  @hw: pointer to the HW structure
40  *
41  *  This function initializes the function pointers for the MAC
42  *  set of functions.  Called by drivers or by e1000_setup_init_funcs.
43  **/
44 s32 e1000_init_mac_params(struct e1000_hw *hw)
45 {
46         s32 ret_val = E1000_SUCCESS;
47
48         if (hw->mac.ops.init_params) {
49                 ret_val = hw->mac.ops.init_params(hw);
50                 if (ret_val) {
51                         DEBUGOUT("MAC Initialization Error\n");
52                         goto out;
53                 }
54         } else {
55                 DEBUGOUT("mac.init_mac_params was NULL\n");
56                 ret_val = -E1000_ERR_CONFIG;
57         }
58
59 out:
60         return ret_val;
61 }
62
63 /**
64  *  e1000_init_nvm_params - Initialize NVM function pointers
65  *  @hw: pointer to the HW structure
66  *
67  *  This function initializes the function pointers for the NVM
68  *  set of functions.  Called by drivers or by e1000_setup_init_funcs.
69  **/
70 s32 e1000_init_nvm_params(struct e1000_hw *hw)
71 {
72         s32 ret_val = E1000_SUCCESS;
73
74         if (hw->nvm.ops.init_params) {
75                 ret_val = hw->nvm.ops.init_params(hw);
76                 if (ret_val) {
77                         DEBUGOUT("NVM Initialization Error\n");
78                         goto out;
79                 }
80         } else {
81                 DEBUGOUT("nvm.init_nvm_params was NULL\n");
82                 ret_val = -E1000_ERR_CONFIG;
83         }
84
85 out:
86         return ret_val;
87 }
88
89 /**
90  *  e1000_init_phy_params - Initialize PHY function pointers
91  *  @hw: pointer to the HW structure
92  *
93  *  This function initializes the function pointers for the PHY
94  *  set of functions.  Called by drivers or by e1000_setup_init_funcs.
95  **/
96 s32 e1000_init_phy_params(struct e1000_hw *hw)
97 {
98         s32 ret_val = E1000_SUCCESS;
99
100         if (hw->phy.ops.init_params) {
101                 ret_val = hw->phy.ops.init_params(hw);
102                 if (ret_val) {
103                         DEBUGOUT("PHY Initialization Error\n");
104                         goto out;
105                 }
106         } else {
107                 DEBUGOUT("phy.init_phy_params was NULL\n");
108                 ret_val =  -E1000_ERR_CONFIG;
109         }
110
111 out:
112         return ret_val;
113 }
114
115
116 /**
117  *  e1000_set_mac_type - Sets MAC type
118  *  @hw: pointer to the HW structure
119  *
120  *  This function sets the mac type of the adapter based on the
121  *  device ID stored in the hw structure.
122  *  MUST BE FIRST FUNCTION CALLED (explicitly or through
123  *  e1000_setup_init_funcs()).
124  **/
125 s32 e1000_set_mac_type(struct e1000_hw *hw)
126 {
127         struct e1000_mac_info *mac = &hw->mac;
128         s32 ret_val = E1000_SUCCESS;
129
130         DEBUGFUNC("e1000_set_mac_type");
131
132         switch (hw->device_id) {
133         case E1000_DEV_ID_82542:
134                 mac->type = e1000_82542;
135                 break;
136         case E1000_DEV_ID_82543GC_FIBER:
137         case E1000_DEV_ID_82543GC_COPPER:
138                 mac->type = e1000_82543;
139                 break;
140         case E1000_DEV_ID_82544EI_COPPER:
141         case E1000_DEV_ID_82544EI_FIBER:
142         case E1000_DEV_ID_82544GC_COPPER:
143         case E1000_DEV_ID_82544GC_LOM:
144                 mac->type = e1000_82544;
145                 break;
146         case E1000_DEV_ID_82540EM:
147         case E1000_DEV_ID_82540EM_LOM:
148         case E1000_DEV_ID_82540EP:
149         case E1000_DEV_ID_82540EP_LOM:
150         case E1000_DEV_ID_82540EP_LP:
151                 mac->type = e1000_82540;
152                 break;
153         case E1000_DEV_ID_82545EM_COPPER:
154         case E1000_DEV_ID_82545EM_FIBER:
155                 mac->type = e1000_82545;
156                 break;
157         case E1000_DEV_ID_82545GM_COPPER:
158         case E1000_DEV_ID_82545GM_FIBER:
159         case E1000_DEV_ID_82545GM_SERDES:
160                 mac->type = e1000_82545_rev_3;
161                 break;
162         case E1000_DEV_ID_82546EB_COPPER:
163         case E1000_DEV_ID_82546EB_FIBER:
164         case E1000_DEV_ID_82546EB_QUAD_COPPER:
165                 mac->type = e1000_82546;
166                 break;
167         case E1000_DEV_ID_82546GB_COPPER:
168         case E1000_DEV_ID_82546GB_FIBER:
169         case E1000_DEV_ID_82546GB_SERDES:
170         case E1000_DEV_ID_82546GB_PCIE:
171         case E1000_DEV_ID_82546GB_QUAD_COPPER:
172         case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
173                 mac->type = e1000_82546_rev_3;
174                 break;
175         case E1000_DEV_ID_82541EI:
176         case E1000_DEV_ID_82541EI_MOBILE:
177         case E1000_DEV_ID_82541ER_LOM:
178                 mac->type = e1000_82541;
179                 break;
180         case E1000_DEV_ID_82541ER:
181         case E1000_DEV_ID_82541GI:
182         case E1000_DEV_ID_82541GI_LF:
183         case E1000_DEV_ID_82541GI_MOBILE:
184                 mac->type = e1000_82541_rev_2;
185                 break;
186         case E1000_DEV_ID_82547EI:
187         case E1000_DEV_ID_82547EI_MOBILE:
188                 mac->type = e1000_82547;
189                 break;
190         case E1000_DEV_ID_82547GI:
191                 mac->type = e1000_82547_rev_2;
192                 break;
193         case E1000_DEV_ID_82571EB_COPPER:
194         case E1000_DEV_ID_82571EB_FIBER:
195         case E1000_DEV_ID_82571EB_SERDES:
196         case E1000_DEV_ID_82571EB_SERDES_DUAL:
197         case E1000_DEV_ID_82571EB_SERDES_QUAD:
198         case E1000_DEV_ID_82571EB_QUAD_COPPER:
199         case E1000_DEV_ID_82571PT_QUAD_COPPER:
200         case E1000_DEV_ID_82571EB_QUAD_FIBER:
201         case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
202                 mac->type = e1000_82571;
203                 break;
204         case E1000_DEV_ID_82572EI:
205         case E1000_DEV_ID_82572EI_COPPER:
206         case E1000_DEV_ID_82572EI_FIBER:
207         case E1000_DEV_ID_82572EI_SERDES:
208                 mac->type = e1000_82572;
209                 break;
210         case E1000_DEV_ID_82573E:
211         case E1000_DEV_ID_82573E_IAMT:
212         case E1000_DEV_ID_82573L:
213                 mac->type = e1000_82573;
214                 break;
215         case E1000_DEV_ID_82574L:
216         case E1000_DEV_ID_82574LA:
217                 mac->type = e1000_82574;
218                 break;
219         case E1000_DEV_ID_82583V:
220                 mac->type = e1000_82583;
221                 break;
222         case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
223         case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
224         case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
225         case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
226                 mac->type = e1000_80003es2lan;
227                 break;
228         case E1000_DEV_ID_ICH8_IFE:
229         case E1000_DEV_ID_ICH8_IFE_GT:
230         case E1000_DEV_ID_ICH8_IFE_G:
231         case E1000_DEV_ID_ICH8_IGP_M:
232         case E1000_DEV_ID_ICH8_IGP_M_AMT:
233         case E1000_DEV_ID_ICH8_IGP_AMT:
234         case E1000_DEV_ID_ICH8_IGP_C:
235         case E1000_DEV_ID_ICH8_82567V_3:
236                 mac->type = e1000_ich8lan;
237                 break;
238         case E1000_DEV_ID_ICH9_IFE:
239         case E1000_DEV_ID_ICH9_IFE_GT:
240         case E1000_DEV_ID_ICH9_IFE_G:
241         case E1000_DEV_ID_ICH9_IGP_M:
242         case E1000_DEV_ID_ICH9_IGP_M_AMT:
243         case E1000_DEV_ID_ICH9_IGP_M_V:
244         case E1000_DEV_ID_ICH9_IGP_AMT:
245         case E1000_DEV_ID_ICH9_BM:
246         case E1000_DEV_ID_ICH9_IGP_C:
247         case E1000_DEV_ID_ICH10_R_BM_LM:
248         case E1000_DEV_ID_ICH10_R_BM_LF:
249         case E1000_DEV_ID_ICH10_R_BM_V:
250                 mac->type = e1000_ich9lan;
251                 break;
252         case E1000_DEV_ID_ICH10_D_BM_LM:
253         case E1000_DEV_ID_ICH10_D_BM_LF:
254                 mac->type = e1000_ich10lan;
255                 break;
256         case E1000_DEV_ID_PCH_D_HV_DM:
257         case E1000_DEV_ID_PCH_D_HV_DC:
258         case E1000_DEV_ID_PCH_M_HV_LM:
259         case E1000_DEV_ID_PCH_M_HV_LC:
260                 mac->type = e1000_pchlan;
261                 break;
262         case E1000_DEV_ID_82575EB_COPPER:
263         case E1000_DEV_ID_82575EB_FIBER_SERDES:
264         case E1000_DEV_ID_82575GB_QUAD_COPPER:
265         case E1000_DEV_ID_82575GB_QUAD_COPPER_PM:
266                 mac->type = e1000_82575;
267                 break;
268         case E1000_DEV_ID_82576:
269         case E1000_DEV_ID_82576_FIBER:
270         case E1000_DEV_ID_82576_SERDES:
271         case E1000_DEV_ID_82576_QUAD_COPPER:
272         case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
273         case E1000_DEV_ID_82576_NS:
274         case E1000_DEV_ID_82576_NS_SERDES:
275         case E1000_DEV_ID_82576_SERDES_QUAD:
276                 mac->type = e1000_82576;
277                 break;
278         case E1000_DEV_ID_82580_COPPER:
279         case E1000_DEV_ID_82580_FIBER:
280         case E1000_DEV_ID_82580_SERDES:
281         case E1000_DEV_ID_82580_SGMII:
282         case E1000_DEV_ID_82580_COPPER_DUAL:
283                 mac->type = e1000_82580;
284                 break;
285         default:
286                 /* Should never have loaded on this device */
287                 ret_val = -E1000_ERR_MAC_INIT;
288                 break;
289         }
290
291         return ret_val;
292 }
293
294 /**
295  *  e1000_setup_init_funcs - Initializes function pointers
296  *  @hw: pointer to the HW structure
297  *  @init_device: TRUE will initialize the rest of the function pointers
298  *                 getting the device ready for use.  FALSE will only set
299  *                 MAC type and the function pointers for the other init
300  *                 functions.  Passing FALSE will not generate any hardware
301  *                 reads or writes.
302  *
303  *  This function must be called by a driver in order to use the rest
304  *  of the 'shared' code files. Called by drivers only.
305  **/
306 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
307 {
308         s32 ret_val;
309
310         /* Can't do much good without knowing the MAC type. */
311         ret_val = e1000_set_mac_type(hw);
312         if (ret_val) {
313                 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
314                 goto out;
315         }
316
317         if (!hw->hw_addr) {
318                 DEBUGOUT("ERROR: Registers not mapped\n");
319                 ret_val = -E1000_ERR_CONFIG;
320                 goto out;
321         }
322
323         /*
324          * Init function pointers to generic implementations. We do this first
325          * allowing a driver module to override it afterward.
326          */
327         e1000_init_mac_ops_generic(hw);
328         e1000_init_phy_ops_generic(hw);
329         e1000_init_nvm_ops_generic(hw);
330
331         /*
332          * Set up the init function pointers. These are functions within the
333          * adapter family file that sets up function pointers for the rest of
334          * the functions in that family.
335          */
336         switch (hw->mac.type) {
337         case e1000_82542:
338                 e1000_init_function_pointers_82542(hw);
339                 break;
340         case e1000_82543:
341         case e1000_82544:
342                 e1000_init_function_pointers_82543(hw);
343                 break;
344         case e1000_82540:
345         case e1000_82545:
346         case e1000_82545_rev_3:
347         case e1000_82546:
348         case e1000_82546_rev_3:
349                 e1000_init_function_pointers_82540(hw);
350                 break;
351         case e1000_82541:
352         case e1000_82541_rev_2:
353         case e1000_82547:
354         case e1000_82547_rev_2:
355                 e1000_init_function_pointers_82541(hw);
356                 break;
357         case e1000_82571:
358         case e1000_82572:
359         case e1000_82573:
360         case e1000_82574:
361         case e1000_82583:
362                 e1000_init_function_pointers_82571(hw);
363                 break;
364         case e1000_80003es2lan:
365                 e1000_init_function_pointers_80003es2lan(hw);
366                 break;
367         case e1000_ich8lan:
368         case e1000_ich9lan:
369         case e1000_ich10lan:
370         case e1000_pchlan:
371                 e1000_init_function_pointers_ich8lan(hw);
372                 break;
373         case e1000_82575:
374         case e1000_82576:
375         case e1000_82580:
376                 e1000_init_function_pointers_82575(hw);
377                 break;
378         default:
379                 DEBUGOUT("Hardware not supported\n");
380                 ret_val = -E1000_ERR_CONFIG;
381                 break;
382         }
383
384         /*
385          * Initialize the rest of the function pointers. These require some
386          * register reads/writes in some cases.
387          */
388         if (!(ret_val) && init_device) {
389                 ret_val = e1000_init_mac_params(hw);
390                 if (ret_val)
391                         goto out;
392
393                 ret_val = e1000_init_nvm_params(hw);
394                 if (ret_val)
395                         goto out;
396
397                 ret_val = e1000_init_phy_params(hw);
398                 if (ret_val)
399                         goto out;
400         }
401
402 out:
403         return ret_val;
404 }
405
406 /**
407  *  e1000_get_bus_info - Obtain bus information for adapter
408  *  @hw: pointer to the HW structure
409  *
410  *  This will obtain information about the HW bus for which the
411  *  adapter is attached and stores it in the hw structure. This is a
412  *  function pointer entry point called by drivers.
413  **/
414 s32 e1000_get_bus_info(struct e1000_hw *hw)
415 {
416         if (hw->mac.ops.get_bus_info)
417                 return hw->mac.ops.get_bus_info(hw);
418
419         return E1000_SUCCESS;
420 }
421
422 /**
423  *  e1000_clear_vfta - Clear VLAN filter table
424  *  @hw: pointer to the HW structure
425  *
426  *  This clears the VLAN filter table on the adapter. This is a function
427  *  pointer entry point called by drivers.
428  **/
429 void e1000_clear_vfta(struct e1000_hw *hw)
430 {
431         if (hw->mac.ops.clear_vfta)
432                 hw->mac.ops.clear_vfta(hw);
433 }
434
435 /**
436  *  e1000_write_vfta - Write value to VLAN filter table
437  *  @hw: pointer to the HW structure
438  *  @offset: the 32-bit offset in which to write the value to.
439  *  @value: the 32-bit value to write at location offset.
440  *
441  *  This writes a 32-bit value to a 32-bit offset in the VLAN filter
442  *  table. This is a function pointer entry point called by drivers.
443  **/
444 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
445 {
446         if (hw->mac.ops.write_vfta)
447                 hw->mac.ops.write_vfta(hw, offset, value);
448 }
449
450 /**
451  *  e1000_update_mc_addr_list - Update Multicast addresses
452  *  @hw: pointer to the HW structure
453  *  @mc_addr_list: array of multicast addresses to program
454  *  @mc_addr_count: number of multicast addresses to program
455  *
456  *  Updates the Multicast Table Array.
457  *  The caller must have a packed mc_addr_list of multicast addresses.
458  **/
459 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
460                                u32 mc_addr_count)
461 {
462         if (hw->mac.ops.update_mc_addr_list)
463                 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
464                                                 mc_addr_count);
465 }
466
467 /**
468  *  e1000_force_mac_fc - Force MAC flow control
469  *  @hw: pointer to the HW structure
470  *
471  *  Force the MAC's flow control settings. Currently no func pointer exists
472  *  and all implementations are handled in the generic version of this
473  *  function.
474  **/
475 s32 e1000_force_mac_fc(struct e1000_hw *hw)
476 {
477         return e1000_force_mac_fc_generic(hw);
478 }
479
480 /**
481  *  e1000_check_for_link - Check/Store link connection
482  *  @hw: pointer to the HW structure
483  *
484  *  This checks the link condition of the adapter and stores the
485  *  results in the hw->mac structure. This is a function pointer entry
486  *  point called by drivers.
487  **/
488 s32 e1000_check_for_link(struct e1000_hw *hw)
489 {
490         if (hw->mac.ops.check_for_link)
491                 return hw->mac.ops.check_for_link(hw);
492
493         return -E1000_ERR_CONFIG;
494 }
495
496 /**
497  *  e1000_check_mng_mode - Check management mode
498  *  @hw: pointer to the HW structure
499  *
500  *  This checks if the adapter has manageability enabled.
501  *  This is a function pointer entry point called by drivers.
502  **/
503 bool e1000_check_mng_mode(struct e1000_hw *hw)
504 {
505         if (hw->mac.ops.check_mng_mode)
506                 return hw->mac.ops.check_mng_mode(hw);
507
508         return FALSE;
509 }
510
511 /**
512  *  e1000_mng_write_dhcp_info - Writes DHCP info to host interface
513  *  @hw: pointer to the HW structure
514  *  @buffer: pointer to the host interface
515  *  @length: size of the buffer
516  *
517  *  Writes the DHCP information to the host interface.
518  **/
519 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
520 {
521         return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
522 }
523
524 /**
525  *  e1000_reset_hw - Reset hardware
526  *  @hw: pointer to the HW structure
527  *
528  *  This resets the hardware into a known state. This is a function pointer
529  *  entry point called by drivers.
530  **/
531 s32 e1000_reset_hw(struct e1000_hw *hw)
532 {
533         if (hw->mac.ops.reset_hw)
534                 return hw->mac.ops.reset_hw(hw);
535
536         return -E1000_ERR_CONFIG;
537 }
538
539 /**
540  *  e1000_init_hw - Initialize hardware
541  *  @hw: pointer to the HW structure
542  *
543  *  This inits the hardware readying it for operation. This is a function
544  *  pointer entry point called by drivers.
545  **/
546 s32 e1000_init_hw(struct e1000_hw *hw)
547 {
548         if (hw->mac.ops.init_hw)
549                 return hw->mac.ops.init_hw(hw);
550
551         return -E1000_ERR_CONFIG;
552 }
553
554 /**
555  *  e1000_setup_link - Configures link and flow control
556  *  @hw: pointer to the HW structure
557  *
558  *  This configures link and flow control settings for the adapter. This
559  *  is a function pointer entry point called by drivers. While modules can
560  *  also call this, they probably call their own version of this function.
561  **/
562 s32 e1000_setup_link(struct e1000_hw *hw)
563 {
564         if (hw->mac.ops.setup_link)
565                 return hw->mac.ops.setup_link(hw);
566
567         return -E1000_ERR_CONFIG;
568 }
569
570 /**
571  *  e1000_get_speed_and_duplex - Returns current speed and duplex
572  *  @hw: pointer to the HW structure
573  *  @speed: pointer to a 16-bit value to store the speed
574  *  @duplex: pointer to a 16-bit value to store the duplex.
575  *
576  *  This returns the speed and duplex of the adapter in the two 'out'
577  *  variables passed in. This is a function pointer entry point called
578  *  by drivers.
579  **/
580 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
581 {
582         if (hw->mac.ops.get_link_up_info)
583                 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
584
585         return -E1000_ERR_CONFIG;
586 }
587
588 /**
589  *  e1000_setup_led - Configures SW controllable LED
590  *  @hw: pointer to the HW structure
591  *
592  *  This prepares the SW controllable LED for use and saves the current state
593  *  of the LED so it can be later restored. This is a function pointer entry
594  *  point called by drivers.
595  **/
596 s32 e1000_setup_led(struct e1000_hw *hw)
597 {
598         if (hw->mac.ops.setup_led)
599                 return hw->mac.ops.setup_led(hw);
600
601         return E1000_SUCCESS;
602 }
603
604 /**
605  *  e1000_cleanup_led - Restores SW controllable LED
606  *  @hw: pointer to the HW structure
607  *
608  *  This restores the SW controllable LED to the value saved off by
609  *  e1000_setup_led. This is a function pointer entry point called by drivers.
610  **/
611 s32 e1000_cleanup_led(struct e1000_hw *hw)
612 {
613         if (hw->mac.ops.cleanup_led)
614                 return hw->mac.ops.cleanup_led(hw);
615
616         return E1000_SUCCESS;
617 }
618
619 /**
620  *  e1000_blink_led - Blink SW controllable LED
621  *  @hw: pointer to the HW structure
622  *
623  *  This starts the adapter LED blinking. Request the LED to be setup first
624  *  and cleaned up after. This is a function pointer entry point called by
625  *  drivers.
626  **/
627 s32 e1000_blink_led(struct e1000_hw *hw)
628 {
629         if (hw->mac.ops.blink_led)
630                 return hw->mac.ops.blink_led(hw);
631
632         return E1000_SUCCESS;
633 }
634
635 /**
636  *  e1000_id_led_init - store LED configurations in SW
637  *  @hw: pointer to the HW structure
638  *
639  *  Initializes the LED config in SW. This is a function pointer entry point
640  *  called by drivers.
641  **/
642 s32 e1000_id_led_init(struct e1000_hw *hw)
643 {
644         if (hw->mac.ops.id_led_init)
645                 return hw->mac.ops.id_led_init(hw);
646
647         return E1000_SUCCESS;
648 }
649
650 /**
651  *  e1000_led_on - Turn on SW controllable LED
652  *  @hw: pointer to the HW structure
653  *
654  *  Turns the SW defined LED on. This is a function pointer entry point
655  *  called by drivers.
656  **/
657 s32 e1000_led_on(struct e1000_hw *hw)
658 {
659         if (hw->mac.ops.led_on)
660                 return hw->mac.ops.led_on(hw);
661
662         return E1000_SUCCESS;
663 }
664
665 /**
666  *  e1000_led_off - Turn off SW controllable LED
667  *  @hw: pointer to the HW structure
668  *
669  *  Turns the SW defined LED off. This is a function pointer entry point
670  *  called by drivers.
671  **/
672 s32 e1000_led_off(struct e1000_hw *hw)
673 {
674         if (hw->mac.ops.led_off)
675                 return hw->mac.ops.led_off(hw);
676
677         return E1000_SUCCESS;
678 }
679
680 /**
681  *  e1000_reset_adaptive - Reset adaptive IFS
682  *  @hw: pointer to the HW structure
683  *
684  *  Resets the adaptive IFS. Currently no func pointer exists and all
685  *  implementations are handled in the generic version of this function.
686  **/
687 void e1000_reset_adaptive(struct e1000_hw *hw)
688 {
689         e1000_reset_adaptive_generic(hw);
690 }
691
692 /**
693  *  e1000_update_adaptive - Update adaptive IFS
694  *  @hw: pointer to the HW structure
695  *
696  *  Updates adapter IFS. Currently no func pointer exists and all
697  *  implementations are handled in the generic version of this function.
698  **/
699 void e1000_update_adaptive(struct e1000_hw *hw)
700 {
701         e1000_update_adaptive_generic(hw);
702 }
703
704 /**
705  *  e1000_disable_pcie_master - Disable PCI-Express master access
706  *  @hw: pointer to the HW structure
707  *
708  *  Disables PCI-Express master access and verifies there are no pending
709  *  requests. Currently no func pointer exists and all implementations are
710  *  handled in the generic version of this function.
711  **/
712 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
713 {
714         return e1000_disable_pcie_master_generic(hw);
715 }
716
717 /**
718  *  e1000_config_collision_dist - Configure collision distance
719  *  @hw: pointer to the HW structure
720  *
721  *  Configures the collision distance to the default value and is used
722  *  during link setup.
723  **/
724 void e1000_config_collision_dist(struct e1000_hw *hw)
725 {
726         if (hw->mac.ops.config_collision_dist)
727                 hw->mac.ops.config_collision_dist(hw);
728 }
729
730 /**
731  *  e1000_rar_set - Sets a receive address register
732  *  @hw: pointer to the HW structure
733  *  @addr: address to set the RAR to
734  *  @index: the RAR to set
735  *
736  *  Sets a Receive Address Register (RAR) to the specified address.
737  **/
738 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
739 {
740         if (hw->mac.ops.rar_set)
741                 hw->mac.ops.rar_set(hw, addr, index);
742 }
743
744 /**
745  *  e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
746  *  @hw: pointer to the HW structure
747  *
748  *  Ensures that the MDI/MDIX SW state is valid.
749  **/
750 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
751 {
752         if (hw->mac.ops.validate_mdi_setting)
753                 return hw->mac.ops.validate_mdi_setting(hw);
754
755         return E1000_SUCCESS;
756 }
757
758 /**
759  *  e1000_hash_mc_addr - Determines address location in multicast table
760  *  @hw: pointer to the HW structure
761  *  @mc_addr: Multicast address to hash.
762  *
763  *  This hashes an address to determine its location in the multicast
764  *  table. Currently no func pointer exists and all implementations
765  *  are handled in the generic version of this function.
766  **/
767 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
768 {
769         return e1000_hash_mc_addr_generic(hw, mc_addr);
770 }
771
772 /**
773  *  e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
774  *  @hw: pointer to the HW structure
775  *
776  *  Enables packet filtering on transmit packets if manageability is enabled
777  *  and host interface is enabled.
778  *  Currently no func pointer exists and all implementations are handled in the
779  *  generic version of this function.
780  **/
781 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
782 {
783         return e1000_enable_tx_pkt_filtering_generic(hw);
784 }
785
786 /**
787  *  e1000_mng_host_if_write - Writes to the manageability host interface
788  *  @hw: pointer to the HW structure
789  *  @buffer: pointer to the host interface buffer
790  *  @length: size of the buffer
791  *  @offset: location in the buffer to write to
792  *  @sum: sum of the data (not checksum)
793  *
794  *  This function writes the buffer content at the offset given on the host if.
795  *  It also does alignment considerations to do the writes in most efficient
796  *  way.  Also fills up the sum of the buffer in *buffer parameter.
797  **/
798 s32 e1000_mng_host_if_write(struct e1000_hw * hw, u8 *buffer, u16 length,
799                             u16 offset, u8 *sum)
800 {
801         if (hw->mac.ops.mng_host_if_write)
802                 return hw->mac.ops.mng_host_if_write(hw, buffer, length,
803                                                      offset, sum);
804
805         return E1000_NOT_IMPLEMENTED;
806 }
807
808 /**
809  *  e1000_mng_write_cmd_header - Writes manageability command header
810  *  @hw: pointer to the HW structure
811  *  @hdr: pointer to the host interface command header
812  *
813  *  Writes the command header after does the checksum calculation.
814  **/
815 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
816                                struct e1000_host_mng_command_header *hdr)
817 {
818         if (hw->mac.ops.mng_write_cmd_header)
819                 return hw->mac.ops.mng_write_cmd_header(hw, hdr);
820
821         return E1000_NOT_IMPLEMENTED;
822 }
823
824 /**
825  *  e1000_mng_enable_host_if - Checks host interface is enabled
826  *  @hw: pointer to the HW structure
827  *
828  *  Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
829  *
830  *  This function checks whether the HOST IF is enabled for command operation
831  *  and also checks whether the previous command is completed.  It busy waits
832  *  in case of previous command is not completed.
833  **/
834 s32 e1000_mng_enable_host_if(struct e1000_hw * hw)
835 {
836         if (hw->mac.ops.mng_enable_host_if)
837                 return hw->mac.ops.mng_enable_host_if(hw);
838
839         return E1000_NOT_IMPLEMENTED;
840 }
841
842 /**
843  *  e1000_wait_autoneg - Waits for autonegotiation completion
844  *  @hw: pointer to the HW structure
845  *
846  *  Waits for autoneg to complete. Currently no func pointer exists and all
847  *  implementations are handled in the generic version of this function.
848  **/
849 s32 e1000_wait_autoneg(struct e1000_hw *hw)
850 {
851         if (hw->mac.ops.wait_autoneg)
852                 return hw->mac.ops.wait_autoneg(hw);
853
854         return E1000_SUCCESS;
855 }
856
857 /**
858  *  e1000_check_reset_block - Verifies PHY can be reset
859  *  @hw: pointer to the HW structure
860  *
861  *  Checks if the PHY is in a state that can be reset or if manageability
862  *  has it tied up. This is a function pointer entry point called by drivers.
863  **/
864 s32 e1000_check_reset_block(struct e1000_hw *hw)
865 {
866         if (hw->phy.ops.check_reset_block)
867                 return hw->phy.ops.check_reset_block(hw);
868
869         return E1000_SUCCESS;
870 }
871
872 /**
873  *  e1000_read_phy_reg - Reads PHY register
874  *  @hw: pointer to the HW structure
875  *  @offset: the register to read
876  *  @data: the buffer to store the 16-bit read.
877  *
878  *  Reads the PHY register and returns the value in data.
879  *  This is a function pointer entry point called by drivers.
880  **/
881 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
882 {
883         if (hw->phy.ops.read_reg)
884                 return hw->phy.ops.read_reg(hw, offset, data);
885
886         return E1000_SUCCESS;
887 }
888
889 /**
890  *  e1000_write_phy_reg - Writes PHY register
891  *  @hw: pointer to the HW structure
892  *  @offset: the register to write
893  *  @data: the value to write.
894  *
895  *  Writes the PHY register at offset with the value in data.
896  *  This is a function pointer entry point called by drivers.
897  **/
898 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
899 {
900         if (hw->phy.ops.write_reg)
901                 return hw->phy.ops.write_reg(hw, offset, data);
902
903         return E1000_SUCCESS;
904 }
905
906 /**
907  *  e1000_release_phy - Generic release PHY
908  *  @hw: pointer to the HW structure
909  *
910  *  Return if silicon family does not require a semaphore when accessing the
911  *  PHY.
912  **/
913 void e1000_release_phy(struct e1000_hw *hw)
914 {
915         if (hw->phy.ops.release)
916                 hw->phy.ops.release(hw);
917 }
918
919 /**
920  *  e1000_acquire_phy - Generic acquire PHY
921  *  @hw: pointer to the HW structure
922  *
923  *  Return success if silicon family does not require a semaphore when
924  *  accessing the PHY.
925  **/
926 s32 e1000_acquire_phy(struct e1000_hw *hw)
927 {
928         if (hw->phy.ops.acquire)
929                 return hw->phy.ops.acquire(hw);
930
931         return E1000_SUCCESS;
932 }
933
934 /**
935  *  e1000_cfg_on_link_up - Configure PHY upon link up
936  *  @hw: pointer to the HW structure
937  **/
938 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
939 {
940         if (hw->phy.ops.cfg_on_link_up)
941                 return hw->phy.ops.cfg_on_link_up(hw);
942
943         return E1000_SUCCESS;
944 }
945
946 /**
947  *  e1000_read_kmrn_reg - Reads register using Kumeran interface
948  *  @hw: pointer to the HW structure
949  *  @offset: the register to read
950  *  @data: the location to store the 16-bit value read.
951  *
952  *  Reads a register out of the Kumeran interface. Currently no func pointer
953  *  exists and all implementations are handled in the generic version of
954  *  this function.
955  **/
956 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
957 {
958         return e1000_read_kmrn_reg_generic(hw, offset, data);
959 }
960
961 /**
962  *  e1000_write_kmrn_reg - Writes register using Kumeran interface
963  *  @hw: pointer to the HW structure
964  *  @offset: the register to write
965  *  @data: the value to write.
966  *
967  *  Writes a register to the Kumeran interface. Currently no func pointer
968  *  exists and all implementations are handled in the generic version of
969  *  this function.
970  **/
971 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
972 {
973         return e1000_write_kmrn_reg_generic(hw, offset, data);
974 }
975
976 /**
977  *  e1000_get_cable_length - Retrieves cable length estimation
978  *  @hw: pointer to the HW structure
979  *
980  *  This function estimates the cable length and stores them in
981  *  hw->phy.min_length and hw->phy.max_length. This is a function pointer
982  *  entry point called by drivers.
983  **/
984 s32 e1000_get_cable_length(struct e1000_hw *hw)
985 {
986         if (hw->phy.ops.get_cable_length)
987                 return hw->phy.ops.get_cable_length(hw);
988
989         return E1000_SUCCESS;
990 }
991
992 /**
993  *  e1000_get_phy_info - Retrieves PHY information from registers
994  *  @hw: pointer to the HW structure
995  *
996  *  This function gets some information from various PHY registers and
997  *  populates hw->phy values with it. This is a function pointer entry
998  *  point called by drivers.
999  **/
1000 s32 e1000_get_phy_info(struct e1000_hw *hw)
1001 {
1002         if (hw->phy.ops.get_info)
1003                 return hw->phy.ops.get_info(hw);
1004
1005         return E1000_SUCCESS;
1006 }
1007
1008 /**
1009  *  e1000_phy_hw_reset - Hard PHY reset
1010  *  @hw: pointer to the HW structure
1011  *
1012  *  Performs a hard PHY reset. This is a function pointer entry point called
1013  *  by drivers.
1014  **/
1015 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1016 {
1017         if (hw->phy.ops.reset)
1018                 return hw->phy.ops.reset(hw);
1019
1020         return E1000_SUCCESS;
1021 }
1022
1023 /**
1024  *  e1000_phy_commit - Soft PHY reset
1025  *  @hw: pointer to the HW structure
1026  *
1027  *  Performs a soft PHY reset on those that apply. This is a function pointer
1028  *  entry point called by drivers.
1029  **/
1030 s32 e1000_phy_commit(struct e1000_hw *hw)
1031 {
1032         if (hw->phy.ops.commit)
1033                 return hw->phy.ops.commit(hw);
1034
1035         return E1000_SUCCESS;
1036 }
1037
1038 /**
1039  *  e1000_set_d0_lplu_state - Sets low power link up state for D0
1040  *  @hw: pointer to the HW structure
1041  *  @active: boolean used to enable/disable lplu
1042  *
1043  *  Success returns 0, Failure returns 1
1044  *
1045  *  The low power link up (lplu) state is set to the power management level D0
1046  *  and SmartSpeed is disabled when active is TRUE, else clear lplu for D0
1047  *  and enable Smartspeed.  LPLU and Smartspeed are mutually exclusive.  LPLU
1048  *  is used during Dx states where the power conservation is most important.
1049  *  During driver activity, SmartSpeed should be enabled so performance is
1050  *  maintained.  This is a function pointer entry point called by drivers.
1051  **/
1052 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1053 {
1054         if (hw->phy.ops.set_d0_lplu_state)
1055                 return hw->phy.ops.set_d0_lplu_state(hw, active);
1056
1057         return E1000_SUCCESS;
1058 }
1059
1060 /**
1061  *  e1000_set_d3_lplu_state - Sets low power link up state for D3
1062  *  @hw: pointer to the HW structure
1063  *  @active: boolean used to enable/disable lplu
1064  *
1065  *  Success returns 0, Failure returns 1
1066  *
1067  *  The low power link up (lplu) state is set to the power management level D3
1068  *  and SmartSpeed is disabled when active is TRUE, else clear lplu for D3
1069  *  and enable Smartspeed.  LPLU and Smartspeed are mutually exclusive.  LPLU
1070  *  is used during Dx states where the power conservation is most important.
1071  *  During driver activity, SmartSpeed should be enabled so performance is
1072  *  maintained.  This is a function pointer entry point called by drivers.
1073  **/
1074 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1075 {
1076         if (hw->phy.ops.set_d3_lplu_state)
1077                 return hw->phy.ops.set_d3_lplu_state(hw, active);
1078
1079         return E1000_SUCCESS;
1080 }
1081
1082 /**
1083  *  e1000_read_mac_addr - Reads MAC address
1084  *  @hw: pointer to the HW structure
1085  *
1086  *  Reads the MAC address out of the adapter and stores it in the HW structure.
1087  *  Currently no func pointer exists and all implementations are handled in the
1088  *  generic version of this function.
1089  **/
1090 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1091 {
1092         if (hw->mac.ops.read_mac_addr)
1093                 return hw->mac.ops.read_mac_addr(hw);
1094
1095         return e1000_read_mac_addr_generic(hw);
1096 }
1097
1098 /**
1099  *  e1000_read_pba_num - Read device part number
1100  *  @hw: pointer to the HW structure
1101  *  @pba_num: pointer to device part number
1102  *
1103  *  Reads the product board assembly (PBA) number from the EEPROM and stores
1104  *  the value in pba_num.
1105  *  Currently no func pointer exists and all implementations are handled in the
1106  *  generic version of this function.
1107  **/
1108 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num)
1109 {
1110         return e1000_read_pba_num_generic(hw, pba_num);
1111 }
1112
1113 /**
1114  *  e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1115  *  @hw: pointer to the HW structure
1116  *
1117  *  Validates the NVM checksum is correct. This is a function pointer entry
1118  *  point called by drivers.
1119  **/
1120 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1121 {
1122         if (hw->nvm.ops.validate)
1123                 return hw->nvm.ops.validate(hw);
1124
1125         return -E1000_ERR_CONFIG;
1126 }
1127
1128 /**
1129  *  e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1130  *  @hw: pointer to the HW structure
1131  *
1132  *  Updates the NVM checksum. Currently no func pointer exists and all
1133  *  implementations are handled in the generic version of this function.
1134  **/
1135 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1136 {
1137         if (hw->nvm.ops.update)
1138                 return hw->nvm.ops.update(hw);
1139
1140         return -E1000_ERR_CONFIG;
1141 }
1142
1143 /**
1144  *  e1000_reload_nvm - Reloads EEPROM
1145  *  @hw: pointer to the HW structure
1146  *
1147  *  Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1148  *  extended control register.
1149  **/
1150 void e1000_reload_nvm(struct e1000_hw *hw)
1151 {
1152         if (hw->nvm.ops.reload)
1153                 hw->nvm.ops.reload(hw);
1154 }
1155
1156 /**
1157  *  e1000_read_nvm - Reads NVM (EEPROM)
1158  *  @hw: pointer to the HW structure
1159  *  @offset: the word offset to read
1160  *  @words: number of 16-bit words to read
1161  *  @data: pointer to the properly sized buffer for the data.
1162  *
1163  *  Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1164  *  pointer entry point called by drivers.
1165  **/
1166 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1167 {
1168         if (hw->nvm.ops.read)
1169                 return hw->nvm.ops.read(hw, offset, words, data);
1170
1171         return -E1000_ERR_CONFIG;
1172 }
1173
1174 /**
1175  *  e1000_write_nvm - Writes to NVM (EEPROM)
1176  *  @hw: pointer to the HW structure
1177  *  @offset: the word offset to read
1178  *  @words: number of 16-bit words to write
1179  *  @data: pointer to the properly sized buffer for the data.
1180  *
1181  *  Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1182  *  pointer entry point called by drivers.
1183  **/
1184 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1185 {
1186         if (hw->nvm.ops.write)
1187                 return hw->nvm.ops.write(hw, offset, words, data);
1188
1189         return E1000_SUCCESS;
1190 }
1191
1192 /**
1193  *  e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1194  *  @hw: pointer to the HW structure
1195  *  @reg: 32bit register offset
1196  *  @offset: the register to write
1197  *  @data: the value to write.
1198  *
1199  *  Writes the PHY register at offset with the value in data.
1200  *  This is a function pointer entry point called by drivers.
1201  **/
1202 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1203                               u8 data)
1204 {
1205         return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1206 }
1207
1208 /**
1209  * e1000_power_up_phy - Restores link in case of PHY power down
1210  * @hw: pointer to the HW structure
1211  *
1212  * The phy may be powered down to save power, to turn off link when the
1213  * driver is unloaded, or wake on lan is not enabled (among others).
1214  **/
1215 void e1000_power_up_phy(struct e1000_hw *hw)
1216 {
1217         if (hw->phy.ops.power_up)
1218                 hw->phy.ops.power_up(hw);
1219
1220         e1000_setup_link(hw);
1221 }
1222
1223 /**
1224  * e1000_power_down_phy - Power down PHY
1225  * @hw: pointer to the HW structure
1226  *
1227  * The phy may be powered down to save power, to turn off link when the
1228  * driver is unloaded, or wake on lan is not enabled (among others).
1229  **/
1230 void e1000_power_down_phy(struct e1000_hw *hw)
1231 {
1232         if (hw->phy.ops.power_down)
1233                 hw->phy.ops.power_down(hw);
1234 }
1235
1236 /**
1237  *  e1000_power_up_fiber_serdes_link - Power up serdes link
1238  *  @hw: pointer to the HW structure
1239  *
1240  *  Power on the optics and PCS.
1241  **/
1242 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1243 {
1244         if (hw->mac.ops.power_up_serdes)
1245                 hw->mac.ops.power_up_serdes(hw);
1246 }
1247
1248 /**
1249  *  e1000_shutdown_fiber_serdes_link - Remove link during power down
1250  *  @hw: pointer to the HW structure
1251  *
1252  *  Shutdown the optics and PCS on driver unload.
1253  **/
1254 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1255 {
1256         if (hw->mac.ops.shutdown_serdes)
1257                 hw->mac.ops.shutdown_serdes(hw);
1258 }
1259