Commit 790fb995 authored by Randy Dunlap's avatar Randy Dunlap Committed by Vinod Koul
Browse files

linux/dmaengine.h: fix a few kernel-doc warnings 



The comment block for "Interleaved Transfer Request" should not begin
with "/**" since it is not in kernel-doc format.

Fix doc name for enum sum_check_flags.

Fix all (4) missing struct member warnings.

Use "Warning:" for one "Note:" in enum dma_desc_metadata_mode since
scripts/kernel-doc does not allow more than one Note:
per function or identifier description.

This leaves around 49 kernel-doc warnings like:
  include/linux/dmaengine.h:43: warning: Enum value 'DMA_OUT_OF_ORDER' not described in enum 'dma_status'

and another scripts/kernel-doc problem with it not being able to parse
some typedefs.

Fixes: b14dab79 ("DMAEngine: Define interleaved transfer request api")
Fixes: ad283ea4 ("async_tx: add sum check flags")
Fixes: 27242021 ("dmaengine: Add DMA_CTRL_REUSE")
Fixes: f067025b ("dmaengine: add support to provide error result from a DMA transation")
Fixes: d38a8c62 ("dmaengine: prepare for generic 'unmap' data")
Fixes: 5878853f ("dmaengine: Add API function dmaengine_prep_peripheral_dma_vec()")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Dan Williams <dan.j.williams@intel.com>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: Paul Cercueil <paul@crapouillou.net>
Cc: Nuno Sa <nuno.sa@analog.com>
Cc: Vinod Koul <vkoul@kernel.org>
Cc: dmaengine@vger.kernel.org
Link: https://lore.kernel.org/r/20241202172004.76020-1-rdunlap@infradead.org


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

include/linux/dmaengine.h

+10 −3
Original line number Diff line number Diff line
@@ -84,7 +84,7 @@ enum dma_transfer_direction { 
	DMA_TRANS_NONE,

};



/**

/*

 * Interleaved Transfer Request

 * ----------------------------

 * A chunk is collection of contiguous bytes to be transferred.
@@ -223,7 +223,7 @@ enum sum_check_bits { 
};



/**

 * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations

 * enum sum_check_flags - result of async_{xor,pq}_zero_sum operations

 * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise

 * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise

 */
@@ -286,7 +286,7 @@ typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t; 
 *	pointer to the engine's metadata area

 *   4. Read out the metadata from the pointer

 *

 * Note: the two mode is not compatible and clients must use one mode for a

 * Warning: the two modes are not compatible and clients must use one mode for a

 * descriptor.

 */

enum dma_desc_metadata_mode {
@@ -594,9 +594,13 @@ struct dma_descriptor_metadata_ops { 
 * @phys: physical address of the descriptor

 * @chan: target channel for this operation

 * @tx_submit: accept the descriptor, assign ordered cookie and mark the

 * @desc_free: driver's callback function to free a resusable descriptor

 *	after completion

 * descriptor pending. To be pushed on .issue_pending() call

 * @callback: routine to call after this operation is complete

 * @callback_result: error result from a DMA transaction

 * @callback_param: general parameter to pass to the callback routine

 * @unmap: hook for generic DMA unmap data

 * @desc_metadata_mode: core managed metadata mode to protect mixed use of

 *	DESC_METADATA_CLIENT or DESC_METADATA_ENGINE. Otherwise

 *	DESC_METADATA_NONE
@@ -827,6 +831,9 @@ struct dma_filter { 
 * @device_prep_dma_memset: prepares a memset operation

 * @device_prep_dma_memset_sg: prepares a memset operation over a scatter list

 * @device_prep_dma_interrupt: prepares an end of chain interrupt operation

 * @device_prep_peripheral_dma_vec: prepares a scatter-gather DMA transfer,

 *	where the address and size of each segment is located in one entry of

 *	the dma_vec array.

 * @device_prep_slave_sg: prepares a slave dma operation

 * @device_prep_dma_cyclic: prepare a cyclic dma operation suitable for audio.

 *	The function takes a buffer of size buf_len. The callback function will