Skip to content

Commit bd6081b

Browse files
committed
dmaengine: at_hdmac: add missing kernel-doc style description
We get following warning with W=1: drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'boundary' not described in 'at_desc' drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'dst_hole' not described in 'at_desc' drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'src_hole' not described in 'at_desc' drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'memset_buffer' not described in 'at_desc' drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'memset_paddr' not described in 'at_desc' drivers/dma/at_hdmac.c:243: warning: Function parameter or struct member 'memset_vaddr' not described in 'at_desc' drivers/dma/at_hdmac.c:255: warning: Enum value 'ATC_IS_PAUSED' not described in enum 'atc_status' drivers/dma/at_hdmac.c:255: warning: Enum value 'ATC_IS_CYCLIC' not described in enum 'atc_status' drivers/dma/at_hdmac.c:287: warning: Function parameter or struct member 'cyclic' not described in 'at_dma_chan' drivers/dma/at_hdmac.c:350: warning: Function parameter or struct member 'memset_pool' not described in 'at_dma' Fix this by adding the required description and also drop unused struct member 'cyclic' in 'at_dma_chan' Reviewed-by: Tudor Ambarus <tudor.ambarus@linaro.org> Signed-off-by: Vinod Koul <vkoul@kernel.org> Link: https://lore.kernel.org/r/20240130163216.633034-1-vkoul@kernel.org Signed-off-by: Vinod Koul <vkoul@kernel.org>
1 parent a22fe1d commit bd6081b

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

drivers/dma/at_hdmac.c

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,12 @@ struct atdma_sg {
224224
* @total_len: total transaction byte count
225225
* @sglen: number of sg entries.
226226
* @sg: array of sgs.
227+
* @boundary: number of transfers to perform before the automatic address increment operation
228+
* @dst_hole: value to add to the destination address when the boundary has been reached
229+
* @src_hole: value to add to the source address when the boundary has been reached
230+
* @memset_buffer: buffer used for the memset operation
231+
* @memset_paddr: physical address of the buffer used for the memset operation
232+
* @memset_vaddr: virtual address of the buffer used for the memset operation
227233
*/
228234
struct at_desc {
229235
struct virt_dma_desc vd;
@@ -247,6 +253,9 @@ struct at_desc {
247253
/**
248254
* enum atc_status - information bits stored in channel status flag
249255
*
256+
* @ATC_IS_PAUSED: If channel is pauses
257+
* @ATC_IS_CYCLIC: If channel is cyclic
258+
*
250259
* Manipulated with atomic operations.
251260
*/
252261
enum atc_status {
@@ -282,7 +291,6 @@ struct at_dma_chan {
282291
u32 save_cfg;
283292
u32 save_dscr;
284293
struct dma_slave_config dma_sconfig;
285-
bool cyclic;
286294
struct at_desc *desc;
287295
};
288296

@@ -333,6 +341,7 @@ static inline u8 convert_buswidth(enum dma_slave_buswidth addr_width)
333341
* @save_imr: interrupt mask register that is saved on suspend/resume cycle
334342
* @all_chan_mask: all channels availlable in a mask
335343
* @lli_pool: hw lli table
344+
* @memset_pool: hw memset pool
336345
* @chan: channels table to store at_dma_chan structures
337346
*/
338347
struct at_dma {

0 commit comments

Comments
 (0)