timers.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /*
  2. * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without modification,
  6. * are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice,
  9. * this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright notice,
  11. * this list of conditions and the following disclaimer in the documentation
  12. * and/or other materials provided with the distribution.
  13. * 3. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19. * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25. * OF SUCH DAMAGE.
  26. *
  27. * This file is part of the lwIP TCP/IP stack.
  28. *
  29. * Author: Adam Dunkels <adam@sics.se>
  30. * Simon Goldschmidt
  31. *
  32. */
  33. #ifndef __LWIP_TIMERS_H__
  34. #define __LWIP_TIMERS_H__
  35. #include "lwip/opt.h"
  36. /* Timers are not supported when NO_SYS==1 and NO_SYS_NO_TIMERS==1 */
  37. #define LWIP_TIMERS (!NO_SYS || (NO_SYS && !NO_SYS_NO_TIMERS))
  38. #if LWIP_TIMERS
  39. #include "lwip/err.h"
  40. #include "lwip/sys.h"
  41. #ifdef __cplusplus
  42. extern "C" {
  43. #endif
  44. #ifndef LWIP_DEBUG_TIMERNAMES
  45. #ifdef LWIP_DEBUG
  46. #define LWIP_DEBUG_TIMERNAMES SYS_DEBUG
  47. #else /* LWIP_DEBUG */
  48. #define LWIP_DEBUG_TIMERNAMES 0
  49. #endif /* LWIP_DEBUG*/
  50. #endif
  51. /** Function prototype for a timeout callback function. Register such a function
  52. * using sys_timeout().
  53. *
  54. * @param arg Additional argument to pass to the function - set up by sys_timeout()
  55. */
  56. typedef void (* sys_timeout_handler)(void *arg);
  57. struct sys_timeo {
  58. struct sys_timeo *next;
  59. u32_t time;
  60. sys_timeout_handler h;
  61. void *arg;
  62. #if LWIP_DEBUG_TIMERNAMES
  63. const char* handler_name;
  64. #endif /* LWIP_DEBUG_TIMERNAMES */
  65. };
  66. void sys_timeouts_init(void)ICACHE_FLASH_ATTR;
  67. #if LWIP_DEBUG_TIMERNAMES
  68. void sys_timeout_debug(u32_t msecs, sys_timeout_handler handler, void *arg, const char* handler_name)ICACHE_FLASH_ATTR;
  69. #define sys_timeout(msecs, handler, arg) sys_timeout_debug(msecs, handler, arg, #handler)
  70. #else /* LWIP_DEBUG_TIMERNAMES */
  71. void sys_timeout(u32_t msecs, sys_timeout_handler handler, void *arg)ICACHE_FLASH_ATTR;
  72. #endif /* LWIP_DEBUG_TIMERNAMES */
  73. void sys_untimeout(sys_timeout_handler handler, void *arg)ICACHE_FLASH_ATTR;
  74. #if NO_SYS
  75. void sys_check_timeouts(void)ICACHE_FLASH_ATTR;
  76. void sys_restart_timeouts(void)ICACHE_FLASH_ATTR;
  77. #else /* NO_SYS */
  78. void sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg);
  79. #endif /* NO_SYS */
  80. #ifdef __cplusplus
  81. }
  82. #endif
  83. #endif /* LWIP_TIMERS */
  84. #endif /* __LWIP_TIMERS_H__ */