John Lowe
/
WebSockets2
Embedded WebSockets Experiment
Core/lwIP/include/lwip/sys.h@0:6dee052a3fa4, 2011-07-26 (annotated)
- Committer:
- nandgate
- Date:
- Tue Jul 26 05:30:53 2011 +0000
- Revision:
- 0:6dee052a3fa4
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
nandgate | 0:6dee052a3fa4 | 1 | /* |
nandgate | 0:6dee052a3fa4 | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
nandgate | 0:6dee052a3fa4 | 3 | * All rights reserved. |
nandgate | 0:6dee052a3fa4 | 4 | * |
nandgate | 0:6dee052a3fa4 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
nandgate | 0:6dee052a3fa4 | 6 | * are permitted provided that the following conditions are met: |
nandgate | 0:6dee052a3fa4 | 7 | * |
nandgate | 0:6dee052a3fa4 | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
nandgate | 0:6dee052a3fa4 | 9 | * this list of conditions and the following disclaimer. |
nandgate | 0:6dee052a3fa4 | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
nandgate | 0:6dee052a3fa4 | 11 | * this list of conditions and the following disclaimer in the documentation |
nandgate | 0:6dee052a3fa4 | 12 | * and/or other materials provided with the distribution. |
nandgate | 0:6dee052a3fa4 | 13 | * 3. The name of the author may not be used to endorse or promote products |
nandgate | 0:6dee052a3fa4 | 14 | * derived from this software without specific prior written permission. |
nandgate | 0:6dee052a3fa4 | 15 | * |
nandgate | 0:6dee052a3fa4 | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
nandgate | 0:6dee052a3fa4 | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
nandgate | 0:6dee052a3fa4 | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
nandgate | 0:6dee052a3fa4 | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
nandgate | 0:6dee052a3fa4 | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
nandgate | 0:6dee052a3fa4 | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
nandgate | 0:6dee052a3fa4 | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
nandgate | 0:6dee052a3fa4 | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
nandgate | 0:6dee052a3fa4 | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
nandgate | 0:6dee052a3fa4 | 25 | * OF SUCH DAMAGE. |
nandgate | 0:6dee052a3fa4 | 26 | * |
nandgate | 0:6dee052a3fa4 | 27 | * This file is part of the lwIP TCP/IP stack. |
nandgate | 0:6dee052a3fa4 | 28 | * |
nandgate | 0:6dee052a3fa4 | 29 | * Author: Adam Dunkels <adam@sics.se> |
nandgate | 0:6dee052a3fa4 | 30 | * |
nandgate | 0:6dee052a3fa4 | 31 | */ |
nandgate | 0:6dee052a3fa4 | 32 | #ifndef __LWIP_SYS_H__ |
nandgate | 0:6dee052a3fa4 | 33 | #define __LWIP_SYS_H__ |
nandgate | 0:6dee052a3fa4 | 34 | |
nandgate | 0:6dee052a3fa4 | 35 | #include "lwip/opt.h" |
nandgate | 0:6dee052a3fa4 | 36 | |
nandgate | 0:6dee052a3fa4 | 37 | #ifdef __cplusplus |
nandgate | 0:6dee052a3fa4 | 38 | extern "C" { |
nandgate | 0:6dee052a3fa4 | 39 | #endif |
nandgate | 0:6dee052a3fa4 | 40 | |
nandgate | 0:6dee052a3fa4 | 41 | #if NO_SYS |
nandgate | 0:6dee052a3fa4 | 42 | |
nandgate | 0:6dee052a3fa4 | 43 | /* For a totally minimal and standalone system, we provide null |
nandgate | 0:6dee052a3fa4 | 44 | definitions of the sys_ functions. */ |
nandgate | 0:6dee052a3fa4 | 45 | typedef u8_t sys_sem_t; |
nandgate | 0:6dee052a3fa4 | 46 | typedef u8_t sys_mbox_t; |
nandgate | 0:6dee052a3fa4 | 47 | struct sys_timeo {u8_t dummy;}; |
nandgate | 0:6dee052a3fa4 | 48 | |
nandgate | 0:6dee052a3fa4 | 49 | #define sys_init() |
nandgate | 0:6dee052a3fa4 | 50 | #define sys_timeout(m,h,a) |
nandgate | 0:6dee052a3fa4 | 51 | #define sys_untimeout(m,a) |
nandgate | 0:6dee052a3fa4 | 52 | #define sys_sem_new(c) c |
nandgate | 0:6dee052a3fa4 | 53 | #define sys_sem_signal(s) |
nandgate | 0:6dee052a3fa4 | 54 | #define sys_sem_wait(s) |
nandgate | 0:6dee052a3fa4 | 55 | #define sys_sem_wait_timeout(s,t) |
nandgate | 0:6dee052a3fa4 | 56 | #define sys_arch_sem_wait(s,t) |
nandgate | 0:6dee052a3fa4 | 57 | #define sys_sem_free(s) |
nandgate | 0:6dee052a3fa4 | 58 | #define sys_mbox_new(s) 0 |
nandgate | 0:6dee052a3fa4 | 59 | #define sys_mbox_fetch(m,d) |
nandgate | 0:6dee052a3fa4 | 60 | #define sys_mbox_tryfetch(m,d) |
nandgate | 0:6dee052a3fa4 | 61 | #define sys_mbox_post(m,d) |
nandgate | 0:6dee052a3fa4 | 62 | #define sys_mbox_trypost(m,d) |
nandgate | 0:6dee052a3fa4 | 63 | #define sys_mbox_free(m) |
nandgate | 0:6dee052a3fa4 | 64 | |
nandgate | 0:6dee052a3fa4 | 65 | #define sys_thread_new(n,t,a,s,p) |
nandgate | 0:6dee052a3fa4 | 66 | |
nandgate | 0:6dee052a3fa4 | 67 | #else /* NO_SYS */ |
nandgate | 0:6dee052a3fa4 | 68 | |
nandgate | 0:6dee052a3fa4 | 69 | /** Return code for timeouts from sys_arch_mbox_fetch and sys_arch_sem_wait */ |
nandgate | 0:6dee052a3fa4 | 70 | #define SYS_ARCH_TIMEOUT 0xffffffffUL |
nandgate | 0:6dee052a3fa4 | 71 | |
nandgate | 0:6dee052a3fa4 | 72 | /* sys_mbox_tryfetch returns SYS_MBOX_EMPTY if appropriate. |
nandgate | 0:6dee052a3fa4 | 73 | * For now we use the same magic value, but we allow this to change in future. |
nandgate | 0:6dee052a3fa4 | 74 | */ |
nandgate | 0:6dee052a3fa4 | 75 | #define SYS_MBOX_EMPTY SYS_ARCH_TIMEOUT |
nandgate | 0:6dee052a3fa4 | 76 | |
nandgate | 0:6dee052a3fa4 | 77 | #include "lwip/err.h" |
nandgate | 0:6dee052a3fa4 | 78 | #include "arch/sys_arch.h" |
nandgate | 0:6dee052a3fa4 | 79 | |
nandgate | 0:6dee052a3fa4 | 80 | typedef void (* sys_timeout_handler)(void *arg); |
nandgate | 0:6dee052a3fa4 | 81 | |
nandgate | 0:6dee052a3fa4 | 82 | struct sys_timeo { |
nandgate | 0:6dee052a3fa4 | 83 | struct sys_timeo *next; |
nandgate | 0:6dee052a3fa4 | 84 | u32_t time; |
nandgate | 0:6dee052a3fa4 | 85 | sys_timeout_handler h; |
nandgate | 0:6dee052a3fa4 | 86 | void *arg; |
nandgate | 0:6dee052a3fa4 | 87 | }; |
nandgate | 0:6dee052a3fa4 | 88 | |
nandgate | 0:6dee052a3fa4 | 89 | struct sys_timeouts { |
nandgate | 0:6dee052a3fa4 | 90 | struct sys_timeo *next; |
nandgate | 0:6dee052a3fa4 | 91 | }; |
nandgate | 0:6dee052a3fa4 | 92 | |
nandgate | 0:6dee052a3fa4 | 93 | /* sys_init() must be called before anthing else. */ |
nandgate | 0:6dee052a3fa4 | 94 | void sys_init(void); |
nandgate | 0:6dee052a3fa4 | 95 | |
nandgate | 0:6dee052a3fa4 | 96 | /* |
nandgate | 0:6dee052a3fa4 | 97 | * sys_timeout(): |
nandgate | 0:6dee052a3fa4 | 98 | * |
nandgate | 0:6dee052a3fa4 | 99 | * Schedule a timeout a specified amount of milliseconds in the |
nandgate | 0:6dee052a3fa4 | 100 | * future. When the timeout occurs, the specified timeout handler will |
nandgate | 0:6dee052a3fa4 | 101 | * be called. The handler will be passed the "arg" argument when |
nandgate | 0:6dee052a3fa4 | 102 | * called. |
nandgate | 0:6dee052a3fa4 | 103 | * |
nandgate | 0:6dee052a3fa4 | 104 | */ |
nandgate | 0:6dee052a3fa4 | 105 | void sys_timeout(u32_t msecs, sys_timeout_handler h, void *arg); |
nandgate | 0:6dee052a3fa4 | 106 | void sys_untimeout(sys_timeout_handler h, void *arg); |
nandgate | 0:6dee052a3fa4 | 107 | struct sys_timeouts *sys_arch_timeouts(void); |
nandgate | 0:6dee052a3fa4 | 108 | |
nandgate | 0:6dee052a3fa4 | 109 | /* Semaphore functions. */ |
nandgate | 0:6dee052a3fa4 | 110 | sys_sem_t sys_sem_new(u8_t count); |
nandgate | 0:6dee052a3fa4 | 111 | void sys_sem_signal(sys_sem_t sem); |
nandgate | 0:6dee052a3fa4 | 112 | u32_t sys_arch_sem_wait(sys_sem_t sem, u32_t timeout); |
nandgate | 0:6dee052a3fa4 | 113 | void sys_sem_free(sys_sem_t sem); |
nandgate | 0:6dee052a3fa4 | 114 | void sys_sem_wait(sys_sem_t sem); |
nandgate | 0:6dee052a3fa4 | 115 | int sys_sem_wait_timeout(sys_sem_t sem, u32_t timeout); |
nandgate | 0:6dee052a3fa4 | 116 | |
nandgate | 0:6dee052a3fa4 | 117 | /* Time functions. */ |
nandgate | 0:6dee052a3fa4 | 118 | #ifndef sys_msleep |
nandgate | 0:6dee052a3fa4 | 119 | void sys_msleep(u32_t ms); /* only has a (close to) 1 jiffy resolution. */ |
nandgate | 0:6dee052a3fa4 | 120 | #endif |
nandgate | 0:6dee052a3fa4 | 121 | #ifndef sys_jiffies |
nandgate | 0:6dee052a3fa4 | 122 | u32_t sys_jiffies(void); /* since power up. */ |
nandgate | 0:6dee052a3fa4 | 123 | #endif |
nandgate | 0:6dee052a3fa4 | 124 | |
nandgate | 0:6dee052a3fa4 | 125 | /* Mailbox functions. */ |
nandgate | 0:6dee052a3fa4 | 126 | sys_mbox_t sys_mbox_new(int size); |
nandgate | 0:6dee052a3fa4 | 127 | void sys_mbox_post(sys_mbox_t mbox, void *msg); |
nandgate | 0:6dee052a3fa4 | 128 | err_t sys_mbox_trypost(sys_mbox_t mbox, void *msg); |
nandgate | 0:6dee052a3fa4 | 129 | u32_t sys_arch_mbox_fetch(sys_mbox_t mbox, void **msg, u32_t timeout); |
nandgate | 0:6dee052a3fa4 | 130 | #ifndef sys_arch_mbox_tryfetch /* Allow port to override with a macro */ |
nandgate | 0:6dee052a3fa4 | 131 | u32_t sys_arch_mbox_tryfetch(sys_mbox_t mbox, void **msg); |
nandgate | 0:6dee052a3fa4 | 132 | #endif |
nandgate | 0:6dee052a3fa4 | 133 | /* For now, we map straight to sys_arch implementation. */ |
nandgate | 0:6dee052a3fa4 | 134 | #define sys_mbox_tryfetch(mbox, msg) sys_arch_mbox_tryfetch(mbox, msg) |
nandgate | 0:6dee052a3fa4 | 135 | void sys_mbox_free(sys_mbox_t mbox); |
nandgate | 0:6dee052a3fa4 | 136 | void sys_mbox_fetch(sys_mbox_t mbox, void **msg); |
nandgate | 0:6dee052a3fa4 | 137 | |
nandgate | 0:6dee052a3fa4 | 138 | /* Thread functions. */ |
nandgate | 0:6dee052a3fa4 | 139 | sys_thread_t sys_thread_new(char *name, void (* thread)(void *arg), void *arg, int stacksize, int prio); |
nandgate | 0:6dee052a3fa4 | 140 | |
nandgate | 0:6dee052a3fa4 | 141 | #endif /* NO_SYS */ |
nandgate | 0:6dee052a3fa4 | 142 | |
nandgate | 0:6dee052a3fa4 | 143 | /** Returns the current time in milliseconds. */ |
nandgate | 0:6dee052a3fa4 | 144 | u32_t sys_now(void); |
nandgate | 0:6dee052a3fa4 | 145 | |
nandgate | 0:6dee052a3fa4 | 146 | /* Critical Region Protection */ |
nandgate | 0:6dee052a3fa4 | 147 | /* These functions must be implemented in the sys_arch.c file. |
nandgate | 0:6dee052a3fa4 | 148 | In some implementations they can provide a more light-weight protection |
nandgate | 0:6dee052a3fa4 | 149 | mechanism than using semaphores. Otherwise semaphores can be used for |
nandgate | 0:6dee052a3fa4 | 150 | implementation */ |
nandgate | 0:6dee052a3fa4 | 151 | #ifndef SYS_ARCH_PROTECT |
nandgate | 0:6dee052a3fa4 | 152 | /** SYS_LIGHTWEIGHT_PROT |
nandgate | 0:6dee052a3fa4 | 153 | * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection |
nandgate | 0:6dee052a3fa4 | 154 | * for certain critical regions during buffer allocation, deallocation and memory |
nandgate | 0:6dee052a3fa4 | 155 | * allocation and deallocation. |
nandgate | 0:6dee052a3fa4 | 156 | */ |
nandgate | 0:6dee052a3fa4 | 157 | #if SYS_LIGHTWEIGHT_PROT |
nandgate | 0:6dee052a3fa4 | 158 | |
nandgate | 0:6dee052a3fa4 | 159 | /** SYS_ARCH_DECL_PROTECT |
nandgate | 0:6dee052a3fa4 | 160 | * declare a protection variable. This macro will default to defining a variable of |
nandgate | 0:6dee052a3fa4 | 161 | * type sys_prot_t. If a particular port needs a different implementation, then |
nandgate | 0:6dee052a3fa4 | 162 | * this macro may be defined in sys_arch.h. |
nandgate | 0:6dee052a3fa4 | 163 | */ |
nandgate | 0:6dee052a3fa4 | 164 | #define SYS_ARCH_DECL_PROTECT(lev) sys_prot_t lev |
nandgate | 0:6dee052a3fa4 | 165 | /** SYS_ARCH_PROTECT |
nandgate | 0:6dee052a3fa4 | 166 | * Perform a "fast" protect. This could be implemented by |
nandgate | 0:6dee052a3fa4 | 167 | * disabling interrupts for an embedded system or by using a semaphore or |
nandgate | 0:6dee052a3fa4 | 168 | * mutex. The implementation should allow calling SYS_ARCH_PROTECT when |
nandgate | 0:6dee052a3fa4 | 169 | * already protected. The old protection level is returned in the variable |
nandgate | 0:6dee052a3fa4 | 170 | * "lev". This macro will default to calling the sys_arch_protect() function |
nandgate | 0:6dee052a3fa4 | 171 | * which should be implemented in sys_arch.c. If a particular port needs a |
nandgate | 0:6dee052a3fa4 | 172 | * different implementation, then this macro may be defined in sys_arch.h |
nandgate | 0:6dee052a3fa4 | 173 | */ |
nandgate | 0:6dee052a3fa4 | 174 | #define SYS_ARCH_PROTECT(lev) lev = sys_arch_protect() |
nandgate | 0:6dee052a3fa4 | 175 | /** SYS_ARCH_UNPROTECT |
nandgate | 0:6dee052a3fa4 | 176 | * Perform a "fast" set of the protection level to "lev". This could be |
nandgate | 0:6dee052a3fa4 | 177 | * implemented by setting the interrupt level to "lev" within the MACRO or by |
nandgate | 0:6dee052a3fa4 | 178 | * using a semaphore or mutex. This macro will default to calling the |
nandgate | 0:6dee052a3fa4 | 179 | * sys_arch_unprotect() function which should be implemented in |
nandgate | 0:6dee052a3fa4 | 180 | * sys_arch.c. If a particular port needs a different implementation, then |
nandgate | 0:6dee052a3fa4 | 181 | * this macro may be defined in sys_arch.h |
nandgate | 0:6dee052a3fa4 | 182 | */ |
nandgate | 0:6dee052a3fa4 | 183 | #define SYS_ARCH_UNPROTECT(lev) sys_arch_unprotect(lev) |
nandgate | 0:6dee052a3fa4 | 184 | sys_prot_t sys_arch_protect(void); |
nandgate | 0:6dee052a3fa4 | 185 | void sys_arch_unprotect(sys_prot_t pval); |
nandgate | 0:6dee052a3fa4 | 186 | |
nandgate | 0:6dee052a3fa4 | 187 | #else |
nandgate | 0:6dee052a3fa4 | 188 | |
nandgate | 0:6dee052a3fa4 | 189 | #define SYS_ARCH_DECL_PROTECT(lev) |
nandgate | 0:6dee052a3fa4 | 190 | #define SYS_ARCH_PROTECT(lev) |
nandgate | 0:6dee052a3fa4 | 191 | #define SYS_ARCH_UNPROTECT(lev) |
nandgate | 0:6dee052a3fa4 | 192 | |
nandgate | 0:6dee052a3fa4 | 193 | #endif /* SYS_LIGHTWEIGHT_PROT */ |
nandgate | 0:6dee052a3fa4 | 194 | |
nandgate | 0:6dee052a3fa4 | 195 | #endif /* SYS_ARCH_PROTECT */ |
nandgate | 0:6dee052a3fa4 | 196 | |
nandgate | 0:6dee052a3fa4 | 197 | /* |
nandgate | 0:6dee052a3fa4 | 198 | * Macros to set/get and increase/decrease variables in a thread-safe way. |
nandgate | 0:6dee052a3fa4 | 199 | * Use these for accessing variable that are used from more than one thread. |
nandgate | 0:6dee052a3fa4 | 200 | */ |
nandgate | 0:6dee052a3fa4 | 201 | |
nandgate | 0:6dee052a3fa4 | 202 | #ifndef SYS_ARCH_INC |
nandgate | 0:6dee052a3fa4 | 203 | #define SYS_ARCH_INC(var, val) do { \ |
nandgate | 0:6dee052a3fa4 | 204 | SYS_ARCH_DECL_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 205 | SYS_ARCH_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 206 | var += val; \ |
nandgate | 0:6dee052a3fa4 | 207 | SYS_ARCH_UNPROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 208 | } while(0) |
nandgate | 0:6dee052a3fa4 | 209 | #endif /* SYS_ARCH_INC */ |
nandgate | 0:6dee052a3fa4 | 210 | |
nandgate | 0:6dee052a3fa4 | 211 | #ifndef SYS_ARCH_DEC |
nandgate | 0:6dee052a3fa4 | 212 | #define SYS_ARCH_DEC(var, val) do { \ |
nandgate | 0:6dee052a3fa4 | 213 | SYS_ARCH_DECL_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 214 | SYS_ARCH_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 215 | var -= val; \ |
nandgate | 0:6dee052a3fa4 | 216 | SYS_ARCH_UNPROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 217 | } while(0) |
nandgate | 0:6dee052a3fa4 | 218 | #endif /* SYS_ARCH_DEC */ |
nandgate | 0:6dee052a3fa4 | 219 | |
nandgate | 0:6dee052a3fa4 | 220 | #ifndef SYS_ARCH_GET |
nandgate | 0:6dee052a3fa4 | 221 | #define SYS_ARCH_GET(var, ret) do { \ |
nandgate | 0:6dee052a3fa4 | 222 | SYS_ARCH_DECL_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 223 | SYS_ARCH_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 224 | ret = var; \ |
nandgate | 0:6dee052a3fa4 | 225 | SYS_ARCH_UNPROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 226 | } while(0) |
nandgate | 0:6dee052a3fa4 | 227 | #endif /* SYS_ARCH_GET */ |
nandgate | 0:6dee052a3fa4 | 228 | |
nandgate | 0:6dee052a3fa4 | 229 | #ifndef SYS_ARCH_SET |
nandgate | 0:6dee052a3fa4 | 230 | #define SYS_ARCH_SET(var, val) do { \ |
nandgate | 0:6dee052a3fa4 | 231 | SYS_ARCH_DECL_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 232 | SYS_ARCH_PROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 233 | var = val; \ |
nandgate | 0:6dee052a3fa4 | 234 | SYS_ARCH_UNPROTECT(old_level); \ |
nandgate | 0:6dee052a3fa4 | 235 | } while(0) |
nandgate | 0:6dee052a3fa4 | 236 | #endif /* SYS_ARCH_SET */ |
nandgate | 0:6dee052a3fa4 | 237 | |
nandgate | 0:6dee052a3fa4 | 238 | |
nandgate | 0:6dee052a3fa4 | 239 | #ifdef __cplusplus |
nandgate | 0:6dee052a3fa4 | 240 | } |
nandgate | 0:6dee052a3fa4 | 241 | #endif |
nandgate | 0:6dee052a3fa4 | 242 | |
nandgate | 0:6dee052a3fa4 | 243 | #endif /* __LWIP_SYS_H__ */ |