Commit e3eea08e authored by Alex Elder's avatar Alex Elder Committed by David S. Miller
Browse files

net: ipa: fix kerneldoc comments 



This commit affects comments (and in one case, whitespace) only.

Throughout the IPA code, return statements are documented using
"@Return:", whereas they should use "Return:" instead.  Fix these
mistakes.

In function definitions, some parameters are missing their comment
to describe them.  And in structure definitions, some fields are
missing their comment to describe them.  Add these missing
descriptions.

Some arguments changed name and type along the way, but their
descriptions were not updated (an endpoint pointer is now used in
many places that previously used an endpoint ID).  Fix these
incorrect parameter descriptions.

In the description for the ipa_clock structure, one field had a
semicolon instead of a colon in its description.  Fix this.

Add a missing function description for ipa_gsi_endpoint_data_empty().

All of these issues were identified when building with "W=1".

Signed-off-by: default avatarAlex Elder <elder@linaro.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent ed757328

drivers/net/ipa/gsi.c

+3 −3
Original line number Diff line number Diff line
@@ -1363,7 +1363,7 @@ static void gsi_channel_update(struct gsi_channel *channel) 
 * gsi_channel_poll_one() - Return a single completed transaction on a channel

 * @channel:	Channel to be polled

 *

 * @Return:	Transaction pointer, or null if none are available

 * Return:	Transaction pointer, or null if none are available

 *

 * This function returns the first entry on a channel's completed transaction

 * list.  If that list is empty, the hardware is consulted to determine
@@ -1393,8 +1393,8 @@ static struct gsi_trans *gsi_channel_poll_one(struct gsi_channel *channel) 
 * gsi_channel_poll() - NAPI poll function for a channel

 * @napi:	NAPI structure for the channel

 * @budget:	Budget supplied by NAPI core



 * @Return:	 Number of items polled (<= budget)

 *

 * Return:	Number of items polled (<= budget)

 *

 * Single transactions completed by hardware are polled until either

 * the budget is exhausted, or there are no more.  Each transaction

drivers/net/ipa/gsi.h

+6 −6
Original line number Diff line number Diff line
@@ -167,7 +167,7 @@ struct gsi { 
 * @gsi:	Address of GSI structure embedded in an IPA structure

 * @legacy:	Set up for legacy hardware

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 *

 * Performs initialization that must wait until the GSI hardware is

 * ready (including firmware loaded).
@@ -185,7 +185,7 @@ void gsi_teardown(struct gsi *gsi); 
 * @gsi:	GSI pointer

 * @channel_id:	Channel whose limit is to be returned

 *

 * @Return:	 The maximum number of TREs oustanding on the channel

 * Return:	 The maximum number of TREs oustanding on the channel

 */

u32 gsi_channel_tre_max(struct gsi *gsi, u32 channel_id);
@@ -194,7 +194,7 @@ u32 gsi_channel_tre_max(struct gsi *gsi, u32 channel_id); 
 * @gsi:	GSI pointer

 * @channel_id:	Channel whose limit is to be returned

 *

 * @Return:	 The maximum TRE count per transaction on the channel

 * Return:	 The maximum TRE count per transaction on the channel

 */

u32 gsi_channel_trans_tre_max(struct gsi *gsi, u32 channel_id);
@@ -203,7 +203,7 @@ u32 gsi_channel_trans_tre_max(struct gsi *gsi, u32 channel_id); 
 * @gsi:	GSI pointer

 * @channel_id:	Channel to start

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 */

int gsi_channel_start(struct gsi *gsi, u32 channel_id);
@@ -212,7 +212,7 @@ int gsi_channel_start(struct gsi *gsi, u32 channel_id); 
 * @gsi:	GSI pointer returned by gsi_setup()

 * @channel_id:	Channel to stop

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 */

int gsi_channel_stop(struct gsi *gsi, u32 channel_id);
@@ -238,7 +238,7 @@ int gsi_channel_resume(struct gsi *gsi, u32 channel_id, bool start); 
 * @gsi:	Address of GSI structure embedded in an IPA structure

 * @pdev:	IPA platform device

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 *

 * Early stage initialization of the GSI subsystem, performing tasks

 * that can be done before the GSI hardware is ready to use.

drivers/net/ipa/gsi_private.h

+3 −3
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ void gsi_trans_complete(struct gsi_trans *trans); 
 * @channel:	Channel associated with the transaction

 * @index:	Index of the TRE having a transaction

 *

 * @Return:	The GSI transaction pointer associated with the TRE index

 * Return:	The GSI transaction pointer associated with the TRE index

 */

struct gsi_trans *gsi_channel_trans_mapped(struct gsi_channel *channel,

					   u32 index);
@@ -53,7 +53,7 @@ struct gsi_trans *gsi_channel_trans_mapped(struct gsi_channel *channel, 
 * gsi_channel_trans_complete() - Return a channel's next completed transaction

 * @channel:	Channel whose next transaction is to be returned

 *

 * @Return:	The next completed transaction, or NULL if nothing new

 * Return:	The next completed transaction, or NULL if nothing new

 */

struct gsi_trans *gsi_channel_trans_complete(struct gsi_channel *channel);
@@ -76,7 +76,7 @@ void gsi_channel_trans_cancel_pending(struct gsi_channel *channel); 
 * @gsi:	GSI pointer

 * @channel_id:	Channel number

 *

 * @Return:	0 if successful, or -ENOMEM on allocation failure

 * Return:	0 if successful, or -ENOMEM on allocation failure

 *

 * Creates and sets up information for managing transactions on a channel

 */

drivers/net/ipa/gsi_trans.h

+6 −6
Original line number Diff line number Diff line
@@ -75,7 +75,7 @@ struct gsi_trans { 
 * @count:	Minimum number of elements in the pool

 * @max_alloc:	Maximum number of elements allocated at a time from pool

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 */

int gsi_trans_pool_init(struct gsi_trans_pool *pool, size_t size, u32 count,

			u32 max_alloc);
@@ -85,7 +85,7 @@ int gsi_trans_pool_init(struct gsi_trans_pool *pool, size_t size, u32 count, 
 * @pool:	Pool pointer

 * @count:	Number of elements to allocate from the pool

 *

 * @Return:	Virtual address of element(s) allocated from the pool

 * Return:	Virtual address of element(s) allocated from the pool

 */

void *gsi_trans_pool_alloc(struct gsi_trans_pool *pool, u32 count);
@@ -103,7 +103,7 @@ void gsi_trans_pool_exit(struct gsi_trans_pool *pool); 
 * @count:	Minimum number of elements in the pool

 * @max_alloc:	Maximum number of elements allocated at a time from pool

 *

 * @Return:	0 if successful, or a negative error code

 * Return:	0 if successful, or a negative error code

 *

 * Structures in this pool reside in DMA-coherent memory.

 */
@@ -115,7 +115,7 @@ int gsi_trans_pool_init_dma(struct device *dev, struct gsi_trans_pool *pool, 
 * @pool:	DMA pool pointer

 * @addr:	DMA address "handle" associated with the allocation

 *

 * @Return:	Virtual address of element allocated from the pool

 * Return:	Virtual address of element allocated from the pool

 *

 * Only one element at a time may be allocated from a DMA pool.

 */
@@ -134,7 +134,7 @@ void gsi_trans_pool_exit_dma(struct device *dev, struct gsi_trans_pool *pool); 
 * @tre_count:	Number of elements in the transaction

 * @direction:	DMA direction for entire SGL (or DMA_NONE)

 *

 * @Return:	A GSI transaction structure, or a null pointer if all

 * Return:	A GSI transaction structure, or a null pointer if all

 *		available transactions are in use

 */

struct gsi_trans *gsi_channel_trans_alloc(struct gsi *gsi, u32 channel_id,
@@ -175,7 +175,7 @@ int gsi_trans_page_add(struct gsi_trans *trans, struct page *page, u32 size, 
 * @trans:	Transaction

 * @skb:	Socket buffer for transfer (outbound)

 *

 * @Return:	0, or -EMSGSIZE if socket data won't fit in transaction.

 * Return:	0, or -EMSGSIZE if socket data won't fit in transaction.

 */

int gsi_trans_skb_add(struct gsi_trans *trans, struct sk_buff *skb);

drivers/net/ipa/ipa_clock.c

+1 −1
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ 
/**

 * struct ipa_clock - IPA clocking information

 * @count:		Clocking reference count

 * @mutex;		Protects clock enable/disable

 * @mutex:		Protects clock enable/disable

 * @core:		IPA core clock

 * @memory_path:	Memory interconnect

 * @imem_path:		Internal memory interconnect

CRA Git | Maintained and supported by SUSTech CRA and CCSE