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_82575EB_COPPER:
292 case E1000_DEV_ID_82575EB_FIBER_SERDES:
293 case E1000_DEV_ID_82575GB_QUAD_COPPER:
294 mac->type = e1000_82575;
296 case E1000_DEV_ID_82576:
297 case E1000_DEV_ID_82576_FIBER:
298 case E1000_DEV_ID_82576_SERDES:
299 case E1000_DEV_ID_82576_QUAD_COPPER:
300 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
301 case E1000_DEV_ID_82576_NS:
302 case E1000_DEV_ID_82576_NS_SERDES:
303 case E1000_DEV_ID_82576_SERDES_QUAD:
304 mac->type = e1000_82576;
306 case E1000_DEV_ID_82580_COPPER:
307 case E1000_DEV_ID_82580_FIBER:
308 case E1000_DEV_ID_82580_SERDES:
309 case E1000_DEV_ID_82580_SGMII:
310 case E1000_DEV_ID_82580_COPPER_DUAL:
311 case E1000_DEV_ID_82580_QUAD_FIBER:
312 case E1000_DEV_ID_DH89XXCC_SGMII:
313 case E1000_DEV_ID_DH89XXCC_SERDES:
314 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
315 case E1000_DEV_ID_DH89XXCC_SFP:
316 mac->type = e1000_82580;
318 case E1000_DEV_ID_I350_COPPER:
319 case E1000_DEV_ID_I350_FIBER:
320 case E1000_DEV_ID_I350_SERDES:
321 case E1000_DEV_ID_I350_SGMII:
322 case E1000_DEV_ID_I350_DA4:
323 mac->type = e1000_i350;
325 case E1000_DEV_ID_I210_COPPER:
326 case E1000_DEV_ID_I210_COPPER_OEM1:
327 case E1000_DEV_ID_I210_COPPER_IT:
328 case E1000_DEV_ID_I210_FIBER:
329 case E1000_DEV_ID_I210_SERDES:
330 case E1000_DEV_ID_I210_SGMII:
331 mac->type = e1000_i210;
333 case E1000_DEV_ID_I211_COPPER:
334 mac->type = e1000_i211;
336 case E1000_DEV_ID_82576_VF:
337 case E1000_DEV_ID_82576_VF_HV:
338 mac->type = e1000_vfadapt;
340 case E1000_DEV_ID_I350_VF:
341 case E1000_DEV_ID_I350_VF_HV:
342 mac->type = e1000_vfadapt_i350;
346 /* Should never have loaded on this device */
347 ret_val = -E1000_ERR_MAC_INIT;
355 * e1000_setup_init_funcs - Initializes function pointers
356 * @hw: pointer to the HW structure
357 * @init_device: true will initialize the rest of the function pointers
358 * getting the device ready for use. false will only set
359 * MAC type and the function pointers for the other init
360 * functions. Passing false will not generate any hardware
363 * This function must be called by a driver in order to use the rest
364 * of the 'shared' code files. Called by drivers only.
366 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
370 /* Can't do much good without knowing the MAC type. */
371 ret_val = e1000_set_mac_type(hw);
373 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
378 DEBUGOUT("ERROR: Registers not mapped\n");
379 ret_val = -E1000_ERR_CONFIG;
384 * Init function pointers to generic implementations. We do this first
385 * allowing a driver module to override it afterward.
387 e1000_init_mac_ops_generic(hw);
388 e1000_init_phy_ops_generic(hw);
389 e1000_init_nvm_ops_generic(hw);
390 e1000_init_mbx_ops_generic(hw);
393 * Set up the init function pointers. These are functions within the
394 * adapter family file that sets up function pointers for the rest of
395 * the functions in that family.
397 switch (hw->mac.type) {
399 e1000_init_function_pointers_82542(hw);
403 e1000_init_function_pointers_82543(hw);
407 case e1000_82545_rev_3:
409 case e1000_82546_rev_3:
410 e1000_init_function_pointers_82540(hw);
413 case e1000_82541_rev_2:
415 case e1000_82547_rev_2:
416 e1000_init_function_pointers_82541(hw);
423 e1000_init_function_pointers_82571(hw);
425 case e1000_80003es2lan:
426 e1000_init_function_pointers_80003es2lan(hw);
433 e1000_init_function_pointers_ich8lan(hw);
439 e1000_init_function_pointers_82575(hw);
443 e1000_init_function_pointers_i210(hw);
446 e1000_init_function_pointers_vf(hw);
448 case e1000_vfadapt_i350:
449 e1000_init_function_pointers_vf(hw);
452 DEBUGOUT("Hardware not supported\n");
453 ret_val = -E1000_ERR_CONFIG;
458 * Initialize the rest of the function pointers. These require some
459 * register reads/writes in some cases.
461 if (!(ret_val) && init_device) {
462 ret_val = e1000_init_mac_params(hw);
466 ret_val = e1000_init_nvm_params(hw);
470 ret_val = e1000_init_phy_params(hw);
474 ret_val = e1000_init_mbx_params(hw);
484 * e1000_get_bus_info - Obtain bus information for adapter
485 * @hw: pointer to the HW structure
487 * This will obtain information about the HW bus for which the
488 * adapter is attached and stores it in the hw structure. This is a
489 * function pointer entry point called by drivers.
491 s32 e1000_get_bus_info(struct e1000_hw *hw)
493 if (hw->mac.ops.get_bus_info)
494 return hw->mac.ops.get_bus_info(hw);
496 return E1000_SUCCESS;
500 * e1000_clear_vfta - Clear VLAN filter table
501 * @hw: pointer to the HW structure
503 * This clears the VLAN filter table on the adapter. This is a function
504 * pointer entry point called by drivers.
506 void e1000_clear_vfta(struct e1000_hw *hw)
508 if (hw->mac.ops.clear_vfta)
509 hw->mac.ops.clear_vfta(hw);
513 * e1000_write_vfta - Write value to VLAN filter table
514 * @hw: pointer to the HW structure
515 * @offset: the 32-bit offset in which to write the value to.
516 * @value: the 32-bit value to write at location offset.
518 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
519 * table. This is a function pointer entry point called by drivers.
521 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
523 if (hw->mac.ops.write_vfta)
524 hw->mac.ops.write_vfta(hw, offset, value);
528 * e1000_update_mc_addr_list - Update Multicast addresses
529 * @hw: pointer to the HW structure
530 * @mc_addr_list: array of multicast addresses to program
531 * @mc_addr_count: number of multicast addresses to program
533 * Updates the Multicast Table Array.
534 * The caller must have a packed mc_addr_list of multicast addresses.
536 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
539 if (hw->mac.ops.update_mc_addr_list)
540 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
545 * e1000_force_mac_fc - Force MAC flow control
546 * @hw: pointer to the HW structure
548 * Force the MAC's flow control settings. Currently no func pointer exists
549 * and all implementations are handled in the generic version of this
552 s32 e1000_force_mac_fc(struct e1000_hw *hw)
554 return e1000_force_mac_fc_generic(hw);
558 * e1000_check_for_link - Check/Store link connection
559 * @hw: pointer to the HW structure
561 * This checks the link condition of the adapter and stores the
562 * results in the hw->mac structure. This is a function pointer entry
563 * point called by drivers.
565 s32 e1000_check_for_link(struct e1000_hw *hw)
567 if (hw->mac.ops.check_for_link)
568 return hw->mac.ops.check_for_link(hw);
570 return -E1000_ERR_CONFIG;
574 * e1000_check_mng_mode - Check management mode
575 * @hw: pointer to the HW structure
577 * This checks if the adapter has manageability enabled.
578 * This is a function pointer entry point called by drivers.
580 bool e1000_check_mng_mode(struct e1000_hw *hw)
582 if (hw->mac.ops.check_mng_mode)
583 return hw->mac.ops.check_mng_mode(hw);
589 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
590 * @hw: pointer to the HW structure
591 * @buffer: pointer to the host interface
592 * @length: size of the buffer
594 * Writes the DHCP information to the host interface.
596 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
598 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
602 * e1000_reset_hw - Reset hardware
603 * @hw: pointer to the HW structure
605 * This resets the hardware into a known state. This is a function pointer
606 * entry point called by drivers.
608 s32 e1000_reset_hw(struct e1000_hw *hw)
610 if (hw->mac.ops.reset_hw)
611 return hw->mac.ops.reset_hw(hw);
613 return -E1000_ERR_CONFIG;
617 * e1000_init_hw - Initialize hardware
618 * @hw: pointer to the HW structure
620 * This inits the hardware readying it for operation. This is a function
621 * pointer entry point called by drivers.
623 s32 e1000_init_hw(struct e1000_hw *hw)
625 if (hw->mac.ops.init_hw)
626 return hw->mac.ops.init_hw(hw);
628 return -E1000_ERR_CONFIG;
632 * e1000_setup_link - Configures link and flow control
633 * @hw: pointer to the HW structure
635 * This configures link and flow control settings for the adapter. This
636 * is a function pointer entry point called by drivers. While modules can
637 * also call this, they probably call their own version of this function.
639 s32 e1000_setup_link(struct e1000_hw *hw)
641 if (hw->mac.ops.setup_link)
642 return hw->mac.ops.setup_link(hw);
644 return -E1000_ERR_CONFIG;
648 * e1000_get_speed_and_duplex - Returns current speed and duplex
649 * @hw: pointer to the HW structure
650 * @speed: pointer to a 16-bit value to store the speed
651 * @duplex: pointer to a 16-bit value to store the duplex.
653 * This returns the speed and duplex of the adapter in the two 'out'
654 * variables passed in. This is a function pointer entry point called
657 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
659 if (hw->mac.ops.get_link_up_info)
660 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
662 return -E1000_ERR_CONFIG;
666 * e1000_setup_led - Configures SW controllable LED
667 * @hw: pointer to the HW structure
669 * This prepares the SW controllable LED for use and saves the current state
670 * of the LED so it can be later restored. This is a function pointer entry
671 * point called by drivers.
673 s32 e1000_setup_led(struct e1000_hw *hw)
675 if (hw->mac.ops.setup_led)
676 return hw->mac.ops.setup_led(hw);
678 return E1000_SUCCESS;
682 * e1000_cleanup_led - Restores SW controllable LED
683 * @hw: pointer to the HW structure
685 * This restores the SW controllable LED to the value saved off by
686 * e1000_setup_led. This is a function pointer entry point called by drivers.
688 s32 e1000_cleanup_led(struct e1000_hw *hw)
690 if (hw->mac.ops.cleanup_led)
691 return hw->mac.ops.cleanup_led(hw);
693 return E1000_SUCCESS;
697 * e1000_blink_led - Blink SW controllable LED
698 * @hw: pointer to the HW structure
700 * This starts the adapter LED blinking. Request the LED to be setup first
701 * and cleaned up after. This is a function pointer entry point called by
704 s32 e1000_blink_led(struct e1000_hw *hw)
706 if (hw->mac.ops.blink_led)
707 return hw->mac.ops.blink_led(hw);
709 return E1000_SUCCESS;
713 * e1000_id_led_init - store LED configurations in SW
714 * @hw: pointer to the HW structure
716 * Initializes the LED config in SW. This is a function pointer entry point
719 s32 e1000_id_led_init(struct e1000_hw *hw)
721 if (hw->mac.ops.id_led_init)
722 return hw->mac.ops.id_led_init(hw);
724 return E1000_SUCCESS;
728 * e1000_led_on - Turn on SW controllable LED
729 * @hw: pointer to the HW structure
731 * Turns the SW defined LED on. This is a function pointer entry point
734 s32 e1000_led_on(struct e1000_hw *hw)
736 if (hw->mac.ops.led_on)
737 return hw->mac.ops.led_on(hw);
739 return E1000_SUCCESS;
743 * e1000_led_off - Turn off SW controllable LED
744 * @hw: pointer to the HW structure
746 * Turns the SW defined LED off. This is a function pointer entry point
749 s32 e1000_led_off(struct e1000_hw *hw)
751 if (hw->mac.ops.led_off)
752 return hw->mac.ops.led_off(hw);
754 return E1000_SUCCESS;
758 * e1000_reset_adaptive - Reset adaptive IFS
759 * @hw: pointer to the HW structure
761 * Resets the adaptive IFS. Currently no func pointer exists and all
762 * implementations are handled in the generic version of this function.
764 void e1000_reset_adaptive(struct e1000_hw *hw)
766 e1000_reset_adaptive_generic(hw);
770 * e1000_update_adaptive - Update adaptive IFS
771 * @hw: pointer to the HW structure
773 * Updates adapter IFS. Currently no func pointer exists and all
774 * implementations are handled in the generic version of this function.
776 void e1000_update_adaptive(struct e1000_hw *hw)
778 e1000_update_adaptive_generic(hw);
782 * e1000_disable_pcie_master - Disable PCI-Express master access
783 * @hw: pointer to the HW structure
785 * Disables PCI-Express master access and verifies there are no pending
786 * requests. Currently no func pointer exists and all implementations are
787 * handled in the generic version of this function.
789 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
791 return e1000_disable_pcie_master_generic(hw);
795 * e1000_config_collision_dist - Configure collision distance
796 * @hw: pointer to the HW structure
798 * Configures the collision distance to the default value and is used
801 void e1000_config_collision_dist(struct e1000_hw *hw)
803 if (hw->mac.ops.config_collision_dist)
804 hw->mac.ops.config_collision_dist(hw);
808 * e1000_rar_set - Sets a receive address register
809 * @hw: pointer to the HW structure
810 * @addr: address to set the RAR to
811 * @index: the RAR to set
813 * Sets a Receive Address Register (RAR) to the specified address.
815 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
817 if (hw->mac.ops.rar_set)
818 hw->mac.ops.rar_set(hw, addr, index);
822 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
823 * @hw: pointer to the HW structure
825 * Ensures that the MDI/MDIX SW state is valid.
827 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
829 if (hw->mac.ops.validate_mdi_setting)
830 return hw->mac.ops.validate_mdi_setting(hw);
832 return E1000_SUCCESS;
836 * e1000_hash_mc_addr - Determines address location in multicast table
837 * @hw: pointer to the HW structure
838 * @mc_addr: Multicast address to hash.
840 * This hashes an address to determine its location in the multicast
841 * table. Currently no func pointer exists and all implementations
842 * are handled in the generic version of this function.
844 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
846 return e1000_hash_mc_addr_generic(hw, mc_addr);
850 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
851 * @hw: pointer to the HW structure
853 * Enables packet filtering on transmit packets if manageability is enabled
854 * and host interface is enabled.
855 * Currently no func pointer exists and all implementations are handled in the
856 * generic version of this function.
858 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
860 return e1000_enable_tx_pkt_filtering_generic(hw);
864 * e1000_mng_host_if_write - Writes to the manageability host interface
865 * @hw: pointer to the HW structure
866 * @buffer: pointer to the host interface buffer
867 * @length: size of the buffer
868 * @offset: location in the buffer to write to
869 * @sum: sum of the data (not checksum)
871 * This function writes the buffer content at the offset given on the host if.
872 * It also does alignment considerations to do the writes in most efficient
873 * way. Also fills up the sum of the buffer in *buffer parameter.
875 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
878 if (hw->mac.ops.mng_host_if_write)
879 return hw->mac.ops.mng_host_if_write(hw, buffer, length,
882 return E1000_NOT_IMPLEMENTED;
886 * e1000_mng_write_cmd_header - Writes manageability command header
887 * @hw: pointer to the HW structure
888 * @hdr: pointer to the host interface command header
890 * Writes the command header after does the checksum calculation.
892 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
893 struct e1000_host_mng_command_header *hdr)
895 if (hw->mac.ops.mng_write_cmd_header)
896 return hw->mac.ops.mng_write_cmd_header(hw, hdr);
898 return E1000_NOT_IMPLEMENTED;
902 * e1000_mng_enable_host_if - Checks host interface is enabled
903 * @hw: pointer to the HW structure
905 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
907 * This function checks whether the HOST IF is enabled for command operation
908 * and also checks whether the previous command is completed. It busy waits
909 * in case of previous command is not completed.
911 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
913 if (hw->mac.ops.mng_enable_host_if)
914 return hw->mac.ops.mng_enable_host_if(hw);
916 return E1000_NOT_IMPLEMENTED;
920 * e1000_wait_autoneg - Waits for autonegotiation completion
921 * @hw: pointer to the HW structure
923 * Waits for autoneg to complete. Currently no func pointer exists and all
924 * implementations are handled in the generic version of this function.
926 s32 e1000_wait_autoneg(struct e1000_hw *hw)
928 if (hw->mac.ops.wait_autoneg)
929 return hw->mac.ops.wait_autoneg(hw);
931 return E1000_SUCCESS;
935 * e1000_check_reset_block - Verifies PHY can be reset
936 * @hw: pointer to the HW structure
938 * Checks if the PHY is in a state that can be reset or if manageability
939 * has it tied up. This is a function pointer entry point called by drivers.
941 s32 e1000_check_reset_block(struct e1000_hw *hw)
943 if (hw->phy.ops.check_reset_block)
944 return hw->phy.ops.check_reset_block(hw);
946 return E1000_SUCCESS;
950 * e1000_read_phy_reg - Reads PHY register
951 * @hw: pointer to the HW structure
952 * @offset: the register to read
953 * @data: the buffer to store the 16-bit read.
955 * Reads the PHY register and returns the value in data.
956 * This is a function pointer entry point called by drivers.
958 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
960 if (hw->phy.ops.read_reg)
961 return hw->phy.ops.read_reg(hw, offset, data);
963 return E1000_SUCCESS;
967 * e1000_write_phy_reg - Writes PHY register
968 * @hw: pointer to the HW structure
969 * @offset: the register to write
970 * @data: the value to write.
972 * Writes the PHY register at offset with the value in data.
973 * This is a function pointer entry point called by drivers.
975 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
977 if (hw->phy.ops.write_reg)
978 return hw->phy.ops.write_reg(hw, offset, data);
980 return E1000_SUCCESS;
984 * e1000_release_phy - Generic release PHY
985 * @hw: pointer to the HW structure
987 * Return if silicon family does not require a semaphore when accessing the
990 void e1000_release_phy(struct e1000_hw *hw)
992 if (hw->phy.ops.release)
993 hw->phy.ops.release(hw);
997 * e1000_acquire_phy - Generic acquire PHY
998 * @hw: pointer to the HW structure
1000 * Return success if silicon family does not require a semaphore when
1001 * accessing the PHY.
1003 s32 e1000_acquire_phy(struct e1000_hw *hw)
1005 if (hw->phy.ops.acquire)
1006 return hw->phy.ops.acquire(hw);
1008 return E1000_SUCCESS;
1012 * e1000_cfg_on_link_up - Configure PHY upon link up
1013 * @hw: pointer to the HW structure
1015 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1017 if (hw->phy.ops.cfg_on_link_up)
1018 return hw->phy.ops.cfg_on_link_up(hw);
1020 return E1000_SUCCESS;
1024 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1025 * @hw: pointer to the HW structure
1026 * @offset: the register to read
1027 * @data: the location to store the 16-bit value read.
1029 * Reads a register out of the Kumeran interface. Currently no func pointer
1030 * exists and all implementations are handled in the generic version of
1033 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1035 return e1000_read_kmrn_reg_generic(hw, offset, data);
1039 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1040 * @hw: pointer to the HW structure
1041 * @offset: the register to write
1042 * @data: the value to write.
1044 * Writes a register to the Kumeran interface. Currently no func pointer
1045 * exists and all implementations are handled in the generic version of
1048 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1050 return e1000_write_kmrn_reg_generic(hw, offset, data);
1054 * e1000_get_cable_length - Retrieves cable length estimation
1055 * @hw: pointer to the HW structure
1057 * This function estimates the cable length and stores them in
1058 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1059 * entry point called by drivers.
1061 s32 e1000_get_cable_length(struct e1000_hw *hw)
1063 if (hw->phy.ops.get_cable_length)
1064 return hw->phy.ops.get_cable_length(hw);
1066 return E1000_SUCCESS;
1070 * e1000_get_phy_info - Retrieves PHY information from registers
1071 * @hw: pointer to the HW structure
1073 * This function gets some information from various PHY registers and
1074 * populates hw->phy values with it. This is a function pointer entry
1075 * point called by drivers.
1077 s32 e1000_get_phy_info(struct e1000_hw *hw)
1079 if (hw->phy.ops.get_info)
1080 return hw->phy.ops.get_info(hw);
1082 return E1000_SUCCESS;
1086 * e1000_phy_hw_reset - Hard PHY reset
1087 * @hw: pointer to the HW structure
1089 * Performs a hard PHY reset. This is a function pointer entry point called
1092 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1094 if (hw->phy.ops.reset)
1095 return hw->phy.ops.reset(hw);
1097 return E1000_SUCCESS;
1101 * e1000_phy_commit - Soft PHY reset
1102 * @hw: pointer to the HW structure
1104 * Performs a soft PHY reset on those that apply. This is a function pointer
1105 * entry point called by drivers.
1107 s32 e1000_phy_commit(struct e1000_hw *hw)
1109 if (hw->phy.ops.commit)
1110 return hw->phy.ops.commit(hw);
1112 return E1000_SUCCESS;
1116 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1117 * @hw: pointer to the HW structure
1118 * @active: boolean used to enable/disable lplu
1120 * Success returns 0, Failure returns 1
1122 * The low power link up (lplu) state is set to the power management level D0
1123 * and SmartSpeed is disabled when active is true, else clear lplu for D0
1124 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1125 * is used during Dx states where the power conservation is most important.
1126 * During driver activity, SmartSpeed should be enabled so performance is
1127 * maintained. This is a function pointer entry point called by drivers.
1129 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1131 if (hw->phy.ops.set_d0_lplu_state)
1132 return hw->phy.ops.set_d0_lplu_state(hw, active);
1134 return E1000_SUCCESS;
1138 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1139 * @hw: pointer to the HW structure
1140 * @active: boolean used to enable/disable lplu
1142 * Success returns 0, Failure returns 1
1144 * The low power link up (lplu) state is set to the power management level D3
1145 * and SmartSpeed is disabled when active is true, else clear lplu for D3
1146 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1147 * is used during Dx states where the power conservation is most important.
1148 * During driver activity, SmartSpeed should be enabled so performance is
1149 * maintained. This is a function pointer entry point called by drivers.
1151 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1153 if (hw->phy.ops.set_d3_lplu_state)
1154 return hw->phy.ops.set_d3_lplu_state(hw, active);
1156 return E1000_SUCCESS;
1160 * e1000_read_mac_addr - Reads MAC address
1161 * @hw: pointer to the HW structure
1163 * Reads the MAC address out of the adapter and stores it in the HW structure.
1164 * Currently no func pointer exists and all implementations are handled in the
1165 * generic version of this function.
1167 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1169 if (hw->mac.ops.read_mac_addr)
1170 return hw->mac.ops.read_mac_addr(hw);
1172 return e1000_read_mac_addr_generic(hw);
1176 * e1000_read_pba_string - Read device part number string
1177 * @hw: pointer to the HW structure
1178 * @pba_num: pointer to device part number
1179 * @pba_num_size: size of part number buffer
1181 * Reads the product board assembly (PBA) number from the EEPROM and stores
1182 * the value in pba_num.
1183 * Currently no func pointer exists and all implementations are handled in the
1184 * generic version of this function.
1186 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1188 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1192 * e1000_read_pba_length - Read device part number string length
1193 * @hw: pointer to the HW structure
1194 * @pba_num_size: size of part number buffer
1196 * Reads the product board assembly (PBA) number length from the EEPROM and
1197 * stores the value in pba_num.
1198 * Currently no func pointer exists and all implementations are handled in the
1199 * generic version of this function.
1201 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1203 return e1000_read_pba_length_generic(hw, pba_num_size);
1207 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1208 * @hw: pointer to the HW structure
1210 * Validates the NVM checksum is correct. This is a function pointer entry
1211 * point called by drivers.
1213 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1215 if (hw->nvm.ops.validate)
1216 return hw->nvm.ops.validate(hw);
1218 return -E1000_ERR_CONFIG;
1222 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1223 * @hw: pointer to the HW structure
1225 * Updates the NVM checksum. Currently no func pointer exists and all
1226 * implementations are handled in the generic version of this function.
1228 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1230 if (hw->nvm.ops.update)
1231 return hw->nvm.ops.update(hw);
1233 return -E1000_ERR_CONFIG;
1237 * e1000_reload_nvm - Reloads EEPROM
1238 * @hw: pointer to the HW structure
1240 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1241 * extended control register.
1243 void e1000_reload_nvm(struct e1000_hw *hw)
1245 if (hw->nvm.ops.reload)
1246 hw->nvm.ops.reload(hw);
1250 * e1000_read_nvm - Reads NVM (EEPROM)
1251 * @hw: pointer to the HW structure
1252 * @offset: the word offset to read
1253 * @words: number of 16-bit words to read
1254 * @data: pointer to the properly sized buffer for the data.
1256 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1257 * pointer entry point called by drivers.
1259 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1261 if (hw->nvm.ops.read)
1262 return hw->nvm.ops.read(hw, offset, words, data);
1264 return -E1000_ERR_CONFIG;
1268 * e1000_write_nvm - Writes to NVM (EEPROM)
1269 * @hw: pointer to the HW structure
1270 * @offset: the word offset to read
1271 * @words: number of 16-bit words to write
1272 * @data: pointer to the properly sized buffer for the data.
1274 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1275 * pointer entry point called by drivers.
1277 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1279 if (hw->nvm.ops.write)
1280 return hw->nvm.ops.write(hw, offset, words, data);
1282 return E1000_SUCCESS;
1286 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1287 * @hw: pointer to the HW structure
1288 * @reg: 32bit register offset
1289 * @offset: the register to write
1290 * @data: the value to write.
1292 * Writes the PHY register at offset with the value in data.
1293 * This is a function pointer entry point called by drivers.
1295 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1298 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1302 * e1000_power_up_phy - Restores link in case of PHY power down
1303 * @hw: pointer to the HW structure
1305 * The phy may be powered down to save power, to turn off link when the
1306 * driver is unloaded, or wake on lan is not enabled (among others).
1308 void e1000_power_up_phy(struct e1000_hw *hw)
1310 if (hw->phy.ops.power_up)
1311 hw->phy.ops.power_up(hw);
1313 e1000_setup_link(hw);
1317 * e1000_power_down_phy - Power down PHY
1318 * @hw: pointer to the HW structure
1320 * The phy may be powered down to save power, to turn off link when the
1321 * driver is unloaded, or wake on lan is not enabled (among others).
1323 void e1000_power_down_phy(struct e1000_hw *hw)
1325 if (hw->phy.ops.power_down)
1326 hw->phy.ops.power_down(hw);
1330 * e1000_power_up_fiber_serdes_link - Power up serdes link
1331 * @hw: pointer to the HW structure
1333 * Power on the optics and PCS.
1335 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1337 if (hw->mac.ops.power_up_serdes)
1338 hw->mac.ops.power_up_serdes(hw);
1342 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1343 * @hw: pointer to the HW structure
1345 * Shutdown the optics and PCS on driver unload.
1347 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1349 if (hw->mac.ops.shutdown_serdes)
1350 hw->mac.ops.shutdown_serdes(hw);