src/include/lwip/sys.h

   1 /*
   2  * Copyright (c) 2001-2003 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  *
  31  */
  32 #ifndef __LWIP_SYS_H__
  33 #define __LWIP_SYS_H__
  34
  35 #include "arch/cc.h"
  36
  37 #include "lwip/opt.h"
  38
  39 #define SYS_ARCH_DECL_PROTECT(lev)
  40 #define SYS_ARCH_PROTECT(lev)
  41 #define SYS_ARCH_UNPROTECT(lev)
  42
  43 #if NO_SYS
  44
  45 /* For a totally minimal and standalone system, we provide null
  46    definitions of the sys_ functions. */
  47 typedef u8_t sys_sem_t;
  48 typedef u8_t sys_mbox_t;
  49 struct sys_timeout {u8_t dummy;};
  50
  51 #define sys_init()
  52 #define sys_timeout(m,h,a)
  53 #define sys_sem_new(c) c
  54 #define sys_sem_signal(s)
  55 #define sys_sem_wait(s)
  56 #define sys_sem_free(s)
  57 #define sys_mbox_new() 0
  58 #define sys_mbox_fetch(m,d)
  59 #define sys_mbox_post(m,d)
  60 #define sys_mbox_free(m)
  61
  62 #define sys_thread_new(t,a)
  63
  64 #else /* NO_SYS */
  65
  66 #include "arch/sys_arch.h"
  67
  68 typedef void (* sys_timeout_handler)(void *arg);
  69
  70 struct sys_timeout {
  71   struct sys_timeout *next;
  72   u32_t time;
  73   sys_timeout_handler h;
  74   void *arg;
  75 };
  76
  77 struct sys_timeouts {
  78   struct sys_timeout *next;
  79 };
  80
  81 /* sys_init() must be called before anthing else. */
  82 void sys_init(void);
  83
  84 /*
  85  * sys_timeout():
  86  *
  87  * Schedule a timeout a specified amount of milliseconds in the
  88  * future. When the timeout occurs, the specified timeout handler will
  89  * be called. The handler will be passed the "arg" argument when
  90  * called.
  91  *
  92  */
  93 void sys_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
  94 void sys_untimeout(sys_timeout_handler h, void *arg);
  95 struct sys_timeouts *sys_arch_timeouts(void);
  96
  97 /* Semaphore functions. */
  98 sys_sem_t sys_sem_new(u8_t count);
  99 void sys_sem_signal(sys_sem_t sem);
 100 u32_t sys_arch_sem_wait(sys_sem_t sem, u32_t timeout);
 101 void sys_sem_free(sys_sem_t sem);
 102 void sys_sem_wait(sys_sem_t sem);
 103 int sys_sem_wait_timeout(sys_sem_t sem, u32_t timeout);
 104
 105 /* Mailbox functions. */
 106 sys_mbox_t sys_mbox_new(void);
 107 void sys_mbox_post(sys_mbox_t mbox, void *msg);
 108 u32_t sys_arch_mbox_fetch(sys_mbox_t mbox, void **msg, u32_t timeout);
 109 void sys_mbox_free(sys_mbox_t mbox);
 110 void sys_mbox_fetch(sys_mbox_t mbox, void **msg);
 111
 112 /* Critical Region Protection */
 113 /* These functions must be implemented in the sys_arch.c file.
 114    In some implementations they can provide a more light-weight protection
 115    mechanism than using semaphores. Otherwise semaphores can be used for
 116    implementation */
 117 #ifndef SYS_ARCH_PROTECT
 118 #ifdef SYS_LIGHTWEIGHT_PROT
 119
 120 #undef SYS_ARCH_DECL_PROTECT
 121 #define SYS_ARCH_DECL_PROTECT(lev) sys_prot_t lev
 122 #undef SYS_ARCH_PROTECT
 123 #define SYS_ARCH_PROTECT(lev) lev = sys_arch_protect()
 124 #undef SYS_ARCH_UNPROTECT
 125 #define SYS_ARCH_UNPROTECT(lev) sys_arch_unprotect(lev)
 126 sys_prot_t sys_arch_protect(void);
 127 void sys_arch_unprotect(sys_prot_t pval);
 128 #endif /* SYS_LIGHTWEIGHT_PROT */
 129
 130 #endif /* SYS_ARCH_PROTECT */
 131
 132 /* Thread functions. */
 133 sys_thread_t sys_thread_new(void (* thread)(void *arg), void *arg);
 134
 135 /* The following functions are used only in Unix code, and
 136    can be omitted when porting the stack. */
 137 /* Returns the current time in microseconds. */
 138 unsigned long sys_now(void);
 139
 140 #endif /* NO_SYS */
 141
 142 #endif /* __LWIP_SYS_H__ */