mirror of
https://github.com/apache/nuttx.git
synced 2026-10-11 08:10:21 +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
122 lines
4.2 KiB
ReStructuredText
122 lines
4.2 KiB
ReStructuredText
=====
|
|
Sleep
|
|
=====
|
|
|
|
NuttX provides three different types of sleep interfaces.
|
|
|
|
Common Sleep Interfaces
|
|
=======================
|
|
|
|
Scheduled Sleep Interfaces (tick-based)
|
|
---------------------------------------
|
|
|
|
Suspend the calling thread for a specified amount of time until the time expires
|
|
or the thread is explicitly woken up through scheduler operations.
|
|
|
|
.. c:function:: void nxsched_abstick_sleep(clock_t ticks)
|
|
|
|
Suspends the calling thread from execution until the specified absolute time in clock ticks.
|
|
|
|
:param ticks: Absolute time in clock ticks.
|
|
|
|
.. c:function:: void nxsched_ticksleep(unsigned int ticks)
|
|
|
|
Suspends the calling thread from execution for the specified number of system ticks.
|
|
|
|
:param ticks: The number of system ticks to sleep.
|
|
|
|
.. c:function:: void nxsched_usleep(useconds_t usec)
|
|
|
|
Suspends the calling thread from execution for the specified number of microseconds.
|
|
|
|
:param usec: The number of microseconds to sleep.
|
|
|
|
.. c:function:: void nxsched_msleep(unsigned int msec)
|
|
|
|
Suspends the calling thread from execution for the specified number of milliseconds.
|
|
|
|
:param msec: The number of milliseconds to sleep.
|
|
|
|
.. c:function:: void nxsched_sleep(unsigned int sec)
|
|
|
|
Suspends the calling thread from execution for the specified number of seconds.
|
|
|
|
:param sec: The number of seconds to sleep.
|
|
|
|
.. c:function:: int nxsched_nanosleep(const struct timespec *rqtp, struct timespec *rmtp)
|
|
|
|
Suspends the calling thread from execution for the specified rqtp argument. This
|
|
function will return the remaining time via updating rmtp if the sleep is interrupted
|
|
by a signal.
|
|
|
|
:param rqtp: The amount of time to be suspended from execution.
|
|
:param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced
|
|
by it is updated to contain the amount of time remaining.
|
|
|
|
:return: 0 (OK), or negated errno if unsuccessful.
|
|
|
|
.. c:function:: void nxsched_wakeup(struct tcb_s *tcb)
|
|
|
|
This function is used to wake up a thread that is currently in sleeping state
|
|
before its timeout expires.
|
|
|
|
:param tcb: Pointer to the TCB of the task to be awakened.
|
|
|
|
Signal-based Sleep Interfaces (timespec-based)
|
|
----------------------------------------------
|
|
|
|
Suspend the calling thread for a specified amount of time until the
|
|
time expires or a signal is delivered to the calling thread.
|
|
|
|
.. note::
|
|
Implementations are dependent on the signal framework and based on standard
|
|
timespec conversion.
|
|
|
|
.. c:function:: void nxsig_usleep(useconds_t usec)
|
|
|
|
Suspends the calling thread from execution for the specified number of microseconds.
|
|
|
|
:param usec: The number of microseconds to sleep.
|
|
|
|
.. c:function:: void nxsig_sleep(unsigned int sec)
|
|
|
|
Suspends the calling thread from execution for the specified number of seconds.
|
|
|
|
:param sec: The number of seconds to sleep.
|
|
|
|
.. c:function:: int nxsig_nanosleep(const struct timespec *rqtp, struct timespec *rmtp)
|
|
|
|
Suspends the calling thread from execution for the specified rqtp argument. This
|
|
function will return the remaining time via updating rmtp if the sleep is interrupted
|
|
by a signal.
|
|
|
|
:param rqtp: The amount of time to be suspended from execution.
|
|
:param rmtp: If the rmtp argument is non-NULL, the timespec structure referenced
|
|
by it is updated to contain the amount of time remaining.
|
|
|
|
:return: 0 (OK), or negated errno if unsuccessful.
|
|
|
|
Busy Sleep Interfaces
|
|
---------------------
|
|
|
|
Spin in a loop for the requested duration and never yield the CPU. The delay accuracy depends on
|
|
``CONFIG_BOARD_LOOPSPERMSEC`` (unless the architecture/board code replaces these
|
|
function(s) with an implementation that does not use the value.)
|
|
|
|
.. c:function:: void up_mdelay(unsigned int milliseconds)
|
|
|
|
Delay inline for the requested number of milliseconds.
|
|
|
|
:param milliseconds: The number of milliseconds to delay.
|
|
|
|
.. c:function:: void up_udelay(useconds_t microseconds)
|
|
|
|
Delay inline for the requested number of microseconds.
|
|
|
|
:param microseconds: The number of microseconds to delay.
|
|
|
|
.. c:function:: void up_ndelay(unsigned long nanoseconds)
|
|
|
|
Delay inline for the requested number of nanoseconds.
|
|
|
|
:param nanoseconds: The number of nanoseconds to delay.
|