1 /******************************************************************************
3 Copyright (c) 2001-2013, 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 ******************************************************************************/
35 #include "e1000_api.h"
38 * e1000_init_mac_params - Initialize MAC function pointers
39 * @hw: pointer to the HW structure
41 * This function initializes the function pointers for the MAC
42 * set of functions. Called by drivers or by e1000_setup_init_funcs.
44 s32 e1000_init_mac_params(struct e1000_hw *hw)
46 s32 ret_val = E1000_SUCCESS;
48 if (hw->mac.ops.init_params) {
49 ret_val = hw->mac.ops.init_params(hw);
51 DEBUGOUT("MAC Initialization Error\n");
55 DEBUGOUT("mac.init_mac_params was NULL\n");
56 ret_val = -E1000_ERR_CONFIG;
64 * e1000_init_nvm_params - Initialize NVM function pointers
65 * @hw: pointer to the HW structure
67 * This function initializes the function pointers for the NVM
68 * set of functions. Called by drivers or by e1000_setup_init_funcs.
70 s32 e1000_init_nvm_params(struct e1000_hw *hw)
72 s32 ret_val = E1000_SUCCESS;
74 if (hw->nvm.ops.init_params) {
75 ret_val = hw->nvm.ops.init_params(hw);
77 DEBUGOUT("NVM Initialization Error\n");
81 DEBUGOUT("nvm.init_nvm_params was NULL\n");
82 ret_val = -E1000_ERR_CONFIG;
90 * e1000_init_phy_params - Initialize PHY function pointers
91 * @hw: pointer to the HW structure
93 * This function initializes the function pointers for the PHY
94 * set of functions. Called by drivers or by e1000_setup_init_funcs.
96 s32 e1000_init_phy_params(struct e1000_hw *hw)
98 s32 ret_val = E1000_SUCCESS;
100 if (hw->phy.ops.init_params) {
101 ret_val = hw->phy.ops.init_params(hw);
103 DEBUGOUT("PHY Initialization Error\n");
107 DEBUGOUT("phy.init_phy_params was NULL\n");
108 ret_val = -E1000_ERR_CONFIG;
116 * e1000_init_mbx_params - Initialize mailbox function pointers
117 * @hw: pointer to the HW structure
119 * This function initializes the function pointers for the PHY
120 * set of functions. Called by drivers or by e1000_setup_init_funcs.
122 s32 e1000_init_mbx_params(struct e1000_hw *hw)
124 s32 ret_val = E1000_SUCCESS;
126 if (hw->mbx.ops.init_params) {
127 ret_val = hw->mbx.ops.init_params(hw);
129 DEBUGOUT("Mailbox Initialization Error\n");
133 DEBUGOUT("mbx.init_mbx_params was NULL\n");
134 ret_val = -E1000_ERR_CONFIG;
142 * e1000_set_mac_type - Sets MAC type
143 * @hw: pointer to the HW structure
145 * This function sets the mac type of the adapter based on the
146 * device ID stored in the hw structure.
147 * MUST BE FIRST FUNCTION CALLED (explicitly or through
148 * e1000_setup_init_funcs()).
150 s32 e1000_set_mac_type(struct e1000_hw *hw)
152 struct e1000_mac_info *mac = &hw->mac;
153 s32 ret_val = E1000_SUCCESS;
155 DEBUGFUNC("e1000_set_mac_type");
157 switch (hw->device_id) {
158 case E1000_DEV_ID_82542:
159 mac->type = e1000_82542;
161 case E1000_DEV_ID_82543GC_FIBER:
162 case E1000_DEV_ID_82543GC_COPPER:
163 mac->type = e1000_82543;
165 case E1000_DEV_ID_82544EI_COPPER:
166 case E1000_DEV_ID_82544EI_FIBER:
167 case E1000_DEV_ID_82544GC_COPPER:
168 case E1000_DEV_ID_82544GC_LOM:
169 mac->type = e1000_82544;
171 case E1000_DEV_ID_82540EM:
172 case E1000_DEV_ID_82540EM_LOM:
173 case E1000_DEV_ID_82540EP:
174 case E1000_DEV_ID_82540EP_LOM:
175 case E1000_DEV_ID_82540EP_LP:
176 mac->type = e1000_82540;
178 case E1000_DEV_ID_82545EM_COPPER:
179 case E1000_DEV_ID_82545EM_FIBER:
180 mac->type = e1000_82545;
182 case E1000_DEV_ID_82545GM_COPPER:
183 case E1000_DEV_ID_82545GM_FIBER:
184 case E1000_DEV_ID_82545GM_SERDES:
185 mac->type = e1000_82545_rev_3;
187 case E1000_DEV_ID_82546EB_COPPER:
188 case E1000_DEV_ID_82546EB_FIBER:
189 case E1000_DEV_ID_82546EB_QUAD_COPPER:
190 mac->type = e1000_82546;
192 case E1000_DEV_ID_82546GB_COPPER:
193 case E1000_DEV_ID_82546GB_FIBER:
194 case E1000_DEV_ID_82546GB_SERDES:
195 case E1000_DEV_ID_82546GB_PCIE:
196 case E1000_DEV_ID_82546GB_QUAD_COPPER:
197 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
198 mac->type = e1000_82546_rev_3;
200 case E1000_DEV_ID_82541EI:
201 case E1000_DEV_ID_82541EI_MOBILE:
202 case E1000_DEV_ID_82541ER_LOM:
203 mac->type = e1000_82541;
205 case E1000_DEV_ID_82541ER:
206 case E1000_DEV_ID_82541GI:
207 case E1000_DEV_ID_82541GI_LF:
208 case E1000_DEV_ID_82541GI_MOBILE:
209 mac->type = e1000_82541_rev_2;
211 case E1000_DEV_ID_82547EI:
212 case E1000_DEV_ID_82547EI_MOBILE:
213 mac->type = e1000_82547;
215 case E1000_DEV_ID_82547GI:
216 mac->type = e1000_82547_rev_2;
218 case E1000_DEV_ID_82571EB_COPPER:
219 case E1000_DEV_ID_82571EB_FIBER:
220 case E1000_DEV_ID_82571EB_SERDES:
221 case E1000_DEV_ID_82571EB_SERDES_DUAL:
222 case E1000_DEV_ID_82571EB_SERDES_QUAD:
223 case E1000_DEV_ID_82571EB_QUAD_COPPER:
224 case E1000_DEV_ID_82571PT_QUAD_COPPER:
225 case E1000_DEV_ID_82571EB_QUAD_FIBER:
226 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
227 mac->type = e1000_82571;
229 case E1000_DEV_ID_82572EI:
230 case E1000_DEV_ID_82572EI_COPPER:
231 case E1000_DEV_ID_82572EI_FIBER:
232 case E1000_DEV_ID_82572EI_SERDES:
233 mac->type = e1000_82572;
235 case E1000_DEV_ID_82573E:
236 case E1000_DEV_ID_82573E_IAMT:
237 case E1000_DEV_ID_82573L:
238 mac->type = e1000_82573;
240 case E1000_DEV_ID_82574L:
241 case E1000_DEV_ID_82574LA:
242 mac->type = e1000_82574;
244 case E1000_DEV_ID_82583V:
245 mac->type = e1000_82583;
247 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
248 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
249 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
250 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
251 mac->type = e1000_80003es2lan;
253 case E1000_DEV_ID_ICH8_IFE:
254 case E1000_DEV_ID_ICH8_IFE_GT:
255 case E1000_DEV_ID_ICH8_IFE_G:
256 case E1000_DEV_ID_ICH8_IGP_M:
257 case E1000_DEV_ID_ICH8_IGP_M_AMT:
258 case E1000_DEV_ID_ICH8_IGP_AMT:
259 case E1000_DEV_ID_ICH8_IGP_C:
260 case E1000_DEV_ID_ICH8_82567V_3:
261 mac->type = e1000_ich8lan;
263 case E1000_DEV_ID_ICH9_IFE:
264 case E1000_DEV_ID_ICH9_IFE_GT:
265 case E1000_DEV_ID_ICH9_IFE_G:
266 case E1000_DEV_ID_ICH9_IGP_M:
267 case E1000_DEV_ID_ICH9_IGP_M_AMT:
268 case E1000_DEV_ID_ICH9_IGP_M_V:
269 case E1000_DEV_ID_ICH9_IGP_AMT:
270 case E1000_DEV_ID_ICH9_BM:
271 case E1000_DEV_ID_ICH9_IGP_C:
272 case E1000_DEV_ID_ICH10_R_BM_LM:
273 case E1000_DEV_ID_ICH10_R_BM_LF:
274 case E1000_DEV_ID_ICH10_R_BM_V:
275 mac->type = e1000_ich9lan;
277 case E1000_DEV_ID_ICH10_D_BM_LM:
278 case E1000_DEV_ID_ICH10_D_BM_LF:
279 case E1000_DEV_ID_ICH10_D_BM_V:
280 mac->type = e1000_ich10lan;
282 case E1000_DEV_ID_PCH_D_HV_DM:
283 case E1000_DEV_ID_PCH_D_HV_DC:
284 case E1000_DEV_ID_PCH_M_HV_LM:
285 case E1000_DEV_ID_PCH_M_HV_LC:
286 mac->type = e1000_pchlan;
288 case E1000_DEV_ID_PCH2_LV_LM:
289 case E1000_DEV_ID_PCH2_LV_V:
290 mac->type = e1000_pch2lan;
292 case E1000_DEV_ID_PCH_LPT_I217_LM:
293 case E1000_DEV_ID_PCH_LPT_I217_V:
294 case E1000_DEV_ID_PCH_LPTLP_I218_LM:
295 case E1000_DEV_ID_PCH_LPTLP_I218_V:
296 mac->type = e1000_pch_lpt;
298 case E1000_DEV_ID_82575EB_COPPER:
299 case E1000_DEV_ID_82575EB_FIBER_SERDES:
300 case E1000_DEV_ID_82575GB_QUAD_COPPER:
301 mac->type = e1000_82575;
303 case E1000_DEV_ID_82576:
304 case E1000_DEV_ID_82576_FIBER:
305 case E1000_DEV_ID_82576_SERDES:
306 case E1000_DEV_ID_82576_QUAD_COPPER:
307 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
308 case E1000_DEV_ID_82576_NS:
309 case E1000_DEV_ID_82576_NS_SERDES:
310 case E1000_DEV_ID_82576_SERDES_QUAD:
311 mac->type = e1000_82576;
313 case E1000_DEV_ID_82580_COPPER:
314 case E1000_DEV_ID_82580_FIBER:
315 case E1000_DEV_ID_82580_SERDES:
316 case E1000_DEV_ID_82580_SGMII:
317 case E1000_DEV_ID_82580_COPPER_DUAL:
318 case E1000_DEV_ID_82580_QUAD_FIBER:
319 case E1000_DEV_ID_DH89XXCC_SGMII:
320 case E1000_DEV_ID_DH89XXCC_SERDES:
321 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
322 case E1000_DEV_ID_DH89XXCC_SFP:
323 mac->type = e1000_82580;
325 case E1000_DEV_ID_I350_COPPER:
326 case E1000_DEV_ID_I350_FIBER:
327 case E1000_DEV_ID_I350_SERDES:
328 case E1000_DEV_ID_I350_SGMII:
329 case E1000_DEV_ID_I350_DA4:
330 mac->type = e1000_i350;
332 #if defined(QV_RELEASE) && defined(SPRINGVILLE_FLASHLESS_HW)
333 case E1000_DEV_ID_I210_NVMLESS:
334 #endif /* QV_RELEASE && SPRINGVILLE_FLASHLESS_HW */
335 case E1000_DEV_ID_I210_COPPER:
336 case E1000_DEV_ID_I210_COPPER_OEM1:
337 case E1000_DEV_ID_I210_COPPER_IT:
338 case E1000_DEV_ID_I210_FIBER:
339 case E1000_DEV_ID_I210_SERDES:
340 case E1000_DEV_ID_I210_SGMII:
341 mac->type = e1000_i210;
343 case E1000_DEV_ID_I211_COPPER:
344 mac->type = e1000_i211;
346 case E1000_DEV_ID_82576_VF:
347 case E1000_DEV_ID_82576_VF_HV:
348 mac->type = e1000_vfadapt;
350 case E1000_DEV_ID_I350_VF:
351 case E1000_DEV_ID_I350_VF_HV:
352 mac->type = e1000_vfadapt_i350;
356 /* Should never have loaded on this device */
357 ret_val = -E1000_ERR_MAC_INIT;
365 * e1000_setup_init_funcs - Initializes function pointers
366 * @hw: pointer to the HW structure
367 * @init_device: TRUE will initialize the rest of the function pointers
368 * getting the device ready for use. FALSE will only set
369 * MAC type and the function pointers for the other init
370 * functions. Passing FALSE will not generate any hardware
373 * This function must be called by a driver in order to use the rest
374 * of the 'shared' code files. Called by drivers only.
376 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
380 /* Can't do much good without knowing the MAC type. */
381 ret_val = e1000_set_mac_type(hw);
383 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
388 DEBUGOUT("ERROR: Registers not mapped\n");
389 ret_val = -E1000_ERR_CONFIG;
394 * Init function pointers to generic implementations. We do this first
395 * allowing a driver module to override it afterward.
397 e1000_init_mac_ops_generic(hw);
398 e1000_init_phy_ops_generic(hw);
399 e1000_init_nvm_ops_generic(hw);
400 e1000_init_mbx_ops_generic(hw);
403 * Set up the init function pointers. These are functions within the
404 * adapter family file that sets up function pointers for the rest of
405 * the functions in that family.
407 switch (hw->mac.type) {
409 e1000_init_function_pointers_82542(hw);
413 e1000_init_function_pointers_82543(hw);
417 case e1000_82545_rev_3:
419 case e1000_82546_rev_3:
420 e1000_init_function_pointers_82540(hw);
423 case e1000_82541_rev_2:
425 case e1000_82547_rev_2:
426 e1000_init_function_pointers_82541(hw);
433 e1000_init_function_pointers_82571(hw);
435 case e1000_80003es2lan:
436 e1000_init_function_pointers_80003es2lan(hw);
444 e1000_init_function_pointers_ich8lan(hw);
450 e1000_init_function_pointers_82575(hw);
454 e1000_init_function_pointers_i210(hw);
457 e1000_init_function_pointers_vf(hw);
459 case e1000_vfadapt_i350:
460 e1000_init_function_pointers_vf(hw);
463 DEBUGOUT("Hardware not supported\n");
464 ret_val = -E1000_ERR_CONFIG;
469 * Initialize the rest of the function pointers. These require some
470 * register reads/writes in some cases.
472 if (!(ret_val) && init_device) {
473 ret_val = e1000_init_mac_params(hw);
477 ret_val = e1000_init_nvm_params(hw);
481 ret_val = e1000_init_phy_params(hw);
485 ret_val = e1000_init_mbx_params(hw);
495 * e1000_get_bus_info - Obtain bus information for adapter
496 * @hw: pointer to the HW structure
498 * This will obtain information about the HW bus for which the
499 * adapter is attached and stores it in the hw structure. This is a
500 * function pointer entry point called by drivers.
502 s32 e1000_get_bus_info(struct e1000_hw *hw)
504 if (hw->mac.ops.get_bus_info)
505 return hw->mac.ops.get_bus_info(hw);
507 return E1000_SUCCESS;
511 * e1000_clear_vfta - Clear VLAN filter table
512 * @hw: pointer to the HW structure
514 * This clears the VLAN filter table on the adapter. This is a function
515 * pointer entry point called by drivers.
517 void e1000_clear_vfta(struct e1000_hw *hw)
519 if (hw->mac.ops.clear_vfta)
520 hw->mac.ops.clear_vfta(hw);
524 * e1000_write_vfta - Write value to VLAN filter table
525 * @hw: pointer to the HW structure
526 * @offset: the 32-bit offset in which to write the value to.
527 * @value: the 32-bit value to write at location offset.
529 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
530 * table. This is a function pointer entry point called by drivers.
532 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
534 if (hw->mac.ops.write_vfta)
535 hw->mac.ops.write_vfta(hw, offset, value);
539 * e1000_update_mc_addr_list - Update Multicast addresses
540 * @hw: pointer to the HW structure
541 * @mc_addr_list: array of multicast addresses to program
542 * @mc_addr_count: number of multicast addresses to program
544 * Updates the Multicast Table Array.
545 * The caller must have a packed mc_addr_list of multicast addresses.
547 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
550 if (hw->mac.ops.update_mc_addr_list)
551 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
556 * e1000_force_mac_fc - Force MAC flow control
557 * @hw: pointer to the HW structure
559 * Force the MAC's flow control settings. Currently no func pointer exists
560 * and all implementations are handled in the generic version of this
563 s32 e1000_force_mac_fc(struct e1000_hw *hw)
565 return e1000_force_mac_fc_generic(hw);
569 * e1000_check_for_link - Check/Store link connection
570 * @hw: pointer to the HW structure
572 * This checks the link condition of the adapter and stores the
573 * results in the hw->mac structure. This is a function pointer entry
574 * point called by drivers.
576 s32 e1000_check_for_link(struct e1000_hw *hw)
578 if (hw->mac.ops.check_for_link)
579 return hw->mac.ops.check_for_link(hw);
581 return -E1000_ERR_CONFIG;
585 * e1000_check_mng_mode - Check management mode
586 * @hw: pointer to the HW structure
588 * This checks if the adapter has manageability enabled.
589 * This is a function pointer entry point called by drivers.
591 bool e1000_check_mng_mode(struct e1000_hw *hw)
593 if (hw->mac.ops.check_mng_mode)
594 return hw->mac.ops.check_mng_mode(hw);
600 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
601 * @hw: pointer to the HW structure
602 * @buffer: pointer to the host interface
603 * @length: size of the buffer
605 * Writes the DHCP information to the host interface.
607 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
609 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
613 * e1000_reset_hw - Reset hardware
614 * @hw: pointer to the HW structure
616 * This resets the hardware into a known state. This is a function pointer
617 * entry point called by drivers.
619 s32 e1000_reset_hw(struct e1000_hw *hw)
621 if (hw->mac.ops.reset_hw)
622 return hw->mac.ops.reset_hw(hw);
624 return -E1000_ERR_CONFIG;
628 * e1000_init_hw - Initialize hardware
629 * @hw: pointer to the HW structure
631 * This inits the hardware readying it for operation. This is a function
632 * pointer entry point called by drivers.
634 s32 e1000_init_hw(struct e1000_hw *hw)
636 if (hw->mac.ops.init_hw)
637 return hw->mac.ops.init_hw(hw);
639 return -E1000_ERR_CONFIG;
643 * e1000_setup_link - Configures link and flow control
644 * @hw: pointer to the HW structure
646 * This configures link and flow control settings for the adapter. This
647 * is a function pointer entry point called by drivers. While modules can
648 * also call this, they probably call their own version of this function.
650 s32 e1000_setup_link(struct e1000_hw *hw)
652 if (hw->mac.ops.setup_link)
653 return hw->mac.ops.setup_link(hw);
655 return -E1000_ERR_CONFIG;
659 * e1000_get_speed_and_duplex - Returns current speed and duplex
660 * @hw: pointer to the HW structure
661 * @speed: pointer to a 16-bit value to store the speed
662 * @duplex: pointer to a 16-bit value to store the duplex.
664 * This returns the speed and duplex of the adapter in the two 'out'
665 * variables passed in. This is a function pointer entry point called
668 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
670 if (hw->mac.ops.get_link_up_info)
671 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
673 return -E1000_ERR_CONFIG;
677 * e1000_setup_led - Configures SW controllable LED
678 * @hw: pointer to the HW structure
680 * This prepares the SW controllable LED for use and saves the current state
681 * of the LED so it can be later restored. This is a function pointer entry
682 * point called by drivers.
684 s32 e1000_setup_led(struct e1000_hw *hw)
686 if (hw->mac.ops.setup_led)
687 return hw->mac.ops.setup_led(hw);
689 return E1000_SUCCESS;
693 * e1000_cleanup_led - Restores SW controllable LED
694 * @hw: pointer to the HW structure
696 * This restores the SW controllable LED to the value saved off by
697 * e1000_setup_led. This is a function pointer entry point called by drivers.
699 s32 e1000_cleanup_led(struct e1000_hw *hw)
701 if (hw->mac.ops.cleanup_led)
702 return hw->mac.ops.cleanup_led(hw);
704 return E1000_SUCCESS;
708 * e1000_blink_led - Blink SW controllable LED
709 * @hw: pointer to the HW structure
711 * This starts the adapter LED blinking. Request the LED to be setup first
712 * and cleaned up after. This is a function pointer entry point called by
715 s32 e1000_blink_led(struct e1000_hw *hw)
717 if (hw->mac.ops.blink_led)
718 return hw->mac.ops.blink_led(hw);
720 return E1000_SUCCESS;
724 * e1000_id_led_init - store LED configurations in SW
725 * @hw: pointer to the HW structure
727 * Initializes the LED config in SW. This is a function pointer entry point
730 s32 e1000_id_led_init(struct e1000_hw *hw)
732 if (hw->mac.ops.id_led_init)
733 return hw->mac.ops.id_led_init(hw);
735 return E1000_SUCCESS;
739 * e1000_led_on - Turn on SW controllable LED
740 * @hw: pointer to the HW structure
742 * Turns the SW defined LED on. This is a function pointer entry point
745 s32 e1000_led_on(struct e1000_hw *hw)
747 if (hw->mac.ops.led_on)
748 return hw->mac.ops.led_on(hw);
750 return E1000_SUCCESS;
754 * e1000_led_off - Turn off SW controllable LED
755 * @hw: pointer to the HW structure
757 * Turns the SW defined LED off. This is a function pointer entry point
760 s32 e1000_led_off(struct e1000_hw *hw)
762 if (hw->mac.ops.led_off)
763 return hw->mac.ops.led_off(hw);
765 return E1000_SUCCESS;
769 * e1000_reset_adaptive - Reset adaptive IFS
770 * @hw: pointer to the HW structure
772 * Resets the adaptive IFS. Currently no func pointer exists and all
773 * implementations are handled in the generic version of this function.
775 void e1000_reset_adaptive(struct e1000_hw *hw)
777 e1000_reset_adaptive_generic(hw);
781 * e1000_update_adaptive - Update adaptive IFS
782 * @hw: pointer to the HW structure
784 * Updates adapter IFS. Currently no func pointer exists and all
785 * implementations are handled in the generic version of this function.
787 void e1000_update_adaptive(struct e1000_hw *hw)
789 e1000_update_adaptive_generic(hw);
793 * e1000_disable_pcie_master - Disable PCI-Express master access
794 * @hw: pointer to the HW structure
796 * Disables PCI-Express master access and verifies there are no pending
797 * requests. Currently no func pointer exists and all implementations are
798 * handled in the generic version of this function.
800 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
802 return e1000_disable_pcie_master_generic(hw);
806 * e1000_config_collision_dist - Configure collision distance
807 * @hw: pointer to the HW structure
809 * Configures the collision distance to the default value and is used
812 void e1000_config_collision_dist(struct e1000_hw *hw)
814 if (hw->mac.ops.config_collision_dist)
815 hw->mac.ops.config_collision_dist(hw);
819 * e1000_rar_set - Sets a receive address register
820 * @hw: pointer to the HW structure
821 * @addr: address to set the RAR to
822 * @index: the RAR to set
824 * Sets a Receive Address Register (RAR) to the specified address.
826 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
828 if (hw->mac.ops.rar_set)
829 hw->mac.ops.rar_set(hw, addr, index);
833 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
834 * @hw: pointer to the HW structure
836 * Ensures that the MDI/MDIX SW state is valid.
838 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
840 if (hw->mac.ops.validate_mdi_setting)
841 return hw->mac.ops.validate_mdi_setting(hw);
843 return E1000_SUCCESS;
847 * e1000_hash_mc_addr - Determines address location in multicast table
848 * @hw: pointer to the HW structure
849 * @mc_addr: Multicast address to hash.
851 * This hashes an address to determine its location in the multicast
852 * table. Currently no func pointer exists and all implementations
853 * are handled in the generic version of this function.
855 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
857 return e1000_hash_mc_addr_generic(hw, mc_addr);
861 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
862 * @hw: pointer to the HW structure
864 * Enables packet filtering on transmit packets if manageability is enabled
865 * and host interface is enabled.
866 * Currently no func pointer exists and all implementations are handled in the
867 * generic version of this function.
869 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
871 return e1000_enable_tx_pkt_filtering_generic(hw);
875 * e1000_mng_host_if_write - Writes to the manageability host interface
876 * @hw: pointer to the HW structure
877 * @buffer: pointer to the host interface buffer
878 * @length: size of the buffer
879 * @offset: location in the buffer to write to
880 * @sum: sum of the data (not checksum)
882 * This function writes the buffer content at the offset given on the host if.
883 * It also does alignment considerations to do the writes in most efficient
884 * way. Also fills up the sum of the buffer in *buffer parameter.
886 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
889 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
893 * e1000_mng_write_cmd_header - Writes manageability command header
894 * @hw: pointer to the HW structure
895 * @hdr: pointer to the host interface command header
897 * Writes the command header after does the checksum calculation.
899 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
900 struct e1000_host_mng_command_header *hdr)
902 return e1000_mng_write_cmd_header_generic(hw, hdr);
906 * e1000_mng_enable_host_if - Checks host interface is enabled
907 * @hw: pointer to the HW structure
909 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
911 * This function checks whether the HOST IF is enabled for command operation
912 * and also checks whether the previous command is completed. It busy waits
913 * in case of previous command is not completed.
915 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
917 return e1000_mng_enable_host_if_generic(hw);
921 * e1000_set_obff_timer - Set Optimized Buffer Flush/Fill timer
922 * @hw: pointer to the HW structure
923 * @itr: u32 indicating itr value
925 * Set the OBFF timer based on the given interrupt rate.
927 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr)
929 if (hw->mac.ops.set_obff_timer)
930 return hw->mac.ops.set_obff_timer(hw, itr);
932 return E1000_SUCCESS;
936 * e1000_check_reset_block - Verifies PHY can be reset
937 * @hw: pointer to the HW structure
939 * Checks if the PHY is in a state that can be reset or if manageability
940 * has it tied up. This is a function pointer entry point called by drivers.
942 s32 e1000_check_reset_block(struct e1000_hw *hw)
944 if (hw->phy.ops.check_reset_block)
945 return hw->phy.ops.check_reset_block(hw);
947 return E1000_SUCCESS;
951 * e1000_read_phy_reg - Reads PHY register
952 * @hw: pointer to the HW structure
953 * @offset: the register to read
954 * @data: the buffer to store the 16-bit read.
956 * Reads the PHY register and returns the value in data.
957 * This is a function pointer entry point called by drivers.
959 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
961 if (hw->phy.ops.read_reg)
962 return hw->phy.ops.read_reg(hw, offset, data);
964 return E1000_SUCCESS;
968 * e1000_write_phy_reg - Writes PHY register
969 * @hw: pointer to the HW structure
970 * @offset: the register to write
971 * @data: the value to write.
973 * Writes the PHY register at offset with the value in data.
974 * This is a function pointer entry point called by drivers.
976 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
978 if (hw->phy.ops.write_reg)
979 return hw->phy.ops.write_reg(hw, offset, data);
981 return E1000_SUCCESS;
985 * e1000_release_phy - Generic release PHY
986 * @hw: pointer to the HW structure
988 * Return if silicon family does not require a semaphore when accessing the
991 void e1000_release_phy(struct e1000_hw *hw)
993 if (hw->phy.ops.release)
994 hw->phy.ops.release(hw);
998 * e1000_acquire_phy - Generic acquire PHY
999 * @hw: pointer to the HW structure
1001 * Return success if silicon family does not require a semaphore when
1002 * accessing the PHY.
1004 s32 e1000_acquire_phy(struct e1000_hw *hw)
1006 if (hw->phy.ops.acquire)
1007 return hw->phy.ops.acquire(hw);
1009 return E1000_SUCCESS;
1013 * e1000_cfg_on_link_up - Configure PHY upon link up
1014 * @hw: pointer to the HW structure
1016 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1018 if (hw->phy.ops.cfg_on_link_up)
1019 return hw->phy.ops.cfg_on_link_up(hw);
1021 return E1000_SUCCESS;
1025 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1026 * @hw: pointer to the HW structure
1027 * @offset: the register to read
1028 * @data: the location to store the 16-bit value read.
1030 * Reads a register out of the Kumeran interface. Currently no func pointer
1031 * exists and all implementations are handled in the generic version of
1034 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1036 return e1000_read_kmrn_reg_generic(hw, offset, data);
1040 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1041 * @hw: pointer to the HW structure
1042 * @offset: the register to write
1043 * @data: the value to write.
1045 * Writes a register to the Kumeran interface. Currently no func pointer
1046 * exists and all implementations are handled in the generic version of
1049 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1051 return e1000_write_kmrn_reg_generic(hw, offset, data);
1055 * e1000_get_cable_length - Retrieves cable length estimation
1056 * @hw: pointer to the HW structure
1058 * This function estimates the cable length and stores them in
1059 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1060 * entry point called by drivers.
1062 s32 e1000_get_cable_length(struct e1000_hw *hw)
1064 if (hw->phy.ops.get_cable_length)
1065 return hw->phy.ops.get_cable_length(hw);
1067 return E1000_SUCCESS;
1071 * e1000_get_phy_info - Retrieves PHY information from registers
1072 * @hw: pointer to the HW structure
1074 * This function gets some information from various PHY registers and
1075 * populates hw->phy values with it. This is a function pointer entry
1076 * point called by drivers.
1078 s32 e1000_get_phy_info(struct e1000_hw *hw)
1080 if (hw->phy.ops.get_info)
1081 return hw->phy.ops.get_info(hw);
1083 return E1000_SUCCESS;
1087 * e1000_phy_hw_reset - Hard PHY reset
1088 * @hw: pointer to the HW structure
1090 * Performs a hard PHY reset. This is a function pointer entry point called
1093 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1095 if (hw->phy.ops.reset)
1096 return hw->phy.ops.reset(hw);
1098 return E1000_SUCCESS;
1102 * e1000_phy_commit - Soft PHY reset
1103 * @hw: pointer to the HW structure
1105 * Performs a soft PHY reset on those that apply. This is a function pointer
1106 * entry point called by drivers.
1108 s32 e1000_phy_commit(struct e1000_hw *hw)
1110 if (hw->phy.ops.commit)
1111 return hw->phy.ops.commit(hw);
1113 return E1000_SUCCESS;
1117 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1118 * @hw: pointer to the HW structure
1119 * @active: boolean used to enable/disable lplu
1121 * Success returns 0, Failure returns 1
1123 * The low power link up (lplu) state is set to the power management level D0
1124 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D0
1125 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1126 * is used during Dx states where the power conservation is most important.
1127 * During driver activity, SmartSpeed should be enabled so performance is
1128 * maintained. This is a function pointer entry point called by drivers.
1130 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1132 if (hw->phy.ops.set_d0_lplu_state)
1133 return hw->phy.ops.set_d0_lplu_state(hw, active);
1135 return E1000_SUCCESS;
1139 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1140 * @hw: pointer to the HW structure
1141 * @active: boolean used to enable/disable lplu
1143 * Success returns 0, Failure returns 1
1145 * The low power link up (lplu) state is set to the power management level D3
1146 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D3
1147 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1148 * is used during Dx states where the power conservation is most important.
1149 * During driver activity, SmartSpeed should be enabled so performance is
1150 * maintained. This is a function pointer entry point called by drivers.
1152 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1154 if (hw->phy.ops.set_d3_lplu_state)
1155 return hw->phy.ops.set_d3_lplu_state(hw, active);
1157 return E1000_SUCCESS;
1161 * e1000_read_mac_addr - Reads MAC address
1162 * @hw: pointer to the HW structure
1164 * Reads the MAC address out of the adapter and stores it in the HW structure.
1165 * Currently no func pointer exists and all implementations are handled in the
1166 * generic version of this function.
1168 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1170 if (hw->mac.ops.read_mac_addr)
1171 return hw->mac.ops.read_mac_addr(hw);
1173 return e1000_read_mac_addr_generic(hw);
1177 * e1000_read_pba_string - Read device part number string
1178 * @hw: pointer to the HW structure
1179 * @pba_num: pointer to device part number
1180 * @pba_num_size: size of part number buffer
1182 * Reads the product board assembly (PBA) number from the EEPROM and stores
1183 * the value in pba_num.
1184 * Currently no func pointer exists and all implementations are handled in the
1185 * generic version of this function.
1187 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1189 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1193 * e1000_read_pba_length - Read device part number string length
1194 * @hw: pointer to the HW structure
1195 * @pba_num_size: size of part number buffer
1197 * Reads the product board assembly (PBA) number length from the EEPROM and
1198 * stores the value in pba_num.
1199 * Currently no func pointer exists and all implementations are handled in the
1200 * generic version of this function.
1202 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1204 return e1000_read_pba_length_generic(hw, pba_num_size);
1208 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1209 * @hw: pointer to the HW structure
1211 * Validates the NVM checksum is correct. This is a function pointer entry
1212 * point called by drivers.
1214 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1216 if (hw->nvm.ops.validate)
1217 return hw->nvm.ops.validate(hw);
1219 return -E1000_ERR_CONFIG;
1223 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1224 * @hw: pointer to the HW structure
1226 * Updates the NVM checksum. Currently no func pointer exists and all
1227 * implementations are handled in the generic version of this function.
1229 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1231 if (hw->nvm.ops.update)
1232 return hw->nvm.ops.update(hw);
1234 return -E1000_ERR_CONFIG;
1238 * e1000_reload_nvm - Reloads EEPROM
1239 * @hw: pointer to the HW structure
1241 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1242 * extended control register.
1244 void e1000_reload_nvm(struct e1000_hw *hw)
1246 if (hw->nvm.ops.reload)
1247 hw->nvm.ops.reload(hw);
1251 * e1000_read_nvm - Reads NVM (EEPROM)
1252 * @hw: pointer to the HW structure
1253 * @offset: the word offset to read
1254 * @words: number of 16-bit words to read
1255 * @data: pointer to the properly sized buffer for the data.
1257 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1258 * pointer entry point called by drivers.
1260 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1262 if (hw->nvm.ops.read)
1263 return hw->nvm.ops.read(hw, offset, words, data);
1265 return -E1000_ERR_CONFIG;
1269 * e1000_write_nvm - Writes to NVM (EEPROM)
1270 * @hw: pointer to the HW structure
1271 * @offset: the word offset to read
1272 * @words: number of 16-bit words to write
1273 * @data: pointer to the properly sized buffer for the data.
1275 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1276 * pointer entry point called by drivers.
1278 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1280 if (hw->nvm.ops.write)
1281 return hw->nvm.ops.write(hw, offset, words, data);
1283 return E1000_SUCCESS;
1287 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1288 * @hw: pointer to the HW structure
1289 * @reg: 32bit register offset
1290 * @offset: the register to write
1291 * @data: the value to write.
1293 * Writes the PHY register at offset with the value in data.
1294 * This is a function pointer entry point called by drivers.
1296 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1299 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1303 * e1000_power_up_phy - Restores link in case of PHY power down
1304 * @hw: pointer to the HW structure
1306 * The phy may be powered down to save power, to turn off link when the
1307 * driver is unloaded, or wake on lan is not enabled (among others).
1309 void e1000_power_up_phy(struct e1000_hw *hw)
1311 if (hw->phy.ops.power_up)
1312 hw->phy.ops.power_up(hw);
1314 e1000_setup_link(hw);
1318 * e1000_power_down_phy - Power down PHY
1319 * @hw: pointer to the HW structure
1321 * The phy may be powered down to save power, to turn off link when the
1322 * driver is unloaded, or wake on lan is not enabled (among others).
1324 void e1000_power_down_phy(struct e1000_hw *hw)
1326 if (hw->phy.ops.power_down)
1327 hw->phy.ops.power_down(hw);
1331 * e1000_power_up_fiber_serdes_link - Power up serdes link
1332 * @hw: pointer to the HW structure
1334 * Power on the optics and PCS.
1336 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1338 if (hw->mac.ops.power_up_serdes)
1339 hw->mac.ops.power_up_serdes(hw);
1343 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1344 * @hw: pointer to the HW structure
1346 * Shutdown the optics and PCS on driver unload.
1348 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1350 if (hw->mac.ops.shutdown_serdes)
1351 hw->mac.ops.shutdown_serdes(hw);