drivers/dma/at_hdmac.c:243: warning: Excess struct member 'sg' description in 'at_desc'

[kernel test robot <lkp@intel.com>]

:::::: 
:::::: Manual check reason: "kernel-doc warning due to __counted_by"
:::::: 

BCC: lkp@intel.com
CC: llvm@lists.linux.dev
CC: oe-kbuild-all@lists.linux.dev
CC: linux-kernel@vger.kernel.org
TO: Kees Cook <keescook@chromium.org>
CC: Vinod Koul <vkoul@kernel.org>
CC: Tudor Ambarus <tudor.ambarus@linaro.org>
CC: "Gustavo A. R. Silva" <gustavoars@kernel.org>

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   ceb6a6f023fd3e8b07761ed900352ef574010bcb
commit: 81cd3cb3b3dd37df1fc45c5b6443a07bc2a7fee4 dmaengine: at_hdmac: Annotate struct at_desc with __counted_by
date:   3 months ago
:::::: branch date: 4 hours ago
:::::: commit date: 3 months ago
config: arm-defconfig (https://download.01.org/0day-ci/archive/20231218/202312181103.SGoIv7HS-lkp@intel.com/config)
compiler: clang version 14.0.6 (https://github.com/llvm/llvm-project.git f28c006a5895fc0e329fe15fead81e37457cb1d1)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231218/202312181103.SGoIv7HS-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/r/202312181103.SGoIv7HS-lkp@intel.com/

All warnings (new ones prefixed by >>):

   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'sglen' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'boundary' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'dst_hole' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'src_hole' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'memset_buffer' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'memset_paddr' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Function parameter or member 'memset_vaddr' not described in 'at_desc'
   drivers/dma/at_hdmac.c:243: warning: Excess struct member 'sg_len' description in 'at_desc'
>> drivers/dma/at_hdmac.c:243: warning: Excess struct member 'sg' description in 'at_desc'
   drivers/dma/at_hdmac.c:252: warning: cannot understand function prototype: 'enum atc_status '
   drivers/dma/at_hdmac.c:287: warning: Function parameter or member 'cyclic' not described in 'at_dma_chan'
   drivers/dma/at_hdmac.c:351: warning: Function parameter or member 'regs' not described in 'at_dma'
   drivers/dma/at_hdmac.c:351: warning: Function parameter or member 'memset_pool' not described in 'at_dma'
   drivers/dma/at_hdmac.c:351: warning: Excess struct member 'atdma_devtype' description in 'at_dma'
   drivers/dma/at_hdmac.c:351: warning: Excess struct member 'ch_regs' description in 'at_dma'


vim +243 drivers/dma/at_hdmac.c

ac803b56860f65 Tudor Ambarus 2022-10-25  219  
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  220  /**
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  221   * struct at_desc - software descriptor
ac803b56860f65 Tudor Ambarus 2022-10-25  222   * @vd: pointer to the virtual dma descriptor.
ac803b56860f65 Tudor Ambarus 2022-10-25  223   * @atchan: pointer to the atmel dma channel.
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  224   * @total_len: total transaction byte count
ac803b56860f65 Tudor Ambarus 2022-10-25  225   * @sg_len: number of sg entries.
ac803b56860f65 Tudor Ambarus 2022-10-25  226   * @sg: array of sgs.
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  227   */
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  228  struct at_desc {
ac803b56860f65 Tudor Ambarus 2022-10-25  229  	struct				virt_dma_desc vd;
ac803b56860f65 Tudor Ambarus 2022-10-25  230  	struct				at_dma_chan *atchan;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  231  	size_t				total_len;
ac803b56860f65 Tudor Ambarus 2022-10-25  232  	unsigned int			sglen;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  233  	/* Interleaved data */
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  234  	size_t				boundary;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  235  	size_t				dst_hole;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  236  	size_t				src_hole;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  237  
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  238  	/* Memset temporary buffer */
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  239  	bool				memset_buffer;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  240  	dma_addr_t			memset_paddr;
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  241  	int				*memset_vaddr;
81cd3cb3b3dd37 Kees Cook     2023-08-17  242  	struct atdma_sg			sg[] __counted_by(sglen);
5cecadc3e2a4fb Tudor Ambarus 2022-10-25 @243  };
5cecadc3e2a4fb Tudor Ambarus 2022-10-25  244  

:::::: The code at line 243 was first introduced by commit
:::::: 5cecadc3e2a4fb72ab37d9420df0a9e1179b8a3e dmaengine: at_hdmac: Keep register definitions and structures private to at_hdmac.c

:::::: TO: Tudor Ambarus <tudor.ambarus@microchip.com>
:::::: CC: Vinod Koul <vkoul@kernel.org>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki