hiroshi matsumoto / EthernetNetIf

lpc1768

lwip/include/lwip/sys.h@0:f35dada1dac1, 2015-01-27 (annotated)

Committer:
jh1cdv00
Date:
Tue Jan 27 01:38:19 2015 +0000
Revision:
0:f35dada1dac1
lpc1768

Who changed what in which revision?

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