]> git.saurik.com Git - apple/xnu.git/blame - osfmk/kern/timer_call.h
xnu-2050.7.9.tar.gz
[apple/xnu.git] / osfmk / kern / timer_call.h
CommitLineData
1c79356b 1/*
c910b4d9 2 * Copyright (c) 1993-1995, 1999-2008 Apple Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * Declarations for timer interrupt callouts.
1c79356b
A
30 */
31
32#ifndef _KERN_TIMER_CALL_H_
33#define _KERN_TIMER_CALL_H_
34
1c79356b
A
35#include <mach/mach_types.h>
36
37#ifdef MACH_KERNEL_PRIVATE
38
6d2010ae
A
39#include <kern/call_entry.h>
40
41/*
42 * NOTE: for now, bsd/dev/dtrace/dtrace_glue.c has its own definition
43 * of this data structure, and the two had better match.
44 */
45typedef struct timer_call {
46 struct call_entry call_entry;
47 decl_simple_lock_data( ,lock); /* protects call_entry queue */
48 uint64_t soft_deadline;
49 uint32_t flags;
50 boolean_t async_dequeue; /* this field is protected by
51 call_entry queue's lock */
52} *timer_call_t;
53
1c79356b
A
54typedef void *timer_call_param_t;
55typedef void (*timer_call_func_t)(
56 timer_call_param_t param0,
57 timer_call_param_t param1);
6d2010ae
A
58#define TIMER_CALL_CRITICAL 0x01
59#define TIMER_CALL_LOCAL 0x02
c910b4d9
A
60extern boolean_t timer_call_enter(
61 timer_call_t call,
6d2010ae
A
62 uint64_t deadline,
63 uint32_t flags);
1c79356b 64
c910b4d9
A
65extern boolean_t timer_call_enter1(
66 timer_call_t call,
67 timer_call_param_t param1,
6d2010ae
A
68 uint64_t deadline,
69 uint32_t flags);
1c79356b 70
c910b4d9
A
71extern boolean_t timer_call_cancel(
72 timer_call_t call);
1c79356b 73
6d2010ae 74typedef struct timer_call timer_call_data_t;
1c79356b 75
c910b4d9 76extern void timer_call_initialize(void);
1c79356b 77
6d2010ae
A
78extern void timer_call_initialize_queue(mpqueue_head_t *);
79
c910b4d9
A
80extern void timer_call_setup(
81 timer_call_t call,
82 timer_call_func_t func,
83 timer_call_param_t param0);
9bccf70c 84
1c79356b
A
85#endif /* MACH_KERNEL_PRIVATE */
86
87#endif /* _KERN_TIMER_CALL_H_ */