dmaengine: mediatek: mtk-hsdma: Fix formatting in 'struct mtk_hsdma_pdesc' doc block
authorLee Jones <lee.jones@linaro.org>
Tue, 14 Jul 2020 11:15:30 +0000 (12:15 +0100)
committerVinod Koul <vkoul@kernel.org>
Wed, 15 Jul 2020 12:20:46 +0000 (17:50 +0530)
Struct attribute names must be an exact match or the kerneldoc checker
gets confused.

Fixes the following W=1 kernel build warning(s):

 drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc1' not described in 'mtk_hsdma_pdesc'
 drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc2' not described in 'mtk_hsdma_pdesc'
 drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc3' not described in 'mtk_hsdma_pdesc'
 drivers/dma/mediatek/mtk-hsdma.c:120: warning: Function parameter or member 'desc4' not described in 'mtk_hsdma_pdesc'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Cc: Sean Wang <sean.wang@mediatek.com>
Cc: Matthias Brugger <matthias.bgg@gmail.com>
Cc: linux-mediatek@lists.infradead.org
Link: https://lore.kernel.org/r/20200714111546.1755231-2-lee.jones@linaro.org
Signed-off-by: Vinod Koul <vkoul@kernel.org>
drivers/dma/mediatek/mtk-hsdma.c

index 4c58da7..f133ae8 100644 (file)
@@ -107,10 +107,10 @@ enum mtk_hsdma_vdesc_flag {
  * struct mtk_hsdma_pdesc - This is the struct holding info describing physical
  *                         descriptor (PD) and its placement must be kept at
  *                         4-bytes alignment in little endian order.
- * @desc[1-4]:             The control pad used to indicate hardware how to
- *                         deal with the descriptor such as source and
- *                         destination address and data length. The maximum
- *                         data length each pdesc can handle is 0x3f80 bytes
+ * @desc1:                 | The control pad used to indicate hardware how to
+ * @desc2:                 | deal with the descriptor such as source and
+ * @desc3:                 | destination address and data length. The maximum
+ * @desc4:                 | data length each pdesc can handle is 0x3f80 bytes
  */
 struct mtk_hsdma_pdesc {
        __le32 desc1;