Commit 8b544310 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Vinod Koul
Browse files

dmaengine: Make an order in struct dma_device definition 



Make an order in struct dma_device:
- added missing kernel doc descriptions
- put descriptions in the order of appearance in the code
- updated indentation where it makes sense

Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20230130110503.52250-1-andriy.shevchenko@linux.intel.com


Signed-off-by: default avatarVinod Koul <vkoul@kernel.org>
parent 837b2faf

include/linux/dmaengine.h

+7 −6
Original line number Diff line number Diff line
@@ -773,6 +773,7 @@ struct dma_filter { 


/**

 * struct dma_device - info on the entity supplying DMA services

 * @ref: reference is taken and put every time a channel is allocated or freed

 * @chancnt: how many DMA channels are supported

 * @privatecnt: how many DMA channels are requested by dma_request_channel

 * @channels: the list of struct dma_chan
@@ -789,6 +790,7 @@ struct dma_filter { 
 * @dev_id: unique device ID

 * @dev: struct device reference for dma mapping api

 * @owner: owner module (automatically set based on the provided dev)

 * @chan_ida: unique channel ID

 * @src_addr_widths: bit mask of src addr widths the device supports

 *	Width is specified in bytes, e.g. for a device supporting

 *	a width of 4 the mask should have BIT(4) set.
@@ -802,6 +804,7 @@ struct dma_filter { 
 * @max_sg_burst: max number of SG list entries executed in a single burst

 *	DMA tansaction with no software intervention for reinitialization.

 *	Zero value means unlimited number of entries.

 * @descriptor_reuse: a submitted transfer can be resubmitted after completion

 * @residue_granularity: granularity of the transfer residue reported

 *	by tx_status

 * @device_alloc_chan_resources: allocate resources and return the
@@ -839,7 +842,6 @@ struct dma_filter { 
 *	struct with auxiliary transfer status information, otherwise the call

 *	will just return a simple status code

 * @device_issue_pending: push pending transactions to hardware

 * @descriptor_reuse: a submitted transfer can be resubmitted after completion

 * @device_release: called sometime atfer dma_async_device_unregister() is

 *     called and there are no further references to this structure. This

 *     must be implemented to free resources however many existing drivers
@@ -847,6 +849,7 @@ struct dma_filter { 
 * @dbg_summary_show: optional routine to show contents in debugfs; default code

 *     will be used when this is omitted, but custom code can show extra,

 *     controller specific information.

 * @dbg_dev_root: the root folder in debugfs for this device

 */

struct dma_device {

	struct kref ref;
@@ -924,10 +927,8 @@ struct dma_device { 
		struct dma_chan *chan, dma_addr_t dst, u64 data,

		unsigned long flags);



	void (*device_caps)(struct dma_chan *chan,

			    struct dma_slave_caps *caps);

	int (*device_config)(struct dma_chan *chan,

			     struct dma_slave_config *config);

	void (*device_caps)(struct dma_chan *chan, struct dma_slave_caps *caps);

	int (*device_config)(struct dma_chan *chan, struct dma_slave_config *config);

	int (*device_pause)(struct dma_chan *chan);

	int (*device_resume)(struct dma_chan *chan);

	int (*device_terminate_all)(struct dma_chan *chan);