http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/mbufs/index.html ---------------------------------------------------------------------- diff --git a/chapter4/mbufs/index.html b/chapter4/mbufs/index.html deleted file mode 100644 index 5e684a0..0000000 --- a/chapter4/mbufs/index.html +++ /dev/null @@ -1,530 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Mbufs - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Mbufs"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mutex/">Mutexes</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../memory_pool/">Memory Pools</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Mbufs</a> - - <ul> - - <li class="toctree-l3"><a href="#mbufs">Mbufs</a></li> - - <li><a class="toctree-l4" href="#description">Description</a></li> - - <li><a class="toctree-l4" href="#data-structures">Data structures</a></li> - - <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li> - - <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../sanity/">Sanity</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../port_os/">Porting to other Platforms</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Mbufs</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="mbufs">Mbufs<a class="headerlink" href="#mbufs" title="Permanent link">¶</a></h1> -<p>Insert synopsis here</p> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<p>Describe OS feature here </p> -<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2> -<p>Replace this with the list of data structures used, why, any neat features</p> -<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2> -<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 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="#function-os_mbuf_pool_init">os_mbuf_pool_init</a></li> -<li><a href="#function-os_mbuf_get">os_mbuf_get</a></li> -<li>add the rest</li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-os_mbuf_pool_init"><font color="2980b9">function os_mbuf_pool_init</font><a class="headerlink" href="#function-os_mbuf_pool_init" title="Permanent link">¶</a></h3> -<pre><code> int - os_mbuf_pool_init(struct os_mbuf_pool *omp, struct os_mempool *mp, - uint16_t hdr_len, uint16_t buf_len, uint16_t nbufs) -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-os_mbuf_get"><font color="#2980b9"> function os_mbuf_get</font><a class="headerlink" href="#function-os_mbuf_get" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../sanity/" class="btn btn-neutral float-right" title="Sanity"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../heap/" class="btn btn-neutral" title="Heap"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../heap/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../sanity/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/memory_pool/index.html ---------------------------------------------------------------------- diff --git a/chapter4/memory_pool/index.html b/chapter4/memory_pool/index.html deleted file mode 100644 index 798cd65..0000000 --- a/chapter4/memory_pool/index.html +++ /dev/null @@ -1,531 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Memory Pools - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Memory Pools"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mutex/">Mutexes</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Memory Pools</a> - - <ul> - - <li class="toctree-l3"><a href="#memory-pools">Memory Pools</a></li> - - <li><a class="toctree-l4" href="#description">Description</a></li> - - <li><a class="toctree-l4" href="#data-structures">Data structures</a></li> - - <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li> - - <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mbufs/">Mbufs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../sanity/">Sanity</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../port_os/">Porting to other Platforms</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Memory Pools</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="memory-pools">Memory Pools<a class="headerlink" href="#memory-pools" title="Permanent link">¶</a></h1> -<p>Insert synopsis here</p> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<p>Describe OS feature here </p> -<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2> -<p>Replace this with the list of data structures used, why, any neat features</p> -<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2> -<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="#function-os_mempool_init">os_mempool_init</a></li> -<li><a href="#function-os_memblock_get">os_memblock_get</a></li> -<li>add the rest</li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-os_mempool_init"><font color="2980b9">function os_mempool_init</font><a class="headerlink" href="#function-os_mempool_init" title="Permanent link">¶</a></h3> -<pre><code> os_error_t - os_mempool_init(struct os_mempool *mp, int blocks, - int block_size, void *membuf, char *name) - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-os_memblock_get"><font color="#2980b9"> function os_memblock_get</font><a class="headerlink" href="#function-os_memblock_get" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../heap/" class="btn btn-neutral float-right" title="Heap"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../mutex/" class="btn btn-neutral" title="Mutexes"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../mutex/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../heap/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/mutex/index.html ---------------------------------------------------------------------- diff --git a/chapter4/mutex/index.html b/chapter4/mutex/index.html deleted file mode 100644 index db7f511..0000000 --- a/chapter4/mutex/index.html +++ /dev/null @@ -1,530 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Mutexes - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Mutexes"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Mutexes</a> - - <ul> - - <li class="toctree-l3"><a href="#mutex">Mutex</a></li> - - <li><a class="toctree-l4" href="#description">Description</a></li> - - <li><a class="toctree-l4" href="#data-structures">Data structures</a></li> - - <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li> - - <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../memory_pool/">Memory Pools</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mbufs/">Mbufs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../sanity/">Sanity</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../port_os/">Porting to other Platforms</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Mutexes</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="mutex">Mutex<a class="headerlink" href="#mutex" title="Permanent link">¶</a></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> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<p>Describe OS feature here </p> -<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2> -<p>Replace this with the list of data structures used, why, any neat features</p> -<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2> -<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="#function-os_mutex_init">os_mutex_init</a></li> -<li><a href="#function-os_mutex_release">os_mutex_release</a></li> -<li>add the rest</li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-os_mutex_init"><font color="2980b9">function os_mutex_init</font><a class="headerlink" href="#function-os_mutex_init" title="Permanent link">¶</a></h3> -<pre><code> os_error_t - os_mutex_init(struct os_mutex *mu) - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-os_mutex_release"><font color="#2980b9"> function os_mutex_release</font><a class="headerlink" href="#function-os_mutex_release" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../memory_pool/" class="btn btn-neutral float-right" title="Memory Pools"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../semaphore/" class="btn btn-neutral" title="Semaphores"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../semaphore/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../memory_pool/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/mynewt_os/index.html ---------------------------------------------------------------------- diff --git a/chapter4/mynewt_os/index.html b/chapter4/mynewt_os/index.html deleted file mode 100644 index 55a19d7..0000000 --- a/chapter4/mynewt_os/index.html +++ /dev/null @@ -1,550 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Overview - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Overview"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Overview</a> - - <ul> - - <li class="toctree-l3"><a href="#mynewt-os">Mynewt OS</a></li> - - <li><a class="toctree-l4" href="#real-time-kernel">Real-Time Kernel </a></li> - - <li><a class="toctree-l4" href="#real-time-os">Real-Time OS </a></li> - - <li><a class="toctree-l4" href="#insert-topic-of-your-choice">Insert topic of your choice</a></li> - - <li><a class="toctree-l4" href="#features">Features</a></li> - - <li><a class="toctree-l4" href="#os-functions">OS Functions</a></li> - - <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mutex/">Mutexes</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../memory_pool/">Memory Pools</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mbufs/">Mbufs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../sanity/">Sanity</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../port_os/">Porting to other Platforms</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Overview</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="mynewt-os">Mynewt OS<a class="headerlink" href="#mynewt-os" title="Permanent link">¶</a></h1> -<p>Insert introduction here </p> -<h2 id="real-time-kernel">Real-Time Kernel <Modify as you Wish><a class="headerlink" href="#real-time-kernel" title="Permanent link">¶</a></h2> -<p>Description</p> -<h2 id="real-time-os">Real-Time OS <Modify as you Wish><a class="headerlink" href="#real-time-os" title="Permanent link">¶</a></h2> -<p>Description</p> -<h2 id="insert-topic-of-your-choice">Insert topic of your choice<a class="headerlink" href="#insert-topic-of-your-choice" title="Permanent link">¶</a></h2> -<p>Description</p> -<h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¶</a></h2> -<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/">Scheduler/context switching</a></li> -<li><a href="../time/">Time</a></li> -<li><a href="../task/">Tasks</a></li> -<li><a href="../event_queue/">Event queues/callouts</a></li> -<li><a href="../semaphore/">Semaphores</a></li> -<li><a href="../mutex/">Mutexes</a></li> -<li><a href="../memory_pool/">Memory pools</a></li> -<li><a href="../heap/">Heap</a></li> -<li><a href="../mbufs/">Mbufs</a></li> -<li><a href="../sanity/">Sanity</a></li> -<li><a href="../port_os/">Porting OS to other platforms</a></li> -</ul> -<h2 id="os-functions">OS Functions<a class="headerlink" href="#os-functions" title="Permanent link">¶</a></h2> -<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="#function-os_idle_task">os_idle_task</a></li> -<li><a href="#function-os_started">os_started</a></li> -<li>add the rest</li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-os_idle_task"><font color="2980b9">function os_idle_task</font><a class="headerlink" href="#function-os_idle_task" title="Permanent link">¶</a></h3> -<pre><code> void - os_idle_task(void *arg) -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-os_started"><font color="#2980b9"> function os_started</font><a class="headerlink" href="#function-os_started" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../context_switch/" class="btn btn-neutral float-right" title="Scheduler/Context Switching"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../../chapter3/newt_tool_reference/" class="btn btn-neutral" title="Command list"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../../chapter3/newt_tool_reference/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../context_switch/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/port_os/index.html ---------------------------------------------------------------------- diff --git a/chapter4/port_os/index.html b/chapter4/port_os/index.html deleted file mode 100644 index 51b3cd0..0000000 --- a/chapter4/port_os/index.html +++ /dev/null @@ -1,393 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Porting to other Platforms - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Porting to other Platforms"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mutex/">Mutexes</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../memory_pool/">Memory Pools</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mbufs/">Mbufs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../sanity/">Sanity</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Porting to other Platforms</a> - - <ul> - - <li class="toctree-l3"><a href="#porting-mynewt-os">Porting Mynewt OS</a></li> - - <li><a class="toctree-l4" href="#description">Description</a></li> - - <li><a class="toctree-l4" href="#insert-sections-as-you-wish">Insert sections as you wish</a></li> - - - </ul> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Porting to other Platforms</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="porting-mynewt-os">Porting Mynewt OS<a class="headerlink" href="#porting-mynewt-os" title="Permanent link">¶</a></h1> -<p>This chapter describes how to adapt Newt OS to different processors. Adapting μC/OS-III to a microprocessor or a microcontroller is called porting. </p> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<h2 id="insert-sections-as-you-wish">Insert sections as you wish<a class="headerlink" href="#insert-sections-as-you-wish" title="Permanent link">¶</a></h2> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../../chapter5/console/" class="btn btn-neutral float-right" title="Console"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../sanity/" class="btn btn-neutral" title="Sanity"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../sanity/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../../chapter5/console/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/chapter4/sanity/index.html ---------------------------------------------------------------------- diff --git a/chapter4/sanity/index.html b/chapter4/sanity/index.html deleted file mode 100644 index 64bcd0a..0000000 --- a/chapter4/sanity/index.html +++ /dev/null @@ -1,530 +0,0 @@ -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Sanity - Mynewt</title> - - - <link rel="shortcut icon" href="../../img/favicon.ico"> - - - <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> - - <link rel="stylesheet" href="../../css/theme.css" type="text/css" /> - <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" /> - <link rel="stylesheet" href="../../css/highlight.css"> - <link href="../../extra.css" rel="stylesheet"> - - - <script> - // Current page data - var mkdocs_page_name = "Sanity"; - </script> - - <script src="../../js/jquery-2.1.1.min.js"></script> - <script src="../../js/modernizr-2.8.3.min.js"></script> - <script type="text/javascript" src="../../js/highlight.pack.js"></script> - <script src="../../js/theme.js"></script> - - -</head> - -<body class="wy-body-for-nav" role="document"> - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> - <div class="wy-side-nav-search"> - <a href="../.." class="icon icon-home"> Mynewt</a> - <div role="search"> - <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - </form> -</div> - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - <ul class="current"> - - <li> - <li class="toctree-l1 "> - <a class="" href="../..">Home</a> - - </li> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter1 - Get Started</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/newt_concepts/">Newt Concepts</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/project1/">Blinky, The First Project</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/how_to_edit_docs/">How to edit docs</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter1/try_markdown/">Sample doc to edit</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter2 - Get Acclimated</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/vocabulary/">Understanding Newt Terms</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project2/">Project 2</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter2/project3/">Project 3</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter3 - Newt Tool</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_ops/">Command structure</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter3/newt_tool_reference/">Command list</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter4 - Newt OS</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../mynewt_os/">Overview</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../context_switch/">Scheduler/Context Switching</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../time/">Time</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../task/">Tasks</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../event_queue/">Event Queues</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../semaphore/">Semaphores</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mutex/">Mutexes</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../memory_pool/">Memory Pools</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../heap/">Heap</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../mbufs/">Mbufs</a> - - </li> - - - - <li class="toctree-l1 current"> - <a class="current" href="./">Sanity</a> - - <ul> - - <li class="toctree-l3"><a href="#sanity">Sanity</a></li> - - <li><a class="toctree-l4" href="#description">Description</a></li> - - <li><a class="toctree-l4" href="#data-structures">Data structures</a></li> - - <li><a class="toctree-l4" href="#list-of-functions">List of Functions</a></li> - - <li><a class="toctree-l4" href="#function-reference">Function Reference</a></li> - - - </ul> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../port_os/">Porting to other Platforms</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter5 - Modules</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/console/">Console</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/shell/">Shell</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/bootloader/">Bootloader</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/filesystem/">File System</a> - - </li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter5/testutil/">Test Utilities</a> - - </li> - - - </ul> -<li> - - <li> - <ul class="subnav"> - <li><span>Chapter6 - Packaging it</span></li> - - - - <li class="toctree-l1 "> - <a class="" href="../../chapter6/dist/">Creating Packages</a> - - </li> - - - </ul> -<li> - - </ul> - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../..">Mynewt</a> - </nav> - - - <div class="wy-nav-content"> - <div class="rst-content"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="../..">Docs</a> »</li> - - - - <li>Chapter4 - Newt OS »</li> - - - - <li>Sanity</li> - <li class="wy-breadcrumbs-aside"> - - </li> - </ul> - <hr/> -</div> - <div role="main"> - <div class="section"> - - <h1 id="sanity">Sanity<a class="headerlink" href="#sanity" title="Permanent link">¶</a></h1> -<p>Insert synopsis here</p> -<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2> -<p>Describe OS feature here </p> -<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2> -<p>Replace this with the list of data structures used, why, any neat features</p> -<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2> -<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="#function-os_sanity_check_init">os_sanity_check_init</a></li> -<li><a href="#function-os_sanity_check_list_lock">os_sanity_check_list_lock</a></li> -<li>add the rest</li> -</ul> -<h2 id="function-reference">Function Reference<a class="headerlink" href="#function-reference" title="Permanent link">¶</a></h2> -<hr /> -<h3 id="function-os_sanity_check_init"><font color="2980b9">function os_sanity_check_init</font><a class="headerlink" href="#function-os_sanity_check_init" title="Permanent link">¶</a></h3> -<pre><code> int - os_sanity_check_init(struct os_sanity_check *sc) - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-os_sanity_check_list_lock"><font color="#2980b9"> function os_sanity_check_list_lock </font><a class="headerlink" href="#function-os_sanity_check_list_lock" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_1">Arguments<a class="headerlink" href="#arguments_1" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_1">Returned values<a class="headerlink" href="#returned-values_1" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_1">Notes<a class="headerlink" href="#notes_1" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> -<h3 id="function-next_one"><font color="#2980b9"> function next_one </font><a class="headerlink" href="#function-next_one" title="Permanent link">¶</a></h3> -<pre><code> <Insert function callout here > - -</code></pre> - -<p><Insert short description></p> -<h4 id="arguments_2">Arguments<a class="headerlink" href="#arguments_2" title="Permanent link">¶</a></h4> -<table> -<thead> -<tr> -<th>Arguments</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>xx</td> -<td>explain argument xx</td> -</tr> -<tr> -<td>yy</td> -<td>explain argument yy</td> -</tr> -</tbody> -</table> -<h4 id="returned-values_2">Returned values<a class="headerlink" href="#returned-values_2" title="Permanent link">¶</a></h4> -<p>List any values returned. -Error codes?</p> -<h4 id="notes_2">Notes<a class="headerlink" href="#notes_2" title="Permanent link">¶</a></h4> -<p>Any special feature/special benefit that we want to tout. -Does it need to be used with some other specific functions? -Any caveats to be careful about (e.g. high memory requirements).</p> -<h4 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">¶</a></h4> -<p><Add text to set up the context for the example here></p> -<pre><code> -<Insert the code snippet here> - -</code></pre> - -<hr /> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="../port_os/" class="btn btn-neutral float-right" title="Porting to other Platforms"/>Next <span class="icon icon-circle-arrow-right"></span></a> - - - <a href="../mbufs/" class="btn btn-neutral" title="Mbufs"><span class="icon icon-circle-arrow-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <!-- Copyright etc --> - - </div> - - Built with <a href="http://www.mkdocs.org";>MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. -</footer> - - </div> - </div> - - </section> - - </div> - -<div class="rst-versions" role="note" style="cursor: pointer"> - <span class="rst-current-version" data-toggle="rst-current-version"> - - - <span><a href="../mbufs/" style="color: #fcfcfc;">« Previous</a></span> - - - <span style="margin-left: 15px"><a href="../port_os/" style="color: #fcfcfc">Next »</a></span> - - </span> -</div> - -</body> -</html>
