blob: 0ee2bddaa83369ec681f8fd2c92ca7e7cb69f111 [file] [log] [blame]
/* SPDX-License-Identifier: GPL-2.0 */
/*
* Copyright (c) 2012-2014 The Linux Foundation. All rights reserved.
*/
#ifndef _LINUX_IOPOLL_H
#define _LINUX_IOPOLL_H
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/io.h>
#include <time.h>
/**
* read_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs
* @op: accessor function (takes @addr as its only argument)
* @val: Variable to read the value into
* @cond: Break condition (usually involving @val)
* @sleep_us: Maximum time to sleep in us
* @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 @addr is stored in @val.
*
* 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...) \
({ \
unsigned long timeout = timer_get_us() + timeout_us; \
for (;;) { \
(val) = op(args); \
if (cond) \
break; \
if (timeout_us && time_after(timer_get_us(), timeout)) { \
(val) = op(args); \
break; \
} \
if (sleep_us) \
udelay(sleep_us); \
} \
(cond) ? 0 : -ETIMEDOUT; \
})
#define readx_poll_sleep_timeout(op, addr, val, cond, sleep_us, timeout_us) \
read_poll_timeout(op, val, cond, sleep_us, timeout_us, addr)
#define readl_poll_sleep_timeout(addr, val, cond, sleep_us, timeout_us) \
readx_poll_sleep_timeout(readl, addr, val, cond, sleep_us, timeout_us)
#define readx_poll_timeout(op, addr, val, cond, timeout_us) \
read_poll_timeout(op, val, cond, false, timeout_us, addr)
#define readb_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readb, addr, val, cond, timeout_us)
#define readw_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readw, addr, val, cond, timeout_us)
#define readl_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readl, addr, val, cond, timeout_us)
#define readq_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readq, addr, val, cond, timeout_us)
#define readb_relaxed_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readb_relaxed, addr, val, cond, timeout_us)
#define readw_relaxed_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readw_relaxed, addr, val, cond, timeout_us)
#define readl_relaxed_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readl_relaxed, addr, val, cond, timeout_us)
#define readq_relaxed_poll_timeout(addr, val, cond, timeout_us) \
readx_poll_timeout(readq_relaxed, addr, val, cond, timeout_us)
#endif /* _LINUX_IOPOLL_H */