<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>schedule_hrtimeout_range</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Linux Device Drivers" /><link rel="up" href="ch01s05.html" title="High-resolution timers" /><link rel="prev" href="API-hrtimer-get-res.html" title="hrtimer_get_res" /><link rel="next" href="API-schedule-hrtimeout.html" title="schedule_hrtimeout" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>schedule_hrtimeout_range</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-hrtimer-get-res.html">Prev</a> </td><th width="60%" align="center">High-resolution timers</th><td width="20%" align="right"> <a accesskey="n" href="API-schedule-hrtimeout.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="schedule_hrtimeout_range"><a id="API-schedule-hrtimeout-range"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>schedule_hrtimeout_range — sleep until timeout </p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int __sched <strong>fsfuncschedule_hrtimeout_range </strong>(</code></td><td>ktime_t * <var class="pdparam">expires</var>, </td></tr><tr><td> </td><td>unsigned long <var class="pdparam">delta</var>, </td></tr><tr><td> </td><td>const enum hrtimer_mode <var class="pdparam">mode</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id3056624"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>expires</code></em></span></dt><dd><p> timeout value (ktime_t) </p></dd><dt><span class="term"><em class="parameter"><code>delta</code></em></span></dt><dd><p> slack in expires timeout (ktime_t) </p></dd><dt><span class="term"><em class="parameter"><code>mode</code></em></span></dt><dd><p> timer mode, HRTIMER_MODE_ABS or HRTIMER_MODE_REL </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id3056684"></a><h2>Description</h2><p> Make the current task sleep until the given expiry time has elapsed. The routine will return immediately unless the current task state has been set (see <code class="function">set_current_state</code>). </p><p> The <em class="parameter"><code>delta</code></em> argument gives the kernel the freedom to schedule the actual wakeup to a time that is both power and performance friendly. The kernel give the normal best effort behavior for <span class="quote">“<span class="quote"><em class="parameter"><code>expires</code></em>+<em class="parameter"><code>delta</code></em></span>”</span>, but may decide to fire the timer earlier, but no earlier than <em class="parameter"><code>expires</code></em>. </p><p> You can set the task state as follows - </p><p> <code class="constant">TASK_UNINTERRUPTIBLE</code> - at least <em class="parameter"><code>timeout</code></em> time is guaranteed to pass before the routine returns. </p><p> <code class="constant">TASK_INTERRUPTIBLE</code> - the routine may return early if a signal is delivered to the current task. </p><p> The current task state is guaranteed to be TASK_RUNNING when this routine returns. </p><p> Returns 0 when the timer has expired otherwise -EINTR </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-hrtimer-get-res.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch01s05.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-schedule-hrtimeout.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>hrtimer_get_res</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>schedule_hrtimeout</span></td></tr></table></div></body></html>