Commit bd6081be authored Jan 30, 2024 by Vinod Koul

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>

parent a22fe1d6

drivers/dma/at_hdmac.c

+10 −1

Original line number	Diff line number	Diff line
		@@ -224,6 +224,12 @@ struct atdma_sg {
		* @total_len: total transaction byte count
		* @sglen: number of sg entries.
		* @sg: array of sgs.
		* @boundary: number of transfers to perform before the automatic address increment operation
		* @dst_hole: value to add to the destination address when the boundary has been reached
		* @src_hole: value to add to the source address when the boundary has been reached
		* @memset_buffer: buffer used for the memset operation
		* @memset_paddr: physical address of the buffer used for the memset operation
		* @memset_vaddr: virtual address of the buffer used for the memset operation
		*/
		struct at_desc {
		struct virt_dma_desc vd;
		@@ -247,6 +253,9 @@ struct at_desc {
		/**
		* enum atc_status - information bits stored in channel status flag
		*
		* @ATC_IS_PAUSED: If channel is pauses
		* @ATC_IS_CYCLIC: If channel is cyclic
		*
		* Manipulated with atomic operations.
		*/
		enum atc_status {
		@@ -282,7 +291,6 @@ struct at_dma_chan {
		u32 save_cfg;
		u32 save_dscr;
		struct dma_slave_config dma_sconfig;
		bool cyclic;
		struct at_desc *desc;
		};

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