ESP8266
sys.h
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  *
31  */
32 #ifndef __LWIP_SYS_H__
33 #define __LWIP_SYS_H__
34 
35 #include "lwip/opt.h"
36 
37 #include "eagle_soc.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
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_mutex_t;
49 typedef u8_t sys_mbox_t;
50 
51 #define sys_sem_new(s, c) ERR_OK
52 #define sys_sem_signal(s)
53 #define sys_sem_wait(s)
54 #define sys_arch_sem_wait(s,t)
55 #define sys_sem_free(s)
56 #define sys_mutex_new(mu) ERR_OK
57 #define sys_mutex_lock(mu)
58 #define sys_mutex_unlock(mu)
59 #define sys_mutex_free(mu)
60 #define sys_mbox_new(m, s) ERR_OK
61 #define sys_mbox_fetch(m,d)
62 #define sys_mbox_tryfetch(m,d)
63 #define sys_mbox_post(m,d)
64 #define sys_mbox_trypost(m,d)
65 #define sys_mbox_free(m)
66 
67 #define sys_thread_new(n,t,a,s,p)
68 
69 #define sys_msleep(t)
70 
71 #else /* NO_SYS */
72 
74 #define SYS_ARCH_TIMEOUT 0xffffffffUL
75 
79 #define SYS_MBOX_EMPTY SYS_ARCH_TIMEOUT
80 
81 #include "lwip/err.h"
82 #include "arch/sys_arch.h"
83 
85 typedef void (*lwip_thread_fn)(void *arg);
86 
87 /* Function prototypes for functions to be implemented by platform ports
88  (in sys_arch.c) */
89 
90 /* Mutex functions: */
91 
94 #if LWIP_COMPAT_MUTEX
95 /* for old ports that don't have mutexes: define them to binary semaphores */
96 #define sys_mutex_t sys_sem_t
97 #define sys_mutex_new(mutex) sys_sem_new(mutex, 1)
98 #define sys_mutex_lock(mutex) sys_sem_wait(mutex)
99 #define sys_mutex_unlock(mutex) sys_sem_signal(mutex)
100 #define sys_mutex_free(mutex) sys_sem_free(mutex)
101 #define sys_mutex_valid(mutex) sys_sem_valid(mutex)
102 #define sys_mutex_set_invalid(mutex) sys_sem_set_invalid(mutex)
103 
104 #else /* LWIP_COMPAT_MUTEX */
105 
109 err_t sys_mutex_new(sys_mutex_t *mutex);
112 void sys_mutex_lock(sys_mutex_t *mutex);
115 void sys_mutex_unlock(sys_mutex_t *mutex);
118 void sys_mutex_free(sys_mutex_t *mutex);
119 #ifndef sys_mutex_valid
120 
121 int sys_mutex_valid(sys_mutex_t *mutex);
122 #endif
123 #ifndef sys_mutex_set_invalid
124 
125 void sys_mutex_set_invalid(sys_mutex_t *mutex);
126 #endif
127 #endif /* LWIP_COMPAT_MUTEX */
128 
129 /* Semaphore functions: */
130 
135 err_t sys_sem_new(sys_sem_t *sem, u8_t count);
138 void sys_sem_signal(sys_sem_t *sem);
144 u32_t sys_arch_sem_wait(sys_sem_t *sem, u32_t timeout);
147 void sys_sem_free(sys_sem_t *sem);
149 #define sys_sem_wait(sem) sys_arch_sem_wait(sem, 0)
150 #ifndef sys_sem_valid
151 
152 int sys_sem_valid(sys_sem_t *sem);
153 #endif
154 #ifndef sys_sem_set_invalid
155 
156 void sys_sem_set_invalid(sys_sem_t *sem);
157 #endif
158 
159 /* Time functions. */
160 #ifndef sys_msleep
161 void sys_msleep(u32_t ms); /* only has a (close to) 1 jiffy resolution. */
162 #endif
163 
164 /* Mailbox functions. */
165 
170 err_t sys_mbox_new(sys_mbox_t *mbox, int size);
175 void sys_mbox_post(sys_mbox_t *mbox, void *msg);
179 err_t sys_mbox_trypost(sys_mbox_t *mbox, void *msg);
187 u32_t sys_arch_mbox_fetch(sys_mbox_t *mbox, void **msg, u32_t timeout);
188 /* Allow port to override with a macro, e.g. special timout for sys_arch_mbox_fetch() */
189 #ifndef sys_arch_mbox_tryfetch
190 
196 u32_t sys_arch_mbox_tryfetch(sys_mbox_t *mbox, void **msg);
197 #endif
198 
199 #define sys_mbox_tryfetch(mbox, msg) sys_arch_mbox_tryfetch(mbox, msg)
200 
202 void sys_mbox_free(sys_mbox_t *mbox);
203 #define sys_mbox_fetch(mbox, msg) sys_arch_mbox_fetch(mbox, msg, 0)
204 #ifndef sys_mbox_valid
205 
206 int sys_mbox_valid(sys_mbox_t *mbox);
207 #endif
208 #ifndef sys_mbox_set_invalid
209 
210 void sys_mbox_set_invalid(sys_mbox_t *mbox);
211 #endif
212 
220 sys_thread_t sys_thread_new(const char *name, lwip_thread_fn thread, void *arg, int stacksize, int prio);
221 
222 #endif /* NO_SYS */
223 
224 /* sys_init() must be called before anthing else. */
225 void sys_init(void)ICACHE_FLASH_ATTR;
226 
227 #ifndef sys_jiffies
228 
229 u32_t sys_jiffies(void)ICACHE_FLASH_ATTR;
230 #endif
231 
234 static inline u32_t sys_now(void) ICACHE_FLASH_ATTR;
235 static inline u32_t sys_now(void)
236 {
237  return NOW()/(TIMER_CLK_FREQ/1000);
238 }
239 
240 /* Critical Region Protection */
241 /* These functions must be implemented in the sys_arch.c file.
242  In some implementations they can provide a more light-weight protection
243  mechanism than using semaphores. Otherwise semaphores can be used for
244  implementation */
245 #ifndef SYS_ARCH_PROTECT
246 
251 #if SYS_LIGHTWEIGHT_PROT
252 
258 #define SYS_ARCH_DECL_PROTECT(lev) sys_prot_t lev
259 
268 #define SYS_ARCH_PROTECT(lev) lev = sys_arch_protect()
269 
277 #define SYS_ARCH_UNPROTECT(lev) sys_arch_unprotect(lev)
278 sys_prot_t sys_arch_protect(void)ICACHE_FLASH_ATTR;
279 void sys_arch_unprotect(sys_prot_t pval)ICACHE_FLASH_ATTR;
280 
281 #else
282 
283 #define SYS_ARCH_DECL_PROTECT(lev)
284 #define SYS_ARCH_PROTECT(lev) lev = os_intr_lock() //fix by ives at 2014.3.24
285 #define SYS_ARCH_UNPROTECT(lev) lev = os_intr_unlock()
286 
287 #endif /* SYS_LIGHTWEIGHT_PROT */
288 
289 #endif /* SYS_ARCH_PROTECT */
290 
291 /*
292  * Macros to set/get and increase/decrease variables in a thread-safe way.
293  * Use these for accessing variable that are used from more than one thread.
294  */
295 
296 #ifndef SYS_ARCH_INC
297 #define SYS_ARCH_INC(var, val) do { \
298  SYS_ARCH_DECL_PROTECT(old_level); \
299  SYS_ARCH_PROTECT(old_level); \
300  var += val; \
301  SYS_ARCH_UNPROTECT(old_level); \
302  } while(0)
303 #endif /* SYS_ARCH_INC */
304 
305 #ifndef SYS_ARCH_DEC
306 #define SYS_ARCH_DEC(var, val) do { \
307  SYS_ARCH_DECL_PROTECT(old_level); \
308  SYS_ARCH_PROTECT(old_level); \
309  var -= val; \
310  SYS_ARCH_UNPROTECT(old_level); \
311  } while(0)
312 #endif /* SYS_ARCH_DEC */
313 
314 #ifndef SYS_ARCH_GET
315 #define SYS_ARCH_GET(var, ret) do { \
316  SYS_ARCH_DECL_PROTECT(old_level); \
317  SYS_ARCH_PROTECT(old_level); \
318  ret = var; \
319  SYS_ARCH_UNPROTECT(old_level); \
320  } while(0)
321 #endif /* SYS_ARCH_GET */
322 
323 #ifndef SYS_ARCH_SET
324 #define SYS_ARCH_SET(var, val) do { \
325  SYS_ARCH_DECL_PROTECT(old_level); \
326  SYS_ARCH_PROTECT(old_level); \
327  var = val; \
328  SYS_ARCH_UNPROTECT(old_level); \
329  } while(0)
330 #endif /* SYS_ARCH_SET */
331 
332 
333 #ifdef __cplusplus
334 }
335 #endif
336 
337 #endif /* __LWIP_SYS_H__ */