1 /******************************************************************************
3 Copyright (c) 2001-2011, 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 #ifndef NO_82542_SUPPORT
159 case E1000_DEV_ID_82542:
160 mac->type = e1000_82542;
163 case E1000_DEV_ID_82543GC_FIBER:
164 case E1000_DEV_ID_82543GC_COPPER:
165 mac->type = e1000_82543;
167 case E1000_DEV_ID_82544EI_COPPER:
168 case E1000_DEV_ID_82544EI_FIBER:
169 case E1000_DEV_ID_82544GC_COPPER:
170 case E1000_DEV_ID_82544GC_LOM:
171 mac->type = e1000_82544;
173 case E1000_DEV_ID_82540EM:
174 case E1000_DEV_ID_82540EM_LOM:
175 case E1000_DEV_ID_82540EP:
176 case E1000_DEV_ID_82540EP_LOM:
177 case E1000_DEV_ID_82540EP_LP:
178 mac->type = e1000_82540;
180 case E1000_DEV_ID_82545EM_COPPER:
181 case E1000_DEV_ID_82545EM_FIBER:
182 mac->type = e1000_82545;
184 case E1000_DEV_ID_82545GM_COPPER:
185 case E1000_DEV_ID_82545GM_FIBER:
186 case E1000_DEV_ID_82545GM_SERDES:
187 mac->type = e1000_82545_rev_3;
189 case E1000_DEV_ID_82546EB_COPPER:
190 case E1000_DEV_ID_82546EB_FIBER:
191 case E1000_DEV_ID_82546EB_QUAD_COPPER:
192 mac->type = e1000_82546;
194 case E1000_DEV_ID_82546GB_COPPER:
195 case E1000_DEV_ID_82546GB_FIBER:
196 case E1000_DEV_ID_82546GB_SERDES:
197 case E1000_DEV_ID_82546GB_PCIE:
198 case E1000_DEV_ID_82546GB_QUAD_COPPER:
199 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
200 mac->type = e1000_82546_rev_3;
202 case E1000_DEV_ID_82541EI:
203 case E1000_DEV_ID_82541EI_MOBILE:
204 case E1000_DEV_ID_82541ER_LOM:
205 mac->type = e1000_82541;
207 case E1000_DEV_ID_82541ER:
208 case E1000_DEV_ID_82541GI:
209 case E1000_DEV_ID_82541GI_LF:
210 case E1000_DEV_ID_82541GI_MOBILE:
211 mac->type = e1000_82541_rev_2;
213 case E1000_DEV_ID_82547EI:
214 case E1000_DEV_ID_82547EI_MOBILE:
215 mac->type = e1000_82547;
217 case E1000_DEV_ID_82547GI:
218 mac->type = e1000_82547_rev_2;
220 case E1000_DEV_ID_82571EB_COPPER:
221 case E1000_DEV_ID_82571EB_FIBER:
222 case E1000_DEV_ID_82571EB_SERDES:
223 case E1000_DEV_ID_82571EB_SERDES_DUAL:
224 case E1000_DEV_ID_82571EB_SERDES_QUAD:
225 case E1000_DEV_ID_82571EB_QUAD_COPPER:
226 case E1000_DEV_ID_82571PT_QUAD_COPPER:
227 case E1000_DEV_ID_82571EB_QUAD_FIBER:
228 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
229 mac->type = e1000_82571;
231 case E1000_DEV_ID_82572EI:
232 case E1000_DEV_ID_82572EI_COPPER:
233 case E1000_DEV_ID_82572EI_FIBER:
234 case E1000_DEV_ID_82572EI_SERDES:
235 mac->type = e1000_82572;
237 case E1000_DEV_ID_82573E:
238 case E1000_DEV_ID_82573E_IAMT:
239 case E1000_DEV_ID_82573L:
240 mac->type = e1000_82573;
242 case E1000_DEV_ID_82574L:
243 case E1000_DEV_ID_82574LA:
244 mac->type = e1000_82574;
246 case E1000_DEV_ID_82583V:
247 mac->type = e1000_82583;
249 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
250 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
251 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
252 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
253 mac->type = e1000_80003es2lan;
255 case E1000_DEV_ID_ICH8_IFE:
256 case E1000_DEV_ID_ICH8_IFE_GT:
257 case E1000_DEV_ID_ICH8_IFE_G:
258 case E1000_DEV_ID_ICH8_IGP_M:
259 case E1000_DEV_ID_ICH8_IGP_M_AMT:
260 case E1000_DEV_ID_ICH8_IGP_AMT:
261 case E1000_DEV_ID_ICH8_IGP_C:
262 case E1000_DEV_ID_ICH8_82567V_3:
263 mac->type = e1000_ich8lan;
265 case E1000_DEV_ID_ICH9_IFE:
266 case E1000_DEV_ID_ICH9_IFE_GT:
267 case E1000_DEV_ID_ICH9_IFE_G:
268 case E1000_DEV_ID_ICH9_IGP_M:
269 case E1000_DEV_ID_ICH9_IGP_M_AMT:
270 case E1000_DEV_ID_ICH9_IGP_M_V:
271 case E1000_DEV_ID_ICH9_IGP_AMT:
272 case E1000_DEV_ID_ICH9_BM:
273 case E1000_DEV_ID_ICH9_IGP_C:
274 case E1000_DEV_ID_ICH10_R_BM_LM:
275 case E1000_DEV_ID_ICH10_R_BM_LF:
276 case E1000_DEV_ID_ICH10_R_BM_V:
277 mac->type = e1000_ich9lan;
279 case E1000_DEV_ID_ICH10_D_BM_LM:
280 case E1000_DEV_ID_ICH10_D_BM_LF:
281 case E1000_DEV_ID_ICH10_D_BM_V:
282 mac->type = e1000_ich10lan;
284 case E1000_DEV_ID_PCH_D_HV_DM:
285 case E1000_DEV_ID_PCH_D_HV_DC:
286 case E1000_DEV_ID_PCH_M_HV_LM:
287 case E1000_DEV_ID_PCH_M_HV_LC:
288 mac->type = e1000_pchlan;
290 case E1000_DEV_ID_PCH2_LV_LM:
291 case E1000_DEV_ID_PCH2_LV_V:
292 mac->type = e1000_pch2lan;
294 case E1000_DEV_ID_82575EB_COPPER:
295 case E1000_DEV_ID_82575EB_FIBER_SERDES:
296 case E1000_DEV_ID_82575GB_QUAD_COPPER:
297 mac->type = e1000_82575;
299 case E1000_DEV_ID_82576:
300 case E1000_DEV_ID_82576_FIBER:
301 case E1000_DEV_ID_82576_SERDES:
302 case E1000_DEV_ID_82576_QUAD_COPPER:
303 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
304 case E1000_DEV_ID_82576_NS:
305 case E1000_DEV_ID_82576_NS_SERDES:
306 case E1000_DEV_ID_82576_SERDES_QUAD:
307 mac->type = e1000_82576;
309 case E1000_DEV_ID_82580_COPPER:
310 case E1000_DEV_ID_82580_FIBER:
311 case E1000_DEV_ID_82580_SERDES:
312 case E1000_DEV_ID_82580_SGMII:
313 case E1000_DEV_ID_82580_COPPER_DUAL:
314 case E1000_DEV_ID_82580_QUAD_FIBER:
315 case E1000_DEV_ID_DH89XXCC_SGMII:
316 case E1000_DEV_ID_DH89XXCC_SERDES:
317 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
318 case E1000_DEV_ID_DH89XXCC_SFP:
319 mac->type = e1000_82580;
321 case E1000_DEV_ID_I350_COPPER:
322 case E1000_DEV_ID_I350_FIBER:
323 case E1000_DEV_ID_I350_SERDES:
324 case E1000_DEV_ID_I350_SGMII:
325 case E1000_DEV_ID_I350_DA4:
326 mac->type = e1000_i350;
328 case E1000_DEV_ID_82576_VF:
329 mac->type = e1000_vfadapt;
331 case E1000_DEV_ID_I350_VF:
332 mac->type = e1000_vfadapt_i350;
335 /* Should never have loaded on this device */
336 ret_val = -E1000_ERR_MAC_INIT;
344 * e1000_setup_init_funcs - Initializes function pointers
345 * @hw: pointer to the HW structure
346 * @init_device: TRUE will initialize the rest of the function pointers
347 * getting the device ready for use. FALSE will only set
348 * MAC type and the function pointers for the other init
349 * functions. Passing FALSE will not generate any hardware
352 * This function must be called by a driver in order to use the rest
353 * of the 'shared' code files. Called by drivers only.
355 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
359 /* Can't do much good without knowing the MAC type. */
360 ret_val = e1000_set_mac_type(hw);
362 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
367 DEBUGOUT("ERROR: Registers not mapped\n");
368 ret_val = -E1000_ERR_CONFIG;
373 * Init function pointers to generic implementations. We do this first
374 * allowing a driver module to override it afterward.
376 e1000_init_mac_ops_generic(hw);
377 e1000_init_phy_ops_generic(hw);
378 e1000_init_nvm_ops_generic(hw);
379 e1000_init_mbx_ops_generic(hw);
382 * Set up the init function pointers. These are functions within the
383 * adapter family file that sets up function pointers for the rest of
384 * the functions in that family.
386 switch (hw->mac.type) {
387 #ifndef NO_82542_SUPPORT
389 e1000_init_function_pointers_82542(hw);
394 e1000_init_function_pointers_82543(hw);
398 case e1000_82545_rev_3:
400 case e1000_82546_rev_3:
401 e1000_init_function_pointers_82540(hw);
404 case e1000_82541_rev_2:
406 case e1000_82547_rev_2:
407 e1000_init_function_pointers_82541(hw);
414 e1000_init_function_pointers_82571(hw);
416 case e1000_80003es2lan:
417 e1000_init_function_pointers_80003es2lan(hw);
424 e1000_init_function_pointers_ich8lan(hw);
430 e1000_init_function_pointers_82575(hw);
433 e1000_init_function_pointers_vf(hw);
435 case e1000_vfadapt_i350:
436 e1000_init_function_pointers_vf(hw);
439 DEBUGOUT("Hardware not supported\n");
440 ret_val = -E1000_ERR_CONFIG;
445 * Initialize the rest of the function pointers. These require some
446 * register reads/writes in some cases.
448 if (!(ret_val) && init_device) {
449 ret_val = e1000_init_mac_params(hw);
453 ret_val = e1000_init_nvm_params(hw);
457 ret_val = e1000_init_phy_params(hw);
461 ret_val = e1000_init_mbx_params(hw);
471 * e1000_get_bus_info - Obtain bus information for adapter
472 * @hw: pointer to the HW structure
474 * This will obtain information about the HW bus for which the
475 * adapter is attached and stores it in the hw structure. This is a
476 * function pointer entry point called by drivers.
478 s32 e1000_get_bus_info(struct e1000_hw *hw)
480 if (hw->mac.ops.get_bus_info)
481 return hw->mac.ops.get_bus_info(hw);
483 return E1000_SUCCESS;
487 * e1000_clear_vfta - Clear VLAN filter table
488 * @hw: pointer to the HW structure
490 * This clears the VLAN filter table on the adapter. This is a function
491 * pointer entry point called by drivers.
493 void e1000_clear_vfta(struct e1000_hw *hw)
495 if (hw->mac.ops.clear_vfta)
496 hw->mac.ops.clear_vfta(hw);
500 * e1000_write_vfta - Write value to VLAN filter table
501 * @hw: pointer to the HW structure
502 * @offset: the 32-bit offset in which to write the value to.
503 * @value: the 32-bit value to write at location offset.
505 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
506 * table. This is a function pointer entry point called by drivers.
508 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
510 if (hw->mac.ops.write_vfta)
511 hw->mac.ops.write_vfta(hw, offset, value);
515 * e1000_update_mc_addr_list - Update Multicast addresses
516 * @hw: pointer to the HW structure
517 * @mc_addr_list: array of multicast addresses to program
518 * @mc_addr_count: number of multicast addresses to program
520 * Updates the Multicast Table Array.
521 * The caller must have a packed mc_addr_list of multicast addresses.
523 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
526 if (hw->mac.ops.update_mc_addr_list)
527 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
532 * e1000_force_mac_fc - Force MAC flow control
533 * @hw: pointer to the HW structure
535 * Force the MAC's flow control settings. Currently no func pointer exists
536 * and all implementations are handled in the generic version of this
539 s32 e1000_force_mac_fc(struct e1000_hw *hw)
541 return e1000_force_mac_fc_generic(hw);
545 * e1000_check_for_link - Check/Store link connection
546 * @hw: pointer to the HW structure
548 * This checks the link condition of the adapter and stores the
549 * results in the hw->mac structure. This is a function pointer entry
550 * point called by drivers.
552 s32 e1000_check_for_link(struct e1000_hw *hw)
554 if (hw->mac.ops.check_for_link)
555 return hw->mac.ops.check_for_link(hw);
557 return -E1000_ERR_CONFIG;
561 * e1000_check_mng_mode - Check management mode
562 * @hw: pointer to the HW structure
564 * This checks if the adapter has manageability enabled.
565 * This is a function pointer entry point called by drivers.
567 bool e1000_check_mng_mode(struct e1000_hw *hw)
569 if (hw->mac.ops.check_mng_mode)
570 return hw->mac.ops.check_mng_mode(hw);
576 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
577 * @hw: pointer to the HW structure
578 * @buffer: pointer to the host interface
579 * @length: size of the buffer
581 * Writes the DHCP information to the host interface.
583 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
585 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
589 * e1000_reset_hw - Reset hardware
590 * @hw: pointer to the HW structure
592 * This resets the hardware into a known state. This is a function pointer
593 * entry point called by drivers.
595 s32 e1000_reset_hw(struct e1000_hw *hw)
597 if (hw->mac.ops.reset_hw)
598 return hw->mac.ops.reset_hw(hw);
600 return -E1000_ERR_CONFIG;
604 * e1000_init_hw - Initialize hardware
605 * @hw: pointer to the HW structure
607 * This inits the hardware readying it for operation. This is a function
608 * pointer entry point called by drivers.
610 s32 e1000_init_hw(struct e1000_hw *hw)
612 if (hw->mac.ops.init_hw)
613 return hw->mac.ops.init_hw(hw);
615 return -E1000_ERR_CONFIG;
619 * e1000_setup_link - Configures link and flow control
620 * @hw: pointer to the HW structure
622 * This configures link and flow control settings for the adapter. This
623 * is a function pointer entry point called by drivers. While modules can
624 * also call this, they probably call their own version of this function.
626 s32 e1000_setup_link(struct e1000_hw *hw)
628 if (hw->mac.ops.setup_link)
629 return hw->mac.ops.setup_link(hw);
631 return -E1000_ERR_CONFIG;
635 * e1000_get_speed_and_duplex - Returns current speed and duplex
636 * @hw: pointer to the HW structure
637 * @speed: pointer to a 16-bit value to store the speed
638 * @duplex: pointer to a 16-bit value to store the duplex.
640 * This returns the speed and duplex of the adapter in the two 'out'
641 * variables passed in. This is a function pointer entry point called
644 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
646 if (hw->mac.ops.get_link_up_info)
647 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
649 return -E1000_ERR_CONFIG;
653 * e1000_setup_led - Configures SW controllable LED
654 * @hw: pointer to the HW structure
656 * This prepares the SW controllable LED for use and saves the current state
657 * of the LED so it can be later restored. This is a function pointer entry
658 * point called by drivers.
660 s32 e1000_setup_led(struct e1000_hw *hw)
662 if (hw->mac.ops.setup_led)
663 return hw->mac.ops.setup_led(hw);
665 return E1000_SUCCESS;
669 * e1000_cleanup_led - Restores SW controllable LED
670 * @hw: pointer to the HW structure
672 * This restores the SW controllable LED to the value saved off by
673 * e1000_setup_led. This is a function pointer entry point called by drivers.
675 s32 e1000_cleanup_led(struct e1000_hw *hw)
677 if (hw->mac.ops.cleanup_led)
678 return hw->mac.ops.cleanup_led(hw);
680 return E1000_SUCCESS;
684 * e1000_blink_led - Blink SW controllable LED
685 * @hw: pointer to the HW structure
687 * This starts the adapter LED blinking. Request the LED to be setup first
688 * and cleaned up after. This is a function pointer entry point called by
691 s32 e1000_blink_led(struct e1000_hw *hw)
693 if (hw->mac.ops.blink_led)
694 return hw->mac.ops.blink_led(hw);
696 return E1000_SUCCESS;
700 * e1000_id_led_init - store LED configurations in SW
701 * @hw: pointer to the HW structure
703 * Initializes the LED config in SW. This is a function pointer entry point
706 s32 e1000_id_led_init(struct e1000_hw *hw)
708 if (hw->mac.ops.id_led_init)
709 return hw->mac.ops.id_led_init(hw);
711 return E1000_SUCCESS;
715 * e1000_led_on - Turn on SW controllable LED
716 * @hw: pointer to the HW structure
718 * Turns the SW defined LED on. This is a function pointer entry point
721 s32 e1000_led_on(struct e1000_hw *hw)
723 if (hw->mac.ops.led_on)
724 return hw->mac.ops.led_on(hw);
726 return E1000_SUCCESS;
730 * e1000_led_off - Turn off SW controllable LED
731 * @hw: pointer to the HW structure
733 * Turns the SW defined LED off. This is a function pointer entry point
736 s32 e1000_led_off(struct e1000_hw *hw)
738 if (hw->mac.ops.led_off)
739 return hw->mac.ops.led_off(hw);
741 return E1000_SUCCESS;
745 * e1000_reset_adaptive - Reset adaptive IFS
746 * @hw: pointer to the HW structure
748 * Resets the adaptive IFS. Currently no func pointer exists and all
749 * implementations are handled in the generic version of this function.
751 void e1000_reset_adaptive(struct e1000_hw *hw)
753 e1000_reset_adaptive_generic(hw);
757 * e1000_update_adaptive - Update adaptive IFS
758 * @hw: pointer to the HW structure
760 * Updates adapter IFS. Currently no func pointer exists and all
761 * implementations are handled in the generic version of this function.
763 void e1000_update_adaptive(struct e1000_hw *hw)
765 e1000_update_adaptive_generic(hw);
769 * e1000_disable_pcie_master - Disable PCI-Express master access
770 * @hw: pointer to the HW structure
772 * Disables PCI-Express master access and verifies there are no pending
773 * requests. Currently no func pointer exists and all implementations are
774 * handled in the generic version of this function.
776 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
778 return e1000_disable_pcie_master_generic(hw);
782 * e1000_config_collision_dist - Configure collision distance
783 * @hw: pointer to the HW structure
785 * Configures the collision distance to the default value and is used
788 void e1000_config_collision_dist(struct e1000_hw *hw)
790 if (hw->mac.ops.config_collision_dist)
791 hw->mac.ops.config_collision_dist(hw);
795 * e1000_rar_set - Sets a receive address register
796 * @hw: pointer to the HW structure
797 * @addr: address to set the RAR to
798 * @index: the RAR to set
800 * Sets a Receive Address Register (RAR) to the specified address.
802 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
804 if (hw->mac.ops.rar_set)
805 hw->mac.ops.rar_set(hw, addr, index);
809 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
810 * @hw: pointer to the HW structure
812 * Ensures that the MDI/MDIX SW state is valid.
814 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
816 if (hw->mac.ops.validate_mdi_setting)
817 return hw->mac.ops.validate_mdi_setting(hw);
819 return E1000_SUCCESS;
823 * e1000_hash_mc_addr - Determines address location in multicast table
824 * @hw: pointer to the HW structure
825 * @mc_addr: Multicast address to hash.
827 * This hashes an address to determine its location in the multicast
828 * table. Currently no func pointer exists and all implementations
829 * are handled in the generic version of this function.
831 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
833 return e1000_hash_mc_addr_generic(hw, mc_addr);
837 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
838 * @hw: pointer to the HW structure
840 * Enables packet filtering on transmit packets if manageability is enabled
841 * and host interface is enabled.
842 * Currently no func pointer exists and all implementations are handled in the
843 * generic version of this function.
845 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
847 return e1000_enable_tx_pkt_filtering_generic(hw);
851 * e1000_mng_host_if_write - Writes to the manageability host interface
852 * @hw: pointer to the HW structure
853 * @buffer: pointer to the host interface buffer
854 * @length: size of the buffer
855 * @offset: location in the buffer to write to
856 * @sum: sum of the data (not checksum)
858 * This function writes the buffer content at the offset given on the host if.
859 * It also does alignment considerations to do the writes in most efficient
860 * way. Also fills up the sum of the buffer in *buffer parameter.
862 s32 e1000_mng_host_if_write(struct e1000_hw * hw, u8 *buffer, u16 length,
865 if (hw->mac.ops.mng_host_if_write)
866 return hw->mac.ops.mng_host_if_write(hw, buffer, length,
869 return E1000_NOT_IMPLEMENTED;
873 * e1000_mng_write_cmd_header - Writes manageability command header
874 * @hw: pointer to the HW structure
875 * @hdr: pointer to the host interface command header
877 * Writes the command header after does the checksum calculation.
879 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
880 struct e1000_host_mng_command_header *hdr)
882 if (hw->mac.ops.mng_write_cmd_header)
883 return hw->mac.ops.mng_write_cmd_header(hw, hdr);
885 return E1000_NOT_IMPLEMENTED;
889 * e1000_mng_enable_host_if - Checks host interface is enabled
890 * @hw: pointer to the HW structure
892 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
894 * This function checks whether the HOST IF is enabled for command operation
895 * and also checks whether the previous command is completed. It busy waits
896 * in case of previous command is not completed.
898 s32 e1000_mng_enable_host_if(struct e1000_hw * hw)
900 if (hw->mac.ops.mng_enable_host_if)
901 return hw->mac.ops.mng_enable_host_if(hw);
903 return E1000_NOT_IMPLEMENTED;
907 * e1000_wait_autoneg - Waits for autonegotiation completion
908 * @hw: pointer to the HW structure
910 * Waits for autoneg to complete. Currently no func pointer exists and all
911 * implementations are handled in the generic version of this function.
913 s32 e1000_wait_autoneg(struct e1000_hw *hw)
915 if (hw->mac.ops.wait_autoneg)
916 return hw->mac.ops.wait_autoneg(hw);
918 return E1000_SUCCESS;
922 * e1000_check_reset_block - Verifies PHY can be reset
923 * @hw: pointer to the HW structure
925 * Checks if the PHY is in a state that can be reset or if manageability
926 * has it tied up. This is a function pointer entry point called by drivers.
928 s32 e1000_check_reset_block(struct e1000_hw *hw)
930 if (hw->phy.ops.check_reset_block)
931 return hw->phy.ops.check_reset_block(hw);
933 return E1000_SUCCESS;
937 * e1000_read_phy_reg - Reads PHY register
938 * @hw: pointer to the HW structure
939 * @offset: the register to read
940 * @data: the buffer to store the 16-bit read.
942 * Reads the PHY register and returns the value in data.
943 * This is a function pointer entry point called by drivers.
945 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
947 if (hw->phy.ops.read_reg)
948 return hw->phy.ops.read_reg(hw, offset, data);
950 return E1000_SUCCESS;
954 * e1000_write_phy_reg - Writes PHY register
955 * @hw: pointer to the HW structure
956 * @offset: the register to write
957 * @data: the value to write.
959 * Writes the PHY register at offset with the value in data.
960 * This is a function pointer entry point called by drivers.
962 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
964 if (hw->phy.ops.write_reg)
965 return hw->phy.ops.write_reg(hw, offset, data);
967 return E1000_SUCCESS;
971 * e1000_release_phy - Generic release PHY
972 * @hw: pointer to the HW structure
974 * Return if silicon family does not require a semaphore when accessing the
977 void e1000_release_phy(struct e1000_hw *hw)
979 if (hw->phy.ops.release)
980 hw->phy.ops.release(hw);
984 * e1000_acquire_phy - Generic acquire PHY
985 * @hw: pointer to the HW structure
987 * Return success if silicon family does not require a semaphore when
990 s32 e1000_acquire_phy(struct e1000_hw *hw)
992 if (hw->phy.ops.acquire)
993 return hw->phy.ops.acquire(hw);
995 return E1000_SUCCESS;
999 * e1000_cfg_on_link_up - Configure PHY upon link up
1000 * @hw: pointer to the HW structure
1002 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1004 if (hw->phy.ops.cfg_on_link_up)
1005 return hw->phy.ops.cfg_on_link_up(hw);
1007 return E1000_SUCCESS;
1011 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1012 * @hw: pointer to the HW structure
1013 * @offset: the register to read
1014 * @data: the location to store the 16-bit value read.
1016 * Reads a register out of the Kumeran interface. Currently no func pointer
1017 * exists and all implementations are handled in the generic version of
1020 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1022 return e1000_read_kmrn_reg_generic(hw, offset, data);
1026 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1027 * @hw: pointer to the HW structure
1028 * @offset: the register to write
1029 * @data: the value to write.
1031 * Writes a register to the Kumeran interface. Currently no func pointer
1032 * exists and all implementations are handled in the generic version of
1035 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1037 return e1000_write_kmrn_reg_generic(hw, offset, data);
1041 * e1000_get_cable_length - Retrieves cable length estimation
1042 * @hw: pointer to the HW structure
1044 * This function estimates the cable length and stores them in
1045 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1046 * entry point called by drivers.
1048 s32 e1000_get_cable_length(struct e1000_hw *hw)
1050 if (hw->phy.ops.get_cable_length)
1051 return hw->phy.ops.get_cable_length(hw);
1053 return E1000_SUCCESS;
1057 * e1000_get_phy_info - Retrieves PHY information from registers
1058 * @hw: pointer to the HW structure
1060 * This function gets some information from various PHY registers and
1061 * populates hw->phy values with it. This is a function pointer entry
1062 * point called by drivers.
1064 s32 e1000_get_phy_info(struct e1000_hw *hw)
1066 if (hw->phy.ops.get_info)
1067 return hw->phy.ops.get_info(hw);
1069 return E1000_SUCCESS;
1073 * e1000_phy_hw_reset - Hard PHY reset
1074 * @hw: pointer to the HW structure
1076 * Performs a hard PHY reset. This is a function pointer entry point called
1079 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1081 if (hw->phy.ops.reset)
1082 return hw->phy.ops.reset(hw);
1084 return E1000_SUCCESS;
1088 * e1000_phy_commit - Soft PHY reset
1089 * @hw: pointer to the HW structure
1091 * Performs a soft PHY reset on those that apply. This is a function pointer
1092 * entry point called by drivers.
1094 s32 e1000_phy_commit(struct e1000_hw *hw)
1096 if (hw->phy.ops.commit)
1097 return hw->phy.ops.commit(hw);
1099 return E1000_SUCCESS;
1103 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1104 * @hw: pointer to the HW structure
1105 * @active: boolean used to enable/disable lplu
1107 * Success returns 0, Failure returns 1
1109 * The low power link up (lplu) state is set to the power management level D0
1110 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D0
1111 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1112 * is used during Dx states where the power conservation is most important.
1113 * During driver activity, SmartSpeed should be enabled so performance is
1114 * maintained. This is a function pointer entry point called by drivers.
1116 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1118 if (hw->phy.ops.set_d0_lplu_state)
1119 return hw->phy.ops.set_d0_lplu_state(hw, active);
1121 return E1000_SUCCESS;
1125 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1126 * @hw: pointer to the HW structure
1127 * @active: boolean used to enable/disable lplu
1129 * Success returns 0, Failure returns 1
1131 * The low power link up (lplu) state is set to the power management level D3
1132 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D3
1133 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1134 * is used during Dx states where the power conservation is most important.
1135 * During driver activity, SmartSpeed should be enabled so performance is
1136 * maintained. This is a function pointer entry point called by drivers.
1138 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1140 if (hw->phy.ops.set_d3_lplu_state)
1141 return hw->phy.ops.set_d3_lplu_state(hw, active);
1143 return E1000_SUCCESS;
1147 * e1000_read_mac_addr - Reads MAC address
1148 * @hw: pointer to the HW structure
1150 * Reads the MAC address out of the adapter and stores it in the HW structure.
1151 * Currently no func pointer exists and all implementations are handled in the
1152 * generic version of this function.
1154 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1156 if (hw->mac.ops.read_mac_addr)
1157 return hw->mac.ops.read_mac_addr(hw);
1159 return e1000_read_mac_addr_generic(hw);
1163 * e1000_read_pba_string - Read device part number string
1164 * @hw: pointer to the HW structure
1165 * @pba_num: pointer to device part number
1166 * @pba_num_size: size of part number buffer
1168 * Reads the product board assembly (PBA) number from the EEPROM and stores
1169 * the value in pba_num.
1170 * Currently no func pointer exists and all implementations are handled in the
1171 * generic version of this function.
1173 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1175 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1179 * e1000_read_pba_length - Read device part number string length
1180 * @hw: pointer to the HW structure
1181 * @pba_num_size: size of part number buffer
1183 * Reads the product board assembly (PBA) number length from the EEPROM and
1184 * stores the value in pba_num.
1185 * Currently no func pointer exists and all implementations are handled in the
1186 * generic version of this function.
1188 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1190 return e1000_read_pba_length_generic(hw, pba_num_size);
1194 * e1000_read_pba_num - Read device part number
1195 * @hw: pointer to the HW structure
1196 * @pba_num: pointer to device part number
1198 * Reads the product board assembly (PBA) number from the EEPROM and stores
1199 * the value in pba_num.
1200 * Currently no func pointer exists and all implementations are handled in the
1201 * generic version of this function.
1203 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num)
1205 return e1000_read_pba_num_generic(hw, pba_num);
1209 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1210 * @hw: pointer to the HW structure
1212 * Validates the NVM checksum is correct. This is a function pointer entry
1213 * point called by drivers.
1215 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1217 if (hw->nvm.ops.validate)
1218 return hw->nvm.ops.validate(hw);
1220 return -E1000_ERR_CONFIG;
1224 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1225 * @hw: pointer to the HW structure
1227 * Updates the NVM checksum. Currently no func pointer exists and all
1228 * implementations are handled in the generic version of this function.
1230 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1232 if (hw->nvm.ops.update)
1233 return hw->nvm.ops.update(hw);
1235 return -E1000_ERR_CONFIG;
1239 * e1000_reload_nvm - Reloads EEPROM
1240 * @hw: pointer to the HW structure
1242 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1243 * extended control register.
1245 void e1000_reload_nvm(struct e1000_hw *hw)
1247 if (hw->nvm.ops.reload)
1248 hw->nvm.ops.reload(hw);
1252 * e1000_read_nvm - Reads NVM (EEPROM)
1253 * @hw: pointer to the HW structure
1254 * @offset: the word offset to read
1255 * @words: number of 16-bit words to read
1256 * @data: pointer to the properly sized buffer for the data.
1258 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1259 * pointer entry point called by drivers.
1261 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1263 if (hw->nvm.ops.read)
1264 return hw->nvm.ops.read(hw, offset, words, data);
1266 return -E1000_ERR_CONFIG;
1270 * e1000_write_nvm - Writes to NVM (EEPROM)
1271 * @hw: pointer to the HW structure
1272 * @offset: the word offset to read
1273 * @words: number of 16-bit words to write
1274 * @data: pointer to the properly sized buffer for the data.
1276 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1277 * pointer entry point called by drivers.
1279 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1281 if (hw->nvm.ops.write)
1282 return hw->nvm.ops.write(hw, offset, words, data);
1284 return E1000_SUCCESS;
1288 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1289 * @hw: pointer to the HW structure
1290 * @reg: 32bit register offset
1291 * @offset: the register to write
1292 * @data: the value to write.
1294 * Writes the PHY register at offset with the value in data.
1295 * This is a function pointer entry point called by drivers.
1297 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1300 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1304 * e1000_power_up_phy - Restores link in case of PHY power down
1305 * @hw: pointer to the HW structure
1307 * The phy may be powered down to save power, to turn off link when the
1308 * driver is unloaded, or wake on lan is not enabled (among others).
1310 void e1000_power_up_phy(struct e1000_hw *hw)
1312 if (hw->phy.ops.power_up)
1313 hw->phy.ops.power_up(hw);
1315 e1000_setup_link(hw);
1319 * e1000_power_down_phy - Power down PHY
1320 * @hw: pointer to the HW structure
1322 * The phy may be powered down to save power, to turn off link when the
1323 * driver is unloaded, or wake on lan is not enabled (among others).
1325 void e1000_power_down_phy(struct e1000_hw *hw)
1327 if (hw->phy.ops.power_down)
1328 hw->phy.ops.power_down(hw);
1332 * e1000_power_up_fiber_serdes_link - Power up serdes link
1333 * @hw: pointer to the HW structure
1335 * Power on the optics and PCS.
1337 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1339 if (hw->mac.ops.power_up_serdes)
1340 hw->mac.ops.power_up_serdes(hw);
1344 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1345 * @hw: pointer to the HW structure
1347 * Shutdown the optics and PCS on driver unload.
1349 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1351 if (hw->mac.ops.shutdown_serdes)
1352 hw->mac.ops.shutdown_serdes(hw);