Commit Graph
12 Commits
Author SHA1 Message Date
Sebastian Huber 2e50add72a cpukit: Write the driver and PCI Doxygen briefs
The briefs of the block device drivers and the PCI headers named a
topic, not the content of the file.  Five libblock files carried the
same brief "Media implementation.".  Four more carried "RAM disk block
device implementation.".

Write every brief in the style of the tree.  A source brief starts with
"This source file contains" and names the functions the file defines
where there are at most three.  A header brief starts with "This header
file provides".  Put @file, @ingroup and @brief in this order.

The CAN and CAN FD stack keeps its briefs.  Its contributors write them
in a style of their own.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-01 20:17:20 +00:00
Sebastian Huber b2cf56b7b8 cpukit: Fix the last undefined group names
Five files named a group which no file defines.  The names
RTEMSLibdebugger, Flash, RTEMSGenericIODevAPI and SPIBus had no
definition.  One shell command left the @ingroup argument empty.

Point each file at the group which covers it.  The headers flashdev.h
and iodev.h define a group of their own, so they name it.

Only the two C++ headers still name an undefined group.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-01 20:17:20 +00:00
Kinsey Moore 098ba8472d cpukit/flashdev: Clarify interface and update consumers
This clarifies the flashdev out of band read and write interfaces and
updates any consumers of those interfaces. This was partially refactored
at one point and the refactoring didn't extend to the consumers as it
should have.
2026-07-27 12:15:22 +10:00
Gedare Bloom ffd859a304 cpukit/dev/flash: reformat
Updates #5443
2026-02-05 10:46:11 -07:00
Kinsey Moore d82efbd7d1 bsps/shared/dev/nor: Add SFDP and CFI parsers
Fixed flashdev doxygen group
2025-12-04 18:52:00 -06:00
Joel Sherrill 426f938869 cpukit/.../flashdev.c: Correct comparisons of different signedness
The GCC warning -Wsign-compare flagged these instances of comparing
signed and unsigned types. A common pair was size_t and int.
2025-12-04 18:46:23 -05:00
Kinsey Moore 38e8e5c286 cpukit/flashdev: Add full support for NAND devices
This extends the flashdev API to support the additional calls required
by NAND device backends. This also adds region-relative IOCTLs to
prevent reimplementation of offset logic in top-end flashdev/filesystem
adapters.
2025-10-02 20:12:51 -04:00
Kinsey Moore 75e7f5cb80 cpukit/flashdev: Add unregister call and private data destructor
This adds an API call allowing for unregistration to include destruction
of private data that is not managed by the flashdev framework. This also
updates the existing consumers of flashdev to use the new private data
destructor callback.
2025-09-22 10:04:58 -05:00
Kinsey Moore b898aa6203 cpukit/flashdev: Correct page/sector references 2025-09-05 13:13:19 -05:00
Aaron Nyholm 87c725b6ed flashdev: Add sector IOCTLs
Added new IOCTLs to flashdev to get sector info.
Updated flashdev shell command and flashdev test with new IOCTLs.
2024-11-06 22:35:20 +00:00
Bernd Moessner a43163d058 flashdev.h: Add missing C++ include guards
Updates #4981
2024-01-16 10:57:43 -06:00
Aaron Nyholm 15d4428e96 cpukit/flash: Add API for Flash devices 2023-05-16 12:48:13 +10:00