xref: /xnu-10002.1.13/bsd/net/devtimer.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions /*
2*1031c584SApple OSS Distributions  * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
3*1031c584SApple OSS Distributions  *
4*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*1031c584SApple OSS Distributions  *
6*1031c584SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*1031c584SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*1031c584SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*1031c584SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*1031c584SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*1031c584SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*1031c584SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*1031c584SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*1031c584SApple OSS Distributions  *
15*1031c584SApple OSS Distributions  * Please obtain a copy of the License at
16*1031c584SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*1031c584SApple OSS Distributions  *
18*1031c584SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*1031c584SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*1031c584SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*1031c584SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*1031c584SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*1031c584SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*1031c584SApple OSS Distributions  * limitations under the License.
25*1031c584SApple OSS Distributions  *
26*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*1031c584SApple OSS Distributions  */
28*1031c584SApple OSS Distributions 
29*1031c584SApple OSS Distributions /*
30*1031c584SApple OSS Distributions  * devtimer.h
31*1031c584SApple OSS Distributions  * - timer source based on <kern/thread_call.h>
32*1031c584SApple OSS Distributions  */
33*1031c584SApple OSS Distributions 
34*1031c584SApple OSS Distributions 
35*1031c584SApple OSS Distributions #ifndef _NET_DEVTIMER_H
36*1031c584SApple OSS Distributions #define _NET_DEVTIMER_H
37*1031c584SApple OSS Distributions 
38*1031c584SApple OSS Distributions #include <sys/types.h>
39*1031c584SApple OSS Distributions #include <sys/systm.h>
40*1031c584SApple OSS Distributions 
41*1031c584SApple OSS Distributions #define DEVTIMER_USECS_PER_SEC          (1000 * 1000)
42*1031c584SApple OSS Distributions 
43*1031c584SApple OSS Distributions enum {
44*1031c584SApple OSS Distributions 	devtimer_process_func_event_lock,
45*1031c584SApple OSS Distributions 	devtimer_process_func_event_unlock,
46*1031c584SApple OSS Distributions };
47*1031c584SApple OSS Distributions typedef int devtimer_process_func_event;
48*1031c584SApple OSS Distributions 
49*1031c584SApple OSS Distributions typedef struct devtimer_s * devtimer_ref;
50*1031c584SApple OSS Distributions typedef void (*devtimer_process_func)(devtimer_ref timer,
51*1031c584SApple OSS Distributions     devtimer_process_func_event event);
52*1031c584SApple OSS Distributions typedef void (*devtimer_timeout_func)(void * arg0, void * arg1, void * arg2);
53*1031c584SApple OSS Distributions 
54*1031c584SApple OSS Distributions int
55*1031c584SApple OSS Distributions devtimer_valid(devtimer_ref timer);
56*1031c584SApple OSS Distributions 
57*1031c584SApple OSS Distributions void
58*1031c584SApple OSS Distributions devtimer_retain(devtimer_ref timer);
59*1031c584SApple OSS Distributions 
60*1031c584SApple OSS Distributions void *
61*1031c584SApple OSS Distributions devtimer_arg0(devtimer_ref timer);
62*1031c584SApple OSS Distributions 
63*1031c584SApple OSS Distributions devtimer_ref
64*1031c584SApple OSS Distributions devtimer_create(devtimer_process_func process_func, void * arg0);
65*1031c584SApple OSS Distributions 
66*1031c584SApple OSS Distributions void
67*1031c584SApple OSS Distributions devtimer_invalidate(devtimer_ref timer);
68*1031c584SApple OSS Distributions 
69*1031c584SApple OSS Distributions void
70*1031c584SApple OSS Distributions devtimer_release(devtimer_ref timer);
71*1031c584SApple OSS Distributions 
72*1031c584SApple OSS Distributions void
73*1031c584SApple OSS Distributions devtimer_set_absolute(devtimer_ref t,
74*1031c584SApple OSS Distributions     struct timeval abs_time,
75*1031c584SApple OSS Distributions     devtimer_timeout_func func,
76*1031c584SApple OSS Distributions     void * arg1, void * arg2);
77*1031c584SApple OSS Distributions 
78*1031c584SApple OSS Distributions void
79*1031c584SApple OSS Distributions devtimer_set_relative(devtimer_ref t,
80*1031c584SApple OSS Distributions     struct timeval rel_time,
81*1031c584SApple OSS Distributions     devtimer_timeout_func func,
82*1031c584SApple OSS Distributions     void * arg1, void * arg2);
83*1031c584SApple OSS Distributions void
84*1031c584SApple OSS Distributions devtimer_cancel(devtimer_ref t);
85*1031c584SApple OSS Distributions 
86*1031c584SApple OSS Distributions int
87*1031c584SApple OSS Distributions devtimer_enabled(devtimer_ref t);
88*1031c584SApple OSS Distributions 
89*1031c584SApple OSS Distributions struct timeval
90*1031c584SApple OSS Distributions devtimer_current_time(void);
91*1031c584SApple OSS Distributions 
92*1031c584SApple OSS Distributions int32_t
93*1031c584SApple OSS Distributions devtimer_current_secs(void);
94*1031c584SApple OSS Distributions 
95*1031c584SApple OSS Distributions #endif /* _NET_DEVTIMER_H */
96