osfmk/kern/time_out.h

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