public inbox for linux-arm-kernel@lists.infradead.org
 help / color / mirror / Atom feed
From: Chunfeng Yun <chunfeng.yun@mediatek.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Felipe Balbi <balbi@kernel.org>,
	linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org,
	Chunfeng Yun <chunfeng.yun@mediatek.com>,
	linux-mediatek@lists.infradead.org,
	Matthias Brugger <matthias.bgg@gmail.com>,
	Alan Stern <stern@rowland.harvard.edu>,
	Lee Jones <lee.jones@linaro.org>,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2 11/11] iopoll: update kerneldoc of read_poll_timeout_atomic()
Date: Thu, 20 Aug 2020 13:45:49 +0800	[thread overview]
Message-ID: <1597902349-8998-11-git-send-email-chunfeng.yun@mediatek.com> (raw)
In-Reply-To: <1597902349-8998-1-git-send-email-chunfeng.yun@mediatek.com>

Arguments description of read_poll_timeout_atomic() if out of date,
update it.

Cc: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
---
v2: new patch, suggested by Alan
---
 include/linux/iopoll.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/iopoll.h b/include/linux/iopoll.h
index bc89ac6..2c8860e 100644
--- a/include/linux/iopoll.h
+++ b/include/linux/iopoll.h
@@ -60,8 +60,7 @@
 /**
  * read_poll_timeout_atomic - Periodically poll an address until a condition is
  * 				met or a timeout occurs
- * @op: accessor function (takes @addr as its only argument)
- * @addr: Address to poll
+ * @op: accessor function (takes @args as its arguments)
  * @val: Variable to read the value into
  * @cond: Break condition (usually involving @val)
  * @delay_us: Time to udelay between reads in us (0 tight-loops).  Should
@@ -69,6 +68,7 @@
  *            Documentation/timers/timers-howto.rst).
  * @timeout_us: Timeout in us, 0 means never timeout
  * @delay_before_read: if it is true, delay @delay_us before read.
+ * @args: arguments for @op poll
  *
  * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
  * case, the last read value at @args is stored in @val.
-- 
1.9.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2020-08-20  7:06 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-20  5:45 [PATCH v2 01/11] usb: early: convert to readl_poll_timeout_atomic() Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 02/11] usb: early: ehci-dbgp: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 03/11] usb: pci-quirks: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 04/11] usb: xhci-rcar: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 05/11] usb: oxu210hp-hcd: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 06/11] usb: fotg210-hcd: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 07/11] usb: isp1760-hcd: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 08/11] usb: phy-ulpi-viewport: " Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 09/11] usb: phy: phy-mv-usb: " Chunfeng Yun
2020-08-20 10:17   ` Sergei Shtylyov
2020-08-21  1:52     ` Chunfeng Yun
2020-08-20  5:45 ` [PATCH v2 10/11] usb: udc: net2280: " Chunfeng Yun
2020-08-20  5:45 ` Chunfeng Yun [this message]
2020-08-20 10:14   ` [PATCH v2 11/11] iopoll: update kerneldoc of read_poll_timeout_atomic() Sergei Shtylyov
2020-08-21  1:43     ` Chunfeng Yun

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=1597902349-8998-11-git-send-email-chunfeng.yun@mediatek.com \
    --to=chunfeng.yun@mediatek.com \
    --cc=balbi@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mediatek@lists.infradead.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=matthias.bgg@gmail.com \
    --cc=stern@rowland.harvard.edu \
    /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