aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/igb/e1000_mac.c
diff options
context:
space:
mode:
authorJeff Kirsher <jeffrey.t.kirsher@intel.com>2008-06-27 13:59:59 -0400
committerJeff Garzik <jgarzik@redhat.com>2008-07-04 08:46:58 -0400
commit733596bea6ba7ea7949720b86794eda4e1b793d1 (patch)
treeefec5e12ca2e1923ce04c468aee2fab1770179e6 /drivers/net/igb/e1000_mac.c
parent3b644cf6cef0324c595b86181220901b5bed0b99 (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_mac.c')
-rw-r--r--drivers/net/igb/e1000_mac.c66
1 files changed, 33 insertions, 33 deletions
diff --git a/drivers/net/igb/e1000_mac.c b/drivers/net/igb/e1000_mac.c
index 3e84a3f0c1d8..0dadcfdfa176 100644
--- a/drivers/net/igb/e1000_mac.c
+++ b/drivers/net/igb/e1000_mac.c
@@ -39,7 +39,7 @@ static s32 igb_set_fc_watermarks(struct e1000_hw *hw);
39static u32 igb_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 39static u32 igb_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
40 40
41/** 41/**
42 * e1000_remove_device - Free device specific structure 42 * igb_remove_device - Free device specific structure
43 * @hw: pointer to the HW structure 43 * @hw: pointer to the HW structure
44 * 44 *
45 * If a device specific structure was allocated, this function will 45 * If a device specific structure was allocated, this function will
@@ -73,7 +73,7 @@ static s32 igb_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value)
73} 73}
74 74
75/** 75/**
76 * e1000_get_bus_info_pcie - Get PCIe bus information 76 * igb_get_bus_info_pcie - Get PCIe bus information
77 * @hw: pointer to the HW structure 77 * @hw: pointer to the HW structure
78 * 78 *
79 * Determines and stores the system bus information for a particular 79 * Determines and stores the system bus information for a particular
@@ -113,7 +113,7 @@ s32 igb_get_bus_info_pcie(struct e1000_hw *hw)
113} 113}
114 114
115/** 115/**
116 * e1000_clear_vfta - Clear VLAN filter table 116 * igb_clear_vfta - Clear VLAN filter table
117 * @hw: pointer to the HW structure 117 * @hw: pointer to the HW structure
118 * 118 *
119 * Clears the register array which contains the VLAN filter table by 119 * Clears the register array which contains the VLAN filter table by
@@ -130,7 +130,7 @@ void igb_clear_vfta(struct e1000_hw *hw)
130} 130}
131 131
132/** 132/**
133 * e1000_write_vfta - Write value to VLAN filter table 133 * igb_write_vfta - Write value to VLAN filter table
134 * @hw: pointer to the HW structure 134 * @hw: pointer to the HW structure
135 * @offset: register offset in VLAN filter table 135 * @offset: register offset in VLAN filter table
136 * @value: register value written to VLAN filter table 136 * @value: register value written to VLAN filter table
@@ -145,7 +145,7 @@ void igb_write_vfta(struct e1000_hw *hw, u32 offset, u32 value)
145} 145}
146 146
147/** 147/**
148 * e1000_init_rx_addrs - Initialize receive address's 148 * igb_init_rx_addrs - Initialize receive address's
149 * @hw: pointer to the HW structure 149 * @hw: pointer to the HW structure
150 * @rar_count: receive address registers 150 * @rar_count: receive address registers
151 * 151 *
@@ -173,7 +173,7 @@ void igb_init_rx_addrs(struct e1000_hw *hw, u16 rar_count)
173} 173}
174 174
175/** 175/**
176 * e1000_check_alt_mac_addr - Check for alternate MAC addr 176 * igb_check_alt_mac_addr - Check for alternate MAC addr
177 * @hw: pointer to the HW structure 177 * @hw: pointer to the HW structure
178 * 178 *
179 * Checks the nvm for an alternate MAC address. An alternate MAC address 179 * Checks the nvm for an alternate MAC address. An alternate MAC address
@@ -233,7 +233,7 @@ out:
233} 233}
234 234
235/** 235/**
236 * e1000_rar_set - Set receive address register 236 * igb_rar_set - Set receive address register
237 * @hw: pointer to the HW structure 237 * @hw: pointer to the HW structure
238 * @addr: pointer to the receive address 238 * @addr: pointer to the receive address
239 * @index: receive address array register 239 * @index: receive address array register
@@ -263,7 +263,7 @@ void igb_rar_set(struct e1000_hw *hw, u8 *addr, u32 index)
263} 263}
264 264
265/** 265/**
266 * e1000_mta_set - Set multicast filter table address 266 * igb_mta_set - Set multicast filter table address
267 * @hw: pointer to the HW structure 267 * @hw: pointer to the HW structure
268 * @hash_value: determines the MTA register and bit to set 268 * @hash_value: determines the MTA register and bit to set
269 * 269 *
@@ -298,7 +298,7 @@ static void igb_mta_set(struct e1000_hw *hw, u32 hash_value)
298} 298}
299 299
300/** 300/**
301 * e1000_update_mc_addr_list - Update Multicast addresses 301 * igb_update_mc_addr_list - Update Multicast addresses
302 * @hw: pointer to the HW structure 302 * @hw: pointer to the HW structure
303 * @mc_addr_list: array of multicast addresses to program 303 * @mc_addr_list: array of multicast addresses to program
304 * @mc_addr_count: number of multicast addresses to program 304 * @mc_addr_count: number of multicast addresses to program
@@ -352,7 +352,7 @@ void igb_update_mc_addr_list(struct e1000_hw *hw,
352} 352}
353 353
354/** 354/**
355 * e1000_hash_mc_addr - Generate a multicast hash value 355 * igb_hash_mc_addr - Generate a multicast hash value
356 * @hw: pointer to the HW structure 356 * @hw: pointer to the HW structure
357 * @mc_addr: pointer to a multicast address 357 * @mc_addr: pointer to a multicast address
358 * 358 *
@@ -423,7 +423,7 @@ static u32 igb_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr)
423} 423}
424 424
425/** 425/**
426 * e1000_clear_hw_cntrs_base - Clear base hardware counters 426 * igb_clear_hw_cntrs_base - Clear base hardware counters
427 * @hw: pointer to the HW structure 427 * @hw: pointer to the HW structure
428 * 428 *
429 * Clears the base hardware counters by reading the counter registers. 429 * Clears the base hardware counters by reading the counter registers.
@@ -472,7 +472,7 @@ void igb_clear_hw_cntrs_base(struct e1000_hw *hw)
472} 472}
473 473
474/** 474/**
475 * e1000_check_for_copper_link - Check for link (Copper) 475 * igb_check_for_copper_link - Check for link (Copper)
476 * @hw: pointer to the HW structure 476 * @hw: pointer to the HW structure
477 * 477 *
478 * Checks to see of the link status of the hardware has changed. If a 478 * Checks to see of the link status of the hardware has changed. If a
@@ -547,7 +547,7 @@ out:
547} 547}
548 548
549/** 549/**
550 * e1000_setup_link - Setup flow control and link settings 550 * igb_setup_link - Setup flow control and link settings
551 * @hw: pointer to the HW structure 551 * @hw: pointer to the HW structure
552 * 552 *
553 * Determines which flow control settings to use, then configures flow 553 * Determines which flow control settings to use, then configures flow
@@ -606,7 +606,7 @@ out:
606} 606}
607 607
608/** 608/**
609 * e1000_config_collision_dist - Configure collision distance 609 * igb_config_collision_dist - Configure collision distance
610 * @hw: pointer to the HW structure 610 * @hw: pointer to the HW structure
611 * 611 *
612 * Configures the collision distance to the default value and is used 612 * Configures the collision distance to the default value and is used
@@ -627,7 +627,7 @@ void igb_config_collision_dist(struct e1000_hw *hw)
627} 627}
628 628
629/** 629/**
630 * e1000_set_fc_watermarks - Set flow control high/low watermarks 630 * igb_set_fc_watermarks - Set flow control high/low watermarks
631 * @hw: pointer to the HW structure 631 * @hw: pointer to the HW structure
632 * 632 *
633 * Sets the flow control high/low threshold (watermark) registers. If 633 * Sets the flow control high/low threshold (watermark) registers. If
@@ -665,7 +665,7 @@ static s32 igb_set_fc_watermarks(struct e1000_hw *hw)
665} 665}
666 666
667/** 667/**
668 * e1000_set_default_fc - Set flow control default values 668 * igb_set_default_fc - Set flow control default values
669 * @hw: pointer to the HW structure 669 * @hw: pointer to the HW structure
670 * 670 *
671 * Read the EEPROM for the default values for flow control and store the 671 * Read the EEPROM for the default values for flow control and store the
@@ -706,7 +706,7 @@ out:
706} 706}
707 707
708/** 708/**
709 * e1000_force_mac_fc - Force the MAC's flow control settings 709 * igb_force_mac_fc - Force the MAC's flow control settings
710 * @hw: pointer to the HW structure 710 * @hw: pointer to the HW structure
711 * 711 *
712 * Force the MAC's flow control settings. Sets the TFCE and RFCE bits in the 712 * Force the MAC's flow control settings. Sets the TFCE and RFCE bits in the
@@ -770,7 +770,7 @@ out:
770} 770}
771 771
772/** 772/**
773 * e1000_config_fc_after_link_up - Configures flow control after link 773 * igb_config_fc_after_link_up - Configures flow control after link
774 * @hw: pointer to the HW structure 774 * @hw: pointer to the HW structure
775 * 775 *
776 * Checks the status of auto-negotiation after link up to ensure that the 776 * Checks the status of auto-negotiation after link up to ensure that the
@@ -991,7 +991,7 @@ out:
991} 991}
992 992
993/** 993/**
994 * e1000_get_speed_and_duplex_copper - Retreive current speed/duplex 994 * igb_get_speed_and_duplex_copper - Retreive current speed/duplex
995 * @hw: pointer to the HW structure 995 * @hw: pointer to the HW structure
996 * @speed: stores the current speed 996 * @speed: stores the current speed
997 * @duplex: stores the current duplex 997 * @duplex: stores the current duplex
@@ -1028,7 +1028,7 @@ s32 igb_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed,
1028} 1028}
1029 1029
1030/** 1030/**
1031 * e1000_get_hw_semaphore - Acquire hardware semaphore 1031 * igb_get_hw_semaphore - Acquire hardware semaphore
1032 * @hw: pointer to the HW structure 1032 * @hw: pointer to the HW structure
1033 * 1033 *
1034 * Acquire the HW semaphore to access the PHY or NVM 1034 * Acquire the HW semaphore to access the PHY or NVM
@@ -1081,7 +1081,7 @@ out:
1081} 1081}
1082 1082
1083/** 1083/**
1084 * e1000_put_hw_semaphore - Release hardware semaphore 1084 * igb_put_hw_semaphore - Release hardware semaphore
1085 * @hw: pointer to the HW structure 1085 * @hw: pointer to the HW structure
1086 * 1086 *
1087 * Release hardware semaphore used to access the PHY or NVM 1087 * Release hardware semaphore used to access the PHY or NVM
@@ -1098,7 +1098,7 @@ void igb_put_hw_semaphore(struct e1000_hw *hw)
1098} 1098}
1099 1099
1100/** 1100/**
1101 * e1000_get_auto_rd_done - Check for auto read completion 1101 * igb_get_auto_rd_done - Check for auto read completion
1102 * @hw: pointer to the HW structure 1102 * @hw: pointer to the HW structure
1103 * 1103 *
1104 * Check EEPROM for Auto Read done bit. 1104 * Check EEPROM for Auto Read done bit.
@@ -1127,7 +1127,7 @@ out:
1127} 1127}
1128 1128
1129/** 1129/**
1130 * e1000_valid_led_default - Verify a valid default LED config 1130 * igb_valid_led_default - Verify a valid default LED config
1131 * @hw: pointer to the HW structure 1131 * @hw: pointer to the HW structure
1132 * @data: pointer to the NVM (EEPROM) 1132 * @data: pointer to the NVM (EEPROM)
1133 * 1133 *
@@ -1152,7 +1152,7 @@ out:
1152} 1152}
1153 1153
1154/** 1154/**
1155 * e1000_id_led_init - 1155 * igb_id_led_init -
1156 * @hw: pointer to the HW structure 1156 * @hw: pointer to the HW structure
1157 * 1157 *
1158 **/ 1158 **/
@@ -1217,7 +1217,7 @@ out:
1217} 1217}
1218 1218
1219/** 1219/**
1220 * e1000_cleanup_led - Set LED config to default operation 1220 * igb_cleanup_led - Set LED config to default operation
1221 * @hw: pointer to the HW structure 1221 * @hw: pointer to the HW structure
1222 * 1222 *
1223 * Remove the current LED configuration and set the LED configuration 1223 * Remove the current LED configuration and set the LED configuration
@@ -1230,7 +1230,7 @@ s32 igb_cleanup_led(struct e1000_hw *hw)
1230} 1230}
1231 1231
1232/** 1232/**
1233 * e1000_blink_led - Blink LED 1233 * igb_blink_led - Blink LED
1234 * @hw: pointer to the HW structure 1234 * @hw: pointer to the HW structure
1235 * 1235 *
1236 * Blink the led's which are set to be on. 1236 * Blink the led's which are set to be on.
@@ -1263,7 +1263,7 @@ s32 igb_blink_led(struct e1000_hw *hw)
1263} 1263}
1264 1264
1265/** 1265/**
1266 * e1000_led_off - Turn LED off 1266 * igb_led_off - Turn LED off
1267 * @hw: pointer to the HW structure 1267 * @hw: pointer to the HW structure
1268 * 1268 *
1269 * Turn LED off. 1269 * Turn LED off.
@@ -1290,7 +1290,7 @@ s32 igb_led_off(struct e1000_hw *hw)
1290} 1290}
1291 1291
1292/** 1292/**
1293 * e1000_disable_pcie_master - Disables PCI-express master access 1293 * igb_disable_pcie_master - Disables PCI-express master access
1294 * @hw: pointer to the HW structure 1294 * @hw: pointer to the HW structure
1295 * 1295 *
1296 * Returns 0 (0) if successful, else returns -10 1296 * Returns 0 (0) if successful, else returns -10
@@ -1332,7 +1332,7 @@ out:
1332} 1332}
1333 1333
1334/** 1334/**
1335 * e1000_reset_adaptive - Reset Adaptive Interframe Spacing 1335 * igb_reset_adaptive - Reset Adaptive Interframe Spacing
1336 * @hw: pointer to the HW structure 1336 * @hw: pointer to the HW structure
1337 * 1337 *
1338 * Reset the Adaptive Interframe Spacing throttle to default values. 1338 * Reset the Adaptive Interframe Spacing throttle to default values.
@@ -1361,7 +1361,7 @@ out:
1361} 1361}
1362 1362
1363/** 1363/**
1364 * e1000_update_adaptive - Update Adaptive Interframe Spacing 1364 * igb_update_adaptive - Update Adaptive Interframe Spacing
1365 * @hw: pointer to the HW structure 1365 * @hw: pointer to the HW structure
1366 * 1366 *
1367 * Update the Adaptive Interframe Spacing Throttle value based on the 1367 * Update the Adaptive Interframe Spacing Throttle value based on the
@@ -1402,7 +1402,7 @@ out:
1402} 1402}
1403 1403
1404/** 1404/**
1405 * e1000_validate_mdi_setting - Verify MDI/MDIx settings 1405 * igb_validate_mdi_setting - Verify MDI/MDIx settings
1406 * @hw: pointer to the HW structure 1406 * @hw: pointer to the HW structure
1407 * 1407 *
1408 * Verify that when not using auto-negotitation that MDI/MDIx is correctly 1408 * Verify that when not using auto-negotitation that MDI/MDIx is correctly
@@ -1424,7 +1424,7 @@ out:
1424} 1424}
1425 1425
1426/** 1426/**
1427 * e1000_write_8bit_ctrl_reg - Write a 8bit CTRL register 1427 * igb_write_8bit_ctrl_reg - Write a 8bit CTRL register
1428 * @hw: pointer to the HW structure 1428 * @hw: pointer to the HW structure
1429 * @reg: 32bit register offset such as E1000_SCTL 1429 * @reg: 32bit register offset such as E1000_SCTL
1430 * @offset: register offset to write to 1430 * @offset: register offset to write to
@@ -1462,7 +1462,7 @@ out:
1462} 1462}
1463 1463
1464/** 1464/**
1465 * e1000_enable_mng_pass_thru - Enable processing of ARP's 1465 * igb_enable_mng_pass_thru - Enable processing of ARP's
1466 * @hw: pointer to the HW structure 1466 * @hw: pointer to the HW structure
1467 * 1467 *
1468 * Verifies the hardware needs to allow ARPs to be processed by the host. 1468 * Verifies the hardware needs to allow ARPs to be processed by the host.