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 14/30] usb: cdns3: ep0: Fix a bunch of kerneldoc issues Date: Thu, 2 Jul 2020 15:46:09 +0100 [thread overview] Message-ID: <20200702144625.2533530-15-lee.jones@linaro.org> (raw) In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org> Add some missing function argument descriptions for 'ep', 'desc' and 'zlp', and correct spelling/bitrot issues surrounding the correct spelling of present args. Fixes the following W=1 warnings: drivers/usb/cdns3/ep0.c:36: warning: Function parameter or member 'zlp' not described in 'cdns3_ep0_run_transfer' drivers/usb/cdns3/ep0.c:236: warning: Function parameter or member 'ctrl' not described in 'cdns3_req_ep0_get_status' drivers/usb/cdns3/ep0.c:236: warning: Excess function parameter 'ctrl_req' description in 'cdns3_req_ep0_get_status' drivers/usb/cdns3/ep0.c:411: warning: Function parameter or member 'ctrl' not described in 'cdns3_req_ep0_handle_feature' drivers/usb/cdns3/ep0.c:411: warning: Excess function parameter 'ctrl_req' description in 'cdns3_req_ep0_handle_feature' drivers/usb/cdns3/ep0.c:661: warning: Function parameter or member 'ep' not described in 'cdns3_gadget_ep0_enable' drivers/usb/cdns3/ep0.c:661: warning: Function parameter or member 'desc' not described in 'cdns3_gadget_ep0_enable' drivers/usb/cdns3/ep0.c:671: warning: Function parameter or member 'ep' not described in 'cdns3_gadget_ep0_disable' drivers/usb/cdns3/ep0.c:867: warning: Function parameter or member 'priv_ep' not described in 'cdns3_init_ep0' drivers/usb/cdns3/ep0.c:867: warning: Excess function parameter 'ep_priv' description in 'cdns3_init_ep0' 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/ep0.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/drivers/usb/cdns3/ep0.c b/drivers/usb/cdns3/ep0.c index 82645a2a0f529..5b3f682338e50 100644 --- a/drivers/usb/cdns3/ep0.c +++ b/drivers/usb/cdns3/ep0.c @@ -227,7 +227,7 @@ static int cdns3_req_ep0_set_address(struct cdns3_device *priv_dev, /** * cdns3_req_ep0_get_status - Handling of GET_STATUS standard USB request * @priv_dev: extended gadget object - * @ctrl_req: pointer to received setup packet + * @ctrl: pointer to received setup packet * * Returns 0 if success, error code on error */ @@ -400,7 +400,7 @@ static int cdns3_ep0_feature_handle_endpoint(struct cdns3_device *priv_dev, * Handling of GET/SET_FEATURE standard USB request * * @priv_dev: extended gadget object - * @ctrl_req: pointer to received setup packet + * @ctrl: pointer to received setup packet * @set: must be set to 1 for SET_FEATURE request * * Returns 0 if success, error code on error @@ -653,6 +653,9 @@ void cdns3_check_ep0_interrupt_proceed(struct cdns3_device *priv_dev, int dir) /** * cdns3_gadget_ep0_enable + * @ep: pointer to endpoint zero object + * @desc: pointer to usb endpoint descriptor + * * Function shouldn't be called by gadget driver, * endpoint 0 is allways active */ @@ -664,6 +667,8 @@ static int cdns3_gadget_ep0_enable(struct usb_ep *ep, /** * cdns3_gadget_ep0_disable + * @ep: pointer to endpoint zero object + * * Function shouldn't be called by gadget driver, * endpoint 0 is allways active */ @@ -690,6 +695,7 @@ static int cdns3_gadget_ep0_set_halt(struct usb_ep *ep, int value) * @ep: pointer to endpoint zero object * @request: pointer to request object * @gfp_flags: gfp flags + * @zlp: add zero length packet * * Returns 0 on success, error code elsewhere */ @@ -858,7 +864,7 @@ void cdns3_ep0_config(struct cdns3_device *priv_dev) /** * cdns3_init_ep0 Initializes software endpoint 0 of gadget * @priv_dev: extended gadget object - * @ep_priv: extended endpoint object + * @priv_ep: extended endpoint object * * Returns 0 on success else error code. */ -- 2.25.1
WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org> To: gregkh@linuxfoundation.org Cc: Peter Chen <peter.chen@nxp.com>, Pawel Laszczak <pawell@cadence.com>, Pawel Jez <pjez@cadence.com>, linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org, Lee Jones <lee.jones@linaro.org>, linux-arm-kernel@lists.infradead.org Subject: [PATCH 14/30] usb: cdns3: ep0: Fix a bunch of kerneldoc issues Date: Thu, 2 Jul 2020 15:46:09 +0100 [thread overview] Message-ID: <20200702144625.2533530-15-lee.jones@linaro.org> (raw) In-Reply-To: <20200702144625.2533530-1-lee.jones@linaro.org> Add some missing function argument descriptions for 'ep', 'desc' and 'zlp', and correct spelling/bitrot issues surrounding the correct spelling of present args. Fixes the following W=1 warnings: drivers/usb/cdns3/ep0.c:36: warning: Function parameter or member 'zlp' not described in 'cdns3_ep0_run_transfer' drivers/usb/cdns3/ep0.c:236: warning: Function parameter or member 'ctrl' not described in 'cdns3_req_ep0_get_status' drivers/usb/cdns3/ep0.c:236: warning: Excess function parameter 'ctrl_req' description in 'cdns3_req_ep0_get_status' drivers/usb/cdns3/ep0.c:411: warning: Function parameter or member 'ctrl' not described in 'cdns3_req_ep0_handle_feature' drivers/usb/cdns3/ep0.c:411: warning: Excess function parameter 'ctrl_req' description in 'cdns3_req_ep0_handle_feature' drivers/usb/cdns3/ep0.c:661: warning: Function parameter or member 'ep' not described in 'cdns3_gadget_ep0_enable' drivers/usb/cdns3/ep0.c:661: warning: Function parameter or member 'desc' not described in 'cdns3_gadget_ep0_enable' drivers/usb/cdns3/ep0.c:671: warning: Function parameter or member 'ep' not described in 'cdns3_gadget_ep0_disable' drivers/usb/cdns3/ep0.c:867: warning: Function parameter or member 'priv_ep' not described in 'cdns3_init_ep0' drivers/usb/cdns3/ep0.c:867: warning: Excess function parameter 'ep_priv' description in 'cdns3_init_ep0' 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/ep0.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/drivers/usb/cdns3/ep0.c b/drivers/usb/cdns3/ep0.c index 82645a2a0f529..5b3f682338e50 100644 --- a/drivers/usb/cdns3/ep0.c +++ b/drivers/usb/cdns3/ep0.c @@ -227,7 +227,7 @@ static int cdns3_req_ep0_set_address(struct cdns3_device *priv_dev, /** * cdns3_req_ep0_get_status - Handling of GET_STATUS standard USB request * @priv_dev: extended gadget object - * @ctrl_req: pointer to received setup packet + * @ctrl: pointer to received setup packet * * Returns 0 if success, error code on error */ @@ -400,7 +400,7 @@ static int cdns3_ep0_feature_handle_endpoint(struct cdns3_device *priv_dev, * Handling of GET/SET_FEATURE standard USB request * * @priv_dev: extended gadget object - * @ctrl_req: pointer to received setup packet + * @ctrl: pointer to received setup packet * @set: must be set to 1 for SET_FEATURE request * * Returns 0 if success, error code on error @@ -653,6 +653,9 @@ void cdns3_check_ep0_interrupt_proceed(struct cdns3_device *priv_dev, int dir) /** * cdns3_gadget_ep0_enable + * @ep: pointer to endpoint zero object + * @desc: pointer to usb endpoint descriptor + * * Function shouldn't be called by gadget driver, * endpoint 0 is allways active */ @@ -664,6 +667,8 @@ static int cdns3_gadget_ep0_enable(struct usb_ep *ep, /** * cdns3_gadget_ep0_disable + * @ep: pointer to endpoint zero object + * * Function shouldn't be called by gadget driver, * endpoint 0 is allways active */ @@ -690,6 +695,7 @@ static int cdns3_gadget_ep0_set_halt(struct usb_ep *ep, int value) * @ep: pointer to endpoint zero object * @request: pointer to request object * @gfp_flags: gfp flags + * @zlp: add zero length packet * * Returns 0 on success, error code elsewhere */ @@ -858,7 +864,7 @@ void cdns3_ep0_config(struct cdns3_device *priv_dev) /** * cdns3_init_ep0 Initializes software endpoint 0 of gadget * @priv_dev: extended gadget object - * @ep_priv: extended endpoint object + * @priv_ep: extended endpoint object * * Returns 0 on success else error code. */ -- 2.25.1 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-07-02 14:48 UTC|newest] Thread overview: 95+ 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 ` 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 ` 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-02 14:45 ` Lee Jones 2020-07-03 10:22 ` Mathias Nyman 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 ` 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:45 ` 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 ` Lee Jones 2020-07-02 14:46 ` [PATCH 06/30] usb: dwc3: ulpi: " Lee Jones 2020-07-02 14:46 ` 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 ` 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 ` Lee Jones 2020-07-02 14:46 ` [PATCH 09/30] usb: dwc2: gadget: Do not read GINTMSK2 Lee Jones 2020-07-02 14:46 ` 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 ` Lee Jones 2020-07-02 14:46 ` [PATCH 11/30] usb: dwc2: gadget: Avoid pointless read of EP control register Lee Jones 2020-07-02 14:46 ` Lee Jones 2020-07-03 7:29 ` Greg KH 2020-07-03 7:29 ` Greg KH 2020-07-03 7:38 ` Minas Harutyunyan 2020-07-03 7:38 ` Minas Harutyunyan 2020-07-03 7:43 ` Greg KH 2020-07-03 7:43 ` Greg KH 2020-07-03 8:35 ` Minas Harutyunyan 2020-07-03 8:35 ` Minas Harutyunyan 2020-07-03 17:16 ` Lee Jones 2020-07-03 17:16 ` Lee Jones 2020-07-04 6:04 ` Greg KH 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 ` 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 ` Lee Jones 2020-07-02 14:46 ` Lee Jones [this message] 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 ` Lee Jones 2020-07-02 14:46 ` [PATCH 16/30] usb: mtu3: mtu3_trace: " Lee Jones 2020-07-02 14:46 ` Lee Jones 2020-07-02 14:46 ` Lee Jones 2020-07-03 1:41 ` Chunfeng Yun 2020-07-03 1:41 ` Chunfeng Yun 2020-07-03 1:41 ` Chunfeng Yun 2020-07-02 14:46 ` [PATCH 17/30] usb: cdns3: gadget: Fix a bunch of kernel doc issues Lee Jones 2020-07-02 14:46 ` Lee Jones 2020-07-02 14:46 ` [PATCH 18/30] usb: dwc3: dwc3-of-simple: Function headers are not good candidates for kerneldoc Lee Jones 2020-07-02 14:46 ` 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 ` 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 ` 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 ` 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 ` 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-02 14:46 ` Lee Jones 2020-07-03 7:36 ` Greg KH 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-02 14:46 ` Lee Jones 2020-07-02 14:46 ` Lee Jones 2020-07-03 5:41 ` kernel test robot 2020-07-03 5:41 ` kernel test robot 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 ` Lee Jones 2020-07-02 14:46 ` 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 ` 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-02 14:46 ` Lee Jones 2020-07-03 7:32 ` Greg KH 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-02 14:46 ` Lee Jones 2020-07-03 7:34 ` Greg KH 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 ` 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-02 14:46 ` Lee Jones 2020-07-03 7:37 ` [PATCH 00/30] Fix a bunch of W=1 issues in USB Greg KH 2020-07-03 7:37 ` Greg KH 2020-07-03 17:21 ` Lee Jones 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-15-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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.