1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>schedule_timeout</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Linux Device Drivers"><link rel="up" href="ch01s03.html" title="Delaying, scheduling, and timer routines"><link rel="prev" href="API-del-timer-sync.html" title="del_timer_sync"><link rel="next" href="API-msleep.html" title="msleep"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">schedule_timeout</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-del-timer-sync.html">Prev</a>&#160;</td><th width="60%" align="center">Delaying, scheduling, and timer routines</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-msleep.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-schedule-timeout"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>schedule_timeout &#8212; 
2     sleep until timeout
3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">signed long __sched <b class="fsfunc">schedule_timeout </b>(</code></td><td>signed long <var class="pdparam">timeout</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1107088476"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>timeout</code></em></span></dt><dd><p>
4     timeout value in jiffies
5    </p></dd></dl></div></div><div class="refsect1"><a name="idp1107090044"></a><h2>Description</h2><p>
6   Make the current task sleep until <em class="parameter"><code>timeout</code></em> jiffies have
7   elapsed. The routine will return immediately unless
8   the current task state has been set (see <code class="function">set_current_state</code>).
9   </p><p>
10
11   You can set the task state as follows -
12   </p><p>
13
14   <code class="constant">TASK_UNINTERRUPTIBLE</code> - at least <em class="parameter"><code>timeout</code></em> jiffies are guaranteed to
15   pass before the routine returns. The routine will return 0
16   </p><p>
17
18   <code class="constant">TASK_INTERRUPTIBLE</code> - the routine may return early if a signal is
19   delivered to the current task. In this case the remaining time
20   in jiffies will be returned, or 0 if the timer expired in time
21   </p><p>
22
23   The current task state is guaranteed to be TASK_RUNNING when this
24   routine returns.
25   </p><p>
26
27   Specifying a <em class="parameter"><code>timeout</code></em> value of <code class="constant">MAX_SCHEDULE_TIMEOUT</code> will schedule
28   the CPU away without a bound on the timeout. In this case the return
29   value will be <code class="constant">MAX_SCHEDULE_TIMEOUT</code>.
30   </p><p>
31
32   In all cases the return value is guaranteed to be non-negative.
33</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-del-timer-sync.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch01s03.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-msleep.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">del_timer_sync</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">msleep</span></td></tr></table></div></body></html>
34