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

Commit 6508871e authored by Randy Dunlap's avatar Randy Dunlap Committed by David S. Miller
Browse files

[IOAT]: fix kernel-doc in source files 



Fix kernel-doc warnings in drivers/dma/:
- use correct function & parameter names
- add descriptions where omitted

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent fe4ada2d

drivers/dma/dmaengine.c

+12 −8
Original line number Diff line number Diff line
@@ -166,8 +166,8 @@ static struct dma_chan *dma_client_chan_alloc(struct dma_client *client) 
}



/**

 * dma_client_chan_free - release a DMA channel

 * @chan: &dma_chan

 * dma_chan_cleanup - release a DMA channel's resources

 * @kref: kernel reference structure that contains the DMA channel device

 */

void dma_chan_cleanup(struct kref *kref)

{
@@ -199,7 +199,7 @@ static void dma_client_chan_free(struct dma_chan *chan) 
 * dma_chans_rebalance - reallocate channels to clients

 *

 * When the number of DMA channel in the system changes,

 * channels need to be rebalanced among clients

 * channels need to be rebalanced among clients.

 */

static void dma_chans_rebalance(void)

{
@@ -264,7 +264,7 @@ struct dma_client *dma_async_client_register(dma_event_callback event_callback) 


/**

 * dma_async_client_unregister - unregister a client and free the &dma_client

 * @client:

 * @client: &dma_client to free

 *

 * Force frees any allocated DMA channels, frees the &dma_client memory

 */
@@ -306,7 +306,7 @@ void dma_async_client_chan_request(struct dma_client *client, 
}



/**

 * dma_async_device_register -

 * dma_async_device_register - registers DMA devices found

 * @device: &dma_device

 */

int dma_async_device_register(struct dma_device *device)
@@ -348,8 +348,8 @@ int dma_async_device_register(struct dma_device *device) 
}



/**

 * dma_async_device_unregister -

 * @device: &dma_device

 * dma_async_device_cleanup - function called when all references are released

 * @kref: kernel reference object

 */

static void dma_async_device_cleanup(struct kref *kref)

{
@@ -359,6 +359,10 @@ static void dma_async_device_cleanup(struct kref *kref) 
	complete(&device->done);

}



/**

 * dma_async_device_unregister - unregisters DMA devices

 * @device: &dma_device

 */

void dma_async_device_unregister(struct dma_device *device)

{

	struct dma_chan *chan;

drivers/dma/ioatdma.c

+5 −3
Original line number Diff line number Diff line
@@ -217,7 +217,7 @@ static void ioat_dma_free_chan_resources(struct dma_chan *chan) 


/**

 * do_ioat_dma_memcpy - actual function that initiates a IOAT DMA transaction

 * @chan: IOAT DMA channel handle

 * @ioat_chan: IOAT DMA channel handle

 * @dest: DMA destination address

 * @src: DMA source address

 * @len: transaction length in bytes
@@ -383,7 +383,7 @@ static dma_cookie_t ioat_dma_memcpy_buf_to_pg(struct dma_chan *chan, 
 * @dest_off: offset into that page

 * @src_pg: pointer to the page to copy from

 * @src_off: offset into that page

 * @len: transaction length in bytes. This is guaranteed to not make a copy

 * @len: transaction length in bytes. This is guaranteed not to make a copy

 *	 across a page boundary.

 */
@@ -407,7 +407,7 @@ static dma_cookie_t ioat_dma_memcpy_pg_to_pg(struct dma_chan *chan, 
}



/**

 * ioat_dma_memcpy_issue_pending - push potentially unrecognoized appended descriptors to hw

 * ioat_dma_memcpy_issue_pending - push potentially unrecognized appended descriptors to hw

 * @chan: DMA channel handle

 */
@@ -510,6 +510,8 @@ static void ioat_dma_memcpy_cleanup(struct ioat_dma_chan *chan) 
 * ioat_dma_is_complete - poll the status of a IOAT DMA transaction

 * @chan: IOAT DMA channel handle

 * @cookie: DMA transaction identifier

 * @done: if not %NULL, updated with last completed transaction

 * @used: if not %NULL, updated with last used transaction

 */



static enum dma_status ioat_dma_is_complete(struct dma_chan *chan,