bsd/net/devtimer.h

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