4776 man: don't lie about ddi_get_time(9f) uses
[illumos-gate.git] / usr / src / man / man9f / ddi_get_time.9f
blob16b383c0c450122fbdf1f9650fab51ef76005854
1 '\" te
2 .\" Copyright (c) 2000, Sun Microsystems, Inc.
3 .\" Copyright (c) 2014, Nexenta Systems, Inc.
4 .\"  All Rights Reserved
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH DDI_GET_TIME 9F "Apr 15, 2014"
9 .SH NAME
10 ddi_get_time \- returns the current time in seconds
11 .SH SYNOPSIS
12 .LP
13 .nf
14 #include <sys/types.h>
15 #include <sys/ddi.h>
16 #include <sys/sunddi.h>
20 \fBtime_t\fR \fBddi_get_time\fR(\fBvoid\fR);
21 .fi
23 .SH INTERFACE LEVEL
24 .sp
25 .LP
26 Solaris DDI specific (Solaris DDI).
27 .SH DESCRIPTION
28 .sp
29 .LP
30 \fBddi_get_time()\fR returns the current time in seconds since 00:00:00 UTC,
31 January 1, 1970. Changes in time of day clock may result in this value
32 changing. In other words, the value is not monotonically increasing and
33 therefore it must not be used to set wait or expiration intervals. For that,
34 instead use \fBddi_get_lbolt\fR(9F) or \fBgethrtime\fR(9F).
35 .SH RETURN VALUES
36 .sp
37 .LP
38 \fBddi_get_time()\fR returns the time in seconds.
39 .SH CONTEXT
40 .sp
41 .LP
42  This routine can be called from any context.
43 .SH SEE ALSO
44 .sp
45 .LP
46 \fBddi_get_lbolt\fR(9F), \fBdrv_getparm\fR(9F), \fBdrv_usectohz\fR(9F),
47 \fBgethrtime\fR(9F)
48 .sp
49 .LP
50 \fIWriting Device Drivers\fR
51 .sp
52 .LP
53  \fISTREAMS Programming Guide\fR