iopoll: update kerneldoc of read_poll_timeout_atomic()
Arguments description of read_poll_timeout_atomic() is out of date, update it. Cc: Alan Stern <stern@rowland.harvard.edu> Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com> Link: https://lore.kernel.org/r/1600668815-12135-11-git-send-email-chunfeng.yun@mediatek.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
parent
805ca9c2c2
commit
34d8f7a462
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue