1 /******************************************************************************
2 SPDX-License-Identifier: BSD-3-Clause
4 Copyright (c) 2001-2015, Intel Corporation
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 1. Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
13 2. Redistributions in binary form must reproduce the above copyright
14 notice, this list of conditions and the following disclaimer in the
15 documentation and/or other materials provided with the distribution.
17 3. Neither the name of the Intel Corporation nor the names of its
18 contributors may be used to endorse or promote products derived from
19 this software without specific prior written permission.
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE.
33 ******************************************************************************/
36 #include "e1000_api.h"
39 * e1000_init_mac_params - Initialize MAC function pointers
40 * @hw: pointer to the HW structure
42 * This function initializes the function pointers for the MAC
43 * set of functions. Called by drivers or by e1000_setup_init_funcs.
45 s32 e1000_init_mac_params(struct e1000_hw *hw)
47 s32 ret_val = E1000_SUCCESS;
49 if (hw->mac.ops.init_params) {
50 ret_val = hw->mac.ops.init_params(hw);
52 DEBUGOUT("MAC Initialization Error\n");
56 DEBUGOUT("mac.init_mac_params was NULL\n");
57 ret_val = -E1000_ERR_CONFIG;
65 * e1000_init_nvm_params - Initialize NVM function pointers
66 * @hw: pointer to the HW structure
68 * This function initializes the function pointers for the NVM
69 * set of functions. Called by drivers or by e1000_setup_init_funcs.
71 s32 e1000_init_nvm_params(struct e1000_hw *hw)
73 s32 ret_val = E1000_SUCCESS;
75 if (hw->nvm.ops.init_params) {
76 ret_val = hw->nvm.ops.init_params(hw);
78 DEBUGOUT("NVM Initialization Error\n");
82 DEBUGOUT("nvm.init_nvm_params was NULL\n");
83 ret_val = -E1000_ERR_CONFIG;
91 * e1000_init_phy_params - Initialize PHY function pointers
92 * @hw: pointer to the HW structure
94 * This function initializes the function pointers for the PHY
95 * set of functions. Called by drivers or by e1000_setup_init_funcs.
97 s32 e1000_init_phy_params(struct e1000_hw *hw)
99 s32 ret_val = E1000_SUCCESS;
101 if (hw->phy.ops.init_params) {
102 ret_val = hw->phy.ops.init_params(hw);
104 DEBUGOUT("PHY Initialization Error\n");
108 DEBUGOUT("phy.init_phy_params was NULL\n");
109 ret_val = -E1000_ERR_CONFIG;
117 * e1000_init_mbx_params - Initialize mailbox function pointers
118 * @hw: pointer to the HW structure
120 * This function initializes the function pointers for the PHY
121 * set of functions. Called by drivers or by e1000_setup_init_funcs.
123 s32 e1000_init_mbx_params(struct e1000_hw *hw)
125 s32 ret_val = E1000_SUCCESS;
127 if (hw->mbx.ops.init_params) {
128 ret_val = hw->mbx.ops.init_params(hw);
130 DEBUGOUT("Mailbox Initialization Error\n");
134 DEBUGOUT("mbx.init_mbx_params was NULL\n");
135 ret_val = -E1000_ERR_CONFIG;
143 * e1000_set_mac_type - Sets MAC type
144 * @hw: pointer to the HW structure
146 * This function sets the mac type of the adapter based on the
147 * device ID stored in the hw structure.
148 * MUST BE FIRST FUNCTION CALLED (explicitly or through
149 * e1000_setup_init_funcs()).
151 s32 e1000_set_mac_type(struct e1000_hw *hw)
153 struct e1000_mac_info *mac = &hw->mac;
154 s32 ret_val = E1000_SUCCESS;
156 DEBUGFUNC("e1000_set_mac_type");
158 switch (hw->device_id) {
159 case E1000_DEV_ID_82542:
160 mac->type = e1000_82542;
162 case E1000_DEV_ID_82543GC_FIBER:
163 case E1000_DEV_ID_82543GC_COPPER:
164 mac->type = e1000_82543;
166 case E1000_DEV_ID_82544EI_COPPER:
167 case E1000_DEV_ID_82544EI_FIBER:
168 case E1000_DEV_ID_82544GC_COPPER:
169 case E1000_DEV_ID_82544GC_LOM:
170 mac->type = e1000_82544;
172 case E1000_DEV_ID_82540EM:
173 case E1000_DEV_ID_82540EM_LOM:
174 case E1000_DEV_ID_82540EP:
175 case E1000_DEV_ID_82540EP_LOM:
176 case E1000_DEV_ID_82540EP_LP:
177 mac->type = e1000_82540;
179 case E1000_DEV_ID_82545EM_COPPER:
180 case E1000_DEV_ID_82545EM_FIBER:
181 mac->type = e1000_82545;
183 case E1000_DEV_ID_82545GM_COPPER:
184 case E1000_DEV_ID_82545GM_FIBER:
185 case E1000_DEV_ID_82545GM_SERDES:
186 mac->type = e1000_82545_rev_3;
188 case E1000_DEV_ID_82546EB_COPPER:
189 case E1000_DEV_ID_82546EB_FIBER:
190 case E1000_DEV_ID_82546EB_QUAD_COPPER:
191 mac->type = e1000_82546;
193 case E1000_DEV_ID_82546GB_COPPER:
194 case E1000_DEV_ID_82546GB_FIBER:
195 case E1000_DEV_ID_82546GB_SERDES:
196 case E1000_DEV_ID_82546GB_PCIE:
197 case E1000_DEV_ID_82546GB_QUAD_COPPER:
198 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
199 mac->type = e1000_82546_rev_3;
201 case E1000_DEV_ID_82541EI:
202 case E1000_DEV_ID_82541EI_MOBILE:
203 case E1000_DEV_ID_82541ER_LOM:
204 mac->type = e1000_82541;
206 case E1000_DEV_ID_82541ER:
207 case E1000_DEV_ID_82541GI:
208 case E1000_DEV_ID_82541GI_LF:
209 case E1000_DEV_ID_82541GI_MOBILE:
210 mac->type = e1000_82541_rev_2;
212 case E1000_DEV_ID_82547EI:
213 case E1000_DEV_ID_82547EI_MOBILE:
214 mac->type = e1000_82547;
216 case E1000_DEV_ID_82547GI:
217 mac->type = e1000_82547_rev_2;
219 case E1000_DEV_ID_82571EB_COPPER:
220 case E1000_DEV_ID_82571EB_FIBER:
221 case E1000_DEV_ID_82571EB_SERDES:
222 case E1000_DEV_ID_82571EB_SERDES_DUAL:
223 case E1000_DEV_ID_82571EB_SERDES_QUAD:
224 case E1000_DEV_ID_82571EB_QUAD_COPPER:
225 case E1000_DEV_ID_82571PT_QUAD_COPPER:
226 case E1000_DEV_ID_82571EB_QUAD_FIBER:
227 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
228 mac->type = e1000_82571;
230 case E1000_DEV_ID_82572EI:
231 case E1000_DEV_ID_82572EI_COPPER:
232 case E1000_DEV_ID_82572EI_FIBER:
233 case E1000_DEV_ID_82572EI_SERDES:
234 mac->type = e1000_82572;
236 case E1000_DEV_ID_82573E:
237 case E1000_DEV_ID_82573E_IAMT:
238 case E1000_DEV_ID_82573L:
239 mac->type = e1000_82573;
241 case E1000_DEV_ID_82574L:
242 case E1000_DEV_ID_82574LA:
243 mac->type = e1000_82574;
245 case E1000_DEV_ID_82583V:
246 mac->type = e1000_82583;
248 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
249 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
250 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
251 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
252 mac->type = e1000_80003es2lan;
254 case E1000_DEV_ID_ICH8_IFE:
255 case E1000_DEV_ID_ICH8_IFE_GT:
256 case E1000_DEV_ID_ICH8_IFE_G:
257 case E1000_DEV_ID_ICH8_IGP_M:
258 case E1000_DEV_ID_ICH8_IGP_M_AMT:
259 case E1000_DEV_ID_ICH8_IGP_AMT:
260 case E1000_DEV_ID_ICH8_IGP_C:
261 case E1000_DEV_ID_ICH8_82567V_3:
262 mac->type = e1000_ich8lan;
264 case E1000_DEV_ID_ICH9_IFE:
265 case E1000_DEV_ID_ICH9_IFE_GT:
266 case E1000_DEV_ID_ICH9_IFE_G:
267 case E1000_DEV_ID_ICH9_IGP_M:
268 case E1000_DEV_ID_ICH9_IGP_M_AMT:
269 case E1000_DEV_ID_ICH9_IGP_M_V:
270 case E1000_DEV_ID_ICH9_IGP_AMT:
271 case E1000_DEV_ID_ICH9_BM:
272 case E1000_DEV_ID_ICH9_IGP_C:
273 case E1000_DEV_ID_ICH10_R_BM_LM:
274 case E1000_DEV_ID_ICH10_R_BM_LF:
275 case E1000_DEV_ID_ICH10_R_BM_V:
276 mac->type = e1000_ich9lan;
278 case E1000_DEV_ID_ICH10_D_BM_LM:
279 case E1000_DEV_ID_ICH10_D_BM_LF:
280 case E1000_DEV_ID_ICH10_D_BM_V:
281 mac->type = e1000_ich10lan;
283 case E1000_DEV_ID_PCH_D_HV_DM:
284 case E1000_DEV_ID_PCH_D_HV_DC:
285 case E1000_DEV_ID_PCH_M_HV_LM:
286 case E1000_DEV_ID_PCH_M_HV_LC:
287 mac->type = e1000_pchlan;
289 case E1000_DEV_ID_PCH2_LV_LM:
290 case E1000_DEV_ID_PCH2_LV_V:
291 mac->type = e1000_pch2lan;
293 case E1000_DEV_ID_PCH_LPT_I217_LM:
294 case E1000_DEV_ID_PCH_LPT_I217_V:
295 case E1000_DEV_ID_PCH_LPTLP_I218_LM:
296 case E1000_DEV_ID_PCH_LPTLP_I218_V:
297 case E1000_DEV_ID_PCH_I218_LM2:
298 case E1000_DEV_ID_PCH_I218_V2:
299 case E1000_DEV_ID_PCH_I218_LM3:
300 case E1000_DEV_ID_PCH_I218_V3:
301 mac->type = e1000_pch_lpt;
303 case E1000_DEV_ID_PCH_SPT_I219_LM:
304 case E1000_DEV_ID_PCH_SPT_I219_V:
305 case E1000_DEV_ID_PCH_SPT_I219_LM2:
306 case E1000_DEV_ID_PCH_SPT_I219_V2:
307 case E1000_DEV_ID_PCH_LBG_I219_LM3:
308 case E1000_DEV_ID_PCH_SPT_I219_LM4:
309 case E1000_DEV_ID_PCH_SPT_I219_V4:
310 case E1000_DEV_ID_PCH_SPT_I219_LM5:
311 case E1000_DEV_ID_PCH_SPT_I219_V5:
312 case E1000_DEV_ID_PCH_CMP_I219_LM12:
313 case E1000_DEV_ID_PCH_CMP_I219_V12:
314 mac->type = e1000_pch_spt;
316 case E1000_DEV_ID_PCH_CNP_I219_LM6:
317 case E1000_DEV_ID_PCH_CNP_I219_V6:
318 case E1000_DEV_ID_PCH_CNP_I219_LM7:
319 case E1000_DEV_ID_PCH_CNP_I219_V7:
320 case E1000_DEV_ID_PCH_ICP_I219_LM8:
321 case E1000_DEV_ID_PCH_ICP_I219_V8:
322 case E1000_DEV_ID_PCH_ICP_I219_LM9:
323 case E1000_DEV_ID_PCH_ICP_I219_V9:
324 case E1000_DEV_ID_PCH_CMP_I219_LM10:
325 case E1000_DEV_ID_PCH_CMP_I219_V10:
326 case E1000_DEV_ID_PCH_CMP_I219_LM11:
327 case E1000_DEV_ID_PCH_CMP_I219_V11:
328 mac->type = e1000_pch_cnp;
330 case E1000_DEV_ID_82575EB_COPPER:
331 case E1000_DEV_ID_82575EB_FIBER_SERDES:
332 case E1000_DEV_ID_82575GB_QUAD_COPPER:
333 mac->type = e1000_82575;
335 case E1000_DEV_ID_82576:
336 case E1000_DEV_ID_82576_FIBER:
337 case E1000_DEV_ID_82576_SERDES:
338 case E1000_DEV_ID_82576_QUAD_COPPER:
339 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
340 case E1000_DEV_ID_82576_NS:
341 case E1000_DEV_ID_82576_NS_SERDES:
342 case E1000_DEV_ID_82576_SERDES_QUAD:
343 mac->type = e1000_82576;
345 case E1000_DEV_ID_82580_COPPER:
346 case E1000_DEV_ID_82580_FIBER:
347 case E1000_DEV_ID_82580_SERDES:
348 case E1000_DEV_ID_82580_SGMII:
349 case E1000_DEV_ID_82580_COPPER_DUAL:
350 case E1000_DEV_ID_82580_QUAD_FIBER:
351 case E1000_DEV_ID_DH89XXCC_SGMII:
352 case E1000_DEV_ID_DH89XXCC_SERDES:
353 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
354 case E1000_DEV_ID_DH89XXCC_SFP:
355 mac->type = e1000_82580;
357 case E1000_DEV_ID_I350_COPPER:
358 case E1000_DEV_ID_I350_FIBER:
359 case E1000_DEV_ID_I350_SERDES:
360 case E1000_DEV_ID_I350_SGMII:
361 case E1000_DEV_ID_I350_DA4:
362 mac->type = e1000_i350;
364 case E1000_DEV_ID_I210_COPPER_FLASHLESS:
365 case E1000_DEV_ID_I210_SERDES_FLASHLESS:
366 case E1000_DEV_ID_I210_COPPER:
367 case E1000_DEV_ID_I210_COPPER_OEM1:
368 case E1000_DEV_ID_I210_COPPER_IT:
369 case E1000_DEV_ID_I210_FIBER:
370 case E1000_DEV_ID_I210_SERDES:
371 case E1000_DEV_ID_I210_SGMII:
372 mac->type = e1000_i210;
374 case E1000_DEV_ID_I211_COPPER:
375 mac->type = e1000_i211;
377 case E1000_DEV_ID_82576_VF:
378 case E1000_DEV_ID_82576_VF_HV:
379 mac->type = e1000_vfadapt;
381 case E1000_DEV_ID_I350_VF:
382 case E1000_DEV_ID_I350_VF_HV:
383 mac->type = e1000_vfadapt_i350;
386 case E1000_DEV_ID_I354_BACKPLANE_1GBPS:
387 case E1000_DEV_ID_I354_SGMII:
388 case E1000_DEV_ID_I354_BACKPLANE_2_5GBPS:
389 mac->type = e1000_i354;
392 /* Should never have loaded on this device */
393 ret_val = -E1000_ERR_MAC_INIT;
401 * e1000_setup_init_funcs - Initializes function pointers
402 * @hw: pointer to the HW structure
403 * @init_device: TRUE will initialize the rest of the function pointers
404 * getting the device ready for use. FALSE will only set
405 * MAC type and the function pointers for the other init
406 * functions. Passing FALSE will not generate any hardware
409 * This function must be called by a driver in order to use the rest
410 * of the 'shared' code files. Called by drivers only.
412 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
416 /* Can't do much good without knowing the MAC type. */
417 ret_val = e1000_set_mac_type(hw);
419 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
424 DEBUGOUT("ERROR: Registers not mapped\n");
425 ret_val = -E1000_ERR_CONFIG;
430 * Init function pointers to generic implementations. We do this first
431 * allowing a driver module to override it afterward.
433 e1000_init_mac_ops_generic(hw);
434 e1000_init_phy_ops_generic(hw);
435 e1000_init_nvm_ops_generic(hw);
436 e1000_init_mbx_ops_generic(hw);
439 * Set up the init function pointers. These are functions within the
440 * adapter family file that sets up function pointers for the rest of
441 * the functions in that family.
443 switch (hw->mac.type) {
445 e1000_init_function_pointers_82542(hw);
449 e1000_init_function_pointers_82543(hw);
453 case e1000_82545_rev_3:
455 case e1000_82546_rev_3:
456 e1000_init_function_pointers_82540(hw);
459 case e1000_82541_rev_2:
461 case e1000_82547_rev_2:
462 e1000_init_function_pointers_82541(hw);
469 e1000_init_function_pointers_82571(hw);
471 case e1000_80003es2lan:
472 e1000_init_function_pointers_80003es2lan(hw);
482 e1000_init_function_pointers_ich8lan(hw);
489 e1000_init_function_pointers_82575(hw);
493 e1000_init_function_pointers_i210(hw);
496 e1000_init_function_pointers_vf(hw);
498 case e1000_vfadapt_i350:
499 e1000_init_function_pointers_vf(hw);
502 DEBUGOUT("Hardware not supported\n");
503 ret_val = -E1000_ERR_CONFIG;
508 * Initialize the rest of the function pointers. These require some
509 * register reads/writes in some cases.
511 if (!(ret_val) && init_device) {
512 ret_val = e1000_init_mac_params(hw);
516 ret_val = e1000_init_nvm_params(hw);
520 ret_val = e1000_init_phy_params(hw);
524 ret_val = e1000_init_mbx_params(hw);
534 * e1000_get_bus_info - Obtain bus information for adapter
535 * @hw: pointer to the HW structure
537 * This will obtain information about the HW bus for which the
538 * adapter is attached and stores it in the hw structure. This is a
539 * function pointer entry point called by drivers.
541 s32 e1000_get_bus_info(struct e1000_hw *hw)
543 if (hw->mac.ops.get_bus_info)
544 return hw->mac.ops.get_bus_info(hw);
546 return E1000_SUCCESS;
550 * e1000_clear_vfta - Clear VLAN filter table
551 * @hw: pointer to the HW structure
553 * This clears the VLAN filter table on the adapter. This is a function
554 * pointer entry point called by drivers.
556 void e1000_clear_vfta(struct e1000_hw *hw)
558 if (hw->mac.ops.clear_vfta)
559 hw->mac.ops.clear_vfta(hw);
563 * e1000_write_vfta - Write value to VLAN filter table
564 * @hw: pointer to the HW structure
565 * @offset: the 32-bit offset in which to write the value to.
566 * @value: the 32-bit value to write at location offset.
568 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
569 * table. This is a function pointer entry point called by drivers.
571 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
573 if (hw->mac.ops.write_vfta)
574 hw->mac.ops.write_vfta(hw, offset, value);
578 * e1000_update_mc_addr_list - Update Multicast addresses
579 * @hw: pointer to the HW structure
580 * @mc_addr_list: array of multicast addresses to program
581 * @mc_addr_count: number of multicast addresses to program
583 * Updates the Multicast Table Array.
584 * The caller must have a packed mc_addr_list of multicast addresses.
586 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
589 if (hw->mac.ops.update_mc_addr_list)
590 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
595 * e1000_force_mac_fc - Force MAC flow control
596 * @hw: pointer to the HW structure
598 * Force the MAC's flow control settings. Currently no func pointer exists
599 * and all implementations are handled in the generic version of this
602 s32 e1000_force_mac_fc(struct e1000_hw *hw)
604 return e1000_force_mac_fc_generic(hw);
608 * e1000_check_for_link - Check/Store link connection
609 * @hw: pointer to the HW structure
611 * This checks the link condition of the adapter and stores the
612 * results in the hw->mac structure. This is a function pointer entry
613 * point called by drivers.
615 s32 e1000_check_for_link(struct e1000_hw *hw)
617 if (hw->mac.ops.check_for_link)
618 return hw->mac.ops.check_for_link(hw);
620 return -E1000_ERR_CONFIG;
624 * e1000_check_mng_mode - Check management mode
625 * @hw: pointer to the HW structure
627 * This checks if the adapter has manageability enabled.
628 * This is a function pointer entry point called by drivers.
630 bool e1000_check_mng_mode(struct e1000_hw *hw)
632 if (hw->mac.ops.check_mng_mode)
633 return hw->mac.ops.check_mng_mode(hw);
639 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
640 * @hw: pointer to the HW structure
641 * @buffer: pointer to the host interface
642 * @length: size of the buffer
644 * Writes the DHCP information to the host interface.
646 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
648 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
652 * e1000_reset_hw - Reset hardware
653 * @hw: pointer to the HW structure
655 * This resets the hardware into a known state. This is a function pointer
656 * entry point called by drivers.
658 s32 e1000_reset_hw(struct e1000_hw *hw)
660 if (hw->mac.ops.reset_hw)
661 return hw->mac.ops.reset_hw(hw);
663 return -E1000_ERR_CONFIG;
667 * e1000_init_hw - Initialize hardware
668 * @hw: pointer to the HW structure
670 * This inits the hardware readying it for operation. This is a function
671 * pointer entry point called by drivers.
673 s32 e1000_init_hw(struct e1000_hw *hw)
675 if (hw->mac.ops.init_hw)
676 return hw->mac.ops.init_hw(hw);
678 return -E1000_ERR_CONFIG;
682 * e1000_setup_link - Configures link and flow control
683 * @hw: pointer to the HW structure
685 * This configures link and flow control settings for the adapter. This
686 * is a function pointer entry point called by drivers. While modules can
687 * also call this, they probably call their own version of this function.
689 s32 e1000_setup_link(struct e1000_hw *hw)
691 if (hw->mac.ops.setup_link)
692 return hw->mac.ops.setup_link(hw);
694 return -E1000_ERR_CONFIG;
698 * e1000_get_speed_and_duplex - Returns current speed and duplex
699 * @hw: pointer to the HW structure
700 * @speed: pointer to a 16-bit value to store the speed
701 * @duplex: pointer to a 16-bit value to store the duplex.
703 * This returns the speed and duplex of the adapter in the two 'out'
704 * variables passed in. This is a function pointer entry point called
707 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
709 if (hw->mac.ops.get_link_up_info)
710 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
712 return -E1000_ERR_CONFIG;
716 * e1000_setup_led - Configures SW controllable LED
717 * @hw: pointer to the HW structure
719 * This prepares the SW controllable LED for use and saves the current state
720 * of the LED so it can be later restored. This is a function pointer entry
721 * point called by drivers.
723 s32 e1000_setup_led(struct e1000_hw *hw)
725 if (hw->mac.ops.setup_led)
726 return hw->mac.ops.setup_led(hw);
728 return E1000_SUCCESS;
732 * e1000_cleanup_led - Restores SW controllable LED
733 * @hw: pointer to the HW structure
735 * This restores the SW controllable LED to the value saved off by
736 * e1000_setup_led. This is a function pointer entry point called by drivers.
738 s32 e1000_cleanup_led(struct e1000_hw *hw)
740 if (hw->mac.ops.cleanup_led)
741 return hw->mac.ops.cleanup_led(hw);
743 return E1000_SUCCESS;
747 * e1000_blink_led - Blink SW controllable LED
748 * @hw: pointer to the HW structure
750 * This starts the adapter LED blinking. Request the LED to be setup first
751 * and cleaned up after. This is a function pointer entry point called by
754 s32 e1000_blink_led(struct e1000_hw *hw)
756 if (hw->mac.ops.blink_led)
757 return hw->mac.ops.blink_led(hw);
759 return E1000_SUCCESS;
763 * e1000_id_led_init - store LED configurations in SW
764 * @hw: pointer to the HW structure
766 * Initializes the LED config in SW. This is a function pointer entry point
769 s32 e1000_id_led_init(struct e1000_hw *hw)
771 if (hw->mac.ops.id_led_init)
772 return hw->mac.ops.id_led_init(hw);
774 return E1000_SUCCESS;
778 * e1000_led_on - Turn on SW controllable LED
779 * @hw: pointer to the HW structure
781 * Turns the SW defined LED on. This is a function pointer entry point
784 s32 e1000_led_on(struct e1000_hw *hw)
786 if (hw->mac.ops.led_on)
787 return hw->mac.ops.led_on(hw);
789 return E1000_SUCCESS;
793 * e1000_led_off - Turn off SW controllable LED
794 * @hw: pointer to the HW structure
796 * Turns the SW defined LED off. This is a function pointer entry point
799 s32 e1000_led_off(struct e1000_hw *hw)
801 if (hw->mac.ops.led_off)
802 return hw->mac.ops.led_off(hw);
804 return E1000_SUCCESS;
808 * e1000_reset_adaptive - Reset adaptive IFS
809 * @hw: pointer to the HW structure
811 * Resets the adaptive IFS. Currently no func pointer exists and all
812 * implementations are handled in the generic version of this function.
814 void e1000_reset_adaptive(struct e1000_hw *hw)
816 e1000_reset_adaptive_generic(hw);
820 * e1000_update_adaptive - Update adaptive IFS
821 * @hw: pointer to the HW structure
823 * Updates adapter IFS. Currently no func pointer exists and all
824 * implementations are handled in the generic version of this function.
826 void e1000_update_adaptive(struct e1000_hw *hw)
828 e1000_update_adaptive_generic(hw);
832 * e1000_disable_pcie_master - Disable PCI-Express master access
833 * @hw: pointer to the HW structure
835 * Disables PCI-Express master access and verifies there are no pending
836 * requests. Currently no func pointer exists and all implementations are
837 * handled in the generic version of this function.
839 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
841 return e1000_disable_pcie_master_generic(hw);
845 * e1000_config_collision_dist - Configure collision distance
846 * @hw: pointer to the HW structure
848 * Configures the collision distance to the default value and is used
851 void e1000_config_collision_dist(struct e1000_hw *hw)
853 if (hw->mac.ops.config_collision_dist)
854 hw->mac.ops.config_collision_dist(hw);
858 * e1000_rar_set - Sets a receive address register
859 * @hw: pointer to the HW structure
860 * @addr: address to set the RAR to
861 * @index: the RAR to set
863 * Sets a Receive Address Register (RAR) to the specified address.
865 int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
867 if (hw->mac.ops.rar_set)
868 return hw->mac.ops.rar_set(hw, addr, index);
870 return E1000_SUCCESS;
874 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
875 * @hw: pointer to the HW structure
877 * Ensures that the MDI/MDIX SW state is valid.
879 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
881 if (hw->mac.ops.validate_mdi_setting)
882 return hw->mac.ops.validate_mdi_setting(hw);
884 return E1000_SUCCESS;
888 * e1000_hash_mc_addr - Determines address location in multicast table
889 * @hw: pointer to the HW structure
890 * @mc_addr: Multicast address to hash.
892 * This hashes an address to determine its location in the multicast
893 * table. Currently no func pointer exists and all implementations
894 * are handled in the generic version of this function.
896 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
898 return e1000_hash_mc_addr_generic(hw, mc_addr);
902 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
903 * @hw: pointer to the HW structure
905 * Enables packet filtering on transmit packets if manageability is enabled
906 * and host interface is enabled.
907 * Currently no func pointer exists and all implementations are handled in the
908 * generic version of this function.
910 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
912 return e1000_enable_tx_pkt_filtering_generic(hw);
916 * e1000_mng_host_if_write - Writes to the manageability host interface
917 * @hw: pointer to the HW structure
918 * @buffer: pointer to the host interface buffer
919 * @length: size of the buffer
920 * @offset: location in the buffer to write to
921 * @sum: sum of the data (not checksum)
923 * This function writes the buffer content at the offset given on the host if.
924 * It also does alignment considerations to do the writes in most efficient
925 * way. Also fills up the sum of the buffer in *buffer parameter.
927 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
930 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
934 * e1000_mng_write_cmd_header - Writes manageability command header
935 * @hw: pointer to the HW structure
936 * @hdr: pointer to the host interface command header
938 * Writes the command header after does the checksum calculation.
940 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
941 struct e1000_host_mng_command_header *hdr)
943 return e1000_mng_write_cmd_header_generic(hw, hdr);
947 * e1000_mng_enable_host_if - Checks host interface is enabled
948 * @hw: pointer to the HW structure
950 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
952 * This function checks whether the HOST IF is enabled for command operation
953 * and also checks whether the previous command is completed. It busy waits
954 * in case of previous command is not completed.
956 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
958 return e1000_mng_enable_host_if_generic(hw);
962 * e1000_set_obff_timer - Set Optimized Buffer Flush/Fill timer
963 * @hw: pointer to the HW structure
964 * @itr: u32 indicating itr value
966 * Set the OBFF timer based on the given interrupt rate.
968 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr)
970 if (hw->mac.ops.set_obff_timer)
971 return hw->mac.ops.set_obff_timer(hw, itr);
973 return E1000_SUCCESS;
977 * e1000_check_reset_block - Verifies PHY can be reset
978 * @hw: pointer to the HW structure
980 * Checks if the PHY is in a state that can be reset or if manageability
981 * has it tied up. This is a function pointer entry point called by drivers.
983 s32 e1000_check_reset_block(struct e1000_hw *hw)
985 if (hw->phy.ops.check_reset_block)
986 return hw->phy.ops.check_reset_block(hw);
988 return E1000_SUCCESS;
992 * e1000_read_phy_reg - Reads PHY register
993 * @hw: pointer to the HW structure
994 * @offset: the register to read
995 * @data: the buffer to store the 16-bit read.
997 * Reads the PHY register and returns the value in data.
998 * This is a function pointer entry point called by drivers.
1000 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1002 if (hw->phy.ops.read_reg)
1003 return hw->phy.ops.read_reg(hw, offset, data);
1005 return E1000_SUCCESS;
1009 * e1000_write_phy_reg - Writes PHY register
1010 * @hw: pointer to the HW structure
1011 * @offset: the register to write
1012 * @data: the value to write.
1014 * Writes the PHY register at offset with the value in data.
1015 * This is a function pointer entry point called by drivers.
1017 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
1019 if (hw->phy.ops.write_reg)
1020 return hw->phy.ops.write_reg(hw, offset, data);
1022 return E1000_SUCCESS;
1026 * e1000_release_phy - Generic release PHY
1027 * @hw: pointer to the HW structure
1029 * Return if silicon family does not require a semaphore when accessing the
1032 void e1000_release_phy(struct e1000_hw *hw)
1034 if (hw->phy.ops.release)
1035 hw->phy.ops.release(hw);
1039 * e1000_acquire_phy - Generic acquire PHY
1040 * @hw: pointer to the HW structure
1042 * Return success if silicon family does not require a semaphore when
1043 * accessing the PHY.
1045 s32 e1000_acquire_phy(struct e1000_hw *hw)
1047 if (hw->phy.ops.acquire)
1048 return hw->phy.ops.acquire(hw);
1050 return E1000_SUCCESS;
1054 * e1000_cfg_on_link_up - Configure PHY upon link up
1055 * @hw: pointer to the HW structure
1057 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1059 if (hw->phy.ops.cfg_on_link_up)
1060 return hw->phy.ops.cfg_on_link_up(hw);
1062 return E1000_SUCCESS;
1066 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1067 * @hw: pointer to the HW structure
1068 * @offset: the register to read
1069 * @data: the location to store the 16-bit value read.
1071 * Reads a register out of the Kumeran interface. Currently no func pointer
1072 * exists and all implementations are handled in the generic version of
1075 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1077 return e1000_read_kmrn_reg_generic(hw, offset, data);
1081 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1082 * @hw: pointer to the HW structure
1083 * @offset: the register to write
1084 * @data: the value to write.
1086 * Writes a register to the Kumeran interface. Currently no func pointer
1087 * exists and all implementations are handled in the generic version of
1090 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1092 return e1000_write_kmrn_reg_generic(hw, offset, data);
1096 * e1000_get_cable_length - Retrieves cable length estimation
1097 * @hw: pointer to the HW structure
1099 * This function estimates the cable length and stores them in
1100 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1101 * entry point called by drivers.
1103 s32 e1000_get_cable_length(struct e1000_hw *hw)
1105 if (hw->phy.ops.get_cable_length)
1106 return hw->phy.ops.get_cable_length(hw);
1108 return E1000_SUCCESS;
1112 * e1000_get_phy_info - Retrieves PHY information from registers
1113 * @hw: pointer to the HW structure
1115 * This function gets some information from various PHY registers and
1116 * populates hw->phy values with it. This is a function pointer entry
1117 * point called by drivers.
1119 s32 e1000_get_phy_info(struct e1000_hw *hw)
1121 if (hw->phy.ops.get_info)
1122 return hw->phy.ops.get_info(hw);
1124 return E1000_SUCCESS;
1128 * e1000_phy_hw_reset - Hard PHY reset
1129 * @hw: pointer to the HW structure
1131 * Performs a hard PHY reset. This is a function pointer entry point called
1134 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1136 if (hw->phy.ops.reset)
1137 return hw->phy.ops.reset(hw);
1139 return E1000_SUCCESS;
1143 * e1000_phy_commit - Soft PHY reset
1144 * @hw: pointer to the HW structure
1146 * Performs a soft PHY reset on those that apply. This is a function pointer
1147 * entry point called by drivers.
1149 s32 e1000_phy_commit(struct e1000_hw *hw)
1151 if (hw->phy.ops.commit)
1152 return hw->phy.ops.commit(hw);
1154 return E1000_SUCCESS;
1158 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1159 * @hw: pointer to the HW structure
1160 * @active: boolean used to enable/disable lplu
1162 * Success returns 0, Failure returns 1
1164 * The low power link up (lplu) state is set to the power management level D0
1165 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D0
1166 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1167 * is used during Dx states where the power conservation is most important.
1168 * During driver activity, SmartSpeed should be enabled so performance is
1169 * maintained. This is a function pointer entry point called by drivers.
1171 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1173 if (hw->phy.ops.set_d0_lplu_state)
1174 return hw->phy.ops.set_d0_lplu_state(hw, active);
1176 return E1000_SUCCESS;
1180 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1181 * @hw: pointer to the HW structure
1182 * @active: boolean used to enable/disable lplu
1184 * Success returns 0, Failure returns 1
1186 * The low power link up (lplu) state is set to the power management level D3
1187 * and SmartSpeed is disabled when active is TRUE, else clear lplu for D3
1188 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1189 * is used during Dx states where the power conservation is most important.
1190 * During driver activity, SmartSpeed should be enabled so performance is
1191 * maintained. This is a function pointer entry point called by drivers.
1193 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1195 if (hw->phy.ops.set_d3_lplu_state)
1196 return hw->phy.ops.set_d3_lplu_state(hw, active);
1198 return E1000_SUCCESS;
1202 * e1000_read_mac_addr - Reads MAC address
1203 * @hw: pointer to the HW structure
1205 * Reads the MAC address out of the adapter and stores it in the HW structure.
1206 * Currently no func pointer exists and all implementations are handled in the
1207 * generic version of this function.
1209 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1211 if (hw->mac.ops.read_mac_addr)
1212 return hw->mac.ops.read_mac_addr(hw);
1214 return e1000_read_mac_addr_generic(hw);
1218 * e1000_read_pba_string - Read device part number string
1219 * @hw: pointer to the HW structure
1220 * @pba_num: pointer to device part number
1221 * @pba_num_size: size of part number buffer
1223 * Reads the product board assembly (PBA) number from the EEPROM and stores
1224 * the value in pba_num.
1225 * Currently no func pointer exists and all implementations are handled in the
1226 * generic version of this function.
1228 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1230 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1234 * e1000_read_pba_length - Read device part number string length
1235 * @hw: pointer to the HW structure
1236 * @pba_num_size: size of part number buffer
1238 * Reads the product board assembly (PBA) number length from the EEPROM and
1239 * stores the value in pba_num.
1240 * Currently no func pointer exists and all implementations are handled in the
1241 * generic version of this function.
1243 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1245 return e1000_read_pba_length_generic(hw, pba_num_size);
1249 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1250 * @hw: pointer to the HW structure
1252 * Validates the NVM checksum is correct. This is a function pointer entry
1253 * point called by drivers.
1255 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1257 if (hw->nvm.ops.validate)
1258 return hw->nvm.ops.validate(hw);
1260 return -E1000_ERR_CONFIG;
1264 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1265 * @hw: pointer to the HW structure
1267 * Updates the NVM checksum. Currently no func pointer exists and all
1268 * implementations are handled in the generic version of this function.
1270 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1272 if (hw->nvm.ops.update)
1273 return hw->nvm.ops.update(hw);
1275 return -E1000_ERR_CONFIG;
1279 * e1000_reload_nvm - Reloads EEPROM
1280 * @hw: pointer to the HW structure
1282 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1283 * extended control register.
1285 void e1000_reload_nvm(struct e1000_hw *hw)
1287 if (hw->nvm.ops.reload)
1288 hw->nvm.ops.reload(hw);
1292 * e1000_read_nvm - Reads NVM (EEPROM)
1293 * @hw: pointer to the HW structure
1294 * @offset: the word offset to read
1295 * @words: number of 16-bit words to read
1296 * @data: pointer to the properly sized buffer for the data.
1298 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1299 * pointer entry point called by drivers.
1301 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1303 if (hw->nvm.ops.read)
1304 return hw->nvm.ops.read(hw, offset, words, data);
1306 return -E1000_ERR_CONFIG;
1310 * e1000_write_nvm - Writes to NVM (EEPROM)
1311 * @hw: pointer to the HW structure
1312 * @offset: the word offset to read
1313 * @words: number of 16-bit words to write
1314 * @data: pointer to the properly sized buffer for the data.
1316 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1317 * pointer entry point called by drivers.
1319 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1321 if (hw->nvm.ops.write)
1322 return hw->nvm.ops.write(hw, offset, words, data);
1324 return E1000_SUCCESS;
1328 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1329 * @hw: pointer to the HW structure
1330 * @reg: 32bit register offset
1331 * @offset: the register to write
1332 * @data: the value to write.
1334 * Writes the PHY register at offset with the value in data.
1335 * This is a function pointer entry point called by drivers.
1337 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1340 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1344 * e1000_power_up_phy - Restores link in case of PHY power down
1345 * @hw: pointer to the HW structure
1347 * The phy may be powered down to save power, to turn off link when the
1348 * driver is unloaded, or wake on lan is not enabled (among others).
1350 void e1000_power_up_phy(struct e1000_hw *hw)
1352 if (hw->phy.ops.power_up)
1353 hw->phy.ops.power_up(hw);
1355 e1000_setup_link(hw);
1359 * e1000_power_down_phy - Power down PHY
1360 * @hw: pointer to the HW structure
1362 * The phy may be powered down to save power, to turn off link when the
1363 * driver is unloaded, or wake on lan is not enabled (among others).
1365 void e1000_power_down_phy(struct e1000_hw *hw)
1367 if (hw->phy.ops.power_down)
1368 hw->phy.ops.power_down(hw);
1372 * e1000_power_up_fiber_serdes_link - Power up serdes link
1373 * @hw: pointer to the HW structure
1375 * Power on the optics and PCS.
1377 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1379 if (hw->mac.ops.power_up_serdes)
1380 hw->mac.ops.power_up_serdes(hw);
1384 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1385 * @hw: pointer to the HW structure
1387 * Shutdown the optics and PCS on driver unload.
1389 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1391 if (hw->mac.ops.shutdown_serdes)
1392 hw->mac.ops.shutdown_serdes(hw);