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 case E1000_DEV_ID_I210_COPPER:
333 case E1000_DEV_ID_I210_COPPER_OEM1:
334 case E1000_DEV_ID_I210_COPPER_IT:
335 case E1000_DEV_ID_I210_FIBER:
336 case E1000_DEV_ID_I210_SERDES:
337 case E1000_DEV_ID_I210_SGMII:
338 mac->type = e1000_i210;
340 case E1000_DEV_ID_I211_COPPER:
341 mac->type = e1000_i211;
343 case E1000_DEV_ID_82576_VF:
344 case E1000_DEV_ID_82576_VF_HV:
345 mac->type = e1000_vfadapt;
347 case E1000_DEV_ID_I350_VF:
348 case E1000_DEV_ID_I350_VF_HV:
349 mac->type = e1000_vfadapt_i350;
353 /* Should never have loaded on this device */
354 ret_val = -E1000_ERR_MAC_INIT;
362 * e1000_setup_init_funcs - Initializes function pointers
363 * @hw: pointer to the HW structure
364 * @init_device: TRUE will initialize the rest of the function pointers
365 * getting the device ready for use. FALSE will only set
366 * MAC type and the function pointers for the other init
367 * functions. Passing FALSE will not generate any hardware
370 * This function must be called by a driver in order to use the rest
371 * of the 'shared' code files. Called by drivers only.
373 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
377 /* Can't do much good without knowing the MAC type. */
378 ret_val = e1000_set_mac_type(hw);
380 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
385 DEBUGOUT("ERROR: Registers not mapped\n");
386 ret_val = -E1000_ERR_CONFIG;
391 * Init function pointers to generic implementations. We do this first
392 * allowing a driver module to override it afterward.
394 e1000_init_mac_ops_generic(hw);
395 e1000_init_phy_ops_generic(hw);
396 e1000_init_nvm_ops_generic(hw);
397 e1000_init_mbx_ops_generic(hw);
400 * Set up the init function pointers. These are functions within the
401 * adapter family file that sets up function pointers for the rest of
402 * the functions in that family.
404 switch (hw->mac.type) {
406 e1000_init_function_pointers_82542(hw);
410 e1000_init_function_pointers_82543(hw);
414 case e1000_82545_rev_3:
416 case e1000_82546_rev_3:
417 e1000_init_function_pointers_82540(hw);
420 case e1000_82541_rev_2:
422 case e1000_82547_rev_2:
423 e1000_init_function_pointers_82541(hw);
430 e1000_init_function_pointers_82571(hw);
432 case e1000_80003es2lan:
433 e1000_init_function_pointers_80003es2lan(hw);
441 e1000_init_function_pointers_ich8lan(hw);
447 e1000_init_function_pointers_82575(hw);
451 e1000_init_function_pointers_i210(hw);
454 e1000_init_function_pointers_vf(hw);
456 case e1000_vfadapt_i350:
457 e1000_init_function_pointers_vf(hw);
460 DEBUGOUT("Hardware not supported\n");
461 ret_val = -E1000_ERR_CONFIG;
466 * Initialize the rest of the function pointers. These require some
467 * register reads/writes in some cases.
469 if (!(ret_val) && init_device) {
470 ret_val = e1000_init_mac_params(hw);
474 ret_val = e1000_init_nvm_params(hw);
478 ret_val = e1000_init_phy_params(hw);
482 ret_val = e1000_init_mbx_params(hw);
492 * e1000_get_bus_info - Obtain bus information for adapter
493 * @hw: pointer to the HW structure
495 * This will obtain information about the HW bus for which the
496 * adapter is attached and stores it in the hw structure. This is a
497 * function pointer entry point called by drivers.
499 s32 e1000_get_bus_info(struct e1000_hw *hw)
501 if (hw->mac.ops.get_bus_info)
502 return hw->mac.ops.get_bus_info(hw);
504 return E1000_SUCCESS;
508 * e1000_clear_vfta - Clear VLAN filter table
509 * @hw: pointer to the HW structure
511 * This clears the VLAN filter table on the adapter. This is a function
512 * pointer entry point called by drivers.
514 void e1000_clear_vfta(struct e1000_hw *hw)
516 if (hw->mac.ops.clear_vfta)
517 hw->mac.ops.clear_vfta(hw);
521 * e1000_write_vfta - Write value to VLAN filter table
522 * @hw: pointer to the HW structure
523 * @offset: the 32-bit offset in which to write the value to.
524 * @value: the 32-bit value to write at location offset.
526 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
527 * table. This is a function pointer entry point called by drivers.
529 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
531 if (hw->mac.ops.write_vfta)
532 hw->mac.ops.write_vfta(hw, offset, value);
536 * e1000_update_mc_addr_list - Update Multicast addresses
537 * @hw: pointer to the HW structure
538 * @mc_addr_list: array of multicast addresses to program
539 * @mc_addr_count: number of multicast addresses to program
541 * Updates the Multicast Table Array.
542 * The caller must have a packed mc_addr_list of multicast addresses.
544 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
547 if (hw->mac.ops.update_mc_addr_list)
548 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
553 * e1000_force_mac_fc - Force MAC flow control
554 * @hw: pointer to the HW structure
556 * Force the MAC's flow control settings. Currently no func pointer exists
557 * and all implementations are handled in the generic version of this
560 s32 e1000_force_mac_fc(struct e1000_hw *hw)
562 return e1000_force_mac_fc_generic(hw);
566 * e1000_check_for_link - Check/Store link connection
567 * @hw: pointer to the HW structure
569 * This checks the link condition of the adapter and stores the
570 * results in the hw->mac structure. This is a function pointer entry
571 * point called by drivers.
573 s32 e1000_check_for_link(struct e1000_hw *hw)
575 if (hw->mac.ops.check_for_link)
576 return hw->mac.ops.check_for_link(hw);
578 return -E1000_ERR_CONFIG;
582 * e1000_check_mng_mode - Check management mode
583 * @hw: pointer to the HW structure
585 * This checks if the adapter has manageability enabled.
586 * This is a function pointer entry point called by drivers.
588 bool e1000_check_mng_mode(struct e1000_hw *hw)
590 if (hw->mac.ops.check_mng_mode)
591 return hw->mac.ops.check_mng_mode(hw);
597 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
598 * @hw: pointer to the HW structure
599 * @buffer: pointer to the host interface
600 * @length: size of the buffer
602 * Writes the DHCP information to the host interface.
604 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
606 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
610 * e1000_reset_hw - Reset hardware
611 * @hw: pointer to the HW structure
613 * This resets the hardware into a known state. This is a function pointer
614 * entry point called by drivers.
616 s32 e1000_reset_hw(struct e1000_hw *hw)
618 if (hw->mac.ops.reset_hw)
619 return hw->mac.ops.reset_hw(hw);
621 return -E1000_ERR_CONFIG;
625 * e1000_init_hw - Initialize hardware
626 * @hw: pointer to the HW structure
628 * This inits the hardware readying it for operation. This is a function
629 * pointer entry point called by drivers.
631 s32 e1000_init_hw(struct e1000_hw *hw)
633 if (hw->mac.ops.init_hw)
634 return hw->mac.ops.init_hw(hw);
636 return -E1000_ERR_CONFIG;
640 * e1000_setup_link - Configures link and flow control
641 * @hw: pointer to the HW structure
643 * This configures link and flow control settings for the adapter. This
644 * is a function pointer entry point called by drivers. While modules can
645 * also call this, they probably call their own version of this function.
647 s32 e1000_setup_link(struct e1000_hw *hw)
649 if (hw->mac.ops.setup_link)
650 return hw->mac.ops.setup_link(hw);
652 return -E1000_ERR_CONFIG;
656 * e1000_get_speed_and_duplex - Returns current speed and duplex
657 * @hw: pointer to the HW structure
658 * @speed: pointer to a 16-bit value to store the speed
659 * @duplex: pointer to a 16-bit value to store the duplex.
661 * This returns the speed and duplex of the adapter in the two 'out'
662 * variables passed in. This is a function pointer entry point called
665 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
667 if (hw->mac.ops.get_link_up_info)
668 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
670 return -E1000_ERR_CONFIG;
674 * e1000_setup_led - Configures SW controllable LED
675 * @hw: pointer to the HW structure
677 * This prepares the SW controllable LED for use and saves the current state
678 * of the LED so it can be later restored. This is a function pointer entry
679 * point called by drivers.
681 s32 e1000_setup_led(struct e1000_hw *hw)
683 if (hw->mac.ops.setup_led)
684 return hw->mac.ops.setup_led(hw);
686 return E1000_SUCCESS;
690 * e1000_cleanup_led - Restores SW controllable LED
691 * @hw: pointer to the HW structure
693 * This restores the SW controllable LED to the value saved off by
694 * e1000_setup_led. This is a function pointer entry point called by drivers.
696 s32 e1000_cleanup_led(struct e1000_hw *hw)
698 if (hw->mac.ops.cleanup_led)
699 return hw->mac.ops.cleanup_led(hw);
701 return E1000_SUCCESS;
705 * e1000_blink_led - Blink SW controllable LED
706 * @hw: pointer to the HW structure
708 * This starts the adapter LED blinking. Request the LED to be setup first
709 * and cleaned up after. This is a function pointer entry point called by
712 s32 e1000_blink_led(struct e1000_hw *hw)
714 if (hw->mac.ops.blink_led)
715 return hw->mac.ops.blink_led(hw);
717 return E1000_SUCCESS;
721 * e1000_id_led_init - store LED configurations in SW
722 * @hw: pointer to the HW structure
724 * Initializes the LED config in SW. This is a function pointer entry point
727 s32 e1000_id_led_init(struct e1000_hw *hw)
729 if (hw->mac.ops.id_led_init)
730 return hw->mac.ops.id_led_init(hw);
732 return E1000_SUCCESS;
736 * e1000_led_on - Turn on SW controllable LED
737 * @hw: pointer to the HW structure
739 * Turns the SW defined LED on. This is a function pointer entry point
742 s32 e1000_led_on(struct e1000_hw *hw)
744 if (hw->mac.ops.led_on)
745 return hw->mac.ops.led_on(hw);
747 return E1000_SUCCESS;
751 * e1000_led_off - Turn off SW controllable LED
752 * @hw: pointer to the HW structure
754 * Turns the SW defined LED off. This is a function pointer entry point
757 s32 e1000_led_off(struct e1000_hw *hw)
759 if (hw->mac.ops.led_off)
760 return hw->mac.ops.led_off(hw);
762 return E1000_SUCCESS;
766 * e1000_reset_adaptive - Reset adaptive IFS
767 * @hw: pointer to the HW structure
769 * Resets the adaptive IFS. Currently no func pointer exists and all
770 * implementations are handled in the generic version of this function.
772 void e1000_reset_adaptive(struct e1000_hw *hw)
774 e1000_reset_adaptive_generic(hw);
778 * e1000_update_adaptive - Update adaptive IFS
779 * @hw: pointer to the HW structure
781 * Updates adapter IFS. Currently no func pointer exists and all
782 * implementations are handled in the generic version of this function.
784 void e1000_update_adaptive(struct e1000_hw *hw)
786 e1000_update_adaptive_generic(hw);
790 * e1000_disable_pcie_master - Disable PCI-Express master access
791 * @hw: pointer to the HW structure
793 * Disables PCI-Express master access and verifies there are no pending
794 * requests. Currently no func pointer exists and all implementations are
795 * handled in the generic version of this function.
797 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
799 return e1000_disable_pcie_master_generic(hw);
803 * e1000_config_collision_dist - Configure collision distance
804 * @hw: pointer to the HW structure
806 * Configures the collision distance to the default value and is used
809 void e1000_config_collision_dist(struct e1000_hw *hw)
811 if (hw->mac.ops.config_collision_dist)
812 hw->mac.ops.config_collision_dist(hw);
816 * e1000_rar_set - Sets a receive address register
817 * @hw: pointer to the HW structure
818 * @addr: address to set the RAR to
819 * @index: the RAR to set
821 * Sets a Receive Address Register (RAR) to the specified address.
823 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
825 if (hw->mac.ops.rar_set)
826 hw->mac.ops.rar_set(hw, addr, index);
830 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
831 * @hw: pointer to the HW structure
833 * Ensures that the MDI/MDIX SW state is valid.
835 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
837 if (hw->mac.ops.validate_mdi_setting)
838 return hw->mac.ops.validate_mdi_setting(hw);
840 return E1000_SUCCESS;
844 * e1000_hash_mc_addr - Determines address location in multicast table
845 * @hw: pointer to the HW structure
846 * @mc_addr: Multicast address to hash.
848 * This hashes an address to determine its location in the multicast
849 * table. Currently no func pointer exists and all implementations
850 * are handled in the generic version of this function.
852 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
854 return e1000_hash_mc_addr_generic(hw, mc_addr);
858 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
859 * @hw: pointer to the HW structure
861 * Enables packet filtering on transmit packets if manageability is enabled
862 * and host interface is enabled.
863 * Currently no func pointer exists and all implementations are handled in the
864 * generic version of this function.
866 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
868 return e1000_enable_tx_pkt_filtering_generic(hw);
872 * e1000_mng_host_if_write - Writes to the manageability host interface
873 * @hw: pointer to the HW structure
874 * @buffer: pointer to the host interface buffer
875 * @length: size of the buffer
876 * @offset: location in the buffer to write to
877 * @sum: sum of the data (not checksum)
879 * This function writes the buffer content at the offset given on the host if.
880 * It also does alignment considerations to do the writes in most efficient
881 * way. Also fills up the sum of the buffer in *buffer parameter.
883 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
886 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
890 * e1000_mng_write_cmd_header - Writes manageability command header
891 * @hw: pointer to the HW structure
892 * @hdr: pointer to the host interface command header
894 * Writes the command header after does the checksum calculation.
896 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
897 struct e1000_host_mng_command_header *hdr)
899 return e1000_mng_write_cmd_header_generic(hw, hdr);
903 * e1000_mng_enable_host_if - Checks host interface is enabled
904 * @hw: pointer to the HW structure
906 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
908 * This function checks whether the HOST IF is enabled for command operation
909 * and also checks whether the previous command is completed. It busy waits
910 * in case of previous command is not completed.
912 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
914 return e1000_mng_enable_host_if_generic(hw);
918 * e1000_set_obff_timer - Set Optimized Buffer Flush/Fill timer
919 * @hw: pointer to the HW structure
920 * @itr: u32 indicating itr value
922 * Set the OBFF timer based on the given interrupt rate.
924 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr)
926 if (hw->mac.ops.set_obff_timer)
927 return hw->mac.ops.set_obff_timer(hw, itr);
929 return E1000_SUCCESS;
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_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1206 * @hw: pointer to the HW structure
1208 * Validates the NVM checksum is correct. This is a function pointer entry
1209 * point called by drivers.
1211 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1213 if (hw->nvm.ops.validate)
1214 return hw->nvm.ops.validate(hw);
1216 return -E1000_ERR_CONFIG;
1220 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1221 * @hw: pointer to the HW structure
1223 * Updates the NVM checksum. Currently no func pointer exists and all
1224 * implementations are handled in the generic version of this function.
1226 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1228 if (hw->nvm.ops.update)
1229 return hw->nvm.ops.update(hw);
1231 return -E1000_ERR_CONFIG;
1235 * e1000_reload_nvm - Reloads EEPROM
1236 * @hw: pointer to the HW structure
1238 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1239 * extended control register.
1241 void e1000_reload_nvm(struct e1000_hw *hw)
1243 if (hw->nvm.ops.reload)
1244 hw->nvm.ops.reload(hw);
1248 * e1000_read_nvm - Reads NVM (EEPROM)
1249 * @hw: pointer to the HW structure
1250 * @offset: the word offset to read
1251 * @words: number of 16-bit words to read
1252 * @data: pointer to the properly sized buffer for the data.
1254 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1255 * pointer entry point called by drivers.
1257 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1259 if (hw->nvm.ops.read)
1260 return hw->nvm.ops.read(hw, offset, words, data);
1262 return -E1000_ERR_CONFIG;
1266 * e1000_write_nvm - Writes to NVM (EEPROM)
1267 * @hw: pointer to the HW structure
1268 * @offset: the word offset to read
1269 * @words: number of 16-bit words to write
1270 * @data: pointer to the properly sized buffer for the data.
1272 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1273 * pointer entry point called by drivers.
1275 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1277 if (hw->nvm.ops.write)
1278 return hw->nvm.ops.write(hw, offset, words, data);
1280 return E1000_SUCCESS;
1284 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1285 * @hw: pointer to the HW structure
1286 * @reg: 32bit register offset
1287 * @offset: the register to write
1288 * @data: the value to write.
1290 * Writes the PHY register at offset with the value in data.
1291 * This is a function pointer entry point called by drivers.
1293 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1296 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1300 * e1000_power_up_phy - Restores link in case of PHY power down
1301 * @hw: pointer to the HW structure
1303 * The phy may be powered down to save power, to turn off link when the
1304 * driver is unloaded, or wake on lan is not enabled (among others).
1306 void e1000_power_up_phy(struct e1000_hw *hw)
1308 if (hw->phy.ops.power_up)
1309 hw->phy.ops.power_up(hw);
1311 e1000_setup_link(hw);
1315 * e1000_power_down_phy - Power down PHY
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_down_phy(struct e1000_hw *hw)
1323 if (hw->phy.ops.power_down)
1324 hw->phy.ops.power_down(hw);
1328 * e1000_power_up_fiber_serdes_link - Power up serdes link
1329 * @hw: pointer to the HW structure
1331 * Power on the optics and PCS.
1333 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1335 if (hw->mac.ops.power_up_serdes)
1336 hw->mac.ops.power_up_serdes(hw);
1340 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1341 * @hw: pointer to the HW structure
1343 * Shutdown the optics and PCS on driver unload.
1345 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1347 if (hw->mac.ops.shutdown_serdes)
1348 hw->mac.ops.shutdown_serdes(hw);