blob: 4db4b790ae1fc5b73eb4f659141348ab11c45f9d [file] [log] [blame]
<!--
Documentation/_templates/layout.html
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. The
ASF licenses this file to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>NuttX Documentation &mdash; NuttX latest documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx_tabs/tabs.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="introduction/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> NuttX
<img src="_static/NuttX.png" class="logo" alt="Logo"/>
</a>
<!-- this version selector is quite ugly, should be probably replaced by something
more modern -->
<div class="version-selector">
<select>
<option value="latest" selected="selected">latest</option>
</select>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/index.html">Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases/index.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">NuttX</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>NuttX Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The present documentation is a recent addition to NuttX and was migrated from previous
documentation content. For this reason, it is possible you may find broken links or
formatting errors. You can help contribute fixes or improvements to this documentation
by following these <a class="reference internal" href="contributing/documentation.html"><span class="doc">instructions</span></a>.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can find the old documentation <a class="reference external" href="https://cwiki.apache.org/confluence/display/NUTTX/Documentation">here</a>.</p>
</div>
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline"></a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 32-bit microcontroller environments, the primary governing standards in NuttX are Posix and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
<p>Last Updated: 07 December 21 at 00:06</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction/about.html">About NuttX</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/supported_platforms.html">Supported Platforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/detailed_support.html">Detailed Platform Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/development_environments.html">Development Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/licensing.html">Licensing</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/trademarks.html">Trademarks</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/resources.html">Resources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#definition">Definition</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#strict-posix-compliance">Strict POSIX compliance</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#modular-architecture">Modular Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#clear-consistent-standardized-coding-style">Clear, Consistent, Standardized Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#open-and-unencumbered-license">Open and Unencumbered License</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#all-users-matter">All Users Matter</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#nuttx-branding">NuttX Branding</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#the-enemies">The Enemies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/install.html">Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/compiling.html">Compiling</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/running.html">Running</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/configuring.html">Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/organization.html">Directory Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/build_and_make.html">Build and Make Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="components/nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/power.html">Power Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/socketcan.html">SocketCAN Device Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/syslog.html">SYSLOG</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/binfmt.html">Binary Loader</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/drivers/index.html">Device Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/filesystem.html">NuttX File System</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/nxflat.html">NXFLAT</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/nxgraphics/index.html">NX Graphics Subsystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/nxwidgets.html">NxWidgets</a></li>
<li class="toctree-l2"><a class="reference internal" href="components/paging.html">On-Demand Paging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/user/index.html">Userspace API</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/os/index.html">Architecture APIs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/index.html">Guides</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/nfs.html">NFS Client How-To</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/usbtrace.html">USB Device Trace</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/simulator.html">Simulator</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/drivers.html">Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releases/index.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing/workflow.html">Development Workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/coding_style.html">C Coding Standard</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/documentation.html">Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, The Apache Software Foundation
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>