1/*
2 * Copyright (c) 1993-1995, 1999-2008 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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.
14 *
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * Declarations for timer interrupt callouts.
30 */
31
32#ifndef _KERN_TIMER_CALL_H_
33#define _KERN_TIMER_CALL_H_
34
35#include <mach/mach_types.h>
36
37#ifdef MACH_KERNEL_PRIVATE
38
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	uint64_t		ttd; /* Time to deadline at creation */
53} *timer_call_t;
54
55typedef void				*timer_call_param_t;
56typedef void				(*timer_call_func_t)(
57									timer_call_param_t		param0,
58									timer_call_param_t		param1);
59#define TIMER_CALL_CRITICAL	0x01
60#define TIMER_CALL_LOCAL	0x02
61extern boolean_t	timer_call_enter(
62						timer_call_t	call,
63						uint64_t	deadline,
64						uint32_t	flags);
65
66extern boolean_t	timer_call_enter1(
67						timer_call_t		call,
68						timer_call_param_t	param1,
69						uint64_t		deadline,
70						uint32_t 		flags);
71
72extern boolean_t	timer_call_cancel(
73						timer_call_t	call);
74
75typedef struct timer_call 	timer_call_data_t;
76
77extern void		timer_call_initialize(void);
78
79extern void		timer_call_initialize_queue(mpqueue_head_t *);
80
81extern void		timer_call_setup(
82					timer_call_t		call,
83					timer_call_func_t	func,
84					timer_call_param_t	param0);
85
86#endif /* MACH_KERNEL_PRIVATE */
87
88#endif /* _KERN_TIMER_CALL_H_ */
89