ZG2100 Network interface source
lwip/include/lwip/sys.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
donatien | 0:b802fc31f1db | 1 | /* |
donatien | 0:b802fc31f1db | 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
donatien | 0:b802fc31f1db | 3 | * All rights reserved. |
donatien | 0:b802fc31f1db | 4 | * |
donatien | 0:b802fc31f1db | 5 | * Redistribution and use in source and binary forms, with or without modification, |
donatien | 0:b802fc31f1db | 6 | * are permitted provided that the following conditions are met: |
donatien | 0:b802fc31f1db | 7 | * |
donatien | 0:b802fc31f1db | 8 | * 1. Redistributions of source code must retain the above copyright notice, |
donatien | 0:b802fc31f1db | 9 | * this list of conditions and the following disclaimer. |
donatien | 0:b802fc31f1db | 10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
donatien | 0:b802fc31f1db | 11 | * this list of conditions and the following disclaimer in the documentation |
donatien | 0:b802fc31f1db | 12 | * and/or other materials provided with the distribution. |
donatien | 0:b802fc31f1db | 13 | * 3. The name of the author may not be used to endorse or promote products |
donatien | 0:b802fc31f1db | 14 | * derived from this software without specific prior written permission. |
donatien | 0:b802fc31f1db | 15 | * |
donatien | 0:b802fc31f1db | 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
donatien | 0:b802fc31f1db | 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
donatien | 0:b802fc31f1db | 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
donatien | 0:b802fc31f1db | 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
donatien | 0:b802fc31f1db | 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
donatien | 0:b802fc31f1db | 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
donatien | 0:b802fc31f1db | 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
donatien | 0:b802fc31f1db | 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
donatien | 0:b802fc31f1db | 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
donatien | 0:b802fc31f1db | 25 | * OF SUCH DAMAGE. |
donatien | 0:b802fc31f1db | 26 | * |
donatien | 0:b802fc31f1db | 27 | * This file is part of the lwIP TCP/IP stack. |
donatien | 0:b802fc31f1db | 28 | * |
donatien | 0:b802fc31f1db | 29 | * Author: Adam Dunkels <adam@sics.se> |
donatien | 0:b802fc31f1db | 30 | * |
donatien | 0:b802fc31f1db | 31 | */ |
donatien | 0:b802fc31f1db | 32 | #ifndef __LWIP_SYS_H__ |
donatien | 0:b802fc31f1db | 33 | #define __LWIP_SYS_H__ |
donatien | 0:b802fc31f1db | 34 | |
donatien | 0:b802fc31f1db | 35 | #include "lwip/opt.h" |
donatien | 0:b802fc31f1db | 36 | |
donatien | 0:b802fc31f1db | 37 | #ifdef __cplusplus |
donatien | 0:b802fc31f1db | 38 | extern "C" { |
donatien | 0:b802fc31f1db | 39 | #endif |
donatien | 0:b802fc31f1db | 40 | |
donatien | 0:b802fc31f1db | 41 | #if NO_SYS |
donatien | 0:b802fc31f1db | 42 | |
donatien | 0:b802fc31f1db | 43 | /* For a totally minimal and standalone system, we provide null |
donatien | 0:b802fc31f1db | 44 | definitions of the sys_ functions. */ |
donatien | 0:b802fc31f1db | 45 | typedef u8_t sys_sem_t; |
donatien | 0:b802fc31f1db | 46 | typedef u8_t sys_mutex_t; |
donatien | 0:b802fc31f1db | 47 | typedef u8_t sys_mbox_t; |
donatien | 0:b802fc31f1db | 48 | |
donatien | 0:b802fc31f1db | 49 | #define sys_sem_new(s, c) ERR_OK |
donatien | 0:b802fc31f1db | 50 | #define sys_sem_signal(s) |
donatien | 0:b802fc31f1db | 51 | #define sys_sem_wait(s) |
donatien | 0:b802fc31f1db | 52 | #define sys_arch_sem_wait(s,t) |
donatien | 0:b802fc31f1db | 53 | #define sys_sem_free(s) |
donatien | 0:b802fc31f1db | 54 | #define sys_mutex_new(mu) ERR_OK |
donatien | 0:b802fc31f1db | 55 | #define sys_mutex_lock(mu) |
donatien | 0:b802fc31f1db | 56 | #define sys_mutex_unlock(mu) |
donatien | 0:b802fc31f1db | 57 | #define sys_mutex_free(mu) |
donatien | 0:b802fc31f1db | 58 | #define sys_mbox_new(m, s) ERR_OK |
donatien | 0:b802fc31f1db | 59 | #define sys_mbox_fetch(m,d) |
donatien | 0:b802fc31f1db | 60 | #define sys_mbox_tryfetch(m,d) |
donatien | 0:b802fc31f1db | 61 | #define sys_mbox_post(m,d) |
donatien | 0:b802fc31f1db | 62 | #define sys_mbox_trypost(m,d) |
donatien | 0:b802fc31f1db | 63 | #define sys_mbox_free(m) |
donatien | 0:b802fc31f1db | 64 | |
donatien | 0:b802fc31f1db | 65 | #define sys_thread_new(n,t,a,s,p) |
donatien | 0:b802fc31f1db | 66 | |
donatien | 0:b802fc31f1db | 67 | #define sys_msleep(t) |
donatien | 0:b802fc31f1db | 68 | |
donatien | 0:b802fc31f1db | 69 | #else /* NO_SYS */ |
donatien | 0:b802fc31f1db | 70 | |
donatien | 0:b802fc31f1db | 71 | /** Return code for timeouts from sys_arch_mbox_fetch and sys_arch_sem_wait */ |
donatien | 0:b802fc31f1db | 72 | #define SYS_ARCH_TIMEOUT 0xffffffffUL |
donatien | 0:b802fc31f1db | 73 | |
donatien | 0:b802fc31f1db | 74 | /** sys_mbox_tryfetch() returns SYS_MBOX_EMPTY if appropriate. |
donatien | 0:b802fc31f1db | 75 | * For now we use the same magic value, but we allow this to change in future. |
donatien | 0:b802fc31f1db | 76 | */ |
donatien | 0:b802fc31f1db | 77 | #define SYS_MBOX_EMPTY SYS_ARCH_TIMEOUT |
donatien | 0:b802fc31f1db | 78 | |
donatien | 0:b802fc31f1db | 79 | #include "lwip/err.h" |
donatien | 0:b802fc31f1db | 80 | #include "arch/sys_arch.h" |
donatien | 0:b802fc31f1db | 81 | |
donatien | 0:b802fc31f1db | 82 | /** Function prototype for thread functions */ |
donatien | 0:b802fc31f1db | 83 | typedef void (*lwip_thread_fn)(void *arg); |
donatien | 0:b802fc31f1db | 84 | |
donatien | 0:b802fc31f1db | 85 | /* Function prototypes for functions to be implemented by platform ports |
donatien | 0:b802fc31f1db | 86 | (in sys_arch.c) */ |
donatien | 0:b802fc31f1db | 87 | |
donatien | 0:b802fc31f1db | 88 | /* Mutex functions: */ |
donatien | 0:b802fc31f1db | 89 | |
donatien | 0:b802fc31f1db | 90 | /** Define LWIP_COMPAT_MUTEX if the port has no mutexes and binary semaphores |
donatien | 0:b802fc31f1db | 91 | should be used instead */ |
donatien | 0:b802fc31f1db | 92 | #if LWIP_COMPAT_MUTEX |
donatien | 0:b802fc31f1db | 93 | /* for old ports that don't have mutexes: define them to binary semaphores */ |
donatien | 0:b802fc31f1db | 94 | #define sys_mutex_t sys_sem_t |
donatien | 0:b802fc31f1db | 95 | #define sys_mutex_new(mutex) sys_sem_new(mutex, 1) |
donatien | 0:b802fc31f1db | 96 | #define sys_mutex_lock(mutex) sys_sem_wait(mutex) |
donatien | 0:b802fc31f1db | 97 | #define sys_mutex_unlock(mutex) sys_sem_signal(mutex) |
donatien | 0:b802fc31f1db | 98 | #define sys_mutex_free(mutex) sys_sem_free(mutex) |
donatien | 0:b802fc31f1db | 99 | #define sys_mutex_valid(mutex) sys_sem_valid(mutex) |
donatien | 0:b802fc31f1db | 100 | #define sys_mutex_set_invalid(mutex) sys_sem_set_invalid(mutex) |
donatien | 0:b802fc31f1db | 101 | |
donatien | 0:b802fc31f1db | 102 | #else /* LWIP_COMPAT_MUTEX */ |
donatien | 0:b802fc31f1db | 103 | |
donatien | 0:b802fc31f1db | 104 | /** Create a new mutex |
donatien | 0:b802fc31f1db | 105 | * @param mutex pointer to the mutex to create |
donatien | 0:b802fc31f1db | 106 | * @return a new mutex */ |
donatien | 0:b802fc31f1db | 107 | err_t sys_mutex_new(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 108 | /** Lock a mutex |
donatien | 0:b802fc31f1db | 109 | * @param mutex the mutex to lock */ |
donatien | 0:b802fc31f1db | 110 | void sys_mutex_lock(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 111 | /** Unlock a mutex |
donatien | 0:b802fc31f1db | 112 | * @param mutex the mutex to unlock */ |
donatien | 0:b802fc31f1db | 113 | void sys_mutex_unlock(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 114 | /** Delete a semaphore |
donatien | 0:b802fc31f1db | 115 | * @param mutex the mutex to delete */ |
donatien | 0:b802fc31f1db | 116 | void sys_mutex_free(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 117 | #ifndef sys_mutex_valid |
donatien | 0:b802fc31f1db | 118 | /** Check if a mutex is valid/allocated: return 1 for valid, 0 for invalid */ |
donatien | 0:b802fc31f1db | 119 | int sys_mutex_valid(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 120 | #endif |
donatien | 0:b802fc31f1db | 121 | #ifndef sys_mutex_set_invalid |
donatien | 0:b802fc31f1db | 122 | /** Set a mutex invalid so that sys_mutex_valid returns 0 */ |
donatien | 0:b802fc31f1db | 123 | void sys_mutex_set_invalid(sys_mutex_t *mutex); |
donatien | 0:b802fc31f1db | 124 | #endif |
donatien | 0:b802fc31f1db | 125 | #endif /* LWIP_COMPAT_MUTEX */ |
donatien | 0:b802fc31f1db | 126 | |
donatien | 0:b802fc31f1db | 127 | /* Semaphore functions: */ |
donatien | 0:b802fc31f1db | 128 | |
donatien | 0:b802fc31f1db | 129 | /** Create a new semaphore |
donatien | 0:b802fc31f1db | 130 | * @param sem pointer to the semaphore to create |
donatien | 0:b802fc31f1db | 131 | * @param count initial count of the semaphore |
donatien | 0:b802fc31f1db | 132 | * @return ERR_OK if successful, another err_t otherwise */ |
donatien | 0:b802fc31f1db | 133 | err_t sys_sem_new(sys_sem_t *sem, u8_t count); |
donatien | 0:b802fc31f1db | 134 | /** Signals a semaphore |
donatien | 0:b802fc31f1db | 135 | * @param sem the semaphore to signal */ |
donatien | 0:b802fc31f1db | 136 | void sys_sem_signal(sys_sem_t *sem); |
donatien | 0:b802fc31f1db | 137 | /** Wait for a semaphore for the specified timeout |
donatien | 0:b802fc31f1db | 138 | * @param sem the semaphore to wait for |
donatien | 0:b802fc31f1db | 139 | * @param timeout timeout in miliseconds to wait (0 = wait forever) |
donatien | 0:b802fc31f1db | 140 | * @return time (in miliseconds) waited for the semaphore |
donatien | 0:b802fc31f1db | 141 | * or SYS_ARCH_TIMEOUT on timeout */ |
donatien | 0:b802fc31f1db | 142 | u32_t sys_arch_sem_wait(sys_sem_t *sem, u32_t timeout); |
donatien | 0:b802fc31f1db | 143 | /** Delete a semaphore |
donatien | 0:b802fc31f1db | 144 | * @param sem semaphore to delete */ |
donatien | 0:b802fc31f1db | 145 | void sys_sem_free(sys_sem_t *sem); |
donatien | 0:b802fc31f1db | 146 | /** Wait for a semaphore - forever/no timeout */ |
donatien | 0:b802fc31f1db | 147 | #define sys_sem_wait(sem) sys_arch_sem_wait(sem, 0) |
donatien | 0:b802fc31f1db | 148 | #ifndef sys_sem_valid |
donatien | 0:b802fc31f1db | 149 | /** Check if a sempahore is valid/allocated: return 1 for valid, 0 for invalid */ |
donatien | 0:b802fc31f1db | 150 | int sys_sem_valid(sys_sem_t *sem); |
donatien | 0:b802fc31f1db | 151 | #endif |
donatien | 0:b802fc31f1db | 152 | #ifndef sys_sem_set_invalid |
donatien | 0:b802fc31f1db | 153 | /** Set a semaphore invalid so that sys_sem_valid returns 0 */ |
donatien | 0:b802fc31f1db | 154 | void sys_sem_set_invalid(sys_sem_t *sem); |
donatien | 0:b802fc31f1db | 155 | #endif |
donatien | 0:b802fc31f1db | 156 | |
donatien | 0:b802fc31f1db | 157 | /* Time functions. */ |
donatien | 0:b802fc31f1db | 158 | #ifndef sys_msleep |
donatien | 0:b802fc31f1db | 159 | void sys_msleep(u32_t ms); /* only has a (close to) 1 jiffy resolution. */ |
donatien | 0:b802fc31f1db | 160 | #endif |
donatien | 0:b802fc31f1db | 161 | |
donatien | 0:b802fc31f1db | 162 | /* Mailbox functions. */ |
donatien | 0:b802fc31f1db | 163 | |
donatien | 0:b802fc31f1db | 164 | /** Create a new mbox of specified size |
donatien | 0:b802fc31f1db | 165 | * @param mbox pointer to the mbox to create |
donatien | 0:b802fc31f1db | 166 | * @param size (miminum) number of messages in this mbox |
donatien | 0:b802fc31f1db | 167 | * @return ERR_OK if successful, another err_t otherwise */ |
donatien | 0:b802fc31f1db | 168 | err_t sys_mbox_new(sys_mbox_t *mbox, int size); |
donatien | 0:b802fc31f1db | 169 | /** Post a message to an mbox - may not fail |
donatien | 0:b802fc31f1db | 170 | * -> blocks if full, only used from tasks not from ISR |
donatien | 0:b802fc31f1db | 171 | * @param mbox mbox to posts the message |
donatien | 0:b802fc31f1db | 172 | * @param msg message to post (ATTENTION: can be NULL) */ |
donatien | 0:b802fc31f1db | 173 | void sys_mbox_post(sys_mbox_t *mbox, void *msg); |
donatien | 0:b802fc31f1db | 174 | /** Try to post a message to an mbox - may fail if full or ISR |
donatien | 0:b802fc31f1db | 175 | * @param mbox mbox to posts the message |
donatien | 0:b802fc31f1db | 176 | * @param msg message to post (ATTENTION: can be NULL) */ |
donatien | 0:b802fc31f1db | 177 | err_t sys_mbox_trypost(sys_mbox_t *mbox, void *msg); |
donatien | 0:b802fc31f1db | 178 | /** Wait for a new message to arrive in the mbox |
donatien | 0:b802fc31f1db | 179 | * @param mbox mbox to get a message from |
donatien | 0:b802fc31f1db | 180 | * @param msg pointer where the message is stored |
donatien | 0:b802fc31f1db | 181 | * @param timeout maximum time (in miliseconds) to wait for a message |
donatien | 0:b802fc31f1db | 182 | * @return time (in miliseconds) waited for a message, may be 0 if not waited |
donatien | 0:b802fc31f1db | 183 | or SYS_ARCH_TIMEOUT on timeout |
donatien | 0:b802fc31f1db | 184 | * The returned time has to be accurate to prevent timer jitter! */ |
donatien | 0:b802fc31f1db | 185 | u32_t sys_arch_mbox_fetch(sys_mbox_t *mbox, void **msg, u32_t timeout); |
donatien | 0:b802fc31f1db | 186 | /* Allow port to override with a macro, e.g. special timout for sys_arch_mbox_fetch() */ |
donatien | 0:b802fc31f1db | 187 | #ifndef sys_arch_mbox_tryfetch |
donatien | 0:b802fc31f1db | 188 | /** Wait for a new message to arrive in the mbox |
donatien | 0:b802fc31f1db | 189 | * @param mbox mbox to get a message from |
donatien | 0:b802fc31f1db | 190 | * @param msg pointer where the message is stored |
donatien | 0:b802fc31f1db | 191 | * @param timeout maximum time (in miliseconds) to wait for a message |
donatien | 0:b802fc31f1db | 192 | * @return 0 (miliseconds) if a message has been received |
donatien | 0:b802fc31f1db | 193 | * or SYS_MBOX_EMPTY if the mailbox is empty */ |
donatien | 0:b802fc31f1db | 194 | u32_t sys_arch_mbox_tryfetch(sys_mbox_t *mbox, void **msg); |
donatien | 0:b802fc31f1db | 195 | #endif |
donatien | 0:b802fc31f1db | 196 | /** For now, we map straight to sys_arch implementation. */ |
donatien | 0:b802fc31f1db | 197 | #define sys_mbox_tryfetch(mbox, msg) sys_arch_mbox_tryfetch(mbox, msg) |
donatien | 0:b802fc31f1db | 198 | /** Delete an mbox |
donatien | 0:b802fc31f1db | 199 | * @param mbox mbox to delete */ |
donatien | 0:b802fc31f1db | 200 | void sys_mbox_free(sys_mbox_t *mbox); |
donatien | 0:b802fc31f1db | 201 | #define sys_mbox_fetch(mbox, msg) sys_arch_mbox_fetch(mbox, msg, 0) |
donatien | 0:b802fc31f1db | 202 | #ifndef sys_mbox_valid |
donatien | 0:b802fc31f1db | 203 | /** Check if an mbox is valid/allocated: return 1 for valid, 0 for invalid */ |
donatien | 0:b802fc31f1db | 204 | int sys_mbox_valid(sys_mbox_t *mbox); |
donatien | 0:b802fc31f1db | 205 | #endif |
donatien | 0:b802fc31f1db | 206 | #ifndef sys_mbox_set_invalid |
donatien | 0:b802fc31f1db | 207 | /** Set an mbox invalid so that sys_mbox_valid returns 0 */ |
donatien | 0:b802fc31f1db | 208 | void sys_mbox_set_invalid(sys_mbox_t *mbox); |
donatien | 0:b802fc31f1db | 209 | #endif |
donatien | 0:b802fc31f1db | 210 | |
donatien | 0:b802fc31f1db | 211 | /** The only thread function: |
donatien | 0:b802fc31f1db | 212 | * Creates a new thread |
donatien | 0:b802fc31f1db | 213 | * @param name human-readable name for the thread (used for debugging purposes) |
donatien | 0:b802fc31f1db | 214 | * @param thread thread-function |
donatien | 0:b802fc31f1db | 215 | * @param arg parameter passed to 'thread' |
donatien | 0:b802fc31f1db | 216 | * @param stacksize stack size in bytes for the new thread (may be ignored by ports) |
donatien | 0:b802fc31f1db | 217 | * @param prio priority of the new thread (may be ignored by ports) */ |
donatien | 0:b802fc31f1db | 218 | sys_thread_t sys_thread_new(char *name, lwip_thread_fn thread, void *arg, int stacksize, int prio); |
donatien | 0:b802fc31f1db | 219 | |
donatien | 0:b802fc31f1db | 220 | #endif /* NO_SYS */ |
donatien | 0:b802fc31f1db | 221 | |
donatien | 0:b802fc31f1db | 222 | /* sys_init() must be called before anthing else. */ |
donatien | 0:b802fc31f1db | 223 | void sys_init(void); |
donatien | 0:b802fc31f1db | 224 | |
donatien | 0:b802fc31f1db | 225 | #ifndef sys_jiffies |
donatien | 0:b802fc31f1db | 226 | /** Ticks/jiffies since power up. */ |
donatien | 0:b802fc31f1db | 227 | u32_t sys_jiffies(void); |
donatien | 0:b802fc31f1db | 228 | #endif |
donatien | 0:b802fc31f1db | 229 | |
donatien | 0:b802fc31f1db | 230 | /** Returns the current time in milliseconds, |
donatien | 0:b802fc31f1db | 231 | * may be the same as sys_jiffies or at least based on it. */ |
donatien | 0:b802fc31f1db | 232 | u32_t sys_now(void); |
donatien | 0:b802fc31f1db | 233 | |
donatien | 0:b802fc31f1db | 234 | /* Critical Region Protection */ |
donatien | 0:b802fc31f1db | 235 | /* These functions must be implemented in the sys_arch.c file. |
donatien | 0:b802fc31f1db | 236 | In some implementations they can provide a more light-weight protection |
donatien | 0:b802fc31f1db | 237 | mechanism than using semaphores. Otherwise semaphores can be used for |
donatien | 0:b802fc31f1db | 238 | implementation */ |
donatien | 0:b802fc31f1db | 239 | #ifndef SYS_ARCH_PROTECT |
donatien | 0:b802fc31f1db | 240 | /** SYS_LIGHTWEIGHT_PROT |
donatien | 0:b802fc31f1db | 241 | * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection |
donatien | 0:b802fc31f1db | 242 | * for certain critical regions during buffer allocation, deallocation and memory |
donatien | 0:b802fc31f1db | 243 | * allocation and deallocation. |
donatien | 0:b802fc31f1db | 244 | */ |
donatien | 0:b802fc31f1db | 245 | #if SYS_LIGHTWEIGHT_PROT |
donatien | 0:b802fc31f1db | 246 | |
donatien | 0:b802fc31f1db | 247 | /** SYS_ARCH_DECL_PROTECT |
donatien | 0:b802fc31f1db | 248 | * declare a protection variable. This macro will default to defining a variable of |
donatien | 0:b802fc31f1db | 249 | * type sys_prot_t. If a particular port needs a different implementation, then |
donatien | 0:b802fc31f1db | 250 | * this macro may be defined in sys_arch.h. |
donatien | 0:b802fc31f1db | 251 | */ |
donatien | 0:b802fc31f1db | 252 | #define SYS_ARCH_DECL_PROTECT(lev) sys_prot_t lev |
donatien | 0:b802fc31f1db | 253 | /** SYS_ARCH_PROTECT |
donatien | 0:b802fc31f1db | 254 | * Perform a "fast" protect. This could be implemented by |
donatien | 0:b802fc31f1db | 255 | * disabling interrupts for an embedded system or by using a semaphore or |
donatien | 0:b802fc31f1db | 256 | * mutex. The implementation should allow calling SYS_ARCH_PROTECT when |
donatien | 0:b802fc31f1db | 257 | * already protected. The old protection level is returned in the variable |
donatien | 0:b802fc31f1db | 258 | * "lev". This macro will default to calling the sys_arch_protect() function |
donatien | 0:b802fc31f1db | 259 | * which should be implemented in sys_arch.c. If a particular port needs a |
donatien | 0:b802fc31f1db | 260 | * different implementation, then this macro may be defined in sys_arch.h |
donatien | 0:b802fc31f1db | 261 | */ |
donatien | 0:b802fc31f1db | 262 | #define SYS_ARCH_PROTECT(lev) lev = sys_arch_protect() |
donatien | 0:b802fc31f1db | 263 | /** SYS_ARCH_UNPROTECT |
donatien | 0:b802fc31f1db | 264 | * Perform a "fast" set of the protection level to "lev". This could be |
donatien | 0:b802fc31f1db | 265 | * implemented by setting the interrupt level to "lev" within the MACRO or by |
donatien | 0:b802fc31f1db | 266 | * using a semaphore or mutex. This macro will default to calling the |
donatien | 0:b802fc31f1db | 267 | * sys_arch_unprotect() function which should be implemented in |
donatien | 0:b802fc31f1db | 268 | * sys_arch.c. If a particular port needs a different implementation, then |
donatien | 0:b802fc31f1db | 269 | * this macro may be defined in sys_arch.h |
donatien | 0:b802fc31f1db | 270 | */ |
donatien | 0:b802fc31f1db | 271 | #define SYS_ARCH_UNPROTECT(lev) sys_arch_unprotect(lev) |
donatien | 0:b802fc31f1db | 272 | sys_prot_t sys_arch_protect(void); |
donatien | 0:b802fc31f1db | 273 | void sys_arch_unprotect(sys_prot_t pval); |
donatien | 0:b802fc31f1db | 274 | |
donatien | 0:b802fc31f1db | 275 | #else |
donatien | 0:b802fc31f1db | 276 | |
donatien | 0:b802fc31f1db | 277 | #define SYS_ARCH_DECL_PROTECT(lev) |
donatien | 0:b802fc31f1db | 278 | #define SYS_ARCH_PROTECT(lev) |
donatien | 0:b802fc31f1db | 279 | #define SYS_ARCH_UNPROTECT(lev) |
donatien | 0:b802fc31f1db | 280 | |
donatien | 0:b802fc31f1db | 281 | #endif /* SYS_LIGHTWEIGHT_PROT */ |
donatien | 0:b802fc31f1db | 282 | |
donatien | 0:b802fc31f1db | 283 | #endif /* SYS_ARCH_PROTECT */ |
donatien | 0:b802fc31f1db | 284 | |
donatien | 0:b802fc31f1db | 285 | /* |
donatien | 0:b802fc31f1db | 286 | * Macros to set/get and increase/decrease variables in a thread-safe way. |
donatien | 0:b802fc31f1db | 287 | * Use these for accessing variable that are used from more than one thread. |
donatien | 0:b802fc31f1db | 288 | */ |
donatien | 0:b802fc31f1db | 289 | |
donatien | 0:b802fc31f1db | 290 | #ifndef SYS_ARCH_INC |
donatien | 0:b802fc31f1db | 291 | #define SYS_ARCH_INC(var, val) do { \ |
donatien | 0:b802fc31f1db | 292 | SYS_ARCH_DECL_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 293 | SYS_ARCH_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 294 | var += val; \ |
donatien | 0:b802fc31f1db | 295 | SYS_ARCH_UNPROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 296 | } while(0) |
donatien | 0:b802fc31f1db | 297 | #endif /* SYS_ARCH_INC */ |
donatien | 0:b802fc31f1db | 298 | |
donatien | 0:b802fc31f1db | 299 | #ifndef SYS_ARCH_DEC |
donatien | 0:b802fc31f1db | 300 | #define SYS_ARCH_DEC(var, val) do { \ |
donatien | 0:b802fc31f1db | 301 | SYS_ARCH_DECL_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 302 | SYS_ARCH_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 303 | var -= val; \ |
donatien | 0:b802fc31f1db | 304 | SYS_ARCH_UNPROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 305 | } while(0) |
donatien | 0:b802fc31f1db | 306 | #endif /* SYS_ARCH_DEC */ |
donatien | 0:b802fc31f1db | 307 | |
donatien | 0:b802fc31f1db | 308 | #ifndef SYS_ARCH_GET |
donatien | 0:b802fc31f1db | 309 | #define SYS_ARCH_GET(var, ret) do { \ |
donatien | 0:b802fc31f1db | 310 | SYS_ARCH_DECL_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 311 | SYS_ARCH_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 312 | ret = var; \ |
donatien | 0:b802fc31f1db | 313 | SYS_ARCH_UNPROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 314 | } while(0) |
donatien | 0:b802fc31f1db | 315 | #endif /* SYS_ARCH_GET */ |
donatien | 0:b802fc31f1db | 316 | |
donatien | 0:b802fc31f1db | 317 | #ifndef SYS_ARCH_SET |
donatien | 0:b802fc31f1db | 318 | #define SYS_ARCH_SET(var, val) do { \ |
donatien | 0:b802fc31f1db | 319 | SYS_ARCH_DECL_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 320 | SYS_ARCH_PROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 321 | var = val; \ |
donatien | 0:b802fc31f1db | 322 | SYS_ARCH_UNPROTECT(old_level); \ |
donatien | 0:b802fc31f1db | 323 | } while(0) |
donatien | 0:b802fc31f1db | 324 | #endif /* SYS_ARCH_SET */ |
donatien | 0:b802fc31f1db | 325 | |
donatien | 0:b802fc31f1db | 326 | |
donatien | 0:b802fc31f1db | 327 | #ifdef __cplusplus |
donatien | 0:b802fc31f1db | 328 | } |
donatien | 0:b802fc31f1db | 329 | #endif |
donatien | 0:b802fc31f1db | 330 | |
donatien | 0:b802fc31f1db | 331 | #endif /* __LWIP_SYS_H__ */ |