bsd/net/devtimer.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, 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 /*
  30  * devtimer.h
  31  * - timer source based on <kern/thread_call.h>
  32  */
  33
  34
  35 #ifndef _NET_DEVTIMER_H
  36 #define _NET_DEVTIMER_H
  37
  38 #include <sys/types.h>
  39 #include <sys/systm.h>
  40
  41 #define DEVTIMER_USECS_PER_SEC          (1000 * 1000)
  42
  43 enum {
  44     devtimer_process_func_event_lock,
  45     devtimer_process_func_event_unlock,
  46 };
  47 typedef int devtimer_process_func_event;
  48
  49 typedef struct devtimer_s * devtimer_ref;
  50 typedef void (*devtimer_process_func)(devtimer_ref timer,
  51                                       devtimer_process_func_event event);
  52 typedef void (*devtimer_timeout_func)(void * arg0, void * arg1, void * arg2);
  53
  54 int
  55 devtimer_valid(devtimer_ref timer);
  56
  57 void
  58 devtimer_retain(devtimer_ref timer);
  59
  60 void *
  61 devtimer_arg0(devtimer_ref timer);
  62
  63 devtimer_ref
  64 devtimer_create(devtimer_process_func process_func, void * arg0);
  65
  66 void
  67 devtimer_invalidate(devtimer_ref timer);
  68
  69 void
  70 devtimer_release(devtimer_ref timer);
  71
  72 void
  73 devtimer_set_absolute(devtimer_ref t,
  74                       struct timeval abs_time,
  75                       devtimer_timeout_func func,
  76                       void * arg1, void * arg2);
  77
  78 void
  79 devtimer_set_relative(devtimer_ref t,
  80                       struct timeval rel_time,
  81                       devtimer_timeout_func func,
  82                       void * arg1, void * arg2);
  83 void
  84 devtimer_cancel(devtimer_ref t);
  85
  86 int
  87 devtimer_enabled(devtimer_ref t);
  88
  89 struct timeval
  90 devtimer_current_time(void);
  91
  92 int32_t
  93 devtimer_current_secs(void);
  94
  95 #endif /* _NET_DEVTIMER_H */