osfmk/kern/time_out.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53 /*
  54  */
  55
  56 #ifndef _KERN_TIME_OUT_H_
  57 #define _KERN_TIME_OUT_H_
  58
  59 /*
  60  * Mach tick-based timing.
  61  */
  62
  63 #include <mach/boolean.h>
  64 #include <kern/kern_types.h>
  65
  66 #include <sys/appleapiopts.h>
  67
  68 #ifdef  __APPLE_API_PRIVATE
  69
  70 extern int                              hz;                             /* num of ticks per second */
  71 extern int                              tick;                   /* num of usec per tick */
  72
  73 #ifdef  MACH_KERNEL_PRIVATE
  74
  75 extern void             hertz_tick(
  76                                         boolean_t               usermode,       /* executing user code */
  77                                         natural_t               pc);
  78
  79 typedef void (*timeout_fcn_t)(void *);
  80
  81 /* Set timeout */
  82 extern void             timeout(
  83                                         timeout_fcn_t   fcn,
  84                                         void                    *param,
  85                                         int                             interval);
  86
  87 /* Cancel timeout */
  88 extern void             untimeout(
  89                                         timeout_fcn_t   fcn,
  90                                         void                    *param);
  91
  92 #endif  /* MACH_KERNEL_PRIVATE */
  93
  94 #endif  /* __APPLE_API_PRIVATE */
  95
  96 #endif  /* _KERN_TIME_OUT_H_ */