http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/os_start/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/os_start/index.html b/latest/os/core_os/os_start/index.html deleted file mode 100644 index ccf78aa..0000000 --- a/latest/os/core_os/os_start/index.html +++ /dev/null @@ -1,783 +0,0 @@ -<!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="canonical" href="http://mynewt.apache.org/os/core_os/os_start/";> --> - <link rel="shortcut icon" href="../../../img/favicon.ico"> - - <title>os_start - Apache Mynewt</title> - - <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";> - <link href="../../../extra.css" rel="stylesheet"> - - <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> - <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> - <![endif]--> - - - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-72162311-1', 'auto'); - ga('send', 'pageview'); - </script> - - </head> - - - <body class="os_start"> - - - <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.0.0-b1</a> released (Dec 13, 2016) - </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="/latest/os/introduction">Documentation</a> - </li> - <li - class="" -> - <a href="/download/">Download</a> - </li> - <li - class="" -> - <a href="/community/">Community</a> - </li> - <li - class="" -> - <a href="/events/">Events</a> - </li> - </ul> - - <!-- Search, Navigation and Repo links --> - <ul class="nav navbar-nav navbar-right"> - - </ul> - </div> - </div> -</nav> - - - - <div class="container"> - - <div class="row"> - <div class="col-md-3 v2-sidebar 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="/develop/os/introduction" - selected="selected" - > - Version: develop (latest) - </option> - - <option - value="/v0_9_0/os/introduction" - - > - Version: 0.9.0 - </option> - -</select> -</li> - - - - - - - - - - - - - - - - - - - - - - <li ><a href="../../introduction/">Mynewt Documentation</a> - - - <ul> - - - - - - - - <li ><a href="../../get_started/get_started/">Basic Setup</a> - - - </li> - - - - - - <li > - <a href="../../get_started/vocabulary/">Concepts</a> - </li> - - - - - - - - <li ><a href="../../tutorials/tutorials/">Tutorials</a> - - - </li> - - - - - - - - <li ><a href="../../os_user_guide/">OS User Guide</a> - - - <ul> - - - - - - - - <li ><a href="../mynewt_os/">OS Core</a> - - - <ul> - - - - - - - - <li><a href=" - ../os_init/ -">System-level Functions</a> - - - <ul> - - - - <li > - <a href="../os_init/">os_init</a> - </li> - - - - - - <li class="active"> - <a href="./">os_start</a> - </li> - - - - - - <li > - <a href="../os_started/">os_started</a> - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../context_switch/context_switch/">Scheduler</a> - - - </li> - - - - - - - - <li ><a href="../time/os_time/">Time</a> - - - </li> - - - - - - - - <li ><a href="../task/task/">Tasks</a> - - - </li> - - - - - - - - <li ><a href="../event_queue/event_queue/">Event Queues</a> - - - </li> - - - - - - - - <li ><a href="../semaphore/semaphore/">Semaphores</a> - - - </li> - - - - - - - - <li ><a href="../mutex/mutex/">Mutexes</a> - - - </li> - - - - - - - - <li ><a href="../memory_pool/memory_pool/">Memory Pools</a> - - - </li> - - - - - - - - <li ><a href="../heap/heap/">Heap</a> - - - </li> - - - - - - - - <li><a href=" - - - ../mbuf/mbuf/ - -">Memory Buffers</a> - - - </li> - - - - - - - - <li ><a href="../sanity/sanity/">Sanity</a> - - - </li> - - - - - - - - <li ><a href="../callout/callout/">Callouts</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../porting/port_os/">Porting to your Platform</a> - - - </li> - - - - - - - - <li ><a href="../../modules/console/console/">Console</a> - - - </li> - - - - - - - - <li ><a href="../../modules/shell/shell/">Shell</a> - - - </li> - - - - - - - - <li ><a href="../../modules/split/split/">Split Images</a> - - - </li> - - - - - - - - <li ><a href="../../modules/bootloader/bootloader/">Bootloader</a> - - - </li> - - - - - - - - <li><a href=" - - - ../../modules/fs/fs/fs/ - -">File System</a> - - - </li> - - - - - - - - <li ><a href="../../modules/hal/hal/">Hardware Abstraction Layer</a> - - - </li> - - - - - - - - <li ><a href="../../modules/drivers/driver/">Drivers</a> - - - </li> - - - - - - - - <li ><a href="../../modules/testutil/testutil/">Test Utilities</a> - - - </li> - - - - - - - - <li ><a href="../../modules/devmgmt/newtmgr/">Device Management with Newt Manager</a> - - - </li> - - - - - - - - <li ><a href="../../modules/imgmgr/imgmgr/">Image Manager</a> - - - </li> - - - - - - <li > - <a href="../../modules/baselibc/">Baselibc library</a> - </li> - - - - - - - - <li ><a href="../../modules/elua/elua/">Embedded Lua</a> - - - </li> - - - - - - - - <li ><a href="../../modules/json/json/">JSON</a> - - - </li> - - - - - - - - <li ><a href="../../modules/fcb/fcb/">Flash Circular Buffer</a> - - - </li> - - - - - - - - <li ><a href="../../modules/stats/stats/">Stats</a> - - - </li> - - - - - - - - <li ><a href="../../modules/logs/logs/">Logs</a> - - - </li> - - - - - - - - <li ><a href="../../modules/sysinitconfig/sysinitconfig/">System Configuration And Initialization</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../network/ble/ble_intro/ -">BLE User Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../newt/newt_intro/">Newt Tool Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../faq/how_to_edit_docs/ -">Appendix</a> - - - </li> - - - - </ul> -</div></div> - - <div class="col-md-9" role="main"> - <div class="doc-header"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs pull-right"> - <li><a href="/latest/os/introduction">Docs</a></li> - - - - <li>» <a href="../mynewt_os/">OS Core</a></li> - - - - <li>» <a href="../os_init/">System-level Functions</a></li> - - - - <li>» os_start</li> - - - - </ul> -</div> - </div> - - <h2 id="os_start"><font color="#F2853F" style="font-size:24pt">os_start</font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">os_start</span>(<span style="color: #A90D91">void</span>) -</pre></div> - - -<p>Starts the OS by initializing and enabling the OS time tick and starting the scheduler.</p> -<p>This function does not return.</p> -<p><br></p> -<h4 id="arguments">Arguments</h4> -<p>None</p> -<p><br></p> -<h4 id="returned-values">Returned values</h4> -<p>None (does not return).</p> -<p><br></p> -<h4 id="notes">Notes</h4> -<p>Once <code>os_start()</code> has been called, context is switched to the highest priority task that was initialized prior to calling <code>os_start()</code>.</p> - - <div class="row"> - - - - -<ul class="nav nav-pills" style="margin-bottom: 10px"> - <li> - - <a href=../os_init/> - <span class="fa fa-arrow-left"></span> - Previous: os_init - </a> - - </li> - <li class="pull-right"> - - <a href=../os_started/> - Next: os_started - <span class="fa fa-arrow-right"></span> - </a> - - </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"> - <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> - - <script src="../../../js/jquery-1.10.2.min.js"></script> - <script src="../../../js/bootstrap-3.0.3.min.js"></script> - <script src="../../../js/highlight.pack.js"></script> - <script src="../../../js/base.js"></script> - <script src="../../../js/custom.js"></script> - - </body> -</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/os_started/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/os_started/index.html b/latest/os/core_os/os_started/index.html index 2c5488f..2ed979a 100644 --- a/latest/os/core_os/os_started/index.html +++ b/latest/os/core_os/os_started/index.html @@ -255,30 +255,14 @@ <li><a href=" - ../os_init/ -">System-level Functions</a> + ./ +">Functions</a> <ul> - <li > - <a href="../os_init/">os_init</a> - </li> - - - - - - <li > - <a href="../os_start/">os_start</a> - </li> - - - - - <li class="active"> <a href="./">os_started</a> </li> @@ -698,7 +682,7 @@ - <li>» <a href="../os_init/">System-level Functions</a></li> + <li>» Functions</li> @@ -731,9 +715,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../os_start/> + <a href=../mynewt_os/> <span class="fa fa-arrow-left"></span> - Previous: os_start + Previous: OS Core </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/os_sanity_check_init/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/os_sanity_check_init/index.html b/latest/os/core_os/sanity/os_sanity_check_init/index.html index 9e9ff90..82a0c74 100644 --- a/latest/os/core_os/sanity/os_sanity_check_init/index.html +++ b/latest/os/core_os/sanity/os_sanity_check_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/os_sanity_check_register/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/os_sanity_check_register/index.html b/latest/os/core_os/sanity/os_sanity_check_register/index.html index fce625c..15bc704 100644 --- a/latest/os/core_os/sanity/os_sanity_check_register/index.html +++ b/latest/os/core_os/sanity/os_sanity_check_register/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/os_sanity_check_reset/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/os_sanity_check_reset/index.html b/latest/os/core_os/sanity/os_sanity_check_reset/index.html index 9694c56..6d37ea7 100644 --- a/latest/os/core_os/sanity/os_sanity_check_reset/index.html +++ b/latest/os/core_os/sanity/os_sanity_check_reset/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/os_sanity_task_checkin/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/os_sanity_task_checkin/index.html b/latest/os/core_os/sanity/os_sanity_task_checkin/index.html index 6ad2409..cebba9e 100644 --- a/latest/os/core_os/sanity/os_sanity_task_checkin/index.html +++ b/latest/os/core_os/sanity/os_sanity_task_checkin/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/os_sanity_task_init/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/os_sanity_task_init/index.html b/latest/os/core_os/sanity/os_sanity_task_init/index.html index 6da2021..1ff4cec 100644 --- a/latest/os/core_os/sanity/os_sanity_task_init/index.html +++ b/latest/os/core_os/sanity/os_sanity_task_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/sanity/sanity/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/sanity/sanity/index.html b/latest/os/core_os/sanity/sanity/index.html index a28c927..929e517 100644 --- a/latest/os/core_os/sanity/sanity/index.html +++ b/latest/os/core_os/sanity/sanity/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/semaphore/os_sem_init/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/semaphore/os_sem_init/index.html b/latest/os/core_os/semaphore/os_sem_init/index.html index b13cbf5..bac433d 100644 --- a/latest/os/core_os/semaphore/os_sem_init/index.html +++ b/latest/os/core_os/semaphore/os_sem_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/semaphore/os_sem_pend/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/semaphore/os_sem_pend/index.html b/latest/os/core_os/semaphore/os_sem_pend/index.html index db7ea8b..8587672 100644 --- a/latest/os/core_os/semaphore/os_sem_pend/index.html +++ b/latest/os/core_os/semaphore/os_sem_pend/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/semaphore/os_sem_release/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/semaphore/os_sem_release/index.html b/latest/os/core_os/semaphore/os_sem_release/index.html index ebe25c9..f5d2c09 100644 --- a/latest/os/core_os/semaphore/os_sem_release/index.html +++ b/latest/os/core_os/semaphore/os_sem_release/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/semaphore/semaphore/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/semaphore/semaphore/index.html b/latest/os/core_os/semaphore/semaphore/index.html index 955cc8a..ebeb8c6 100644 --- a/latest/os/core_os/semaphore/semaphore/index.html +++ b/latest/os/core_os/semaphore/semaphore/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/task/os_task_count/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/task/os_task_count/index.html b/latest/os/core_os/task/os_task_count/index.html index dc76b5c..aeaa534 100644 --- a/latest/os/core_os/task/os_task_count/index.html +++ b/latest/os/core_os/task/os_task_count/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/task/os_task_info_get_next/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/task/os_task_info_get_next/index.html b/latest/os/core_os/task/os_task_info_get_next/index.html index 509dd19..dcbb7a9 100644 --- a/latest/os/core_os/task/os_task_info_get_next/index.html +++ b/latest/os/core_os/task/os_task_info_get_next/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/task/os_task_init/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/task/os_task_init/index.html b/latest/os/core_os/task/os_task_init/index.html index fee0ee3..6246c4c 100644 --- a/latest/os/core_os/task/os_task_init/index.html +++ b/latest/os/core_os/task/os_task_init/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/task/task/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/task/task/index.html b/latest/os/core_os/task/task/index.html index b9d86d3..103d863 100644 --- a/latest/os/core_os/task/task/index.html +++ b/latest/os/core_os/task/task/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> @@ -772,23 +772,21 @@ task simply toggles an LED at a one second interval.</p> } <span style="color: #177500">/* This is the main function for the project */</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: #A90D91">int</span> <span style="color: #000000">main</span>(<span style="color: #A90D91">int</span> <span style="color: #000000">argc</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">**argv</span>) +{ - <span style="color: #177500">/* Initialize OS */</span> - <span style="color: #000000">os_init</span>(); + <span style="color: #177500">/* Perform system and package initialization */</span> + <span style="color: #000000">sysinit</span>(); <span style="color: #177500">/* Initialize the task */</span> <span style="color: #000000">os_task_init</span>(<span style="color: #000000">&my_task</span>, <span style="color: #C41A16">"my_task"</span>, <span style="color: #000000">my_task_func</span>, <span style="color: #A90D91">NULL</span>, <span style="color: #000000">MY_TASK_PRIO</span>, <span style="color: #000000">OS_WAIT_FOREVER</span>, <span style="color: #000000">my_task_stack</span>, <span style="color: #000000">MY_STACK_SIZE</span>); - <span style="color: #177500">/* Start the OS */</span> - <span style="color: #000000">os_start</span>(); - - <span style="color: #177500">/* os start should never return. If it does, this should be an error */</span> - <span style="color: #000000">assert</span>(<span style="color: #1C01CE">0</span>); - - <span style="color: #A90D91">return</span> <span style="color: #000000">rc</span>; + <span style="color: #177500">/* Process events from the default event queue. */</span> + <span style="color: #A90D91">while</span> (<span style="color: #1C01CE">1</span>) { + <span style="color: #000000">os_eventq_run</span>(<span style="color: #000000">os_eventq_dflt_get</span>()); + } + <span style="color: #177500">/* main never returns */</span> } </pre></div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_gettimeofday/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_gettimeofday/index.html b/latest/os/core_os/time/os_gettimeofday/index.html index 600db2d..75108f7 100644 --- a/latest/os/core_os/time/os_gettimeofday/index.html +++ b/latest/os/core_os/time/os_gettimeofday/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_settimeofday/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_settimeofday/index.html b/latest/os/core_os/time/os_settimeofday/index.html index 6a8445f..b9ab9c4 100644 --- a/latest/os/core_os/time/os_settimeofday/index.html +++ b/latest/os/core_os/time/os_settimeofday/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_time/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_time/index.html b/latest/os/core_os/time/os_time/index.html index 374ce60..0b3684f 100644 --- a/latest/os/core_os/time/os_time/index.html +++ b/latest/os/core_os/time/os_time/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_time_delay/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_time_delay/index.html b/latest/os/core_os/time/os_time_delay/index.html index 9a11eb8..3d3c99d 100644 --- a/latest/os/core_os/time/os_time_delay/index.html +++ b/latest/os/core_os/time/os_time_delay/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_time_get/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_time_get/index.html b/latest/os/core_os/time/os_time_get/index.html index cfa25b4..dcf9ca7 100644 --- a/latest/os/core_os/time/os_time_get/index.html +++ b/latest/os/core_os/time/os_time_get/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/core_os/time/os_time_tick/index.html ---------------------------------------------------------------------- diff --git a/latest/os/core_os/time/os_time_tick/index.html b/latest/os/core_os/time/os_time_tick/index.html index dbe3277..38056a5 100644 --- a/latest/os/core_os/time/os_time_tick/index.html +++ b/latest/os/core_os/time/os_time_tick/index.html @@ -255,8 +255,8 @@ <li><a href=" - ../../os_init/ -">System-level Functions</a> + ../../os_started/ +">Functions</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/console/console/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/console/console/index.html b/latest/os/modules/console/console/index.html index a47ef30..da737d7 100644 --- a/latest/os/modules/console/console/index.html +++ b/latest/os/modules/console/console/index.html @@ -555,49 +555,66 @@ </div> <h1 id="console">Console</h1> -<p>The console is an operating system window where users interact with system programs of the operating system -or a console application by entering text input (typically from a keyboard) and reading text output -(typically on the computer terminal or monitor). The text written on the console brings some information -and is a sequence of characters sent by the OS or programs running on the OS. </p> +<p>The console is an operating system window where users interact with the OS subsystems or a console +application. A user typically inputs text from a keyboard and reads the OS output text on a computer +monitor. The text are sent as a sequence of characters between the user and the OS. </p> <p>Support is currently available for console access via the serial port on the hardware board.</p> <h3 id="description">Description</h3> <p>In the Mynewt OS, the console library comes in two versions:</p> <ul> -<li>full - containing the full implementation</li> -<li>stub - containing stubs for the API</li> +<li> +<p>The <code>sys/console/full</code> package implements the complete console functionality and API.</p> +</li> +<li> +<p>The <code>sys/console/stub</code> package implements stubs for the API.</p> +</li> </ul> -<p>Both of these have a <code>pkg.yml</code> file which states that they provide the <code>console</code> API. If a pkg uses -this API, it should list <code>console</code> as a requirement. For example, the shell pkg is defined by the -following pkg.yml file:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> pkg.name: libs/shell - pkg.vers: 0.1 - pkg.deps: - - libs/os - - libs/util - pkg.reqs: - - console - pkg.identities: - - SHELL +<p>Both packages export the <code>console</code> API, and any package that uses +the console API must list <code>console</code> as a requirement. For example, the shell package defines the following <code>pkg.yml</code> +file:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: sys/shell +pkg.deps: + - kernel/os + - encoding/base64 + - time/datetime + - util/crc +pkg.req_apis: + - console +</pre></div> + + +<p>The project <code>pkg.yml</code> file specifies the version of the console package to use. +A project that requires the full console capability must list the <code>sys/console/full</code> package as a dependency +in its <code>pkg.yml</code> file.</p> +<p>An example is the <code>slinky</code> application. It requires the full console capability and has the following +<code>pkg.yml</code> file: </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: apps/slinky +pkg.deps: + - test/flash_test + - mgmt/imgmgr + - mgmt/newtmgr + - mgmt/newtmgr/transport/nmgr_shell + - kernel/os + - boot/bootutil + - sys/shell + - sys/console/full + ... + - sys/id </pre></div> -<p>The project .yml file decides which version of the console pkg should be included. -If a project requires the full console capability it lists dependency <code>libs/console/full</code> in its pkg.yml -file. On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) -but may have a dependency on a pkg that has console capability. In that case you would use a console stub. </p> -<p>Another example would be the bootloader project where we want to keep the size of the image small. It includes -the <code>libs/os</code> pkg that can print out messages on a console (e.g. if there is a hard fault) and the <code>libs/util</code> -pkg that uses the full console (but only if SHELL is present to provide a CLI). However, we do not want to use -any console I/O capability in this particular bootloader project to keep the size small. We simply use the console -stub instead, and the pkg.yml file for the project boot pkg looks like the following:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> project.name: boot - project.identities: bootloader - project.pkgs: - - libs/os - - libs/bootutil - - libs/nffs - - libs/console/stub - - libs/util +<p>On the other hand, a project may not have a physical console (e.g. a UART port to connect a terminal to) +but may have a dependency on a package that has console capability. In this case, you use +the console stub API and list the <code>sys/console/stub</code> package as a dependency in its <code>pkg.yml</code> file. </p> +<p>An example is the bootloader project where we want to keep the size of the image small. It includes +the <code>kernel/os</code> package that can print out messages on a console (e.g. if there is a hard fault). +However, we do not want to use any console I/O capability in this particular bootloader project to +keep the size small. The project uses the console stub API and has the following <code>pkg.yml</code> file: </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">pkg.name: apps/boot +pkg.deps: + - boot/bootutil + - kernel/os + - sys/console/stub </pre></div> @@ -608,8 +625,8 @@ based on these interrupts.</p> want to output info related to that crash.</p> <p>Console, by default, echoes everything it receives back. Terminal programs expect this, and is a way for the user to know that the console is connected and responsive. Whether echoing happens or not can be controlled programmatically.</p> -<p>The Console also has a prompt that is configurable. It is off by default but can be turned on programatically. The -prompt cahracter can also be changed by the user.</p> +<p>The Console also has a prompt that is configurable. It is off by default but can be turned on programmatically. The +prompt character can also be changed by the user.</p> <h3 id="data-structures">Data structures</h3> <p>N/A</p> <h3 id="list-of-functions">List of Functions</h3> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/imgmgr/imgmgr/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/imgmgr/imgmgr/index.html b/latest/os/modules/imgmgr/imgmgr/index.html index 76982a0..97676dc 100644 --- a/latest/os/modules/imgmgr/imgmgr/index.html +++ b/latest/os/modules/imgmgr/imgmgr/index.html @@ -381,7 +381,7 @@ <li><a href=" - ../imgmgr_module_init/ + ../imgr_ver_parse/ ">Functions</a> @@ -576,10 +576,6 @@ </thead> <tbody> <tr> -<td><a href="../imgmgr_module_init/">imgmgr_module_init</a></td> -<td>Registers image manager commands with newtmgr.</td> -</tr> -<tr> <td><a href="../imgr_ver_parse/">imgr_ver_parse</a></td> <td>Parses character string containing specified image version number and writes that to given image_version struct.</td> </tr> @@ -606,8 +602,8 @@ </li> <li class="pull-right"> - <a href=../imgmgr_module_init/> - Next: imgmgr_module_init + <a href=../imgr_ver_parse/> + Next: imgr_ver_parse <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/imgmgr/imgmgr_module_init/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/imgmgr/imgmgr_module_init/index.html b/latest/os/modules/imgmgr/imgmgr_module_init/index.html deleted file mode 100644 index 31a003a..0000000 --- a/latest/os/modules/imgmgr/imgmgr_module_init/index.html +++ /dev/null @@ -1,654 +0,0 @@ -<!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="canonical" href="http://mynewt.apache.org/os/modules/imgmgr/imgmgr_module_init/";> --> - <link rel="shortcut icon" href="../../../../img/favicon.ico"> - - <title>imgmgr_module_init - 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";> - <link href="../../../../extra.css" rel="stylesheet"> - - <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> - <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> - <![endif]--> - - - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-72162311-1', 'auto'); - ga('send', 'pageview'); - </script> - - </head> - - - <body class="imgmgr_module_init"> - - - <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.0.0-b1</a> released (Dec 13, 2016) - </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="/latest/os/introduction">Documentation</a> - </li> - <li - class="" -> - <a href="/download/">Download</a> - </li> - <li - class="" -> - <a href="/community/">Community</a> - </li> - <li - class="" -> - <a href="/events/">Events</a> - </li> - </ul> - - <!-- Search, Navigation and Repo links --> - <ul class="nav navbar-nav navbar-right"> - - </ul> - </div> - </div> -</nav> - - - - <div class="container"> - - <div class="row"> - <div class="col-md-3 v2-sidebar 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="/develop/os/introduction" - selected="selected" - > - Version: develop (latest) - </option> - - <option - value="/v0_9_0/os/introduction" - - > - Version: 0.9.0 - </option> - -</select> -</li> - - - - - - - - - - - - - - - - - - - - - - <li ><a href="../../../introduction/">Mynewt Documentation</a> - - - <ul> - - - - - - - - <li ><a href="../../../get_started/get_started/">Basic Setup</a> - - - </li> - - - - - - <li > - <a href="../../../get_started/vocabulary/">Concepts</a> - </li> - - - - - - - - <li ><a href="../../../tutorials/tutorials/">Tutorials</a> - - - </li> - - - - - - - - <li ><a href="../../../os_user_guide/">OS User Guide</a> - - - <ul> - - - - - - - - <li ><a href="../../../core_os/mynewt_os/">OS Core</a> - - - </li> - - - - - - - - <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a> - - - </li> - - - - - - - - <li ><a href="../../console/console/">Console</a> - - - </li> - - - - - - - - <li ><a href="../../shell/shell/">Shell</a> - - - </li> - - - - - - - - <li ><a href="../../split/split/">Split Images</a> - - - </li> - - - - - - - - <li ><a href="../../bootloader/bootloader/">Bootloader</a> - - - </li> - - - - - - - - <li><a href=" - - - ../../fs/fs/fs/ - -">File System</a> - - - </li> - - - - - - - - <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a> - - - </li> - - - - - - - - <li ><a href="../../drivers/driver/">Drivers</a> - - - </li> - - - - - - - - <li ><a href="../../testutil/testutil/">Test Utilities</a> - - - </li> - - - - - - - - <li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a> - - - </li> - - - - - - - - <li ><a href="../imgmgr/">Image Manager</a> - - - <ul> - - - - - - - - <li><a href=" - ./ -">Functions</a> - - - <ul> - - - - <li class="active"> - <a href="./">imgmgr_module_init</a> - </li> - - - - - - <li > - <a href="../imgr_ver_parse/">imgr_ver_parse</a> - </li> - - - - - - <li > - <a href="../imgr_ver_str/">imgr_ver_str</a> - </li> - - - - </ul> - - </li> - - - - </ul> - - </li> - - - - - - <li > - <a href="../../baselibc/">Baselibc library</a> - </li> - - - - - - - - <li ><a href="../../elua/elua/">Embedded Lua</a> - - - </li> - - - - - - - - <li ><a href="../../json/json/">JSON</a> - - - </li> - - - - - - - - <li ><a href="../../fcb/fcb/">Flash Circular Buffer</a> - - - </li> - - - - - - - - <li ><a href="../../stats/stats/">Stats</a> - - - </li> - - - - - - - - <li ><a href="../../logs/logs/">Logs</a> - - - </li> - - - - - - - - <li ><a href="../../sysinitconfig/sysinitconfig/">System Configuration And Initialization</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../../network/ble/ble_intro/ -">BLE User Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../../faq/how_to_edit_docs/ -">Appendix</a> - - - </li> - - - - </ul> -</div></div> - - <div class="col-md-9" role="main"> - <div class="doc-header"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs pull-right"> - <li><a href="/latest/os/introduction">Docs</a></li> - - - - <li>» <a href="../imgmgr/">Image Manager</a></li> - - - - <li>» Functions</li> - - - - <li>» imgmgr_module_init</li> - - - - </ul> -</div> - </div> - - <h2 id="imgmgr_module_init"><font color="#F2853F" style="font-size:24pt"> imgmgr_module_init </font></h2> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> void - imgmgr_module_init(void) -</pre></div> - - -<p>Registers the image manager commands with the <code>mgmt</code> package. <code>sysinit()</code> automatically calls this function during -system initialization.</p> -<h4 id="arguments">Arguments</h4> -<p>N/A</p> -<h4 id="returned-values">Returned values</h4> -<p>N/A</p> -<h4 id="notes">Notes</h4> - - <div class="row"> - - - - -<ul class="nav nav-pills" style="margin-bottom: 10px"> - <li> - - <a href=../imgmgr/> - <span class="fa fa-arrow-left"></span> - Previous: Image Manager - </a> - - </li> - <li class="pull-right"> - - <a href=../imgr_ver_parse/> - Next: imgr_ver_parse - <span class="fa fa-arrow-right"></span> - </a> - - </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"> - <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> - - <script src="../../../../js/jquery-1.10.2.min.js"></script> - <script src="../../../../js/bootstrap-3.0.3.min.js"></script> - <script src="../../../../js/highlight.pack.js"></script> - <script src="../../../../js/base.js"></script> - <script src="../../../../js/custom.js"></script> - - </body> -</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/imgmgr/imgr_ver_parse/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/imgmgr/imgr_ver_parse/index.html b/latest/os/modules/imgmgr/imgr_ver_parse/index.html index 0ffde04..6625913 100644 --- a/latest/os/modules/imgmgr/imgr_ver_parse/index.html +++ b/latest/os/modules/imgmgr/imgr_ver_parse/index.html @@ -381,7 +381,7 @@ <li><a href=" - ../imgmgr_module_init/ + ./ ">Functions</a> @@ -389,14 +389,6 @@ - <li > - <a href="../imgmgr_module_init/">imgmgr_module_init</a> - </li> - - - - - <li class="active"> <a href="./">imgr_ver_parse</a> </li> @@ -572,7 +564,7 @@ - <li>» <a href="../imgmgr_module_init/">Functions</a></li> + <li>» Functions</li> @@ -638,9 +630,9 @@ <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../imgmgr_module_init/> + <a href=../imgmgr/> <span class="fa fa-arrow-left"></span> - Previous: imgmgr_module_init + Previous: Image Manager </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/imgmgr/imgr_ver_str/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/imgmgr/imgr_ver_str/index.html b/latest/os/modules/imgmgr/imgr_ver_str/index.html index 561d077..00ea43a 100644 --- a/latest/os/modules/imgmgr/imgr_ver_str/index.html +++ b/latest/os/modules/imgmgr/imgr_ver_str/index.html @@ -381,7 +381,7 @@ <li><a href=" - ../imgmgr_module_init/ + ../imgr_ver_parse/ ">Functions</a> @@ -390,14 +390,6 @@ <li > - <a href="../imgmgr_module_init/">imgmgr_module_init</a> - </li> - - - - - - <li > <a href="../imgr_ver_parse/">imgr_ver_parse</a> </li> @@ -572,7 +564,7 @@ - <li>» <a href="../imgmgr_module_init/">Functions</a></li> + <li>» <a href="../imgr_ver_parse/">Functions</a></li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/shell/shell/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/shell/shell/index.html b/latest/os/modules/shell/shell/index.html index fb9b53a..1163e43 100644 --- a/latest/os/modules/shell/shell/index.html +++ b/latest/os/modules/shell/shell/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_task_init/ + ../shell_cmd_register/ ">Functions</a> @@ -555,16 +555,23 @@ </div> <h1 id="shell">Shell</h1> -<p>The shell is package sitting on top of console, handling 2 jobs: processing console input and implementing -<a href="../../../../newtmgr/overview/">newtmgr</a> line protocol over serial line. Shell runs in its own task.</p> +<p>The shell runs above the console and provides two functionalities:</p> +<ul> +<li>Processes console input. </li> +<li>Implements the <a href="../../../../newtmgr/overview/">newtmgr</a> line protocol over serial transport. </li> +</ul> +<p>The <code>sys/shell</code> package implements the shell. The shell uses the OS default event queue +for shell events and runs in the context of the main task. An application can, optionally, +specify a dedicated event queue for the shell to use.</p> <h3 id="description">Description</h3> <ul> <li> -<p>Shell's first job is directing incoming commands to other subsystems. It parses the incoming character string -and splits it into tokens. Then it looks for the subsystem to handle this command based on the first token of input.</p> +<p>The shell's first job is to direct incoming commands to other subsystems. It parses the incoming character string +into tokens and uses the first token to determine the subsystem command handler to call to process the command.</p> <ul> <li> -<p>Subsystems register their command handlers using <code>shell_cmd_register()</code>. When shell calls the command handler, it passes the other tokens as arguments.</p> +<p>Subsystems register their command handlers using the <code>shell_cmd_register()</code> + function. When shell calls the command handler, it passes the other tokens as arguments.</p> </li> <li> <p>A few commands are currently available in the shell - <code>tasks</code>, <code>log</code>, <code>echo</code>, <code>date</code> and <code>prompt</code>.</p> @@ -572,9 +579,10 @@ and splits it into tokens. Then it looks for the subsystem to handle this comman </ul> </li> <li> -<p>Shell's second job is doing framing, encoding and decoding newtmgr protocol when it's carried over the console. -Protocol handler (libs/newtmgr) registers itself using <code>shell_nlip_input_register()</code>, and shell calls the registered -handler for every frame. Outgoing frames for the protocol are sent using <code>shell_nlip_output()</code>.</p> +<p>The shell's second job is to handle packet framing, encoding, and decoding of newtmgr protocol messages that are +sent over the console. The Newtmgr serial transport package (<code>mgmt/newtmgr/transport/newtmgr_shell</code>) +calls the <code>shell_nlip_input_register()</code> function to register a handler that the shell calls when it +receives newtmgr request messages.</p> </li> </ul> <p><br></p> @@ -694,10 +702,6 @@ Prompt set to: > </thead> <tbody> <tr> -<td><a href="../shell_task_init/">shell_task_init</a></td> -<td>Initializes the shell package. This creates a task for shell, and registers few commands on its own.</td> -</tr> -<tr> <td><a href="../shell_cmd_register/">shell_cmd_register</a></td> <td>Registers a handler for incoming console commands.</td> </tr> @@ -709,6 +713,10 @@ Prompt set to: > <td><a href="../shell_nlip_output/">shell_nlip_output</a></td> <td>Queue outgoing newtmgr message for transmission.</td> </tr> +<tr> +<td><a href="../shell_evq_set/">shell_evq_set</a></td> +<td>Specifies a dedicated event queue for shell events.</td> +</tr> </tbody> </table> @@ -728,8 +736,8 @@ Prompt set to: > </li> <li class="pull-right"> - <a href=../shell_task_init/> - Next: shell_task_init + <a href=../shell_cmd_register/> + Next: shell_cmd_register <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/shell/shell_cmd_register/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/shell/shell_cmd_register/index.html b/latest/os/modules/shell/shell_cmd_register/index.html index 27ec760..d35fdf9 100644 --- a/latest/os/modules/shell/shell_cmd_register/index.html +++ b/latest/os/modules/shell/shell_cmd_register/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_task_init/ + ./ ">Functions</a> @@ -296,16 +296,16 @@ - <li > - <a href="../shell_task_init/">shell_task_init</a> + <li class="active"> + <a href="./">shell_cmd_register</a> </li> - <li class="active"> - <a href="./">shell_cmd_register</a> + <li > + <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> </li> @@ -313,7 +313,7 @@ <li > - <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> + <a href="../shell_nlip_output/">shell_nlip_output</a> </li> @@ -321,7 +321,7 @@ <li > - <a href="../shell_nlip_output/">shell_nlip_output</a> + <a href="../shell_evq_set/">shell_evq_set</a> </li> @@ -580,7 +580,7 @@ - <li>» <a href="../shell_task_init/">Functions</a></li> + <li>» Functions</li> @@ -644,9 +644,9 @@ Non-zero on failure.</p> <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../shell_task_init/> + <a href=../shell/> <span class="fa fa-arrow-left"></span> - Previous: shell_task_init + Previous: Shell </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/shell/shell_evq_set/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/shell/shell_evq_set/index.html b/latest/os/modules/shell/shell_evq_set/index.html new file mode 100644 index 0000000..5a4adfb --- /dev/null +++ b/latest/os/modules/shell/shell_evq_set/index.html @@ -0,0 +1,676 @@ +<!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="canonical" href="http://mynewt.apache.org/os/modules/shell/shell_evq_set/";> --> + <link rel="shortcut icon" href="../../../../img/favicon.ico"> + + <title>shell_evq_set - 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";> + <link href="../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="shell_evq_set"> + + + <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.0.0-b1</a> released (Dec 13, 2016) + </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="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar 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="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../os_user_guide/">OS User Guide</a> + + + <ul> + + + + + + + + <li ><a href="../../../core_os/mynewt_os/">OS Core</a> + + + </li> + + + + + + + + <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a> + + + </li> + + + + + + + + <li ><a href="../../console/console/">Console</a> + + + </li> + + + + + + + + <li ><a href="../shell/">Shell</a> + + + <ul> + + + + + + + + <li><a href=" + ../shell_cmd_register/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../shell_cmd_register/">shell_cmd_register</a> + </li> + + + + + + <li > + <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> + </li> + + + + + + <li > + <a href="../shell_nlip_output/">shell_nlip_output</a> + </li> + + + + + + <li class="active"> + <a href="./">shell_evq_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../split/split/">Split Images</a> + + + </li> + + + + + + + + <li ><a href="../../bootloader/bootloader/">Bootloader</a> + + + </li> + + + + + + + + <li><a href=" + + + ../../fs/fs/fs/ + +">File System</a> + + + </li> + + + + + + + + <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a> + + + </li> + + + + + + + + <li ><a href="../../drivers/driver/">Drivers</a> + + + </li> + + + + + + + + <li ><a href="../../testutil/testutil/">Test Utilities</a> + + + </li> + + + + + + + + <li ><a href="../../devmgmt/newtmgr/">Device Management with Newt Manager</a> + + + </li> + + + + + + + + <li ><a href="../../imgmgr/imgmgr/">Image Manager</a> + + + </li> + + + + + + <li > + <a href="../../baselibc/">Baselibc library</a> + </li> + + + + + + + + <li ><a href="../../elua/elua/">Embedded Lua</a> + + + </li> + + + + + + + + <li ><a href="../../json/json/">JSON</a> + + + </li> + + + + + + + + <li ><a href="../../fcb/fcb/">Flash Circular Buffer</a> + + + </li> + + + + + + + + <li ><a href="../../stats/stats/">Stats</a> + + + </li> + + + + + + + + <li ><a href="../../logs/logs/">Logs</a> + + + </li> + + + + + + + + <li ><a href="../../sysinitconfig/sysinitconfig/">System Configuration And Initialization</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../network/ble/ble_intro/ +">BLE User Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../shell/">Shell</a></li> + + + + <li>» <a href="../shell_cmd_register/">Functions</a></li> + + + + <li>» shell_evq_set</li> + + + + </ul> +</div> + </div> + + <h2 id="shell_evq_set"><font color="F2853F" style="font-size:24pt"> shell_evq_set</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">void</span> <span style="color: #000000">shell_evq_set</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">os_eventq</span> <span style="color: #000000">*evq</span>) +</pre></div> + + +<p>Specifies an event queue to use for shell events. You must create the event queue +and the task to process events from the queue before calling this function. </p> +<p>By default, shell uses the OS default event queue and executes in the context +of the main task that Mynewt creates.</p> +<h4 id="arguments">Arguments</h4> +<table> +<thead> +<tr> +<th>Arguments</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td><code>evq</code></td> +<td>Pointer to the event queue to use for shell events.</td> +</tr> +</tbody> +</table> +<h4 id="returned-values">Returned values</h4> +<p>None</p> +<h4 id="notes">Notes</h4> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../shell_nlip_output/> + <span class="fa fa-arrow-left"></span> + Previous: shell_nlip_output + </a> + + </li> + <li class="pull-right"> + + <a href=../../split/split/> + Next: Split Images + <span class="fa fa-arrow-right"></span> + </a> + + </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"> + <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> + + <script src="../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../js/highlight.pack.js"></script> + <script src="../../../../js/base.js"></script> + <script src="../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/shell/shell_nlip_input_register/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/shell/shell_nlip_input_register/index.html b/latest/os/modules/shell/shell_nlip_input_register/index.html index 48351de..df5c507 100644 --- a/latest/os/modules/shell/shell_nlip_input_register/index.html +++ b/latest/os/modules/shell/shell_nlip_input_register/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_task_init/ + ../shell_cmd_register/ ">Functions</a> @@ -297,23 +297,23 @@ <li > - <a href="../shell_task_init/">shell_task_init</a> + <a href="../shell_cmd_register/">shell_cmd_register</a> </li> - <li > - <a href="../shell_cmd_register/">shell_cmd_register</a> + <li class="active"> + <a href="./">shell_nlip_input_register</a> </li> - <li class="active"> - <a href="./">shell_nlip_input_register</a> + <li > + <a href="../shell_nlip_output/">shell_nlip_output</a> </li> @@ -321,7 +321,7 @@ <li > - <a href="../shell_nlip_output/">shell_nlip_output</a> + <a href="../shell_evq_set/">shell_evq_set</a> </li> @@ -580,7 +580,7 @@ - <li>» <a href="../shell_task_init/">Functions</a></li> + <li>» <a href="../shell_cmd_register/">Functions</a></li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8e70b507/latest/os/modules/shell/shell_nlip_output/index.html ---------------------------------------------------------------------- diff --git a/latest/os/modules/shell/shell_nlip_output/index.html b/latest/os/modules/shell/shell_nlip_output/index.html index 86e42ef..993ee48 100644 --- a/latest/os/modules/shell/shell_nlip_output/index.html +++ b/latest/os/modules/shell/shell_nlip_output/index.html @@ -288,7 +288,7 @@ <li><a href=" - ../shell_task_init/ + ../shell_cmd_register/ ">Functions</a> @@ -297,7 +297,7 @@ <li > - <a href="../shell_task_init/">shell_task_init</a> + <a href="../shell_cmd_register/">shell_cmd_register</a> </li> @@ -305,23 +305,23 @@ <li > - <a href="../shell_cmd_register/">shell_cmd_register</a> + <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> </li> - <li > - <a href="../shell_nlip_input_register/">shell_nlip_input_register</a> + <li class="active"> + <a href="./">shell_nlip_output</a> </li> - <li class="active"> - <a href="./">shell_nlip_output</a> + <li > + <a href="../shell_evq_set/">shell_evq_set</a> </li> @@ -580,7 +580,7 @@ - <li>» <a href="../shell_task_init/">Functions</a></li> + <li>» <a href="../shell_cmd_register/">Functions</a></li> @@ -648,8 +648,8 @@ </li> <li class="pull-right"> - <a href=../../split/split/> - Next: Split Images + <a href=../shell_evq_set/> + Next: shell_evq_set <span class="fa fa-arrow-right"></span> </a>
