All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Peter Chen <peter.chen@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linux-usb@vger.kernel.org
Subject: [PATCH 14/24] usb: chipidea: otg: Fix formatting and missing documentation issues
Date: Wed, 26 May 2021 14:00:27 +0100	[thread overview]
Message-ID: <20210526130037.856068-15-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/chipidea/otg.c:25: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/chipidea/otg.c:78: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/usb/chipidea/otg.c:143: 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: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/usb/chipidea/otg.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/drivers/usb/chipidea/otg.c b/drivers/usb/chipidea/otg.c
index d3aada3ce7ec2..8dd59282827b0 100644
--- a/drivers/usb/chipidea/otg.c
+++ b/drivers/usb/chipidea/otg.c
@@ -22,7 +22,7 @@
 #include "otg_fsm.h"
 
 /**
- * hw_read_otgsc returns otgsc register bits value.
+ * hw_read_otgsc - returns otgsc register bits value.
  * @ci: the controller
  * @mask: bitfield mask
  */
@@ -75,7 +75,7 @@ u32 hw_read_otgsc(struct ci_hdrc *ci, u32 mask)
 }
 
 /**
- * hw_write_otgsc updates target bits of OTGSC register.
+ * hw_write_otgsc - updates target bits of OTGSC register.
  * @ci: the controller
  * @mask: bitfield mask
  * @data: to be written
@@ -140,8 +140,9 @@ void ci_handle_vbus_change(struct ci_hdrc *ci)
 }
 
 /**
- * When we switch to device mode, the vbus value should be lower
- * than OTGSC_BSV before connecting to host.
+ * hw_wait_vbus_lower_bsv - When we switch to device mode, the vbus value
+ *                          should be lower than OTGSC_BSV before connecting
+ *                          to host.
  *
  * @ci: the controller
  *
-- 
2.31.1


  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 ` [PATCH 07/24] usb: cdns3: cdns3-gadget: Fix a bunch of kernel-doc related formatting issues Lee Jones
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 ` Lee Jones [this message]
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-15-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=peter.chen@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.