diff options
author | Jeff Kirsher <jeffrey.t.kirsher@intel.com> | 2008-06-27 13:59:59 -0400 |
---|---|---|
committer | Jeff Garzik <jgarzik@redhat.com> | 2008-07-04 08:46:58 -0400 |
commit | 733596bea6ba7ea7949720b86794eda4e1b793d1 (patch) | |
tree | efec5e12ca2e1923ce04c468aee2fab1770179e6 /drivers/net/igb/e1000_82575.c | |
parent | 3b644cf6cef0324c595b86181220901b5bed0b99 (diff) |
igb: cleanup function header comments
Function header comments do not match function name.
Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Jeff Garzik <jgarzik@redhat.com>
Diffstat (limited to 'drivers/net/igb/e1000_82575.c')
-rw-r--r-- | drivers/net/igb/e1000_82575.c | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/drivers/net/igb/e1000_82575.c b/drivers/net/igb/e1000_82575.c index 39d44dc072e9..e6dd387fdb0e 100644 --- a/drivers/net/igb/e1000_82575.c +++ b/drivers/net/igb/e1000_82575.c | |||
@@ -226,7 +226,7 @@ static s32 igb_get_invariants_82575(struct e1000_hw *hw) | |||
226 | } | 226 | } |
227 | 227 | ||
228 | /** | 228 | /** |
229 | * e1000_acquire_phy_82575 - Acquire rights to access PHY | 229 | * igb_acquire_phy_82575 - Acquire rights to access PHY |
230 | * @hw: pointer to the HW structure | 230 | * @hw: pointer to the HW structure |
231 | * | 231 | * |
232 | * Acquire access rights to the correct PHY. This is a | 232 | * Acquire access rights to the correct PHY. This is a |
@@ -242,7 +242,7 @@ static s32 igb_acquire_phy_82575(struct e1000_hw *hw) | |||
242 | } | 242 | } |
243 | 243 | ||
244 | /** | 244 | /** |
245 | * e1000_release_phy_82575 - Release rights to access PHY | 245 | * igb_release_phy_82575 - Release rights to access PHY |
246 | * @hw: pointer to the HW structure | 246 | * @hw: pointer to the HW structure |
247 | * | 247 | * |
248 | * A wrapper to release access rights to the correct PHY. This is a | 248 | * A wrapper to release access rights to the correct PHY. This is a |
@@ -257,7 +257,7 @@ static void igb_release_phy_82575(struct e1000_hw *hw) | |||
257 | } | 257 | } |
258 | 258 | ||
259 | /** | 259 | /** |
260 | * e1000_read_phy_reg_sgmii_82575 - Read PHY register using sgmii | 260 | * igb_read_phy_reg_sgmii_82575 - Read PHY register using sgmii |
261 | * @hw: pointer to the HW structure | 261 | * @hw: pointer to the HW structure |
262 | * @offset: register offset to be read | 262 | * @offset: register offset to be read |
263 | * @data: pointer to the read data | 263 | * @data: pointer to the read data |
@@ -310,7 +310,7 @@ static s32 igb_read_phy_reg_sgmii_82575(struct e1000_hw *hw, u32 offset, | |||
310 | } | 310 | } |
311 | 311 | ||
312 | /** | 312 | /** |
313 | * e1000_write_phy_reg_sgmii_82575 - Write PHY register using sgmii | 313 | * igb_write_phy_reg_sgmii_82575 - Write PHY register using sgmii |
314 | * @hw: pointer to the HW structure | 314 | * @hw: pointer to the HW structure |
315 | * @offset: register offset to write to | 315 | * @offset: register offset to write to |
316 | * @data: data to write at register offset | 316 | * @data: data to write at register offset |
@@ -365,7 +365,7 @@ static s32 igb_write_phy_reg_sgmii_82575(struct e1000_hw *hw, u32 offset, | |||
365 | } | 365 | } |
366 | 366 | ||
367 | /** | 367 | /** |
368 | * e1000_get_phy_id_82575 - Retreive PHY addr and id | 368 | * igb_get_phy_id_82575 - Retrieve PHY addr and id |
369 | * @hw: pointer to the HW structure | 369 | * @hw: pointer to the HW structure |
370 | * | 370 | * |
371 | * Retreives the PHY address and ID for both PHY's which do and do not use | 371 | * Retreives the PHY address and ID for both PHY's which do and do not use |
@@ -426,7 +426,7 @@ out: | |||
426 | } | 426 | } |
427 | 427 | ||
428 | /** | 428 | /** |
429 | * e1000_phy_hw_reset_sgmii_82575 - Performs a PHY reset | 429 | * igb_phy_hw_reset_sgmii_82575 - Performs a PHY reset |
430 | * @hw: pointer to the HW structure | 430 | * @hw: pointer to the HW structure |
431 | * | 431 | * |
432 | * Resets the PHY using the serial gigabit media independent interface. | 432 | * Resets the PHY using the serial gigabit media independent interface. |
@@ -457,7 +457,7 @@ out: | |||
457 | } | 457 | } |
458 | 458 | ||
459 | /** | 459 | /** |
460 | * e1000_set_d0_lplu_state_82575 - Set Low Power Linkup D0 state | 460 | * igb_set_d0_lplu_state_82575 - Set Low Power Linkup D0 state |
461 | * @hw: pointer to the HW structure | 461 | * @hw: pointer to the HW structure |
462 | * @active: true to enable LPLU, false to disable | 462 | * @active: true to enable LPLU, false to disable |
463 | * | 463 | * |
@@ -543,7 +543,7 @@ out: | |||
543 | } | 543 | } |
544 | 544 | ||
545 | /** | 545 | /** |
546 | * e1000_acquire_nvm_82575 - Request for access to EEPROM | 546 | * igb_acquire_nvm_82575 - Request for access to EEPROM |
547 | * @hw: pointer to the HW structure | 547 | * @hw: pointer to the HW structure |
548 | * | 548 | * |
549 | * Acquire the necessary semaphores for exclussive access to the EEPROM. | 549 | * Acquire the necessary semaphores for exclussive access to the EEPROM. |
@@ -569,7 +569,7 @@ out: | |||
569 | } | 569 | } |
570 | 570 | ||
571 | /** | 571 | /** |
572 | * e1000_release_nvm_82575 - Release exclusive access to EEPROM | 572 | * igb_release_nvm_82575 - Release exclusive access to EEPROM |
573 | * @hw: pointer to the HW structure | 573 | * @hw: pointer to the HW structure |
574 | * | 574 | * |
575 | * Stop any current commands to the EEPROM and clear the EEPROM request bit, | 575 | * Stop any current commands to the EEPROM and clear the EEPROM request bit, |
@@ -582,7 +582,7 @@ static void igb_release_nvm_82575(struct e1000_hw *hw) | |||
582 | } | 582 | } |
583 | 583 | ||
584 | /** | 584 | /** |
585 | * e1000_acquire_swfw_sync_82575 - Acquire SW/FW semaphore | 585 | * igb_acquire_swfw_sync_82575 - Acquire SW/FW semaphore |
586 | * @hw: pointer to the HW structure | 586 | * @hw: pointer to the HW structure |
587 | * @mask: specifies which semaphore to acquire | 587 | * @mask: specifies which semaphore to acquire |
588 | * | 588 | * |
@@ -632,7 +632,7 @@ out: | |||
632 | } | 632 | } |
633 | 633 | ||
634 | /** | 634 | /** |
635 | * e1000_release_swfw_sync_82575 - Release SW/FW semaphore | 635 | * igb_release_swfw_sync_82575 - Release SW/FW semaphore |
636 | * @hw: pointer to the HW structure | 636 | * @hw: pointer to the HW structure |
637 | * @mask: specifies which semaphore to acquire | 637 | * @mask: specifies which semaphore to acquire |
638 | * | 638 | * |
@@ -654,7 +654,7 @@ static void igb_release_swfw_sync_82575(struct e1000_hw *hw, u16 mask) | |||
654 | } | 654 | } |
655 | 655 | ||
656 | /** | 656 | /** |
657 | * e1000_get_cfg_done_82575 - Read config done bit | 657 | * igb_get_cfg_done_82575 - Read config done bit |
658 | * @hw: pointer to the HW structure | 658 | * @hw: pointer to the HW structure |
659 | * | 659 | * |
660 | * Read the management control register for the config done bit for | 660 | * Read the management control register for the config done bit for |
@@ -690,7 +690,7 @@ static s32 igb_get_cfg_done_82575(struct e1000_hw *hw) | |||
690 | } | 690 | } |
691 | 691 | ||
692 | /** | 692 | /** |
693 | * e1000_check_for_link_82575 - Check for link | 693 | * igb_check_for_link_82575 - Check for link |
694 | * @hw: pointer to the HW structure | 694 | * @hw: pointer to the HW structure |
695 | * | 695 | * |
696 | * If sgmii is enabled, then use the pcs register to determine link, otherwise | 696 | * If sgmii is enabled, then use the pcs register to determine link, otherwise |
@@ -713,7 +713,7 @@ static s32 igb_check_for_link_82575(struct e1000_hw *hw) | |||
713 | } | 713 | } |
714 | 714 | ||
715 | /** | 715 | /** |
716 | * e1000_get_pcs_speed_and_duplex_82575 - Retrieve current speed/duplex | 716 | * igb_get_pcs_speed_and_duplex_82575 - Retrieve current speed/duplex |
717 | * @hw: pointer to the HW structure | 717 | * @hw: pointer to the HW structure |
718 | * @speed: stores the current speed | 718 | * @speed: stores the current speed |
719 | * @duplex: stores the current duplex | 719 | * @duplex: stores the current duplex |
@@ -768,7 +768,7 @@ static s32 igb_get_pcs_speed_and_duplex_82575(struct e1000_hw *hw, u16 *speed, | |||
768 | } | 768 | } |
769 | 769 | ||
770 | /** | 770 | /** |
771 | * e1000_rar_set_82575 - Set receive address register | 771 | * igb_rar_set_82575 - Set receive address register |
772 | * @hw: pointer to the HW structure | 772 | * @hw: pointer to the HW structure |
773 | * @addr: pointer to the receive address | 773 | * @addr: pointer to the receive address |
774 | * @index: receive address array register | 774 | * @index: receive address array register |
@@ -785,7 +785,7 @@ static void igb_rar_set_82575(struct e1000_hw *hw, u8 *addr, u32 index) | |||
785 | } | 785 | } |
786 | 786 | ||
787 | /** | 787 | /** |
788 | * e1000_reset_hw_82575 - Reset hardware | 788 | * igb_reset_hw_82575 - Reset hardware |
789 | * @hw: pointer to the HW structure | 789 | * @hw: pointer to the HW structure |
790 | * | 790 | * |
791 | * This resets the hardware into a known state. This is a | 791 | * This resets the hardware into a known state. This is a |
@@ -842,7 +842,7 @@ static s32 igb_reset_hw_82575(struct e1000_hw *hw) | |||
842 | } | 842 | } |
843 | 843 | ||
844 | /** | 844 | /** |
845 | * e1000_init_hw_82575 - Initialize hardware | 845 | * igb_init_hw_82575 - Initialize hardware |
846 | * @hw: pointer to the HW structure | 846 | * @hw: pointer to the HW structure |
847 | * | 847 | * |
848 | * This inits the hardware readying it for operation. | 848 | * This inits the hardware readying it for operation. |
@@ -886,7 +886,7 @@ static s32 igb_init_hw_82575(struct e1000_hw *hw) | |||
886 | } | 886 | } |
887 | 887 | ||
888 | /** | 888 | /** |
889 | * e1000_setup_copper_link_82575 - Configure copper link settings | 889 | * igb_setup_copper_link_82575 - Configure copper link settings |
890 | * @hw: pointer to the HW structure | 890 | * @hw: pointer to the HW structure |
891 | * | 891 | * |
892 | * Configures the link for auto-neg or forced speed and duplex. Then we check | 892 | * Configures the link for auto-neg or forced speed and duplex. Then we check |
@@ -974,7 +974,7 @@ out: | |||
974 | } | 974 | } |
975 | 975 | ||
976 | /** | 976 | /** |
977 | * e1000_setup_fiber_serdes_link_82575 - Setup link for fiber/serdes | 977 | * igb_setup_fiber_serdes_link_82575 - Setup link for fiber/serdes |
978 | * @hw: pointer to the HW structure | 978 | * @hw: pointer to the HW structure |
979 | * | 979 | * |
980 | * Configures speed and duplex for fiber and serdes links. | 980 | * Configures speed and duplex for fiber and serdes links. |
@@ -1038,7 +1038,7 @@ static s32 igb_setup_fiber_serdes_link_82575(struct e1000_hw *hw) | |||
1038 | } | 1038 | } |
1039 | 1039 | ||
1040 | /** | 1040 | /** |
1041 | * e1000_configure_pcs_link_82575 - Configure PCS link | 1041 | * igb_configure_pcs_link_82575 - Configure PCS link |
1042 | * @hw: pointer to the HW structure | 1042 | * @hw: pointer to the HW structure |
1043 | * | 1043 | * |
1044 | * Configure the physical coding sub-layer (PCS) link. The PCS link is | 1044 | * Configure the physical coding sub-layer (PCS) link. The PCS link is |
@@ -1103,7 +1103,7 @@ out: | |||
1103 | } | 1103 | } |
1104 | 1104 | ||
1105 | /** | 1105 | /** |
1106 | * e1000_sgmii_active_82575 - Return sgmii state | 1106 | * igb_sgmii_active_82575 - Return sgmii state |
1107 | * @hw: pointer to the HW structure | 1107 | * @hw: pointer to the HW structure |
1108 | * | 1108 | * |
1109 | * 82575 silicon has a serialized gigabit media independent interface (sgmii) | 1109 | * 82575 silicon has a serialized gigabit media independent interface (sgmii) |
@@ -1129,7 +1129,7 @@ out: | |||
1129 | } | 1129 | } |
1130 | 1130 | ||
1131 | /** | 1131 | /** |
1132 | * e1000_reset_init_script_82575 - Inits HW defaults after reset | 1132 | * igb_reset_init_script_82575 - Inits HW defaults after reset |
1133 | * @hw: pointer to the HW structure | 1133 | * @hw: pointer to the HW structure |
1134 | * | 1134 | * |
1135 | * Inits recommended HW defaults after a reset when there is no EEPROM | 1135 | * Inits recommended HW defaults after a reset when there is no EEPROM |
@@ -1165,7 +1165,7 @@ static s32 igb_reset_init_script_82575(struct e1000_hw *hw) | |||
1165 | } | 1165 | } |
1166 | 1166 | ||
1167 | /** | 1167 | /** |
1168 | * e1000_read_mac_addr_82575 - Read device MAC address | 1168 | * igb_read_mac_addr_82575 - Read device MAC address |
1169 | * @hw: pointer to the HW structure | 1169 | * @hw: pointer to the HW structure |
1170 | **/ | 1170 | **/ |
1171 | static s32 igb_read_mac_addr_82575(struct e1000_hw *hw) | 1171 | static s32 igb_read_mac_addr_82575(struct e1000_hw *hw) |
@@ -1179,7 +1179,7 @@ static s32 igb_read_mac_addr_82575(struct e1000_hw *hw) | |||
1179 | } | 1179 | } |
1180 | 1180 | ||
1181 | /** | 1181 | /** |
1182 | * e1000_clear_hw_cntrs_82575 - Clear device specific hardware counters | 1182 | * igb_clear_hw_cntrs_82575 - Clear device specific hardware counters |
1183 | * @hw: pointer to the HW structure | 1183 | * @hw: pointer to the HW structure |
1184 | * | 1184 | * |
1185 | * Clears the hardware counters by reading the counter registers. | 1185 | * Clears the hardware counters by reading the counter registers. |