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

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

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

drivers/staging/octeon/ethernet-mdio.c

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

 * @rq:     the request

 * @cmd:    the command

 *

 * Returns Zero on success

 */

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) 




/**

 * Setup the PHY

 * cvm_oct_phy_setup_device - setup the PHY

 *

 * @dev:    Device to setup

 *

drivers/staging/octeon/ethernet-mem.c

+8 −8
Original line number Diff line number Diff line
@@ -34,11 +34,12 @@ 
#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

 * @size:     Size of the buffer needed for the pool

 * @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)

{
@@ -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

 * @size:     Size of the buffer needed for the pool

 * @elements: Number of buffers to allocate
@@ -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

 * @size:     Size of each buffer in the pool

 * @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)

{
@@ -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

 * @size:     Size of each buffer in the pool

 * @elements: Number of buffers that should be in the pool

drivers/staging/octeon/ethernet-rx.c

+9 −8
Original line number Diff line number Diff line
@@ -124,8 +124,9 @@ static void cvm_oct_no_more_work(void) 
}



/**

 * Interrupt handler. The interrupt occurs whenever the POW

 * has packets in our group.

 * cvm_oct_do_interrupt - interrupt handler.

 *

 * The interrupt occurs whenever the POW has packets in our group.

 *

 */

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

 * can be dropped early-on in cvm_oct_tasklet_rx().

 *

 * cvm_oct_check_rcv_error - process receive errors

 * @work: Work queue entry pointing to the packet.

 *

 * Returns Non-zero if the packet can be dropped, zero otherwise.

 */

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

 * @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)

{
@@ -484,7 +485,7 @@ static int cvm_oct_napi_poll(struct napi_struct *napi, int budget) 


#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.

 *

 * @dev:    Device to poll. Unused

drivers/staging/octeon/ethernet-tx.c

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

 * @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)

{
@@ -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

 * @dev:    Device info structure



 * Returns Always returns zero

 */

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

 *

 */

void cvm_oct_tx_shutdown_dev(struct net_device *dev)

{

drivers/staging/octeon/ethernet-util.h

+4 −9
Original line number Diff line number Diff line
@@ -30,10 +30,9 @@ 
				} while (0)



/**

 * Given a packet data address, return a pointer to the

 * beginning of the packet buffer.

 *

 * cvm_oct_get_buffer_ptr - convert packet data address to pointer

 * @packet_ptr: Packet data hardware address

 *

 * Returns Packet buffer pointer

 */

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

 * on.

 *

 * INTERFACE - convert IPD port to locgical interface

 * @ipd_port: Port to check

 *

 * Returns Logical interface
@@ -65,9 +62,7 @@ static inline int INTERFACE(int ipd_port) 
}



/**

 * Given an IPD/PKO port number, return the port's index on a

 * logical interface.

 *

 * INDEX - convert IPD/PKO port number to the port's interface index

 * @ipd_port: Port to check

 *

 * Returns Index into interface port list