Skip to content

Commit 790fb99

Browse files
rddunlapvinodkoul
authored andcommitted
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: b14dab7 ("DMAEngine: Define interleaved transfer request api") Fixes: ad283ea ("async_tx: add sum check flags") Fixes: 2724202 ("dmaengine: Add DMA_CTRL_REUSE") Fixes: f067025 ("dmaengine: add support to provide error result from a DMA transation") Fixes: d38a8c6 ("dmaengine: prepare for generic 'unmap' data") Fixes: 5878853 ("dmaengine: Add API function dmaengine_prep_peripheral_dma_vec()") Signed-off-by: Randy 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: Vinod Koul <vkoul@kernel.org>
1 parent 4b65d53 commit 790fb99

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

include/linux/dmaengine.h

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ enum dma_transfer_direction {
8484
DMA_TRANS_NONE,
8585
};
8686

87-
/**
87+
/*
8888
* Interleaved Transfer Request
8989
* ----------------------------
9090
* A chunk is collection of contiguous bytes to be transferred.
@@ -223,7 +223,7 @@ enum sum_check_bits {
223223
};
224224

225225
/**
226-
* enum pq_check_flags - result of async_{xor,pq}_zero_sum operations
226+
* enum sum_check_flags - result of async_{xor,pq}_zero_sum operations
227227
* @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise
228228
* @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise
229229
*/
@@ -286,7 +286,7 @@ typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
286286
* pointer to the engine's metadata area
287287
* 4. Read out the metadata from the pointer
288288
*
289-
* Note: the two mode is not compatible and clients must use one mode for a
289+
* Warning: the two modes are not compatible and clients must use one mode for a
290290
* descriptor.
291291
*/
292292
enum dma_desc_metadata_mode {
@@ -594,9 +594,13 @@ struct dma_descriptor_metadata_ops {
594594
* @phys: physical address of the descriptor
595595
* @chan: target channel for this operation
596596
* @tx_submit: accept the descriptor, assign ordered cookie and mark the
597+
* @desc_free: driver's callback function to free a resusable descriptor
598+
* after completion
597599
* descriptor pending. To be pushed on .issue_pending() call
598600
* @callback: routine to call after this operation is complete
601+
* @callback_result: error result from a DMA transaction
599602
* @callback_param: general parameter to pass to the callback routine
603+
* @unmap: hook for generic DMA unmap data
600604
* @desc_metadata_mode: core managed metadata mode to protect mixed use of
601605
* DESC_METADATA_CLIENT or DESC_METADATA_ENGINE. Otherwise
602606
* DESC_METADATA_NONE
@@ -827,6 +831,9 @@ struct dma_filter {
827831
* @device_prep_dma_memset: prepares a memset operation
828832
* @device_prep_dma_memset_sg: prepares a memset operation over a scatter list
829833
* @device_prep_dma_interrupt: prepares an end of chain interrupt operation
834+
* @device_prep_peripheral_dma_vec: prepares a scatter-gather DMA transfer,
835+
* where the address and size of each segment is located in one entry of
836+
* the dma_vec array.
830837
* @device_prep_slave_sg: prepares a slave dma operation
831838
* @device_prep_dma_cyclic: prepare a cyclic dma operation suitable for audio.
832839
* The function takes a buffer of size buf_len. The callback function will

0 commit comments

Comments
 (0)