blob: 2b8009431df10dd6d987a904b12da0c01a2aedcb [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="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Run NuttX on Renode &mdash; 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/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.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/design-tabs.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="Signaling Events from Interrupt Handlers" href="signal_events_interrupt_handlers.html" />
<link rel="prev" title="Semihosting" href="semihosting.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"><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="../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="../debugging/index.html">Debugging</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Guides</a><ul class="current">
<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="rndis.html">How to use RNDIS</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="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>
<li class="toctree-l2"><a class="reference internal" href="customboards.html">Custom Boards How-To</a></li>
<li class="toctree-l2"><a class="reference internal" href="customapps.html">Custom Apps How-to</a></li>
<li class="toctree-l2"><a class="reference internal" href="citests.html">Running CI Test Locally</a></li>
<li class="toctree-l2"><a class="reference internal" href="zerolatencyinterrupts.html">High Performance: Zero Latency Interrupts, Maskable Nested Interrupts</a></li>
<li class="toctree-l2"><a class="reference internal" href="fortify.html">Fortify</a></li>
<li class="toctree-l2"><a class="reference internal" href="nestedinterrupts.html">Nested Interrupts</a></li>
<li class="toctree-l2"><a class="reference internal" href="ofloader.html">Open Flash Loader</a></li>
<li class="toctree-l2"><a class="reference internal" href="testingtcpip.html">Testing TCP/IP Network Stacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="automounter.html">Auto-Mounter</a></li>
<li class="toctree-l2"><a class="reference internal" href="stm32nullpointer.html">STM32 Null Pointer Detection</a></li>
<li class="toctree-l2"><a class="reference internal" href="stm32ccm.html">STM32 CCM Allocator</a></li>
<li class="toctree-l2"><a class="reference internal" href="etcromfs.html">etc romfs</a></li>
<li class="toctree-l2"><a class="reference internal" href="thread_local_storage.html">Thread Local Storage</a></li>
<li class="toctree-l2"><a class="reference internal" href="devicetree.html">Device Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="changing_systemclockconfig.html">Changing the System Clock Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="usingkernelthreads.html">Using Kernel Threads</a></li>
<li class="toctree-l2"><a class="reference internal" href="armv7m_runtimestackcheck.html">ARMv7-M Run Time Stack Checking</a></li>
<li class="toctree-l2"><a class="reference internal" href="include_files_board_h.html">Including Files in board.h</a></li>
<li class="toctree-l2"><a class="reference internal" href="specialstuff_in_nuttxheaderfiles.html">Why can’t I put my special stuff in NuttX header files?</a></li>
<li class="toctree-l2"><a class="reference internal" href="kernel_threads_with_custom_stacks.html">Kernel Threads with Custom Stacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="versioning_and_task_names.html">Versioning and Task Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging_rambuffer.html">Logging to a RAM Buffer</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6.html">IPv6</a></li>
<li class="toctree-l2"><a class="reference internal" href="integrate_newlib.html">Integrating with Newlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="protected_build.html">NuttX Protected Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="platform_directories.html">Platform Directories</a></li>
<li class="toctree-l2"><a class="reference internal" href="port_drivers_to_stm32f7.html">Porting Drivers to the STM32 F7</a></li>
<li class="toctree-l2"><a class="reference internal" href="semihosting.html">Semihosting</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Run NuttX on Renode</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#stm32f4discovery">stm32f4discovery</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nucleo-l073rz">nucleo-l073rz</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nrf52840-dk">nrf52840-dk</a></li>
<li class="toctree-l3"><a class="reference internal" href="#stm32f746g-disco">stm32f746g-disco</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nucleo-h743zi">nucleo-h743zi</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="signal_events_interrupt_handlers.html">Signaling Events from Interrupt Handlers</a></li>
<li class="toctree-l2"><a class="reference internal" href="signaling_sem_priority_inheritance.html">Signaling Semaphores and Priority Inheritance</a></li>
<li class="toctree-l2"><a class="reference internal" href="smaller_vector_tables.html">Smaller Vector Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="port.html">How to port</a></li>
<li class="toctree-l2"><a class="reference internal" href="updating_release_system_elf.html">Updating a Release System with ELF Programs</a></li>
<li class="toctree-l2"><a class="reference internal" href="partially_linked_elf.html">ELF Programs – With Symbol Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="fully_linked_elf.html">ELF Programs – No Symbol Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="building_nuttx_with_app_out_of_src_tree.html">Building NuttX with Applications Outside the Source Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="building_uclibcpp.html">Building uClibc++</a></li>
<li class="toctree-l2"><a class="reference internal" href="custom_app_directories.html">Custom Application Directories</a></li>
<li class="toctree-l2"><a class="reference internal" href="multiple_nsh_sessions.html">Multiple NSH Sessions</a></li>
<li class="toctree-l2"><a class="reference internal" href="nsh_network_link_management.html">NSH Network Link Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="ram_rom_disks.html">RAM Disks and ROM Disks</a></li>
<li class="toctree-l2"><a class="reference internal" href="reading_can_msgs.html">Reading CAN Messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="remove_device_drivers_nsh.html">Removing Device Drivers with NSH</a></li>
<li class="toctree-l2"><a class="reference internal" href="rust.html">Rust in NuttX</a></li>
<li class="toctree-l2"><a class="reference internal" href="optee.html">Interfacing with OP-TEE</a></li>
</ul>
</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>
<li class="toctree-l1"><a class="reference internal" href="../_tags/tagsindex.html">Tags</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">Guides</a></li>
<li class="breadcrumb-item active">Run NuttX on Renode</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/nuttx/blob/master/Documentation/guides/renode.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="run-nuttx-on-renode">
<h1>Run NuttX on Renode<a class="headerlink" href="#run-nuttx-on-renode" title="Permalink to this heading"></a></h1>
<p>Renode (<a class="reference external" href="https://renode.io/">https://renode.io/</a>) is and open source virtual development
framework dedicated for complex embedded systems.</p>
<p>This page contains notes on running some of NuttX boards on Renode.</p>
<section id="stm32f4discovery">
<h2>stm32f4discovery<a class="headerlink" href="#stm32f4discovery" title="Permalink to this heading"></a></h2>
<p>Renode doesn’t support CCM memory, so we have to disable it
with <code class="docutils literal notranslate"><span class="pre">CONFIG_MM_REGIONS=1</span></code>.</p>
<p>Renode script:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>using sysbus
$name?=&quot;STM32F4_Discovery&quot;
mach create $name
machine LoadPlatformDescription @platforms/boards/stm32f4_discovery-kit.repl
cpu PerformanceInMips 125
$bin?=@nuttx
showAnalyzer sysbus.usart2
macro reset
&quot;&quot;&quot;
sysbus LoadELF $bin
&quot;&quot;&quot;
runMacro $reset
</pre></div>
</div>
<p>Tested with <code class="docutils literal notranslate"><span class="pre">stm32f4discovery/nsh</span></code>.</p>
</section>
<section id="nucleo-l073rz">
<h2>nucleo-l073rz<a class="headerlink" href="#nucleo-l073rz" title="Permalink to this heading"></a></h2>
<p>Doesn’t work. No BASEPRI implementation for <code class="docutils literal notranslate"><span class="pre">Cotex-M0</span></code> in NuttX.</p>
</section>
<section id="nrf52840-dk">
<h2>nrf52840-dk<a class="headerlink" href="#nrf52840-dk" title="Permalink to this heading"></a></h2>
<p>At default Renode uses UART with EasyDMA enabled (UARTE) which is not supported
by Nuttx yet. We can get around this by creating our own machine description
based on Renode default implementation:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>using &quot;platforms/cpus/nrf52840.repl&quot;
uart0:
easyDMA: false
</pre></div>
</div>
<p>Renode script:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>using sysbus
mach create
machine LoadPlatformDescription @nrf52840_custom.repl
$bin?=@nuttx
showAnalyzer uart0
macro reset
&quot;&quot;&quot;
sysbus LoadELF $bin
&quot;&quot;&quot;
runMacro $reset
</pre></div>
</div>
<p>Tested with <code class="docutils literal notranslate"><span class="pre">nrf52840-dk/nsh</span></code>.</p>
<p>Known issues:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">QSPI</span></code> not implemented in Renode,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PWM</span></code> doesn’t work, missing <code class="docutils literal notranslate"><span class="pre">NRF52_PWM_EVENTS_SEQSTARTED0_OFFSET</span></code>
implementation in Renode,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ADC</span></code> doesn’t work, missing <code class="docutils literal notranslate"><span class="pre">NRF52_SAADC_EVENTS_CALDONE_OFFSET</span></code>
implementation in Renode,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">SoftDevice</span></code> doesn’t work, crash in <code class="docutils literal notranslate"><span class="pre">mpsl_init()</span></code></p></li>
</ul>
</section>
<section id="stm32f746g-disco">
<h2>stm32f746g-disco<a class="headerlink" href="#stm32f746g-disco" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">CONFIG_ARMV7M_BASEPRI_WAR=y</span></code> must be set.</p>
<p>Renode script:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>using sysbus
$name?=&quot;STM32F746&quot;
mach create $name
machine LoadPlatformDescription @platforms/boards/stm32f7_discovery-bb.repl
$bin ?= @nuttx
showAnalyzer usart1
showAnalyzer ltdc
macro reset
&quot;&quot;&quot;
sysbus LoadELF $bin
&quot;&quot;&quot;
runMacro $reset
</pre></div>
</div>
<p>Tested with <code class="docutils literal notranslate"><span class="pre">stm32f746g-disco/nsh</span></code>.</p>
<p>Known issues:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">stm32f746g-disco/lvgl</span></code> - crash due to incompatible I2C our touchscreen driver</p></li>
</ul>
</section>
<section id="nucleo-h743zi">
<h2>nucleo-h743zi<a class="headerlink" href="#nucleo-h743zi" title="Permalink to this heading"></a></h2>
<p>Renode doesn’t support <code class="docutils literal notranslate"><span class="pre">PWR_CSR1_ACTVOSRDY</span></code> bit so we have to disable
it with <code class="docutils literal notranslate"><span class="pre">CONFIG_STM32H7_PWR_IGNORE_ACTVOSRDY=y</span></code>.</p>
<p>Renode script:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>using sysbus
mach create &quot;nucleo_h743zi&quot;
include @platforms/boards/nucleo_h753zi.repl
$bin=@nuttx
showAnalyzer sysbus.usart3
macro reset
&quot;&quot;&quot;
sysbus LoadELF $bin
&quot;&quot;&quot;
runMacro $reset
</pre></div>
</div>
<p>Tested with <code class="docutils literal notranslate"><span class="pre">nucleo-h743zi/nsh</span></code>.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="semihosting.html" class="btn btn-neutral float-left" title="Semihosting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="signal_events_interrupt_handlers.html" class="btn btn-neutral float-right" title="Signaling Events from Interrupt Handlers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, The Apache Software Foundation.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>