| <!-- |
| 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>Guides — 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/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 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="NFS Client How-To" href="nfs.html" /> |
| <link rel="prev" title="FAQ" href="../faq/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="../index.html" 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 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" /> |
| <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"><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"><a class="reference internal" href="../quickstart/index.html">Getting Started</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="../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="../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 current"><a class="current reference internal" href="#">Guides</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="nfs.html">NFS Client How-To</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="simulator.html">Simulator</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html">Drivers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tasktrace.html">Task Trace</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cpp_cmake.html">C++ Example using CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pysimcoder.html">pysimCoder integration with NuttX</a></li> |
| </ul> |
| </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="../index.html">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="../index.html" class="icon icon-home"></a> »</li> |
| |
| <li>Guides</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../_sources/guides/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-todo admonition" id="id1"> |
| <p class="admonition-title">Todo</p> |
| <p>Create “tutorial” type documentation for specific subjects not to be covered in more general terms.</p> |
| </div> |
| <div class="section" id="guides"> |
| <h1>Guides<a class="headerlink" href="#guides" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="nfs.html">NFS Client How-To</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="nfs.html#adding-nfs-to-the-nuttx-configuration">Adding NFS to the NuttX Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nfs.html#mount-interface">Mount Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nfs.html#nfs-mount-command">NFS Mount Command</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nfs.html#configuring-the-nfs-server-ubuntu">Configuring the NFS server (Ubuntu)</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="simulator.html">Simulator</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="simulator.html#compiling">Compiling</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="simulator.html#accessing-the-network">Accessing the Network</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="simulator.html#stopping">Stopping</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="simulator.html#debugging">Debugging</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="drivers.html">Drivers</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html#porting-a-driver">Porting a Driver</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html#nuttx-drivers-as-a-reference">NuttX Drivers as a Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html#using-chip-datasheets">Using Chip Datasheets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html#logic-analyzers">Logic Analyzers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="drivers.html#dma-debugging">DMA Debugging</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="tasktrace.html">Task Trace</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="tasktraceuser.html">Task Trace User Guide</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="tasktraceuser.html#installation">Installation</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#install-trace-compass">Install Trace Compass</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#nuttx-kernel-configuration">NuttX kernel configuration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="tasktraceuser.html#how-to-get-trace-data">How to get trace data</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#quick-guide">Quick Guide</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="tasktraceuser.html#getting-the-trace">Getting the trace</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="tasktraceuser.html#displaying-the-trace-result">Displaying the trace result</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="tasktraceuser.html#trace-command-description">Trace command description</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-start">trace start</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-stop">trace stop</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-cmd">trace cmd</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-dump">trace dump</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-mode">trace mode</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-syscall">trace syscall</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceuser.html#trace-irq">trace irq</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="tasktraceinternal.html">Task Trace Internals</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="tasktraceinternal.html#overview">Overview</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#nuttx-kernel-events-collection">NuttX kernel events collection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#filter-logic-nuttx-sched-sched-note-c">Filter logic (<code class="docutils literal notranslate"><span class="pre">nuttx/sched/sched_note.c</span></code>)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#noteram-device-driver-nuttx-drivers-note-noteram-driver-c">Noteram device driver (<code class="docutils literal notranslate"><span class="pre">nuttx/drivers/note/noteram_driver.c</span></code>)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#notectl-device-driver-nuttx-drivers-note-notectl-driver-c">Notectl device driver (<code class="docutils literal notranslate"><span class="pre">nuttx/drivers/note/notectl_driver.c</span></code>)</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#trace-built-in-application-apps-system-trace-trace-c">“<code class="docutils literal notranslate"><span class="pre">trace</span></code>” Built-In Application (<code class="docutils literal notranslate"><span class="pre">apps/system/trace/trace.c</span></code>)</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="tasktraceinternal.html#getting-the-system-call-events">Getting the system call events</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#flat-build">FLAT build</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="tasktraceinternal.html#protected-kernel-build">PROTECTED/KERNEL build</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="cpp_cmake.html">C++ Example using CMake</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="cpp_cmake.html#preparation">Preparation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cpp_cmake.html#creating-the-project">Creating the project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cpp_cmake.html#building">Building</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pysimcoder.html">pysimCoder integration with NuttX</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pysimcoder.html#peripheral-support">Peripheral Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pysimcoder.html#nuttx-configuration">NuttX Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pysimcoder.html#using-pysimcoder-to-design-nuttx-application">Using pysimCoder to design NuttX application</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="nfs.html" class="btn btn-neutral float-right" title="NFS Client How-To" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| <a href="../faq/index.html" class="btn btn-neutral float-left" title="FAQ" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |
