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>
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>
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.
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.
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.