lib/librte_pmd_e1000/e1000/e1000_api.c

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