summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorDavid Gwynne <dlg@cvs.openbsd.org>2014-02-13 12:32:50 +0000
committerDavid Gwynne <dlg@cvs.openbsd.org>2014-02-13 12:32:50 +0000
commit33c3598c1f99877da98eaaf82c8c846054c2975d (patch)
treeba4256729c86deea8d0b7010a0df3fde767cfc03 /share/man
parent147361393cdf0feb05d14404a263275489505bc1 (diff)
document the contexts you can call this api from out into its own section
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/timeout.925
1 files changed, 21 insertions, 4 deletions
diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9
index fe80ea90683..f32c0149c56 100644
--- a/share/man/man9/timeout.9
+++ b/share/man/man9/timeout.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: timeout.9,v 1.33 2013/11/27 04:28:32 dlg Exp $
+.\" $OpenBSD: timeout.9,v 1.34 2014/02/13 12:32:49 dlg Exp $
.\"
.\" Copyright (c) 2000 Artur Grabowski <art@openbsd.org>
.\" All rights reserved.
@@ -23,7 +23,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: November 27 2013 $
+.Dd $Mdocdate: February 13 2014 $
.Dt TIMEOUT 9
.Os
.Sh NAME
@@ -83,8 +83,6 @@ The function will be called at softclock interrupt level.
.Pp
It is the responsibility of the caller to provide these functions with
pre-allocated timeout structures.
-All functions in this API may be used in interrupt context below
-.Fn splclock .
.Pp
The function
.Fn timeout_set
@@ -181,12 +179,31 @@ functions instead of
.Fn timeout_add .
Those functions add a timeout whilst converting the time specified
by the respective types.
+.Sh CONTEXT
+.Fn timeout_set
+can be called during autoconf, from process context, or from interrupt context.
+.Pp
+.Fn timeout_add ,
+.Fn timeout_add_sec ,
+.Fn timeout_add_msec ,
+.Fn timeout_add_nsec ,
+.Fn timeout_add_usec ,
+.Fn timeout_add_tv ,
+.Fn timeout_add_ts ,
+.Fn timeout_add_bt ,
+.Fn timeout_del ,
+.Fn timeout_pending ,
+.Fn timeout_initialized ,
+.Fn timeout_triggered
+can be called during autoconf, from process context, or from any interrupt context at or below
+.Dv IPL_CLOCK .
.Sh CODE REFERENCES
These functions are implemented in the file
.Pa sys/kern/kern_timeout.c .
.Sh SEE ALSO
.Xr hz 9 ,
.Xr hzto 9 ,
+.Xr spl 9 ,
.Xr splclock 9 ,
.Xr tsleep 9 ,
.Xr tvtohz 9