Skip to content

Commit e4cec07

Browse files
rddunlapvinodkoul
authored andcommitted
dmaengine: at_hdmac: fix some kernel-doc warnings
Fix some kernel-doc format warnings: at_hdmac.c:243: warning: Excess struct member 'sg_len' description in 'at_desc' at_hdmac.c:252: warning: cannot understand function prototype: 'enum atc_status ' ez at_hdmac.c:351: warning: Excess struct member 'atdma_devtype' description in 'at_dma' at_hdmac.c:351: warning: Excess struct member 'ch_regs' description in 'at_dma' at_hdmac.c:664: warning: contents before sections Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Ludovic Desroches <ludovic.desroches@microchip.com> Cc: Tudor Ambarus <tudor.ambarus@linaro.org> Cc: linux-arm-kernel@lists.infradead.org Cc: Vinod Koul <vkoul@kernel.org> Cc: dmaengine@vger.kernel.org Link: https://lore.kernel.org/r/20240121070021.25365-1-rdunlap@infradead.org Signed-off-by: Vinod Koul <vkoul@kernel.org>
1 parent 6613476 commit e4cec07

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

drivers/dma/at_hdmac.c

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ struct atdma_sg {
222222
* @vd: pointer to the virtual dma descriptor.
223223
* @atchan: pointer to the atmel dma channel.
224224
* @total_len: total transaction byte count
225-
* @sg_len: number of sg entries.
225+
* @sglen: number of sg entries.
226226
* @sg: array of sgs.
227227
*/
228228
struct at_desc {
@@ -245,7 +245,7 @@ struct at_desc {
245245
/*-- Channels --------------------------------------------------------*/
246246

247247
/**
248-
* atc_status - information bits stored in channel status flag
248+
* enum atc_status - information bits stored in channel status flag
249249
*
250250
* Manipulated with atomic operations.
251251
*/
@@ -328,8 +328,7 @@ static inline u8 convert_buswidth(enum dma_slave_buswidth addr_width)
328328
/**
329329
* struct at_dma - internal representation of an Atmel HDMA Controller
330330
* @dma_device: dmaengine dma_device object members
331-
* @atdma_devtype: identifier of DMA controller compatibility
332-
* @ch_regs: memory mapped register base
331+
* @regs: memory mapped register base
333332
* @clk: dma controller clock
334333
* @save_imr: interrupt mask register that is saved on suspend/resume cycle
335334
* @all_chan_mask: all channels availlable in a mask
@@ -626,6 +625,9 @@ static inline u32 atc_calc_bytes_left(u32 current_len, u32 ctrla)
626625

627626
/**
628627
* atc_get_llis_residue - Get residue for a hardware linked list transfer
628+
* @atchan: pointer to an atmel hdmac channel.
629+
* @desc: pointer to the descriptor for which the residue is calculated.
630+
* @residue: residue to be set to dma_tx_state.
629631
*
630632
* Calculate the residue by removing the length of the Linked List Item (LLI)
631633
* already transferred from the total length. To get the current LLI we can use
@@ -661,10 +663,8 @@ static inline u32 atc_calc_bytes_left(u32 current_len, u32 ctrla)
661663
* two DSCR values are different, we read again the CTRLA then the DSCR till two
662664
* consecutive read values from DSCR are equal or till the maximum trials is
663665
* reach. This algorithm is very unlikely not to find a stable value for DSCR.
664-
* @atchan: pointer to an atmel hdmac channel.
665-
* @desc: pointer to the descriptor for which the residue is calculated.
666-
* @residue: residue to be set to dma_tx_state.
667-
* Returns 0 on success, -errno otherwise.
666+
*
667+
* Returns: %0 on success, -errno otherwise.
668668
*/
669669
static int atc_get_llis_residue(struct at_dma_chan *atchan,
670670
struct at_desc *desc, u32 *residue)
@@ -731,7 +731,8 @@ static int atc_get_llis_residue(struct at_dma_chan *atchan,
731731
* @chan: DMA channel
732732
* @cookie: transaction identifier to check status of
733733
* @residue: residue to be updated.
734-
* Return 0 on success, -errono otherwise.
734+
*
735+
* Return: %0 on success, -errno otherwise.
735736
*/
736737
static int atc_get_residue(struct dma_chan *chan, dma_cookie_t cookie,
737738
u32 *residue)
@@ -1710,7 +1711,7 @@ static void atc_issue_pending(struct dma_chan *chan)
17101711
* atc_alloc_chan_resources - allocate resources for DMA channel
17111712
* @chan: allocate descriptor resources for this channel
17121713
*
1713-
* return - the number of allocated descriptors
1714+
* Return: the number of allocated descriptors
17141715
*/
17151716
static int atc_alloc_chan_resources(struct dma_chan *chan)
17161717
{

0 commit comments

Comments
 (0)