| 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 kernel_time
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef KERN_TIMEOUT_H_
|
|---|
| 36 | #define KERN_TIMEOUT_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <adt/list.h>
|
|---|
| 39 | #include <cpu.h>
|
|---|
| 40 | #include <stdint.h>
|
|---|
| 41 |
|
|---|
| 42 | typedef void (*timeout_handler_t)(void *arg);
|
|---|
| 43 |
|
|---|
| 44 | typedef uint64_t deadline_t;
|
|---|
| 45 | #define DEADLINE_NEVER ((deadline_t) UINT64_MAX)
|
|---|
| 46 |
|
|---|
| 47 | typedef struct {
|
|---|
| 48 | /** Link to the list of active timeouts on timeout->cpu */
|
|---|
| 49 | link_t link;
|
|---|
| 50 | /** Timeout will be activated when current clock tick reaches this value. */
|
|---|
| 51 | deadline_t deadline;
|
|---|
| 52 | /** Function that will be called on timeout activation. */
|
|---|
| 53 | timeout_handler_t handler;
|
|---|
| 54 | /** Argument to be passed to handler() function. */
|
|---|
| 55 | void *arg;
|
|---|
| 56 | /** On which processor is this timeout registered. */
|
|---|
| 57 | cpu_t *cpu;
|
|---|
| 58 | /** Used to synchronize with the handler callback. */
|
|---|
| 59 | atomic_bool finished;
|
|---|
| 60 | } timeout_t;
|
|---|
| 61 |
|
|---|
| 62 | #define us2ticks(us) ((uint64_t) (((uint32_t) (us) / (1000000 / HZ))))
|
|---|
| 63 |
|
|---|
| 64 | extern deadline_t timeout_deadline_in_usec(uint32_t us);
|
|---|
| 65 |
|
|---|
| 66 | extern void timeout_init(void);
|
|---|
| 67 | extern void timeout_initialize(timeout_t *);
|
|---|
| 68 | extern void timeout_register(timeout_t *, uint64_t, timeout_handler_t, void *);
|
|---|
| 69 | extern void timeout_register_deadline(timeout_t *, deadline_t, timeout_handler_t, void *);
|
|---|
| 70 | extern bool timeout_unregister(timeout_t *);
|
|---|
| 71 |
|
|---|
| 72 | #endif
|
|---|
| 73 |
|
|---|
| 74 | /** @}
|
|---|
| 75 | */
|
|---|
