Skip to content

API Reference Hub

Welcome to the SyntropicOS C API Reference. This directory provides direct access to functional module subsystems, Doxygen-annotated group references, and global type indexes.

Technical Architecture & Memory Guarantees

Property Guarantee
Standards Compliance Pure C99, compatible with GCC, Clang, IAR, Keil, and MSVC.
Heap Allocation 0 Bytes. No malloc(), free(), or dynamic memory pools.
Concurrency Model Cooperative stackless coroutines (syn_pt). RAM footprint = 2 bytes/thread.
Reentrancy & Safety Lock-free SPSC data structures for safe ISR $\leftrightarrow$ Task communication.

Subsystem Navigation Directory

Jump directly to module documentation guides and Doxygen API groups:

Subsystem Functional Scope Documentation Guide
⚡ Core & Multitasking Protothreads, Task Scheduler, Active Objects, Workqueues, Mailboxes, Event Flags. Multitasking Guide
🎛️ Drivers & Peripherals GPIO, EXTI, UART, CAN, SPI, I2C, ADC, DAC, SD Card, RTC, DMA Engine. Drivers Guide
🔘 Input / Output Debounced Buttons, Tap Gestures, Combos, Rotary Encoders, LEDs, Soft PWM. I/O Guide
📡 Communications COBS Framing, Addressed Packet Router, Modbus RTU/TCP, M-Bus, ISO-TP, J1939. Communication Guide
⚙️ Motor & Control Integer PID Controller, Auto-Tuning, Steppers, Servos, DC Motors, FOC & Observer. Control Guide
🖥️ Display & UI Framebuffer Canvas, Graphics Primitives, Immediate-Mode GUI (syn_imgui), Menus. Display Guide
💾 Storage Persistent Settings Manager, Wear-Leveled Flash, LittleFS, FAT32, Virtual VFS. Storage Guide
🔬 Diagnostics & Debug ISR Event Tracer (syn_trace), CPU Profiler (syn_profiler), Serial CLI, Watchdog. Debug Guide
🛡️ System & Resilience Boot Manager, Crash-Loop Recovery, Core Dump Flash Capture, OTA Updates. System Guide
📐 DSP & Signal Processing Biquad Butterworth IIR Filters, EMA, Median, Radix-2 FFT, Signal Statistics. DSP Guide
🔒 Cryptography BLAKE2s Hash / MAC, ChaCha20-Poly1305 AEAD Cipher, X25519 Key Exchange. Crypto Guide

Global Indexes