From: Dejin Zheng <zhengdejin5@gmail.com>
To: andrew@lunn.ch, f.fainelli@gmail.com, hkallweit1@gmail.com,
linux@armlinux.org.uk, davem@davemloft.net, allison@lohutok.net,
tglx@linutronix.de, gregkh@linuxfoundation.org,
mchehab+samsung@kernel.org, netdev@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Dejin Zheng <zhengdejin5@gmail.com>
Subject: [PATCH net-next v3 1/7] iopoll: introduce read_poll_timeout macro
Date: Sun, 22 Mar 2020 10:48:28 +0800 [thread overview]
Message-ID: <20200322024834.31402-2-zhengdejin5@gmail.com> (raw)
In-Reply-To: <20200322024834.31402-1-zhengdejin5@gmail.com>
this macro is an extension of readx_poll_timeout macro. the accessor
function op just supports only one parameter in the readx_poll_timeout
macro, but this macro can supports multiple variable parameters for
it. so functions like phy_read(struct phy_device *phydev, u32 regnum)
and phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum) can
also use this poll timeout framework.
Signed-off-by: Dejin Zheng <zhengdejin5@gmail.com>
---
v2 -> v3:
no changed
v1 -> v2:
no changed
include/linux/iopoll.h | 40 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git a/include/linux/iopoll.h b/include/linux/iopoll.h
index 35e15dfd4155..7d44a2e20267 100644
--- a/include/linux/iopoll.h
+++ b/include/linux/iopoll.h
@@ -13,6 +13,46 @@
#include <linux/errno.h>
#include <linux/io.h>
+/**
+ * read_poll_timeout - Periodically poll an address until a condition is
+ * met or a timeout occurs
+ * @op: accessor function (takes @args as its arguments)
+ * @val: Variable to read the value into
+ * @cond: Break condition (usually involving @val)
+ * @sleep_us: Maximum time to sleep between reads in us (0
+ * tight-loops). Should be less than ~20ms since usleep_range
+ * is used (see Documentation/timers/timers-howto.rst).
+ * @timeout_us: Timeout in us, 0 means never timeout
+ * @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. Must not
+ * be called from atomic context if sleep_us or timeout_us are used.
+ *
+ * When available, you'll probably want to use one of the specialized
+ * macros defined below rather than this macro directly.
+ */
+#define read_poll_timeout(op, val, cond, sleep_us, timeout_us, args...) \
+({ \
+ u64 __timeout_us = (timeout_us); \
+ unsigned long __sleep_us = (sleep_us); \
+ ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
+ might_sleep_if((__sleep_us) != 0); \
+ for (;;) { \
+ (val) = op(args); \
+ if (cond) \
+ break; \
+ if (__timeout_us && \
+ ktime_compare(ktime_get(), __timeout) > 0) { \
+ (val) = op(args); \
+ break; \
+ } \
+ if (__sleep_us) \
+ usleep_range((__sleep_us >> 2) + 1, __sleep_us); \
+ } \
+ (cond) ? 0 : -ETIMEDOUT; \
+})
+
/**
* readx_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs
* @op: accessor function (takes @addr as its only argument)
--
2.25.0
next prev parent reply other threads:[~2020-03-22 2:49 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-22 2:48 [PATCH net-next v3 0/7] introduce read_poll_timeout Dejin Zheng
2020-03-22 2:48 ` Dejin Zheng [this message]
2020-03-22 2:48 ` [PATCH net-next v3 2/7] iopoll: redefined readx_poll_timeout macro to simplify the code Dejin Zheng
2020-03-22 2:48 ` [PATCH net-next v3 3/7] net: phy: introduce phy_read_mmd_poll_timeout macro Dejin Zheng
2020-03-22 2:48 ` [PATCH net-next v3 4/7] net: phy: bcm84881: use phy_read_mmd_poll_timeout() to simplify the code Dejin Zheng
2020-03-22 2:48 ` [PATCH net-next v3 5/7] net: phy: aquantia: " Dejin Zheng
2020-03-22 2:48 ` [PATCH net-next v3 6/7] net: phy: introduce phy_read_poll_timeout macro Dejin Zheng
2020-03-22 2:48 ` [PATCH net-next v3 7/7] net: phy: use phy_read_poll_timeout() to simplify the code Dejin Zheng
2020-03-22 2:57 ` Florian Fainelli
2020-03-22 6:12 ` Dejin Zheng
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=20200322024834.31402-2-zhengdejin5@gmail.com \
--to=zhengdejin5@gmail.com \
--cc=allison@lohutok.net \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=f.fainelli@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=hkallweit1@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=mchehab+samsung@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=tglx@linutronix.de \
/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).