xref: /xnu-10063.121.3/osfmk/mach/mk_timer.h (revision 2c2f96dc2b9a4408a43d3150ae9c105355ca3daa)
1*2c2f96dcSApple OSS Distributions /*
2*2c2f96dcSApple OSS Distributions  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
3*2c2f96dcSApple OSS Distributions  *
4*2c2f96dcSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*2c2f96dcSApple OSS Distributions  *
6*2c2f96dcSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*2c2f96dcSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*2c2f96dcSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*2c2f96dcSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*2c2f96dcSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*2c2f96dcSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*2c2f96dcSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*2c2f96dcSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*2c2f96dcSApple OSS Distributions  *
15*2c2f96dcSApple OSS Distributions  * Please obtain a copy of the License at
16*2c2f96dcSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*2c2f96dcSApple OSS Distributions  *
18*2c2f96dcSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*2c2f96dcSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*2c2f96dcSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*2c2f96dcSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*2c2f96dcSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*2c2f96dcSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*2c2f96dcSApple OSS Distributions  * limitations under the License.
25*2c2f96dcSApple OSS Distributions  *
26*2c2f96dcSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*2c2f96dcSApple OSS Distributions  */
28*2c2f96dcSApple OSS Distributions /*
29*2c2f96dcSApple OSS Distributions  * Copyright (c) 2000 Apple Computer, Inc.  All rights reserved.
30*2c2f96dcSApple OSS Distributions  *
31*2c2f96dcSApple OSS Distributions  * HISTORY
32*2c2f96dcSApple OSS Distributions  *
33*2c2f96dcSApple OSS Distributions  * 31 August 2000 (debo)
34*2c2f96dcSApple OSS Distributions  *  Created.
35*2c2f96dcSApple OSS Distributions  */
36*2c2f96dcSApple OSS Distributions 
37*2c2f96dcSApple OSS Distributions #ifndef _MACH_MK_TIMER_H_
38*2c2f96dcSApple OSS Distributions #define _MACH_MK_TIMER_H_
39*2c2f96dcSApple OSS Distributions 
40*2c2f96dcSApple OSS Distributions #include <mach/mach_time.h>
41*2c2f96dcSApple OSS Distributions #include <sys/cdefs.h>
42*2c2f96dcSApple OSS Distributions 
43*2c2f96dcSApple OSS Distributions __BEGIN_DECLS
44*2c2f96dcSApple OSS Distributions 
45*2c2f96dcSApple OSS Distributions mach_port_name_t        mk_timer_create(void);
46*2c2f96dcSApple OSS Distributions 
47*2c2f96dcSApple OSS Distributions kern_return_t   mk_timer_destroy(
48*2c2f96dcSApple OSS Distributions 	mach_port_name_t        name);
49*2c2f96dcSApple OSS Distributions 
50*2c2f96dcSApple OSS Distributions kern_return_t   mk_timer_arm(
51*2c2f96dcSApple OSS Distributions 	mach_port_name_t        name,
52*2c2f96dcSApple OSS Distributions 	uint64_t                        expire_time);
53*2c2f96dcSApple OSS Distributions 
54*2c2f96dcSApple OSS Distributions kern_return_t   mk_timer_cancel(
55*2c2f96dcSApple OSS Distributions 	mach_port_name_t        name,
56*2c2f96dcSApple OSS Distributions 	uint64_t                        *result_time);
57*2c2f96dcSApple OSS Distributions #define MK_TIMER_NORMAL (0)
58*2c2f96dcSApple OSS Distributions #define MK_TIMER_CRITICAL (1)
59*2c2f96dcSApple OSS Distributions kern_return_t   mk_timer_arm_leeway(
60*2c2f96dcSApple OSS Distributions 	mach_port_name_t        name,
61*2c2f96dcSApple OSS Distributions 	uint64_t                mk_timer_flags,
62*2c2f96dcSApple OSS Distributions 	uint64_t                mk_timer_expire_time,
63*2c2f96dcSApple OSS Distributions 	uint64_t                mk_timer_leeway);
64*2c2f96dcSApple OSS Distributions 
65*2c2f96dcSApple OSS Distributions __END_DECLS
66*2c2f96dcSApple OSS Distributions 
67*2c2f96dcSApple OSS Distributions #pragma pack(4)
68*2c2f96dcSApple OSS Distributions struct mk_timer_expire_msg {
69*2c2f96dcSApple OSS Distributions 	mach_msg_header_t       header;
70*2c2f96dcSApple OSS Distributions 	uint64_t                        unused[3];
71*2c2f96dcSApple OSS Distributions };
72*2c2f96dcSApple OSS Distributions #pragma pack()
73*2c2f96dcSApple OSS Distributions 
74*2c2f96dcSApple OSS Distributions typedef struct mk_timer_expire_msg              mk_timer_expire_msg_t;
75*2c2f96dcSApple OSS Distributions 
76*2c2f96dcSApple OSS Distributions #endif /* _MACH_MK_TIMER_H_ */
77