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