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
41 lines
2 KiB
ReStructuredText
41 lines
2 KiB
ReStructuredText
==================================
|
|
Single Button Multi Actions Driver
|
|
==================================
|
|
|
|
**Single Button (aka SButton)** is an kind of keyboard that uses
|
|
only a single physical button (Switch) in the board. This kind of
|
|
button is used with simple interfaces like those used on 3D Printers
|
|
or other devices where all the user needs is to move to the next
|
|
option and confirm the selection.
|
|
|
|
It could be done detecting if the button was pressed for a short
|
|
period of time (i.e. less than 500ms) or long pressed. If it is a
|
|
short press the driver will return **TAB** and if it is a long
|
|
press the driver will return **ENTER**. Using it is possible to
|
|
navigate on those kind of menu.
|
|
|
|
**How does it work?**. The driver uses a simple config data (this
|
|
config data is equivalent to the platform data on Linux kernel) to
|
|
map the pin from MCU will be used to register and detect the
|
|
interrupt from this pin physically connected to the button.
|
|
|
|
It uses a kind of "polymorphism" in C to allow the driver to get
|
|
access to the functions responsible to attach and enable the
|
|
interrupt and to get the status of the pin.
|
|
See ``include/nuttx/input/sbutton.h``
|
|
and ``boards/arm/common/stm32/src/stm32_sbutton.c`` to understand
|
|
better how it works. But basically the board file (config data)
|
|
creates a struct when the first field (variable) is the config
|
|
struct used the but SButton driver (``drivers/input/sbutton.c``).
|
|
|
|
Every time the user presses or releases the key button an interrupt
|
|
is generated. The ISR of this interrupt inside sbutton
|
|
(``sbutton_interrupt()``) calls a workqueue to process it (because
|
|
we cannot spend time inside the ISR processing data, it could
|
|
degradate the performance of the RTOS). All that workqueue
|
|
(``sbutton_worker()``) needs to do it measure the elapsed time
|
|
(ticks) from the moment the key was pressed until the moment it
|
|
was released to decide if it is a "KEY_1" (**TAB**) or a "KEY_2"
|
|
(**ENTER**). Then is call the ``keyboard_event()`` from the
|
|
keyboard upper to send this key stroke to the user application.
|
|
|