Atmel Software Framework

lwip-1.4.0/src/include/lwip/sys.h File Reference
#include "lwip/opt.h"
#include "lwip/err.h"
#include "arch/sys_arch.h"

Macros

#define SYS_ARCH_DEC(var, val)
 
#define SYS_ARCH_DECL_PROTECT(lev)
 SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for certain critical regions during buffer allocation, deallocation and memory allocation and deallocation. More...
 
#define SYS_ARCH_GET(var, ret)
 
#define SYS_ARCH_INC(var, val)
 
#define SYS_ARCH_PROTECT(lev)
 
#define SYS_ARCH_SET(var, val)
 
#define SYS_ARCH_TIMEOUT   0xffffffffUL
 Return code for timeouts from sys_arch_mbox_fetch and sys_arch_sem_wait. More...
 
#define SYS_ARCH_UNPROTECT(lev)
 
#define SYS_MBOX_EMPTY   SYS_ARCH_TIMEOUT
 sys_mbox_tryfetch() returns SYS_MBOX_EMPTY if appropriate. More...
 
#define sys_mbox_fetch(mbox, msg)   sys_arch_mbox_fetch(mbox, msg, 0)
 
#define sys_mbox_tryfetch(mbox, msg)   sys_arch_mbox_tryfetch(mbox, msg)
 For now, we map straight to sys_arch implementation. More...
 
#define sys_sem_wait(sem)   sys_arch_sem_wait(sem, 0)
 Wait for a semaphore - forever/no timeout. More...
 

Typedefs

typedef void(* lwip_thread_fn )(void *arg)
 Function prototype for thread functions. More...
 

Functions

u32_t sys_arch_mbox_fetch (sys_mbox_t *mbox, void **msg, u32_t timeout)
 Wait for a new message to arrive in the mbox. More...
 
u32_t sys_arch_mbox_tryfetch (sys_mbox_t *mbox, void **msg)
 Wait for a new message to arrive in the mbox. More...
 
u32_t sys_arch_sem_wait (sys_sem_t *sem, u32_t timeout)
 Wait for a semaphore for the specified timeout. More...
 
void sys_init (void)
 
u32_t sys_jiffies (void)
 Ticks/jiffies since power up. More...
 
void sys_mbox_free (sys_mbox_t *mbox)
 Delete an mbox. More...
 
err_t sys_mbox_new (sys_mbox_t *mbox, int size)
 Create a new mbox of specified size. More...
 
void sys_mbox_post (sys_mbox_t *mbox, void *msg)
 Post a message to an mbox - may not fail -> blocks if full, only used from tasks not from ISR. More...
 
void sys_mbox_set_invalid (sys_mbox_t *mbox)
 Set an mbox invalid so that sys_mbox_valid returns 0. More...
 
err_t sys_mbox_trypost (sys_mbox_t *mbox, void *msg)
 Try to post a message to an mbox - may fail if full or ISR. More...
 
int sys_mbox_valid (sys_mbox_t *mbox)
 Check if an mbox is valid/allocated: return 1 for valid, 0 for invalid. More...
 
void sys_msleep (u32_t ms)
 Sleep for some ms. More...
 
void sys_mutex_free (sys_mutex_t *mutex)
 Delete a semaphore. More...
 
void sys_mutex_lock (sys_mutex_t *mutex)
 Lock a mutex. More...
 
err_t sys_mutex_new (sys_mutex_t *mutex)
 Define LWIP_COMPAT_MUTEX if the port has no mutexes and binary semaphores should be used instead. More...
 
void sys_mutex_set_invalid (sys_mutex_t *mutex)
 Set a mutex invalid so that sys_mutex_valid returns 0. More...
 
void sys_mutex_unlock (sys_mutex_t *mutex)
 Unlock a mutex. More...
 
int sys_mutex_valid (sys_mutex_t *mutex)
 Check if a mutex is valid/allocated: return 1 for valid, 0 for invalid. More...
 
u32_t sys_now (void)
 Returns the current time in milliseconds, may be the same as sys_jiffies or at least based on it. More...
 
void sys_sem_free (sys_sem_t *sem)
 Delete a semaphore. More...
 
err_t sys_sem_new (sys_sem_t *sem, u8_t count)
 Create a new semaphore. More...
 
void sys_sem_set_invalid (sys_sem_t *sem)
 Set a semaphore invalid so that sys_sem_valid returns 0. More...
 
void sys_sem_signal (sys_sem_t *sem)
 Signals a semaphore. More...
 
int sys_sem_valid (sys_sem_t *sem)
 Check if a sempahore is valid/allocated: return 1 for valid, 0 for invalid. More...
 
sys_thread_t sys_thread_new (const char *name, lwip_thread_fn thread, void *arg, int stacksize, int prio)
 The only thread function: Creates a new thread. More...
 

#define SYS_ARCH_DEC (   var,
  val 
)
Value:
do { \
SYS_ARCH_PROTECT(old_level); \
var -= val; \
SYS_ARCH_UNPROTECT(old_level); \
} while(0)
#define SYS_ARCH_DECL_PROTECT(lev)
SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for ...
Definition: lwip-1.4.0/src/include/lwip/sys.h:277
#define SYS_ARCH_PROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:278
#define SYS_ARCH_UNPROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:279
int val
Definition: jpeglib.h:957
#define SYS_ARCH_DECL_PROTECT (   lev)

SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for certain critical regions during buffer allocation, deallocation and memory allocation and deallocation.

Referenced by mem_free(), mem_realloc(), mem_trim(), memp_free(), pbuf_free(), pbuf_ref(), and sys_thread_new().

#define SYS_ARCH_GET (   var,
  ret 
)
Value:
do { \
SYS_ARCH_PROTECT(old_level); \
ret = var; \
SYS_ARCH_UNPROTECT(old_level); \
} while(0)
#define SYS_ARCH_DECL_PROTECT(lev)
SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for ...
Definition: lwip-1.4.0/src/include/lwip/sys.h:277
#define SYS_ARCH_PROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:278
#define SYS_ARCH_UNPROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:279
#define SYS_ARCH_INC (   var,
  val 
)
Value:
do { \
SYS_ARCH_PROTECT(old_level); \
var += val; \
SYS_ARCH_UNPROTECT(old_level); \
} while(0)
#define SYS_ARCH_DECL_PROTECT(lev)
SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for ...
Definition: lwip-1.4.0/src/include/lwip/sys.h:277
#define SYS_ARCH_PROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:278
#define SYS_ARCH_UNPROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:279
int val
Definition: jpeglib.h:957
#define SYS_ARCH_PROTECT (   lev)
#define SYS_ARCH_SET (   var,
  val 
)
Value:
do { \
SYS_ARCH_PROTECT(old_level); \
var = val; \
SYS_ARCH_UNPROTECT(old_level); \
} while(0)
#define SYS_ARCH_DECL_PROTECT(lev)
SYS_LIGHTWEIGHT_PROT define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection for ...
Definition: lwip-1.4.0/src/include/lwip/sys.h:277
#define SYS_ARCH_PROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:278
#define SYS_ARCH_UNPROTECT(lev)
Definition: lwip-1.4.0/src/include/lwip/sys.h:279
int val
Definition: jpeglib.h:957
#define SYS_ARCH_TIMEOUT   0xffffffffUL

Return code for timeouts from sys_arch_mbox_fetch and sys_arch_sem_wait.

Referenced by sys_arch_mbox_fetch(), sys_arch_sem_wait(), sys_mbox_fetch(), and sys_sem_wait().

#define SYS_ARCH_UNPROTECT (   lev)
#define SYS_MBOX_EMPTY   SYS_ARCH_TIMEOUT

sys_mbox_tryfetch() returns SYS_MBOX_EMPTY if appropriate.

For now we use the same magic value, but we allow this to change in future.

Referenced by sys_arch_mbox_tryfetch().

#define sys_mbox_fetch (   mbox,
  msg 
)    sys_arch_mbox_fetch(mbox, msg, 0)

Referenced by tcpip_thread().

#define sys_mbox_tryfetch (   mbox,
  msg 
)    sys_arch_mbox_tryfetch(mbox, msg)

For now, we map straight to sys_arch implementation.

#define sys_sem_wait (   sem)    sys_arch_sem_wait(sem, 0)

Wait for a semaphore - forever/no timeout.

Referenced by prvlwIPInit(), and sys_sem_wait_timeout().

typedef void(* lwip_thread_fn)(void *arg)

Function prototype for thread functions.

u32_t sys_arch_mbox_fetch ( sys_mbox_t mbox,
void **  msg,
u32_t  timeout 
)

Wait for a new message to arrive in the mbox.

Parameters
mboxmbox to get a message from
msgpointer where the message is stored
timeoutmaximum time (in milliseconds) to wait for a message
Returns
time (in milliseconds) waited for a message, may be 0 if not waited or SYS_ARCH_TIMEOUT on timeout The returned time has to be accurate to prevent timer jitter!
u32_t sys_arch_mbox_tryfetch ( sys_mbox_t mbox,
void **  msg 
)

Wait for a new message to arrive in the mbox.

Parameters
mboxmbox to get a message from
msgpointer where the message is stored
timeoutmaximum time (in milliseconds) to wait for a message
Returns
0 (milliseconds) if a message has been received or SYS_MBOX_EMPTY if the mailbox is empty
u32_t sys_arch_sem_wait ( sys_sem_t sem,
u32_t  timeout 
)

Wait for a semaphore for the specified timeout.

Parameters
semthe semaphore to wait for
timeouttimeout in milliseconds to wait (0 = wait forever)
Returns
time (in milliseconds) waited for the semaphore or SYS_ARCH_TIMEOUT on timeout
void sys_init ( void  )
u32_t sys_jiffies ( void  )

Ticks/jiffies since power up.

void sys_mbox_free ( sys_mbox_t mbox)

Delete an mbox.

Parameters
mboxmbox to delete
err_t sys_mbox_new ( sys_mbox_t mbox,
int  size 
)

Create a new mbox of specified size.

Parameters
mboxpointer to the mbox to create
size(miminum) number of messages in this mbox
Returns
ERR_OK if successful, another err_t otherwise
void sys_mbox_post ( sys_mbox_t mbox,
void *  msg 
)

Post a message to an mbox - may not fail -> blocks if full, only used from tasks not from ISR.

Parameters
mboxmbox to posts the message
msgmessage to post (ATTENTION: can be NULL)
void sys_mbox_set_invalid ( sys_mbox_t mbox)

Set an mbox invalid so that sys_mbox_valid returns 0.

err_t sys_mbox_trypost ( sys_mbox_t mbox,
void *  msg 
)

Try to post a message to an mbox - may fail if full or ISR.

Parameters
mboxmbox to posts the message
msgmessage to post (ATTENTION: can be NULL)
int sys_mbox_valid ( sys_mbox_t mbox)

Check if an mbox is valid/allocated: return 1 for valid, 0 for invalid.

void sys_msleep ( u32_t  ms)

Sleep for some ms.

Timeouts are NOT processed while sleeping.

Parameters
msnumber of milliseconds to sleep

Timeouts are processed while sleeping.

Parameters
msnumber of milliseconds to sleep
void sys_mutex_free ( sys_mutex_t mutex)

Delete a semaphore.

Parameters
mutexthe mutex to delete
void sys_mutex_lock ( sys_mutex_t mutex)

Lock a mutex.

Parameters
mutexthe mutex to lock
err_t sys_mutex_new ( sys_mutex_t mutex)

Define LWIP_COMPAT_MUTEX if the port has no mutexes and binary semaphores should be used instead.

Create a new mutex

Parameters
mutexpointer to the mutex to create
Returns
a new mutex
void sys_mutex_set_invalid ( sys_mutex_t mutex)

Set a mutex invalid so that sys_mutex_valid returns 0.

void sys_mutex_unlock ( sys_mutex_t mutex)

Unlock a mutex.

Parameters
mutexthe mutex to unlock
int sys_mutex_valid ( sys_mutex_t mutex)

Check if a mutex is valid/allocated: return 1 for valid, 0 for invalid.

u32_t sys_now ( void  )

Returns the current time in milliseconds, may be the same as sys_jiffies or at least based on it.

void sys_sem_free ( sys_sem_t sem)

Delete a semaphore.

Parameters
semsemaphore to delete
err_t sys_sem_new ( sys_sem_t sem,
u8_t  count 
)

Create a new semaphore.

Parameters
sempointer to the semaphore to create
countinitial count of the semaphore
Returns
ERR_OK if successful, another err_t otherwise
void sys_sem_set_invalid ( sys_sem_t sem)

Set a semaphore invalid so that sys_sem_valid returns 0.

void sys_sem_signal ( sys_sem_t sem)

Signals a semaphore.

Parameters
semthe semaphore to signal
int sys_sem_valid ( sys_sem_t sem)

Check if a sempahore is valid/allocated: return 1 for valid, 0 for invalid.

sys_thread_t sys_thread_new ( const char *  name,
lwip_thread_fn  thread,
void *  arg,
int  stacksize,
int  prio 
)

The only thread function: Creates a new thread.

Parameters
namehuman-readable name for the thread (used for debugging purposes)
threadthread-function
argparameter passed to 'thread'
stacksizestack size in bytes for the new thread (may be ignored by ports)
priopriority of the new thread (may be ignored by ports)