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