Files
Sebastian Huber 3f2e1bc22b cpukit: Add the remaining Doxygen file headers
Thirty-five files across the device drivers, the event recording, the
debugger interfaces, the flattened device tree support and several small
libraries had no Doxygen block.  Doxygen listed none of them.

Give each file a block with @file, @ingroup and @brief.  The brief names
what the file implements.

The score/cpu ports and the shell still lack their blocks.  Later
commits add them.

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
..
2026-02-05 09:49:37 -06:00
…

cpuuse

This directory contains code to report and reset per-task CPU usage. If the BSP supports nanosecond timestamp granularity, this this information is very accurate. Otherwise, it is dependendent on the tick granularity.

It provides two primary features:

  • Generate a CPU Usage Report
  • Reset CPU Usage Information

NOTES:

  1. If configured for tick granularity, CPU usage is "docked" by a clock tick at each context switch.
  2. If configured for nanosecond granularity, no work is done at each clock tick. All bookkeeping is done as part of a context switch.