mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 14:55:18 +00:00
f6ecf80ebb
The documentation grew one page at a time, so the tree follows the
history of who wrote what and not the shape of NuttX. Scheduling is
spread over three places, a driver page can sit above the subsystem
that owns it, and the front page lists everything at the same level.
That is a lot to face when all you want to know is where the scheduler
lives.
This change files every page under the code it describes. It is a move,
not a rewrite: outside the ten pages named below, every page keeps the
text that is already in master, and no page's text is deleted.
What it does:
* Groups the table of contents into nine chapters.
* Moves the OS subsystems under os/: scheduling, memory, drivers,
filesystem, networking, IPC, interrupts, libs, time.
* Renames the platform pages to the names the source tree uses, and
derives their tags from the tree instead of by hand.
* Splits guides/ by subject.
* Adds Documentation/redirects.py, with a rule for every page that left
its old path, so old URLs keep working. The redirect page also carries
a link's #anchor across to the new page.
Ten pages have text that is new or rewritten. Nine of them are the
landing page of a chapter, which has to exist for the new structure:
index the front page
os/index OS Design
os/scheduling/index Scheduling
os/interrupts/index Interrupts
os/ipc/index IPC
os/time/index Time and timers
about/index About
developing/index Developing NuttX
ReleaseNotes/index Release notes
The tenth is os/libs/libbuiltin, the only page here with technical
content: libs/libbuiltin/ had no page at all. Five SVG diagrams come
with these pages, hand-written XML with no editor metadata.
Nothing outside Documentation/ is touched.
How it was checked:
* Sphinx builds with -W: no warnings, and no document left outside a
toctree.
* A script, offered in the PR, proves the narrow claim this rests on.
For every page outside the ten named above it erases what a move
touches -- link target, path, tag line, toctree block, table border --
from the whole old text and the whole new text, and requires the two
to be byte for byte identical. It also requires every sentence of a
deleted page to turn up somewhere, and every page that left its old
path to have a redirect, from a URL that existed, to where its content
went. It exits non-zero and names the page if any of that is not true,
and it tests added pages too, so forgetting to declare one cannot make
it pass.
* An independent audit checked 133 factual claims on these ten pages
against the tree, one shell command per claim: 130 confirmed, 1
refuted and fixed here, 2 not checkable.
* tools/checkpatch.sh is clean over the range.
The diff is large because moving a page changes every link that points
to it. Most of it is pure renames, and board pages that gained one tag
line.
Assisted-by: Claude:claude-opus-5
141 lines
2.5 KiB
ReStructuredText
141 lines
2.5 KiB
ReStructuredText
===================
|
|
Run NuttX on Renode
|
|
===================
|
|
|
|
Renode (https://renode.io/) is and open source virtual development
|
|
framework dedicated for complex embedded systems.
|
|
|
|
This page contains notes on running some of NuttX boards on Renode.
|
|
|
|
stm32f4discovery
|
|
================
|
|
|
|
Renode doesn't support CCM memory, so we have to disable it
|
|
with ``CONFIG_MM_REGIONS=1``.
|
|
|
|
Renode script::
|
|
|
|
using sysbus
|
|
$name?="STM32F4_Discovery"
|
|
mach create $name
|
|
machine LoadPlatformDescription @platforms/boards/stm32f4_discovery-kit.repl
|
|
|
|
cpu PerformanceInMips 125
|
|
|
|
$bin?=@nuttx
|
|
|
|
showAnalyzer sysbus.usart2
|
|
|
|
macro reset
|
|
"""
|
|
sysbus LoadELF $bin
|
|
"""
|
|
|
|
runMacro $reset
|
|
|
|
|
|
Tested with ``stm32f4discovery/nsh``.
|
|
|
|
nucleo-l073rz
|
|
=============
|
|
|
|
Doesn't work. No BASEPRI implementation for ``Cotex-M0`` in NuttX.
|
|
|
|
nrf52840-dk
|
|
===========
|
|
|
|
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::
|
|
|
|
using "platforms/cpus/nrf52840.repl"
|
|
|
|
uart0:
|
|
easyDMA: false
|
|
|
|
Renode script::
|
|
|
|
using sysbus
|
|
|
|
mach create
|
|
machine LoadPlatformDescription @nrf52840_custom.repl
|
|
|
|
$bin?=@nuttx
|
|
|
|
showAnalyzer uart0
|
|
|
|
macro reset
|
|
"""
|
|
sysbus LoadELF $bin
|
|
"""
|
|
|
|
runMacro $reset
|
|
|
|
Tested with ``nrf52840-dk/nsh``.
|
|
|
|
Known issues:
|
|
|
|
* ``QSPI`` not implemented in Renode,
|
|
|
|
* ``PWM`` doesn't work, missing ``NRF52_PWM_EVENTS_SEQSTARTED0_OFFSET``
|
|
implementation in Renode,
|
|
|
|
* ``ADC`` doesn't work, missing ``NRF52_SAADC_EVENTS_CALDONE_OFFSET``
|
|
implementation in Renode,
|
|
|
|
* ``SoftDevice`` doesn't work, crash in ``mpsl_init()``
|
|
|
|
stm32f746g-disco
|
|
================
|
|
|
|
``CONFIG_ARMV7M_BASEPRI_WAR=y`` must be set.
|
|
|
|
Renode script::
|
|
|
|
using sysbus
|
|
$name?="STM32F746"
|
|
mach create $name
|
|
machine LoadPlatformDescription @platforms/boards/stm32f7_discovery-bb.repl
|
|
|
|
$bin ?= @nuttx
|
|
|
|
showAnalyzer usart1
|
|
showAnalyzer ltdc
|
|
|
|
macro reset
|
|
"""
|
|
sysbus LoadELF $bin
|
|
"""
|
|
|
|
runMacro $reset
|
|
|
|
Tested with ``stm32f746g-disco/nsh``.
|
|
|
|
Known issues:
|
|
|
|
* ``stm32f746g-disco/lvgl`` - crash due to incompatible I2C our touchscreen driver
|
|
|
|
nucleo-h743zi
|
|
=============
|
|
|
|
Renode doesn't support ``PWR_CSR1_ACTVOSRDY`` bit so we have to disable
|
|
it with ``CONFIG_STM32_PWR_IGNORE_ACTVOSRDY=y``.
|
|
|
|
Renode script::
|
|
|
|
using sysbus
|
|
mach create "nucleo_h743zi"
|
|
include @platforms/boards/nucleo_h753zi.repl
|
|
|
|
$bin=@nuttx
|
|
|
|
showAnalyzer sysbus.usart3
|
|
|
|
macro reset
|
|
"""
|
|
sysbus LoadELF $bin
|
|
"""
|
|
|
|
runMacro $reset
|
|
|
|
Tested with ``nucleo-h743zi/nsh``.
|