Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a man page for mstohz()

Browse Source
This commit is contained in:
bouyer 2002-04-05 18:30:32 +00:00
parent e5727031fb
commit 99ff14de48
2 changed files with 69 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
share/man/man9/Makefile
View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.107 2002/02/11 18:48:03 kleink Exp $
# $NetBSD: Makefile,v 1.108 2002/04/05 18:30:32 bouyer Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@ -14,7 +14,7 @@ MAN= access.9 altq.9 arp.9 audio.9 autoconf.9 bitmask_snprintf.9 \
itimerfix.9 \
kprintf.9 kthread.9 linedisc.9 lock.9 log.9 malloc.9 mbuf.9 \
mca.9 memcmp.9 memcpy.9 memmove.9 memset.9 \
microtime.9 namecache.9 namei.9 \
microtime.9 mstohz.9 namecache.9 namei.9 \
panic.9 pci.9 pci_configure_bus.9 pci_intr.9 \
pcmcia.9 pfil.9 physio.9 \
pmap.9 pool.9 powerhook_establish.9 ppsratecheck.9 properties.9 \

67
share/man/man9/mstohz.9 Normal file
View File

@ -0,0 +1,67 @@
.\" $NetBSD: mstohz.9,v 1.1 2002/04/05 18:30:32 bouyer Exp $
.\"
.\"
.\" Copyright (c) 2002 Manuel Bouyer.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"
.Dd April 4, 2002
.Dt MSTOHZ 9
.Os
.Sh NAME
.Nm mstohz ,
.Nd convert milliseconds to system clock ticks
.Sh SYNOPSIS
.Fd #include \*[Lt]sys/param.h\*[Gt]
.Ft int
.Fn mstohz "int ms"
.Sh DESCRIPTION
.Nm
can be used to convert time in millisecond to system clock ticks, as used
by the
.Xr callout 9
facility, in a integer-overflow safe way.
.Pp
This function is implemented as a define in the
.Em \*[Lt]sys/param.h\*[Gt]
header. Individual ports can have a processor-specific, more efficient
vesion implemented in their
.Em \*[Lt]machine/param.h\*[Gt]
header as a define.
.Sh RETURN VALUES
The return value is the number of clock tick for the specifed value.
.Sh SEE ALSO
.Xr callout 9 ,
.Sh BUGS
The machine-independant
.Fn
function doesn't make use of expensive 64 bits integer arithmetic, so
the result will be rounded down to a second if the parameter is larger
than 131072 milliseconds.