1 /*******************************************************************************
3 Copyright (c) 2001-2015, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
12 2. Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
16 3. Neither the name of the Intel Corporation nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 POSSIBILITY OF SUCH DAMAGE.
32 ***************************************************************************/
34 #include "e1000_api.h"
37 * e1000_init_mac_params - Initialize MAC function pointers
38 * @hw: pointer to the HW structure
40 * This function initializes the function pointers for the MAC
41 * set of functions. Called by drivers or by e1000_setup_init_funcs.
43 s32 e1000_init_mac_params(struct e1000_hw *hw)
45 s32 ret_val = E1000_SUCCESS;
47 if (hw->mac.ops.init_params) {
48 ret_val = hw->mac.ops.init_params(hw);
50 DEBUGOUT("MAC Initialization Error\n");
54 DEBUGOUT("mac.init_mac_params was NULL\n");
55 ret_val = -E1000_ERR_CONFIG;
63 * e1000_init_nvm_params - Initialize NVM function pointers
64 * @hw: pointer to the HW structure
66 * This function initializes the function pointers for the NVM
67 * set of functions. Called by drivers or by e1000_setup_init_funcs.
69 s32 e1000_init_nvm_params(struct e1000_hw *hw)
71 s32 ret_val = E1000_SUCCESS;
73 if (hw->nvm.ops.init_params) {
74 ret_val = hw->nvm.ops.init_params(hw);
76 DEBUGOUT("NVM Initialization Error\n");
80 DEBUGOUT("nvm.init_nvm_params was NULL\n");
81 ret_val = -E1000_ERR_CONFIG;
89 * e1000_init_phy_params - Initialize PHY function pointers
90 * @hw: pointer to the HW structure
92 * This function initializes the function pointers for the PHY
93 * set of functions. Called by drivers or by e1000_setup_init_funcs.
95 s32 e1000_init_phy_params(struct e1000_hw *hw)
97 s32 ret_val = E1000_SUCCESS;
99 if (hw->phy.ops.init_params) {
100 ret_val = hw->phy.ops.init_params(hw);
102 DEBUGOUT("PHY Initialization Error\n");
106 DEBUGOUT("phy.init_phy_params was NULL\n");
107 ret_val = -E1000_ERR_CONFIG;
115 * e1000_init_mbx_params - Initialize mailbox function pointers
116 * @hw: pointer to the HW structure
118 * This function initializes the function pointers for the PHY
119 * set of functions. Called by drivers or by e1000_setup_init_funcs.
121 s32 e1000_init_mbx_params(struct e1000_hw *hw)
123 s32 ret_val = E1000_SUCCESS;
125 if (hw->mbx.ops.init_params) {
126 ret_val = hw->mbx.ops.init_params(hw);
128 DEBUGOUT("Mailbox Initialization Error\n");
132 DEBUGOUT("mbx.init_mbx_params was NULL\n");
133 ret_val = -E1000_ERR_CONFIG;
141 * e1000_set_mac_type - Sets MAC type
142 * @hw: pointer to the HW structure
144 * This function sets the mac type of the adapter based on the
145 * device ID stored in the hw structure.
146 * MUST BE FIRST FUNCTION CALLED (explicitly or through
147 * e1000_setup_init_funcs()).
149 s32 e1000_set_mac_type(struct e1000_hw *hw)
151 struct e1000_mac_info *mac = &hw->mac;
152 s32 ret_val = E1000_SUCCESS;
154 DEBUGFUNC("e1000_set_mac_type");
156 switch (hw->device_id) {
157 case E1000_DEV_ID_82542:
158 mac->type = e1000_82542;
160 case E1000_DEV_ID_82543GC_FIBER:
161 case E1000_DEV_ID_82543GC_COPPER:
162 mac->type = e1000_82543;
164 case E1000_DEV_ID_82544EI_COPPER:
165 case E1000_DEV_ID_82544EI_FIBER:
166 case E1000_DEV_ID_82544GC_COPPER:
167 case E1000_DEV_ID_82544GC_LOM:
168 mac->type = e1000_82544;
170 case E1000_DEV_ID_82540EM:
171 case E1000_DEV_ID_82540EM_LOM:
172 case E1000_DEV_ID_82540EP:
173 case E1000_DEV_ID_82540EP_LOM:
174 case E1000_DEV_ID_82540EP_LP:
175 mac->type = e1000_82540;
177 case E1000_DEV_ID_82545EM_COPPER:
178 case E1000_DEV_ID_82545EM_FIBER:
179 mac->type = e1000_82545;
181 case E1000_DEV_ID_82545GM_COPPER:
182 case E1000_DEV_ID_82545GM_FIBER:
183 case E1000_DEV_ID_82545GM_SERDES:
184 mac->type = e1000_82545_rev_3;
186 case E1000_DEV_ID_82546EB_COPPER:
187 case E1000_DEV_ID_82546EB_FIBER:
188 case E1000_DEV_ID_82546EB_QUAD_COPPER:
189 mac->type = e1000_82546;
191 case E1000_DEV_ID_82546GB_COPPER:
192 case E1000_DEV_ID_82546GB_FIBER:
193 case E1000_DEV_ID_82546GB_SERDES:
194 case E1000_DEV_ID_82546GB_PCIE:
195 case E1000_DEV_ID_82546GB_QUAD_COPPER:
196 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
197 mac->type = e1000_82546_rev_3;
199 case E1000_DEV_ID_82541EI:
200 case E1000_DEV_ID_82541EI_MOBILE:
201 case E1000_DEV_ID_82541ER_LOM:
202 mac->type = e1000_82541;
204 case E1000_DEV_ID_82541ER:
205 case E1000_DEV_ID_82541GI:
206 case E1000_DEV_ID_82541GI_LF:
207 case E1000_DEV_ID_82541GI_MOBILE:
208 mac->type = e1000_82541_rev_2;
210 case E1000_DEV_ID_82547EI:
211 case E1000_DEV_ID_82547EI_MOBILE:
212 mac->type = e1000_82547;
214 case E1000_DEV_ID_82547GI:
215 mac->type = e1000_82547_rev_2;
217 case E1000_DEV_ID_82571EB_COPPER:
218 case E1000_DEV_ID_82571EB_FIBER:
219 case E1000_DEV_ID_82571EB_SERDES:
220 case E1000_DEV_ID_82571EB_SERDES_DUAL:
221 case E1000_DEV_ID_82571EB_SERDES_QUAD:
222 case E1000_DEV_ID_82571EB_QUAD_COPPER:
223 case E1000_DEV_ID_82571PT_QUAD_COPPER:
224 case E1000_DEV_ID_82571EB_QUAD_FIBER:
225 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
226 mac->type = e1000_82571;
228 case E1000_DEV_ID_82572EI:
229 case E1000_DEV_ID_82572EI_COPPER:
230 case E1000_DEV_ID_82572EI_FIBER:
231 case E1000_DEV_ID_82572EI_SERDES:
232 mac->type = e1000_82572;
234 case E1000_DEV_ID_82573E:
235 case E1000_DEV_ID_82573E_IAMT:
236 case E1000_DEV_ID_82573L:
237 mac->type = e1000_82573;
239 case E1000_DEV_ID_82574L:
240 case E1000_DEV_ID_82574LA:
241 mac->type = e1000_82574;
243 case E1000_DEV_ID_82583V:
244 mac->type = e1000_82583;
246 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
247 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
248 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
249 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
250 mac->type = e1000_80003es2lan;
252 case E1000_DEV_ID_ICH8_IFE:
253 case E1000_DEV_ID_ICH8_IFE_GT:
254 case E1000_DEV_ID_ICH8_IFE_G:
255 case E1000_DEV_ID_ICH8_IGP_M:
256 case E1000_DEV_ID_ICH8_IGP_M_AMT:
257 case E1000_DEV_ID_ICH8_IGP_AMT:
258 case E1000_DEV_ID_ICH8_IGP_C:
259 case E1000_DEV_ID_ICH8_82567V_3:
260 mac->type = e1000_ich8lan;
262 case E1000_DEV_ID_ICH9_IFE:
263 case E1000_DEV_ID_ICH9_IFE_GT:
264 case E1000_DEV_ID_ICH9_IFE_G:
265 case E1000_DEV_ID_ICH9_IGP_M:
266 case E1000_DEV_ID_ICH9_IGP_M_AMT:
267 case E1000_DEV_ID_ICH9_IGP_M_V:
268 case E1000_DEV_ID_ICH9_IGP_AMT:
269 case E1000_DEV_ID_ICH9_BM:
270 case E1000_DEV_ID_ICH9_IGP_C:
271 case E1000_DEV_ID_ICH10_R_BM_LM:
272 case E1000_DEV_ID_ICH10_R_BM_LF:
273 case E1000_DEV_ID_ICH10_R_BM_V:
274 mac->type = e1000_ich9lan;
276 case E1000_DEV_ID_ICH10_D_BM_LM:
277 case E1000_DEV_ID_ICH10_D_BM_LF:
278 case E1000_DEV_ID_ICH10_D_BM_V:
279 mac->type = e1000_ich10lan;
281 case E1000_DEV_ID_PCH_D_HV_DM:
282 case E1000_DEV_ID_PCH_D_HV_DC:
283 case E1000_DEV_ID_PCH_M_HV_LM:
284 case E1000_DEV_ID_PCH_M_HV_LC:
285 mac->type = e1000_pchlan;
287 case E1000_DEV_ID_PCH2_LV_LM:
288 case E1000_DEV_ID_PCH2_LV_V:
289 mac->type = e1000_pch2lan;
291 case E1000_DEV_ID_PCH_LPT_I217_LM:
292 case E1000_DEV_ID_PCH_LPT_I217_V:
293 case E1000_DEV_ID_PCH_LPTLP_I218_LM:
294 case E1000_DEV_ID_PCH_LPTLP_I218_V:
295 case E1000_DEV_ID_PCH_I218_LM2:
296 case E1000_DEV_ID_PCH_I218_V2:
297 case E1000_DEV_ID_PCH_I218_LM3:
298 case E1000_DEV_ID_PCH_I218_V3:
299 mac->type = e1000_pch_lpt;
301 case E1000_DEV_ID_PCH_SPT_I219_LM:
302 case E1000_DEV_ID_PCH_SPT_I219_V:
303 case E1000_DEV_ID_PCH_SPT_I219_LM2:
304 case E1000_DEV_ID_PCH_SPT_I219_V2:
305 case E1000_DEV_ID_PCH_LBG_I219_LM3:
306 case E1000_DEV_ID_PCH_SPT_I219_LM4:
307 case E1000_DEV_ID_PCH_SPT_I219_V4:
308 case E1000_DEV_ID_PCH_SPT_I219_LM5:
309 case E1000_DEV_ID_PCH_SPT_I219_V5:
310 mac->type = e1000_pch_spt;
312 case E1000_DEV_ID_82575EB_COPPER:
313 case E1000_DEV_ID_82575EB_FIBER_SERDES:
314 case E1000_DEV_ID_82575GB_QUAD_COPPER:
315 mac->type = e1000_82575;
317 case E1000_DEV_ID_82576:
318 case E1000_DEV_ID_82576_FIBER:
319 case E1000_DEV_ID_82576_SERDES:
320 case E1000_DEV_ID_82576_QUAD_COPPER:
321 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
322 case E1000_DEV_ID_82576_NS:
323 case E1000_DEV_ID_82576_NS_SERDES:
324 case E1000_DEV_ID_82576_SERDES_QUAD:
325 mac->type = e1000_82576;
327 case E1000_DEV_ID_82580_COPPER:
328 case E1000_DEV_ID_82580_FIBER:
329 case E1000_DEV_ID_82580_SERDES:
330 case E1000_DEV_ID_82580_SGMII:
331 case E1000_DEV_ID_82580_COPPER_DUAL:
332 case E1000_DEV_ID_82580_QUAD_FIBER:
333 case E1000_DEV_ID_DH89XXCC_SGMII:
334 case E1000_DEV_ID_DH89XXCC_SERDES:
335 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
336 case E1000_DEV_ID_DH89XXCC_SFP:
337 mac->type = e1000_82580;
339 case E1000_DEV_ID_I350_COPPER:
340 case E1000_DEV_ID_I350_FIBER:
341 case E1000_DEV_ID_I350_SERDES:
342 case E1000_DEV_ID_I350_SGMII:
343 case E1000_DEV_ID_I350_DA4:
344 mac->type = e1000_i350;
346 case E1000_DEV_ID_I210_COPPER_FLASHLESS:
347 case E1000_DEV_ID_I210_SERDES_FLASHLESS:
348 case E1000_DEV_ID_I210_COPPER:
349 case E1000_DEV_ID_I210_COPPER_OEM1:
350 case E1000_DEV_ID_I210_COPPER_IT:
351 case E1000_DEV_ID_I210_FIBER:
352 case E1000_DEV_ID_I210_SERDES:
353 case E1000_DEV_ID_I210_SGMII:
354 mac->type = e1000_i210;
356 case E1000_DEV_ID_I211_COPPER:
357 mac->type = e1000_i211;
359 case E1000_DEV_ID_82576_VF:
360 case E1000_DEV_ID_82576_VF_HV:
361 mac->type = e1000_vfadapt;
363 case E1000_DEV_ID_I350_VF:
364 case E1000_DEV_ID_I350_VF_HV:
365 mac->type = e1000_vfadapt_i350;
368 case E1000_DEV_ID_I354_BACKPLANE_1GBPS:
369 case E1000_DEV_ID_I354_SGMII:
370 case E1000_DEV_ID_I354_BACKPLANE_2_5GBPS:
371 mac->type = e1000_i354;
374 /* Should never have loaded on this device */
375 ret_val = -E1000_ERR_MAC_INIT;
383 * e1000_setup_init_funcs - Initializes function pointers
384 * @hw: pointer to the HW structure
385 * @init_device: true will initialize the rest of the function pointers
386 * getting the device ready for use. false will only set
387 * MAC type and the function pointers for the other init
388 * functions. Passing false will not generate any hardware
391 * This function must be called by a driver in order to use the rest
392 * of the 'shared' code files. Called by drivers only.
394 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
398 /* Can't do much good without knowing the MAC type. */
399 ret_val = e1000_set_mac_type(hw);
401 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
406 DEBUGOUT("ERROR: Registers not mapped\n");
407 ret_val = -E1000_ERR_CONFIG;
412 * Init function pointers to generic implementations. We do this first
413 * allowing a driver module to override it afterward.
415 e1000_init_mac_ops_generic(hw);
416 e1000_init_phy_ops_generic(hw);
417 e1000_init_nvm_ops_generic(hw);
418 e1000_init_mbx_ops_generic(hw);
421 * Set up the init function pointers. These are functions within the
422 * adapter family file that sets up function pointers for the rest of
423 * the functions in that family.
425 switch (hw->mac.type) {
427 e1000_init_function_pointers_82542(hw);
431 e1000_init_function_pointers_82543(hw);
435 case e1000_82545_rev_3:
437 case e1000_82546_rev_3:
438 e1000_init_function_pointers_82540(hw);
441 case e1000_82541_rev_2:
443 case e1000_82547_rev_2:
444 e1000_init_function_pointers_82541(hw);
451 e1000_init_function_pointers_82571(hw);
453 case e1000_80003es2lan:
454 e1000_init_function_pointers_80003es2lan(hw);
463 e1000_init_function_pointers_ich8lan(hw);
470 e1000_init_function_pointers_82575(hw);
474 e1000_init_function_pointers_i210(hw);
477 e1000_init_function_pointers_vf(hw);
479 case e1000_vfadapt_i350:
480 e1000_init_function_pointers_vf(hw);
483 DEBUGOUT("Hardware not supported\n");
484 ret_val = -E1000_ERR_CONFIG;
489 * Initialize the rest of the function pointers. These require some
490 * register reads/writes in some cases.
492 if (!(ret_val) && init_device) {
493 ret_val = e1000_init_mac_params(hw);
497 ret_val = e1000_init_nvm_params(hw);
501 ret_val = e1000_init_phy_params(hw);
505 ret_val = e1000_init_mbx_params(hw);
515 * e1000_get_bus_info - Obtain bus information for adapter
516 * @hw: pointer to the HW structure
518 * This will obtain information about the HW bus for which the
519 * adapter is attached and stores it in the hw structure. This is a
520 * function pointer entry point called by drivers.
522 s32 e1000_get_bus_info(struct e1000_hw *hw)
524 if (hw->mac.ops.get_bus_info)
525 return hw->mac.ops.get_bus_info(hw);
527 return E1000_SUCCESS;
531 * e1000_clear_vfta - Clear VLAN filter table
532 * @hw: pointer to the HW structure
534 * This clears the VLAN filter table on the adapter. This is a function
535 * pointer entry point called by drivers.
537 void e1000_clear_vfta(struct e1000_hw *hw)
539 if (hw->mac.ops.clear_vfta)
540 hw->mac.ops.clear_vfta(hw);
544 * e1000_write_vfta - Write value to VLAN filter table
545 * @hw: pointer to the HW structure
546 * @offset: the 32-bit offset in which to write the value to.
547 * @value: the 32-bit value to write at location offset.
549 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
550 * table. This is a function pointer entry point called by drivers.
552 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
554 if (hw->mac.ops.write_vfta)
555 hw->mac.ops.write_vfta(hw, offset, value);
559 * e1000_update_mc_addr_list - Update Multicast addresses
560 * @hw: pointer to the HW structure
561 * @mc_addr_list: array of multicast addresses to program
562 * @mc_addr_count: number of multicast addresses to program
564 * Updates the Multicast Table Array.
565 * The caller must have a packed mc_addr_list of multicast addresses.
567 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
570 if (hw->mac.ops.update_mc_addr_list)
571 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
576 * e1000_force_mac_fc - Force MAC flow control
577 * @hw: pointer to the HW structure
579 * Force the MAC's flow control settings. Currently no func pointer exists
580 * and all implementations are handled in the generic version of this
583 s32 e1000_force_mac_fc(struct e1000_hw *hw)
585 return e1000_force_mac_fc_generic(hw);
589 * e1000_check_for_link - Check/Store link connection
590 * @hw: pointer to the HW structure
592 * This checks the link condition of the adapter and stores the
593 * results in the hw->mac structure. This is a function pointer entry
594 * point called by drivers.
596 s32 e1000_check_for_link(struct e1000_hw *hw)
598 if (hw->mac.ops.check_for_link)
599 return hw->mac.ops.check_for_link(hw);
601 return -E1000_ERR_CONFIG;
605 * e1000_check_mng_mode - Check management mode
606 * @hw: pointer to the HW structure
608 * This checks if the adapter has manageability enabled.
609 * This is a function pointer entry point called by drivers.
611 bool e1000_check_mng_mode(struct e1000_hw *hw)
613 if (hw->mac.ops.check_mng_mode)
614 return hw->mac.ops.check_mng_mode(hw);
620 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
621 * @hw: pointer to the HW structure
622 * @buffer: pointer to the host interface
623 * @length: size of the buffer
625 * Writes the DHCP information to the host interface.
627 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
629 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
633 * e1000_reset_hw - Reset hardware
634 * @hw: pointer to the HW structure
636 * This resets the hardware into a known state. This is a function pointer
637 * entry point called by drivers.
639 s32 e1000_reset_hw(struct e1000_hw *hw)
641 if (hw->mac.ops.reset_hw)
642 return hw->mac.ops.reset_hw(hw);
644 return -E1000_ERR_CONFIG;
648 * e1000_init_hw - Initialize hardware
649 * @hw: pointer to the HW structure
651 * This inits the hardware readying it for operation. This is a function
652 * pointer entry point called by drivers.
654 s32 e1000_init_hw(struct e1000_hw *hw)
656 if (hw->mac.ops.init_hw)
657 return hw->mac.ops.init_hw(hw);
659 return -E1000_ERR_CONFIG;
663 * e1000_setup_link - Configures link and flow control
664 * @hw: pointer to the HW structure
666 * This configures link and flow control settings for the adapter. This
667 * is a function pointer entry point called by drivers. While modules can
668 * also call this, they probably call their own version of this function.
670 s32 e1000_setup_link(struct e1000_hw *hw)
672 if (hw->mac.ops.setup_link)
673 return hw->mac.ops.setup_link(hw);
675 return -E1000_ERR_CONFIG;
679 * e1000_get_speed_and_duplex - Returns current speed and duplex
680 * @hw: pointer to the HW structure
681 * @speed: pointer to a 16-bit value to store the speed
682 * @duplex: pointer to a 16-bit value to store the duplex.
684 * This returns the speed and duplex of the adapter in the two 'out'
685 * variables passed in. This is a function pointer entry point called
688 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
690 if (hw->mac.ops.get_link_up_info)
691 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
693 return -E1000_ERR_CONFIG;
697 * e1000_setup_led - Configures SW controllable LED
698 * @hw: pointer to the HW structure
700 * This prepares the SW controllable LED for use and saves the current state
701 * of the LED so it can be later restored. This is a function pointer entry
702 * point called by drivers.
704 s32 e1000_setup_led(struct e1000_hw *hw)
706 if (hw->mac.ops.setup_led)
707 return hw->mac.ops.setup_led(hw);
709 return E1000_SUCCESS;
713 * e1000_cleanup_led - Restores SW controllable LED
714 * @hw: pointer to the HW structure
716 * This restores the SW controllable LED to the value saved off by
717 * e1000_setup_led. This is a function pointer entry point called by drivers.
719 s32 e1000_cleanup_led(struct e1000_hw *hw)
721 if (hw->mac.ops.cleanup_led)
722 return hw->mac.ops.cleanup_led(hw);
724 return E1000_SUCCESS;
728 * e1000_blink_led - Blink SW controllable LED
729 * @hw: pointer to the HW structure
731 * This starts the adapter LED blinking. Request the LED to be setup first
732 * and cleaned up after. This is a function pointer entry point called by
735 s32 e1000_blink_led(struct e1000_hw *hw)
737 if (hw->mac.ops.blink_led)
738 return hw->mac.ops.blink_led(hw);
740 return E1000_SUCCESS;
744 * e1000_id_led_init - store LED configurations in SW
745 * @hw: pointer to the HW structure
747 * Initializes the LED config in SW. This is a function pointer entry point
750 s32 e1000_id_led_init(struct e1000_hw *hw)
752 if (hw->mac.ops.id_led_init)
753 return hw->mac.ops.id_led_init(hw);
755 return E1000_SUCCESS;
759 * e1000_led_on - Turn on SW controllable LED
760 * @hw: pointer to the HW structure
762 * Turns the SW defined LED on. This is a function pointer entry point
765 s32 e1000_led_on(struct e1000_hw *hw)
767 if (hw->mac.ops.led_on)
768 return hw->mac.ops.led_on(hw);
770 return E1000_SUCCESS;
774 * e1000_led_off - Turn off SW controllable LED
775 * @hw: pointer to the HW structure
777 * Turns the SW defined LED off. This is a function pointer entry point
780 s32 e1000_led_off(struct e1000_hw *hw)
782 if (hw->mac.ops.led_off)
783 return hw->mac.ops.led_off(hw);
785 return E1000_SUCCESS;
789 * e1000_reset_adaptive - Reset adaptive IFS
790 * @hw: pointer to the HW structure
792 * Resets the adaptive IFS. Currently no func pointer exists and all
793 * implementations are handled in the generic version of this function.
795 void e1000_reset_adaptive(struct e1000_hw *hw)
797 e1000_reset_adaptive_generic(hw);
801 * e1000_update_adaptive - Update adaptive IFS
802 * @hw: pointer to the HW structure
804 * Updates adapter IFS. Currently no func pointer exists and all
805 * implementations are handled in the generic version of this function.
807 void e1000_update_adaptive(struct e1000_hw *hw)
809 e1000_update_adaptive_generic(hw);
813 * e1000_disable_pcie_master - Disable PCI-Express master access
814 * @hw: pointer to the HW structure
816 * Disables PCI-Express master access and verifies there are no pending
817 * requests. Currently no func pointer exists and all implementations are
818 * handled in the generic version of this function.
820 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
822 return e1000_disable_pcie_master_generic(hw);
826 * e1000_config_collision_dist - Configure collision distance
827 * @hw: pointer to the HW structure
829 * Configures the collision distance to the default value and is used
832 void e1000_config_collision_dist(struct e1000_hw *hw)
834 if (hw->mac.ops.config_collision_dist)
835 hw->mac.ops.config_collision_dist(hw);
839 * e1000_rar_set - Sets a receive address register
840 * @hw: pointer to the HW structure
841 * @addr: address to set the RAR to
842 * @index: the RAR to set
844 * Sets a Receive Address Register (RAR) to the specified address.
846 int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
848 if (hw->mac.ops.rar_set)
849 return hw->mac.ops.rar_set(hw, addr, index);
851 return E1000_SUCCESS;
855 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
856 * @hw: pointer to the HW structure
858 * Ensures that the MDI/MDIX SW state is valid.
860 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
862 if (hw->mac.ops.validate_mdi_setting)
863 return hw->mac.ops.validate_mdi_setting(hw);
865 return E1000_SUCCESS;
869 * e1000_hash_mc_addr - Determines address location in multicast table
870 * @hw: pointer to the HW structure
871 * @mc_addr: Multicast address to hash.
873 * This hashes an address to determine its location in the multicast
874 * table. Currently no func pointer exists and all implementations
875 * are handled in the generic version of this function.
877 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
879 return e1000_hash_mc_addr_generic(hw, mc_addr);
883 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
884 * @hw: pointer to the HW structure
886 * Enables packet filtering on transmit packets if manageability is enabled
887 * and host interface is enabled.
888 * Currently no func pointer exists and all implementations are handled in the
889 * generic version of this function.
891 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
893 return e1000_enable_tx_pkt_filtering_generic(hw);
897 * e1000_mng_host_if_write - Writes to the manageability host interface
898 * @hw: pointer to the HW structure
899 * @buffer: pointer to the host interface buffer
900 * @length: size of the buffer
901 * @offset: location in the buffer to write to
902 * @sum: sum of the data (not checksum)
904 * This function writes the buffer content at the offset given on the host if.
905 * It also does alignment considerations to do the writes in most efficient
906 * way. Also fills up the sum of the buffer in *buffer parameter.
908 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
911 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
915 * e1000_mng_write_cmd_header - Writes manageability command header
916 * @hw: pointer to the HW structure
917 * @hdr: pointer to the host interface command header
919 * Writes the command header after does the checksum calculation.
921 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
922 struct e1000_host_mng_command_header *hdr)
924 return e1000_mng_write_cmd_header_generic(hw, hdr);
928 * e1000_mng_enable_host_if - Checks host interface is enabled
929 * @hw: pointer to the HW structure
931 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
933 * This function checks whether the HOST IF is enabled for command operation
934 * and also checks whether the previous command is completed. It busy waits
935 * in case of previous command is not completed.
937 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
939 return e1000_mng_enable_host_if_generic(hw);
943 * e1000_check_reset_block - Verifies PHY can be reset
944 * @hw: pointer to the HW structure
946 * Checks if the PHY is in a state that can be reset or if manageability
947 * has it tied up. This is a function pointer entry point called by drivers.
949 s32 e1000_check_reset_block(struct e1000_hw *hw)
951 if (hw->phy.ops.check_reset_block)
952 return hw->phy.ops.check_reset_block(hw);
954 return E1000_SUCCESS;
958 * e1000_read_phy_reg - Reads PHY register
959 * @hw: pointer to the HW structure
960 * @offset: the register to read
961 * @data: the buffer to store the 16-bit read.
963 * Reads the PHY register and returns the value in data.
964 * This is a function pointer entry point called by drivers.
966 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
968 if (hw->phy.ops.read_reg)
969 return hw->phy.ops.read_reg(hw, offset, data);
971 return E1000_SUCCESS;
975 * e1000_write_phy_reg - Writes PHY register
976 * @hw: pointer to the HW structure
977 * @offset: the register to write
978 * @data: the value to write.
980 * Writes the PHY register at offset with the value in data.
981 * This is a function pointer entry point called by drivers.
983 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
985 if (hw->phy.ops.write_reg)
986 return hw->phy.ops.write_reg(hw, offset, data);
988 return E1000_SUCCESS;
992 * e1000_release_phy - Generic release PHY
993 * @hw: pointer to the HW structure
995 * Return if silicon family does not require a semaphore when accessing the
998 void e1000_release_phy(struct e1000_hw *hw)
1000 if (hw->phy.ops.release)
1001 hw->phy.ops.release(hw);
1005 * e1000_acquire_phy - Generic acquire PHY
1006 * @hw: pointer to the HW structure
1008 * Return success if silicon family does not require a semaphore when
1009 * accessing the PHY.
1011 s32 e1000_acquire_phy(struct e1000_hw *hw)
1013 if (hw->phy.ops.acquire)
1014 return hw->phy.ops.acquire(hw);
1016 return E1000_SUCCESS;
1020 * e1000_cfg_on_link_up - Configure PHY upon link up
1021 * @hw: pointer to the HW structure
1023 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1025 if (hw->phy.ops.cfg_on_link_up)
1026 return hw->phy.ops.cfg_on_link_up(hw);
1028 return E1000_SUCCESS;
1032 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1033 * @hw: pointer to the HW structure
1034 * @offset: the register to read
1035 * @data: the location to store the 16-bit value read.
1037 * Reads a register out of the Kumeran interface. Currently no func pointer
1038 * exists and all implementations are handled in the generic version of
1041 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1043 return e1000_read_kmrn_reg_generic(hw, offset, data);
1047 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1048 * @hw: pointer to the HW structure
1049 * @offset: the register to write
1050 * @data: the value to write.
1052 * Writes a register to the Kumeran interface. Currently no func pointer
1053 * exists and all implementations are handled in the generic version of
1056 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1058 return e1000_write_kmrn_reg_generic(hw, offset, data);
1062 * e1000_get_cable_length - Retrieves cable length estimation
1063 * @hw: pointer to the HW structure
1065 * This function estimates the cable length and stores them in
1066 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1067 * entry point called by drivers.
1069 s32 e1000_get_cable_length(struct e1000_hw *hw)
1071 if (hw->phy.ops.get_cable_length)
1072 return hw->phy.ops.get_cable_length(hw);
1074 return E1000_SUCCESS;
1078 * e1000_get_phy_info - Retrieves PHY information from registers
1079 * @hw: pointer to the HW structure
1081 * This function gets some information from various PHY registers and
1082 * populates hw->phy values with it. This is a function pointer entry
1083 * point called by drivers.
1085 s32 e1000_get_phy_info(struct e1000_hw *hw)
1087 if (hw->phy.ops.get_info)
1088 return hw->phy.ops.get_info(hw);
1090 return E1000_SUCCESS;
1094 * e1000_phy_hw_reset - Hard PHY reset
1095 * @hw: pointer to the HW structure
1097 * Performs a hard PHY reset. This is a function pointer entry point called
1100 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1102 if (hw->phy.ops.reset)
1103 return hw->phy.ops.reset(hw);
1105 return E1000_SUCCESS;
1109 * e1000_phy_commit - Soft PHY reset
1110 * @hw: pointer to the HW structure
1112 * Performs a soft PHY reset on those that apply. This is a function pointer
1113 * entry point called by drivers.
1115 s32 e1000_phy_commit(struct e1000_hw *hw)
1117 if (hw->phy.ops.commit)
1118 return hw->phy.ops.commit(hw);
1120 return E1000_SUCCESS;
1124 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1125 * @hw: pointer to the HW structure
1126 * @active: boolean used to enable/disable lplu
1128 * Success returns 0, Failure returns 1
1130 * The low power link up (lplu) state is set to the power management level D0
1131 * and SmartSpeed is disabled when active is true, else clear lplu for D0
1132 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1133 * is used during Dx states where the power conservation is most important.
1134 * During driver activity, SmartSpeed should be enabled so performance is
1135 * maintained. This is a function pointer entry point called by drivers.
1137 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1139 if (hw->phy.ops.set_d0_lplu_state)
1140 return hw->phy.ops.set_d0_lplu_state(hw, active);
1142 return E1000_SUCCESS;
1146 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1147 * @hw: pointer to the HW structure
1148 * @active: boolean used to enable/disable lplu
1150 * Success returns 0, Failure returns 1
1152 * The low power link up (lplu) state is set to the power management level D3
1153 * and SmartSpeed is disabled when active is true, else clear lplu for D3
1154 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1155 * is used during Dx states where the power conservation is most important.
1156 * During driver activity, SmartSpeed should be enabled so performance is
1157 * maintained. This is a function pointer entry point called by drivers.
1159 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1161 if (hw->phy.ops.set_d3_lplu_state)
1162 return hw->phy.ops.set_d3_lplu_state(hw, active);
1164 return E1000_SUCCESS;
1168 * e1000_read_mac_addr - Reads MAC address
1169 * @hw: pointer to the HW structure
1171 * Reads the MAC address out of the adapter and stores it in the HW structure.
1172 * Currently no func pointer exists and all implementations are handled in the
1173 * generic version of this function.
1175 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1177 if (hw->mac.ops.read_mac_addr)
1178 return hw->mac.ops.read_mac_addr(hw);
1180 return e1000_read_mac_addr_generic(hw);
1184 * e1000_read_pba_string - Read device part number string
1185 * @hw: pointer to the HW structure
1186 * @pba_num: pointer to device part number
1187 * @pba_num_size: size of part number buffer
1189 * Reads the product board assembly (PBA) number from the EEPROM and stores
1190 * the value in pba_num.
1191 * Currently no func pointer exists and all implementations are handled in the
1192 * generic version of this function.
1194 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1196 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1200 * e1000_read_pba_length - Read device part number string length
1201 * @hw: pointer to the HW structure
1202 * @pba_num_size: size of part number buffer
1204 * Reads the product board assembly (PBA) number length from the EEPROM and
1205 * stores the value in pba_num.
1206 * Currently no func pointer exists and all implementations are handled in the
1207 * generic version of this function.
1209 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1211 return e1000_read_pba_length_generic(hw, pba_num_size);
1215 * e1000_read_pba_num - Read device part number
1216 * @hw: pointer to the HW structure
1217 * @pba_num: pointer to device part number
1219 * Reads the product board assembly (PBA) number from the EEPROM and stores
1220 * the value in pba_num.
1221 * Currently no func pointer exists and all implementations are handled in the
1222 * generic version of this function.
1224 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num)
1226 return e1000_read_pba_num_generic(hw, pba_num);
1230 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1231 * @hw: pointer to the HW structure
1233 * Validates the NVM checksum is correct. This is a function pointer entry
1234 * point called by drivers.
1236 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1238 if (hw->nvm.ops.validate)
1239 return hw->nvm.ops.validate(hw);
1241 return -E1000_ERR_CONFIG;
1245 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1246 * @hw: pointer to the HW structure
1248 * Updates the NVM checksum. Currently no func pointer exists and all
1249 * implementations are handled in the generic version of this function.
1251 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1253 if (hw->nvm.ops.update)
1254 return hw->nvm.ops.update(hw);
1256 return -E1000_ERR_CONFIG;
1260 * e1000_reload_nvm - Reloads EEPROM
1261 * @hw: pointer to the HW structure
1263 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1264 * extended control register.
1266 void e1000_reload_nvm(struct e1000_hw *hw)
1268 if (hw->nvm.ops.reload)
1269 hw->nvm.ops.reload(hw);
1273 * e1000_read_nvm - Reads NVM (EEPROM)
1274 * @hw: pointer to the HW structure
1275 * @offset: the word offset to read
1276 * @words: number of 16-bit words to read
1277 * @data: pointer to the properly sized buffer for the data.
1279 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1280 * pointer entry point called by drivers.
1282 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1284 if (hw->nvm.ops.read)
1285 return hw->nvm.ops.read(hw, offset, words, data);
1287 return -E1000_ERR_CONFIG;
1291 * e1000_write_nvm - Writes to NVM (EEPROM)
1292 * @hw: pointer to the HW structure
1293 * @offset: the word offset to read
1294 * @words: number of 16-bit words to write
1295 * @data: pointer to the properly sized buffer for the data.
1297 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1298 * pointer entry point called by drivers.
1300 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1302 if (hw->nvm.ops.write)
1303 return hw->nvm.ops.write(hw, offset, words, data);
1305 return E1000_SUCCESS;
1309 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1310 * @hw: pointer to the HW structure
1311 * @reg: 32bit register offset
1312 * @offset: the register to write
1313 * @data: the value to write.
1315 * Writes the PHY register at offset with the value in data.
1316 * This is a function pointer entry point called by drivers.
1318 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1321 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1325 * e1000_power_up_phy - Restores link in case of PHY power down
1326 * @hw: pointer to the HW structure
1328 * The phy may be powered down to save power, to turn off link when the
1329 * driver is unloaded, or wake on lan is not enabled (among others).
1331 void e1000_power_up_phy(struct e1000_hw *hw)
1333 if (hw->phy.ops.power_up)
1334 hw->phy.ops.power_up(hw);
1336 e1000_setup_link(hw);
1340 * e1000_power_down_phy - Power down PHY
1341 * @hw: pointer to the HW structure
1343 * The phy may be powered down to save power, to turn off link when the
1344 * driver is unloaded, or wake on lan is not enabled (among others).
1346 void e1000_power_down_phy(struct e1000_hw *hw)
1348 if (hw->phy.ops.power_down)
1349 hw->phy.ops.power_down(hw);
1353 * e1000_power_up_fiber_serdes_link - Power up serdes link
1354 * @hw: pointer to the HW structure
1356 * Power on the optics and PCS.
1358 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1360 if (hw->mac.ops.power_up_serdes)
1361 hw->mac.ops.power_up_serdes(hw);
1365 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1366 * @hw: pointer to the HW structure
1368 * Shutdown the optics and PCS on driver unload.
1370 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1372 if (hw->mac.ops.shutdown_serdes)
1373 hw->mac.ops.shutdown_serdes(hw);