]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
soc: ti: knav_dma: fix all kernel-doc warnings in knav_dma.h
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 1 Mar 2026 01:12:28 +0000 (17:12 -0800)
committerNishanth Menon <nm@ti.com>
Tue, 5 May 2026 11:08:34 +0000 (06:08 -0500)
Use correct struct member names and formats to avoid kernel-doc
warnings:

Warning: include/linux/soc/ti/knav_dma.h:83 struct member 'priority' not
 described in 'knav_dma_tx_cfg'
Warning: include/linux/soc/ti/knav_dma.h:113 struct member 'err_mode' not
 described in 'knav_dma_rx_cfg'
Warning: include/linux/soc/ti/knav_dma.h:113 struct member 'desc_type' not
 described in 'knav_dma_rx_cfg'
Warning: include/linux/soc/ti/knav_dma.h:113 struct member 'fdq' not
 described in 'knav_dma_rx_cfg'
Warning: include/linux/soc/ti/knav_dma.h:127 struct member 'direction' not
 described in 'knav_dma_cfg'
Warning: include/linux/soc/ti/knav_dma.h:127 struct member 'u' not
 described in 'knav_dma_cfg'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260301011228.3064940-1-rdunlap@infradead.org
Signed-off-by: Nishanth Menon <nm@ti.com>
include/linux/soc/ti/knav_dma.h

index 18d806a8e52c84500db34dc38e25b6cefcc0e465..eb1e6b014eaf4059aed35d198289094f962598f1 100644 (file)
@@ -75,7 +75,7 @@ enum knav_dma_desc_type {
  * struct knav_dma_tx_cfg:     Tx channel configuration
  * @filt_einfo:                        Filter extended packet info
  * @filt_pswords:              Filter PS words present
- * @knav_dma_tx_priority:      Tx channel scheduling priority
+ * @priority:                  Tx channel scheduling priority
  */
 struct knav_dma_tx_cfg {
        bool                            filt_einfo;
@@ -87,13 +87,13 @@ struct knav_dma_tx_cfg {
  * struct knav_dma_rx_cfg:     Rx flow configuration
  * @einfo_present:             Extended packet info present
  * @psinfo_present:            PS words present
- * @knav_dma_rx_err_mode:      Error during buffer starvation
- * @knav_dma_desc_type:        Host or Monolithic desc
+ * @err_mode:                  Error during buffer starvation
+ * @desc_type:                 Host or Monolithic desc
  * @psinfo_at_sop:             PS word located at start of packet
  * @sop_offset:                        Start of packet offset
  * @dst_q:                     Destination queue for a given flow
  * @thresh:                    Rx flow size threshold
- * @fdq[]:                     Free desc Queue array
+ * @fdq:                       Free desc Queue array
  * @sz_thresh0:                        RX packet size threshold 0
  * @sz_thresh1:                        RX packet size threshold 1
  * @sz_thresh2:                        RX packet size threshold 2
@@ -115,7 +115,8 @@ struct knav_dma_rx_cfg {
 
 /**
  * struct knav_dma_cfg:        Pktdma channel configuration
- * @sl_cfg:                    Slave configuration
+ * @direction:                 DMA transfer mode and direction
+ * @u:                         union containing @tx or @rx
  * @tx:                                Tx channel configuration
  * @rx:                                Rx flow configuration
  */