You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/06/23 21:19:00 UTC
[5/9] incubator-mynewt-site git commit: Added os_mutex_init and
os_mutex_pend pages correctly. Pushed core OS function descriptor tables in
pull request #95 by bgiori
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/callout/callout/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/callout/callout/index.html b/latest/os/core_os/callout/callout/index.html
index fb3a0d8..29c2af1 100644
--- a/latest/os/core_os/callout/callout/index.html
+++ b/latest/os/core_os/callout/callout/index.html
@@ -704,13 +704,36 @@
</table>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in callout are:</p>
-<ul>
-<li><a href="../os_callout_func_init">os_callout_func_init</a></li>
-<li><a href="../os_callout_init">os_callout_init</a></li>
-<li><a href="../os_callout_queued">os_callout_queued</a></li>
-<li><a href="../os_callout_reset">os_callout_reset</a></li>
-<li><a href="../os_callout_stop">os_callout_stop</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_callout_func_init">os_callout_func_init</a></td>
+<td>Initializes the given callout function struct.</td>
+</tr>
+<tr>
+<td><a href="../os_callout_init">os_callout_init</a></td>
+<td>Initializes the given callout struct.</td>
+</tr>
+<tr>
+<td><a href="../os_callout_queued">os_callout_queued</a></td>
+<td>Checks whether the given callout has been armed.</td>
+</tr>
+<tr>
+<td><a href="../os_callout_reset">os_callout_reset</a></td>
+<td>Resets the callout to happen in the given number of OS ticks.</td>
+</tr>
+<tr>
+<td><a href="../os_callout_stop">os_callout_stop</a></td>
+<td>Disarms a timer.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_arch_ctx_sw/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_arch_ctx_sw/index.html b/latest/os/core_os/context_switch/os_arch_ctx_sw/index.html
index b216c1f..9bb2cdf 100644
--- a/latest/os/core_os/context_switch/os_arch_ctx_sw/index.html
+++ b/latest/os/core_os/context_switch/os_arch_ctx_sw/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched/index.html b/latest/os/core_os/context_switch/os_sched/index.html
index 67e7213..4c1f562 100644
--- a/latest/os/core_os/context_switch/os_sched/index.html
+++ b/latest/os/core_os/context_switch/os_sched/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html b/latest/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html
index d9eaf4b..f3a88d0 100644
--- a/latest/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html
+++ b/latest/os/core_os/context_switch/os_sched_ctx_sw_hook/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
@@ -761,7 +761,7 @@
<li class="pull-right">
<a href=../os_sched_get_current_task/>
- Next: os_/sched_get_current_task
+ Next: os_sched_get_current_task
<span class="fa fa-arrow-right"></span>
</a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_get_current_task/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_get_current_task/index.html b/latest/os/core_os/context_switch/os_sched_get_current_task/index.html
index c207e86..b1d5ff6 100644
--- a/latest/os/core_os/context_switch/os_sched_get_current_task/index.html
+++ b/latest/os/core_os/context_switch/os_sched_get_current_task/index.html
@@ -9,7 +9,7 @@
<link rel="canonical" href="http://mynewt.apache.org/os/core_os/context_switch/os_sched_get_current_task/">
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>os_/sched_get_current_task - Apache Mynewt</title>
+ <title>os_sched_get_current_task - Apache Mynewt</title>
<link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
<link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -41,7 +41,7 @@
</head>
- <body class="os_/sched_get_current_task">
+ <body class="os_sched_get_current_task">
@@ -288,7 +288,7 @@
<li class="active">
- <a href="./">os_/sched_get_current_task</a>
+ <a href="./">os_sched_get_current_task</a>
</li>
@@ -711,7 +711,7 @@
- <li>» os_/sched_get_current_task</li>
+ <li>» os_sched_get_current_task</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_insert/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_insert/index.html b/latest/os/core_os/context_switch/os_sched_insert/index.html
index 7e13e16..2bc7b15 100644
--- a/latest/os/core_os/context_switch/os_sched_insert/index.html
+++ b/latest/os/core_os/context_switch/os_sched_insert/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
@@ -758,7 +758,7 @@ Returns 0 on success.</p>
<a href=../os_sched_get_current_task/>
<span class="fa fa-arrow-left"></span>
- Previous: os_/sched_get_current_task
+ Previous: os_sched_get_current_task
</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_next_task/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_next_task/index.html b/latest/os/core_os/context_switch/os_sched_next_task/index.html
index e4879ac..ea75a94 100644
--- a/latest/os/core_os/context_switch/os_sched_next_task/index.html
+++ b/latest/os/core_os/context_switch/os_sched_next_task/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_os_timer_exp/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_os_timer_exp/index.html b/latest/os/core_os/context_switch/os_sched_os_timer_exp/index.html
index ce71c40..c746ad4 100644
--- a/latest/os/core_os/context_switch/os_sched_os_timer_exp/index.html
+++ b/latest/os/core_os/context_switch/os_sched_os_timer_exp/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_resort/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_resort/index.html b/latest/os/core_os/context_switch/os_sched_resort/index.html
index 3d53f33..1462b2f 100644
--- a/latest/os/core_os/context_switch/os_sched_resort/index.html
+++ b/latest/os/core_os/context_switch/os_sched_resort/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_set_current_task/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_set_current_task/index.html b/latest/os/core_os/context_switch/os_sched_set_current_task/index.html
index 2afb3b7..7da4015 100644
--- a/latest/os/core_os/context_switch/os_sched_set_current_task/index.html
+++ b/latest/os/core_os/context_switch/os_sched_set_current_task/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_sleep/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_sleep/index.html b/latest/os/core_os/context_switch/os_sched_sleep/index.html
index 97978f6..0e12c72 100644
--- a/latest/os/core_os/context_switch/os_sched_sleep/index.html
+++ b/latest/os/core_os/context_switch/os_sched_sleep/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/context_switch/os_sched_wakeup/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/context_switch/os_sched_wakeup/index.html b/latest/os/core_os/context_switch/os_sched_wakeup/index.html
index 7d81b34..41af591 100644
--- a/latest/os/core_os/context_switch/os_sched_wakeup/index.html
+++ b/latest/os/core_os/context_switch/os_sched_wakeup/index.html
@@ -288,7 +288,7 @@
<li >
- <a href="../os_sched_get_current_task/">os_/sched_get_current_task</a>
+ <a href="../os_sched_get_current_task/">os_sched_get_current_task</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/event_queue/event_queue/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/event_queue/event_queue/index.html b/latest/os/core_os/event_queue/event_queue/index.html
index 11d2da7..c5390dd 100644
--- a/latest/os/core_os/event_queue/event_queue/index.html
+++ b/latest/os/core_os/event_queue/event_queue/index.html
@@ -701,12 +701,32 @@ Processing task would then act according to event type.</p>
</table>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in event queue feature are:</p>
-<ul>
-<li><a href="../os_eventq_get/">os_eventq_get</a></li>
-<li><a href="../os_eventq_init/">os_eventq_init</a></li>
-<li><a href="../os_eventq_put/">os_eventq_put</a></li>
-<li><a href="../os_eventq_remove/">os_eventq_remove</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_eventq_get/">os_eventq_get</a></td>
+<td>Fetches the first event from a queue. Task will sleep until something gets queued.</td>
+</tr>
+<tr>
+<td><a href="../os_eventq_init/">os_eventq_init</a></td>
+<td>Initializes the given event queue, making it ready for use.</td>
+</tr>
+<tr>
+<td><a href="../os_eventq_put/">os_eventq_put</a></td>
+<td>Queues an event to tail of the event queue.</td>
+</tr>
+<tr>
+<td><a href="../os_eventq_remove/">os_eventq_remove</a></td>
+<td>Removes an event which has been placed in a queue.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/heap/heap/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/heap/heap/index.html b/latest/os/core_os/heap/heap/index.html
index d2d7c63..6d316e4 100644
--- a/latest/os/core_os/heap/heap/index.html
+++ b/latest/os/core_os/heap/heap/index.html
@@ -634,11 +634,28 @@
<p>N/A</p>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in heap are:</p>
-<ul>
-<li><a href="../os_free">os_free</a></li>
-<li><a href="../os_malloc">os_malloc</a></li>
-<li><a href="../os_realloc">os_realloc</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_free">os_free</a></td>
+<td>Frees previously allocated memory back to the heap.</td>
+</tr>
+<tr>
+<td><a href="../os_malloc">os_malloc</a></td>
+<td>Allocates the given number of bytes from heap and returns a pointer to it.</td>
+</tr>
+<tr>
+<td><a href="../os_realloc">os_realloc</a></td>
+<td>Tries to resize previously allocated memory block, and returns pointer to resized memory.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mbuf/mbuf/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mbuf/mbuf/index.html b/latest/os/core_os/mbuf/mbuf/index.html
index c7570b0..3dec0e3 100644
--- a/latest/os/core_os/mbuf/mbuf/index.html
+++ b/latest/os/core_os/mbuf/mbuf/index.html
@@ -912,31 +912,108 @@
</table>
<h3 id="list-of-functionsmacros">List of Functions/Macros</h3>
<p>The functions/macros available in mbuf are:</p>
-<ul>
-<li><a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a></li>
-<li><a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a></li>
-<li><a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a></li>
-<li><a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a></li>
-<li><a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a></li>
-<li><a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a></li>
-<li><a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a></li>
-<li><a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a></li>
-<li><a href="../os_mbuf_adj/">os_mbuf_adj</a></li>
-<li><a href="../os_mbuf_append/">os_mbuf_append</a></li>
-<li><a href="../os_mbuf_concat/">os_mbuf_concat</a></li>
-<li><a href="../os_mbuf_copydata/">os_mbuf_copydata</a></li>
-<li><a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a></li>
-<li><a href="../os_mbuf_dup/">os_mbuf_dup</a></li>
-<li><a href="../os_mbuf_extend/">os_mbuf_extend</a></li>
-<li><a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a></li>
-<li><a href="../os_mbuf_get/">os_mbuf_get</a></li>
-<li><a href="../os_mbuf_get_pkthdr/">os_mbuf_get_pkthdr</a></li>
-<li><a href="../os_mbuf_memcmp/">os_mbuf_memcmp</a></li>
-<li><a href="../os_mbuf_off/">os_mbuf_off</a></li>
-<li><a href="../os_mbuf_pool_init/">os_mbuf_pool_init</a></li>
-<li><a href="../os_mbuf_prepend/">os_mbuf_prepend</a></li>
-<li><a href="../os_mbuf_pullup/">os_mbuf_pullup</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function/Macro</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../OS_MBUF_PKTHDR/">OS_MBUF_PKTHDR</a></td>
+<td>Get a pointer to the os mbuf packet header of an mbuf.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_PKTHDR_TO_MBUF/">OS_MBUF_PKTHDR_TO_MBUF</a></td>
+<td>Get a pointer to the mbuf given a pointer to the os mbuf packet header.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_PKTLEN/">OS_MBUF_PKTLEN</a></td>
+<td>Get the length of an entire mbuf chain.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_DATA/">OS_MBUF_DATA</a></td>
+<td>Cast the data pointer of an mbuf to a given type.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_USRHDR/">OS_MBUF_USRHDR</a></td>
+<td>Get a pointer to the user packet header of an mbuf.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_USRHDR_LEN/">OS_MBUF_USRHDR_LEN</a></td>
+<td>Retrieve the length of the user packet header in an mbuf.</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_LEADINGSPACE/">OS_MBUF_LEADINGSPACE</a></td>
+<td>Get the amount of leading space in an mbuf (in bytes).</td>
+</tr>
+<tr>
+<td><a href="../OS_MBUF_TRAILINGSPACE/">OS_MBUF_TRAILINGSPACE</a></td>
+<td>Get the amount of trailing space in an mbuf (in bytes).</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_adj/">os_mbuf_adj</a></td>
+<td>Trims the given number of bytes from either the head (if positive) or tail (if negative) of an mbuf chain.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_append/">os_mbuf_append</a></td>
+<td>Appends a data buffer of the given length to the end of an mbuf chain.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_concat/">os_mbuf_concat</a></td>
+<td>Attaches a second mbuf chain onto the end of the first.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_copydata/">os_mbuf_copydata</a></td>
+<td>Copy data from an mbuf chain.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_copyinto/">os_mbuf_copyinto</a></td>
+<td>Copies the contents of a flat buffer into an mbuf chain.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_dup/">os_mbuf_dup</a></td>
+<td>Duplicate a chain of mbufs.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_extend/">os_mbuf_extend</a></td>
+<td>Increases the length of an mbuf chain by the specified amount.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_free_chain/">os_mbuf_free_chain</a></td>
+<td>Frees a chain of mbufs.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_get/">os_mbuf_get</a></td>
+<td>Get an mbuf from the mbuf pool.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_get_pkthdr/">os_mbuf_get_pkthdr</a></td>
+<td>Allocates a packet header mbuf from the given mbuf pool. Adds a user header to the packet header mbuf.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_memcmp/">os_mbuf_memcmp</a></td>
+<td>Performs a memory compare of the specified region of an mbuf chain against a flat buffer.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_off/">os_mbuf_off</a></td>
+<td>Given an offset in the packet, return the mbuf and the offset in that mbuf where byte 'off' is located.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_pool_init/">os_mbuf_pool_init</a></td>
+<td>nitialize an mbuf pool.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_prepend/">os_mbuf_prepend</a></td>
+<td>Increases the length of an mbuf chain by adding data to the front.</td>
+</tr>
+<tr>
+<td><a href="../os_mbuf_pullup/">os_mbuf_pullup</a></td>
+<td>Rearrange an mbuf chain so that the given length of bytes are contiguous and in the data area of an mbuf.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/memory_pool/memory_pool/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/memory_pool/memory_pool/index.html b/latest/os/core_os/memory_pool/memory_pool/index.html
index b72ea4b..db34315 100644
--- a/latest/os/core_os/memory_pool/memory_pool/index.html
+++ b/latest/os/core_os/memory_pool/memory_pool/index.html
@@ -708,15 +708,38 @@ Once the memory pool has been initialized the developer can allocate memory bloc
</tr>
</tbody>
</table>
-<h3 id="list-of-functions">List of Functions</h3>
-<p>The functions available in mem_pool are:</p>
-<ul>
-<li><a href="../os_memblock_get">os_memblock_get</a></li>
-<li><a href="../os_mempool_init">os_mempool_init</a></li>
-<li><a href="../os_memblock_put">os_memblock_put</a></li>
-<li><a href="../OS_MEMPOOL_BYTES">OS_MEMPOOL_BYTES</a></li>
-<li><a href="../OS_MEMPOOL_SIZE">OS_MEMPOOL_SIZE</a></li>
-</ul>
+<h3 id="list-of-functionsmacros">List of Functions/Macros</h3>
+<p>The functions/macros available in mem_pool are:</p>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_memblock_get">os_memblock_get</a></td>
+<td>Allocate an element from the memory pool.</td>
+</tr>
+<tr>
+<td><a href="../os_mempool_init">os_mempool_init</a></td>
+<td>Initializes the memory pool.</td>
+</tr>
+<tr>
+<td><a href="../os_memblock_put">os_memblock_put</a></td>
+<td>Releases previously allocated element back to the pool.</td>
+</tr>
+<tr>
+<td><a href="../OS_MEMPOOL_BYTES">OS_MEMPOOL_BYTES</a></td>
+<td>Calculates how many bytes of memory is used by n number of elements, when individual element size is blksize bytes.</td>
+</tr>
+<tr>
+<td><a href="../OS_MEMPOOL_SIZE">OS_MEMPOOL_SIZE</a></td>
+<td>Calculates the number of os_membuf_t elements used by n blocks of size blksize bytes.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mqueue/mqueue/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mqueue/mqueue/index.html b/latest/os/core_os/mqueue/mqueue/index.html
index 5d7cc5a..62c1dc1 100644
--- a/latest/os/core_os/mqueue/mqueue/index.html
+++ b/latest/os/core_os/mqueue/mqueue/index.html
@@ -740,11 +740,28 @@
<p><br></p>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in Mqueue are:</p>
-<ul>
-<li><a href="../os_mqueue_init/">os_mqueue_init</a></li>
-<li><a href="../os_mqueue_get/">os_mqueue_get</a></li>
-<li><a href="../os_mqueue_put/">os_mqueue_put</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_mqueue_init/">os_mqueue_init</a></td>
+<td>Initializes an mqueue.</td>
+</tr>
+<tr>
+<td><a href="../os_mqueue_get/">os_mqueue_get</a></td>
+<td>Retrieves a packet off an Mqueue.</td>
+</tr>
+<tr>
+<td><a href="../os_mqueue_put/">os_mqueue_put</a></td>
+<td>Adds a packet (i.e. packet header mbuf) to an mqueue.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/msys/msys/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/msys/msys/index.html b/latest/os/core_os/msys/msys/index.html
index 78beae4..677307c 100644
--- a/latest/os/core_os/msys/msys/index.html
+++ b/latest/os/core_os/msys/msys/index.html
@@ -671,12 +671,32 @@
<p><br> </p>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in msys are:</p>
-<ul>
-<li><a href="../os_msys_get/">os_msys_get</a></li>
-<li><a href="../os_msys_get_pkthdr/">os_msys_get_pkthdr</a></li>
-<li><a href="../os_msys_register/">os_msys_register</a></li>
-<li><a href="../os_msys_reset/">os_msys_reset</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_msys_get/">os_msys_get</a></td>
+<td>Retrieve an mbuf from the system mbuf pools with the given number of bytes available in the mbuf.</td>
+</tr>
+<tr>
+<td><a href="../os_msys_get_pkthdr/">os_msys_get_pkthdr</a></td>
+<td>Retrieve a packet header mbuf from the system mbuf pools with the given number of bytes available for the user header in the mbuf.</td>
+</tr>
+<tr>
+<td><a href="../os_msys_register/">os_msys_register</a></td>
+<td>Register an mbuf pool for use as a system mbuf pool.</td>
+</tr>
+<tr>
+<td><a href="../os_msys_reset/">os_msys_reset</a></td>
+<td>Resets msys module.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mutex/mutex/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mutex/mutex/index.html b/latest/os/core_os/mutex/mutex/index.html
index 9b1928c..a84ca64 100644
--- a/latest/os/core_os/mutex/mutex/index.html
+++ b/latest/os/core_os/mutex/mutex/index.html
@@ -310,7 +310,7 @@
<li><a href="
- ../os_mutex_pend/
+ ../os_mutex_init/
">Functions</a>
@@ -678,11 +678,28 @@
<h3 id="list-of-functions">List of Functions</h3>
<p><List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the words of the heading need to be connected with a dash for the anchor to work. Hence the word "function" and the function name is connected with a dash, not underscore! And the header has to have at least 2 words for the anchor to work - that's how it is.></p>
<p>The functions available in this OS feature are:</p>
-<ul>
-<li><a href="../os_mutex_init">os_mutex_init</a></li>
-<li><a href="../os_mutex_pend">os_mutex_pend</a></li>
-<li><a href="../os_mutex_release">os_mutex_release</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_mutex_init">os_mutex_init</a></td>
+<td>Initialize the mutex. Must be called before the mutex can be used.</td>
+</tr>
+<tr>
+<td><a href="../os_mutex_pend">os_mutex_pend</a></td>
+<td>Acquire ownership of a mutex.</td>
+</tr>
+<tr>
+<td><a href="../os_mutex_release">os_mutex_release</a></td>
+<td>Release ownership of a mutex.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
@@ -700,7 +717,7 @@
</li>
<li class="pull-right">
- <a href=../os_mutex_pend/>
+ <a href=../os_mutex_init/>
Next: os_mutex_init
<span class="fa fa-arrow-right"></span>
</a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mutex/os_mutex_init/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mutex/os_mutex_init/index.html b/latest/os/core_os/mutex/os_mutex_init/index.html
new file mode 100644
index 0000000..05e2abe
--- /dev/null
+++ b/latest/os/core_os/mutex/os_mutex_init/index.html
@@ -0,0 +1,760 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mutex/os_mutex_init/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mutex_init - Apache Mynewt</title>
+
+ <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
+ <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../../../css/highlight.css">
+ <link href="../../../../css/base.css" rel="stylesheet">
+ <link href="../../../../css/custom.css" rel="stylesheet">
+ <link href="../../../../css/v2.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ <link href="../../../../extra.css" rel="stylesheet">
+
+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+ <![endif]-->
+
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-72162311-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+
+ </head>
+
+
+ <body class="os_mutex_init">
+
+
+
+
+
+
+
+
+
+<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <!-- Collapsed navigation -->
+ <div class="navbar-header">
+ <!-- Expander button -->
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ </div>
+
+ <!-- Expanded navigation -->
+ <div class="navbar-collapse collapse">
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav navbar-right">
+ <li
+ class=""
+>
+ <a href="/">Home</a>
+ </li>
+ <li
+ class="important"
+>
+ <a href="/quick-start/">Quick Start</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/about/">About</a>
+ </li>
+ <li
+ class="active"
+>
+ <a href="/latest/os/introduction">Documentation</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/download/">Download</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/community/">Community</a>
+ </li>
+ <li
+ class=""
+>
+ <a href="/events/">Events</a>
+ </li>
+ </ul>
+
+ <!-- Search, Navigation and Repo links -->
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div>
+ </div>
+</nav>
+
+
+
+ <div class="container">
+
+ <div class="row">
+ <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary">
+ <div class="top">
+ <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
+ <div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+ <div class="form-group">
+ <input type="text" name="q" class="form-control" placeholder="Search documentation" />
+ </div>
+ </form>
+ </div>
+ </div>
+ <ul class="toc-nav">
+ <li class="doc-version">
+<select class="form-control" onchange="if (this.value) window.location.href=this.value">
+
+ <option
+ value="/develop/os/introduction"
+
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+ selected="selected"
+ >
+ Version: 0.9.0 (latest)
+ </option>
+
+</select>
+</li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li ><a href="../../../introduction/">Mynewt Documentation</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../../get_started/get_started/">Basic Setup</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../get_started/vocabulary/">Concepts</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../tutorials/tutorials/">Tutorials</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../os_user_guide/">OS User Guide</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li ><a href="../../mynewt_os/">OS Core</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../os_init/
+">System-level Functions</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../context_switch/context_switch/">Scheduler</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../time/os_time/">Time</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../task/task/">Tasks</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../event_queue/event_queue/">Event Queues</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../semaphore/semaphore/">Semaphores</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../mutex/">Mutexes</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ./
+">Functions</a>
+
+
+ <ul>
+
+
+
+ <li class="active">
+ <a href="./">os_mutex_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mutex_pend/">os_mutex_pend</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mutex_release/">os_mutex_release</a>
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../memory_pool/memory_pool/">Memory Pools</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../heap/heap/">Heap</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../mbuf/mbuf/
+
+">Memory Buffers</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../sanity/sanity/">Sanity</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../callout/callout/">Callouts</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../porting/port_os/">Porting to your Platform</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/console/console/">Console</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/shell/shell/">Shell</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/bootloader/bootloader/">Bootloader</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+
+
+ ../../../modules/fs/fs/fs/
+
+">File System</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/hal/hal/">Hardware Abstraction Layer</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/testutil/testutil/">Test Utilities</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/imgmgr/imgmgr/">Image Manager</a>
+
+
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../../../modules/baselibc/">Baselibc library</a>
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/elua/elua/">Embedded Lua</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/json/json/">JSON</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/stats/stats/">Stats</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../modules/logs/logs/">Logs</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../network/ble/ble_intro/
+">BLE User Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
+
+
+ </li>
+
+
+
+
+
+
+
+ <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
+
+
+ </li>
+
+
+
+ </ul>
+
+ </li>
+
+
+
+
+
+
+
+ <li><a href="
+ ../../../../faq/how_to_edit_docs/
+">Appendix</a>
+
+
+ </li>
+
+
+
+ </ul>
+</div></div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9" role="main">
+ <div class="row doc-header">
+ <div class="col-sm-12">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs pull-right">
+ <li><a href="/latest/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mutex/">Mutexes</a></li>
+
+
+
+ <li>» Functions</li>
+
+
+
+ <li>» os_mutex_init</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mutex_init"><font color="#F2853F" style="font-size:24pt">os_mutex_init</font></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">os_error_t</span> <span style="color: #000000">os_mutex_init</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mutex</span> <span style="color: #000000">*mu</span>)
+</pre></div>
+
+
+<p>Initialize the mutex. Must be called before the mutex can be used.</p>
+<h4 id="arguments">Arguments</h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>*mu</td>
+<td>Pointer to mutex</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values</h4>
+<p>OS_INVALID_PARM: returned when *mu is NULL on entry.</p>
+<p>OS_OK: mutex initialized successfully.</p>
+<h4 id="notes">Notes</h4>
+<p><Any special feature/special benefit that we want to tout.
+Does it need to be used with some other specific functions?
+Any caveats to be careful about (e.g. high memory requirements).></p>
+<h4 id="example">Example</h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #000000">os_mutex</span> <span style="color: #000000">g_mutex1</span>;
+<span style="color: #A90D91">os_error_t</span> <span style="color: #000000">err</span>;
+
+<span style="color: #000000">err</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mutex_init</span>(<span style="color: #000000">&g_mutex1</span>);
+<span style="color: #000000">assert</span>(<span style="color: #000000">err</span> <span style="color: #000000">==</span> <span style="color: #000000">OS_OK</span>);
+</pre></div>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../mutex/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: Mutexes
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mutex_pend/>
+ Next: os_mutex_pend
+ <span class="fa fa-arrow-right"></span>
+ </a>
+
+ </li>
+</ul>
+ </div>
+ <div class="row">
+ <footer>
+ <div class="row">
+ <div class="col-md-12">
+
+ <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
+
+ </div>
+ </div>
+ <div class="copyright-logos">
+ <div class="row">
+ <div class="col-xs-6 text-right">
+ <img src="/img/apache-feather.png" alt="Apache" title="Apache">
+ </div>
+ <div class="col-xs-6 text-left">
+ <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-12">
+ <small class="footnote">
+ MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+ </small>
+ </div>
+ </div>
+</footer>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+ <script src="../../../../js/jquery-1.10.2.min.js"></script>
+ <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/base.js"></script>
+ <script src="../../../../js/custom.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mutex/os_mutex_pend/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mutex/os_mutex_pend/index.html b/latest/os/core_os/mutex/os_mutex_pend/index.html
index 539da1c..b149a62 100644
--- a/latest/os/core_os/mutex/os_mutex_pend/index.html
+++ b/latest/os/core_os/mutex/os_mutex_pend/index.html
@@ -9,7 +9,7 @@
<link rel="canonical" href="http://mynewt.apache.org/os/core_os/mutex/os_mutex_pend/">
<link rel="shortcut icon" href="../../../../img/favicon.ico">
- <title>os_mutex_init - Apache Mynewt</title>
+ <title>os_mutex_pend - Apache Mynewt</title>
<link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
<link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
@@ -41,7 +41,7 @@
</head>
- <body class="os_mutex_init">
+ <body class="os_mutex_pend">
@@ -310,7 +310,7 @@
<li><a href="
- ./
+ ../os_mutex_init/
">Functions</a>
@@ -318,8 +318,16 @@
+ <li >
+ <a href="../os_mutex_init/">os_mutex_init</a>
+ </li>
+
+
+
+
+
<li class="active">
- <a href="./">os_mutex_init</a>
+ <a href="./">os_mutex_pend</a>
</li>
@@ -635,11 +643,11 @@
- <li>» Functions</li>
+ <li>» <a href="../os_mutex_init/">Functions</a></li>
- <li>» os_mutex_init</li>
+ <li>» os_mutex_pend</li>
@@ -701,9 +709,9 @@
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
- <a href=../mutex/>
+ <a href=../os_mutex_init/>
<span class="fa fa-arrow-left"></span>
- Previous: Mutexes
+ Previous: os_mutex_init
</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/mutex/os_mutex_release/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/mutex/os_mutex_release/index.html b/latest/os/core_os/mutex/os_mutex_release/index.html
index 9d8d915..508ff97 100644
--- a/latest/os/core_os/mutex/os_mutex_release/index.html
+++ b/latest/os/core_os/mutex/os_mutex_release/index.html
@@ -310,7 +310,7 @@
<li><a href="
- ../os_mutex_pend/
+ ../os_mutex_init/
">Functions</a>
@@ -319,7 +319,15 @@
<li >
- <a href="../os_mutex_pend/">os_mutex_init</a>
+ <a href="../os_mutex_init/">os_mutex_init</a>
+ </li>
+
+
+
+
+
+ <li >
+ <a href="../os_mutex_pend/">os_mutex_pend</a>
</li>
@@ -635,7 +643,7 @@
- <li>» <a href="../os_mutex_pend/">Functions</a></li>
+ <li>» <a href="../os_mutex_init/">Functions</a></li>
@@ -697,7 +705,7 @@
<a href=../os_mutex_pend/>
<span class="fa fa-arrow-left"></span>
- Previous: os_mutex_init
+ Previous: os_mutex_pend
</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/sanity/sanity/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/sanity/sanity/index.html b/latest/os/core_os/sanity/sanity/index.html
index cf9953f..634a722 100644
--- a/latest/os/core_os/sanity/sanity/index.html
+++ b/latest/os/core_os/sanity/sanity/index.html
@@ -818,13 +818,36 @@ for temporary failures.</p>
</table>
<h2 id="list-of-functions">List of Functions</h2>
<p>The functions available in sanity are:</p>
-<ul>
-<li><a href="../os_sanity_check_init/">os_sanity_check_init</a></li>
-<li><a href="../os_sanity_check_register/">os_sanity_check_register</a></li>
-<li><a href="../os_sanity_check_reset/">os_sanity_check_reset</a></li>
-<li><a href="../os_sanity_task_checkin/">os_sanity_task_checkin</a></li>
-<li><a href="../os_sanity_task_init/">os_sanity_task_init</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_sanity_check_init/">os_sanity_check_init</a></td>
+<td>Initialize the given sanity check.</td>
+</tr>
+<tr>
+<td><a href="../os_sanity_check_register/">os_sanity_check_register</a></td>
+<td>Register the given sanity check with the sanity task.</td>
+</tr>
+<tr>
+<td><a href="../os_sanity_check_reset/">os_sanity_check_reset</a></td>
+<td>Reset the given sanity check.</td>
+</tr>
+<tr>
+<td><a href="../os_sanity_task_checkin/">os_sanity_task_checkin</a></td>
+<td>Informs the sanity task that the given task is still alive and working normally.</td>
+</tr>
+<tr>
+<td><a href="../os_sanity_task_init/">os_sanity_task_init</a></td>
+<td>Initialize the os sanity task.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/semaphore/semaphore/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/semaphore/semaphore/index.html b/latest/os/core_os/semaphore/semaphore/index.html
index 1437776..b6f100a 100644
--- a/latest/os/core_os/semaphore/semaphore/index.html
+++ b/latest/os/core_os/semaphore/semaphore/index.html
@@ -667,11 +667,28 @@
</table>
<h3 id="list-of-functions">List of Functions</h3>
<p>The functions available in semaphore are:</p>
-<ul>
-<li><a href="../os_sem_init">os_sem_init</a></li>
-<li><a href="../os_sem_pend">os_sem_pend</a></li>
-<li><a href="../os_sem_release">os_sem_release</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_sem_init">os_sem_init</a></td>
+<td>Initialize a semaphore with a given number of tokens.</td>
+</tr>
+<tr>
+<td><a href="../os_sem_pend">os_sem_pend</a></td>
+<td>Wait for a semaphore for a given amount of time.</td>
+</tr>
+<tr>
+<td><a href="../os_sem_release">os_sem_release</a></td>
+<td>Release a semaphore that you are holding. This adds a token to the semaphore.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/task/task/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/task/task/index.html b/latest/os/core_os/task/task/index.html
index 17a2260..015dbe7 100644
--- a/latest/os/core_os/task/task/index.html
+++ b/latest/os/core_os/task/task/index.html
@@ -937,11 +937,28 @@ task simply toggles an LED at a one second interval.</p>
<p><br></p>
<h2 id="list-of-functions">List of Functions</h2>
<p>The functions available in task are:</p>
-<ul>
-<li><a href="../os_task_init/">os_task_init</a></li>
-<li><a href="../os_task_count/">os_task_count</a></li>
-<li><a href="../os_task_info_get_next/">os_task_info_get_next</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_task_init/">os_task_init</a></td>
+<td>Called to create a task. This adds the task object to the list of ready to run tasks.</td>
+</tr>
+<tr>
+<td><a href="../os_task_count/">os_task_count</a></td>
+<td>Returns the number of tasks that have been created.</td>
+</tr>
+<tr>
+<td><a href="../os_task_info_get_next/">os_task_info_get_next</a></td>
+<td>Populates the os task info structure given with task information.</td>
+</tr>
+</tbody>
+</table>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/ea84c9e9/latest/os/core_os/time/os_time/index.html
----------------------------------------------------------------------
diff --git a/latest/os/core_os/time/os_time/index.html b/latest/os/core_os/time/os_time/index.html
index a9ddf4e..370a929 100644
--- a/latest/os/core_os/time/os_time/index.html
+++ b/latest/os/core_os/time/os_time/index.html
@@ -657,13 +657,36 @@ struct os_timezone IST = { -330, 0 };
</pre></p>
<h2 id="list-of-functions">List of Functions</h2>
<p>The functions available in time are:</p>
-<ul>
-<li><a href="../os_time_delay/">os_time_delay</a></li>
-<li><a href="../os_time_get/">os_time_get</a></li>
-<li><a href="../os_time_tick/">os_time_tick</a></li>
-<li><a href="../os_settimeofday/">os_settimeofday</a></li>
-<li><a href="../os_gettimeofday/">os_gettimeofday</a></li>
-</ul>
+<table>
+<thead>
+<tr>
+<th><strong>Function</strong></th>
+<th><strong>Description</strong></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="../os_time_delay/">os_time_delay</a></td>
+<td>Put the current task to sleep for the given number of ticks.</td>
+</tr>
+<tr>
+<td><a href="../os_time_get/">os_time_get</a></td>
+<td>Get the current value of OS time.</td>
+</tr>
+<tr>
+<td><a href="../os_time_tick/">os_time_tick</a></td>
+<td>Increments the OS time tick for the system.</td>
+</tr>
+<tr>
+<td><a href="../os_settimeofday/">os_settimeofday</a></td>
+<td>Set the current time of day to the given time structs.</td>
+</tr>
+<tr>
+<td><a href="../os_gettimeofday/">os_gettimeofday</a></td>
+<td>Populate the given timeval and timezone structs with current time data.</td>
+</tr>
+</tbody>
+</table>
<h2 id="list-of-macros">List of Macros</h2>
<p>Several macros help with the evalution of times with respect to each other.</p>
<ul>