kernel/generic/include/time/timeout.h

   1 /*
   2  * Copyright (c) 2001-2004 Jakub Jermar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup time
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_TIMEOUT_H_
  36 #define KERN_TIMEOUT_H_
  37
  38 #include <arch/types.h>
  39 #include <adt/list.h>
  40 #include <cpu.h>
  41
  42 typedef void (* timeout_handler_t)(void *arg);
  43
  44 typedef struct {
  45         SPINLOCK_DECLARE(lock);
  46
  47         /** Link to the list of active timeouts on THE->cpu */
  48         link_t link;
  49         /** Timeout will be activated in this amount of clock() ticks. */
  50         uint64_t ticks;
  51         /** Function that will be called on timeout activation. */
  52         timeout_handler_t handler;
  53         /** Argument to be passed to handler() function. */
  54         void *arg;
  55         /** On which processor is this timeout registered. */
  56         cpu_t *cpu;
  57 } timeout_t;
  58
  59 #define us2ticks(us)    ((uint64_t) (((uint32_t) (us) / (1000000 / HZ))))
  60
  61 extern void timeout_init(void);
  62 extern void timeout_initialize(timeout_t *t);
  63 extern void timeout_reinitialize(timeout_t *t);
  64 extern void timeout_register(timeout_t *t, uint64_t usec, timeout_handler_t f,
  65     void *arg);
  66 extern bool timeout_unregister(timeout_t *t);
  67
  68 #endif
  69
  70 /** @}
  71  */