From: Lee Jones <lee.jones@linaro.org>
To: gregkh@linuxfoundation.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org,
Lee Jones <lee.jones@linaro.org>,
Pawel Laszczak <pawell@cadence.com>, Pawel Jez <pjez@cadence.com>,
Peter Chen <peter.chen@nxp.com>
Subject: [PATCH 17/30] usb: cdns3: gadget: Fix a bunch of kernel doc issues
Date: Thu, 2 Jul 2020 15:46:12 +0100 [thread overview]
Message-ID: <20200702144625.2533530-18-lee.jones@linaro.org> (raw)
In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org>
Mainline misspelled function argument descriptions. Also one
formatting issue with a missing '@' identifier.
Fixes the following W=1 build warnings:
drivers/usb/cdns3/gadget.c:653: warning: Function parameter or member 'priv_ep' not described in 'cdns3_wa2_descmissing_packet'
drivers/usb/cdns3/gadget.c:653: warning: Excess function parameter 'priv_dev' description in 'cdns3_wa2_descmissing_packet'
drivers/usb/cdns3/gadget.c:1088: warning: Function parameter or member 'request' not described in 'cdns3_ep_run_transfer'
drivers/usb/cdns3/gadget.c:2574: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_set_halt'
drivers/usb/cdns3/gadget.c:2574: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_set_halt'
drivers/usb/cdns3/gadget.c:2595: warning: Function parameter or member 'priv_ep' not described in '__cdns3_gadget_ep_clear_halt'
drivers/usb/cdns3/gadget.c:2595: warning: Excess function parameter 'ep' description in '__cdns3_gadget_ep_clear_halt'
drivers/usb/cdns3/gadget.c:2898: warning: Function parameter or member 'priv_dev' not described in 'cdns3_init_eps'
drivers/usb/cdns3/gadget.c:2898: warning: Excess function parameter 'cdns3' description in 'cdns3_init_eps'
drivers/usb/cdns3/gadget.c:3210: warning: Function parameter or member 'cdns' not described in 'cdns3_gadget_init'
Cc: Pawel Laszczak <pawell@cadence.com>
Cc: Pawel Jez <pjez@cadence.com>
Cc: Peter Chen <peter.chen@nxp.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/usb/cdns3/gadget.c | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c
index 5e24c2e57c0d8..bfb1cbd492892 100644
--- a/drivers/usb/cdns3/gadget.c
+++ b/drivers/usb/cdns3/gadget.c
@@ -644,7 +644,7 @@ static void cdns3_wa2_remove_old_request(struct cdns3_endpoint *priv_ep)
/**
* cdns3_wa2_descmissing_packet - handles descriptor missing event.
- * @priv_dev: extended gadget object
+ * @priv_ep: extended gadget object
*
* This function is used only for WA2. For more information see Work around 2
* description.
@@ -1080,6 +1080,7 @@ static int cdns3_ep_run_stream_transfer(struct cdns3_endpoint *priv_ep,
/**
* cdns3_ep_run_transfer - start transfer on no-default endpoint hardware
* @priv_ep: endpoint object
+ * @request: request object
*
* Returns zero on success or negative value on failure
*/
@@ -2568,7 +2569,7 @@ int cdns3_gadget_ep_dequeue(struct usb_ep *ep,
/**
* __cdns3_gadget_ep_set_halt Sets stall on selected endpoint
* Should be called after acquiring spin_lock and selecting ep
- * @ep: endpoint object to set stall on.
+ * @priv_ep: endpoint object to set stall on.
*/
void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep)
{
@@ -2589,7 +2590,7 @@ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep)
/**
* __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint
* Should be called after acquiring spin_lock and selecting ep
- * @ep: endpoint object to clear stall on
+ * @priv_ep: endpoint object to clear stall on
*/
int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep)
{
@@ -2890,7 +2891,7 @@ static void cdns3_free_all_eps(struct cdns3_device *priv_dev)
/**
* cdns3_init_eps Initializes software endpoints of gadget
- * @cdns3: extended gadget object
+ * @priv_dev: extended gadget object
*
* Returns 0 on success, error code elsewhere
*/
@@ -3202,7 +3203,7 @@ static int cdns3_gadget_resume(struct cdns3 *cdns, bool hibernated)
/**
* cdns3_gadget_init - initialize device structure
*
- * cdns: cdns3 instance
+ * @cdns: cdns3 instance
*
* This function initializes the gadget.
*/
--
2.25.1
next prev parent reply other threads:[~2020-07-02 14:48 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-02 14:45 [PATCH 00/30] Fix a bunch of W=1 issues in USB Lee Jones
2020-07-02 14:45 ` [PATCH 01/30] usb: phy: phy: Fix-up a whole bunch of formatting issues Lee Jones
2020-07-02 14:45 ` [PATCH 02/30] usb: host: pci-quirks: Demote function header from kerneldoc to comment block Lee Jones
2020-07-03 10:22 ` Mathias Nyman
2020-07-02 14:45 ` [PATCH 03/30] usb: common: debug: Demote comment blocks which are obviously not kerneldoc Lee Jones
2020-07-02 14:45 ` [PATCH 04/30] usb: common: usb-conn-gpio: Demote comment block which is clearly " Lee Jones
2020-07-02 14:46 ` [PATCH 05/30] usb: dwc3: drd: File headers are not doc headers Lee Jones
2020-07-02 14:46 ` [PATCH 06/30] usb: dwc3: ulpi: " Lee Jones
2020-07-02 14:46 ` [PATCH 07/30] usb: common: ulpi: Fix a few kerneldoc related issues Lee Jones
2020-07-02 14:46 ` [PATCH 08/30] usb: dwc3: dwc3-omap: Do not read DMA status Lee Jones
2020-07-02 14:46 ` [PATCH 09/30] usb: dwc2: gadget: Do not read GINTMSK2 Lee Jones
2020-07-02 14:46 ` [PATCH 10/30] usb: dwc2: gadget: Remove assigned but never used 'maxsize' Lee Jones
2020-07-02 14:46 ` [PATCH 11/30] usb: dwc2: gadget: Avoid pointless read of EP control register Lee Jones
2020-07-03 7:29 ` Greg KH
2020-07-03 7:38 ` Minas Harutyunyan
2020-07-03 7:43 ` Greg KH
2020-07-03 8:35 ` Minas Harutyunyan
2020-07-03 17:16 ` Lee Jones
2020-07-04 6:04 ` Greg KH
2020-07-02 14:46 ` [PATCH 12/30] usb: host: ehci-omap: Provide documentation for ehci_hcd_omap_probe()'s arg 'pdev' Lee Jones
2020-07-02 14:46 ` [PATCH 13/30] usb: cdns3: core: Fix incorrect formatting and misspelled function arg docs Lee Jones
2020-07-02 14:46 ` [PATCH 14/30] usb: cdns3: ep0: Fix a bunch of kerneldoc issues Lee Jones
2020-07-02 14:46 ` [PATCH 15/30] usb: dwc3: dwc3-haps: Function headers are not suitable for kerneldoc Lee Jones
2020-07-02 14:46 ` [PATCH 16/30] usb: mtu3: mtu3_trace: " Lee Jones
2020-07-03 1:41 ` Chunfeng Yun
2020-07-02 14:46 ` Lee Jones [this message]
2020-07-02 14:46 ` [PATCH 18/30] usb: dwc3: dwc3-of-simple: Function headers are not good candidates " Lee Jones
2020-07-02 14:46 ` [PATCH 19/30] usb: host: isp1362: Mark the many unused ISP1362_REG entries as __maybe_unused Lee Jones
2020-07-02 14:46 ` [PATCH 20/30] usb: host: ohci-at91: Demote kerneldoc headers down to basic comment blocks Lee Jones
2020-07-02 14:46 ` [PATCH 21/30] usb: host: ohci: Mark cc_to_error as __maybe_unused Lee Jones
2020-07-02 14:46 ` [PATCH 22/30] usb: cdns3: ep0: Move 'zlp' description to appropriate function header Lee Jones
2020-07-02 14:46 ` [PATCH 23/30] usb: host: oxu210hp-hcd: Move declaration of 'qtd' into 'ifdef OXU_URB_TRACE' Lee Jones
2020-07-03 7:36 ` Greg KH
2020-07-02 14:46 ` [PATCH 24/30] usb: mtu3: mtu3_trace: Supply missing mtu3_debug.h include file Lee Jones
2020-07-03 5:41 ` kernel test robot
2020-07-02 14:46 ` [PATCH 25/30] usb: mtu3: mtu3_core: Demote obvious misuse of kerneldoc to standard comment block Lee Jones
2020-07-02 14:46 ` [PATCH 26/30] usb: c67x00: c67x00-ll-hpi: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-02 14:46 ` [PATCH 27/30] usb: class: cdc-wdm: Provide description for usb_cdc_wdm_register()'s manage_power arg Lee Jones
2020-07-03 7:32 ` Greg KH
2020-07-02 14:46 ` [PATCH 28/30] usb: c67x00: c67x00-hcd: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-03 7:34 ` Greg KH
2020-07-02 14:46 ` [PATCH 29/30] usb: class: usbtmc: File headers are not good candidates for kerneldoc Lee Jones
2020-07-02 14:46 ` [PATCH 30/30] usb: c67x00: c67x00-sched: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-03 7:37 ` [PATCH 00/30] Fix a bunch of W=1 issues in USB Greg KH
2020-07-03 17:21 ` Lee Jones
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=20200702144625.2533530-18-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=pawell@cadence.com \
--cc=peter.chen@nxp.com \
--cc=pjez@cadence.com \
/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;
as well as URLs for NNTP newsgroup(s).