FreeRTOS

[armadillo_firmware.git] / FreeRTOS / Common / ethernet / lwIP_130 / doc / sys_arch.txt

sys_arch interface for lwIP 0.6++\r
\r
Author: Adam Dunkels\r
\r
The operating system emulation layer provides a common interface\r
between the lwIP code and the underlying operating system kernel. The\r
general idea is that porting lwIP to new architectures requires only\r
small changes to a few header files and a new sys_arch\r
implementation. It is also possible to do a sys_arch implementation\r
that does not rely on any underlying operating system.\r
\r
The sys_arch provides semaphores and mailboxes to lwIP. For the full\r
lwIP functionality, multiple threads support can be implemented in the\r
sys_arch, but this is not required for the basic lwIP\r
functionality. Previous versions of lwIP required the sys_arch to\r
implement timer scheduling as well but as of lwIP 0.5 this is\r
implemented in a higher layer.\r
\r
In addition to the source file providing the functionality of sys_arch,\r
the OS emulation layer must provide several header files defining\r
macros used throughout lwip.  The files required and the macros they\r
must define are listed below the sys_arch description.\r
\r
Semaphores can be either counting or binary - lwIP works with both\r
kinds. Mailboxes are used for message passing and can be implemented\r
either as a queue which allows multiple messages to be posted to a\r
mailbox, or as a rendez-vous point where only one message can be\r
posted at a time. lwIP works with both kinds, but the former type will\r
be more efficient. A message in a mailbox is just a pointer, nothing\r
more. \r
\r
Semaphores are represented by the type "sys_sem_t" which is typedef'd\r
in the sys_arch.h file. Mailboxes are equivalently represented by the\r
type "sys_mbox_t". lwIP does not place any restrictions on how\r
sys_sem_t or sys_mbox_t are represented internally.\r
\r
The following functions must be implemented by the sys_arch:\r
\r
- void sys_init(void)\r
\r
  Is called to initialize the sys_arch layer.\r
\r
- sys_sem_t sys_sem_new(u8_t count)\r
\r
  Creates and returns a new semaphore. The "count" argument specifies\r
  the initial state of the semaphore.\r
\r
- void sys_sem_free(sys_sem_t sem)\r
\r
  Deallocates a semaphore.\r
\r
- void sys_sem_signal(sys_sem_t sem)\r
\r
  Signals a semaphore.\r
\r
- u32_t sys_arch_sem_wait(sys_sem_t sem, u32_t timeout)\r
\r
  Blocks the thread while waiting for the semaphore to be\r
  signaled. If the "timeout" argument is non-zero, the thread should\r
  only be blocked for the specified time (measured in\r
  milliseconds). If the "timeout" argument is zero, the thread should be\r
  blocked until the semaphore is signalled.\r
\r
  If the timeout argument is non-zero, the return value is the number of\r
  milliseconds spent waiting for the semaphore to be signaled. If the\r
  semaphore wasn't signaled within the specified time, the return value is\r
  SYS_ARCH_TIMEOUT. If the thread didn't have to wait for the semaphore\r
  (i.e., it was already signaled), the function may return zero.\r
\r
  Notice that lwIP implements a function with a similar name,\r
  sys_sem_wait(), that uses the sys_arch_sem_wait() function.\r
\r
- sys_mbox_t sys_mbox_new(int size)\r
\r
  Creates an empty mailbox for maximum "size" elements. Elements stored\r
  in mailboxes are pointers. You have to define macros "_MBOX_SIZE"\r
  in your lwipopts.h, or ignore this parameter in your implementation\r
  and use a default size.\r
\r
- void sys_mbox_free(sys_mbox_t mbox)\r
\r
  Deallocates a mailbox. If there are messages still present in the\r
  mailbox when the mailbox is deallocated, it is an indication of a\r
  programming error in lwIP and the developer should be notified.\r
\r
- void sys_mbox_post(sys_mbox_t mbox, void *msg)\r
\r
  Posts the "msg" to the mailbox. This function have to block until\r
  the "msg" is really posted.\r
\r
- err_t sys_mbox_trypost(sys_mbox_t mbox, void *msg)\r
\r
  Try to post the "msg" to the mailbox. Returns ERR_MEM if this one\r
  is full, else, ERR_OK if the "msg" is posted.\r
\r
- u32_t sys_arch_mbox_fetch(sys_mbox_t mbox, void **msg, u32_t timeout)\r
\r
  Blocks the thread until a message arrives in the mailbox, but does\r
  not block the thread longer than "timeout" milliseconds (similar to\r
  the sys_arch_sem_wait() function). If "timeout" is 0, the thread should\r
  be blocked until a message arrives. The "msg" argument is a result\r
  parameter that is set by the function (i.e., by doing "*msg =\r
  ptr"). The "msg" parameter maybe NULL to indicate that the message\r
  should be dropped.\r
\r
  The return values are the same as for the sys_arch_sem_wait() function:\r
  Number of milliseconds spent waiting or SYS_ARCH_TIMEOUT if there was a\r
  timeout.\r
\r
  Note that a function with a similar name, sys_mbox_fetch(), is\r
  implemented by lwIP. \r
\r
- u32_t sys_arch_mbox_tryfetch(sys_mbox_t mbox, void **msg)\r
\r
  This is similar to sys_arch_mbox_fetch, however if a message is not\r
  present in the mailbox, it immediately returns with the code\r
  SYS_MBOX_EMPTY. On success 0 is returned.\r
\r
  To allow for efficient implementations, this can be defined as a\r
  function-like macro in sys_arch.h instead of a normal function. For\r
  example, a naive implementation could be:\r
    #define sys_arch_mbox_tryfetch(mbox,msg) \\r
      sys_arch_mbox_fetch(mbox,msg,1)\r
  although this would introduce unnecessary delays.\r
  \r
- struct sys_timeouts *sys_arch_timeouts(void)\r
\r
  Returns a pointer to the per-thread sys_timeouts structure. In lwIP,\r
  each thread has a list of timeouts which is repressented as a linked\r
  list of sys_timeout structures. The sys_timeouts structure holds a\r
  pointer to a linked list of timeouts. This function is called by\r
  the lwIP timeout scheduler and must not return a NULL value. \r
\r
  In a single thread sys_arch implementation, this function will\r
  simply return a pointer to a global sys_timeouts variable stored in\r
  the sys_arch module.\r
  \r
If threads are supported by the underlying operating system and if\r
such functionality is needed in lwIP, the following function will have\r
to be implemented as well:\r
\r
- sys_thread_t sys_thread_new(char *name, void (* thread)(void *arg), void *arg, int stacksize, int prio)\r
\r
  Starts a new thread named "name" with priority "prio" that will begin its\r
  execution in the function "thread()". The "arg" argument will be passed as an\r
  argument to the thread() function. The stack size to used for this thread is\r
  the "stacksize" parameter. The id of the new thread is returned. Both the id\r
  and the priority are system dependent.\r
\r
- sys_prot_t sys_arch_protect(void)\r
\r
  This optional function does a "fast" critical region protection and returns\r
  the previous protection level. This function is only called during very short\r
  critical regions. An embedded system which supports ISR-based drivers might\r
  want to implement this function by disabling interrupts. Task-based systems\r
  might want to implement this by using a mutex or disabling tasking. This\r
  function should support recursive calls from the same task or interrupt. In\r
  other words, sys_arch_protect() could be called while already protected. In\r
  that case the return value indicates that it is already protected.\r
\r
  sys_arch_protect() is only required if your port is supporting an operating\r
  system.\r
\r
- void sys_arch_unprotect(sys_prot_t pval)\r
\r
  This optional function does a "fast" set of critical region protection to the\r
  value specified by pval. See the documentation for sys_arch_protect() for\r
  more information. This function is only required if your port is supporting\r
  an operating system.\r
\r
Note:\r
\r
Be carefull with using mem_malloc() in sys_arch. When malloc() refers to\r
mem_malloc() you can run into a circular function call problem. In mem.c\r
mem_init() tries to allcate a semaphore using mem_malloc, which of course\r
can't be performed when sys_arch uses mem_malloc.\r
\r
-------------------------------------------------------------------------------\r
Additional files required for the "OS support" emulation layer:\r
-------------------------------------------------------------------------------\r
\r
cc.h       - Architecture environment, some compiler specific, some\r
             environment specific (probably should move env stuff \r
             to sys_arch.h.)\r
\r
  Typedefs for the types used by lwip -\r
    u8_t, s8_t, u16_t, s16_t, u32_t, s32_t, mem_ptr_t\r
\r
  Compiler hints for packing lwip's structures -\r
    PACK_STRUCT_FIELD(x)\r
    PACK_STRUCT_STRUCT\r
    PACK_STRUCT_BEGIN\r
    PACK_STRUCT_END\r
\r
  Platform specific diagnostic output -\r
    LWIP_PLATFORM_DIAG(x)    - non-fatal, print a message.\r
    LWIP_PLATFORM_ASSERT(x)  - fatal, print message and abandon execution.\r
\r
  "lightweight" synchronization mechanisms -\r
    SYS_ARCH_DECL_PROTECT(x) - declare a protection state variable.\r
    SYS_ARCH_PROTECT(x)      - enter protection mode.\r
    SYS_ARCH_UNPROTECT(x)    - leave protection mode.\r
\r
  If the compiler does not provide memset() this file must include a\r
  definition of it, or include a file which defines it.\r
\r
  This file must either include a system-local <errno.h> which defines\r
  the standard *nix error codes, or it should #define LWIP_PROVIDE_ERRNO\r
  to make lwip/arch.h define the codes which are used throughout.\r
\r
\r
perf.h     - Architecture specific performance measurement.\r
  Measurement calls made throughout lwip, these can be defined to nothing.\r
    PERF_START               - start measuring something.\r
    PERF_STOP(x)             - stop measuring something, and record the result.\r
\r
sys_arch.h - Tied to sys_arch.c\r
\r
  Arch dependent types for the following objects:\r
    sys_sem_t, sys_mbox_t, sys_thread_t,\r
  And, optionally:\r
    sys_prot_t\r
\r
  Defines to set vars of sys_mbox_t and sys_sem_t to NULL.\r
    SYS_MBOX_NULL NULL\r
    SYS_SEM_NULL NULL\r