Re: [PATCH] dmaengine: ti-cppi5: fix all kernel-doc warnings
From: Vinod Koul
Date: Mon Mar 09 2026 - 03:51:26 EST
On Sat, 28 Feb 2026 17:12:13 -0800, Randy Dunlap wrote:
> Add missing struct member, function parameter, and enum value descriptions.
> Add missing function Returns: sections.
> Use correct function name in kernel-doc to avoid mismatched prototypes.
>
> These repair all kernel-doc warnings in ti-cppi5.h:
>
> Warning: include/linux/dma/ti-cppi5.h:27 struct member 'pkt_info1' not
> described in 'cppi5_desc_hdr_t'
> Warning: include/linux/dma/ti-cppi5.h:27 struct member 'pkt_info2' not
> described in 'cppi5_desc_hdr_t'
> Warning: include/linux/dma/ti-cppi5.h:50 struct member 'epib' not
> described in 'cppi5_host_desc_t'
> Warning: include/linux/dma/ti-cppi5.h:142 struct member 'epib' not
> described in 'cppi5_monolithic_desc_t'
> Warning: include/linux/dma/ti-cppi5.h:413 function parameter 'pkt_len'
> not described in 'cppi5_hdesc_set_pktlen'
> Warning: include/linux/dma/ti-cppi5.h:436 function parameter 'ps_flags'
> not described in 'cppi5_hdesc_set_psflags'
> Warning: include/linux/dma/ti-cppi5.h:509 function parameter 'hbuf_desc'
> not described in 'cppi5_hdesc_link_hbdesc'
> Warning: include/linux/dma/ti-cppi5.h:839 struct member 'dicnt3' not
> described in 'cppi5_tr_type15_t'
> Warning: include/linux/dma/ti-cppi5.h:970 function parameter 'desc_hdr'
> not described in 'cppi5_trdesc_init'
> Warning: include/linux/dma/ti-cppi5.h:184 No description found for
> return value of 'cppi5_desc_is_tdcm'
> Warning: include/linux/dma/ti-cppi5.h:198 No description found for
> return value of 'cppi5_desc_get_type'
> Warning: include/linux/dma/ti-cppi5.h:210 No description found for
> return value of 'cppi5_desc_get_errflags'
> Warning: include/linux/dma/ti-cppi5.h:448 expecting prototype for
> cppi5_hdesc_get_errflags(). Prototype was for cppi5_hdesc_get_pkttype()
> instead
> Warning: include/linux/dma/ti-cppi5.h:460 expecting prototype for
> cppi5_hdesc_get_errflags(). Prototype was for cppi5_hdesc_set_pkttype()
> instead
> Warning: include/linux/dma/ti-cppi5.h:1053 expecting prototype for
> cppi5_tr_cflag_set(). Prototype was for cppi5_tr_csf_set() instead
> Warning: include/linux/dma/ti-cppi5.h:651 Enum value 'CPPI5_TR_TYPE_MAX'
> not described in enum 'cppi5_tr_types'
> Warning: include/linux/dma/ti-cppi5.h:676 Enum value
> 'CPPI5_TR_EVENT_SIZE_MAX' not described in enum 'cppi5_tr_event_size'
> Warning: include/linux/dma/ti-cppi5.h:693 Enum value 'CPPI5_TR_TRIGGER_MAX'
> not described in enum 'cppi5_tr_trigger'
> Warning: include/linux/dma/ti-cppi5.h:714 Enum value
> 'CPPI5_TR_TRIGGER_TYPE_MAX' not described in enum 'cppi5_tr_trigger_type'
> Warning: include/linux/dma/ti-cppi5.h:890 Enum value
> 'CPPI5_TR_RESPONSE_STATUS_MAX' not described in enum
> 'cppi5_tr_resp_status_type'
> Warning: include/linux/dma/ti-cppi5.h:906 Enum value
> 'CPPI5_TR_RESPONSE_STATUS_SUBMISSION_MAX' not described in enum
> 'cppi5_tr_resp_status_submission'
> Warning: include/linux/dma/ti-cppi5.h:934 Enum value
> 'CPPI5_TR_RESPONSE_STATUS_UNSUPPORTED_MAX' not described in enum
> 'cppi5_tr_resp_status_unsupported'
>
> [...]
Applied, thanks!
[1/1] dmaengine: ti-cppi5: fix all kernel-doc warnings
commit: 70fbea9f1a44d80a4c573c225f119022d6e21360
Best regards,
--
~Vinod