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/20 21:42:17 UTC
[15/51] [partial] incubator-mynewt-site git commit: generated two
versions of docs - develop and v0_9_0
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d18c34dd/develop/os/core_os/mutex/mutex/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mutex/mutex/index.html b/develop/os/core_os/mutex/mutex/index.html
new file mode 100644
index 0000000..074d779
--- /dev/null
+++ b/develop/os/core_os/mutex/mutex/index.html
@@ -0,0 +1,752 @@
+<!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/mutex/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>toc - 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="toc">
+
+
+
+
+
+
+
+
+
+<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"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ 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 class="active"><a href="./">Mutexes</a>
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="
+ ../os_mutex_pend/
+">Functions</a>
+
+
+ </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="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../../mynewt_os/">OS Core</a></li>
+
+
+
+ <li>» Mutexes</li>
+
+
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h1 id="mutex">Mutex</h1>
+<p>Mutex is short for "mutual exclusion"; a mutex provides mutually exclusive access to a shared resource. A mutex provides <em>priority inheritance</em> in order to prevent <em>priority inversion</em>. Priority inversion occurs when a higher priority task is waiting on a resource owned by a lower priority task. Using a mutex, the lower priority task will inherit the highest priority of any task waiting on the mutex. </p>
+<h3 id="description">Description</h3>
+<p>The first order of business when using a mutex is to declare the mutex globally. The mutex needs to be initialized before it is used (see the examples). It is generally a good idea to initialize the mutex before tasks start running in order to avoid a task possibly using the mutex before it is initialized.</p>
+<p>When a task wants exclusive access to a shared resource it needs to obtain the mutex by calling <em>os_mutex_pend</em>. If the mutex is currently owned by a different task (a lower priority task), the requesting task will be put to sleep and the owners priority will be elevated to the priority of the requesting task. Note that multiple tasks can request ownership and the current owner is elevated to the highest priority of any task waitin on the mutex. When the task is done using the shared resource, it needs to release the mutex by called <em>os_mutex_release</em>. There needs to be one release per call to pend. Note that nested calls to <em>os_mutex_pend</em> are allowed but there needs to be one release per pend.</p>
+<p>The following example will illustrate how priority inheritance works. In this example, the task number is the same as its priority. Remember that the lower the number, the higher the priority (i.e. priority 0 is higher priority than priority 1). Suppose that task 5 gets ownership of a mutex but is preempted by task 4. Task 4 attempts to gain ownership of the mutex but cannot as it is owned by task 5. Task 4 is put to sleep and task 5 is temporarily raised to priority 4. Before task 5 can release the mutex, task 3 runs and attempts to acquire the mutex. At this point, both task 3 and task 4 are waiting on the mutex (sleeping). Task 5 now runs at priority 3 (the highest priority of all the tasks waiting on the mutex). When task 5 finally releases the mutex it will be preempted as two higher priority tasks are waiting for it. </p>
+<p>Note that when multiple tasks are waiting on a mutex owned by another task, once the mutex is released the highest priority task waiting on the mutex is run. </p>
+<h3 id="data-structures">Data structures</h3>
+<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">SLIST_HEAD</span>(, <span style="color: #000000">os_task</span>) <span style="color: #000000">mu_head</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">_pad</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">mu_prio</span>;
+ <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">mu_level</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">os_task</span> <span style="color: #000000">*mu_owner</span>;
+};
+</pre></div>
+
+
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>mu_head</td>
+<td>Queue head for list of tasks waiting on mutex</td>
+</tr>
+<tr>
+<td>_pad</td>
+<td>Padding</td>
+</tr>
+<tr>
+<td>mu_prio</td>
+<td>Default priority of owner of mutex. Used to reset priority of task when mutex released</td>
+</tr>
+<tr>
+<td>mu_level</td>
+<td>Call nesting level (for nested calls)</td>
+</tr>
+<tr>
+<td>mu_owner</td>
+<td>Pointer to task structure which owns mutex</td>
+</tr>
+</tbody>
+</table>
+<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>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../../semaphore/os_sem_release/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_sem_release
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_mutex_pend/>
+ Next: os_mutex_init
+ <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/d18c34dd/develop/os/core_os/mutex/os_mutex_pend/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mutex/os_mutex_pend/index.html b/develop/os/core_os/mutex/os_mutex_pend/index.html
new file mode 100644
index 0000000..b94bbd9
--- /dev/null
+++ b/develop/os/core_os/mutex/os_mutex_pend/index.html
@@ -0,0 +1,761 @@
+<!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_pend/">
+ <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"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ 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_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="/develop/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_pend"><font color="#F2853F" style="font-size:24pt">os_mutex_pend </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_pend</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mutex</span> <span style="color: #000000">*mu</span>, <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">timeout</span>)
+</pre></div>
+
+
+<p>Acquire ownership of a mutex.</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>
+<tr>
+<td>timeout</td>
+<td>Timeout, in os ticks. A value of 0 means no timeout. A value of 0xFFFFFFFF means to wait forever.</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 was successfully acquired.</p>
+<p>OS_TIMEOUT: the mutex was not available within the timeout specified.</p>
+<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</p>
+<h4 id="notes">Notes</h4>
+<p>If the mutex is owned by another task and the timeout is 0 the function returns immediately with the error code OS_TIMEOUT. The calling task <em>does not</em> own the mutex when this occurs.</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_pend</span>(<span style="color: #000000">&g_mutex1</span>, <span style="color: #1C01CE">0</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>);
+
+<span style="color: #177500">/* Perform operations requiring exclusive access */</span>
+
+<span style="color: #000000">err</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mutex_release</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_release/>
+ Next: os_mutex_release
+ <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/d18c34dd/develop/os/core_os/mutex/os_mutex_release/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mutex/os_mutex_release/index.html b/develop/os/core_os/mutex/os_mutex_release/index.html
new file mode 100644
index 0000000..6fee421
--- /dev/null
+++ b/develop/os/core_os/mutex/os_mutex_release/index.html
@@ -0,0 +1,755 @@
+<!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_release/">
+ <link rel="shortcut icon" href="../../../../img/favicon.ico">
+
+ <title>os_mutex_release - 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_release">
+
+
+
+
+
+
+
+
+
+<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"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ 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="
+ ../os_mutex_pend/
+">Functions</a>
+
+
+ <ul>
+
+
+
+ <li >
+ <a href="../os_mutex_pend/">os_mutex_init</a>
+ </li>
+
+
+
+
+
+ <li class="active">
+ <a href="./">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="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../mutex/">Mutexes</a></li>
+
+
+
+ <li>» <a href="../os_mutex_pend/">Functions</a></li>
+
+
+
+ <li>» os_mutex_release</li>
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h2 id="os_mutex_release"><font color="#F2853F" style="font-size:24pt">os_mutex_release</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_release</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_mutex</span> <span style="color: #000000">*mu</span>)
+</pre></div>
+
+
+<p>Release ownership of a mutex</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>
+<p>OS_BAD_MUTEX: The mutex was not owned by the task attempting to release it.</p>
+<p>OS_NOT_STARTED: Attempt to release a mutex before the os has been started.</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_pend</span>(<span style="color: #000000">&g_mutex1</span>, <span style="color: #1C01CE">0</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>);
+
+<span style="color: #177500">/* Perform operations requiring exclusive access */</span>
+
+<span style="color: #000000">err</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mutex_release</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=../os_mutex_pend/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: os_mutex_init
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../../memory_pool/memory_pool/>
+ Next: Memory Pools
+ <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/d18c34dd/develop/os/core_os/mynewt_os/index.html
----------------------------------------------------------------------
diff --git a/develop/os/core_os/mynewt_os/index.html b/develop/os/core_os/mynewt_os/index.html
new file mode 100644
index 0000000..79b8873
--- /dev/null
+++ b/develop/os/core_os/mynewt_os/index.html
@@ -0,0 +1,817 @@
+<!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/mynewt_os/">
+ <link rel="shortcut icon" href="../../../img/favicon.ico">
+
+ <title>toc - 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="toc">
+
+
+
+
+
+
+
+
+
+<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"
+ selected="selected"
+ >
+ Version: develop
+ </option>
+
+ <option
+ value="/v0_9_0/os/introduction"
+
+ >
+ 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 class="active"><a href="./">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/mutex/">Mutexes</a>
+
+
+ </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="/develop/os/introduction">Docs</a></li>
+
+
+
+ <li>» <a href="../../os_user_guide/">OS User Guide</a></li>
+
+
+
+ <li>» OS Core</li>
+
+
+
+
+
+ </ul>
+</div>
+ </div>
+ </div>
+
+ <h1 id="mynewt-core-os">Mynewt Core OS</h1>
+<p>The Mynewt Core OS is a multitasking, preemptive real-time operating system combining a scheduler with typical RTOS features such as mutexes, semaphores, memory pools, etc. The Mynewt Core OS also provides a number of useful utilities such as a task watchdog, networking stack memory buffers and time management API. Each of these features is described in detail in its own section of the manual.</p>
+<p>A multitasking, preemptive operating system is one in which a number of different tasks can be instantiated and assigned a priority, with higher priority tasks running before lower priority tasks. Furthermore, if a lower priority task is running and a higher priority task wants to run, the lower priority task is halted and the higher priority task is allowed to run. In other words, the lower priority task is preempted by the higher priority task.</p>
+<h3 id="why-use-an-os">Why use an OS?</h3>
+<p>You may ask yourself "why do I need a multitasking preemptive OS"? The answer may indeed be that you do not. Some applications are simple and only require a polling loop. Others are more complex and may require that certain jobs are executed in a timely manner or before other jobs are executed. If you have a simple polling loop, you cannot move on to service a job until the current job is done being serviced. With the Mynewt OS, the application developer need not worry about certain jobs taking too long or not executing in a timely fashion; the OS provides mechanisms to deal with these situations. Another benefit of using an OS is that it helps shield application developers from other application code being written; the developer does not have to worry (or has to worry less) about other application code behaving badly and causing undesirable behavior or preventing their code from executing properly. Other benefits of using an OS (and the Mynewt OS in particular) is that it also p
rovides features that the developer would otherwise need to create on his/her own. </p>
+<h3 id="core-os-features">Core OS Features</h3>
+<p><Insert basic feature descriptions, how the various pieces fit together etc., what's special in Mynewt OS></p>
+<ul>
+<li><a href="../context_switch/context_switch/">Scheduler/context switching</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/callouts</a></li>
+<li><a href="../semaphore/semaphore/">Semaphores</a></li>
+<li><a href="../mutex/mutex/">Mutexes</a></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/">Mbufs</a></li>
+<li><a href="../sanity/sanity/">Sanity</a></li>
+<li><a href="../callout/callout/">Callouts</a></li>
+<li><a href="../porting/port_os/">Porting OS to other platforms</a></li>
+</ul>
+<h3 id="basic-os-application-creation">Basic OS Application Creation</h3>
+<p>Creating an application using the Mynewt Core OS is a relatively simple task: once you have installed the basic Newt Tool structure (build structure) for your application and created your BSP (Board Support Package), the developer initializes the OS by calling <code>os_init()</code>, performs application specific initializations, and then starts the os by calling <code>os_start()</code>. </p>
+<p>The <code>os_init()</code> API performs two basic functions: calls architecture and bsp specific setup and initializes the idle task of the OS. This is required before the OS is started. The OS start API initializes the OS time tick interrupt and starts the highest priority task running (i.e starts the scheduler). Note that <code>os_start()</code> never returns; once called the device is either running in an application task context or in idle task context.</p>
+<p>Initializing application modules and tasks can get somewhat complicated with RTOS's similar to Mynewt. Care must be taken that the API provided by a task are initialized prior to being called by another (higher priority) task. </p>
+<p>For example, take a simple application with two tasks (tasks 1 and 2, with task 1 higher priority than task 2). Task 2 provides an API which has a semaphore lock and this semaphore is initialized by task 2 when the task handler for task 2 is called. Task 1 is expected to call this API.</p>
+<p>Consider the sequence of events when the OS is started. The scheduler starts running and picks the highest priority task (task 1 in this case). The task handler function for task 1 is called and will keep running until it yields execution. Before yielding, code in the task 1 handler function calls the API provided by task 2. The semaphore being accessed in the task 2 API has yet to be initialized since the task 2 handler function has not had a chance to run! This will lead to undesirable behavior and will need to be addressed by the application developer. Note that the Mynewt OS does guard against internal API being called before the OS has started (they will return error) but it does not safeguard application defined objects from access prior to initialization.</p>
+<h3 id="example">Example</h3>
+<p>One way to avoid initialization issues like the one described above is to perform task initializations prior to starting the OS. The code example shown below illustrates this concept. The application initializes the OS, calls an application specific "task initialization" function, and then starts the OS. The application task initialization function is responsible for initializing all the data objects that each task exposes to the other tasks. The tasks themselves are also initialized at this time (by calling <code>os_task_init()</code>). </p>
+<p>In the example, each task works in a ping-pong like fashion: task 1 wakes up, adds a token to semaphore 1 and then waits for a token from semaphore 2. Task 2 waits for a token on semaphore 1 and once it gets it, adds a token to semaphore 2. Notice that the semaphores are initialized by the application specific task initialization functions and not inside the task handler functions. If task 2 (being lower in priority than task 1) had called os_sem_init() for task2_sem inside task2_handler(), task 1 would have called os_sem_pend() using task2_sem before task2_sem was initialized.</p>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">/* Task 1 handler function */
+void
+task1_handler(void *arg)
+{
+ while (1) {
+ /* Release semaphore to task 2 */
+ os_sem_release(&task1_sem);
+
+ /* Wait for semaphore from task 2 */
+ os_sem_pend(&task2_sem, OS_TIMEOUT_NEVER);
+ }
+}
+
+/* Task 2 handler function */
+void
+task2_handler(void *arg)
+{
+ struct os_task *t;
+
+ while (1) {
+ /* Wait for semaphore from task1 */
+ os_sem_pend(&task1_sem, OS_TIMEOUT_NEVER);
+
+ /* Release task2 semaphore */
+ os_sem_release(&task2_sem);
+ }
+}
+
+
+/* Initialize task 1 exposed data objects */
+void
+task1_init(void)
+{
+ /* Initialize task1 semaphore */
+ os_sem_init(&task1_sem, 0);
+}
+
+/* Initialize task 2 exposed data objects */
+void
+task2_init(void)
+{
+ /* Initialize task1 semaphore */
+ os_sem_init(&task2_sem, 0);
+}
+
+/**
+ * init_app_tasks
+ *
+ * Called by main.c after os_init(). This function performs initializations
+ * that are required before tasks are running.
+ *
+ * @return int 0 success; error otherwise.
+ */
+static int
+init_app_tasks(void)
+{
+ /*
+ * Initialize tasks 1 and 2. Note that the task handlers are not called yet; they will
+ * be called when the OS is started.
+ */
+ os_task_init(&task1, "task1", task1_handler, NULL, TASK1_PRIO,
+ OS_WAIT_FOREVER, task1_stack, TASK1_STACK_SIZE);
+
+ os_task_init(&task2, "task2", task2_handler, NULL, TASK2_PRIO,
+ OS_WAIT_FOREVER, task2_stack, TASK2_STACK_SIZE);
+
+ /* Call task specific initialization functions. */
+ task1_init();
+ task2_init();
+
+ return 0;
+}
+
+/**
+ * main
+ *
+ * The main function for the application. This function initializes the os, calls
+ * the application specific task initialization function. then starts the
+ * OS. We should not return from os start!
+ */
+int
+main(void)
+{
+ int i;
+ int rc;
+ uint32_t seed;
+
+ /* Initialize OS */
+ os_init();
+
+ /* Initialize application specific tasks */
+ init_app_tasks();
+
+ /* Start the OS */
+ os_start();
+
+ /* os start should never return. If it does, this should be an error */
+ assert(0);
+
+ return rc;
+}
+</pre></div>
+
+
+<h3 id="os-functions">OS Functions</h3>
+<p>The functions available at the OS level are:</p>
+<ul>
+<li><a href="../os_init/">os_init</a></li>
+<li><a href="../os_start/">os_start</a></li>
+<li><a href="../os_started/">os_started</a></li>
+</ul>
+
+ <div class="row">
+
+
+
+
+<ul class="nav nav-pills" style="margin-bottom: 10px">
+ <li>
+
+ <a href=../../os_user_guide/>
+ <span class="fa fa-arrow-left"></span>
+ Previous: OS User Guide
+ </a>
+
+ </li>
+ <li class="pull-right">
+
+ <a href=../os_init/>
+ Next: os_init
+ <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