osfmk/kern/timer_call.h

   1 /*
   2  * Copyright (c) 1993-1995, 1999-2000 Apple Computer, Inc.
   3  * All rights reserved.
   4  *
   5  * @APPLE_LICENSE_HEADER_START@
   6  *
   7  * This file contains Original Code and/or Modifications of Original Code
   8  * as defined in and that are subject to the Apple Public Source License
   9  * Version 2.0 (the 'License'). You may not use this file except in
  10  * compliance with the License. Please obtain a copy of the License at
  11  * http://www.opensource.apple.com/apsl/ and read it before using this
  12  * file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  19  * Please see the License for the specific language governing rights and
  20  * limitations under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Declarations for timer interrupt callouts.
  26  *
  27  * HISTORY
  28  *
  29  * 20 December 2000 (debo)
  30  *      Created.
  31  */
  32
  33 #ifndef _KERN_TIMER_CALL_H_
  34 #define _KERN_TIMER_CALL_H_
  35
  36 #include <mach/mach_types.h>
  37
  38 #ifdef MACH_KERNEL_PRIVATE
  39
  40 typedef struct call_entry       *timer_call_t;
  41 typedef void                            *timer_call_param_t;
  42 typedef void                            (*timer_call_func_t)(
  43                                                                         timer_call_param_t              param0,
  44                                                                         timer_call_param_t              param1);
  45
  46 boolean_t
  47 timer_call_enter(
  48         timer_call_t                    call,
  49         uint64_t                                deadline);
  50
  51 boolean_t
  52 timer_call_enter1(
  53         timer_call_t                    call,
  54         timer_call_param_t              param1,
  55         uint64_t                                deadline);
  56
  57 boolean_t
  58 timer_call_cancel(
  59         timer_call_t                    call);
  60
  61 boolean_t
  62 timer_call_is_delayed(
  63         timer_call_t                    call,
  64         uint64_t                                *deadline);
  65
  66 #include <kern/call_entry.h>
  67
  68 typedef struct call_entry       timer_call_data_t;
  69
  70 void
  71 timer_call_initialize(void);
  72
  73 void
  74 timer_call_setup(
  75         timer_call_t                    call,
  76         timer_call_func_t               func,
  77         timer_call_param_t              param0);
  78
  79 void
  80 timer_call_shutdown(
  81         processor_t                     processor);
  82
  83 #endif /* MACH_KERNEL_PRIVATE */
  84
  85 #endif /* _KERN_TIMER_CALL_H_ */