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