| <!-- |
| 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Directory Structure — NuttX latest documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/custom.css" /> |
| |
| |
| <link rel="shortcut icon" href="../_static/favicon.ico"/> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/doctools.js"></script> |
| <script src="../_static/sphinx_highlight.js"></script> |
| <script src="../_static/clipboard.min.js"></script> |
| <script src="../_static/copybutton.js"></script> |
| <script 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="Contributing" href="../contributing/index.html" /> |
| <link rel="prev" title="Debugging" href="debugging.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="../index.html" class="icon icon-home"> NuttX |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../latest" selected="selected">latest</option> |
| |
| <option value="../../10.0.0" >10.0.0</option> |
| |
| <option value="../../10.0.1" >10.0.1</option> |
| |
| <option value="../../10.1.0" >10.1.0</option> |
| |
| <option value="../../10.2.0" >10.2.0</option> |
| |
| <option value="../../10.3.0" >10.3.0</option> |
| |
| <option value="../../11.0.0" >11.0.0</option> |
| |
| <option value="../../12.0.0" >12.0.0</option> |
| |
| <option value="../../12.1.0" >12.1.0</option> |
| |
| <option value="../../12.2.0" >12.2.0</option> |
| |
| <option value="../../12.2.1" >12.2.1</option> |
| |
| <option value="../../12.3.0" >12.3.0</option> |
| |
| <option value="../../12.4.0" >12.4.0</option> |
| |
| <option value="../../12.5.0" >12.5.0</option> |
| |
| <option value="../../12.5.1" >12.5.1</option> |
| |
| <option value="../../12.6.0" >12.6.0</option> |
| |
| <option value="../../12.7.0" >12.7.0</option> |
| |
| <option value="../../12.8.0" >12.8.0</option> |
| |
| <option value="../../12.9.0" >12.9.0</option> |
| |
| <option value="../../12.10.0" >12.10.0</option> |
| |
| <option value="../../12.11.0" >12.11.0</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" aria-label="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="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="compiling_make.html">Compiling with Make</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="compiling_cmake.html">Compiling with CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Directory Structure</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-documentation"><code class="docutils literal notranslate"><span class="pre">nuttx/Documentation</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-arch"><code class="docutils literal notranslate"><span class="pre">nuttx/arch</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-binfmt"><code class="docutils literal notranslate"><span class="pre">nuttx/binfmt</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-audio"><code class="docutils literal notranslate"><span class="pre">nuttx/audio</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-boards"><code class="docutils literal notranslate"><span class="pre">nuttx/boards</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#boards-subdirectory-structure">Boards Subdirectory Structure</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-cmake"><code class="docutils literal notranslate"><span class="pre">nuttx/cmake</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-crypto"><code class="docutils literal notranslate"><span class="pre">nuttx/crypto</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-drivers"><code class="docutils literal notranslate"><span class="pre">nuttx/drivers</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-fs"><code class="docutils literal notranslate"><span class="pre">nuttx/fs</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-graphics"><code class="docutils literal notranslate"><span class="pre">nuttx/graphics</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-include"><code class="docutils literal notranslate"><span class="pre">nuttx/include</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-libs-libc"><code class="docutils literal notranslate"><span class="pre">nuttx/libs/libc</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-mm"><code class="docutils literal notranslate"><span class="pre">nuttx/mm</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-net"><code class="docutils literal notranslate"><span class="pre">nuttx/net</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-openamp"><code class="docutils literal notranslate"><span class="pre">nuttx/openamp</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-pass1"><code class="docutils literal notranslate"><span class="pre">nuttx/pass1</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-sched"><code class="docutils literal notranslate"><span class="pre">nuttx/sched</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-syscall"><code class="docutils literal notranslate"><span class="pre">nuttx/syscall</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-tools"><code class="docutils literal notranslate"><span class="pre">nuttx/tools</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-video"><code class="docutils literal notranslate"><span class="pre">nuttx/video</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-wireless"><code class="docutils literal notranslate"><span class="pre">nuttx/wireless</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-cmakelists-txt"><code class="docutils literal notranslate"><span class="pre">nuttx/CMakeLists.txt</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#nuttx-makefile"><code class="docutils literal notranslate"><span class="pre">nuttx/Makefile</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </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="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../platforms/index.html">Supported Platforms</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="../implementation/index.html">Implementation Details</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="../faq/index.html">FAQ</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="../glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../logos/index.html">NuttX Logos</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">NuttX</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="index.html">Getting Started</a></li> |
| <li class="breadcrumb-item active">Directory Structure</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/quickstart/organization.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-todo admonition" id="id1"> |
| <p class="admonition-title">Todo</p> |
| <p>This is mostly untouched from the original documentation. It does |
| not really belong to “quickstart”. Also, this needs cleanup.</p> |
| </div> |
| <section id="directory-structure"> |
| <span id="organization"></span><h1>Directory Structure<a class="headerlink" href="#directory-structure" title="Permalink to this heading"></a></h1> |
| <p>This is included for reference, and it’s not necessary to know |
| all the details at first.</p> |
| <p>The general directory layout for NuttX is |
| very similar to the directory structure of the Linux kernel – at |
| least at the most superficial layers. At the top level is the main |
| makefile and a series of sub-directories identified below and |
| discussed in the following paragraphs:</p> |
| <p><strong>Configuration Files</strong>. The NuttX configuration consists of logic |
| in processor architecture directories, <em>chip/SoC</em> directories, and |
| board configuration directories. The complete configuration is |
| specified by several settings in the NuttX configuration file.</p> |
| <ul> |
| <li><p><em>Processor architecture specific files</em>. These are the files |
| contained in the <code class="docutils literal notranslate"><span class="pre">arch/<arch-name>/</span></code> directory and |
| are discussed in a paragraph |
| <a class="reference external" href="#arch-subdirectory-structure">below</a>. As an example, all ARM |
| processor architectures are provided under the <code class="docutils literal notranslate"><span class="pre">arch/arm/</span></code> |
| directory which is selected with the <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH="arm"</span></code> |
| configuration option.</p> |
| <p>Variants of the processor architecture may be provided in |
| sub-directories of the Extending this example, the ARMv7-M ARM |
| family is supported by logic in <code class="docutils literal notranslate"><span class="pre">arch/arm/include/armv7-m</span></code> |
| and <code class="docutils literal notranslate"><span class="pre">arch/arm/src/armv7-m</span></code> directories which are selected by |
| the <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_CORTEXM3=y</span></code>, <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_CORTEXM4=y</span></code>, or |
| <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_CORTEXM7=y</span></code> configuration options</p> |
| </li> |
| <li><p><em>Chip/SoC specific files</em>. Each processor architecture is |
| embedded in a <em>System-on-a-Chip</em> (SoC) architecture. The full |
| SoC architecture includes the processor architecture plus |
| chip-specific interrupt logic, clocking logic, general purpose |
| I/O (GPIO) logic, and specialized, internal peripherals (such |
| as UARTs, USB, etc.).</p> |
| <p>These chip-specific files are contained within chip-specific |
| sub-directories also under the <code class="docutils literal notranslate"><span class="pre">arch/<arch-name>/</span></code> |
| directory and are selected via the <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_CHIP</span></code> |
| selection.</p> |
| <p>As an example, the STMicro STM32 SoC architecture is based on |
| the ARMv7-M processor and is supported by logic in the |
| <code class="docutils literal notranslate"><span class="pre">arch/arm/include/stm32</span></code> and <code class="docutils literal notranslate"><span class="pre">arch/arm/src/stm32</span></code> |
| directories which are selected with the |
| <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_CHIP="stm32"</span></code> configuration setting.</p> |
| </li> |
| <li><p><em>Board specific configurations</em>. In order to be usable, the |
| chip must be contained in a board environment. The board |
| configuration defines additional properties of the board |
| including such things as peripheral LEDs, external peripherals |
| (such as networks, USB, etc.).</p> |
| <p>These board-specific configuration files can be found in the |
| <code class="docutils literal notranslate"><span class="pre">boards/<arch-name>/<chip-name>/<board-name>/</span></code> |
| sub-directories and are discussed in a paragraph |
| <a class="reference external" href="#boards-subdirectory-structure">below</a>.</p> |
| <p>The directory <code class="docutils literal notranslate"><span class="pre">boards/arm/stm32/stm32f4disovery/</span></code>, as an |
| example, holds board-specific logic for the STM32F4 Discovery |
| board and is selected via the |
| <code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_BOARD="stm32f4discovery"</span></code> configuration setting.</p> |
| </li> |
| </ul> |
| <section id="nuttx-documentation"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/Documentation</span></code><a class="headerlink" href="#nuttx-documentation" title="Permalink to this heading"></a></h2> |
| <p>This directory holds the NuttX documentation. It’s made with |
| the <a class="reference external" href="https://www.sphinx-doc.org">Sphinx documentation system</a>. See the |
| README.md file for information on how to build it.</p> |
| </section> |
| <section id="nuttx-arch"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/arch</span></code><a class="headerlink" href="#nuttx-arch" title="Permalink to this heading"></a></h2> |
| <p>This sub-directory holds the NuttX supported architectures.</p> |
| <p>For details see <a class="reference internal" href="../components/arch/index.html"><span class="doc">Architecture-Specific Code</span></a>.</p> |
| </section> |
| <section id="nuttx-binfmt"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/binfmt</span></code><a class="headerlink" href="#nuttx-binfmt" title="Permalink to this heading"></a></h2> |
| <p>The <code class="docutils literal notranslate"><span class="pre">binfmt/</span></code> subdirectory contains logic for loading binaries |
| in the file system into memory in a form that can be used to |
| execute them.</p> |
| </section> |
| <section id="nuttx-audio"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/audio</span></code><a class="headerlink" href="#nuttx-audio" title="Permalink to this heading"></a></h2> |
| <p>The <code class="docutils literal notranslate"><span class="pre">audio/</span></code> subdirectory contains the NuttX audio sub-system.</p> |
| </section> |
| <section id="nuttx-boards"> |
| <span id="id2"></span><h2><code class="docutils literal notranslate"><span class="pre">nuttx/boards</span></code><a class="headerlink" href="#nuttx-boards" title="Permalink to this heading"></a></h2> |
| <p>The <code class="docutils literal notranslate"><span class="pre">boards/</span></code> subdirectory contains custom logic and board |
| configuration data for each board. These board-specific |
| configurations plus the architecture-specific configurations in |
| the <code class="docutils literal notranslate"><span class="pre">arch/</span></code> subdirectory complete define a customized port of |
| NuttX.</p> |
| <section id="boards-subdirectory-structure"> |
| <h3>Boards Subdirectory Structure<a class="headerlink" href="#boards-subdirectory-structure" title="Permalink to this heading"></a></h3> |
| <p>The <code class="docutils literal notranslate"><span class="pre">boards/</span></code> directory contains board specific configuration |
| files. Each board must provide a sub-directory <board-name> under |
| <code class="docutils literal notranslate"><span class="pre">boards/<arch-name>/<chip-name>/</span></code>.</p> |
| <p>See <a class="reference internal" href="../components/boards.html"><span class="doc">Boards Support</span></a> for details.</p> |
| </section> |
| </section> |
| <section id="nuttx-cmake"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/cmake</span></code><a class="headerlink" href="#nuttx-cmake" title="Permalink to this heading"></a></h2> |
| <p>This sub-directory holds the NuttX CMake functions.</p> |
| <p>For details see <a class="reference internal" href="../components/cmake.html"><span class="doc">CMake Support</span></a>.</p> |
| </section> |
| <section id="nuttx-crypto"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/crypto</span></code><a class="headerlink" href="#nuttx-crypto" title="Permalink to this heading"></a></h2> |
| <p>This sub-directory holds the NuttX cryptographic sub-system.</p> |
| <p>For details see <a class="reference internal" href="../components/crypto.html"><span class="doc">Crypto API Subsystem</span></a>.</p> |
| </section> |
| <section id="nuttx-drivers"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/drivers</span></code><a class="headerlink" href="#nuttx-drivers" title="Permalink to this heading"></a></h2> |
| <p>This directory holds architecture-independent device drivers.</p> |
| <p>For details see <a class="reference internal" href="../components/drivers/index.html"><span class="doc">Device Drivers</span></a>.</p> |
| </section> |
| <section id="nuttx-fs"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/fs</span></code><a class="headerlink" href="#nuttx-fs" title="Permalink to this heading"></a></h2> |
| <p>This directory contains the NuttX file system. This file system is |
| described <a class="reference external" href="#NxFileSystem">below</a>.</p> |
| </section> |
| <section id="nuttx-graphics"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/graphics</span></code><a class="headerlink" href="#nuttx-graphics" title="Permalink to this heading"></a></h2> |
| <p>This directory contains files for graphics/video support under |
| NuttX.</p> |
| <p>For details see <a class="reference internal" href="../components/nxgraphics/index.html"><span class="doc">NX Graphics Subsystem</span></a>.</p> |
| </section> |
| <section id="nuttx-include"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/include</span></code><a class="headerlink" href="#nuttx-include" title="Permalink to this heading"></a></h2> |
| <p>This directory holds NuttX header files. Standard header files |
| file retained in can be included in the <em>normal</em> fashion:</p> |
| </section> |
| <section id="nuttx-libs-libc"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/libs/libc</span></code><a class="headerlink" href="#nuttx-libs-libc" title="Permalink to this heading"></a></h2> |
| <p>This directory holds a collection of standard libc-like functions |
| with custom interfaces into NuttX.</p> |
| <p>For details see <a class="reference internal" href="../components/libs/index.html"><span class="doc">NuttX libraries</span></a>.</p> |
| </section> |
| <section id="nuttx-mm"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/mm</span></code><a class="headerlink" href="#nuttx-mm" title="Permalink to this heading"></a></h2> |
| <p>This is the NuttX memory manager.</p> |
| <p>For details see <a class="reference internal" href="../components/mm/index.html"><span class="doc">Memory Management</span></a>.</p> |
| </section> |
| <section id="nuttx-net"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/net</span></code><a class="headerlink" href="#nuttx-net" title="Permalink to this heading"></a></h2> |
| <p>This directory contains the implementation of the NuttX networking |
| layer including internal socket APIs.</p> |
| <p>For details see <a class="reference internal" href="../components/net/index.html"><span class="doc">Network Support</span></a>.</p> |
| </section> |
| <section id="nuttx-openamp"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/openamp</span></code><a class="headerlink" href="#nuttx-openamp" title="Permalink to this heading"></a></h2> |
| <p>This directory contains OpenAMP support for NuttX.</p> |
| <p>For details see <a class="reference internal" href="../components/openamp.html"><span class="doc">OpenAMP Support</span></a>.</p> |
| </section> |
| <section id="nuttx-pass1"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/pass1</span></code><a class="headerlink" href="#nuttx-pass1" title="Permalink to this heading"></a></h2> |
| <p>TODO</p> |
| </section> |
| <section id="nuttx-sched"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/sched</span></code><a class="headerlink" href="#nuttx-sched" title="Permalink to this heading"></a></h2> |
| <p>The files forming core of the NuttX RTOS reside here.</p> |
| </section> |
| <section id="nuttx-syscall"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/syscall</span></code><a class="headerlink" href="#nuttx-syscall" title="Permalink to this heading"></a></h2> |
| <p>If NuttX is built as a separately compiled kernel (with |
| <code class="docutils literal notranslate"><span class="pre">CONFIG_BUILD_PROTECTED=y</span></code> or <code class="docutils literal notranslate"><span class="pre">CONFIG_BUILD_KERNEL=y</span></code>), then |
| the contents of this directory are built. This directory holds a |
| syscall interface that can be used for communication between |
| user-mode applications and the kernel-mode RTOS.</p> |
| <p>For details see <a class="reference internal" href="../components/syscall.html"><span class="doc">Syscall Layer</span></a>.</p> |
| </section> |
| <section id="nuttx-tools"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/tools</span></code><a class="headerlink" href="#nuttx-tools" title="Permalink to this heading"></a></h2> |
| <p>This directory holds a collection of tools and scripts to simplify |
| configuring, building and maintaining NuttX.</p> |
| <p>Refer to the <a class="reference internal" href="../components/tools/index.html"><span class="doc">/tools Host Tools</span></a> page for more |
| information about the individual files. Some of these tools are |
| discussed below as well in the discussion of <a class="reference external" href="#configandbuild">configuring and |
| building</a> NuttX.</p> |
| </section> |
| <section id="nuttx-video"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/video</span></code><a class="headerlink" href="#nuttx-video" title="Permalink to this heading"></a></h2> |
| <p>This directory holds support for video sub-system.</p> |
| <p>For details see <a class="reference internal" href="../components/video.html"><span class="doc">Video Subsystem</span></a>.</p> |
| </section> |
| <section id="nuttx-wireless"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/wireless</span></code><a class="headerlink" href="#nuttx-wireless" title="Permalink to this heading"></a></h2> |
| <p>This directory holds support for hardware-independent wireless |
| support.</p> |
| <p>For details see <a class="reference internal" href="../components/wireless.html"><span class="doc">Wireless Subsystem</span></a>.</p> |
| </section> |
| <section id="nuttx-cmakelists-txt"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/CMakeLists.txt</span></code><a class="headerlink" href="#nuttx-cmakelists-txt" title="Permalink to this heading"></a></h2> |
| <p>The top-level <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> file.</p> |
| </section> |
| <section id="nuttx-makefile"> |
| <h2><code class="docutils literal notranslate"><span class="pre">nuttx/Makefile</span></code><a class="headerlink" href="#nuttx-makefile" title="Permalink to this heading"></a></h2> |
| <p>The top-level <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> in the <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)</span></code> directory contains |
| all of the top-level control logic to build NuttX.</p> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="debugging.html" class="btn btn-neutral float-left" title="Debugging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="../contributing/index.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2023, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
