1 /******************************************************************************
2 SPDX-License-Identifier: BSD-3-Clause
3
4 Copyright (c) 2001-2020, Intel Corporation
5 All rights reserved.
6
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9
10 1. Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12
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.
16
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.
20
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.
32
33 ******************************************************************************/
34
35 #include "e1000_api.h"
36
37 /**
38 * e1000_init_mac_params - Initialize MAC function pointers
39 * @hw: pointer to the HW structure
40 *
41 * This function initializes the function pointers for the MAC
42 * set of functions. Called by drivers or by e1000_setup_init_funcs.
43 **/
e1000_init_mac_params(struct e1000_hw * hw)44 s32 e1000_init_mac_params(struct e1000_hw *hw)
45 {
46 s32 ret_val = E1000_SUCCESS;
47
48 if (hw->mac.ops.init_params) {
49 ret_val = hw->mac.ops.init_params(hw);
50 if (ret_val) {
51 DEBUGOUT("MAC Initialization Error\n");
52 goto out;
53 }
54 } else {
55 DEBUGOUT("mac.init_mac_params was NULL\n");
56 ret_val = -E1000_ERR_CONFIG;
57 }
58
59 out:
60 return ret_val;
61 }
62
63 /**
64 * e1000_init_nvm_params - Initialize NVM function pointers
65 * @hw: pointer to the HW structure
66 *
67 * This function initializes the function pointers for the NVM
68 * set of functions. Called by drivers or by e1000_setup_init_funcs.
69 **/
e1000_init_nvm_params(struct e1000_hw * hw)70 s32 e1000_init_nvm_params(struct e1000_hw *hw)
71 {
72 s32 ret_val = E1000_SUCCESS;
73
74 if (hw->nvm.ops.init_params) {
75 ret_val = hw->nvm.ops.init_params(hw);
76 if (ret_val) {
77 DEBUGOUT("NVM Initialization Error\n");
78 goto out;
79 }
80 } else {
81 DEBUGOUT("nvm.init_nvm_params was NULL\n");
82 ret_val = -E1000_ERR_CONFIG;
83 }
84
85 out:
86 return ret_val;
87 }
88
89 /**
90 * e1000_init_phy_params - Initialize PHY function pointers
91 * @hw: pointer to the HW structure
92 *
93 * This function initializes the function pointers for the PHY
94 * set of functions. Called by drivers or by e1000_setup_init_funcs.
95 **/
e1000_init_phy_params(struct e1000_hw * hw)96 s32 e1000_init_phy_params(struct e1000_hw *hw)
97 {
98 s32 ret_val = E1000_SUCCESS;
99
100 if (hw->phy.ops.init_params) {
101 ret_val = hw->phy.ops.init_params(hw);
102 if (ret_val) {
103 DEBUGOUT("PHY Initialization Error\n");
104 goto out;
105 }
106 } else {
107 DEBUGOUT("phy.init_phy_params was NULL\n");
108 ret_val = -E1000_ERR_CONFIG;
109 }
110
111 out:
112 return ret_val;
113 }
114
115 /**
116 * e1000_init_mbx_params - Initialize mailbox function pointers
117 * @hw: pointer to the HW structure
118 *
119 * This function initializes the function pointers for the PHY
120 * set of functions. Called by drivers or by e1000_setup_init_funcs.
121 **/
e1000_init_mbx_params(struct e1000_hw * hw)122 s32 e1000_init_mbx_params(struct e1000_hw *hw)
123 {
124 s32 ret_val = E1000_SUCCESS;
125
126 if (hw->mbx.ops.init_params) {
127 ret_val = hw->mbx.ops.init_params(hw);
128 if (ret_val) {
129 DEBUGOUT("Mailbox Initialization Error\n");
130 goto out;
131 }
132 } else {
133 DEBUGOUT("mbx.init_mbx_params was NULL\n");
134 ret_val = -E1000_ERR_CONFIG;
135 }
136
137 out:
138 return ret_val;
139 }
140
141 /**
142 * e1000_set_mac_type - Sets MAC type
143 * @hw: pointer to the HW structure
144 *
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()).
149 **/
e1000_set_mac_type(struct e1000_hw * hw)150 s32 e1000_set_mac_type(struct e1000_hw *hw)
151 {
152 struct e1000_mac_info *mac = &hw->mac;
153 s32 ret_val = E1000_SUCCESS;
154
155 DEBUGFUNC("e1000_set_mac_type");
156
157 switch (hw->device_id) {
158 case E1000_DEV_ID_82542:
159 mac->type = e1000_82542;
160 break;
161 case E1000_DEV_ID_82543GC_FIBER:
162 case E1000_DEV_ID_82543GC_COPPER:
163 mac->type = e1000_82543;
164 break;
165 case E1000_DEV_ID_82544EI_COPPER:
166 case E1000_DEV_ID_82544EI_FIBER:
167 case E1000_DEV_ID_82544GC_COPPER:
168 case E1000_DEV_ID_82544GC_LOM:
169 mac->type = e1000_82544;
170 break;
171 case E1000_DEV_ID_82540EM:
172 case E1000_DEV_ID_82540EM_LOM:
173 case E1000_DEV_ID_82540EP:
174 case E1000_DEV_ID_82540EP_LOM:
175 case E1000_DEV_ID_82540EP_LP:
176 mac->type = e1000_82540;
177 break;
178 case E1000_DEV_ID_82545EM_COPPER:
179 case E1000_DEV_ID_82545EM_FIBER:
180 mac->type = e1000_82545;
181 break;
182 case E1000_DEV_ID_82545GM_COPPER:
183 case E1000_DEV_ID_82545GM_FIBER:
184 case E1000_DEV_ID_82545GM_SERDES:
185 mac->type = e1000_82545_rev_3;
186 break;
187 case E1000_DEV_ID_82546EB_COPPER:
188 case E1000_DEV_ID_82546EB_FIBER:
189 case E1000_DEV_ID_82546EB_QUAD_COPPER:
190 mac->type = e1000_82546;
191 break;
192 case E1000_DEV_ID_82546GB_COPPER:
193 case E1000_DEV_ID_82546GB_FIBER:
194 case E1000_DEV_ID_82546GB_SERDES:
195 case E1000_DEV_ID_82546GB_PCIE:
196 case E1000_DEV_ID_82546GB_QUAD_COPPER:
197 case E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3:
198 mac->type = e1000_82546_rev_3;
199 break;
200 case E1000_DEV_ID_82541EI:
201 case E1000_DEV_ID_82541EI_MOBILE:
202 case E1000_DEV_ID_82541ER_LOM:
203 mac->type = e1000_82541;
204 break;
205 case E1000_DEV_ID_82541ER:
206 case E1000_DEV_ID_82541GI:
207 case E1000_DEV_ID_82541GI_LF:
208 case E1000_DEV_ID_82541GI_MOBILE:
209 mac->type = e1000_82541_rev_2;
210 break;
211 case E1000_DEV_ID_82547EI:
212 case E1000_DEV_ID_82547EI_MOBILE:
213 mac->type = e1000_82547;
214 break;
215 case E1000_DEV_ID_82547GI:
216 mac->type = e1000_82547_rev_2;
217 break;
218 case E1000_DEV_ID_82571EB_COPPER:
219 case E1000_DEV_ID_82571EB_FIBER:
220 case E1000_DEV_ID_82571EB_SERDES:
221 case E1000_DEV_ID_82571EB_SERDES_DUAL:
222 case E1000_DEV_ID_82571EB_SERDES_QUAD:
223 case E1000_DEV_ID_82571EB_QUAD_COPPER:
224 case E1000_DEV_ID_82571PT_QUAD_COPPER:
225 case E1000_DEV_ID_82571EB_QUAD_FIBER:
226 case E1000_DEV_ID_82571EB_QUAD_COPPER_LP:
227 mac->type = e1000_82571;
228 break;
229 case E1000_DEV_ID_82572EI:
230 case E1000_DEV_ID_82572EI_COPPER:
231 case E1000_DEV_ID_82572EI_FIBER:
232 case E1000_DEV_ID_82572EI_SERDES:
233 mac->type = e1000_82572;
234 break;
235 case E1000_DEV_ID_82573E:
236 case E1000_DEV_ID_82573E_IAMT:
237 case E1000_DEV_ID_82573L:
238 mac->type = e1000_82573;
239 break;
240 case E1000_DEV_ID_82574L:
241 case E1000_DEV_ID_82574LA:
242 mac->type = e1000_82574;
243 break;
244 case E1000_DEV_ID_82583V:
245 mac->type = e1000_82583;
246 break;
247 case E1000_DEV_ID_80003ES2LAN_COPPER_DPT:
248 case E1000_DEV_ID_80003ES2LAN_SERDES_DPT:
249 case E1000_DEV_ID_80003ES2LAN_COPPER_SPT:
250 case E1000_DEV_ID_80003ES2LAN_SERDES_SPT:
251 mac->type = e1000_80003es2lan;
252 break;
253 case E1000_DEV_ID_ICH8_IFE:
254 case E1000_DEV_ID_ICH8_IFE_GT:
255 case E1000_DEV_ID_ICH8_IFE_G:
256 case E1000_DEV_ID_ICH8_IGP_M:
257 case E1000_DEV_ID_ICH8_IGP_M_AMT:
258 case E1000_DEV_ID_ICH8_IGP_AMT:
259 case E1000_DEV_ID_ICH8_IGP_C:
260 case E1000_DEV_ID_ICH8_82567V_3:
261 mac->type = e1000_ich8lan;
262 break;
263 case E1000_DEV_ID_ICH9_IFE:
264 case E1000_DEV_ID_ICH9_IFE_GT:
265 case E1000_DEV_ID_ICH9_IFE_G:
266 case E1000_DEV_ID_ICH9_IGP_M:
267 case E1000_DEV_ID_ICH9_IGP_M_AMT:
268 case E1000_DEV_ID_ICH9_IGP_M_V:
269 case E1000_DEV_ID_ICH9_IGP_AMT:
270 case E1000_DEV_ID_ICH9_BM:
271 case E1000_DEV_ID_ICH9_IGP_C:
272 case E1000_DEV_ID_ICH10_R_BM_LM:
273 case E1000_DEV_ID_ICH10_R_BM_LF:
274 case E1000_DEV_ID_ICH10_R_BM_V:
275 mac->type = e1000_ich9lan;
276 break;
277 case E1000_DEV_ID_ICH10_D_BM_LM:
278 case E1000_DEV_ID_ICH10_D_BM_LF:
279 case E1000_DEV_ID_ICH10_D_BM_V:
280 mac->type = e1000_ich10lan;
281 break;
282 case E1000_DEV_ID_PCH_D_HV_DM:
283 case E1000_DEV_ID_PCH_D_HV_DC:
284 case E1000_DEV_ID_PCH_M_HV_LM:
285 case E1000_DEV_ID_PCH_M_HV_LC:
286 mac->type = e1000_pchlan;
287 break;
288 case E1000_DEV_ID_PCH2_LV_LM:
289 case E1000_DEV_ID_PCH2_LV_V:
290 mac->type = e1000_pch2lan;
291 break;
292 case E1000_DEV_ID_PCH_LPT_I217_LM:
293 case E1000_DEV_ID_PCH_LPT_I217_V:
294 case E1000_DEV_ID_PCH_LPTLP_I218_LM:
295 case E1000_DEV_ID_PCH_LPTLP_I218_V:
296 case E1000_DEV_ID_PCH_I218_LM2:
297 case E1000_DEV_ID_PCH_I218_V2:
298 case E1000_DEV_ID_PCH_I218_LM3:
299 case E1000_DEV_ID_PCH_I218_V3:
300 mac->type = e1000_pch_lpt;
301 break;
302 case E1000_DEV_ID_PCH_SPT_I219_LM:
303 case E1000_DEV_ID_PCH_SPT_I219_V:
304 case E1000_DEV_ID_PCH_SPT_I219_LM2:
305 case E1000_DEV_ID_PCH_SPT_I219_V2:
306 case E1000_DEV_ID_PCH_LBG_I219_LM3:
307 case E1000_DEV_ID_PCH_SPT_I219_LM4:
308 case E1000_DEV_ID_PCH_SPT_I219_V4:
309 case E1000_DEV_ID_PCH_SPT_I219_LM5:
310 case E1000_DEV_ID_PCH_SPT_I219_V5:
311 case E1000_DEV_ID_PCH_CMP_I219_LM12:
312 case E1000_DEV_ID_PCH_CMP_I219_V12:
313 mac->type = e1000_pch_spt;
314 break;
315 case E1000_DEV_ID_PCH_CNP_I219_LM6:
316 case E1000_DEV_ID_PCH_CNP_I219_V6:
317 case E1000_DEV_ID_PCH_CNP_I219_LM7:
318 case E1000_DEV_ID_PCH_CNP_I219_V7:
319 case E1000_DEV_ID_PCH_ICP_I219_LM8:
320 case E1000_DEV_ID_PCH_ICP_I219_V8:
321 case E1000_DEV_ID_PCH_ICP_I219_LM9:
322 case E1000_DEV_ID_PCH_ICP_I219_V9:
323 case E1000_DEV_ID_PCH_CMP_I219_LM10:
324 case E1000_DEV_ID_PCH_CMP_I219_V10:
325 case E1000_DEV_ID_PCH_CMP_I219_LM11:
326 case E1000_DEV_ID_PCH_CMP_I219_V11:
327 mac->type = e1000_pch_cnp;
328 break;
329 case E1000_DEV_ID_PCH_TGP_I219_LM13:
330 case E1000_DEV_ID_PCH_TGP_I219_V13:
331 case E1000_DEV_ID_PCH_TGP_I219_LM14:
332 case E1000_DEV_ID_PCH_TGP_I219_V14:
333 case E1000_DEV_ID_PCH_TGP_I219_LM15:
334 case E1000_DEV_ID_PCH_TGP_I219_V15:
335 mac->type = e1000_pch_tgp;
336 break;
337 case E1000_DEV_ID_PCH_ADL_I219_LM16:
338 case E1000_DEV_ID_PCH_ADL_I219_V16:
339 case E1000_DEV_ID_PCH_ADL_I219_LM17:
340 case E1000_DEV_ID_PCH_ADL_I219_V17:
341 case E1000_DEV_ID_PCH_ADL_I219_LM19:
342 case E1000_DEV_ID_PCH_ADL_I219_V19:
343 mac->type = e1000_pch_adp;
344 break;
345 case E1000_DEV_ID_PCH_MTP_I219_LM18:
346 case E1000_DEV_ID_PCH_MTP_I219_V18:
347 mac->type = e1000_pch_mtp;
348 break;
349 case E1000_DEV_ID_PCH_ARL_I219_LM24:
350 case E1000_DEV_ID_PCH_ARL_I219_V24:
351 case E1000_DEV_ID_PCH_PTP_I219_LM25:
352 case E1000_DEV_ID_PCH_PTP_I219_V25:
353 case E1000_DEV_ID_PCH_PTP_I219_LM26:
354 case E1000_DEV_ID_PCH_PTP_I219_V26:
355 case E1000_DEV_ID_PCH_PTP_I219_LM27:
356 case E1000_DEV_ID_PCH_PTP_I219_V27:
357 mac->type = e1000_pch_ptp;
358 break;
359 case E1000_DEV_ID_82575EB_COPPER:
360 case E1000_DEV_ID_82575EB_FIBER_SERDES:
361 case E1000_DEV_ID_82575GB_QUAD_COPPER:
362 mac->type = e1000_82575;
363 break;
364 case E1000_DEV_ID_82576:
365 case E1000_DEV_ID_82576_FIBER:
366 case E1000_DEV_ID_82576_SERDES:
367 case E1000_DEV_ID_82576_QUAD_COPPER:
368 case E1000_DEV_ID_82576_QUAD_COPPER_ET2:
369 case E1000_DEV_ID_82576_NS:
370 case E1000_DEV_ID_82576_NS_SERDES:
371 case E1000_DEV_ID_82576_SERDES_QUAD:
372 mac->type = e1000_82576;
373 break;
374 case E1000_DEV_ID_82580_COPPER:
375 case E1000_DEV_ID_82580_FIBER:
376 case E1000_DEV_ID_82580_SERDES:
377 case E1000_DEV_ID_82580_SGMII:
378 case E1000_DEV_ID_82580_COPPER_DUAL:
379 case E1000_DEV_ID_82580_QUAD_FIBER:
380 case E1000_DEV_ID_DH89XXCC_SGMII:
381 case E1000_DEV_ID_DH89XXCC_SERDES:
382 case E1000_DEV_ID_DH89XXCC_BACKPLANE:
383 case E1000_DEV_ID_DH89XXCC_SFP:
384 mac->type = e1000_82580;
385 break;
386 case E1000_DEV_ID_I350_COPPER:
387 case E1000_DEV_ID_I350_FIBER:
388 case E1000_DEV_ID_I350_SERDES:
389 case E1000_DEV_ID_I350_SGMII:
390 case E1000_DEV_ID_I350_DA4:
391 mac->type = e1000_i350;
392 break;
393 case E1000_DEV_ID_I210_COPPER_FLASHLESS:
394 case E1000_DEV_ID_I210_SERDES_FLASHLESS:
395 case E1000_DEV_ID_I210_SGMII_FLASHLESS:
396 case E1000_DEV_ID_I210_COPPER:
397 case E1000_DEV_ID_I210_COPPER_OEM1:
398 case E1000_DEV_ID_I210_COPPER_IT:
399 case E1000_DEV_ID_I210_FIBER:
400 case E1000_DEV_ID_I210_SERDES:
401 case E1000_DEV_ID_I210_SGMII:
402 mac->type = e1000_i210;
403 break;
404 case E1000_DEV_ID_I211_COPPER:
405 mac->type = e1000_i211;
406 break;
407 case E1000_DEV_ID_82576_VF:
408 case E1000_DEV_ID_82576_VF_HV:
409 mac->type = e1000_vfadapt;
410 break;
411 case E1000_DEV_ID_I350_VF:
412 case E1000_DEV_ID_I350_VF_HV:
413 mac->type = e1000_vfadapt_i350;
414 break;
415
416 case E1000_DEV_ID_I354_BACKPLANE_1GBPS:
417 case E1000_DEV_ID_I354_SGMII:
418 case E1000_DEV_ID_I354_BACKPLANE_2_5GBPS:
419 mac->type = e1000_i354;
420 break;
421 default:
422 /* Should never have loaded on this device */
423 ret_val = -E1000_ERR_MAC_INIT;
424 break;
425 }
426
427 return ret_val;
428 }
429
430 /**
431 * e1000_setup_init_funcs - Initializes function pointers
432 * @hw: pointer to the HW structure
433 * @init_device: true will initialize the rest of the function pointers
434 * getting the device ready for use. false will only set
435 * MAC type and the function pointers for the other init
436 * functions. Passing false will not generate any hardware
437 * reads or writes.
438 *
439 * This function must be called by a driver in order to use the rest
440 * of the 'shared' code files. Called by drivers only.
441 **/
e1000_setup_init_funcs(struct e1000_hw * hw,bool init_device)442 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device)
443 {
444 s32 ret_val;
445
446 /* Can't do much good without knowing the MAC type. */
447 ret_val = e1000_set_mac_type(hw);
448 if (ret_val) {
449 DEBUGOUT("ERROR: MAC type could not be set properly.\n");
450 goto out;
451 }
452
453 if (!hw->hw_addr) {
454 DEBUGOUT("ERROR: Registers not mapped\n");
455 ret_val = -E1000_ERR_CONFIG;
456 goto out;
457 }
458
459 /*
460 * Init function pointers to generic implementations. We do this first
461 * allowing a driver module to override it afterward.
462 */
463 e1000_init_mac_ops_generic(hw);
464 e1000_init_phy_ops_generic(hw);
465 e1000_init_nvm_ops_generic(hw);
466 e1000_init_mbx_ops_generic(hw);
467
468 /*
469 * Set up the init function pointers. These are functions within the
470 * adapter family file that sets up function pointers for the rest of
471 * the functions in that family.
472 */
473 switch (hw->mac.type) {
474 case e1000_82542:
475 e1000_init_function_pointers_82542(hw);
476 break;
477 case e1000_82543:
478 case e1000_82544:
479 e1000_init_function_pointers_82543(hw);
480 break;
481 case e1000_82540:
482 case e1000_82545:
483 case e1000_82545_rev_3:
484 case e1000_82546:
485 case e1000_82546_rev_3:
486 e1000_init_function_pointers_82540(hw);
487 break;
488 case e1000_82541:
489 case e1000_82541_rev_2:
490 case e1000_82547:
491 case e1000_82547_rev_2:
492 e1000_init_function_pointers_82541(hw);
493 break;
494 case e1000_82571:
495 case e1000_82572:
496 case e1000_82573:
497 case e1000_82574:
498 case e1000_82583:
499 e1000_init_function_pointers_82571(hw);
500 break;
501 case e1000_80003es2lan:
502 e1000_init_function_pointers_80003es2lan(hw);
503 break;
504 case e1000_ich8lan:
505 case e1000_ich9lan:
506 case e1000_ich10lan:
507 case e1000_pchlan:
508 case e1000_pch2lan:
509 case e1000_pch_lpt:
510 case e1000_pch_spt:
511 case e1000_pch_cnp:
512 case e1000_pch_tgp:
513 case e1000_pch_adp:
514 case e1000_pch_mtp:
515 case e1000_pch_ptp:
516 e1000_init_function_pointers_ich8lan(hw);
517 break;
518 case e1000_82575:
519 case e1000_82576:
520 case e1000_82580:
521 case e1000_i350:
522 case e1000_i354:
523 e1000_init_function_pointers_82575(hw);
524 break;
525 case e1000_i210:
526 case e1000_i211:
527 e1000_init_function_pointers_i210(hw);
528 break;
529 case e1000_vfadapt:
530 e1000_init_function_pointers_vf(hw);
531 break;
532 case e1000_vfadapt_i350:
533 e1000_init_function_pointers_vf(hw);
534 break;
535 default:
536 DEBUGOUT("Hardware not supported\n");
537 ret_val = -E1000_ERR_CONFIG;
538 break;
539 }
540
541 /*
542 * Initialize the rest of the function pointers. These require some
543 * register reads/writes in some cases.
544 */
545 if (!(ret_val) && init_device) {
546 ret_val = e1000_init_mac_params(hw);
547 if (ret_val)
548 goto out;
549
550 ret_val = e1000_init_nvm_params(hw);
551 if (ret_val)
552 goto out;
553
554 ret_val = e1000_init_phy_params(hw);
555 if (ret_val)
556 goto out;
557
558 ret_val = e1000_init_mbx_params(hw);
559 if (ret_val)
560 goto out;
561 }
562
563 out:
564 return ret_val;
565 }
566
567 /**
568 * e1000_get_bus_info - Obtain bus information for adapter
569 * @hw: pointer to the HW structure
570 *
571 * This will obtain information about the HW bus for which the
572 * adapter is attached and stores it in the hw structure. This is a
573 * function pointer entry point called by drivers.
574 **/
e1000_get_bus_info(struct e1000_hw * hw)575 s32 e1000_get_bus_info(struct e1000_hw *hw)
576 {
577 if (hw->mac.ops.get_bus_info)
578 return hw->mac.ops.get_bus_info(hw);
579
580 return E1000_SUCCESS;
581 }
582
583 /**
584 * e1000_clear_vfta - Clear VLAN filter table
585 * @hw: pointer to the HW structure
586 *
587 * This clears the VLAN filter table on the adapter. This is a function
588 * pointer entry point called by drivers.
589 **/
e1000_clear_vfta(struct e1000_hw * hw)590 void e1000_clear_vfta(struct e1000_hw *hw)
591 {
592 if (hw->mac.ops.clear_vfta)
593 hw->mac.ops.clear_vfta(hw);
594 }
595
596 /**
597 * e1000_write_vfta - Write value to VLAN filter table
598 * @hw: pointer to the HW structure
599 * @offset: the 32-bit offset in which to write the value to.
600 * @value: the 32-bit value to write at location offset.
601 *
602 * This writes a 32-bit value to a 32-bit offset in the VLAN filter
603 * table. This is a function pointer entry point called by drivers.
604 **/
e1000_write_vfta(struct e1000_hw * hw,u32 offset,u32 value)605 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
606 {
607 if (hw->mac.ops.write_vfta)
608 hw->mac.ops.write_vfta(hw, offset, value);
609 }
610
611 /**
612 * e1000_update_mc_addr_list - Update Multicast addresses
613 * @hw: pointer to the HW structure
614 * @mc_addr_list: array of multicast addresses to program
615 * @mc_addr_count: number of multicast addresses to program
616 *
617 * Updates the Multicast Table Array.
618 * The caller must have a packed mc_addr_list of multicast addresses.
619 **/
e1000_update_mc_addr_list(struct e1000_hw * hw,u8 * mc_addr_list,u32 mc_addr_count)620 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
621 u32 mc_addr_count)
622 {
623 if (hw->mac.ops.update_mc_addr_list)
624 hw->mac.ops.update_mc_addr_list(hw, mc_addr_list,
625 mc_addr_count);
626 }
627
628 /**
629 * e1000_force_mac_fc - Force MAC flow control
630 * @hw: pointer to the HW structure
631 *
632 * Force the MAC's flow control settings. Currently no func pointer exists
633 * and all implementations are handled in the generic version of this
634 * function.
635 **/
e1000_force_mac_fc(struct e1000_hw * hw)636 s32 e1000_force_mac_fc(struct e1000_hw *hw)
637 {
638 return e1000_force_mac_fc_generic(hw);
639 }
640
641 /**
642 * e1000_check_for_link - Check/Store link connection
643 * @hw: pointer to the HW structure
644 *
645 * This checks the link condition of the adapter and stores the
646 * results in the hw->mac structure. This is a function pointer entry
647 * point called by drivers.
648 **/
e1000_check_for_link(struct e1000_hw * hw)649 s32 e1000_check_for_link(struct e1000_hw *hw)
650 {
651 if (hw->mac.ops.check_for_link)
652 return hw->mac.ops.check_for_link(hw);
653
654 return -E1000_ERR_CONFIG;
655 }
656
657 /**
658 * e1000_check_mng_mode - Check management mode
659 * @hw: pointer to the HW structure
660 *
661 * This checks if the adapter has manageability enabled.
662 * This is a function pointer entry point called by drivers.
663 **/
e1000_check_mng_mode(struct e1000_hw * hw)664 bool e1000_check_mng_mode(struct e1000_hw *hw)
665 {
666 if (hw->mac.ops.check_mng_mode)
667 return hw->mac.ops.check_mng_mode(hw);
668
669 return false;
670 }
671
672 /**
673 * e1000_mng_write_dhcp_info - Writes DHCP info to host interface
674 * @hw: pointer to the HW structure
675 * @buffer: pointer to the host interface
676 * @length: size of the buffer
677 *
678 * Writes the DHCP information to the host interface.
679 **/
e1000_mng_write_dhcp_info(struct e1000_hw * hw,u8 * buffer,u16 length)680 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length)
681 {
682 return e1000_mng_write_dhcp_info_generic(hw, buffer, length);
683 }
684
685 /**
686 * e1000_reset_hw - Reset hardware
687 * @hw: pointer to the HW structure
688 *
689 * This resets the hardware into a known state. This is a function pointer
690 * entry point called by drivers.
691 **/
e1000_reset_hw(struct e1000_hw * hw)692 s32 e1000_reset_hw(struct e1000_hw *hw)
693 {
694 if (hw->mac.ops.reset_hw)
695 return hw->mac.ops.reset_hw(hw);
696
697 return -E1000_ERR_CONFIG;
698 }
699
700 /**
701 * e1000_init_hw - Initialize hardware
702 * @hw: pointer to the HW structure
703 *
704 * This inits the hardware readying it for operation. This is a function
705 * pointer entry point called by drivers.
706 **/
e1000_init_hw(struct e1000_hw * hw)707 s32 e1000_init_hw(struct e1000_hw *hw)
708 {
709 if (hw->mac.ops.init_hw)
710 return hw->mac.ops.init_hw(hw);
711
712 return -E1000_ERR_CONFIG;
713 }
714
715 /**
716 * e1000_setup_link - Configures link and flow control
717 * @hw: pointer to the HW structure
718 *
719 * This configures link and flow control settings for the adapter. This
720 * is a function pointer entry point called by drivers. While modules can
721 * also call this, they probably call their own version of this function.
722 **/
e1000_setup_link(struct e1000_hw * hw)723 s32 e1000_setup_link(struct e1000_hw *hw)
724 {
725 if (hw->mac.ops.setup_link)
726 return hw->mac.ops.setup_link(hw);
727
728 return -E1000_ERR_CONFIG;
729 }
730
731 /**
732 * e1000_get_speed_and_duplex - Returns current speed and duplex
733 * @hw: pointer to the HW structure
734 * @speed: pointer to a 16-bit value to store the speed
735 * @duplex: pointer to a 16-bit value to store the duplex.
736 *
737 * This returns the speed and duplex of the adapter in the two 'out'
738 * variables passed in. This is a function pointer entry point called
739 * by drivers.
740 **/
e1000_get_speed_and_duplex(struct e1000_hw * hw,u16 * speed,u16 * duplex)741 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex)
742 {
743 if (hw->mac.ops.get_link_up_info)
744 return hw->mac.ops.get_link_up_info(hw, speed, duplex);
745
746 return -E1000_ERR_CONFIG;
747 }
748
749 /**
750 * e1000_setup_led - Configures SW controllable LED
751 * @hw: pointer to the HW structure
752 *
753 * This prepares the SW controllable LED for use and saves the current state
754 * of the LED so it can be later restored. This is a function pointer entry
755 * point called by drivers.
756 **/
e1000_setup_led(struct e1000_hw * hw)757 s32 e1000_setup_led(struct e1000_hw *hw)
758 {
759 if (hw->mac.ops.setup_led)
760 return hw->mac.ops.setup_led(hw);
761
762 return E1000_SUCCESS;
763 }
764
765 /**
766 * e1000_cleanup_led - Restores SW controllable LED
767 * @hw: pointer to the HW structure
768 *
769 * This restores the SW controllable LED to the value saved off by
770 * e1000_setup_led. This is a function pointer entry point called by drivers.
771 **/
e1000_cleanup_led(struct e1000_hw * hw)772 s32 e1000_cleanup_led(struct e1000_hw *hw)
773 {
774 if (hw->mac.ops.cleanup_led)
775 return hw->mac.ops.cleanup_led(hw);
776
777 return E1000_SUCCESS;
778 }
779
780 /**
781 * e1000_blink_led - Blink SW controllable LED
782 * @hw: pointer to the HW structure
783 *
784 * This starts the adapter LED blinking. Request the LED to be setup first
785 * and cleaned up after. This is a function pointer entry point called by
786 * drivers.
787 **/
e1000_blink_led(struct e1000_hw * hw)788 s32 e1000_blink_led(struct e1000_hw *hw)
789 {
790 if (hw->mac.ops.blink_led)
791 return hw->mac.ops.blink_led(hw);
792
793 return E1000_SUCCESS;
794 }
795
796 /**
797 * e1000_id_led_init - store LED configurations in SW
798 * @hw: pointer to the HW structure
799 *
800 * Initializes the LED config in SW. This is a function pointer entry point
801 * called by drivers.
802 **/
e1000_id_led_init(struct e1000_hw * hw)803 s32 e1000_id_led_init(struct e1000_hw *hw)
804 {
805 if (hw->mac.ops.id_led_init)
806 return hw->mac.ops.id_led_init(hw);
807
808 return E1000_SUCCESS;
809 }
810
811 /**
812 * e1000_led_on - Turn on SW controllable LED
813 * @hw: pointer to the HW structure
814 *
815 * Turns the SW defined LED on. This is a function pointer entry point
816 * called by drivers.
817 **/
e1000_led_on(struct e1000_hw * hw)818 s32 e1000_led_on(struct e1000_hw *hw)
819 {
820 if (hw->mac.ops.led_on)
821 return hw->mac.ops.led_on(hw);
822
823 return E1000_SUCCESS;
824 }
825
826 /**
827 * e1000_led_off - Turn off SW controllable LED
828 * @hw: pointer to the HW structure
829 *
830 * Turns the SW defined LED off. This is a function pointer entry point
831 * called by drivers.
832 **/
e1000_led_off(struct e1000_hw * hw)833 s32 e1000_led_off(struct e1000_hw *hw)
834 {
835 if (hw->mac.ops.led_off)
836 return hw->mac.ops.led_off(hw);
837
838 return E1000_SUCCESS;
839 }
840
841 /**
842 * e1000_reset_adaptive - Reset adaptive IFS
843 * @hw: pointer to the HW structure
844 *
845 * Resets the adaptive IFS. Currently no func pointer exists and all
846 * implementations are handled in the generic version of this function.
847 **/
e1000_reset_adaptive(struct e1000_hw * hw)848 void e1000_reset_adaptive(struct e1000_hw *hw)
849 {
850 e1000_reset_adaptive_generic(hw);
851 }
852
853 /**
854 * e1000_update_adaptive - Update adaptive IFS
855 * @hw: pointer to the HW structure
856 *
857 * Updates adapter IFS. Currently no func pointer exists and all
858 * implementations are handled in the generic version of this function.
859 **/
e1000_update_adaptive(struct e1000_hw * hw)860 void e1000_update_adaptive(struct e1000_hw *hw)
861 {
862 e1000_update_adaptive_generic(hw);
863 }
864
865 /**
866 * e1000_disable_pcie_master - Disable PCI-Express master access
867 * @hw: pointer to the HW structure
868 *
869 * Disables PCI-Express master access and verifies there are no pending
870 * requests. Currently no func pointer exists and all implementations are
871 * handled in the generic version of this function.
872 **/
e1000_disable_pcie_master(struct e1000_hw * hw)873 s32 e1000_disable_pcie_master(struct e1000_hw *hw)
874 {
875 return e1000_disable_pcie_master_generic(hw);
876 }
877
878 /**
879 * e1000_config_collision_dist - Configure collision distance
880 * @hw: pointer to the HW structure
881 *
882 * Configures the collision distance to the default value and is used
883 * during link setup.
884 **/
e1000_config_collision_dist(struct e1000_hw * hw)885 void e1000_config_collision_dist(struct e1000_hw *hw)
886 {
887 if (hw->mac.ops.config_collision_dist)
888 hw->mac.ops.config_collision_dist(hw);
889 }
890
891 /**
892 * e1000_rar_set - Sets a receive address register
893 * @hw: pointer to the HW structure
894 * @addr: address to set the RAR to
895 * @index: the RAR to set
896 *
897 * Sets a Receive Address Register (RAR) to the specified address.
898 **/
e1000_rar_set(struct e1000_hw * hw,u8 * addr,u32 index)899 int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
900 {
901 if (hw->mac.ops.rar_set)
902 return hw->mac.ops.rar_set(hw, addr, index);
903
904 return E1000_SUCCESS;
905 }
906
907 /**
908 * e1000_validate_mdi_setting - Ensures valid MDI/MDIX SW state
909 * @hw: pointer to the HW structure
910 *
911 * Ensures that the MDI/MDIX SW state is valid.
912 **/
e1000_validate_mdi_setting(struct e1000_hw * hw)913 s32 e1000_validate_mdi_setting(struct e1000_hw *hw)
914 {
915 if (hw->mac.ops.validate_mdi_setting)
916 return hw->mac.ops.validate_mdi_setting(hw);
917
918 return E1000_SUCCESS;
919 }
920
921 /**
922 * e1000_hash_mc_addr - Determines address location in multicast table
923 * @hw: pointer to the HW structure
924 * @mc_addr: Multicast address to hash.
925 *
926 * This hashes an address to determine its location in the multicast
927 * table. Currently no func pointer exists and all implementations
928 * are handled in the generic version of this function.
929 **/
e1000_hash_mc_addr(struct e1000_hw * hw,u8 * mc_addr)930 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
931 {
932 return e1000_hash_mc_addr_generic(hw, mc_addr);
933 }
934
935 /**
936 * e1000_enable_tx_pkt_filtering - Enable packet filtering on TX
937 * @hw: pointer to the HW structure
938 *
939 * Enables packet filtering on transmit packets if manageability is enabled
940 * and host interface is enabled.
941 * Currently no func pointer exists and all implementations are handled in the
942 * generic version of this function.
943 **/
e1000_enable_tx_pkt_filtering(struct e1000_hw * hw)944 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw)
945 {
946 return e1000_enable_tx_pkt_filtering_generic(hw);
947 }
948
949 /**
950 * e1000_mng_host_if_write - Writes to the manageability host interface
951 * @hw: pointer to the HW structure
952 * @buffer: pointer to the host interface buffer
953 * @length: size of the buffer
954 * @offset: location in the buffer to write to
955 * @sum: sum of the data (not checksum)
956 *
957 * This function writes the buffer content at the offset given on the host if.
958 * It also does alignment considerations to do the writes in most efficient
959 * way. Also fills up the sum of the buffer in *buffer parameter.
960 **/
e1000_mng_host_if_write(struct e1000_hw * hw,u8 * buffer,u16 length,u16 offset,u8 * sum)961 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
962 u16 offset, u8 *sum)
963 {
964 return e1000_mng_host_if_write_generic(hw, buffer, length, offset, sum);
965 }
966
967 /**
968 * e1000_mng_write_cmd_header - Writes manageability command header
969 * @hw: pointer to the HW structure
970 * @hdr: pointer to the host interface command header
971 *
972 * Writes the command header after does the checksum calculation.
973 **/
e1000_mng_write_cmd_header(struct e1000_hw * hw,struct e1000_host_mng_command_header * hdr)974 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
975 struct e1000_host_mng_command_header *hdr)
976 {
977 return e1000_mng_write_cmd_header_generic(hw, hdr);
978 }
979
980 /**
981 * e1000_mng_enable_host_if - Checks host interface is enabled
982 * @hw: pointer to the HW structure
983 *
984 * Returns E1000_success upon success, else E1000_ERR_HOST_INTERFACE_COMMAND
985 *
986 * This function checks whether the HOST IF is enabled for command operation
987 * and also checks whether the previous command is completed. It busy waits
988 * in case of previous command is not completed.
989 **/
e1000_mng_enable_host_if(struct e1000_hw * hw)990 s32 e1000_mng_enable_host_if(struct e1000_hw *hw)
991 {
992 return e1000_mng_enable_host_if_generic(hw);
993 }
994
995 /**
996 * e1000_set_obff_timer - Set Optimized Buffer Flush/Fill timer
997 * @hw: pointer to the HW structure
998 * @itr: u32 indicating itr value
999 *
1000 * Set the OBFF timer based on the given interrupt rate.
1001 **/
e1000_set_obff_timer(struct e1000_hw * hw,u32 itr)1002 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr)
1003 {
1004 if (hw->mac.ops.set_obff_timer)
1005 return hw->mac.ops.set_obff_timer(hw, itr);
1006
1007 return E1000_SUCCESS;
1008 }
1009
1010 /**
1011 * e1000_check_reset_block - Verifies PHY can be reset
1012 * @hw: pointer to the HW structure
1013 *
1014 * Checks if the PHY is in a state that can be reset or if manageability
1015 * has it tied up. This is a function pointer entry point called by drivers.
1016 **/
e1000_check_reset_block(struct e1000_hw * hw)1017 s32 e1000_check_reset_block(struct e1000_hw *hw)
1018 {
1019 if (hw->phy.ops.check_reset_block)
1020 return hw->phy.ops.check_reset_block(hw);
1021
1022 return E1000_SUCCESS;
1023 }
1024
1025 /**
1026 * e1000_read_phy_reg - Reads PHY register
1027 * @hw: pointer to the HW structure
1028 * @offset: the register to read
1029 * @data: the buffer to store the 16-bit read.
1030 *
1031 * Reads the PHY register and returns the value in data.
1032 * This is a function pointer entry point called by drivers.
1033 **/
e1000_read_phy_reg(struct e1000_hw * hw,u32 offset,u16 * data)1034 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1035 {
1036 if (hw->phy.ops.read_reg)
1037 return hw->phy.ops.read_reg(hw, offset, data);
1038
1039 return E1000_SUCCESS;
1040 }
1041
1042 /**
1043 * e1000_write_phy_reg - Writes PHY register
1044 * @hw: pointer to the HW structure
1045 * @offset: the register to write
1046 * @data: the value to write.
1047 *
1048 * Writes the PHY register at offset with the value in data.
1049 * This is a function pointer entry point called by drivers.
1050 **/
e1000_write_phy_reg(struct e1000_hw * hw,u32 offset,u16 data)1051 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
1052 {
1053 if (hw->phy.ops.write_reg)
1054 return hw->phy.ops.write_reg(hw, offset, data);
1055
1056 return E1000_SUCCESS;
1057 }
1058
1059 /**
1060 * e1000_release_phy - Generic release PHY
1061 * @hw: pointer to the HW structure
1062 *
1063 * Return if silicon family does not require a semaphore when accessing the
1064 * PHY.
1065 **/
e1000_release_phy(struct e1000_hw * hw)1066 void e1000_release_phy(struct e1000_hw *hw)
1067 {
1068 if (hw->phy.ops.release)
1069 hw->phy.ops.release(hw);
1070 }
1071
1072 /**
1073 * e1000_acquire_phy - Generic acquire PHY
1074 * @hw: pointer to the HW structure
1075 *
1076 * Return success if silicon family does not require a semaphore when
1077 * accessing the PHY.
1078 **/
e1000_acquire_phy(struct e1000_hw * hw)1079 s32 e1000_acquire_phy(struct e1000_hw *hw)
1080 {
1081 if (hw->phy.ops.acquire)
1082 return hw->phy.ops.acquire(hw);
1083
1084 return E1000_SUCCESS;
1085 }
1086
1087 /**
1088 * e1000_cfg_on_link_up - Configure PHY upon link up
1089 * @hw: pointer to the HW structure
1090 **/
e1000_cfg_on_link_up(struct e1000_hw * hw)1091 s32 e1000_cfg_on_link_up(struct e1000_hw *hw)
1092 {
1093 if (hw->phy.ops.cfg_on_link_up)
1094 return hw->phy.ops.cfg_on_link_up(hw);
1095
1096 return E1000_SUCCESS;
1097 }
1098
1099 /**
1100 * e1000_read_kmrn_reg - Reads register using Kumeran interface
1101 * @hw: pointer to the HW structure
1102 * @offset: the register to read
1103 * @data: the location to store the 16-bit value read.
1104 *
1105 * Reads a register out of the Kumeran interface. Currently no func pointer
1106 * exists and all implementations are handled in the generic version of
1107 * this function.
1108 **/
e1000_read_kmrn_reg(struct e1000_hw * hw,u32 offset,u16 * data)1109 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data)
1110 {
1111 return e1000_read_kmrn_reg_generic(hw, offset, data);
1112 }
1113
1114 /**
1115 * e1000_write_kmrn_reg - Writes register using Kumeran interface
1116 * @hw: pointer to the HW structure
1117 * @offset: the register to write
1118 * @data: the value to write.
1119 *
1120 * Writes a register to the Kumeran interface. Currently no func pointer
1121 * exists and all implementations are handled in the generic version of
1122 * this function.
1123 **/
e1000_write_kmrn_reg(struct e1000_hw * hw,u32 offset,u16 data)1124 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data)
1125 {
1126 return e1000_write_kmrn_reg_generic(hw, offset, data);
1127 }
1128
1129 /**
1130 * e1000_get_cable_length - Retrieves cable length estimation
1131 * @hw: pointer to the HW structure
1132 *
1133 * This function estimates the cable length and stores them in
1134 * hw->phy.min_length and hw->phy.max_length. This is a function pointer
1135 * entry point called by drivers.
1136 **/
e1000_get_cable_length(struct e1000_hw * hw)1137 s32 e1000_get_cable_length(struct e1000_hw *hw)
1138 {
1139 if (hw->phy.ops.get_cable_length)
1140 return hw->phy.ops.get_cable_length(hw);
1141
1142 return E1000_SUCCESS;
1143 }
1144
1145 /**
1146 * e1000_get_phy_info - Retrieves PHY information from registers
1147 * @hw: pointer to the HW structure
1148 *
1149 * This function gets some information from various PHY registers and
1150 * populates hw->phy values with it. This is a function pointer entry
1151 * point called by drivers.
1152 **/
e1000_get_phy_info(struct e1000_hw * hw)1153 s32 e1000_get_phy_info(struct e1000_hw *hw)
1154 {
1155 if (hw->phy.ops.get_info)
1156 return hw->phy.ops.get_info(hw);
1157
1158 return E1000_SUCCESS;
1159 }
1160
1161 /**
1162 * e1000_phy_hw_reset - Hard PHY reset
1163 * @hw: pointer to the HW structure
1164 *
1165 * Performs a hard PHY reset. This is a function pointer entry point called
1166 * by drivers.
1167 **/
e1000_phy_hw_reset(struct e1000_hw * hw)1168 s32 e1000_phy_hw_reset(struct e1000_hw *hw)
1169 {
1170 if (hw->phy.ops.reset)
1171 return hw->phy.ops.reset(hw);
1172
1173 return E1000_SUCCESS;
1174 }
1175
1176 /**
1177 * e1000_phy_commit - Soft PHY reset
1178 * @hw: pointer to the HW structure
1179 *
1180 * Performs a soft PHY reset on those that apply. This is a function pointer
1181 * entry point called by drivers.
1182 **/
e1000_phy_commit(struct e1000_hw * hw)1183 s32 e1000_phy_commit(struct e1000_hw *hw)
1184 {
1185 if (hw->phy.ops.commit)
1186 return hw->phy.ops.commit(hw);
1187
1188 return E1000_SUCCESS;
1189 }
1190
1191 /**
1192 * e1000_set_d0_lplu_state - Sets low power link up state for D0
1193 * @hw: pointer to the HW structure
1194 * @active: boolean used to enable/disable lplu
1195 *
1196 * Success returns 0, Failure returns 1
1197 *
1198 * The low power link up (lplu) state is set to the power management level D0
1199 * and SmartSpeed is disabled when active is true, else clear lplu for D0
1200 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1201 * is used during Dx states where the power conservation is most important.
1202 * During driver activity, SmartSpeed should be enabled so performance is
1203 * maintained. This is a function pointer entry point called by drivers.
1204 **/
e1000_set_d0_lplu_state(struct e1000_hw * hw,bool active)1205 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active)
1206 {
1207 if (hw->phy.ops.set_d0_lplu_state)
1208 return hw->phy.ops.set_d0_lplu_state(hw, active);
1209
1210 return E1000_SUCCESS;
1211 }
1212
1213 /**
1214 * e1000_set_d3_lplu_state - Sets low power link up state for D3
1215 * @hw: pointer to the HW structure
1216 * @active: boolean used to enable/disable lplu
1217 *
1218 * Success returns 0, Failure returns 1
1219 *
1220 * The low power link up (lplu) state is set to the power management level D3
1221 * and SmartSpeed is disabled when active is true, else clear lplu for D3
1222 * and enable Smartspeed. LPLU and Smartspeed are mutually exclusive. LPLU
1223 * is used during Dx states where the power conservation is most important.
1224 * During driver activity, SmartSpeed should be enabled so performance is
1225 * maintained. This is a function pointer entry point called by drivers.
1226 **/
e1000_set_d3_lplu_state(struct e1000_hw * hw,bool active)1227 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active)
1228 {
1229 if (hw->phy.ops.set_d3_lplu_state)
1230 return hw->phy.ops.set_d3_lplu_state(hw, active);
1231
1232 return E1000_SUCCESS;
1233 }
1234
1235 /**
1236 * e1000_read_mac_addr - Reads MAC address
1237 * @hw: pointer to the HW structure
1238 *
1239 * Reads the MAC address out of the adapter and stores it in the HW structure.
1240 * Currently no func pointer exists and all implementations are handled in the
1241 * generic version of this function.
1242 **/
e1000_read_mac_addr(struct e1000_hw * hw)1243 s32 e1000_read_mac_addr(struct e1000_hw *hw)
1244 {
1245 if (hw->mac.ops.read_mac_addr)
1246 return hw->mac.ops.read_mac_addr(hw);
1247
1248 return e1000_read_mac_addr_generic(hw);
1249 }
1250
1251 /**
1252 * e1000_read_pba_string - Read device part number string
1253 * @hw: pointer to the HW structure
1254 * @pba_num: pointer to device part number
1255 * @pba_num_size: size of part number buffer
1256 *
1257 * Reads the product board assembly (PBA) number from the EEPROM and stores
1258 * the value in pba_num.
1259 * Currently no func pointer exists and all implementations are handled in the
1260 * generic version of this function.
1261 **/
e1000_read_pba_string(struct e1000_hw * hw,u8 * pba_num,u32 pba_num_size)1262 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size)
1263 {
1264 return e1000_read_pba_string_generic(hw, pba_num, pba_num_size);
1265 }
1266
1267 /**
1268 * e1000_read_pba_length - Read device part number string length
1269 * @hw: pointer to the HW structure
1270 * @pba_num_size: size of part number buffer
1271 *
1272 * Reads the product board assembly (PBA) number length from the EEPROM and
1273 * stores the value in pba_num.
1274 * Currently no func pointer exists and all implementations are handled in the
1275 * generic version of this function.
1276 **/
e1000_read_pba_length(struct e1000_hw * hw,u32 * pba_num_size)1277 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size)
1278 {
1279 return e1000_read_pba_length_generic(hw, pba_num_size);
1280 }
1281
1282 /**
1283 * e1000_read_pba_num - Read device part number
1284 * @hw: pointer to the HW structure
1285 * @pba_num: pointer to device part number
1286 *
1287 * Reads the product board assembly (PBA) number from the EEPROM and stores
1288 * the value in pba_num.
1289 * Currently no func pointer exists and all implementations are handled in the
1290 * generic version of this function.
1291 **/
e1000_read_pba_num(struct e1000_hw * hw,u32 * pba_num)1292 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num)
1293 {
1294 return e1000_read_pba_num_generic(hw, pba_num);
1295 }
1296
1297 /**
1298 * e1000_validate_nvm_checksum - Verifies NVM (EEPROM) checksum
1299 * @hw: pointer to the HW structure
1300 *
1301 * Validates the NVM checksum is correct. This is a function pointer entry
1302 * point called by drivers.
1303 **/
e1000_validate_nvm_checksum(struct e1000_hw * hw)1304 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
1305 {
1306 if (hw->nvm.ops.validate)
1307 return hw->nvm.ops.validate(hw);
1308
1309 return -E1000_ERR_CONFIG;
1310 }
1311
1312 /**
1313 * e1000_update_nvm_checksum - Updates NVM (EEPROM) checksum
1314 * @hw: pointer to the HW structure
1315 *
1316 * Updates the NVM checksum. Currently no func pointer exists and all
1317 * implementations are handled in the generic version of this function.
1318 **/
e1000_update_nvm_checksum(struct e1000_hw * hw)1319 s32 e1000_update_nvm_checksum(struct e1000_hw *hw)
1320 {
1321 if (hw->nvm.ops.update)
1322 return hw->nvm.ops.update(hw);
1323
1324 return -E1000_ERR_CONFIG;
1325 }
1326
1327 /**
1328 * e1000_reload_nvm - Reloads EEPROM
1329 * @hw: pointer to the HW structure
1330 *
1331 * Reloads the EEPROM by setting the "Reinitialize from EEPROM" bit in the
1332 * extended control register.
1333 **/
e1000_reload_nvm(struct e1000_hw * hw)1334 void e1000_reload_nvm(struct e1000_hw *hw)
1335 {
1336 if (hw->nvm.ops.reload)
1337 hw->nvm.ops.reload(hw);
1338 }
1339
1340 /**
1341 * e1000_read_nvm - Reads NVM (EEPROM)
1342 * @hw: pointer to the HW structure
1343 * @offset: the word offset to read
1344 * @words: number of 16-bit words to read
1345 * @data: pointer to the properly sized buffer for the data.
1346 *
1347 * Reads 16-bit chunks of data from the NVM (EEPROM). This is a function
1348 * pointer entry point called by drivers.
1349 **/
e1000_read_nvm(struct e1000_hw * hw,u16 offset,u16 words,u16 * data)1350 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1351 {
1352 if (hw->nvm.ops.read)
1353 return hw->nvm.ops.read(hw, offset, words, data);
1354
1355 return -E1000_ERR_CONFIG;
1356 }
1357
1358 /**
1359 * e1000_write_nvm - Writes to NVM (EEPROM)
1360 * @hw: pointer to the HW structure
1361 * @offset: the word offset to read
1362 * @words: number of 16-bit words to write
1363 * @data: pointer to the properly sized buffer for the data.
1364 *
1365 * Writes 16-bit chunks of data to the NVM (EEPROM). This is a function
1366 * pointer entry point called by drivers.
1367 **/
e1000_write_nvm(struct e1000_hw * hw,u16 offset,u16 words,u16 * data)1368 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
1369 {
1370 if (hw->nvm.ops.write)
1371 return hw->nvm.ops.write(hw, offset, words, data);
1372
1373 return E1000_SUCCESS;
1374 }
1375
1376 /**
1377 * e1000_write_8bit_ctrl_reg - Writes 8bit Control register
1378 * @hw: pointer to the HW structure
1379 * @reg: 32bit register offset
1380 * @offset: the register to write
1381 * @data: the value to write.
1382 *
1383 * Writes the PHY register at offset with the value in data.
1384 * This is a function pointer entry point called by drivers.
1385 **/
e1000_write_8bit_ctrl_reg(struct e1000_hw * hw,u32 reg,u32 offset,u8 data)1386 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
1387 u8 data)
1388 {
1389 return e1000_write_8bit_ctrl_reg_generic(hw, reg, offset, data);
1390 }
1391
1392 /**
1393 * e1000_power_up_phy - Restores link in case of PHY power down
1394 * @hw: pointer to the HW structure
1395 *
1396 * The phy may be powered down to save power, to turn off link when the
1397 * driver is unloaded, or wake on lan is not enabled (among others).
1398 **/
e1000_power_up_phy(struct e1000_hw * hw)1399 void e1000_power_up_phy(struct e1000_hw *hw)
1400 {
1401 if (hw->phy.ops.power_up)
1402 hw->phy.ops.power_up(hw);
1403
1404 e1000_setup_link(hw);
1405 }
1406
1407 /**
1408 * e1000_power_down_phy - Power down PHY
1409 * @hw: pointer to the HW structure
1410 *
1411 * The phy may be powered down to save power, to turn off link when the
1412 * driver is unloaded, or wake on lan is not enabled (among others).
1413 **/
e1000_power_down_phy(struct e1000_hw * hw)1414 void e1000_power_down_phy(struct e1000_hw *hw)
1415 {
1416 if (hw->phy.ops.power_down)
1417 hw->phy.ops.power_down(hw);
1418 }
1419
1420 /**
1421 * e1000_power_up_fiber_serdes_link - Power up serdes link
1422 * @hw: pointer to the HW structure
1423 *
1424 * Power on the optics and PCS.
1425 **/
e1000_power_up_fiber_serdes_link(struct e1000_hw * hw)1426 void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw)
1427 {
1428 if (hw->mac.ops.power_up_serdes)
1429 hw->mac.ops.power_up_serdes(hw);
1430 }
1431
1432 /**
1433 * e1000_shutdown_fiber_serdes_link - Remove link during power down
1434 * @hw: pointer to the HW structure
1435 *
1436 * Shutdown the optics and PCS on driver unload.
1437 **/
e1000_shutdown_fiber_serdes_link(struct e1000_hw * hw)1438 void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw)
1439 {
1440 if (hw->mac.ops.shutdown_serdes)
1441 hw->mac.ops.shutdown_serdes(hw);
1442 }
1443
1444