1.\" $NetBSD: mstohz.9,v 1.2 2002/04/05 23:19:31 wiz Exp $ 2.\" 3.\" Copyright (c) 2002 Manuel Bouyer. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. All advertising materials mentioning features or use of this software 14.\" must display the following acknowledgement: 15.\" This product includes software developed by the University of 16.\" California, Berkeley and its contributors. 17.\" 4. Neither the name of the University nor the names of its contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31.\" SUCH DAMAGE. 32.\" 33.\" 34.Dd April 4, 2002 35.Dt MSTOHZ 9 36.Os 37.Sh NAME 38.Nm mstohz 39.Nd convert milliseconds to system clock ticks 40.Sh SYNOPSIS 41.Fd #include \*[Lt]sys/param.h\*[Gt] 42.Ft int 43.Fn mstohz "int ms" 44.Sh DESCRIPTION 45.Nm 46can be used to convert time in milliseconds to system clock ticks, as used 47by the 48.Xr callout 9 49facility, in an integer-overflow safe way. 50.Pp 51This function is implemented as a define in the 52.Em \*[Lt]sys/param.h\*[Gt] 53header. Individual ports can have a processor-specific, more efficient 54version implemented in their 55.Em \*[Lt]machine/param.h\*[Gt] 56header as a define. 57.Sh RETURN VALUES 58The return value is the number of clock ticks for the specified value. 59.Sh SEE ALSO 60.Xr callout 9 61.Sh BUGS 62The machine-independent 63.Fn 64function does not make use of expensive 64-bit integer arithmetic, so 65the result will be rounded down to one second if the parameter is larger 66than 131072 milliseconds. 67