Commit ec977c5b authored by David Daney's avatar David Daney Committed by Ralf Baechle

Staging: Octeon: Reformat a bunch of comments.

Many of the comments didn't follow kerneldoc guidlines.
Signed-off-by: default avatarDavid Daney <ddaney@caviumnetworks.com>
To: linux-mips@linux-mips.org
To: netdev@vger.kernel.org
To: gregkh@suse.de
Patchwork: http://patchwork.linux-mips.org/patch/971/Signed-off-by: default avatarRalf Baechle <ralf@linux-mips.org>
parent 4898c560
...@@ -96,11 +96,11 @@ const struct ethtool_ops cvm_oct_ethtool_ops = { ...@@ -96,11 +96,11 @@ const struct ethtool_ops cvm_oct_ethtool_ops = {
}; };
/** /**
* IOCTL support for PHY control * cvm_oct_ioctl - IOCTL support for PHY control
*
* @dev: Device to change * @dev: Device to change
* @rq: the request * @rq: the request
* @cmd: the command * @cmd: the command
*
* Returns Zero on success * Returns Zero on success
*/ */
int cvm_oct_ioctl(struct net_device *dev, struct ifreq *rq, int cmd) int cvm_oct_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
...@@ -153,7 +153,7 @@ static void cvm_oct_adjust_link(struct net_device *dev) ...@@ -153,7 +153,7 @@ static void cvm_oct_adjust_link(struct net_device *dev)
/** /**
* Setup the PHY * cvm_oct_phy_setup_device - setup the PHY
* *
* @dev: Device to setup * @dev: Device to setup
* *
......
...@@ -34,11 +34,12 @@ ...@@ -34,11 +34,12 @@
#include "cvmx-fpa.h" #include "cvmx-fpa.h"
/** /**
* Fill the supplied hardware pool with skbuffs * cvm_oct_fill_hw_skbuff - fill the supplied hardware pool with skbuffs
*
* @pool: Pool to allocate an skbuff for * @pool: Pool to allocate an skbuff for
* @size: Size of the buffer needed for the pool * @size: Size of the buffer needed for the pool
* @elements: Number of buffers to allocate * @elements: Number of buffers to allocate
*
* Returns the actual number of buffers allocated.
*/ */
static int cvm_oct_fill_hw_skbuff(int pool, int size, int elements) static int cvm_oct_fill_hw_skbuff(int pool, int size, int elements)
{ {
...@@ -62,8 +63,7 @@ static int cvm_oct_fill_hw_skbuff(int pool, int size, int elements) ...@@ -62,8 +63,7 @@ static int cvm_oct_fill_hw_skbuff(int pool, int size, int elements)
} }
/** /**
* Free the supplied hardware pool of skbuffs * cvm_oct_free_hw_skbuff- free hardware pool skbuffs
*
* @pool: Pool to allocate an skbuff for * @pool: Pool to allocate an skbuff for
* @size: Size of the buffer needed for the pool * @size: Size of the buffer needed for the pool
* @elements: Number of buffers to allocate * @elements: Number of buffers to allocate
...@@ -91,11 +91,12 @@ static void cvm_oct_free_hw_skbuff(int pool, int size, int elements) ...@@ -91,11 +91,12 @@ static void cvm_oct_free_hw_skbuff(int pool, int size, int elements)
} }
/** /**
* This function fills a hardware pool with memory. * cvm_oct_fill_hw_memory - fill a hardware pool with memory.
*
* @pool: Pool to populate * @pool: Pool to populate
* @size: Size of each buffer in the pool * @size: Size of each buffer in the pool
* @elements: Number of buffers to allocate * @elements: Number of buffers to allocate
*
* Returns the actual number of buffers allocated.
*/ */
static int cvm_oct_fill_hw_memory(int pool, int size, int elements) static int cvm_oct_fill_hw_memory(int pool, int size, int elements)
{ {
...@@ -129,8 +130,7 @@ static int cvm_oct_fill_hw_memory(int pool, int size, int elements) ...@@ -129,8 +130,7 @@ static int cvm_oct_fill_hw_memory(int pool, int size, int elements)
} }
/** /**
* Free memory previously allocated with cvm_oct_fill_hw_memory * cvm_oct_free_hw_memory - Free memory allocated by cvm_oct_fill_hw_memory
*
* @pool: FPA pool to free * @pool: FPA pool to free
* @size: Size of each buffer in the pool * @size: Size of each buffer in the pool
* @elements: Number of buffers that should be in the pool * @elements: Number of buffers that should be in the pool
......
...@@ -124,8 +124,9 @@ static void cvm_oct_no_more_work(void) ...@@ -124,8 +124,9 @@ static void cvm_oct_no_more_work(void)
} }
/** /**
* Interrupt handler. The interrupt occurs whenever the POW * cvm_oct_do_interrupt - interrupt handler.
* has packets in our group. *
* The interrupt occurs whenever the POW has packets in our group.
* *
*/ */
static irqreturn_t cvm_oct_do_interrupt(int cpl, void *dev_id) static irqreturn_t cvm_oct_do_interrupt(int cpl, void *dev_id)
...@@ -138,10 +139,9 @@ static irqreturn_t cvm_oct_do_interrupt(int cpl, void *dev_id) ...@@ -138,10 +139,9 @@ static irqreturn_t cvm_oct_do_interrupt(int cpl, void *dev_id)
} }
/** /**
* This is called on receive errors, and determines if the packet * cvm_oct_check_rcv_error - process receive errors
* can be dropped early-on in cvm_oct_tasklet_rx().
*
* @work: Work queue entry pointing to the packet. * @work: Work queue entry pointing to the packet.
*
* Returns Non-zero if the packet can be dropped, zero otherwise. * Returns Non-zero if the packet can be dropped, zero otherwise.
*/ */
static inline int cvm_oct_check_rcv_error(cvmx_wqe_t *work) static inline int cvm_oct_check_rcv_error(cvmx_wqe_t *work)
...@@ -224,10 +224,11 @@ static inline int cvm_oct_check_rcv_error(cvmx_wqe_t *work) ...@@ -224,10 +224,11 @@ static inline int cvm_oct_check_rcv_error(cvmx_wqe_t *work)
} }
/** /**
* The NAPI poll function. * cvm_oct_napi_poll - the NAPI poll function.
*
* @napi: The NAPI instance, or null if called from cvm_oct_poll_controller * @napi: The NAPI instance, or null if called from cvm_oct_poll_controller
* @budget: Maximum number of packets to receive. * @budget: Maximum number of packets to receive.
*
* Returns the number of packets processed.
*/ */
static int cvm_oct_napi_poll(struct napi_struct *napi, int budget) static int cvm_oct_napi_poll(struct napi_struct *napi, int budget)
{ {
...@@ -484,7 +485,7 @@ static int cvm_oct_napi_poll(struct napi_struct *napi, int budget) ...@@ -484,7 +485,7 @@ static int cvm_oct_napi_poll(struct napi_struct *napi, int budget)
#ifdef CONFIG_NET_POLL_CONTROLLER #ifdef CONFIG_NET_POLL_CONTROLLER
/** /**
* This is called when the kernel needs to manually poll the * cvm_oct_poll_controller - poll for receive packets
* device. * device.
* *
* @dev: Device to poll. Unused * @dev: Device to poll. Unused
......
...@@ -137,11 +137,11 @@ void cvm_oct_free_tx_skbs(struct net_device *dev) ...@@ -137,11 +137,11 @@ void cvm_oct_free_tx_skbs(struct net_device *dev)
} }
/** /**
* Packet transmit * cvm_oct_xmit - transmit a packet
*
* @skb: Packet to send * @skb: Packet to send
* @dev: Device info structure * @dev: Device info structure
* Returns Always returns zero *
* Returns Always returns NETDEV_TX_OK
*/ */
int cvm_oct_xmit(struct sk_buff *skb, struct net_device *dev) int cvm_oct_xmit(struct sk_buff *skb, struct net_device *dev)
{ {
...@@ -510,10 +510,10 @@ int cvm_oct_xmit(struct sk_buff *skb, struct net_device *dev) ...@@ -510,10 +510,10 @@ int cvm_oct_xmit(struct sk_buff *skb, struct net_device *dev)
} }
/** /**
* Packet transmit to the POW * cvm_oct_xmit_pow - transmit a packet to the POW
*
* @skb: Packet to send * @skb: Packet to send
* @dev: Device info structure * @dev: Device info structure
* Returns Always returns zero * Returns Always returns zero
*/ */
int cvm_oct_xmit_pow(struct sk_buff *skb, struct net_device *dev) int cvm_oct_xmit_pow(struct sk_buff *skb, struct net_device *dev)
...@@ -661,9 +661,9 @@ int cvm_oct_xmit_pow(struct sk_buff *skb, struct net_device *dev) ...@@ -661,9 +661,9 @@ int cvm_oct_xmit_pow(struct sk_buff *skb, struct net_device *dev)
} }
/** /**
* This function frees all skb that are currently queued for TX. * cvm_oct_tx_shutdown_dev - free all skb that are currently queued for TX.
*
* @dev: Device being shutdown * @dev: Device being shutdown
*
*/ */
void cvm_oct_tx_shutdown_dev(struct net_device *dev) void cvm_oct_tx_shutdown_dev(struct net_device *dev)
{ {
......
...@@ -30,10 +30,9 @@ ...@@ -30,10 +30,9 @@
} while (0) } while (0)
/** /**
* Given a packet data address, return a pointer to the * cvm_oct_get_buffer_ptr - convert packet data address to pointer
* beginning of the packet buffer.
*
* @packet_ptr: Packet data hardware address * @packet_ptr: Packet data hardware address
*
* Returns Packet buffer pointer * Returns Packet buffer pointer
*/ */
static inline void *cvm_oct_get_buffer_ptr(union cvmx_buf_ptr packet_ptr) static inline void *cvm_oct_get_buffer_ptr(union cvmx_buf_ptr packet_ptr)
...@@ -43,9 +42,7 @@ static inline void *cvm_oct_get_buffer_ptr(union cvmx_buf_ptr packet_ptr) ...@@ -43,9 +42,7 @@ static inline void *cvm_oct_get_buffer_ptr(union cvmx_buf_ptr packet_ptr)
} }
/** /**
* Given an IPD/PKO port number, return the logical interface it is * INTERFACE - convert IPD port to locgical interface
* on.
*
* @ipd_port: Port to check * @ipd_port: Port to check
* *
* Returns Logical interface * Returns Logical interface
...@@ -65,9 +62,7 @@ static inline int INTERFACE(int ipd_port) ...@@ -65,9 +62,7 @@ static inline int INTERFACE(int ipd_port)
} }
/** /**
* Given an IPD/PKO port number, return the port's index on a * INDEX - convert IPD/PKO port number to the port's interface index
* logical interface.
*
* @ipd_port: Port to check * @ipd_port: Port to check
* *
* Returns Index into interface port list * Returns Index into interface port list
......
...@@ -176,9 +176,6 @@ static void cvm_oct_periodic_worker(struct work_struct *work) ...@@ -176,9 +176,6 @@ static void cvm_oct_periodic_worker(struct work_struct *work)
queue_delayed_work(cvm_oct_poll_queue, &priv->port_periodic_work, HZ); queue_delayed_work(cvm_oct_poll_queue, &priv->port_periodic_work, HZ);
} }
/**
* Configure common hardware for all interfaces
*/
static __init void cvm_oct_configure_common_hw(void) static __init void cvm_oct_configure_common_hw(void)
{ {
/* Setup the FPA */ /* Setup the FPA */
...@@ -198,10 +195,10 @@ static __init void cvm_oct_configure_common_hw(void) ...@@ -198,10 +195,10 @@ static __init void cvm_oct_configure_common_hw(void)
} }
/** /**
* Free a work queue entry received in a intercept callback. * cvm_oct_free_work- Free a work queue entry
*
* @work_queue_entry: Work queue entry to free
* *
* @work_queue_entry:
* Work queue entry to free
* Returns Zero on success, Negative on failure. * Returns Zero on success, Negative on failure.
*/ */
int cvm_oct_free_work(void *work_queue_entry) int cvm_oct_free_work(void *work_queue_entry)
...@@ -228,9 +225,9 @@ int cvm_oct_free_work(void *work_queue_entry) ...@@ -228,9 +225,9 @@ int cvm_oct_free_work(void *work_queue_entry)
EXPORT_SYMBOL(cvm_oct_free_work); EXPORT_SYMBOL(cvm_oct_free_work);
/** /**
* Get the low level ethernet statistics * cvm_oct_common_get_stats - get the low level ethernet statistics
*
* @dev: Device to get the statistics from * @dev: Device to get the statistics from
*
* Returns Pointer to the statistics * Returns Pointer to the statistics
*/ */
static struct net_device_stats *cvm_oct_common_get_stats(struct net_device *dev) static struct net_device_stats *cvm_oct_common_get_stats(struct net_device *dev)
...@@ -274,8 +271,7 @@ static struct net_device_stats *cvm_oct_common_get_stats(struct net_device *dev) ...@@ -274,8 +271,7 @@ static struct net_device_stats *cvm_oct_common_get_stats(struct net_device *dev)
} }
/** /**
* Change the link MTU. Unimplemented * cvm_oct_common_change_mtu - change the link MTU
*
* @dev: Device to change * @dev: Device to change
* @new_mtu: The new MTU * @new_mtu: The new MTU
* *
...@@ -339,8 +335,7 @@ static int cvm_oct_common_change_mtu(struct net_device *dev, int new_mtu) ...@@ -339,8 +335,7 @@ static int cvm_oct_common_change_mtu(struct net_device *dev, int new_mtu)
} }
/** /**
* Set the multicast list. Currently unimplemented. * cvm_oct_common_set_multicast_list - set the multicast list
*
* @dev: Device to work on * @dev: Device to work on
*/ */
static void cvm_oct_common_set_multicast_list(struct net_device *dev) static void cvm_oct_common_set_multicast_list(struct net_device *dev)
...@@ -395,10 +390,10 @@ static void cvm_oct_common_set_multicast_list(struct net_device *dev) ...@@ -395,10 +390,10 @@ static void cvm_oct_common_set_multicast_list(struct net_device *dev)
} }
/** /**
* Set the hardware MAC address for a device * cvm_oct_common_set_mac_address - set the hardware MAC address for a device
* * @dev: The device in question.
* @dev: Device to change the MAC address for * @addr: Address structure to change it too.
* @addr: Address structure to change it too. MAC address is addr + 2.
* Returns Zero on success * Returns Zero on success
*/ */
static int cvm_oct_common_set_mac_address(struct net_device *dev, void *addr) static int cvm_oct_common_set_mac_address(struct net_device *dev, void *addr)
...@@ -445,9 +440,9 @@ static int cvm_oct_common_set_mac_address(struct net_device *dev, void *addr) ...@@ -445,9 +440,9 @@ static int cvm_oct_common_set_mac_address(struct net_device *dev, void *addr)
} }
/** /**
* Per network device initialization * cvm_oct_common_init - per network device initialization
*
* @dev: Device to initialize * @dev: Device to initialize
*
* Returns Zero on success * Returns Zero on success
*/ */
int cvm_oct_common_init(struct net_device *dev) int cvm_oct_common_init(struct net_device *dev)
...@@ -603,12 +598,6 @@ static const struct net_device_ops cvm_oct_pow_netdev_ops = { ...@@ -603,12 +598,6 @@ static const struct net_device_ops cvm_oct_pow_netdev_ops = {
extern void octeon_mdiobus_force_mod_depencency(void); extern void octeon_mdiobus_force_mod_depencency(void);
/**
* Module/ driver initialization. Creates the linux network
* devices.
*
* Returns Zero on success
*/
static int __init cvm_oct_init_module(void) static int __init cvm_oct_init_module(void)
{ {
int num_interfaces; int num_interfaces;
...@@ -802,11 +791,6 @@ static int __init cvm_oct_init_module(void) ...@@ -802,11 +791,6 @@ static int __init cvm_oct_init_module(void)
return 0; return 0;
} }
/**
* Module / driver shutdown
*
* Returns Zero on success
*/
static void __exit cvm_oct_cleanup_module(void) static void __exit cvm_oct_cleanup_module(void)
{ {
int port; int port;
......
...@@ -61,13 +61,6 @@ struct octeon_ethernet { ...@@ -61,13 +61,6 @@ struct octeon_ethernet {
struct work_struct port_work; /* may be unused. */ struct work_struct port_work; /* may be unused. */
}; };
/**
* Free a work queue entry received in a intercept callback.
*
* @work_queue_entry:
* Work queue entry to free
* Returns Zero on success, Negative on failure.
*/
int cvm_oct_free_work(void *work_queue_entry); int cvm_oct_free_work(void *work_queue_entry);
extern int cvm_oct_rgmii_init(struct net_device *dev); extern int cvm_oct_rgmii_init(struct net_device *dev);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment