2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
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.
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
27 * This file is part of the lwIP TCP/IP stack.
29 * Author: Adam Dunkels <adam@sics.se>
32 #ifndef __LWIP_SYS_H__
33 #define __LWIP_SYS_H__
42 /* For a totally minimal and standalone system, we provide null
43 definitions of the sys_ functions. */
44 typedef u8_t sys_sem_t;
45 typedef u8_t sys_mbox_t;
46 struct sys_timeo {u8_t dummy;};
49 #define sys_timeout(m,h,a)
50 #define sys_untimeout(m,a)
51 #define sys_sem_new(c) c
52 #define sys_sem_signal(s)
53 #define sys_sem_wait(s)
54 #define sys_sem_free(s)
55 #define sys_mbox_new() 0
56 #define sys_mbox_fetch(m,d)
57 #define sys_mbox_post(m,d)
58 #define sys_mbox_free(m)
60 #define sys_thread_new(t,a,p)
64 #include "arch/sys_arch.h"
66 /** Return code for timeouts from sys_arch_mbox_fetch and sys_arch_sem_wait */
67 #define SYS_ARCH_TIMEOUT 0xffffffff
69 typedef void (* sys_timeout_handler)(void *arg);
72 struct sys_timeo *next;
74 sys_timeout_handler h;
79 struct sys_timeo *next;
82 /* sys_init() must be called before anthing else. */
88 * Schedule a timeout a specified amount of milliseconds in the
89 * future. When the timeout occurs, the specified timeout handler will
90 * be called. The handler will be passed the "arg" argument when
94 void sys_timeout(u32_t msecs, sys_timeout_handler h, void *arg);
95 void sys_untimeout(sys_timeout_handler h, void *arg);
96 struct sys_timeouts *sys_arch_timeouts(void);
98 /* Semaphore functions. */
99 sys_sem_t sys_sem_new(u8_t count);
100 void sys_sem_signal(sys_sem_t sem);
101 u32_t sys_arch_sem_wait(sys_sem_t sem, u32_t timeout);
102 void sys_sem_free(sys_sem_t sem);
103 void sys_sem_wait(sys_sem_t sem);
104 int sys_sem_wait_timeout(sys_sem_t sem, u32_t timeout);
106 /* Time functions. */
108 void sys_msleep(u32_t ms); /* only has a (close to) 1 jiffy resolution. */
111 u32_t sys_jiffies(void); /* since power up. */
114 /* Mailbox functions. */
115 sys_mbox_t sys_mbox_new(void);
116 void sys_mbox_post(sys_mbox_t mbox, void *msg);
117 u32_t sys_arch_mbox_fetch(sys_mbox_t mbox, void **msg, u32_t timeout);
118 void sys_mbox_free(sys_mbox_t mbox);
119 void sys_mbox_fetch(sys_mbox_t mbox, void **msg);
122 /* Thread functions. */
123 sys_thread_t sys_thread_new(void (* thread)(void *arg), void *arg, int prio);
125 /* The following functions are used only in Unix code, and
126 can be omitted when porting the stack. */
127 /* Returns the current time in microseconds. */
128 unsigned long sys_now(void);
132 /* Critical Region Protection */
133 /* These functions must be implemented in the sys_arch.c file.
134 In some implementations they can provide a more light-weight protection
135 mechanism than using semaphores. Otherwise semaphores can be used for
137 #ifndef SYS_ARCH_PROTECT
138 /** SYS_LIGHTWEIGHT_PROT
139 * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection
140 * for certain critical regions during buffer allocation, deallocation and memory
141 * allocation and deallocation.
143 #if SYS_LIGHTWEIGHT_PROT
145 /** SYS_ARCH_DECL_PROTECT
146 * declare a protection variable. This macro will default to defining a variable of
147 * type sys_prot_t. If a particular port needs a different implementation, then
148 * this macro may be defined in sys_arch.h.
150 #define SYS_ARCH_DECL_PROTECT(lev) sys_prot_t lev
152 * Perform a "fast" protect. This could be implemented by
153 * disabling interrupts for an embedded system or by using a semaphore or
154 * mutex. The implementation should allow calling SYS_ARCH_PROTECT when
155 * already protected. The old protection level is returned in the variable
156 * "lev". This macro will default to calling the sys_arch_protect() function
157 * which should be implemented in sys_arch.c. If a particular port needs a
158 * different implementation, then this macro may be defined in sys_arch.h
160 #define SYS_ARCH_PROTECT(lev) lev = sys_arch_protect()
161 /** SYS_ARCH_UNPROTECT
162 * Perform a "fast" set of the protection level to "lev". This could be
163 * implemented by setting the interrupt level to "lev" within the MACRO or by
164 * using a semaphore or mutex. This macro will default to calling the
165 * sys_arch_unprotect() function which should be implemented in
166 * sys_arch.c. If a particular port needs a different implementation, then
167 * this macro may be defined in sys_arch.h
169 #define SYS_ARCH_UNPROTECT(lev) sys_arch_unprotect(lev)
170 sys_prot_t sys_arch_protect(void);
171 void sys_arch_unprotect(sys_prot_t pval);
175 #define SYS_ARCH_DECL_PROTECT(lev)
176 #define SYS_ARCH_PROTECT(lev)
177 #define SYS_ARCH_UNPROTECT(lev)
179 #endif /* SYS_LIGHTWEIGHT_PROT */
181 #endif /* SYS_ARCH_PROTECT */
183 #endif /* __LWIP_SYS_H__ */