How scarletshroud/reliability_lib works
Project type and purpose
• A portability‐focused, embedded C library (“reliability_lib”) providing error-detection and recovery mechanisms for microcontrollers.
• Supports multiple platforms (bare-metal mk32, FreeRTOS, AUTOSAR, QEMU) via a hardware‐abstraction/adapter layer.
• Includes standalone tools for error monitoring and reliability evaluation.
File structure
Top‐level:
• main.c – example or test harness (application).
• CMakeLists.txt, build scripts (.cfg, .ld, .bat).
• platform/ – adapter API + platform‐specific implementations.
• snippets/ & tools/reliability_mechanisms/ – core reliability modules.
• tools/ – CLI utilities (error_monitor, reliability_evaluation_models).
Key patterns:
• Layered architecture: Application → Library API → Adapter → Platform → Hardware.
• Core modules grouped by mechanism type (single_design, design_diversity).
• Tools separated from embedded library, but reuse core modules for model simulation.
Extract architecture details from README
• Core features = modular mechanisms (CRC, CFC, N-version, recovery blocks, watchdog, etc.).
• Designed for resource‐constrained MCUs.
• Intended embedding in various RTOS/bare‐metal/AUTOSAR environments.
Main components & interactions
a. Application Layer
– main.c invokes reliability APIs (e.g., CFC_CHECK).
b. Reliability Core (Library API)
– Modules under snippets/ & tools/reliability_mechanisms/
– Provides interface headers (e.g., cfc_monitor.h, checksum_snippet.h, n_version_snippet.h).
c. Platform Abstraction Layer
– platform/adapter: defines adapter_target.h and init_platform_adapter.h
– Decouples core from platform details (timers, memory, I/O).
d. Platform Implementations
– mk32_baremetal: HAL drivers (core/peripherals), startup, linker scripts.
– freeRTOS & autosar: stubbed directories for OS integration.
– qemu: simulator glue (qemu_riscv_uart.c), .ld, run scripts.
e. Hardware / Simulator
– Actual MCU registers accessed via HAL.
– QEMU as virtual hardware target.
f. Tools Subsystem (Desktop)
– error_monitor: CLI to track runtime errors.
– reliability_evaluation_models: continuous, discrete, static model code.
– These tools link against core reliability modules to simulate or analyze.
Interactions:
• Application → calls Reliability Core → calls Adapter API → uses Platform Impl → accesses Hardware.
• Tools CLI → links Reliability Core + Models → outputs metrics.
Architectural patterns / principles
• Layered, modular design for portability and scalability.
• Hardware‐abstraction via adapter interface.
• Build‐time selection of platform via CMake + scripts.
• Separation of embedded library vs. desktop tools.