http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/msys/os_msys_register/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/msys/os_msys_register/index.html b/develop/os/core_os/msys/os_msys_register/index.html index 26d86a3..0322d43 100644 --- a/develop/os/core_os/msys/os_msys_register/index.html +++ b/develop/os/core_os/msys/os_msys_register/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/msys/os_msys_register/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_msys_register - Apache Mynewt</title> + <title>os_msys_register - 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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_msys_register"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -694,14 +711,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -721,7 +733,6 @@ </ul> </div> - </div> </div> <h2 id="os_msys_register"><font color="#F2853F" style="font-size:24pt">os_msys_register</font></h2> @@ -741,7 +752,7 @@ </thead> <tbody> <tr> -<td>new_pool</td> +<td><code>new_pool</code></td> <td>Pointer to mbuf pool to add to system mbuf pools</td> </tr> </tbody> @@ -779,34 +790,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/msys/os_msys_reset/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/msys/os_msys_reset/index.html b/develop/os/core_os/msys/os_msys_reset/index.html index 847e013..a308542 100644 --- a/develop/os/core_os/msys/os_msys_reset/index.html +++ b/develop/os/core_os/msys/os_msys_reset/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/msys/os_msys_reset/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_msys_reset - Apache Mynewt</title> + <title>os_msys_reset - 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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_msys_reset"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -694,14 +711,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -721,7 +733,6 @@ </ul> </div> - </div> </div> <h2 id="os_msys_reset"><font color="#F2853F" style="font-size:24pt">os_msys_reset</font></h2> @@ -765,34 +776,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/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 index ebd3a1e..cbd0e94 100644 --- a/develop/os/core_os/mutex/mutex/index.html +++ b/develop/os/core_os/mutex/mutex/index.html @@ -10,15 +10,14 @@ <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> + <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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="toc"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -621,14 +638,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -646,14 +658,13 @@ </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>When a task wants exclusive access to a shared resource it needs to obtain the mutex by calling <code>os_mutex_pend</code>. 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 <code>os_mutex_release</code>. There needs to be one release per call to pend. Note that nested calls to <code>os_mutex_pend</code> 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> @@ -748,34 +759,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/mutex/os_mutex_init/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mutex/os_mutex_init/index.html b/develop/os/core_os/mutex/os_mutex_init/index.html index 2155cfa..54004b8 100644 --- a/develop/os/core_os/mutex/os_mutex_init/index.html +++ b/develop/os/core_os/mutex/os_mutex_init/index.html @@ -10,15 +10,14 @@ <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> + <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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_mutex_init"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -649,14 +666,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -676,7 +688,6 @@ </ul> </div> - </div> </div> <h2 id="os_mutex_init"><font color="#F2853F" style="font-size:24pt">os_mutex_init</font></h2> @@ -695,14 +706,14 @@ </thead> <tbody> <tr> -<td>*mu</td> +<td><code>*mu</code></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><code>OS_INVALID_PARM</code>: returned when <code>*mu</code> is <strong>NULL</strong> on entry.</p> +<p><code>OS_OK</code>: 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? @@ -739,34 +750,22 @@ Any caveats to be careful about (e.g. high memory requirements).></p> </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/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 index f5eaf40..421e894 100644 --- a/develop/os/core_os/mutex/os_mutex_pend/index.html +++ b/develop/os/core_os/mutex/os_mutex_pend/index.html @@ -10,15 +10,14 @@ <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_pend - 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"> <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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_mutex_pend"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -649,14 +666,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -676,7 +688,6 @@ </ul> </div> - </div> </div> <h2 id="os_mutex_pend"><font color="#F2853F" style="font-size:24pt">os_mutex_pend </font></h2> @@ -695,22 +706,22 @@ </thead> <tbody> <tr> -<td>*mu</td> +<td><code>*mu</code></td> <td>Pointer to mutex</td> </tr> <tr> -<td>timeout</td> +<td><code>timeout</code></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> +<p><code>OS_INVALID_PARM</code>: returned when <code>*mu</code> is <strong>NULL</strong> on entry.</p> +<p><code>OS_OK</code>: mutex was successfully acquired.</p> +<p><code>OS_TIMEOUT</code>: the mutex was not available within the timeout specified.</p> +<p><code>OS_NOT_STARTED</code>: 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> +<p>If the mutex is owned by another task and the timeout is 0 the function returns immediately with the error code <code>OS_TIMEOUT</code>. 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>; @@ -748,34 +759,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/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 index fc67cce..5a5adb8 100644 --- a/develop/os/core_os/mutex/os_mutex_release/index.html +++ b/develop/os/core_os/mutex/os_mutex_release/index.html @@ -10,15 +10,14 @@ <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> + <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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_mutex_release"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -649,14 +666,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -676,7 +688,6 @@ </ul> </div> - </div> </div> <h2 id="os_mutex_release"><font color="#F2853F" style="font-size:24pt">os_mutex_release</font></h2> @@ -695,16 +706,16 @@ </thead> <tbody> <tr> -<td>*mu</td> +<td><code>*mu</code></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> +<p><code>OS_INVALID_PARM</code>: returned when <code>*mu</code> is <strong>NULL</strong> on entry.</p> +<p><code>OS_OK</code>: mutex initialized successfully.</p> +<p><code>OS_BAD_MUTEX</code>: The mutex was not owned by the task attempting to release it.</p> +<p><code>OS_NOT_STARTED</code>: 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>; @@ -742,34 +753,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/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 index 4d8645a..8aae9c0 100644 --- a/develop/os/core_os/mynewt_os/index.html +++ b/develop/os/core_os/mynewt_os/index.html @@ -10,15 +10,14 @@ <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> + <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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="toc"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -602,14 +619,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -627,11 +639,10 @@ </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>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> @@ -659,108 +670,108 @@ <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); +<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 <code>os_sem_init()</code> for task2_sem inside <code>task2_handler()</code>, task 1 would have called <code>os_sem_pend()</code> using task2_sem before task2_sem was initialized.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #177500">/* Task 1 handler function */</span> + <span style="color: #A90D91">void</span> + <span style="color: #000000">task1_handler</span>(<span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>) + { + <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) { + <span style="color: #177500">/* Release semaphore to task 2 */</span> + <span style="color: #000000">os_sem_release</span>(<span style="color: #000000">&task1_sem</span>); + + <span style="color: #177500">/* Wait for semaphore from task 2 */</span> + <span style="color: #000000">os_sem_pend</span>(<span style="color: #000000">&task2_sem</span>, <span style="color: #000000">OS_TIMEOUT_NEVER</span>); + } + } + + <span style="color: #177500">/* Task 2 handler function */</span> + <span style="color: #A90D91">void</span> + <span style="color: #000000">task2_handler</span>(<span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>) + { + <span style="color: #A90D91">struct</span> <span style="color: #000000">os_task</span> <span style="color: #000000">*t</span>; + + <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) { + <span style="color: #177500">/* Wait for semaphore from task1 */</span> + <span style="color: #000000">os_sem_pend</span>(<span style="color: #000000">&task1_sem</span>, <span style="color: #000000">OS_TIMEOUT_NEVER</span>); + + <span style="color: #177500">/* Release task2 semaphore */</span> + <span style="color: #000000">os_sem_release</span>(<span style="color: #000000">&task2_sem</span>); + } } -} -/* 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); + <span style="color: #177500">/* Initialize task 1 exposed data objects */</span> + <span style="color: #A90D91">void</span> + <span style="color: #000000">task1_init</span>(<span style="color: #A90D91">void</span>) + { + <span style="color: #177500">/* Initialize task1 semaphore */</span> + <span style="color: #000000">os_sem_init</span>(<span style="color: #000000">&task1_sem</span>, <span style="color: #1C01CE">0</span>); + } - /* Release task2 semaphore */ - os_sem_release(&task2_sem); + <span style="color: #177500">/* Initialize task 2 exposed data objects */</span> + <span style="color: #A90D91">void</span> + <span style="color: #000000">task2_init</span>(<span style="color: #A90D91">void</span>) + { + <span style="color: #177500">/* Initialize task1 semaphore */</span> + <span style="color: #000000">os_sem_init</span>(<span style="color: #000000">&task2_sem</span>, <span style="color: #1C01CE">0</span>); + } + + <span style="color: #177500">/**</span> +<span style="color: #177500"> * init_app_tasks</span> +<span style="color: #177500"> * </span> +<span style="color: #177500"> * Called by main.c after os_init(). This function performs initializations </span> +<span style="color: #177500"> * that are required before tasks are running. </span> +<span style="color: #177500"> * </span> +<span style="color: #177500"> * @return int 0 success; error otherwise.</span> +<span style="color: #177500"> */</span> + <span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span> + <span style="color: #000000">init_app_tasks</span>(<span style="color: #A90D91">void</span>) + { + <span style="color: #177500">/*</span> +<span style="color: #177500"> * Initialize tasks 1 and 2. Note that the task handlers are not called yet; they will</span> +<span style="color: #177500"> * be called when the OS is started.</span> +<span style="color: #177500"> */</span> + <span style="color: #000000">os_task_init</span>(<span style="color: #000000">&task1</span>, <span style="color: #C41A16">"task1"</span>, <span style="color: #000000">task1_handler</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #000000">TASK1_PRIO</span>, + <span style="color: #000000">OS_WAIT_FOREVER</span>, <span style="color: #000000">task1_stack</span>, <span style="color: #000000">TASK1_STACK_SIZE</span>); + + <span style="color: #000000">os_task_init</span>(<span style="color: #000000">&task2</span>, <span style="color: #C41A16">"task2"</span>, <span style="color: #000000">task2_handler</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #000000">TASK2_PRIO</span>, + <span style="color: #000000">OS_WAIT_FOREVER</span>, <span style="color: #000000">task2_stack</span>, <span style="color: #000000">TASK2_STACK_SIZE</span>); + + <span style="color: #177500">/* Call task specific initialization functions. */</span> + <span style="color: #000000">task1_init</span>(); + <span style="color: #000000">task2_init</span>(); + + <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>; + } + + <span style="color: #177500">/**</span> +<span style="color: #177500"> * main</span> +<span style="color: #177500"> * </span> +<span style="color: #177500"> * The main function for the application. This function initializes the os, calls </span> +<span style="color: #177500"> * the application specific task initialization function. then starts the </span> +<span style="color: #177500"> * OS. We should not return from os start! </span> +<span style="color: #177500"> */</span> + <span style="color: #A90D91">int</span> + <span style="color: #000000">main</span>(<span style="color: #A90D91">void</span>) + { + <span style="color: #A90D91">int</span> <span style="color: #000000">i</span>; + <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>; + <span style="color: #A90D91">uint32_t</span> <span style="color: #000000">seed</span>; + + <span style="color: #177500">/* Initialize OS */</span> + <span style="color: #000000">os_init</span>(); + + <span style="color: #177500">/* Initialize application specific tasks */</span> + <span style="color: #000000">init_app_tasks</span>(); + + <span style="color: #177500">/* Start the OS */</span> + <span style="color: #000000">os_start</span>(); + + <span style="color: #177500">/* os start should never return. If it does, this should be an error */</span> + <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>); + + <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span>; } -} - - -/* 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> @@ -796,34 +807,22 @@ main(void) </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/os_init/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/os_init/index.html b/develop/os/core_os/os_init/index.html index 6b6a8f8..cd035ed 100644 --- a/develop/os/core_os/os_init/index.html +++ b/develop/os/core_os/os_init/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/os_init/";> --> <link rel="shortcut icon" href="../../../img/favicon.ico"> - <title>os_init - Apache Mynewt</title> + <title>os_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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_init"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -630,14 +647,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -657,15 +669,14 @@ </ul> </div> - </div> </div> <h2 id="os_init"><font color="#F2853F" style="font-size:24pt">os_init</font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">void os_init(void) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">os_init</span>(<span style="color: #A90D91">void</span>) </pre></div> -<p>Initializes the OS. Must be called before the OS is started (i.e. os_start() is called).</p> +<p>Initializes the OS. Must be called before the OS is started (i.e. <code>os_start()</code> is called).</p> <p><br></p> <h4 id="arguments">Arguments</h4> <p>None</p> @@ -674,7 +685,7 @@ <p>None</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>The call to os_init performs architecture and bsp initializations and initializes the idle task.</p> +<p>The call to <code>os_init()</code> performs architecture and bsp initializations and initializes the idle task.</p> <p>This function does not start the OS, the OS time tick interrupt, or the scheduler.</p> <div class="row"> @@ -701,34 +712,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/os_start/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/os_start/index.html b/develop/os/core_os/os_start/index.html index 4406221..0ab99e8 100644 --- a/develop/os/core_os/os_start/index.html +++ b/develop/os/core_os/os_start/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/os_start/";> --> <link rel="shortcut icon" href="../../../img/favicon.ico"> - <title>os_start - Apache Mynewt</title> + <title>os_start - 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 href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> <link href="../../../extra.css" rel="stylesheet"> @@ -45,6 +44,16 @@ <body class="os_start"> + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + @@ -52,7 +61,7 @@ -<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> <div class="container"> <!-- Collapsed navigation --> <div class="navbar-header"> @@ -73,7 +82,7 @@ <li class="" > - <a href="/">Home</a> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> </li> <li class="important" @@ -86,6 +95,11 @@ <a href="/about/">About</a> </li> <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li class="active" > <a href="/latest/os/introduction">Documentation</a> @@ -120,9 +134,8 @@ <div class="container"> <div class="row"> - <div class="col-md-3 v2-sidebar"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="col-md-3 v2-sidebar sidebar-container"><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"> @@ -139,14 +152,14 @@ value="/develop/os/introduction" selected="selected" > - Version: develop + Version: develop (latest) </option> <option value="/v0_9_0/os/introduction" > - Version: 0.9.0 (latest) + Version: 0.9.0 </option> </select> @@ -165,6 +178,10 @@ + + + + @@ -630,14 +647,9 @@ </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"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs pull-right"> <li><a href="/develop/os/introduction">Docs</a></li> @@ -657,11 +669,10 @@ </ul> </div> - </div> </div> <h2 id="os_start"><font color="#F2853F" style="font-size:24pt">os_start</font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">void os_start(void) +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">os_start</span>(<span style="color: #A90D91">void</span>) </pre></div> @@ -675,7 +686,7 @@ <p>None (does not return).</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>Once os_start has been called, context is switched to the highest priority task that was initialized prior to calling os_start.</p> +<p>Once <code>os_start()</code> has been called, context is switched to the highest priority task that was initialized prior to calling <code>os_start()</code>.</p> <div class="row"> @@ -701,34 +712,22 @@ </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-left"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - </div> - <div class="col-xs-6 text-right"> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> + <footer class="row"> + <div class="col-xs-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.</p> + </div> - <div class="row"> - <div class="col-md-12"> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> <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> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> </div> </div> </footer> - </div> </div> </div>
