e1000e: reformat comment blocks, cosmetic changes only

Adjusting the comment blocks here to be code-style compliant. no
code changes.

Changed some copyright dates to 2008.

Indentation fixes.

Signed-off-by: Bruce Allan <bruce.w.allan@intel.com>
Signed-off-by: Auke Kok <auke-jan.h.kok@intel.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>

1 files changed, 67 insertions, 38 deletions

diff --git a/drivers/net/e1000e/82571.c b/drivers/net/e1000e/82571.c
index 7fe20310eb5f..c58dc2e8de1e 100644
--- a/drivers/net/e1000e/82571.c
+++ b/drivers/net/e1000e/82571.c
@@ -1,7 +1,7 @@
 /*******************************************************************************
 
   Intel PRO/1000 Linux driver
-  Copyright(c) 1999 - 2007 Intel Corporation.
+  Copyright(c) 1999 - 2008 Intel Corporation.
 
   This program is free software; you can redistribute it and/or modify it
   under the terms and conditions of the GNU General Public License,
@@ -29,6 +29,9 @@
 /*
  * 82571EB Gigabit Ethernet Controller
  * 82571EB Gigabit Ethernet Controller (Fiber)
+ * 82571EB Dual Port Gigabit Mezzanine Adapter
+ * 82571EB Quad Port Gigabit Mezzanine Adapter
+ * 82571PT Gigabit PT Quad Port Server ExpressModule
  * 82572EI Gigabit Ethernet Controller (Copper)
  * 82572EI Gigabit Ethernet Controller (Fiber)
  * 82572EI Gigabit Ethernet Controller
@@ -150,7 +153,8 @@ static s32 e1000_init_nvm_params_82571(struct e1000_hw *hw)
                 if (((eecd >> 15) & 0x3) == 0x3) {
                         nvm->type = e1000_nvm_flash_hw;
                         nvm->word_size = 2048;
-                        /* Autonomous Flash update bit must be cleared due
+                        /*
+                         * Autonomous Flash update bit must be cleared due
                          * to Flash update issue.
                          */
                         eecd &= ~E1000_EECD_AUPDEN;
@@ -159,10 +163,11 @@ static s32 e1000_init_nvm_params_82571(struct e1000_hw *hw)
                 }
                 /* Fall Through */
         default:
-                nvm->type       = e1000_nvm_eeprom_spi;
+                nvm->type = e1000_nvm_eeprom_spi;
                 size = (u16)((eecd & E1000_EECD_SIZE_EX_MASK) >>
                                   E1000_EECD_SIZE_EX_SHIFT);
-                /* Added to a constant, "size" becomes the left-shift value
+                /*
+                 * Added to a constant, "size" becomes the left-shift value
                  * for setting word_size.
                  */
                 size += NVM_WORD_SIZE_BASE_SHIFT;
@@ -208,8 +213,7 @@ static s32 e1000_init_mac_params_82571(struct e1000_adapter *adapter)
         /* Set rar entry count */
         mac->rar_entry_count = E1000_RAR_ENTRIES;
         /* Set if manageability features are enabled. */
-        mac->arc_subsystem_valid =
-                (er32(FWSM) & E1000_FWSM_MODE_MASK) ? 1 : 0;
+        mac->arc_subsystem_valid = (er32(FWSM) & E1000_FWSM_MODE_MASK) ? 1 : 0;
 
         /* check for link */
         switch (hw->media_type) {
@@ -219,14 +223,18 @@ static s32 e1000_init_mac_params_82571(struct e1000_adapter *adapter)
                 func->get_link_up_info = e1000e_get_speed_and_duplex_copper;
                 break;
         case e1000_media_type_fiber:
-                func->setup_physical_interface = e1000_setup_fiber_serdes_link_82571;
+                func->setup_physical_interface =
+                        e1000_setup_fiber_serdes_link_82571;
                 func->check_for_link = e1000e_check_for_fiber_link;
-                func->get_link_up_info = e1000e_get_speed_and_duplex_fiber_serdes;
+                func->get_link_up_info =
+                        e1000e_get_speed_and_duplex_fiber_serdes;
                 break;
         case e1000_media_type_internal_serdes:
-                func->setup_physical_interface = e1000_setup_fiber_serdes_link_82571;
+                func->setup_physical_interface =
+                        e1000_setup_fiber_serdes_link_82571;
                 func->check_for_link = e1000e_check_for_serdes_link;
-                func->get_link_up_info = e1000e_get_speed_and_duplex_fiber_serdes;
+                func->get_link_up_info =
+                        e1000e_get_speed_and_duplex_fiber_serdes;
                 break;
         default:
                 return -E1000_ERR_CONFIG;
@@ -322,10 +330,12 @@ static s32 e1000_get_phy_id_82571(struct e1000_hw *hw)
         switch (hw->mac.type) {
         case e1000_82571:
         case e1000_82572:
-                /* The 82571 firmware may still be configuring the PHY.
+                /*
+                 * The 82571 firmware may still be configuring the PHY.
                  * In this case, we cannot access the PHY until the
                  * configuration is done.  So we explicitly set the
-                 * PHY ID. */
+                 * PHY ID.
+                 */
                 phy->id = IGP01E1000_I_PHY_ID;
                 break;
         case e1000_82573:
@@ -479,8 +489,10 @@ static s32 e1000_update_nvm_checksum_82571(struct e1000_hw *hw)
         if (ret_val)
                 return ret_val;
 
-        /* If our nvm is an EEPROM, then we're done
-         * otherwise, commit the checksum to the flash NVM. */
+        /*
+         * If our nvm is an EEPROM, then we're done
+         * otherwise, commit the checksum to the flash NVM.
+         */
         if (hw->nvm.type != e1000_nvm_flash_hw)
                 return ret_val;
 
@@ -496,7 +508,8 @@ static s32 e1000_update_nvm_checksum_82571(struct e1000_hw *hw)
 
         /* Reset the firmware if using STM opcode. */
         if ((er32(FLOP) & 0xFF00) == E1000_STM_OPCODE) {
-                /* The enabling of and the actual reset must be done
+                /*
+                 * The enabling of and the actual reset must be done
                  * in two write cycles.
                  */
                 ew32(HICR, E1000_HICR_FW_RESET_ENABLE);
@@ -557,8 +570,10 @@ static s32 e1000_write_nvm_eewr_82571(struct e1000_hw *hw, u16 offset,
         u32 eewr = 0;
         s32 ret_val = 0;
 
-        /* A check for invalid values:  offset too large, too many words,
-         * and not enough words. */
+        /*
+         * A check for invalid values:  offset too large, too many words,
+         * and not enough words.
+         */
         if ((offset >= nvm->word_size) || (words > (nvm->word_size - offset)) ||
             (words == 0)) {
                 hw_dbg(hw, "nvm parameter(s) out of bounds\n");
@@ -645,30 +660,32 @@ static s32 e1000_set_d0_lplu_state_82571(struct e1000_hw *hw, bool active)
         } else {
                 data &= ~IGP02E1000_PM_D0_LPLU;
                 ret_val = e1e_wphy(hw, IGP02E1000_PHY_POWER_MGMT, data);
-                /* LPLU and SmartSpeed are mutually exclusive.  LPLU is used
+                /*
+                 * LPLU and SmartSpeed are mutually exclusive.  LPLU is used
                  * during Dx states where the power conservation is most
                  * important.  During driver activity we should enable
-                 * SmartSpeed, so performance is maintained. */
+                 * SmartSpeed, so performance is maintained.
+                 */
                 if (phy->smart_speed == e1000_smart_speed_on) {
                         ret_val = e1e_rphy(hw, IGP01E1000_PHY_PORT_CONFIG,
-                                                     &data);
+                                           &data);
                         if (ret_val)
                                 return ret_val;
 
                         data |= IGP01E1000_PSCFR_SMART_SPEED;
                         ret_val = e1e_wphy(hw, IGP01E1000_PHY_PORT_CONFIG,
-                                                     data);
+                                           data);
                         if (ret_val)
                                 return ret_val;
                 } else if (phy->smart_speed == e1000_smart_speed_off) {
                         ret_val = e1e_rphy(hw, IGP01E1000_PHY_PORT_CONFIG,
-                                                     &data);
+                                           &data);
                         if (ret_val)
                                 return ret_val;
 
                         data &= ~IGP01E1000_PSCFR_SMART_SPEED;
                         ret_val = e1e_wphy(hw, IGP01E1000_PHY_PORT_CONFIG,
-                                                     data);
+                                           data);
                         if (ret_val)
                                 return ret_val;
                 }
@@ -693,7 +710,8 @@ static s32 e1000_reset_hw_82571(struct e1000_hw *hw)
         s32 ret_val;
         u16 i = 0;
 
-        /* Prevent the PCI-E bus from sticking if there is no TLP connection
+        /*
+         * Prevent the PCI-E bus from sticking if there is no TLP connection
          * on the last TLP read/write transaction when MAC is reset.
          */
         ret_val = e1000e_disable_pcie_master(hw);
@@ -709,8 +727,10 @@ static s32 e1000_reset_hw_82571(struct e1000_hw *hw)
 
         msleep(10);
 
-        /* Must acquire the MDIO ownership before MAC reset.
-         * Ownership defaults to firmware after a reset. */
+        /*
+         * Must acquire the MDIO ownership before MAC reset.
+         * Ownership defaults to firmware after a reset.
+         */
         if (hw->mac.type == e1000_82573) {
                 extcnf_ctrl = er32(EXTCNF_CTRL);
                 extcnf_ctrl |= E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP;
@@ -747,7 +767,8 @@ static s32 e1000_reset_hw_82571(struct e1000_hw *hw)
                 /* We don't want to continue accessing MAC registers. */
                 return ret_val;
 
-        /* Phy configuration from NVM just starts after EECD_AUTO_RD is set.
+        /*
+         * Phy configuration from NVM just starts after EECD_AUTO_RD is set.
          * Need to wait for Phy configuration completion before accessing
          * NVM and Phy.
          */
@@ -793,7 +814,8 @@ static s32 e1000_init_hw_82571(struct e1000_hw *hw)
         e1000e_clear_vfta(hw);
 
         /* Setup the receive address. */
-        /* If, however, a locally administered address was assigned to the
+        /*
+         * If, however, a locally administered address was assigned to the
          * 82571, we must reserve a RAR for it to work around an issue where
          * resetting one port will reload the MAC on the other port.
          */
@@ -830,7 +852,8 @@ static s32 e1000_init_hw_82571(struct e1000_hw *hw)
                 ew32(GCR, reg_data);
         }
 
-        /* Clear all of the statistics registers (clear on read).  It is
+        /*
+         * Clear all of the statistics registers (clear on read).  It is
          * important that we do this after we have tried to establish link
          * because the symbol error count will increment wildly if there
          * is no link.
@@ -922,7 +945,8 @@ void e1000e_clear_vfta(struct e1000_hw *hw)
 
         if (hw->mac.type == e1000_82573) {
                 if (hw->mng_cookie.vlan_id != 0) {
-                        /* The VFTA is a 4096b bit-field, each identifying
+                        /*
+                         * The VFTA is a 4096b bit-field, each identifying
                          * a single VLAN ID.  The following operations
                          * determine which 32b entry (i.e. offset) into the
                          * array we want to set the VLAN ID (i.e. bit) of
@@ -936,7 +960,8 @@ void e1000e_clear_vfta(struct e1000_hw *hw)
                 }
         }
         for (offset = 0; offset < E1000_VLAN_FILTER_TBL_SIZE; offset++) {
-                /* If the offset we want to clear is the same offset of the
+                /*
+                 * If the offset we want to clear is the same offset of the
                  * manageability VLAN ID, then clear all bits except that of
                  * the manageability unit.
                  */
@@ -984,7 +1009,8 @@ static void e1000_mc_addr_list_update_82571(struct e1000_hw *hw,
  **/
 static s32 e1000_setup_link_82571(struct e1000_hw *hw)
 {
-        /* 82573 does not have a word in the NVM to determine
+        /*
+         * 82573 does not have a word in the NVM to determine
          * the default flow control setting, so we explicitly
          * set it to full.
          */
@@ -1050,14 +1076,14 @@ static s32 e1000_setup_fiber_serdes_link_82571(struct e1000_hw *hw)
         switch (hw->mac.type) {
         case e1000_82571:
         case e1000_82572:
-                /* If SerDes loopback mode is entered, there is no form
+                /*
+                 * If SerDes loopback mode is entered, there is no form
                  * of reset to take the adapter out of that mode.  So we
                  * have to explicitly take the adapter out of loopback
                  * mode.  This prevents drivers from twiddling their thumbs
                  * if another tool failed to take it out of loopback mode.
                  */
-                ew32(SCTL,
-                                E1000_SCTL_DISABLE_SERDES_LOOPBACK);
+                ew32(SCTL, E1000_SCTL_DISABLE_SERDES_LOOPBACK);
                 break;
         default:
                 break;
@@ -1124,7 +1150,8 @@ void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state)
 
         /* If workaround is activated... */
         if (state)
-                /* Hold a copy of the LAA in RAR[14] This is done so that
+                /*
+                 * Hold a copy of the LAA in RAR[14] This is done so that
                  * between the time RAR[0] gets clobbered and the time it
                  * gets fixed, the actual LAA is in one of the RARs and no
                  * incoming packets directed to this port are dropped.
@@ -1152,7 +1179,8 @@ static s32 e1000_fix_nvm_checksum_82571(struct e1000_hw *hw)
         if (nvm->type != e1000_nvm_flash_hw)
                 return 0;
 
-        /* Check bit 4 of word 10h.  If it is 0, firmware is done updating
+        /*
+         * Check bit 4 of word 10h.  If it is 0, firmware is done updating
          * 10h-12h.  Checksum may need to be fixed.
          */
         ret_val = e1000_read_nvm(hw, 0x10, 1, &data);
@@ -1160,7 +1188,8 @@ static s32 e1000_fix_nvm_checksum_82571(struct e1000_hw *hw)
                 return ret_val;
 
         if (!(data & 0x10)) {
-                /* Read 0x23 and check bit 15.  This bit is a 1
+                /*
+                 * Read 0x23 and check bit 15.  This bit is a 1
                  * when the checksum has already been fixed.  If
                  * the checksum is still wrong and this bit is a
                  * 1, we need to return bad checksum.  Otherwise,