1 /** 2 * @file 3 * Timer implementations 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * Simon Goldschmidt 36 * 37 */ 38 #ifndef LWIP_HDR_TIMEOUTS_H 39 #define LWIP_HDR_TIMEOUTS_H 40 41 #include "lwip/opt.h" 42 #include "lwip/err.h" 43 #if !NO_SYS 44 #include "lwip/sys.h" 45 #endif 46 #if LWIP_LOWPOWER 47 #include "lwip/lowpower.h" 48 #endif 49 50 #ifdef __cplusplus 51 extern "C" { 52 #endif 53 54 #if !LWIP_LOWPOWER 55 #ifndef LWIP_DEBUG_TIMERNAMES 56 #ifdef LWIP_DEBUG 57 #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG 58 #else /* LWIP_DEBUG */ 59 #define LWIP_DEBUG_TIMERNAMES 0 60 #endif /* LWIP_DEBUG*/ 61 #endif 62 63 /** Returned by sys_timeouts_sleeptime() to indicate there is no timer, so we 64 * can sleep forever. 65 */ 66 #define SYS_TIMEOUTS_SLEEPTIME_INFINITE 0xFFFFFFFF 67 68 /** Function prototype for a stack-internal timer function that has to be 69 * called at a defined interval */ 70 typedef void (* lwip_cyclic_timer_handler)(void); 71 72 /** This struct contains information about a stack-internal timer function 73 that has to be called at a defined interval */ 74 struct lwip_cyclic_timer { 75 u32_t interval_ms; 76 lwip_cyclic_timer_handler handler; 77 #if LWIP_DEBUG_TIMERNAMES 78 const char* handler_name; 79 #endif /* LWIP_DEBUG_TIMERNAMES */ 80 }; 81 82 /** This array contains all stack-internal cyclic timers. To get the number of 83 * timers, use lwip_num_cyclic_timers */ 84 extern const struct lwip_cyclic_timer lwip_cyclic_timers[]; 85 /** Array size of lwip_cyclic_timers[] */ 86 extern const int lwip_num_cyclic_timers; 87 88 #if LWIP_TIMERS 89 90 /** Function prototype for a timeout callback function. Register such a function 91 * using sys_timeout(). 92 * 93 * @param arg Additional argument to pass to the function - set up by sys_timeout() 94 */ 95 typedef void (* sys_timeout_handler)(void *arg); 96 97 struct sys_timeo { 98 struct sys_timeo *next; 99 u32_t time; 100 sys_timeout_handler h; 101 void *arg; 102 #if LWIP_DEBUG_TIMERNAMES 103 const char* handler_name; 104 #endif /* LWIP_DEBUG_TIMERNAMES */ 105 }; 106 107 void sys_timeouts_init(void); 108 109 #if LWIP_DEBUG_TIMERNAMES 110 void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name); 111 #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler) 112 #else /* LWIP_DEBUG_TIMERNAMES */ 113 void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg); 114 #endif /* LWIP_DEBUG_TIMERNAMES */ 115 116 void sys_untimeout(sys_timeout_handler handler, void *arg); 117 void sys_restart_timeouts(void); 118 void sys_check_timeouts(void); 119 u32_t sys_timeouts_sleeptime(void); 120 121 #if LWIP_TESTMODE 122 struct sys_timeo** sys_timeouts_get_next_timeout(void); 123 void lwip_cyclic_timer(void *arg); 124 #endif 125 126 #endif /* LWIP_TIMERS */ 127 #endif /* !LWIP_LOWPOWER */ 128 #ifdef __cplusplus 129 } 130 #endif 131 132 #endif /* LWIP_HDR_TIMEOUTS_H */ 133