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>
This commit is contained in:
Ben Hutchings
committed by
David S. Miller
David S. Miller
parent
ae86b9e384
commit
49ce9c2cda
@@ -166,7 +166,7 @@ static void atl1c_reset_pcie(struct atl1c_hw *hw, u32 flag)
|
||||
msleep(5);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_irq_enable - Enable default interrupt generation settings
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
@@ -179,7 +179,7 @@ static inline void atl1c_irq_enable(struct atl1c_adapter *adapter)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_irq_disable - Mask off interrupt generation on the NIC
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
@@ -192,7 +192,7 @@ static inline void atl1c_irq_disable(struct atl1c_adapter *adapter)
|
||||
synchronize_irq(adapter->pdev->irq);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_irq_reset - reset interrupt confiure on the NIC
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
@@ -220,7 +220,7 @@ static u32 atl1c_wait_until_idle(struct atl1c_hw *hw, u32 modu_ctrl)
|
||||
return data;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_phy_config - Timer Call-back
|
||||
* @data: pointer to netdev cast into an unsigned long
|
||||
*/
|
||||
@@ -361,7 +361,7 @@ static void atl1c_del_timer(struct atl1c_adapter *adapter)
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_tx_timeout - Respond to a Tx Hang
|
||||
* @netdev: network interface device structure
|
||||
*/
|
||||
@@ -374,7 +374,7 @@ static void atl1c_tx_timeout(struct net_device *netdev)
|
||||
schedule_work(&adapter->common_task);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_set_multi - Multicast and Promiscuous mode set
|
||||
* @netdev: network interface device structure
|
||||
*
|
||||
@@ -453,7 +453,7 @@ static void atl1c_restore_vlan(struct atl1c_adapter *adapter)
|
||||
atl1c_vlan_mode(adapter->netdev, adapter->netdev->features);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_set_mac - Change the Ethernet Address of the NIC
|
||||
* @netdev: network interface device structure
|
||||
* @p: pointer to an address structure
|
||||
@@ -518,7 +518,7 @@ static int atl1c_set_features(struct net_device *netdev,
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_change_mtu - Change the Maximum Transfer Unit
|
||||
* @netdev: network interface device structure
|
||||
* @new_mtu: new value for maximum frame size
|
||||
@@ -577,12 +577,6 @@ static void atl1c_mdio_write(struct net_device *netdev, int phy_id,
|
||||
atl1c_write_phy_reg(&adapter->hw, reg_num, val);
|
||||
}
|
||||
|
||||
/*
|
||||
* atl1c_mii_ioctl -
|
||||
* @netdev:
|
||||
* @ifreq:
|
||||
* @cmd:
|
||||
*/
|
||||
static int atl1c_mii_ioctl(struct net_device *netdev,
|
||||
struct ifreq *ifr, int cmd)
|
||||
{
|
||||
@@ -633,12 +627,6 @@ out:
|
||||
return retval;
|
||||
}
|
||||
|
||||
/*
|
||||
* atl1c_ioctl -
|
||||
* @netdev:
|
||||
* @ifreq:
|
||||
* @cmd:
|
||||
*/
|
||||
static int atl1c_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
|
||||
{
|
||||
switch (cmd) {
|
||||
@@ -651,7 +639,7 @@ static int atl1c_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_alloc_queues - Allocate memory for all rings
|
||||
* @adapter: board private structure to initialize
|
||||
*
|
||||
@@ -755,7 +743,7 @@ static void __devinit atl1c_patch_assign(struct atl1c_hw *hw)
|
||||
i++;
|
||||
}
|
||||
}
|
||||
/*
|
||||
/**
|
||||
* atl1c_sw_init - Initialize general software structures (struct atl1c_adapter)
|
||||
* @adapter: board private structure to initialize
|
||||
*
|
||||
@@ -853,7 +841,7 @@ static inline void atl1c_clean_buffer(struct pci_dev *pdev,
|
||||
buffer_info->skb = NULL;
|
||||
ATL1C_SET_BUFFER_STATE(buffer_info, ATL1C_BUFFER_FREE);
|
||||
}
|
||||
/*
|
||||
/**
|
||||
* atl1c_clean_tx_ring - Free Tx-skb
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
@@ -878,7 +866,7 @@ static void atl1c_clean_tx_ring(struct atl1c_adapter *adapter,
|
||||
tpd_ring->next_to_use = 0;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_clean_rx_ring - Free rx-reservation skbs
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
@@ -931,7 +919,7 @@ static void atl1c_init_ring_ptrs(struct atl1c_adapter *adapter)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_free_ring_resources - Free Tx / RX descriptor Resources
|
||||
* @adapter: board private structure
|
||||
*
|
||||
@@ -954,7 +942,7 @@ static void atl1c_free_ring_resources(struct atl1c_adapter *adapter)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_setup_mem_resources - allocate Tx / RX descriptor resources
|
||||
* @adapter: board private structure
|
||||
*
|
||||
@@ -1363,7 +1351,7 @@ static void atl1c_set_aspm(struct atl1c_hw *hw, u16 link_speed)
|
||||
return;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_configure - Configure Transmit&Receive Unit after Reset
|
||||
* @adapter: board private structure
|
||||
*
|
||||
@@ -1477,7 +1465,7 @@ static void atl1c_update_hw_stats(struct atl1c_adapter *adapter)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_get_stats - Get System Network Statistics
|
||||
* @netdev: network interface device structure
|
||||
*
|
||||
@@ -1558,11 +1546,10 @@ static bool atl1c_clean_tx_irq(struct atl1c_adapter *adapter,
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_intr - Interrupt Handler
|
||||
* @irq: interrupt number
|
||||
* @data: pointer to a network interface device structure
|
||||
* @pt_regs: CPU registers structure
|
||||
*/
|
||||
static irqreturn_t atl1c_intr(int irq, void *data)
|
||||
{
|
||||
@@ -1813,9 +1800,8 @@ rrs_checked:
|
||||
atl1c_alloc_rx_buffer(adapter);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_clean - NAPI Rx polling callback
|
||||
* @adapter: board private structure
|
||||
*/
|
||||
static int atl1c_clean(struct napi_struct *napi, int budget)
|
||||
{
|
||||
@@ -2270,7 +2256,7 @@ static void atl1c_down(struct atl1c_adapter *adapter)
|
||||
atl1c_reset_dma_ring(adapter);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_open - Called when a network interface is made active
|
||||
* @netdev: network interface device structure
|
||||
*
|
||||
@@ -2309,7 +2295,7 @@ err_up:
|
||||
return err;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_close - Disables a network interface
|
||||
* @netdev: network interface device structure
|
||||
*
|
||||
@@ -2432,7 +2418,7 @@ static int atl1c_init_netdev(struct net_device *netdev, struct pci_dev *pdev)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_probe - Device Initialization Routine
|
||||
* @pdev: PCI device information struct
|
||||
* @ent: entry in atl1c_pci_tbl
|
||||
@@ -2579,7 +2565,7 @@ err_dma:
|
||||
return err;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_remove - Device Removal Routine
|
||||
* @pdev: PCI device information struct
|
||||
*
|
||||
@@ -2605,7 +2591,7 @@ static void __devexit atl1c_remove(struct pci_dev *pdev)
|
||||
free_netdev(netdev);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_io_error_detected - called when PCI error is detected
|
||||
* @pdev: Pointer to PCI device
|
||||
* @state: The current pci connection state
|
||||
@@ -2633,7 +2619,7 @@ static pci_ers_result_t atl1c_io_error_detected(struct pci_dev *pdev,
|
||||
return PCI_ERS_RESULT_NEED_RESET;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_io_slot_reset - called after the pci bus has been reset.
|
||||
* @pdev: Pointer to PCI device
|
||||
*
|
||||
@@ -2661,7 +2647,7 @@ static pci_ers_result_t atl1c_io_slot_reset(struct pci_dev *pdev)
|
||||
return PCI_ERS_RESULT_RECOVERED;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_io_resume - called when traffic can start flowing again.
|
||||
* @pdev: Pointer to PCI device
|
||||
*
|
||||
@@ -2704,7 +2690,7 @@ static struct pci_driver atl1c_driver = {
|
||||
.driver.pm = &atl1c_pm_ops,
|
||||
};
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_init_module - Driver Registration Routine
|
||||
*
|
||||
* atl1c_init_module is the first routine called when the driver is
|
||||
@@ -2715,7 +2701,7 @@ static int __init atl1c_init_module(void)
|
||||
return pci_register_driver(&atl1c_driver);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* atl1c_exit_module - Driver Exit Cleanup Routine
|
||||
*
|
||||
* atl1c_exit_module is called just before the driver is removed
|
||||
|
||||
Reference in New Issue
Block a user