summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDirk Ziegelmeier <[email protected]>2017-10-17 22:38:18 +0200
committerDirk Ziegelmeier <[email protected]>2017-10-17 22:38:18 +0200
commit8a46a853d2ab2c470c76962d3f1cbe9362e30fa1 (patch)
treecc72e72eebb1d43c23da6369069bf0ed4902ea0f /doc
parent26b2628f01e6320d8622e8300a9f13a33a6a16fd (diff)
Improve system abstraction layer doxygen docs by moving documentation from sys_arch.txt to sys.c
Diffstat (limited to 'doc')
-rw-r--r--doc/sys_arch.txt14
1 files changed, 2 insertions, 12 deletions
diff --git a/doc/sys_arch.txt b/doc/sys_arch.txt
index 903b2e9f..39f2ea3c 100644
--- a/doc/sys_arch.txt
+++ b/doc/sys_arch.txt
@@ -21,24 +21,14 @@ the OS emulation layer must provide several header files defining
macros used throughout lwip. The files required and the macros they
must define are listed below the sys_arch description.
-Semaphores can be either counting or binary - lwIP works with both
-kinds. Mailboxes should be implemented as a queue which allows multiple messages
-to be posted (implementing as a rendez-vous point where only one message can be
-posted at a time can have a highly negative impact on performance). A message
-in a mailbox is just a pointer, nothing more.
-
-Semaphores are represented by the type "sys_sem_t" which is typedef'd
-in the sys_arch.h file. Mailboxes are equivalently represented by the
-type "sys_mbox_t". Mutexes are represented by the type "sys_mutex_t".
-lwIP does not place any restrictions on how these types are represented
-internally.
-
Since lwIP 1.4.0, semaphore, mutexes and mailbox functions are prototyped in a way that
allows both using pointers or actual OS structures to be used. This way, memory
required for such types can be either allocated in place (globally or on the
stack) or on the heap (allocated internally in the "*_new()" functions).
+-------------------------------------------------------------------------------
Note:
+-------------------------------------------------------------------------------
Be careful with using mem_malloc() in sys_arch. When malloc() refers to
mem_malloc() you can run into a circular function call problem. In mem.c