Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drivers/net/ethernet: Fix (nearly-)kernel-doc comments for various functions

Fix incorrect start markers, wrapped summary lines, missing section
breaks, incorrect separators, and some name mismatches. Delete
a few that are content-free.

Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Ben Hutchings and committed by
David S. Miller
49ce9c2c ae86b9e3

+378 -410
+1 -1
drivers/net/ethernet/3com/3c501.c
··· 143 143 static int mem_start; 144 144 145 145 /** 146 - * el1_probe: - probe for a 3c501 146 + * el1_probe - probe for a 3c501 147 147 * @dev: The device structure passed in to probe. 148 148 * 149 149 * This can be called from two places. The network layer will probe using
+27 -41
drivers/net/ethernet/atheros/atl1c/atl1c_main.c
··· 166 166 msleep(5); 167 167 } 168 168 169 - /* 169 + /** 170 170 * atl1c_irq_enable - Enable default interrupt generation settings 171 171 * @adapter: board private structure 172 172 */ ··· 179 179 } 180 180 } 181 181 182 - /* 182 + /** 183 183 * atl1c_irq_disable - Mask off interrupt generation on the NIC 184 184 * @adapter: board private structure 185 185 */ ··· 192 192 synchronize_irq(adapter->pdev->irq); 193 193 } 194 194 195 - /* 195 + /** 196 196 * atl1c_irq_reset - reset interrupt confiure on the NIC 197 197 * @adapter: board private structure 198 198 */ ··· 220 220 return data; 221 221 } 222 222 223 - /* 223 + /** 224 224 * atl1c_phy_config - Timer Call-back 225 225 * @data: pointer to netdev cast into an unsigned long 226 226 */ ··· 361 361 } 362 362 363 363 364 - /* 364 + /** 365 365 * atl1c_tx_timeout - Respond to a Tx Hang 366 366 * @netdev: network interface device structure 367 367 */ ··· 374 374 schedule_work(&adapter->common_task); 375 375 } 376 376 377 - /* 377 + /** 378 378 * atl1c_set_multi - Multicast and Promiscuous mode set 379 379 * @netdev: network interface device structure 380 380 * ··· 453 453 atl1c_vlan_mode(adapter->netdev, adapter->netdev->features); 454 454 } 455 455 456 - /* 456 + /** 457 457 * atl1c_set_mac - Change the Ethernet Address of the NIC 458 458 * @netdev: network interface device structure 459 459 * @p: pointer to an address structure ··· 518 518 return 0; 519 519 } 520 520 521 - /* 521 + /** 522 522 * atl1c_change_mtu - Change the Maximum Transfer Unit 523 523 * @netdev: network interface device structure 524 524 * @new_mtu: new value for maximum frame size ··· 577 577 atl1c_write_phy_reg(&adapter->hw, reg_num, val); 578 578 } 579 579 580 - /* 581 - * atl1c_mii_ioctl - 582 - * @netdev: 583 - * @ifreq: 584 - * @cmd: 585 - */ 586 580 static int atl1c_mii_ioctl(struct net_device *netdev, 587 581 struct ifreq *ifr, int cmd) 588 582 { ··· 627 633 return retval; 628 634 } 629 635 630 - /* 631 - * atl1c_ioctl - 632 - * @netdev: 633 - * @ifreq: 634 - * @cmd: 635 - */ 636 636 static int atl1c_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 637 637 { 638 638 switch (cmd) { ··· 639 651 } 640 652 } 641 653 642 - /* 654 + /** 643 655 * atl1c_alloc_queues - Allocate memory for all rings 644 656 * @adapter: board private structure to initialize 645 657 * ··· 743 755 i++; 744 756 } 745 757 } 746 - /* 758 + /** 747 759 * atl1c_sw_init - Initialize general software structures (struct atl1c_adapter) 748 760 * @adapter: board private structure to initialize 749 761 * ··· 841 853 buffer_info->skb = NULL; 842 854 ATL1C_SET_BUFFER_STATE(buffer_info, ATL1C_BUFFER_FREE); 843 855 } 844 - /* 856 + /** 845 857 * atl1c_clean_tx_ring - Free Tx-skb 846 858 * @adapter: board private structure 847 859 */ ··· 866 878 tpd_ring->next_to_use = 0; 867 879 } 868 880 869 - /* 881 + /** 870 882 * atl1c_clean_rx_ring - Free rx-reservation skbs 871 883 * @adapter: board private structure 872 884 */ ··· 919 931 } 920 932 } 921 933 922 - /* 934 + /** 923 935 * atl1c_free_ring_resources - Free Tx / RX descriptor Resources 924 936 * @adapter: board private structure 925 937 * ··· 942 954 } 943 955 } 944 956 945 - /* 957 + /** 946 958 * atl1c_setup_mem_resources - allocate Tx / RX descriptor resources 947 959 * @adapter: board private structure 948 960 * ··· 1351 1363 return; 1352 1364 } 1353 1365 1354 - /* 1366 + /** 1355 1367 * atl1c_configure - Configure Transmit&Receive Unit after Reset 1356 1368 * @adapter: board private structure 1357 1369 * ··· 1465 1477 } 1466 1478 } 1467 1479 1468 - /* 1480 + /** 1469 1481 * atl1c_get_stats - Get System Network Statistics 1470 1482 * @netdev: network interface device structure 1471 1483 * ··· 1546 1558 return true; 1547 1559 } 1548 1560 1549 - /* 1561 + /** 1550 1562 * atl1c_intr - Interrupt Handler 1551 1563 * @irq: interrupt number 1552 1564 * @data: pointer to a network interface device structure 1553 - * @pt_regs: CPU registers structure 1554 1565 */ 1555 1566 static irqreturn_t atl1c_intr(int irq, void *data) 1556 1567 { ··· 1800 1813 atl1c_alloc_rx_buffer(adapter); 1801 1814 } 1802 1815 1803 - /* 1816 + /** 1804 1817 * atl1c_clean - NAPI Rx polling callback 1805 - * @adapter: board private structure 1806 1818 */ 1807 1819 static int atl1c_clean(struct napi_struct *napi, int budget) 1808 1820 { ··· 2256 2270 atl1c_reset_dma_ring(adapter); 2257 2271 } 2258 2272 2259 - /* 2273 + /** 2260 2274 * atl1c_open - Called when a network interface is made active 2261 2275 * @netdev: network interface device structure 2262 2276 * ··· 2295 2309 return err; 2296 2310 } 2297 2311 2298 - /* 2312 + /** 2299 2313 * atl1c_close - Disables a network interface 2300 2314 * @netdev: network interface device structure 2301 2315 * ··· 2418 2432 return 0; 2419 2433 } 2420 2434 2421 - /* 2435 + /** 2422 2436 * atl1c_probe - Device Initialization Routine 2423 2437 * @pdev: PCI device information struct 2424 2438 * @ent: entry in atl1c_pci_tbl ··· 2565 2579 return err; 2566 2580 } 2567 2581 2568 - /* 2582 + /** 2569 2583 * atl1c_remove - Device Removal Routine 2570 2584 * @pdev: PCI device information struct 2571 2585 * ··· 2591 2605 free_netdev(netdev); 2592 2606 } 2593 2607 2594 - /* 2608 + /** 2595 2609 * atl1c_io_error_detected - called when PCI error is detected 2596 2610 * @pdev: Pointer to PCI device 2597 2611 * @state: The current pci connection state ··· 2619 2633 return PCI_ERS_RESULT_NEED_RESET; 2620 2634 } 2621 2635 2622 - /* 2636 + /** 2623 2637 * atl1c_io_slot_reset - called after the pci bus has been reset. 2624 2638 * @pdev: Pointer to PCI device 2625 2639 * ··· 2647 2661 return PCI_ERS_RESULT_RECOVERED; 2648 2662 } 2649 2663 2650 - /* 2664 + /** 2651 2665 * atl1c_io_resume - called when traffic can start flowing again. 2652 2666 * @pdev: Pointer to PCI device 2653 2667 * ··· 2690 2704 .driver.pm = &atl1c_pm_ops, 2691 2705 }; 2692 2706 2693 - /* 2707 + /** 2694 2708 * atl1c_init_module - Driver Registration Routine 2695 2709 * 2696 2710 * atl1c_init_module is the first routine called when the driver is ··· 2701 2715 return pci_register_driver(&atl1c_driver); 2702 2716 } 2703 2717 2704 - /* 2718 + /** 2705 2719 * atl1c_exit_module - Driver Exit Cleanup Routine 2706 2720 * 2707 2721 * atl1c_exit_module is called just before the driver is removed
+28 -42
drivers/net/ethernet/atheros/atl1e/atl1e_main.c
··· 89 89 128, 256, 512, 1024, 2048, 4096, 90 90 }; 91 91 92 - /* 92 + /** 93 93 * atl1e_irq_enable - Enable default interrupt generation settings 94 94 * @adapter: board private structure 95 95 */ ··· 102 102 } 103 103 } 104 104 105 - /* 105 + /** 106 106 * atl1e_irq_disable - Mask off interrupt generation on the NIC 107 107 * @adapter: board private structure 108 108 */ ··· 114 114 synchronize_irq(adapter->pdev->irq); 115 115 } 116 116 117 - /* 117 + /** 118 118 * atl1e_irq_reset - reset interrupt confiure on the NIC 119 119 * @adapter: board private structure 120 120 */ ··· 126 126 AT_WRITE_FLUSH(&adapter->hw); 127 127 } 128 128 129 - /* 129 + /** 130 130 * atl1e_phy_config - Timer Call-back 131 131 * @data: pointer to netdev cast into an unsigned long 132 132 */ ··· 210 210 return 0; 211 211 } 212 212 213 - /* 213 + /** 214 214 * atl1e_link_chg_task - deal with link change event Out of interrupt context 215 215 * @netdev: network interface device structure 216 216 */ ··· 259 259 cancel_work_sync(&adapter->link_chg_task); 260 260 } 261 261 262 - /* 262 + /** 263 263 * atl1e_tx_timeout - Respond to a Tx Hang 264 264 * @netdev: network interface device structure 265 265 */ ··· 271 271 schedule_work(&adapter->reset_task); 272 272 } 273 273 274 - /* 274 + /** 275 275 * atl1e_set_multi - Multicast and Promiscuous mode set 276 276 * @netdev: network interface device structure 277 277 * ··· 345 345 atl1e_vlan_mode(adapter->netdev, adapter->netdev->features); 346 346 } 347 347 348 - /* 348 + /** 349 349 * atl1e_set_mac - Change the Ethernet Address of the NIC 350 350 * @netdev: network interface device structure 351 351 * @p: pointer to an address structure ··· 397 397 return 0; 398 398 } 399 399 400 - /* 400 + /** 401 401 * atl1e_change_mtu - Change the Maximum Transfer Unit 402 402 * @netdev: network interface device structure 403 403 * @new_mtu: new value for maximum frame size ··· 449 449 atl1e_write_phy_reg(&adapter->hw, reg_num & MDIO_REG_ADDR_MASK, val); 450 450 } 451 451 452 - /* 453 - * atl1e_mii_ioctl - 454 - * @netdev: 455 - * @ifreq: 456 - * @cmd: 457 - */ 458 452 static int atl1e_mii_ioctl(struct net_device *netdev, 459 453 struct ifreq *ifr, int cmd) 460 454 { ··· 499 505 500 506 } 501 507 502 - /* 503 - * atl1e_ioctl - 504 - * @netdev: 505 - * @ifreq: 506 - * @cmd: 507 - */ 508 508 static int atl1e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 509 509 { 510 510 switch (cmd) { ··· 529 541 msleep(1); 530 542 } 531 543 532 - /* 544 + /** 533 545 * atl1e_alloc_queues - Allocate memory for all rings 534 546 * @adapter: board private structure to initialize 535 547 * ··· 539 551 return 0; 540 552 } 541 553 542 - /* 554 + /** 543 555 * atl1e_sw_init - Initialize general software structures (struct atl1e_adapter) 544 556 * @adapter: board private structure to initialize 545 557 * ··· 623 635 return 0; 624 636 } 625 637 626 - /* 638 + /** 627 639 * atl1e_clean_tx_ring - Free Tx-skb 628 640 * @adapter: board private structure 629 641 */ ··· 666 678 ring_count); 667 679 } 668 680 669 - /* 681 + /** 670 682 * atl1e_clean_rx_ring - Free rx-reservation skbs 671 683 * @adapter: board private structure 672 684 */ ··· 749 761 } 750 762 } 751 763 752 - /* 764 + /** 753 765 * atl1e_free_ring_resources - Free Tx / RX descriptor Resources 754 766 * @adapter: board private structure 755 767 * ··· 774 786 } 775 787 } 776 788 777 - /* 789 + /** 778 790 * atl1e_setup_mem_resources - allocate Tx / RX descriptor resources 779 791 * @adapter: board private structure 780 792 * ··· 1063 1075 AT_WRITE_REG(hw, REG_MAC_CTRL, value); 1064 1076 } 1065 1077 1066 - /* 1078 + /** 1067 1079 * atl1e_configure - Configure Transmit&Receive Unit after Reset 1068 1080 * @adapter: board private structure 1069 1081 * ··· 1133 1145 return 0; 1134 1146 } 1135 1147 1136 - /* 1148 + /** 1137 1149 * atl1e_get_stats - Get System Network Statistics 1138 1150 * @netdev: network interface device structure 1139 1151 * ··· 1245 1257 return true; 1246 1258 } 1247 1259 1248 - /* 1260 + /** 1249 1261 * atl1e_intr - Interrupt Handler 1250 1262 * @irq: interrupt number 1251 1263 * @data: pointer to a network interface device structure 1252 - * @pt_regs: CPU registers structure 1253 1264 */ 1254 1265 static irqreturn_t atl1e_intr(int irq, void *data) 1255 1266 { ··· 1476 1489 schedule_work(&adapter->reset_task); 1477 1490 } 1478 1491 1479 - /* 1492 + /** 1480 1493 * atl1e_clean - NAPI Rx polling callback 1481 - * @adapter: board private structure 1482 1494 */ 1483 1495 static int atl1e_clean(struct napi_struct *napi, int budget) 1484 1496 { ··· 1942 1956 atl1e_clean_rx_ring(adapter); 1943 1957 } 1944 1958 1945 - /* 1959 + /** 1946 1960 * atl1e_open - Called when a network interface is made active 1947 1961 * @netdev: network interface device structure 1948 1962 * ··· 1988 2002 return err; 1989 2003 } 1990 2004 1991 - /* 2005 + /** 1992 2006 * atl1e_close - Disables a network interface 1993 2007 * @netdev: network interface device structure 1994 2008 * ··· 2224 2238 return 0; 2225 2239 } 2226 2240 2227 - /* 2241 + /** 2228 2242 * atl1e_probe - Device Initialization Routine 2229 2243 * @pdev: PCI device information struct 2230 2244 * @ent: entry in atl1e_pci_tbl ··· 2378 2392 return err; 2379 2393 } 2380 2394 2381 - /* 2395 + /** 2382 2396 * atl1e_remove - Device Removal Routine 2383 2397 * @pdev: PCI device information struct 2384 2398 * ··· 2410 2424 pci_disable_device(pdev); 2411 2425 } 2412 2426 2413 - /* 2427 + /** 2414 2428 * atl1e_io_error_detected - called when PCI error is detected 2415 2429 * @pdev: Pointer to PCI device 2416 2430 * @state: The current pci connection state ··· 2438 2452 return PCI_ERS_RESULT_NEED_RESET; 2439 2453 } 2440 2454 2441 - /* 2455 + /** 2442 2456 * atl1e_io_slot_reset - called after the pci bus has been reset. 2443 2457 * @pdev: Pointer to PCI device 2444 2458 * ··· 2465 2479 return PCI_ERS_RESULT_RECOVERED; 2466 2480 } 2467 2481 2468 - /* 2482 + /** 2469 2483 * atl1e_io_resume - called when traffic can start flowing again. 2470 2484 * @pdev: Pointer to PCI device 2471 2485 * ··· 2509 2523 .err_handler = &atl1e_err_handler 2510 2524 }; 2511 2525 2512 - /* 2526 + /** 2513 2527 * atl1e_init_module - Driver Registration Routine 2514 2528 * 2515 2529 * atl1e_init_module is the first routine called when the driver is ··· 2520 2534 return pci_register_driver(&atl1e_driver); 2521 2535 } 2522 2536 2523 - /* 2537 + /** 2524 2538 * atl1e_exit_module - Driver Exit Cleanup Routine 2525 2539 * 2526 2540 * atl1e_exit_module is called just before the driver is removed
+1 -1
drivers/net/ethernet/atheros/atl1e/atl1e_param.c
··· 168 168 return -1; 169 169 } 170 170 171 - /* 171 + /** 172 172 * atl1e_check_options - Range Checking for Command Line Parameters 173 173 * @adapter: board private structure 174 174 *
+17 -24
drivers/net/ethernet/atheros/atlx/atl1.c
··· 195 195 return -1; 196 196 } 197 197 198 - /* 198 + /** 199 199 * atl1_check_options - Range Checking for Command Line Parameters 200 200 * @adapter: board private structure 201 201 * ··· 937 937 iowrite32(value, (hw->hw_addr + REG_MAC_STA_ADDR) + (1 << 2)); 938 938 } 939 939 940 - /* 940 + /** 941 941 * atl1_sw_init - Initialize general software structures (struct atl1_adapter) 942 942 * @adapter: board private structure to initialize 943 943 * ··· 1014 1014 atl1_write_phy_reg(&adapter->hw, reg_num, val); 1015 1015 } 1016 1016 1017 - /* 1018 - * atl1_mii_ioctl - 1019 - * @netdev: 1020 - * @ifreq: 1021 - * @cmd: 1022 - */ 1023 1017 static int atl1_mii_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 1024 1018 { 1025 1019 struct atl1_adapter *adapter = netdev_priv(netdev); ··· 1030 1036 return retval; 1031 1037 } 1032 1038 1033 - /* 1039 + /** 1034 1040 * atl1_setup_mem_resources - allocate Tx / RX descriptor resources 1035 1041 * @adapter: board private structure 1036 1042 * ··· 1141 1147 atomic_set(&rrd_ring->next_to_clean, 0); 1142 1148 } 1143 1149 1144 - /* 1150 + /** 1145 1151 * atl1_clean_rx_ring - Free RFD Buffers 1146 1152 * @adapter: board private structure 1147 1153 */ ··· 1181 1187 atomic_set(&rrd_ring->next_to_clean, 0); 1182 1188 } 1183 1189 1184 - /* 1190 + /** 1185 1191 * atl1_clean_tx_ring - Free Tx Buffers 1186 1192 * @adapter: board private structure 1187 1193 */ ··· 1221 1227 atomic_set(&tpd_ring->next_to_clean, 0); 1222 1228 } 1223 1229 1224 - /* 1230 + /** 1225 1231 * atl1_free_ring_resources - Free Tx / RX descriptor Resources 1226 1232 * @adapter: board private structure 1227 1233 * ··· 1464 1470 iowrite32(value, hw->hw_addr + REG_RXQ_RRD_PAUSE_THRESH); 1465 1471 } 1466 1472 1467 - /* 1473 + /** 1468 1474 * atl1_configure - Configure Transmit&Receive Unit after Reset 1469 1475 * @adapter: board private structure 1470 1476 * ··· 1838 1844 } 1839 1845 } 1840 1846 1841 - /* 1847 + /** 1842 1848 * atl1_alloc_rx_buffers - Replace used receive buffers 1843 1849 * @adapter: address of board private structure 1844 1850 */ ··· 2483 2489 return 1; 2484 2490 } 2485 2491 2486 - /* 2492 + /** 2487 2493 * atl1_intr - Interrupt Handler 2488 2494 * @irq: interrupt number 2489 2495 * @data: pointer to a network interface device structure 2490 - * @pt_regs: CPU registers structure 2491 2496 */ 2492 2497 static irqreturn_t atl1_intr(int irq, void *data) 2493 2498 { ··· 2567 2574 } 2568 2575 2569 2576 2570 - /* 2577 + /** 2571 2578 * atl1_phy_config - Timer Call-back 2572 2579 * @data: pointer to netdev cast into an unsigned long 2573 2580 */ ··· 2686 2693 netif_device_attach(netdev); 2687 2694 } 2688 2695 2689 - /* 2696 + /** 2690 2697 * atl1_change_mtu - Change the Maximum Transfer Unit 2691 2698 * @netdev: network interface device structure 2692 2699 * @new_mtu: new value for maximum frame size ··· 2720 2727 return 0; 2721 2728 } 2722 2729 2723 - /* 2730 + /** 2724 2731 * atl1_open - Called when a network interface is made active 2725 2732 * @netdev: network interface device structure 2726 2733 * ··· 2755 2762 return err; 2756 2763 } 2757 2764 2758 - /* 2765 + /** 2759 2766 * atl1_close - Disables a network interface 2760 2767 * @netdev: network interface device structure 2761 2768 * ··· 2923 2930 #endif 2924 2931 }; 2925 2932 2926 - /* 2933 + /** 2927 2934 * atl1_probe - Device Initialization Routine 2928 2935 * @pdev: PCI device information struct 2929 2936 * @ent: entry in atl1_pci_tbl ··· 3104 3111 return err; 3105 3112 } 3106 3113 3107 - /* 3114 + /** 3108 3115 * atl1_remove - Device Removal Routine 3109 3116 * @pdev: PCI device information struct 3110 3117 * ··· 3151 3158 .driver.pm = ATL1_PM_OPS, 3152 3159 }; 3153 3160 3154 - /* 3161 + /** 3155 3162 * atl1_exit_module - Driver Exit Cleanup Routine 3156 3163 * 3157 3164 * atl1_exit_module is called just before the driver is removed ··· 3162 3169 pci_unregister_driver(&atl1_driver); 3163 3170 } 3164 3171 3165 - /* 3172 + /** 3166 3173 * atl1_init_module - Driver Registration Routine 3167 3174 * 3168 3175 * atl1_init_module is the first routine called when the driver is
+21 -35
drivers/net/ethernet/atheros/atlx/atl2.c
··· 75 75 76 76 static void atl2_check_options(struct atl2_adapter *adapter); 77 77 78 - /* 78 + /** 79 79 * atl2_sw_init - Initialize general software structures (struct atl2_adapter) 80 80 * @adapter: board private structure to initialize 81 81 * ··· 123 123 return 0; 124 124 } 125 125 126 - /* 126 + /** 127 127 * atl2_set_multi - Multicast and Promiscuous mode set 128 128 * @netdev: network interface device structure 129 129 * ··· 177 177 adapter->txs_next_clear = 0; 178 178 } 179 179 180 - /* 180 + /** 181 181 * atl2_configure - Configure Transmit&Receive Unit after Reset 182 182 * @adapter: board private structure 183 183 * ··· 283 283 return value; 284 284 } 285 285 286 - /* 286 + /** 287 287 * atl2_setup_ring_resources - allocate Tx / RX descriptor resources 288 288 * @adapter: board private structure 289 289 * ··· 340 340 return 0; 341 341 } 342 342 343 - /* 343 + /** 344 344 * atl2_irq_enable - Enable default interrupt generation settings 345 345 * @adapter: board private structure 346 346 */ ··· 350 350 ATL2_WRITE_FLUSH(&adapter->hw); 351 351 } 352 352 353 - /* 353 + /** 354 354 * atl2_irq_disable - Mask off interrupt generation on the NIC 355 355 * @adapter: board private structure 356 356 */ ··· 599 599 spin_unlock(&adapter->stats_lock); 600 600 } 601 601 602 - /* 602 + /** 603 603 * atl2_intr - Interrupt Handler 604 604 * @irq: interrupt number 605 605 * @data: pointer to a network interface device structure 606 - * @pt_regs: CPU registers structure 607 606 */ 608 607 static irqreturn_t atl2_intr(int irq, void *data) 609 608 { ··· 678 679 netdev); 679 680 } 680 681 681 - /* 682 + /** 682 683 * atl2_free_ring_resources - Free Tx / RX descriptor Resources 683 684 * @adapter: board private structure 684 685 * ··· 691 692 adapter->ring_dma); 692 693 } 693 694 694 - /* 695 + /** 695 696 * atl2_open - Called when a network interface is made active 696 697 * @netdev: network interface device structure 697 698 * ··· 797 798 #endif 798 799 } 799 800 800 - /* 801 + /** 801 802 * atl2_close - Disables a network interface 802 803 * @netdev: network interface device structure 803 804 * ··· 917 918 return NETDEV_TX_OK; 918 919 } 919 920 920 - /* 921 + /** 921 922 * atl2_change_mtu - Change the Maximum Transfer Unit 922 923 * @netdev: network interface device structure 923 924 * @new_mtu: new value for maximum frame size ··· 942 943 return 0; 943 944 } 944 945 945 - /* 946 + /** 946 947 * atl2_set_mac - Change the Ethernet Address of the NIC 947 948 * @netdev: network interface device structure 948 949 * @p: pointer to an address structure ··· 968 969 return 0; 969 970 } 970 971 971 - /* 972 - * atl2_mii_ioctl - 973 - * @netdev: 974 - * @ifreq: 975 - * @cmd: 976 - */ 977 972 static int atl2_mii_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 978 973 { 979 974 struct atl2_adapter *adapter = netdev_priv(netdev); ··· 1004 1011 return 0; 1005 1012 } 1006 1013 1007 - /* 1008 - * atl2_ioctl - 1009 - * @netdev: 1010 - * @ifreq: 1011 - * @cmd: 1012 - */ 1013 1014 static int atl2_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 1014 1015 { 1015 1016 switch (cmd) { ··· 1020 1033 } 1021 1034 } 1022 1035 1023 - /* 1036 + /** 1024 1037 * atl2_tx_timeout - Respond to a Tx Hang 1025 1038 * @netdev: network interface device structure 1026 1039 */ ··· 1032 1045 schedule_work(&adapter->reset_task); 1033 1046 } 1034 1047 1035 - /* 1048 + /** 1036 1049 * atl2_watchdog - Timer Call-back 1037 1050 * @data: pointer to netdev cast into an unsigned long 1038 1051 */ ··· 1057 1070 } 1058 1071 } 1059 1072 1060 - /* 1073 + /** 1061 1074 * atl2_phy_config - Timer Call-back 1062 1075 * @data: pointer to netdev cast into an unsigned long 1063 1076 */ ··· 1261 1274 return 0; 1262 1275 } 1263 1276 1264 - /* 1277 + /** 1265 1278 * atl2_link_chg_task - deal with link change event Out of interrupt context 1266 - * @netdev: network interface device structure 1267 1279 */ 1268 1280 static void atl2_link_chg_task(struct work_struct *work) 1269 1281 { ··· 1327 1341 #endif 1328 1342 }; 1329 1343 1330 - /* 1344 + /** 1331 1345 * atl2_probe - Device Initialization Routine 1332 1346 * @pdev: PCI device information struct 1333 1347 * @ent: entry in atl2_pci_tbl ··· 1487 1501 return err; 1488 1502 } 1489 1503 1490 - /* 1504 + /** 1491 1505 * atl2_remove - Device Removal Routine 1492 1506 * @pdev: PCI device information struct 1493 1507 * ··· 1714 1728 .shutdown = atl2_shutdown, 1715 1729 }; 1716 1730 1717 - /* 1731 + /** 1718 1732 * atl2_init_module - Driver Registration Routine 1719 1733 * 1720 1734 * atl2_init_module is the first routine called when the driver is ··· 1729 1743 } 1730 1744 module_init(atl2_init_module); 1731 1745 1732 - /* 1746 + /** 1733 1747 * atl2_exit_module - Driver Exit Cleanup Routine 1734 1748 * 1735 1749 * atl2_exit_module is called just before the driver is removed ··· 2983 2997 return -1; 2984 2998 } 2985 2999 2986 - /* 3000 + /** 2987 3001 * atl2_check_options - Range Checking for Command Line Parameters 2988 3002 * @adapter: board private structure 2989 3003 *
+5 -5
drivers/net/ethernet/atheros/atlx/atlx.c
··· 64 64 } 65 65 } 66 66 67 - /* 67 + /** 68 68 * atlx_set_mac - Change the Ethernet Address of the NIC 69 69 * @netdev: network interface device structure 70 70 * @p: pointer to an address structure ··· 115 115 schedule_work(&adapter->link_chg_task); 116 116 } 117 117 118 - /* 118 + /** 119 119 * atlx_set_multi - Multicast and Promiscuous mode set 120 120 * @netdev: network interface device structure 121 121 * ··· 162 162 ioread32(adapter->hw.hw_addr + REG_IMR); 163 163 } 164 164 165 - /* 165 + /** 166 166 * atlx_irq_enable - Enable default interrupt generation settings 167 167 * @adapter: board private structure 168 168 */ ··· 172 172 adapter->int_enabled = true; 173 173 } 174 174 175 - /* 175 + /** 176 176 * atlx_irq_disable - Mask off interrupt generation on the NIC 177 177 * @adapter: board private structure 178 178 */ ··· 193 193 spin_unlock_irqrestore(&adapter->lock, flags); 194 194 } 195 195 196 - /* 196 + /** 197 197 * atlx_tx_timeout - Respond to a Tx Hang 198 198 * @netdev: network interface device structure 199 199 */
+1 -1
drivers/net/ethernet/broadcom/bnx2x/bnx2x_cmn.h
··· 90 90 * bnx2x_config_rss_pf - configure RSS parameters in a PF. 91 91 * 92 92 * @bp: driver handle 93 - * @rss_obj RSS object to use 93 + * @rss_obj: RSS object to use 94 94 * @ind_table: indirection table to configure 95 95 * @config_hash: re-configure RSS hash keys configuration 96 96 */
+8 -28
drivers/net/ethernet/brocade/bna/bfa_cee.c
··· 52 52 } 53 53 54 54 /** 55 - * bfa_cee_attr_meminfo() 56 - * 57 - * @brief Returns the size of the DMA memory needed by CEE attributes 58 - * 59 - * @param[in] void 60 - * 61 - * @return Size of DMA region 55 + * bfa_cee_attr_meminfo - Returns the size of the DMA memory needed by CEE attributes 62 56 */ 63 57 static u32 64 58 bfa_cee_attr_meminfo(void) ··· 60 66 return roundup(sizeof(struct bfa_cee_attr), BFA_DMA_ALIGN_SZ); 61 67 } 62 68 /** 63 - * bfa_cee_stats_meminfo() 64 - * 65 - * @brief Returns the size of the DMA memory needed by CEE stats 66 - * 67 - * @param[in] void 68 - * 69 - * @return Size of DMA region 69 + * bfa_cee_stats_meminfo - Returns the size of the DMA memory needed by CEE stats 70 70 */ 71 71 static u32 72 72 bfa_cee_stats_meminfo(void) ··· 69 81 } 70 82 71 83 /** 72 - * bfa_cee_get_attr_isr() 84 + * bfa_cee_get_attr_isr - CEE ISR for get-attributes responses from f/w 73 85 * 74 - * @brief CEE ISR for get-attributes responses from f/w 75 - * 76 - * @param[in] cee - Pointer to the CEE module 77 - * status - Return status from the f/w 78 - * 79 - * @return void 86 + * @cee: Pointer to the CEE module 87 + * @status: Return status from the f/w 80 88 */ 81 89 static void 82 90 bfa_cee_get_attr_isr(struct bfa_cee *cee, enum bfa_status status) ··· 89 105 } 90 106 91 107 /** 92 - * bfa_cee_get_attr_isr() 108 + * bfa_cee_get_attr_isr - CEE ISR for get-stats responses from f/w 93 109 * 94 - * @brief CEE ISR for get-stats responses from f/w 95 - * 96 - * @param[in] cee - Pointer to the CEE module 97 - * status - Return status from the f/w 98 - * 99 - * @return void 110 + * @cee: Pointer to the CEE module 111 + * @status: Return status from the f/w 100 112 */ 101 113 static void 102 114 bfa_cee_get_stats_isr(struct bfa_cee *cee, enum bfa_status status)
+1 -1
drivers/net/ethernet/chelsio/cxgb3/sge.c
··· 2877 2877 mod_timer(&qs->tx_reclaim_timer, jiffies + next_period); 2878 2878 } 2879 2879 2880 - /* 2880 + /** 2881 2881 * sge_timer_rx - perform periodic maintenance of an SGE qset 2882 2882 * @data: the SGE queue set to maintain 2883 2883 *
+1 -1
drivers/net/ethernet/chelsio/cxgb3/t3_hw.c
··· 1076 1076 return 0; 1077 1077 } 1078 1078 1079 - /* 1079 + /** 1080 1080 * t3_load_fw - download firmware 1081 1081 * @adapter: the adapter 1082 1082 * @fw_data: the firmware image to write
+1 -1
drivers/net/ethernet/chelsio/cxgb4/t4_hw.c
··· 2010 2010 return t4_wr_mbox(adap, mbox, &c, sizeof(c), NULL); 2011 2011 } 2012 2012 2013 - /* 2013 + /** 2014 2014 * t4_mem_win_read_len - read memory through PCIE memory window 2015 2015 * @adap: the adapter 2016 2016 * @addr: address of first byte requested aligned on 32b.
+2 -2
drivers/net/ethernet/ethoc.c
··· 902 902 }; 903 903 904 904 /** 905 - * ethoc_probe() - initialize OpenCores ethernet MAC 905 + * ethoc_probe - initialize OpenCores ethernet MAC 906 906 * pdev: platform device 907 907 */ 908 908 static int __devinit ethoc_probe(struct platform_device *pdev) ··· 1140 1140 } 1141 1141 1142 1142 /** 1143 - * ethoc_remove() - shutdown OpenCores ethernet MAC 1143 + * ethoc_remove - shutdown OpenCores ethernet MAC 1144 1144 * @pdev: platform device 1145 1145 */ 1146 1146 static int __devexit ethoc_remove(struct platform_device *pdev)
+2 -2
drivers/net/ethernet/freescale/fec.c
··· 1389 1389 } 1390 1390 1391 1391 #ifdef CONFIG_NET_POLL_CONTROLLER 1392 - /* 1393 - * fec_poll_controller: FEC Poll controller function 1392 + /** 1393 + * fec_poll_controller - FEC Poll controller function 1394 1394 * @dev: The FEC network adapter 1395 1395 * 1396 1396 * Polled functionality used by netconsole and others in non interrupt mode
+4 -4
drivers/net/ethernet/intel/e1000/e1000_hw.c
··· 399 399 } 400 400 401 401 /** 402 - * e1000_reset_hw: reset the hardware completely 402 + * e1000_reset_hw - reset the hardware completely 403 403 * @hw: Struct containing variables accessed by shared code 404 404 * 405 405 * Reset the transmit and receive units; mask and clear all interrupts. ··· 546 546 } 547 547 548 548 /** 549 - * e1000_init_hw: Performs basic configuration of the adapter. 549 + * e1000_init_hw - Performs basic configuration of the adapter. 550 550 * @hw: Struct containing variables accessed by shared code 551 551 * 552 552 * Assumes that the controller has previously been reset and is in a ··· 2591 2591 * @hw: Struct containing variables accessed by shared code 2592 2592 * @speed: Speed of the connection 2593 2593 * @duplex: Duplex setting of the connection 2594 - 2594 + * 2595 2595 * Detects the current speed and duplex settings of the hardware. 2596 2596 */ 2597 2597 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex) ··· 2959 2959 * @hw: Struct containing variables accessed by shared code 2960 2960 * @reg_addr: address of the PHY register to write 2961 2961 * @data: data to write to the PHY 2962 - 2962 + * 2963 2963 * Writes a value to a PHY register 2964 2964 */ 2965 2965 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 reg_addr, u16 phy_data)
+1 -1
drivers/net/ethernet/intel/e1000e/netdev.c
··· 2159 2159 } 2160 2160 2161 2161 /** 2162 - * @e1000_alloc_ring - allocate memory for a ring structure 2162 + * e1000_alloc_ring_dma - allocate memory for a ring structure 2163 2163 **/ 2164 2164 static int e1000_alloc_ring_dma(struct e1000_adapter *adapter, 2165 2165 struct e1000_ring *ring)
+1
drivers/net/ethernet/intel/igb/igb_main.c
··· 5777 5777 /** 5778 5778 * igb_clean_tx_irq - Reclaim resources after transmit completes 5779 5779 * @q_vector: pointer to q_vector containing needed info 5780 + * 5780 5781 * returns true if ring is completely cleaned 5781 5782 **/ 5782 5783 static bool igb_clean_tx_irq(struct igb_q_vector *q_vector)
+1
drivers/net/ethernet/intel/igbvf/netdev.c
··· 766 766 /** 767 767 * igbvf_clean_tx_irq - Reclaim resources after transmit completes 768 768 * @adapter: board private structure 769 + * 769 770 * returns true if ring is completely cleaned 770 771 **/ 771 772 static bool igbvf_clean_tx_irq(struct igbvf_ring *tx_ring)
+3 -2
drivers/net/ethernet/intel/igbvf/vf.c
··· 283 283 return err; 284 284 } 285 285 286 - /** e1000_rlpml_set_vf - Set the maximum receive packet length 286 + /** 287 + * e1000_rlpml_set_vf - Set the maximum receive packet length 287 288 * @hw: pointer to the HW structure 288 289 * @max_size: value to assign to max frame size 289 290 **/ ··· 303 302 * e1000_rar_set_vf - set device MAC address 304 303 * @hw: pointer to the HW structure 305 304 * @addr: pointer to the receive address 306 - * @index receive address array register 305 + * @index: receive address array register 307 306 **/ 308 307 static void e1000_rar_set_vf(struct e1000_hw *hw, u8 * addr, u32 index) 309 308 {
+3 -3
drivers/net/ethernet/intel/ixgb/ixgb_main.c
··· 2276 2276 #endif 2277 2277 2278 2278 /** 2279 - * ixgb_io_error_detected() - called when PCI error is detected 2280 - * @pdev pointer to pci device with error 2281 - * @state pci channel state after error 2279 + * ixgb_io_error_detected - called when PCI error is detected 2280 + * @pdev: pointer to pci device with error 2281 + * @state: pci channel state after error 2282 2282 * 2283 2283 * This callback is called by the PCI subsystem whenever 2284 2284 * a PCI bus error is detected.
+2 -1
drivers/net/ethernet/intel/ixgbe/ixgbe_common.c
··· 3132 3132 } 3133 3133 3134 3134 /** 3135 - * ixgbe_get_wwn_prefix_generic Get alternative WWNN/WWPN prefix from 3135 + * ixgbe_get_wwn_prefix_generic - Get alternative WWNN/WWPN prefix from 3136 3136 * the EEPROM 3137 3137 * @hw: pointer to hardware structure 3138 3138 * @wwnn_prefix: the alternative WWNN prefix ··· 3325 3325 * ixgbe_calculate_checksum - Calculate checksum for buffer 3326 3326 * @buffer: pointer to EEPROM 3327 3327 * @length: size of EEPROM to calculate a checksum for 3328 + * 3328 3329 * Calculates the checksum for some buffer on a specified length. The 3329 3330 * checksum calculated is returned. 3330 3331 **/
+1 -1
drivers/net/ethernet/intel/ixgbe/ixgbe_fcoe.c
··· 38 38 39 39 /** 40 40 * ixgbe_fcoe_clear_ddp - clear the given ddp context 41 - * @ddp - ptr to the ixgbe_fcoe_ddp 41 + * @ddp: ptr to the ixgbe_fcoe_ddp 42 42 * 43 43 * Returns : none 44 44 *
+5 -5
drivers/net/ethernet/intel/ixgbe/ixgbe_lib.c
··· 252 252 } 253 253 254 254 /** 255 - * ixgbe_set_sriov_queues: Allocate queues for IOV use 255 + * ixgbe_set_sriov_queues - Allocate queues for IOV use 256 256 * @adapter: board private structure to initialize 257 257 * 258 258 * IOV doesn't actually use anything, so just NAK the ··· 265 265 } 266 266 267 267 /** 268 - * ixgbe_set_rss_queues: Allocate queues for RSS 268 + * ixgbe_set_rss_queues - Allocate queues for RSS 269 269 * @adapter: board private structure to initialize 270 270 * 271 271 * This is our "base" multiqueue mode. RSS (Receive Side Scaling) will try ··· 288 288 } 289 289 290 290 /** 291 - * ixgbe_set_fdir_queues: Allocate queues for Flow Director 291 + * ixgbe_set_fdir_queues - Allocate queues for Flow Director 292 292 * @adapter: board private structure to initialize 293 293 * 294 294 * Flow Director is an advanced Rx filter, attempting to get Rx flows back ··· 323 323 324 324 #ifdef IXGBE_FCOE 325 325 /** 326 - * ixgbe_set_fcoe_queues: Allocate queues for Fiber Channel over Ethernet (FCoE) 326 + * ixgbe_set_fcoe_queues - Allocate queues for Fiber Channel over Ethernet (FCoE) 327 327 * @adapter: board private structure to initialize 328 328 * 329 329 * FCoE RX FCRETA can use up to 8 rx queues for up to 8 different exchanges. ··· 410 410 #endif 411 411 412 412 /** 413 - * ixgbe_set_num_queues: Allocate queues for device, feature dependent 413 + * ixgbe_set_num_queues - Allocate queues for device, feature dependent 414 414 * @adapter: board private structure to initialize 415 415 * 416 416 * This is the top level queue allocation routine. The order here is very
+21 -20
drivers/net/ethernet/intel/ixgbe/ixgbe_main.c
··· 516 516 ctrl_ext | IXGBE_CTRL_EXT_DRV_LOAD); 517 517 } 518 518 519 - /* 519 + /** 520 520 * ixgbe_set_ivar - set the IVAR registers, mapping interrupt causes to vectors 521 521 * @adapter: pointer to adapter struct 522 522 * @direction: 0 for Rx, 1 for Tx, -1 for other causes ··· 3591 3591 } 3592 3592 3593 3593 #ifdef CONFIG_IXGBE_DCB 3594 - /* 3594 + /** 3595 3595 * ixgbe_configure_dcb - Configure DCB hardware 3596 3596 * @adapter: ixgbe adapter struct 3597 3597 * ··· 3658 3658 /* Additional bittime to account for IXGBE framing */ 3659 3659 #define IXGBE_ETH_FRAMING 20 3660 3660 3661 - /* 3661 + /** 3662 3662 * ixgbe_hpbthresh - calculate high water mark for flow control 3663 3663 * 3664 3664 * @adapter: board private structure to calculate for 3665 - * @pb - packet buffer to calculate 3665 + * @pb: packet buffer to calculate 3666 3666 */ 3667 3667 static int ixgbe_hpbthresh(struct ixgbe_adapter *adapter, int pb) 3668 3668 { ··· 3722 3722 return marker; 3723 3723 } 3724 3724 3725 - /* 3725 + /** 3726 3726 * ixgbe_lpbthresh - calculate low water mark for for flow control 3727 3727 * 3728 3728 * @adapter: board private structure to calculate for 3729 - * @pb - packet buffer to calculate 3729 + * @pb: packet buffer to calculate 3730 3730 */ 3731 3731 static int ixgbe_lpbthresh(struct ixgbe_adapter *adapter) 3732 3732 { ··· 5243 5243 5244 5244 /** 5245 5245 * ixgbe_fdir_reinit_subtask - worker thread to reinit FDIR filter table 5246 - * @adapter - pointer to the device adapter structure 5246 + * @adapter: pointer to the device adapter structure 5247 5247 **/ 5248 5248 static void ixgbe_fdir_reinit_subtask(struct ixgbe_adapter *adapter) 5249 5249 { ··· 5279 5279 5280 5280 /** 5281 5281 * ixgbe_check_hang_subtask - check for hung queues and dropped interrupts 5282 - * @adapter - pointer to the device adapter structure 5282 + * @adapter: pointer to the device adapter structure 5283 5283 * 5284 5284 * This function serves two purposes. First it strobes the interrupt lines 5285 5285 * in order to make certain interrupts are occurring. Secondly it sets the ··· 5327 5327 5328 5328 /** 5329 5329 * ixgbe_watchdog_update_link - update the link status 5330 - * @adapter - pointer to the device adapter structure 5331 - * @link_speed - pointer to a u32 to store the link_speed 5330 + * @adapter: pointer to the device adapter structure 5331 + * @link_speed: pointer to a u32 to store the link_speed 5332 5332 **/ 5333 5333 static void ixgbe_watchdog_update_link(struct ixgbe_adapter *adapter) 5334 5334 { ··· 5371 5371 /** 5372 5372 * ixgbe_watchdog_link_is_up - update netif_carrier status and 5373 5373 * print link up message 5374 - * @adapter - pointer to the device adapter structure 5374 + * @adapter: pointer to the device adapter structure 5375 5375 **/ 5376 5376 static void ixgbe_watchdog_link_is_up(struct ixgbe_adapter *adapter) 5377 5377 { ··· 5431 5431 /** 5432 5432 * ixgbe_watchdog_link_is_down - update netif_carrier status and 5433 5433 * print link down message 5434 - * @adapter - pointer to the adapter structure 5434 + * @adapter: pointer to the adapter structure 5435 5435 **/ 5436 5436 static void ixgbe_watchdog_link_is_down(struct ixgbe_adapter *adapter) 5437 5437 { ··· 5459 5459 5460 5460 /** 5461 5461 * ixgbe_watchdog_flush_tx - flush queues on link down 5462 - * @adapter - pointer to the device adapter structure 5462 + * @adapter: pointer to the device adapter structure 5463 5463 **/ 5464 5464 static void ixgbe_watchdog_flush_tx(struct ixgbe_adapter *adapter) 5465 5465 { ··· 5508 5508 5509 5509 /** 5510 5510 * ixgbe_watchdog_subtask - check and bring link up 5511 - * @adapter - pointer to the device adapter structure 5511 + * @adapter: pointer to the device adapter structure 5512 5512 **/ 5513 5513 static void ixgbe_watchdog_subtask(struct ixgbe_adapter *adapter) 5514 5514 { ··· 5532 5532 5533 5533 /** 5534 5534 * ixgbe_sfp_detection_subtask - poll for SFP+ cable 5535 - * @adapter - the ixgbe adapter structure 5535 + * @adapter: the ixgbe adapter structure 5536 5536 **/ 5537 5537 static void ixgbe_sfp_detection_subtask(struct ixgbe_adapter *adapter) 5538 5538 { ··· 5599 5599 5600 5600 /** 5601 5601 * ixgbe_sfp_link_config_subtask - set up link SFP after module install 5602 - * @adapter - the ixgbe adapter structure 5602 + * @adapter: the ixgbe adapter structure 5603 5603 **/ 5604 5604 static void ixgbe_sfp_link_config_subtask(struct ixgbe_adapter *adapter) 5605 5605 { ··· 6586 6586 } 6587 6587 6588 6588 #ifdef CONFIG_IXGBE_DCB 6589 - /* ixgbe_validate_rtr - verify 802.1Qp to Rx packet buffer mapping is valid. 6590 - * #adapter: pointer to ixgbe_adapter 6589 + /** 6590 + * ixgbe_validate_rtr - verify 802.1Qp to Rx packet buffer mapping is valid. 6591 + * @adapter: pointer to ixgbe_adapter 6591 6592 * @tc: number of traffic classes currently enabled 6592 6593 * 6593 6594 * Configure a valid 802.1Qp to Rx packet buffer mapping ie confirm ··· 6623 6622 return; 6624 6623 } 6625 6624 6626 - /* ixgbe_setup_tc - routine to configure net_device for multiple traffic 6627 - * classes. 6625 + /** 6626 + * ixgbe_setup_tc - configure net_device for multiple traffic classes 6628 6627 * 6629 6628 * @netdev: net device to configure 6630 6629 * @tc: number of traffic classes to enable
+19 -19
drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c
··· 107 107 108 108 /** 109 109 * ixgbe_ptp_read - read raw cycle counter (to be used by time counter) 110 - * @cc - the cyclecounter structure 110 + * @cc: the cyclecounter structure 111 111 * 112 112 * this function reads the cyclecounter registers and is called by the 113 113 * cyclecounter structure used to construct a ns counter from the ··· 128 128 129 129 /** 130 130 * ixgbe_ptp_adjfreq 131 - * @ptp - the ptp clock structure 132 - * @ppb - parts per billion adjustment from base 131 + * @ptp: the ptp clock structure 132 + * @ppb: parts per billion adjustment from base 133 133 * 134 134 * adjust the frequency of the ptp cycle counter by the 135 135 * indicated ppb from the base frequency. ··· 175 175 176 176 /** 177 177 * ixgbe_ptp_adjtime 178 - * @ptp - the ptp clock structure 179 - * @delta - offset to adjust the cycle counter by 178 + * @ptp: the ptp clock structure 179 + * @delta: offset to adjust the cycle counter by 180 180 * 181 181 * adjust the timer by resetting the timecounter structure. 182 182 */ ··· 203 203 204 204 /** 205 205 * ixgbe_ptp_gettime 206 - * @ptp - the ptp clock structure 207 - * @ts - timespec structure to hold the current time value 206 + * @ptp: the ptp clock structure 207 + * @ts: timespec structure to hold the current time value 208 208 * 209 209 * read the timecounter and return the correct value on ns, 210 210 * after converting it into a struct timespec. ··· 229 229 230 230 /** 231 231 * ixgbe_ptp_settime 232 - * @ptp - the ptp clock structure 233 - * @ts - the timespec containing the new time for the cycle counter 232 + * @ptp: the ptp clock structure 233 + * @ts: the timespec containing the new time for the cycle counter 234 234 * 235 235 * reset the timecounter to use a new base value instead of the kernel 236 236 * wall timer value. ··· 256 256 257 257 /** 258 258 * ixgbe_ptp_enable 259 - * @ptp - the ptp clock structure 260 - * @rq - the requested feature to change 261 - * @on - whether to enable or disable the feature 259 + * @ptp: the ptp clock structure 260 + * @rq: the requested feature to change 261 + * @on: whether to enable or disable the feature 262 262 * 263 263 * enable (or disable) ancillary features of the phc subsystem. 264 264 * our driver only supports the PPS feature on the X540 ··· 294 294 295 295 /** 296 296 * ixgbe_ptp_check_pps_event 297 - * @adapter - the private adapter structure 298 - * @eicr - the interrupt cause register value 297 + * @adapter: the private adapter structure 298 + * @eicr: the interrupt cause register value 299 299 * 300 300 * This function is called by the interrupt routine when checking for 301 301 * interrupts. It will check and handle a pps event. ··· 325 325 326 326 /** 327 327 * ixgbe_ptp_enable_sdp 328 - * @hw - the hardware private structure 329 - * @shift - the clock shift for calculating nanoseconds 328 + * @hw: the hardware private structure 329 + * @shift: the clock shift for calculating nanoseconds 330 330 * 331 331 * this function enables the clock out feature on the sdp0 for the 332 332 * X540 device. It will create a 1second periodic output that can be ··· 399 399 400 400 /** 401 401 * ixgbe_ptp_disable_sdp 402 - * @hw - the private hardware structure 402 + * @hw: the private hardware structure 403 403 * 404 404 * this function disables the auxiliary SDP clock out feature 405 405 */ ··· 769 769 770 770 /** 771 771 * ixgbe_ptp_start_cyclecounter - create the cycle counter from hw 772 - * @adapter - pointer to the adapter structure 772 + * @adapter: pointer to the adapter structure 773 773 * 774 774 * this function initializes the timecounter and cyclecounter 775 775 * structures for use in generated a ns counter from the arbitrary ··· 905 905 906 906 /** 907 907 * ixgbe_ptp_init 908 - * @adapter - the ixgbe private adapter structure 908 + * @adapter: the ixgbe private adapter structure 909 909 * 910 910 * This function performs the required steps for enabling ptp 911 911 * support. If ptp support has already been loaded it simply calls the
+4 -4
drivers/net/ethernet/intel/ixgbe/ixgbe_sysfs.c
··· 95 95 return sprintf(buf, "%u\n", value); 96 96 } 97 97 98 - /* 98 + /** 99 99 * ixgbe_add_hwmon_attr - Create hwmon attr table for a hwmon sysfs file. 100 - * @ adapter: pointer to the adapter structure 101 - * @ offset: offset in the eeprom sensor data table 102 - * @ type: type of sensor data to display 100 + * @adapter: pointer to the adapter structure 101 + * @offset: offset in the eeprom sensor data table 102 + * @type: type of sensor data to display 103 103 * 104 104 * For each file we want in hwmon's sysfs interface we need a device_attribute 105 105 * This is included in our hwmon_attr struct that contains the references to
+3 -3
drivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c
··· 115 115 IXGBE_WRITE_REG(hw, IXGBE_VFRDT(rx_ring->reg_idx), val); 116 116 } 117 117 118 - /* 118 + /** 119 119 * ixgbevf_set_ivar - set IVAR registers - maps interrupt causes to vectors 120 120 * @adapter: pointer to adapter struct 121 121 * @direction: 0 for Rx, 1 for Tx, -1 for other causes ··· 1942 1942 } 1943 1943 } 1944 1944 1945 - /* 1946 - * ixgbevf_set_num_queues: Allocate queues for device, feature dependent 1945 + /** 1946 + * ixgbevf_set_num_queues - Allocate queues for device, feature dependent 1947 1947 * @adapter: board private structure to initialize 1948 1948 * 1949 1949 * This is the top level queue allocation routine. The order here is very
+1 -1
drivers/net/ethernet/micrel/ks8851_mll.c
··· 1103 1103 } 1104 1104 } /* ks_set_grpaddr */ 1105 1105 1106 - /* 1106 + /** 1107 1107 * ks_clear_mcast - clear multicast information 1108 1108 * 1109 1109 * @ks : The chip information
+1 -1
drivers/net/ethernet/micrel/ksz884x.c
··· 3913 3913 hw->rx_stop = 2; 3914 3914 } 3915 3915 3916 - /* 3916 + /** 3917 3917 * hw_stop_rx - stop receiving 3918 3918 * @hw: The hardware instance. 3919 3919 *
+5 -5
drivers/net/ethernet/neterion/s2io.c
··· 3377 3377 } while (cnt < 20); 3378 3378 return ret; 3379 3379 } 3380 - /* 3380 + /** 3381 3381 * check_pci_device_id - Checks if the device id is supported 3382 3382 * @id : device id 3383 3383 * Description: Function to check if the pci device id is supported by driver. ··· 5238 5238 } 5239 5239 5240 5240 /** 5241 - * s2io_set_mac_addr driver entry point 5241 + * s2io_set_mac_addr - driver entry point 5242 5242 */ 5243 5243 5244 5244 static int s2io_set_mac_addr(struct net_device *dev, void *p) ··· 6088 6088 } 6089 6089 6090 6090 /** 6091 - * s2io-link_test - verifies the link state of the nic 6091 + * s2io_link_test - verifies the link state of the nic 6092 6092 * @sp ; private member of the device structure, which is a pointer to the 6093 6093 * s2io_nic structure. 6094 6094 * @data: variable that returns the result of each of the test conducted by ··· 6116 6116 6117 6117 /** 6118 6118 * s2io_rldram_test - offline test for access to the RldRam chip on the NIC 6119 - * @sp - private member of the device structure, which is a pointer to the 6119 + * @sp: private member of the device structure, which is a pointer to the 6120 6120 * s2io_nic structure. 6121 - * @data - variable that returns the result of each of the test 6121 + * @data: variable that returns the result of each of the test 6122 6122 * conducted by the driver. 6123 6123 * Description: 6124 6124 * This is one of the offline test that tests the read and write
+1 -1
drivers/net/ethernet/nvidia/forcedeth.c
··· 3218 3218 } 3219 3219 3220 3220 /** 3221 - * nv_update_linkspeed: Setup the MAC according to the link partner 3221 + * nv_update_linkspeed - Setup the MAC according to the link partner 3222 3222 * @dev: Network device to be configured 3223 3223 * 3224 3224 * The function queries the PHY and checks if there is a link partner.
+6 -6
drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_api.c
··· 60 60 /** 61 61 * pch_gbe_plat_init_hw - Initialize hardware 62 62 * @hw: Pointer to the HW structure 63 - * Returns 63 + * Returns: 64 64 * 0: Successfully 65 65 * Negative value: Failed-EBUSY 66 66 */ ··· 108 108 /** 109 109 * pch_gbe_hal_setup_init_funcs - Initializes function pointers 110 110 * @hw: Pointer to the HW structure 111 - * Returns 111 + * Returns: 112 112 * 0: Successfully 113 113 * ENOSYS: Function is not registered 114 114 */ ··· 137 137 /** 138 138 * pch_gbe_hal_init_hw - Initialize hardware 139 139 * @hw: Pointer to the HW structure 140 - * Returns 140 + * Returns: 141 141 * 0: Successfully 142 142 * ENOSYS: Function is not registered 143 143 */ ··· 155 155 * @hw: Pointer to the HW structure 156 156 * @offset: The register to read 157 157 * @data: The buffer to store the 16-bit read. 158 - * Returns 158 + * Returns: 159 159 * 0: Successfully 160 160 * Negative value: Failed 161 161 */ ··· 172 172 * @hw: Pointer to the HW structure 173 173 * @offset: The register to read 174 174 * @data: The value to write. 175 - * Returns 175 + * Returns: 176 176 * 0: Successfully 177 177 * Negative value: Failed 178 178 */ ··· 211 211 /** 212 212 * pch_gbe_hal_read_mac_addr - Reads MAC address 213 213 * @hw: Pointer to the HW structure 214 - * Returns 214 + * Returns: 215 215 * 0: Successfully 216 216 * ENOSYS: Function is not registered 217 217 */
+5 -5
drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_ethtool.c
··· 77 77 * pch_gbe_get_settings - Get device-specific settings 78 78 * @netdev: Network interface device structure 79 79 * @ecmd: Ethtool command 80 - * Returns 80 + * Returns: 81 81 * 0: Successful. 82 82 * Negative value: Failed. 83 83 */ ··· 100 100 * pch_gbe_set_settings - Set device-specific settings 101 101 * @netdev: Network interface device structure 102 102 * @ecmd: Ethtool command 103 - * Returns 103 + * Returns: 104 104 * 0: Successful. 105 105 * Negative value: Failed. 106 106 */ ··· 220 220 * pch_gbe_set_wol - Turn Wake-on-Lan on or off 221 221 * @netdev: Network interface device structure 222 222 * @wol: Pointer of wake-on-Lan information straucture 223 - * Returns 223 + * Returns: 224 224 * 0: Successful. 225 225 * Negative value: Failed. 226 226 */ ··· 248 248 /** 249 249 * pch_gbe_nway_reset - Restart autonegotiation 250 250 * @netdev: Network interface device structure 251 - * Returns 251 + * Returns: 252 252 * 0: Successful. 253 253 * Negative value: Failed. 254 254 */ ··· 398 398 * pch_gbe_set_pauseparam - Set pause paramters 399 399 * @netdev: Network interface device structure 400 400 * @pause: Pause parameters structure 401 - * Returns 401 + * Returns: 402 402 * 0: Successful. 403 403 * Negative value: Failed. 404 404 */
+21 -21
drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_main.c
··· 301 301 /** 302 302 * pch_gbe_mac_read_mac_addr - Read MAC address 303 303 * @hw: Pointer to the HW structure 304 - * Returns 304 + * Returns: 305 305 * 0: Successful. 306 306 */ 307 307 s32 pch_gbe_mac_read_mac_addr(struct pch_gbe_hw *hw) ··· 483 483 /** 484 484 * pch_gbe_mac_force_mac_fc - Force the MAC's flow control settings 485 485 * @hw: Pointer to the HW structure 486 - * Returns 486 + * Returns: 487 487 * 0: Successful. 488 488 * Negative value: Failed. 489 489 */ ··· 639 639 /** 640 640 * pch_gbe_alloc_queues - Allocate memory for all rings 641 641 * @adapter: Board private structure to initialize 642 - * Returns 642 + * Returns: 643 643 * 0: Successfully 644 644 * Negative value: Failed 645 645 */ ··· 670 670 /** 671 671 * pch_gbe_init_phy - Initialize PHY 672 672 * @adapter: Board private structure to initialize 673 - * Returns 673 + * Returns: 674 674 * 0: Successfully 675 675 * Negative value: Failed 676 676 */ ··· 720 720 * @netdev: Network interface device structure 721 721 * @addr: Phy ID 722 722 * @reg: Access location 723 - * Returns 723 + * Returns: 724 724 * 0: Successfully 725 725 * Negative value: Failed 726 726 */ ··· 1364 1364 * pch_gbe_intr - Interrupt Handler 1365 1365 * @irq: Interrupt number 1366 1366 * @data: Pointer to a network interface device structure 1367 - * Returns 1367 + * Returns: 1368 1368 * - IRQ_HANDLED: Our interrupt 1369 1369 * - IRQ_NONE: Not our interrupt 1370 1370 */ ··· 1566 1566 * pch_gbe_clean_tx - Reclaim resources after transmit completes 1567 1567 * @adapter: Board private structure 1568 1568 * @tx_ring: Tx descriptor ring 1569 - * Returns 1569 + * Returns: 1570 1570 * true: Cleaned the descriptor 1571 1571 * false: Not cleaned the descriptor 1572 1572 */ ··· 1660 1660 * @rx_ring: Rx descriptor ring 1661 1661 * @work_done: Completed count 1662 1662 * @work_to_do: Request count 1663 - * Returns 1663 + * Returns: 1664 1664 * true: Cleaned the descriptor 1665 1665 * false: Not cleaned the descriptor 1666 1666 */ ··· 1775 1775 * pch_gbe_setup_tx_resources - Allocate Tx resources (Descriptors) 1776 1776 * @adapter: Board private structure 1777 1777 * @tx_ring: Tx descriptor ring (for a specific queue) to setup 1778 - * Returns 1778 + * Returns: 1779 1779 * 0: Successfully 1780 1780 * Negative value: Failed 1781 1781 */ ··· 1822 1822 * pch_gbe_setup_rx_resources - Allocate Rx resources (Descriptors) 1823 1823 * @adapter: Board private structure 1824 1824 * @rx_ring: Rx descriptor ring (for a specific queue) to setup 1825 - * Returns 1825 + * Returns: 1826 1826 * 0: Successfully 1827 1827 * Negative value: Failed 1828 1828 */ ··· 1899 1899 /** 1900 1900 * pch_gbe_request_irq - Allocate an interrupt line 1901 1901 * @adapter: Board private structure 1902 - * Returns 1902 + * Returns: 1903 1903 * 0: Successfully 1904 1904 * Negative value: Failed 1905 1905 */ ··· 1932 1932 /** 1933 1933 * pch_gbe_up - Up GbE network device 1934 1934 * @adapter: Board private structure 1935 - * Returns 1935 + * Returns: 1936 1936 * 0: Successfully 1937 1937 * Negative value: Failed 1938 1938 */ ··· 2018 2018 /** 2019 2019 * pch_gbe_sw_init - Initialize general software structures (struct pch_gbe_adapter) 2020 2020 * @adapter: Board private structure to initialize 2021 - * Returns 2021 + * Returns: 2022 2022 * 0: Successfully 2023 2023 * Negative value: Failed 2024 2024 */ ··· 2057 2057 /** 2058 2058 * pch_gbe_open - Called when a network interface is made active 2059 2059 * @netdev: Network interface device structure 2060 - * Returns 2060 + * Returns: 2061 2061 * 0: Successfully 2062 2062 * Negative value: Failed 2063 2063 */ ··· 2097 2097 /** 2098 2098 * pch_gbe_stop - Disables a network interface 2099 2099 * @netdev: Network interface device structure 2100 - * Returns 2100 + * Returns: 2101 2101 * 0: Successfully 2102 2102 */ 2103 2103 static int pch_gbe_stop(struct net_device *netdev) ··· 2117 2117 * pch_gbe_xmit_frame - Packet transmitting start 2118 2118 * @skb: Socket buffer structure 2119 2119 * @netdev: Network interface device structure 2120 - * Returns 2120 + * Returns: 2121 2121 * - NETDEV_TX_OK: Normal end 2122 2122 * - NETDEV_TX_BUSY: Error end 2123 2123 */ ··· 2225 2225 * pch_gbe_set_mac - Change the Ethernet Address of the NIC 2226 2226 * @netdev: Network interface device structure 2227 2227 * @addr: Pointer to an address structure 2228 - * Returns 2228 + * Returns: 2229 2229 * 0: Successfully 2230 2230 * -EADDRNOTAVAIL: Failed 2231 2231 */ ··· 2256 2256 * pch_gbe_change_mtu - Change the Maximum Transfer Unit 2257 2257 * @netdev: Network interface device structure 2258 2258 * @new_mtu: New value for maximum frame size 2259 - * Returns 2259 + * Returns: 2260 2260 * 0: Successfully 2261 2261 * -EINVAL: Failed 2262 2262 */ ··· 2309 2309 * pch_gbe_set_features - Reset device after features changed 2310 2310 * @netdev: Network interface device structure 2311 2311 * @features: New features 2312 - * Returns 2312 + * Returns: 2313 2313 * 0: HW state updated successfully 2314 2314 */ 2315 2315 static int pch_gbe_set_features(struct net_device *netdev, ··· 2334 2334 * @netdev: Network interface device structure 2335 2335 * @ifr: Pointer to ifr structure 2336 2336 * @cmd: Control command 2337 - * Returns 2337 + * Returns: 2338 2338 * 0: Successfully 2339 2339 * Negative value: Failed 2340 2340 */ ··· 2369 2369 * pch_gbe_napi_poll - NAPI receive and transfer polling callback 2370 2370 * @napi: Pointer of polling device struct 2371 2371 * @budget: The maximum number of a packet 2372 - * Returns 2372 + * Returns: 2373 2373 * false: Exit the polling mode 2374 2374 * true: Continue the polling mode 2375 2375 */
+2 -2
drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_param.c
··· 139 139 /** 140 140 * pch_gbe_option - Force the MAC's flow control settings 141 141 * @hw: Pointer to the HW structure 142 - * Returns 142 + * Returns: 143 143 * 0: Successful. 144 144 * Negative value: Failed. 145 145 */ ··· 220 220 * @value: value 221 221 * @opt: option 222 222 * @adapter: Board private structure 223 - * Returns 223 + * Returns: 224 224 * 0: Successful. 225 225 * Negative value: Failed. 226 226 */
+1 -1
drivers/net/ethernet/sfc/net_driver.h
··· 527 527 }; 528 528 529 529 /** 530 - * @enum efx_phy_mode - PHY operating mode flags 530 + * enum efx_phy_mode - PHY operating mode flags 531 531 * @PHY_MODE_NORMAL: on and should pass traffic 532 532 * @PHY_MODE_TX_DISABLED: on with TX disabled 533 533 * @PHY_MODE_LOW_POWER: set to low power through MDIO
+1
drivers/net/ethernet/sfc/rx.c
··· 336 336 /** 337 337 * efx_fast_push_rx_descriptors - push new RX descriptors quickly 338 338 * @rx_queue: RX descriptor queue 339 + * 339 340 * This will aim to fill the RX descriptor queue up to 340 341 * @rx_queue->@max_fill. If there is insufficient atomic 341 342 * memory to do so, a slow fill will be scheduled.
+3 -3
drivers/net/ethernet/smsc/smc911x.c
··· 773 773 return 1; 774 774 } 775 775 776 - /* 776 + /** 777 777 * smc911x_phy_reset - reset the phy 778 778 * @dev: net device 779 779 * @phy: phy address ··· 819 819 return reg & PMT_CTRL_PHY_RST_; 820 820 } 821 821 822 - /* 822 + /** 823 823 * smc911x_phy_powerdown - powerdown phy 824 824 * @dev: net device 825 825 * @phy: phy address ··· 837 837 SMC_SET_PHY_BMCR(lp, phy, bmcr); 838 838 } 839 839 840 - /* 840 + /** 841 841 * smc911x_phy_check_media - check the media status and adjust BMCR 842 842 * @dev: net device 843 843 * @init: set true for initialisation
+3 -3
drivers/net/ethernet/smsc/smc91x.c
··· 942 942 return 1; 943 943 } 944 944 945 - /* 945 + /** 946 946 * smc_phy_reset - reset the phy 947 947 * @dev: net device 948 948 * @phy: phy address ··· 976 976 return bmcr & BMCR_RESET; 977 977 } 978 978 979 - /* 979 + /** 980 980 * smc_phy_powerdown - powerdown phy 981 981 * @dev: net device 982 982 * ··· 1000 1000 smc_phy_write(dev, phy, MII_BMCR, bmcr | BMCR_PDOWN); 1001 1001 } 1002 1002 1003 - /* 1003 + /** 1004 1004 * smc_phy_check_media - check the media status and adjust TCR 1005 1005 * @dev: net device 1006 1006 * @init: set true for initialisation
+1 -1
drivers/net/ethernet/stmicro/stmmac/stmmac_pci.c
··· 125 125 } 126 126 127 127 /** 128 - * stmmac_dvr_remove 128 + * stmmac_pci_remove 129 129 * 130 130 * @pdev: platform device pointer 131 131 * Description: this function calls the main to free the net resources
+103 -74
drivers/net/ethernet/tehuti/tehuti.c
··· 137 137 #define bdx_disable_interrupts(priv) \ 138 138 do { WRITE_REG(priv, regIMR, 0); } while (0) 139 139 140 - /* bdx_fifo_init 141 - * create TX/RX descriptor fifo for host-NIC communication. 140 + /** 141 + * bdx_fifo_init - create TX/RX descriptor fifo for host-NIC communication. 142 + * @priv: NIC private structure 143 + * @f: fifo to initialize 144 + * @fsz_type: fifo size type: 0-4KB, 1-8KB, 2-16KB, 3-32KB 145 + * @reg_XXX: offsets of registers relative to base address 146 + * 142 147 * 1K extra space is allocated at the end of the fifo to simplify 143 148 * processing of descriptors that wraps around fifo's end 144 - * @priv - NIC private structure 145 - * @f - fifo to initialize 146 - * @fsz_type - fifo size type: 0-4KB, 1-8KB, 2-16KB, 3-32KB 147 - * @reg_XXX - offsets of registers relative to base address 148 149 * 149 150 * Returns 0 on success, negative value on failure 150 151 * ··· 178 177 RET(0); 179 178 } 180 179 181 - /* bdx_fifo_free - free all resources used by fifo 182 - * @priv - NIC private structure 183 - * @f - fifo to release 180 + /** 181 + * bdx_fifo_free - free all resources used by fifo 182 + * @priv: NIC private structure 183 + * @f: fifo to release 184 184 */ 185 185 static void bdx_fifo_free(struct bdx_priv *priv, struct fifo *f) 186 186 { ··· 194 192 RET(); 195 193 } 196 194 197 - /* 195 + /** 198 196 * bdx_link_changed - notifies OS about hw link state. 199 - * @bdx_priv - hw adapter structure 197 + * @priv: hw adapter structure 200 198 */ 201 199 static void bdx_link_changed(struct bdx_priv *priv) 202 200 { ··· 235 233 236 234 } 237 235 238 - /* bdx_isr - Interrupt Service Routine for Bordeaux NIC 239 - * @irq - interrupt number 240 - * @ndev - network device 241 - * @regs - CPU registers 236 + /** 237 + * bdx_isr_napi - Interrupt Service Routine for Bordeaux NIC 238 + * @irq: interrupt number 239 + * @dev: network device 242 240 * 243 241 * Return IRQ_NONE if it was not our interrupt, IRQ_HANDLED - otherwise 244 242 * ··· 309 307 return work_done; 310 308 } 311 309 312 - /* bdx_fw_load - loads firmware to NIC 313 - * @priv - NIC private structure 310 + /** 311 + * bdx_fw_load - loads firmware to NIC 312 + * @priv: NIC private structure 313 + * 314 314 * Firmware is loaded via TXD fifo, so it must be initialized first. 315 315 * Firware must be loaded once per NIC not per PCI device provided by NIC (NIC 316 316 * can have few of them). So all drivers use semaphore register to choose one ··· 384 380 RET(); 385 381 } 386 382 387 - /* bdx_hw_start - inits registers and starts HW's Rx and Tx engines 388 - * @priv - NIC private structure 383 + /** 384 + * bdx_hw_start - inits registers and starts HW's Rx and Tx engines 385 + * @priv: NIC private structure 389 386 */ 390 387 static int bdx_hw_start(struct bdx_priv *priv) 391 388 { ··· 696 691 RET(-EOPNOTSUPP); 697 692 } 698 693 699 - /* 694 + /** 700 695 * __bdx_vlan_rx_vid - private helper for adding/killing VLAN vid 701 - * by passing VLAN filter table to hardware 702 - * @ndev network device 703 - * @vid VLAN vid 704 - * @op add or kill operation 696 + * @ndev: network device 697 + * @vid: VLAN vid 698 + * @op: add or kill operation 699 + * 700 + * Passes VLAN filter table to hardware 705 701 */ 706 702 static void __bdx_vlan_rx_vid(struct net_device *ndev, uint16_t vid, int enable) 707 703 { ··· 728 722 RET(); 729 723 } 730 724 731 - /* 725 + /** 732 726 * bdx_vlan_rx_add_vid - kernel hook for adding VLAN vid to hw filtering table 733 - * @ndev network device 734 - * @vid VLAN vid to add 727 + * @ndev: network device 728 + * @vid: VLAN vid to add 735 729 */ 736 730 static int bdx_vlan_rx_add_vid(struct net_device *ndev, uint16_t vid) 737 731 { ··· 739 733 return 0; 740 734 } 741 735 742 - /* 736 + /** 743 737 * bdx_vlan_rx_kill_vid - kernel hook for killing VLAN vid in hw filtering table 744 - * @ndev network device 745 - * @vid VLAN vid to kill 738 + * @ndev: network device 739 + * @vid: VLAN vid to kill 746 740 */ 747 741 static int bdx_vlan_rx_kill_vid(struct net_device *ndev, unsigned short vid) 748 742 { ··· 980 974 * Rx Init * 981 975 *************************************************************************/ 982 976 983 - /* bdx_rx_init - initialize RX all related HW and SW resources 984 - * @priv - NIC private structure 977 + /** 978 + * bdx_rx_init - initialize RX all related HW and SW resources 979 + * @priv: NIC private structure 985 980 * 986 981 * Returns 0 on success, negative value on failure 987 982 * ··· 1023 1016 return -ENOMEM; 1024 1017 } 1025 1018 1026 - /* bdx_rx_free_skbs - frees and unmaps all skbs allocated for the fifo 1027 - * @priv - NIC private structure 1028 - * @f - RXF fifo 1019 + /** 1020 + * bdx_rx_free_skbs - frees and unmaps all skbs allocated for the fifo 1021 + * @priv: NIC private structure 1022 + * @f: RXF fifo 1029 1023 */ 1030 1024 static void bdx_rx_free_skbs(struct bdx_priv *priv, struct rxf_fifo *f) 1031 1025 { ··· 1053 1045 } 1054 1046 } 1055 1047 1056 - /* bdx_rx_free - release all Rx resources 1057 - * @priv - NIC private structure 1048 + /** 1049 + * bdx_rx_free - release all Rx resources 1050 + * @priv: NIC private structure 1051 + * 1058 1052 * It assumes that Rx is desabled in HW 1059 1053 */ 1060 1054 static void bdx_rx_free(struct bdx_priv *priv) ··· 1077 1067 * Rx Engine * 1078 1068 *************************************************************************/ 1079 1069 1080 - /* bdx_rx_alloc_skbs - fill rxf fifo with new skbs 1081 - * @priv - nic's private structure 1082 - * @f - RXF fifo that needs skbs 1070 + /** 1071 + * bdx_rx_alloc_skbs - fill rxf fifo with new skbs 1072 + * @priv: nic's private structure 1073 + * @f: RXF fifo that needs skbs 1074 + * 1083 1075 * It allocates skbs, build rxf descs and push it (rxf descr) into rxf fifo. 1084 1076 * skb's virtual and physical addresses are stored in skb db. 1085 1077 * To calculate free space, func uses cached values of RPTR and WPTR ··· 1191 1179 RET(); 1192 1180 } 1193 1181 1194 - /* bdx_rx_receive - receives full packets from RXD fifo and pass them to OS 1182 + /** 1183 + * bdx_rx_receive - receives full packets from RXD fifo and pass them to OS 1195 1184 * NOTE: a special treatment is given to non-continuous descriptors 1196 1185 * that start near the end, wraps around and continue at the beginning. a second 1197 1186 * part is copied right after the first, and then descriptor is interpreted as 1198 1187 * normal. fifo has an extra space to allow such operations 1199 - * @priv - nic's private structure 1200 - * @f - RXF fifo that needs skbs 1188 + * @priv: nic's private structure 1189 + * @f: RXF fifo that needs skbs 1190 + * @budget: maximum number of packets to receive 1201 1191 */ 1202 1192 1203 1193 /* TBD: replace memcpy func call by explicite inline asm */ ··· 1389 1375 return db->size - taken; 1390 1376 } 1391 1377 1392 - /* __bdx_tx_ptr_next - helper function, increment read/write pointer + wrap 1393 - * @d - tx data base 1394 - * @ptr - read or write pointer 1378 + /** 1379 + * __bdx_tx_db_ptr_next - helper function, increment read/write pointer + wrap 1380 + * @db: tx data base 1381 + * @pptr: read or write pointer 1395 1382 */ 1396 1383 static inline void __bdx_tx_db_ptr_next(struct txdb *db, struct tx_map **pptr) 1397 1384 { ··· 1409 1394 *pptr = db->start; 1410 1395 } 1411 1396 1412 - /* bdx_tx_db_inc_rptr - increment read pointer 1413 - * @d - tx data base 1397 + /** 1398 + * bdx_tx_db_inc_rptr - increment read pointer 1399 + * @db: tx data base 1414 1400 */ 1415 1401 static inline void bdx_tx_db_inc_rptr(struct txdb *db) 1416 1402 { ··· 1419 1403 __bdx_tx_db_ptr_next(db, &db->rptr); 1420 1404 } 1421 1405 1422 - /* bdx_tx_db_inc_rptr - increment write pointer 1423 - * @d - tx data base 1406 + /** 1407 + * bdx_tx_db_inc_wptr - increment write pointer 1408 + * @db: tx data base 1424 1409 */ 1425 1410 static inline void bdx_tx_db_inc_wptr(struct txdb *db) 1426 1411 { ··· 1430 1413 a result of write */ 1431 1414 } 1432 1415 1433 - /* bdx_tx_db_init - creates and initializes tx db 1434 - * @d - tx data base 1435 - * @sz_type - size of tx fifo 1416 + /** 1417 + * bdx_tx_db_init - creates and initializes tx db 1418 + * @d: tx data base 1419 + * @sz_type: size of tx fifo 1420 + * 1436 1421 * Returns 0 on success, error code otherwise 1437 1422 */ 1438 1423 static int bdx_tx_db_init(struct txdb *d, int sz_type) ··· 1460 1441 return 0; 1461 1442 } 1462 1443 1463 - /* bdx_tx_db_close - closes tx db and frees all memory 1464 - * @d - tx data base 1444 + /** 1445 + * bdx_tx_db_close - closes tx db and frees all memory 1446 + * @d: tx data base 1465 1447 */ 1466 1448 static void bdx_tx_db_close(struct txdb *d) 1467 1449 { ··· 1483 1463 u16 qwords; /* qword = 64 bit */ 1484 1464 } txd_sizes[MAX_SKB_FRAGS + 1]; 1485 1465 1486 - /* txdb_map_skb - creates and stores dma mappings for skb's data blocks 1487 - * @priv - NIC private structure 1488 - * @skb - socket buffer to map 1466 + /** 1467 + * bdx_tx_map_skb - creates and stores dma mappings for skb's data blocks 1468 + * @priv: NIC private structure 1469 + * @skb: socket buffer to map 1470 + * @txdd: TX descriptor to use 1489 1471 * 1490 1472 * It makes dma mappings for skb's data blocks and writes them to PBL of 1491 1473 * new tx descriptor. It also stores them in the tx db, so they could be ··· 1584 1562 return -ENOMEM; 1585 1563 } 1586 1564 1587 - /* 1565 + /** 1588 1566 * bdx_tx_space - calculates available space in TX fifo 1589 - * @priv - NIC private structure 1567 + * @priv: NIC private structure 1568 + * 1590 1569 * Returns available space in TX fifo in bytes 1591 1570 */ 1592 1571 static inline int bdx_tx_space(struct bdx_priv *priv) ··· 1602 1579 return fsize; 1603 1580 } 1604 1581 1605 - /* bdx_tx_transmit - send packet to NIC 1606 - * @skb - packet to send 1607 - * ndev - network device assigned to NIC 1582 + /** 1583 + * bdx_tx_transmit - send packet to NIC 1584 + * @skb: packet to send 1585 + * @ndev: network device assigned to NIC 1608 1586 * Return codes: 1609 1587 * o NETDEV_TX_OK everything ok. 1610 1588 * o NETDEV_TX_BUSY Cannot transmit packet, try later ··· 1723 1699 return NETDEV_TX_OK; 1724 1700 } 1725 1701 1726 - /* bdx_tx_cleanup - clean TXF fifo, run in the context of IRQ. 1727 - * @priv - bdx adapter 1702 + /** 1703 + * bdx_tx_cleanup - clean TXF fifo, run in the context of IRQ. 1704 + * @priv: bdx adapter 1705 + * 1728 1706 * It scans TXF fifo for descriptors, frees DMA mappings and reports to OS 1729 1707 * that those packets were sent 1730 1708 */ ··· 1787 1761 spin_unlock(&priv->tx_lock); 1788 1762 } 1789 1763 1790 - /* bdx_tx_free_skbs - frees all skbs from TXD fifo. 1764 + /** 1765 + * bdx_tx_free_skbs - frees all skbs from TXD fifo. 1791 1766 * It gets called when OS stops this dev, eg upon "ifconfig down" or rmmod 1792 1767 */ 1793 1768 static void bdx_tx_free_skbs(struct bdx_priv *priv) ··· 1817 1790 bdx_tx_db_close(&priv->txdb); 1818 1791 } 1819 1792 1820 - /* bdx_tx_push_desc - push descriptor to TxD fifo 1821 - * @priv - NIC private structure 1822 - * @data - desc's data 1823 - * @size - desc's size 1793 + /** 1794 + * bdx_tx_push_desc - push descriptor to TxD fifo 1795 + * @priv: NIC private structure 1796 + * @data: desc's data 1797 + * @size: desc's size 1824 1798 * 1825 1799 * Pushes desc to TxD fifo and overlaps it if needed. 1826 1800 * NOTE: this func does not check for available space. this is responsibility ··· 1847 1819 WRITE_REG(priv, f->m.reg_WPTR, f->m.wptr & TXF_WPTR_WR_PTR); 1848 1820 } 1849 1821 1850 - /* bdx_tx_push_desc_safe - push descriptor to TxD fifo in a safe way 1851 - * @priv - NIC private structure 1852 - * @data - desc's data 1853 - * @size - desc's size 1822 + /** 1823 + * bdx_tx_push_desc_safe - push descriptor to TxD fifo in a safe way 1824 + * @priv: NIC private structure 1825 + * @data: desc's data 1826 + * @size: desc's size 1854 1827 * 1855 1828 * NOTE: this func does check for available space and, if necessary, waits for 1856 1829 * NIC to read existing data before writing new one.
+35 -35
drivers/net/ethernet/ti/davinci_emac.c
··· 375 375 #define emac_ctrl_write(reg, val) iowrite32(val, (priv->ctrl_base + (reg))) 376 376 377 377 /** 378 - * emac_dump_regs: Dump important EMAC registers to debug terminal 378 + * emac_dump_regs - Dump important EMAC registers to debug terminal 379 379 * @priv: The DaVinci EMAC private adapter structure 380 380 * 381 381 * Executes ethtool set cmd & sets phy mode ··· 466 466 } 467 467 468 468 /** 469 - * emac_get_drvinfo: Get EMAC driver information 469 + * emac_get_drvinfo - Get EMAC driver information 470 470 * @ndev: The DaVinci EMAC network adapter 471 471 * @info: ethtool info structure containing name and version 472 472 * ··· 481 481 } 482 482 483 483 /** 484 - * emac_get_settings: Get EMAC settings 484 + * emac_get_settings - Get EMAC settings 485 485 * @ndev: The DaVinci EMAC network adapter 486 486 * @ecmd: ethtool command 487 487 * ··· 500 500 } 501 501 502 502 /** 503 - * emac_set_settings: Set EMAC settings 503 + * emac_set_settings - Set EMAC settings 504 504 * @ndev: The DaVinci EMAC network adapter 505 505 * @ecmd: ethtool command 506 506 * ··· 518 518 } 519 519 520 520 /** 521 - * emac_get_coalesce : Get interrupt coalesce settings for this device 521 + * emac_get_coalesce - Get interrupt coalesce settings for this device 522 522 * @ndev : The DaVinci EMAC network adapter 523 523 * @coal : ethtool coalesce settings structure 524 524 * ··· 536 536 } 537 537 538 538 /** 539 - * emac_set_coalesce : Set interrupt coalesce settings for this device 539 + * emac_set_coalesce - Set interrupt coalesce settings for this device 540 540 * @ndev : The DaVinci EMAC network adapter 541 541 * @coal : ethtool coalesce settings structure 542 542 * ··· 631 631 }; 632 632 633 633 /** 634 - * emac_update_phystatus: Update Phy status 634 + * emac_update_phystatus - Update Phy status 635 635 * @priv: The DaVinci EMAC private adapter structure 636 636 * 637 637 * Updates phy status and takes action for network queue if required ··· 697 697 } 698 698 699 699 /** 700 - * hash_get: Calculate hash value from mac address 700 + * hash_get - Calculate hash value from mac address 701 701 * @addr: mac address to delete from hash table 702 702 * 703 703 * Calculates hash value from mac address ··· 723 723 } 724 724 725 725 /** 726 - * hash_add: Hash function to add mac addr from hash table 726 + * hash_add - Hash function to add mac addr from hash table 727 727 * @priv: The DaVinci EMAC private adapter structure 728 - * mac_addr: mac address to delete from hash table 728 + * @mac_addr: mac address to delete from hash table 729 729 * 730 730 * Adds mac address to the internal hash table 731 731 * ··· 765 765 } 766 766 767 767 /** 768 - * hash_del: Hash function to delete mac addr from hash table 768 + * hash_del - Hash function to delete mac addr from hash table 769 769 * @priv: The DaVinci EMAC private adapter structure 770 - * mac_addr: mac address to delete from hash table 770 + * @mac_addr: mac address to delete from hash table 771 771 * 772 772 * Removes mac address from the internal hash table 773 773 * ··· 807 807 #define EMAC_ALL_MULTI_CLR 3 808 808 809 809 /** 810 - * emac_add_mcast: Set multicast address in the EMAC adapter (Internal) 810 + * emac_add_mcast - Set multicast address in the EMAC adapter (Internal) 811 811 * @priv: The DaVinci EMAC private adapter structure 812 812 * @action: multicast operation to perform 813 813 * mac_addr: mac address to set ··· 855 855 } 856 856 857 857 /** 858 - * emac_dev_mcast_set: Set multicast address in the EMAC adapter 858 + * emac_dev_mcast_set - Set multicast address in the EMAC adapter 859 859 * @ndev: The DaVinci EMAC network adapter 860 860 * 861 861 * Set multicast addresses in EMAC adapter ··· 901 901 *************************************************************************/ 902 902 903 903 /** 904 - * emac_int_disable: Disable EMAC module interrupt (from adapter) 904 + * emac_int_disable - Disable EMAC module interrupt (from adapter) 905 905 * @priv: The DaVinci EMAC private adapter structure 906 906 * 907 907 * Disable EMAC interrupt on the adapter ··· 931 931 } 932 932 933 933 /** 934 - * emac_int_enable: Enable EMAC module interrupt (from adapter) 934 + * emac_int_enable - Enable EMAC module interrupt (from adapter) 935 935 * @priv: The DaVinci EMAC private adapter structure 936 936 * 937 937 * Enable EMAC interrupt on the adapter ··· 967 967 } 968 968 969 969 /** 970 - * emac_irq: EMAC interrupt handler 970 + * emac_irq - EMAC interrupt handler 971 971 * @irq: interrupt number 972 972 * @dev_id: EMAC network adapter data structure ptr 973 973 * ··· 1060 1060 } 1061 1061 1062 1062 /** 1063 - * emac_dev_xmit: EMAC Transmit function 1063 + * emac_dev_xmit - EMAC Transmit function 1064 1064 * @skb: SKB pointer 1065 1065 * @ndev: The DaVinci EMAC network adapter 1066 1066 * ··· 1111 1111 } 1112 1112 1113 1113 /** 1114 - * emac_dev_tx_timeout: EMAC Transmit timeout function 1114 + * emac_dev_tx_timeout - EMAC Transmit timeout function 1115 1115 * @ndev: The DaVinci EMAC network adapter 1116 1116 * 1117 1117 * Called when system detects that a skb timeout period has expired ··· 1138 1138 } 1139 1139 1140 1140 /** 1141 - * emac_set_type0addr: Set EMAC Type0 mac address 1141 + * emac_set_type0addr - Set EMAC Type0 mac address 1142 1142 * @priv: The DaVinci EMAC private adapter structure 1143 1143 * @ch: RX channel number 1144 1144 * @mac_addr: MAC address to set in device ··· 1165 1165 } 1166 1166 1167 1167 /** 1168 - * emac_set_type1addr: Set EMAC Type1 mac address 1168 + * emac_set_type1addr - Set EMAC Type1 mac address 1169 1169 * @priv: The DaVinci EMAC private adapter structure 1170 1170 * @ch: RX channel number 1171 1171 * @mac_addr: MAC address to set in device ··· 1187 1187 } 1188 1188 1189 1189 /** 1190 - * emac_set_type2addr: Set EMAC Type2 mac address 1190 + * emac_set_type2addr - Set EMAC Type2 mac address 1191 1191 * @priv: The DaVinci EMAC private adapter structure 1192 1192 * @ch: RX channel number 1193 1193 * @mac_addr: MAC address to set in device ··· 1213 1213 } 1214 1214 1215 1215 /** 1216 - * emac_setmac: Set mac address in the adapter (internal function) 1216 + * emac_setmac - Set mac address in the adapter (internal function) 1217 1217 * @priv: The DaVinci EMAC private adapter structure 1218 1218 * @ch: RX channel number 1219 1219 * @mac_addr: MAC address to set in device ··· 1242 1242 } 1243 1243 1244 1244 /** 1245 - * emac_dev_setmac_addr: Set mac address in the adapter 1245 + * emac_dev_setmac_addr - Set mac address in the adapter 1246 1246 * @ndev: The DaVinci EMAC network adapter 1247 1247 * @addr: MAC address to set in device 1248 1248 * ··· 1277 1277 } 1278 1278 1279 1279 /** 1280 - * emac_hw_enable: Enable EMAC hardware for packet transmission/reception 1280 + * emac_hw_enable - Enable EMAC hardware for packet transmission/reception 1281 1281 * @priv: The DaVinci EMAC private adapter structure 1282 1282 * 1283 1283 * Enables EMAC hardware for packet processing - enables PHY, enables RX ··· 1347 1347 } 1348 1348 1349 1349 /** 1350 - * emac_poll: EMAC NAPI Poll function 1350 + * emac_poll - EMAC NAPI Poll function 1351 1351 * @ndev: The DaVinci EMAC network adapter 1352 1352 * @budget: Number of receive packets to process (as told by NAPI layer) 1353 1353 * ··· 1430 1430 1431 1431 #ifdef CONFIG_NET_POLL_CONTROLLER 1432 1432 /** 1433 - * emac_poll_controller: EMAC Poll controller function 1433 + * emac_poll_controller - EMAC Poll controller function 1434 1434 * @ndev: The DaVinci EMAC network adapter 1435 1435 * 1436 1436 * Polled functionality used by netconsole and others in non interrupt mode ··· 1489 1489 *************************************************************************/ 1490 1490 1491 1491 /** 1492 - * emac_devioctl: EMAC adapter ioctl 1492 + * emac_devioctl - EMAC adapter ioctl 1493 1493 * @ndev: The DaVinci EMAC network adapter 1494 1494 * @ifrq: request parameter 1495 1495 * @cmd: command parameter ··· 1516 1516 } 1517 1517 1518 1518 /** 1519 - * emac_dev_open: EMAC device open 1519 + * emac_dev_open - EMAC device open 1520 1520 * @ndev: The DaVinci EMAC network adapter 1521 1521 * 1522 1522 * Called when system wants to start the interface. We init TX/RX channels ··· 1649 1649 } 1650 1650 1651 1651 /** 1652 - * emac_dev_stop: EMAC device stop 1652 + * emac_dev_stop - EMAC device stop 1653 1653 * @ndev: The DaVinci EMAC network adapter 1654 1654 * 1655 1655 * Called when system wants to stop or down the interface. We stop the network ··· 1691 1691 } 1692 1692 1693 1693 /** 1694 - * emac_dev_getnetstats: EMAC get statistics function 1694 + * emac_dev_getnetstats - EMAC get statistics function 1695 1695 * @ndev: The DaVinci EMAC network adapter 1696 1696 * 1697 1697 * Called when system wants to get statistics from the device. ··· 1763 1763 }; 1764 1764 1765 1765 /** 1766 - * davinci_emac_probe: EMAC device probe 1766 + * davinci_emac_probe - EMAC device probe 1767 1767 * @pdev: The DaVinci EMAC device that we are removing 1768 1768 * 1769 1769 * Called when probing for emac devicesr. We get details of instances and ··· 1949 1949 } 1950 1950 1951 1951 /** 1952 - * davinci_emac_remove: EMAC device remove 1952 + * davinci_emac_remove - EMAC device remove 1953 1953 * @pdev: The DaVinci EMAC device that we are removing 1954 1954 * 1955 1955 * Called when removing the device driver. We disable clock usage and release ··· 2029 2029 }; 2030 2030 2031 2031 /** 2032 - * davinci_emac_init: EMAC driver module init 2032 + * davinci_emac_init - EMAC driver module init 2033 2033 * 2034 2034 * Called when initializing the driver. We register the driver with 2035 2035 * the platform. ··· 2041 2041 late_initcall(davinci_emac_init); 2042 2042 2043 2043 /** 2044 - * davinci_emac_exit: EMAC driver module exit 2044 + * davinci_emac_exit - EMAC driver module exit 2045 2045 * 2046 2046 * Called when exiting the driver completely. We unregister the driver with 2047 2047 * the platform and exit
+4 -2
drivers/net/ethernet/toshiba/spider_net.c
··· 114 114 out_be32(card->regs + reg, value); 115 115 } 116 116 117 - /** spider_net_write_phy - write to phy register 117 + /** 118 + * spider_net_write_phy - write to phy register 118 119 * @netdev: adapter to be written to 119 120 * @mii_id: id of MII 120 121 * @reg: PHY register ··· 138 137 spider_net_write_reg(card, SPIDER_NET_GPCWOPCMD, writevalue); 139 138 } 140 139 141 - /** spider_net_read_phy - read from phy register 140 + /** 141 + * spider_net_read_phy - read from phy register 142 142 * @netdev: network device to be read from 143 143 * @mii_id: id of MII 144 144 * @reg: PHY register
+1 -1
drivers/net/ethernet/xilinx/ll_temac_main.c
··· 197 197 #endif 198 198 199 199 /** 200 - * * temac_dma_bd_release - Release buffer descriptor rings 200 + * temac_dma_bd_release - Release buffer descriptor rings 201 201 */ 202 202 static void temac_dma_bd_release(struct net_device *ndev) 203 203 {