http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/develop/os/core_os/mbuf/os_mbuf_get/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_get/index.html b/develop/os/core_os/mbuf/os_mbuf_get/index.html index 991e9c9..8de8bf2 100644 --- a/develop/os/core_os/mbuf/os_mbuf_get/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_get/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_get/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_get - Apache Mynewt</title> + <title>os_mbuf_get - 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_mbuf_get"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_get"><font color="#F2853F" style="font-size:24pt">os_mbuf_get</font></h2> @@ -881,7 +892,7 @@ </pre></div> -<p>Get an mbuf from the mbuf pool. The mbuf is allocated, and initialized prior to being returned. The <em>leadingspace</em> parameter allows the user to specify the amount of leading space in the allocated mbuf.</p> +<p>Get an mbuf from the mbuf pool. The mbuf is allocated, and initialized prior to being returned. The <code>eadingspace</code> parameter allows the user to specify the amount of leading space in the allocated mbuf.</p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -893,18 +904,18 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf pool from which to allocate mbuf</td> </tr> <tr> -<td>leadingspace</td> +<td><code>leadingspace</code></td> <td>Amount of leading space in allocated mbuf. Request cannot exceed the mbuf data buffer size.</td> </tr> </tbody> </table> <p><br></p> <h4 id="returned-values">Returned values</h4> -<p>Returns a pointer to the allocated mbuf or NULL if there are no mbufs available or <em>leadingspace</em> was too large. +<p>Returns a pointer to the allocated mbuf or <strong>NULL</strong> if there are no mbufs available or <code>leadingspace</code> was too large. <br></p> <h4 id="notes">Notes</h4> <p>In most typical applications, the application developer does not need to call <code>os_mbuf_get()</code>; the other API will do this automatically. However, this API is provided for convenience as mbufs can also be a simple way to allocate temporary chunks of memory.</p> @@ -943,34 +954,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/mbuf/os_mbuf_get_pkthdr/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html b/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html index 60f4266..961282b 100644 --- a/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_get_pkthdr/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_get_pkthdr/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_get_pkthdr - Apache Mynewt</title> + <title>os_mbuf_get_pkthdr - 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_mbuf_get_pkthdr"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_get_pkthdr"><font color="#F2853F" style="font-size:24pt">os_mbuf_get_pkthdr</font></h2> @@ -881,7 +892,7 @@ </pre></div> -<p>Allocates a packet header mbuf from the mbuf pool pointed to by <em>omp</em>. Adds a user header of length <em>pkthdr_len</em> to packet header mbuf.</p> +<p>Allocates a packet header mbuf from the mbuf pool pointed to by <code>omp</code>. Adds a user header of length <code>pkthdr_len</code> to packet header mbuf.</p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -893,21 +904,21 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf pool from which to allocate mbuf</td> </tr> <tr> -<td>pkthdr_len</td> +<td><code>pkthdr_len</code></td> <td>The user header packet length to allocate for the packet header mbuf</td> </tr> </tbody> </table> <p><br></p> <h4 id="returned-values">Returned values</h4> -<p>Returns a pointer to the allocated mbuf or NULL if there are no mbufs available or the user packet header was too large.</p> +<p>Returns a pointer to the allocated mbuf or <strong>NULL</strong> if there are no mbufs available or the user packet header was too large.</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>The packet header mbuf returned will have its data pointer incremented by the sizeof(struct os_mbuf_pkthdr) as well as the amount of user header data (i.e. <em>pkthdr_len</em>). In other words, the data pointer is offset from the start of the mbuf by: sizeof(struct os_mbuf) + sizeof(struct os_mbuf_pkthdr) + pkthdr_len. The <code>om_pkthdr_len</code> element in the allocated mbuf is set to: sizeof(struct os_mbuf_pkthdr) + pkthdr_len.</p> +<p>The packet header mbuf returned will have its data pointer incremented by the <code>sizeof(struct os_mbuf_pkthdr)</code> as well as the amount of user header data (i.e. <code>pkthdr_len</code>). In other words, the data pointer is offset from the start of the mbuf by: <code>sizeof(struct os_mbuf)</code> + <code>sizeof(struct os_mbuf_pkthdr)</code> + <code>pkthdr_len</code>. The <code>om_pkthdr_len</code> element in the allocated mbuf is set to: <code>sizeof(struct os_mbuf_pkthdr)</code> + <code>pkthdr_len</code>.</p> <p><br></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_mbuf</span> <span style="color: #000000">*om</span>; @@ -944,34 +955,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/mbuf/os_mbuf_memcmp/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html b/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html index 8bfc2f8..107363a 100644 --- a/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_memcmp/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_memcmp/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_memcmp - Apache Mynewt</title> + <title>os_mbuf_memcmp - 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_mbuf_memcmp"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_memcmp"><font color="#F2853F" style="font-size:24pt">os_mbuf_memcmp</font></h2> @@ -893,19 +904,19 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf</td> </tr> <tr> -<td>off</td> +<td><code>off</code></td> <td>Offset, in bytes, from start of mbuf to start of comparison</td> </tr> <tr> -<td>data</td> +<td><code>data</code></td> <td>Pointer to flat data buffer to compare</td> </tr> <tr> -<td>len</td> +<td><code>len</code></td> <td>Number of bytes to compare</td> </tr> </tbody> @@ -915,7 +926,7 @@ <p>A value of zero means the memory regions are identical; all other values represent either an error or a value returned from memcmp. </p> <p><br></p> <h4 id="notes">Notes</h4> -<p>This function will compare bytes starting from <em>off</em> bytes from the start of the mbuf chain with a data buffer.</p> +<p>This function will compare bytes starting from <code>off</code> bytes from the start of the mbuf chain with a data buffer.</p> <p><br></p> <h4 id="example">Example</h4> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>; @@ -953,34 +964,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/mbuf/os_mbuf_off/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_off/index.html b/develop/os/core_os/mbuf/os_mbuf_off/index.html index ecd914c..49da5b5 100644 --- a/develop/os/core_os/mbuf/os_mbuf_off/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_off/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_off/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_off - Apache Mynewt</title> + <title>os_mbuf_off - 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_mbuf_off"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_off"><font color="#F2853F" style="font-size:24pt">os_mbuf_off</font></h2> @@ -881,7 +892,7 @@ </pre></div> -<p>Given an offset in the packet (i.e. user data byte offset in the mbuf chain), return the mbuf and the offset in that mbuf where byte 'off' is located. Note that the offset is 'returned' in <em>out_off</em>.</p> +<p>Given an offset in the packet (i.e. user data byte offset in the mbuf chain), return the mbuf and the offset in that mbuf where byte 'off' is located. Note that the offset is <em>returned</em> in <code>out_off</code>.</p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -893,26 +904,26 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf</td> </tr> <tr> -<td>off</td> +<td><code>off</code></td> <td>Location in mbuf chain of desired byte offset</td> </tr> <tr> -<td>out_off</td> +<td><code>out_off</code></td> <td>Pointer to storage for the relative offset of the absolute location in the returned mbuf</td> </tr> </tbody> </table> <p><br></p> <h4 id="returned-values">Returned values</h4> -<p>NULL if the offset is not within the mbuf chain or <em>om</em> points to NULL.</p> +<p><strong>NULL</strong> if the offset is not within the mbuf chain or <code>om</code> points to <strong>NULL</strong>.</p> <p><br></p> <h4 id="notes">Notes</h4> <p>The user is allowed to call this function with the length of the mbuf chain but no greater. This allows the user to get the mbuf and offset (in that mbuf) where the next user data byte should be written.</p> -<p>While this api is provided to the user, other API are expected to be used by the applciation developer (i.e. <code>os_mbuf_append()</code> or <code>os_mbuf_copyinto()</code>). +<p>While this api is provided to the user, other APIs are expected to be used by the applciation developer (i.e. <code>os_mbuf_append()</code> or <code>os_mbuf_copyinto()</code>). <br></p> <h4 id="example">Example</h4> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">int</span> <span style="color: #000000">relative_offset</span>; @@ -960,34 +971,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/mbuf/os_mbuf_pool_init/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html b/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html index 66b32e5..894e30e 100644 --- a/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_pool_init/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_pool_init/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_pool_init - Apache Mynewt</title> + <title>os_mbuf_pool_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_mbuf_pool_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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_pool_init"><font color="#F2853F" style="font-size:24pt">os_mbuf_pool_init</font></h2> @@ -894,19 +905,19 @@ </thead> <tbody> <tr> -<td>omp</td> +<td><code>omp</code></td> <td>Pointer to mbuf pool to initialize</td> </tr> <tr> -<td>mp</td> +<td><code>mp</code></td> <td>Pointer to memory pool used by mbuf pool</td> </tr> <tr> -<td>buf_len</td> +<td><code>buf_len</code></td> <td>The size of the memory blocks in the memory pool used by the mbuf pool</td> </tr> <tr> -<td>nbufs</td> +<td><code>nbufs</code></td> <td>The number of mbufs in the pool</td> </tr> </tbody> @@ -916,7 +927,7 @@ <p>0 on success; all other values indicate an error.</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>The parameter <em>buf_len</em> is the total size of the memory block. This must accommodate the os_mbuf structure, the os_mbuf_pkthdr structure, any user headers plus the desired amount of user data.</p> +<p>The parameter <code>buf_len</code> is the total size of the memory block. This must accommodate the <code>os_mbuf</code> structure, the <code>os_mbuf_pkthdr</code> structure, any user headers plus the desired amount of user data.</p> <p><br></p> <h4 id="example">Example</h4> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define MBUF_PKTHDR_OVERHEAD sizeof(struct os_mbuf_pkthdr) + sizeof(struct user_hdr)</span> @@ -971,34 +982,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/mbuf/os_mbuf_prepend/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_prepend/index.html b/develop/os/core_os/mbuf/os_mbuf_prepend/index.html index e3f588f..68f2116 100644 --- a/develop/os/core_os/mbuf/os_mbuf_prepend/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_prepend/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_prepend/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_prepend - Apache Mynewt</title> + <title>os_mbuf_prepend - 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_mbuf_prepend"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_prepend"><font color="#F2853F" style="font-size:24pt">os_mbuf_prepend</font></h2> @@ -893,21 +904,21 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf</td> </tr> <tr> -<td>len</td> +<td><code>len</code></td> <td>Length, in bytes, to prepend</td> </tr> </tbody> </table> <p><br></p> <h4 id="returned-values">Returned values</h4> -<p>Pointer to mbuf at head of chain; NULL if not enough mbufs were available to accommodate <em>len</em>.</p> +<p>Pointer to mbuf at head of chain; <strong>NULL</strong> if not enough mbufs were available to accommodate <code>len</code>.</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>If <em>om</em> is a packet header mbuf, the total length of the packet is adjusted by <em>len</em>. Note that the returned mbuf may not point to <em>om</em> if insufficient leading space was available in <em>om</em>.</p> +<p>If <code>om</code> is a packet header mbuf, the total length of the packet is adjusted by <code>len</code>. Note that the returned mbuf may not point to <code>om</code> if insufficient leading space was available in <code>om</code>.</p> <p><br></p> <h4 id="example">Example</h4> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">pktlen</span>; @@ -951,34 +962,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/mbuf/os_mbuf_pullup/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/mbuf/os_mbuf_pullup/index.html b/develop/os/core_os/mbuf/os_mbuf_pullup/index.html index 34bdb6c..dac6232 100644 --- a/develop/os/core_os/mbuf/os_mbuf_pullup/index.html +++ b/develop/os/core_os/mbuf/os_mbuf_pullup/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/mbuf/os_mbuf_pullup/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>os_mbuf_pullup - Apache Mynewt</title> + <title>os_mbuf_pullup - 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_mbuf_pullup"> + <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 @@ + + + + @@ -846,14 +863,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> @@ -873,7 +885,6 @@ </ul> </div> - </div> </div> <h2 id="os_mbuf_pullup"><font color="#F2853F" style="font-size:24pt">os_mbuf_pullup</font></h2> @@ -881,7 +892,7 @@ </pre></div> -<p>Rearrange an mbuf chain so that len bytes are contiguous, and in the data area of an mbuf (so that OS_MBUF_DATA() will work on a structure of size len.) Returns the resulting mbuf chain on success, free's it and returns NULL on failure.</p> +<p>Rearrange an mbuf chain so that len bytes are contiguous, and in the data area of an mbuf (so that <code>OS_MBUF_DATA()</code> will work on a structure of size <code>len</code>.) Returns the resulting mbuf chain on success, free's it and returns <strong>NULL</strong> on failure.</p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -893,18 +904,18 @@ </thead> <tbody> <tr> -<td>om</td> +<td><code>om</code></td> <td>Pointer to mbuf</td> </tr> <tr> -<td>len</td> +<td><code>len</code></td> <td>Length, in bytes, to pullup (make contiguous in mbuf)</td> </tr> </tbody> </table> <p><br></p> <h4 id="returned-values">Returned values</h4> -<p>Pointer to mbuf at head of chain; NULL if not enough mbufs were available to accommodate <em>len</em> or if the requested pullup size was too large.</p> +<p>Pointer to mbuf at head of chain; <strong>NULL</strong> if not enough mbufs were available to accommodate <code>len</code> or if the requested pullup size was too large.</p> <p><br></p> <h4 id="notes">Notes</h4> <p>Hopefully it is apparent to the user that you cannot pullup more bytes than the mbuf can accommodate. Pullup does not allocate more than one mbuf; the entire pullup length must be contained within a single mbuf.</p> @@ -950,34 +961,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/memory_pool/OS_MEMPOOL_BYTES/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/memory_pool/OS_MEMPOOL_BYTES/index.html b/develop/os/core_os/memory_pool/OS_MEMPOOL_BYTES/index.html index 66e3c57..9dbeb33 100644 --- a/develop/os/core_os/memory_pool/OS_MEMPOOL_BYTES/index.html +++ b/develop/os/core_os/memory_pool/OS_MEMPOOL_BYTES/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/memory_pool/OS_MEMPOOL_BYTES/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>OS_MEMPOOL_BYTES - Apache Mynewt</title> + <title>OS_MEMPOOL_BYTES - 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_MEMPOOL_BYTES"> + <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 @@ + + + + @@ -665,14 +682,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> @@ -692,7 +704,6 @@ </ul> </div> - </div> </div> <h2 id="os_mempool_bytes"><font color="#F2853F" style="font-size:24pt">OS_MEMPOOL_BYTES</font></h2> @@ -700,7 +711,7 @@ </pre></div> -<p>Calculates how many bytes of memory is used by <em>n</em> number of elements, when individual element size is <em>blksize</em> bytes.</p> +<p>Calculates how many bytes of memory is used by <code>n</code> number of elements, when individual element size is <code>blksize</code> bytes.</p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -712,11 +723,11 @@ </thead> <tbody> <tr> -<td>n</td> +<td><code>n</code></td> <td>Number of elements</td> </tr> <tr> -<td>blksize</td> +<td><code>blksize</code></td> <td>Size of an element is number of bytes</td> </tr> </tbody> @@ -725,7 +736,7 @@ <p>The number of bytes used by the memory pool.</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>OS_MEMPOOL_BYTES is a macro and not a function.</p> +<p><code>OS_MEMPOOL_BYTES</code> is a macro and not a function.</p> <p><br></p> <h4 id="example">Example</h4> <p>Here we allocate memory to be used as a pool.</p> @@ -761,34 +772,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/memory_pool/OS_MEMPOOL_SIZE/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/memory_pool/OS_MEMPOOL_SIZE/index.html b/develop/os/core_os/memory_pool/OS_MEMPOOL_SIZE/index.html index 913512f..d7bf404 100644 --- a/develop/os/core_os/memory_pool/OS_MEMPOOL_SIZE/index.html +++ b/develop/os/core_os/memory_pool/OS_MEMPOOL_SIZE/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/memory_pool/OS_MEMPOOL_SIZE/";> --> <link rel="shortcut icon" href="../../../../img/favicon.ico"> - <title>OS_MEMPOOL_SIZE - Apache Mynewt</title> + <title>OS_MEMPOOL_SIZE - 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_MEMPOOL_SIZE"> + <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 @@ + + + + @@ -665,14 +682,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> @@ -692,7 +704,6 @@ </ul> </div> - </div> </div> <h2 id="os_mempool_size"><font color="#F2853F" style="font-size:24pt">OS_MEMPOOL_SIZE</font></h2> @@ -700,9 +711,9 @@ </pre></div> -<p>Calculates the number of os_membuf_t elements used by <em>n</em> blocks of size <em>blksize</em> bytes.</p> -<p>Note that os_membuf_t is used so that memory blocks are aligned on OS_ALIGNMENT boundaries.</p> -<p>The <em>blksize</em> variable is the minimum number of bytes required for each block; the actual block size is padded so that each block is aligned on OS_ALIGNMENT boundaries. </p> +<p>Calculates the number of <code>os_membuf_t</code> elements used by <code>n</code> blocks of size <code>blksize</code> bytes.</p> +<p>Note that <code>os_membuf_t</code> is used so that memory blocks are aligned on <code>OS_ALIGNMENT</code> boundaries.</p> +<p>The <code>blksize</code> variable is the minimum number of bytes required for each block; the actual block size is padded so that each block is aligned on <code>OS_ALIGNMENT</code> boundaries. </p> <p><br></p> <h4 id="arguments">Arguments</h4> <table> @@ -714,23 +725,23 @@ </thead> <tbody> <tr> -<td>n</td> +<td><code>n</code></td> <td>Number of elements</td> </tr> <tr> -<td>blksize</td> +<td><code>blksize</code></td> <td>Size of an element is number of bytes</td> </tr> </tbody> </table> <h4 id="returned-values">Returned values</h4> -<p>The number of os_membuf_t elements used by the memory pool. Note that os_membuf_t is defined to be a unsigned, 32-bit integer when OS_ALIGNMENT is 4 and an unsigned, 64-bit integer when OS_ALIGNMENT is 8.</p> +<p>The number of <code>os_membuf_t</code> elements used by the memory pool. Note that <code>os_membuf_t</code> is defined to be a unsigned, 32-bit integer when <code>OS_ALIGNMENT</code> is 4 and an unsigned, 64-bit integer when <code>OS_ALIGNMENT</code> is 8.</p> <p><br></p> <h4 id="notes">Notes</h4> -<p>OS_MEMPOOL_SIZE is a macro and not a function.</p> +<p><code>OS_MEMPOOL_SIZE</code> is a macro and not a function.</p> <p><br></p> <h4 id="example">Example</h4> -<p>Here we define a memory buffer to be used by a memory pool using OS_MEMPOOL_SIZE</p> +<p>Here we define a memory buffer to be used by a memory pool using <code>OS_MEMPOOL_SIZE</code></p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#define NUM_BLOCKS (16)</span> <span style="color: #633820">#define BLOCK_SIZE (32)</span> @@ -761,34 +772,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/memory_pool/memory_pool/index.html ---------------------------------------------------------------------- diff --git a/develop/os/core_os/memory_pool/memory_pool/index.html b/develop/os/core_os/memory_pool/memory_pool/index.html index 776b116..621e8fb 100644 --- a/develop/os/core_os/memory_pool/memory_pool/index.html +++ b/develop/os/core_os/memory_pool/memory_pool/index.html @@ -10,15 +10,14 @@ <link rel="canonical" href="http://mynewt.apache.org/os/core_os/memory_pool/memory_pool/";> --> <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,7 +658,6 @@ </ul> </div> - </div> </div> <h1 id="memory-pools">Memory Pools</h1> @@ -660,7 +671,7 @@ <p><br> The next order of business is to allocate the memory used by the memory pool. This memory can either be statically allocated (i.e. a global variable) or dynamically allocated (i.e. from the heap). When determining the amount of memory required for the memory pool, simply multiplying the number of blocks by the size of each block is not sufficient as the OS may have alignment requirements. The alignment size definition is named <code>OS_ALIGNMENT</code> and can be found in os_arch.h as it is architecture specific. The memory block alignment is usually for efficiency but may be due to other reasons. Generally, blocks are aligned on 32-bit boundaries. Note that memory blocks must also be of sufficient size to hold a list pointer as this is needed to chain memory blocks on the free list.</p> <p>In order to simplify this for the user two macros have been provided: <code>OS_MEMPOOL_BYTES(n, blksize)</code> and <code>OS_MEMPOOL_SIZE(n, blksize)</code>. The first macro returns the number of bytes needed for the memory pool while the second returns the number of <code>os_membuf_t</code> elements required by the memory pool. The <code>os_membuf_t</code> type is used to guarantee that the memory buffer used by the memory pool is aligned on the correct boundary. </p> -<p>Here are some examples. Note that if a custom malloc implementation is used it must guarantee that the memory buffer used by the pool is allocated on the correct boundary (i.e. OS_ALIGNMENT).</p> +<p>Here are some examples. Note that if a custom malloc implementation is used it must guarantee that the memory buffer used by the pool is allocated on the correct boundary (i.e. <code>OS_ALIGNMENT</code>).</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">*my_memory_buffer</span>; <span style="color: #000000">my_memory_buffer</span> <span style="color: #000000">=</span> <span style="color: #000000">malloc</span>(<span style="color: #000000">OS_MEMPOOL_BYTES</span>(<span style="color: #000000">NUM_BLOCKS</span>, <span style="color: #000000">BLOCK_SIZE</span>)); </pre></div> @@ -788,34 +799,22 @@ Once the memory pool has been initialized the developer can allocate memory bloc </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>
