Firmware Document Types

Comprehensive document defining what your firmware product needs to do — functional requirements, non-functional requirements, power budgets, user stories, and acceptance criteria.

High-level system design showing how firmware modules interact — task architecture, communication patterns, memory layout, and dependency maps with Mermaid diagrams.

Defines the interface layer between your firmware application and hardware peripherals — GPIO, SPI, I2C, UART, ADC drivers with clean API definitions.

Formal definition of your firmware's state machine — states, transitions, guards, actions, and error recovery paths visualized with state diagrams.

Machine-readable JSON file containing all project context — hardware specs, pin mappings, library versions, and configuration — optimized for AI coding tools to consume.

Complete specification for the device bootloader, firmware update mechanism (DFU), and over-the-air update flow — memory partitioning, image signing, and rollback strategy.

Phase-by-phase development roadmap breaking the firmware project into sprint-sized work packages with dependencies, milestones, and effort estimates.

Detailed pin mappings, peripheral assignments, clock configuration, and power rail definitions for your specific hardware design and development kit.

Reference guide for all software libraries, SDKs, and middleware used in the project — version pinning, initialization sequences, and API usage patterns.

Specification of all communication interfaces — BLE services, MQTT topics, REST APIs, UART protocols — with message formats, error handling, and sequence diagrams.

Detailed configuration for each MCU peripheral — ADC settings, timer configurations, DMA channels, interrupt priorities, and power domain assignments.

Production-ready starter code files — main.c, CMakeLists.txt, prj.conf, Kconfig, device tree overlays, and .cursorrules — tailored to your specific hardware and project type.