mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Vinod Koul <vkoul@kernel.org>
To: linux-kernel@vger.kernel.org, Randy Dunlap <rdunlap@infradead.org>
Cc: Peter Ujfalusi <peter.ujfalusi@gmail.com>,
	 Frank Li <Frank.Li@kernel.org>,
	dmaengine@vger.kernel.org
Subject: Re: [PATCH] dmaengine: ti-cppi5: fix all kernel-doc warnings
Date: Mon, 09 Mar 2026 08:46:36 +0100	[thread overview]
Message-ID: <177304239656.87946.18319548971940689143.b4-ty@kernel.org> (raw)
In-Reply-To: <20260301011213.3063688-1-rdunlap@infradead.org>


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



      reply	other threads:[~2026-03-09  7:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-01  1:12 Randy Dunlap
2026-03-09  7:46 ` Vinod Koul [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=177304239656.87946.18319548971940689143.b4-ty@kernel.org \
    --to=vkoul@kernel.org \
    --cc=Frank.Li@kernel.org \
    --cc=dmaengine@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=peter.ujfalusi@gmail.com \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®