From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Peter Chen <peter.chen@kernel.org>,
Pawel Laszczak <pawell@cadence.com>,
Roger Quadros <rogerq@kernel.org>,
Aswath Govindraju <a-govindraju@ti.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Pawel Jez <pjez@cadence.com>,
linux-usb@vger.kernel.org
Subject: [PATCH 07/24] usb: cdns3: cdns3-gadget: Fix a bunch of kernel-doc related formatting issues
Date: Wed, 26 May 2021 14:00:20 +0100 [thread overview]
Message-ID: <20210526130037.856068-8-lee.jones@linaro.org> (raw)
In-Reply-To: <20210526130037.856068-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/usb/cdns3/cdns3-gadget.c:163: warning: expecting prototype for select_ep(). Prototype was for cdns3_select_ep() instead
drivers/usb/cdns3/cdns3-gadget.c:2025: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2224: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2247: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2264: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2399: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2489: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2589: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2656: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2677: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2722: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2768: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2877: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2923: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/usb/cdns3/cdns3-gadget.c:2986: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
Cc: Peter Chen <peter.chen@kernel.org>
Cc: Pawel Laszczak <pawell@cadence.com>
Cc: Roger Quadros <rogerq@kernel.org>
Cc: Aswath Govindraju <a-govindraju@ti.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Pawel Jez <pjez@cadence.com>
Cc: linux-usb@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/usb/cdns3/cdns3-gadget.c | 34 ++++++++++++++++----------------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
index f3c027653e0e6..54fa429fae777 100644
--- a/drivers/usb/cdns3/cdns3-gadget.c
+++ b/drivers/usb/cdns3/cdns3-gadget.c
@@ -155,7 +155,7 @@ static struct cdns3_request *cdns3_next_priv_request(struct list_head *list)
}
/**
- * select_ep - selects endpoint
+ * cdns3_select_ep - selects endpoint
* @priv_dev: extended gadget object
* @ep: endpoint address
*/
@@ -1835,7 +1835,7 @@ __must_hold(&priv_dev->lock)
}
/**
- * cdns3_device_irq_handler- interrupt handler for device part of controller
+ * cdns3_device_irq_handler - interrupt handler for device part of controller
*
* @irq: irq number for cdns3 core device
* @data: structure of cdns3
@@ -1879,7 +1879,7 @@ static irqreturn_t cdns3_device_irq_handler(int irq, void *data)
}
/**
- * cdns3_device_thread_irq_handler- interrupt handler for device part
+ * cdns3_device_thread_irq_handler - interrupt handler for device part
* of controller
*
* @irq: irq number for cdns3 core device
@@ -2022,7 +2022,7 @@ static void cdns3_configure_dmult(struct cdns3_device *priv_dev,
}
/**
- * cdns3_ep_config Configure hardware endpoint
+ * cdns3_ep_config - Configure hardware endpoint
* @priv_ep: extended endpoint object
* @enable: set EP_CFG_ENABLE bit in ep_cfg register.
*/
@@ -2221,7 +2221,7 @@ usb_ep *cdns3_gadget_match_ep(struct usb_gadget *gadget,
}
/**
- * cdns3_gadget_ep_alloc_request Allocates request
+ * cdns3_gadget_ep_alloc_request - Allocates request
* @ep: endpoint object associated with request
* @gfp_flags: gfp flags
*
@@ -2244,7 +2244,7 @@ struct usb_request *cdns3_gadget_ep_alloc_request(struct usb_ep *ep,
}
/**
- * cdns3_gadget_ep_free_request Free memory occupied by request
+ * cdns3_gadget_ep_free_request - Free memory occupied by request
* @ep: endpoint object associated with request
* @request: request to free memory
*/
@@ -2261,7 +2261,7 @@ void cdns3_gadget_ep_free_request(struct usb_ep *ep,
}
/**
- * cdns3_gadget_ep_enable Enable endpoint
+ * cdns3_gadget_ep_enable - Enable endpoint
* @ep: endpoint object
* @desc: endpoint descriptor
*
@@ -2396,7 +2396,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep,
}
/**
- * cdns3_gadget_ep_disable Disable endpoint
+ * cdns3_gadget_ep_disable - Disable endpoint
* @ep: endpoint object
*
* Returns 0 on success, error code elsewhere
@@ -2486,7 +2486,7 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep)
}
/**
- * cdns3_gadget_ep_queue Transfer data on endpoint
+ * cdns3_gadget_ep_queue - Transfer data on endpoint
* @ep: endpoint object
* @request: request object
* @gfp_flags: gfp flags
@@ -2586,7 +2586,7 @@ static int cdns3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request,
}
/**
- * cdns3_gadget_ep_dequeue Remove request from transfer queue
+ * cdns3_gadget_ep_dequeue - Remove request from transfer queue
* @ep: endpoint object associated with request
* @request: request object
*
@@ -2653,7 +2653,7 @@ int cdns3_gadget_ep_dequeue(struct usb_ep *ep,
}
/**
- * __cdns3_gadget_ep_set_halt Sets stall on selected endpoint
+ * __cdns3_gadget_ep_set_halt - Sets stall on selected endpoint
* Should be called after acquiring spin_lock and selecting ep
* @priv_ep: endpoint object to set stall on.
*/
@@ -2674,7 +2674,7 @@ void __cdns3_gadget_ep_set_halt(struct cdns3_endpoint *priv_ep)
}
/**
- * __cdns3_gadget_ep_clear_halt Clears stall on selected endpoint
+ * __cdns3_gadget_ep_clear_halt - Clears stall on selected endpoint
* Should be called after acquiring spin_lock and selecting ep
* @priv_ep: endpoint object to clear stall on
*/
@@ -2719,7 +2719,7 @@ int __cdns3_gadget_ep_clear_halt(struct cdns3_endpoint *priv_ep)
}
/**
- * cdns3_gadget_ep_set_halt Sets/clears stall on selected endpoint
+ * cdns3_gadget_ep_set_halt - Sets/clears stall on selected endpoint
* @ep: endpoint object to set/clear stall on
* @value: 1 for set stall, 0 for clear stall
*
@@ -2765,7 +2765,7 @@ static const struct usb_ep_ops cdns3_gadget_ep_ops = {
};
/**
- * cdns3_gadget_get_frame Returns number of actual ITP frame
+ * cdns3_gadget_get_frame - Returns number of actual ITP frame
* @gadget: gadget object
*
* Returns number of actual ITP frame
@@ -2874,7 +2874,7 @@ static void cdns3_gadget_config(struct cdns3_device *priv_dev)
}
/**
- * cdns3_gadget_udc_start Gadget start
+ * cdns3_gadget_udc_start - Gadget start
* @gadget: gadget object
* @driver: driver which operates on this gadget
*
@@ -2920,7 +2920,7 @@ static int cdns3_gadget_udc_start(struct usb_gadget *gadget,
}
/**
- * cdns3_gadget_udc_stop Stops gadget
+ * cdns3_gadget_udc_stop - Stops gadget
* @gadget: gadget object
*
* Returns 0
@@ -2983,7 +2983,7 @@ static void cdns3_free_all_eps(struct cdns3_device *priv_dev)
}
/**
- * cdns3_init_eps Initializes software endpoints of gadget
+ * cdns3_init_eps - Initializes software endpoints of gadget
* @priv_dev: extended gadget object
*
* Returns 0 on success, error code elsewhere
--
2.31.1
next prev parent reply other threads:[~2021-05-26 13:01 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-26 13:00 [PATCH 00/24] Rid W=1 warnings from USB Lee Jones
2021-05-26 13:00 ` Lee Jones
2021-05-26 13:00 ` [PATCH 01/24] usb: cdns3: core: Fix a couple of incorrectly documented function names Lee Jones
2021-05-26 13:00 ` [PATCH 02/24] usb: dwc2: platform: Provide function name for 'dwc2_check_core_version()' Lee Jones
2021-05-26 15:10 ` Minas Harutyunyan
2021-05-26 13:00 ` [PATCH 03/24] usb: common: ulpi: Add leading underscores for function name '__ulpi_register_driver()' Lee Jones
2021-05-26 14:35 ` Heikki Krogerus
2021-05-26 13:00 ` [PATCH 04/24] usb: cdns3: cdns3-plat: Fix incorrect naming of function 'cdns3_plat_remove()' Lee Jones
2021-05-26 13:00 ` [PATCH 05/24] usb: dwc2: params: Fix naming of 'dwc2_get_hwparams()' in the docs Lee Jones
2021-05-26 15:10 ` Minas Harutyunyan
2021-05-26 13:00 ` [PATCH 06/24] usb: isp1760: isp1760-udc: Provide missing description for 'udc' param Lee Jones
2021-05-26 14:11 ` Rui Miguel Silva
2021-05-26 13:00 ` Lee Jones [this message]
2021-05-26 13:00 ` [PATCH 08/24] usb: cdns3: cdns3-ti: File headers are not good candidates for kernel-doc Lee Jones
2021-05-26 13:00 ` [PATCH 09/24] usb: cdns3: cdns3-ep0: Fix a few kernel-doc formatting issues Lee Jones
2021-05-26 13:00 ` [PATCH 10/24] usb: cdns3: cdns3-imx: File headers are not good candidates for kernel-doc Lee Jones
2021-05-26 13:00 ` Lee Jones
2021-05-26 13:00 ` [PATCH 11/24] usb: dwc2: hcd_queue: Fix typeo in function name 'dwc2_hs_pmap_unschedule()' Lee Jones
2021-05-26 15:11 ` Minas Harutyunyan
2021-05-26 13:00 ` [PATCH 12/24] usb: dwc2: pci: Fix possible copy/paste issue Lee Jones
2021-05-26 15:11 ` Minas Harutyunyan
2021-05-26 13:00 ` [PATCH 13/24] usb: chipidea: core: Fix incorrectly documented function 'ci_usb_phy_exit()' Lee Jones
2021-05-26 14:24 ` Sergei Shtylyov
2021-05-26 14:42 ` Lee Jones
2021-05-26 13:00 ` [PATCH 14/24] usb: chipidea: otg: Fix formatting and missing documentation issues Lee Jones
2021-05-26 13:00 ` [PATCH 15/24] usb: dwc2: gadget: Repair 'dwc2_hsotg_core_init_disconnected()'s documentation Lee Jones
2021-05-26 15:11 ` Minas Harutyunyan
2021-05-26 13:00 ` [PATCH 16/24] usb: chipidea: udc: Fix incorrectly documented function 'hw_port_is_high_speed()' Lee Jones
2021-05-26 13:00 ` [PATCH 17/24] usb: host: xhci: Remove unused variable 'len' Lee Jones
2021-05-27 7:26 ` Greg Kroah-Hartman
2021-05-27 8:16 ` Lee Jones
2021-05-27 9:23 ` Mathias Nyman
2021-05-27 9:50 ` Greg Kroah-Hartman
2021-05-27 11:06 ` Lee Jones
2021-05-26 13:00 ` [PATCH 18/24] usb: gadget: udc: pxa27x_udc: Fix documentation for 'pxa27x_udc_start()' Lee Jones
2021-05-26 13:00 ` Lee Jones
2021-05-26 13:18 ` Daniel Mack
2021-05-26 13:18 ` Daniel Mack
2021-05-26 13:00 ` [PATCH 19/24] usb: gadget: udc: udc-xilinx: Place correct function names into the headers Lee Jones
2021-05-26 13:00 ` Lee Jones
2021-05-26 13:00 ` [PATCH 20/24] usb: cdns3: cdns3-gadget: Provide correct function naming for '__cdns3_gadget_ep_queue()' Lee Jones
2021-05-26 13:00 ` [PATCH 21/24] usb: host: xhci: Move array of structs from the stack onto the heap Lee Jones
2021-05-26 14:21 ` Sergei Shtylyov
2021-05-26 14:44 ` Lee Jones
2021-05-26 14:59 ` Sergei Shtylyov
2021-05-26 15:28 ` Lee Jones
2021-05-27 11:36 ` Mathias Nyman
2021-06-01 9:25 ` Lee Jones
2021-06-22 10:47 ` Lee Jones
2021-06-22 11:32 ` Mathias Nyman
2021-05-26 13:00 ` [PATCH 22/24] usb: host: xhci: Document xhci_get_endpoint_index()'s 'desc' param Lee Jones
2021-05-26 13:00 ` [PATCH 23/24] usb: cdns3: cdnsp-gadget: Provide function name for 'cdnsp_find_next_ext_cap()' Lee Jones
2021-05-26 13:00 ` [PATCH 24/24] usb: typec: ucsi: Fix copy/paste issue for 'ucsi_set_drvdata()' Lee Jones
2021-05-26 14:34 ` Heikki Krogerus
2021-05-27 1:46 ` [PATCH 00/24] Rid W=1 warnings from USB Peter Chen
2021-05-27 1:46 ` Peter Chen
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=20210526130037.856068-8-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=a-govindraju@ti.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=pawell@cadence.com \
--cc=peter.chen@kernel.org \
--cc=pjez@cadence.com \
--cc=rogerq@kernel.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 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.