mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 23:05:20 +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
55 lines
2.2 KiB
ReStructuredText
55 lines
2.2 KiB
ReStructuredText
The diagram of boot sequence
|
|
============================
|
|
|
|
The premise of this sequence diagram is NuttX12.4.0, cxd56xx, non-SMP and Flat build.
|
|
|
|
The beginning of boot sequence is ``__start()``.
|
|
|
|
``__start()`` will call ``nx_start()``. ``nx_start()`` will initialize the
|
|
kernel and call ``nsh_main()``. ``nsh_main()`` will execute NuttShell(NSH).
|
|
``nx_start()`` is NuttX standard function, but the behavior depends on some
|
|
kernel configurations. For example, the calling ``nsh_main()`` is also
|
|
configurable. About related kernel configurations, see
|
|
:doc:`/guides/porting/port_relatedkernelconfigrations`.
|
|
|
|
.. uml::
|
|
|
|
bootloader --> cxd56_start.c : Jump to __start by function call or de-assert the reset signal of CM4F
|
|
|
|
note over cxd56_start.c : Initialize SP
|
|
note over cxd56_start.c : Disable IRQ @processor level
|
|
note over cxd56_start.c : Initialize .data/.bss
|
|
note over cxd56_start.c : cxd56_board_initialize() as <arch>_board_initialize()
|
|
|
|
cxd56_start.c --> nx_start.c : nx_start()
|
|
|
|
note over nx_start.c : Initialize IDLE task TCB
|
|
note over nx_start.c : nxsem_initialize()
|
|
note over nx_start.c : Initialize HEAP
|
|
note over nx_start.c : Create and initialize IDLE group instance
|
|
note over nx_start.c : sched_lock()
|
|
note over nx_start.c : fs_initialize()
|
|
note over nx_start.c : irq_initialize()
|
|
note over nx_start.c : clock_initialize()
|
|
note over nx_start.c : timer_initialize()
|
|
note over nx_start.c : nxsig_initialize()
|
|
note over nx_start.c : nxmq_initialize()
|
|
note over nx_start.c : net_initialize()
|
|
note over nx_start.c : binfmt_initialize()
|
|
note over nx_start.c : up_initialize()
|
|
note over nx_start.c : drivers_initialize()
|
|
note over nx_start.c : board_early_initialize()
|
|
note over nx_start.c : Initialize SDIO for IDLE task
|
|
|
|
nx_start.c --> nx_bringup.c : nx_bringup()
|
|
|
|
note over nx_bringup.c : Initialize environment variables (PWD, PATH, LD_LIBRARY_PATH)
|
|
note over nx_bringup.c : Start work queues
|
|
|
|
nx_bringup.c --> nx_start_application : nx_start_task()
|
|
|
|
note over nx_start_application : board_late_initialize()
|
|
note over nx_start_application : coredump_initialize()
|
|
note over nx_start_application : Start nsh_main() as the application initialization task
|
|
|
|
note over nx_start.c : up_idle()
|