1 /*******************************************************************************
3 Copyright (c) 2001-2012, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
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.
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.
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.
32 ***************************************************************************/
34 #include "e1000_api.h"
37 * e1000_init_mac_params - Initialize MAC function pointers
38 * @hw: pointer to the HW structure
40 * This function initializes the function pointers for the MAC
41 * set of functions. Called by drivers or by e1000_setup_init_funcs.
43 s32 e1000_init_mac_params(struct e1000_hw *hw)
45 s32 ret_val = E1000_SUCCESS;
47 if (hw->mac.ops.init_params) {
48 ret_val = hw->mac.ops.init_params(hw);
50 DEBUGOUT("MAC Initialization Error\n");
54 DEBUGOUT("mac.init_mac_params was NULL\n");
55 ret_val = -E1000_ERR_CONFIG;
63 * e1000_init_nvm_params - Initialize NVM function pointers
64 * @hw: pointer to the HW structure
66 * This function initializes the function pointers for the NVM
67 * set of functions. Called by drivers or by e1000_setup_init_funcs.
69 s32 e1000_init_nvm_params(struct e1000_hw *hw)
71 s32 ret_val = E1000_SUCCESS;
73 if (hw->nvm.ops.init_params) {
74 ret_val = hw->nvm.ops.init_params(hw);
76 DEBUGOUT("NVM Initialization Error\n");
80 DEBUGOUT("nvm.init_nvm_params was NULL\n");
81 ret_val = -E1000_ERR_CONFIG;
89 * e1000_init_phy_params - Initialize PHY function pointers
90 * @hw: pointer to the HW structure
92 * This function initializes the function pointers for the PHY
93 * set of functions. Called by drivers or by e1000_setup_init_funcs.
95 s32 e1000_init_phy_params(struct e1000_hw *hw)
97 s32 ret_val = E1000_SUCCESS;
99 if (hw->phy.ops.init_params) {
100 ret_val = hw->phy.ops.init_params(hw);
102 DEBUGOUT("PHY Initialization Error\n");
106 DEBUGOUT("phy.init_phy_params was NULL\n");
107 ret_val = -E1000_ERR_CONFIG;
115 * e1000_init_mbx_params - Initialize mailbox function pointers
116 * @hw: pointer to the HW structure
118 * This function initializes the function pointers for the PHY
119 * set of functions. Called by drivers or by e1000_setup_init_funcs.
121 s32 e1000_init_mbx_params(struct e1000_hw *hw)
123 s32 ret_val = E1000_SUCCESS;
125 if (hw->mbx.ops.init_params) {
126 ret_val = hw->mbx.ops.init_params(hw);
128 DEBUGOUT("Mailbox Initialization Error\n");
132 DEBUGOUT("mbx.init_mbx_params was NULL\n");
133 ret_val = -E1000_ERR_CONFIG;
141 * e1000_set_mac_type - Sets MAC type
142 * @hw: pointer to the HW structure
144 * This function sets the mac type of the adapter based on the
145 * device ID stored in the hw structure.
146 * MUST BE FIRST FUNCTION CALLED (explicitly or through
147 * e1000_setup_init_funcs()).
149 s32 e1000_set_mac_type(struct e1000_hw *hw)
151 struct e1000_mac_info *mac = &hw->mac;
152 s32 ret_val = E1000_SUCCESS;
154 DEBUGFUNC("e1000_set_mac_type");
156 switch (hw->device_id) {
157 case E1000_DEV_ID_82542:
158 mac->type = e1000_82542;
160 case E1000_DEV_ID_82543GC_FIBER:
161 case E1000_DEV_ID_82543GC_COPPER:
162 mac->type = e1000_82543;
164 case E1000_DEV_ID_82544EI_COPPER:
165 case E1000_DEV_ID_82544EI_FIBER:
166 case E1000_DEV_ID_82544GC_COPPER:
167 case E1000_DEV_ID_82544GC_LOM:
168 mac->type = e1000_82544;
170 case E1000_DEV_ID_82540EM:
171 case E1000_DEV_ID_82540EM_LOM:
172 case E1000_DEV_ID_82540EP:
173 case E1000_DEV_ID_82540EP_LOM:
174 case E1000_DEV_ID_82540EP_LP:
175 mac->type = e1000_82540;
177 case E1000_DEV_ID_82545EM_COPPER:
178 case E1000_DEV_ID_82545EM_FIBER:
179 mac->type = e1000_82545;
181 case E1000_DEV_ID_82545GM_COPPER:
182 case E1000_DEV_ID_82545GM_FIBER:
183 case E1000_DEV_ID_82545GM_SERDES:
184 mac->type = e1000_82545_rev_3;
186 case E1000_DEV_ID_82546EB_COPPER:
187 case E1000_DEV_ID_82546EB_FIBER:
188 case E1000_DEV_ID_82546EB_QUAD_COPPER:
189 mac->type = e1000_82546;
191 case E1000_DEV_ID_82546GB_COPPER:
192 case E1000_DEV_ID_82546GB_FIBER:
193 case E1000_DEV_ID_82546GB_SERDES:
194 case E1000_DEV_ID_82546GB_PCIE:
195 case E1000_DEV_ID_82546GB_QUAD_COPPER:
196 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
197 mac->type = e1000_82546_rev_3;
199 case E1000_DEV_ID_82541EI:
200 case E1000_DEV_ID_82541EI_MOBILE:
201 case E1000_DEV_ID_82541ER_LOM:
202 mac->type = e1000_82541;
204 case E1000_DEV_ID_82541ER:
205 case E1000_DEV_ID_82541GI:
206 case E1000_DEV_ID_82541GI_LF:
207 case E1000_DEV_ID_82541GI_MOBILE:
208 mac->type = e1000_82541_rev_2;
210 case E1000_DEV_ID_82547EI:
211 case E1000_DEV_ID_82547EI_MOBILE:
212 mac->type = e1000_82547;
214 case E1000_DEV_ID_82547GI:
215 mac->type = e1000_82547_rev_2;
217 case E1000_DEV_ID_82571EB_COPPER:
218 case E1000_DEV_ID_82571EB_FIBER:
219 case E1000_DEV_ID_82571EB_SERDES:
220 case E1000_DEV_ID_82571EB_SERDES_DUAL:
221 case E1000_DEV_ID_82571EB_SERDES_QUAD:
222 case E1000_DEV_ID_82571EB_QUAD_COPPER:
223 case E1000_DEV_ID_82571PT_QUAD_COPPER:
224 case E1000_DEV_ID_82571EB_QUAD_FIBER:
225 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
226 mac->type = e1000_82571;
228 case E1000_DEV_ID_82572EI:
229 case E1000_DEV_ID_82572EI_COPPER:
230 case E1000_DEV_ID_82572EI_FIBER:
231 case E1000_DEV_ID_82572EI_SERDES:
232 mac->type = e1000_82572;
234 case E1000_DEV_ID_82573E:
235 case E1000_DEV_ID_82573E_IAMT:
236 case E1000_DEV_ID_82573L:
237 mac->type = e1000_82573;
239 case E1000_DEV_ID_82574L:
240 case E1000_DEV_ID_82574LA:
241 mac->type = e1000_82574;
243 case E1000_DEV_ID_82583V:
244 mac->type = e1000_82583;
246 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
247 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
248 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
249 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
250 mac->type = e1000_80003es2lan;
252 case E1000_DEV_ID_ICH8_IFE:
253 case E1000_DEV_ID_ICH8_IFE_GT:
254 case E1000_DEV_ID_ICH8_IFE_G:
255 case E1000_DEV_ID_ICH8_IGP_M:
256 case E1000_DEV_ID_ICH8_IGP_M_AMT:
257 case E1000_DEV_ID_ICH8_IGP_AMT:
258 case E1000_DEV_ID_ICH8_IGP_C:
259 case E1000_DEV_ID_ICH8_82567V_3:
260 mac->type = e1000_ich8lan;
262 case E1000_DEV_ID_ICH9_IFE:
263 case E1000_DEV_ID_ICH9_IFE_GT:
264 case E1000_DEV_ID_ICH9_IFE_G:
265 case E1000_DEV_ID_ICH9_IGP_M:
266 case E1000_DEV_ID_ICH9_IGP_M_AMT:
267 case E1000_DEV_ID_ICH9_IGP_M_V:
268 case E1000_DEV_ID_ICH9_IGP_AMT:
269 case E1000_DEV_ID_ICH9_BM:
270 case E1000_DEV_ID_ICH9_IGP_C:
271 case E1000_DEV_ID_ICH10_R_BM_LM:
272 case E1000_DEV_ID_ICH10_R_BM_LF:
273 case E1000_DEV_ID_ICH10_R_BM_V:
274 mac->type = e1000_ich9lan;
276 case E1000_DEV_ID_ICH10_D_BM_LM:
277 case E1000_DEV_ID_ICH10_D_BM_LF:
278 case E1000_DEV_ID_ICH10_D_BM_V:
279 mac->type = e1000_ich10lan;
281 case E1000_DEV_ID_PCH_D_HV_DM:
282 case E1000_DEV_ID_PCH_D_HV_DC:
283 case E1000_DEV_ID_PCH_M_HV_LM:
284 case E1000_DEV_ID_PCH_M_HV_LC:
285 mac->type = e1000_pchlan;
287 case E1000_DEV_ID_PCH2_LV_LM:
288 case E1000_DEV_ID_PCH2_LV_V:
289 mac->type = e1000_pch2lan;
291 case E1000_DEV_ID_PCH_LPT_I217_LM:
292 case E1000_DEV_ID_PCH_LPT_I217_V:
293 case E1000_DEV_ID_PCH_LPTLP_I218_LM:
294 case E1000_DEV_ID_PCH_LPTLP_I218_V:
295 #ifdef NAHUM6_LPTH_I218_HW
296 case E1000_DEV_ID_PCH_I218_LM2:
297 case E1000_DEV_ID_PCH_I218_V2:
298 #endif /* NAHUM6_LPTH_I218_HW */
300 case E1000_DEV_ID_PCH_I218_LM3:
301 case E1000_DEV_ID_PCH_I218_V3:
302 #endif /* NAHUM6_WPT_HW */
303 mac->type = e1000_pch_lpt;
305 case E1000_DEV_ID_82575EB_COPPER:
306 case E1000_DEV_ID_82575EB_FIBER_SERDES:
307 case E1000_DEV_ID_82575GB_QUAD_COPPER:
308 mac->type = e1000_82575;
310 case E1000_DEV_ID_82576:
311 case E1000_DEV_ID_82576_FIBER:
312 case E1000_DEV_ID_82576_SERDES:
313 case E1000_DEV_ID_82576_QUAD_COPPER:
314 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
315 case E1000_DEV_ID_82576_NS:
316 case E1000_DEV_ID_82576_NS_SERDES:
317 case E1000_DEV_ID_82576_SERDES_QUAD:
318 mac->type = e1000_82576;
320 case E1000_DEV_ID_82580_COPPER:
321 case E1000_DEV_ID_82580_FIBER:
322 case E1000_DEV_ID_82580_SERDES:
323 case E1000_DEV_ID_82580_SGMII:
324 case E1000_DEV_ID_82580_COPPER_DUAL:
325 case E1000_DEV_ID_82580_QUAD_FIBER:
326 case E1000_DEV_ID_DH89XXCC_SGMII:
327 case E1000_DEV_ID_DH89XXCC_SERDES:
328 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
329 case E1000_DEV_ID_DH89XXCC_SFP:
330 mac->type = e1000_82580;
332 case E1000_DEV_ID_I350_COPPER:
333 case E1000_DEV_ID_I350_FIBER:
334 case E1000_DEV_ID_I350_SERDES:
335 case E1000_DEV_ID_I350_SGMII:
336 case E1000_DEV_ID_I350_DA4:
337 mac->type = e1000_i350;
339 case E1000_DEV_ID_I210_COPPER_FLASHLESS:
340 case E1000_DEV_ID_I210_SERDES_FLASHLESS:
341 case E1000_DEV_ID_I210_COPPER:
342 case E1000_DEV_ID_I210_COPPER_OEM1:
343 case E1000_DEV_ID_I210_COPPER_IT:
344 case E1000_DEV_ID_I210_FIBER:
345 case E1000_DEV_ID_I210_SERDES:
346 case E1000_DEV_ID_I210_SGMII:
347 mac->type = e1000_i210;
349 case E1000_DEV_ID_I211_COPPER:
350 mac->type = e1000_i211;
352 case E1000_DEV_ID_82576_VF:
353 case E1000_DEV_ID_82576_VF_HV:
354 mac->type = e1000_vfadapt;
356 case E1000_DEV_ID_I350_VF:
357 case E1000_DEV_ID_I350_VF_HV:
358 mac->type = e1000_vfadapt_i350;
361 case E1000_DEV_ID_I354_BACKPLANE_1GBPS:
362 case E1000_DEV_ID_I354_SGMII:
363 case E1000_DEV_ID_I354_BACKPLANE_2_5GBPS:
364 mac->type = e1000_i354;
367 /* Should never have loaded on this device */
368 ret_val = -E1000_ERR_MAC_INIT;
376 * e1000_setup_init_funcs - Initializes function pointers
377 * @hw: pointer to the HW structure
378 * @init_device: true will initialize the rest of the function pointers
379 * getting the device ready for use. false will only set
380 * MAC type and the function pointers for the other init
381 * functions. Passing false will not generate any hardware
384 * This function must be called by a driver in order to use the rest
385 * of the 'shared' code files. Called by drivers only.
387 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
391 /* Can't do much good without knowing the MAC type. */
392 ret_val = e1000_set_mac_type(hw);
394 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
399 DEBUGOUT("ERROR: Registers not mapped\n");
400 ret_val = -E1000_ERR_CONFIG;
405 * Init function pointers to generic implementations. We do this first
406 * allowing a driver module to override it afterward.
408 e1000_init_mac_ops_generic(hw);
409 e1000_init_phy_ops_generic(hw);
410 e1000_init_nvm_ops_generic(hw);
411 e1000_init_mbx_ops_generic(hw);
414 * Set up the init function pointers. These are functions within the
415 * adapter family file that sets up function pointers for the rest of
416 * the functions in that family.
418 switch (hw->mac.type) {
420 e1000_init_function_pointers_82542(hw);
424 e1000_init_function_pointers_82543(hw);
428 case e1000_82545_rev_3:
430 case e1000_82546_rev_3:
431 e1000_init_function_pointers_82540(hw);
434 case e1000_82541_rev_2:
436 case e1000_82547_rev_2:
437 e1000_init_function_pointers_82541(hw);
444 e1000_init_function_pointers_82571(hw);
446 case e1000_80003es2lan:
447 e1000_init_function_pointers_80003es2lan(hw);
455 e1000_init_function_pointers_ich8lan(hw);
462 e1000_init_function_pointers_82575(hw);
466 e1000_init_function_pointers_i210(hw);
469 e1000_init_function_pointers_vf(hw);
471 case e1000_vfadapt_i350:
472 e1000_init_function_pointers_vf(hw);
475 DEBUGOUT("Hardware not supported\n");
476 ret_val = -E1000_ERR_CONFIG;
481 * Initialize the rest of the function pointers. These require some
482 * register reads/writes in some cases.
484 if (!(ret_val) && init_device) {
485 ret_val = e1000_init_mac_params(hw);
489 ret_val = e1000_init_nvm_params(hw);
493 ret_val = e1000_init_phy_params(hw);
497 ret_val = e1000_init_mbx_params(hw);
507 * e1000_get_bus_info - Obtain bus information for adapter
508 * @hw: pointer to the HW structure
510 * This will obtain information about the HW bus for which the
511 * adapter is attached and stores it in the hw structure. This is a
512 * function pointer entry point called by drivers.
514 s32 e1000_get_bus_info(struct e1000_hw *hw)
516 if (hw->mac.ops.get_bus_info)
517 return hw->mac.ops.get_bus_info(hw);
519 return E1000_SUCCESS;
523 * e1000_clear_vfta - Clear VLAN filter table
524 * @hw: pointer to the HW structure
526 * This clears the VLAN filter table on the adapter. This is a function
527 * pointer entry point called by drivers.
529 void e1000_clear_vfta(struct e1000_hw *hw)
531 if (hw->mac.ops.clear_vfta)
532 hw->mac.ops.clear_vfta(hw);
536 * e1000_write_vfta - Write value to VLAN filter table
537 * @hw: pointer to the HW structure
538 * @offset: the 32-bit offset in which to write the value to.
539 * @value: the 32-bit value to write at location offset.
541 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
542 * table. This is a function pointer entry point called by drivers.
544 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
546 if (hw->mac.ops.write_vfta)
547 hw->mac.ops.write_vfta(hw, offset, value);
551 * e1000_update_mc_addr_list - Update Multicast addresses
552 * @hw: pointer to the HW structure
553 * @mc_addr_list: array of multicast addresses to program
554 * @mc_addr_count: number of multicast addresses to program
556 * Updates the Multicast Table Array.
557 * The caller must have a packed mc_addr_list of multicast addresses.
559 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
562 if (hw->mac.ops.update_mc_addr_list)
563 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
568 * e1000_force_mac_fc - Force MAC flow control
569 * @hw: pointer to the HW structure
571 * Force the MAC's flow control settings. Currently no func pointer exists
572 * and all implementations are handled in the generic version of this
575 s32 e1000_force_mac_fc(struct e1000_hw *hw)
577 return e1000_force_mac_fc_generic(hw);
581 * e1000_check_for_link - Check/Store link connection
582 * @hw: pointer to the HW structure
584 * This checks the link condition of the adapter and stores the
585 * results in the hw->mac structure. This is a function pointer entry
586 * point called by drivers.
588 s32 e1000_check_for_link(struct e1000_hw *hw)
590 if (hw->mac.ops.check_for_link)
591 return hw->mac.ops.check_for_link(hw);
593 return -E1000_ERR_CONFIG;
597 * e1000_check_mng_mode - Check management mode
598 * @hw: pointer to the HW structure
600 * This checks if the adapter has manageability enabled.
601 * This is a function pointer entry point called by drivers.
603 bool e1000_check_mng_mode(struct e1000_hw *hw)
605 if (hw->mac.ops.check_mng_mode)
606 return hw->mac.ops.check_mng_mode(hw);
612 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
613 * @hw: pointer to the HW structure
614 * @buffer: pointer to the host interface
615 * @length: size of the buffer
617 * Writes the DHCP information to the host interface.
619 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
621 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
625 * e1000_reset_hw - Reset hardware
626 * @hw: pointer to the HW structure
628 * This resets the hardware into a known state. This is a function pointer
629 * entry point called by drivers.
631 s32 e1000_reset_hw(struct e1000_hw *hw)
633 if (hw->mac.ops.reset_hw)
634 return hw->mac.ops.reset_hw(hw);
636 return -E1000_ERR_CONFIG;
640 * e1000_init_hw - Initialize hardware
641 * @hw: pointer to the HW structure
643 * This inits the hardware readying it for operation. This is a function
644 * pointer entry point called by drivers.
646 s32 e1000_init_hw(struct e1000_hw *hw)
648 if (hw->mac.ops.init_hw)
649 return hw->mac.ops.init_hw(hw);
651 return -E1000_ERR_CONFIG;
655 * e1000_setup_link - Configures link and flow control
656 * @hw: pointer to the HW structure
658 * This configures link and flow control settings for the adapter. This
659 * is a function pointer entry point called by drivers. While modules can
660 * also call this, they probably call their own version of this function.
662 s32 e1000_setup_link(struct e1000_hw *hw)
664 if (hw->mac.ops.setup_link)
665 return hw->mac.ops.setup_link(hw);
667 return -E1000_ERR_CONFIG;
671 * e1000_get_speed_and_duplex - Returns current speed and duplex
672 * @hw: pointer to the HW structure
673 * @speed: pointer to a 16-bit value to store the speed
674 * @duplex: pointer to a 16-bit value to store the duplex.
676 * This returns the speed and duplex of the adapter in the two 'out'
677 * variables passed in. This is a function pointer entry point called
680 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
682 if (hw->mac.ops.get_link_up_info)
683 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
685 return -E1000_ERR_CONFIG;
689 * e1000_setup_led - Configures SW controllable LED
690 * @hw: pointer to the HW structure
692 * This prepares the SW controllable LED for use and saves the current state
693 * of the LED so it can be later restored. This is a function pointer entry
694 * point called by drivers.
696 s32 e1000_setup_led(struct e1000_hw *hw)
698 if (hw->mac.ops.setup_led)
699 return hw->mac.ops.setup_led(hw);
701 return E1000_SUCCESS;
705 * e1000_cleanup_led - Restores SW controllable LED
706 * @hw: pointer to the HW structure
708 * This restores the SW controllable LED to the value saved off by
709 * e1000_setup_led. This is a function pointer entry point called by drivers.
711 s32 e1000_cleanup_led(struct e1000_hw *hw)
713 if (hw->mac.ops.cleanup_led)
714 return hw->mac.ops.cleanup_led(hw);
716 return E1000_SUCCESS;
720 * e1000_blink_led - Blink SW controllable LED
721 * @hw: pointer to the HW structure
723 * This starts the adapter LED blinking. Request the LED to be setup first
724 * and cleaned up after. This is a function pointer entry point called by
727 s32 e1000_blink_led(struct e1000_hw *hw)
729 if (hw->mac.ops.blink_led)
730 return hw->mac.ops.blink_led(hw);
732 return E1000_SUCCESS;
736 * e1000_id_led_init - store LED configurations in SW
737 * @hw: pointer to the HW structure
739 * Initializes the LED config in SW. This is a function pointer entry point
742 s32 e1000_id_led_init(struct e1000_hw *hw)
744 if (hw->mac.ops.id_led_init)
745 return hw->mac.ops.id_led_init(hw);
747 return E1000_SUCCESS;
751 * e1000_led_on - Turn on SW controllable LED
752 * @hw: pointer to the HW structure
754 * Turns the SW defined LED on. This is a function pointer entry point
757 s32 e1000_led_on(struct e1000_hw *hw)
759 if (hw->mac.ops.led_on)
760 return hw->mac.ops.led_on(hw);
762 return E1000_SUCCESS;
766 * e1000_led_off - Turn off SW controllable LED
767 * @hw: pointer to the HW structure
769 * Turns the SW defined LED off. This is a function pointer entry point
772 s32 e1000_led_off(struct e1000_hw *hw)
774 if (hw->mac.ops.led_off)
775 return hw->mac.ops.led_off(hw);
777 return E1000_SUCCESS;
781 * e1000_reset_adaptive - Reset adaptive IFS
782 * @hw: pointer to the HW structure
784 * Resets the adaptive IFS. Currently no func pointer exists and all
785 * implementations are handled in the generic version of this function.
787 void e1000_reset_adaptive(struct e1000_hw *hw)
789 e1000_reset_adaptive_generic(hw);
793 * e1000_update_adaptive - Update adaptive IFS
794 * @hw: pointer to the HW structure
796 * Updates adapter IFS. Currently no func pointer exists and all
797 * implementations are handled in the generic version of this function.
799 void e1000_update_adaptive(struct e1000_hw *hw)
801 e1000_update_adaptive_generic(hw);
805 * e1000_disable_pcie_master - Disable PCI-Express master access
806 * @hw: pointer to the HW structure
808 * Disables PCI-Express master access and verifies there are no pending
809 * requests. Currently no func pointer exists and all implementations are
810 * handled in the generic version of this function.
812 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
814 return e1000_disable_pcie_master_generic(hw);
818 * e1000_config_collision_dist - Configure collision distance
819 * @hw: pointer to the HW structure
821 * Configures the collision distance to the default value and is used
824 void e1000_config_collision_dist(struct e1000_hw *hw)
826 if (hw->mac.ops.config_collision_dist)
827 hw->mac.ops.config_collision_dist(hw);
831 * e1000_rar_set - Sets a receive address register
832 * @hw: pointer to the HW structure
833 * @addr: address to set the RAR to
834 * @index: the RAR to set
836 * Sets a Receive Address Register (RAR) to the specified address.
838 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
840 if (hw->mac.ops.rar_set)
841 hw->mac.ops.rar_set(hw, addr, index);
845 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
846 * @hw: pointer to the HW structure
848 * Ensures that the MDI/MDIX SW state is valid.
850 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
852 if (hw->mac.ops.validate_mdi_setting)
853 return hw->mac.ops.validate_mdi_setting(hw);
855 return E1000_SUCCESS;
859 * e1000_hash_mc_addr - Determines address location in multicast table
860 * @hw: pointer to the HW structure
861 * @mc_addr: Multicast address to hash.
863 * This hashes an address to determine its location in the multicast
864 * table. Currently no func pointer exists and all implementations
865 * are handled in the generic version of this function.
867 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
869 return e1000_hash_mc_addr_generic(hw, mc_addr);
873 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
874 * @hw: pointer to the HW structure
876 * Enables packet filtering on transmit packets if manageability is enabled
877 * and host interface is enabled.
878 * Currently no func pointer exists and all implementations are handled in the
879 * generic version of this function.
881 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
883 return e1000_enable_tx_pkt_filtering_generic(hw);
887 * e1000_mng_host_if_write - Writes to the manageability host interface
888 * @hw: pointer to the HW structure
889 * @buffer: pointer to the host interface buffer
890 * @length: size of the buffer
891 * @offset: location in the buffer to write to
892 * @sum: sum of the data (not checksum)
894 * This function writes the buffer content at the offset given on the host if.
895 * It also does alignment considerations to do the writes in most efficient
896 * way. Also fills up the sum of the buffer in *buffer parameter.
898 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
901 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
905 * e1000_mng_write_cmd_header - Writes manageability command header
906 * @hw: pointer to the HW structure
907 * @hdr: pointer to the host interface command header
909 * Writes the command header after does the checksum calculation.
911 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
912 struct e1000_host_mng_command_header *hdr)
914 return e1000_mng_write_cmd_header_generic(hw, hdr);
918 * e1000_mng_enable_host_if - Checks host interface is enabled
919 * @hw: pointer to the HW structure
921 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
923 * This function checks whether the HOST IF is enabled for command operation
924 * and also checks whether the previous command is completed. It busy waits
925 * in case of previous command is not completed.
927 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
929 return e1000_mng_enable_host_if_generic(hw);
933 * e1000_check_reset_block - Verifies PHY can be reset
934 * @hw: pointer to the HW structure
936 * Checks if the PHY is in a state that can be reset or if manageability
937 * has it tied up. This is a function pointer entry point called by drivers.
939 s32 e1000_check_reset_block(struct e1000_hw *hw)
941 if (hw->phy.ops.check_reset_block)
942 return hw->phy.ops.check_reset_block(hw);
944 return E1000_SUCCESS;
948 * e1000_read_phy_reg - Reads PHY register
949 * @hw: pointer to the HW structure
950 * @offset: the register to read
951 * @data: the buffer to store the 16-bit read.
953 * Reads the PHY register and returns the value in data.
954 * This is a function pointer entry point called by drivers.
956 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
958 if (hw->phy.ops.read_reg)
959 return hw->phy.ops.read_reg(hw, offset, data);
961 return E1000_SUCCESS;
965 * e1000_write_phy_reg - Writes PHY register
966 * @hw: pointer to the HW structure
967 * @offset: the register to write
968 * @data: the value to write.
970 * Writes the PHY register at offset with the value in data.
971 * This is a function pointer entry point called by drivers.
973 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
975 if (hw->phy.ops.write_reg)
976 return hw->phy.ops.write_reg(hw, offset, data);
978 return E1000_SUCCESS;
982 * e1000_release_phy - Generic release PHY
983 * @hw: pointer to the HW structure
985 * Return if silicon family does not require a semaphore when accessing the
988 void e1000_release_phy(struct e1000_hw *hw)
990 if (hw->phy.ops.release)
991 hw->phy.ops.release(hw);
995 * e1000_acquire_phy - Generic acquire PHY
996 * @hw: pointer to the HW structure
998 * Return success if silicon family does not require a semaphore when
1001 s32 e1000_acquire_phy(struct e1000_hw *hw)
1003 if (hw->phy.ops.acquire)
1004 return hw->phy.ops.acquire(hw);
1006 return E1000_SUCCESS;
1010 * e1000_cfg_on_link_up - Configure PHY upon link up
1011 * @hw: pointer to the HW structure
1013 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1015 if (hw->phy.ops.cfg_on_link_up)
1016 return hw->phy.ops.cfg_on_link_up(hw);
1018 return E1000_SUCCESS;
1022 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1023 * @hw: pointer to the HW structure
1024 * @offset: the register to read
1025 * @data: the location to store the 16-bit value read.
1027 * Reads a register out of the Kumeran interface. Currently no func pointer
1028 * exists and all implementations are handled in the generic version of
1031 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1033 return e1000_read_kmrn_reg_generic(hw, offset, data);
1037 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1038 * @hw: pointer to the HW structure
1039 * @offset: the register to write
1040 * @data: the value to write.
1042 * Writes a register to the Kumeran interface. Currently no func pointer
1043 * exists and all implementations are handled in the generic version of
1046 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1048 return e1000_write_kmrn_reg_generic(hw, offset, data);
1052 * e1000_get_cable_length - Retrieves cable length estimation
1053 * @hw: pointer to the HW structure
1055 * This function estimates the cable length and stores them in
1056 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1057 * entry point called by drivers.
1059 s32 e1000_get_cable_length(struct e1000_hw *hw)
1061 if (hw->phy.ops.get_cable_length)
1062 return hw->phy.ops.get_cable_length(hw);
1064 return E1000_SUCCESS;
1068 * e1000_get_phy_info - Retrieves PHY information from registers
1069 * @hw: pointer to the HW structure
1071 * This function gets some information from various PHY registers and
1072 * populates hw->phy values with it. This is a function pointer entry
1073 * point called by drivers.
1075 s32 e1000_get_phy_info(struct e1000_hw *hw)
1077 if (hw->phy.ops.get_info)
1078 return hw->phy.ops.get_info(hw);
1080 return E1000_SUCCESS;
1084 * e1000_phy_hw_reset - Hard PHY reset
1085 * @hw: pointer to the HW structure
1087 * Performs a hard PHY reset. This is a function pointer entry point called
1090 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1092 if (hw->phy.ops.reset)
1093 return hw->phy.ops.reset(hw);
1095 return E1000_SUCCESS;
1099 * e1000_phy_commit - Soft PHY reset
1100 * @hw: pointer to the HW structure
1102 * Performs a soft PHY reset on those that apply. This is a function pointer
1103 * entry point called by drivers.
1105 s32 e1000_phy_commit(struct e1000_hw *hw)
1107 if (hw->phy.ops.commit)
1108 return hw->phy.ops.commit(hw);
1110 return E1000_SUCCESS;
1114 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1115 * @hw: pointer to the HW structure
1116 * @active: boolean used to enable/disable lplu
1118 * Success returns 0, Failure returns 1
1120 * The low power link up (lplu) state is set to the power management level D0
1121 * and SmartSpeed is disabled when active is true, else clear lplu for D0
1122 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1123 * is used during Dx states where the power conservation is most important.
1124 * During driver activity, SmartSpeed should be enabled so performance is
1125 * maintained. This is a function pointer entry point called by drivers.
1127 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1129 if (hw->phy.ops.set_d0_lplu_state)
1130 return hw->phy.ops.set_d0_lplu_state(hw, active);
1132 return E1000_SUCCESS;
1136 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1137 * @hw: pointer to the HW structure
1138 * @active: boolean used to enable/disable lplu
1140 * Success returns 0, Failure returns 1
1142 * The low power link up (lplu) state is set to the power management level D3
1143 * and SmartSpeed is disabled when active is true, else clear lplu for D3
1144 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1145 * is used during Dx states where the power conservation is most important.
1146 * During driver activity, SmartSpeed should be enabled so performance is
1147 * maintained. This is a function pointer entry point called by drivers.
1149 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1151 if (hw->phy.ops.set_d3_lplu_state)
1152 return hw->phy.ops.set_d3_lplu_state(hw, active);
1154 return E1000_SUCCESS;
1158 * e1000_read_mac_addr - Reads MAC address
1159 * @hw: pointer to the HW structure
1161 * Reads the MAC address out of the adapter and stores it in the HW structure.
1162 * Currently no func pointer exists and all implementations are handled in the
1163 * generic version of this function.
1165 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1167 if (hw->mac.ops.read_mac_addr)
1168 return hw->mac.ops.read_mac_addr(hw);
1170 return e1000_read_mac_addr_generic(hw);
1174 * e1000_read_pba_string - Read device part number string
1175 * @hw: pointer to the HW structure
1176 * @pba_num: pointer to device part number
1177 * @pba_num_size: size of part number buffer
1179 * Reads the product board assembly (PBA) number from the EEPROM and stores
1180 * the value in pba_num.
1181 * Currently no func pointer exists and all implementations are handled in the
1182 * generic version of this function.
1184 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1186 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1190 * e1000_read_pba_length - Read device part number string length
1191 * @hw: pointer to the HW structure
1192 * @pba_num_size: size of part number buffer
1194 * Reads the product board assembly (PBA) number length from the EEPROM and
1195 * stores the value in pba_num.
1196 * Currently no func pointer exists and all implementations are handled in the
1197 * generic version of this function.
1199 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1201 return e1000_read_pba_length_generic(hw, pba_num_size);
1205 * e1000_read_pba_num - Read device part number
1206 * @hw: pointer to the HW structure
1207 * @pba_num: pointer to device part number
1209 * Reads the product board assembly (PBA) number from the EEPROM and stores
1210 * the value in pba_num.
1211 * Currently no func pointer exists and all implementations are handled in the
1212 * generic version of this function.
1214 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num)
1216 return e1000_read_pba_num_generic(hw, pba_num);
1220 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1221 * @hw: pointer to the HW structure
1223 * Validates the NVM checksum is correct. This is a function pointer entry
1224 * point called by drivers.
1226 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1228 if (hw->nvm.ops.validate)
1229 return hw->nvm.ops.validate(hw);
1231 return -E1000_ERR_CONFIG;
1235 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1236 * @hw: pointer to the HW structure
1238 * Updates the NVM checksum. Currently no func pointer exists and all
1239 * implementations are handled in the generic version of this function.
1241 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1243 if (hw->nvm.ops.update)
1244 return hw->nvm.ops.update(hw);
1246 return -E1000_ERR_CONFIG;
1250 * e1000_reload_nvm - Reloads EEPROM
1251 * @hw: pointer to the HW structure
1253 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1254 * extended control register.
1256 void e1000_reload_nvm(struct e1000_hw *hw)
1258 if (hw->nvm.ops.reload)
1259 hw->nvm.ops.reload(hw);
1263 * e1000_read_nvm - Reads NVM (EEPROM)
1264 * @hw: pointer to the HW structure
1265 * @offset: the word offset to read
1266 * @words: number of 16-bit words to read
1267 * @data: pointer to the properly sized buffer for the data.
1269 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1270 * pointer entry point called by drivers.
1272 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1274 if (hw->nvm.ops.read)
1275 return hw->nvm.ops.read(hw, offset, words, data);
1277 return -E1000_ERR_CONFIG;
1281 * e1000_write_nvm - Writes to NVM (EEPROM)
1282 * @hw: pointer to the HW structure
1283 * @offset: the word offset to read
1284 * @words: number of 16-bit words to write
1285 * @data: pointer to the properly sized buffer for the data.
1287 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1288 * pointer entry point called by drivers.
1290 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1292 if (hw->nvm.ops.write)
1293 return hw->nvm.ops.write(hw, offset, words, data);
1295 return E1000_SUCCESS;
1299 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1300 * @hw: pointer to the HW structure
1301 * @reg: 32bit register offset
1302 * @offset: the register to write
1303 * @data: the value to write.
1305 * Writes the PHY register at offset with the value in data.
1306 * This is a function pointer entry point called by drivers.
1308 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1311 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1315 * e1000_power_up_phy - Restores link in case of PHY power down
1316 * @hw: pointer to the HW structure
1318 * The phy may be powered down to save power, to turn off link when the
1319 * driver is unloaded, or wake on lan is not enabled (among others).
1321 void e1000_power_up_phy(struct e1000_hw *hw)
1323 if (hw->phy.ops.power_up)
1324 hw->phy.ops.power_up(hw);
1326 e1000_setup_link(hw);
1330 * e1000_power_down_phy - Power down PHY
1331 * @hw: pointer to the HW structure
1333 * The phy may be powered down to save power, to turn off link when the
1334 * driver is unloaded, or wake on lan is not enabled (among others).
1336 void e1000_power_down_phy(struct e1000_hw *hw)
1338 if (hw->phy.ops.power_down)
1339 hw->phy.ops.power_down(hw);
1343 * e1000_power_up_fiber_serdes_link - Power up serdes link
1344 * @hw: pointer to the HW structure
1346 * Power on the optics and PCS.
1348 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1350 if (hw->mac.ops.power_up_serdes)
1351 hw->mac.ops.power_up_serdes(hw);
1355 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1356 * @hw: pointer to the HW structure
1358 * Shutdown the optics and PCS on driver unload.
1360 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1362 if (hw->mac.ops.shutdown_serdes)
1363 hw->mac.ops.shutdown_serdes(hw);