Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 49ce9c2c authored by Ben Hutchings's avatar Ben Hutchings Committed by David S. Miller
Browse files

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: default avatarBen Hutchings <bhutchings@solarflare.com>
Acked-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent ae86b9e3

drivers/net/ethernet/3com/3c501.c

+1 −1
Original line number Diff line number Diff line
@@ -143,7 +143,7 @@ static int irq = 5; 
static int mem_start;



/**

 * el1_probe:		-	probe for a 3c501

 * el1_probe		-	probe for a 3c501

 * @dev: The device structure passed in to probe.

 *

 * This can be called from two places. The network layer will probe using

drivers/net/ethernet/atheros/atl1c/atl1c_main.c

+27 −41
Original line number Diff line number Diff line
@@ -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

drivers/net/ethernet/atheros/atl1e/atl1e_main.c

+28 −42
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ static const u16 atl1e_pay_load_size[] = { 
	128, 256, 512, 1024, 2048, 4096,

};



/*

/**

 * atl1e_irq_enable - Enable default interrupt generation settings

 * @adapter: board private structure

 */
@@ -102,7 +102,7 @@ static inline void atl1e_irq_enable(struct atl1e_adapter *adapter) 
	}

}



/*

/**

 * atl1e_irq_disable - Mask off interrupt generation on the NIC

 * @adapter: board private structure

 */
@@ -114,7 +114,7 @@ static inline void atl1e_irq_disable(struct atl1e_adapter *adapter) 
	synchronize_irq(adapter->pdev->irq);

}



/*

/**

 * atl1e_irq_reset - reset interrupt confiure on the NIC

 * @adapter: board private structure

 */
@@ -126,7 +126,7 @@ static inline void atl1e_irq_reset(struct atl1e_adapter *adapter) 
	AT_WRITE_FLUSH(&adapter->hw);

}



/*

/**

 * atl1e_phy_config - Timer Call-back

 * @data: pointer to netdev cast into an unsigned long

 */
@@ -210,7 +210,7 @@ static int atl1e_check_link(struct atl1e_adapter *adapter) 
	return 0;

}



/*

/**

 * atl1e_link_chg_task - deal with link change event Out of interrupt context

 * @netdev: network interface device structure

 */
@@ -259,7 +259,7 @@ static void atl1e_cancel_work(struct atl1e_adapter *adapter) 
	cancel_work_sync(&adapter->link_chg_task);

}



/*

/**

 * atl1e_tx_timeout - Respond to a Tx Hang

 * @netdev: network interface device structure

 */
@@ -271,7 +271,7 @@ static void atl1e_tx_timeout(struct net_device *netdev) 
	schedule_work(&adapter->reset_task);

}



/*

/**

 * atl1e_set_multi - Multicast and Promiscuous mode set

 * @netdev: network interface device structure

 *
@@ -345,7 +345,7 @@ static void atl1e_restore_vlan(struct atl1e_adapter *adapter) 
	atl1e_vlan_mode(adapter->netdev, adapter->netdev->features);

}



/*

/**

 * atl1e_set_mac - Change the Ethernet Address of the NIC

 * @netdev: network interface device structure

 * @p: pointer to an address structure
@@ -397,7 +397,7 @@ static int atl1e_set_features(struct net_device *netdev, 
	return 0;

}



/*

/**

 * atl1e_change_mtu - Change the Maximum Transfer Unit

 * @netdev: network interface device structure

 * @new_mtu: new value for maximum frame size
@@ -449,12 +449,6 @@ static void atl1e_mdio_write(struct net_device *netdev, int phy_id, 
	atl1e_write_phy_reg(&adapter->hw, reg_num & MDIO_REG_ADDR_MASK, val);

}



/*

 * atl1e_mii_ioctl -

 * @netdev:

 * @ifreq:

 * @cmd:

 */

static int atl1e_mii_ioctl(struct net_device *netdev,

			   struct ifreq *ifr, int cmd)

{
@@ -505,12 +499,6 @@ out: 


}



/*

 * atl1e_ioctl -

 * @netdev:

 * @ifreq:

 * @cmd:

 */

static int atl1e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)

{

	switch (cmd) {
@@ -541,7 +529,7 @@ static void atl1e_setup_pcicmd(struct pci_dev *pdev) 
	msleep(1);

}



/*

/**

 * atl1e_alloc_queues - Allocate memory for all rings

 * @adapter: board private structure to initialize

 *
@@ -551,7 +539,7 @@ static int __devinit atl1e_alloc_queues(struct atl1e_adapter *adapter) 
	return 0;

}



/*

/**

 * atl1e_sw_init - Initialize general software structures (struct atl1e_adapter)

 * @adapter: board private structure to initialize

 *
@@ -635,7 +623,7 @@ static int __devinit atl1e_sw_init(struct atl1e_adapter *adapter) 
	return 0;

}



/*

/**

 * atl1e_clean_tx_ring - Free Tx-skb

 * @adapter: board private structure

 */
@@ -678,7 +666,7 @@ static void atl1e_clean_tx_ring(struct atl1e_adapter *adapter) 
				ring_count);

}



/*

/**

 * atl1e_clean_rx_ring - Free rx-reservation skbs

 * @adapter: board private structure

 */
@@ -761,7 +749,7 @@ static void atl1e_init_ring_ptrs(struct atl1e_adapter *adapter) 
	}

}



/*

/**

 * atl1e_free_ring_resources - Free Tx / RX descriptor Resources

 * @adapter: board private structure

 *
@@ -786,7 +774,7 @@ static void atl1e_free_ring_resources(struct atl1e_adapter *adapter) 
	}

}



/*

/**

 * atl1e_setup_mem_resources - allocate Tx / RX descriptor resources

 * @adapter: board private structure

 *
@@ -1075,7 +1063,7 @@ static void atl1e_setup_mac_ctrl(struct atl1e_adapter *adapter) 
	AT_WRITE_REG(hw, REG_MAC_CTRL, value);

}



/*

/**

 * atl1e_configure - Configure Transmit&Receive Unit after Reset

 * @adapter: board private structure

 *
@@ -1145,7 +1133,7 @@ static int atl1e_configure(struct atl1e_adapter *adapter) 
	return 0;

}



/*

/**

 * atl1e_get_stats - Get System Network Statistics

 * @netdev: network interface device structure

 *
@@ -1257,11 +1245,10 @@ static bool atl1e_clean_tx_irq(struct atl1e_adapter *adapter) 
	return true;

}



/*

/**

 * atl1e_intr - Interrupt Handler

 * @irq: interrupt number

 * @data: pointer to a network interface device structure

 * @pt_regs: CPU registers structure

 */

static irqreturn_t atl1e_intr(int irq, void *data)

{
@@ -1489,9 +1476,8 @@ fatal_err: 
		schedule_work(&adapter->reset_task);

}



/*

/**

 * atl1e_clean - NAPI Rx polling callback

 * @adapter: board private structure

 */

static int atl1e_clean(struct napi_struct *napi, int budget)

{
@@ -1956,7 +1942,7 @@ void atl1e_down(struct atl1e_adapter *adapter) 
	atl1e_clean_rx_ring(adapter);

}



/*

/**

 * atl1e_open - Called when a network interface is made active

 * @netdev: network interface device structure

 *
@@ -2002,7 +1988,7 @@ err_req_irq: 
	return err;

}



/*

/**

 * atl1e_close - Disables a network interface

 * @netdev: network interface device structure

 *
@@ -2238,7 +2224,7 @@ static int atl1e_init_netdev(struct net_device *netdev, struct pci_dev *pdev) 
	return 0;

}



/*

/**

 * atl1e_probe - Device Initialization Routine

 * @pdev: PCI device information struct

 * @ent: entry in atl1e_pci_tbl
@@ -2392,7 +2378,7 @@ err_dma: 
	return err;

}



/*

/**

 * atl1e_remove - Device Removal Routine

 * @pdev: PCI device information struct

 *
@@ -2424,7 +2410,7 @@ static void __devexit atl1e_remove(struct pci_dev *pdev) 
	pci_disable_device(pdev);

}



/*

/**

 * atl1e_io_error_detected - called when PCI error is detected

 * @pdev: Pointer to PCI device

 * @state: The current pci connection state
@@ -2452,7 +2438,7 @@ atl1e_io_error_detected(struct pci_dev *pdev, pci_channel_state_t state) 
	return PCI_ERS_RESULT_NEED_RESET;

}



/*

/**

 * atl1e_io_slot_reset - called after the pci bus has been reset.

 * @pdev: Pointer to PCI device

 *
@@ -2479,7 +2465,7 @@ static pci_ers_result_t atl1e_io_slot_reset(struct pci_dev *pdev) 
	return PCI_ERS_RESULT_RECOVERED;

}



/*

/**

 * atl1e_io_resume - called when traffic can start flowing again.

 * @pdev: Pointer to PCI device

 *
@@ -2523,7 +2509,7 @@ static struct pci_driver atl1e_driver = { 
	.err_handler = &atl1e_err_handler

};



/*

/**

 * atl1e_init_module - Driver Registration Routine

 *

 * atl1e_init_module is the first routine called when the driver is
@@ -2534,7 +2520,7 @@ static int __init atl1e_init_module(void) 
	return pci_register_driver(&atl1e_driver);

}



/*

/**

 * atl1e_exit_module - Driver Exit Cleanup Routine

 *

 * atl1e_exit_module is called just before the driver is removed

drivers/net/ethernet/atheros/atl1e/atl1e_param.c

+1 −1
Original line number Diff line number Diff line
@@ -168,7 +168,7 @@ static int __devinit atl1e_validate_option(int *value, struct atl1e_option *opt, 
	return -1;

}



/*

/**

 * atl1e_check_options - Range Checking for Command Line Parameters

 * @adapter: board private structure

 *

drivers/net/ethernet/atheros/atlx/atl1.c

+17 −24
Original line number Diff line number Diff line
@@ -195,7 +195,7 @@ static int __devinit atl1_validate_option(int *value, struct atl1_option *opt, 
	return -1;

}



/*

/**

 * atl1_check_options - Range Checking for Command Line Parameters

 * @adapter: board private structure

 *
@@ -937,7 +937,7 @@ static void atl1_set_mac_addr(struct atl1_hw *hw) 
	iowrite32(value, (hw->hw_addr + REG_MAC_STA_ADDR) + (1 << 2));

}



/*

/**

 * atl1_sw_init - Initialize general software structures (struct atl1_adapter)

 * @adapter: board private structure to initialize

 *
@@ -1014,12 +1014,6 @@ static void mdio_write(struct net_device *netdev, int phy_id, int reg_num, 
	atl1_write_phy_reg(&adapter->hw, reg_num, val);

}



/*

 * atl1_mii_ioctl -

 * @netdev:

 * @ifreq:

 * @cmd:

 */

static int atl1_mii_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)

{

	struct atl1_adapter *adapter = netdev_priv(netdev);
@@ -1036,7 +1030,7 @@ static int atl1_mii_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd) 
	return retval;

}



/*

/**

 * atl1_setup_mem_resources - allocate Tx / RX descriptor resources

 * @adapter: board private structure

 *
@@ -1147,7 +1141,7 @@ static void atl1_init_ring_ptrs(struct atl1_adapter *adapter) 
	atomic_set(&rrd_ring->next_to_clean, 0);

}



/*

/**

 * atl1_clean_rx_ring - Free RFD Buffers

 * @adapter: board private structure

 */
@@ -1187,7 +1181,7 @@ static void atl1_clean_rx_ring(struct atl1_adapter *adapter) 
	atomic_set(&rrd_ring->next_to_clean, 0);

}



/*

/**

 * atl1_clean_tx_ring - Free Tx Buffers

 * @adapter: board private structure

 */
@@ -1227,7 +1221,7 @@ static void atl1_clean_tx_ring(struct atl1_adapter *adapter) 
	atomic_set(&tpd_ring->next_to_clean, 0);

}



/*

/**

 * atl1_free_ring_resources - Free Tx / RX descriptor Resources

 * @adapter: board private structure

 *
@@ -1470,7 +1464,7 @@ static void set_flow_ctrl_new(struct atl1_hw *hw) 
	iowrite32(value, hw->hw_addr + REG_RXQ_RRD_PAUSE_THRESH);

}



/*

/**

 * atl1_configure - Configure Transmit&Receive Unit after Reset

 * @adapter: board private structure

 *
@@ -1844,7 +1838,7 @@ static void atl1_rx_checksum(struct atl1_adapter *adapter, 
	}

}



/*

/**

 * atl1_alloc_rx_buffers - Replace used receive buffers

 * @adapter: address of board private structure

 */
@@ -2489,11 +2483,10 @@ static inline int atl1_sched_rings_clean(struct atl1_adapter* adapter) 
	return 1;

}



/*

/**

 * atl1_intr - Interrupt Handler

 * @irq: interrupt number

 * @data: pointer to a network interface device structure

 * @pt_regs: CPU registers structure

 */

static irqreturn_t atl1_intr(int irq, void *data)

{
@@ -2574,7 +2567,7 @@ static irqreturn_t atl1_intr(int irq, void *data) 
}





/*

/**

 * atl1_phy_config - Timer Call-back

 * @data: pointer to netdev cast into an unsigned long

 */
@@ -2693,7 +2686,7 @@ static void atl1_reset_dev_task(struct work_struct *work) 
	netif_device_attach(netdev);

}



/*

/**

 * atl1_change_mtu - Change the Maximum Transfer Unit

 * @netdev: network interface device structure

 * @new_mtu: new value for maximum frame size
@@ -2727,7 +2720,7 @@ static int atl1_change_mtu(struct net_device *netdev, int new_mtu) 
	return 0;

}



/*

/**

 * atl1_open - Called when a network interface is made active

 * @netdev: network interface device structure

 *
@@ -2762,7 +2755,7 @@ err_up: 
	return err;

}



/*

/**

 * atl1_close - Disables a network interface

 * @netdev: network interface device structure

 *
@@ -2930,7 +2923,7 @@ static const struct net_device_ops atl1_netdev_ops = { 
#endif

};



/*

/**

 * atl1_probe - Device Initialization Routine

 * @pdev: PCI device information struct

 * @ent: entry in atl1_pci_tbl
@@ -3111,7 +3104,7 @@ err_request_regions: 
	return err;

}



/*

/**

 * atl1_remove - Device Removal Routine

 * @pdev: PCI device information struct

 *
@@ -3158,7 +3151,7 @@ static struct pci_driver atl1_driver = { 
	.driver.pm = ATL1_PM_OPS,

};



/*

/**

 * atl1_exit_module - Driver Exit Cleanup Routine

 *

 * atl1_exit_module is called just before the driver is removed
@@ -3169,7 +3162,7 @@ static void __exit atl1_exit_module(void) 
	pci_unregister_driver(&atl1_driver);

}



/*

/**

 * atl1_init_module - Driver Registration Routine

 *

 * atl1_init_module is the first routine called when the driver is