Google Git
Sign in
apache / mynewt-site / refs/heads/asf-site / . / v0_9_0 / network / ble / ini_stack / ble_parent_ini / index.html
blob: a318b02c888e78aa233490f1d585ccf82cf0e561 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../../../img/favicon.ico">
<title>Initialize parent task - Apache Mynewt</title>
<link href="../../../../css/bootstrap-3.0.3.min.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=Lato" rel="stylesheet">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<script>
(function(i, s, o, g, r, a, m) {
i["GoogleAnalyticsObject"] = r;
(i[r] =
i[r] ||
function() {
(i[r].q = i[r].q || []).push(arguments);
}),
(i[r].l = 1 * new Date());
(a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m);
})(window, document, "script", "//www.google-analytics.com/analytics.js", "ga");
ga("create", "UA-72162311-1", "auto");
ga("send", "pageview");
</script>
</head>
<body class="Initialize parent task">
<div class="container">
<div class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="/img/logo.png">
</a>
<div class="tagline-cell">
<h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4>
</div>
<div class="news-cell">
<div class="well">
<h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.12.0, Apache NimBLE 1.7.0 </a> released (April 4, 2024)
</div>
</div>
</div>
</div>
<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">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
<li
class=""
>
<a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a>
</li>
<li
class="important"
>
<a href="/quick-start/">Quick Start</a>
</li>
<li
class=""
>
<a href="/about/">About</a>
</li>
<li
class=""
>
<a href="/talks/">Talks</a>
</li>
<li
class="active"
>
<a href="/documentation/">Documentation</a>
</li>
<li
class=""
>
<a href="/download/">Download</a>
</li>
<li
class=""
>
<a href="/community/">Community</a>
</li>
<li
class=""
>
<a href="/events/">Events</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
<ul class="toc-nav">
<li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest">
Version: master
</option>
<option value="/v1_12_0/" >
Version: 1.12.0
</option>
<option value="/v1_11_0/" >
Version: 1.11.0
</option>
<option value="/v1_10_0/" >
Version: 1.10.0
</option>
<option value="/v1_9_0/" >
Version: 1.9.0
</option>
<option value="/v1_8_0/" >
Version: 1.8.0
</option>
<option value="/v1_7_0/" >
Version: 1.7.0
</option>
<option value="/v1_6_0/" >
Version: 1.6.0
</option>
<option value="/v1_5_0/" >
Version: 1.5.0
</option>
<option value="/v1_4_0/" >
Version: 1.4.0
</option>
<option value="/v1_3_0/os/introduction" >
Version: 1.3.0
</option>
<option value="/v1_2_0/os/introduction" >
Version: 1.2.0
</option>
<option value="/v1_1_0/os/introduction" >
Version: 1.1.0
</option>
<option value="/v1_0_0/os/introduction" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" selected="selected" >
Version: 0.9.0
</option>
</select></li>
<li ><a href="../../../../os/introduction/">Mynewt Documentation</a>
<ul>
<li ><a href="../../../../os/get_started/get_started/">Basic Setup</a>
</li>
<li >
<a href="../../../../os/get_started/vocabulary/">Concepts</a>
</li>
<li ><a href="../../../../os/tutorials/tutorials/">Tutorials</a>
</li>
<li ><a href="../../../../os/os_user_guide/">OS User Guide</a>
</li>
<li><a href="
../../ble_intro/
">BLE User Guide</a>
<ul>
<li >
<a href="../../ble_intro/">NimBLE Introduction</a>
</li>
<li >
<a href="../../ble_sec/">NimBLE Security</a>
</li>
<li >
<a href="../../nimble_setup/">Set up application</a>
</li>
<li ><a href="../ble_ini_intro/">Initialize stack</a>
<ul>
<li >
<a href="../ble_add_cpu/">Add cputime</a>
</li>
<li >
<a href="../ble_mempool/">Create mem pool</a>
</li>
<li >
<a href="../ble_devadd/">Initialize device addr</a>
</li>
<li >
<a href="../ble_statpkg/">Initialize stats pkg</a>
</li>
<li >
<a href="../ble_consolepkg/">Initialize console pkg</a>
</li>
<li >
<a href="../ble_controller_ini/">Initialize controller</a>
</li>
<li class="active">
<a href="./">Initialize parent task</a>
</li>
<li >
<a href="../ble_host_ini/">Initialize host</a>
</li>
</ul>
</li>
<li ><a href="../../bletiny_api/">API for bletiny app</a>
</li>
</ul>
</li>
<li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a>
</li>
<li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a>
</li>
<li >
<a href="../../../../known_issues/">Known Issues</a>
</li>
</ul>
</li>
<li><a href="
../../../../faq/how_to_edit_docs/
">Appendix</a>
</li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<div class="doc-header">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/documentation/">Docs</a></li>
<li>&raquo; <a href="network/ble/ini_stack/ble_ini_intro/">Initialize stack</a></li>
<li>&raquo; <a href="network/ble/ble_intro/">BLE User Guide</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; Initialize parent task</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 0.9.0 is not the most recent version of the Apache Mynewt
documentation. Click <a href="/latest">here</a> to read the latest
version.
</p>
</div>
<h2 id="create-the-host-parent-task">Create the host parent task</h2>
<p>The NimBLE stack requires an application task to function. One application
task in particular is designated as the <em>host parent task</em>. In addition to
application-specific work, the host parent task does work for NimBLE by
processing events generated by the host.</p>
<p>The process of creating an OS task is described in the <a href="#../../../../os/tutorials/event_queue/">Add Task
tutorial</a>.</p>
<p><strong>Priority:</strong>
It is up to you which priority to use for the host parent task. Unlike the
controller, the host does not have any strict timing requirements, so the
priority should be based on the application's needs. In the below example, we
use a priority of <strong>1</strong>.</p>
<p><strong>Stack size:</strong>
The host parent task's stack needs to be sufficiently large to handle BLE
operations. This depends on the set of BLE features your application uses, and
on the specifics application callbacks that the stack is configured to use. A
safe value is to use here is <strong>300 words</strong>; that is the value used in the below
example.</p>
<p>The parent task must do two things:</p>
<ul>
<li>Call <code>ble_hs_start()</code> before starting its task loop.</li>
<li>Handle <em>OS_EVENT_T_TIMER</em> events within its task loop.</li>
</ul>
<p>The <code>ble_hs_start()</code> function is declared as follows:</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">int</span> <span style="color: #000000">ble_hs_start</span>(<span style="color: #A90D91">void</span>)
</code></pre></div>
<p>The <code>ble_hs_start()</code> function causes the host to send a sequence of HCI
commands to the controller. This sequence of commands is necessary for the
host and controller to remain in sync.</p>
<p>We add an application task to our example below.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="background-color: #ffffcc"><span style="color: #633820">#include</span> <span style="color: #177500">&quot;os/os.h&quot;</span>
</span>
<span style="background-color: #ffffcc"><span style="color: #177500">/** Application task. */</span>
</span><span style="background-color: #ffffcc"><span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">os_task</span> <span style="color: #000000">app_task</span>;
</span>
<span style="background-color: #ffffcc"><span style="color: #177500">/** Application task event queue. */</span>
</span><span style="background-color: #ffffcc"><span style="color: #A90D91">static</span> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">os_eventq</span> <span style="color: #000000">app_evq</span>;
</span>
<span style="background-color: #ffffcc"><span style="color: #177500">/** Application task stack. */</span>
</span><span style="background-color: #ffffcc"><span style="color: #633820">#define APP_STACK_SIZE (OS_STACK_ALIGN(300))</span>
</span><span style="background-color: #ffffcc"><span style="color: #A90D91">static</span> <span style="color: #000000">os_stack_t</span> <span style="color: #000000">app_stack</span>[<span style="color: #000000">APP_STACK_SIZE</span>];
</span>
<span style="background-color: #ffffcc"><span style="color: #177500">/**</span>
</span><span style="background-color: #ffffcc"><span style="color: #177500"> * Application task.</span>
</span><span style="background-color: #ffffcc"><span style="color: #177500"> */</span>
</span><span style="background-color: #ffffcc"><span style="color: #A90D91">static</span> <span style="color: #A90D91">void</span>
</span><span style="background-color: #ffffcc"><span style="color: #000000">app_task_handler</span>(<span style="color: #A90D91">void</span> <span style="color: #000000">*arg</span>)
</span><span style="background-color: #ffffcc">{
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">os_callout_func</span> <span style="color: #000000">*cf</span>;
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">struct</span> <span style="color: #3F6E75">os_event</span> <span style="color: #000000">*ev</span>;
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
</span>
<span style="background-color: #ffffcc"> <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">ble_hs_start</span>();
</span><span style="background-color: #ffffcc"> <span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
</span>
<span style="background-color: #ffffcc"> <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) {
</span><span style="background-color: #ffffcc"> <span style="color: #000000">ev</span> <span style="color: #000000">=</span> <span style="color: #000000">os_eventq_get</span>(<span style="color: #000000">&amp;app_evq</span>);
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">switch</span> (<span style="color: #000000">ev-&gt;ev_type</span>) {
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">case</span> <span style="color: #000000">OS_EVENT_T_TIMER</span>:
</span><span style="background-color: #ffffcc"> <span style="color: #000000">cf</span> <span style="color: #000000">=</span> (<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">os_callout_func</span> <span style="color: #000000">*</span>)<span style="color: #000000">ev</span>;
</span><span style="background-color: #ffffcc"> <span style="color: #000000">assert</span>(<span style="color: #000000">cf-&gt;cf_func</span>);
</span><span style="background-color: #ffffcc"> <span style="color: #000000">cf-&gt;cf_func</span>(<span style="color: #000000">cf-&gt;cf_arg</span>);
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">break</span>;
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">default</span><span style="color: #000000">:</span>
</span><span style="background-color: #ffffcc"> <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>);
</span><span style="background-color: #ffffcc"> <span style="color: #A90D91">break</span>;
</span><span style="background-color: #ffffcc"> }
</span><span style="background-color: #ffffcc"> }
</span><span style="background-color: #ffffcc">}
</span>
<span style="color: #A90D91">int</span>
<span style="color: #000000">main</span>(<span style="color: #A90D91">void</span>)
{
<span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
<span style="color: #177500">/* Initialize OS */</span>
<span style="color: #000000">os_init</span>();
<span style="color: #177500">/* Set cputime to count at 1 usec increments */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">cputime_init</span>(<span style="color: #1C01CE">1000000</span>);
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="color: #177500">/* Create memory pool for Nimble packets and register with Msys */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mempool_init</span>(<span style="color: #000000">&amp;g_mbuf_mempool</span>, <span style="color: #000000">MBUF_NUM_MBUFS</span>,
<span style="color: #000000">MBUF_MEMBLOCK_SIZE</span>, <span style="color: #000000">&amp;g_mbuf_buffer</span>[<span style="color: #1C01CE">0</span>], <span style="color: #C41A16">&quot;mbuf_pool&quot;</span>);
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_mbuf_pool_init</span>(<span style="color: #000000">&amp;g_mbuf_pool</span>, <span style="color: #000000">&amp;g_mbuf_mempool</span>, <span style="color: #000000">MBUF_MEMBLOCK_SIZE</span>,
<span style="color: #000000">MBUF_NUM_MBUFS</span>);
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">os_msys_register</span>(<span style="color: #000000">&amp;g_mbuf_pool</span>);
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="color: #177500">/* Initialize our device address */</span>
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">0</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0x33</span>;
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">1</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0x22</span>;
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">2</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0x11</span>;
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">3</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0xcc</span>;
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">4</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0xbb</span>;
<span style="color: #000000">g_dev_addr</span>[<span style="color: #1C01CE">5</span>] <span style="color: #000000">=</span> <span style="color: #1C01CE">0x0a</span>;
<span style="color: #177500">/* Initialize the statistics package */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">stats_module_init</span>();
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="color: #177500">/* Initialize the BLE LL */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">ble_ll_init</span>(<span style="color: #1C01CE">0</span>, <span style="color: #1C01CE">7</span>, <span style="color: #1C01CE">260</span>);
<span style="color: #000000">assert</span>(<span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span>);
<span style="background-color: #ffffcc"> <span style="color: #177500">/* Initialize the application task. */</span>
</span><span style="background-color: #ffffcc"> <span style="color: #000000">os_eventq_init</span>(<span style="color: #000000">&amp;app_evq</span>);
</span><span style="background-color: #ffffcc"> <span style="color: #000000">os_task_init</span>(<span style="color: #000000">&amp;app_task</span>, <span style="color: #C41A16">&quot;app&quot;</span>, <span style="color: #000000">app_task_handler</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #1C01CE">1</span>, <span style="color: #000000">OS_WAIT_FOREVER</span>,
</span><span style="background-color: #ffffcc"> <span style="color: #000000">app_stack</span>, <span style="color: #000000">APP_STACK_SIZE</span>);
</span><span style="background-color: #ffffcc">
</span> <span style="color: #177500">/* Start the OS */</span>
<span style="color: #000000">os_start</span>();
<span style="color: #177500">/* os start should never return. If it does, this should be an error */</span>
<span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>);
}
</code></pre></div>
<div class="row">
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
</li>
<li class="pull-right">
</li>
</ul>
</div>
<footer class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<a href="https://www.apache.org/">
<img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
</a>
<p>
Copyright © 2015-2021 The Apache Software Foundation.<br>
<small class="footnote">
Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt
project logo are either registered trademarks or trademarks of the Apache
Software Foundation in the United States and other countries.
</small>
</p>
<a href="">
<img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
<a href="https://www.apache.org/licenses/">
<button class="button-footer-asf">
License
</button>
</a>
<a href="https://www.apache.org/foundation/sponsorship.html">
<button class="button-footer-asf">
Sponsorship
</button>
</a>
<a href="https://www.apache.org/foundation/thanks.html">
<button class="button-footer-asf">
Thanks
</button>
</a>
<a href="https://www.apache.org/security/">
<button class="button-footer-asf">
Security
</button>
</a>
<a href="https://apache.org/events/current-event">
<button class="button-footer-asf">
ASF Events
</button>
</a>
</footer>
</div>
</div>
</div>
<script src="../../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../../js/highlight.pack.js"></script>
<script src="../../../../js/base.js"></script>
<script src="../../../../js/custom.js"></script>
<script src="search/main.js"></script>
</body>
</html>